@kontent-ai/delivery-sdk 16.4.3 → 16.4.5

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

@@ -1,181 +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();
-  }
-}
+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

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

package/lib/images/index.ts

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

package/lib/index.ts

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