@kontent-ai/delivery-sdk 12.0.0-0

package/lib/mappers/language.mapper.ts

@@ -0,0 +1,20 @@
+import { Contracts } from '../contracts';
+import { ILanguage } from '../models';
+
+export class LanguageMapper {
+    mapMultipleLanguages(response: Contracts.IListLanguagesContract): ILanguage[] {
+        return response.languages.map((language) => {
+            return this.mapLanguage(language);
+        });
+    }
+
+    private mapLanguage(language: Contracts.ILanguageContract): ILanguage {
+        if (!language) {
+            throw Error(`Cannot map language`);
+        }
+
+        return {
+            system: language.system
+        };
+    }
+}

package/lib/mappers/taxonomy.mapper.ts

@@ -0,0 +1,77 @@
+import { Contracts } from '../contracts';
+import { ITaxonomyGroup, ITaxonomySystemAttributes, ITaxonomyTerms } from '../models';
+
+export class TaxonomyMapper {
+    mapTaxonomy(
+        taxonomySystem: Contracts.ITaxonomySystemAttributesContract,
+        taxonomyTerms: Contracts.ITaxonomyTermsContract[]
+    ): ITaxonomyGroup {
+        if (!taxonomySystem) {
+            throw Error(`Cannot map taxonomy due to missing 'system' property`);
+        }
+
+        if (!taxonomyTerms) {
+            throw Error(`Cannot map taxonomy due to missing 'terms' property`);
+        }
+
+        if (!Array.isArray(taxonomyTerms)) {
+            throw Error(`Cannot map terms because no terms array was provided`);
+        }
+
+        const mappedSystemAttributes: ITaxonomySystemAttributes = {
+            name: taxonomySystem.name,
+            codename: taxonomySystem.codename,
+            id: taxonomySystem.id,
+            lastModified: taxonomySystem.last_modified
+        };
+
+        const mappedTerms: ITaxonomyTerms[] = this.mapTaxonomyTerms(taxonomyTerms);
+
+        return {
+            system: mappedSystemAttributes,
+            terms: mappedTerms
+        };
+    }
+
+    mapTaxonomies(taxonomies: Contracts.ITaxonomyGroupContract[]): ITaxonomyGroup[] {
+        if (!taxonomies) {
+            throw Error(`Cannot map taxonomy due to missing 'taxonomies' property`);
+        }
+
+        if (!Array.isArray(taxonomies)) {
+            throw Error(`Cannot map taxonomies because the 'taxonomies' property is not an array `);
+        }
+
+        const mappedTaxonomies: ITaxonomyGroup[] = [];
+
+        taxonomies.forEach((taxonomy) => {
+            mappedTaxonomies.push(this.mapTaxonomy(taxonomy.system, taxonomy.terms));
+        });
+
+        return mappedTaxonomies;
+    }
+
+    /**
+     * Recursively map array of taxonomy terms
+     * @param termsArray Terms array to map
+     */
+    private mapTaxonomyTerms(termsArray: Contracts.ITaxonomyTermsContract[]): ITaxonomyTerms[] {
+        if (termsArray.length === 0) {
+            return [];
+        }
+
+        const mappedTermsArray: ITaxonomyTerms[] = [];
+
+        termsArray.forEach((terms) => {
+            const mappedTerms: ITaxonomyTerms = {
+                codename: terms.codename,
+                name: terms.name,
+                terms: this.mapTaxonomyTerms(terms.terms)
+            };
+
+            mappedTermsArray.push(mappedTerms);
+        });
+
+        return mappedTermsArray;
+    }
+}

package/lib/mappers/type.mapper.ts

