@chili-publish/studio-sdk 1.43.0 → 1.44.0

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

@@ -0,0 +1,190 @@
+"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, _localConfig, _connectorCompatibilityTools, _connectorId, _res;
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const ConnectorTypes = require("../types/ConnectorTypes.cjs.js");
+const EditorResponseData = require("../utils/EditorResponseData.cjs.js");
+const ConfigurationTypes = require("../types/ConfigurationTypes.cjs.js");
+const ConnectorCompatibilityTools = require("../utils/ConnectorCompatibilityTools.cjs.js");
+class ConnectorController {
+  /**
+   * @ignore
+   */
+  constructor(editorAPI, localConfig) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _editorAPI);
+    __privateAdd(this, _localConfig);
+    __privateAdd(this, _connectorCompatibilityTools);
+    this.getById = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectorById(id).then((result) => EditorResponseData.getEditorResponseData(result)).then((resp) => {
+        const update = { ...resp, parsedData: null };
+        if (resp.parsedData) {
+          update.parsedData = __privateGet(this, _connectorCompatibilityTools).makeSingleConnectorBackwardsCompatible(
+            resp.parsedData,
+            __privateGet(this, _localConfig).get(ConfigurationTypes.WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl)
+          );
+        }
+        return update;
+      });
+    };
+    this.getAllByType = async (type) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectors(type).then((result) => EditorResponseData.getEditorResponseData(result)).then((resp) => {
+        const update = { ...resp, parsedData: null };
+        if (resp.parsedData) {
+          update.parsedData = __privateGet(this, _connectorCompatibilityTools).makeMultipleConnectorsBackwardsCompatible(
+            resp.parsedData,
+            __privateGet(this, _localConfig).get(ConfigurationTypes.WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl)
+          );
+        }
+        return update;
+      });
+    };
+    this.register = async (registration) => {
+      const res = await __privateGet(this, _editorAPI);
+      const connectorRegistration = __privateGet(this, _connectorCompatibilityTools).makeConnectorSourceForwardsCompatible(registration);
+      return res.registerConnector(JSON.stringify(connectorRegistration)).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.unregister = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.unregisterConnector(id).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.configure = async (id, configurationCallback) => {
+      const res = await __privateGet(this, _editorAPI);
+      await this.waitToBeReady(id);
+      await configurationCallback(new ConnectorConfigurator(id, res));
+      return res.updateConnectorConfiguration(id).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.getState = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectorState(id).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.getOptions = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectorOptions(id).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.waitToBeReady = async (id, timeoutMilliseconds = 2e3) => {
+      let timeout = Math.max(timeoutMilliseconds, 500);
+      timeout = Math.min(timeout, 5e3);
+      const waitTime = 100;
+      let retries = 0;
+      try {
+        while (retries * waitTime < timeout) {
+          const result = await this.getState(id);
+          if (result.success && result.parsedData && (result.parsedData.type === ConnectorTypes.ConnectorStateType.running || result.parsedData.type === ConnectorTypes.ConnectorStateType.ready)) {
+            return EditorResponseData.getEditorResponseData(
+              { data: null, success: true, error: void 0, status: 0, parsedData: void 0 },
+              false
+            );
+          }
+          await new Promise((resolve) => setTimeout(resolve, waitTime));
+          retries++;
+        }
+      } catch (err) {
+        return EditorResponseData.getEditorResponseData(
+          {
+            data: null,
+            success: false,
+            error: `Error while getting connector state ${err}`,
+            status: 5e4,
+            parsedData: void 0
+          },
+          false
+        );
+      }
+      return EditorResponseData.getEditorResponseData(
+        {
+          data: null,
+          success: false,
+          error: `Timed out waiting for connector`,
+          status: 5e4,
+          parsedData: void 0
+        },
+        false
+      );
+    };
+    this.updateMappings = async (id, mappings) => {
+      return await this.configure(id, async (config) => {
+        const { parsedData: existingMappings } = await this.getMappings(id);
+        const filteredMappings = (existingMappings == null ? void 0 : existingMappings.filter(
+          (mapping) => !mappings.some(
+            (newMapping) => newMapping.name === mapping.name && newMapping.direction === mapping.direction
+          )
+        )) ?? [];
+        const validMappings = mappings.filter((i) => i.name !== "" && i.value !== "");
+        const combinedMappings = [...filteredMappings, ...validMappings];
+        await config.setMappings(combinedMappings);
+      });
+    };
+    this.applyMappings = async (id, mappings) => {
+      return await this.configure(id, async (config) => {
+        const validMappings = mappings.filter((i) => i.name !== "" && i.value !== "");
+        await config.setMappings(validMappings);
+      });
+    };
+    this.setHttpHeaders = async (remoteConnectorId, headers) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.remoteConnectorAuthenticationSetHttpHeaders(remoteConnectorId, JSON.stringify(headers)).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    __privateSet(this, _editorAPI, editorAPI);
+    __privateSet(this, _localConfig, localConfig);
+    __privateSet(this, _connectorCompatibilityTools, new ConnectorCompatibilityTools.ConnectorCompatibilityTools());
+  }
+  async getMappings(id, direction) {
+    const res = await __privateGet(this, _editorAPI);
+    return res.getConnectorMappings(id).then((result) => EditorResponseData.getEditorResponseData(result)).then(
+      (result) => {
+        var _a;
+        return !direction ? result : {
+          ...result,
+          parsedData: (_a = result.parsedData) == null ? void 0 : _a.filter((cm) => cm.direction === direction)
+        };
+      }
+    );
+  }
+}
+_editorAPI = new WeakMap();
+_localConfig = new WeakMap();
+_connectorCompatibilityTools = new WeakMap();
+class ConnectorConfigurator {
+  /**
+   * @ignore
+   */
+  constructor(id, res) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _connectorId);
+    __privateAdd(this, _res);
+    this.setOptions = async (options) => {
+      return __privateGet(this, _res).setConnectorOptions(__privateGet(this, _connectorId), JSON.stringify(options)).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.setMappings = async (mappings) => {
+      const result = await __privateGet(this, _res).setConnectorMappings(
+        __privateGet(this, _connectorId),
+        mappings.map(function(m) {
+          return JSON.stringify(m);
+        })
+      );
+      return EditorResponseData.getEditorResponseData(result);
+    };
+    this.setHttpHeader = async (headerName, headerValue) => {
+      return __privateGet(this, _res).connectorAuthenticationSetHttpHeader(__privateGet(this, _connectorId), headerName, headerValue).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    __privateSet(this, _connectorId, id);
+    __privateSet(this, _res, res);
+  }
+}
+_connectorId = new WeakMap();
+_res = new WeakMap();
+exports.ConnectorController = ConnectorController;
+//# sourceMappingURL=ConnectorController.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectorController.cjs.js","sources":["../../../src/controllers/ConnectorController.ts"],"sourcesContent":["import { EditorAPI, EditorResponse, Id } from '../types/CommonTypes';\r\nimport {\r\n    ConnectorInstance,\r\n    ConnectorMappingDirection,\r\n    ConnectorMappingType,\r\n    ConnectorOptions,\r\n    ConnectorRegistration,\r\n    ConnectorState,\r\n    ConnectorStateType,\r\n    ConnectorToEngineMapping,\r\n    ConnectorType,\r\n    EngineToConnectorMapping,\r\n} from '../types/ConnectorTypes';\r\nimport { getEditorResponseData } from '../utils/EditorResponseData';\r\n\r\nimport * as Next from '../next/types/ConnectorTypes';\r\nimport { WellKnownConfigurationKeys } from '../types/ConfigurationTypes';\r\nimport { ConnectorCompatibilityTools } from '../utils/ConnectorCompatibilityTools';\r\n\r\n/**\r\n * The ConnectorController manages lifetime of all available connectors, regardless of the type, in the\r\n * document. Use it to add/remove connectors to a template, or set specific configuration.\r\n *\r\n * The way CHILI Studio handles different sources of resources is called 'Connectors'. A Connectors is an\r\n * implementation of a set of capabilities we need to interact with a certain external resource management system.\r\n * In essence a connector is the combination of a Javascript snippet and some metadata. The Javascript snippet\r\n * is loaded in the studio engine using a sandboxed Javascript execution engine (QuickJs). This allows us to\r\n * execute the media connector both on web using webassembly and on the server side during e.g. animation output\r\n * generation.\r\n * This controller is an interface to the running connector instance inside the studio engine. The engine will\r\n * automatically register the 'grafx-media' and 'grafx-font' connectors. Custom connectors need to be registered\r\n * manually.\r\n */\r\nexport class ConnectorController {\r\n    /**\r\n     * @ignore\r\n     */\r\n    #editorAPI: EditorAPI;\r\n    #localConfig: Map<string, string>;\r\n    #connectorCompatibilityTools: ConnectorCompatibilityTools;\r\n\r\n    /**\r\n     * @ignore\r\n     */\r\n    constructor(editorAPI: EditorAPI, localConfig: Map<string, string>) {\r\n        this.#editorAPI = editorAPI;\r\n        this.#localConfig = localConfig;\r\n        this.#connectorCompatibilityTools = new ConnectorCompatibilityTools();\r\n    }\r\n\r\n    /**\r\n     * Gets a connector by its id\r\n     * @param id the id of the connector\r\n     * @returns connector\r\n     */\r\n    getById = async (id: Id) => {\r\n        // add backwards compatibility code\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .getConnectorById(id)\r\n            .then((result) => getEditorResponseData<Next.ConnectorInstance>(result))\r\n            .then((resp) => {\r\n                const update: EditorResponse<ConnectorInstance> = { ...resp, parsedData: null };\r\n                if (resp.parsedData) {\r\n                    update.parsedData = this.#connectorCompatibilityTools.makeSingleConnectorBackwardsCompatible(\r\n                        resp.parsedData,\r\n                        this.#localConfig.get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl),\r\n                    );\r\n                }\r\n                return update;\r\n            });\r\n    };\r\n\r\n    /**\r\n     * Gets all available connectors of a 'ConnectorType'\r\n     * @param type type of connector you want to get\r\n     * @returns list of all available connectors of a 'ConnectorType'\r\n     */\r\n    getAllByType = async (type: ConnectorType) => {\r\n        // add backwards compatibility code\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .getConnectors(type)\r\n            .then((result) => getEditorResponseData<Next.ConnectorInstance[]>(result))\r\n            .then((resp) => {\r\n                const update: EditorResponse<ConnectorInstance[]> = { ...resp, parsedData: null };\r\n                if (resp.parsedData) {\r\n                    update.parsedData = this.#connectorCompatibilityTools.makeMultipleConnectorsBackwardsCompatible(\r\n                        resp.parsedData,\r\n                        this.#localConfig.get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl),\r\n                    );\r\n                }\r\n                return update;\r\n            });\r\n    };\r\n\r\n    /**\r\n     * Registers a new connector in the SDK. After successful registration, depending\r\n     * on the connector type, the connector can be configured and used in the template\r\n     * Remember to add custom authentication information after registering the connector\r\n     * @param registration registration object containing all details about the connector\r\n     * @returns the Id of the newly created connector, this Id should be used going forward.\r\n     */\r\n    register = async (registration: ConnectorRegistration) => {\r\n        const res = await this.#editorAPI;\r\n\r\n        const connectorRegistration =\r\n            this.#connectorCompatibilityTools.makeConnectorSourceForwardsCompatible(registration);\r\n\r\n        return res\r\n            .registerConnector(JSON.stringify(connectorRegistration))\r\n            .then((result) => getEditorResponseData<Id>(result));\r\n    };\r\n\r\n    /**\r\n     * Unregisters a connector from the document.\r\n     * @param id the id of the connector to unregister\r\n     * @returns\r\n     */\r\n    unregister = async (id: Id) => {\r\n        const res = await this.#editorAPI;\r\n        return res.unregisterConnector(id).then((result) => getEditorResponseData<null>(result));\r\n    };\r\n\r\n    /**\r\n     * Configures a registered connector. A configurator helper is passed as an argument\r\n     * of the callback for you to setup your connector.\r\n     * @param id the id of your registered connector\r\n     * @param configurationCallback callback to setup the connector\r\n     * @returns\r\n     */\r\n    configure = async (id: Id, configurationCallback: (configurator: ConnectorConfigurator) => Promise<void>) => {\r\n        const res = await this.#editorAPI;\r\n        // wait for connector to be ready\r\n        await this.waitToBeReady(id);\r\n        // execute callback\r\n        await configurationCallback(new ConnectorConfigurator(id, res));\r\n        // invalidate connector in engine\r\n        return res.updateConnectorConfiguration(id).then((result) => getEditorResponseData<null>(result));\r\n    };\r\n\r\n    /**\r\n     * Gets the current state a connector is in, to wait until a connector is ready to be used, use the 'waitToBeReady'\r\n     * method in this controller.\r\n     * @param id the id of your registered connector you want to make sure it is loaded\r\n     * @returns connector state\r\n     */\r\n    getState = async (id: Id) => {\r\n        const res = await this.#editorAPI;\r\n        return res.getConnectorState(id).then((result) => getEditorResponseData<ConnectorState>(result));\r\n    };\r\n\r\n    /**\r\n     * Gets the mapped data from connector.\r\n     * @param id the id of your registered connector\r\n     * @param direction the mapping direction\r\n     * @returns mappings\r\n     */\r\n    async getMappings(\r\n        id: string,\r\n        direction: ConnectorMappingDirection.engineToConnector,\r\n    ): Promise<EditorResponse<EngineToConnectorMapping[]>>;\r\n    async getMappings(\r\n        id: string,\r\n        direction: ConnectorMappingDirection.connectorToEngine,\r\n    ): Promise<EditorResponse<ConnectorToEngineMapping[]>>;\r\n    async getMappings(id: string, direction?: undefined): Promise<EditorResponse<ConnectorMappingType[]>>;\r\n    async getMappings(id: string, direction?: ConnectorMappingDirection) {\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .getConnectorMappings(id)\r\n            .then((result) => getEditorResponseData<ConnectorMappingType[]>(result))\r\n            .then((result) =>\r\n                !direction\r\n                    ? result\r\n                    : {\r\n                        ...result,\r\n                        parsedData: result.parsedData?.filter((cm) => cm.direction === direction),\r\n                    },\r\n            );\r\n    }\r\n\r\n    /**\r\n     * Gets the options from the connector.\r\n     * @param id the id of your registered connector\r\n     * @returns options\r\n     */\r\n    getOptions = async (id: string) => {\r\n        const res = await this.#editorAPI;\r\n        return res.getConnectorOptions(id).then((result) => getEditorResponseData<ConnectorOptions>(result));\r\n    };\r\n\r\n    /**\r\n     * Connectors are loaded asynchronously in the editor engine, this causes some challenges while configuring them. To make sure\r\n     * an action on the connector will be available, it's advised to await this method. After the Promise resolves we are sure\r\n     * the connector is up and running. This is used internally by the configure method to ensure correct execution. It's especially\r\n     * useful during startup of the SDK / right after the loadDocument call.\r\n     * @param id the id of your registered connector you want to make sure it is loaded\r\n     * @returns\r\n     */\r\n    waitToBeReady = async (id: Id, timeoutMilliseconds = 2000): Promise<EditorResponse<null>> => {\r\n        // minimum timeout is 500ms\r\n        let timeout = Math.max(timeoutMilliseconds, 500);\r\n\r\n        // maximum timeout is 5000ms\r\n        timeout = Math.min(timeout, 5000);\r\n\r\n        const waitTime = 100;\r\n        let retries = 0;\r\n\r\n        try {\r\n            // using while loop will prevent stack overflow issues when using recursion\r\n            // wait for maximum 2 seconds to fail\r\n            while (retries * waitTime < timeout) {\r\n                const result = await this.getState(id);\r\n\r\n                if (\r\n                    result.success &&\r\n                    result.parsedData &&\r\n                    (result.parsedData.type === ConnectorStateType.running ||\r\n                        result.parsedData.type === ConnectorStateType.ready)\r\n                ) {\r\n                    return getEditorResponseData<null>(\r\n                        { data: null, success: true, error: undefined, status: 0, parsedData: undefined },\r\n                        false,\r\n                    );\r\n                }\r\n\r\n                await new Promise((resolve) => setTimeout(resolve, waitTime));\r\n                retries++;\r\n            }\r\n        } catch (err) {\r\n            return getEditorResponseData<null>(\r\n                {\r\n                    data: null,\r\n                    success: false,\r\n                    error: `Error while getting connector state ${err}`,\r\n                    status: 50000,\r\n                    parsedData: undefined,\r\n                },\r\n                false,\r\n            );\r\n        }\r\n\r\n        return getEditorResponseData<null>(\r\n            {\r\n                data: null,\r\n                success: false,\r\n                error: `Timed out waiting for connector`,\r\n                status: 50000,\r\n                parsedData: undefined,\r\n            },\r\n            false,\r\n        );\r\n    };\r\n\r\n    /**\r\n     * Updates the mappings for a given connector.\r\n     * @param id the id of your registered connector\r\n     * @param mappings An array of mapping objects\r\n     * @returns\r\n     */\r\n    updateMappings = async (id: Id, mappings: ConnectorMappingType[]) => {\r\n        return await this.configure(id, async (config) => {\r\n            // Retrieve all existing mappings\r\n            const { parsedData: existingMappings } = await this.getMappings(id);\r\n\r\n            // Filter out old mappings that are being replaced with new ones\r\n            const filteredMappings =\r\n                existingMappings?.filter(\r\n                    (mapping) =>\r\n                        !mappings.some(\r\n                            (newMapping) =>\r\n                                newMapping.name === mapping.name && newMapping.direction === mapping.direction,\r\n                        ),\r\n                ) ?? [];\r\n\r\n            // Filter out new mappings that have empty `name` or `value`\r\n            const validMappings = mappings.filter((i) => i.name !== '' && i.value !== '');\r\n\r\n            // Merge valid new mappings with the filtered existing mappings\r\n            const combinedMappings = [...filteredMappings, ...validMappings];\r\n\r\n            // Update the configuration with the resulted mappings\r\n            await config.setMappings(combinedMappings);\r\n        });\r\n    };\r\n\r\n    /**\r\n        * Sets the mappings for a given connector, replacing the existing mappings with the new ones.\r\n        * @param id the id of your registered connector\r\n        * @param mappings An array of mapping objects to set\r\n        * @returns\r\n        */\r\n    applyMappings = async (id: Id, mappings: ConnectorMappingType[]) => {\r\n        return await this.configure(id, async (config) => {\r\n            const validMappings = mappings.filter((i) => i.name !== '' && i.value !== '');\r\n            await config.setMappings(validMappings);\r\n        });\r\n    };\r\n\r\n    /**\r\n     * Sets HTTP headers on every local connector instance of the given type that uses the given remote (Environment API) connector id.\r\n     * It's applicable as for already registered connectors as well as for future one with same remote connector id.\r\n     *\r\n     * @param remoteConnectorId unique id of the remote connector from the Environment API (grafx source)\r\n     * @param headers HTTP headers to set on the connector\r\n     * @returns EditorResponse with null on success; error if the engine call fails\r\n     */\r\n    setHttpHeaders = async (\r\n        remoteConnectorId: string,\r\n        headers: Record<string, string>,\r\n    ): Promise<EditorResponse<null>> => {\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .remoteConnectorAuthenticationSetHttpHeaders(remoteConnectorId, JSON.stringify(headers))\r\n            .then((result) => getEditorResponseData<null>(result));\r\n    };\r\n}\r\n\r\n/**\r\n * Helper to setup your connector\r\n */\r\nclass ConnectorConfigurator {\r\n    /**\r\n     * @ignore\r\n     */\r\n    #connectorId: Id;\r\n    #res: EditorAPI;\r\n\r\n    /**\r\n     * @ignore\r\n     */\r\n    constructor(id: Id, res: EditorAPI) {\r\n        this.#connectorId = id;\r\n        this.#res = res;\r\n    }\r\n\r\n    /**\r\n     * Allows to customize the context data a connector can work with. The options data\r\n     * will be available using the context parameter in the connector implementation code.\r\n     * @param options object containing key value data to pass to connector context\r\n     * @returns\r\n     */\r\n    setOptions = async (options: ConnectorOptions) => {\r\n        return this.#res\r\n            .setConnectorOptions(this.#connectorId, JSON.stringify(options))\r\n            .then((result) => getEditorResponseData<null>(result));\r\n    };\r\n\r\n    /**\r\n     * Allows to map variables or strings to connector context data.\r\n     * By defining the mappings, we can trigger re-download of assets (dynamic asset provider)\r\n     * or populate filters for the query endpoint. The mapped data will be available using\r\n     * the context parameter in the connector implementation code.\r\n     *\r\n     * For the variables the mapping should follow the format \"var.[variable id]\". e.g. var.6B29FC40-CA47-1067-B31D-00DD010662DA\r\n     *\r\n     * @param mappings collection of mappings to set to this connector\r\n     * @returns\r\n     */\r\n    setMappings = async (mappings: ConnectorMappingType[]) => {\r\n        const result = await this.#res.setConnectorMappings(\r\n            this.#connectorId,\r\n            mappings.map(function (m) {\r\n                return JSON.stringify(m);\r\n            }),\r\n        );\r\n        return getEditorResponseData<null>(result);\r\n    };\r\n\r\n    /**\r\n     * This method sets the HTTP headers for the 'staticKey' authentication type.\r\n     * These additional headers will be added to all connector http calls.\r\n     * Can only be used after a connector has been registered. (if you are using a grafx connector no registration is needed)\r\n     * @param headerName name of the header\r\n     * @param headerValue value of the header\r\n     * @returns\r\n     */\r\n    setHttpHeader = async (headerName: string, headerValue: string) => {\r\n        return this.#res\r\n            .connectorAuthenticationSetHttpHeader(this.#connectorId, headerName, headerValue)\r\n            .then((result) => getEditorResponseData<null>(result));\r\n    };\r\n}\r\n"],"names":["getEditorResponseData","WellKnownConfigurationKeys","ConnectorStateType","ConnectorCompatibilityTools"],"mappings":";;;;;;;;;;;;;;AAiCO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA,EAW7B,YAAY,WAAsB,aAAkC;AAPpE;AAAA;AAAA;AAAA;AACA;AACA;AAgBA,SAAA,UAAU,OAAO,OAAW;AAExB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,iBAAiB,EAAE,EACnB,KAAK,CAAC,WAAWA,mBAAAA,sBAA8C,MAAM,CAAC,EACtE,KAAK,CAAC,SAAS;AACZ,cAAM,SAA4C,EAAE,GAAG,MAAM,YAAY,KAAA;AACzE,YAAI,KAAK,YAAY;AACjB,iBAAO,aAAa,mBAAK,8BAA6B;AAAA,YAClD,KAAK;AAAA,YACL,mBAAK,cAAa,IAAIC,mBAAAA,2BAA2B,4BAA4B;AAAA,UAAA;AAAA,QAErF;AACA,eAAO;AAAA,MACX,CAAC;AAAA,IACT;AAOA,SAAA,eAAe,OAAO,SAAwB;AAE1C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,cAAc,IAAI,EAClB,KAAK,CAAC,WAAWD,mBAAAA,sBAAgD,MAAM,CAAC,EACxE,KAAK,CAAC,SAAS;AACZ,cAAM,SAA8C,EAAE,GAAG,MAAM,YAAY,KAAA;AAC3E,YAAI,KAAK,YAAY;AACjB,iBAAO,aAAa,mBAAK,8BAA6B;AAAA,YAClD,KAAK;AAAA,YACL,mBAAK,cAAa,IAAIC,mBAAAA,2BAA2B,4BAA4B;AAAA,UAAA;AAAA,QAErF;AACA,eAAO;AAAA,MACX,CAAC;AAAA,IACT;AASA,SAAA,WAAW,OAAO,iBAAwC;AACtD,YAAM,MAAM,MAAM,mBAAK;AAEvB,YAAM,wBACF,mBAAK,8BAA6B,sCAAsC,YAAY;AAExF,aAAO,IACF,kBAAkB,KAAK,UAAU,qBAAqB,CAAC,EACvD,KAAK,CAAC,WAAWD,mBAAAA,sBAA0B,MAAM,CAAC;AAAA,IAC3D;AAOA,SAAA,aAAa,OAAO,OAAW;AAC3B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,EAAE,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC3F;AASA,SAAA,YAAY,OAAO,IAAQ,0BAAkF;AACzG,YAAM,MAAM,MAAM,mBAAK;AAEvB,YAAM,KAAK,cAAc,EAAE;AAE3B,YAAM,sBAAsB,IAAI,sBAAsB,IAAI,GAAG,CAAC;AAE9D,aAAO,IAAI,6BAA6B,EAAE,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACpG;AAQA,SAAA,WAAW,OAAO,OAAW;AACzB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,EAAE,EAAE,KAAK,CAAC,WAAWA,yCAAsC,MAAM,CAAC;AAAA,IACnG;AAqCA,SAAA,aAAa,OAAO,OAAe;AAC/B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,EAAE,EAAE,KAAK,CAAC,WAAWA,yCAAwC,MAAM,CAAC;AAAA,IACvG;AAUA,SAAA,gBAAgB,OAAO,IAAQ,sBAAsB,QAAwC;AAEzF,UAAI,UAAU,KAAK,IAAI,qBAAqB,GAAG;AAG/C,gBAAU,KAAK,IAAI,SAAS,GAAI;AAEhC,YAAM,WAAW;AACjB,UAAI,UAAU;AAEd,UAAI;AAGA,eAAO,UAAU,WAAW,SAAS;AACjC,gBAAM,SAAS,MAAM,KAAK,SAAS,EAAE;AAErC,cACI,OAAO,WACP,OAAO,eACN,OAAO,WAAW,SAASE,eAAAA,mBAAmB,WAC3C,OAAO,WAAW,SAASA,eAAAA,mBAAmB,QACpD;AACE,mBAAOF,mBAAAA;AAAAA,cACH,EAAE,MAAM,MAAM,SAAS,MAAM,OAAO,QAAW,QAAQ,GAAG,YAAY,OAAA;AAAA,cACtE;AAAA,YAAA;AAAA,UAER;AAEA,gBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,QAAQ,CAAC;AAC5D;AAAA,QACJ;AAAA,MACJ,SAAS,KAAK;AACV,eAAOA,mBAAAA;AAAAA,UACH;AAAA,YACI,MAAM;AAAA,YACN,SAAS;AAAA,YACT,OAAO,uCAAuC,GAAG;AAAA,YACjD,QAAQ;AAAA,YACR,YAAY;AAAA,UAAA;AAAA,UAEhB;AAAA,QAAA;AAAA,MAER;AAEA,aAAOA,mBAAAA;AAAAA,QACH;AAAA,UACI,MAAM;AAAA,UACN,SAAS;AAAA,UACT,OAAO;AAAA,UACP,QAAQ;AAAA,UACR,YAAY;AAAA,QAAA;AAAA,QAEhB;AAAA,MAAA;AAAA,IAER;AAQA,SAAA,iBAAiB,OAAO,IAAQ,aAAqC;AACjE,aAAO,MAAM,KAAK,UAAU,IAAI,OAAO,WAAW;AAE9C,cAAM,EAAE,YAAY,iBAAA,IAAqB,MAAM,KAAK,YAAY,EAAE;AAGlE,cAAM,oBACF,qDAAkB;AAAA,UACd,CAAC,YACG,CAAC,SAAS;AAAA,YACN,CAAC,eACG,WAAW,SAAS,QAAQ,QAAQ,WAAW,cAAc,QAAQ;AAAA,UAAA;AAAA,cAEhF,CAAA;AAGT,cAAM,gBAAgB,SAAS,OAAO,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,UAAU,EAAE;AAG5E,cAAM,mBAAmB,CAAC,GAAG,kBAAkB,GAAG,aAAa;AAG/D,cAAM,OAAO,YAAY,gBAAgB;AAAA,MAC7C,CAAC;AAAA,IACL;AAQA,SAAA,gBAAgB,OAAO,IAAQ,aAAqC;AAChE,aAAO,MAAM,KAAK,UAAU,IAAI,OAAO,WAAW;AAC9C,cAAM,gBAAgB,SAAS,OAAO,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,UAAU,EAAE;AAC5E,cAAM,OAAO,YAAY,aAAa;AAAA,MAC1C,CAAC;AAAA,IACL;AAUA,SAAA,iBAAiB,OACb,mBACA,YACgC;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,4CAA4C,mBAAmB,KAAK,UAAU,OAAO,CAAC,EACtF,KAAK,CAAC,WAAWA,mBAAAA,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAhRI,uBAAK,YAAa;AAClB,uBAAK,cAAe;AACpB,uBAAK,8BAA+B,IAAIG,wDAAA;AAAA,EAC5C;AAAA,EAuHA,MAAM,YAAY,IAAY,WAAuC;AACjE,UAAM,MAAM,MAAM,mBAAK;AACvB,WAAO,IACF,qBAAqB,EAAE,EACvB,KAAK,CAAC,WAAWH,mBAAAA,sBAA8C,MAAM,CAAC,EACtE;AAAA,MAAK,CAAC,WAAA;;AACH,gBAAC,YACK,SACA;AAAA,UACE,GAAG;AAAA,UACH,aAAY,YAAO,eAAP,mBAAmB,OAAO,CAAC,OAAO,GAAG,cAAc;AAAA,QAAS;AAAA;AAAA,IAC5E;AAAA,EAEhB;AA0IJ;AAzRI;AACA;AACA;AA4RJ,MAAM,sBAAsB;AAAA;AAAA;AAAA;AAAA,EAUxB,YAAY,IAAQ,KAAgB;AANpC;AAAA;AAAA;AAAA;AACA;AAgBA,SAAA,aAAa,OAAO,YAA8B;AAC9C,aAAO,mBAAK,MACP,oBAAoB,mBAAK,eAAc,KAAK,UAAU,OAAO,CAAC,EAC9D,KAAK,CAAC,WAAWA,mBAAAA,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAaA,SAAA,cAAc,OAAO,aAAqC;AACtD,YAAM,SAAS,MAAM,mBAAK,MAAK;AAAA,QAC3B,mBAAK;AAAA,QACL,SAAS,IAAI,SAAU,GAAG;AACtB,iBAAO,KAAK,UAAU,CAAC;AAAA,QAC3B,CAAC;AAAA,MAAA;AAEL,aAAOA,mBAAAA,sBAA4B,MAAM;AAAA,IAC7C;AAUA,SAAA,gBAAgB,OAAO,YAAoB,gBAAwB;AAC/D,aAAO,mBAAK,MACP,qCAAqC,mBAAK,eAAc,YAAY,WAAW,EAC/E,KAAK,CAAC,WAAWA,mBAAAA,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAjDI,uBAAK,cAAe;AACpB,uBAAK,MAAO;AAAA,EAChB;AAgDJ;AAzDI;AACA;;"}

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

