@contrail/extensions-sdk 1.0.20 → 1.0.22

package/lib/apps/showcase.d.ts

@@ -1,11 +1,50 @@
+import { DocumentElement } from '@contrail/documents';
 export declare enum ShowcaseCommand {
-    ADD_ITEMS_TO_CLIPBOARD = "showcase:add_items_to_clipboard"
+    ADD_ITEMS_TO_CLIPBOARD = "showcase:add_items_to_clipboard",
+    ADD_ELEMENTS = "showcase:add_elements",
+    ADD_CANVAS_FRAME = "showcase:add_canvas_frame",
+    MODIFY_ELEMENTS = "showcase:modify_elements"
+}
+export interface ShowcaseDocumentElement extends DocumentElement {
+    [key: string]: any;
+}
+export interface ShowcaseDocumentElementChanges {
+    id: string;
+    changes: ShowcaseDocumentElement;
+}
+export interface AddElementsToShowcasePayload {
+    elements: Array<ShowcaseDocumentElement>;
+    frameId?: string;
+}
+export interface ModifyElementsInShowcasePayload {
+    changeObjects: Array<ShowcaseDocumentElementChanges>;
+    frameId?: string;
+}
+export interface AddCanvasFrameToShowcasePayload {
+    elements: Array<ShowcaseDocumentElement>;
+    frameOptions?: {
+        name?: string;
+        size?: {
+            width: number;
+            height: number;
+        };
+    };
 }
 export declare class ShowcaseApp {
     static getCurrentShowcase(): any;
+    static addElements(elements: Array<ShowcaseDocumentElement>, frameId?: string): void;
+    static addCanvasFrame(elements: Array<ShowcaseDocumentElement>, frameOptions?: {
+        name?: string;
+        size?: {
+            width: number;
+            height: number;
+        };
+    }): Promise<any>;
+    static modifyElements(changeObjects: Array<ShowcaseDocumentElementChanges>, frameId?: string): void;
     static addItemsToClipboard(clipboardItems: Array<{
         itemId: string;
         projectItemId?: string | null;
     }>): void;
     private static validateShowcaseContext;
+    private static validateAndReturnResults;
 }

package/lib/apps/showcase.js

@@ -1,4 +1,13 @@
 "use strict";
+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());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShowcaseApp = exports.ShowcaseCommand = void 0;
 const actions_1 = require("../actions/actions");
@@ -6,6 +15,9 @@ const app_context_1 = require("./app-context");
 var ShowcaseCommand;
 (function (ShowcaseCommand) {
     ShowcaseCommand["ADD_ITEMS_TO_CLIPBOARD"] = "showcase:add_items_to_clipboard";
+    ShowcaseCommand["ADD_ELEMENTS"] = "showcase:add_elements";
+    ShowcaseCommand["ADD_CANVAS_FRAME"] = "showcase:add_canvas_frame";
+    ShowcaseCommand["MODIFY_ELEMENTS"] = "showcase:modify_elements";
 })(ShowcaseCommand = exports.ShowcaseCommand || (exports.ShowcaseCommand = {}));
 class ShowcaseApp {
     static getCurrentShowcase() {
@@ -13,6 +25,33 @@ class ShowcaseApp {
         ShowcaseApp.validateShowcaseContext();
         return (_a = (0, app_context_1.getAppContext)().appContext) === null || _a === void 0 ? void 0 : _a.showcase;
     }
+    static addElements(elements, frameId) {
+        ShowcaseApp.validateShowcaseContext();
+        if (elements === null || elements === void 0 ? void 0 : elements.length) {
+            const data = { elements, frameId };
+            (0, actions_1.getExtensionActions)().sendMessageToHost({ command: ShowcaseCommand.ADD_ELEMENTS, data });
+        }
+    }
+    static addCanvasFrame(elements, frameOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            ShowcaseApp.validateShowcaseContext();
+            if (elements === null || elements === void 0 ? void 0 : elements.length) {
+                const data = { elements, frameOptions };
+                const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+                    command: ShowcaseCommand.ADD_CANVAS_FRAME,
+                    data,
+                });
+                return this.validateAndReturnResults(results);
+            }
+        });
+    }
+    static modifyElements(changeObjects, frameId) {
+        ShowcaseApp.validateShowcaseContext();
+        if (changeObjects === null || changeObjects === void 0 ? void 0 : changeObjects.length) {
+            const data = { changeObjects, frameId };
+            (0, actions_1.getExtensionActions)().sendMessageToHost({ command: ShowcaseCommand.MODIFY_ELEMENTS, data });
+        }
+    }
     static addItemsToClipboard(clipboardItems) {
         ShowcaseApp.validateShowcaseContext();
         if (clipboardItems === null || clipboardItems === void 0 ? void 0 : clipboardItems.length) {
@@ -29,5 +68,12 @@ class ShowcaseApp {
             throw new Error('App extension has not been initialized with Showcase context.');
         }
     }
+    static validateAndReturnResults(results) {
+        var _a;
+        if (!results.success) {
+            throw new Error((_a = results.error) !== null && _a !== void 0 ? _a : 'App operation failed.');
+        }
+        return results.data;
+    }
 }
 exports.ShowcaseApp = ShowcaseApp;

package/lib/extensions/connection-timeout.d.ts

@@ -0,0 +1,7 @@
+export declare class ExtensionConnectionTimeoutError extends Error {
+    constructor(timeoutMs: number);
+}
+export declare class HostConnectionTimeoutError extends Error {
+    constructor(timeoutMs: number);
+}
+export declare function withConnectionTimeout<T>(promise: Promise<T>, timeoutMs: number, createError: () => Error): Promise<T>;

package/lib/extensions/connection-timeout.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withConnectionTimeout = exports.HostConnectionTimeoutError = exports.ExtensionConnectionTimeoutError = void 0;
+class ExtensionConnectionTimeoutError extends Error {
+    constructor(timeoutMs) {
+        super(`Extension connection to host timed out after ${timeoutMs}ms. Ensure the host calls registerHostWithAppExtension after the extension iframe has loaded.`);
+        this.name = 'ExtensionConnectionTimeoutError';
+        Object.setPrototypeOf(this, ExtensionConnectionTimeoutError.prototype);
+    }
+}
+exports.ExtensionConnectionTimeoutError = ExtensionConnectionTimeoutError;
+class HostConnectionTimeoutError extends Error {
+    constructor(timeoutMs) {
+        super(`Host connection to extension timed out after ${timeoutMs}ms. Ensure the extension calls registerAppExtension() on load and the iframe has loaded.`);
+        this.name = 'HostConnectionTimeoutError';
+        Object.setPrototypeOf(this, HostConnectionTimeoutError.prototype);
+    }
+}
+exports.HostConnectionTimeoutError = HostConnectionTimeoutError;
+function withConnectionTimeout(promise, timeoutMs, createError) {
+    return new Promise((resolve, reject) => {
+        const timer = setTimeout(() => reject(createError()), timeoutMs);
+        promise
+            .then((value) => {
+            clearTimeout(timer);
+            resolve(value);
+        })
+            .catch((err) => {
+            clearTimeout(timer);
+            reject(err);
+        });
+    });
+}
+exports.withConnectionTimeout = withConnectionTimeout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/extensions-sdk",
-  "version": "1.0.20",
+  "version": "1.0.22",
   "description": "Client library for interfacing with VibeIQ's services and apps from an extension.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",