Feature/format from json (#470)

Author: Nir Maoz

__TESTS_BUNDLE_SIZE__/bundleSizeTestCases.ts

@@ -24,7 +24,7 @@ const bundleSizeTestCases:ITestCase[] = [
   },
   {
     name: 'Tests CloudinaryImage with Resize and Adjust',
-    sizeLimitInKB: 22,
+    sizeLimitInKB: 23,
     importsArray: [
       importFromDist('assets/CloudinaryImage', 'CloudinaryImage'),
       importFromDist('instance/Cloudinary', 'Cloudinary'),

__TESTS__/unit/fromJson/delivery.fromJson.test.ts

@@ -15,4 +15,28 @@ describe('delivery.fromJson', () => {
 
     expect(transformation.toString()).toStrictEqual('cs_icc:sample');
   });
+
+  it('jpg.progressive.semi()', () => {
+    const transformation = fromJson([
+      {
+        progressive: { mode: 'semi' },
+        actionType: 'format',
+        formatType: 'jpg'
+      }
+    ]);
+
+    expect(transformation.toString()).toStrictEqual('f_jpg,fl_progressive:semi');
+  });
+
+  it('gif.lossy()', () => {
+    const transformation = fromJson([
+      {
+        actionType: 'format',
+        formatType: 'gif',
+        lossy: true
+      }
+    ]);
+
+    expect(transformation.toString()).toStrictEqual('f_gif,fl_lossy');
+  });
 });

__TESTS__/unit/toJson/delivery.toJson.test.ts

@@ -62,7 +62,7 @@ describe('Delivery.toJson()', () => {
     ]);
   });
 
-  it('jpg.progressive.semi()', () => {
+  it('jpg.progressive("semi")', () => {
     const transformation = new Transformation()
       .addAction(Delivery.format(Format.jpg()).progressive('semi'));
     expect(transformation.toJson()).toStrictEqual([

src/actions/delivery.ts

@@ -6,7 +6,7 @@
  * See the examples under every method
  */
 
-import {DeliveryFormat} from "./delivery/DeliveryFormat.js";
+import {DeliveryFormatAction} from "./delivery/DeliveryFormatAction.js";
 import {DeliveryQualityAction} from "./delivery/DeliveryQuality.js";
 import {FormatQualifier} from "../qualifiers/format/FormatQualifier.js";
 import {toFloatAsString} from "../internal/utils/toFloatAsString.js";
@@ -42,8 +42,8 @@ export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceAction | Delive
  * );
  *
  */
-function format(format:FormatQualifier | ImageFormatType | VideoFormatType | string) :DeliveryFormat {
-  return new DeliveryFormat('f', format);
+function format(format:FormatQualifier | ImageFormatType | VideoFormatType | string) :DeliveryFormatAction {
+  return new DeliveryFormatAction('f', format);
 }
 
 /**

src/actions/delivery/DeliveryFormat.ts …actions/delivery/DeliveryFormatAction.tssrc/actions/delivery/DeliveryFormat.ts renamed to src/actions/delivery/DeliveryFormatAction.ts src/actions/delivery/DeliveryFormat.ts renamed to src/actions/delivery/DeliveryFormatAction.ts

@@ -3,13 +3,15 @@ import {DeliveryAction} from "./DeliveryAction.js";
 import {ProgressiveQualifier} from "../../qualifiers/progressive.js";
 import {FormatQualifier} from "../../qualifiers/format/FormatQualifier.js";
 import {ProgressiveType} from "../../types/types.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
+import {IDeliveryFormatModel} from "../../internal/models/IDeliveryActionModel.js";
 
 /**
  * @memberOf Actions.Delivery
  * @extends {Actions.Delivery.DeliveryAction}
  * @see Visit {@link Actions.Delivery|Delivery} for an example
  */
-class DeliveryFormat extends DeliveryAction {
+class DeliveryFormatAction extends DeliveryAction {
   constructor(deliveryKey?: string, deliveryType?: FormatQualifier|string|number) {
     super(deliveryKey, deliveryType, 'formatType');
   }
@@ -46,6 +48,30 @@ class DeliveryFormat extends DeliveryAction {
     this.addFlag(preserveTransparency());
     return this;
   }
+
+  static fromJson(actionModel: IActionModel): DeliveryFormatAction {
+    const {formatType, lossy, progressive, preserveTransparency} = (actionModel as IDeliveryFormatModel);
+    let result: DeliveryFormatAction;
+
+    if (formatType) {
+      result = new this('f', formatType);
+    } else{
+      result = new this('f');
+    }
+
+    if (progressive){
+      if (progressive.mode){
+        result.progressive(progressive.mode as unknown as ProgressiveQualifier);
+      } else{
+        result.progressive();
+      }
+    }
+
+    lossy && result.lossy();
+    preserveTransparency && result.preserveTransparency();
+
+    return result;
+  }
 }
 
-export {DeliveryFormat};
+export {DeliveryFormatAction};

src/assets/CloudinaryTransformable.ts

@@ -22,10 +22,9 @@ import IURLConfig from "../config/interfaces/Config/IURLConfig.js";
 import ICloudConfig from "../config/interfaces/Config/ICloudConfig.js";
 import {IDeliveryAction} from "../actions/delivery.js";
 import {IAdjustAction} from "../actions/adjust.js";
-import {DeliveryQualityAction} from "../actions/delivery/DeliveryQuality.js";
 import {ITrackedPropertiesThroughAnalytics} from "../sdkAnalytics/interfaces/ITrackedPropertiesThroughAnalytics.js";
 import {AnimatedAction} from "../actions/animated.js";
-import {DeliveryFormat} from "../actions/delivery/DeliveryFormat.js";
+import {DeliveryFormatAction} from "../actions/delivery/DeliveryFormatAction.js";
 
 /**
  * @desc Cloudinary Transformable interface, extended by any class that needs a Transformation Interface
@@ -86,7 +85,7 @@ class CloudinaryTransformable extends CloudinaryFile {
    * @return {this}
    */
   quality(quality: string|number): this {
-    this.addAction(new DeliveryFormat('q', quality));
+    this.addAction(new DeliveryFormatAction('q', quality));
     return this;
   }
 
@@ -96,7 +95,7 @@ class CloudinaryTransformable extends CloudinaryFile {
    * @return {this}
    */
   format(format: string): this {
-    this.addAction(new DeliveryFormat('f', format));
+    this.addAction(new DeliveryFormatAction('f', format));
     return this;
   }
 

src/internal/fromJson.ts

@@ -17,6 +17,7 @@ import {ResizeLimitPadAction} from "../actions/resize/ResizeLimitPadAction.js";
 import {ResizeMinimumPadAction} from "../actions/resize/ResizeMinimumPadAction.js";
 import {DeliveryColorSpaceAction} from "../actions/delivery/DeliveryColorSpaceAction.js";
 import {DeliveryColorSpaceFromICCAction} from "../actions/delivery/DeliveryColorSpaceFromICCAction.js";
+import {DeliveryFormatAction} from "../actions/delivery/DeliveryFormatAction.js";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -31,7 +32,8 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   limitPad: ResizeLimitPadAction,
   minimumPad: ResizeMinimumPadAction,
   colorSpace: DeliveryColorSpaceAction,
-  colorSpaceFromICC: DeliveryColorSpaceFromICCAction
+  colorSpaceFromICC: DeliveryColorSpaceFromICCAction,
+  format: DeliveryFormatAction
 };
 
 /**