@@ -0,0 +1,190 @@
+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, _localConfig, _connectorCompatibilityTools, _connectorId, _res;
+import { ConnectorStateType } from "../types/ConnectorTypes.es.js";
+import { getEditorResponseData } from "../utils/EditorResponseData.es.js";
+import { WellKnownConfigurationKeys } from "../types/ConfigurationTypes.es.js";
+import { ConnectorCompatibilityTools } from "../utils/ConnectorCompatibilityTools.es.js";
+class ConnectorController {
+  /**
+   * @ignore
+   */
+  constructor(editorAPI, localConfig) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _editorAPI);
+    __privateAdd(this, _localConfig);
+    __privateAdd(this, _connectorCompatibilityTools);
+    this.getById = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectorById(id).then((result) => getEditorResponseData(result)).then((resp) => {
+        const update = { ...resp, parsedData: null };
+        if (resp.parsedData) {
+          update.parsedData = __privateGet(this, _connectorCompatibilityTools).makeSingleConnectorBackwardsCompatible(
+            resp.parsedData,
+            __privateGet(this, _localConfig).get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl)
+          );
+        }
+        return update;
+      });
+    };
+    this.getAllByType = async (type) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectors(type).then((result) => getEditorResponseData(result)).then((resp) => {
+        const update = { ...resp, parsedData: null };
+        if (resp.parsedData) {
+          update.parsedData = __privateGet(this, _connectorCompatibilityTools).makeMultipleConnectorsBackwardsCompatible(
+            resp.parsedData,
+            __privateGet(this, _localConfig).get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl)
+          );
+        }
+        return update;
+      });
+    };
+    this.register = async (registration) => {
+      const res = await __privateGet(this, _editorAPI);
+      const connectorRegistration = __privateGet(this, _connectorCompatibilityTools).makeConnectorSourceForwardsCompatible(registration);
+      return res.registerConnector(JSON.stringify(connectorRegistration)).then((result) => getEditorResponseData(result));
+    };
+    this.unregister = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.unregisterConnector(id).then((result) => getEditorResponseData(result));
+    };
+    this.configure = async (id, configurationCallback) => {
+      const res = await __privateGet(this, _editorAPI);
+      await this.waitToBeReady(id);
+      await configurationCallback(new ConnectorConfigurator(id, res));
+      return res.updateConnectorConfiguration(id).then((result) => getEditorResponseData(result));
+    };
+    this.getState = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectorState(id).then((result) => getEditorResponseData(result));
+    };
+    this.getOptions = async (id) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.getConnectorOptions(id).then((result) => getEditorResponseData(result));
+    };
+    this.waitToBeReady = async (id, timeoutMilliseconds = 2e3) => {
+      let timeout = Math.max(timeoutMilliseconds, 500);
+      timeout = Math.min(timeout, 5e3);
+      const waitTime = 100;
+      let retries = 0;
+      try {
+        while (retries * waitTime < timeout) {
+          const result = await this.getState(id);
+          if (result.success && result.parsedData && (result.parsedData.type === ConnectorStateType.running || result.parsedData.type === ConnectorStateType.ready)) {
+            return getEditorResponseData(
+              { data: null, success: true, error: void 0, status: 0, parsedData: void 0 },
+              false
+            );
+          }
+          await new Promise((resolve) => setTimeout(resolve, waitTime));
+          retries++;
+        }
+      } catch (err) {
+        return getEditorResponseData(
+          {
+            data: null,
+            success: false,
+            error: `Error while getting connector state ${err}`,
+            status: 5e4,
+            parsedData: void 0
+          },
+          false
+        );
+      }
+      return getEditorResponseData(
+        {
+          data: null,
+          success: false,
+          error: `Timed out waiting for connector`,
+          status: 5e4,
+          parsedData: void 0
+        },
+        false
+      );
+    };
+    this.updateMappings = async (id, mappings) => {
+      return await this.configure(id, async (config) => {
+        const { parsedData: existingMappings } = await this.getMappings(id);
+        const filteredMappings = (existingMappings == null ? void 0 : existingMappings.filter(
+          (mapping) => !mappings.some(
+            (newMapping) => newMapping.name === mapping.name && newMapping.direction === mapping.direction
+          )
+        )) ?? [];
+        const validMappings = mappings.filter((i) => i.name !== "" && i.value !== "");
+        const combinedMappings = [...filteredMappings, ...validMappings];
+        await config.setMappings(combinedMappings);
+      });
+    };
+    this.applyMappings = async (id, mappings) => {
+      return await this.configure(id, async (config) => {
+        const validMappings = mappings.filter((i) => i.name !== "" && i.value !== "");
+        await config.setMappings(validMappings);
+      });
+    };
+    this.setHttpHeaders = async (remoteConnectorId, headers) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.remoteConnectorAuthenticationSetHttpHeaders(remoteConnectorId, JSON.stringify(headers)).then((result) => getEditorResponseData(result));
+    };
+    __privateSet(this, _editorAPI, editorAPI);
+    __privateSet(this, _localConfig, localConfig);
+    __privateSet(this, _connectorCompatibilityTools, new ConnectorCompatibilityTools());
+  }
+  async getMappings(id, direction) {
+    const res = await __privateGet(this, _editorAPI);
+    return res.getConnectorMappings(id).then((result) => getEditorResponseData(result)).then(
+      (result) => {
+        var _a;
+        return !direction ? result : {
+          ...result,
+          parsedData: (_a = result.parsedData) == null ? void 0 : _a.filter((cm) => cm.direction === direction)
+        };
+      }
+    );
+  }
+}
+_editorAPI = new WeakMap();
+_localConfig = new WeakMap();
+_connectorCompatibilityTools = new WeakMap();
+class ConnectorConfigurator {
+  /**
+   * @ignore
+   */
+  constructor(id, res) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _connectorId);
+    __privateAdd(this, _res);
+    this.setOptions = async (options) => {
+      return __privateGet(this, _res).setConnectorOptions(__privateGet(this, _connectorId), JSON.stringify(options)).then((result) => getEditorResponseData(result));
+    };
+    this.setMappings = async (mappings) => {
+      const result = await __privateGet(this, _res).setConnectorMappings(
+        __privateGet(this, _connectorId),
+        mappings.map(function(m) {
+          return JSON.stringify(m);
+        })
+      );
+      return getEditorResponseData(result);
+    };
+    this.setHttpHeader = async (headerName, headerValue) => {
+      return __privateGet(this, _res).connectorAuthenticationSetHttpHeader(__privateGet(this, _connectorId), headerName, headerValue).then((result) => getEditorResponseData(result));
+    };
+    __privateSet(this, _connectorId, id);
+    __privateSet(this, _res, res);
+  }
+}
+_connectorId = new WeakMap();
+_res = new WeakMap();
+export {
+  ConnectorController
+};
+//# sourceMappingURL=ConnectorController.es.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ConnectorController.es.js","sources":["../../../src/controllers/ConnectorController.ts"],"sourcesContent":["import { EditorAPI, EditorResponse, Id } from '../types/CommonTypes';\r\nimport {\r\n    ConnectorInstance,\r\n    ConnectorMappingDirection,\r\n    ConnectorMappingType,\r\n    ConnectorOptions,\r\n    ConnectorRegistration,\r\n    ConnectorState,\r\n    ConnectorStateType,\r\n    ConnectorToEngineMapping,\r\n    ConnectorType,\r\n    EngineToConnectorMapping,\r\n} from '../types/ConnectorTypes';\r\nimport { getEditorResponseData } from '../utils/EditorResponseData';\r\n\r\nimport * as Next from '../next/types/ConnectorTypes';\r\nimport { WellKnownConfigurationKeys } from '../types/ConfigurationTypes';\r\nimport { ConnectorCompatibilityTools } from '../utils/ConnectorCompatibilityTools';\r\n\r\n/**\r\n * The ConnectorController manages lifetime of all available connectors, regardless of the type, in the\r\n * document. Use it to add/remove connectors to a template, or set specific configuration.\r\n *\r\n * The way CHILI Studio handles different sources of resources is called 'Connectors'. A Connectors is an\r\n * implementation of a set of capabilities we need to interact with a certain external resource management system.\r\n * In essence a connector is the combination of a Javascript snippet and some metadata. The Javascript snippet\r\n * is loaded in the studio engine using a sandboxed Javascript execution engine (QuickJs). This allows us to\r\n * execute the media connector both on web using webassembly and on the server side during e.g. animation output\r\n * generation.\r\n * This controller is an interface to the running connector instance inside the studio engine. The engine will\r\n * automatically register the 'grafx-media' and 'grafx-font' connectors. Custom connectors need to be registered\r\n * manually.\r\n */\r\nexport class ConnectorController {\r\n    /**\r\n     * @ignore\r\n     */\r\n    #editorAPI: EditorAPI;\r\n    #localConfig: Map<string, string>;\r\n    #connectorCompatibilityTools: ConnectorCompatibilityTools;\r\n\r\n    /**\r\n     * @ignore\r\n     */\r\n    constructor(editorAPI: EditorAPI, localConfig: Map<string, string>) {\r\n        this.#editorAPI = editorAPI;\r\n        this.#localConfig = localConfig;\r\n        this.#connectorCompatibilityTools = new ConnectorCompatibilityTools();\r\n    }\r\n\r\n    /**\r\n     * Gets a connector by its id\r\n     * @param id the id of the connector\r\n     * @returns connector\r\n     */\r\n    getById = async (id: Id) => {\r\n        // add backwards compatibility code\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .getConnectorById(id)\r\n            .then((result) => getEditorResponseData<Next.ConnectorInstance>(result))\r\n            .then((resp) => {\r\n                const update: EditorResponse<ConnectorInstance> = { ...resp, parsedData: null };\r\n                if (resp.parsedData) {\r\n                    update.parsedData = this.#connectorCompatibilityTools.makeSingleConnectorBackwardsCompatible(\r\n                        resp.parsedData,\r\n                        this.#localConfig.get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl),\r\n                    );\r\n                }\r\n                return update;\r\n            });\r\n    };\r\n\r\n    /**\r\n     * Gets all available connectors of a 'ConnectorType'\r\n     * @param type type of connector you want to get\r\n     * @returns list of all available connectors of a 'ConnectorType'\r\n     */\r\n    getAllByType = async (type: ConnectorType) => {\r\n        // add backwards compatibility code\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .getConnectors(type)\r\n            .then((result) => getEditorResponseData<Next.ConnectorInstance[]>(result))\r\n            .then((resp) => {\r\n                const update: EditorResponse<ConnectorInstance[]> = { ...resp, parsedData: null };\r\n                if (resp.parsedData) {\r\n                    update.parsedData = this.#connectorCompatibilityTools.makeMultipleConnectorsBackwardsCompatible(\r\n                        resp.parsedData,\r\n                        this.#localConfig.get(WellKnownConfigurationKeys.GraFxStudioEnvironmentApiUrl),\r\n                    );\r\n                }\r\n                return update;\r\n            });\r\n    };\r\n\r\n    /**\r\n     * Registers a new connector in the SDK. After successful registration, depending\r\n     * on the connector type, the connector can be configured and used in the template\r\n     * Remember to add custom authentication information after registering the connector\r\n     * @param registration registration object containing all details about the connector\r\n     * @returns the Id of the newly created connector, this Id should be used going forward.\r\n     */\r\n    register = async (registration: ConnectorRegistration) => {\r\n        const res = await this.#editorAPI;\r\n\r\n        const connectorRegistration =\r\n            this.#connectorCompatibilityTools.makeConnectorSourceForwardsCompatible(registration);\r\n\r\n        return res\r\n            .registerConnector(JSON.stringify(connectorRegistration))\r\n            .then((result) => getEditorResponseData<Id>(result));\r\n    };\r\n\r\n    /**\r\n     * Unregisters a connector from the document.\r\n     * @param id the id of the connector to unregister\r\n     * @returns\r\n     */\r\n    unregister = async (id: Id) => {\r\n        const res = await this.#editorAPI;\r\n        return res.unregisterConnector(id).then((result) => getEditorResponseData<null>(result));\r\n    };\r\n\r\n    /**\r\n     * Configures a registered connector. A configurator helper is passed as an argument\r\n     * of the callback for you to setup your connector.\r\n     * @param id the id of your registered connector\r\n     * @param configurationCallback callback to setup the connector\r\n     * @returns\r\n     */\r\n    configure = async (id: Id, configurationCallback: (configurator: ConnectorConfigurator) => Promise<void>) => {\r\n        const res = await this.#editorAPI;\r\n        // wait for connector to be ready\r\n        await this.waitToBeReady(id);\r\n        // execute callback\r\n        await configurationCallback(new ConnectorConfigurator(id, res));\r\n        // invalidate connector in engine\r\n        return res.updateConnectorConfiguration(id).then((result) => getEditorResponseData<null>(result));\r\n    };\r\n\r\n    /**\r\n     * Gets the current state a connector is in, to wait until a connector is ready to be used, use the 'waitToBeReady'\r\n     * method in this controller.\r\n     * @param id the id of your registered connector you want to make sure it is loaded\r\n     * @returns connector state\r\n     */\r\n    getState = async (id: Id) => {\r\n        const res = await this.#editorAPI;\r\n        return res.getConnectorState(id).then((result) => getEditorResponseData<ConnectorState>(result));\r\n    };\r\n\r\n    /**\r\n     * Gets the mapped data from connector.\r\n     * @param id the id of your registered connector\r\n     * @param direction the mapping direction\r\n     * @returns mappings\r\n     */\r\n    async getMappings(\r\n        id: string,\r\n        direction: ConnectorMappingDirection.engineToConnector,\r\n    ): Promise<EditorResponse<EngineToConnectorMapping[]>>;\r\n    async getMappings(\r\n        id: string,\r\n        direction: ConnectorMappingDirection.connectorToEngine,\r\n    ): Promise<EditorResponse<ConnectorToEngineMapping[]>>;\r\n    async getMappings(id: string, direction?: undefined): Promise<EditorResponse<ConnectorMappingType[]>>;\r\n    async getMappings(id: string, direction?: ConnectorMappingDirection) {\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .getConnectorMappings(id)\r\n            .then((result) => getEditorResponseData<ConnectorMappingType[]>(result))\r\n            .then((result) =>\r\n                !direction\r\n                    ? result\r\n                    : {\r\n                        ...result,\r\n                        parsedData: result.parsedData?.filter((cm) => cm.direction === direction),\r\n                    },\r\n            );\r\n    }\r\n\r\n    /**\r\n     * Gets the options from the connector.\r\n     * @param id the id of your registered connector\r\n     * @returns options\r\n     */\r\n    getOptions = async (id: string) => {\r\n        const res = await this.#editorAPI;\r\n        return res.getConnectorOptions(id).then((result) => getEditorResponseData<ConnectorOptions>(result));\r\n    };\r\n\r\n    /**\r\n     * Connectors are loaded asynchronously in the editor engine, this causes some challenges while configuring them. To make sure\r\n     * an action on the connector will be available, it's advised to await this method. After the Promise resolves we are sure\r\n     * the connector is up and running. This is used internally by the configure method to ensure correct execution. It's especially\r\n     * useful during startup of the SDK / right after the loadDocument call.\r\n     * @param id the id of your registered connector you want to make sure it is loaded\r\n     * @returns\r\n     */\r\n    waitToBeReady = async (id: Id, timeoutMilliseconds = 2000): Promise<EditorResponse<null>> => {\r\n        // minimum timeout is 500ms\r\n        let timeout = Math.max(timeoutMilliseconds, 500);\r\n\r\n        // maximum timeout is 5000ms\r\n        timeout = Math.min(timeout, 5000);\r\n\r\n        const waitTime = 100;\r\n        let retries = 0;\r\n\r\n        try {\r\n            // using while loop will prevent stack overflow issues when using recursion\r\n            // wait for maximum 2 seconds to fail\r\n            while (retries * waitTime < timeout) {\r\n                const result = await this.getState(id);\r\n\r\n                if (\r\n                    result.success &&\r\n                    result.parsedData &&\r\n                    (result.parsedData.type === ConnectorStateType.running ||\r\n                        result.parsedData.type === ConnectorStateType.ready)\r\n                ) {\r\n                    return getEditorResponseData<null>(\r\n                        { data: null, success: true, error: undefined, status: 0, parsedData: undefined },\r\n                        false,\r\n                    );\r\n                }\r\n\r\n                await new Promise((resolve) => setTimeout(resolve, waitTime));\r\n                retries++;\r\n            }\r\n        } catch (err) {\r\n            return getEditorResponseData<null>(\r\n                {\r\n                    data: null,\r\n                    success: false,\r\n                    error: `Error while getting connector state ${err}`,\r\n                    status: 50000,\r\n                    parsedData: undefined,\r\n                },\r\n                false,\r\n            );\r\n        }\r\n\r\n        return getEditorResponseData<null>(\r\n            {\r\n                data: null,\r\n                success: false,\r\n                error: `Timed out waiting for connector`,\r\n                status: 50000,\r\n                parsedData: undefined,\r\n            },\r\n            false,\r\n        );\r\n    };\r\n\r\n    /**\r\n     * Updates the mappings for a given connector.\r\n     * @param id the id of your registered connector\r\n     * @param mappings An array of mapping objects\r\n     * @returns\r\n     */\r\n    updateMappings = async (id: Id, mappings: ConnectorMappingType[]) => {\r\n        return await this.configure(id, async (config) => {\r\n            // Retrieve all existing mappings\r\n            const { parsedData: existingMappings } = await this.getMappings(id);\r\n\r\n            // Filter out old mappings that are being replaced with new ones\r\n            const filteredMappings =\r\n                existingMappings?.filter(\r\n                    (mapping) =>\r\n                        !mappings.some(\r\n                            (newMapping) =>\r\n                                newMapping.name === mapping.name && newMapping.direction === mapping.direction,\r\n                        ),\r\n                ) ?? [];\r\n\r\n            // Filter out new mappings that have empty `name` or `value`\r\n            const validMappings = mappings.filter((i) => i.name !== '' && i.value !== '');\r\n\r\n            // Merge valid new mappings with the filtered existing mappings\r\n            const combinedMappings = [...filteredMappings, ...validMappings];\r\n\r\n            // Update the configuration with the resulted mappings\r\n            await config.setMappings(combinedMappings);\r\n        });\r\n    };\r\n\r\n    /**\r\n        * Sets the mappings for a given connector, replacing the existing mappings with the new ones.\r\n        * @param id the id of your registered connector\r\n        * @param mappings An array of mapping objects to set\r\n        * @returns\r\n        */\r\n    applyMappings = async (id: Id, mappings: ConnectorMappingType[]) => {\r\n        return await this.configure(id, async (config) => {\r\n            const validMappings = mappings.filter((i) => i.name !== '' && i.value !== '');\r\n            await config.setMappings(validMappings);\r\n        });\r\n    };\r\n\r\n    /**\r\n     * Sets HTTP headers on every local connector instance of the given type that uses the given remote (Environment API) connector id.\r\n     * It's applicable as for already registered connectors as well as for future one with same remote connector id.\r\n     *\r\n     * @param remoteConnectorId unique id of the remote connector from the Environment API (grafx source)\r\n     * @param headers HTTP headers to set on the connector\r\n     * @returns EditorResponse with null on success; error if the engine call fails\r\n     */\r\n    setHttpHeaders = async (\r\n        remoteConnectorId: string,\r\n        headers: Record<string, string>,\r\n    ): Promise<EditorResponse<null>> => {\r\n        const res = await this.#editorAPI;\r\n        return res\r\n            .remoteConnectorAuthenticationSetHttpHeaders(remoteConnectorId, JSON.stringify(headers))\r\n            .then((result) => getEditorResponseData<null>(result));\r\n    };\r\n}\r\n\r\n/**\r\n * Helper to setup your connector\r\n */\r\nclass ConnectorConfigurator {\r\n    /**\r\n     * @ignore\r\n     */\r\n    #connectorId: Id;\r\n    #res: EditorAPI;\r\n\r\n    /**\r\n     * @ignore\r\n     */\r\n    constructor(id: Id, res: EditorAPI) {\r\n        this.#connectorId = id;\r\n        this.#res = res;\r\n    }\r\n\r\n    /**\r\n     * Allows to customize the context data a connector can work with. The options data\r\n     * will be available using the context parameter in the connector implementation code.\r\n     * @param options object containing key value data to pass to connector context\r\n     * @returns\r\n     */\r\n    setOptions = async (options: ConnectorOptions) => {\r\n        return this.#res\r\n            .setConnectorOptions(this.#connectorId, JSON.stringify(options))\r\n            .then((result) => getEditorResponseData<null>(result));\r\n    };\r\n\r\n    /**\r\n     * Allows to map variables or strings to connector context data.\r\n     * By defining the mappings, we can trigger re-download of assets (dynamic asset provider)\r\n     * or populate filters for the query endpoint. The mapped data will be available using\r\n     * the context parameter in the connector implementation code.\r\n     *\r\n     * For the variables the mapping should follow the format \"var.[variable id]\". e.g. var.6B29FC40-CA47-1067-B31D-00DD010662DA\r\n     *\r\n     * @param mappings collection of mappings to set to this connector\r\n     * @returns\r\n     */\r\n    setMappings = async (mappings: ConnectorMappingType[]) => {\r\n        const result = await this.#res.setConnectorMappings(\r\n            this.#connectorId,\r\n            mappings.map(function (m) {\r\n                return JSON.stringify(m);\r\n            }),\r\n        );\r\n        return getEditorResponseData<null>(result);\r\n    };\r\n\r\n    /**\r\n     * This method sets the HTTP headers for the 'staticKey' authentication type.\r\n     * These additional headers will be added to all connector http calls.\r\n     * Can only be used after a connector has been registered. (if you are using a grafx connector no registration is needed)\r\n     * @param headerName name of the header\r\n     * @param headerValue value of the header\r\n     * @returns\r\n     */\r\n    setHttpHeader = async (headerName: string, headerValue: string) => {\r\n        return this.#res\r\n            .connectorAuthenticationSetHttpHeader(this.#connectorId, headerName, headerValue)\r\n            .then((result) => getEditorResponseData<null>(result));\r\n    };\r\n}\r\n"],"names":[],"mappings":";;;;;;;;;;;;AAiCO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA,EAW7B,YAAY,WAAsB,aAAkC;AAPpE;AAAA;AAAA;AAAA;AACA;AACA;AAgBA,SAAA,UAAU,OAAO,OAAW;AAExB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,iBAAiB,EAAE,EACnB,KAAK,CAAC,WAAW,sBAA8C,MAAM,CAAC,EACtE,KAAK,CAAC,SAAS;AACZ,cAAM,SAA4C,EAAE,GAAG,MAAM,YAAY,KAAA;AACzE,YAAI,KAAK,YAAY;AACjB,iBAAO,aAAa,mBAAK,8BAA6B;AAAA,YAClD,KAAK;AAAA,YACL,mBAAK,cAAa,IAAI,2BAA2B,4BAA4B;AAAA,UAAA;AAAA,QAErF;AACA,eAAO;AAAA,MACX,CAAC;AAAA,IACT;AAOA,SAAA,eAAe,OAAO,SAAwB;AAE1C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,cAAc,IAAI,EAClB,KAAK,CAAC,WAAW,sBAAgD,MAAM,CAAC,EACxE,KAAK,CAAC,SAAS;AACZ,cAAM,SAA8C,EAAE,GAAG,MAAM,YAAY,KAAA;AAC3E,YAAI,KAAK,YAAY;AACjB,iBAAO,aAAa,mBAAK,8BAA6B;AAAA,YAClD,KAAK;AAAA,YACL,mBAAK,cAAa,IAAI,2BAA2B,4BAA4B;AAAA,UAAA;AAAA,QAErF;AACA,eAAO;AAAA,MACX,CAAC;AAAA,IACT;AASA,SAAA,WAAW,OAAO,iBAAwC;AACtD,YAAM,MAAM,MAAM,mBAAK;AAEvB,YAAM,wBACF,mBAAK,8BAA6B,sCAAsC,YAAY;AAExF,aAAO,IACF,kBAAkB,KAAK,UAAU,qBAAqB,CAAC,EACvD,KAAK,CAAC,WAAW,sBAA0B,MAAM,CAAC;AAAA,IAC3D;AAOA,SAAA,aAAa,OAAO,OAAW;AAC3B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3F;AASA,SAAA,YAAY,OAAO,IAAQ,0BAAkF;AACzG,YAAM,MAAM,MAAM,mBAAK;AAEvB,YAAM,KAAK,cAAc,EAAE;AAE3B,YAAM,sBAAsB,IAAI,sBAAsB,IAAI,GAAG,CAAC;AAE9D,aAAO,IAAI,6BAA6B,EAAE,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACpG;AAQA,SAAA,WAAW,OAAO,OAAW;AACzB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAAsC,MAAM,CAAC;AAAA,IACnG;AAqCA,SAAA,aAAa,OAAO,OAAe;AAC/B,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,EAAE,EAAE,KAAK,CAAC,WAAW,sBAAwC,MAAM,CAAC;AAAA,IACvG;AAUA,SAAA,gBAAgB,OAAO,IAAQ,sBAAsB,QAAwC;AAEzF,UAAI,UAAU,KAAK,IAAI,qBAAqB,GAAG;AAG/C,gBAAU,KAAK,IAAI,SAAS,GAAI;AAEhC,YAAM,WAAW;AACjB,UAAI,UAAU;AAEd,UAAI;AAGA,eAAO,UAAU,WAAW,SAAS;AACjC,gBAAM,SAAS,MAAM,KAAK,SAAS,EAAE;AAErC,cACI,OAAO,WACP,OAAO,eACN,OAAO,WAAW,SAAS,mBAAmB,WAC3C,OAAO,WAAW,SAAS,mBAAmB,QACpD;AACE,mBAAO;AAAA,cACH,EAAE,MAAM,MAAM,SAAS,MAAM,OAAO,QAAW,QAAQ,GAAG,YAAY,OAAA;AAAA,cACtE;AAAA,YAAA;AAAA,UAER;AAEA,gBAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,QAAQ,CAAC;AAC5D;AAAA,QACJ;AAAA,MACJ,SAAS,KAAK;AACV,eAAO;AAAA,UACH;AAAA,YACI,MAAM;AAAA,YACN,SAAS;AAAA,YACT,OAAO,uCAAuC,GAAG;AAAA,YACjD,QAAQ;AAAA,YACR,YAAY;AAAA,UAAA;AAAA,UAEhB;AAAA,QAAA;AAAA,MAER;AAEA,aAAO;AAAA,QACH;AAAA,UACI,MAAM;AAAA,UACN,SAAS;AAAA,UACT,OAAO;AAAA,UACP,QAAQ;AAAA,UACR,YAAY;AAAA,QAAA;AAAA,QAEhB;AAAA,MAAA;AAAA,IAER;AAQA,SAAA,iBAAiB,OAAO,IAAQ,aAAqC;AACjE,aAAO,MAAM,KAAK,UAAU,IAAI,OAAO,WAAW;AAE9C,cAAM,EAAE,YAAY,iBAAA,IAAqB,MAAM,KAAK,YAAY,EAAE;AAGlE,cAAM,oBACF,qDAAkB;AAAA,UACd,CAAC,YACG,CAAC,SAAS;AAAA,YACN,CAAC,eACG,WAAW,SAAS,QAAQ,QAAQ,WAAW,cAAc,QAAQ;AAAA,UAAA;AAAA,cAEhF,CAAA;AAGT,cAAM,gBAAgB,SAAS,OAAO,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,UAAU,EAAE;AAG5E,cAAM,mBAAmB,CAAC,GAAG,kBAAkB,GAAG,aAAa;AAG/D,cAAM,OAAO,YAAY,gBAAgB;AAAA,MAC7C,CAAC;AAAA,IACL;AAQA,SAAA,gBAAgB,OAAO,IAAQ,aAAqC;AAChE,aAAO,MAAM,KAAK,UAAU,IAAI,OAAO,WAAW;AAC9C,cAAM,gBAAgB,SAAS,OAAO,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,UAAU,EAAE;AAC5E,cAAM,OAAO,YAAY,aAAa;AAAA,MAC1C,CAAC;AAAA,IACL;AAUA,SAAA,iBAAiB,OACb,mBACA,YACgC;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,4CAA4C,mBAAmB,KAAK,UAAU,OAAO,CAAC,EACtF,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAhRI,uBAAK,YAAa;AAClB,uBAAK,cAAe;AACpB,uBAAK,8BAA+B,IAAI,4BAAA;AAAA,EAC5C;AAAA,EAuHA,MAAM,YAAY,IAAY,WAAuC;AACjE,UAAM,MAAM,MAAM,mBAAK;AACvB,WAAO,IACF,qBAAqB,EAAE,EACvB,KAAK,CAAC,WAAW,sBAA8C,MAAM,CAAC,EACtE;AAAA,MAAK,CAAC,WAAA;;AACH,gBAAC,YACK,SACA;AAAA,UACE,GAAG;AAAA,UACH,aAAY,YAAO,eAAP,mBAAmB,OAAO,CAAC,OAAO,GAAG,cAAc;AAAA,QAAS;AAAA;AAAA,IAC5E;AAAA,EAEhB;AA0IJ;AAzRI;AACA;AACA;AA4RJ,MAAM,sBAAsB;AAAA;AAAA;AAAA;AAAA,EAUxB,YAAY,IAAQ,KAAgB;AANpC;AAAA;AAAA;AAAA;AACA;AAgBA,SAAA,aAAa,OAAO,YAA8B;AAC9C,aAAO,mBAAK,MACP,oBAAoB,mBAAK,eAAc,KAAK,UAAU,OAAO,CAAC,EAC9D,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAaA,SAAA,cAAc,OAAO,aAAqC;AACtD,YAAM,SAAS,MAAM,mBAAK,MAAK;AAAA,QAC3B,mBAAK;AAAA,QACL,SAAS,IAAI,SAAU,GAAG;AACtB,iBAAO,KAAK,UAAU,CAAC;AAAA,QAC3B,CAAC;AAAA,MAAA;AAEL,aAAO,sBAA4B,MAAM;AAAA,IAC7C;AAUA,SAAA,gBAAgB,OAAO,YAAoB,gBAAwB;AAC/D,aAAO,mBAAK,MACP,qCAAqC,mBAAK,eAAc,YAAY,WAAW,EAC/E,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAjDI,uBAAK,cAAe;AACpB,uBAAK,MAAO;AAAA,EAChB;AAgDJ;AAzDI;AACA;"}

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

