@chili-publish/studio-sdk 1.43.0 → 1.44.0

package/lib/src/controllers/LayoutController.es.js

@@ -0,0 +1,179 @@
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var _editorAPI, _blobAPI;
+import { PositionEnum } from "../types/LayoutTypes.es.js";
+import { getEditorResponseData } from "../utils/EditorResponseData.es.js";
+class LayoutController {
+  /**
+   * @ignore
+   */
+  constructor(editorAPI) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _editorAPI);
+    __privateAdd(this, _blobAPI);
+    this.getAll = async () => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getLayouts().then((result) => getEditorResponseData(result));
+    };
+    this.getById = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getLayoutById(id).then((result) => getEditorResponseData(result));
+    };
+    this.getByName = async (name) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getLayoutByName(name).then((result) => getEditorResponseData(result));
+    };
+    this.getSelected = async () => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getSelectedLayout().then((result) => getEditorResponseData(result));
+    };
+    this.remove = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.removeLayout(id).then((result) => getEditorResponseData(result));
+    };
+    this.create = async (parentId, presets) => {
+      const res = await __privateGet(this, _editorAPI);
+      if (presets == null ? void 0 : presets.length) {
+        return res.addLayouts(parentId, JSON.stringify(presets)).then((result) => getEditorResponseData(result));
+      }
+      return res.addLayout(parentId).then((result) => getEditorResponseData(result));
+    };
+    this.rename = async (id, name) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.renameLayout(id, name).then((result) => getEditorResponseData(result));
+    };
+    this.select = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.selectLayoutWithOptions(id, null).then((result) => getEditorResponseData(result));
+    };
+    this.selectWithPageSize = async (id, pageSize) => {
+      const res = await __privateGet(this, _editorAPI);
+      const options = {
+        pageSize
+      };
+      return res.selectLayoutWithOptions(id, JSON.stringify(options)).then((result) => getEditorResponseData(result));
+    };
+    this.duplicate = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.duplicateLayout(id).then((result) => getEditorResponseData(result));
+    };
+    this.reset = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.resetLayout(id).then((result) => getEditorResponseData(result));
+    };
+    this.setHeight = async (id, height) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutHeight(id, height).then((result) => getEditorResponseData(result));
+    };
+    this.setWidth = async (id, width) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutWidth(id, width).then((result) => getEditorResponseData(result));
+    };
+    this.setUnit = async (id, unit) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutUnit(id, unit).then((result) => getEditorResponseData(result));
+    };
+    this.resetHeight = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.resetLayoutHeight(id).then((result) => getEditorResponseData(result));
+    };
+    this.resetWidth = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.resetLayoutWidth(id).then((result) => getEditorResponseData(result));
+    };
+    this.resetUnit = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.resetLayoutUnit(id).then((result) => getEditorResponseData(result));
+    };
+    this.getSelectedSnapshot = async () => {
+      const res = await __privateGet(this, _blobAPI);
+      return res.getPageSnapshot().then((result) => result ?? result);
+    };
+    this.setIntent = async (id, intent) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutIntent(id, intent).then((result) => getEditorResponseData(result));
+    };
+    this.resetIntent = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.resetLayoutIntent(id).then((result) => getEditorResponseData(result));
+    };
+    this.setFillColor = async (id, color) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutFillColor(id, JSON.stringify(color)).then((result) => getEditorResponseData(result));
+    };
+    this.setFillColorEnabled = async (id, enabled) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutFillColorEnabled(id, enabled).then((result) => getEditorResponseData(result));
+    };
+    this.resetFillColor = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.resetLayoutFillColor(id).then((result) => getEditorResponseData(result));
+    };
+    this.setBleedValue = async (id, value, position) => {
+      const update = position ? {
+        left: position === PositionEnum.left ? value : void 0,
+        top: position === PositionEnum.top ? value : void 0,
+        right: position === PositionEnum.right ? value : void 0,
+        bottom: position === PositionEnum.bottom ? value : void 0
+      } : { left: value, top: value, right: value, bottom: value };
+      const res = await __privateGet(this, _editorAPI);
+      return res.updateLayoutBleed(id, JSON.stringify(update)).then((result) => getEditorResponseData(result));
+    };
+    this.setAreBleedValuesCombined = async (id, value) => {
+      const update = { areBleedValuesCombined: value };
+      const res = await __privateGet(this, _editorAPI);
+      return res.updateLayoutBleed(id, JSON.stringify(update)).then((result) => getEditorResponseData(result));
+    };
+    this.resetBleedValues = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.updateLayoutBleed(id, null).then((result) => getEditorResponseData(result));
+    };
+    this.setPrivateData = async (id, privateData) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutPrivateData(id, JSON.stringify(privateData)).then((result) => getEditorResponseData(result));
+    };
+    this.getPrivateData = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getLayoutPrivateData(id).then((result) => getEditorResponseData(result));
+    };
+    this.setDisplayName = async (id, displayName) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutDisplayName(id, displayName).then((result) => getEditorResponseData(result));
+    };
+    this.getDisplayName = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getLayoutDisplayName(id).then((result) => getEditorResponseData(result));
+    };
+    this.resetDisplayName = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutDisplayName(id, null).then((result) => getEditorResponseData(result));
+    };
+    this.setAvailableForUser = async (id, isAvailable) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutAvailableForUser(id, isAvailable).then((result) => getEditorResponseData(result));
+    };
+    this.setSelectedByUser = async (id, isSelected) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutSelectedByUser(id, isSelected).then((result) => getEditorResponseData(result));
+    };
+    this.setResizableByUser = async (id, resizableLayoutProperties) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setLayoutResizableByUser(id, JSON.stringify(resizableLayoutProperties)).then((result) => getEditorResponseData(result));
+    };
+    __privateSet(this, _editorAPI, editorAPI);
+    __privateSet(this, _blobAPI, editorAPI);
+  }
+}
+_editorAPI = new WeakMap();
+_blobAPI = new WeakMap();
+export {
+  LayoutController
+};
+//# sourceMappingURL=LayoutController.es.js.map

