Feature/color-space-from-icc-from-json (#469)

Author: Nir Maoz

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

@@ -8,4 +8,11 @@ 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'}
+    ]);
+
+    expect(transformation.toString()).toStrictEqual('cs_icc:sample');
+  });
 });

src/actions/delivery.ts

@@ -10,14 +10,14 @@ import {DeliveryFormat} from "./delivery/DeliveryFormat.js";
 import {DeliveryQualityAction} from "./delivery/DeliveryQuality.js";
 import {FormatQualifier} from "../qualifiers/format/FormatQualifier.js";
 import {toFloatAsString} from "../internal/utils/toFloatAsString.js";
-import {DeliveryColorSpaceFromICC} from "./delivery/DeliveryColorSpaceFromICC.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";
 
-export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceAction | DeliveryColorSpaceFromICC;
+export type IDeliveryAction = DeliveryAction | DeliveryColorSpaceAction | DeliveryColorSpaceFromICCAction;
 
 /**
  * @summary action
@@ -46,8 +46,6 @@ function format(format:FormatQualifier | ImageFormatType | VideoFormatType | str
   return new DeliveryFormat('f', format);
 }
 
-
-
 /**
  * @summary action
  * @description Deliver the image in the specified device pixel ratio.
@@ -69,7 +67,6 @@ function dpr(dpr: string|number):DeliveryAction {
   return new DeliveryAction('dpr', toFloatAsString(dpr), 'type');
 }
 
-
 /**
  * @summary action
  * @description Controls the quality of the delivered image or video.
@@ -117,8 +114,6 @@ function density(value:number) :DeliveryAction {
   return new DeliveryAction('dn', value, 'density');
 }
 
-
-
 /**
  * @summary action
  * @description Default images can be used in the case that a requested image does not exist.
@@ -139,7 +134,6 @@ function defaultImage(publicIdWithExtension:string) :DeliveryAction {
   return new DeliveryAction('d', publicIdWithExtension, 'defaultImage');
 }
 
-
 /**
  * @summary action
  * @description Controls the color space used for the delivered image.
@@ -161,7 +155,6 @@ function colorSpace(mode: ColorSpaceType): DeliveryColorSpaceAction {
   return new DeliveryColorSpaceAction(mode);
 }
 
-
 /**
  * @summary action
  * @description Specifies the ICC profile to use for the color space.
@@ -181,13 +174,10 @@ function colorSpace(mode: ColorSpaceType): DeliveryColorSpaceAction {
  *  colorSpaceFromICC('sample.icc'),
  * );
  */
