Add preview.toJson & preview.fromJson (#503)

Author: Nir Maoz

__TESTS__/unit/fromJson/preview.fromJson.test.ts

@@ -0,0 +1,17 @@
+import {fromJson} from "../../../src/internal/fromJson";
+import {IPreviewActionModel} from "../../../src/internal/models/IPreviewActionModel";
+
+describe('videoEdit.preview fromJson', () => {
+  it('Should generate PreviewAction from model', () => {
+    const previewModel: IPreviewActionModel = {
+      actionType: 'preview',
+      duration: 5,
+      maximumSegments: 10,
+      minimumSegmentDuration: 1
+    };
+
+    const transformation = fromJson({actions: [previewModel]});
+
+    expect(transformation.toString()).toStrictEqual('e_preview:duration_5.0:max_seg_10:min_seg_dur_1.0');
+  });
+});

__TESTS__/unit/toJson/preview.toJson.test.ts

@@ -0,0 +1,23 @@
+import {Transformation} from '../../../src';
+import {VideoEdit} from "../../../src/actions";
+
+describe('videoEdit.preview toJson', () => {
+  it('Should return a json representation of given preview action', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.preview()
+        .duration(1)
+        .maximumSegments(10)
+        .minimumSegmentDuration(1)
+      );
+    expect(transformation.toJson()).toStrictEqual({
+      actions: [
+        {
+          actionType: 'preview',
+          duration: 1,
+          maximumSegments: 10,
+          minimumSegmentDuration: 1
+        }
+      ]
+    });
+  });
+});

src/actions/videoEdit/PreviewAction.ts

@@ -1,5 +1,7 @@
 import {Action} from "../../internal/Action.js";
 import {toFloatAsString} from "../../internal/utils/toFloatAsString.js";
+import {IPreviewActionModel} from "../../internal/models/IPreviewActionModel.js";
+import {IActionModel} from "../../internal/models/IActionModel.js";
 
 /**
  * @description Class for creating a preview of a video
@@ -8,12 +10,16 @@ import {toFloatAsString} from "../../internal/utils/toFloatAsString.js";
  * @see Visit {@link Actions.VideoEdit|VideoEdit} for an example
  */
 class PreviewAction extends Action {
+  protected _actionModel: IPreviewActionModel;
   private _minSeg: string | number;
   private _maxSeg: string | number;
   private _duration: string | number;
 
   constructor() {
     super();
+    this._actionModel = {
+      actionType: 'preview'
+    };
   }
 
   /**
@@ -22,6 +28,7 @@ class PreviewAction extends Action {
    * @return {this}
    */
   minimumSegmentDuration(minSegDuration: string | number): this {
+    this._actionModel.minimumSegmentDuration = +minSegDuration;
     this._minSeg = minSegDuration;
     return this;
   }
@@ -32,6 +39,7 @@ class PreviewAction extends Action {
    * @return {this}
    */
   maximumSegments(maxSeg: string | number): this {
+    this._actionModel.maximumSegments = +maxSeg;
     this._maxSeg = maxSeg;
     return this;
   }
@@ -42,6 +50,7 @@ class PreviewAction extends Action {
    * @return {this}
    */
   duration(duration: string | number): this {
+    this._actionModel.duration = +duration;
     this._duration = duration;
     return this;
   }
@@ -54,6 +63,26 @@ class PreviewAction extends Action {
       this._minSeg && `min_seg_dur_${toFloatAsString(this._minSeg)}`
     ].filter((a) => a).join(':');
   }
+
+  static fromJson(actionModel: IActionModel): PreviewAction {
+    const {duration, maximumSegments, minimumSegmentDuration} = (actionModel as IPreviewActionModel);
+    // 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();
+    if (duration != null){
+      result.duration(duration);
+    }
+
+    if (maximumSegments != null){
+      result.maximumSegments(maximumSegments);
+    }
+
+    if (minimumSegmentDuration != null){
+      result.minimumSegmentDuration(minimumSegmentDuration);
+    }
+
+    return result;
+  }
 }
 
 export {PreviewAction};

src/internal/fromJson.ts

@@ -42,6 +42,7 @@ import {ImproveAction} from "../actions/adjust/ImproveAction.js";
 import {DeliveryDPRAction} from "../actions/delivery/DeliveryDPRAction.js";
 import ConcatenateAction from "../actions/videoEdit/ConcatenateAction.js";
 import {ITransformationModel} from "./models/ITransformationModel.js";
+import {PreviewAction} from "../actions/videoEdit/PreviewAction.js";
 
 const ActionModelMap: Record<string, IHasFromJson> = {
   scale: ResizeScaleAction,
@@ -93,7 +94,8 @@ const ActionModelMap: Record<string, IHasFromJson> = {
   contrast: EffectActionWithLevel,
   brightness: EffectActionWithLevel,
   gamma: EffectActionWithLevel,
-  concatenate: ConcatenateAction
+  concatenate: ConcatenateAction,
+  preview: PreviewAction
 };
 
 /**

src/internal/models/IPreviewActionModel.ts

@@ -0,0 +1,7 @@
+import {IActionModel} from "./IActionModel.js";
+
+export interface IPreviewActionModel extends IActionModel{
+  duration?: number;
+  maximumSegments?: number;
+  minimumSegmentDuration?: number;
+}