@chili-publish/studio-sdk 1.44.0 → 1.45.0

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

@@ -8,7 +8,6 @@ var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot
 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;
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const BrandKitAdapter = require("../utils/BrandKitAdapter.cjs.js");
 const EditorResponseData = require("../utils/EditorResponseData.cjs.js");
 class BrandKitController {
   /**
@@ -41,16 +40,7 @@ class BrandKitController {
     };
     this.get = async () => {
       const res = await __privateGet(this, _editorAPI);
-      const result = await res.getBrandKit();
-      const response = EditorResponseData.getEditorResponseData(result);
-      const engineData = response.parsedData;
-      if (engineData == null) {
-        throw new Error("Brand kit response has no data");
-      }
-      return {
-        ...response,
-        parsedData: BrandKitAdapter.engineBrandKitToStudioBrandKit(engineData)
-      };
+      return res.getBrandKit().then((result) => EditorResponseData.getEditorResponseData(result));
     };
     this.getAllMedia = async () => {
       const res = await __privateGet(this, _editorAPI);
@@ -72,52 +62,13 @@ class BrandKitController {
       const res = await __privateGet(this, _editorAPI);
       return res.removeBrandKitMedia(name).then((result) => EditorResponseData.getEditorResponseData(result));
     };
-    this.remove = async () => {
-      const colors = await this.colorStyleController.getAll();
-      const colorsList = colors.parsedData || [];
-      const gradients = await this.gradientStyleController.getAll();
-      const gradientsList = gradients.parsedData || [];
-      const paragraphStyles = await this.paragraphStyleController.getAll();
-      const paragraphStylesList = paragraphStyles.parsedData || [];
-      const characterStyles = await this.characterStyleController.getAll();
-      const characterStylesList = characterStyles.parsedData || [];
-      const fonts = await this.fontController.getFontFamilies();
-      const fontsList = fonts.parsedData || [];
-      const media = await this.getAllMedia();
-      const mediaList = media.parsedData || [];
-      await this.undoManagerController.record("brandKit.remove", async (sdk2) => {
-        for (const color of colorsList) {
-          await sdk2.colorStyle.remove(color.id);
-        }
-        for (const gradient of gradientsList) {
-          await sdk2.gradientStyle.remove(gradient.id);
-        }
-        for (const style of paragraphStylesList) {
-          await sdk2.paragraphStyle.remove(style.id);
-        }
-        for (const style of characterStylesList) {
-          await sdk2.characterStyle.remove(style.id);
-        }
-        for (const font of fontsList) {
-          await sdk2.font.removeFontFamily(font.id);
-        }
-        for (const media2 of mediaList) {
-          await this.removeMedia(media2.name);
-        }
-      });
-    };
-    this.set = async (studioBrandKit) => {
-      const res = await __privateGet(this, _editorAPI);
-      const result = await res.setBrandKit(JSON.stringify(studioBrandKit.brandKit));
-      const response = EditorResponseData.getEditorResponseData(result);
-      const engineData = response.parsedData;
-      if (engineData == null) {
-        throw new Error("Brand kit set response has no data");
-      }
-      return {
-        ...response,
-        parsedData: BrandKitAdapter.engineBrandKitToBrandKitInternal(engineData)
-      };
+    this.set = async (apiBrandKit) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setBrandKit(JSON.stringify(apiBrandKit)).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
+    this.sync = async (apiBrandKit) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.syncBrandKit(JSON.stringify(apiBrandKit)).then((result) => EditorResponseData.getEditorResponseData(result));
     };
     this.isAutoSync = async () => {
       const res = await __privateGet(this, _editorAPI);
@@ -127,14 +78,12 @@ class BrandKitController {
       const res = await __privateGet(this, _editorAPI);
       return res.enableBrandKitAutoSync(enableAutoSync).then((result) => EditorResponseData.getEditorResponseData(result));
     };
+    this.switchTheme = async (themeName) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.switchBrandKitTheme(themeName).then((result) => EditorResponseData.getEditorResponseData(result));
+    };
     __privateSet(this, _editorAPI, editorAPI);
-    this.colorStyleController = sdk.colorStyle;
-    this.gradientStyleController = sdk.gradientStyle;
-    this.fontController = sdk.font;
-    this.mediaController = sdk.mediaConnector;
-    this.paragraphStyleController = sdk.paragraphStyle;
-    this.characterStyleController = sdk.characterStyle;
-    this.undoManagerController = sdk.undoManager;
+    this.sdk = sdk;
   }
 }
 _editorAPI = new WeakMap();

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

@@ -1 +1 @@
-{"version":3,"file":"BrandKitController.cjs.js","sources":["../../../src/controllers/BrandKitController.ts"],"sourcesContent":["import SDK from '..';\nimport {\n    BrandKitMedia,\n    EngineBrandKit,\n    StudioBrandKit,\n} from '../types/BrandKitTypes';\nimport { EditorAPI, Id } from '../types/CommonTypes';\nimport { engineBrandKitToBrandKitInternal, engineBrandKitToStudioBrandKit } from '../utils/BrandKitAdapter';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\nimport { CharacterStyleController } from './CharacterStyleController';\nimport { ColorStyleController } from './ColorStyleController';\nimport { FontController } from './FontController';\nimport { GradientStyleController } from './GradientStyleController';\nimport { MediaConnectorController } from './MediaConnectorController';\nimport { ParagraphStyleController } from './ParagraphStyleController';\nimport { UndoManagerController } from './UndoManagerController';\n\n/**\n * The BrandKitController is responsible for all communication regarding Brand Kits.\n * Methods inside this controller can be called by `window.SDK.brandKit.{method-name}`\n */\n\nexport class BrandKitController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI, sdk: SDK) {\n        this.#editorAPI = editorAPI;\n        this.colorStyleController = sdk.colorStyle;\n        this.gradientStyleController = sdk.gradientStyle;\n        this.fontController = sdk.font;\n        this.mediaController = sdk.mediaConnector;\n        this.paragraphStyleController = sdk.paragraphStyle;\n        this.characterStyleController = sdk.characterStyle;\n\n        this.undoManagerController = sdk.undoManager;\n    }\n\n    private colorStyleController: ColorStyleController;\n\n    private gradientStyleController: GradientStyleController;\n\n    private fontController: FontController;\n\n    private mediaController: MediaConnectorController;\n\n    private paragraphStyleController: ParagraphStyleController;\n\n    private characterStyleController: CharacterStyleController;\n\n    private undoManagerController: UndoManagerController;\n\n    /**\n     * This method returns the current brand kit id.\n     * @returns current brand kit id\n     */\n    getId = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitId().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit version.\n     * @returns current brand kit version\n     */\n    getVersion = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitVersion().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit name.\n     * @returns current brand kit name\n     */\n    getName = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitName().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method renames the brand kit.\n     * @param newName - The new name for the brand kit\n     * @returns\n     */\n    rename = async (newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKit(newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method updates both the brand kit id and version.\n     * @param id - The new brand kit id\n     * @param version - The new brand kit version\n     * @returns\n     */\n    updateIdAndVersion = async (id: string, version: string) => {\n        const res = await this.#editorAPI;\n        return res.updateBrandKitIdAndVersion(id, version).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method returns the local brandkit\n     * @returns brandkit with all assigned resources\n     */\n    get = async () => {\n        const res = await this.#editorAPI;\n        const result = await res.getBrandKit();\n        const response = getEditorResponseData<EngineBrandKit>(result);\n        const engineData = response.parsedData;\n        if (engineData == null) {\n            throw new Error('Brand kit response has no data');\n        }\n        return {\n            ...response,\n            parsedData: engineBrandKitToStudioBrandKit(engineData),\n        };\n    };\n\n    /**\n     * This method returns all media items in the brand kit\n     * @returns list of media items in the brand kit\n     */\n    getAllMedia = async () => {\n        const res = await this.#editorAPI;\n        return res.getAllBrandKitMedia().then((result) => getEditorResponseData<BrandKitMedia[]>(result));\n    };\n\n    /**\n     * This method adds a media item to the brand kit\n     * @param name - The name of the media item\n     * @param remoteConnectorId - The remote connector ID\n     * @param assetId - The asset ID of the media item\n     * @returns\n     */\n    addMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .addBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * This method updates an existing media item in the brand kit\n     * @param name - The name of the media item to update\n     * @param remoteConnectorId - The new remote connector ID\n     * @param assetId - The new asset ID\n     * @returns\n     */\n    updateMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .updateBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method renames an existing media item in the brand kit\n     * @param name - The name of the media item to rename\n     * @param newName - The new name for the media item\n     * @returns\n     */\n    renameMedia = async (name: string, newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKitMedia(name, newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method removes a media item from the brand kit\n     * @param name - The name of the media item to remove\n     * @returns\n     */\n    removeMedia = async (name: string) => {\n        const res = await this.#editorAPI;\n        return res.removeBrandKitMedia(name).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method removes a brand kit and all related resources assigned to it\n     * @returns\n     */\n    remove = async () => {\n        const colors = await this.colorStyleController.getAll();\n        const colorsList = colors.parsedData || [];\n\n        const gradients = await this.gradientStyleController.getAll();\n        const gradientsList = gradients.parsedData || [];\n\n        const paragraphStyles = await this.paragraphStyleController.getAll();\n        const paragraphStylesList = paragraphStyles.parsedData || [];\n\n        const characterStyles = await this.characterStyleController.getAll();\n        const characterStylesList = characterStyles.parsedData || [];\n\n        const fonts = await this.fontController.getFontFamilies();\n        const fontsList = fonts.parsedData || [];\n\n        const media = await this.getAllMedia();\n        const mediaList = media.parsedData || [];\n\n        await this.undoManagerController.record('brandKit.remove', async (sdk) => {\n            for (const color of colorsList) {\n                await sdk.colorStyle.remove(color.id);\n            }\n            for (const gradient of gradientsList) {\n                await sdk.gradientStyle.remove(gradient.id);\n            }\n            for (const style of paragraphStylesList) {\n                await sdk.paragraphStyle.remove(style.id);\n            }\n            for (const style of characterStylesList) {\n                await sdk.characterStyle.remove(style.id);\n            }\n            for (const font of fontsList) {\n                await sdk.font.removeFontFamily(font.id);\n            }\n            for (const media of mediaList) {\n                await this.removeMedia(media.name);\n            }\n        });\n    };\n\n    /**\n     * @experimental This method updates a brand kit and all related resources assigned to it\n     * @param studioBrandKit the content of the brand kit\n     * @returns\n     */\n    set = async (studioBrandKit: StudioBrandKit) => {\n        const res = await this.#editorAPI;\n        const result = await res.setBrandKit(JSON.stringify(studioBrandKit.brandKit));\n        const response = getEditorResponseData<EngineBrandKit>(result);\n        const engineData = response.parsedData;\n        if (engineData == null) {\n            throw new Error('Brand kit set response has no data');\n        }\n        return {\n            ...response,\n            parsedData: engineBrandKitToBrandKitInternal(engineData),\n        };\n    };\n\n\n    /**\n     * This method returns the value indicating whether the brand kit auto-sync is enabled or not\n     * It is up to the integrator to implement this auto-sync functionality, this method only is an indication if it should be done or not.\n     \n     * @returns boolean indicating sync status\n     */\n    isAutoSync = async () => {\n        const res = await this.#editorAPI;\n        return res.isBrandKitAutoSync().then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * This method enables or disables brand kit auto-sync\n     * @param enableAutoSync boolean indicating auto-sync status\n     * @returns boolean indicating the result of the operation\n     */\n    enableAutoSync = async (enableAutoSync: boolean) => {\n        const res = await this.#editorAPI;\n        return res.enableBrandKitAutoSync(enableAutoSync).then((result) => getEditorResponseData<boolean>(result));\n    };\n}\n"],"names":["getEditorResponseData","engineBrandKitToStudioBrandKit","sdk","media","engineBrandKitToBrandKitInternal"],"mappings":";;;;;;;;;;;;AAsBO,MAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA,EAS5B,YAAY,WAAsB,KAAU;AAL5C;AAAA;AAAA;AAAA;AAmCA,SAAA,QAAQ,YAAY;AAChB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,KAAK,CAAC,WAAWA,mBAAAA,sBAA8B,MAAM,CAAC;AAAA,IACrF;AAMA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAWA,mBAAAA,sBAA8B,MAAM,CAAC;AAAA,IAC1F;AAMA,SAAA,UAAU,YAAY;AAClB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,KAAK,CAAC,WAAWA,mBAAAA,sBAA8B,MAAM,CAAC;AAAA,IACvF;AAOA,SAAA,SAAS,OAAO,YAAoB;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,eAAe,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC3F;AAQA,SAAA,qBAAqB,OAAO,IAAY,YAAoB;AACxD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,2BAA2B,IAAI,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC3G;AAMA,SAAA,MAAM,YAAY;AACd,YAAM,MAAM,MAAM,mBAAK;AACvB,YAAM,SAAS,MAAM,IAAI,YAAA;AACzB,YAAM,WAAWA,mBAAAA,sBAAsC,MAAM;AAC7D,YAAM,aAAa,SAAS;AAC5B,UAAI,cAAc,MAAM;AACpB,cAAM,IAAI,MAAM,gCAAgC;AAAA,MACpD;AACA,aAAO;AAAA,QACH,GAAG;AAAA,QACH,YAAYC,gBAAAA,+BAA+B,UAAU;AAAA,MAAA;AAAA,IAE7D;AAMA,SAAA,cAAc,YAAY;AACtB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,KAAK,CAAC,WAAWD,mBAAAA,sBAAuC,MAAM,CAAC;AAAA,IACpG;AASA,SAAA,WAAW,OAAO,MAAc,mBAAuB,YAAoB;AACvE,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,iBAAiB,MAAM,mBAAmB,OAAO,EACjD,KAAK,CAAC,WAAWA,mBAAAA,sBAA0B,MAAM,CAAC;AAAA,IAC3D;AASA,SAAA,cAAc,OAAO,MAAc,mBAAuB,YAAoB;AAC1E,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,oBAAoB,MAAM,mBAAmB,OAAO,EACpD,KAAK,CAAC,WAAWA,mBAAAA,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAQA,SAAA,cAAc,OAAO,MAAc,YAAoB;AACnD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,MAAM,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACtG;AAOA,SAAA,cAAc,OAAO,SAAiB;AAClC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,IAAI,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC7F;AAMA,SAAA,SAAS,YAAY;AACjB,YAAM,SAAS,MAAM,KAAK,qBAAqB,OAAA;AAC/C,YAAM,aAAa,OAAO,cAAc,CAAA;AAExC,YAAM,YAAY,MAAM,KAAK,wBAAwB,OAAA;AACrD,YAAM,gBAAgB,UAAU,cAAc,CAAA;AAE9C,YAAM,kBAAkB,MAAM,KAAK,yBAAyB,OAAA;AAC5D,YAAM,sBAAsB,gBAAgB,cAAc,CAAA;AAE1D,YAAM,kBAAkB,MAAM,KAAK,yBAAyB,OAAA;AAC5D,YAAM,sBAAsB,gBAAgB,cAAc,CAAA;AAE1D,YAAM,QAAQ,MAAM,KAAK,eAAe,gBAAA;AACxC,YAAM,YAAY,MAAM,cAAc,CAAA;AAEtC,YAAM,QAAQ,MAAM,KAAK,YAAA;AACzB,YAAM,YAAY,MAAM,cAAc,CAAA;AAEtC,YAAM,KAAK,sBAAsB,OAAO,mBAAmB,OAAOE,SAAQ;AACtE,mBAAW,SAAS,YAAY;AAC5B,gBAAMA,KAAI,WAAW,OAAO,MAAM,EAAE;AAAA,QACxC;AACA,mBAAW,YAAY,eAAe;AAClC,gBAAMA,KAAI,cAAc,OAAO,SAAS,EAAE;AAAA,QAC9C;AACA,mBAAW,SAAS,qBAAqB;AACrC,gBAAMA,KAAI,eAAe,OAAO,MAAM,EAAE;AAAA,QAC5C;AACA,mBAAW,SAAS,qBAAqB;AACrC,gBAAMA,KAAI,eAAe,OAAO,MAAM,EAAE;AAAA,QAC5C;AACA,mBAAW,QAAQ,WAAW;AAC1B,gBAAMA,KAAI,KAAK,iBAAiB,KAAK,EAAE;AAAA,QAC3C;AACA,mBAAWC,UAAS,WAAW;AAC3B,gBAAM,KAAK,YAAYA,OAAM,IAAI;AAAA,QACrC;AAAA,MACJ,CAAC;AAAA,IACL;AAOA,SAAA,MAAM,OAAO,mBAAmC;AAC5C,YAAM,MAAM,MAAM,mBAAK;AACvB,YAAM,SAAS,MAAM,IAAI,YAAY,KAAK,UAAU,eAAe,QAAQ,CAAC;AAC5E,YAAM,WAAWH,mBAAAA,sBAAsC,MAAM;AAC7D,YAAM,aAAa,SAAS;AAC5B,UAAI,cAAc,MAAM;AACpB,cAAM,IAAI,MAAM,oCAAoC;AAAA,MACxD;AACA,aAAO;AAAA,QACH,GAAG;AAAA,QACH,YAAYI,gBAAAA,iCAAiC,UAAU;AAAA,MAAA;AAAA,IAE/D;AASA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAWJ,mBAAAA,sBAA+B,MAAM,CAAC;AAAA,IAC3F;AAOA,SAAA,iBAAiB,OAAO,mBAA4B;AAChD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,uBAAuB,cAAc,EAAE,KAAK,CAAC,WAAWA,yCAA+B,MAAM,CAAC;AAAA,IAC7G;AAzOI,uBAAK,YAAa;AAClB,SAAK,uBAAuB,IAAI;AAChC,SAAK,0BAA0B,IAAI;AACnC,SAAK,iBAAiB,IAAI;AAC1B,SAAK,kBAAkB,IAAI;AAC3B,SAAK,2BAA2B,IAAI;AACpC,SAAK,2BAA2B,IAAI;AAEpC,SAAK,wBAAwB,IAAI;AAAA,EACrC;AAiOJ;AAhPI;;"}
+{"version":3,"file":"BrandKitController.cjs.js","sources":["../../../src/controllers/BrandKitController.ts"],"sourcesContent":["import SDK from '..';\nimport { BrandKitMedia, BrandKit, APIBrandKit } from '../types/BrandKitTypes';\nimport { EditorAPI, Id } from '../types/CommonTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n\n/**\n * The BrandKitController is responsible for all communication regarding Brand Kits.\n * Methods inside this controller can be called by `window.SDK.brandKit.{method-name}`\n */\n\nexport class BrandKitController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    private sdk: SDK;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI, sdk: SDK) {\n        this.#editorAPI = editorAPI;\n        this.sdk = sdk;\n    }\n\n    /**\n     * This method returns the current brand kit id.\n     * @returns current brand kit id\n     */\n    getId = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitId().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit version.\n     * @returns current brand kit version\n     */\n    getVersion = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitVersion().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit name.\n     * @returns current brand kit name\n     */\n    getName = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitName().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method renames the brand kit.\n     * @param newName - The new name for the brand kit\n     * @returns\n     */\n    rename = async (newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKit(newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method updates both the brand kit id and version.\n     * @param id - The new brand kit id\n     * @param version - The new brand kit version\n     * @returns\n     */\n    updateIdAndVersion = async (id: string, version: string) => {\n        const res = await this.#editorAPI;\n        return res.updateBrandKitIdAndVersion(id, version).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method returns the local brand kit\n     * @returns brand kit with all assigned resources\n     */\n    get = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKit().then((result) => getEditorResponseData<BrandKit>(result));\n    };\n\n    /**\n     * This method returns all media items in the brand kit\n     * @returns list of media items in the brand kit\n     */\n    getAllMedia = async () => {\n        const res = await this.#editorAPI;\n        return res.getAllBrandKitMedia().then((result) => getEditorResponseData<BrandKitMedia[]>(result));\n    };\n\n    /**\n     * This method adds a media item to the brand kit\n     * @param name - The name of the media item\n     * @param remoteConnectorId - The remote connector ID\n     * @param assetId - The asset ID of the media item\n     * @returns\n     */\n    addMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .addBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * This method updates an existing media item in the brand kit\n     * @param name - The name of the media item to update\n     * @param remoteConnectorId - The new remote connector ID\n     * @param assetId - The new asset ID\n     * @returns\n     */\n    updateMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .updateBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method renames an existing media item in the brand kit\n     * @param name - The name of the media item to rename\n     * @param newName - The new name for the media item\n     * @returns\n     */\n    renameMedia = async (name: string, newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKitMedia(name, newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method removes a media item from the brand kit\n     * @param name - The name of the media item to remove\n     * @returns\n     */\n    removeMedia = async (name: string) => {\n        const res = await this.#editorAPI;\n        return res.removeBrandKitMedia(name).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method replaces the full brand kit and all related resources assigned to it\n     * @param apiBrandKit the brand kit from the environment api\n     * @returns the local brand kit\n     */\n    set = async (apiBrandKit: APIBrandKit) => {\n        const res = await this.#editorAPI;\n        return res.setBrandKit(JSON.stringify(apiBrandKit)).then((result) => getEditorResponseData<BrandKit>(result));\n    };\n\n    /**\n     * @experimental This method syncs brand kit items and structure in place without replacing the existing brand kit\n     * @param apiBrandKit the brand kit from the environment api\n     * @returns boolean indicating whether the brand kit changed after the sync attempt\n     */\n    sync = async (apiBrandKit: APIBrandKit) => {\n        const res = await this.#editorAPI;\n        return res.syncBrandKit(JSON.stringify(apiBrandKit)).then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * This method returns the value indicating whether the brand kit auto-sync is enabled or not\n     * It is up to the integrator to implement this auto-sync functionality, this method only is an indication if it should be done or not.\n     \n     * @returns boolean indicating sync status\n     */\n    isAutoSync = async () => {\n        const res = await this.#editorAPI;\n        return res.isBrandKitAutoSync().then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * This method enables or disables brand kit auto-sync\n     * @param enableAutoSync boolean indicating auto-sync status\n     * @returns boolean indicating the result of the operation\n     */\n    enableAutoSync = async (enableAutoSync: boolean) => {\n        const res = await this.#editorAPI;\n        return res.enableBrandKitAutoSync(enableAutoSync).then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * Switches the active brand kit theme.\n     * @param themeName - Theme name\n     * @returns\n     */\n    switchTheme = async (themeName: string) => {\n        const res = await this.#editorAPI;\n        return res.switchBrandKitTheme(themeName).then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":["getEditorResponseData"],"mappings":";;;;;;;;;;;AAUO,MAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA,EAc5B,YAAY,WAAsB,KAAU;AAV5C;AAAA;AAAA;AAAA;AAmBA,SAAA,QAAQ,YAAY;AAChB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,KAAK,CAAC,WAAWA,mBAAAA,sBAA8B,MAAM,CAAC;AAAA,IACrF;AAMA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAWA,mBAAAA,sBAA8B,MAAM,CAAC;AAAA,IAC1F;AAMA,SAAA,UAAU,YAAY;AAClB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,KAAK,CAAC,WAAWA,mBAAAA,sBAA8B,MAAM,CAAC;AAAA,IACvF;AAOA,SAAA,SAAS,OAAO,YAAoB;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,eAAe,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC3F;AAQA,SAAA,qBAAqB,OAAO,IAAY,YAAoB;AACxD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,2BAA2B,IAAI,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC3G;AAMA,SAAA,MAAM,YAAY;AACd,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,cAAc,KAAK,CAAC,WAAWA,mBAAAA,sBAAgC,MAAM,CAAC;AAAA,IACrF;AAMA,SAAA,cAAc,YAAY;AACtB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,KAAK,CAAC,WAAWA,mBAAAA,sBAAuC,MAAM,CAAC;AAAA,IACpG;AASA,SAAA,WAAW,OAAO,MAAc,mBAAuB,YAAoB;AACvE,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,iBAAiB,MAAM,mBAAmB,OAAO,EACjD,KAAK,CAAC,WAAWA,mBAAAA,sBAA0B,MAAM,CAAC;AAAA,IAC3D;AASA,SAAA,cAAc,OAAO,MAAc,mBAAuB,YAAoB;AAC1E,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,oBAAoB,MAAM,mBAAmB,OAAO,EACpD,KAAK,CAAC,WAAWA,mBAAAA,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAQA,SAAA,cAAc,OAAO,MAAc,YAAoB;AACnD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,MAAM,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IACtG;AAOA,SAAA,cAAc,OAAO,SAAiB;AAClC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,IAAI,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC7F;AAOA,SAAA,MAAM,OAAO,gBAA6B;AACtC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,YAAY,KAAK,UAAU,WAAW,CAAC,EAAE,KAAK,CAAC,WAAWA,mBAAAA,sBAAgC,MAAM,CAAC;AAAA,IAChH;AAOA,SAAA,OAAO,OAAO,gBAA6B;AACvC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,aAAa,KAAK,UAAU,WAAW,CAAC,EAAE,KAAK,CAAC,WAAWA,mBAAAA,sBAA+B,MAAM,CAAC;AAAA,IAChH;AAQA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAWA,mBAAAA,sBAA+B,MAAM,CAAC;AAAA,IAC3F;AAOA,SAAA,iBAAiB,OAAO,mBAA4B;AAChD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,uBAAuB,cAAc,EAAE,KAAK,CAAC,WAAWA,yCAA+B,MAAM,CAAC;AAAA,IAC7G;AAOA,SAAA,cAAc,OAAO,cAAsB;AACvC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,SAAS,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAClG;AAxKI,uBAAK,YAAa;AAClB,SAAK,MAAM;AAAA,EACf;AAuKJ;AApLI;;"}

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

@@ -1,5 +1,5 @@
 import { default as SDK } from '..';
-import { BrandKitMedia, StudioBrandKit } from '../types/BrandKitTypes';
+import { BrandKitMedia, BrandKit, APIBrandKit } from '../types/BrandKitTypes';
 import { EditorAPI, Id } from '../types/CommonTypes';
 /**
  * The BrandKitController is responsible for all communication regarding Brand Kits.
@@ -7,17 +7,14 @@ import { EditorAPI, Id } from '../types/CommonTypes';
  */
 export declare class BrandKitController {
     #private;
+    /**
+     * @ignore
+     */
+    private sdk;
     /**
      * @ignore
      */
     constructor(editorAPI: EditorAPI, sdk: SDK);
-    private colorStyleController;
-    private gradientStyleController;
-    private fontController;
-    private mediaController;
-    private paragraphStyleController;
-    private characterStyleController;
-    private undoManagerController;
     /**
      * This method returns the current brand kit id.
      * @returns current brand kit id
@@ -47,16 +44,10 @@ export declare class BrandKitController {
      */
     updateIdAndVersion: (id: string, version: string) => Promise<import('..').EditorResponse<null>>;
     /**
-     * @experimental This method returns the local brandkit
-     * @returns brandkit with all assigned resources
+     * @experimental This method returns the local brand kit
+     * @returns brand kit with all assigned resources
      */
-    get: () => Promise<{
-        parsedData: StudioBrandKit;
-        success: boolean;
-        status: number;
-        data?: string | null;
-        error?: import('../types/CommonTypes').EditorResponseError | null;
-    }>;
+    get: () => Promise<import('..').EditorResponse<BrandKit>>;
     /**
      * This method returns all media items in the brand kit
      * @returns list of media items in the brand kit
@@ -92,22 +83,17 @@ export declare class BrandKitController {
      */
     removeMedia: (name: string) => Promise<import('..').EditorResponse<null>>;
     /**
-     * @experimental This method removes a brand kit and all related resources assigned to it
-     * @returns
+     * @experimental This method replaces the full brand kit and all related resources assigned to it
+     * @param apiBrandKit the brand kit from the environment api
+     * @returns the local brand kit
      */
-    remove: () => Promise<void>;
+    set: (apiBrandKit: APIBrandKit) => Promise<import('..').EditorResponse<BrandKit>>;
     /**
-     * @experimental This method updates a brand kit and all related resources assigned to it
-     * @param studioBrandKit the content of the brand kit
-     * @returns
+     * @experimental This method syncs brand kit items and structure in place without replacing the existing brand kit
+     * @param apiBrandKit the brand kit from the environment api
+     * @returns boolean indicating whether the brand kit changed after the sync attempt
      */
-    set: (studioBrandKit: StudioBrandKit) => Promise<{
-        parsedData: import('../types/BrandKitTypes').BrandKitInternal;
-        success: boolean;
-        status: number;
-        data?: string | null;
-        error?: import('../types/CommonTypes').EditorResponseError | null;
-    }>;
+    sync: (apiBrandKit: APIBrandKit) => Promise<import('..').EditorResponse<boolean>>;
     /**
      * This method returns the value indicating whether the brand kit auto-sync is enabled or not
      * It is up to the integrator to implement this auto-sync functionality, this method only is an indication if it should be done or not.
@@ -121,4 +107,10 @@ export declare class BrandKitController {
      * @returns boolean indicating the result of the operation
      */
     enableAutoSync: (enableAutoSync: boolean) => Promise<import('..').EditorResponse<boolean>>;
+    /**
+     * Switches the active brand kit theme.
+     * @param themeName - Theme name
+     * @returns
+     */
+    switchTheme: (themeName: string) => Promise<import('..').EditorResponse<null>>;
 }

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

@@ -6,7 +6,6 @@ var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read fr
 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;
-import { engineBrandKitToStudioBrandKit, engineBrandKitToBrandKitInternal } from "../utils/BrandKitAdapter.es.js";
 import { getEditorResponseData } from "../utils/EditorResponseData.es.js";
 class BrandKitController {
   /**
@@ -39,16 +38,7 @@ class BrandKitController {
     };
     this.get = async () => {
       const res = await __privateGet(this, _editorAPI);
-      const result = await res.getBrandKit();
-      const response = getEditorResponseData(result);
-      const engineData = response.parsedData;
-      if (engineData == null) {
-        throw new Error("Brand kit response has no data");
-      }
-      return {
-        ...response,
-        parsedData: engineBrandKitToStudioBrandKit(engineData)
-      };
+      return res.getBrandKit().then((result) => getEditorResponseData(result));
     };
     this.getAllMedia = async () => {
       const res = await __privateGet(this, _editorAPI);
@@ -70,52 +60,13 @@ class BrandKitController {
       const res = await __privateGet(this, _editorAPI);
       return res.removeBrandKitMedia(name).then((result) => getEditorResponseData(result));
     };
-    this.remove = async () => {
-      const colors = await this.colorStyleController.getAll();
-      const colorsList = colors.parsedData || [];
-      const gradients = await this.gradientStyleController.getAll();
-      const gradientsList = gradients.parsedData || [];
-      const paragraphStyles = await this.paragraphStyleController.getAll();
-      const paragraphStylesList = paragraphStyles.parsedData || [];
-      const characterStyles = await this.characterStyleController.getAll();
-      const characterStylesList = characterStyles.parsedData || [];
-      const fonts = await this.fontController.getFontFamilies();
-      const fontsList = fonts.parsedData || [];
-      const media = await this.getAllMedia();
-      const mediaList = media.parsedData || [];
-      await this.undoManagerController.record("brandKit.remove", async (sdk2) => {
-        for (const color of colorsList) {
-          await sdk2.colorStyle.remove(color.id);
-        }
-        for (const gradient of gradientsList) {
-          await sdk2.gradientStyle.remove(gradient.id);
-        }
-        for (const style of paragraphStylesList) {
-          await sdk2.paragraphStyle.remove(style.id);
-        }
-        for (const style of characterStylesList) {
-          await sdk2.characterStyle.remove(style.id);
-        }
-        for (const font of fontsList) {
-          await sdk2.font.removeFontFamily(font.id);
-        }
-        for (const media2 of mediaList) {
-          await this.removeMedia(media2.name);
-        }
-      });
-    };
-    this.set = async (studioBrandKit) => {
-      const res = await __privateGet(this, _editorAPI);
-      const result = await res.setBrandKit(JSON.stringify(studioBrandKit.brandKit));
-      const response = getEditorResponseData(result);
-      const engineData = response.parsedData;
-      if (engineData == null) {
-        throw new Error("Brand kit set response has no data");
-      }
-      return {
-        ...response,
-        parsedData: engineBrandKitToBrandKitInternal(engineData)
-      };
+    this.set = async (apiBrandKit) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.setBrandKit(JSON.stringify(apiBrandKit)).then((result) => getEditorResponseData(result));
+    };
+    this.sync = async (apiBrandKit) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.syncBrandKit(JSON.stringify(apiBrandKit)).then((result) => getEditorResponseData(result));
     };
     this.isAutoSync = async () => {
       const res = await __privateGet(this, _editorAPI);
@@ -125,14 +76,12 @@ class BrandKitController {
       const res = await __privateGet(this, _editorAPI);
       return res.enableBrandKitAutoSync(enableAutoSync).then((result) => getEditorResponseData(result));
     };
+    this.switchTheme = async (themeName) => {
+      const res = await __privateGet(this, _editorAPI);
+      return res.switchBrandKitTheme(themeName).then((result) => getEditorResponseData(result));
+    };
     __privateSet(this, _editorAPI, editorAPI);
-    this.colorStyleController = sdk.colorStyle;
-    this.gradientStyleController = sdk.gradientStyle;
-    this.fontController = sdk.font;
-    this.mediaController = sdk.mediaConnector;
-    this.paragraphStyleController = sdk.paragraphStyle;
-    this.characterStyleController = sdk.characterStyle;
-    this.undoManagerController = sdk.undoManager;
+    this.sdk = sdk;
   }
 }
 _editorAPI = new WeakMap();

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

@@ -1 +1 @@
-{"version":3,"file":"BrandKitController.es.js","sources":["../../../src/controllers/BrandKitController.ts"],"sourcesContent":["import SDK from '..';\nimport {\n    BrandKitMedia,\n    EngineBrandKit,\n    StudioBrandKit,\n} from '../types/BrandKitTypes';\nimport { EditorAPI, Id } from '../types/CommonTypes';\nimport { engineBrandKitToBrandKitInternal, engineBrandKitToStudioBrandKit } from '../utils/BrandKitAdapter';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\nimport { CharacterStyleController } from './CharacterStyleController';\nimport { ColorStyleController } from './ColorStyleController';\nimport { FontController } from './FontController';\nimport { GradientStyleController } from './GradientStyleController';\nimport { MediaConnectorController } from './MediaConnectorController';\nimport { ParagraphStyleController } from './ParagraphStyleController';\nimport { UndoManagerController } from './UndoManagerController';\n\n/**\n * The BrandKitController is responsible for all communication regarding Brand Kits.\n * Methods inside this controller can be called by `window.SDK.brandKit.{method-name}`\n */\n\nexport class BrandKitController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI, sdk: SDK) {\n        this.#editorAPI = editorAPI;\n        this.colorStyleController = sdk.colorStyle;\n        this.gradientStyleController = sdk.gradientStyle;\n        this.fontController = sdk.font;\n        this.mediaController = sdk.mediaConnector;\n        this.paragraphStyleController = sdk.paragraphStyle;\n        this.characterStyleController = sdk.characterStyle;\n\n        this.undoManagerController = sdk.undoManager;\n    }\n\n    private colorStyleController: ColorStyleController;\n\n    private gradientStyleController: GradientStyleController;\n\n    private fontController: FontController;\n\n    private mediaController: MediaConnectorController;\n\n    private paragraphStyleController: ParagraphStyleController;\n\n    private characterStyleController: CharacterStyleController;\n\n    private undoManagerController: UndoManagerController;\n\n    /**\n     * This method returns the current brand kit id.\n     * @returns current brand kit id\n     */\n    getId = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitId().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit version.\n     * @returns current brand kit version\n     */\n    getVersion = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitVersion().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit name.\n     * @returns current brand kit name\n     */\n    getName = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitName().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method renames the brand kit.\n     * @param newName - The new name for the brand kit\n     * @returns\n     */\n    rename = async (newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKit(newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method updates both the brand kit id and version.\n     * @param id - The new brand kit id\n     * @param version - The new brand kit version\n     * @returns\n     */\n    updateIdAndVersion = async (id: string, version: string) => {\n        const res = await this.#editorAPI;\n        return res.updateBrandKitIdAndVersion(id, version).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method returns the local brandkit\n     * @returns brandkit with all assigned resources\n     */\n    get = async () => {\n        const res = await this.#editorAPI;\n        const result = await res.getBrandKit();\n        const response = getEditorResponseData<EngineBrandKit>(result);\n        const engineData = response.parsedData;\n        if (engineData == null) {\n            throw new Error('Brand kit response has no data');\n        }\n        return {\n            ...response,\n            parsedData: engineBrandKitToStudioBrandKit(engineData),\n        };\n    };\n\n    /**\n     * This method returns all media items in the brand kit\n     * @returns list of media items in the brand kit\n     */\n    getAllMedia = async () => {\n        const res = await this.#editorAPI;\n        return res.getAllBrandKitMedia().then((result) => getEditorResponseData<BrandKitMedia[]>(result));\n    };\n\n    /**\n     * This method adds a media item to the brand kit\n     * @param name - The name of the media item\n     * @param remoteConnectorId - The remote connector ID\n     * @param assetId - The asset ID of the media item\n     * @returns\n     */\n    addMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .addBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * This method updates an existing media item in the brand kit\n     * @param name - The name of the media item to update\n     * @param remoteConnectorId - The new remote connector ID\n     * @param assetId - The new asset ID\n     * @returns\n     */\n    updateMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .updateBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method renames an existing media item in the brand kit\n     * @param name - The name of the media item to rename\n     * @param newName - The new name for the media item\n     * @returns\n     */\n    renameMedia = async (name: string, newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKitMedia(name, newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method removes a media item from the brand kit\n     * @param name - The name of the media item to remove\n     * @returns\n     */\n    removeMedia = async (name: string) => {\n        const res = await this.#editorAPI;\n        return res.removeBrandKitMedia(name).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method removes a brand kit and all related resources assigned to it\n     * @returns\n     */\n    remove = async () => {\n        const colors = await this.colorStyleController.getAll();\n        const colorsList = colors.parsedData || [];\n\n        const gradients = await this.gradientStyleController.getAll();\n        const gradientsList = gradients.parsedData || [];\n\n        const paragraphStyles = await this.paragraphStyleController.getAll();\n        const paragraphStylesList = paragraphStyles.parsedData || [];\n\n        const characterStyles = await this.characterStyleController.getAll();\n        const characterStylesList = characterStyles.parsedData || [];\n\n        const fonts = await this.fontController.getFontFamilies();\n        const fontsList = fonts.parsedData || [];\n\n        const media = await this.getAllMedia();\n        const mediaList = media.parsedData || [];\n\n        await this.undoManagerController.record('brandKit.remove', async (sdk) => {\n            for (const color of colorsList) {\n                await sdk.colorStyle.remove(color.id);\n            }\n            for (const gradient of gradientsList) {\n                await sdk.gradientStyle.remove(gradient.id);\n            }\n            for (const style of paragraphStylesList) {\n                await sdk.paragraphStyle.remove(style.id);\n            }\n            for (const style of characterStylesList) {\n                await sdk.characterStyle.remove(style.id);\n            }\n            for (const font of fontsList) {\n                await sdk.font.removeFontFamily(font.id);\n            }\n            for (const media of mediaList) {\n                await this.removeMedia(media.name);\n            }\n        });\n    };\n\n    /**\n     * @experimental This method updates a brand kit and all related resources assigned to it\n     * @param studioBrandKit the content of the brand kit\n     * @returns\n     */\n    set = async (studioBrandKit: StudioBrandKit) => {\n        const res = await this.#editorAPI;\n        const result = await res.setBrandKit(JSON.stringify(studioBrandKit.brandKit));\n        const response = getEditorResponseData<EngineBrandKit>(result);\n        const engineData = response.parsedData;\n        if (engineData == null) {\n            throw new Error('Brand kit set response has no data');\n        }\n        return {\n            ...response,\n            parsedData: engineBrandKitToBrandKitInternal(engineData),\n        };\n    };\n\n\n    /**\n     * This method returns the value indicating whether the brand kit auto-sync is enabled or not\n     * It is up to the integrator to implement this auto-sync functionality, this method only is an indication if it should be done or not.\n     \n     * @returns boolean indicating sync status\n     */\n    isAutoSync = async () => {\n        const res = await this.#editorAPI;\n        return res.isBrandKitAutoSync().then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * This method enables or disables brand kit auto-sync\n     * @param enableAutoSync boolean indicating auto-sync status\n     * @returns boolean indicating the result of the operation\n     */\n    enableAutoSync = async (enableAutoSync: boolean) => {\n        const res = await this.#editorAPI;\n        return res.enableBrandKitAutoSync(enableAutoSync).then((result) => getEditorResponseData<boolean>(result));\n    };\n}\n"],"names":["sdk","media"],"mappings":";;;;;;;;;;AAsBO,MAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA,EAS5B,YAAY,WAAsB,KAAU;AAL5C;AAAA;AAAA;AAAA;AAmCA,SAAA,QAAQ,YAAY;AAChB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IACrF;AAMA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IAC1F;AAMA,SAAA,UAAU,YAAY;AAClB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IACvF;AAOA,SAAA,SAAS,OAAO,YAAoB;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,eAAe,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3F;AAQA,SAAA,qBAAqB,OAAO,IAAY,YAAoB;AACxD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,2BAA2B,IAAI,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3G;AAMA,SAAA,MAAM,YAAY;AACd,YAAM,MAAM,MAAM,mBAAK;AACvB,YAAM,SAAS,MAAM,IAAI,YAAA;AACzB,YAAM,WAAW,sBAAsC,MAAM;AAC7D,YAAM,aAAa,SAAS;AAC5B,UAAI,cAAc,MAAM;AACpB,cAAM,IAAI,MAAM,gCAAgC;AAAA,MACpD;AACA,aAAO;AAAA,QACH,GAAG;AAAA,QACH,YAAY,+BAA+B,UAAU;AAAA,MAAA;AAAA,IAE7D;AAMA,SAAA,cAAc,YAAY;AACtB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,KAAK,CAAC,WAAW,sBAAuC,MAAM,CAAC;AAAA,IACpG;AASA,SAAA,WAAW,OAAO,MAAc,mBAAuB,YAAoB;AACvE,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,iBAAiB,MAAM,mBAAmB,OAAO,EACjD,KAAK,CAAC,WAAW,sBAA0B,MAAM,CAAC;AAAA,IAC3D;AASA,SAAA,cAAc,OAAO,MAAc,mBAAuB,YAAoB;AAC1E,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,oBAAoB,MAAM,mBAAmB,OAAO,EACpD,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAQA,SAAA,cAAc,OAAO,MAAc,YAAoB;AACnD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,MAAM,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACtG;AAOA,SAAA,cAAc,OAAO,SAAiB;AAClC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7F;AAMA,SAAA,SAAS,YAAY;AACjB,YAAM,SAAS,MAAM,KAAK,qBAAqB,OAAA;AAC/C,YAAM,aAAa,OAAO,cAAc,CAAA;AAExC,YAAM,YAAY,MAAM,KAAK,wBAAwB,OAAA;AACrD,YAAM,gBAAgB,UAAU,cAAc,CAAA;AAE9C,YAAM,kBAAkB,MAAM,KAAK,yBAAyB,OAAA;AAC5D,YAAM,sBAAsB,gBAAgB,cAAc,CAAA;AAE1D,YAAM,kBAAkB,MAAM,KAAK,yBAAyB,OAAA;AAC5D,YAAM,sBAAsB,gBAAgB,cAAc,CAAA;AAE1D,YAAM,QAAQ,MAAM,KAAK,eAAe,gBAAA;AACxC,YAAM,YAAY,MAAM,cAAc,CAAA;AAEtC,YAAM,QAAQ,MAAM,KAAK,YAAA;AACzB,YAAM,YAAY,MAAM,cAAc,CAAA;AAEtC,YAAM,KAAK,sBAAsB,OAAO,mBAAmB,OAAOA,SAAQ;AACtE,mBAAW,SAAS,YAAY;AAC5B,gBAAMA,KAAI,WAAW,OAAO,MAAM,EAAE;AAAA,QACxC;AACA,mBAAW,YAAY,eAAe;AAClC,gBAAMA,KAAI,cAAc,OAAO,SAAS,EAAE;AAAA,QAC9C;AACA,mBAAW,SAAS,qBAAqB;AACrC,gBAAMA,KAAI,eAAe,OAAO,MAAM,EAAE;AAAA,QAC5C;AACA,mBAAW,SAAS,qBAAqB;AACrC,gBAAMA,KAAI,eAAe,OAAO,MAAM,EAAE;AAAA,QAC5C;AACA,mBAAW,QAAQ,WAAW;AAC1B,gBAAMA,KAAI,KAAK,iBAAiB,KAAK,EAAE;AAAA,QAC3C;AACA,mBAAWC,UAAS,WAAW;AAC3B,gBAAM,KAAK,YAAYA,OAAM,IAAI;AAAA,QACrC;AAAA,MACJ,CAAC;AAAA,IACL;AAOA,SAAA,MAAM,OAAO,mBAAmC;AAC5C,YAAM,MAAM,MAAM,mBAAK;AACvB,YAAM,SAAS,MAAM,IAAI,YAAY,KAAK,UAAU,eAAe,QAAQ,CAAC;AAC5E,YAAM,WAAW,sBAAsC,MAAM;AAC7D,YAAM,aAAa,SAAS;AAC5B,UAAI,cAAc,MAAM;AACpB,cAAM,IAAI,MAAM,oCAAoC;AAAA,MACxD;AACA,aAAO;AAAA,QACH,GAAG;AAAA,QACH,YAAY,iCAAiC,UAAU;AAAA,MAAA;AAAA,IAE/D;AASA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAW,sBAA+B,MAAM,CAAC;AAAA,IAC3F;AAOA,SAAA,iBAAiB,OAAO,mBAA4B;AAChD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,uBAAuB,cAAc,EAAE,KAAK,CAAC,WAAW,sBAA+B,MAAM,CAAC;AAAA,IAC7G;AAzOI,uBAAK,YAAa;AAClB,SAAK,uBAAuB,IAAI;AAChC,SAAK,0BAA0B,IAAI;AACnC,SAAK,iBAAiB,IAAI;AAC1B,SAAK,kBAAkB,IAAI;AAC3B,SAAK,2BAA2B,IAAI;AACpC,SAAK,2BAA2B,IAAI;AAEpC,SAAK,wBAAwB,IAAI;AAAA,EACrC;AAiOJ;AAhPI;"}
+{"version":3,"file":"BrandKitController.es.js","sources":["../../../src/controllers/BrandKitController.ts"],"sourcesContent":["import SDK from '..';\nimport { BrandKitMedia, BrandKit, APIBrandKit } from '../types/BrandKitTypes';\nimport { EditorAPI, Id } from '../types/CommonTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n\n/**\n * The BrandKitController is responsible for all communication regarding Brand Kits.\n * Methods inside this controller can be called by `window.SDK.brandKit.{method-name}`\n */\n\nexport class BrandKitController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    private sdk: SDK;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI, sdk: SDK) {\n        this.#editorAPI = editorAPI;\n        this.sdk = sdk;\n    }\n\n    /**\n     * This method returns the current brand kit id.\n     * @returns current brand kit id\n     */\n    getId = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitId().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit version.\n     * @returns current brand kit version\n     */\n    getVersion = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitVersion().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method returns the current brand kit name.\n     * @returns current brand kit name\n     */\n    getName = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKitName().then((result) => getEditorResponseData<string>(result));\n    };\n\n    /**\n     * This method renames the brand kit.\n     * @param newName - The new name for the brand kit\n     * @returns\n     */\n    rename = async (newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKit(newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method updates both the brand kit id and version.\n     * @param id - The new brand kit id\n     * @param version - The new brand kit version\n     * @returns\n     */\n    updateIdAndVersion = async (id: string, version: string) => {\n        const res = await this.#editorAPI;\n        return res.updateBrandKitIdAndVersion(id, version).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method returns the local brand kit\n     * @returns brand kit with all assigned resources\n     */\n    get = async () => {\n        const res = await this.#editorAPI;\n        return res.getBrandKit().then((result) => getEditorResponseData<BrandKit>(result));\n    };\n\n    /**\n     * This method returns all media items in the brand kit\n     * @returns list of media items in the brand kit\n     */\n    getAllMedia = async () => {\n        const res = await this.#editorAPI;\n        return res.getAllBrandKitMedia().then((result) => getEditorResponseData<BrandKitMedia[]>(result));\n    };\n\n    /**\n     * This method adds a media item to the brand kit\n     * @param name - The name of the media item\n     * @param remoteConnectorId - The remote connector ID\n     * @param assetId - The asset ID of the media item\n     * @returns\n     */\n    addMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .addBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<Id>(result));\n    };\n\n    /**\n     * This method updates an existing media item in the brand kit\n     * @param name - The name of the media item to update\n     * @param remoteConnectorId - The new remote connector ID\n     * @param assetId - The new asset ID\n     * @returns\n     */\n    updateMedia = async (name: string, remoteConnectorId: Id, assetId: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .updateBrandKitMedia(name, remoteConnectorId, assetId)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method renames an existing media item in the brand kit\n     * @param name - The name of the media item to rename\n     * @param newName - The new name for the media item\n     * @returns\n     */\n    renameMedia = async (name: string, newName: string) => {\n        const res = await this.#editorAPI;\n        return res.renameBrandKitMedia(name, newName).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method removes a media item from the brand kit\n     * @param name - The name of the media item to remove\n     * @returns\n     */\n    removeMedia = async (name: string) => {\n        const res = await this.#editorAPI;\n        return res.removeBrandKitMedia(name).then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * @experimental This method replaces the full brand kit and all related resources assigned to it\n     * @param apiBrandKit the brand kit from the environment api\n     * @returns the local brand kit\n     */\n    set = async (apiBrandKit: APIBrandKit) => {\n        const res = await this.#editorAPI;\n        return res.setBrandKit(JSON.stringify(apiBrandKit)).then((result) => getEditorResponseData<BrandKit>(result));\n    };\n\n    /**\n     * @experimental This method syncs brand kit items and structure in place without replacing the existing brand kit\n     * @param apiBrandKit the brand kit from the environment api\n     * @returns boolean indicating whether the brand kit changed after the sync attempt\n     */\n    sync = async (apiBrandKit: APIBrandKit) => {\n        const res = await this.#editorAPI;\n        return res.syncBrandKit(JSON.stringify(apiBrandKit)).then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * This method returns the value indicating whether the brand kit auto-sync is enabled or not\n     * It is up to the integrator to implement this auto-sync functionality, this method only is an indication if it should be done or not.\n     \n     * @returns boolean indicating sync status\n     */\n    isAutoSync = async () => {\n        const res = await this.#editorAPI;\n        return res.isBrandKitAutoSync().then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * This method enables or disables brand kit auto-sync\n     * @param enableAutoSync boolean indicating auto-sync status\n     * @returns boolean indicating the result of the operation\n     */\n    enableAutoSync = async (enableAutoSync: boolean) => {\n        const res = await this.#editorAPI;\n        return res.enableBrandKitAutoSync(enableAutoSync).then((result) => getEditorResponseData<boolean>(result));\n    };\n\n    /**\n     * Switches the active brand kit theme.\n     * @param themeName - Theme name\n     * @returns\n     */\n    switchTheme = async (themeName: string) => {\n        const res = await this.#editorAPI;\n        return res.switchBrandKitTheme(themeName).then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":[],"mappings":";;;;;;;;;AAUO,MAAM,mBAAmB;AAAA;AAAA;AAAA;AAAA,EAc5B,YAAY,WAAsB,KAAU;AAV5C;AAAA;AAAA;AAAA;AAmBA,SAAA,QAAQ,YAAY;AAChB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,gBAAgB,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IACrF;AAMA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IAC1F;AAMA,SAAA,UAAU,YAAY;AAClB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,kBAAkB,KAAK,CAAC,WAAW,sBAA8B,MAAM,CAAC;AAAA,IACvF;AAOA,SAAA,SAAS,OAAO,YAAoB;AAChC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,eAAe,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3F;AAQA,SAAA,qBAAqB,OAAO,IAAY,YAAoB;AACxD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,2BAA2B,IAAI,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3G;AAMA,SAAA,MAAM,YAAY;AACd,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,cAAc,KAAK,CAAC,WAAW,sBAAgC,MAAM,CAAC;AAAA,IACrF;AAMA,SAAA,cAAc,YAAY;AACtB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,KAAK,CAAC,WAAW,sBAAuC,MAAM,CAAC;AAAA,IACpG;AASA,SAAA,WAAW,OAAO,MAAc,mBAAuB,YAAoB;AACvE,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,iBAAiB,MAAM,mBAAmB,OAAO,EACjD,KAAK,CAAC,WAAW,sBAA0B,MAAM,CAAC;AAAA,IAC3D;AASA,SAAA,cAAc,OAAO,MAAc,mBAAuB,YAAoB;AAC1E,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,oBAAoB,MAAM,mBAAmB,OAAO,EACpD,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAQA,SAAA,cAAc,OAAO,MAAc,YAAoB;AACnD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,MAAM,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IACtG;AAOA,SAAA,cAAc,OAAO,SAAiB;AAClC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,IAAI,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7F;AAOA,SAAA,MAAM,OAAO,gBAA6B;AACtC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,YAAY,KAAK,UAAU,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,sBAAgC,MAAM,CAAC;AAAA,IAChH;AAOA,SAAA,OAAO,OAAO,gBAA6B;AACvC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,aAAa,KAAK,UAAU,WAAW,CAAC,EAAE,KAAK,CAAC,WAAW,sBAA+B,MAAM,CAAC;AAAA,IAChH;AAQA,SAAA,aAAa,YAAY;AACrB,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,qBAAqB,KAAK,CAAC,WAAW,sBAA+B,MAAM,CAAC;AAAA,IAC3F;AAOA,SAAA,iBAAiB,OAAO,mBAA4B;AAChD,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,uBAAuB,cAAc,EAAE,KAAK,CAAC,WAAW,sBAA+B,MAAM,CAAC;AAAA,IAC7G;AAOA,SAAA,cAAc,OAAO,cAAsB;AACvC,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,oBAAoB,SAAS,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAClG;AAxKI,uBAAK,YAAa;AAClB,SAAK,MAAM;AAAA,EACf;AAuKJ;AApLI;"}

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

@@ -1 +1 @@
-{"version":3,"file":"ComponentController.cjs.js","sources":["../../../src/controllers/ComponentController.ts"],"sourcesContent":["import { EditorAPI, Id } from '../types/CommonTypes';\nimport { ComponentFitEnum } from '../types/FrameTypes';\nimport { Variable } from '../types/VariableTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n\n/**\n * @experimental This controller is experimental and may change without warning.\n * The ComponentController is responsible for all communication regarding Component frames.\n * Methods inside this controller can be called by `window.SDK.component.{method-name}`\n */\nexport class ComponentController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n    }\n\n    /**\n     * @experimental This method will link (or unlink) a variable from the template to the component frame\n     * @param id the id of the componentFrame that needs to be updated.\n     * @param target the id of the variable, inside the component, that will be linked (or unlinked) to the source variable.\n     * @param source the id of the source variable from the template. If not provided, the variable will be unlinked.\n     * @param sourceField the field of the data source variable.\n    * @returns\n     */\n    linkVariable = async (frameId: Id, target: Id, source?: Id, sourceField?: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .linkComponentVariable(frameId, target, source, sourceField ?? null)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method returns the list of variables of a component frame.\n     * @param id the id of the componentFrame.\n     * @returns\n     */\n    getComponentVariables = async (frameId: Id) => {\n        const res = await this.#editorAPI;\n        return res.getComponentVariables(frameId).then((result) => getEditorResponseData<Variable[]>(result));\n    };\n\n    /**\n     * This method sets the fit mode of a component frame.\n     * @param frameId the id of the component frame.\n     * @param fitMode the fit mode to set.\n     * @returns\n     */\n    setFitMode = async (frameId: Id, fitMode: ComponentFitEnum) => {\n        const res = await this.#editorAPI;\n        return res.setComponentLayoutFit(frameId, fitMode).then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":["getEditorResponseData"],"mappings":";;;;;;;;;;;AAUO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA,EAS7B,YAAY,WAAsB;AALlC;AAAA;AAAA;AAAA;AAiBA,SAAA,eAAe,OAAO,SAAa,QAAY,QAAa,gBAAyB;AACjF,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,sBAAsB,SAAS,QAAQ,QAAQ,eAAe,IAAI,EAClE,KAAK,CAAC,WAAWA,mBAAAA,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAOA,SAAA,wBAAwB,OAAO,YAAgB;AAC3C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAAkC,MAAM,CAAC;AAAA,IACxG;AAQA,SAAA,aAAa,OAAO,SAAa,YAA8B;AAC3D,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,SAAS,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC3G;AArCI,uBAAK,YAAa;AAAA,EACtB;AAqCJ;AA5CI;;"}
+{"version":3,"file":"ComponentController.cjs.js","sources":["../../../src/controllers/ComponentController.ts"],"sourcesContent":["import { EditorAPI, Id } from '../types/CommonTypes';\nimport { ComponentFitEnum } from '../types/FrameTypes';\nimport { Variable } from '../types/VariableTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n\n/**\n * @experimental This controller is experimental and may change without warning.\n * The ComponentController is responsible for all communication regarding Component frames.\n * Methods inside this controller can be called by `window.SDK.component.{method-name}`\n */\nexport class ComponentController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n    }\n\n    /**\n     * @experimental This method will link (or unlink) a variable from the template to the component frame\n     * @param id the id of the componentFrame that needs to be updated.\n     * @param target the id of the variable, inside the component, that will be linked (or unlinked) to the source variable.\n     * @param source the id of the source variable from the template. If not provided, the variable will be unlinked.\n     * @param sourceField the field of the data source variable.\n     * @returns\n     */\n    linkVariable = async (frameId: Id, target: Id, source?: Id, sourceField?: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .linkComponentVariable(frameId, target, source, sourceField ?? null)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method returns the list of variables of a component frame.\n     * @param id the id of the componentFrame.\n     * @returns\n     */\n    getComponentVariables = async (frameId: Id) => {\n        const res = await this.#editorAPI;\n        return res.getComponentVariables(frameId).then((result) => getEditorResponseData<Variable[]>(result));\n    };\n\n    /**\n     * This method sets the fit mode of a component frame.\n     * @param frameId the id of the component frame.\n     * @param fitMode the fit mode to set.\n     * @returns\n     */\n    setFitMode = async (frameId: Id, fitMode: ComponentFitEnum) => {\n        const res = await this.#editorAPI;\n        return res.setComponentLayoutFit(frameId, fitMode).then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":["getEditorResponseData"],"mappings":";;;;;;;;;;;AAUO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA,EAS7B,YAAY,WAAsB;AALlC;AAAA;AAAA;AAAA;AAiBA,SAAA,eAAe,OAAO,SAAa,QAAY,QAAa,gBAAyB;AACjF,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,sBAAsB,SAAS,QAAQ,QAAQ,eAAe,IAAI,EAClE,KAAK,CAAC,WAAWA,mBAAAA,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAOA,SAAA,wBAAwB,OAAO,YAAgB;AAC3C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAAkC,MAAM,CAAC;AAAA,IACxG;AAQA,SAAA,aAAa,OAAO,SAAa,YAA8B;AAC3D,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,SAAS,OAAO,EAAE,KAAK,CAAC,WAAWA,yCAA4B,MAAM,CAAC;AAAA,IAC3G;AArCI,uBAAK,YAAa;AAAA,EACtB;AAqCJ;AA5CI;;"}

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

@@ -18,7 +18,7 @@ export declare class ComponentController {
      * @param target the id of the variable, inside the component, that will be linked (or unlinked) to the source variable.
      * @param source the id of the source variable from the template. If not provided, the variable will be unlinked.
      * @param sourceField the field of the data source variable.
-    * @returns
+     * @returns
      */
     linkVariable: (frameId: Id, target: Id, source?: Id, sourceField?: string) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"ComponentController.es.js","sources":["../../../src/controllers/ComponentController.ts"],"sourcesContent":["import { EditorAPI, Id } from '../types/CommonTypes';\nimport { ComponentFitEnum } from '../types/FrameTypes';\nimport { Variable } from '../types/VariableTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n\n/**\n * @experimental This controller is experimental and may change without warning.\n * The ComponentController is responsible for all communication regarding Component frames.\n * Methods inside this controller can be called by `window.SDK.component.{method-name}`\n */\nexport class ComponentController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n    }\n\n    /**\n     * @experimental This method will link (or unlink) a variable from the template to the component frame\n     * @param id the id of the componentFrame that needs to be updated.\n     * @param target the id of the variable, inside the component, that will be linked (or unlinked) to the source variable.\n     * @param source the id of the source variable from the template. If not provided, the variable will be unlinked.\n     * @param sourceField the field of the data source variable.\n    * @returns\n     */\n    linkVariable = async (frameId: Id, target: Id, source?: Id, sourceField?: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .linkComponentVariable(frameId, target, source, sourceField ?? null)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method returns the list of variables of a component frame.\n     * @param id the id of the componentFrame.\n     * @returns\n     */\n    getComponentVariables = async (frameId: Id) => {\n        const res = await this.#editorAPI;\n        return res.getComponentVariables(frameId).then((result) => getEditorResponseData<Variable[]>(result));\n    };\n\n    /**\n     * This method sets the fit mode of a component frame.\n     * @param frameId the id of the component frame.\n     * @param fitMode the fit mode to set.\n     * @returns\n     */\n    setFitMode = async (frameId: Id, fitMode: ComponentFitEnum) => {\n        const res = await this.#editorAPI;\n        return res.setComponentLayoutFit(frameId, fitMode).then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":[],"mappings":";;;;;;;;;AAUO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA,EAS7B,YAAY,WAAsB;AALlC;AAAA;AAAA;AAAA;AAiBA,SAAA,eAAe,OAAO,SAAa,QAAY,QAAa,gBAAyB;AACjF,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,sBAAsB,SAAS,QAAQ,QAAQ,eAAe,IAAI,EAClE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAOA,SAAA,wBAAwB,OAAO,YAAgB;AAC3C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,OAAO,EAAE,KAAK,CAAC,WAAW,sBAAkC,MAAM,CAAC;AAAA,IACxG;AAQA,SAAA,aAAa,OAAO,SAAa,YAA8B;AAC3D,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,SAAS,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3G;AArCI,uBAAK,YAAa;AAAA,EACtB;AAqCJ;AA5CI;"}
+{"version":3,"file":"ComponentController.es.js","sources":["../../../src/controllers/ComponentController.ts"],"sourcesContent":["import { EditorAPI, Id } from '../types/CommonTypes';\nimport { ComponentFitEnum } from '../types/FrameTypes';\nimport { Variable } from '../types/VariableTypes';\nimport { getEditorResponseData } from '../utils/EditorResponseData';\n\n/**\n * @experimental This controller is experimental and may change without warning.\n * The ComponentController is responsible for all communication regarding Component frames.\n * Methods inside this controller can be called by `window.SDK.component.{method-name}`\n */\nexport class ComponentController {\n    /**\n     * @ignore\n     */\n    #editorAPI: EditorAPI;\n\n    /**\n     * @ignore\n     */\n    constructor(editorAPI: EditorAPI) {\n        this.#editorAPI = editorAPI;\n    }\n\n    /**\n     * @experimental This method will link (or unlink) a variable from the template to the component frame\n     * @param id the id of the componentFrame that needs to be updated.\n     * @param target the id of the variable, inside the component, that will be linked (or unlinked) to the source variable.\n     * @param source the id of the source variable from the template. If not provided, the variable will be unlinked.\n     * @param sourceField the field of the data source variable.\n     * @returns\n     */\n    linkVariable = async (frameId: Id, target: Id, source?: Id, sourceField?: string) => {\n        const res = await this.#editorAPI;\n        return res\n            .linkComponentVariable(frameId, target, source, sourceField ?? null)\n            .then((result) => getEditorResponseData<null>(result));\n    };\n\n    /**\n     * This method returns the list of variables of a component frame.\n     * @param id the id of the componentFrame.\n     * @returns\n     */\n    getComponentVariables = async (frameId: Id) => {\n        const res = await this.#editorAPI;\n        return res.getComponentVariables(frameId).then((result) => getEditorResponseData<Variable[]>(result));\n    };\n\n    /**\n     * This method sets the fit mode of a component frame.\n     * @param frameId the id of the component frame.\n     * @param fitMode the fit mode to set.\n     * @returns\n     */\n    setFitMode = async (frameId: Id, fitMode: ComponentFitEnum) => {\n        const res = await this.#editorAPI;\n        return res.setComponentLayoutFit(frameId, fitMode).then((result) => getEditorResponseData<null>(result));\n    };\n}\n"],"names":[],"mappings":";;;;;;;;;AAUO,MAAM,oBAAoB;AAAA;AAAA;AAAA;AAAA,EAS7B,YAAY,WAAsB;AALlC;AAAA;AAAA;AAAA;AAiBA,SAAA,eAAe,OAAO,SAAa,QAAY,QAAa,gBAAyB;AACjF,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IACF,sBAAsB,SAAS,QAAQ,QAAQ,eAAe,IAAI,EAClE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC7D;AAOA,SAAA,wBAAwB,OAAO,YAAgB;AAC3C,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,OAAO,EAAE,KAAK,CAAC,WAAW,sBAAkC,MAAM,CAAC;AAAA,IACxG;AAQA,SAAA,aAAa,OAAO,SAAa,YAA8B;AAC3D,YAAM,MAAM,MAAM,mBAAK;AACvB,aAAO,IAAI,sBAAsB,SAAS,OAAO,EAAE,KAAK,CAAC,WAAW,sBAA4B,MAAM,CAAC;AAAA,IAC3G;AArCI,uBAAK,YAAa;AAAA,EACtB;AAqCJ;AA5CI;"}

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

@@ -1 +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;;"}
+{"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,UACI,GAAG;AAAA,UACH,aAAY,YAAO,eAAP,mBAAmB,OAAO,CAAC,OAAO,GAAG,cAAc;AAAA,QAAS;AAAA;AAAA,IAC5E;AAAA,EAElB;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.d.ts

@@ -93,11 +93,11 @@ export declare class ConnectorController {
      */
     updateMappings: (id: Id, mappings: ConnectorMappingType[]) => Promise<EditorResponse<null>>;
     /**
-        * Sets the mappings for a given connector, replacing the existing mappings with the new ones.
-        * @param id the id of your registered connector
-        * @param mappings An array of mapping objects to set
-        * @returns
-        */
+     * Sets the mappings for a given connector, replacing the existing mappings with the new ones.
+     * @param id the id of your registered connector
+     * @param mappings An array of mapping objects to set
+     * @returns
+     */
     applyMappings: (id: Id, mappings: ConnectorMappingType[]) => Promise<EditorResponse<null>>;
     /**
      * Sets HTTP headers on every local connector instance of the given type that uses the given remote (Environment API) connector id.