@chili-publish/studio-sdk 0.123.0 → 0.133.2

package/lib/src/controllers/ToolController.js

@@ -45,56 +45,56 @@ export class ToolController {
         /**
          * This method returns selected tool
          */
-        this.getSelectedTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.getSelected = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ToolController_editorAPI, "f");
             return res.getSelectedTool().then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets the used tool to a Pointer tool
          */
-        this.setSelectTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setPointer = () => __awaiter(this, void 0, void 0, function* () {
             return this.setTool(ToolType.SELECT);
         });
         /**
          * This method sets the used tool to a Move tool
          */
-        this.setHandTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setHand = () => __awaiter(this, void 0, void 0, function* () {
             return this.setTool(ToolType.HAND);
         });
         /**
          * This method sets the used tool to a Zoom tool
          */
-        this.setZoomTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setZoom = () => __awaiter(this, void 0, void 0, function* () {
             yield this.setTool(ToolType.ZOOM);
         });
         /**
          * This method sets the used tool to a TextFrame tool
          */
-        this.setTextFrameTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setTextFrame = () => __awaiter(this, void 0, void 0, function* () {
             return this.setTool(ToolType.TEXT_FRAME);
         });
         /**
          * This method sets the used tool to a ImageFrame tool
          */
-        this.setImageFrameTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setImageFrame = () => __awaiter(this, void 0, void 0, function* () {
             return this.setTool(ToolType.IMAGE_FRAME);
         });
         /**
          * This method sets the used tool to a ShapeRectangle tool
          */
-        this.setShapeRectTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setShapeRect = () => __awaiter(this, void 0, void 0, function* () {
             return this.setTool(ToolType.SHAPE_RECT);
         });
         /**
          * This method sets the used tool to a ShapeEllipse tool
          */
-        this.setShapeEllipseTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setShapeEllipse = () => __awaiter(this, void 0, void 0, function* () {
             return this.setTool(ToolType.SHAPE_ELLIPSE);
         });
         /**
          * This method sets the used tool to a ShapePolygon tool
          */
