@kontent-ai/delivery-sdk 12.0.0-0

package/lib/contracts/contracts.ts

@@ -0,0 +1,222 @@
+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;
+        taxonomyGroup?: 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 ILanguageContract {
+        system: {
+            id: string;
+            name: string;
+            codename: string;
+        };
+    }
+
+    export interface IViewContentTypeElementContract {
+        type: string;
+        name: string;
+        codename: string;
+        taxonomy_group?: string;
+        options?: IElementOptionContract[];
+    }
+
+    export interface IElementContract {
+        codename?: string;
+        name: string;
+        type: string;
+        value: any;
+        taxonomy_group?: 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;
+    }
+
+    export interface IItemsWithModularContentContract {
+        items: IContentItemContract[];
+        modular_content: IModularContentContract;
+    }
+
+    export interface IItemsFeedContract extends IItemsWithModularContentContract {}
+
+    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

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

package/lib/elements/element-models.ts

@@ -0,0 +1,95 @@
+import { IContentItemSystemAttributes } from '../models/item-models';
+import { Contracts } from '../contracts';
+import { ElementType } from './element-type';
+
+export namespace ElementModels {
+    export interface IRichTextResolverData {
+        html: string;
+        linkedItemCodenames: string[];
+        componentCodenames: string[];
+    }
+
+    export interface IElementWrapper {
+        element: string;
+        system: IContentItemSystemAttributes;
+        rawElement: Contracts.IElementContract;
+    }
+
+    export interface IElement<TValue> {
+        /**
+         * Name of the element
+         */
+        name: string;
+
+        /**
+         * Element type
+         */
+        type: ElementType;
+
+        /**
+         * Element value
+         */
+        value: TValue;
+    }
+
+    export interface AssetModel {
+        /**
+         * Name of the asset
+         */
+        name: string;
+
+        /**
+         * Type of the asset
+         */
+        type: string;
+
+        /**
+         * Size of the asset
+         */
+        size: number;
+
+        /**
+         * Description of the asset
+         */
+        description: string | null;
+
+        /**
+         * Url of the asset
+         */
+        url: string;
+
+        /**
+         * Width in pixels for image assets
+         */
+        width: number | null;
+
+        /**
+         * Height in pixels for image assets
+         */
+        height: number | null;
+
+        /**
+         * Dictionary with rendition preset codenames as keys and respective renditions as values.
+         */
+        renditions: { [renditionPresetCodename: string]: Rendition } | null;
+    }
+
+    export interface Rendition {
+        rendition_id: string;
+        preset_id: string;
+        width: number;
+        height: number;
+        query: string;
+        url: string;
+    }
+
+    export interface MultipleChoiceOption {
+        name: string;
+        codename: string;
+    }
+
+    export interface TaxonomyTerm<TaxonomyCodename extends string = string> {
+        name: string;
+        codename: TaxonomyCodename;
+    }
+}

package/lib/elements/element-resolver.ts

@@ -0,0 +1,3 @@
+import { ElementModels } from './element-models';
+
+export type ElementResolver = (element: ElementModels.IElementWrapper) => any | undefined;

package/lib/elements/element-type.ts

@@ -0,0 +1,16 @@
+/**
+* Represents codename of Kontent.ai element types
+*/
+export enum ElementType {
+    Text = 'text',
+    Number = 'number',
+    ModularContent = 'modular_content',
+    Asset = 'asset',
+    DateTime = 'date_time',
+    RichText = 'rich_text',
+    MultipleChoice = 'multiple_choice',
+    UrlSlug = 'url_slug',
+    Taxonomy = 'taxonomy',
+    Custom = 'custom',
+    Unknown = 'unknown'
+}

package/lib/elements/elements.ts

