Adds support for types model in linkedItems (modular_content)

kontent-ai · Feb 6, 2025 · 4560adf · 4560adf
1 parent c26915a
commit 4560adf
Show file tree

Hide file tree

Showing 8 changed files with 87 additions and 51 deletions.
diff --git a/lib/mappers/element.mapper.ts b/lib/mappers/element.mapper.ts
@@ -24,7 +24,7 @@ export class ElementMapper<TClientTypes extends ClientTypes> {
 
     mapElements<TContentItem extends IContentItem = TClientTypes['contentItemType']>(data: {
         dataToMap: IContentItemWithRawElements;
-        processedItems: IContentItemsContainer;
+        processedItems: IContentItemsContainer<TClientTypes['contentItemType']>;
         processingStartedForCodenames: string[];
         preparedItems: IContentItemWithRawDataContainer;
     }): IMapElementsResult<TContentItem> | undefined {
@@ -84,7 +84,7 @@ export class ElementMapper<TClientTypes extends ClientTypes> {
     private mapElement(data: {
         elementWrapper: ElementModels.IElementWrapper;
         item: IContentItem;
-        processedItems: IContentItemsContainer;
+        processedItems: IContentItemsContainer<TClientTypes['contentItemType']>;
         processingStartedForCodenames: string[];
         preparedItems: IContentItemWithRawDataContainer;
     }): ElementModels.IElement<any> {
@@ -147,7 +147,7 @@ export class ElementMapper<TClientTypes extends ClientTypes> {
 
     private mapRichTextElement(
         elementWrapper: ElementModels.IElementWrapper,
-        processedItems: IContentItemsContainer,
+        processedItems: IContentItemsContainer<TClientTypes['contentItemType']>,
         processingStartedForCodenames: string[],
         preparedItems: IContentItemWithRawDataContainer
     ): Elements.RichTextElement {
@@ -337,7 +337,7 @@ export class ElementMapper<TClientTypes extends ClientTypes> {
 
     private mapLinkedItemsElement(data: {
         elementWrapper: ElementModels.IElementWrapper;
-        processedItems: IContentItemsContainer;
+        processedItems: IContentItemsContainer<TClientTypes['contentItemType']>;
         processingStartedForCodenames: string[];
         preparedItems: IContentItemWithRawDataContainer;
     }): Elements.LinkedItemsElement<any> {
@@ -372,7 +372,7 @@ export class ElementMapper<TClientTypes extends ClientTypes> {
     private getOrSaveLinkedItemForElement(
         codename: string,
         element: Contracts.IElementContract,
-        processedItems: IContentItemsContainer,
+        processedItems: IContentItemsContainer<TClientTypes['contentItemType']>,
         mappingStartedForCodenames: string[],
         preparedItems: IContentItemWithRawDataContainer
     ): IContentItem | undefined {

diff --git a/lib/models/item-models.ts b/lib/models/item-models.ts
@@ -2,9 +2,12 @@ import { Contracts } from '../contracts';
 import { ElementModels } from '../elements/element-models';
 import { IQueryConfig } from './common/common-models';
 
-export interface IMapElementsResult<TContentItem extends IContentItem = IContentItem> {
+export interface IMapElementsResult<
+    TContentItem extends IContentItem = IContentItem,
+    TLinkedItemType extends IContentItem = IContentItem
+> {
     item: TContentItem;
-    processedItems: IContentItemsContainer;
+    processedItems: IContentItemsContainer<TLinkedItemType>;
     preparedItems: IContentItemWithRawDataContainer;
     processingStartedForCodenames: string[];
 }
@@ -145,8 +148,8 @@ export interface IContentItemWithRawDataContainer {
     [key: string]: IContentItemWithRawElements;
 }
 
-export interface IContentItemsContainer {
-    [key: string]: IContentItem;
+export interface IContentItemsContainer<TLinkedItemType extends IContentItem> {
+    [key: string]: TLinkedItemType;
 }
 
 export interface IRichTextImage {

diff --git a/lib/models/responses.ts b/lib/models/responses.ts
@@ -35,38 +35,51 @@ export namespace Responses {
         options: IGenericElementOption[];
     }
 
-    export interface IListItemsFeedResponse<TContentItem extends IContentItem = IContentItem>
-        extends IKontentListResponse {
+    export interface IListItemsFeedResponse<
+        TContentItem extends IContentItem = IContentItem,
+        TLinkedItemType extends IContentItem = IContentItem
+    > extends IKontentListResponse {
         items: TContentItem[];
-        linkedItems: IContentItemsContainer;
+        linkedItems: IContentItemsContainer<TLinkedItemType>;
     }
 
-    export interface IListItemsFeedAllResponse<TContentItem extends IContentItem = IContentItem>
-        extends IKontentListAllResponse {
+    export interface IListItemsFeedAllResponse<
+        TContentItem extends IContentItem = IContentItem,
+        TLinkedItemType extends IContentItem = IContentItem
+    > extends IKontentListAllResponse {
         items: TContentItem[];
-        responses: IDeliveryNetworkResponse<IListItemsFeedResponse<TContentItem>, Contracts.IItemsFeedContract>[];
+        responses: IDeliveryNetworkResponse<
+            IListItemsFeedResponse<TContentItem, TLinkedItemType>,
+            Contracts.IItemsFeedContract
+        >[];
     }
 
-    export interface IListContentItemsResponse<TContentItem extends IContentItem = IContentItem>
-        extends IKontentListResponse {
+    export interface IListContentItemsResponse<
+        TContentItem extends IContentItem = IContentItem,
+        TLinkedItemType extends IContentItem = IContentItem
+    > extends IKontentListResponse {
         items: TContentItem[];
         pagination: IPagination;
-        linkedItems: IContentItemsContainer;
+        linkedItems: IContentItemsContainer<TLinkedItemType>;
     }
 
-    export interface IListContentItemsAllResponse<TContentItem extends IContentItem = IContentItem>
-        extends IKontentListAllResponse {
+    export interface IListContentItemsAllResponse<
+        TContentItem extends IContentItem = IContentItem,
+        TLinkedItemType extends IContentItem = IContentItem
+    > extends IKontentListAllResponse {
         items: TContentItem[];
         responses: IDeliveryNetworkResponse<
-            IListContentItemsResponse<TContentItem>,
+            IListContentItemsResponse<TContentItem, TLinkedItemType>,
             Contracts.IListContentItemsContract
         >[];
     }
 
-    export interface IViewContentItemResponse<TContentItem extends IContentItem = IContentItem>
-        extends IKontentResponse {
+    export interface IViewContentItemResponse<
+        TContentItem extends IContentItem = IContentItem,
+        TLinkedItemType extends IContentItem = IContentItem
+    > extends IKontentResponse {
         item: TContentItem;
-        linkedItems: IContentItemsContainer;
+        linkedItems: IContentItemsContainer<TLinkedItemType>;
     }
 
     export interface IInitializeSyncResponse extends IKontentResponse {

diff --git a/lib/query/item/multiple-items-query.class.ts b/lib/query/item/multiple-items-query.class.ts
@@ -17,8 +17,8 @@ export class MultipleItemsQuery<
     TContentItem extends IContentItem = IContentItem
 > extends BaseItemListingQuery<
     TClientTypes,
-    Responses.IListContentItemsResponse<TContentItem>,
-    Responses.IListContentItemsAllResponse<TContentItem>,
+    Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
+    Responses.IListContentItemsAllResponse<TContentItem, TClientTypes['contentItemType']>,
     IItemQueryConfig,
     Contracts.IListContentItemsContract
 > {
@@ -113,7 +113,10 @@ export class MultipleItemsQuery<
     }
 
     toPromise(): Promise<
-        IDeliveryNetworkResponse<Responses.IListContentItemsResponse<TContentItem>, Contracts.IListContentItemsContract>
+        IDeliveryNetworkResponse<
+            Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
+            Contracts.IListContentItemsContract
+        >
     > {
         return this.queryService.getMultipleItems(this.getUrl(), this._queryConfig ?? {});
     }
@@ -130,17 +133,17 @@ export class MultipleItemsQuery<
         return super.resolveUrlInternal(action);
     }
 
-    map(json: any): Responses.IListContentItemsResponse<TContentItem> {
+    map(json: any): Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']> {
         return this.queryService.mappingService.listContentItemsResponse(json);
     }
 
     protected allResponseFactory(
         items: any[],
         responses: IDeliveryNetworkResponse<
-            Responses.IListContentItemsResponse<TContentItem>,
+            Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
             Contracts.IListContentItemsContract
         >[]
-    ): Responses.IListContentItemsAllResponse<TContentItem> {
+    ): Responses.IListContentItemsAllResponse<TContentItem, TClientTypes['contentItemType']> {
         this.linkItems(items, responses);
 
         return {
@@ -152,7 +155,7 @@ export class MultipleItemsQuery<
     private linkItems(
         items: IContentItem[],
         responses: IDeliveryNetworkResponse<
-            Responses.IListContentItemsResponse<TContentItem>,
+            Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
             Contracts.IListContentItemsContract
         >[]
     ): void {

diff --git a/lib/query/item/single-item-query.class.ts b/lib/query/item/single-item-query.class.ts
@@ -16,7 +16,7 @@ export class SingleItemQuery<
     TContentItem extends IContentItem = IContentItem
 > extends BaseQuery<
     TClientTypes,
-    Responses.IViewContentItemResponse<TContentItem>,
+    Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']>,
     IItemQueryConfig,
     Contracts.IViewContentItemContract
 > {
@@ -80,7 +80,10 @@ export class SingleItemQuery<
     }
 
     toPromise(): Promise<
-        IDeliveryNetworkResponse<Responses.IViewContentItemResponse<TContentItem>, Contracts.IViewContentItemContract>
+        IDeliveryNetworkResponse<
+            Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']>,
+            Contracts.IViewContentItemContract
+        >
     > {
         return this.queryService.getSingleItemAsync(this.getUrl(), this._queryConfig ?? {});
     }
@@ -97,7 +100,7 @@ export class SingleItemQuery<
         return super.resolveUrlInternal(action);
     }
 
-    map(json: any): Responses.IViewContentItemResponse<TContentItem> {
+    map(json: any): Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']> {
         return this.queryService.mappingService.viewContentItemResponse(json);
     }
 }
diff --git a/lib/query/items-feed/items-feed-query.class.ts b/lib/query/items-feed/items-feed-query.class.ts
@@ -17,8 +17,8 @@ export class ItemsFeedQuery<
     TContentItem extends IContentItem = IContentItem
 > extends BaseItemListingQuery<
     TClientTypes,
-    Responses.IListItemsFeedResponse<TContentItem>,
-    Responses.IListItemsFeedAllResponse<TContentItem>,
+    Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
+    Responses.IListItemsFeedAllResponse<TContentItem, TClientTypes['contentItemType']>,
     IItemFeedQueryConfig,
     Contracts.IItemsFeedContract
 > {
@@ -94,7 +94,10 @@ export class ItemsFeedQuery<
     }
 
     toPromise(): Promise<
-        IDeliveryNetworkResponse<Responses.IListItemsFeedResponse<TContentItem>, Contracts.IItemsFeedContract>
+        IDeliveryNetworkResponse<
+            Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
+            Contracts.IItemsFeedContract
+        >
     > {
         return this.queryService.getItemsFeed(this.getUrl(), this._queryConfig ?? {});
     }
@@ -120,17 +123,17 @@ export class ItemsFeedQuery<
         return this;
     }
 
-    map(json: any): Responses.IListItemsFeedResponse<TContentItem> {
+    map(json: any): Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']> {
         return this.queryService.mappingService.itemsFeedResponse(json);
     }
 
     protected allResponseFactory(
         items: TContentItem[],
         responses: IDeliveryNetworkResponse<
-            Responses.IListItemsFeedResponse<TContentItem>,
+            Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
             Contracts.IItemsFeedContract
         >[]
-    ): Responses.IListItemsFeedAllResponse<TContentItem> {
+    ): Responses.IListItemsFeedAllResponse<TContentItem, TClientTypes['contentItemType']> {
         if (this.canLinkItems()) {
             this.linkFeedItems(items, responses);
         }
@@ -144,7 +147,7 @@ export class ItemsFeedQuery<
     private linkFeedItems(
         items: TContentItem[],
         responses: IDeliveryNetworkResponse<
-            Responses.IListItemsFeedResponse<TContentItem>,
+            Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
             Contracts.IItemsFeedContract
         >[]
     ): void {

diff --git a/lib/services/delivery-query.service.ts b/lib/services/delivery-query.service.ts
@@ -42,12 +42,15 @@ export class QueryService<TClientTypes extends ClientTypes> extends BaseDelivery
         url: string,
         queryConfig: IItemQueryConfig
     ): Promise<
-        IDeliveryNetworkResponse<Responses.IViewContentItemResponse<TContentItem>, Contracts.IViewContentItemContract>
+        IDeliveryNetworkResponse<
+            Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']>,
+            Contracts.IViewContentItemContract
+        >
     > {
         const response = await this.getResponseAsync<Contracts.IViewContentItemContract>(url, queryConfig);
 
         return this.mapNetworkResponse<
-            Responses.IViewContentItemResponse<TContentItem>,
+            Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']>,
             Contracts.IViewContentItemContract
         >(this.mappingService.viewContentItemResponse<TContentItem>(response.data), response);
     }
@@ -60,7 +63,12 @@ export class QueryService<TClientTypes extends ClientTypes> extends BaseDelivery
     async getItemsFeed<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
         url: string,
         queryConfig: IItemQueryConfig
-    ): Promise<IDeliveryNetworkResponse<Responses.IListItemsFeedResponse<TContentItem>, Contracts.IItemsFeedContract>> {
+    ): Promise<
+        IDeliveryNetworkResponse<
+            Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
+            Contracts.IItemsFeedContract
+        >
+    > {
         const response = await this.getResponseAsync<Contracts.IItemsFeedContract>(url, queryConfig);
 
         return this.mapNetworkResponse(this.mappingService.itemsFeedResponse<TContentItem>(response.data), response);
@@ -75,7 +83,10 @@ export class QueryService<TClientTypes extends ClientTypes> extends BaseDelivery
         url: string,
         queryConfig: IItemQueryConfig
     ): Promise<
-        IDeliveryNetworkResponse<Responses.IListContentItemsResponse<TContentItem>, Contracts.IListContentItemsContract>
+        IDeliveryNetworkResponse<
+            Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
+            Contracts.IListContentItemsContract
+        >
     > {
         const response = await this.getResponseAsync<Contracts.IListContentItemsContract>(url, queryConfig);
 

diff --git a/lib/services/mapping.service.ts b/lib/services/mapping.service.ts
@@ -10,19 +10,19 @@ export interface IMappingService<TClientTypes extends ClientTypes> {
 
     itemsFeedResponse<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
         data: Contracts.IItemsFeedContract
-    ): Responses.IListItemsFeedResponse<TContentItem>;
+    ): Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>;
 
     viewContentTypeResponse(
         data: Contracts.IViewContentTypeContract
     ): Responses.IViewContentTypeResponse<TClientTypes['contentTypeCodenames']>;
 
     viewContentItemResponse<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
         data: Contracts.IViewContentItemContract
-    ): Responses.IViewContentItemResponse<TContentItem>;
+    ): Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']>;
 
     listContentItemsResponse<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
         data: Contracts.IListContentItemsContract
-    ): Responses.IListContentItemsResponse<TContentItem>;
+    ): Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>;
 
     viewTaxonomyResponse(
         data: Contracts.IViewTaxonomyGroupContract
@@ -101,7 +101,7 @@ export class MappingService<TClientTypes extends ClientTypes> implements IMappin
 
     itemsFeedResponse<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
         data: Contracts.IItemsFeedContract
-    ): Responses.IListItemsFeedResponse<TContentItem> {
+    ): Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']> {
         const itemsResult = this.itemMapper.mapItems<TContentItem>({
             linkedItems: Object.values(data.modular_content),
             mainItems: data.items
@@ -120,7 +120,7 @@ export class MappingService<TClientTypes extends ClientTypes> implements IMappin
      */
     viewContentItemResponse<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
         data: Contracts.IViewContentItemContract
-    ): Responses.IViewContentItemResponse<TContentItem> {
+    ): Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']> {
         const itemResult = this.itemMapper.mapSingleItemFromResponse<TContentItem>(data);
 
         return {
@@ -136,7 +136,7 @@ export class MappingService<TClientTypes extends ClientTypes> implements IMappin
      */
     listContentItemsResponse<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
         data: Contracts.IListContentItemsContract
-    ): Responses.IListContentItemsResponse<TContentItem> {
+    ): Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']> {
         const itemsResult = this.itemMapper.mapMultipleItemsFromResponse<TContentItem>(data);
 
         return {