@@ -0,0 +1,78 @@
+import { Contracts } from '../contracts';
+import { IContentType, IContentTypeSystemAttributes, IGenericElement } from '../models';
+
+export class TypeMapper {
+    mapSingleType(response: Contracts.IViewContentTypeContract): IContentType {
+        return this.mapType(response);
+    }
+
+    mapMultipleTypes(response: Contracts.IListContentTypeContract): IContentType[] {
+        const that = this;
+        return response.types.map(function (type) {
+            return that.mapType(type);
+        });
+    }
+
+    private mapType(type: Contracts.IContentTypeContract): IContentType {
+        if (!type) {
+            throw Error(`Cannot map type`);
+        }
+
+        if (!type.elements) {
+            throw Error(`Cannot map type elements`);
+        }
+
+        const system: IContentTypeSystemAttributes = {
+            codename: type.system.codename,
+            id: type.system.id,
+            name: type.system.name,
+            lastModified: type.system.last_modified
+        };
+
+        const elements: IGenericElement[] = [];
+
+        const elementNames = Object.getOwnPropertyNames(type.elements);
+        elementNames.forEach((elementName: string) => {
+            const typeElement = type.elements[elementName] as Contracts.IViewContentTypeElementContract;
+
+            if (!typeElement) {
+                throw Error(`Cannot find element '${elementName}' on type '${type}'`);
+            }
+
+            // use json property as a codename of the type element
+            const elementCodename = elementName;
+
+            // extra properties for certain element types
+            const taxonomyGroup: string | undefined = typeElement.taxonomy_group;
+            const options: Contracts.IElementOptionContract[] = [];
+
+            // some elements can contain options
+            const rawOptions = typeElement.options;
+            if (rawOptions) {
+                if (!Array.isArray(rawOptions)) {
+                    throw Error(`Content type 'options' property has to be an array`);
+                }
+
+                rawOptions.forEach((rawOption) => {
+                    options.push({
+                        codename: rawOption.codename,
+                        name: rawOption.name
+                    });
+                });
+            }
+
+            elements.push({
+                codename: elementCodename,
+                taxonomyGroup: taxonomyGroup,
+                options: options,
+                name: typeElement.name,
+                type: typeElement.type
+            });
+        });
+
+        return {
+            elements: elements,
+            system: system
+        };
+    }
+}

package/lib/models/common/base-responses.ts

@@ -0,0 +1,13 @@
+import { IResponse } from '@kontent-ai/core-sdk';
+
+export interface IDeliveryNetworkResponse<TData, TContract> {
+    data: TData;
+    response: IResponse<TContract>;
+    xContinuationToken?: string;
+    hasStaleContent: boolean;
+}
+
+export interface IGroupedNetworkResponse<TData> {
+    data: TData;
+    responses: IDeliveryNetworkResponse<any, any>[];
+}

package/lib/models/common/common-models.ts

