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

package/lib/client/delivery-client.ts

@@ -1,163 +0,0 @@
-import { HttpService } from '@kontent-ai/core-sdk';
-import { IDeliveryClientConfig } from '../config';
-import { ClientTypes, IContentItem } from '../models';
-import {
-    ElementQuery,
-    ItemsFeedQuery,
-    MultipleItemsQuery,
-    MultipleTypeQuery,
-    SingleItemQuery,
-    SingleTypeQuery,
-    TaxonomiesQuery,
-    TaxonomyQuery,
-    LanguagesQuery,
-    InitializeSyncQuery,
-    SyncChangesQuery,
-    UsedInQuery
-} from '../query';
-import { sdkInfo } from '../sdk-info.generated';
-import { IMappingService, MappingService, QueryService } from '../services';
-import { IDeliveryClient } from './idelivery-client.interface';
-
-export class DeliveryClient<TClientTypes extends ClientTypes = ClientTypes> implements IDeliveryClient {
-    private queryService: QueryService<TClientTypes>;
-    public mappingService: IMappingService<TClientTypes>;
-
-    /**
-     * Delivery client used to fetch data from Kontent.ai
-     * @constructor
-     * @param {IDeliveryClientConfig} config - The client configuration
-     */
-    constructor(protected config: IDeliveryClientConfig) {
-        if (!config) {
-            throw Error(`Delivery client configuration is not set`);
-        }
-
-        this.mappingService = new MappingService(config);
-        this.queryService = new QueryService(
-            config,
-            config.httpService ? config.httpService : new HttpService(),
-            {
-                host: sdkInfo.host,
-                name: sdkInfo.name,
-                version: sdkInfo.version
-            },
-            this.mappingService
-        );
-    }
-
-    /**
-     * Gets query for multiple languages
-     */
-    languages(): LanguagesQuery<TClientTypes> {
-        return new LanguagesQuery(this.config, this.queryService);
-    }
-
-    /**
-     * Gets query for multiple types
-     */
-    types(): MultipleTypeQuery<TClientTypes> {
-        return new MultipleTypeQuery(this.config, this.queryService);
-    }
-
-    /**
-     * Gets query for single type
-     * @param {string} typeCodename - Codename of the type to fetch
-     */
-    type(typeCodename: TClientTypes['contentTypeCodenames']): SingleTypeQuery<TClientTypes> {
-        return new SingleTypeQuery(this.config, this.queryService, typeCodename);
-    }
-
-    /**
-     * Gets query for multiple items
-     */
-    items<TContentItem extends IContentItem = TClientTypes['contentItemType']>(): MultipleItemsQuery<
-        TClientTypes,
-        TContentItem
-    > {
-        return new MultipleItemsQuery<TClientTypes, TContentItem>(this.config, this.queryService);
-    }
-
-    /**
-     * Gets query for single item
-     * @param {string} codename - Codename of item to fetch
-     */
-    item<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
-        codename: string
-    ): SingleItemQuery<TClientTypes, TContentItem> {
-        return new SingleItemQuery<TClientTypes, TContentItem>(this.config, this.queryService, codename);
-    }
-
-    /**
-     * Gets query for items feed. Executes single HTTP request only
-     */
-    itemsFeed<TContentItem extends IContentItem = TClientTypes['contentItemType']>(): ItemsFeedQuery<
-        TClientTypes,
-        TContentItem
-    > {
-        return new ItemsFeedQuery<TClientTypes, TContentItem>(this.config, this.queryService);
-    }
-
-    /**
-     * Gets query for single taxonomy
-     * @param {string} codename - Codename of taxonomy to fetch
-     */
-    taxonomy(codename: TClientTypes['taxonomyCodenames']): TaxonomyQuery<TClientTypes> {
-        return new TaxonomyQuery(this.config, this.queryService, codename);
-    }
-
-    /**
-     * Gets query for multiple taxonomies
-     */
-    taxonomies(): TaxonomiesQuery<TClientTypes> {
-        return new TaxonomiesQuery<TClientTypes>(this.config, this.queryService);
-    }
-
-    /**
-     * Gets query for an element within a type
-     * @param {string} typeCodename - Codename of the type
-     * @param {string} elementCodename - Codename of the element
-     */
-    element(
-        typeCodename: TClientTypes['contentTypeCodenames'],
-        elementCodename: TClientTypes['elementCodenames']
-    ): ElementQuery<TClientTypes> {
-        return new ElementQuery(this.config, this.queryService, typeCodename, elementCodename);
-    }
-
-    /**
-     * @deprecated Sync API v1 is deprecated and will be shut down by the end of this year.
-     * Please migrate to Sync API v2 using the `@kontent-ai/sync-sdk` package.
-     *
-     * For migration guidance and full documentation, visit:
-     * https://kontent.ai/learn/docs/apis/openapi/sync-api-v2/
-     */
-    initializeSync(): InitializeSyncQuery<TClientTypes> {
-        return new InitializeSyncQuery(this.config, this.queryService);
-    }
-
-    /**
-     * @deprecated Sync API v1 is deprecated and will be shut down by the end of this year.
-     * Please migrate to Sync API v2 using the `@kontent-ai/sync-sdk` package.
-     *
-     * For migration guidance and full documentation, visit:
-     * https://kontent.ai/learn/docs/apis/openapi/sync-api-v2/
-     */
-    syncChanges(): SyncChangesQuery<TClientTypes> {
-        return new SyncChangesQuery(this.config, this.queryService);
-    }
-
-    /**
-     * Item listing of where an asset is used
-     */
-    assetUsedIn(assetCodename: string): UsedInQuery<TClientTypes> {
-        return new UsedInQuery(this.config, this.queryService, { entity: 'asset', codename: assetCodename });
-    }
-
-    /**
-     * Item listing of where a content item is used
-     */
-    itemUsedIn(itemCodename: string): UsedInQuery<TClientTypes> {
-        return new UsedInQuery(this.config, this.queryService, { entity: 'contentItem', codename: itemCodename });
-    }
-}

