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

package/lib/query/items-feed/items-feed-query.class.ts

@@ -1,191 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    Filters,
-    IContentItem,
-    IDeliveryNetworkResponse,
-    Parameters,
-    Responses,
-    IItemFeedQueryConfig,
-    ClientTypes
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseItemListingQuery } from '../common/base-item-listing-query.class';
-
-export class ItemsFeedQuery<
-    TClientTypes extends ClientTypes,
-    TContentItem extends IContentItem = IContentItem
-> extends BaseItemListingQuery<
-    TClientTypes,
-    Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
-    Responses.IListItemsFeedAllResponse<TContentItem, TClientTypes['contentItemType']>,
-    IItemFeedQueryConfig,
-    Contracts.IItemsFeedContract
-> {
-    protected _queryConfig: IItemFeedQueryConfig = {};
-
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Gets only item of given type
-     * @param type Codename of type to get
-     */
-    type(type: TClientTypes['contentTypeCodenames']): this {
-        this.parameters.push(new Filters.TypeFilter(type));
-        return this;
-    }
-
-    /**
-     * Gets items of given types (logical or)
-     * I.e. get items of either 'Actor' or 'Movie' type
-     * @param types Types to get
-     */
-    types(types: TClientTypes['contentTypeCodenames'][]): this {
-        this.parameters.push(new Filters.TypeFilter(types));
-        return this;
-    }
-
-    /**
-     * Gets only item from given collection
-     * @param collection Codename of collection to get
-     */
-    collection(collection: TClientTypes['collectionCodenames']): this {
-        this.parameters.push(new Filters.CollectionFilter(collection));
-        return this;
-    }
-
-    /**
-     * Gets items from given collections (logical or)
-     * I.e. get items of either 'default' or 'christmas-campaign' collection
-     * @param collections Collections to get
-     */
-    collections(collections: TClientTypes['collectionCodenames'][]): this {
-        this.parameters.push(new Filters.CollectionFilter(collections));
-        return this;
-    }
-
-    /**
-     * Language codename
-     * @param languageCodename Codename of the language
-     */
-    languageParameter(languageCodename: TClientTypes['languageCodenames']): this {
-        this.parameters.push(new Parameters.LanguageParameter(languageCodename));
-        return this;
-    }
-
-    /**
-     * Used to limit the number of elements returned by query.
-     * @param elementCodenames Array of element codenames to fetch
-     */
-    elementsParameter(elementCodenames: TClientTypes['elementCodenames'][]): this {
-        this.parameters.push(new Parameters.ElementsParameter(elementCodenames));
-        return this;
-    }
-
-    /**
-     * Used to exclude elements returned by query.
-     * @param elementCodenames Array of element codenames to exclude
-     */
-    excludeElementsParameter(elementCodenames: TClientTypes['elementCodenames'][]): this {
-        this.parameters.push(new Parameters.ExcludeElementsParameter(elementCodenames));
-        return this;
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<
-            Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
-            Contracts.IItemsFeedContract
-        >
-    > {
-        return this.queryService.getItemsFeed(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/items-feed';
-
-        // add default language is necessary
-        this.processDefaultLanguageParameter();
-
-        //process client level archived item exclusion
-        this.processExcludeArchivedItemsParameter();
-
-        return super.resolveUrlInternal(action);
-    }
-
-    /**
-     * Used to configure query
-     * @param queryConfig Query configuration
-     */
-    queryConfig(queryConfig: IItemFeedQueryConfig): this {
-        this._queryConfig = queryConfig;
-        return this;
-    }
-
-    map(json: any): Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']> {
-        return this.queryService.mappingService.itemsFeedResponse(json);
-    }
-
-    protected allResponseFactory(
-        items: TContentItem[],
-        responses: IDeliveryNetworkResponse<
-            Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
-            Contracts.IItemsFeedContract
-        >[]
-    ): Responses.IListItemsFeedAllResponse<TContentItem, TClientTypes['contentItemType']> {
-        if (this.canLinkItems()) {
-            this.linkFeedItems(items, responses);
-        }
-
-        return {
-            items: items,
-            responses: responses
-        };
-    }
-
-    private linkFeedItems(
-        items: TContentItem[],
-        responses: IDeliveryNetworkResponse<
-            Responses.IListItemsFeedResponse<TContentItem, TClientTypes['contentItemType']>,
-            Contracts.IItemsFeedContract
-        >[]
-    ): void {
-        // prepare all available items (including components) for linking
-        const allAvailableContentItems: IContentItem[] = [];
-
-        // process linked items (modular_content part of the response)
-        for (const response of responses) {
-            allAvailableContentItems.push(
-                ...Object.values(response.data.linkedItems)
-                    .filter((m) => m !== undefined)
-                    .map((m) => m as TClientTypes['contentItemType'])
-            );
-        }
-
-        // add standard items
-        for (const item of items) {
-            if (
-                !allAvailableContentItems.find(
-                    (m) => m.system.codename.toLowerCase() === item.system.codename.toLowerCase()
-                )
-            ) {
-                allAvailableContentItems.push(item);
-            }
-        }
-        // process main items
-        this.linkItemsInRte(allAvailableContentItems);
-    }
-
-    private canLinkItems(): boolean {
-        if (this.config.linkedItemsReferenceHandler === 'ignore') {
-            return false;
-        }
-
-        if (this._queryConfig.disableItemLinking === true) {
-            return false;
-        }
-
-        return true;
-    }
-}

package/lib/query/language/languages-query.class.ts

@@ -1,91 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    ClientTypes,
-    IDeliveryNetworkResponse,
-    ILanguage,
-    ILanguagesQueryConfig,
-    Parameters,
-    Responses
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseListingQuery } from '../common/base-listing-query.class';
-
-export class LanguagesQuery<TClientTypes extends ClientTypes> extends BaseListingQuery<
-    TClientTypes,
-    ILanguage<TClientTypes['languageCodenames']>,
-    Responses.IListLanguagesResponse<TClientTypes['languageCodenames']>,
-    Responses.IListLanguagesAllResponse<TClientTypes['languageCodenames']>,
-    ILanguagesQueryConfig,
-    Contracts.IListLanguagesContract
-> {
-    /**
-     * Endpoint
-     */
-    protected readonly endpoint: string = 'languages';
-
-    protected _queryConfig: ILanguagesQueryConfig = {};
-
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Limits the number of taxonomies returned by query
-     * @param limit Number of taxonomies to load
-     */
-    limitParameter(limit: number): this {
-        this.parameters.push(new Parameters.LimitParameter(limit));
-        return this;
-    }
-
-    /**
-     * Skips the selected number of taxonomies
-     * @param skip Number of taxonomies to skip
-     */
-    skipParameter(skip: number): this {
-        this.parameters.push(new Parameters.SkipParameter(skip));
-        return this;
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<
-            Responses.IListLanguagesResponse<TClientTypes['languageCodenames']>,
-            Contracts.IListLanguagesContract
-        >
-    > {
-        return this.queryService.getLanguages(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/' + this.endpoint;
-
-        return super.resolveUrlInternal(action);
-    }
-
-    /**
-     * Used to configure query
-     * @param queryConfig Query configuration
-     */
-    queryConfig(queryConfig: ILanguagesQueryConfig): this {
-        this._queryConfig = queryConfig;
-        return this;
-    }
-
-    map(json: any): Responses.IListLanguagesResponse<TClientTypes['languageCodenames']> {
-        return this.queryService.mappingService.listLanguagesResponse(json);
-    }
-
-    protected allResponseFactory(
-        items: ILanguage<TClientTypes['languageCodenames']>[],
-        responses: IDeliveryNetworkResponse<
-            Responses.IListLanguagesResponse<TClientTypes['languageCodenames']>,
-            Contracts.IListLanguagesContract
-        >[]
-    ): Responses.IListLanguagesAllResponse<TClientTypes['languageCodenames']> {
-        return {
-            items: items,
-            responses: responses
-        };
-    }
-}

package/lib/query/sync/initialize-sync-query.class.ts

@@ -1,83 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    ClientTypes,
-    Filters,
-    IDeliveryNetworkResponse,
-    ILanguagesQueryConfig,
-    ISyncInitQueryConfig,
-    Parameters,
-    Responses
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseQuery } from '../common/base-query.class';
-
-export class InitializeSyncQuery<TClientTypes extends ClientTypes> extends BaseQuery<
-    TClientTypes,
-    Responses.IInitializeSyncResponse,
-    ISyncInitQueryConfig,
-    Contracts.IInitializeSyncContract
-> {
-    protected readonly endpoint: string = 'sync/init';
-
-    protected _queryConfig: ILanguagesQueryConfig = {};
-
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Gets only item of given type
-     * @param type Codename of type to get
-     */
-    type(type: string): this {
-        this.parameters.push(new Filters.TypeFilter(type));
-        return this;
-    }
-
-    /**
-     * Gets only item from given collection
-     * @param collection Codename of collection to get
-     */
-    collection(collection: string): this {
-        this.parameters.push(new Filters.CollectionFilter(collection));
-        return this;
-    }
-
-    /**
-     * Language codename
-     * @param languageCodename Codename of the language
-     */
-    languageParameter(languageCodename: string): this {
-        this.parameters.push(new Parameters.LanguageParameter(languageCodename));
-        return this;
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<Responses.IInitializeSyncResponse, Contracts.IInitializeSyncContract>
-    > {
-        console.warn(
-            `Sync Api v1 is deprecated. Please use the new Sync Api v2. https://kontent.ai/learn/docs/apis/openapi/sync-api-v2/`
-        );
-        return this.queryService.initializeSync(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/' + this.endpoint;
-
-        return super.resolveUrlInternal(action);
-    }
-
-    /**
-     * Used to configure query
-     * @param queryConfig Query configuration
-     */
-    queryConfig(queryConfig: ISyncInitQueryConfig): this {
-        this._queryConfig = queryConfig;
-        return this;
-    }
-
-    map(json: any): Responses.IInitializeSyncResponse {
-        return this.queryService.mappingService.initializeContentSync(json);
-    }
-}

package/lib/query/sync/sync-changes-query.class.ts

@@ -1,56 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import { IItemQueryConfig, IDeliveryNetworkResponse, Responses, ClientTypes, IContentItemDelta } from '../../models';
-import { QueryService } from '../../services';
-import { BaseListingQuery } from '../common/base-listing-query.class';
-
-export class SyncChangesQuery<TClientTypes extends ClientTypes> extends BaseListingQuery<
-    TClientTypes,
-    IContentItemDelta,
-    Responses.ISyncChangesResponse,
-    Responses.ISyncChangesAllResponse,
-    IItemQueryConfig,
-    Contracts.ISyncChangesContract
-> {
-    protected _queryConfig: IItemQueryConfig = {};
-
-    private readonly action: string = '/sync';
-
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    toPromise(): Promise<IDeliveryNetworkResponse<Responses.ISyncChangesResponse, Contracts.ISyncChangesContract>> {
-        console.warn(
-            `Sync Api v1 is deprecated. Please use the new Sync Api v2. https://kontent.ai/learn/docs/apis/openapi/sync-api-v2/`
-        );
-        return this.queryService.syncChanges(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        return super.resolveUrlInternal(this.action);
-    }
-
-    /**
-     * Used to configure query
-     * @param queryConfig Query configuration
-     */
-    queryConfig(queryConfig: IItemQueryConfig): this {
-        this._queryConfig = queryConfig;
-        return this;
-    }
-
-    map(json: any): Responses.ISyncChangesResponse {
-        return this.queryService.mappingService.syncChanges(json);
-    }
-
-    protected allResponseFactory(
-        items: IContentItemDelta[],
-        responses: IDeliveryNetworkResponse<Responses.ISyncChangesResponse, Contracts.ISyncChangesContract>[]
-    ): Responses.ISyncChangesAllResponse {
-        return {
-            items: items,
-            responses: responses
-        };
-    }
-}

package/lib/query/taxonomy/taxonomies-query.class.ts

@@ -1,82 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    ClientTypes,
-    IDeliveryNetworkResponse,
-    ITaxonomyGroup,
-    ITaxonomyQueryConfig,
-    Parameters,
-    Responses
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseListingQuery } from '../common/base-listing-query.class';
-
-export class TaxonomiesQuery<TClientTypes extends ClientTypes> extends BaseListingQuery<
-    TClientTypes,
-    ITaxonomyGroup<TClientTypes['taxonomyCodenames']>,
-    Responses.IListTaxonomiesResponse<TClientTypes['taxonomyCodenames']>,
-    Responses.IListTaxonomiesAllResponse<TClientTypes['taxonomyCodenames']>,
-    ITaxonomyQueryConfig,
-    Contracts.IListTaxonomyGroupsContract
-> {
-    /**
-     * Taxonomies endpoint URL action
-     */
-    protected readonly taxonomiesEndpoint: string = 'taxonomies';
-
-    protected _queryConfig: ITaxonomyQueryConfig = {};
-
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Limits the number of taxonomies returned by query
-     * @param limit Number of taxonomies to load
-     */
-    limitParameter(limit: number): this {
-        this.parameters.push(new Parameters.LimitParameter(limit));
-        return this;
-    }
-
-    /**
-     * Skips the selected number of taxonomies
-     * @param skip Number of taxonomies to skip
-     */
-    skipParameter(skip: number): this {
-        this.parameters.push(new Parameters.SkipParameter(skip));
-        return this;
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<
-            Responses.IListTaxonomiesResponse<TClientTypes['taxonomyCodenames']>,
-            Contracts.IListTaxonomyGroupsContract
-        >
-    > {
-        return this.queryService.getTaxonomies(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/' + this.taxonomiesEndpoint;
-
-        return super.resolveUrlInternal(action);
-    }
-
-    map(json: any): Responses.IListTaxonomiesResponse<TClientTypes['taxonomyCodenames']> {
-        return this.queryService.mappingService.listTaxonomiesResponse(json);
-    }
-
-    protected allResponseFactory(
-        items: ITaxonomyGroup<TClientTypes['taxonomyCodenames']>[],
-        responses: IDeliveryNetworkResponse<
-            Responses.IListTaxonomiesResponse<TClientTypes['taxonomyCodenames']>,
-            Contracts.IListTaxonomyGroupsContract
-        >[]
-    ): Responses.IListTaxonomiesAllResponse<TClientTypes['taxonomyCodenames']> {
-        return {
-            items: items,
-            responses: responses
-        };
-    }
-}

package/lib/query/taxonomy/taxonomy-query.class.ts

@@ -1,50 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import { ClientTypes, IDeliveryNetworkResponse, ITaxonomyQueryConfig, Responses } from '../../models';
-import { QueryService } from '../../services';
-import { BaseQuery } from '../common/base-query.class';
-
-export class TaxonomyQuery<TClientTypes extends ClientTypes> extends BaseQuery<
-    TClientTypes,
-    Responses.IViewTaxonomyResponse<TClientTypes['taxonomyCodenames']>,
-    ITaxonomyQueryConfig,
-    Contracts.IViewTaxonomyGroupContract
-> {
-    /**
-     * Taxonomies endpoint URL action
-     */
-    protected readonly taxonomiesEndpoint: string = 'taxonomies';
-
-    protected _queryConfig: ITaxonomyQueryConfig = {};
-
-    constructor(
-        protected config: IDeliveryClientConfig,
-        protected queryService: QueryService<TClientTypes>,
-        private taxonomyCodename: string
-    ) {
-        super(config, queryService);
-
-        if (!taxonomyCodename) {
-            throw Error(`Cannot create taxonomy query without codename of the taxonomy`);
-        }
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<
-            Responses.IViewTaxonomyResponse<TClientTypes['taxonomyCodenames']>,
-            Contracts.IViewTaxonomyGroupContract
-        >
-    > {
-        return this.queryService.getTaxonomy(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/' + this.taxonomiesEndpoint + '/' + this.taxonomyCodename;
-
-        return super.resolveUrlInternal(action);
-    }
-
-    map(json: any): Responses.IViewTaxonomyResponse<TClientTypes['taxonomyCodenames']> {
-        return this.queryService.mappingService.viewTaxonomyResponse(json);
-    }
-}

package/lib/query/type/multiple-type-query.class.ts

@@ -1,95 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    ClientTypes,
-    IContentType,
-    IContentTypeQueryConfig,
-    IDeliveryNetworkResponse,
-    Parameters,
-    Responses
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseListingQuery } from '../common/base-listing-query.class';
-
-export class MultipleTypeQuery<TClientTypes extends ClientTypes> extends BaseListingQuery<
-    TClientTypes,
-    IContentType<TClientTypes['contentTypeCodenames']>,
-    Responses.IListContentTypesResponse<TClientTypes['contentTypeCodenames']>,
-    Responses.IListContentTypesAllResponse<TClientTypes['contentTypeCodenames']>,
-    IContentTypeQueryConfig,
-    Contracts.IListContentTypeContract
-> {
-    protected _queryConfig: IContentTypeQueryConfig = {};
-
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Used to limit the number of elements returned by query.
-     * @param elementCodenames Array of element codenames to fetch
-     */
-    elementsParameter(elementCodenames: TClientTypes['elementCodenames'][]): this {
-        this.parameters.push(new Parameters.ElementsParameter(elementCodenames));
-        return this;
-    }
-
-    /**
-     * Used to exclude elements returned by query.
-     * @param elementCodenames Array of element codenames to exclude
-     */
-    excludeElementsParameter(elementCodenames: TClientTypes['elementCodenames'][]): this {
-        this.parameters.push(new Parameters.ExcludeElementsParameter(elementCodenames));
-        return this;
-    }
-
-    /**
-     * Limits the number of taxonomies returned by query
-     * @param limit Number of taxonomies to load
-     */
-    limitParameter(limit: number): this {
-        this.parameters.push(new Parameters.LimitParameter(limit));
-        return this;
-    }
-
-    /**
-     * Skips the selected number of taxonomies
-     * @param skip Number of taxonomies to skip
-     */
-    skipParameter(skip: number): this {
-        this.parameters.push(new Parameters.SkipParameter(skip));
-        return this;
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<
-            Responses.IListContentTypesResponse<TClientTypes['contentTypeCodenames']>,
-            Contracts.IListContentTypeContract
-        >
-    > {
-        return this.queryService.getMultipleTypes(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/types';
-
-        return super.resolveUrlInternal(action);
-    }
-
-    map(json: any): Responses.IListContentTypesResponse<TClientTypes['contentTypeCodenames']> {
-        return this.queryService.mappingService.listContentTypesResponse(json);
-    }
-
-    protected allResponseFactory(
-        items: IContentType<TClientTypes['contentTypeCodenames']>[],
-        responses: IDeliveryNetworkResponse<
-            Responses.IListContentTypesResponse<TClientTypes['contentTypeCodenames']>,
-            Contracts.IListContentTypeContract
-        >[]
-    ): Responses.IListContentTypesAllResponse<TClientTypes['contentTypeCodenames']> {
-        return {
-            items: items,
-            responses: responses
-        };
-    }
-}

package/lib/query/type/single-type-query.class.ts

@@ -1,45 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import { ClientTypes, IContentTypeQueryConfig, IDeliveryNetworkResponse, Responses } from '../../models';
-import { QueryService } from '../../services';
-import { BaseQuery } from '../common/base-query.class';
-
-export class SingleTypeQuery<TClientTypes extends ClientTypes> extends BaseQuery<
-    TClientTypes,
-    Responses.IViewContentTypeResponse<TClientTypes['contentTypeCodenames']>,
-    IContentTypeQueryConfig,
-    Contracts.IViewContentTypeContract
-> {
-    protected _queryConfig: IContentTypeQueryConfig = {};
-
-    constructor(
-        protected config: IDeliveryClientConfig,
-        protected queryService: QueryService<TClientTypes>,
-        private typeCodename: string
-    ) {
-        super(config, queryService);
-
-        if (!typeCodename) {
-            throw Error(`Cannot create type query without the codename of the type`);
-        }
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<
-            Responses.IViewContentTypeResponse<TClientTypes['contentTypeCodenames']>,
-            Contracts.IViewContentTypeContract
-        >
-    > {
-        return this.queryService.getSingleType(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/types/' + this.typeCodename;
-
-        return super.resolveUrlInternal(action);
-    }
-
-    map(json: any): Responses.IViewContentTypeResponse<TClientTypes['contentTypeCodenames']> {
-        return this.queryService.mappingService.viewContentTypeResponse(json);
-    }
-}