@@ -0,0 +1,118 @@
+import { IHeader, IHttpCancelRequestToken, IQueryParameter } from '@kontent-ai/core-sdk';
+import { IDeliveryNetworkResponse } from './base-responses';
+import { IPagination } from './pagination.class';
+
+export type LinkedItemsReferenceHandler = 'map' | 'ignore';
+
+export interface IProxyUrlData {
+    action: string;
+    domain: string;
+    queryParameters: IQueryParameter[];
+    queryString: string;
+    queryConfig: IQueryConfig;
+    projectId: string;
+}
+
+export interface ISDKInfo {
+    /**
+     * Name of SDK
+     */
+    name: string;
+    /**
+     * Version SDK
+     */
+    version: string;
+    /**
+     * Host of SDK
+     */
+    host: string;
+}
+
+export interface IKontentResponse {}
+
+export interface IKontentListWithHeaderResponse extends IKontentResponse {
+    items: any[];
+}
+
+export interface IKontentListResponse extends IKontentResponse {
+    pagination?: IPagination;
+    items: any[];
+}
+
+export interface IKontentListAllResponse extends IKontentResponse {
+    responses: any[];
+    items: any[];
+}
+
+export interface IListAllQueryConfig<TResponse extends IKontentListResponse, TContract> {
+    /**
+     * Number of pages to get. If not set, all available pages are fetched.
+     */
+    pages?: number;
+
+    /**
+     * Delay between each HTTP requests
+     */
+    delayBetweenRequests?: number;
+
+    /**
+     * Executed when a list response is loaded
+     */
+    responseFetched?: (
+        response: IDeliveryNetworkResponse<TResponse, TContract>,
+        nextPageUrl?: string,
+        continuationToken?: string
+    ) => void;
+}
+
+export interface IQueryConfig {
+    /**
+     * Indicates if query should use preview mode. Overrides default configuration
+     */
+    usePreviewMode?: boolean;
+
+    /**
+     * Indicates if query should use secured delivery API mode.  Overrides default configuration
+     */
+    useSecuredMode?: boolean;
+
+    /**
+     * If the requested content has changed since the last request, the header determines whether
+     * to wait while fetching content. This can be useful when retrieving changed content
+     * in reaction to a webhook call. By default, when the header is not set, the API
+     * serves old content (if cached by the CDN) while it's fetching the new content
+     * to minimize wait time.
+     */
+    waitForLoadingNewContent?: boolean;
+
+    /**
+     * Extra headers added to request
+     */
+    customHeaders?: IHeader[];
+
+    /**
+     * Cancel token
+     */
+    cancelToken?: IHttpCancelRequestToken<any>;
+}
+
+export interface IDeliveryErrorRaw {
+    message: string;
+    request_id: string | null;
+    error_code: number;
+    specific_code: number;
+}
+
+export class DeliveryError {
+    public message: string;
+    public requestId: string | null;
+    public errorCode: number;
+    public specificCode: number;
+
+    constructor(data: { message: string; requestId: string | null; errorCode: number; specificCode: number }) {
+        this.message = data.message;
+        this.requestId = data.requestId;
+        this.errorCode = data.errorCode;
+        this.specificCode = data.specificCode;
+    }
+}

package/lib/models/common/filters.ts