@@ -0,0 +1,62 @@
+import { IContentItem, ILink, IRichTextImage } from '../models';
+import { ElementModels } from './element-models';
+
+export namespace Elements {
+    export type TextElement = ElementModels.IElement<string>;
+
+    export type LinkedItemsElement<TContentItem extends IContentItem = IContentItem> = ElementModels.IElement<
+        string[]
+    > & {
+        /**
+         * Linked items
+         */
+        linkedItems: TContentItem[];
+    };
+
+    export type MultipleChoiceElement = ElementModels.IElement<ElementModels.MultipleChoiceOption[]>;
+
+    export type DateTimeElement = ElementModels.IElement<string | null>;
+
+    export type RichTextElement = ElementModels.IElement<string> & {
+        /**
+         * Links
+         */
+        links: ILink[];
+
+        /**
+         * Images included within rich text element
+         */
+        images: IRichTextImage[];
+
+        /**
+         * Array of linked item codenames
+         */
+        linkedItemCodenames: string[];
+
+        /**
+         * Array of linked items retrieved from `modular_content` part of the response. Not all items might be here
+         * as it depends on the `depth` parameter of query.
+         * The `linkedItemsReferenceHandler` configuration can be used to disable mapping of linked items
+         */
+        linkedItems: IContentItem[];
+    };
+
+    export type NumberElement = ElementModels.IElement<number | null>;
+
+    export type AssetsElement = ElementModels.IElement<ElementModels.AssetModel[]>;
+
+    export type UrlSlugElement = ElementModels.IElement<string>;
+
+    export type TaxonomyElement<TaxonomyCodename extends string = string> = ElementModels.IElement<
+        ElementModels.TaxonomyTerm<TaxonomyCodename>[]
+    > & {
+        /**
+         * Taxonomy group
+         */
+        taxonomyGroup: string | null;
+    };
+
+    export type UnknownElement = ElementModels.IElement<any>;
+
+    export type CustomElement<TValue = string> = ElementModels.IElement<TValue>;
+}

package/lib/elements/index.ts

@@ -0,0 +1,4 @@
+export * from './element-models';
+export * from './element-type';
+export * from './elements';
+export * from './element-resolver';

package/lib/images/image-url-transformation-builder.factory.ts

@@ -0,0 +1,5 @@
+import { ImageUrlTransformationBuilder } from './image-url-transformation-builder';
+
+export function transformImageUrl(url: string): ImageUrlTransformationBuilder {
+    return new ImageUrlTransformationBuilder(url);
+}

package/lib/images/image-url-transformation-builder.ts