package/lib/client/idelivery-client.interface.ts

@@ -1,110 +0,0 @@
-import { ClientTypes, IContentItem } from '../models';
-import {
-    ElementQuery,
-    ItemsFeedQuery,
-    MultipleItemsQuery,
-    MultipleTypeQuery,
-    SingleItemQuery,
-    SingleTypeQuery,
-    TaxonomiesQuery,
-    TaxonomyQuery,
-    LanguagesQuery,
-    InitializeSyncQuery,
-    SyncChangesQuery,
-    UsedInQuery
-} from '../query';
-import { IMappingService } from '../services';
-
-export interface IDeliveryClient<TClientTypes extends ClientTypes = ClientTypes> {
-    /**
-     * Mapping service - can be used to get strongly typed responses from json result
-     */
-    mappingService: IMappingService<TClientTypes>;
-
-    /**
-     * Gets query for languages
-     */
-    languages(): LanguagesQuery<TClientTypes>;
-
-    /**
-     * Gets query for multiple types
-     */
-    types(): MultipleTypeQuery<TClientTypes>;
-
-    /**
-     * Gets query for single type
-     * @param {string} typeCodename - Codename of the type to retrieve
-     */
-    type(typeCodename: TClientTypes['contentTypeCodenames']): SingleTypeQuery<TClientTypes>;
-
-    /**
-     * Gets query for multiple items
-     */
-    items<TContentItem extends IContentItem = TClientTypes['contentItemType']>(): MultipleItemsQuery<
-        TClientTypes,
-        TContentItem
-    >;
-
-    /**
-     * Gets query for items feed. Executes single HTTP request only
-     */
-    itemsFeed<TContentItem extends IContentItem = TClientTypes['contentItemType']>(): ItemsFeedQuery<
-        TClientTypes,
-        TContentItem
-    >;
-
-    /**
-     * Gets query for single item
-     * @param {string} codename - Codename of item to retrieve
-     */
-    item<TContentItem extends IContentItem = TClientTypes['contentItemType']>(
-        codename: string
-    ): SingleItemQuery<TClientTypes, TContentItem>;
-
-    /**
-     * Gets query for multiple taxonomies
-     */
-    taxonomies(): TaxonomiesQuery<TClientTypes>;
-
-    /**
-     * Gets query for single item
-     * @param {string} codename - Codename of taxonomy to retrieve
-     */
-    taxonomy(codename: TClientTypes['taxonomyCodenames']): TaxonomyQuery<TClientTypes>;
-
-    /**
-     * Gets query for an element within a type
-     */
-    element(
-        typeCodename: TClientTypes['contentTypeCodenames'],
-        elementCodename: TClientTypes['elementCodenames']
-    ): ElementQuery<TClientTypes>;
-
-    /**
-     * @deprecated Sync API v1 is deprecated and will be shut down by the end of this year.
-     * Please migrate to Sync API v2 using the `@kontent-ai/sync-sdk` package.
-     *
-     * For migration guidance and full documentation, visit:
-     * https://kontent.ai/learn/docs/apis/openapi/sync-api-v2/
-     */
-    initializeSync(): InitializeSyncQuery<TClientTypes>;
-
-    /**
-     * @deprecated Sync API v1 is deprecated and will be shut down by the end of this year.
-     * Please migrate to Sync API v2 using the `@kontent-ai/sync-sdk` package.
-     *
-     * For migration guidance and full documentation, visit:
-     * https://kontent.ai/learn/docs/apis/openapi/sync-api-v2/
-     */
-    syncChanges(): SyncChangesQuery<TClientTypes>;
-
-    /**
-     * Item listing of where an asset is used
-     */
-    assetUsedIn(assetCodename: string): UsedInQuery<TClientTypes>;
-
-    /**
-     * Item listing of where a content item is used
-     */
-    itemUsedIn(itemCodename: string): UsedInQuery<TClientTypes>;
-}

