update dpr action from/to json (#494)

Author: strausr

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

@@ -1,8 +1,4 @@
 import {fromJson} from "../../../src/internal/fromJson";
-import {Transformation} from "../../../src";
-import {Delivery} from "../../../src/actions/delivery";
-import {Quality} from "../../../src/qualifiers/quality";
-import {ChromaSubSampling} from "../../../src/qualifiers/chromaSubSampling";
 
 describe('delivery.fromJson', () => {
   it('should generate a transformation string from colorSpace action', function () {
@@ -167,4 +163,12 @@ describe('delivery.fromJson', () => {
 
     expect(transformation.toString()).toStrictEqual('q_75:420');
   });
+
+  it('dpr', () => {
+    const transformation = fromJson([
+      { actionType: 'dpr', dpr: 'auto'},
+      { actionType: 'dpr', dpr: 2},
+    ]);
+    expect(transformation.toString()).toStrictEqual('dpr_auto/dpr_2.0');
+  });
 });

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

@@ -17,13 +17,24 @@ describe('Delivery.toJson()', () => {
     );
   });
 
-  it('delivery.dpr', () => {
+  it('delivery.dpr auto', () => {
     const transformation = new Transformation()
       .addAction(Delivery.dpr('auto'));
     expect(transformation.toJson()).toStrictEqual([
       {
         actionType: 'dpr',
-        type: 'auto'
+        dpr: 'auto'
+      }
+    ]);
+  });
+
+  it('delivery.dpr number', () => {
+    const transformation = new Transformation()
+      .addAction(Delivery.dpr(2));
+    expect(transformation.toJson()).toStrictEqual([
+      {
+        actionType: 'dpr',
+        dpr: '2.0'
       }
     ]);
   });

src/actions/delivery.ts

@@ -9,15 +9,15 @@
 import {DeliveryFormatAction} from "./delivery/DeliveryFormatAction.js";
 import {DeliveryQualityAction} from "./delivery/DeliveryQualityAction.js";
 import {FormatQualifier} from "../qualifiers/format/FormatQualifier.js";
-import {toFloatAsString} from "../internal/utils/toFloatAsString.js";
 import {DeliveryColorSpaceFromICCAction} from "./delivery/DeliveryColorSpaceFromICCAction.js";
 import {DeliveryAction} from "./delivery/DeliveryAction.js";
 import {ColorSpaceType} from "../types/types.js";
 import {QualityTypes} from "../types/types.js";
 import {ImageFormatType, VideoFormatType} from "../types/types.js";
 import {DeliveryColorSpaceAction} from "./delivery/DeliveryColorSpaceAction.js";
+import {DeliveryDPRAction} from "./delivery/DeliveryDPRAction.js";
 
-export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceAction | DeliveryColorSpaceFromICCAction;
+export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceAction | DeliveryColorSpaceFromICCAction | DeliveryDPRAction;
 
 /**
  * @summary action
@@ -62,9 +62,8 @@ function format(format:FormatQualifier | ImageFormatType | VideoFormatType | str
  *  dpr('2.0'),
  * );
  */
-function dpr(dpr: string|number):DeliveryAction {
-  // toFloatAsString is used to ensure 1 turns into 1.0
-  return new DeliveryAction('dpr', toFloatAsString(dpr), 'type');
+function dpr(dpr: string|number):DeliveryDPRAction {
+  return new DeliveryDPRAction(dpr);
 }
 
 /**

src/actions/delivery/DeliveryAction.ts

@@ -3,25 +3,27 @@ import {FormatQualifier} from "../../qualifiers/format/FormatQualifier.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
 import {
   IDefaultImageModel, IDeliveryColorSpaceActionModel, IDeliveryColorSpaceFromICCActionModel,
-  IDeliveryFormatModel, IDeliveryQualityModel, IDensityModel, IDprModel
+  IDeliveryFormatModel, IDeliveryQualityModel, IDensityModel
 } from "../../internal/models/IDeliveryActionModel.js";
-import {DELIVERY_MODE_TO_ACTION_TYPE_MAP} from "../../internal/internalConstants.js";
+import {
+  DELIVERY_MODE_TO_ACTION_TYPE_MAP
+} from "../../internal/internalConstants.js";
 
 /**
  * @description Qualifies the delivery of an asset.
  * @memberOf Actions.Delivery
  * @extends SDK.Action
  */
 class DeliveryAction extends Action {
-  protected _actionModel: IDeliveryColorSpaceActionModel | IDeliveryColorSpaceFromICCActionModel | IDprModel | IDensityModel | IDefaultImageModel | IDeliveryFormatModel | IDeliveryQualityModel = {};
+  protected _actionModel: IDeliveryColorSpaceActionModel | IDeliveryColorSpaceFromICCActionModel | IDensityModel | IDefaultImageModel | IDeliveryFormatModel | IDeliveryQualityModel = {};
 
   /**
    * @param {string} deliveryKey A generic Delivery Action Key (such as q, f, dn, etc.)
    * @param {string} deliveryType A Format Qualifiers for the action, such as Quality.auto()
    * @param {string} modelProperty internal model property of the action, for example quality uses `level` while dpr uses `density`
    * @see Visit {@link Actions.Delivery|Delivery} for an example
    */
-  constructor(deliveryKey?: string, deliveryType?: FormatQualifier | string|number, modelProperty?: 'level' | 'density' | 'defaultImage' | 'colorSpaceType' | 'formatType' | 'type') {
+  constructor(deliveryKey?: string, deliveryType?: FormatQualifier | string|number, modelProperty?: 'level' | 'density' | 'defaultImage' | 'colorSpaceType' | 'formatType') {
     super();
 
     let deliveryTypeValue;

src/actions/delivery/DeliveryDPRAction.ts

@@ -0,0 +1,37 @@
+import {Action} from "../../internal/Action.js";
+import {Qualifier} from "../../internal/qualifier/Qualifier.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
+import {IDprModel} from "../../internal/models/IDeliveryActionModel.js";
+import {toFloatAsString} from "../../internal/utils/toFloatAsString.js";
+
+/**
+ * @description Specifies the dpr.
+ * @memberOf Actions.Delivery
+ * @extends SDK.Action
+ * @see Visit {@link Actions.Delivery|Delivery} for an example
+ */
+class DeliveryDPRAction extends Action {
+  protected _actionModel: IDprModel = { actionType: 'dpr'};
+
+  /**
+   * Create a new DeliveryDPRAction
+   * @param dprValue
+   */
+  constructor(dprValue: string | number) {
+    super();
+    // toFloatAsString is used to ensure 1 turns into 1.0
+    const dprAsFloat = toFloatAsString(dprValue);
+    this._actionModel.dpr = dprAsFloat;
+    this.addQualifier(new Qualifier('dpr', dprAsFloat));
+  }
+
+
+  static fromJson(actionModel: IActionModel): DeliveryDPRAction {
+    const {dpr} = (actionModel as IDprModel);
+    // 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
+    return new this(dpr);
+  }
+}
+
+export {DeliveryDPRAction};

src/internal/fromJson.ts

@@ -39,6 +39,7 @@ 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";
+import {DeliveryDPRAction} from "../actions/delivery/DeliveryDPRAction.js";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -85,7 +86,8 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   blur: BlurAction,
   improve: ImproveAction,
   unsharpMask: EffectActionWithStrength,
-  saturation: EffectActionWithLevel
+  saturation: EffectActionWithLevel,
+  dpr: DeliveryDPRAction
 };
 
 /**

src/internal/models/IDeliveryActionModel.ts

@@ -7,7 +7,7 @@ interface IDeliveryColorSpaceActionModel extends IActionModel{
 }
 
 interface IDprModel extends IActionModel {
-  "type": number | string;
+  "dpr"?: number | string;
 }
 
 interface IDensityModel extends IActionModel {