@chili-publish/studio-sdk 0.121.0

package/lib/src/controllers/ConnectorController.js

@@ -0,0 +1,196 @@
+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 _ConnectorController_editorAPI, _ConnectorConfigurator_connectorId, _ConnectorConfigurator_res;
+import { ConnectorStateType, } from '../types/ConnectorTypes';
+import { getEditorResponseData } from '../utils/EditorResponseData';
+/**
+ * The ConnectorController manages lifetime of all available connectors, regardless of the type, in the
+ * document. Use it to add/remove connectors to a template, or set specific configuration.
+ *
+ * The way CHILI Studio handles different sources of resouces is called 'Connectors'. A Connectors is an
+ * implementation of a set of capabilities we need to interact with a certain external resource 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. The engine will
+ * automatically register the 'grafx-media' and 'grafx-font' connectors. Custom connectors need to be registered
+ * manually.
+ */
+export class ConnectorController {
+    /**
+     * @ignore
+     */
+    constructor(editorAPI) {
+        /**
+         * @ignore
+         */
+        _ConnectorController_editorAPI.set(this, void 0);
+        /**
+         * Registers a new connector in the SDK. After successful registration, depending
+         * on the connector type, the connector can be configured and used in the template
+         * Remember to add custom authentication information after registering the connector
+         * @param registration registration object containing all details about the connector
+         */
+        this.registerConnector = (registration) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _ConnectorController_editorAPI, "f");
+            return res
+                .registerConnector(JSON.stringify(registration))
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * Configures a registered connector. A configurator helper is passed as an argument
+         * of the callback for you to setup your connector.
+         * @param connectorId Id of your registered connector
+         * @param configurationCallback callback to setup the connector
+         */
+        this.configure = (connectorId, configurationCallback) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _ConnectorController_editorAPI, "f");
+            // wait for connector to be ready
+            yield this.waitForConnectorReady(connectorId);
+            // execute callback
+            yield configurationCallback(new ConnectorConfigurator(connectorId, res));
+            // invalidate connector in engine
+            return res.updateConnectorConfiguration(connectorId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * Gets the current state a connector is in, to wait until a connector is ready to be used, use the 'waitForConnectorReady'
+         * method in this controller.
+         * @param connectorId Id of your registered connector you want to make sure it is loaded
+         */
+        this.getState = (connectorId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _ConnectorController_editorAPI, "f");
+            return res.getConnectorState(connectorId).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * Connectors are loaded asynchronously in the editor engine, this causes some challenges while configuring them. To make sure
+         * an action on the connector will be available, it's advised to await this method. After the Promise resolves we are sure
+         * the connector is up and running. This is used internally by the configure method to ensure correct execution. It's especially
+         * usefull during startup of the SDK / rigth after the loadDocument call.
+         * @param connectorId Id of your registered connector you want to make sure it is loaded
+         */
+        this.waitForConnectorReady = (connectorId, timeoutMilliseconds = 2000) => __awaiter(this, void 0, void 0, function* () {
+            // minimum timeout is 500ms
+            let timeout = Math.max(timeoutMilliseconds, 500);
+            // maximum timeout is 5000ms
+            timeout = Math.min(timeout, 5000);
+            const waitTime = 100;
+            let retries = 0;
+            try {
+                // using while loop will prevent stackoverflow issues when using recursion
+                // wait for maximum 2 seconds to fail
+                while (retries * waitTime < timeout) {
+                    const result = yield this.getState(connectorId);
+                    if (result.success &&
+                        result.parsedData &&
+                        (result.parsedData.type === ConnectorStateType.running ||
+                            result.parsedData.type === ConnectorStateType.ready)) {
+                        return getEditorResponseData({ data: null, success: true, error: undefined, status: 0, parsedData: undefined }, false);
+                    }
+                    yield new Promise((resolve) => setTimeout(resolve, waitTime));
+                    retries++;
+                }
+            }
+            catch (err) {
+                return getEditorResponseData({
+                    data: null,
+                    success: false,
+                    error: `Error while getting connector state ${err}`,
+                    status: 50000,
+                    parsedData: undefined,
+                }, false);
+            }
+            return getEditorResponseData({
+                data: null,
+                success: false,
+                error: `Timed out waiting for connector`,
+                status: 50000,
+                parsedData: undefined,
+            }, false);
+        });
+        __classPrivateFieldSet(this, _ConnectorController_editorAPI, editorAPI, "f");
+    }
+}
+_ConnectorController_editorAPI = new WeakMap();
+/**
+ * Helper to setup your connector
+ */
+class ConnectorConfigurator {
+    /**
+     * @ignore
+     */
+    constructor(connectorId, res) {
+        /**
+         * @ignore
+         */
+        _ConnectorConfigurator_connectorId.set(this, void 0);
+        _ConnectorConfigurator_res.set(this, void 0);
+        /**
+         * Allows to customize the context data a connector can work with. The options data
+         * will be available using the context parameter in the connector implementation code.
+         * @param options object containing key value data to pass to connector context
+         */
+        this.setOptions = (options) => __awaiter(this, void 0, void 0, function* () {
+            return __classPrivateFieldGet(this, _ConnectorConfigurator_res, "f")
+                .setConnectorOptions(__classPrivateFieldGet(this, _ConnectorConfigurator_connectorId, "f"), JSON.stringify(options))
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * Allows to map document data (variables, selectedFrame, etc) to connector context data.
+         * By defining the mappings, we can trigger redownload of assets (dynamic asset provider)
+         * or populate filters for the query endpoint. The mapped data will be available using
+         * the context parameter in the connector implementation code.
+         * @param mappings collection of mappings to set to this connector
+         */
+        this.setMappings = (mappings) => __awaiter(this, void 0, void 0, function* () {
+            const result = yield __classPrivateFieldGet(this, _ConnectorConfigurator_res, "f").setConnectorMappings(__classPrivateFieldGet(this, _ConnectorConfigurator_connectorId, "f"), mappings.map(function (m) {
+                return JSON.stringify(m);
+            }));
+            return getEditorResponseData(result);
+        });
+        /**
+         * This method sets the CHILI GraFx Access Token in the Authentication HTTP header for the 'chili' authentication type.
+         * The CHILI Token will be used to authenticate every grafx connector http call.
+         * @param token token for the CHILI authentication
+         */
+        this.setChiliToken = (token) => __awaiter(this, void 0, void 0, function* () {
+            return __classPrivateFieldGet(this, _ConnectorConfigurator_res, "f")
+                .connectorAuthenticationSetChiliToken(__classPrivateFieldGet(this, _ConnectorConfigurator_connectorId, "f"), token)
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method sets the HTTP headers for the 'staticKey' authentication type.
+         * These additional headers will be added to all connector http calls.
+         * Can only be used after a connector has been registered. (if you are using a grafx connector no registration is needed)
+         * @param headerName name of the header
+         * @param headerValue value of the header
+         */
+        this.setHttpHeader = (headerName, headerValue) => __awaiter(this, void 0, void 0, function* () {
+            return __classPrivateFieldGet(this, _ConnectorConfigurator_res, "f")
+                .connectorAuthenticationSetHttpHeader(__classPrivateFieldGet(this, _ConnectorConfigurator_connectorId, "f"), headerName, headerValue)
+                .then((result) => getEditorResponseData(result));
+        });
+        __classPrivateFieldSet(this, _ConnectorConfigurator_connectorId, connectorId, "f");
+        __classPrivateFieldSet(this, _ConnectorConfigurator_res, res, "f");
+    }
+}
+_ConnectorConfigurator_connectorId = new WeakMap(), _ConnectorConfigurator_res = new WeakMap();
+//# sourceMappingURL=ConnectorController.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectorController.js","sourceRoot":"","sources":["../../../src/controllers/ConnectorController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAEH,kBAAkB,GAGrB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAEpE;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,mBAAmB;IAM5B;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,iDAAsB;QAStB;;;;;WAKG;QACH,sBAAiB,GAAG,CAAO,YAAmC,EAAE,EAAE;YAC9D,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG;iBACL,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;iBAC/C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;;WAKG;QACH,cAAS,GAAG,CACR,WAAmB,EACnB,qBAA6E,EAC/E,EAAE;YACA,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,iCAAiC;YACjC,MAAM,IAAI,CAAC,qBAAqB,CAAC,WAAW,CAAC,CAAC;YAC9C,mBAAmB;YACnB,MAAM,qBAAqB,CAAC,IAAI,qBAAqB,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;YACzE,iCAAiC;YACjC,OAAO,GAAG,CAAC,4BAA4B,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/G,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,aAAQ,GAAG,CAAO,WAAmB,EAAE,EAAE;YACrC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,sCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiB,MAAM,CAAC,CAAC,CAAC;QAC9G,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,0BAAqB,GAAG,CAAO,WAAmB,EAAE,mBAAmB,GAAG,IAAI,EAAiC,EAAE;YAC7G,2BAA2B;YAC3B,IAAI,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,GAAG,CAAC,CAAC;YAEjD,4BAA4B;YAC5B,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAElC,MAAM,QAAQ,GAAG,GAAG,CAAC;YACrB,IAAI,OAAO,GAAG,CAAC,CAAC;YAEhB,IAAI;gBACA,0EAA0E;gBAC1E,qCAAqC;gBACrC,OAAO,OAAO,GAAG,QAAQ,GAAG,OAAO,EAAE;oBACjC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;oBAEhD,IACI,MAAM,CAAC,OAAO;wBACd,MAAM,CAAC,UAAU;wBACjB,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,KAAK,kBAAkB,CAAC,OAAO;4BAClD,MAAM,CAAC,UAAU,CAAC,IAAI,KAAK,kBAAkB,CAAC,KAAK,CAAC,EAC1D;wBACE,OAAO,qBAAqB,CACxB,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,SAAS,EAAE,EACjF,KAAK,CACR,CAAC;qBACL;oBAED,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;oBAC9D,OAAO,EAAE,CAAC;iBACb;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,qBAAqB,CACxB;oBACI,IAAI,EAAE,IAAI;oBACV,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,uCAAuC,GAAG,EAAE;oBACnD,MAAM,EAAE,KAAK;oBACb,UAAU,EAAE,SAAS;iBACxB,EACD,KAAK,CACR,CAAC;aACL;YAED,OAAO,qBAAqB,CACxB;gBACI,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,iCAAiC;gBACxC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE,SAAS;aACxB,EACD,KAAK,CACR,CAAC;QACN,CAAC,CAAA,CAAC;QA1GE,uBAAA,IAAI,kCAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CA0GJ;;AAED;;GAEG;AACH,MAAM,qBAAqB;IAOvB;;OAEG;IACH,YAAY,WAAmB,EAAE,GAAc;QAT/C;;WAEG;QACH,qDAAqB;QACrB,6CAAgB;QAUhB;;;;WAIG;QACH,eAAU,GAAG,CAAO,OAAyB,EAAE,EAAE;YAC7C,OAAO,uBAAA,IAAI,kCAAK;iBACX,mBAAmB,CAAC,uBAAA,IAAI,0CAAa,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;iBAC/D,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,gBAAW,GAAG,CAAO,QAA4B,EAAE,EAAE;YACjD,MAAM,MAAM,GAAG,MAAM,uBAAA,IAAI,kCAAK,CAAC,oBAAoB,CAC/C,uBAAA,IAAI,0CAAa,EACjB,QAAQ,CAAC,GAAG,CAAC,UAAU,CAAC;gBACpB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC7B,CAAC,CAAC,CACL,CAAC;YACF,OAAO,qBAAqB,CAAO,MAAM,CAAC,CAAC;QAC/C,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,kBAAa,GAAG,CAAO,KAAa,EAAE,EAAE;YACpC,OAAO,uBAAA,IAAI,kCAAK;iBACX,oCAAoC,CAAC,uBAAA,IAAI,0CAAa,EAAE,KAAK,CAAC;iBAC9D,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,kBAAa,GAAG,CAAO,UAAkB,EAAE,WAAmB,EAAE,EAAE;YAC9D,OAAO,uBAAA,IAAI,kCAAK;iBACX,oCAAoC,CAAC,uBAAA,IAAI,0CAAa,EAAE,UAAU,EAAE,WAAW,CAAC;iBAChF,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QAC/D,CAAC,CAAA,CAAC;QAtDE,uBAAA,IAAI,sCAAgB,WAAW,MAAA,CAAC;QAChC,uBAAA,IAAI,8BAAQ,GAAG,MAAA,CAAC;IACpB,CAAC;CAqDJ"}

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

@@ -0,0 +1,33 @@
+import { EditorAPI } from '../types/CommonTypes';
+import { DebugData } from '../types/DebugTypes';
+/**
+ * The DebugController is responsible for all communication regarding Debugging.
+ * Methods inside this controller can be called by `window.SDK.debug.{method-name}`
+ */
+export declare class DebugController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * This method returns all debug logs
+     * @returns
+     */
+    getLogs: () => Promise<import("../types/CommonTypes").EditorResponse<DebugData[]>>;
+    /**
+     * This method toggles the showcase of debug panel
+     * @returns
+     */
+    toggleDebugPanel: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method enables the debugging
+     * @returns
+     */
+    enableDebug: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method disables the debugging
+     * @returns
+     */
+    disableDebug: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+}

package/lib/src/controllers/DebugController.js

@@ -0,0 +1,72 @@
+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 _DebugController_editorAPI;
+import { getEditorResponseData } from '../utils/EditorResponseData';
+/**
+ * The DebugController is responsible for all communication regarding Debugging.
+ * Methods inside this controller can be called by `window.SDK.debug.{method-name}`
+ */
+export class DebugController {
+    /**
+     * @ignore
+     */
+    constructor(editorAPI) {
+        /**
+         * @ignore
+         */
+        _DebugController_editorAPI.set(this, void 0);
+        /**
+         * This method returns all debug logs
+         * @returns
+         */
+        this.getLogs = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _DebugController_editorAPI, "f");
+            return res.getLogs().then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method toggles the showcase of debug panel
+         * @returns
+         */
+        this.toggleDebugPanel = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _DebugController_editorAPI, "f");
+            return res.toggleDebugPanel().then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method enables the debugging
+         * @returns
+         */
+        this.enableDebug = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _DebugController_editorAPI, "f");
+            return res.enableDebug().then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method disables the debugging
+         * @returns
+         */
+        this.disableDebug = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _DebugController_editorAPI, "f");
+            return res.disableDebug().then((result) => getEditorResponseData(result));
+        });
+        __classPrivateFieldSet(this, _DebugController_editorAPI, editorAPI, "f");
+    }
+}
+_DebugController_editorAPI = new WeakMap();
+//# sourceMappingURL=DebugController.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DebugController.js","sourceRoot":"","sources":["../../../src/controllers/DebugController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AACA,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AAGpE;;;GAGG;AACH,MAAM,OAAO,eAAe;IAMxB;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,6CAAsB;QAStB;;;WAGG;QACH,YAAO,GAAG,GAAS,EAAE;YACjB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAc,MAAM,CAAC,CAAC,CAAC;QACtF,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,qBAAgB,GAAG,GAAS,EAAE;YAC1B,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,gBAAgB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACxF,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,gBAAW,GAAG,GAAS,EAAE;YACrB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACnF,CAAC,CAAA,CAAC;QAEF;;;WAGG;QACH,iBAAY,GAAG,GAAS,EAAE;YACtB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,kCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACpF,CAAC,CAAA,CAAC;QArCE,uBAAA,IAAI,8BAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CAqCJ"}

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

