@kontent-ai/delivery-sdk 16.4.3 → 17.0.0-preview.0

package/lib/models/item-models.ts

@@ -1,192 +0,0 @@
-import { Contracts } from '../contracts';
-import { ElementModels } from '../elements/element-models';
-import { IQueryConfig } from './common/common-models';
-
-export interface IMapElementsResult<
-    TContentItem extends IContentItem = IContentItem,
-    TLinkedItemType extends IContentItem = IContentItem
-> {
-    item: TContentItem;
-    processedItems: IContentItemsContainer<TLinkedItemType>;
-    preparedItems: IContentItemWithRawDataContainer;
-    processingStartedForCodenames: string[];
-}
-
-export interface IContentItemSystemAttributes<
-    TTypeCodename extends string = string,
-    TLanguageCodenames extends string = string,
-    TCollectionCodenames extends string = string,
-    TWorkflowCodenames extends string = string,
-    TWorkflowStepCodenames extends string = string
-> {
-    /**
-     * Id of the item
-     */
-    id: string;
-
-    /**
-     * Name of the item
-     */
-    name: string;
-
-    /**
-     * Codename of the item
-     */
-    codename: string;
-
-    /**
-     * Codename of the type this item is using
-     */
-    type: TTypeCodename;
-
-    /**
-     * Date when the item was last modified
-     */
-    lastModified: string;
-
-    /**
-     * Codename of the language
-     */
-    language: TLanguageCodenames;
-
-    /**
-     * Array of sitemap locations (obsolete)
-     */
-    sitemapLocations: string[];
-
-    /**
-     * Codename of the collection this item belongs to
-     */
-    collection: TCollectionCodenames;
-
-    /**
-     * Workflow step of the item
-     */
-    workflowStep: TWorkflowStepCodenames | null;
-
-    /**
-     * Workflow of the item
-     */
-    workflow: TWorkflowCodenames | null;
-}
-
-/**
- * Indexer for elements within content item
- */
-export type ContentItemElementsIndexer<TElement extends ElementModels.IElement<any> = ElementModels.IElement<any>> =
-    TElement;
-
-export type ContentItemType = 'component' | 'linkedItem';
-
-/**
- * Prefix with I to keep the name consistent and prevent releasing major version
- */
-export type IContentItemElements<TElementCodenames extends string = string> = Record<
-    TElementCodenames,
-    ContentItemElementsIndexer
->;
-
-export type Snippet<
-    TElementCodenames extends string,
-    TElements extends IContentItemElements<TElementCodenames>
-> = TElements;
-
-export interface IContentItem<
-    TElements extends IContentItemElements<TTypeElementCodenames> = IContentItemElements,
-    TTypeCodename extends string = string,
-    TLanguageCodenames extends string = string,
-    TCollectionCodenames extends string = string,
-    TWorkflowCodenames extends string = string,
-    TWorkflowStepCodenames extends string = string,
-    TTypeElementCodenames extends string = string
-> {
-    /**
-     * Elements of the content item
-     */
-    elements: TElements;
-
-    /**
-     * System data of the content item
-     */
-    system: IContentItemSystemAttributes<
-        TTypeCodename,
-        TLanguageCodenames,
-        TCollectionCodenames,
-        TWorkflowCodenames,
-        TWorkflowStepCodenames
-    >;
-}
-
-export interface ILink {
-    /**
-     * Id of the link
-     */
-    linkId: string;
-
-    /**
-     * Codename of the content item
-     */
-    codename: string;
-
-    /**
-     * Type codename of the content item
-     */
-    type: string;
-
-    /**
-     * Url slug defined for the content item
-     */
-    urlSlug: string;
-}
-
-export interface IContentItemWithRawElements {
-    item: IContentItem;
-    rawItem: Contracts.IContentItemContract;
-}
-
-export interface IContentItemWithRawDataContainer {
-    [key: string]: IContentItemWithRawElements;
-}
-
-export interface IContentItemsContainer<TContentItem extends IContentItem> {
-    [key: string]: TContentItem | undefined;
-}
-
-export interface IRichTextImage {
-    imageId: string;
-    url: string;
-    description: string | null;
-    width: number | null;
-    height: number | null;
-}
-
-export interface IItemQueryConfig extends IQueryConfig {}
-
-export interface IItemFeedQueryConfig extends IQueryConfig {
-    disableItemLinking?: boolean;
-}
-
-export interface IUsedInItemRecord<TClientTypes extends ClientTypes> {
-    readonly system: {
-        readonly id: string;
-        readonly name: string;
-        readonly codename: string;
-        readonly language: TClientTypes['languageCodenames'];
-        readonly type: TClientTypes['contentTypeCodenames'];
-        readonly collection: TClientTypes['collectionCodenames'];
-        readonly workflow: TClientTypes['workflowCodenames'];
-        readonly workflowStep: TClientTypes['workflowStepCodenames'];
-        readonly lastModified: string;
-    };
-}
-
-export type ClientTypes = {
-    readonly contentItemType: IContentItem;
-    readonly contentTypeCodenames: string;
-    readonly workflowCodenames: string;
-    readonly workflowStepCodenames: string;
-    readonly collectionCodenames: string;
-    readonly taxonomyCodenames: string;
-    readonly languageCodenames: string;
-    readonly elementCodenames: string;
-};