package/lib/src/controllers/LayoutController.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LayoutController.es.js","sources":["../../../src/controllers/LayoutController.ts"],"sourcesContent":["import { CallSender } from 'penpal';\nimport { ColorUsage } from '../types/ColorStyleTypes';\nimport type { EditorAPI, EditorRawAPI, EditorResponse, Id, PrivateData } from '../types/CommonTypes';\nimport {\n    BleedDeltaUpdate,\n    Layout,\n    LayoutIntent,\n    LayoutPreset,\n    PositionEnum,\n    ResizableLayoutPropertiesUpdate,\n    SelectLayoutOptions,\n    LayoutOptionPageSize,\n    MeasurementUnit,\n} from '../types/LayoutTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n/**\n * The LayoutController is responsible for all communication regarding Layouts.\n * Methods inside this controller can be called by `window.SDK.layout.{method-name}`\n */\nexport class LayoutController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n    #blobAPI: EditorRawAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n        this.#blobAPI = editorAPI as CallSender as EditorRawAPI;\n    }\n\n    /**\n     * This method returns the list of layouts\n     * @returns list of all layouts\n     */\n    getAll = async () => {\n        const res = await this.#editorAPI;\n        return res.getLayouts().then((result) => getEditorResponseData<Layout[]>(result));\n    };\n\n    /**\n     * This method returns a layout by its id\n     * @param id the id of a specific layout\n     * @returns layout properties\n     */\n    getById = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.getLayoutById(id).then((result) => getEditorResponseData<Layout>(result));\n    };\n\n    /**\n     * This method returns a layout by its name\n     * @param name the name of a specific layout\n     * @returns layout properties\n     */\n    getByName = async (name: string) => {\n        const res = await this.#editorAPI;\n        return res.getLayoutByName(name).then((result) => getEditorResponseData<Layout>(result));\n    };\n\n    /**\n     * This method returns the selected layout\n     * @returns layout properties\n     */\n    getSelected = async () => {\n        const res = await this.#editorAPI;\n        return res.getSelectedLayout().then((result) => getEditorResponseData<Layout>(result));\n    };\n\n    /**\n     * This method will remove a specific layout\n     * @param id the id of a specific layout\n     * @returns\n     */\n    remove = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.removeLayout(id).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will create a new child layout (a new layout is always child of a root / parent)\n     * @param parentId the id of a specific layout, being the parent\n     * @returns id of new layout\n     */\n    create = async (parentId: Id, presets?: LayoutPreset[]) => {\n        const res = await this.#editorAPI;\n\n        if (presets?.length) {\n            return res\n                .addLayouts(parentId, JSON.stringify(presets))\n                .then((result) => getEditorResponseData<Id>(result));\n        }\n\n        return res.addLayout(parentId).then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * This method will update the name of a specific layout\n     * @param id the id of a specific layout\n     * @param name the new name that the layout should receive\n     * @returns\n     */\n    rename = async (id: Id, name: string) => {\n        const res = await this.#editorAPI;\n        return res.renameLayout(id, name).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will select a specific layout\n     * @param id the id of a specific layout\n     * @returns\n     */\n    select = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.selectLayoutWithOptions(id, null).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will select a specific layout and set the page size to the provided value. Note that\n     * the same limitations that apply to PageController.setSize also apply here.\n     * @param id the id of a specific layout\n     * @param pageSize the new page size that will be applied when selecting the layout\n     * @returns\n     */\n    selectWithPageSize = async (id: Id, pageSize: LayoutOptionPageSize) => {\n        const res = await this.#editorAPI;\n        const options: SelectLayoutOptions = {\n            pageSize: pageSize,\n        };\n        return res\n            .selectLayoutWithOptions(id, JSON.stringify(options))\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will duplicate a specific layout\n     * @param id the id of a specific layout\n     * @returns id of specific layout\n     */\n    duplicate = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.duplicateLayout(id).then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * This method will reset a specific layout to its original value\n     * @param id the id of a specific layout\n     * @returns\n     */\n    reset = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.resetLayout(id).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will set the height of the layout to a specific value\n     * @param id the id of a specific layout\n     * @param height the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels\n     * @returns\n     */\n    setHeight = async (id: Id, height: string) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutHeight(id, height).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will set the width of the layout to a specific value\n     * @param id the id of a specific layout\n     * @param width the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels\n     * @returns\n     */\n    setWidth = async (id: Id, width: string) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutWidth(id, width).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will set the unit of the layout to a specific value\n     *\n     * @param id The id of a specific layout\n     * @param unit the unit that will be used for the layout. All values in this layout will now be reported in this unit\n     * @returns\n     */\n    setUnit = async (id: Id, unit: MeasurementUnit) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutUnit(id, unit).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will reset the height of a specific layout to its original value\n     * @param id the id of a specific layout\n     * @returns\n     */\n    resetHeight = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.resetLayoutHeight(id).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will reset the width of a specific layout to its original value\n     * @param id the id of a specific layout\n     * @returns\n     */\n    resetWidth = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.resetLayoutWidth(id).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will reset the unit of a specific layout to its original (inherited) value\n     * @param id the id of a specific layout\n     * @returns\n     */\n    resetUnit = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.resetLayoutUnit(id).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @deprecated\n     * This method returns a UInt8Array containing a PNG encoded image of the currently selected layout.\n     * This method is deprecated, please use getSnapshot in the PageController\n     * @returns UInt8Array snapshot of the current layout\n     */\n    getSelectedSnapshot = async () => {\n        const res = await this.#blobAPI;\n        return res.getPageSnapshot().then((result) => (result as Uint8Array) ?? (result as EditorResponse<null>));\n    };\n\n    /**\n     * This method sets the intent of a specific layout. Note that setting the intent for a layout\n     * can have side-effects such as updating the measurement unit\n     * @param id the id of a specific layout\n     * @param intent the intent that will be used for the layout\n     */\n    setIntent = async (id: Id, intent: LayoutIntent) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutIntent(id, intent).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method resets the intent of a specific layout to its original (inherited) value.\n     * Note: Calling this on the top layout is not valid\n     *\n     * @param id The id of the (child) layout to reset the intent for\n     */\n    resetIntent = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.resetLayoutIntent(id).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method sets the fill color of a specific layout.\n     * Note: Depending on the layout intent, some colors might not be valid (eg opacity for digitalAnimated, any color for print)\n     *\n     * @param id the id of a specific layout\n     * @param color the color that will be used for the layout\n     */\n    setFillColor = async (id: Id, color: ColorUsage) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutFillColor(id, JSON.stringify(color)).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This is a convenience method to enable or disable the fill color of a specific layout.\n     * Note: Depending on the layout intent, disabling might not be valid (eg disabling for digitalAnimated)\n     *\n     * @param id the id of a specific layout\n     * @param enabled whether the fill color should be enabled or disabled\n     */\n    setFillColorEnabled = async (id: Id, enabled: boolean) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutFillColorEnabled(id, enabled).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method resets the fill color of a specific layout to its original (inherited) value.\n     * Note: Calling this on the top layout is not valid\n     *\n     * @param id The id of the (child) layout to reset the fill color for\n     */\n    resetFillColor = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.resetLayoutFillColor(id).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method sets the bleed value of a specific layout.\n     * Note: this is only valid on a print layout\n     *\n     * @param id The id of the specific layout\n     * @param value The bleed value\n     * @param position When defined will update the bleed value of a single position,\n     * otherwise will set all positions to the same value. Depending on this parameter\n     * being defined, the `areBleedValuesCombined` will also be updated.\n     */\n    setBleedValue = async (id: Id, value: string, position?: PositionEnum) => {\n        const update: BleedDeltaUpdate = position\n            ? {\n                  left: position === PositionEnum.left ? value : undefined,\n                  top: position === PositionEnum.top ? value : undefined,\n                  right: position === PositionEnum.right ? value : undefined,\n                  bottom: position === PositionEnum.bottom ? value : undefined,\n              }\n            : { left: value, top: value, right: value, bottom: value };\n\n        const res = await this.#editorAPI;\n        return res.updateLayoutBleed(id, JSON.stringify(update)).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method sets the combined state of the bleed values.\n     * Note: this is only valid on a print layout\n     *\n     * @param id The id of the specific layout\n     * @param value Whether the bleed values are combined\n     */\n    setAreBleedValuesCombined = async (id: Id, value: boolean) => {\n        const update: BleedDeltaUpdate = { areBleedValuesCombined: value };\n\n        const res = await this.#editorAPI;\n        return res.updateLayoutBleed(id, JSON.stringify(update)).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will reset the bleed values on the specified layout to its original (inherited) value.\n     * Note: Calling this on the top layout is not valid.\n     *\n     * @param id The id of the (child) layout to reset the bleed values for\n     */\n    resetBleedValues = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res.updateLayoutBleed(id, null).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * Sets the private data for any layout\n     * @param id the id of the layout to update\n     * @param privateData the private data\n     * @returns\n     */\n    setPrivateData = async (id: string, privateData: PrivateData) => {\n        const res = await this.#editorAPI;\n        return res\n            .setLayoutPrivateData(id, JSON.stringify(privateData))\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * Gets the private data for any layout\n     * @param id the id of the layout\n     * @returns the private data\n     */\n    getPrivateData = async (id: string) => {\n        const res = await this.#editorAPI;\n        return res.getLayoutPrivateData(id).then((result) => getEditorResponseData<PrivateData>(result));\n    };\n\n    /**\n     * Sets the display name for any layout\n     * @param id the id of the layout to update\n     * @param displayName the display name\n     * @returns\n     */\n    setDisplayName = async (id: string, displayName: string) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutDisplayName(id, displayName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * Gets the display name for any layout\n     * @param id the id of the layout\n     * @returns the display name\n     */\n    getDisplayName = async (id: string) => {\n        const res = await this.#editorAPI;\n        return res.getLayoutDisplayName(id).then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * Resets the display name for any layout\n     * @param id the id of the layout to update\n     * @returns\n     */\n    resetDisplayName = async (id: string) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutDisplayName(id, null).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will set the layout availability for end-users\n     *\n     * @param id The id of a specific layout\n     * @param isAvailable whether this layout is available for end-users\n     * @returns\n     */\n    setAvailableForUser = async (id: Id, isAvailable: boolean) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutAvailableForUser(id, isAvailable).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will set the user selected layout\n     *\n     * @param id The id of a specific layout\n     * @param isSelected whether this layout is selected by end-users\n     * @returns\n     */\n    setSelectedByUser = async (id: Id, isSelected: boolean) => {\n        const res = await this.#editorAPI;\n        return res.setLayoutSelectedByUser(id, isSelected).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will set the layout size boundaries for end-users\n     *\n     * @param id The id of a specific layout\n     * @param resizableLayoutProperties the new layout size boundaries\n     * @returns\n     */\n    setResizableByUser = async (id: Id, resizableLayoutProperties: ResizableLayoutPropertiesUpdate) => {\n        const res = await this.#editorAPI;\n        return res\n            .setLayoutResizableByUser(id, JSON.stringify(resizableLayoutProperties))\n            .then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":[],"mappings":";;;;;;;;;;AAmBO,MAAM,iBAAiB;AAAA;AAAA;AAAA;AAAA,EAU1B,YAAY,WAAsB;AANlC;AAAA;AAAA;AAAA;AACA;AAcA,SAAA,SAAS,YAAY;AACjB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,aAAa,KAAK,CAAC,WAAW,sBAAgC,MAAM,CAAC;AAAA,IACpF;AAOA,SAAA,UAAU,OAAO,OAAW;AACxB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,cAAc,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IACvF;AAOA,SAAA,YAAY,OAAO,SAAiB;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IAC3F;AAMA,SAAA,cAAc,YAAY;AACtB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IACzF;AAOA,SAAA,SAAS,OAAO,OAAW;AACvB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,aAAa,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACpF;AAOA,SAAA,SAAS,OAAO,UAAc,YAA6B;AACvD,YAAM,MAAM,MAAM,mBAAK;AAEvB,UAAI,mCAAS,QAAQ;AACjB,eAAO,IACF,WAAW,UAAU,KAAK,UAAU,OAAO,CAAC,EAC5C,KAAK,CAAC,WAAW,sBAA0B,MAAM,CAAC;AAAA,MAC3D;AAEA,aAAO,IAAI,UAAU,QAAQ,EAAE,KAAK,CAAC,WAAW,sBAA0B,MAAM,CAAC;AAAA,IACrF;AAQA,SAAA,SAAS,OAAO,IAAQ,SAAiB;AACrC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,aAAa,IAAI,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC1F;AAOA,SAAA,SAAS,OAAO,OAAW;AACvB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,wBAAwB,IAAI,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACrG;AASA,SAAA,qBAAqB,OAAO,IAAQ,aAAmC;AACnE,YAAM,MAAM,MAAM,mBAAK;AACvB,YAAM,UAA+B;AAAA,QACjC;AAAA,MAAA;AAEJ,aAAO,IACF,wBAAwB,IAAI,KAAK,UAAU,OAAO,CAAC,EACnD,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAOA,SAAA,YAAY,OAAO,OAAW;AAC1B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA0B,MAAM,CAAC;AAAA,IACrF;AAOA,SAAA,QAAQ,OAAO,OAAW;AACtB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,YAAY,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACnF;AAQA,SAAA,YAAY,OAAO,IAAQ,WAAmB;AAC1C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,IAAI,MAAM,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC/F;AAQA,SAAA,WAAW,OAAO,IAAQ,UAAkB;AACxC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,eAAe,IAAI,KAAK,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7F;AASA,SAAA,UAAU,OAAO,IAAQ,SAA0B;AAC/C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,cAAc,IAAI,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3F;AAOA,SAAA,cAAc,OAAO,OAAW;AAC5B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACzF;AAOA,SAAA,aAAa,OAAO,OAAW;AAC3B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,iBAAiB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACxF;AAOA,SAAA,YAAY,OAAO,OAAW;AAC1B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACvF;AAQA,SAAA,sBAAsB,YAAY;AAC9B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,KAAK,CAAC,WAAY,UAA0B,MAA+B;AAAA,IAC5G;AAQA,SAAA,YAAY,OAAO,IAAQ,WAAyB;AAChD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,IAAI,MAAM,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC/F;AAQA,SAAA,cAAc,OAAO,OAAW;AAC5B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACzF;AASA,SAAA,eAAe,OAAO,IAAQ,UAAsB;AAChD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,mBAAmB,IAAI,KAAK,UAAU,KAAK,CAAC,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACjH;AASA,SAAA,sBAAsB,OAAO,IAAQ,YAAqB;AACtD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,0BAA0B,IAAI,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC1G;AAQA,SAAA,iBAAiB,OAAO,OAAW;AAC/B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC5F;AAYA,SAAA,gBAAgB,OAAO,IAAQ,OAAe,aAA4B;AACtE,YAAM,SAA2B,WAC3B;AAAA,QACI,MAAM,aAAa,aAAa,OAAO,QAAQ;AAAA,QAC/C,KAAK,aAAa,aAAa,MAAM,QAAQ;AAAA,QAC7C,OAAO,aAAa,aAAa,QAAQ,QAAQ;AAAA,QACjD,QAAQ,aAAa,aAAa,SAAS,QAAQ;AAAA,MAAA,IAEvD,EAAE,MAAM,OAAO,KAAK,OAAO,OAAO,OAAO,QAAQ,MAAA;AAEvD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,IAAI,KAAK,UAAU,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACjH;AASA,SAAA,4BAA4B,OAAO,IAAQ,UAAmB;AAC1D,YAAM,SAA2B,EAAE,wBAAwB,MAAA;AAE3D,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,IAAI,KAAK,UAAU,MAAM,CAAC,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACjH;AAQA,SAAA,mBAAmB,OAAO,OAAW;AACjC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,IAAI,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC/F;AAQA,SAAA,iBAAiB,OAAO,IAAY,gBAA6B;AAC7D,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,qBAAqB,IAAI,KAAK,UAAU,WAAW,CAAC,EACpD,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAOA,SAAA,iBAAiB,OAAO,OAAe;AACnC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAAmC,MAAM,CAAC;AAAA,IACnG;AAQA,SAAA,iBAAiB,OAAO,IAAY,gBAAwB;AACxD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,IAAI,WAAW,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACzG;AAOA,SAAA,iBAAiB,OAAO,OAAe;AACnC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IAC9F;AAOA,SAAA,mBAAmB,OAAO,OAAe;AACrC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,IAAI,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAClG;AASA,SAAA,sBAAsB,OAAO,IAAQ,gBAAyB;AAC1D,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,0BAA0B,IAAI,WAAW,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC9G;AASA,SAAA,oBAAoB,OAAO,IAAQ,eAAwB;AACvD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,wBAAwB,IAAI,UAAU,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3G;AASA,SAAA,qBAAqB,OAAO,IAAQ,8BAA+D;AAC/F,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,yBAAyB,IAAI,KAAK,UAAU,yBAAyB,CAAC,EACtE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AA9YI,uBAAK,YAAa;AAClB,uBAAK,UAAW;AAAA,EACpB;AA6YJ;AAtZI;AACA;"}

