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

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

@@ -1,95 +0,0 @@
-import { IDeliveryClientConfig } from '../../config';
-import {
-    continuationTokenHeaderName,
-    IGroupedNetworkResponse,
-    IKontentListAllResponse,
-    IKontentListResponse,
-    IDeliveryNetworkResponse,
-    IListAllQueryConfig,
-    IQueryConfig,
-    IContentItem,
-    ClientTypes,
-    IUsedInItemRecord,
-    IContentType,
-    ITaxonomyGroup,
-    IContentItemDelta,
-    ILanguage
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseQuery } from './base-query.class';
-
-type ListingRecord<TClientTypes extends ClientTypes> =
-    | IContentItem
-    | IContentItemDelta
-    | IUsedInItemRecord<TClientTypes>
-    | IContentType<TClientTypes['contentTypeCodenames']>
-    | ILanguage<TClientTypes['languageCodenames']>
-    | ITaxonomyGroup<TClientTypes['taxonomyCodenames']>;
-
-export abstract class BaseListingQuery<
-    TClientTypes extends ClientTypes,
-    TRecord extends ListingRecord<TClientTypes>,
-    TResponse extends IKontentListResponse,
-    TAllResponse extends IKontentListAllResponse,
-    TQueryConfig extends IQueryConfig,
-    TContract
-> extends BaseQuery<TClientTypes, TResponse, TQueryConfig, TContract> {
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Sets continuation token header
-     */
-    withContinuationToken(token: string): this {
-        // remove previous continuation token if there is any
-        let queryHeaders = this._queryConfig.customHeaders ?? [];
-        queryHeaders = queryHeaders.filter((m) => m.header !== continuationTokenHeaderName);
-
-        this._queryConfig.customHeaders = queryHeaders;
-
-        this.withHeaders([
-            {
-                header: continuationTokenHeaderName,
-                value: token
-            }
-        ]);
-
-        return this;
-    }
-
-    /**
-     * Query to get all items. Uses paging data and may execute multiple HTTP requests depending on number of items
-     */
-    toAllPromise(
-        queryAllConfig?: IListAllQueryConfig<TResponse, TContract>
-    ): Promise<IGroupedNetworkResponse<TAllResponse>> {
-        return this.queryService.getListAllResponse<TResponse, TAllResponse, TContract>({
-            page: 1,
-            listQueryConfig: queryAllConfig,
-            allResponseFactory: (items, responses) => {
-                const response = this.allResponseFactory(items, responses);
-
-                return {
-                    data: response,
-                    responses: responses
-                };
-            },
-            getResponse: (nextPageUrl, continuationToken) => {
-                if (nextPageUrl) {
-                    this.withCustomUrl(nextPageUrl);
-                }
-                if (continuationToken) {
-                    this.withContinuationToken(continuationToken);
-                }
-
-                return this.toPromise();
-            }
-        });
-    }
-
-    protected abstract allResponseFactory(
-        items: TRecord[],
-        responses: IDeliveryNetworkResponse<TResponse, TContract>[]
-    ): TAllResponse;
-}

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