@@ -0,0 +1,181 @@
+import { IQueryParameter } from '@kontent-ai/core-sdk';
+
+import { Parameters } from '../models';
+import { ImageCompression, ImageFitMode, ImageFormat } from './image.models';
+
+export class ImageUrlTransformationBuilder {
+  private queryParams: IQueryParameter[] = [];
+  private readonly automaticFormatValue: string = 'format';
+
+  constructor(
+    /** Image url */
+    public imageUrl: string
+  ) { }
+
+  /**
+   * Used to add custom parameters to existing query string
+   * @param param Parameter (may or may not include value)
+   */
+  withCustomParam(param: string): this {
+    this.queryParams.push(
+      new Parameters.CustomParameter(param)
+    );
+    return this;
+  }
+
+  /**
+   * The dpr transformation is used to serve correctly sized images for devices that expose a device pixel ratio.
+   * @param dpr A required DPR value.
+   */
+  withDpr(dpr: number): this {
+    this.queryParams.push(
+      new Parameters.QueryParameter('dpr', dpr.toString())
+    );
+
+    return this;
+  }
+
+  /**
+   * Applies the crop transformation that removes pixels from an image outside the specified rectangle.
+   * @param x Rectangle offset on the X-axis.
+   * @param y Rectangle offset on the Y-axis.
+   * @param width Rectangle width.
+   * @param height Rectangle height.
+   */
+  withRectangleCrop(x: number, y: number, width: number, height: number): this {
+    this.queryParams.push(
+      new Parameters.QueryParameter('rect', [x, y, width, height].join(','))
+    );
+    return this;
+  }
+
+  /**
+   * Applies the crop transformation centered on the specified point.
+   * @param x Focal point X coordinate.
+   * @param y Focal point Y coordinate.
+   * @param z Zoom of the transformation.
+   */
+  withFocalPointCrop(x: number, y: number, z: number): this {
+    this.withFitMode('crop');
+
+    this.queryParams.push(new Parameters.QueryParameter('crop', 'focalpoint'));
+    this.queryParams.push(new Parameters.QueryParameter('fp-x', x.toString()));
+    this.queryParams.push(new Parameters.QueryParameter('fp-y', y.toString()));
+    this.queryParams.push(new Parameters.QueryParameter('fp-z', z.toString()));
+
+    return this;
+  }
+
+  /**
+   * Enables WebP image support.
+   * @param compression Specifies the lossy or lossless compression.
+   */
+  withAutomaticFormat(backupFormat?: ImageFormat): this {
+    this.queryParams.push(
+      new Parameters.QueryParameter('auto', this.automaticFormatValue)
+    );
+
+    if (backupFormat) {
+      this.withFormat(backupFormat);
+    }
+
+    return this;
+  }
+
+  /**
+   * The fit transformation controls how the output image is fit to its target dimensions after resizing.
+   * @param fitMode Specifies the mode for the transformation.
+   */
+  withFitMode(fitMode: ImageFitMode): this {
+    this.queryParams.push(new Parameters.QueryParameter('fit', fitMode));
+    return this;
+  }
+
+  /**
+   * Specifies the compression mode for the WebP image transformations.
+   * @param compression Specifies the lossy or lossless compression.
+   */
+  withCompression(compression: ImageCompression): this {
+    this.queryParams.push(
+      new Parameters.QueryParameter(
+        'lossless',
+        compression === 'lossless' ? 'true' : 'false'
+      )
+    );
+    return this;
+  }
+
+  /**
+   * Applies the quality parameter that enables control over the compression level for lossy file-formatted images.
+   * @param quality The required quality of the image.
+   */
+  withQuality(quality: number): this {
+    this.queryParams.push(
+      new Parameters.QueryParameter('q', quality.toString())
+    );
+    return this;
+  }
+
+  /**
+   * The format transformation enables the source image to be converted (a.k.a., "transcoded") from
+   * one encoded format to another. This is very useful when the source image has been saved in a sub-optimal
+   * file format that hinders performance.
+   * @param format Target image file type.
+   */
+  withFormat(format: ImageFormat): this {
+    this.queryParams.push(
+      new Parameters.QueryParameter('fm', format)
+    );
+    return this;
+  }
+
+  /**
+   * The height transformation enables dynamic height resizing based on pixels and percent values.
+   * @param height A required image height.
+   */
+  withHeight(height: number): this {
+    this.queryParams.push(
+      new Parameters.QueryParameter('h', height.toString())
+    );
+    return this;
+  }
+
+  /**
+   * The width transformation enables dynamic width resizing based on pixels and percent values.
+   * @param width A required image width.
+   */
+  withWidth(width: number): this {
+    this.queryParams.push(new Parameters.QueryParameter('w', width.toString()));
+    return this;
+  }
+
+  /**
+   * Gets params applied to image
+   */
+  getParams(): IQueryParameter[] {
+    return this.queryParams;
+  }
+
+  /**
+   * Gets query string part of the image URL
+   */
+  getQueryString(): string {
+    let query: string = '';
+    this.queryParams.forEach(filter => {
+      if (query.indexOf('?') > -1) {
+        query = query + '&' + filter.getParam();
+      } else {
+        query = query + '?' + filter.getParam();
+      }
+    });
+
+    return query;
+  }
+
+  /**
+   * Gets full transformed url to image with parameters
+   */
+  getUrl(): string {
+    return this.imageUrl + this.getQueryString();
+  }
+}

package/lib/images/image.models.ts

@@ -0,0 +1,4 @@
+export type ImageFitMode = 'clip' | 'scale' | 'crop';
+export type ImageFormat = 'gif' | 'png' |'png8' | 'jpg' | 'pjpg' |'webp';
+export type ImageCompression = 'lossless' | 'lossy';
+

package/lib/images/index.ts

@@ -0,0 +1,3 @@
+export * from './image-url-transformation-builder';
+export * from './image.models';
+export * from './image-url-transformation-builder.factory';

package/lib/index.ts

@@ -0,0 +1,15 @@
+// Public API
+export * from './client';
+export * from './sdk-info.generated';
+export * from './config';
+export * from './contracts';
+export * from './elements';
+export * from './parser';
+export * from './resolvers';
+export * from './services';
+export * from './mappers';
+export * from './query';
+export * from './models';
+export * from './images';
+export * from './utilities';
+