Feature/concatenate to json (#501)

Author: Nir Maoz

__TESTS_BUNDLE_SIZE__/bundleSizeTestCases.ts

@@ -15,7 +15,7 @@ import importFromPackage from "./utils/stringGenerators/importFromPackage";
 const bundleSizeTestCases:ITestCase[] = [
   {
     name: 'Tests CloudinaryImage with Resize',
-    sizeLimitInKB: 25,
+    sizeLimitInKB: 26,
     importsArray: [
       importFromDist('assets/CloudinaryImage', 'CloudinaryImage'),
       importFromDist('instance/Cloudinary', 'Cloudinary'),
@@ -24,7 +24,7 @@ const bundleSizeTestCases:ITestCase[] = [
   },
   {
     name: 'Tests CloudinaryImage with Resize and Adjust',
-    sizeLimitInKB: 29,
+    sizeLimitInKB: 30,
     importsArray: [
       importFromDist('assets/CloudinaryImage', 'CloudinaryImage'),
       importFromDist('instance/Cloudinary', 'Cloudinary'),
@@ -88,7 +88,7 @@ const bundleSizeTestCases:ITestCase[] = [
   },
   {
     name: 'Import All Actions',
-    sizeLimitInKB: 43,
+    sizeLimitInKB: 44,
     importsArray: [
       importFromPackage('Actions')
     ]

__TESTS__/unit/fromJson/concatenate.fromJson.test.ts

@@ -6,7 +6,7 @@ describe('concatenate.fromJson', () => {
     const concatenateModel: IConcatenateActionModel = {
       actionType: 'concatenate',
       source: {
-        qualifierType: 'videoSource',
+        qualifierType: 'VideoSource',
         sourceType: 'video',
         publicId: 'dog'
       },
@@ -18,4 +18,26 @@ describe('concatenate.fromJson', () => {
 
     expect(transformation.toString()).toStrictEqual('du_1,fl_splice,l_video:dog/fl_layer_apply,so_0');
   });
+
+  it('Should generate ConcatenateAction with transition from model', ()=>{
+    const concatenateModel: IConcatenateActionModel = {
+      actionType: 'concatenate',
+      source: {
+        qualifierType: 'VideoSource',
+        sourceType: 'video',
+        publicId: 'dog'
+      },
+      prepend: true,
+      duration: 1,
+      transition: {
+        qualifierType: 'VideoSource',
+        sourceType: 'video',
+        publicId: 'cat'
+      }
+    };
+
+    const transformation = fromJson([concatenateModel]);
+
+    expect(transformation.toString()).toStrictEqual('du_1,l_video:dog/e_transition,l_video:cat/fl_layer_apply/fl_layer_apply,so_0');
+  });
 });

__TESTS__/unit/toJson/concatenate.toJson.test.ts

@@ -0,0 +1,31 @@
+import {Transformation} from '../../../src';
+import {Concatenate} from "../../../src/qualifiers/concatenate";
+import {VideoEdit} from "../../../src/actions";
+
+describe('concatenate.toJson()', () => {
+  it('Concatenate + prepend + duration + transition', () => {
+    const transformation = new Transformation()
+      .videoEdit(VideoEdit.concatenate(Concatenate.videoSource('dog'))
+        .prepend()
+        .duration(1)
+        .transition(Concatenate.videoSource('cat'))
+      );
+    expect(transformation.toJson()).toStrictEqual([
+      {
+        actionType: 'concatenate',
+        source: {
+          qualifierType: 'VideoSource',
+          sourceType: 'video',
+          publicId: 'dog'
+        },
+        prepend: true,
+        duration: 1,
+        transition: {
+          qualifierType: 'VideoSource',
+          sourceType: 'video',
+          publicId: 'cat'
+        }
+      }
+    ]);
+  });
+});

src/actions/videoEdit/ConcatenateAction.ts

@@ -6,6 +6,7 @@ import {FetchSource} from "../../qualifiers/source/sourceTypes/FetchSource.js";
 import {IActionModel} from "../../internal/models/IActionModel.js";
 import {IConcatenateActionModel} from "../../internal/models/IConcatenateActionModel.js";
 import {ITransformationFromJson} from "../../internal/models/IHasFromJson.js";
+import {IVideoSourceModel} from "../../internal/models/IVideoSourceModel.js";
 
 /**
  * @description Class for Concatenating another video.
@@ -31,7 +32,7 @@ class ConcatenateAction extends Action {
     super();
     this._actionModel = {
       actionType: 'concatenate',
-      source: { sourceType: 'video' }
+      source: source.toJson() as IVideoSourceModel
     };
 
     this.concatSource = source;
@@ -43,6 +44,7 @@ class ConcatenateAction extends Action {
    * @return {this}
    */
   transition(source: VideoSource): this {
+    this._actionModel.transition = source.toJson() as IVideoSourceModel;
     this._transition = source;
     return this;
   }
@@ -52,6 +54,7 @@ class ConcatenateAction extends Action {
    * @return {this}
    */
   prepend(): this {
+    this._actionModel.prepend = true;
     this._prepend = true;
     return this;
   }
@@ -62,6 +65,7 @@ class ConcatenateAction extends Action {
    * @return {this}
    */
   duration(sec: number): this {
+    this._actionModel.duration = sec;
     this._duration = sec;
     return this;
   }

src/internal/Action.ts

@@ -2,18 +2,14 @@ import {FlagQualifier} from "../qualifiers/flag/FlagQualifier.js";
 import {Qualifier} from "./qualifier/Qualifier.js";
 import {mapToSortedArray} from "./utils/dataStructureUtils.js";
 import {FlagTypes} from "../types/types.js";
-import {IActionModel} from "./models/IActionModel.js";
-import {IErrorObject} from "./models/IErrorObject.js";
-import {createUnsupportedError} from "./utils/unsupportedError.js";
+import {ActionModel} from "./models/ActionModel.js";
 
 /**
  * @summary SDK
  * @memberOf SDK
  * @description Defines the category of transformation to perform.
  */
-class Action {
-  protected _actionModel: IActionModel = {}; // Action model representation
-
+class Action extends ActionModel {
   // We're using map, to overwrite existing keys. for example:
   // addParam(w_100).addQualifier(w_200) should result in w_200. and not w_100,w_200
   qualifiers: Map<string, Qualifier> = new Map();
@@ -23,7 +19,8 @@ class Action {
   // So flags are stored separately until the very end because of that reason
   flags: FlagQualifier[] = [];
   private delimiter = ','; // {qualifier}{delimiter}{qualifier} for example: `${'w_100'}${','}${'c_fill'}`
-  protected prepareQualifiers():void {}
+  protected prepareQualifiers(): void {}
+
   private actionTag = ''; // A custom name tag to identify this action in the future
 
   /**
@@ -38,7 +35,7 @@ class Action {
    * @description Sets the custom name tag for this action
    * @return {this}
    */
-  setActionTag(tag:string): this {
+  setActionTag(tag: string): this {
     this.actionTag = tag;
     return this;
   }
@@ -96,15 +93,7 @@ class Action {
     return this;
   }
 
-  toJson(): IActionModel | IErrorObject{
-    if (this._actionModel.actionType){
-      return this._actionModel;
-    }
-
-    return {error: createUnsupportedError(`unsupported action ${this.constructor.name}`)};
-  }
-
-  protected addValueToQualifier(qualifierKey: string, qualifierValue: any): this{
+  protected addValueToQualifier(qualifierKey: string, qualifierValue: any): this {
     this.qualifiers.get(qualifierKey).addValue(qualifierValue);
 
     return this;

src/internal/models/ActionModel.ts

@@ -0,0 +1,11 @@
+import {IActionModel} from "./IActionModel.js";
+import {actionToJson} from "./actionToJson.js";
+
+export class ActionModel {
+  protected _actionModel: IActionModel;
+  toJson = actionToJson;
+
+  constructor() {
+    this._actionModel = {};
+  }
+}

src/internal/models/IVideoSourceModel.ts

@@ -2,7 +2,7 @@ import {ISourceModel} from "./ISourceModel.js";
 import {IVideoTransformationModel} from "./IVideoTransformationModel.js";
 
 export interface IVideoSourceModel extends ISourceModel {
-  qualifierType: "videoSource";
+  qualifierType: "VideoSource";
   sourceType: "video";
   publicId: string;
   transformation?: IVideoTransformationModel;

src/internal/models/QualifierModel.ts

@@ -0,0 +1,11 @@
+import {IQualifierModel} from "../models/IQualifierModel.js";
+import {qualifierToJson} from "../models/qualifierToJson.js";
+
+export class QualifierModel{
+  _qualifierModel: IQualifierModel;
+  toJson = qualifierToJson;
+
+  constructor() {
+    this._qualifierModel = {};
+  }
+}

src/internal/models/actionToJson.ts

@@ -0,0 +1,14 @@
+import {IActionModel} from "./IActionModel.js";
+import {IErrorObject} from "./IErrorObject.js";
+import {createUnsupportedError} from "../utils/unsupportedError.js";
+
+/**
+ * Returns the action's model
+ */
+export function actionToJson(): IActionModel | IErrorObject {
+  if (this._actionModel && this._actionModel.actionType) {
+    return this._actionModel;
+  }
+
+  return {error: createUnsupportedError(`unsupported action ${this.constructor.name}`)};
+}

src/internal/models/qualifierToJson.ts

@@ -0,0 +1,14 @@
+import {IErrorObject} from "./IErrorObject.js";
+import {createUnsupportedError} from "../utils/unsupportedError.js";
+import {IQualifierModel} from "./IQualifierModel.js";
+
+/**
+ * Returns the action's model
+ */
+export function qualifierToJson(): IQualifierModel | IErrorObject {
+  if (this._qualifierModel && this._qualifierModel.qualifierType) {
+    return this._qualifierModel;
+  }
+
+  return {error: createUnsupportedError(`unsupported qualifier ${this.constructor.name}`)};
+}