package/lib/client/index.ts

@@ -1,3 +0,0 @@
-export * from './delivery-client';
-export * from './idelivery-client.interface';
-export * from './delivery-client.factory';

package/lib/config/delivery-configs.ts

@@ -1,98 +0,0 @@
-import { IHeader, IHttpService, IRetryStrategyOptions } from '@kontent-ai/core-sdk';
-
-import { ElementResolver } from '../elements';
-import { IProxyUrlData, IQueryConfig, LinkedItemsReferenceHandler } from '../models';
-
-export interface IDeliveryClientProxyConfig {
-    /**
-     * Base url used for preview reqeusts. Defaults to 'preview-deliver.kontent.ai'
-     */
-    basePreviewUrl?: string;
-
-    /**
-     * Can be used to generate custom request urls.
-     * Useful when you have a proxy server and need to transform url to a specific format
-     * and setting 'baseUrl' is not sufficient.
-     */
-    advancedProxyUrlResolver?: (data: IProxyUrlData) => string;
-
-    /**
-     * Base url used for all requests. Defaults to 'deliver.kontent.ai'
-     */
-    baseUrl?: string;
-}
-
-export interface IDeliveryClientConfig {
-    /**
-     * EnvironmentId
-     */
-    environmentId: string;
-
-    /**
-     * Preview API key
-     */
-    previewApiKey?: string;
-
-    /**
-     * Secure API key
-     * Important: Use secured API only when running on Node.JS server, otherwise
-     * your key would be exposed in browsers
-     */
-    secureApiKey?: string;
-
-    /**
-     * Resolver used for using custom models for custom elements.
-     */
-    elementResolver?: ElementResolver;
-
-    /**
-     * Proxy configuration
-     */
-    proxy?: IDeliveryClientProxyConfig;
-
-    /**
-     * Default language of content items
-     */
-    defaultLanguage?: string;
-
-    /**
-     * Retry policy configuration
-     */
-    retryStrategy?: IRetryStrategyOptions;
-
-    /**
-     * Can be used to inject custom Http service to perform requests
-     */
-    httpService?: IHttpService<any>;
-
-    /**
-     * Extra headers added to each http request
-     */
-    globalHeaders?: (queryConfig: IQueryConfig) => IHeader[];
-
-    /**
-     * Default query configuration. Can be overriden by individual queries.
-     */
-    defaultQueryConfig?: IQueryConfig;
-
-    /**
-     * Indicates how linked item references are handled (can be used to disable refence mapping when you encounter an issue
-     * with circular refences)
-     */
-    linkedItemsReferenceHandler?: LinkedItemsReferenceHandler;
-
-    /**
-     * Sets custom domain for assets
-     */
-    assetsDomain?: string;
-
-    /**
-     * Codename of rendition preset to be applied by default to the base asset URL path.
-     */
-    defaultRenditionPreset?: string;
-
-    /**
-     * Can be used to exclude archived items from all queries by default. Only applicable when preview API is used
-     */
-    excludeArchivedItems?: boolean;
-}

