@chili-publish/studio-sdk 1.34.0 → 1.36.0

package/connector-types/src/Common.d.ts

@@ -0,0 +1,7 @@
+export declare enum MeasurementUnit {
+    px = "px",
+    mm = "mm",
+    cm = "cm",
+    inch = "inch",
+    pt = "pt"
+}

package/connector-types/src/Common.js

@@ -0,0 +1,9 @@
+export var MeasurementUnit;
+(function (MeasurementUnit) {
+    MeasurementUnit["px"] = "px";
+    MeasurementUnit["mm"] = "mm";
+    MeasurementUnit["cm"] = "cm";
+    MeasurementUnit["inch"] = "inch";
+    MeasurementUnit["pt"] = "pt";
+})(MeasurementUnit || (MeasurementUnit = {}));
+//# sourceMappingURL=Common.js.map

package/connector-types/src/Common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Common.js","sourceRoot":"","sources":["../../../../connector-types/src/Common.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACvB,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,4BAAS,CAAA;IACT,gCAAa,CAAA;IACb,4BAAS,CAAA;AACb,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B"}

package/connector-types/src/ComponentConnector.d.ts

@@ -0,0 +1,28 @@
+import { MeasurementUnit } from './Common';
+import { QueryPage } from './Connector.Shared';
+/**
+ * @experimental This is still experimental and might change in future releases.
+ */
+export type ComponentPage = QueryPage<Component>;
+/**
+ * @experimental This is still experimental and might change in future releases.
+ */
+export interface Component {
+    id: string;
+    name: string;
+    defaultComponentDimensions: {
+        width: number;
+        height: number;
+        unit: MeasurementUnit;
+    };
+}
+/**
+ * @experimental This is still experimental and might change in future releases.
+ */
+export type ComponentConnectorCapabilities = {
+    query: boolean;
+    detail: boolean;
+    preview: boolean;
+    filtering: boolean;
+    serverRender: boolean;
+};

package/connector-types/src/ComponentConnector.js

@@ -0,0 +1,3 @@
+;
+export {};
+//# sourceMappingURL=ComponentConnector.js.map

package/connector-types/src/ComponentConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComponentConnector.js","sourceRoot":"","sources":["../../../../connector-types/src/ComponentConnector.ts"],"names":[],"mappings":"AAmBC,CAAC"}

package/connector-types/src/index.d.ts

@@ -2,3 +2,5 @@ export * from './Connector.Shared';
 export * from './DataConnector';
 export * from './FontConnector';
 export * from './MediaConnector';
+export * from './ComponentConnector';
+export * from './Common';

package/connector-types/src/index.js

@@ -2,4 +2,6 @@ export * from './Connector.Shared';
 export * from './DataConnector';
 export * from './FontConnector';
 export * from './MediaConnector';
+export * from './ComponentConnector';
+export * from './Common';
 //# sourceMappingURL=index.js.map

package/connector-types/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../connector-types/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../connector-types/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,UAAU,CAAC"}

package/lib/editor-engine.json

@@ -1,3 +1,3 @@
 {
-    "current": "2.17.latest"
+    "current": "2.19.latest"
 }

package/lib/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@chili-publish/studio-sdk",
     "private": false,