-function colorSpaceFromICC(publicId:string) :DeliveryColorSpaceFromICC {
-  return new DeliveryColorSpaceFromICC(publicId);
+function colorSpaceFromICC(publicId: string): DeliveryColorSpaceFromICCAction {
+  return new DeliveryColorSpaceFromICCAction(publicId);
 }
 
-
-
-
 const Delivery = {
   format,
   dpr,

src/actions/delivery/DeliveryAction.ts

@@ -2,11 +2,8 @@ import {Action} from "../../internal/Action.js";
 import {FormatQualifier} from "../../qualifiers/format/FormatQualifier.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
 import {
-  IColorSpaceModel,
-  IDefaultImageModel,
-  IDeliveryFormatModel, IDeliveryQualityModel,
-  IDensityModel,
-  IDprModel
+  IDefaultImageModel, IDeliveryColorSpaceActionModel, IDeliveryColorSpaceFromICCActionModel,
+  IDeliveryFormatModel, IDeliveryQualityModel, IDensityModel, IDprModel
 } from "../../internal/models/IDeliveryActionModel.js";
 import {DELIVERY_MODE_TO_ACTION_TYPE_MAP} from "../../internal/internalConstants.js";
 
@@ -16,7 +13,7 @@ import {DELIVERY_MODE_TO_ACTION_TYPE_MAP} from "../../internal/internalConstants
  * @extends SDK.Action
  */
 class DeliveryAction extends Action {
-  protected _actionModel: IColorSpaceModel | IDprModel | IDensityModel | IDefaultImageModel | IDeliveryFormatModel | IDeliveryQualityModel = {};
+  protected _actionModel: IDeliveryColorSpaceActionModel | IDeliveryColorSpaceFromICCActionModel | IDprModel | IDensityModel | IDefaultImageModel | IDeliveryFormatModel | IDeliveryQualityModel = {};
 
   /**
    * @param {string} deliveryKey A generic Delivery Action Key (such as q, f, dn, etc.)

src/actions/delivery/DeliveryColorSpaceAction.ts

@@ -1,16 +1,13 @@
 import {Action} from "../../internal/Action.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
-import {
-  ColorSpaceModeType,
-  IDeliveryColorSpaceActionModel
-} from "../../internal/models/IDeliveryColorSpaceActionModel.js";
 import {IActionModel} from "../../internal/models/IActionModel.js";
 import {ColorSpace} from "../../qualifiers/colorSpace.js";
 import {ColorSpaceType} from "../../types/types.js";
 import {
   COLOR_SPACE_MODE_TO_COLOR_SPACE_MODEL_MODE_MAP,
   COLOR_SPACE_MODEL_MODE_TO_COLOR_SPACE_MODE_MAP
 } from "../../internal/internalConstants.js";
+import {IDeliveryColorSpaceActionModel, ColorSpaceModeType} from "../../internal/models/IDeliveryActionModel.js";
 
 /**
  * @description Specifies the color space to use.

…ns/delivery/DeliveryColorSpaceFromICC.ts …ivery/DeliveryColorSpaceFromICCAction.tssrc/actions/delivery/DeliveryColorSpaceFromICC.ts renamed to src/actions/delivery/DeliveryColorSpaceFromICCAction.ts src/actions/delivery/DeliveryColorSpaceFromICC.ts renamed to src/actions/delivery/DeliveryColorSpaceFromICCAction.ts

@@ -1,17 +1,17 @@
 import {Action} from "../../internal/Action.js";
 import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
-import {IColorSpaceFromICCModel} from "../../internal/models/IDeliveryActionModel.js";
-
+import {IActionModel} from "../../internal/models/IActionModel.js";
+import {IDeliveryColorSpaceFromICCActionModel} from "../../internal/models/IDeliveryActionModel.js";
 
 /**
  * @description Specifies the ICC profile to use for the color space.
  * @memberOf Actions.Delivery
  * @extends SDK.Action
  * @see Visit {@link Actions.Delivery|Delivery} for an example
  */
-class DeliveryColorSpaceFromICC extends Action {
-  protected _actionModel: IColorSpaceFromICCModel = {};
+class DeliveryColorSpaceFromICCAction extends Action {
+  protected _actionModel: IDeliveryColorSpaceFromICCActionModel = {};
 
   /**
    * @param {string} publicId
@@ -23,6 +23,12 @@ class DeliveryColorSpaceFromICC extends Action {
     const qualifierValue = new QualifierValue(['icc', publicId]).setDelimiter(':');
     this.addQualifier(new Qualifier('cs', qualifierValue));
   }
+
+  static fromJson(actionModel: IActionModel): DeliveryColorSpaceFromICCAction {
+    const {publicId} = (actionModel as IDeliveryColorSpaceFromICCActionModel);
+
+    return new this(publicId);
+  }
 }
 
-export {DeliveryColorSpaceFromICC};
+export {DeliveryColorSpaceFromICCAction};

src/internal/fromJson.ts

@@ -16,6 +16,7 @@ import {ResizePadAction} from "../actions/resize/ResizePadAction.js";
 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";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -29,7 +30,8 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   pad: ResizePadAction,
   limitPad: ResizeLimitPadAction,
   minimumPad: ResizeMinimumPadAction,
-  colorSpace: DeliveryColorSpaceAction
+  colorSpace: DeliveryColorSpaceAction,
+  colorSpaceFromICC: DeliveryColorSpaceFromICCAction
 };
 
 /**

src/internal/models/IDeliveryActionModel.ts

@@ -1,7 +1,9 @@
 import {IActionModel} from "./IActionModel.js";
 
-interface IColorSpaceModel extends IActionModel {
-  colorSpaceType?: string
+type ColorSpaceModeType = "srgb" | "srgbTrueColor" | "tinySrgb" | "cmyk" | "noCmyk" | "keepCmyk";
+
+interface IDeliveryColorSpaceActionModel extends IActionModel{
+  mode?: ColorSpaceModeType
 }
 
 interface IDprModel extends IActionModel {
@@ -16,8 +18,8 @@ interface IDefaultImageModel extends IActionModel{
   "publicId": string;
 }
 
-interface IColorSpaceFromICCModel extends IActionModel{
-  "publicId"?: string;
+interface IDeliveryColorSpaceFromICCActionModel extends IActionModel{
+  publicId?: string;
 }
 
 interface IDeliveryFormatModel extends IActionModel {
@@ -35,4 +37,4 @@ interface IDeliveryQualityModel extends IActionModel{
   "quantization"?: number;
 }
 
-export {IColorSpaceModel, IDprModel, IDensityModel, IDefaultImageModel, IColorSpaceFromICCModel, IDeliveryFormatModel, IDeliveryQualityModel};
+export {ColorSpaceModeType, IDeliveryColorSpaceActionModel, IDprModel, IDensityModel, IDefaultImageModel, IDeliveryColorSpaceFromICCActionModel, IDeliveryFormatModel, IDeliveryQualityModel};