package/lib/src/controllers/MediaConnectorController.cjs.js

@@ -0,0 +1,93 @@
+"use strict";
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var _editorAPI, _blobAPI;
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ConnectorTypes = require("../types/ConnectorTypes.cjs.js");
+const MediaConnectorTypes = require("../types/MediaConnectorTypes.cjs.js");
+const EditorResponseData = require("../utils/EditorResponseData.cjs.js");
+const Helpers = require("../exceptions/Helpers.cjs.js");
+class MediaConnectorController {
+  /**
+   * @ignore
+   */
+  constructor(editorAPI) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _editorAPI);
+    __privateAdd(this, _blobAPI);
+    this.query = async (id, queryOptions, context = {}) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorQuery(id, JSON.stringify(queryOptions), JSON.stringify(context)).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.detail = async (id, mediaId, context = {}) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorDetail(id, mediaId, JSON.stringify(context)).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.download = async (id, mediaId, downloadType, context = {}) => {
+      const compatibleDownloadType = this.parseDeprecatedMediaDownloadType(
+        downloadType
+      );
+      const res = await __privateGet(this, _blobAPI);
+      return res.mediaConnectorDownload(
+        id,
+        mediaId,
+        compatibleDownloadType,
+        MediaConnectorTypes.MediaDownloadIntent.web,
+        JSON.stringify(context)
+      ).then((result) => {
+        if (result instanceof Uint8Array) {
+          return result;
+        }
+        if (typeof result === "object" && result !== null && "success" in result && !result.success) {
+          Helpers.throwEditorResponseError(result);
+        }
+        throw new Error(`Unexpected response type: ${typeof result}.`);
+      });
+    };
+    this.getConfigurationOptions = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorGetConfigurationOptions(id).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.getCapabilities = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorGetCapabilities(id).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.parseDeprecatedMediaType = (deprecatedType) => {
+      if (deprecatedType === ConnectorTypes.DeprecatedMediaType.file) return ConnectorTypes.MediaType.file;
+      if (deprecatedType === ConnectorTypes.DeprecatedMediaType.collection) return ConnectorTypes.MediaType.collection;
+    };
+    this.upload = async (connectorId, filePointers, context = {}) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorUpload(connectorId, JSON.stringify(filePointers), JSON.stringify(context)).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    __privateSet(this, _editorAPI, editorAPI);
+    __privateSet(this, _blobAPI, editorAPI);
+  }
+  /**
+   * This method will parse the deprecatedMediaDownloadType to the new media download type.
+   * This method will be removed once the deprecatedMediaDownloadType is out of use
+   * @param deprecatedMediaDownloadType legacy download type
+   * @returns MediaDownloadType
+   */
+  parseDeprecatedMediaDownloadType(deprecatedMediaDownloadType) {
+    switch (deprecatedMediaDownloadType) {
+      case ConnectorTypes.DeprecatedMediaConnectorDownloadType.HighResolutionWeb:
+        return MediaConnectorTypes.MediaDownloadType.highres;
+      case ConnectorTypes.DeprecatedMediaConnectorDownloadType.LowResolutionWeb:
+        return MediaConnectorTypes.MediaDownloadType.thumbnail;
+      default:
+        return deprecatedMediaDownloadType;
+    }
+  }
+}
+_editorAPI = new WeakMap();
+_blobAPI = new WeakMap();
+exports.MediaConnectorController = MediaConnectorController;
+//# sourceMappingURL=MediaConnectorController.cjs.js.map