@@ -0,0 +1,280 @@
+import { IQueryParameter } from '@kontent-ai/core-sdk';
+
+export namespace Filters {
+    const valueSeparator: string = ',';
+    const defaultValue: string = '';
+
+    const getParamValueForSystemFilter = (param: string | string[]): string | undefined => {
+        if (!param) {
+            return defaultValue;
+        }
+
+        if (Array.isArray(param)) {
+            let value = '';
+            // use [in] filter
+            for (let i = 0; i < param.length; i++) {
+                value = value + param[i].toString();
+
+                if (i !== param.length - 1) {
+                    // append separator if its not last item
+                    value = value + valueSeparator;
+                }
+            }
+
+            return value;
+        }
+
+        // single param was given
+        return param.toString();
+    };
+
+    export class TypeFilter implements IQueryParameter {
+        constructor(public type: string | string[]) {}
+
+        getParam(): string {
+            if (Array.isArray(this.type)) {
+                // multiple types
+                return `system.type[in]=${getParamValueForSystemFilter(this.type)}`;
+            }
+
+            // single type
+            return `system.type=${getParamValueForSystemFilter(this.type)}`;
+        }
+    }
+
+    export class CollectionFilter implements IQueryParameter {
+        constructor(public collection: string | string[]) {}
+
+        getParam(): string {
+            if (Array.isArray(this.collection)) {
+                // multiple collections
+                return `system.collection[in]=${getParamValueForSystemFilter(this.collection)}`;
+            }
+
+            // single collection
+            return `system.collection=${getParamValueForSystemFilter(this.collection)}`;
+        }
+    }
+
+    export class EmptyFilter implements IQueryParameter {
+        constructor(public element: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[empty]`;
+        }
+    }
+
+    export class NotEmptyFilter implements IQueryParameter {
+        constructor(public element: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[nempty]`;
+        }
+    }
+
+    export class EqualsFilter implements IQueryParameter {
+        constructor(public element: string, public value: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[eq]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.value) {
+                return defaultValue;
+            }
+
+            return this.value;
+        }
+    }
+
+    export class NotEqualsFilter implements IQueryParameter {
+        constructor(public element: string, public value: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[neq]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.value) {
+                return defaultValue;
+            }
+
+            return this.value;
+        }
+    }
+
+    export class AllFilter implements IQueryParameter {
+        constructor(public element: string, public values: string[]) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[all]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.values || !Array.isArray(this.values)) {
+                return defaultValue;
+            }
+
+            return this.values.map((m) => m.trim()).join(',');
+        }
+    }
+
+    export class AnyFilter implements IQueryParameter {
+        constructor(public element: string, public values: string[]) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[any]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.values || !Array.isArray(this.values)) {
+                return defaultValue;
+            }
+
+            return this.values.map((m) => m.trim()).join(',');
+        }
+    }
+
+    export class ContainsFilter implements IQueryParameter {
+        constructor(public element: string, public values: string[]) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[contains]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.values || !Array.isArray(this.values)) {
+                return defaultValue;
+            }
+
+            return this.values.map((m) => m.trim()).join(',');
+        }
+    }
+
+    export class GreaterThanFilter implements IQueryParameter {
+        constructor(public element: string, public value: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[gt]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.value) {
+                return defaultValue;
+            }
+
+            return this.value;
+        }
+    }
+
+    export class GreaterThanOrEqualFilter implements IQueryParameter {
+        constructor(public element: string, public value: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[gte]=${this.getParamValue()}`;
+        }
+
+        getParamValue(): string | undefined {
+            if (!this.value) {
+                return defaultValue;
+            }
+
+            return this.value;
+        }
+    }
+
+    export class InFilter implements IQueryParameter {
+        constructor(public element: string, public values: string[]) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[in]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.values || !Array.isArray(this.values)) {
+                return defaultValue;
+            }
+
+            return this.values
+                .map((m) => {
+                    return m.trim();
+                })
+                .join(',');
+        }
+    }
+
+    export class NotInFilter implements IQueryParameter {
+        constructor(public element: string, public values: string[]) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[nin]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.values || !Array.isArray(this.values)) {
+                return defaultValue;
+            }
+
+            return this.values
+                .map((m) => {
+                    return m.trim();
+                })
+                .join(',');
+        }
+    }
+
+    export class LessThanFilter implements IQueryParameter {
+        constructor(public element: string, public value: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[lt]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.value) {
+                return defaultValue;
+            }
+            return this.value;
+        }
+    }
+
+    export class LessThanOrEqualFilter implements IQueryParameter {
+        constructor(public element: string, public value: string) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[lte]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            if (!this.value) {
+                return defaultValue;
+            }
+
+            return this.value;
+        }
+    }
+
+    export class RangeFilter implements IQueryParameter {
+        constructor(public element: string, public lowerValue: number, public higherValue: number) {}
+
+        getParam(): string {
+            return `${this.element.trim()}[range]=${this.getParamValue()}`;
+        }
+
+        private getParamValue(): string | undefined {
+            let lowerVal = defaultValue;
+            let higherVal = defaultValue;
+
+            if (this.lowerValue) {
+                lowerVal = this.lowerValue.toString();
+            }
+
+            if (this.higherValue) {
+                higherVal = this.higherValue.toString();
+            }
+
+            return `${lowerVal},${higherVal}`;
+        }
+    }
+}

package/lib/models/common/headers.ts

@@ -0,0 +1,5 @@
+export const continuationTokenHeaderName: string = 'X-Continuation';
+export const waitForLoadingNewContentHeader: string = 'X-KC-Wait-For-Loading-New-Content';
+export const sdkVersionHeader: string = 'X-KC-SDKID';
+export const staleContentHeaderName: string = 'X-Stale-Content';
+

package/lib/models/common/index.ts

@@ -0,0 +1,7 @@
+export * from './filters';
+export * from './pagination.class';
+export * from './parameters';
+export * from './sort-order';
+export * from './common-models';
+export * from './base-responses';
+export * from './headers';

package/lib/models/common/pagination.class.ts

@@ -0,0 +1,7 @@
+export interface IPagination {
+    skip: number;
+    limit: number;
+    count: number;
+    nextPage: string;
+    totalCount: number | null;
+}