@chili-publish/studio-sdk 0.121.0

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

@@ -0,0 +1,103 @@
+import type { EditorAPI, EditorResponse, Id } from '../types/CommonTypes';
+import { Layout } from '../types/LayoutTypes';
+/**
+ * The LayoutController is responsible for all communication regarding Layouts.
+ * Methods inside this controller can be called by `window.SDK.layout.{method-name}`
+ */
+export declare class LayoutController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * This method returns the list of layouts
+     * @returns
+     */
+    getLayouts: () => Promise<EditorResponse<Layout[]>>;
+    /**
+     * This method returns a layout by its id
+     * @param id The ID of a specific layout
+     * @returns
+     */
+    getLayoutById: (id: Id) => Promise<EditorResponse<Layout>>;
+    /**
+     * This method returns a layout by its name
+     * @param name The name of a specific layout
+     * @returns
+     */
+    getLayoutByName: (name: string) => Promise<EditorResponse<Layout>>;
+    /**
+     * This method returns the selected layout
+     * @returns
+     */
+    getSelectedLayout: () => Promise<EditorResponse<Layout>>;
+    /**
+     * This method will remove a specific layout
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    removeLayout: (layoutId: Id) => Promise<EditorResponse<null>>;
+    /**
+     * This method will add a new child layout (a new layout is always child of a root / parentlayout)
+     * @param parentId The ID of a specific layout, being the parent
+     * @returns
+     */
+    addLayout: (parentId: Id) => Promise<EditorResponse<number>>;
+    /**
+     * This method will update the name of a specific layout
+     * @param layoutId The ID of a specific layout
+     * @param layoutName The new name that the layout should receive
+     * @returns
+     */
+    setLayoutName: (layoutId: Id, layoutName: string) => Promise<EditorResponse<null>>;
+    /**
+     * This method will select a specific layout
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    selectLayout: (layoutId: Id) => Promise<EditorResponse<null>>;
+    /**
+     * This method will duplicate a specific layout
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    duplicateLayout: (layoutId: Id) => Promise<EditorResponse<number>>;
+    /**
+     * This method will reset a specific layout to its original value
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    resetLayout: (layoutId: Id) => Promise<EditorResponse<null>>;
+    /**
+     * This method will set the height of the layout to a specific value
+     * @param layoutId The ID of a specific layout
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setLayoutHeight: (layoutId: Id, value: string) => Promise<EditorResponse<null> | null>;
+    /**
+     * This method will set the width of the layout to a specific value
+     * @param layoutId The ID of a specific layout
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setLayoutWidth: (layoutId: Id, value: string) => Promise<EditorResponse<null> | null>;
+    /**
+     * This method will reset the height of a specific layout to its original value
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    resetLayoutHeight: (layoutId: Id) => Promise<EditorResponse<null>>;
+    /**
+     * This method will reset the width of a specific layout to its original value
+     * @param layoutId The ID of a specific layout
+     * @returns
+     */
+    resetLayoutWidth: (layoutId: Id) => Promise<EditorResponse<null>>;
+    /**
+     * This method returns a UInt8Array containing a PNG encoded image of the currently selected layout.
+     * @returns UInt8Array snapshot of the current layout
+     */
+    getSelectedLayoutSnapshot: () => Promise<Uint8Array>;
+}

package/lib/src/controllers/LayoutController.js

