@kontent-ai/delivery-sdk 16.4.3 → 16.4.5

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

@@ -1,95 +1,95 @@
-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;
-}
+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 +1,148 @@
-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'));
-        }
-    }
-}
+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 +1,47 @@
-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);
-    }
-}
+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/${encodeURIComponent(this.typeCodename)}/elements/${encodeURIComponent(this.elementCodename)}`
+        );
+    }
+
+    map(json: any): Responses.IViewContentTypeElementResponse {
+        return this.queryService.mappingService.viewContentTypeElementResponse(json);
+    }
+}

package/lib/query/index.ts

@@ -1,13 +1,13 @@
-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';
+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';