@kontent-ai/delivery-sdk 16.4.3 → 16.4.5

package/lib/client/delivery-client.ts

@@ -1,163 +1,163 @@
-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 });
-    }
-}
+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 +1,110 @@
-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>;
-}
+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 +1,3 @@
-export * from './delivery-client';
-export * from './idelivery-client.interface';
-export * from './delivery-client.factory';
+export * from './delivery-client';
+export * from './idelivery-client.interface';
+export * from './delivery-client.factory';