-        this.setShapePolygonTool = () => __awaiter(this, void 0, void 0, function* () {
+        this.setShapePolygon = () => __awaiter(this, void 0, void 0, function* () {
             return this.setTool(ToolType.SHAPE_POLYGON);
         });
         __classPrivateFieldSet(this, _ToolController_editorAPI, editorAPI, "f");

package/lib/src/controllers/ToolController.js.map

@@ -1 +1 @@
-{"version":3,"file":"ToolController.js","sourceRoot":"","sources":["../../../src/controllers/ToolController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,cAAc;IAMvB;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,4CAAsB;QAStB;;;WAGG;QACK,YAAO,GAAG,CAAO,IAAc,EAAE,EAAE;YACvC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,iCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACnF,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,oBAAe,GAAG,GAAS,EAAE;YACzB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,iCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAW,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,kBAAa,GAAG,GAAS,EAAE;YACvB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,gBAAW,GAAG,GAAS,EAAE;YACrB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,gBAAW,GAAG,GAAS,EAAE;YACrB,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,qBAAgB,GAAG,GAAS,EAAE;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,sBAAiB,GAAG,GAAS,EAAE;YAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,qBAAgB,GAAG,GAAS,EAAE;YAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,wBAAmB,GAAG,GAAS,EAAE;YAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,wBAAmB,GAAG,GAAS,EAAE;YAC7B,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC,CAAA,CAAC;QA1EE,uBAAA,IAAI,6BAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA0EJ"}
+{"version":3,"file":"ToolController.js","sourceRoot":"","sources":["../../../src/controllers/ToolController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,cAAc;IAMvB;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,4CAAsB;QAStB;;;WAGG;QACH,YAAO,GAAG,CAAO,IAAc,EAAE,EAAE;YAC/B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,iCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACnF,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,gBAAW,GAAG,GAAS,EAAE;YACrB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,iCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAW,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,eAAU,GAAG,GAAS,EAAE;YACpB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACzC,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,YAAO,GAAG,GAAS,EAAE;YACjB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,YAAO,GAAG,GAAS,EAAE;YACjB,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,iBAAY,GAAG,GAAS,EAAE;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,kBAAa,GAAG,GAAS,EAAE;YACvB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAC9C,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,iBAAY,GAAG,GAAS,EAAE;YACtB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;QAC7C,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,oBAAe,GAAG,GAAS,EAAE;YACzB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC,CAAA,CAAC;QAEF;;WAEG;QACH,oBAAe,GAAG,GAAS,EAAE;YACzB,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;QAChD,CAAC,CAAA,CAAC;QA1EE,uBAAA,IAAI,6BAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA0EJ"}

package/lib/src/controllers/UtilsController.d.ts

@@ -1,20 +1,26 @@
+import { EnvironmentType } from '../utils/enums';
 /**
- * The UtilsController exposes a set of usefull utilities that can be used to make some repeated tasks a bit easier
+ * The UtilsController exposes a set of useful utilities that can be used to make some repeated tasks a bit easier
  * Methods inside this controller can be called by `window.SDK.utils.{method-name}`
  */
 export declare class UtilsController {
     /**
      * This method can calculate what's inside a string that represents a calculation (f.e. "1 + 5 - 2" will result in 4)
      * @param val the string value that needs to be calculated
-     * @param precision the precision that the calculation should round to (f.e. if the return value is 5.012 and precision is 2, the endresult should be 5.01) 2 is also the default
-     * @returns The calculated value or null in case that it can't be calculated
+     * @param precision the precision that the calculation should round to (f.e. if the return value is 5.012 and precision is 2, the end result should be 5.01) 2 is also the default
+     * @returns the calculated value or null in case that it can't be calculated
      */
     calculateFromString: (val: string, precision?: number) => import("..").EditorResponse<number>;
     /**
      * This method can round a value to a certain precision, default is 2
      * @param val the value that needs to be rounded
      * @param precision the precision of the rounding operation
-     * @returns The rounded value as a number
+     * @returns the rounded value as a number
      */
     round: (val: number, precision?: number) => import("..").EditorResponse<number>;
+    createEnvironmentBaseURL: (parameters: {
+        type?: EnvironmentType;
+        environment?: string;
+        version?: string;
+    }) => string;
 }

package/lib/src/controllers/UtilsController.js

@@ -1,7 +1,8 @@
 import { getCalculatedValue, round } from '../utils/getCalculatedValue';
 import { getEditorResponseData } from '../utils/EditorResponseData';
+import { EnvironmentType } from '../utils/enums';
 /**
- * The UtilsController exposes a set of usefull utilities that can be used to make some repeated tasks a bit easier
+ * The UtilsController exposes a set of useful utilities that can be used to make some repeated tasks a bit easier
  * Methods inside this controller can be called by `window.SDK.utils.{method-name}`
  */
 export class UtilsController {
@@ -9,8 +10,8 @@ export class UtilsController {
         /**
          * This method can calculate what's inside a string that represents a calculation (f.e. "1 + 5 - 2" will result in 4)
          * @param val the string value that needs to be calculated
-         * @param precision the precision that the calculation should round to (f.e. if the return value is 5.012 and precision is 2, the endresult should be 5.01) 2 is also the default
-         * @returns The calculated value or null in case that it can't be calculated
+         * @param precision the precision that the calculation should round to (f.e. if the return value is 5.012 and precision is 2, the end result should be 5.01) 2 is also the default
+         * @returns the calculated value or null in case that it can't be calculated
          */
         this.calculateFromString = (val, precision) => getEditorResponseData({
             data: String(getCalculatedValue(val, precision)),
@@ -22,7 +23,7 @@ export class UtilsController {
          * This method can round a value to a certain precision, default is 2
          * @param val the value that needs to be rounded
          * @param precision the precision of the rounding operation
-         * @returns The rounded value as a number
+         * @returns the rounded value as a number
          */
         this.round = (val, precision) => getEditorResponseData({
             data: String(round(val, precision)),
@@ -30,6 +31,11 @@ export class UtilsController {
             status: 200,
             parsedData: null,
         });
+        this.createEnvironmentBaseURL = (parameters) => {
+            const { type = EnvironmentType.SANDBOX, environment = 'ft-nostress', version = '1' } = parameters;
+            const host = type == EnvironmentType.SANDBOX ? 'chili-publish-sandbox' : 'chili-publish';
+            return `https://${environment}.${host}.online/grafx/api/v${version}/environment/${environment}`;
+        };
     }
 }
 //# sourceMappingURL=UtilsController.js.map

package/lib/src/controllers/UtilsController.js.map

@@ -1 +1 @@
-{"version":3,"file":"UtilsController.js","sourceRoot":"","sources":["../../../src/controllers/UtilsController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,eAAe;IAA5B;QACI;;;;;WAKG;QACH,wBAAmB,GAAG,CAAC,GAAW,EAAE,SAAkB,EAAE,EAAE,CACtD,qBAAqB,CAAS;YAC1B,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAChD,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QAEP;;;;;WAKG;QACH,UAAK,GAAG,CAAC,GAAW,EAAE,SAAkB,EAAE,EAAE,CACxC,qBAAqB,CAAS;YAC1B,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YACnC,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;IACX,CAAC;CAAA"}
+{"version":3,"file":"UtilsController.js","sourceRoot":"","sources":["../../../src/controllers/UtilsController.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,KAAK,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;;GAGG;AACH,MAAM,OAAO,eAAe;IAA5B;QACI;;;;;WAKG;QACH,wBAAmB,GAAG,CAAC,GAAW,EAAE,SAAkB,EAAE,EAAE,CACtD,qBAAqB,CAAS;YAC1B,IAAI,EAAE,MAAM,CAAC,kBAAkB,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YAChD,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QAEP;;;;;WAKG;QACH,UAAK,GAAG,CAAC,GAAW,EAAE,SAAkB,EAAE,EAAE,CACxC,qBAAqB,CAAS;YAC1B,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;YACnC,OAAO,EAAE,IAAI;YACb,MAAM,EAAE,GAAG;YACX,UAAU,EAAE,IAAI;SACnB,CAAC,CAAC;QAEP,6BAAwB,GAAG,CAAC,UAA8E,EAAE,EAAE;YAC1G,MAAM,EAAE,IAAI,GAAG,eAAe,CAAC,OAAO,EAAE,WAAW,GAAG,aAAa,EAAE,OAAO,GAAG,GAAG,EAAE,GAAG,UAAU,CAAC;YAClG,MAAM,IAAI,GAAG,IAAI,IAAI,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,eAAe,CAAC;YACzF,OAAO,WAAW,WAAW,IAAI,IAAI,sBAAsB,OAAO,gBAAgB,WAAW,EAAE,CAAC;QACpG,CAAC,CAAC;IACN,CAAC;CAAA"}

package/lib/src/controllers/VariableController.d.ts

@@ -1,5 +1,5 @@
-import { EditorAPI } from '../types/CommonTypes';
-import { Variable, VariableMoves, ImageVariableSource, VariableType } from '../types/VariableTypes';
+import { EditorAPI, Id } from '../types/CommonTypes';
+import { Variable, ImageVariableSource, VariableType } from '../types/VariableTypes';
 /**
  * The VariableController is responsible for all communication regarding the variables.
  * Methods inside this controller can be called by `window.SDK.variable.{method-name}`
@@ -14,104 +14,148 @@ export declare class VariableController {
      * This method returns the list of variables
      * @returns
      */
-    getVariables: () => Promise<import("../types/CommonTypes").EditorResponse<Variable[]>>;
+    getAll: () => Promise<import("../types/CommonTypes").EditorResponse<Variable[]>>;
     /**
      * This method returns a variable by id
-     * @param variableId The ID of a specific variable
+     * @param id the id of a specific variable
      * @returns
      */
-    getVariableById: (variableId: string) => Promise<import("../types/CommonTypes").EditorResponse<Variable>>;
+    getById: (id: string) => Promise<import("../types/CommonTypes").EditorResponse<Variable>>;
     /**
      * This method returns a variable by name
-     * @param variableName The name of a specific variable
+     * @param name the name of a specific variable
      * @returns
      */
-    getVariableByName: (variableName: string) => Promise<import("../types/CommonTypes").EditorResponse<Variable>>;
+    getByName: (name: string) => Promise<import("../types/CommonTypes").EditorResponse<Variable>>;
     /**
-     * This method adds a new variable
-     * @returns The new created variable id
+     * This method creates a new variable
+     * @param parentId parent id of the created variable
+     * @param type type of the created variable
+     * @returns the new created variable id
      */
-    addVariable: (parentId: string, variableType: VariableType) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    create: (parentId: string, type: VariableType) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
     /**
      * This method removes a list of variables
+     * @param ids list of the variables to be removed
      * @returns
      */
-    removeVariables: (variableIds: string[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    remove: (ids: string[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method sets a new name for a variable
+     * @param id id of the variable
+     * @param name name of the variable
      * @returns
      */
-    setVariableName: (variableId: string, name: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    rename: (id: string, name: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method sets a new label for a variable
+     * @param id id of the variable
+     * @param label label of the variable
      * @returns
      */
-    setVariableLabel: (variableId: string, label: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setLabel: (id: string, label: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method sets a new type for a variable
+     * @param id id of the variable
+     * @param type type of the variable
      * @returns
      */
-    setVariableType: (variableId: string, type: VariableType) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setType: (id: string, type: VariableType) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method sets the items of the list variable
+     *
+     * The items need to be unique and are not case sensitive.
+     *
+     * @param id the id of the list variable
+     * @param items the items of the list
+     * @returns
+     */
+    setListVariable: (id: Id, items: string[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method sets a new value for a variable
+     *
+     * @param id the id of the variable
+     * @param value the new value of the variable
      * @returns
      */
-    setVariableValue: (variableId: string, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setValue: (id: Id, value: string | null) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method creates a copy of a variable
      * @returns
      */
-    duplicateVariable: (variableId: string) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    duplicate: (id: string) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
     /**
      * This method aggregates the provided variables into a new group
-     * @returns
+     * @param name name of the new group
+     * @param ids list of variable ids to group together
+     * @returns group id
      */
-    groupVariables: (groupName: string, variableIds: string[]) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    groupVariables: (name: string, ids: string[]) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
     /**
      * This method dissolves the specified group
+     * @param id id of the variable group
      * @returns
      */
-    ungroupVariable: (groupId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    ungroupVariables: (id: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method moves a variable's position
+     * @param order new order of variable
+     * @param id id of the variable
+     * @param parentId parent id of the created variable
      * @returns
      */
-    moveVariable: (variableId: string, parentId: string, orderIndex: number) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    move: (order: number, id: string, parentId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method changes positions of variables
+     * @param order new order of variable
+     * @param ids Array of the variable IDs
+     * @param parentId parent id of the variables
+     * @returns
+     */
+    moveVariables: (order: number, ids: string[], parentId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method sets isVisible flag for a variable
      * @returns
      */
-    moveVariables: (movedVariables: VariableMoves) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setIsVisible: (id: string, isVisible: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
+     * @deprecated Use `setIsVisible` instead.
+     *
      * This method sets isHidden flag for a variable
      * @returns
      */
-    setVariableIsHidden: (variableId: string, isHidden: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setIsHidden: (id: string, isHidden: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method sets isRequired flag for a variable
      * @returns
      */
-    setVariableIsRequired: (variableId: string, isRequired: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setIsRequired: (id: string, isRequired: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method sets isReadonly flag for a variable
      * @returns
      */
-    setVariableIsReadonly: (variableId: string, isReadonly: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setIsReadonly: (id: string, isReadonly: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
-     * This method sets or removes the variable source
-     * @param variableId The ID of the variable to update
-     * @param src The new variable source
+     * @deprecated Use `setValue` and `setImageVariableConnector` instead.
+     *
+     * This method sets the variable source
+     * @param id the id of the variable to update
+     * @param source the new variable source
      */
-    private updateVariableSource;
+    setSource: (id: string, source?: ImageVariableSource) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
-     * This method sets the variable source
-     * @param variableId The ID of the variable to update
-     * @param src The new variable source
+     * This method sets the image variable connector. Setting a connector will
+     * automatically remove the assetId linked to the connector if present.
+     * @param id The ID of the image variable to update
+     * @param connectorId The new ID of the connector
+     * @returns
      */
-    setVariableSource: (variableId: string, src: ImageVariableSource) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setImageVariableConnector: (id: string, connectorId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
+     * @deprecated use `setValue` instead and pass `null` as the value argument.
+     *
      * This method removes the variable source
-     * @param variableId The ID of the variable to update
+     * @param id the id of the variable to update
      */
-    removeVariableSource: (variableId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    removeSource: (id: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
 }

package/lib/src/controllers/VariableController.js

@@ -19,6 +19,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
 var _VariableController_editorAPI;
+import { ImageVariableSourceType, } from '../types/VariableTypes';
 import { getEditorResponseData } from '../utils/EditorResponseData';
 /**
  * The VariableController is responsible for all communication regarding the variables.
@@ -37,166 +38,218 @@ export class VariableController {
          * This method returns the list of variables
          * @returns
          */
-        this.getVariables = () => __awaiter(this, void 0, void 0, function* () {
+        this.getAll = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
             return res.getVariables().then((result) => getEditorResponseData(result));
         });
         /**
          * This method returns a variable by id
-         * @param variableId The ID of a specific variable
+         * @param id the id of a specific variable
          * @returns
          */
-        this.getVariableById = (variableId) => __awaiter(this, void 0, void 0, function* () {
+        this.getById = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.getVariableById(variableId).then((result) => getEditorResponseData(result));
+            return res.getVariableById(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method returns a variable by name
-         * @param variableName The name of a specific variable
+         * @param name the name of a specific variable
          * @returns
          */
-        this.getVariableByName = (variableName) => __awaiter(this, void 0, void 0, function* () {
+        this.getByName = (name) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.getVariableByName(variableName).then((result) => getEditorResponseData(result));
+            return res.getVariableByName(name).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method adds a new variable
-         * @returns The new created variable id
+         * This method creates a new variable
+         * @param parentId parent id of the created variable
+         * @param type type of the created variable
+         * @returns the new created variable id
          */
-        this.addVariable = (parentId, variableType) => __awaiter(this, void 0, void 0, function* () {
+        this.create = (parentId, type) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.addVariable(parentId, variableType).then((result) => getEditorResponseData(result));
+            return res.addVariable(parentId, type).then((result) => getEditorResponseData(result));
         });
         /**
          * This method removes a list of variables
+         * @param ids list of the variables to be removed
          * @returns
          */
-        this.removeVariables = (variableIds) => __awaiter(this, void 0, void 0, function* () {
+        this.remove = (ids) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.removeVariables(variableIds).then((result) => getEditorResponseData(result));
+            return res.removeVariables(ids).then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets a new name for a variable
+         * @param id id of the variable
+         * @param name name of the variable
          * @returns
          */
-        this.setVariableName = (variableId, name) => __awaiter(this, void 0, void 0, function* () {
+        this.rename = (id, name) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.setVariableName(variableId, name).then((result) => getEditorResponseData(result));
+            return res.setVariableName(id, name).then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets a new label for a variable
+         * @param id id of the variable
+         * @param label label of the variable
          * @returns
          */
-        this.setVariableLabel = (variableId, label) => __awaiter(this, void 0, void 0, function* () {
+        this.setLabel = (id, label) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.setVariableLabel(variableId, label).then((result) => getEditorResponseData(result));
+            return res.setVariableLabel(id, label).then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets a new type for a variable
+         * @param id id of the variable
+         * @param type type of the variable
          * @returns
          */
-        this.setVariableType = (variableId, type) => __awaiter(this, void 0, void 0, function* () {
+        this.setType = (id, type) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.setVariableType(variableId, type).then((result) => getEditorResponseData(result));
+            return res.setVariableType(id, type).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method sets the items of the list variable
+         *
+         * The items need to be unique and are not case sensitive.
+         *
+         * @param id the id of the list variable
+         * @param items the items of the list
+         * @returns
+         */
+        this.setListVariable = (id, items) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
+            return res.setListVariableItems(id, items).then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets a new value for a variable
+         *
+         * @param id the id of the variable
+         * @param value the new value of the variable
          * @returns
          */
-        this.setVariableValue = (variableId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setValue = (id, value) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.setVariableValue(variableId, value).then((result) => getEditorResponseData(result));
+            return res.setVariableValue(id, value).then((result) => getEditorResponseData(result));
         });
         /**
          * This method creates a copy of a variable
          * @returns
          */
-        this.duplicateVariable = (variableId) => __awaiter(this, void 0, void 0, function* () {
+        this.duplicate = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.duplicateVariable(variableId).then((result) => getEditorResponseData(result));
+            return res.duplicateVariable(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method aggregates the provided variables into a new group
-         * @returns
+         * @param name name of the new group
+         * @param ids list of variable ids to group together
+         * @returns group id
          */
-        this.groupVariables = (groupName, variableIds) => __awaiter(this, void 0, void 0, function* () {
+        this.groupVariables = (name, ids) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.groupVariables(groupName, variableIds).then((result) => getEditorResponseData(result));
+            return res.groupVariables(name, ids).then((result) => getEditorResponseData(result));
         });
         /**
          * This method dissolves the specified group
+         * @param id id of the variable group
          * @returns
          */
-        this.ungroupVariable = (groupId) => __awaiter(this, void 0, void 0, function* () {
+        this.ungroupVariables = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.ungroupVariable(groupId).then((result) => getEditorResponseData(result));
+            return res.ungroupVariable(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method moves a variable's position
+         * @param order new order of variable
+         * @param id id of the variable
+         * @param parentId parent id of the created variable
          * @returns
          */
-        this.moveVariable = (variableId, parentId, orderIndex) => __awaiter(this, void 0, void 0, function* () {
+        this.move = (order, id, parentId) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.moveVariable(variableId, parentId, orderIndex).then((result) => getEditorResponseData(result));
+            return res.moveVariable(id, parentId, order).then((result) => getEditorResponseData(result));
         });
         /**
          * This method changes positions of variables
+         * @param order new order of variable
+         * @param ids Array of the variable IDs
+         * @param parentId parent id of the variables
          * @returns
          */
-        this.moveVariables = (movedVariables) => __awaiter(this, void 0, void 0, function* () {
+        this.moveVariables = (order, ids, parentId) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
             return res
-                .moveVariables(movedVariables.moves, movedVariables.parent, movedVariables.order)
+                .moveVariables(ids, parentId, order)
                 .then((result) => getEditorResponseData(result));
         });
         /**
+         * This method sets isVisible flag for a variable
+         * @returns
+         */
+        this.setIsVisible = (id, isVisible) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
+            return res.setVariableIsVisible(id, isVisible).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * @deprecated Use `setIsVisible` instead.
+         *
          * This method sets isHidden flag for a variable
          * @returns
          */
-        this.setVariableIsHidden = (variableId, isHidden) => __awaiter(this, void 0, void 0, function* () {
+        this.setIsHidden = (id, isHidden) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.setVariableIsHidden(variableId, isHidden).then((result) => getEditorResponseData(result));
+            return res.setVariableIsVisible(id, !isHidden).then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets isRequired flag for a variable
          * @returns
          */
-        this.setVariableIsRequired = (variableId, isRequired) => __awaiter(this, void 0, void 0, function* () {
+        this.setIsRequired = (id, isRequired) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.setVariableIsRequired(variableId, isRequired).then((result) => getEditorResponseData(result));
+            return res.setVariableIsRequired(id, isRequired).then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets isReadonly flag for a variable
          * @returns
          */
-        this.setVariableIsReadonly = (variableId, isReadonly) => __awaiter(this, void 0, void 0, function* () {
+        this.setIsReadonly = (id, isReadonly) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            return res.setVariableIsReadonly(variableId, isReadonly).then((result) => getEditorResponseData(result));
+            return res.setVariableIsReadonly(id, isReadonly).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method sets or removes the variable source
-         * @param variableId The ID of the variable to update
-         * @param src The new variable source
+         * @deprecated Use `setValue` and `setImageVariableConnector` instead.
+         *
+         * This method sets the variable source
+         * @param id the id of the variable to update
+         * @param source the new variable source
          */
-        this.updateVariableSource = (variableId, src) => __awaiter(this, void 0, void 0, function* () {
-            const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
-            const srcJson = src !== null ? JSON.stringify(src) : null;
-            return res.setVariableSource(variableId, srcJson).then((result) => getEditorResponseData(result));
+        this.setSource = (id, source) => __awaiter(this, void 0, void 0, function* () {
+            const value = source && source.type === ImageVariableSourceType.mediaConnector
+                ? source.assetId
+                : null;
+            return this.setValue(id, value);
         });
         /**
-         * This method sets the variable source
-         * @param variableId The ID of the variable to update
-         * @param src The new variable source
+         * This method sets the image variable connector. Setting a connector will
+         * automatically remove the assetId linked to the connector if present.
+         * @param id The ID of the image variable to update
+         * @param connectorId The new ID of the connector
+         * @returns
          */
-        this.setVariableSource = (variableId, src) => __awaiter(this, void 0, void 0, function* () {
-            return this.updateVariableSource(variableId, src);
+        this.setImageVariableConnector = (id, connectorId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _VariableController_editorAPI, "f");
+            return res.setImageVariableConnector(id, connectorId).then((result) => getEditorResponseData(result));
         });
         /**
+         * @deprecated use `setValue` instead and pass `null` as the value argument.
+         *
          * This method removes the variable source
-         * @param variableId The ID of the variable to update
+         * @param id the id of the variable to update
          */
-        this.removeVariableSource = (variableId) => __awaiter(this, void 0, void 0, function* () {
-            return this.updateVariableSource(variableId, null);
+        this.removeSource = (id) => __awaiter(this, void 0, void 0, function* () {
+            return this.setValue(id, null);
         });
         __classPrivateFieldSet(this, _VariableController_editorAPI, editorAPI, "f");
     }