package/lib/src/controllers/MediaConnectorController.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaConnectorController.cjs.js","sources":["../../../src/controllers/MediaConnectorController.ts"],"sourcesContent":["import { CallSender } from 'penpal';\nimport { EditorAPI, EditorRawAPI, EditorResponse, Id } from '../types/CommonTypes';\nimport {\n    ConnectorConfigOptions,\n    DeprecatedMediaConnectorDownloadType,\n    DeprecatedMediaType,\n    FilePointer,\n    MediaType,\n    MetaData,\n    QueryOptions,\n    QueryPage,\n} from '../types/ConnectorTypes';\nimport {\n    Media,\n    MediaConnectorCapabilities,\n    MediaDetail,\n    MediaDownloadIntent,\n    MediaDownloadType,\n} from '../types/MediaConnectorTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\nimport { throwEditorResponseError } from '../exceptions';\n\n/**\n * The MediaConnectorController is responsible for all communication regarding media connectors.\n * Methods inside this controller can be called by `window.SDK.mediaConnector.{method-name}`\n *\n * The way GraFx Studio handles different sources of media is called 'MediaConnector'.\n * A MediaConnector is an implementation of a set of capabilities we need\n * to interact with a certain Digital Asset Management system.\n * In essence, a connector is the combination of a JavaScript snippet and some metadata.\n * The JavaScript snippet is loaded in the studio engine using a sandboxed JavaScript execution engine (QuickJs).\n * This allows us to execute the media connector\n * both on web using webassembly and on the server side during e.g. animation output generation.\n * This controller is an interface to the running connector instance inside the studio engine.\n */\nexport class MediaConnectorController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n    #blobAPI: EditorRawAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n        this.#blobAPI = editorAPI as CallSender as EditorRawAPI;\n    }\n\n    /**\n     * Query a specific MediaConnector for data using both standardized queryOptions and the dynamic\n     * context as parameters. This call returns an array of Media items.\n     * @param id unique id of the media connector\n     * @param queryOptions stringified instance of `QueryOptions`\n     * @param context context that will be available in the connector script.\n     * @returns array of Media items\n     */\n    query = async (id: Id, queryOptions: QueryOptions, context: MetaData = {}) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorQuery(id, JSON.stringify(queryOptions), JSON.stringify(context))\n            .then((result) => getEditorResponseData<QueryPage<Media>>(result));\n    };\n\n    /**\n     * Returns a single media using a specific MediaConnector.\n     *\n     * The connector needs to list `detail` as a supported capability.\n     * @param id unique id of the Media connector\n     * @param mediaId unique id of the Media\n     * @param context context that will be available in the connector script.\n     * @returns Media item\n     */\n    detail = async (id: Id, mediaId: string, context: MetaData = {}) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorDetail(id, mediaId, JSON.stringify(context))\n            .then((result) => getEditorResponseData<MediaDetail>(result));\n    };\n\n    /**\n     * The combination of a `connectorId` and `mediaId` is typically enough for a media connector to\n     * perform the download of this asset. The `download` endpoint is capable of relaying this information to the\n     * media connector instance running in the editor engine.\n     * @param id unique id of the media connector\n     * @param mediaId unique id of the media to download\n     * @param downloadType hint to the media connector about desired quality of the downloaded media\n     * @param context context that will be available in the connector script.\n     * @returns\n     */\n    download = async (id: Id, mediaId: Id, downloadType: MediaDownloadType, context: MetaData = {}) => {\n        const compatibleDownloadType = this.parseDeprecatedMediaDownloadType(\n            downloadType as unknown as DeprecatedMediaConnectorDownloadType,\n        ) as MediaDownloadType;\n        const res = await this.#blobAPI;\n\n        return res\n            .mediaConnectorDownload(\n                id,\n                mediaId,\n                compatibleDownloadType,\n                MediaDownloadIntent.web,\n                JSON.stringify(context),\n            )\n            .then((result) => {\n                // Handle binary data (Uint8Array) directly\n                if (result instanceof Uint8Array) {\n                    return result;\n                }\n\n                // Handle structured response (EditorResponse) for non-success cases\n                if (typeof result === 'object' && result !== null && 'success' in result && !result.success) {\n                    throwEditorResponseError(result as EditorResponse<null>);\n                }\n\n                // Unexpected response type - throw error\n                throw new Error(`Unexpected response type: ${typeof result}.`);\n            });\n    };\n\n    /**\n     * All connectors have a certain set of mappings they allow to be passed into the connector methods their context. This\n     * method allows you to discover which mappings are available for a given connector. If you want to use any of these\n     * mappings, they will be available in the `context` parameter of any connector method.\n     * @param id unique id of the media connector\n     * @returns connector mappings\n     */\n    getConfigurationOptions = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorGetConfigurationOptions(id)\n            .then((result) => getEditorResponseData<ConnectorConfigOptions>(result));\n    };\n\n    /**\n     * This method returns what capabilities the selected connector has. It gives an indication what methods can\n     * be used successfully for a certain connector.\n     * @param id unique id of the media connector\n     * @returns MediaConnectorCapabilities\n     */\n    getCapabilities = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorGetCapabilities(id)\n            .then((result) => getEditorResponseData<MediaConnectorCapabilities>(result));\n    };\n\n    /**\n     * This method will parse the deprecatedMediaType to the new media type. This method will be removed once the deprecatedMediaType is out of use\n     * @param deprecatedType is 0 or 1\n     * @returns connector capabilities\n     */\n    parseDeprecatedMediaType = (deprecatedType: DeprecatedMediaType) => {\n        if (deprecatedType === DeprecatedMediaType.file) return MediaType.file;\n        if (deprecatedType === DeprecatedMediaType.collection) return MediaType.collection;\n    };\n\n    /**\n     * This method will parse the deprecatedMediaDownloadType to the new media download type.\n     * This method will be removed once the deprecatedMediaDownloadType is out of use\n     * @param deprecatedMediaDownloadType legacy download type\n     * @returns MediaDownloadType\n     */\n    parseDeprecatedMediaDownloadType(\n        deprecatedMediaDownloadType: DeprecatedMediaConnectorDownloadType,\n    ): MediaDownloadType {\n        switch (deprecatedMediaDownloadType) {\n            case DeprecatedMediaConnectorDownloadType.HighResolutionWeb:\n                return MediaDownloadType.highres;\n            case DeprecatedMediaConnectorDownloadType.LowResolutionWeb:\n                return MediaDownloadType.thumbnail;\n            default:\n                return deprecatedMediaDownloadType as unknown as MediaDownloadType;\n        }\n    }\n\n    /**\n     * Invokes the upload on the connector, using the given staged pointer(s).\n     * If you want help with staging files, use the `stageFiles` method from the UtilsController.\n     * @param connectorId The MediaConnector instance to use (just like download API).\n     * @param filePointers Array of FilePointer as staged by stageFile(s).\n     * @param context Arbitrary metadata/context for the upload (auth, meta fields, etc).\n     * @returns Promise<Media[]>\n     */\n    upload = async (connectorId: Id, filePointers: FilePointer[], context: MetaData = {}) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorUpload(connectorId, JSON.stringify(filePointers), JSON.stringify(context))\n            .then((result) => getEditorResponseData<Media[]>(result));\n    };\n}\n"],"names":["getEditorResponseData","MediaDownloadIntent","throwEditorResponseError","DeprecatedMediaType","MediaType","DeprecatedMediaConnectorDownloadType","MediaDownloadType"],"mappings":";;;;;;;;;;;;;;AAmCO,MAAM,yBAAyB;AAAA;AAAA;AAAA;AAAA,EAUlC,YAAY,WAAsB;AANlC;AAAA;AAAA;AAAA;AACA;AAkBA,SAAA,QAAQ,OAAO,IAAQ,cAA4B,UAAoB,CAAA,MAAO;AAC1E,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,oBAAoB,IAAI,KAAK,UAAU,YAAY,GAAG,KAAK,UAAU,OAAO,CAAC,EAC7E,KAAK,CAAC,WAAWA,mBAAAA,sBAAwC,MAAM,CAAC;AAAA,IACzE;AAWA,SAAA,SAAS,OAAO,IAAQ,SAAiB,UAAoB,CAAA,MAAO;AAChE,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,qBAAqB,IAAI,SAAS,KAAK,UAAU,OAAO,CAAC,EACzD,KAAK,CAAC,WAAWA,mBAAAA,sBAAmC,MAAM,CAAC;AAAA,IACpE;AAYA,SAAA,WAAW,OAAO,IAAQ,SAAa,cAAiC,UAAoB,OAAO;AAC/F,YAAM,yBAAyB,KAAK;AAAA,QAChC;AAAA,MAAA;AAEJ,YAAM,MAAM,MAAM,mBAAK;AAEvB,aAAO,IACF;AAAA,QACG;AAAA,QACA;AAAA,QACA;AAAA,QACAC,oBAAAA,oBAAoB;AAAA,QACpB,KAAK,UAAU,OAAO;AAAA,MAAA,EAEzB,KAAK,CAAC,WAAW;AAEd,YAAI,kBAAkB,YAAY;AAC9B,iBAAO;AAAA,QACX;AAGA,YAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,aAAa,UAAU,CAAC,OAAO,SAAS;AACzFC,kBAAAA,yBAAyB,MAA8B;AAAA,QAC3D;AAGA,cAAM,IAAI,MAAM,6BAA6B,OAAO,MAAM,GAAG;AAAA,MACjE,CAAC;AAAA,IACT;AASA,SAAA,0BAA0B,OAAO,OAAW;AACxC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,sCAAsC,EAAE,EACxC,KAAK,CAAC,WAAWF,yCAA8C,MAAM,CAAC;AAAA,IAC/E;AAQA,SAAA,kBAAkB,OAAO,OAAW;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,8BAA8B,EAAE,EAChC,KAAK,CAAC,WAAWA,yCAAkD,MAAM,CAAC;AAAA,IACnF;AAOA,SAAA,2BAA2B,CAAC,mBAAwC;AAChE,UAAI,mBAAmBG,eAAAA,oBAAoB,KAAM,QAAOC,eAAAA,UAAU;AAClE,UAAI,mBAAmBD,eAAAA,oBAAoB,WAAY,QAAOC,eAAAA,UAAU;AAAA,IAC5E;AA6BA,SAAA,SAAS,OAAO,aAAiB,cAA6B,UAAoB,CAAA,MAAO;AACrF,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,qBAAqB,aAAa,KAAK,UAAU,YAAY,GAAG,KAAK,UAAU,OAAO,CAAC,EACvF,KAAK,CAAC,WAAWJ,mBAAAA,sBAA+B,MAAM,CAAC;AAAA,IAChE;AAhJI,uBAAK,YAAa;AAClB,uBAAK,UAAW;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoHA,iCACI,6BACiB;AACjB,YAAQ,6BAAA;AAAA,MACJ,KAAKK,eAAAA,qCAAqC;AACtC,eAAOC,oBAAAA,kBAAkB;AAAA,MAC7B,KAAKD,eAAAA,qCAAqC;AACtC,eAAOC,oBAAAA,kBAAkB;AAAA,MAC7B;AACI,eAAO;AAAA,IAAA;AAAA,EAEnB;AAgBJ;AAxJI;AACA;;"}

