@chili-publish/studio-sdk 0.123.0 → 0.133.2

package/lib/src/controllers/ActionController.js

@@ -35,78 +35,89 @@ export class ActionController {
         _ActionController_editorAPI.set(this, void 0);
         /**
          * This method returns the list of all actions.
-         * @returns
+         * @returns list of all actions
          */
-        this.getActions = () => __awaiter(this, void 0, void 0, function* () {
+        this.getAll = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
             return res.getActions().then((result) => getEditorResponseData(result));
         });
         /**
-         * This method returns an action by id
-         * @param actionId The ID of a specific action
-         * @returns
+         * This method returns an action by the id
+         * @param id the id of a specific action
+         * @returns action details
          */
-        this.getActionById = (actionId) => __awaiter(this, void 0, void 0, function* () {
+        this.getById = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
-            return res.getActionById(actionId).then((result) => getEditorResponseData(result));
+            return res.getActionById(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method creates a new action.
-         * @returns The ID of the newly created action.
+         * @returns the id of the newly created action.
          */
-        this.createAction = () => __awaiter(this, void 0, void 0, function* () {
+        this.create = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
             return res.createAction().then((result) => getEditorResponseData(result));
         });
         /**
-         * This method duplicates an existing action.
-         * @returns The ID of the duplicated action.
+         * This method duplicates an existing action by the id
+         * @param id the id of a specific action
+         * @returns the id of the duplicated action.
          */
-        this.duplicateAction = (actionId) => __awaiter(this, void 0, void 0, function* () {
+        this.duplicate = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
-            return res.duplicateAction(actionId).then((result) => getEditorResponseData(result));
+            return res.duplicateAction(id).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method removes the action.
-         * @param actionId The ID of a specific action
+         * This method removes the action by the id
+         * @param id the id of a specific action
          * @returns
          */
-        this.removeAction = (actionId) => __awaiter(this, void 0, void 0, function* () {
+        this.remove = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
-            return res.removeAction(actionId).then((result) => getEditorResponseData(result));
+            return res.removeAction(id).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method renames an action.
-         * @param actionId The ID of a specific action
-         * @param name The new unique name for the action
+         * This method renames an action by the id and provided name
+         * @param id the id of a specific action
+         * @param name the new unique name for the action
          * @returns
          */
-        this.renameAction = (actionId, name) => __awaiter(this, void 0, void 0, function* () {
+        this.rename = (id, name) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
-            return res.renameAction(actionId, name).then((result) => getEditorResponseData(result));
+            return res.renameAction(id, name).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method updates the script the action uses.
-         * @param actionId The ID of a specific action
-         * @param script The JavaScript based action script
+         * This method updates the script the action uses by the id and provided script
+         * @param id the id of a specific action
+         * @param actionScript the JavaScript based action script
          * @returns
          */
-        this.updateActionScript = (actionId, script) => __awaiter(this, void 0, void 0, function* () {
+        this.updateScript = (id, actionScript) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
-            return res.updateActionScript(actionId, script).then((result) => getEditorResponseData(result));
+            return res.updateActionScript(id, actionScript).then((result) => getEditorResponseData(result));
         });
         /**
          * This method updates the triggers on which the action will react.
-         * @param actionId The ID of a specific action
-         * @param triggers The triggers this action should react on.
+         * @param id the id of a specific action
+         * @param triggers the triggers this action should react on.
          * @returns
          */
-        this.updateActionTriggers = (actionId, triggers) => __awaiter(this, void 0, void 0, function* () {
+        this.updateTriggers = (id, triggers) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
             return res
-                .updateActionTriggers(actionId, JSON.stringify(triggers))
+                .updateActionTriggers(id, JSON.stringify(triggers))
                 .then((result) => getEditorResponseData(result));
         });
+        /**
+         * This method changes positions of actions
+         * @param order the position of actions
+         * @param ids the list of action IDs
+         * @returns
+         */
+        this.move = (order, ids) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _ActionController_editorAPI, "f");
+            return res.moveActions(order, ids).then((result) => getEditorResponseData(result));
+        });
         __classPrivateFieldSet(this, _ActionController_editorAPI, editorAPI, "f");
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"ActionController.js","sourceRoot":"","sources":["../../../src/controllers/ActionController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAMzB;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,8CAAsB;QAStB;;;WAGG;QACH,eAAU,GAAG,GAAS,EAAE;YACpB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,kBAAa,GAAG,CAAO,QAAY,EAAE,EAAE;YACnC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiB,MAAM,CAAC,CAAC,CAAC;QACvG,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,iBAAY,GAAG,GAAS,EAAE;YACtB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAK,MAAM,CAAC,CAAC,CAAC;QAClF,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,oBAAe,GAAG,CAAO,QAAY,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAK,MAAM,CAAC,CAAC,CAAC;QAC7F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,iBAAY,GAAG,CAAO,QAAY,EAAE,EAAE;YAClC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,iBAAY,GAAG,CAAO,QAAY,EAAE,IAAY,EAAE,EAAE;YAChD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAClG,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,uBAAkB,GAAG,CAAO,QAAY,EAAE,MAAc,EAAE,EAAE;YACxD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,kBAAkB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC1G,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,yBAAoB,GAAG,CAAO,QAAY,EAAE,QAAyB,EAAE,EAAE;YACrE,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,oBAAoB,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;iBACxD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAnFE,uBAAA,IAAI,+BAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CAmFJ"}
+{"version":3,"file":"ActionController.js","sourceRoot":"","sources":["../../../src/controllers/ActionController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAMzB;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,8CAAsB;QAStB;;;WAGG;QACH,WAAM,GAAG,GAAS,EAAE;YAChB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,YAAO,GAAG,CAAO,EAAM,EAAE,EAAE;YACvB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiB,MAAM,CAAC,CAAC,CAAC;QACjG,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,WAAM,GAAG,GAAS,EAAE;YAChB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAK,MAAM,CAAC,CAAC,CAAC;QAClF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,cAAS,GAAG,CAAO,EAAM,EAAE,EAAE;YACzB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAK,MAAM,CAAC,CAAC,CAAC;QACvF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,WAAM,GAAG,CAAO,EAAM,EAAE,EAAE;YACtB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACtF,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,WAAM,GAAG,CAAO,EAAM,EAAE,IAAY,EAAE,EAAE;YACpC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,iBAAY,GAAG,CAAO,EAAM,EAAE,YAAoB,EAAE,EAAE;YAClD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,kBAAkB,CAAC,EAAE,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC1G,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,mBAAc,GAAG,CAAO,EAAM,EAAE,QAAyB,EAAE,EAAE;YACzD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,oBAAoB,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;iBAClD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,SAAI,GAAG,CAAO,KAAa,EAAE,GAAa,EAAE,EAAE;YAC1C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,WAAW,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC7F,CAAC,CAAA,CAAC;QA/FE,uBAAA,IAAI,+BAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA+FJ"}

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

@@ -12,59 +12,59 @@ export declare class AnimationController {
     constructor(children: EditorAPI);
     /**
      * This method returns all animations on current layout
-     * @returns
+     * @returns list of all animation on current layout
      */
-    getAnimationsOnSelectedLayout: () => Promise<import("../types/CommonTypes").EditorResponse<FrameAnimationPropertiesType[]>>;
+    getAllOnSelectedLayout: () => Promise<import("../types/CommonTypes").EditorResponse<FrameAnimationPropertiesType[]>>;
     /**
-     * This method returns an animation for a given frame and layout
-     * @param frameId The ID of a specific frame
-     * @param layoutId The ID of a specific layout
-     * @returns
+     * This method returns an animation for a given frame and layout IDs
+     * @param id the id of a specific frame
+     * @param layoutId the id of a specific layout
+     * @returns animation properties for a given frame and layout
      */
-    getAnimationByFrameId: (frameId: Id, layoutId?: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameAnimationPropertiesType>>;
+    getByFrameId: (id: Id, layoutId?: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameAnimationPropertiesType>>;
     /**
-     * This method returns the animations for a given layout
-     * @param layoutId The ID of a specific layout
-     * @returns
+     * This method returns the animations for a given layout id
+     * @param id the id of a specific layout
+     * @returns animation properties for a given layout
      */
-    getAnimationsByLayoutId: (layoutId: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameAnimationPropertiesType>>;
+    getByLayoutId: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameAnimationPropertiesType>>;
     /**
      * This method sets the animation state for a certain Frame
-     * @param animation
-     * @returns
+     * @param animation animation properties
+     * @returns updated animation properties
      */
     setFrameAnimation: (animation: FrameAnimationPropertiesType) => Promise<import("../types/CommonTypes").EditorResponse<FrameAnimationPropertiesType>>;
     /**
      * This method triggers the animation to play
      * @returns
      */
-    playAnimation: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    play: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method triggers the animation to pause
      * @returns
      */
-    pauseAnimation: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    pause: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
-     * This method sets the animation time to a certain time, expressed in miliseconds
-     * @param timeInMS The time expressed in miliseconds
+     * This method sets the animation time to a certain time, expressed in milliseconds
+     * @param timeInMS the time expressed in milliseconds
      * @returns
      */
-    setScrubberPosition: (timeInMS: number) => Promise<import("../types/CommonTypes").EditorResponse<unknown>>;
+    setScrubberPosition: (timeInMS: number) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
-     * This method sets the total and maximum duration of the animation
-     * @param timeInMS The time expressed in miliseconds
+     * This method sets the total and maximum duration of the animation, expressed in milliseconds
+     * @param timeInMS the time expressed in milliseconds
      * @returns
      */
-    setAnimationDuration: (timeInMS: number) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setDuration: (timeInMS: number) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method resets the animation to its initial state
-     * @param frameId The id of a certain frame
+     * @param id the id of a certain frame
      * @returns
      */
-    resetFrameAnimation: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<unknown>>;
+    resetFrameAnimation: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method resets the layout's animations and animation duration to its initial state
      * @returns
      */
-    resetAnimation: () => Promise<import("../types/CommonTypes").EditorResponse<unknown>>;
+    reset: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
 }

package/lib/src/controllers/AnimationController.js

@@ -35,41 +35,41 @@ export class AnimationController {
         _AnimationController_editorAPI.set(this, void 0);
         /**
          * This method returns all animations on current layout
-         * @returns
+         * @returns list of all animation on current layout
          */
-        this.getAnimationsOnSelectedLayout = () => __awaiter(this, void 0, void 0, function* () {
+        this.getAllOnSelectedLayout = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
             return res
                 .getAnimationsOnSelectedLayout()
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * This method returns an animation for a given frame and layout
-         * @param frameId The ID of a specific frame
-         * @param layoutId The ID of a specific layout
-         * @returns
+         * This method returns an animation for a given frame and layout IDs
+         * @param id the id of a specific frame
+         * @param layoutId the id of a specific layout
+         * @returns animation properties for a given frame and layout
          */
-        this.getAnimationByFrameId = (frameId, layoutId) => __awaiter(this, void 0, void 0, function* () {
+        this.getByFrameId = (id, layoutId) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
             return res
-                .getAnimationByFrameId(frameId, layoutId)
+                .getAnimationByFrameId(id, layoutId)
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * This method returns the animations for a given layout
-         * @param layoutId The ID of a specific layout
-         * @returns
+         * This method returns the animations for a given layout id
+         * @param id the id of a specific layout
+         * @returns animation properties for a given layout
          */
-        this.getAnimationsByLayoutId = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+        this.getByLayoutId = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
             return res
-                .getAnimationsByLayoutId(layoutId)
+                .getAnimationsByLayoutId(id)
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets the animation state for a certain Frame
-         * @param animation
-         * @returns
+         * @param animation animation properties
+         * @returns updated animation properties
          */
         this.setFrameAnimation = (animation) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
@@ -81,7 +81,7 @@ export class AnimationController {
          * This method triggers the animation to play
          * @returns
          */
-        this.playAnimation = () => __awaiter(this, void 0, void 0, function* () {
+        this.play = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
             return res.playAnimation().then((result) => getEditorResponseData(result));
         });
@@ -89,44 +89,44 @@ export class AnimationController {
          * This method triggers the animation to pause
          * @returns
          */
-        this.pauseAnimation = () => __awaiter(this, void 0, void 0, function* () {
+        this.pause = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
             return res.pauseAnimation().then((result) => getEditorResponseData(result));
         });
         /**
-         * This method sets the animation time to a certain time, expressed in miliseconds
-         * @param timeInMS The time expressed in miliseconds
+         * This method sets the animation time to a certain time, expressed in milliseconds
+         * @param timeInMS the time expressed in milliseconds
          * @returns
          */
         this.setScrubberPosition = (timeInMS) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
-            return res.setScrubberPosition(timeInMS);
+            return res.setScrubberPosition(timeInMS).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method sets the total and maximum duration of the animation
-         * @param timeInMS The time expressed in miliseconds
+         * This method sets the total and maximum duration of the animation, expressed in milliseconds
+         * @param timeInMS the time expressed in milliseconds
          * @returns
          */
-        this.setAnimationDuration = (timeInMS) => __awaiter(this, void 0, void 0, function* () {
+        this.setDuration = (timeInMS) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
             return res.setAnimationDuration(timeInMS).then((result) => getEditorResponseData(result));
         });
         /**
          * This method resets the animation to its initial state
-         * @param frameId The id of a certain frame
+         * @param id the id of a certain frame
          * @returns
          */
-        this.resetFrameAnimation = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetFrameAnimation = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
-            return res.resetFrameAnimation(frameId);
+            return res.resetFrameAnimation(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method resets the layout's animations and animation duration to its initial state
          * @returns
          */
-        this.resetAnimation = () => __awaiter(this, void 0, void 0, function* () {
+        this.reset = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _AnimationController_editorAPI, "f");
-            return res.resetAnimation();
+            return res.resetAnimation().then((result) => getEditorResponseData(result));
         });
         __classPrivateFieldSet(this, _AnimationController_editorAPI, children, "f");
     }

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

@@ -1 +1 @@
-{"version":3,"file":"AnimationController.js","sourceRoot":"","sources":["../../../src/controllers/AnimationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAM5B;;OAEG;IACH,YAAY,QAAmB;QAR/B;;WAEG;QACH,iDAAsB;QAStB;;;WAGG;QACH,kCAA6B,GAAG,GAAS,EAAE;YACvC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,6BAA6B,EAAE;iBAC/B,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiC,MAAM,CAAC,CAAC,CAAC;QACzF,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,0BAAqB,GAAG,CAAO,OAAW,EAAE,QAAa,EAAE,EAAE;YACzD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,qBAAqB,CAAS,OAAO,EAAE,QAAQ,CAAC;iBAChD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAA+B,MAAM,CAAC,CAAC,CAAC;QACvF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,4BAAuB,GAAG,CAAO,QAAY,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,uBAAuB,CAAC,QAAQ,CAAC;iBACjC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAA+B,MAAM,CAAC,CAAC,CAAC;QACvF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,sBAAiB,GAAG,CAAO,SAAuC,EAAE,EAAE;YAClE,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;iBAC5C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACb,qBAAqB,iCAAoC,MAAM,KAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAG,CACtG,CAAC;QACV,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,kBAAa,GAAG,GAAS,EAAE;YACvB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACrF,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,mBAAc,GAAG,GAAS,EAAE;YACxB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACtF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,wBAAmB,GAAG,CAAO,QAAgB,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QAC7C,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,yBAAoB,GAAG,CAAO,QAAgB,EAAE,EAAE;YAC9C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACpG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,wBAAmB,GAAG,CAAO,OAAW,EAAE,EAAE;YACxC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;QAC5C,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,mBAAc,GAAG,GAAS,EAAE;YACxB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,cAAc,EAAE,CAAC;QAChC,CAAC,CAAA,CAAC;QA5GE,uBAAA,IAAI,kCAAc,QAAQ,MAAA,CAAC;IAC/B,CAAC;CA4GJ"}
+{"version":3,"file":"AnimationController.js","sourceRoot":"","sources":["../../../src/controllers/AnimationController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAM5B;;OAEG;IACH,YAAY,QAAmB;QAR/B;;WAEG;QACH,iDAAsB;QAStB;;;WAGG;QACH,2BAAsB,GAAG,GAAS,EAAE;YAChC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,6BAA6B,EAAE;iBAC/B,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiC,MAAM,CAAC,CAAC,CAAC;QACzF,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,iBAAY,GAAG,CAAO,EAAM,EAAE,QAAa,EAAE,EAAE;YAC3C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,qBAAqB,CAAS,EAAE,EAAE,QAAQ,CAAC;iBAC3C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAA+B,MAAM,CAAC,CAAC,CAAC;QACvF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,kBAAa,GAAG,CAAO,EAAM,EAAE,EAAE;YAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,uBAAuB,CAAC,EAAE,CAAC;iBAC3B,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAA+B,MAAM,CAAC,CAAC,CAAC;QACvF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,sBAAiB,GAAG,CAAO,SAAuC,EAAE,EAAE;YAClE,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;iBAC5C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CACb,qBAAqB,iCAAoC,MAAM,KAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAG,CACtG,CAAC;QACV,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,SAAI,GAAG,GAAS,EAAE;YACd,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,aAAa,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACrF,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,UAAK,GAAG,GAAS,EAAE;YACf,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACtF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,wBAAmB,GAAG,CAAO,QAAgB,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACnG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,gBAAW,GAAG,CAAO,QAAgB,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACpG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,wBAAmB,GAAG,CAAO,EAAM,EAAE,EAAE;YACnC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC7F,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,UAAK,GAAG,GAAS,EAAE;YACf,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,cAAc,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACtF,CAAC,CAAA,CAAC;QA5GE,uBAAA,IAAI,kCAAc,QAAQ,MAAA,CAAC;IAC/B,CAAC;CA4GJ"}

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

@@ -13,14 +13,14 @@ export declare class CanvasController {
      * This method fits the page to the given rectangle or the viewport available
      * Optional parameters `left`, `top`, `width` and `height` are needed to define the rectangle to fit the page to
      * If any or all of them aren't provided the page will fit the whole viewport available
-     * @param pageId The ID of a specific page
+     * @param id the id of a specific page
      * @param left
      * @param top
      * @param width
      * @param height
      * @returns
      */
-    zoomToPage: (pageId?: Id | null, left?: number | null, top?: number | null, width?: number | null, height?: number | null) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    zoomToPage: (id?: Id | null, left?: number | null, top?: number | null, width?: number | null, height?: number | null) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method gets the scale factor of the canvas
      * @returns scale factor in percents
@@ -29,6 +29,7 @@ export declare class CanvasController {
     /**
      * This method sets the scale factor to the canvas and re-centers the page
      * @param scaleFactor scale factor in percents
+     * @returns
      */
     setZoomPercentage: (scaleFactor: number) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
 }

package/lib/src/controllers/CanvasController.js

@@ -37,16 +37,16 @@ export class CanvasController {
          * This method fits the page to the given rectangle or the viewport available
          * Optional parameters `left`, `top`, `width` and `height` are needed to define the rectangle to fit the page to
          * If any or all of them aren't provided the page will fit the whole viewport available
-         * @param pageId The ID of a specific page
+         * @param id the id of a specific page
          * @param left
          * @param top
          * @param width
          * @param height
          * @returns
          */
-        this.zoomToPage = (pageId, left, top, width, height) => __awaiter(this, void 0, void 0, function* () {
+        this.zoomToPage = (id, left, top, width, height) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CanvasController_editorAPI, "f");
-            return res.zoomToPage(pageId, left, top, width, height).then((result) => getEditorResponseData(result));
+            return res.zoomToPage(id, left, top, width, height).then((result) => getEditorResponseData(result));
         });
         /**
          * This method gets the scale factor of the canvas
@@ -59,6 +59,7 @@ export class CanvasController {
         /**
          * This method sets the scale factor to the canvas and re-centers the page
          * @param scaleFactor scale factor in percents
+         * @returns
          */
         this.setZoomPercentage = (scaleFactor) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CanvasController_editorAPI, "f");

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

@@ -1 +1 @@
-{"version":3,"file":"CanvasController.js","sourceRoot":"","sources":["../../../src/controllers/CanvasController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAMzB;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,8CAAsB;QAStB;;;;;;;;;;WAUG;QACH,eAAU,GAAG,CACT,MAAkB,EAClB,IAAoB,EACpB,GAAmB,EACnB,KAAqB,EACrB,MAAsB,EACxB,EAAE;YACA,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAClH,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,sBAAiB,GAAG,GAAS,EAAE;YAC3B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,sBAAiB,GAAG,CAAO,WAAmB,EAAE,EAAE;YAC9C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACpG,CAAC,CAAA,CAAC;QAzCE,uBAAA,IAAI,+BAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CAyCJ"}
+{"version":3,"file":"CanvasController.js","sourceRoot":"","sources":["../../../src/controllers/CanvasController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAMzB;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,8CAAsB;QAStB;;;;;;;;;;WAUG;QACH,eAAU,GAAG,CACT,EAAc,EACd,IAAoB,EACpB,GAAmB,EACnB,KAAqB,EACrB,MAAsB,EACxB,EAAE;YACA,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,UAAU,CAAC,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,sBAAiB,GAAG,GAAS,EAAE;YAC3B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,sBAAiB,GAAG,CAAO,WAAmB,EAAE,EAAE;YAC9C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACpG,CAAC,CAAA,CAAC;QA1CE,uBAAA,IAAI,+BAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA0CJ"}

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

@@ -12,44 +12,44 @@ export declare class CharacterStyleController {
     constructor(editorAPI: EditorAPI);
     /**
      * This method returns the list of character styles
-     * @returns
+     * @returns list of all character styles
      */
-    getCharacterStyles: () => Promise<import("../types/CommonTypes").EditorResponse<CharacterStyle[]>>;
+    getAll: () => Promise<import("../types/CommonTypes").EditorResponse<CharacterStyle[]>>;
     /**
-     * This method returns a character style by id
-     * @param characterStyleId The ID of a specific character style
-     * @returns
+     * This method returns a character style by the id
+     * @param characterStyleId the id of a specific character style
+     * @returns character style for given id
      */
-    getCharacterStyleById: (characterStyleId: Id) => Promise<import("../types/CommonTypes").EditorResponse<CharacterStyle>>;
+    getById: (characterStyleId: Id) => Promise<import("../types/CommonTypes").EditorResponse<CharacterStyle>>;
     /**
      * This method creates a new character style
-     * @returns the new created character style id
+     * @returns the id of new character style
      */
-    createCharacterStyle: () => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    create: () => Promise<import("../types/CommonTypes").EditorResponse<string>>;
     /**
-     * This method updates a character style
-     * @param id The ID of a specific character style
-     * @param characterStyle The new character style properties
+     * This method updates a character style by the id and provided properties
+     * @param characterStyleId the id of a specific character style
+     * @param characterStyle the new character style properties
      * @returns
      */
-    updateCharacterStyle: (id: Id, characterStyle: CharacterStyleUpdate) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    update: (characterStyleId: Id, characterStyle: CharacterStyleUpdate) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
-     * This method removes a character style
-     * @param id The ID of a specific character style
+     * This method removes a character style by the id
+     * @param characterStyleId the id of a specific character style
      * @returns
      */
-    removeCharacterStyle: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    remove: (characterStyleId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
-     * This method duplicates a character style
-     * @param characterStyleId The ID of a specific character style
-     * @returns
+     * This method duplicates a character style by the id
+     * @param characterStyleId the id of a specific character style
+     * @returns id of the duplicated character style
      */
-    duplicateCharacterStyle: (characterStyleId: Id) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    duplicate: (characterStyleId: Id) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
     /**
-     * This method renames a character style
-     * @param id The ID of a specific character style
-     * @param name The new name of the character style
+     * This method renames a character style by the id
+     * @param characterStyleId the id of a specific character style
+     * @param characterStyleName the new name of the character style
      * @returns
      */
-    renameCharacterStyle: (id: Id, name: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    rename: (characterStyleId: Id, characterStyleName: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
 }

package/lib/src/controllers/CharacterStyleController.js

@@ -35,18 +35,18 @@ export class CharacterStyleController {
         _CharacterStyleController_editorAPI.set(this, void 0);
         /**
          * This method returns the list of character styles
-         * @returns
+         * @returns list of all character styles
          */
-        this.getCharacterStyles = () => __awaiter(this, void 0, void 0, function* () {
+        this.getAll = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
             return res.getCharacterStyles().then((result) => getEditorResponseData(result));
         });
         /**
-         * This method returns a character style by id
-         * @param characterStyleId The ID of a specific character style
-         * @returns
+         * This method returns a character style by the id
+         * @param characterStyleId the id of a specific character style
+         * @returns character style for given id
          */
-        this.getCharacterStyleById = (characterStyleId) => __awaiter(this, void 0, void 0, function* () {
+        this.getById = (characterStyleId) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
             return res
                 .getCharacterStyleById(characterStyleId)
@@ -54,51 +54,51 @@ export class CharacterStyleController {
         });
         /**
          * This method creates a new character style
-         * @returns the new created character style id
+         * @returns the id of new character style
          */
-        this.createCharacterStyle = () => __awaiter(this, void 0, void 0, function* () {
+        this.create = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
             return res.createCharacterStyle().then((result) => getEditorResponseData(result));
         });
         /**
-         * This method updates a character style
-         * @param id The ID of a specific character style
-         * @param characterStyle The new character style properties
+         * This method updates a character style by the id and provided properties
+         * @param characterStyleId the id of a specific character style
+         * @param characterStyle the new character style properties
          * @returns
          */
-        this.updateCharacterStyle = (id, characterStyle) => __awaiter(this, void 0, void 0, function* () {
+        this.update = (characterStyleId, characterStyle) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
             return res
-                .updateCharacterStyle(id, JSON.stringify(characterStyle))
+                .updateCharacterStyle(characterStyleId, JSON.stringify(characterStyle))
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * This method removes a character style
-         * @param id The ID of a specific character style
+         * This method removes a character style by the id
+         * @param characterStyleId the id of a specific character style
          * @returns
          */
-        this.removeCharacterStyle = (id) => __awaiter(this, void 0, void 0, function* () {
+        this.remove = (characterStyleId) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
-            return res.removeCharacterStyle(id).then((result) => getEditorResponseData(result));
+            return res.removeCharacterStyle(characterStyleId).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method duplicates a character style
-         * @param characterStyleId The ID of a specific character style
-         * @returns
+         * This method duplicates a character style by the id
+         * @param characterStyleId the id of a specific character style
+         * @returns id of the duplicated character style
          */
-        this.duplicateCharacterStyle = (characterStyleId) => __awaiter(this, void 0, void 0, function* () {
+        this.duplicate = (characterStyleId) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
             return res.duplicateCharacterStyle(characterStyleId).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method renames a character style
-         * @param id The ID of a specific character style
-         * @param name The new name of the character style
+         * This method renames a character style by the id
+         * @param characterStyleId the id of a specific character style
+         * @param characterStyleName the new name of the character style
          * @returns
          */
-        this.renameCharacterStyle = (id, name) => __awaiter(this, void 0, void 0, function* () {
+        this.rename = (characterStyleId, characterStyleName) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _CharacterStyleController_editorAPI, "f");
-            return res.renameCharacterStyle(id, name).then((result) => getEditorResponseData(result));
+            return res.renameCharacterStyle(characterStyleId, characterStyleName).then((result) => getEditorResponseData(result));
         });
         __classPrivateFieldSet(this, _CharacterStyleController_editorAPI, editorAPI, "f");
     }

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

@@ -1 +1 @@
-{"version":3,"file":"CharacterStyleController.js","sourceRoot":"","sources":["../../../src/controllers/CharacterStyleController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGpE;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAMjC;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,sDAAsB;QAStB;;;WAGG;QACH,uBAAkB,GAAG,GAAS,EAAE;YAC5B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QACtG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,0BAAqB,GAAG,CAAO,gBAAoB,EAAE,EAAE;YACnD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,qBAAqB,CAAC,gBAAgB,CAAC;iBACvC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiB,MAAM,CAAC,CAAC,CAAC;QACzE,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,yBAAoB,GAAG,GAAS,EAAE;YAC9B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,yBAAoB,GAAG,CAAO,EAAM,EAAE,cAAoC,EAAE,EAAE;YAC1E,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,oBAAoB,CAAC,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;iBACxD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,yBAAoB,GAAG,CAAO,EAAM,EAAE,EAAE;YACpC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC9F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,4BAAuB,GAAG,CAAO,gBAAoB,EAAE,EAAE;YACrD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QACjH,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,yBAAoB,GAAG,CAAO,EAAM,EAAE,IAAY,EAAE,EAAE;YAClD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACpG,CAAC,CAAA,CAAC;QA3EE,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA2EJ"}
+{"version":3,"file":"CharacterStyleController.js","sourceRoot":"","sources":["../../../src/controllers/CharacterStyleController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGpE;;;GAGG;AACH,MAAM,OAAO,wBAAwB;IAMjC;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,sDAAsB;QAStB;;;WAGG;QACH,WAAM,GAAG,GAAS,EAAE;YAChB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QACtG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,YAAO,GAAG,CAAO,gBAAoB,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,qBAAqB,CAAC,gBAAgB,CAAC;iBACvC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiB,MAAM,CAAC,CAAC,CAAC;QACzE,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,WAAM,GAAG,GAAS,EAAE;YAChB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAK,MAAM,CAAC,CAAC,CAAC;QAC1F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,WAAM,GAAG,CAAO,gBAAoB,EAAE,cAAoC,EAAE,EAAE;YAC1E,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,oBAAoB,CAAC,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;iBACtE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,WAAM,GAAG,CAAO,gBAAoB,EAAE,EAAE;YACpC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC5G,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,cAAS,GAAG,CAAO,gBAAoB,EAAE,EAAE;YACvC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,uBAAuB,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAK,MAAM,CAAC,CAAC,CAAC;QAC7G,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,WAAM,GAAG,CAAO,gBAAoB,EAAE,kBAA0B,EAAE,EAAE;YAChE,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAChI,CAAC,CAAA,CAAC;QA3EE,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA2EJ"}