@@ -0,0 +1,190 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _LayoutController_editorAPI, _LayoutController_blobAPI;
+import { getCalculatedValue } from '../utils/getCalculatedValue';
+import { getEditorResponseData } from '../utils/EditorResponseData';
+/**
+ * The LayoutController is responsible for all communication regarding Layouts.
+ * Methods inside this controller can be called by `window.SDK.layout.{method-name}`
+ */
+export class LayoutController {
+    /**
+     * @ignore
+     */
+    constructor(editorAPI) {
+        /**
+         * @ignore
+         */
+        _LayoutController_editorAPI.set(this, void 0);
+        _LayoutController_blobAPI.set(this, void 0);
+        /**
+         * This method returns the list of layouts
+         * @returns
+         */
+        this.getLayouts = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.getLayouts().then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method returns a layout by its id
+         * @param id The ID of a specific layout
+         * @returns
+         */
+        this.getLayoutById = (id) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.getLayoutById(id).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method returns a layout by its name
+         * @param name The name of a specific layout
+         * @returns
+         */
+        this.getLayoutByName = (name) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.getLayoutByName(name).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method returns the selected layout
+         * @returns
+         */
+        this.getSelectedLayout = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.getSelectedLayout().then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will remove a specific layout
+         * @param layoutId The ID of a specific layout
+         * @returns
+         */
+        this.removeLayout = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.removeLayout(layoutId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will add a new child layout (a new layout is always child of a root / parentlayout)
+         * @param parentId The ID of a specific layout, being the parent
+         * @returns
+         */
+        this.addLayout = (parentId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.addLayout(parentId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will update the name of a specific layout
+         * @param layoutId The ID of a specific layout
+         * @param layoutName The new name that the layout should receive
+         * @returns
+         */
+        this.setLayoutName = (layoutId, layoutName) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.renameLayout(layoutId, layoutName).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will select a specific layout
+         * @param layoutId The ID of a specific layout
+         * @returns
+         */
+        this.selectLayout = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.selectLayout(layoutId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will duplicate a specific layout
+         * @param layoutId The ID of a specific layout
+         * @returns
+         */
+        this.duplicateLayout = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.duplicateLayout(layoutId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will reset a specific layout to its original value
+         * @param layoutId The ID of a specific layout
+         * @returns
+         */
+        this.resetLayout = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.resetLayout(layoutId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will set the height of the layout to a specific value
+         * @param layoutId The ID of a specific layout
+         * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+         * @returns
+         */
+        this.setLayoutHeight = (layoutId, value) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            const calc = getCalculatedValue(value);
+            if (calc === null || calc === Infinity) {
+                return null;
+            }
+            return res
+                .setLayoutHeight(layoutId, parseFloat(calc.toString()))
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will set the width of the layout to a specific value
+         * @param layoutId The ID of a specific layout
+         * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+         * @returns
+         */
+        this.setLayoutWidth = (layoutId, value) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            const calc = getCalculatedValue(value);
+            if (calc === null || calc === Infinity) {
+                return null;
+            }
+            return res
+                .setLayoutWidth(layoutId, parseFloat(calc.toString()))
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will reset the height of a specific layout to its original value
+         * @param layoutId The ID of a specific layout
+         * @returns
+         */
+        this.resetLayoutHeight = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.resetLayoutHeight(layoutId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will reset the width of a specific layout to its original value
+         * @param layoutId The ID of a specific layout
+         * @returns
+         */
+        this.resetLayoutWidth = (layoutId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_editorAPI, "f");
+            return res.resetLayoutWidth(layoutId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method returns a UInt8Array containing a PNG encoded image of the currently selected layout.
+         * @returns UInt8Array snapshot of the current layout
+         */
+        this.getSelectedLayoutSnapshot = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _LayoutController_blobAPI, "f");
+            return res.getPageSnapshot().then((result) => { var _a; return (_a = result) !== null && _a !== void 0 ? _a : result; });
+        });
+        __classPrivateFieldSet(this, _LayoutController_editorAPI, editorAPI, "f");
+        __classPrivateFieldSet(this, _LayoutController_blobAPI, editorAPI, "f");
+    }
+}
+_LayoutController_editorAPI = new WeakMap(), _LayoutController_blobAPI = new WeakMap();
+//# sourceMappingURL=LayoutController.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"LayoutController.js","sourceRoot":"","sources":["../../../src/controllers/LayoutController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACjE,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAIpE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAOzB;;OAEG;IACH,YAAY,SAAoB;QAThC;;WAEG;QACH,8CAAsB;QACtB,4CAAuB;QAUvB;;;WAGG;QACH,eAAU,GAAG,GAAS,EAAE;YACpB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAW,MAAM,CAAC,CAAC,CAAC;QACtF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,kBAAa,GAAG,CAAO,EAAM,EAAE,EAAE;YAC7B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QACzF,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,oBAAe,GAAG,CAAO,IAAY,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC7F,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,sBAAiB,GAAG,GAAS,EAAE;YAC3B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,iBAAiB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,iBAAY,GAAG,CAAO,QAAY,EAAE,EAAE;YAClC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,cAAS,GAAG,CAAO,QAAY,EAAE,EAAE;YAC/B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,kBAAa,GAAG,CAAO,QAAY,EAAE,UAAkB,EAAE,EAAE;YACvD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACxG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,iBAAY,GAAG,CAAO,QAAY,EAAE,EAAE;YAClC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC5F,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,oBAAe,GAAG,CAAO,QAAY,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAS,MAAM,CAAC,CAAC,CAAC;QACjG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,gBAAW,GAAG,CAAO,QAAY,EAAE,EAAE;YACjC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC3F,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,oBAAe,GAAG,CAAO,QAAY,EAAE,KAAa,EAAE,EAAE;YACpD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACvC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,QAAQ,EAAE;gBACpC,OAAO,IAAI,CAAC;aACf;YACD,OAAO,GAAG;iBACL,eAAe,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;iBACtD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,mBAAc,GAAG,CAAO,QAAY,EAAE,KAAa,EAAE,EAAE;YACnD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,MAAM,IAAI,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YACvC,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,QAAQ,EAAE;gBACpC,OAAO,IAAI,CAAC;aACf;YAED,OAAO,GAAG;iBACL,cAAc,CAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;iBACrD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,sBAAiB,GAAG,CAAO,QAAY,EAAE,EAAE;YACvC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACjG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,qBAAgB,GAAG,CAAO,QAAY,EAAE,EAAE;YACtC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAChG,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,8BAAyB,GAAG,GAAS,EAAE;YACnC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,iCAAS,CAAC;YAChC,OAAO,GAAG,CAAC,eAAe,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,WAAC,OAAA,MAAC,MAAqB,mCAAK,MAA+B,CAAA,EAAA,CAAC,CAAC;QAC9G,CAAC,CAAA,CAAC;QArKE,uBAAA,IAAI,+BAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,6BAAY,SAAuC,MAAA,CAAC;IAC5D,CAAC;CAoKJ"}

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

@@ -0,0 +1,95 @@
+import { ConnectorOptions, EditorAPI, EditorResponse, MetaData } from '../types/CommonTypes';
+import { DeprecatedMediaType, ConnectorCapabilities, MediaType, QueryOptions, QueryPage } from '../types/ConnectorTypes';
+import { Media, MediaDownloadType } from '../types/MediaConnectorTypes';
+/**
+ * The MediaConnectorController is responsible for all communication regarding media connectors.
+ * Methods inside this controller can be called by `window.SDK.mediaConnector.{method-name}`
+ *
+ * The way CHILI Studio handles different sources of media is called 'MediaConnectors'. A MediaConnectors is an
+ * implementation of a set of capabilities we need to interact with a certain Digital Asset Management system.
+ * In essence a connector is the combination of a Javascript snippet and some metadata. The Javascript snippet
+ * is loaded in the studio engine using a sandboxed Javascript execution engine (QuickJs). This allows us to
+ * execute the media connector both on web using webassembly and on the server side during e.g. animation output
+ * generation.
+ * This controller is an interface to the running connector instance inside the studio engine.
+ */
+export declare class MediaConnectorController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * Query a specific MediaConnector for data using both standardized queryOptions and the dynamic
+     * context as parameters. This call returns an array of Media items.
+     * @param connectorId unique Id of the media connector
+     * @param queryOptions stringified instance of `QueryOptions`
+     * @param context stringified `Map<string, string>` of dynamic options
+     */
+    query: (connectorId: string, queryOptions: QueryOptions, context: MetaData) => Promise<EditorResponse<QueryPage<Media>>>;
+    /**
+     * Returns a single media using a specific MediaConnector.
+     *
+     * The connector needs to list `detail` as a supported capability.
+     * @param connectorId unique Id of the Media connector
+     * @param mediaId unique id of the Media
+     */
+    detail: (connectorId: string, mediaId: string) => Promise<EditorResponse<Media>>;
+    /**
+     * The combination of a `connectorId` and `mediaId` is typically enough for a media connector to
+     * perform the download of this asset. The `download` endpoint is capable of relaying this information to the
+     * media connector instance running in the editor engine.
+     * @param connectorId unique Id of the media connector
+     * @param mediaId unique Id of the media to download
+     * @param downloadType hint to the media connector about desired quality of the downloaded media
+     * @param context dynamic map of additional options potentially used by the connector
+     */
+    download: (connectorId: string, mediaId: string, downloadType: MediaDownloadType, context: MetaData) => Promise<Uint8Array>;
+    /**
+     * Depending on the connector capabilities, this api method allows you to upload new media to the
+     * connector's backend.
+     * @param connectorId unique Id of the media connector
+     * @param mediaId unique Id of the media to upload
+     * @param blob byte array representation of the media to upload
+     */
+    upload: (connectorId: string, mediaId: string, blob: Uint8Array) => Promise<EditorResponse<null>>;
+    /**
+     * Depending on the connector capabilities, removes media identified by `mediaId` from the connector's backend storage
+     * @param connectorId unique Id of the media connector
+     * @param mediaId unique Id of the media to download
+     */
+    remove: (connectorId: string, mediaId: string) => Promise<EditorResponse<null>>;
+    /**
+     * Depending on the connector capabilities, copies media identified by `mediaId` to a new media item on the
+     * connector's backend
+     * @param connectorId unique Id of the media connector
+     * @param mediaId unique Id of the media to download
+     * @param newName name of the copied media on the connector's backend
+     */
+    copy: (connectorId: string, mediaId: string, newName: string) => Promise<EditorResponse<null>>;
+    /**
+     * All connectors have a certain set of queryOptions they allow to be passed in the query context. This
+     * method allows you to discover what options are available for a given connector. If you want to use any of these
+     * options, they need to be passed in the `context` parameter of the `query` api method.
+     * @param connectorId unique Id of the media connector
+     */
+    getQueryOptions: (connectorId: string) => Promise<EditorResponse<ConnectorOptions>>;
+    /**
+     * All connectors have a certain set of downloadOptions they allow to be passed in the download context. This
+     * method allows you to discover what options are available for a given connector. If you want to use any of these
+     * options, they need to be passed in the `context` parameter of the `download` api method.
+     * @param connectorId unique Id of the media connector
+     */
+    getDownloadOptions: (connectorId: string) => Promise<EditorResponse<ConnectorOptions>>;
+    /**
+     * This method returns what capabilities the selected connector has. It gives an indication what methods can
+     * be used successfully for a certain connector.
+     * @param connectorId unique Id of the media connector
+     */
+    getCapabilities: (connectorId: string) => Promise<EditorResponse<ConnectorCapabilities>>;
+    /**
+     * This method will parse the deprecatedMediaType to the new media type. This method will be removed once the deprecatedMediaType is out of use
+     * @param deprecatedType is 0 or 1
+     */
+    parseDeprecatedMediaType: (deprecatedType: DeprecatedMediaType) => MediaType | undefined;
+}

package/lib/src/controllers/MediaConnectorController.js

@@ -0,0 +1,170 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _MediaConnectorController_editorAPI, _MediaConnectorController_blobAPI;
+import { getEditorResponseData } from '../utils/EditorResponseData';
+import { DeprecatedMediaType, MediaType, } from '../types/ConnectorTypes';
+/**
+ * The MediaConnectorController is responsible for all communication regarding media connectors.
+ * Methods inside this controller can be called by `window.SDK.mediaConnector.{method-name}`
+ *
+ * The way CHILI Studio handles different sources of media is called 'MediaConnectors'. A MediaConnectors is an
+ * implementation of a set of capabilities we need to interact with a certain Digital Asset Management system.
+ * In essence a connector is the combination of a Javascript snippet and some metadata. The Javascript snippet
+ * is loaded in the studio engine using a sandboxed Javascript execution engine (QuickJs). This allows us to
+ * execute the media connector both on web using webassembly and on the server side during e.g. animation output
+ * generation.
+ * This controller is an interface to the running connector instance inside the studio engine.
+ */
+export class MediaConnectorController {
+    /**
+     * @ignore
+     */
+    constructor(editorAPI) {
+        /**
+         * @ignore
+         */
+        _MediaConnectorController_editorAPI.set(this, void 0);
+        _MediaConnectorController_blobAPI.set(this, void 0);
+        /**
+         * Query a specific MediaConnector for data using both standardized queryOptions and the dynamic
+         * context as parameters. This call returns an array of Media items.
+         * @param connectorId unique Id of the media connector
+         * @param queryOptions stringified instance of `QueryOptions`
+         * @param context stringified `Map<string, string>` of dynamic options
+         */
+        this.query = (connectorId, queryOptions, context) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res
+                .mediaConnectorQuery(connectorId, JSON.stringify(queryOptions), JSON.stringify(context))
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * Returns a single media using a specific MediaConnector.
+         *
+         * The connector needs to list `detail` as a supported capability.
+         * @param connectorId unique Id of the Media connector
+         * @param mediaId unique id of the Media
+         */
+        this.detail = (connectorId, mediaId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res.mediaConnectorDetail(connectorId, mediaId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * The combination of a `connectorId` and `mediaId` is typically enough for a media connector to
+         * perform the download of this asset. The `download` endpoint is capable of relaying this information to the
+         * media connector instance running in the editor engine.
+         * @param connectorId unique Id of the media connector
+         * @param mediaId unique Id of the media to download
+         * @param downloadType hint to the media connector about desired quality of the downloaded media
+         * @param context dynamic map of additional options potentially used by the connector
+         */
+        this.download = (connectorId, mediaId, downloadType, context) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_blobAPI, "f");
+            return res
+                .mediaConnectorDownload(connectorId, mediaId, downloadType, JSON.stringify(context))
+                .then((result) => { var _a; return (_a = result) !== null && _a !== void 0 ? _a : result; });
+        });
+        /**
+         * Depending on the connector capabilities, this api method allows you to upload new media to the
+         * connector's backend.
+         * @param connectorId unique Id of the media connector
+         * @param mediaId unique Id of the media to upload
+         * @param blob byte array representation of the media to upload
+         */
+        this.upload = (connectorId, mediaId, blob) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res
+                .mediaConnectorUpload(connectorId, mediaId, blob)
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * Depending on the connector capabilities, removes media identified by `mediaId` from the connector's backend storage
+         * @param connectorId unique Id of the media connector
+         * @param mediaId unique Id of the media to download
+         */
+        this.remove = (connectorId, mediaId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res.mediaConnectorRemove(connectorId, mediaId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * Depending on the connector capabilities, copies media identified by `mediaId` to a new media item on the
+         * connector's backend
+         * @param connectorId unique Id of the media connector
+         * @param mediaId unique Id of the media to download
+         * @param newName name of the copied media on the connector's backend
+         */
+        this.copy = (connectorId, mediaId, newName) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res
+                .mediaConnectorCopy(connectorId, mediaId, newName)
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * All connectors have a certain set of queryOptions they allow to be passed in the query context. This
+         * method allows you to discover what options are available for a given connector. If you want to use any of these
+         * options, they need to be passed in the `context` parameter of the `query` api method.
+         * @param connectorId unique Id of the media connector
+         */
+        this.getQueryOptions = (connectorId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res
+                .mediaConnectorGetQueryOptions(connectorId)
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * All connectors have a certain set of downloadOptions they allow to be passed in the download context. This
+         * method allows you to discover what options are available for a given connector. If you want to use any of these
+         * options, they need to be passed in the `context` parameter of the `download` api method.
+         * @param connectorId unique Id of the media connector
+         */
+        this.getDownloadOptions = (connectorId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res
+                .mediaConnectorGetDownloadOptions(connectorId)
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method returns what capabilities the selected connector has. It gives an indication what methods can
+         * be used successfully for a certain connector.
+         * @param connectorId unique Id of the media connector
+         */
+        this.getCapabilities = (connectorId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _MediaConnectorController_editorAPI, "f");
+            return res
+                .mediaConnectorGetCapabilities(connectorId)
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will parse the deprecatedMediaType to the new media type. This method will be removed once the deprecatedMediaType is out of use
+         * @param deprecatedType is 0 or 1
+         */
+        this.parseDeprecatedMediaType = (deprecatedType) => {
+            if (deprecatedType === DeprecatedMediaType.file)
+                return MediaType.file;
+            if (deprecatedType === DeprecatedMediaType.collection)
+                return MediaType.collection;
+        };
+        __classPrivateFieldSet(this, _MediaConnectorController_editorAPI, editorAPI, "f");
+        __classPrivateFieldSet(this, _MediaConnectorController_blobAPI, editorAPI, "f");
+    }
+}
+_MediaConnectorController_editorAPI = new WeakMap(), _MediaConnectorController_blobAPI = new WeakMap();
+//# sourceMappingURL=MediaConnectorController.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MediaConnectorController.js","sourceRoot":"","sources":["../../../src/controllers/MediaConnectorController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EACH,mBAAmB,EAEnB,SAAS,GAGZ,MAAM,yBAAyB,CAAC;AAIjC;;;;;;;;;;;GAWG;AACH,MAAM,OAAO,wBAAwB;IAOjC;;OAEG;IACH,YAAY,SAAoB;QAThC;;WAEG;QACH,sDAAsB;QACtB,oDAAuB;QAUvB;;;;;;WAMG;QACH,UAAK,GAAG,CAAO,WAAmB,EAAE,YAA0B,EAAE,OAAiB,EAAE,EAAE;YACjF,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;iBACvF,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,WAAM,GAAG,CAAO,WAAmB,EAAE,OAAe,EAAE,EAAE;YACpD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAQ,MAAM,CAAC,CAAC,CAAC;QACjH,CAAC,CAAA,CAAC;QAEF;;;;;;;;WAQG;QACH,aAAQ,GAAG,CACP,WAAmB,EACnB,OAAe,EACf,YAA+B,EAC/B,OAAiB,EACE,EAAE;YACrB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,yCAAS,CAAC;YAChC,OAAO,GAAG;iBACL,sBAAsB,CAAC,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;iBACnF,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,WAAC,OAAA,MAAC,MAAqB,mCAAK,MAA+B,CAAA,EAAA,CAAC,CAAC;QACtF,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,WAAM,GAAG,CAAO,WAAmB,EAAE,OAAe,EAAE,IAAgB,EAAE,EAAE;YACtE,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,oBAAoB,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC;iBAChD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,WAAM,GAAG,CAAO,WAAmB,EAAE,OAAe,EAAE,EAAE;YACpD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG,CAAC,oBAAoB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAChH,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,SAAI,GAAG,CAAO,WAAmB,EAAE,OAAe,EAAE,OAAe,EAAE,EAAE;YACnE,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,kBAAkB,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC;iBACjD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,oBAAe,GAAG,CAAO,WAAmB,EAAE,EAAE;YAC5C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,6BAA6B,CAAC,WAAW,CAAC;iBAC1C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,uBAAkB,GAAG,CAAO,WAAmB,EAAE,EAAE;YAC/C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,gCAAgC,CAAC,WAAW,CAAC;iBAC7C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAmB,MAAM,CAAC,CAAC,CAAC;QAC3E,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,oBAAe,GAAG,CAAO,WAAmB,EAAE,EAAE;YAC5C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,2CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,6BAA6B,CAAC,WAAW,CAAC;iBAC1C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAwB,MAAM,CAAC,CAAC,CAAC;QAChF,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,6BAAwB,GAAG,CAAC,cAAmC,EAAE,EAAE;YAC/D,IAAI,cAAc,KAAK,mBAAmB,CAAC,IAAI;gBAAE,OAAO,SAAS,CAAC,IAAI,CAAC;YACvE,IAAI,cAAc,KAAK,mBAAmB,CAAC,UAAU;gBAAE,OAAO,SAAS,CAAC,UAAU,CAAC;QACvF,CAAC,CAAC;QAtIE,uBAAA,IAAI,uCAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,qCAAY,SAAuC,MAAA,CAAC;IAC5D,CAAC;CAqIJ"}

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

@@ -0,0 +1,40 @@
+import { EditorAPI, Id } from '../types/CommonTypes';
+import { Page } from '../types/PageTypes';
+/**
+ * The PageController is responsible for all communication regarding Pages.
+ * Methods inside this controller can be called by `window.SDK.page.{method-name}`
+ */
+export declare class PageController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * This method returns the list of pages
+     * @returns
+     */
+    getPages: () => Promise<import("../types/CommonTypes").EditorResponse<Page[]>>;
+    /**
+     * This method returns a page by its id
+     * @param pageId The ID of a specific page
+     * @returns
+     */
+    getPageById: (pageId: Id) => Promise<import("../types/CommonTypes").EditorResponse<Page>>;
+    /**
+     * This method will set the width of the page to a specific value.
+     * This only works if the document is a project.
+     * @param pageId The ID of a specific page
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setPageWidth: (pageId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    /**
+     * This method will set the height of the page to a specific value.
+     * This only works if the document is a project.
+     * @param pageId The ID of a specific page
+     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @returns
+     */
+    setPageHeight: (pageId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+}