package/lib/src/controllers/MediaConnectorController.es.js

@@ -0,0 +1,93 @@
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var _editorAPI, _blobAPI;
+import { DeprecatedMediaType, MediaType, DeprecatedMediaConnectorDownloadType } from "../types/ConnectorTypes.es.js";
+import { MediaDownloadIntent, MediaDownloadType } from "../types/MediaConnectorTypes.es.js";
+import { getEditorResponseData } from "../utils/EditorResponseData.es.js";
+import { throwEditorResponseError } from "../exceptions/Helpers.es.js";
+class MediaConnectorController {
+  /**
+   * @ignore
+   */
+  constructor(editorAPI) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _editorAPI);
+    __privateAdd(this, _blobAPI);
+    this.query = async (id, queryOptions, context = {}) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorQuery(id, JSON.stringify(queryOptions), JSON.stringify(context)).then((result) => getEditorResponseData(result));
+    };
+    this.detail = async (id, mediaId, context = {}) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorDetail(id, mediaId, JSON.stringify(context)).then((result) => getEditorResponseData(result));
+    };
+    this.download = async (id, mediaId, downloadType, context = {}) => {
+      const compatibleDownloadType = this.parseDeprecatedMediaDownloadType(
+        downloadType
+      );
+      const res = await __privateGet(this, _blobAPI);
+      return res.mediaConnectorDownload(
+        id,
+        mediaId,
+        compatibleDownloadType,
+        MediaDownloadIntent.web,
+        JSON.stringify(context)
+      ).then((result) => {
+        if (result instanceof Uint8Array) {
+          return result;
+        }
+        if (typeof result === "object" && result !== null && "success" in result && !result.success) {
+          throwEditorResponseError(result);
+        }
+        throw new Error(`Unexpected response type: ${typeof result}.`);
+      });
+    };
+    this.getConfigurationOptions = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorGetConfigurationOptions(id).then((result) => getEditorResponseData(result));
+    };
+    this.getCapabilities = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorGetCapabilities(id).then((result) => getEditorResponseData(result));
+    };
+    this.parseDeprecatedMediaType = (deprecatedType) => {
+      if (deprecatedType === DeprecatedMediaType.file) return MediaType.file;
+      if (deprecatedType === DeprecatedMediaType.collection) return MediaType.collection;
+    };
+    this.upload = async (connectorId, filePointers, context = {}) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.mediaConnectorUpload(connectorId, JSON.stringify(filePointers), JSON.stringify(context)).then((result) => getEditorResponseData(result));
+    };
+    __privateSet(this, _editorAPI, editorAPI);
+    __privateSet(this, _blobAPI, editorAPI);
+  }
+  /**
+   * This method will parse the deprecatedMediaDownloadType to the new media download type.
+   * This method will be removed once the deprecatedMediaDownloadType is out of use
+   * @param deprecatedMediaDownloadType legacy download type
+   * @returns MediaDownloadType
+   */
+  parseDeprecatedMediaDownloadType(deprecatedMediaDownloadType) {
+    switch (deprecatedMediaDownloadType) {
+      case DeprecatedMediaConnectorDownloadType.HighResolutionWeb:
+        return MediaDownloadType.highres;
+      case DeprecatedMediaConnectorDownloadType.LowResolutionWeb:
+        return MediaDownloadType.thumbnail;
+      default:
+        return deprecatedMediaDownloadType;
+    }
+  }
+}
+_editorAPI = new WeakMap();
+_blobAPI = new WeakMap();
+export {
+  MediaConnectorController
+};
+//# sourceMappingURL=MediaConnectorController.es.js.map