-    "version": "1.34.0",
+    "version": "1.36.0",
     "description": "The sdk for the chili editor",
     "repository": {
         "type": "git",

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

@@ -14,76 +14,76 @@ export declare class BarcodeController {
      */
     constructor(editorAPI: EditorAPI);
     /**
-     * @experimental This method updates properties of the barcode
+     * This method updates properties of the barcode
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param properties A property to update
      * @returns
      */
     private setBarcodeProperties;
     /**
-     * @experimental This method will set the background of a barcode enabled or disabled
+     * This method will set the background of a barcode enabled or disabled
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param enableBackground Whether the barcode's background is visible.
      * @returns
      */
     setEnableBackground: (id: Id, enableBackground: boolean) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method will set the barcode background color of a specified barcode frame.
+     * This method will set the barcode background color of a specified barcode frame.
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param backgroundColor the new barcode background color that you want to set to the barcodeFrame.
      * @returns
      */
     setBackgroundColor: (id: Id, backgroundColor: ColorUsage) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method will set the visibility of the barcode's bars.
+     * This method will set the visibility of the barcode's bars.
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param enableBars Whether the barcode bars are visible.
      * @returns
      */
     setEnableBars: (id: Id, enableBars: boolean) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method will set the bar color of a specified barcode frame.
+     * This method will set the bar color of a specified barcode frame.
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param barColor the new bar color that you want to set to the barcodeFrame.
      * @returns
      */
     setBarColor: (id: Id, barColor: ColorUsage) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method will set the source of the barcode to the given source.
+     * This method will set the source of the barcode to the given source.
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param source the new source that you want to set to the barcodeFrame.
      * @returns
      */
     setBarcodeSource: (id: Id, source: BarcodeSource) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method will remove the source from the barcode frame provided.
+     * This method will remove the source from the barcode frame provided.
      * @param id the id of the barcodeFrame that needs to have the source removed.
      * @returns
      */
     removeBarcodeSource: (id: Id) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method enables/disables displaying the text of the barcode.
+     * This method enables/disables displaying the text of the barcode.
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param enableText true if the text should be displayed, false otherwise.
      * @returns
      */
     setEnableText: (id: Id, enableText: boolean) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the bar height for 1-dimensional barcodes.
+     * This method sets the bar height for 1-dimensional barcodes.
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param barHeight the height of the bars in the barcode. The string value will be calculated (f.e. 1+1 will result in 2)
      * @returns
      */
     setBarHeight: (id: Id, barHeight: string) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the magnification for 1-dimensional barcodes.
+     * This method sets the magnification for 1-dimensional barcodes.
      * @param id the id of the barcodeFrame that needs to be updated.
      * @param magnification the magnification of the barcode. This is a decimal value where 1 denotes 100%. (f.e. 1.5 will result in 150%)
      * @returns
      */
     setMagnification: (id: Id, magnification: number) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the quiet zone value of a specific barcode.
+     * This method sets the quiet zone value of a specific barcode.
      * @param id The id of the specific barcode frame
      * @param value The quiet zone value
      * @param position When defined will update the quiet value of a single position,
@@ -92,27 +92,27 @@ export declare class BarcodeController {
      */
     setQuietZoneValue: (id: Id, value: string, position?: PositionEnum) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the combined state of the quiet zone values.
+     * This method sets the combined state of the quiet zone values.
      * @param id The id of the specific barcode frame
      * @param value Whether the quiet zone values are combined
      */
     setAreQuietZoneValuesCombined: (id: Id, value: boolean) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the character set for the barcode.
+     * This method sets the character set for the barcode.
      * @param id The id of the specific barcode frame.
      * @param errorCorrectionLevel The error correction level to set.
      * @returns
      */
     setErrorCorrectionLevel: (id: Id, errorCorrectionLevel: BarcodeErrorCorrectionLevel) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the character set for the barcode.
+     * This method sets the character set for the barcode.
      * @param id The id of the specific barcode frame.
      * @param characterSet The character set to set.
      * @returns
      */
     setCharacterSet: (id: Id, characterSet: BarcodeCharacterSet) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the flag to render the end characters of the barcode. This is not
+     * This method sets the flag to render the end characters of the barcode. This is not
      * supported for all barcode types.
      * @param id The id of the specific barcode frame.
      * @param drawLightMarginIndicator The flag indicating if the end characters should be drawn or not
@@ -120,7 +120,7 @@ export declare class BarcodeController {
      */
     setDrawLightMarginIndicator: (id: Id, drawLightMarginIndicator: boolean) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method sets the flag to render the start and end characters of the barcode. This is not
+     * This method sets the flag to render the start and end characters of the barcode. This is not
      * supported for all barcode types.
      * @param id The id of the specific barcode frame.
      * @param drawStartStopChars The flag indicating if the start and stop characters should be drawn or not
@@ -128,7 +128,7 @@ export declare class BarcodeController {
      */
     setDrawStartStopChars: (id: Id, drawStartStopChars: boolean) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
     /**
-     * @experimental This method returns the possible configuration options which are valid for the given barcode type.
+     * This method returns the possible configuration options which are valid for the given barcode type.
      * @param type the barcode type for which the configuration options are requested.
      * @returns a BarcodeConfigurationOptions object
      */

package/lib/src/controllers/BarcodeController.js

@@ -36,7 +36,7 @@ export class BarcodeController {
          */
         _BarcodeController_editorAPI.set(this, void 0);
         /**
-         * @experimental This method updates properties of the barcode
+         * This method updates properties of the barcode
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param properties A property to update
          * @returns
@@ -48,7 +48,7 @@ export class BarcodeController {
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * @experimental This method will set the background of a barcode enabled or disabled
+         * This method will set the background of a barcode enabled or disabled
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param enableBackground Whether the barcode's background is visible.
          * @returns
@@ -58,7 +58,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method will set the barcode background color of a specified barcode frame.
+         * This method will set the barcode background color of a specified barcode frame.
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param backgroundColor the new barcode background color that you want to set to the barcodeFrame.
          * @returns
@@ -68,7 +68,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method will set the visibility of the barcode's bars.
+         * This method will set the visibility of the barcode's bars.
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param enableBars Whether the barcode bars are visible.
          * @returns
@@ -78,7 +78,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method will set the bar color of a specified barcode frame.
+         * This method will set the bar color of a specified barcode frame.
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param barColor the new bar color that you want to set to the barcodeFrame.
          * @returns
@@ -88,7 +88,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method will set the source of the barcode to the given source.
+         * This method will set the source of the barcode to the given source.
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param source the new source that you want to set to the barcodeFrame.
          * @returns
@@ -98,7 +98,7 @@ export class BarcodeController {
             return res.setBarcodeSource(id, JSON.stringify(source)).then((result) => getEditorResponseData(result));
         });
         /**
-         * @experimental This method will remove the source from the barcode frame provided.
+         * This method will remove the source from the barcode frame provided.
          * @param id the id of the barcodeFrame that needs to have the source removed.
          * @returns
          */
@@ -107,7 +107,7 @@ export class BarcodeController {
             return res.setBarcodeSource(id, null).then((result) => getEditorResponseData(result));
         });
         /**
-         * @experimental This method enables/disables displaying the text of the barcode.
+         * This method enables/disables displaying the text of the barcode.
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param enableText true if the text should be displayed, false otherwise.
          * @returns
@@ -117,7 +117,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method sets the bar height for 1-dimensional barcodes.
+         * This method sets the bar height for 1-dimensional barcodes.
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param barHeight the height of the bars in the barcode. The string value will be calculated (f.e. 1+1 will result in 2)
          * @returns
@@ -127,7 +127,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method sets the magnification for 1-dimensional barcodes.
+         * This method sets the magnification for 1-dimensional barcodes.
          * @param id the id of the barcodeFrame that needs to be updated.
          * @param magnification the magnification of the barcode. This is a decimal value where 1 denotes 100%. (f.e. 1.5 will result in 150%)
          * @returns
@@ -137,7 +137,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method sets the quiet zone value of a specific barcode.
+         * This method sets the quiet zone value of a specific barcode.
          * @param id The id of the specific barcode frame
          * @param value The quiet zone value
          * @param position When defined will update the quiet value of a single position,
@@ -159,7 +159,7 @@ export class BarcodeController {
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * @experimental This method sets the combined state of the quiet zone values.
+         * This method sets the combined state of the quiet zone values.
          * @param id The id of the specific barcode frame
          * @param value Whether the quiet zone values are combined
          */
@@ -171,7 +171,7 @@ export class BarcodeController {
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * @experimental This method sets the character set for the barcode.
+         * This method sets the character set for the barcode.
          * @param id The id of the specific barcode frame.
          * @param errorCorrectionLevel The error correction level to set.
          * @returns
@@ -183,7 +183,7 @@ export class BarcodeController {
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * @experimental This method sets the character set for the barcode.
+         * This method sets the character set for the barcode.
          * @param id The id of the specific barcode frame.
          * @param characterSet The character set to set.
          * @returns
@@ -195,7 +195,7 @@ export class BarcodeController {
                 .then((result) => getEditorResponseData(result));
         });
         /**
-         * @experimental This method sets the flag to render the end characters of the barcode. This is not
+         * This method sets the flag to render the end characters of the barcode. This is not
          * supported for all barcode types.
          * @param id The id of the specific barcode frame.
          * @param drawLightMarginIndicator The flag indicating if the end characters should be drawn or not
@@ -206,7 +206,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method sets the flag to render the start and end characters of the barcode. This is not
+         * This method sets the flag to render the start and end characters of the barcode. This is not
          * supported for all barcode types.
          * @param id The id of the specific barcode frame.
          * @param drawStartStopChars The flag indicating if the start and stop characters should be drawn or not
@@ -217,7 +217,7 @@ export class BarcodeController {
             return this.setBarcodeProperties(id, properties);
         });
         /**
-         * @experimental This method returns the possible configuration options which are valid for the given barcode type.
+         * This method returns the possible configuration options which are valid for the given barcode type.
          * @param type the barcode type for which the configuration options are requested.
          * @returns a BarcodeConfigurationOptions object
          */

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

@@ -0,0 +1,64 @@
+import { EditorAPI, EditorResponse } from '../types/CommonTypes';
+import { Component, ComponentConnectorCapabilities, ComponentPreviewType } from '../types/ComponentConnectorTypes';
+import { ConnectorConfigOptions, MetaData, QueryOptions, QueryPage } from '../types/ConnectorTypes';
+/**
+ * @experimental This controller is still experimental and might change in future releases.
+ *
+ * The ComponentConnectorController is responsible for all communication regarding Component connectors.
+ * Methods inside this controller can be called by `window.SDK.componentConnector.{method-name}`
+ *
+ * The way GraFx Studio handles different sources of Component is called 'ComponentConnector'.
+ * A ComponentConnector is an implementation of a set of capabilities we need
+ * to interact with a certain Component Asset Management system.
+ * In essence, a connector is the combination of a JavaScript snippet and some metadata.
+ * The JavaScript snippet is loaded in the studio engine using a sandboxed JavaScript execution engine (QuickJs).
+ * This allows us to execute the Component connector
+ * both on web using webassembly and on the server side during output generation.
+ * This controller is an interface to the running connector instance inside the studio engine.
+ */
+export declare class ComponentConnectorController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * @experimental This method is still experimental and might change in future releases.
+     * Query a specific ComponentConnector for data using both standardized queryOptions and the dynamic
+     * context as parameters.
+     * @param connectorId unique id of the Component connector
+     * @param queryOptions query options
+     * @param context context that will be available in the connector script.
+     * @returns array of component instances
+     */
+    query: (connectorId: string, queryOptions: QueryOptions, context?: MetaData) => Promise<EditorResponse<QueryPage<Component>>>;
+    /**
+     * @experimental This method is still experimental and might change in future releases.
+     * The combination of a `connectorId` and `componentId` is typically enough for a Component connector to
+     * perform the preview of this asset. The `preview` endpoint is capable of relaying this information to the
+     * Component connector instance running in the editor engine.
+     * @param connectorId unique id of the Component connector
+     * @param componentId unique id of the Component to download
+     * @param previewType hint to the Component connector about desired format of the Component preview
+     * @param context dynamic map of additional options potentially used by the connector
+     * @returns
+     */
+    preview: (connectorId: string, componentId: string, previewType: ComponentPreviewType, context?: MetaData) => Promise<Uint8Array>;
+    /**
+     * @experimental This method is still experimental and might change in future releases.
+     * All connectors have a certain set of mappings they allow to be passed into the connector methods their context. This
+     * method allows you to discover which mappings are available for a given connector. If you want to use any of these
+     * mappings, they will be available in the `context` parameter of any connector method.
+     * @param connectorId unique id of the component connector
+     * @returns connector mappings
+     */
+    getConfigurationOptions: (connectorId: string) => Promise<EditorResponse<ConnectorConfigOptions>>;
+    /**
+     * @experimental This method is still experimental and might change in future releases.
+     * This method returns what capabilities the selected connector has. It gives an indication what methods can
+     * be used successfully for a certain connector.
+     * @param connectorId unique id of the component connector
+     * @returns ComponentConnectorCapabilities
+     */
+    getCapabilities: (connectorId: string) => Promise<EditorResponse<ComponentConnectorCapabilities>>;
+}

package/lib/src/controllers/ComponentConnectorController.js

@@ -0,0 +1,123 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ComponentConnectorController_editorAPI, _ComponentConnectorController_blobAPI;
+import { getEditorResponseData, throwEditorResponseError } from '../utils/EditorResponseData';
+/**
+ * @experimental This controller is still experimental and might change in future releases.
+ *
+ * The ComponentConnectorController is responsible for all communication regarding Component connectors.
+ * Methods inside this controller can be called by `window.SDK.componentConnector.{method-name}`
+ *
+ * The way GraFx Studio handles different sources of Component is called 'ComponentConnector'.
+ * A ComponentConnector is an implementation of a set of capabilities we need
+ * to interact with a certain Component Asset Management system.
+ * In essence, a connector is the combination of a JavaScript snippet and some metadata.
+ * The JavaScript snippet is loaded in the studio engine using a sandboxed JavaScript execution engine (QuickJs).
+ * This allows us to execute the Component connector
+ * both on web using webassembly and on the server side during output generation.
+ * This controller is an interface to the running connector instance inside the studio engine.
+ */
+export class ComponentConnectorController {
+    /**
+     * @ignore
+     */
+    constructor(editorAPI) {
+        /**
+         * @ignore
+         */
+        _ComponentConnectorController_editorAPI.set(this, void 0);
+        _ComponentConnectorController_blobAPI.set(this, void 0);
+        /**
+         * @experimental This method is still experimental and might change in future releases.
+         * Query a specific ComponentConnector for data using both standardized queryOptions and the dynamic
+         * context as parameters.
+         * @param connectorId unique id of the Component connector
+         * @param queryOptions query options
+         * @param context context that will be available in the connector script.
+         * @returns array of component instances
+         */
+        this.query = (connectorId_1, queryOptions_1, ...args_1) => __awaiter(this, [connectorId_1, queryOptions_1, ...args_1], void 0, function* (connectorId, queryOptions, context = {}) {
+            const res = yield __classPrivateFieldGet(this, _ComponentConnectorController_editorAPI, "f");
+            return res
+                .componentConnectorQuery(connectorId, JSON.stringify(queryOptions), JSON.stringify(context))
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * @experimental This method is still experimental and might change in future releases.
+         * The combination of a `connectorId` and `componentId` is typically enough for a Component connector to
+         * perform the preview of this asset. The `preview` endpoint is capable of relaying this information to the
+         * Component connector instance running in the editor engine.
+         * @param connectorId unique id of the Component connector
+         * @param componentId unique id of the Component to download
+         * @param previewType hint to the Component connector about desired format of the Component preview
+         * @param context dynamic map of additional options potentially used by the connector
+         * @returns
+         */
+        this.preview = (connectorId_1, componentId_1, previewType_1, ...args_1) => __awaiter(this, [connectorId_1, componentId_1, previewType_1, ...args_1], void 0, function* (connectorId, componentId, previewType, context = {}) {
+            const res = yield __classPrivateFieldGet(this, _ComponentConnectorController_blobAPI, "f");
+            return res
+                .componentConnectorPreview(connectorId, componentId, previewType, JSON.stringify(context))
+                .then((result) => {
+                // Handle binary data (Uint8Array) directly
+                if (result instanceof Uint8Array) {
+                    return result;
+                }
+                // Handle structured response (EditorResponse) for non-success cases
+                if (typeof result === 'object' && result !== null && 'success' in result && !result.success) {
+                    throwEditorResponseError(result);
+                }
+                // Unexpected response type - throw error
+                throw new Error(`Unexpected response type: ${typeof result}.`);
+            });
+        });
+        /**
+         * @experimental This method is still experimental and might change in future releases.
+         * All connectors have a certain set of mappings they allow to be passed into the connector methods their context. This
+         * method allows you to discover which mappings are available for a given connector. If you want to use any of these
+         * mappings, they will be available in the `context` parameter of any connector method.
+         * @param connectorId unique id of the component connector
+         * @returns connector mappings
+         */
+        this.getConfigurationOptions = (connectorId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _ComponentConnectorController_editorAPI, "f");
+            return res
+                .componentConnectorGetConfigurationOptions(connectorId)
+                .then((result) => getEditorResponseData(result));
+        });
+        /**
+         * @experimental This method is still experimental and might change in future releases.
+         * This method returns what capabilities the selected connector has. It gives an indication what methods can
+         * be used successfully for a certain connector.
+         * @param connectorId unique id of the component connector
+         * @returns ComponentConnectorCapabilities
+         */
+        this.getCapabilities = (connectorId) => __awaiter(this, void 0, void 0, function* () {
+            const res = yield __classPrivateFieldGet(this, _ComponentConnectorController_editorAPI, "f");
+            return res
+                .componentConnectorGetCapabilities(connectorId)
+                .then((result) => getEditorResponseData(result));
+        });
+        __classPrivateFieldSet(this, _ComponentConnectorController_editorAPI, editorAPI, "f");
+        __classPrivateFieldSet(this, _ComponentConnectorController_blobAPI, editorAPI, "f");
+    }
+}
+_ComponentConnectorController_editorAPI = new WeakMap(), _ComponentConnectorController_blobAPI = new WeakMap();
+//# sourceMappingURL=ComponentConnectorController.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ComponentConnectorController.js","sourceRoot":"","sources":["../../../../src/controllers/ComponentConnectorController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;AAIA,OAAO,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AAE9F;;;;;;;;;;;;;;GAcG;AACH,MAAM,OAAO,4BAA4B;IAOrC;;OAEG;IACH,YAAY,SAAoB;QAThC;;WAEG;QACH,0DAAsB;QACtB,wDAAuB;QAUvB;;;;;;;;WAQG;QACH,UAAK,GAAG,2CAAgF,EAAE,gFAA3E,WAAmB,EAAE,YAA0B,EAAE,UAAoB,EAAE;YAClF,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,+CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,uBAAuB,CAAC,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;iBAC3F,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAuB,MAAM,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAA,CAAC;QAEF;;;;;;;;;;WAUG;QACH,YAAO,GAAG,yDAKa,EAAE,8FAJrB,WAAmB,EACnB,WAAmB,EACnB,WAAiC,EACjC,UAAoB,EAAE;YAEtB,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,6CAAS,CAAC;YAChC,OAAO,GAAG;iBACL,yBAAyB,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;iBACzF,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACb,2CAA2C;gBAC3C,IAAI,MAAM,YAAY,UAAU,EAAE,CAAC;oBAC/B,OAAO,MAAM,CAAC;gBAClB,CAAC;gBAED,oEAAoE;gBACpE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,SAAS,IAAI,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;oBAC1F,wBAAwB,CAAC,MAA8B,CAAC,CAAC;gBAC7D,CAAC;gBAED,yCAAyC;gBACzC,MAAM,IAAI,KAAK,CAAC,6BAA6B,OAAO,MAAM,GAAG,CAAC,CAAC;YACnE,CAAC,CAAC,CAAC;QACX,CAAC,CAAA,CAAC;QAEF;;;;;;;WAOG;QACH,4BAAuB,GAAG,CAAO,WAAmB,EAAE,EAAE;YACpD,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,+CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,yCAAyC,CAAC,WAAW,CAAC;iBACtD,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAyB,MAAM,CAAC,CAAC,CAAC;QACjF,CAAC,CAAA,CAAC;QAEF;;;;;;WAMG;QACH,oBAAe,GAAG,CAAO,WAAmB,EAAE,EAAE;YAC5C,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,+CAAW,CAAC;YAClC,OAAO,GAAG;iBACL,iCAAiC,CAAC,WAAW,CAAC;iBAC9C,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,qBAAqB,CAAiC,MAAM,CAAC,CAAC,CAAC;QACzF,CAAC,CAAA,CAAC;QAnFE,uBAAA,IAAI,2CAAc,SAAS,MAAA,CAAC;QAC5B,uBAAA,IAAI,yCAAY,SAAuC,MAAA,CAAC;IAC5D,CAAC;CAkFJ"}

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

@@ -0,0 +1,28 @@
+import { EditorAPI, Id } from '../types/CommonTypes';
+import { Variable } from '../types/VariableTypes';
+/**
+ * @experimental This controller is experimental and may change without warning.
+ * The ComponentController is responsible for all communication regarding Component frames.
+ * Methods inside this controller can be called by `window.SDK.component.{method-name}`
+ */
+export declare class ComponentController {
+    #private;
+    /**
+     * @ignore
+     */
+    constructor(editorAPI: EditorAPI);
+    /**
+     * @experimental This method will link (or unlink) a variable from the template to the component frame
+     * @param id the id of the componentFrame that needs to be updated.
+     * @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.
+     * @returns
+     */
+    linkVariable: (frameId: Id, target: Id, source?: Id) => Promise<import('../types/CommonTypes').EditorResponse<null>>;
+    /**
+     * This method returns the list of variables of a component frame.
+     * @param id the id of the componentFrame.
+     * @returns
+     */
+    getComponentVariables: (frameId: Id) => Promise<import('../types/CommonTypes').EditorResponse<Variable[]>>;
+}