Merge pull request #485 from cloudinary/feature/add-adjust-model-values

Feature/add adjust model values

Author: strausr

__TESTS__/unit/fromJson/adjust.fromJson.test.ts

@@ -0,0 +1,17 @@
+import {fromJson} from "../../../src/internal/fromJson";
+
+describe('adjust.fromJson', () => {
+  it('should generate a url with adjust actions from array of models', function () {
+    const transformation = fromJson([
+      { actionType: 'improve', mode: 'outdoor', blend: 30},
+      { actionType: 'unsharpMask', level: 50},
+      { actionType: 'saturation', level: 40}
+    ]);
+
+    expect(transformation.toString()).toStrictEqual([
+      'e_improve:outdoor:30',
+      'e_unsharp_mask:50',
+      'e_saturation:40'
+    ].join('/'));
+  });
+});

__TESTS__/unit/toJson/adjust.toJson.test.ts

@@ -0,0 +1,38 @@
+import {Transformation} from "../../../src";
+import {Adjust} from "../../../src/actions/adjust";
+
+describe('Adjust toJson()', () => {
+  it('adjust.improve', () => {
+    const transformation = new Transformation()
+      .addAction(Adjust.improve().mode('outdoor').blend(50));
+    expect(transformation.toJson()).toStrictEqual( [
+      {
+        actionType: 'improve',
+        mode: 'outdoor',
+        blend: 50
+      }
+    ]);
+  });
+
+  it('adjust.unsharpMask', () => {
+    const transformation = new Transformation()
+      .addAction(Adjust.unsharpMask().strength(10));
+    expect(transformation.toJson()).toStrictEqual( [
+      {
+        actionType: 'unsharpMask',
+        level: 10
+      }
+    ]);
+  });
+
+  it('adjust.saturation', () => {
+    const transformation = new Transformation()
+      .addAction(Adjust.saturation().level(50));
+    expect(transformation.toJson()).toStrictEqual( [
+      {
+        actionType: 'saturation',
+        level: 50
+      }
+    ]);
+  });
+});

src/actions/adjust/ImproveAction.ts

@@ -2,6 +2,8 @@ import {Action} from "../../internal/Action.js";
 import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
 import {stringOrNumber} from "../../types/types.js";
+import {ImproveActionModel} from "../../internal/models/IAdjustActionModel.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
 
 /**
  * @description Defines how to improve an image by automatically adjusting image colors, contrast and brightness.</br>
@@ -11,6 +13,7 @@ import {stringOrNumber} from "../../types/types.js";
 class ImproveAction extends Action {
   private modeValue:stringOrNumber;
   private blendValue:number;
+  protected _actionModel: ImproveActionModel = {actionType: 'improve'};
   constructor() {
     super();
   }
@@ -22,6 +25,7 @@ class ImproveAction extends Action {
    */
   mode(value: 'outdoor' | 'indoor' | string): this {
     this.modeValue = value;
+    this._actionModel.mode = value;
     return this;
   }
 
@@ -31,6 +35,7 @@ class ImproveAction extends Action {
    */
   blend(value:number): this {
     this.blendValue = value;
+    this._actionModel.blend = value;
     return this;
   }
 
@@ -39,6 +44,18 @@ class ImproveAction extends Action {
     this.addQualifier(new Qualifier('e', qualifierValue));
     return this;
   }
+
+  static fromJson(actionModel: IActionModel): ImproveAction{
+    const {mode, blend} = (actionModel as ImproveActionModel);
+
+    // We are using this() to allow inheriting classes to use super.fromJson.apply(this, [actionModel])
+    // This allows the inheriting classes to determine the class to be created
+    const result = new this();
+    mode && result.mode(mode);
+    blend && result.blend(blend);
+
+    return result;
+  }
 }
 
 export {ImproveAction};

src/internal/fromJson.ts

@@ -38,6 +38,7 @@ import {SimulateColorBlindEffectAction} from "../actions/effect/SimulateColorBli
 import {DeshakeEffectAction} from "../actions/effect/leveled/Deshake.js";
 import {Pixelate} from "../actions/effect/pixelate/Pixelate.js";
 import {BlurAction} from "../actions/effect/blur/Blur.js";
+import {ImproveAction} from "../actions/adjust/ImproveAction.js";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -81,7 +82,10 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   simulateColorblind: SimulateColorBlindEffectAction,
   deshake: DeshakeEffectAction,
   pixelate: Pixelate,
-  blur: BlurAction
+  blur: BlurAction,
+  improve: ImproveAction,
+  unsharpMask: EffectActionWithStrength,
+  saturation: EffectActionWithLevel
 };
 
 /**

src/internal/internalConstants.ts

@@ -104,7 +104,8 @@ export const ACTION_TYPE_TO_DELIVERY_MODE_MAP: Record<string, string> = {
 export const ACTION_TYPE_TO_EFFECT_MODE_MAP: Record<string, string> = {
   redEye: 'redeye',
   advancedRedEye: 'adv_redeye',
-  oilPaint: 'oil_paint'
+  oilPaint: 'oil_paint',
+  unsharpMask: 'unsharp_mask'
 };
 
 export const CHROMA_VALUE_TO_CHROMA_MODEL_ENUM: Record<number, string> = {

src/internal/models/IAdjustActionModel.ts

@@ -0,0 +1,8 @@
+import {IActionModel} from "./IActionModel.js";
+
+interface ImproveActionModel extends IActionModel {
+  mode?: string;
+  blend?: number;
+}
+
+export {ImproveActionModel};