package/lib/src/controllers/MediaConnectorController.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MediaConnectorController.es.js","sources":["../../../src/controllers/MediaConnectorController.ts"],"sourcesContent":["import { CallSender } from 'penpal';\nimport { EditorAPI, EditorRawAPI, EditorResponse, Id } from '../types/CommonTypes';\nimport {\n    ConnectorConfigOptions,\n    DeprecatedMediaConnectorDownloadType,\n    DeprecatedMediaType,\n    FilePointer,\n    MediaType,\n    MetaData,\n    QueryOptions,\n    QueryPage,\n} from '../types/ConnectorTypes';\nimport {\n    Media,\n    MediaConnectorCapabilities,\n    MediaDetail,\n    MediaDownloadIntent,\n    MediaDownloadType,\n} from '../types/MediaConnectorTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\nimport { throwEditorResponseError } from '../exceptions';\n\n/**\n * The MediaConnectorController is responsible for all communication regarding media connectors.\n * Methods inside this controller can be called by `window.SDK.mediaConnector.{method-name}`\n *\n * The way GraFx Studio handles different sources of media is called 'MediaConnector'.\n * A MediaConnector is an implementation of a set of capabilities we need\n * to interact with a certain Digital Asset Management system.\n * In essence, a connector is the combination of a JavaScript snippet and some metadata.\n * The JavaScript snippet is loaded in the studio engine using a sandboxed JavaScript execution engine (QuickJs).\n * This allows us to execute the media connector\n * both on web using webassembly and on the server side during e.g. animation output generation.\n * This controller is an interface to the running connector instance inside the studio engine.\n */\nexport class MediaConnectorController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n    #blobAPI: EditorRawAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n        this.#blobAPI = editorAPI as CallSender as EditorRawAPI;\n    }\n\n    /**\n     * Query a specific MediaConnector for data using both standardized queryOptions and the dynamic\n     * context as parameters. This call returns an array of Media items.\n     * @param id unique id of the media connector\n     * @param queryOptions stringified instance of `QueryOptions`\n     * @param context context that will be available in the connector script.\n     * @returns array of Media items\n     */\n    query = async (id: Id, queryOptions: QueryOptions, context: MetaData = {}) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorQuery(id, JSON.stringify(queryOptions), JSON.stringify(context))\n            .then((result) => getEditorResponseData<QueryPage<Media>>(result));\n    };\n\n    /**\n     * Returns a single media using a specific MediaConnector.\n     *\n     * The connector needs to list `detail` as a supported capability.\n     * @param id unique id of the Media connector\n     * @param mediaId unique id of the Media\n     * @param context context that will be available in the connector script.\n     * @returns Media item\n     */\n    detail = async (id: Id, mediaId: string, context: MetaData = {}) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorDetail(id, mediaId, JSON.stringify(context))\n            .then((result) => getEditorResponseData<MediaDetail>(result));\n    };\n\n    /**\n     * The combination of a `connectorId` and `mediaId` is typically enough for a media connector to\n     * perform the download of this asset. The `download` endpoint is capable of relaying this information to the\n     * media connector instance running in the editor engine.\n     * @param id unique id of the media connector\n     * @param mediaId unique id of the media to download\n     * @param downloadType hint to the media connector about desired quality of the downloaded media\n     * @param context context that will be available in the connector script.\n     * @returns\n     */\n    download = async (id: Id, mediaId: Id, downloadType: MediaDownloadType, context: MetaData = {}) => {\n        const compatibleDownloadType = this.parseDeprecatedMediaDownloadType(\n            downloadType as unknown as DeprecatedMediaConnectorDownloadType,\n        ) as MediaDownloadType;\n        const res = await this.#blobAPI;\n\n        return res\n            .mediaConnectorDownload(\n                id,\n                mediaId,\n                compatibleDownloadType,\n                MediaDownloadIntent.web,\n                JSON.stringify(context),\n            )\n            .then((result) => {\n                // Handle binary data (Uint8Array) directly\n                if (result instanceof Uint8Array) {\n                    return result;\n                }\n\n                // Handle structured response (EditorResponse) for non-success cases\n                if (typeof result === 'object' && result !== null && 'success' in result && !result.success) {\n                    throwEditorResponseError(result as EditorResponse<null>);\n                }\n\n                // Unexpected response type - throw error\n                throw new Error(`Unexpected response type: ${typeof result}.`);\n            });\n    };\n\n    /**\n     * All connectors have a certain set of mappings they allow to be passed into the connector methods their context. This\n     * method allows you to discover which mappings are available for a given connector. If you want to use any of these\n     * mappings, they will be available in the `context` parameter of any connector method.\n     * @param id unique id of the media connector\n     * @returns connector mappings\n     */\n    getConfigurationOptions = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorGetConfigurationOptions(id)\n            .then((result) => getEditorResponseData<ConnectorConfigOptions>(result));\n    };\n\n    /**\n     * This method returns what capabilities the selected connector has. It gives an indication what methods can\n     * be used successfully for a certain connector.\n     * @param id unique id of the media connector\n     * @returns MediaConnectorCapabilities\n     */\n    getCapabilities = async (id: Id) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorGetCapabilities(id)\n            .then((result) => getEditorResponseData<MediaConnectorCapabilities>(result));\n    };\n\n    /**\n     * This method will parse the deprecatedMediaType to the new media type. This method will be removed once the deprecatedMediaType is out of use\n     * @param deprecatedType is 0 or 1\n     * @returns connector capabilities\n     */\n    parseDeprecatedMediaType = (deprecatedType: DeprecatedMediaType) => {\n        if (deprecatedType === DeprecatedMediaType.file) return MediaType.file;\n        if (deprecatedType === DeprecatedMediaType.collection) return MediaType.collection;\n    };\n\n    /**\n     * This method will parse the deprecatedMediaDownloadType to the new media download type.\n     * This method will be removed once the deprecatedMediaDownloadType is out of use\n     * @param deprecatedMediaDownloadType legacy download type\n     * @returns MediaDownloadType\n     */\n    parseDeprecatedMediaDownloadType(\n        deprecatedMediaDownloadType: DeprecatedMediaConnectorDownloadType,\n    ): MediaDownloadType {\n        switch (deprecatedMediaDownloadType) {\n            case DeprecatedMediaConnectorDownloadType.HighResolutionWeb:\n                return MediaDownloadType.highres;\n            case DeprecatedMediaConnectorDownloadType.LowResolutionWeb:\n                return MediaDownloadType.thumbnail;\n            default:\n                return deprecatedMediaDownloadType as unknown as MediaDownloadType;\n        }\n    }\n\n    /**\n     * Invokes the upload on the connector, using the given staged pointer(s).\n     * If you want help with staging files, use the `stageFiles` method from the UtilsController.\n     * @param connectorId The MediaConnector instance to use (just like download API).\n     * @param filePointers Array of FilePointer as staged by stageFile(s).\n     * @param context Arbitrary metadata/context for the upload (auth, meta fields, etc).\n     * @returns Promise<Media[]>\n     */\n    upload = async (connectorId: Id, filePointers: FilePointer[], context: MetaData = {}) => {\n        const res = await this.#editorAPI;\n        return res\n            .mediaConnectorUpload(connectorId, JSON.stringify(filePointers), JSON.stringify(context))\n            .then((result) => getEditorResponseData<Media[]>(result));\n    };\n}\n"],"names":[],"mappings":";;;;;;;;;;;;AAmCO,MAAM,yBAAyB;AAAA;AAAA;AAAA;AAAA,EAUlC,YAAY,WAAsB;AANlC;AAAA;AAAA;AAAA;AACA;AAkBA,SAAA,QAAQ,OAAO,IAAQ,cAA4B,UAAoB,CAAA,MAAO;AAC1E,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,oBAAoB,IAAI,KAAK,UAAU,YAAY,GAAG,KAAK,UAAU,OAAO,CAAC,EAC7E,KAAK,CAAC,WAAW,sBAAwC,MAAM,CAAC;AAAA,IACzE;AAWA,SAAA,SAAS,OAAO,IAAQ,SAAiB,UAAoB,CAAA,MAAO;AAChE,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,qBAAqB,IAAI,SAAS,KAAK,UAAU,OAAO,CAAC,EACzD,KAAK,CAAC,WAAW,sBAAmC,MAAM,CAAC;AAAA,IACpE;AAYA,SAAA,WAAW,OAAO,IAAQ,SAAa,cAAiC,UAAoB,OAAO;AAC/F,YAAM,yBAAyB,KAAK;AAAA,QAChC;AAAA,MAAA;AAEJ,YAAM,MAAM,MAAM,mBAAK;AAEvB,aAAO,IACF;AAAA,QACG;AAAA,QACA;AAAA,QACA;AAAA,QACA,oBAAoB;AAAA,QACpB,KAAK,UAAU,OAAO;AAAA,MAAA,EAEzB,KAAK,CAAC,WAAW;AAEd,YAAI,kBAAkB,YAAY;AAC9B,iBAAO;AAAA,QACX;AAGA,YAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,aAAa,UAAU,CAAC,OAAO,SAAS;AACzF,mCAAyB,MAA8B;AAAA,QAC3D;AAGA,cAAM,IAAI,MAAM,6BAA6B,OAAO,MAAM,GAAG;AAAA,MACjE,CAAC;AAAA,IACT;AASA,SAAA,0BAA0B,OAAO,OAAW;AACxC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,sCAAsC,EAAE,EACxC,KAAK,CAAC,WAAW,sBAA8C,MAAM,CAAC;AAAA,IAC/E;AAQA,SAAA,kBAAkB,OAAO,OAAW;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,8BAA8B,EAAE,EAChC,KAAK,CAAC,WAAW,sBAAkD,MAAM,CAAC;AAAA,IACnF;AAOA,SAAA,2BAA2B,CAAC,mBAAwC;AAChE,UAAI,mBAAmB,oBAAoB,KAAM,QAAO,UAAU;AAClE,UAAI,mBAAmB,oBAAoB,WAAY,QAAO,UAAU;AAAA,IAC5E;AA6BA,SAAA,SAAS,OAAO,aAAiB,cAA6B,UAAoB,CAAA,MAAO;AACrF,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,qBAAqB,aAAa,KAAK,UAAU,YAAY,GAAG,KAAK,UAAU,OAAO,CAAC,EACvF,KAAK,CAAC,WAAW,sBAA+B,MAAM,CAAC;AAAA,IAChE;AAhJI,uBAAK,YAAa;AAClB,uBAAK,UAAW;AAAA,EACpB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAoHA,iCACI,6BACiB;AACjB,YAAQ,6BAAA;AAAA,MACJ,KAAK,qCAAqC;AACtC,eAAO,kBAAkB;AAAA,MAC7B,KAAK,qCAAqC;AACtC,eAAO,kBAAkB;AAAA,MAC7B;AACI,eAAO;AAAA,IAAA;AAAA,EAEnB;AAgBJ;AAxJI;AACA;"}