package/lib/config/index.ts

@@ -1 +0,0 @@
-export * from './delivery-configs';

package/lib/contracts/contracts.ts

@@ -1,265 +0,0 @@
-export namespace Contracts {
-    export interface IPaginationContract {
-        skip: number;
-        limit: number;
-        count: number;
-        next_page: string;
-        total_count?: number;
-    }
-
-    export interface IContentTypeElementContract {
-        codename?: string;
-        type: string;
-        name: string;
-        taxonomy_group?: string;
-        options?: IElementOptionContract[];
-    }
-
-    export interface IContentTypeElementsContainer {
-        [key: string]: IContentTypeElementContract;
-    }
-
-    export interface IElementOptionContract {
-        name: string;
-        codename: string;
-    }
-
-    export interface IListLanguagesContract {
-        languages: ILanguageContract[];
-        pagination: IPaginationContract;
-    }
-
-    export interface IContentItemDeltaContract {
-        data: {
-            system: IContentItemSystemAttributesContract;
-            elements: IContentItemElementsContracts | undefined;
-        };
-        change_type: 'changed_item' | 'deleted_item';
-        timestamp: string;
-    }
-
-    export interface IInitializeSyncContract {
-        items: IContentItemDeltaContract[];
-    }
-
-    export interface ISyncChangesContract {
-        items: IContentItemDeltaContract[];
-    }
-
-    export interface ILanguageContract {
-        system: {
-            id: string;
-            name: string;
-            codename: string;
-        };
-    }
-
-    export interface IViewContentTypeElementContract {
-        codename?: string;
-        type: string;
-        name: string;
-        taxonomy_group?: string;
-        options?: IElementOptionContract[];
-    }
-
-    export interface IElementContract {
-        codename?: string;
-        name: string;
-        type: string;
-        value: any;
-        taxonomy_group?: string;
-    }
-
-    export interface IDateTimeElementContract extends IElementContract {
-        /**
-         * Display time zone
-         */
-        display_timezone: string;
-    }
-
-    export interface IAsssetRenditionContract {
-        rendition_id: string;
-        preset_id: string;
-        width: number;
-        height: number;
-        query: string;
-    }
-
-    export interface IAssetContract {
-        name: string;
-        type: string;
-        size: number;
-        description: string;
-        url: string;
-        width: number | null;
-        height: number | null;
-        renditions?: { [renditionPresetCodename: string]: IAsssetRenditionContract };
-    }
-
-    export interface IMultipleChoiceOptionContract {
-        name: string;
-        codename: string;
-    }
-
-    export interface ITaxonomyTerm {
-        name: string;
-        codename: string;
-    }
-
-    export interface IRichTextElementLinkWrapperContract {
-        [key: string]: IRichTextElementLinkContract;
-    }
-
-    export interface IRichTextElementLinkContract {
-        type: string;
-        codename: string;
-        url_slug: string;
-    }
-
-    export interface IRichTextElementImageWrapperContract {
-        [key: string]: IRichTextElementImageContract;
-    }
-
-    export interface IRichTextElementImageContract {
-        image_id: string;
-        url: string;
-        description: string | null;
-        height: number | null;
-        width: number | null;
-    }
-
-    export interface IRichTextElementContract extends IElementContract {
-        /**
-         * Modular content items
-         */
-        modular_content: string[];
-
-        /**
-         * Json with links
-         */
-        links: IRichTextElementLinkWrapperContract;
-
-        /**
-         * Json with images
-         */
-        images: IRichTextElementImageWrapperContract;
-    }
-
-    export interface IContentItemElementsContracts {
-        [key: string]: IElementContract;
-    }
-
-    export interface ILinkContract {
-        codename: string;
-        type: string;
-        url_slug: string;
-    }
-
-    export interface IModularContentContract {
-        [key: string]: IModularContentContentItemContract;
-    }
-
-    export interface IModularContentContentItemContract {
-        system: IContentItemSystemAttributesContract;
-        elements: IContentItemElementsContracts;
-    }
-
-    export interface IContentItemContract {
-        system: IContentItemSystemAttributesContract;
-        elements: IContentItemElementsContracts;
-    }
-
-    export interface IContentItemSystemAttributesContract {
-        id: string;
-        name: string;
-        codename: string;
-        type: string;
-        last_modified: string;
-        language: string;
-        sitemap_locations: string[];
-        collection: string;
-        workflow_step: string | null;
-        workflow: string | null;
-    }
-
-    export interface IItemsWithModularContentContract {
-        items: IContentItemContract[];
-        modular_content: IModularContentContract;
-    }
-
-    export interface IItemsFeedContract extends IItemsWithModularContentContract {}
-
-    export interface IUsedInItemsContract {
-        items: IUsedInItemContract[];
-    }
-
-    export interface IUsedInItemContract {
-        system: {
-            id: string;
-            name: string;
-            codename: string;
-            language: string;
-            type: string;
-            collection: string;
-            workflow: string;
-            workflow_step: string;
-            last_modified: string;
-        };
-    }
-
-    export interface IListContentItemsContract extends IItemsWithModularContentContract {
-        pagination: IPaginationContract;
-    }
-
-    export interface IViewContentItemContract {
-        item: IContentItemContract;
-        modular_content: IModularContentContract;
-    }
-
-    export interface ITaxonomyTermsContract {
-        name: string;
-        codename: string;
-        terms: ITaxonomyTermsContract[];
-    }
-
-    export interface ITaxonomySystemAttributesContract {
-        id: string;
-        name: string;
-        codename: string;
-        last_modified: Date;
-    }
-
-    export interface ITaxonomyGroupContract {
-        system: ITaxonomySystemAttributesContract;
-        terms: ITaxonomyTermsContract[];
-    }
-
-    export interface IViewTaxonomyGroupContract {
-        system: ITaxonomySystemAttributesContract;
-        terms: ITaxonomyTermsContract[];
-    }
-
-    export interface IListTaxonomyGroupsContract {
-        taxonomies: ITaxonomyGroupContract[];
-        pagination: IPaginationContract;
-    }
-
-    export interface IContentTypeSystemAttributesContract {
-        id: string;
-        name: string;
-        codename: string;
-        last_modified: Date;
-    }
-
-    export interface IContentTypeContract {
-        system: IContentTypeSystemAttributesContract;
-        elements: IContentTypeElementsContainer;
-    }
-
-    export interface IListContentTypeContract {
-        types: IContentTypeContract[];
-        pagination: IPaginationContract;
-    }
-
-    export interface IViewContentTypeContract extends IContentTypeContract {}
-}

package/lib/contracts/index.ts

@@ -1 +0,0 @@
-export * from './contracts';