package/lib/models/language-models.ts

@@ -1,17 +0,0 @@
-import { IQueryConfig } from './common';
-
-export interface ILanguageSystem<TLanguageCodenames extends string> {
-    id: string;
-    name: string;
-    codename: TLanguageCodenames;
-}
-
-export interface ILanguage<TLanguageCodenames extends string> {
-    system: ILanguageSystem<TLanguageCodenames>;
-}
-
-export interface ILanguagesQueryConfig extends IQueryConfig {
-    /**
-     * No dedicated properties required at this moment
-     */
-}

package/lib/models/responses.ts

@@ -1,137 +0,0 @@
-import { Contracts } from '../contracts';
-import { IDeliveryNetworkResponse } from './common/base-responses';
-import { IKontentListAllResponse, IKontentListResponse, IKontentResponse } from './common/common-models';
-import { IPagination } from './common/pagination.class';
-import { IContentType } from './content-type-models';
-import { IGenericElementOption } from './element-models';
-import { IContentItem, IContentItemsContainer, IUsedInItemRecord } from './item-models';
-import { ILanguage } from './language-models';
-import { IContentItemDelta } from './sync-models';
-import { ITaxonomyGroup } from './taxonomy-models';
-import { ClientTypes } from './item-models';
-
-export namespace Responses {
-    export interface IListContentTypesResponse<TContentTypeCodename extends string> extends IKontentListResponse {
-        items: IContentType<TContentTypeCodename>[];
-        pagination: IPagination;
-    }
-
-    export interface IListContentTypesAllResponse<TContentTypeCodename extends string> extends IKontentListAllResponse {
-        items: IContentType<TContentTypeCodename>[];
-        responses: IDeliveryNetworkResponse<
-            IListContentTypesResponse<TContentTypeCodename>,
-            Contracts.IListContentTypeContract
-        >[];
-    }
-
-    export interface IViewContentTypeResponse<TContentTypeCodename extends string> extends IKontentResponse {
-        type: IContentType<TContentTypeCodename>;
-    }
-
-    export interface IViewContentTypeElementResponse extends IKontentResponse {
-        codename?: string;
-        type: string;
-        name: string;
-        taxonomyGroup?: string;
-        options: IGenericElementOption[];
-    }
-
-    export interface IUsedInResponse<TClientTypes extends ClientTypes> extends IKontentListResponse {
-        items: IUsedInItemRecord<TClientTypes>[];
-    }
-
-    export interface IUsedInAllResponse<TClientTypes extends ClientTypes> extends IKontentListAllResponse {
-        items: IUsedInItemRecord<TClientTypes>[];
-        responses: IDeliveryNetworkResponse<IUsedInResponse<TClientTypes>, Contracts.IUsedInItemsContract>[];
-    }
-
-    export interface IListItemsFeedResponse<
-        TContentItem extends IContentItem = IContentItem,
-        TLinkedItemType extends IContentItem = IContentItem
-    > extends IKontentListResponse {
-        items: TContentItem[];
-        linkedItems: IContentItemsContainer<TLinkedItemType>;
-    }
-
-    export interface IListItemsFeedAllResponse<
-        TContentItem extends IContentItem = IContentItem,
-        TLinkedItemType extends IContentItem = IContentItem
-    > extends IKontentListAllResponse {
-        items: TContentItem[];
-        responses: IDeliveryNetworkResponse<
-            IListItemsFeedResponse<TContentItem, TLinkedItemType>,
-            Contracts.IItemsFeedContract
-        >[];
-    }
-
-    export interface IListContentItemsResponse<
-        TContentItem extends IContentItem = IContentItem,
-        TLinkedItemType extends IContentItem = IContentItem
-    > extends IKontentListResponse {
-        items: TContentItem[];
-        pagination: IPagination;
-        linkedItems: IContentItemsContainer<TLinkedItemType>;
-    }
-
-    export interface IListContentItemsAllResponse<
-        TContentItem extends IContentItem = IContentItem,
-        TLinkedItemType extends IContentItem = IContentItem
-    > extends IKontentListAllResponse {
-        items: TContentItem[];
-        responses: IDeliveryNetworkResponse<
-            IListContentItemsResponse<TContentItem, TLinkedItemType>,
-            Contracts.IListContentItemsContract
-        >[];
-    }
-
-    export interface IViewContentItemResponse<
-        TContentItem extends IContentItem = IContentItem,
-        TLinkedItemType extends IContentItem = IContentItem
-    > extends IKontentResponse {
-        item: TContentItem;
-        linkedItems: IContentItemsContainer<TLinkedItemType>;
-    }
-
-    export interface IInitializeSyncResponse extends IKontentResponse {
-        items: IContentItemDelta[];
-    }
-
-    export interface ISyncChangesResponse extends IKontentResponse {
-        items: IContentItemDelta[];
-    }
-
-    export interface ISyncChangesAllResponse extends IKontentListAllResponse {
-        items: IContentItemDelta[];
-        responses: IDeliveryNetworkResponse<ISyncChangesResponse, Contracts.ISyncChangesContract>[];
-    }
-
-    export interface IListLanguagesResponse<TLanguageCodenames extends string> extends IKontentListResponse {
-        items: ILanguage<TLanguageCodenames>[];
-        pagination: IPagination;
-    }
-
-    export interface IListLanguagesAllResponse<TLanguageCodenames extends string> extends IKontentListAllResponse {
-        items: ILanguage<TLanguageCodenames>[];
-        responses: IDeliveryNetworkResponse<
-            IListLanguagesResponse<TLanguageCodenames>,
-            Contracts.IListLanguagesContract
-        >[];
-    }
-
-    export interface IViewTaxonomyResponse<TaxonomyCodename extends string> extends IKontentResponse {
-        taxonomy: ITaxonomyGroup<TaxonomyCodename>;
-    }
-
-    export interface IListTaxonomiesResponse<TaxonomyCodename extends string> extends IKontentListResponse {
-        items: ITaxonomyGroup<TaxonomyCodename>[];
-        pagination: IPagination;
-    }
-
-    export interface IListTaxonomiesAllResponse<TaxonomyCodename extends string> extends IKontentListAllResponse {
-        items: ITaxonomyGroup<TaxonomyCodename>[];
-        responses: IDeliveryNetworkResponse<
-            IListTaxonomiesResponse<TaxonomyCodename>,
-            Contracts.IListTaxonomyGroupsContract
-        >[];
-    }
-}

