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

package/lib/models/common/filters.ts

@@ -1,280 +0,0 @@
-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 | number) {}
-
-        getParam(): string {
-            return `${this.element.trim()}[gt]=${this.getParamValue()}`;
-        }
-
-        private getParamValue(): string | number | undefined {
-            if (!this.value) {
-                return defaultValue;
-            }
-
-            return this.value;
-        }
-    }
-
-    export class GreaterThanOrEqualFilter implements IQueryParameter {
-        constructor(public element: string, public value: string | number) {}
-
-        getParam(): string {
-            return `${this.element.trim()}[gte]=${this.getParamValue()}`;
-        }
-
-        getParamValue(): string | number | 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 | number) {}
-
-        getParam(): string {
-            return `${this.element.trim()}[lt]=${this.getParamValue()}`;
-        }
-
-        private getParamValue(): string | number | undefined {
-            if (!this.value) {
-                return defaultValue;
-            }
-            return this.value;
-        }
-    }
-
-    export class LessThanOrEqualFilter implements IQueryParameter {
-        constructor(public element: string, public value: string | number) {}
-
-        getParam(): string {
-            return `${this.element.trim()}[lte]=${this.getParamValue()}`;
-        }
-
-        private getParamValue(): string | number | undefined {
-            if (!this.value) {
-                return defaultValue;
-            }
-
-            return this.value;
-        }
-    }
-
-    export class RangeFilter implements IQueryParameter {
-        constructor(public element: string, public lowerValue: number | string, public higherValue: number | string) {}
-
-        getParam(): string {
-            return `${this.element.trim()}[range]=${this.getParamValue()}`;
-        }
-
-        private getParamValue(): string | number | 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

@@ -1,5 +0,0 @@
-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

@@ -1,7 +0,0 @@
-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

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

package/lib/models/common/parameters.ts

@@ -1,189 +0,0 @@
-import { IQueryParameter } from '@kontent-ai/core-sdk';
-
-import { SortOrder } from './sort-order';
-
-export namespace Parameters {
-    const defaultValue: string = '';
-
-    export class QueryParameter implements IQueryParameter {
-        /**
-         * Parameter
-         * @constructor
-         * @param {string} name - Name of the parameter
-         * @param {string} value - Value of the parameter
-         */
-        constructor(public name: string, public value: string) {
-            if (!name) {
-                throw Error(`Name of the parameter is not specified`);
-            }
-        }
-
-        getParam(): string {
-            return `${this.name}=${this.value}`;
-        }
-    }
-
-    export class ElementsParameter implements IQueryParameter {
-        /**
-         * Sets elements (projection) so that only certain elements from a content item are returned
-         * @constructor
-         * @param {string[]} elementCodenames - Array of element codenames to include in response.
-         */
-        constructor(public elementCodenames: string[]) {}
-
-        getParam(): string {
-            return `elements=${this.getParamValue()}`;
-        }
-
-        private getParamValue(): string | undefined {
-            if (!this.elementCodenames) {
-                return defaultValue;
-            }
-
-            return this.elementCodenames
-                .map((m) => {
-                    if (!m) {
-                        throw Error(`Codename of 'ElementsParameter' cannot be null or empty`);
-                    }
-                    return m.trim();
-                })
-                .join(',');
-        }
-    }
-
-    export class ExcludeElementsParameter implements IQueryParameter {
-        /**
-         * Sets elements (projection) so that only certain elements are excluded from API response
-         * @constructor
-         * @param {string[]} elementCodenames - Array of element codenames to exclude from API response.
-         */
-        constructor(public elementCodenames: string[]) {}
-
-        getParam(): string {
-            return `excludeElements=${this.getParamValue()}`;
-        }
-
-        private getParamValue(): string | undefined {
-            if (!this.elementCodenames) {
-                return defaultValue;
-            }
-
-            return this.elementCodenames
-                .map((m) => {
-                    if (!m) {
-                        throw Error(`Codename of 'ExcludeElementsParameter' cannot be null or empty`);
-                    }
-                    return m.trim();
-                })
-                .join(',');
-        }
-    }
-
-    export class LimitParameter implements IQueryParameter {
-        /**
-         * Limits the number of items that are returned from response
-         * @constructor
-         * @param {number} limit - Number of elements that will be returned
-         */
-        constructor(public limit: number) {
-            if (limit <= 0) {
-                throw Error(`'LimitParameter' must specify a positive integer`);
-            }
-        }
-
-        getParam(): string {
-            return `limit=${this.limit}`;
-        }
-    }
-
-    export class IncludeTotalCountParameter implements IQueryParameter {
-        /**
-         * Adds 'includeTotalCount' query parameter to query
-         * @constructor
-         */
-        constructor() {}
-
-        getParam(): string {
-            return `includeTotalCount=true`;
-        }
-    }
-
-    export class SkipParameter implements IQueryParameter {
-        /**
-         * Configures response to skip certain number of items
-         * @constructor
-         * @param {number} skip - Number of content items that will be skipped
-         */
-        constructor(public skip: number) {
-            if (skip < 0) {
-                throw Error(`'SkipParameter' must specify a positive integer number or zero."`);
-            }
-        }
-
-        getParam(): string {
-            return `skip=${this.skip}`;
-        }
-    }
-
-    export class OrderParameter implements IQueryParameter {
-        /**
-         * Sorts the response based on given element.
-         * @constructor
-         * @param {string} element - Element that will be used for sorting (can be both elements.<elementname> or system.<elementname>)
-         * @param {SortOrder} sortOrder - Order type (desc/asc). Defaults to 'asc' if SortOrder is null or invalid.
-         */
-        constructor(public element: string, public sortOrder: SortOrder) {
-            if (!element) {
-                throw Error(`Element specified in 'OrderParameter' is null or empty`);
-            }
-        }
-
-        getParam(): string {
-            return `order=${this.getParamValue()}`;
-        }
-
-        private getParamValue(): string | undefined {
-            return `${this.element.trim()}[${this.sortOrder}]`;
-        }
-    }
-
-    export class CustomParameter implements IQueryParameter {
-        constructor(public param: string) {}
-
-        getParam(): string {
-            return this.param;
-        }
-    }
-
-    export class DepthParameter implements IQueryParameter {
-        /**
-         * Configures the depth of the response. Content items might reference another 'linked items' using the Linked items element.
-         * Recursively, these linked items can reference another linked items.
-         * By default, only one level of linked content is returned.
-         * @constructor
-         * @param {number} depth - Depth fo the response
-         */
-        constructor(public depth: number) {
-            if (depth < 0) {
-                throw Error(`'DepthParameter' must specify a positive integer or zero`);
-            }
-        }
-
-        getParam(): string {
-            return `depth=${this.depth}`;
-        }
-    }
-
-    export class LanguageParameter implements IQueryParameter {
-        /**
-         * Specifies language version to fetch
-         * @constructor
-         * @param {string} languageCodename - Codename of the language
-         */
-        constructor(public languageCodename: string) {}
-
-        getParam(): string {
-            return `language=${this.languageCodename}`;
-        }
-    }
-}

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

@@ -1 +0,0 @@
-export type SortOrder = 'asc' | 'desc';

package/lib/models/content-type-models.ts

@@ -1,42 +0,0 @@
-import { IQueryConfig } from './common/common-models';
-import { IGenericElement } from './element-models';
-
-export interface IContentTypeSystemAttributes<TContentTypeCodename extends string> {
-    /**
-     * Id of the type
-     */
-    id: string;
-
-    /**
-     * Name of the type
-     */
-    name: string;
-
-    /**
-     * Codename of the type
-     */
-    codename: TContentTypeCodename;
-
-    /**
-     * Date of last modification
-     */
-    lastModified: Date;
-}
-
-export interface IContentType<TContentTypeCodename extends string> {
-    /**
-     * Content type system attributes
-     */
-    system: IContentTypeSystemAttributes<TContentTypeCodename>;
-
-    /**
-     * Elements (elements) assigned to content type
-     */
-    elements: IGenericElement[];
-}
-
-export interface IContentTypeQueryConfig extends IQueryConfig {
-    /**
-     * No dedicated properties required at this moment
-     */
-}

package/lib/models/element-models.ts

@@ -1,51 +0,0 @@
-import { IQueryConfig } from './common/common-models';
-
-export interface IElementQueryConfig extends IQueryConfig {
-    /**
-     * No dedicated properties required at this moment
-     */
-}
-
-export interface IGenericElementOption {
-    /**
-     * Name of the option
-     */
-    name: string;
-
-    /**
-     * Value of the option
-     */
-    codename: string;
-}
-
-export interface IGenericElement {
-    /**
-     * Indexer
-     */
-    [key: string]: any;
-
-    /**
-     * Codename of the element
-     */
-    codename?: string;
-
-    /**
-     * Type of the element
-     */
-    type: string;
-
-    /**
-     * Name of the element
-     */
-    name: string;
-
-    /**
-     * Taxonomy group in case the element is a taxonomy
-     */
-    taxonomyGroup?: string;
-
-    /**
-     * Array of options if the element has some
-     */
-    options: IGenericElementOption[];
-}

package/lib/models/index.ts

@@ -1,9 +0,0 @@
-export * from './common';
-export * from './element-models';
-export * from './item-models';
-export * from './taxonomy-models';
-export * from './content-type-models';
-export * from './language-models';
-export * from './responses';
-export * from './sync-models';
-