@chili-publish/studio-sdk 0.123.0 → 0.133.2

package/lib/src/controllers/FrameController.js

@@ -38,329 +38,329 @@ export class FrameController {
         _FrameController_editorAPI.set(this, void 0);
         /**
          * This method returns the list of frames
-         * @returns
+         * @returns list of all frames
          */
-        this.getFrames = () => __awaiter(this, void 0, void 0, function* () {
+        this.getAll = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res.getFrames().then((result) => getEditorResponseData(result));
         });
         /**
          * This method returns the list of selected frames
-         * @returns
+         * @returns list of all selected frames
          */
-        this.getSelectedFrames = () => __awaiter(this, void 0, void 0, function* () {
+        this.getSelected = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res.getSelectedFrames().then((result) => getEditorResponseData(result));
         });
         /**
-         * This method returns the list of frames by pageId
-         * @param pageId The ID of a specific page
-         * @returns
+         * This method returns the list of frames by id
+         * @param id the id of a specific page
+         * @returns list of all frames by id
          */
-        this.getFramesByPageId = (pageId) => __awaiter(this, void 0, void 0, function* () {
+        this.getAllByPageId = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.getFramesByPageId(pageId).then((result) => getEditorResponseData(result));
+            return res.getFramesByPageId(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method returns a frame by its name
-         * @param name The name of a specific frame
-         * @returns
+         * @param name the name of a specific frame
+         * @returns frame properties
          */
-        this.getFrameByName = (name) => __awaiter(this, void 0, void 0, function* () {
+        this.getByName = (name) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res.getFrameByName(name).then((result) => getEditorResponseData(result));
         });
         /**
          * This method returns a frame by its id
-         * @param id The ID of a specific frame
-         * @returns
+         * @param id the id of a specific frame
+         * @returns frame properties
          */
-        this.getFrameById = (id) => __awaiter(this, void 0, void 0, function* () {
+        this.getById = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res.getFrameById(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method returns all frame properties on current layout
-         * @returns
+         * @returns all frame properties on current layout
          */
-        this.getFramePropertiesOnSelectedLayout = () => __awaiter(this, void 0, void 0, function* () {
+        this.getPropertiesOnSelectedLayout = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res
                 .getFramePropertiesOnSelectedLayout()
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * This method returns frame properties 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 frame layout properties for a given frame and layout
+         * @param id the id of a specific frame
+         * @param layoutId the id of a specific layout
+         * @returns frame layout properties
          */
-        this.getFramePropertiesByFrameId = (frameId, layoutId) => __awaiter(this, void 0, void 0, function* () {
+        this.getLayoutProperties = (id, layoutId) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res
-                .getFramePropertiesByFrameId(frameId, layoutId)
+                .getFramePropertiesByFrameId(id, layoutId)
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * This method returns frame properties for a given layout
-         * @param layoutId The ID of a specific layout
-         * @returns
+         * This method returns a list of frame properties for a given layout
+         * @param id the id of a specific layout
+         * @returns list of frame layout properties
          */
-        this.getFramesProperties = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+        this.getAllLayoutProperties = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.getFramesProperties(layoutId).then((result) => getEditorResponseData(result));
+            return res.getFramesProperties(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the frame size (width and height) to the frame's original value
-         * @param frameId The ID of a specific frame
+         * @param id the id of a specific frame
          * @returns
          */
-        this.resetFrameSize = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetSize = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetFrameSize(frameId).then((result) => getEditorResponseData(result));
+            return res.resetFrameSize(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will select a specific frame
-         * @param frameId The ID of a specific frame
+         * @param id the id of a specific frame
          * @returns
          */
-        this.selectFrame = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.select = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.selectFrames([frameId]).then((result) => getEditorResponseData(result));
+            return res.selectFrames([id]).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will select multipleFrames
-         * @param frameIds An array of all IDs you want to select
+         * @param ids An array of all ids you want to select
          * @returns
          */
-        this.selectMultipleFrames = (frameIds) => __awaiter(this, void 0, void 0, function* () {
+        this.selectMultiple = (ids) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.selectFrames(frameIds).then((result) => getEditorResponseData(result));
+            return res.selectFrames(ids).then((result) => getEditorResponseData(result));
         });
         /**
          * This method changes the order of frames in the z-index list.
-         * @param orderIndex The index in the list to move to
-         * @param frameIdsToMove An array of all IDs you want to move to the given index
+         * @param order the index in the list to move to
+         * @param ids An array of all IDs you want to move to the given index
          * @returns
          */
-        this.reorderFrames = (orderIndex, frameIdsToMove) => __awaiter(this, void 0, void 0, function* () {
+        this.reorderFrames = (order, ids) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.reorderFrames(orderIndex, frameIdsToMove).then((result) => getEditorResponseData(result));
+            return res.reorderFrames(order, ids).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will update the z-index of a frame.
-         * @param frameId The ID of the frame you want to change the z-index of
-         * @param method The z-index update method to perform
+         * @param id the id of the frame you want to change the z-index of
+         * @param method the z-index update method to perform
          * @returns
          */
-        this.setFrameZIndex = (frameId, method) => __awaiter(this, void 0, void 0, function* () {
+        this.setZIndex = (id, method) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.setFrameZIndex(frameId, method).then((result) => getEditorResponseData(result));
+            return res.setFrameZIndex(id, method).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the height of a specific frame
-         * @param frameId The ID of a specific frame
-         * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+         * @param id the id of a specific frame
+         * @param height the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
          * @returns
          */
-        this.setFrameHeight = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setHeight = (id, height) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            const calc = getCalculatedValue(value);
+            const calc = getCalculatedValue(height);
             if (calc === null || calc === Infinity) {
                 return null;
             }
             return res
-                .setFrameHeight(frameId, parseFloat(calc.toString()))
+                .setFrameHeight(id, parseFloat(calc.toString()))
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the rotation angle of a specific frame
-         * @param frameId The ID of a specific frame
-         * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+         * @param id the id of a specific frame
+         * @param rotation the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
          * @returns
          */
-        this.setFrameRotation = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setRotation = (id, rotation) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            const calc = getCalculatedValue(value);
+            const calc = getCalculatedValue(rotation);
             if (calc === null || calc === Infinity) {
                 return null;
             }
             return res
-                .setFrameRotation(frameId, parseFloat(calc.toString()))
+                .setFrameRotation(id, parseFloat(calc.toString()))
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the width of a specific frame
-         * @param frameId The ID of a specific frame
-         * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+         * @param id the id of a specific frame
+         * @param width the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
          * @returns
          */
-        this.setFrameWidth = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setWidth = (id, width) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            const calc = getCalculatedValue(value);
+            const calc = getCalculatedValue(width);
             if (calc === null || calc === Infinity) {
                 return null;
             }
             return res
-                .setFrameWidth(frameId, parseFloat(calc.toString()))
+                .setFrameWidth(id, parseFloat(calc.toString()))
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the x value of a specific frame
-         * @param frameId The ID of a specific frame
-         * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+         * @param id the id of a specific frame
+         * @param XValue the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
          * @returns
          */
-        this.setFrameX = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setX = (id, XValue) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            const calc = getCalculatedValue(value);
+            const calc = getCalculatedValue(XValue);
             if (calc === null || calc === Infinity) {
                 return null;
             }
             return res
-                .setFrameX(frameId, parseFloat(calc.toString()))
+                .setFrameX(id, parseFloat(calc.toString()))
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the y value of a specific frame
-         * @param frameId The ID of a specific frame
-         * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+         * @param id the id of a specific frame
+         * @param YValue the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
          * @returns
          */
-        this.setFrameY = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setY = (id, YValue) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            const calc = getCalculatedValue(value);
+            const calc = getCalculatedValue(YValue);
             if (calc === null || calc === Infinity) {
                 return null;
             }
             return res
-                .setFrameY(frameId, parseFloat(calc.toString()))
+                .setFrameY(id, parseFloat(calc.toString()))
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will update the name of a specific frame
-         * @param frameId The ID of a specific frame
-         * @param frameName The new name that the frame should receive
+         * @param id the id of a specific frame
+         * @param name the new name that the frame should receive
          * @returns
          */
-        this.setFrameName = (frameId, frameName) => __awaiter(this, void 0, void 0, function* () {
+        this.rename = (id, name) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.renameFrame(frameId, frameName).then((result) => getEditorResponseData(result));
+            return res.renameFrame(id, name).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset properties of a specific frame to their original values
-         * @param frameId The ID of the frame that needs to get reset
+         * @param id the id of the frame that needs to get reset
          * @returns
          */
-        this.resetFrame = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.reset = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetFrame(frameId).then((result) => getEditorResponseData(result));
+            return res.resetFrame(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the x value of a specific frame to its original value
-         * @param frameId The ID of the frame that needs to get reset
+         * @param id the id of the frame that needs to get reset
          * @returns
          */
-        this.resetFrameX = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetX = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetFrameX(frameId).then((result) => getEditorResponseData(result));
+            return res.resetFrameX(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the y value of a specific frame to its original value
-         * @param frameId The ID of the frame that needs to get reset
+         * @param id the id of the frame that needs to get reset
          * @returns
          */
-        this.resetFrameY = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetY = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetFrameY(frameId).then((result) => getEditorResponseData(result));
+            return res.resetFrameY(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the rotation value of a specific frame to its original value
-         * @param frameId The ID of the frame that needs to get reset
+         * @param id the id of the frame that needs to get reset
          * @returns
          */
-        this.resetFrameRotation = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetRotation = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetFrameRotation(frameId).then((result) => getEditorResponseData(result));
+            return res.resetFrameRotation(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the width of a specific frame to its original value
-         * @param frameId The ID of the frame that needs to get reset
+         * @param id the id of the frame that needs to get reset
          * @returns
          */
-        this.resetFrameWidth = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetWidth = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetFrameWidth(frameId).then((result) => getEditorResponseData(result));
+            return res.resetFrameWidth(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the height of a specific frame to its original value
-         * @param frameId The ID of the frame that needs to get reset
+         * @param id the id of the frame that needs to get reset
          * @returns
          */
-        this.resetFrameHeight = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetHeight = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetFrameHeight(frameId).then((result) => getEditorResponseData(result));
+            return res.resetFrameHeight(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the fitMode property of a specific frame to its original value
-         * @param frameId The ID of the frame that needs to get reset
+         * @param id the id of the frame that needs to get reset
          * @returns
          */
-        this.resetImageFrameFitMode = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetImageFrameFitMode = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetImageFrameFitMode(frameId).then((result) => getEditorResponseData(result));
+            return res.resetImageFrameFitMode(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the visibility property of a specified frame. If set to false the frame will be invisible and vice versa.
-         * @param frameId The ID of the frame that needs to get updated
+         * @param id the id of the frame that needs to get updated
          * @param value True means the frame gets visible, false means the frame gets invisible
          * @returns
          */
-        this.setFrameVisibility = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setVisibility = (id, value) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.setFrameVisibility(frameId, value).then((result) => getEditorResponseData(result));
+            return res.setFrameVisibility(id, value).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will remove a specific frame using the Id.
-         * @param frameId The ID of the frame that needs to be deleted
+         * @param id the id of the frame that needs to be deleted
          * @returns
          */
-        this.removeFrame = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.remove = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.removeFrame(frameId).then((result) => getEditorResponseData(result));
+            return res.removeFrame(id).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method will add a new frame of 'frameType' to the template positioned on the requested
+         * This method will create a new frame of 'type' to the template positioned on the requested
          * coordinates.
-         * @param frameType The type of frame to create
+         * @param type the type of frame to create
          * @param x X coordinate of the new frame within the template
          * @param y Y coordinate of the new frame within the template
          * @param width Width of the new frame within the template
          * @param height Height of the new frame within the template
-         * @returns The newly created frame's ID
+         * @returns the newly created frame's id
          */
-        this.addFrame = (frameType, x, y, width, height) => __awaiter(this, void 0, void 0, function* () {
+        this.create = (type, x, y, width, height) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.addFrame(frameType, x, y, width, height).then((result) => getEditorResponseData(result));
+            return res.addFrame(type, x, y, width, height).then((result) => getEditorResponseData(result));
         });
         /**
-         * This method will add a new frame of 'shapeType' type to the template positioned on the requested
+         * This method will create a new frame of 'type' type to the template positioned on the requested
          * coordinates.
-         * @param shapeType The type of frame to create
+         * @param type the type of frame to create
          * @param x X coordinate of the new frame within the template
          * @param y Y coordinate of the new frame within the template
          * @param width Width of the new frame within the template
          * @param height Height of the new frame within the template
-         * @returns The newly created frame's ID
+         * @returns the newly created shape frame's id
          */
-        this.addShapeFrame = (shapeType, x, y, width, height) => __awaiter(this, void 0, void 0, function* () {
+        this.createShapeFrame = (type, x, y, width, height) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.addFrame(shapeType, x, y, width, height).then((result) => getEditorResponseData(result));
+            return res.addFrame(type, x, y, width, height).then((result) => getEditorResponseData(result));
         });
         /**
          * This method sets or removes the image source to the ImageFrame
-         * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
-         * @param src A new image source
+         * @param imageFrameId the id of the imageFrame where an image needs to be assigned to
+         * @param newImageSource A new image source
          * @returns
          */
         this.updateImageSource = (imageFrameId, src) => __awaiter(this, void 0, void 0, function* () {
@@ -370,41 +370,41 @@ export class FrameController {
         });
         /**
          * This method removes the image source from the ImageFrame
-         * @param imageFrameId The ID of the imageFrame where an image needs to be removed from
+         * @param imageFrameId the id of the imageFrame where an image needs to be removed from
          */
         this.removeImageSource = (imageFrameId) => __awaiter(this, void 0, void 0, function* () {
             return this.updateImageSource(imageFrameId, null);
         });
         /**
          * This method will assign an image from a mediaConnector to the correct ImageFrame
-         * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
-         * @param connectorId Unique Id of the media connector
-         * @param resourceId Unique Id of the asset that you want to assign to the imageFrame
+         * @param id Unique Id of the media connector
+         * @param imageFrameId the id of the imageFrame where an image needs to be assigned to
+         * @param assetId Unique id of the asset that you want to assign to the imageFrame
          * @returns
          */
-        this.setImageFromConnector = (imageFrameId, connectorId, resourceId) => __awaiter(this, void 0, void 0, function* () {
+        this.setImageFromConnector = (imageFrameId, connectorId, assetId) => __awaiter(this, void 0, void 0, function* () {
             const src = {
-                assetId: resourceId,
-                connectorId: connectorId,
-                sourceType: ImageSourceTypeEnum.connector,
+                id: connectorId,
+                assetId,
+                type: ImageSourceTypeEnum.connector,
             };
             return this.updateImageSource(imageFrameId, src);
         });
         /**
          * This method will assign an image from url to the correct ImageFrame
          * Make sure the url can be accessed by the editor.
-         * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
+         * @param imageFrameId the id of the imageFrame where an image needs to be assigned to
          * @param url A valid image uri
          * @returns
          */
         this.setImageFromUrl = (imageFrameId, url) => __awaiter(this, void 0, void 0, function* () {
-            const src = { url: url, sourceType: ImageSourceTypeEnum.url };
-            return this.updateImageSource(imageFrameId, src);
+            const source = { url: url, type: ImageSourceTypeEnum.url };
+            return this.updateImageSource(imageFrameId, source);
         });
         /**
          * This method will set the fitMode property of a specified image frame.
-         * @param imageFrameId The ID of the imageFrame that needs to get updated.
-         * @param fitMode The new fitMode that you want to set to the imageFrame.
+         * @param imageFrameId the id of the imageFrame that needs to get updated.
+         * @param fitMode the new fitMode that you want to set to the imageFrame.
          * @returns
          */
         this.setImageFrameFitMode = (imageFrameId, fitMode) => __awaiter(this, void 0, void 0, function* () {
@@ -413,98 +413,98 @@ export class FrameController {
         });
         /**
          * This method will set the constrainProportions property of a specified frame.
-         * @param frameId The ID of the frame that needs to get updated.
+         * @param id the id of the frame that needs to get updated.
          * @param constrainProportions The new constraint that you want to set to the frame.
          * @returns
          */
-        this.setFrameConstrainProportions = (frameId, constrainProportions) => __awaiter(this, void 0, void 0, function* () {
+        this.setFrameConstrainProportions = (id, constrainProportions) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res
-                .setFrameConstrainProportions(frameId, constrainProportions)
+                .setFrameConstrainProportions(id, constrainProportions)
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the vertical alignment property of a specified frame.
-         * @param frameId The ID of the frame that needs to get updated
-         * @param verticalAlign The new vertical alignment to be set to the frame.
+         * @param id the id of the frame that needs to get updated
+         * @param verticalAlign the new vertical alignment to be set to the frame.
          * @returns
          */
-        this.setVerticalAlignment = (frameId, verticalAlign) => __awaiter(this, void 0, void 0, function* () {
+        this.setVerticalAlign = (id, verticalAlign) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.setVerticalAlignment(frameId, verticalAlign).then((result) => getEditorResponseData(result));
+            return res.setVerticalAlignment(id, verticalAlign).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the min copyFitting property of a specified frame.
-         * @param frameId The ID of the frame that needs to get updated
-         * @param value The new min copyFitting value to be set to the frame.
+         * @param id the id of the frame that needs to get updated
+         * @param value the new min copyFitting value to be set to the frame.
          * @returns
          */
-        this.setMinCopyfitting = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setMinCopyfitting = (id, value) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             const calc = getCalculatedValue(value);
             if (calc === null || calc === Infinity) {
                 return null;
             }
             return res
-                .setMinCopyfitting(frameId, parseFloat(calc.toString()))
+                .setMinCopyfitting(id, parseFloat(calc.toString()))
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the max copyFitting property of a specified frame.
-         * @param frameId The ID of the frame that needs to get updated
-         * @param value The new max copyFitting value to be set to the frame.
+         * @param id the id of the frame that needs to get updated
+         * @param value the new max copyFitting value to be set to the frame.
          * @returns
          */
-        this.setMaxCopyfitting = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setMaxCopyfitting = (id, value) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             const calc = getCalculatedValue(value);
             if (calc === null || calc === Infinity) {
                 return null;
             }
             return res
-                .setMaxCopyfitting(frameId, parseFloat(calc.toString()))
+                .setMaxCopyfitting(id, parseFloat(calc.toString()))
                 .then((result) => getEditorResponseData(result));
         });
         /**
          * This method will enable copyFitting on a specified frame.
-         * @param frameId The ID of the frame that needs to get updated
-         * @param value The new value to be set to the frame.
+         * @param id the id of the frame that needs to get updated
+         * @param value the new value to be set to the frame.
          * @returns
          */
-        this.setEnableCopyfitting = (frameId, value) => __awaiter(this, void 0, void 0, function* () {
+        this.setEnableCopyfitting = (id, value) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.setEnableCopyfitting(frameId, value).then((result) => getEditorResponseData(result));
+            return res.setEnableCopyfitting(id, value).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the frame minCopyfitting to the frame's original value
-         * @param frameId The ID of a specific frame
+         * @param id the id of a specific frame
          * @returns
          */
-        this.resetMinCopyfitting = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetMinCopyfitting = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetMinCopyfitting(frameId).then((result) => getEditorResponseData(result));
+            return res.resetMinCopyfitting(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the frame maxCopyfitting to the frame's original value
-         * @param frameId The ID of a specific frame
+         * @param id the id of a specific frame
          * @returns
          */
-        this.resetMaxCopyfitting = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetMaxCopyfitting = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetMaxCopyfitting(frameId).then((result) => getEditorResponseData(result));
+            return res.resetMaxCopyfitting(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will reset the frame enableCopyfitting to the frame's original value
-         * @param frameId The ID of a specific frame
+         * @param id the id of a specific frame
          * @returns
          */
-        this.resetEnableCopyfitting = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetEnableCopyfitting = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetEnableCopyfitting(frameId).then((result) => getEditorResponseData(result));
+            return res.resetEnableCopyfitting(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will set the visibility of the shape fill.
-         * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+         * @param shapeFrameId the id of the shapeFrame that needs to get updated.
          * @param enableFill Whether the shape fill is visible.
          * @returns
          */
@@ -513,8 +513,8 @@ export class FrameController {
         });
         /**
          * This method will set the shape fill color of a specified shape frame.
-         * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
-         * @param fillColor The new shape fill color that you want to set to the shapeFrame.
+         * @param shapeFrameId the id of the shapeFrame that needs to get updated.
+         * @param fillColor the new shape fill color that you want to set to the shapeFrame.
          * @returns
          */
         this.setShapeFrameFillColor = (shapeFrameId, fillColor) => __awaiter(this, void 0, void 0, function* () {
@@ -522,7 +522,7 @@ export class FrameController {
         });
         /**
          * This method will set the visibility of the shape stroke.
-         * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+         * @param shapeFrameId the id of the shapeFrame that needs to get updated.
          * @param enableStroke Whether the shape stroke is visible.
          * @returns
          */
@@ -531,8 +531,8 @@ export class FrameController {
         });
         /**
          * This method will set the shape stroke color of a specified shape frame.
-         * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
-         * @param strokeColor The new shape stroke color that you want to set to the shapeFrame.
+         * @param shapeFrameId the id of the shapeFrame that needs to get updated.
+         * @param strokeColor the new shape stroke color that you want to set to the shapeFrame.
          * @returns
          */
         this.setShapeFrameStrokeColor = (shapeFrameId, strokeColor) => __awaiter(this, void 0, void 0, function* () {
@@ -540,8 +540,8 @@ export class FrameController {
         });
         /**
          * This method will set the shape stroke weight of a specified shape frame.
-         * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
-         * @param strokeWeight The new shape stroke weight that you want to set to the shapeFrame.
+         * @param shapeFrameId the id of the shapeFrame that needs to get updated.
+         * @param strokeWeight the new shape stroke weight that you want to set to the shapeFrame.
          * @returns
          */
         this.setShapeFrameStrokeWeight = (shapeFrameId, strokeWeight) => __awaiter(this, void 0, void 0, function* () {
@@ -549,22 +549,22 @@ export class FrameController {
         });
         /**
          * This method will set the blend mode of a specified shape frame
-         * @param frameId The ID of a specific frame
-         * @param blendMode The blend mode
+         * @param id the id of a specific frame
+         * @param blendMode the blend mode
          * @returns
          */
-        this.setFrameBlendMode = (frameId, blendMode) => __awaiter(this, void 0, void 0, function* () {
+        this.setBlendMode = (id, blendMode) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.setFrameBlendMode(frameId, blendMode).then((result) => getEditorResponseData(result));
+            return res.setFrameBlendMode(id, blendMode).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will make the specified image frame go into cropping mode.
-         * @param frameId The ID of a specific image frame
+         * @param id the id of a specific image frame
          * @returns
          */
-        this.enterCropMode = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.enterCropMode = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.enterCropMode(frameId).then((result) => getEditorResponseData(result));
+            return res.enterCropMode(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will exit cropping mode while saving the applied crop.
@@ -576,18 +576,18 @@ export class FrameController {
         });
         /**
          * This method will reset the currently applied crop mode and apply the last selected fit mode again.
-         * @param frameId The ID of a specific image frame
+         * @param id the id of a specific image frame
          * @returns
          */
-        this.resetCropMode = (frameId) => __awaiter(this, void 0, void 0, function* () {
+        this.resetCropMode = (id) => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
-            return res.resetCropMode(frameId).then((result) => getEditorResponseData(result));
+            return res.resetCropMode(id).then((result) => getEditorResponseData(result));
         });
         /**
          * This method will exit cropping mode without saving the applied crop.
          * @returns
          */
-        this.cancelCropMode = () => __awaiter(this, void 0, void 0, function* () {
+        this.exitCropMode = () => __awaiter(this, void 0, void 0, function* () {
             const res = yield __classPrivateFieldGet(this, _FrameController_editorAPI, "f");
             return res.cancelCropMode().then((result) => getEditorResponseData(result));
         });