package/lib/models/sync-models.ts

@@ -1,18 +0,0 @@
-import { Contracts } from '../contracts';
-import { IQueryConfig } from './common/common-models';
-import { IContentItemSystemAttributes } from './item-models';
-
-export interface ISyncInitQueryConfig extends IQueryConfig {
-    /**
-     * No dedicated properties required at this moment
-     */
-}
-
-export interface IContentItemDelta {
-    data: {
-        system: IContentItemSystemAttributes;
-        elements: Contracts.IContentItemElementsContracts;
-    };
-    changeType: 'deleted_item' | 'changed_item';
-    timestamp: string;
-}

package/lib/models/taxonomy-models.ts

@@ -1,25 +0,0 @@
-import { IQueryConfig } from './common/common-models';
-
-export interface ITaxonomyGroup<TaxonomyCodename extends string> {
-    system: ITaxonomySystemAttributes<TaxonomyCodename>;
-    terms: ITaxonomyTerms[];
-}
-
-export interface ITaxonomySystemAttributes<TaxonomyCodename extends string> {
-    id: string;
-    name: string;
-    codename: TaxonomyCodename;
-    lastModified: Date;
-}
-
-export interface ITaxonomyTerms {
-    name: string;
-    codename: string;
-    terms: ITaxonomyTerms[];
-}
-
-export interface ITaxonomyQueryConfig extends IQueryConfig {
-    /**
-     * No dedicated properties required at this moment
-     */
-}

