Merge pull request #410 from cloudinary/feature/add-shortened-quality

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))

src/actions/delivery.ts

@@ -12,6 +12,7 @@ import {FormatQualifier} from "../qualifiers/format/FormatQualifier";
 import {toFloatAsString} from "../internal/utils/toFloatAsString";
 import {DeliveryColorSpaceFromICC} from "./delivery/DeliveryColorSpaceFromICC";
 import {DeliveryAction} from "./delivery/DeliveryAction";
+import {QualityTypes} from "../types/types";
 import {ImageFormatType, VideoFormatType} from "../types/types";
 
 export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceFromICC;
@@ -74,7 +75,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
@@ -88,7 +90,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/types/types.ts

@@ -1,5 +1,3 @@
-import {gif, png, webp} from "../qualifiers/animatedFormat";
-
 export type StreamingProfiles = string | "4k" | "full_hd" | "hd" | "sd" | "full_hd_wifi" | "full_hd_lean" | "hd_lean";
 
 export type stringOrNumber = number | string;
@@ -363,3 +361,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';