@@ -0,0 +1,40 @@
+import { EditorAPI, Id } from '../types/CommonTypes';
+import type { ChiliDocument } from '../types/DocumentTypes';
+import { DownloadFormats } from '../utils/enums';
+/**
+ * The DocumentController is responsible for all communication regarding the Document.
+ * Methods inside this controller can be called by `window.SDK.document.{method-name}`
+ */
+export declare class DocumentController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * This method retrieves the current document state from the editor
+     * @returns The JSON document in the form of a string
+     */
+    getCurrentDocumentState: () => Promise<import("../types/CommonTypes").EditorResponse<ChiliDocument>>;
+    /**
+     * This method will load a provided document in the ChiliDocument format
+     * @param doc The document to load in
+     * @returns The document loaded inside of the canvas
+     */
+    loadDocument: (doc: ChiliDocument | string) => Promise<import("../types/CommonTypes").EditorResponse<unknown>>;
+    /**
+     * This method will call an external api to create a download url
+     * The video will be generated in the dimensions (and resolution) of the layout.
+     * This means that any upscaling (e.g. playing the video full screen on a 4k monitor) will result in interpolation (= quality loss).
+     * @param format The format of a downloadable url
+     * @param layoutId id of layout to be downloaded
+     * @returns the download link
+     */
+    getDownloadLink: (format: DownloadFormats, layoutId: Id) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    /**
+     * This method will call an external api endpoint, untill the api endpoint returns a status code 200
+     * @param endpoint api endpoint to start polling on
+     * @returns true when the endpoint call has successfully been resolved
+     */
+    startPollingOnEndpoint: (endpoint: string) => Promise<true | unknown>;
+}