@@ -0,0 +1,88 @@
+"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, _dataItemMappingTools;
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const EditorResponseData = require("../utils/EditorResponseData.cjs.js");
+class DataConnectorController {
+  /**
+   * @ignore
+   */
+  constructor(editorAPI, dataItemMappingTools) {
+    /**
+     * @ignore
+     */
+    __privateAdd(this, _editorAPI);
+    __privateAdd(this, _dataItemMappingTools);
+    this.getPageItemById = async (connectorId, id, pageOptions, context = {}) => {
+      const res = await __privateGet(this, _editorAPI);
+      const result = await res.dataConnectorGetPageItemById(
+        connectorId,
+        id,
+        JSON.stringify(pageOptions),
+        JSON.stringify(context)
+      );
+      const resp = EditorResponseData.getEditorResponseData(result);
+      const update = { ...resp, parsedData: null };
+      if (resp.parsedData) {
+        update.parsedData = {
+          ...resp.parsedData,
+          data: __privateGet(this, _dataItemMappingTools).mapEngineToDataItem(resp.parsedData.data)
+        };
+      }
+      return update;
+    };
+    this.getConfigurationOptions = async (connectorId) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.dataConnectorGetConfigurationOptions(connectorId).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.getCapabilities = async (connectorId) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.dataConnectorGetCapabilities(connectorId).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    __privateSet(this, _editorAPI, editorAPI);
+    __privateSet(this, _dataItemMappingTools, dataItemMappingTools);
+  }
+  async getPage(connectorId, config, context = {}) {
+    const { previousPageToken, continuationToken } = config;
+    if (previousPageToken != null && continuationToken != null) {
+      throw new Error(
+        'Invalid page config: "previousPageToken" and "continuationToken" are mutually exclusive. Provide only one to indicate navigation direction.'
+      );
+    }
+    const res = await __privateGet(this, _editorAPI);
+    const result = await res.dataConnectorGetPage(connectorId, JSON.stringify(config), JSON.stringify(context));
+    const resp = EditorResponseData.getEditorResponseData(
+      result
+    );
+    const update = { ...resp, parsedData: null };
+    if (resp.parsedData) {
+      update.parsedData = {
+        ...resp.parsedData,
+        data: resp.parsedData.data.map(
+          (e) => __privateGet(this, _dataItemMappingTools).mapEngineToDataItem(e)
+        )
+      };
+    }
+    return update;
+  }
+  /**
+   * Query a specific DataConnector for a data model using the dynamic context as parameter.
+   * @param connectorId unique id of the data connector
+   * @param context context that will be available in the connector script.
+   * @returns DataModel or DataSourceVariableDataModel
+   */
+  async getModel(connectorId, context = {}) {
+    const res = await __privateGet(this, _editorAPI);
+    return res.dataConnectorGetModel(connectorId, JSON.stringify(context)).then((result) => EditorResponseData.getEditorResponseData(result));
+  }
+}
+_editorAPI = new WeakMap();
+_dataItemMappingTools = new WeakMap();
+exports.DataConnectorController = DataConnectorController;
+//# sourceMappingURL=DataConnectorController.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"DataConnectorController.cjs.js","sources":["../../../src/controllers/DataConnectorController.ts"],"sourcesContent":["import { EditorAPI, EditorResponse } from '../types/CommonTypes';\nimport { ConnectorConfigOptions, MetaData } from '../types/ConnectorTypes';\nimport {\n    BidirectionalDataPage,\n    BidirectionalDataPageItem,\n    BidirectionalNavigation,\n    BidirectionalPageConfig,\n    DataConnectorCapabilities,\n    DataModel,\n    DataPage,\n    EditorDataPage,\n    OneDirectionalNavigation,\n    PageConfig,\n    PageItemOptions,\n} from '../types/DataConnectorTypes';\nimport { DataItemMappingTools, EngineDataItem } from '../utils/DataItemMappingTools';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n\n/**\n * The DataConnectorController is responsible for all communication regarding Data connectors.\n * Methods inside this controller can be called by `window.SDK.dataConnector.{method-name}`\n *\n * The way GraFx Studio handles different sources of Data is called 'DataConnector'.\n * A DataConnector is an implementation of a set of capabilities we need\n * to interact with a certain Data 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 Data 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 DataConnectorController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n    #dataItemMappingTools: DataItemMappingTools;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI, dataItemMappingTools: DataItemMappingTools) {\n        this.#editorAPI = editorAPI;\n        this.#dataItemMappingTools = dataItemMappingTools;\n    }\n\n    /**\n     * Query a specific DataConnector for data using both specific PageConfig and the dynamic\n     * context as parameters.\n     * @param connectorId unique id of the Data connector\n     * @param config bidirectional page configuration — provides `previousPageToken` / `continuationToken` navigation\n     * @param context context that will be available in the connector script.\n     * @returns a BidirectionalDataPage with an array of data objects and bidirectional navigation tokens\n     */\n    getPage(\n        connectorId: string,\n        config: BidirectionalPageConfig,\n        context?: MetaData,\n    ): Promise<EditorResponse<BidirectionalDataPage>>;\n\n    /**\n     * Query a specific DataConnector for data using both specific PageConfig and the dynamic\n     * context as parameters.\n     * @param connectorId unique id of the Data connector\n     * @param config one-directional page configuration — provides a `continuationToken` for forward navigation\n     * @param context context that will be available in the connector script.\n     * @returns a DataPage with an array of data objects and a continuation token\n     */\n    getPage(connectorId: string, config: PageConfig, context?: MetaData): Promise<EditorResponse<DataPage>>;\n\n    async getPage(\n        connectorId: string,\n        config: PageConfig | BidirectionalPageConfig,\n        context: MetaData = {},\n    ): Promise<EditorResponse<DataPage | BidirectionalDataPage>> {\n        const { previousPageToken, continuationToken } = config as BidirectionalPageConfig;\n        if (previousPageToken != null && continuationToken != null) {\n            throw new Error(\n                'Invalid page config: \"previousPageToken\" and \"continuationToken\" are mutually exclusive. Provide only one to indicate navigation direction.',\n            );\n        }\n\n        const res = await this.#editorAPI;\n        const result = await res.dataConnectorGetPage(connectorId, JSON.stringify(config), JSON.stringify(context));\n        const resp =\n            getEditorResponseData<EditorDataPage<EngineDataItem, OneDirectionalNavigation | BidirectionalNavigation>>(\n                result,\n            );\n        const update: EditorResponse<DataPage | BidirectionalDataPage> = { ...resp, parsedData: null };\n        if (resp.parsedData) {\n            update.parsedData = {\n                ...resp.parsedData,\n                data: resp.parsedData.data.map((e: EngineDataItem) =>\n                    this.#dataItemMappingTools.mapEngineToDataItem(e),\n                ),\n            } as DataPage | BidirectionalDataPage;\n        }\n        return update;\n    }\n\n    /**\n     * @experimental This method is still experimental and might change in future releases.\n     *\n     * Retrieve a single data item by its identifier from a specific DataConnector.\n     * Only available for connectors that set `DataConnectorCapabilities.dataSourceVariable = true`,\n     * which implies support for both bidirectional page navigation and item-level lookup.\n     * pageOptions (sorting, limit) are used by the connector to build navigation tokens.\n     * @param connectorId unique id of the Data connector\n     * @param id identifier of the item to retrieve\n     * @param pageOptions sorting and limit used to build previousPageToken/continuationToken\n     * @param context context that will be available in the connector script.\n     * @returns a BidirectionalDataPageItem containing the data item and bidirectional navigation tokens\n     */\n    getPageItemById = async (\n        connectorId: string,\n        id: string,\n        pageOptions: PageItemOptions,\n        context: MetaData = {},\n    ): Promise<EditorResponse<BidirectionalDataPageItem>> => {\n        const res = await this.#editorAPI;\n        const result = await res.dataConnectorGetPageItemById(\n            connectorId,\n            id,\n            JSON.stringify(pageOptions),\n            JSON.stringify(context),\n        );\n        const resp = getEditorResponseData<{ data: EngineDataItem } & BidirectionalNavigation>(result);\n        const update: EditorResponse<BidirectionalDataPageItem> = { ...resp, parsedData: null };\n        if (resp.parsedData) {\n            update.parsedData = {\n                ...resp.parsedData,\n                data: this.#dataItemMappingTools.mapEngineToDataItem(resp.parsedData.data),\n            };\n        }\n        return update;\n    };\n\n    /**\n     * Query a specific DataConnector for a data model using the dynamic context as parameter.\n     * @param connectorId unique id of the data connector\n     * @param context context that will be available in the connector script.\n     * @returns DataModel or DataSourceVariableDataModel\n     */\n    async getModel<R extends DataModel = DataModel>(\n        connectorId: string,\n        context: MetaData = {},\n    ): Promise<EditorResponse<R>> {\n        const res = await this.#editorAPI;\n        return res\n            .dataConnectorGetModel(connectorId, JSON.stringify(context))\n            .then((result) => getEditorResponseData<R>(result));\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 connectorId unique id of the data connector\n     * @returns connector mappings\n     */\n    getConfigurationOptions = async (connectorId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .dataConnectorGetConfigurationOptions(connectorId)\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 connectorId unique id of the Data connector\n     * @returns DataConnectorCapabilities\n     */\n    getCapabilities = async (connectorId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .dataConnectorGetCapabilities(connectorId)\n            .then((result) => getEditorResponseData<DataConnectorCapabilities>(result));\n    };\n}\n"],"names":["getEditorResponseData"],"mappings":";;;;;;;;;;;AA+BO,MAAM,wBAAwB;AAAA;AAAA;AAAA;AAAA,EAUjC,YAAY,WAAsB,sBAA4C;AAN9E;AAAA;AAAA;AAAA;AACA;AA6EA,SAAA,kBAAkB,OACd,aACA,IACA,aACA,UAAoB,OACiC;AACrD,YAAM,MAAM,MAAM,mBAAK;AACvB,YAAM,SAAS,MAAM,IAAI;AAAA,QACrB;AAAA,QACA;AAAA,QACA,KAAK,UAAU,WAAW;AAAA,QAC1B,KAAK,UAAU,OAAO;AAAA,MAAA;AAE1B,YAAM,OAAOA,mBAAAA,sBAA0E,MAAM;AAC7F,YAAM,SAAoD,EAAE,GAAG,MAAM,YAAY,KAAA;AACjF,UAAI,KAAK,YAAY;AACjB,eAAO,aAAa;AAAA,UAChB,GAAG,KAAK;AAAA,UACR,MAAM,mBAAK,uBAAsB,oBAAoB,KAAK,WAAW,IAAI;AAAA,QAAA;AAAA,MAEjF;AACA,aAAO;AAAA,IACX;AAyBA,SAAA,0BAA0B,OAAO,gBAAwB;AACrD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,qCAAqC,WAAW,EAChD,KAAK,CAAC,WAAWA,yCAA8C,MAAM,CAAC;AAAA,IAC/E;AAQA,SAAA,kBAAkB,OAAO,gBAAwB;AAC7C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,6BAA6B,WAAW,EACxC,KAAK,CAAC,WAAWA,yCAAiD,MAAM,CAAC;AAAA,IAClF;AAxII,uBAAK,YAAa;AAClB,uBAAK,uBAAwB;AAAA,EACjC;AAAA,EA0BA,MAAM,QACF,aACA,QACA,UAAoB,CAAA,GACqC;AACzD,UAAM,EAAE,mBAAmB,kBAAA,IAAsB;AACjD,QAAI,qBAAqB,QAAQ,qBAAqB,MAAM;AACxD,YAAM,IAAI;AAAA,QACN;AAAA,MAAA;AAAA,IAER;AAEA,UAAM,MAAM,MAAM,mBAAK;AACvB,UAAM,SAAS,MAAM,IAAI,qBAAqB,aAAa,KAAK,UAAU,MAAM,GAAG,KAAK,UAAU,OAAO,CAAC;AAC1G,UAAM,OACFA,mBAAAA;AAAAA,MACI;AAAA,IAAA;AAER,UAAM,SAA2D,EAAE,GAAG,MAAM,YAAY,KAAA;AACxF,QAAI,KAAK,YAAY;AACjB,aAAO,aAAa;AAAA,QAChB,GAAG,KAAK;AAAA,QACR,MAAM,KAAK,WAAW,KAAK;AAAA,UAAI,CAAC,MAC5B,mBAAK,uBAAsB,oBAAoB,CAAC;AAAA,QAAA;AAAA,MACpD;AAAA,IAER;AACA,WAAO;AAAA,EACX;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EA6CA,MAAM,SACF,aACA,UAAoB,IACM;AAC1B,UAAM,MAAM,MAAM,mBAAK;AACvB,WAAO,IACF,sBAAsB,aAAa,KAAK,UAAU,OAAO,CAAC,EAC1D,KAAK,CAAC,WAAWA,mBAAAA,sBAAyB,MAAM,CAAC;AAAA,EAC1D;AA4BJ;AAhJI;AACA;;"}