resolve conflicts

Author: strausr

__TESTS__/unit/actions/Delivery.test.ts

@@ -215,6 +215,14 @@ describe('Tests for Transformation Action -- Delivery', () => {
     expect(url).toBe('https://res.cloudinary.com/demo/image/upload/q_auto/sample');
   });
 
+  it('Can use shortened quality notation', () => {
+    const url = createNewImage('sample')
+      .delivery(Delivery.quality('auto:best'))
+      .toURL();
+
+    expect(url).toBe('https://res.cloudinary.com/demo/image/upload/q_auto:best/sample');
+  });
+
   it('Creates a cloudinaryURL with Delivery.density', () => {
     const url = createNewImage('sample')
       .delivery(Delivery.density(150))
@@ -319,4 +327,11 @@ describe('Tests for Transformation Action -- Delivery', () => {
 
     expect(url).toContain('f_jpg,fl_progressive:none');
   });
+
+  it('Can use shortened format notation', () => {
+    // f_jpg,fl_progressive
+    const url = createNewImage('sample').delivery(format('jpg')).toString();
+
+    expect(url).toContain('f_jpg');
+  });
 });

__TESTS__/unit/actions/Effect.test.ts

@@ -152,6 +152,14 @@ describe('Tests for Transformation Action -- Effect', () => {
     expect(url).toBe('https://res.cloudinary.com/demo/image/upload/e_art:peacock/sample');
   });
 
+  it('Can use shortened artisticFilter notation', () => {
+    const url = createNewImage('sample')
+      .effect(Effect.artisticFilter("al_dente"))
+      .toURL();
+
+    expect(url).toBe('https://res.cloudinary.com/demo/image/upload/e_art:al_dente/sample');
+  });
+
   it('Creates a cloudinaryURL with effect cartoonify:50', () => {
     const url = createNewImage('sample')
       .effect(cartoonify().lineStrength(50).blackwhite())

__TESTS__/unit/actions/Resize/AspectRatio.test.ts

@@ -32,4 +32,13 @@ describe('Tests for AspectRatio values Action -- Resize.crop', () => {
 
     expect(url).toContain('ar_1:1,c_crop/ar_16:9,c_crop/ar_4:3,c_crop/ar_3:2,c_crop/ar_3:1,c_crop/ar_5:4,c_crop/c_crop,fl_ignore_aspect_ratio');
   });
+  it('Can use shortened aspectRatio notation', () => {
+    const url = createNewImage('sample')
+      .resize(
+        crop().aspectRatio("3:2"))
+      .setPublicID('sample')
+      .toURL();
+
+    expect(url).toContain('ar_3:2,c_crop');
+  });
 });

src/actions/delivery.ts

@@ -13,10 +13,11 @@ import {toFloatAsString} from "../internal/utils/toFloatAsString";
 import {DeliveryColorSpaceFromICC} from "./delivery/DeliveryColorSpaceFromICC";
 import {DeliveryAction} from "./delivery/DeliveryAction";
 import {ColorSpaceType} from "../types/types";
+import {QualityTypes} from "../types/types";
+import {ImageFormatType, VideoFormatType} from "../types/types";
 
 export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceFromICC;
 
-
 /**
  * @summary action
  * @description Defines the format of the delivered asset.
@@ -40,7 +41,7 @@ export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceFromICC;
  * );
  *
  */