package/lib/src/controllers/DocumentController.js

@@ -0,0 +1,163 @@
+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 _DocumentController_editorAPI;
+import { renderURLs } from '../utils/enums';
+import { getFetchURL } from '../utils/getFetchUrl';
+import { getEditorResponseData } from '../utils/EditorResponseData';
+/**
+ * The DocumentController is responsible for all communication regarding the Document.
+ * Methods inside this controller can be called by `window.SDK.document.{method-name}`
+ */
+export class DocumentController {
+    /**
+     * @ignore
+     */
+    constructor(editorAPI) {
+        /**
+         * @ignore
+         */
+        _DocumentController_editorAPI.set(this, void 0);
+        /**
+         * This method retrieves the current document state from the editor
+         * @returns The JSON document in the form of a string
+         */
+        this.getCurrentDocumentState = () => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _DocumentController_editorAPI, "f");
+            return res.getCurrentDocumentState().then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will load a provided document in the ChiliDocument format
+         * @param doc The document to load in
+         * @returns The document loaded inside of the canvas
+         */
+        this.loadDocument = (doc) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _DocumentController_editorAPI, "f");
+            if (typeof doc === 'string')
+                return res.loadDocument(doc);
+            return res.loadDocument(JSON.stringify(doc)).then((result) => getEditorResponseData(result));
+        });
+        /**
+         * This method will call an external api to create a download url
+         * The video will be generated in the dimensions (and resolution) of the layout.
+         * This means that any upscaling (e.g. playing the video full screen on a 4k monitor) will result in interpolation (= quality loss).
+         * @param format The format of a downloadable url
+         * @param layoutId id of layout to be downloaded
+         * @returns the download link
+         */
+        this.getDownloadLink = (format, layoutId) => __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
+            let error = null;
+            let PREPARE_DOWNLOAD_URL = null;
+            let DOWNLOAD_URL = '';
+            const documentResponse = yield this.getCurrentDocumentState();
+            const FETCH_URL = getFetchURL(format, layoutId);
+            try {
+                const response = yield fetch(FETCH_URL, {
+                    method: 'POST',
+                    headers: {
+                        'Content-Type': 'application/json',
+                    },
+                    body: (_a = documentResponse.data) !== null && _a !== void 0 ? _a : null,
+                })
+                    .then((data) => data.json())
+                    .catch((err) => {
+                    if (err.code) {
+                        error = { code: err.code, error: err.message || err };
+                    }
+                    else {
+                        error = { code: 400, error: err.message || err };
+                    }
+                    return error;
+                });
+                if ((response === null || response === void 0 ? void 0 : response.error) || error) {
+                    return getEditorResponseData({
+                        success: false,
+                        data: DOWNLOAD_URL,
+                        error,
+                        status: response.status,
+                        parsedData: null,
+                    }, false);
+                }
+                PREPARE_DOWNLOAD_URL = (response === null || response === void 0 ? void 0 : response.resultUrl) ? renderURLs.BASE_URL + (response === null || response === void 0 ? void 0 : response.resultUrl) : null;
+                DOWNLOAD_URL = (response === null || response === void 0 ? void 0 : response.downloadUrl) ? renderURLs.BASE_URL + (response === null || response === void 0 ? void 0 : response.downloadUrl) : '';
+                let isFileDownloadable = error;
+                try {
+                    isFileDownloadable = yield this.startPollingOnEndpoint(PREPARE_DOWNLOAD_URL);
+                }
+                catch (err) {
+                    error = err;
+                }
+                if (isFileDownloadable !== true)
+                    error = isFileDownloadable;
+                if (error) {
+                    return getEditorResponseData({
+                        success: false,
+                        data: '',
+                        error,
+                        status: (_b = error === null || error === void 0 ? void 0 : error.code) !== null && _b !== void 0 ? _b : 400,
+                        parsedData: null,
+                    }, false);
+                }
+                return getEditorResponseData({
+                    success: true,
+                    status: 200,
+                    data: DOWNLOAD_URL,
+                    parsedData: null,
+                }, false);
+            }
+            catch (err) {
+                error = err;
+                return getEditorResponseData({
+                    success: false,
+                    data: DOWNLOAD_URL,
+                    error,
+                    status: (_c = error === null || error === void 0 ? void 0 : error.code) !== null && _c !== void 0 ? _c : 400,
+                    parsedData: null,
+                }, false);
+            }
+        });
+        /**
+         * This method will call an external api endpoint, untill the api endpoint returns a status code 200
+         * @param endpoint api endpoint to start polling on
+         * @returns true when the endpoint call has successfully been resolved
+         */
+        this.startPollingOnEndpoint = (endpoint) => __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield fetch(endpoint)
+                    .then((data) => data)
+                    .catch((err) => err);
+                if ((response === null || response === void 0 ? void 0 : response.status) === 202) {
+                    yield new Promise((resolve) => setTimeout(resolve, 2000));
+                    return yield this.startPollingOnEndpoint(endpoint);
+                }
+                else {
+                    return true;
+                }
+            }
+            catch (err) {
+                return err;
+            }
+        });
+        __classPrivateFieldSet(this, _DocumentController_editorAPI, editorAPI, "f");
+    }
+}
+_DocumentController_editorAPI = new WeakMap();
+//# sourceMappingURL=DocumentController.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DocumentController.js","sourceRoot":"","sources":["../../../src/controllers/DocumentController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAEA,OAAO,EAAE,UAAU,EAAmB,MAAM,gBAAgB,CAAC;AAE7D,OAAO,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACnD,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE;;;GAGG;AAEH,MAAM,OAAO,kBAAkB;IAM3B;;OAEG;IACH,YAAY,SAAoB;QARhC;;WAEG;QACH,gDAAsB;QAStB;;;WAGG;QACH,4BAAuB,GAAG,GAAS,EAAE;YACjC,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,qCAAW,CAAC;YAClC,OAAO,GAAG,CAAC,uBAAuB,EAAE,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAgB,MAAM,CAAC,CAAC,CAAC;QACxG,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,iBAAY,GAAG,CAAO,GAA2B,EAAE,EAAE;YACjD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,qCAAW,CAAC;YAClC,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,OAAO,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YAC1D,OAAO,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAO,MAAM,CAAC,CAAC,CAAC;QACvG,CAAC,CAAA,CAAC;QAEF;;;;;;;WAOG;QACH,oBAAe,GAAG,CAAO,MAAuB,EAAE,QAAY,EAAE,EAAE;;YAC9D,IAAI,KAAK,GAAyB,IAAI,CAAC;YACvC,IAAI,oBAAoB,GAAkB,IAAI,CAAC;YAC/C,IAAI,YAAY,GAAG,EAAE,CAAC;YAEtB,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC9D,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAChD,IAAI;gBACA,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,SAAS,EAAE;oBACpC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACL,cAAc,EAAE,kBAAkB;qBACrC;oBACD,IAAI,EAAE,MAAC,gBAAgB,CAAC,IAAe,mCAAI,IAAI;iBAClD,CAAC;qBACG,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;qBAC3B,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACX,IAAI,GAAG,CAAC,IAAI,EAAE;wBACV,KAAK,GAAG,EAAE,IAAI,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC;qBACzD;yBAAM;wBACH,KAAK,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,OAAO,IAAI,GAAG,EAAE,CAAC;qBACpD;oBACD,OAAO,KAAK,CAAC;gBACjB,CAAC,CAAC,CAAC;gBACP,IAAI,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,KAAK,KAAI,KAAK,EAAE;oBAC1B,OAAO,qBAAqB,CACxB;wBACI,OAAO,EAAE,KAAK;wBACd,IAAI,EAAE,YAAY;wBAClB,KAAK;wBACL,MAAM,EAAE,QAAQ,CAAC,MAAM;wBACvB,UAAU,EAAE,IAAI;qBACnB,EACD,KAAK,CACR,CAAC;iBACL;gBACD,oBAAoB,GAAG,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,EAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,IAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,SAAS,CAAA,CAAC,CAAC,CAAC,IAAI,CAAC;gBAE9F,YAAY,GAAG,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,WAAW,EAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,IAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,WAAW,CAAA,CAAC,CAAC,CAAC,EAAE,CAAC;gBAExF,IAAI,kBAAkB,GAA0C,KAAK,CAAC;gBAEtE,IAAI;oBACA,kBAAkB,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,oBAA8B,CAAC,CAAC;iBAC1F;gBAAC,OAAO,GAAG,EAAE;oBACV,KAAK,GAAG,GAA+B,CAAC;iBAC3C;gBAED,IAAI,kBAAkB,KAAK,IAAI;oBAAE,KAAK,GAAG,kBAAmC,CAAC;gBAC7E,IAAI,KAAK,EAAE;oBACP,OAAO,qBAAqB,CACxB;wBACI,OAAO,EAAE,KAAK;wBACd,IAAI,EAAE,EAAE;wBACR,KAAK;wBACL,MAAM,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,mCAAI,GAAG;wBAC1B,UAAU,EAAE,IAAI;qBACnB,EACD,KAAK,CACR,CAAC;iBACL;gBACD,OAAO,qBAAqB,CACxB;oBACI,OAAO,EAAE,IAAI;oBACb,MAAM,EAAE,GAAG;oBACX,IAAI,EAAE,YAAY;oBAClB,UAAU,EAAE,IAAI;iBACnB,EACD,KAAK,CACR,CAAC;aACL;YAAC,OAAO,GAAG,EAAE;gBACV,KAAK,GAAG,GAAoB,CAAC;gBAC7B,OAAO,qBAAqB,CACxB;oBACI,OAAO,EAAE,KAAK;oBACd,IAAI,EAAE,YAAY;oBAClB,KAAK;oBACL,MAAM,EAAE,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,mCAAI,GAAG;oBAC1B,UAAU,EAAE,IAAI;iBACnB,EACD,KAAK,CACR,CAAC;aACL;QACL,CAAC,CAAA,CAAC;QAEF;;;;WAIG;QACH,2BAAsB,GAAG,CAAO,QAAgB,EAA2B,EAAE;YACzE,IAAI;gBACA,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC;qBACjC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;qBACpB,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;gBACzB,IAAI,CAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,MAAM,MAAK,GAAG,EAAE;oBAC1B,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;oBAC1D,OAAO,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,CAAC;iBACtD;qBAAM;oBACH,OAAO,IAAI,CAAC;iBACf;aACJ;YAAC,OAAO,GAAG,EAAE;gBACV,OAAO,GAAG,CAAC;aACd;QACL,CAAC,CAAA,CAAC;QAvIE,uBAAA,IAAI,iCAAc,SAAS,MAAA,CAAC;IAChC,CAAC;CAuIJ"}

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

@@ -0,0 +1,39 @@
+import { EditorAPI, Id } from '../types/CommonTypes';
+/**
+ * The ExperimentController contains all SDK functions that are considered for addition,
+ * or functions we want to keep open for changing definitions. This is a sneak peak
+ * into future versions of the SDK. Never build production code relying on functions in
+ * this controller.
+ */
+export declare class ExperimentController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * This method will assign an image from a variable to the correct ImageFrame
+     * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
+     * @param variableId The ID of the variable which contains the image
+     * @returns
+     */
+    insertImageVariableToFrame: (imageFrameId: Id, variableId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will insert a text variable in the selected frame. Calling this method
+     * requires that the selected frame is in text editing mode.
+     * @param variableId The ID of the variable to be inserted.
+     * @returns
+     */
+    insertTextVariable: (variableId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will enter text editing mode on the provided frame.
+     * @param frameId The ID frame to enter text edit mode on.
+     * @returns
+     */
+    enterTextEditMode: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    /**
+     * This method will exit text editing mode.
+     * @returns
+     */
+    exitTextEditMode: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+}