@@ -1,148 +0,0 @@
-import { IHeader, IQueryParameter } from '@kontent-ai/core-sdk';
-
-import { IDeliveryClientConfig } from '../../config';
-import {
-    ClientTypes,
-    Filters,
-    IDeliveryNetworkResponse,
-    IKontentResponse,
-    IQueryConfig,
-    Parameters
-} from '../../models';
-import { QueryService } from '../../services';
-
-export abstract class BaseQuery<
-    TClientTypes extends ClientTypes,
-    TResponse extends IKontentResponse,
-    TQueryConfig extends IQueryConfig,
-    TContract
-> {
-    protected parameters: IQueryParameter[] = [];
-    protected customUrl?: string;
-    protected abstract _queryConfig: TQueryConfig;
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {}
-
-    /**
-     * Gets URL of the query
-     */
-    abstract getUrl(): string;
-
-    /**
-     * Gets promise for query execution
-     */
-    abstract toPromise(): Promise<IDeliveryNetworkResponse<TResponse, TContract>>;
-
-    /**
-     * Maps json data to response
-     */
-    abstract map(json: any): TResponse;
-
-    /**
-     * Adds custom parameter to query
-     * @param name Name of parameter
-     * @param value Value of parameter
-     */
-    withCustomParameter(name: string, value: string): this {
-        this.parameters.push(new Parameters.QueryParameter(name, value));
-        return this;
-    }
-
-    /**
-     * Adds parameter to query
-     * @param name Name of parameter
-     * @param value Value of parameter
-     */
-    withParameter(parameter: IQueryParameter): this {
-        this.parameters.push(parameter);
-        return this;
-    }
-
-    /**
-     * Adds parameters to query
-     * @param parameters Array of parameters
-     */
-    withParameters(parameters: IQueryParameter[]): this {
-        this.parameters.push(...parameters);
-        return this;
-    }
-
-    /**
-     * Gets headers used by this query
-     */
-    getHeaders(): IHeader[] {
-        return this.queryService.getHeaders(this._queryConfig, []);
-    }
-
-    /**
-     * Sets request headers
-     */
-    withHeaders(headers: IHeader[]): this {
-        const queryHeaders = this._queryConfig.customHeaders ?? [];
-        queryHeaders.push(...headers);
-        this._queryConfig.customHeaders = queryHeaders;
-        return this;
-    }
-
-    /**
-     * Sets request header
-     */
-    withHeader(header: IHeader): this {
-        const queryHeaders = this._queryConfig.customHeaders ?? [];
-        queryHeaders.push(header);
-        this._queryConfig.customHeaders = queryHeaders;
-        return this;
-    }
-
-    /**
-     * Sets custom URL of request (overrides default URL of the query)
-     */
-    withCustomUrl(url: string): this {
-        this.customUrl = url;
-        return this;
-    }
-
-    /**
-     * Gets all query parameter currently applied to query
-     */
-    getParameters(): IQueryParameter[] {
-        return this.parameters;
-    }
-
-    /**
-     * Used to configure query
-     * @param queryConfig Query configuration
-     */
-    queryConfig(queryConfig: TQueryConfig): this {
-        this._queryConfig = queryConfig;
-        return this;
-    }
-
-    protected resolveUrlInternal(action: string): string {
-        // use custom URL if user specified it
-        if (this.customUrl) {
-            return this.customUrl;
-        }
-
-        // use original url
-        return this.queryService.getUrl(action, this._queryConfig ?? {}, this.getParameters());
-    }
-
-    protected processDefaultLanguageParameter(): void {
-        // add default language if none is specified && default language is specified globally
-        if (this.config.defaultLanguage) {
-            const languageParameter = this.getParameters().find((m) =>
-                m.getParam()?.toLowerCase().includes('language='.toLowerCase())
-            );
-            if (!languageParameter) {
-                // language parameter was not specified in query, use globally defined language
-                this.parameters.push(new Parameters.LanguageParameter(this.config.defaultLanguage));
-            }
-        }
-    }
-
-    protected processExcludeArchivedItemsParameter(): void {
-        if (this.config.excludeArchivedItems) {
-            this.parameters.push(new Filters.NotEqualsFilter('system.workflow_step', 'archived'));
-        }
-    }
-}

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