package/lib/query/common/base-item-listing-query.class.ts

@@ -1,274 +0,0 @@
-import { ElementType, Elements } from '../../elements';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    ClientTypes,
-    Filters,
-    IContentItem,
-    IKontentListAllResponse,
-    IKontentListResponse,
-    IQueryConfig,
-    Parameters,
-    SortOrder
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseListingQuery } from './base-listing-query.class';
-
-export abstract class BaseItemListingQuery<
-    TClientTypes extends ClientTypes,
-    TResponse extends IKontentListResponse,
-    TAllResponse extends IKontentListAllResponse,
-    TQueryConfig extends IQueryConfig,
-    TContract
-> extends BaseListingQuery<TClientTypes, IContentItem, TResponse, TAllResponse, TQueryConfig, TContract> {
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Empty filter condition
-     * @param element Element with empty value
-     */
-    emptyFilter(element: string): this {
-        this.parameters.push(new Filters.EmptyFilter(element));
-        return this;
-    }
-
-    /**
-     * Not empty filter condition
-     * @param element Element with non-empty value
-     */
-    notEmptyFilter(element: string): this {
-        this.parameters.push(new Filters.NotEmptyFilter(element));
-        return this;
-    }
-
-    /**
-     * Equals filter condition
-     * @param element Element to filter. Example: 'elements.movie'
-     * @param value Value to match. Example: 'Kingsman'
-     */
-    equalsFilter(element: string, value: string): this {
-        this.parameters.push(new Filters.EqualsFilter(element, value));
-        return this;
-    }
-
-    /**
-     * Not equals filter condition
-     * @param element Element to filter. Example: 'elements.movie'
-     * @param value Value to match. Example: 'Kingsman'
-     */
-    notEqualsFilter(element: string, value: string): this {
-        this.parameters.push(new Filters.NotEqualsFilter(element, value));
-        return this;
-    }
-
-    /**
-     * All filter
-     * @param element Element to filter.
-     * @param values Values
-     */
-    allFilter(element: string, values: string[]): this {
-        this.parameters.push(new Filters.AllFilter(element, values));
-        return this;
-    }
-
-    /**
-     * Any filter
-     * @param element Element to filter.
-     * @param values Values
-     */
-    anyFilter(element: string, values: string[]): this {
-        this.parameters.push(new Filters.AnyFilter(element, values));
-        return this;
-    }
-
-    /**
-     * Contains filter
-     * @param element Element to filter.
-     * @param values Values
-     */
-    containsFilter(element: string, values: string[]): this {
-        this.parameters.push(new Filters.ContainsFilter(element, values));
-        return this;
-    }
-
-    /**
-     * Greater then filter
-     * @param element Element to filter.
-     * @param value Value
-     */
-    greaterThanFilter(element: string, value: string | number): this {
-        this.parameters.push(new Filters.GreaterThanFilter(element, value));
-        return this;
-    }
-
-    /**
-     * Greater then or equals filter
-     * @param element Element to filter.
-     * @param value Value
-     */
-    greaterThanOrEqualFilter(element: string, value: string | number): this {
-        this.parameters.push(new Filters.GreaterThanOrEqualFilter(element, value));
-        return this;
-    }
-
-    /**
-     * In filter
-     * @param element Element to filter.
-     * @param values Values
-     */
-    inFilter(element: string, values: string[]): this {
-        this.parameters.push(new Filters.InFilter(element, values));
-        return this;
-    }
-
-    /**
-     * Not in filter
-     * @param element Element to filter.
-     * @param values Values
-     */
-    notInFilter(element: string, values: string[]): this {
-        this.parameters.push(new Filters.NotInFilter(element, values));
-        return this;
-    }
-
-    /**
-     * Less then filter
-     * @param element Element to filter.
-     * @param value Value
-     */
-    lessThanFilter(element: string, value: string | number): this {
-        this.parameters.push(new Filters.LessThanFilter(element, value));
-        return this;
-    }
-
-    /**
-     * @param element Element to filter.
-     * @param value Value
-     */
-    lessThanOrEqualFilter(element: string, value: string | number): this {
-        this.parameters.push(new Filters.LessThanOrEqualFilter(element, value));
-        return this;
-    }
-
-    /**
-     * @param element Element to filter.
-     * @param lowerValue Lower value of range (e.g. 2)
-     * @param higherValue Higher value of range (e.g. 10)
-     */
-    rangeFilter(element: string, lowerValue: number | string, higherValue: number | string): this {
-        this.parameters.push(new Filters.RangeFilter(element, lowerValue, higherValue));
-        return this;
-    }
-
-    /**
-     * Limits the number of items returned by query
-     * @param limit Number of items to load
-     */
-    limitParameter(limit: number): this {
-        this.parameters.push(new Parameters.LimitParameter(limit));
-        return this;
-    }
-
-    /**
-     * Orders query based on given element and sort order
-     * @param element Element by which to order
-     * @param sortOrder Asc/Desc order type
-     */
-    orderParameter(element: string, sortOrder: SortOrder): this {
-        this.parameters.push(new Parameters.OrderParameter(element, sortOrder));
-        return this;
-    }
-
-    /**
-     * Sets descending order on given element
-     * @param element Element by which to order
-     */
-    orderByDescending(element: string): this {
-        this.parameters.push(new Parameters.OrderParameter(element, 'desc'));
-        return this;
-    }
-
-    /**
-     * Sets Ascending order on given element
-     * @param element Element by which to order
-     */
-    orderByAscending(element: string): this {
-        this.parameters.push(new Parameters.OrderParameter(element, 'asc'));
-        return this;
-    }
-
-    /**
-     * Skips the selected number of items
-     * @param skip Number of items to skip
-     */
-    skipParameter(skip: number): this {
-        this.parameters.push(new Parameters.SkipParameter(skip));
-        return this;
-    }
-
-    protected linkItemsInRte(allContentItems: IContentItem[]): void {
-        for (const item of allContentItems) {
-            for (const elementKey of Object.keys(item.elements)) {
-                const element = item.elements[elementKey];
-
-                if (element.type === ElementType.ModularContent) {
-                    const linkedItemElement = element as Elements.LinkedItemsElement;
-
-                    // We create separate array for ordered items because the 'linkedItems' from response might be incomplete
-                    // e.g. If 4 items are linked, only 2 might be available in the response. Rest needs to be mapped from all available items
-                    const orderedLinkedItems: IContentItem[] = [];
-
-                    for (const linkedItemCodename of linkedItemElement.value) {
-                        let linkedItem: IContentItem | undefined;
-
-                        const linkedItemInElement = linkedItemElement.linkedItems.find(
-                            (m) => m.system.codename.toLowerCase() === linkedItemCodename.toLowerCase()
-                        );
-                        if (linkedItemInElement) {
-                            linkedItem = linkedItemInElement;
-                        } else {
-                            linkedItem = allContentItems.find(
-                                (m) => m.system.codename.toLowerCase() === linkedItemCodename.toLowerCase()
-                            );
-                        }
-
-                        if (linkedItem) {
-                            orderedLinkedItems.push(linkedItem);
-                        }
-                    }
-
-                    // Replace linked items with the ordered one
-                    linkedItemElement.linkedItems = orderedLinkedItems;
-                }
-
-                if (element.type === ElementType.RichText) {
-                    const orderedLinkedItems: IContentItem[] = [];
-
-                    const richTextElement = element as Elements.RichTextElement;
-
-                    for (const linkedItemCodename of richTextElement.linkedItemCodenames) {
-                        let linkedItem: IContentItem | undefined;
-
-                        const linkedItemInElement = richTextElement.linkedItems.find(
-                            (m) => m.system.codename.toLowerCase() === linkedItemCodename.toLowerCase()
-                        );
-                        if (linkedItemInElement) {
-                            linkedItem = linkedItemInElement;
-                        } else {
-                            linkedItem = allContentItems.find(
-                                (m) => m.system.codename.toLowerCase() === linkedItemCodename.toLowerCase()
-                            );
-                        }
-
-                        if (linkedItem) {
-                            orderedLinkedItems.push(linkedItem);
-                        }
-                    }
-
-                    richTextElement.linkedItems = orderedLinkedItems;
-                }
-            }
-        }
-    }
-}