package/lib/src/controllers/PageController.cjs.js

@@ -0,0 +1,95 @@
+"use strict";
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
+var __privateSet = (obj, member, value, setter) => (__accessCheck(obj, member, "write to private field"), setter ? setter.call(obj, value) : member.set(obj, value), value);
+var _editorAPI, _blobAPI;
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const EditorResponseData = require("../utils/EditorResponseData.cjs.js");
+const Helpers = require("../exceptions/Helpers.cjs.js");
+class PageController {
+  /**
+   * @ignore
+   */
+  constructor(editorAPI) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _editorAPI);
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _blobAPI);
+    this.add = async () => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.addPage().then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.remove = async (pageId) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.removePage(pageId).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.select = async (pageId) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.selectPage(pageId).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.setVisibility = async (pageId, isVisible) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setPageIsVisible(pageId, isVisible).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.duplicate = async (pageId) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.duplicatePage(pageId).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.getAll = async () => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getPages().then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.getById = async (pageId) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getPageById(pageId).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.getSnapshot = async (pageId, settings) => {
+      const res = await __privateGet(this, _blobAPI);
+      return res.getPageSnapshotWithSettings(pageId, settings == null ? null : JSON.stringify(settings)).then((result) => {
+        if (result instanceof Uint8Array) {
+          return result;
+        }
+        if (typeof result === "object" && result !== null && "success" in result && !result.success) {
+          Helpers.throwEditorResponseError(result);
+        }
+        throw new Error(`Unexpected response type: ${typeof result}.`);
+      });
+    };
+    this.setWidth = async (_pageId, width) => {
+      if (_pageId !== void 0) {
+        console.warn("pageId has no effect since all pages are being updated simultaneously.");
+      }
+      const res = await __privateGet(this, _editorAPI);
+      return res.setPageWidth(width).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.setHeight = async (_pageId, height) => {
+      if (_pageId !== void 0) {
+        console.warn("pageId has no effect since all pages are being updated simultaneously.");
+      }
+      const res = await __privateGet(this, _editorAPI);
+      return res.setPageHeight(height).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.setSize = async (width, height) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setPageSize(width, height).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.move = async (order, ids) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.reorderPages(order, ids).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    __privateSet(this, _editorAPI, editorAPI);
+    __privateSet(this, _blobAPI, editorAPI);
+  }
+}
+_editorAPI = new WeakMap();
+_blobAPI = new WeakMap();
+exports.PageController = PageController;
+//# sourceMappingURL=PageController.cjs.js.map