-function format(format:FormatQualifier | string) :DeliveryFormat {
+function format(format:FormatQualifier | ImageFormatType | VideoFormatType | string) :DeliveryFormat {
   return new DeliveryFormat('f', format);
 }
 
@@ -75,7 +76,8 @@ function dpr(dpr: string|number):DeliveryAction {
  * <b>Learn more:</b> {@link https://cloudinary.com/documentation/image_optimization#how_to_optimize_image_quality | Image quality}
  *  {@link https://cloudinary.com/documentation/video_manipulation_and_delivery#quality_control | Video quality}
  * @memberOf Actions.Delivery
- * @param {string | number | Qualifiers.Quality} qualityType For a list of supported quality types see {@link Qualifiers.Quality| quality types} for
+ * @param {QualityTypes | string | number | Qualifiers.Quality} qualityType For a list of supported quality types see
+ * {@link Qualifiers.Quality| quality types} for
  * possible values.
  * @return {Actions.Delivery.DeliveryQualityAction}
  * @example
@@ -89,7 +91,7 @@ function dpr(dpr: string|number):DeliveryAction {
  *  quality('auto'),
  * );
  */
-function quality(qualityType:string | number) :DeliveryQualityAction {
+function quality(qualityType:QualityTypes | string | number) :DeliveryQualityAction {
   return new DeliveryQualityAction(qualityType);
 }
 

src/actions/effect.ts

@@ -24,6 +24,7 @@ import {FadeInEffectAction} from "./effect/leveled/fadeIn";
 import {RemoveBackgroundAction} from "./effect/removeBackgroundAction";
 import {ThemeEffect} from "./effect/theme";
 import {SystemColors} from "../qualifiers/color";
+import {ArtisticFilterType} from "../types/types";
 
 
 /**
@@ -101,10 +102,10 @@ function oilPaint(oilPaintLevel?: number):EffectActionWithStrength {
  * @summary action
  * @description Applies an artistic filter to the asset.
  * @memberOf Actions.Effect
- * @param artisticFilterType
+ * @param {ArtisticFilterType | string} artisticFilterType
  * @return {Actions.Effect.SimpleEffectAction}
  */
-function artisticFilter(artisticFilterType: string):SimpleEffectAction {
+function artisticFilter(artisticFilterType: ArtisticFilterType | string):SimpleEffectAction {
   return new SimpleEffectAction('art', artisticFilterType);
 }
 

src/actions/resize/ResizeSimpleAction.ts

@@ -5,6 +5,7 @@ import {AspectRatioQualifierValue} from "../../qualifiers/aspectRatio/AspectRati
 import {regionRelative, relative} from "../../qualifiers/flag";
 import {FlagQualifier} from "../../qualifiers/flag/FlagQualifier";
 import {ExpressionQualifier} from "../../qualifiers/expression/ExpressionQualifier";
+import {AspectRatioType} from "../../types/types";
 
 /**
  * @description Defines a resize using width and height.
@@ -49,10 +50,10 @@ class ResizeSimpleAction extends Action {
    * @description Sets the aspect ratio of the asset.
    * For a list of supported types see {@link Qualifiers.AspectRatio |
     * AspectRatio values}
-   * @param {number|string} ratio The new aspect ratio, specified as a percentage or ratio.
+   * @param {AspectRatioType|number|string} ratio The new aspect ratio, specified as a percentage or ratio.
    * @return {this}
    */
-  aspectRatio(ratio: AspectRatioQualifierValue | FlagQualifier | number | string): this {
+  aspectRatio(ratio: AspectRatioType | AspectRatioQualifierValue | FlagQualifier | number | string): this {
     // toFloatAsString is used to ensure 1 turns into 1.0
     if (ratio instanceof AspectRatioQualifierValue) {
       return this.addQualifier(new Qualifier('ar', ratio));

src/types/types.ts

@@ -208,35 +208,74 @@ export type DeliveryType =
   | "dailymotion";
 /****************************** URL *************************************/
 export type ResourceType = string | "image" | "raw" | "video";
-export type ImageFormat =
-  string
-  | "gif"
-  | "png"
-  | "jpg"
-  | "bmp"
-  | "ico"
-  | "pdf"
-  | "tiff"
-  | "eps"
-  | "jpc"
-  | "jp2"
-  | "psd"
-  | "webp"
-  | "zip"
-  | "svg"
-  | "webm"
-  | "wdp"
-  | "hpx"
-  | "djvu"
-  | "ai"
-  | "flif"
-  | "bpg"
-  | "miff"
-  | "tga"
-  | "heic"
-  | "ignore_mask_channels";
+export type ImageFormatType =
+  string |
+  'usdz'|
+  'jp2'|
+  'ai'|
+  'auto'|
+  'bmp'|
+  'eps'|
+  'flif'|
+  'gif'|
+  'heic'|
+  'ico'|
+  'jpc'|
+  'jpg'|
+  'pdf'|
+  'png'|
+  'psd'|
+  'svg'|
+  'tiff'|
+  'wdp'|
+  'webp'|
+  'arw'|
+  'aac'|
+  'aiff'|
+  'amr'|
+  'flac'|
+  'm4a'|
+  'mp3'|
+  'ogg'|
+  'opus'|
+  'wav'|
+  'avif'|
+  'cr2'|
+  'djvu'|
+  'eps3'|
+  'ept'|
+  'fxb'|
+  'gltf'|
+  'hdp'|
+  'heif'|
+  'indd'|
+  'jpe'|
+  'jpeg'|
+  'jxr'|
+  'ps'|
+  'spd'|
+  'tga'|
+  'tif'|
+  '3g2'|
+  '3gp'|
+  'avi'|
+  'flv'|
+  'm2ts'|
+  'm3u8'|
+  'mkv'|
+  'mov'|
+  'mp4'|
+  'mpd'|
+  'mpeg'|
+  'mts'|
+  'mxf'|
+  'ogv'|
+  'ts'|
+  'webm'|
+  'wmv'|
+  'glb';
 
-export type VideoFormat =
+export type VideoFormatType =
   string
   | "auto"
   | "flv"
@@ -251,6 +290,37 @@ export type VideoFormat =
 
 export type AnimatedFormatType = "auto" | "gif" | "webp" | "png";
 
+export type ArtisticFilterType =
+  "al_dente"|
+  "athena"|
+  "audrey"|
+  "aurora"|
+  "daguerre"|
+  "eucalyptus"|
+  "hairspray"|
+  "hokusai"|
+  "peacock"|
+  "primavera"|
+  "quartz"|
+  "incognito"|
+  "red_rock"|
+  "sizzle"|
+  "fes"|
+  "linen"|
+  "refresh"|
+  "sonnet"|
+  "ukulele"|
+  "frost"|
+  "zorro";
+
+export type AspectRatioType =
+  "1:1"|
+  "5:4"|
+  "3:1"|
+  "3:2"|
+  "4:3"|
+  "16:9";
+
 export type AudioFrequencyType =
   8000|
   11025|
@@ -364,8 +434,8 @@ export interface LegacyITransforamtionOptions {
   } | string;
   default_image?: string;
   density?: stringOrNumber;
-  format?: ImageFormat;
-  fetch_format?: ImageFormat;
+  format?: ImageFormatType;
+  fetch_format?: ImageFormatType;
   effect?: string | Array<stringOrNumber> | ImageEffect;
   page?: stringOrNumber;
   flags?: ImageFlags | [] | string;
@@ -406,3 +476,14 @@ export interface LegacyITransforamtionOptions {
   url_suffix?: string;
   [futureKey: string]: any;
 }
+
+export type QualityTypes =
+  'auto'|
+  'auto:best'|
+  'auto:eco'|
+  'auto:good'|
+  'auto:low'|
+  'jpegmini'|
+  'jpegmini:best' |
+  'jpegmini:high' |
+  'jpegmini:medium';