@@ -1,45 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import { Responses, IElementQueryConfig, IDeliveryNetworkResponse, ClientTypes } from '../../models';
-import { QueryService } from '../../services';
-import { BaseQuery } from '../common/base-query.class';
-
-export class ElementQuery<TClientTypes extends ClientTypes> extends BaseQuery<
-    TClientTypes,
-    Responses.IViewContentTypeElementResponse,
-    IElementQueryConfig,
-    Contracts.IViewContentTypeElementContract
-> {
-    protected _queryConfig: IElementQueryConfig = {};
-
-    constructor(
-        protected config: IDeliveryClientConfig,
-        protected queryService: QueryService<TClientTypes>,
-        private typeCodename: string,
-        private elementCodename: string
-    ) {
-        super(config, queryService);
-
-        if (!typeCodename) {
-            throw Error(`Codename of the type has to be provided`);
-        }
-
-        if (!elementCodename) {
-            throw Error(`Codename of the element has to be provided`);
-        }
-    }
-
-    toPromise(): Promise<
-        IDeliveryNetworkResponse<Responses.IViewContentTypeElementResponse, Contracts.IViewContentTypeElementContract>
-    > {
-        return this.queryService.getElementAsync(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        return super.resolveUrlInternal(`/types/${this.typeCodename}/elements/${this.elementCodename}`);
-    }
-
-    map(json: any): Responses.IViewContentTypeElementResponse {
-        return this.queryService.mappingService.viewContentTypeElementResponse(json);
-    }
-}

package/lib/query/index.ts

@@ -1,13 +0,0 @@
-export * from './common/base-query.class';
-export * from './element/element-query.class';
-export * from './item/multiple-items-query.class';
-export * from './item/single-item-query.class';
-export * from './taxonomy/taxonomies-query.class';
-export * from './taxonomy/taxonomy-query.class';
-export * from './type/multiple-type-query.class';
-export * from './type/single-type-query.class';
-export * from './items-feed/items-feed-query.class';
-export * from './language/languages-query.class';
-export * from './sync/initialize-sync-query.class';
-export * from './sync/sync-changes-query.class';
-export * from './used-in/used-in-query.class';

package/lib/query/item/multiple-items-query.class.ts

@@ -1,183 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    Filters,
-    IContentItem,
-    IItemQueryConfig,
-    IDeliveryNetworkResponse,
-    Responses,
-    Parameters,
-    ClientTypes
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseItemListingQuery } from '../common/base-item-listing-query.class';
-
-export class MultipleItemsQuery<
-    TClientTypes extends ClientTypes,
-    TContentItem extends IContentItem = IContentItem
-> extends BaseItemListingQuery<
-    TClientTypes,
-    Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
-    Responses.IListContentItemsAllResponse<TContentItem, TClientTypes['contentItemType']>,
-    IItemQueryConfig,
-    Contracts.IListContentItemsContract
-> {
-    protected _queryConfig: IItemQueryConfig = {};
-
-    constructor(protected config: IDeliveryClientConfig, protected queryService: QueryService<TClientTypes>) {
-        super(config, queryService);
-    }
-
-    /**
-     * Adds information about the total number of content items matching your query.
-     * When set to true, the pagination object returned in the API response contains
-     * an additional total_count property.
-     */
-    includeTotalCountParameter(): this {
-        this.parameters.push(new Parameters.IncludeTotalCountParameter());
-        return this;
-    }
-
-    /**
-     * 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;
-    }
-
-    /**
-     * Indicates depth of query that affects loading of nested linked items.
-     * @param depth Depth of the query (> 0)
-     */
-    depthParameter(depth: number): this {
-        this.parameters.push(new Parameters.DepthParameter(depth));
-        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.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
-            Contracts.IListContentItemsContract
-        >
-    > {
-        return this.queryService.getMultipleItems(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/items';
-
-        // handle default language
-        this.processDefaultLanguageParameter();
-
-        // handle archived items
-        this.processExcludeArchivedItemsParameter();
-
-        return super.resolveUrlInternal(action);
-    }
-
-    map(json: any): Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']> {
-        return this.queryService.mappingService.listContentItemsResponse(json);
-    }
-
-    protected allResponseFactory(
-        items: any[],
-        responses: IDeliveryNetworkResponse<
-            Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
-            Contracts.IListContentItemsContract
-        >[]
-    ): Responses.IListContentItemsAllResponse<TContentItem, TClientTypes['contentItemType']> {
-        this.linkItems(items, responses);
-
-        return {
-            items: items,
-            responses: responses
-        };
-    }
-
-    private linkItems(
-        items: IContentItem[],
-        responses: IDeliveryNetworkResponse<
-            Responses.IListContentItemsResponse<TContentItem, TClientTypes['contentItemType']>,
-            Contracts.IListContentItemsContract
-        >[]
-    ): void {
-        // prepare all available items (including components) for linking
-        const allContentItems: IContentItem[] = [];
-
-        // process linked items (modular_content part of the response)
-        for (const response of responses) {
-            allContentItems.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 (!allContentItems.find((m) => m.system.codename.toLowerCase() === item.system.codename.toLowerCase())) {
-                allContentItems.push(item);
-            }
-        }
-        // process main items
-        this.linkItemsInRte(allContentItems);
-    }
-}

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

@@ -1,106 +0,0 @@
-import { Contracts } from '../../contracts';
-import { IDeliveryClientConfig } from '../../config';
-import {
-    IContentItem,
-    IItemQueryConfig,
-    IDeliveryNetworkResponse,
-    Responses,
-    Parameters,
-    ClientTypes
-} from '../../models';
-import { QueryService } from '../../services';
-import { BaseQuery } from '../common/base-query.class';
-
-export class SingleItemQuery<
-    TClientTypes extends ClientTypes,
-    TContentItem extends IContentItem = IContentItem
-> extends BaseQuery<
-    TClientTypes,
-    Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']>,
-    IItemQueryConfig,
-    Contracts.IViewContentItemContract
-> {
-    protected _queryConfig: IItemQueryConfig = {};
-
-    constructor(
-        protected config: IDeliveryClientConfig,
-        protected queryService: QueryService<TClientTypes>,
-        private codename: string
-    ) {
-        super(config, queryService);
-
-        if (!codename) {
-            throw Error(`'codename' has to be configured for 'SingleItemQuery' query`);
-        }
-    }
-
-    /**
-     * Indicates depth of query that affects loading of nested linked items.
-     * @param depth Depth of the query (> 0)
-     */
-    depthParameter(depth: number): this {
-        this.parameters.push(new Parameters.DepthParameter(depth));
-        return this;
-    }
-
-    /**
-     * Used to configure query
-     * @param queryConfig Query configuration
-     */
-    queryConfig(queryConfig: IItemQueryConfig): this {
-        this._queryConfig = queryConfig;
-        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.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']>,
-            Contracts.IViewContentItemContract
-        >
-    > {
-        return this.queryService.getSingleItemAsync(this.getUrl(), this._queryConfig ?? {});
-    }
-
-    getUrl(): string {
-        const action = '/items/' + this.codename;
-
-        // add default language is necessry
-        this.processDefaultLanguageParameter();
-
-        //process client level archived item exclusion
-        this.processExcludeArchivedItemsParameter();
-
-        return super.resolveUrlInternal(action);
-    }
-
-    map(json: any): Responses.IViewContentItemResponse<TContentItem, TClientTypes['contentItemType']> {
-        return this.queryService.mappingService.viewContentItemResponse(json);
-    }
-}