package/lib/src/controllers/PageController.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PageController.cjs.js","sources":["../../../src/controllers/PageController.ts"],"sourcesContent":["import { EditorAPI, EditorRawAPI, EditorResponse, Id } from '../types/CommonTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\nimport { throwEditorResponseError } from '../exceptions';\nimport { Page, SnapshotSettings } from '../types/PageTypes';\nimport { CallSender } from 'penpal';\n\n/**\n * The PageController is responsible for all communication regarding Pages.\n * Methods inside this controller can be called by `window.SDK.page.{method-name}`\n */\nexport class PageController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    #blobAPI: EditorRawAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n        this.#blobAPI = editorAPI as CallSender as EditorRawAPI;\n    }\n\n    /**\n     * @experimental\n     * This method adds a new page.\n     * @returns the id of the new page\n     */\n    add = async () => {\n        const res = await this.#editorAPI;\n        return res.addPage().then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * @experimental\n     * This method removes a certain page.\n     * @param pageId the id of the page\n     * @returns the id of the current active page\n     */\n    remove = async (pageId: Id) => {\n        const res = await this.#editorAPI;\n        return res.removePage(pageId).then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * @experimental\n     * This method selects a certain page to be the active page.\n     * @param pageId the id of the page\n     * @returns\n     */\n    select = async (pageId: Id) => {\n        const res = await this.#editorAPI;\n        return res.selectPage(pageId).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental\n     * This method sets the page's visibility.\n     * @param pageId the id of the page\n     * @param isVisible the visibility of the page\n     * @returns\n     */\n    setVisibility = async (pageId: Id, isVisible: boolean) => {\n        const res = await this.#editorAPI;\n        return res.setPageIsVisible(pageId, isVisible).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental\n     * This method duplicates a certain page.\n     * @param pageId the id of the page\n     * @returns\n     */\n    duplicate = async (pageId: Id) => {\n        const res = await this.#editorAPI;\n        return res.duplicatePage(pageId).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method returns the list of pages\n     * @returns list of all pages\n     */\n    getAll = async () => {\n        const res = await this.#editorAPI;\n        return res.getPages().then((result) => getEditorResponseData<Page[]>(result));\n    };\n\n    /**\n     * This method returns a page by its id\n     * @param pageId the id of a specific page\n     * @returns page properties\n     */\n    getById = async (pageId: Id) => {\n        const res = await this.#editorAPI;\n        return res.getPageById(pageId).then((result) => getEditorResponseData<Page>(result));\n    };\n\n    /**\n     * This method returns a UInt8Array containing a PNG encoded image of the page.\n     * @param pageId The id of a specific page.\n     * If not specified, selected page snapshot will be provided\n     * @param settings an object to specify desired snapshot properties, e.g., resolution.\n     * If it's not provided, default settings will be applied, e.g., page resolution.\n     * Limit for `largestAxisSize` is 1000 px\n     * @returns UInt8Array snapshot of the given page\n     */\n    getSnapshot = async (pageId?: Id, settings?: SnapshotSettings | null) => {\n        const res = await this.#blobAPI;\n        return res\n            .getPageSnapshotWithSettings(pageId, settings == null ? null : JSON.stringify(settings))\n            .then((result) => {\n                // Handle binary data (Uint8Array) directly\n                if (result instanceof Uint8Array) {\n                    return result;\n                }\n\n                // Handle structured response (EditorResponse) for non-success cases\n                if (typeof result === 'object' && result !== null && 'success' in result && !result.success) {\n                    throwEditorResponseError(result as EditorResponse<null>);\n                }\n\n                // Unexpected response type - throw error\n                throw new Error(`Unexpected response type: ${typeof result}.`);\n            });\n    };\n\n    /**\n     * This method will set the width of the page to a specific value.\n     * This only works if the document is a project.\n     * @param _pageId the id of a specific page.\n     * @param width the string value that will be calculated (f.e. 1+1 will result in 2) The default unit is in the current layout unit (e.g. px, mm, in)\n     */\n    setWidth = async (_pageId: Id | undefined, width: string) => {\n        if (_pageId !== undefined) {\n            console.warn('pageId has no effect since all pages are being updated simultaneously.');\n        }\n\n        const res = await this.#editorAPI;\n        return res.setPageWidth(width).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method will set the height of the page to a specific value.\n     * This only works if the document is a project.\n     * @param _pageId the id of a specific page.\n     * @param height the string value that will be calculated (f.e. 1+1 will result in 2). The default unit is in the current layout unit (e.g. px, mm, in)\n     * @returns\n     */\n    setHeight = async (_pageId: Id | undefined, height: string) => {\n        if (_pageId !== undefined) {\n            console.warn('pageId has no effect since all pages are being updated simultaneously.');\n        }\n\n        const res = await this.#editorAPI;\n        return res.setPageHeight(height).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * Sets the width and height of the page to a specific value simultaneously.\n     * This only works if the document is a project.\n     * @param width the string value that will be calculated (f.e. 1+1 will result in 2). The default unit is in the current layout unit (e.g. px, mm, in)\n     * @param height the string value that will be calculated (f.e. 1+1 will result in 2). The default unit is in the current layout unit (e.g. px, mm, in)\n     */\n    setSize = async (width: string, height: string) => {\n        const res = await this.#editorAPI;\n        return res.setPageSize(width, height).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method changes the order of pages.\n     * @param order the index in the list to move to\n     * @param ids An array of all IDs you want to move to the given index\n     * @returns\n     */\n    move = async (order: number, ids: Id[]) => {\n        const res = await this.#editorAPI;\n        return res.reorderPages(order, ids).then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":["getEditorResponseData","throwEditorResponseError"],"mappings":";;;;;;;;;;;;AAUO,MAAM,eAAe;AAAA;AAAA;AAAA;AAAA,EAcxB,YAAY,WAAsB;AAVlC;AAAA;AAAA;AAAA;AAKA;AAAA;AAAA;AAAA;AAeA,SAAA,MAAM,YAAY;AACd,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,UAAU,KAAK,CAAC,WAAWA,mBAAAA,sBAA0B,MAAM,CAAC;AAAA,IAC3E;AAQA,SAAA,SAAS,OAAO,WAAe;AAC3B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,WAAW,MAAM,EAAE,KAAK,CAAC,WAAWA,yCAA0B,MAAM,CAAC;AAAA,IACpF;AAQA,SAAA,SAAS,OAAO,WAAe;AAC3B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,WAAW,MAAM,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACtF;AASA,SAAA,gBAAgB,OAAO,QAAY,cAAuB;AACtD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,iBAAiB,QAAQ,SAAS,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACvG;AAQA,SAAA,YAAY,OAAO,WAAe;AAC9B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,cAAc,MAAM,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACzF;AAMA,SAAA,SAAS,YAAY;AACjB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,WAAW,KAAK,CAAC,WAAWA,mBAAAA,sBAA8B,MAAM,CAAC;AAAA,IAChF;AAOA,SAAA,UAAU,OAAO,WAAe;AAC5B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,YAAY,MAAM,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACvF;AAWA,SAAA,cAAc,OAAO,QAAa,aAAuC;AACrE,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,4BAA4B,QAAQ,YAAY,OAAO,OAAO,KAAK,UAAU,QAAQ,CAAC,EACtF,KAAK,CAAC,WAAW;AAEd,YAAI,kBAAkB,YAAY;AAC9B,iBAAO;AAAA,QACX;AAGA,YAAI,OAAO,WAAW,YAAY,WAAW,QAAQ,aAAa,UAAU,CAAC,OAAO,SAAS;AACzFC,kBAAAA,yBAAyB,MAA8B;AAAA,QAC3D;AAGA,cAAM,IAAI,MAAM,6BAA6B,OAAO,MAAM,GAAG;AAAA,MACjE,CAAC;AAAA,IACT;AAQA,SAAA,WAAW,OAAO,SAAyB,UAAkB;AACzD,UAAI,YAAY,QAAW;AACvB,gBAAQ,KAAK,wEAAwE;AAAA,MACzF;AAEA,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,aAAa,KAAK,EAAE,KAAK,CAAC,WAAWD,yCAA4B,MAAM,CAAC;AAAA,IACvF;AASA,SAAA,YAAY,OAAO,SAAyB,WAAmB;AAC3D,UAAI,YAAY,QAAW;AACvB,gBAAQ,KAAK,wEAAwE;AAAA,MACzF;AAEA,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,cAAc,MAAM,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACzF;AAQA,SAAA,UAAU,OAAO,OAAe,WAAmB;AAC/C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,YAAY,OAAO,MAAM,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC9F;AAQA,SAAA,OAAO,OAAO,OAAe,QAAc;AACvC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,aAAa,OAAO,GAAG,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC5F;AA9JI,uBAAK,YAAa;AAClB,uBAAK,UAAW;AAAA,EACpB;AA6JJ;AA1KI;AAKA;;"}