Feature/quality from json (#471)

Author: Nir Maoz

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

@@ -1,4 +1,8 @@
 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 () {
@@ -8,6 +12,7 @@ describe('delivery.fromJson', () => {
 
     expect(transformation.toString()).toStrictEqual('cs_srgb:truecolor');
   });
+
   it('should generate a transformation string from colorSpaceFromIcc action', function () {
     const transformation = fromJson([
       {actionType: 'colorSpaceFromICC', publicId: 'sample'}
@@ -39,4 +44,50 @@ describe('delivery.fromJson', () => {
 
     expect(transformation.toString()).toStrictEqual('f_gif,fl_lossy');
   });
+
+  it('quality:80', () => {
+    const transformation = fromJson([
+      {
+        actionType: 'quality',
+        level: '80'
+      }
+    ]);
+
+    expect(transformation.toString()).toStrictEqual('q_80');
+  });
+
+  it('quality:80.quantization', () => {
+    const transformation = fromJson([
+      {
+        actionType: 'quality',
+        level: '80',
+        quantization: 10
+      }
+    ]);
+
+    expect(transformation.toString()).toStrictEqual('q_80:qmax_10');
+  });
+
+  it('quality:auto', () => {
+    const transformation = fromJson([
+      {
+        actionType: 'quality',
+        level: 'auto'
+      }
+    ]);
+
+    expect(transformation.toString()).toStrictEqual('q_auto');
+  });
+
+  it('chromaSubSampling', () => {
+    const transformation = fromJson([
+      {
+        actionType: 'quality',
+        level: '75',
+        chromaSubSampling: 'CHROMA_420'
+      }
+    ]);
+
+    expect(transformation.toString()).toStrictEqual('q_75:420');
+  });
 });

src/actions/delivery.ts

@@ -7,7 +7,7 @@
  */
 
 import {DeliveryFormatAction} from "./delivery/DeliveryFormatAction.js";
-import {DeliveryQualityAction} from "./delivery/DeliveryQuality.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";

src/actions/delivery/DeliveryQuality.ts …ctions/delivery/DeliveryQualityAction.tssrc/actions/delivery/DeliveryQuality.ts renamed to src/actions/delivery/DeliveryQualityAction.ts src/actions/delivery/DeliveryQuality.ts renamed to src/actions/delivery/DeliveryQualityAction.ts

@@ -2,7 +2,8 @@ import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
 import {DeliveryAction} from "./DeliveryAction.js";
 import {IDeliveryQualityModel} from "../../internal/models/IDeliveryActionModel.js";
-import {ACTION_TYPE_TO_CHROMA_MAP} from "../../internal/internalConstants.js";
+import {CHROMA_VALUE_TO_CHROMA_MODEL_ENUM, CHROMA_MODEL_ENUM_TO_CHROMA_VALUE} from "../../internal/internalConstants.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
 
 
 /**
@@ -19,7 +20,6 @@ class DeliveryQualityAction extends DeliveryAction {
    */
   constructor(qualityValue: string | number) {
     super( 'q', qualityValue.toString(), 'level');
-    this.qualityValue = qualityValue;
   }
 
   /**
@@ -28,8 +28,8 @@ class DeliveryQualityAction extends DeliveryAction {
    * @param {420 | 444 | number} type The chroma sub sampling type
    */
   chromaSubSampling(type: 420 | 444 | number): this {
-    this._actionModel.chromaSubSampling = ACTION_TYPE_TO_CHROMA_MAP[type];
-    const qualityWithSubSampling = new QualifierValue([this.qualityValue, type]);
+    this._actionModel.chromaSubSampling = CHROMA_VALUE_TO_CHROMA_MODEL_ENUM[type];
+    const qualityWithSubSampling = new QualifierValue([this._actionModel.level, type]);
     qualityWithSubSampling.setDelimiter(':');
     // We either have chroma or quantization, but not both
     return this.addQualifier(new Qualifier('q', qualityWithSubSampling));
@@ -41,12 +41,26 @@ class DeliveryQualityAction extends DeliveryAction {
    */
   quantization(val:number): this {
     this._actionModel.quantization = val;
-    const qualityWithQuantization = new QualifierValue([this.qualityValue, `qmax_${val}`]);
-    qualityWithQuantization.setDelimiter(':');
+    const qualityWithQuantization = new QualifierValue([this._actionModel.level, `qmax_${val}`]).setDelimiter(':');
 
     // We either have chroma or quantization, but not both
     return this.addQualifier(new Qualifier('q', qualityWithQuantization));
   }
+
+  static fromJson(actionModel: IActionModel): DeliveryQualityAction {
+    const {level, chromaSubSampling, quantization} = (actionModel as IDeliveryQualityModel);
+    const result = new this(level);
+
+    if (chromaSubSampling){
+      //Turn strings like 'CHROMA_420' to 420
+      const chromaValue = CHROMA_MODEL_ENUM_TO_CHROMA_VALUE[chromaSubSampling.toUpperCase()];
+      chromaValue && result.chromaSubSampling(+chromaValue);
+    }
+
+    quantization && result.quantization(quantization);
+
+    return result;
+  }
 }
 
 export {DeliveryQualityAction};

src/internal/fromJson.ts

@@ -18,6 +18,7 @@ import {ResizeMinimumPadAction} from "../actions/resize/ResizeMinimumPadAction.j
 import {DeliveryColorSpaceAction} from "../actions/delivery/DeliveryColorSpaceAction.js";
 import {DeliveryColorSpaceFromICCAction} from "../actions/delivery/DeliveryColorSpaceFromICCAction.js";
 import {DeliveryFormatAction} from "../actions/delivery/DeliveryFormatAction.js";
+import {DeliveryQualityAction} from "../actions/delivery/DeliveryQualityAction.js";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -33,7 +34,8 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   minimumPad: ResizeMinimumPadAction,
   colorSpace: DeliveryColorSpaceAction,
   colorSpaceFromICC: DeliveryColorSpaceFromICCAction,
-  format: DeliveryFormatAction
+  format: DeliveryFormatAction,
+  quality: DeliveryQualityAction
 };
 
 /**

src/internal/internalConstants.ts

@@ -106,7 +106,7 @@ export const ACTION_TYPE_TO_EFFECT_MODE_MAP: Record<string, string> = {
   advancedRedEye: 'adv_redeye'
 };
 
-export const ACTION_TYPE_TO_CHROMA_MAP: Record<number, string> = {
+export const CHROMA_VALUE_TO_CHROMA_MODEL_ENUM: Record<number, string> = {
   444: "CHROMA_444",
   420: "CHROMA_420"
 };
@@ -118,6 +118,8 @@ export const COLOR_SPACE_MODEL_MODE_TO_COLOR_SPACE_MODE_MAP: Record<string, stri
   'srgbTrueColor': 'srgb:truecolor'
 };
 
+export const CHROMA_MODEL_ENUM_TO_CHROMA_VALUE = objectFlip(CHROMA_VALUE_TO_CHROMA_MODEL_ENUM);
+
 export const COLOR_SPACE_MODE_TO_COLOR_SPACE_MODEL_MODE_MAP = objectFlip(COLOR_SPACE_MODEL_MODE_TO_COLOR_SPACE_MODE_MAP);
 
 export const CROP_MODE_TO_ACTION_TYPE_MAP = objectFlip(ACTION_TYPE_TO_CROP_MODE_MAP);