@contrail/extensions-sdk 1.0.18-2 → 1.0.18-4

package/lib/actions/actions.d.ts

@@ -1,9 +1,10 @@
-import { AppContext } from '../apps/app-context';
+import { AppContext, AppExtensionEvent } from '../apps/app-context';
 import { EntitiesClientAction } from '../entities/entities-action-handler';
 import { AppExtensionMessage } from '../extensions/app-extension-message-handler';
 import { TypesClientAction } from '../types/types-action-handler';
 export interface RegisterExtensionActions {
-    init(context: AppContext): void;
+    init(context: AppContext): Promise<void>;
+    emitEvent(event: AppExtensionEvent): void;
 }
 export interface ExtensionActions {
     close(): void;
@@ -11,6 +12,7 @@ export interface ExtensionActions {
     sendMessageToTypesClient(message: TypesClientAction): Promise<any>;
     sendMessageToHost(message: AppExtensionMessage): Promise<any>;
 }
-export declare let EXTENSION_ACTIONS: ExtensionActions;
+export declare let EXTENSION_ACTIONS: ExtensionActions | undefined;
 export declare function setExtensionActions(actions: ExtensionActions): void;
-export declare function getExtensionActions(): ExtensionActions;
+export declare function getExtensionActions(): ExtensionActions | undefined;
+export declare function getExtensionActionsOrThrow(): ExtensionActions;

package/lib/actions/actions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExtensionActions = exports.setExtensionActions = exports.EXTENSION_ACTIONS = void 0;
+exports.getExtensionActionsOrThrow = exports.getExtensionActions = exports.setExtensionActions = exports.EXTENSION_ACTIONS = void 0;
 function setExtensionActions(actions) {
     exports.EXTENSION_ACTIONS = actions;
 }
@@ -9,3 +9,11 @@ function getExtensionActions() {
     return exports.EXTENSION_ACTIONS;
 }
 exports.getExtensionActions = getExtensionActions;
+function getExtensionActionsOrThrow() {
+    const actions = exports.EXTENSION_ACTIONS;
+    if (!actions) {
+        throw new Error('Extension is not connected. Ensure AppExtension.registerAppExtension() has resolved before using this API.');
+    }
+    return actions;
+}
+exports.getExtensionActionsOrThrow = getExtensionActionsOrThrow;

package/lib/apps/app-context.d.ts

@@ -1,4 +1,26 @@
 import { User } from '@contrail/entity-types';
+interface Document {
+    id: string;
+    name: string;
+    orgId: string;
+    ownedByReference: string;
+    size: {
+        width: string;
+        height: string;
+    };
+    elements: any[];
+    documentElementSortOrder: any;
+    modelBindings: any;
+    workspaceId: string;
+}
+interface Frame {
+    id: string;
+    name: string;
+    orgId: string;
+    ownedByReference: string;
+    documentId: string;
+    document?: Document;
+}
 export declare enum VibeIQAppType {
     BOARDS = "boards",
     PLAN = "plan",
@@ -52,9 +74,26 @@ export interface BoardContext {
     workspaceId?: string;
 }
 export interface ShowcaseContext {
-    currentFrame?: any;
-    frames?: any[];
+    id: string;
+    name: string;
+    orgId: string;
+    currentFrame: Frame;
+    frames?: Frame[];
+    rootWorkspaceId?: string;
+    workspaceId?: string;
+    previewFileId?: string;
+    backingAssortmentId?: string;
+}
+export declare enum AppEventType {
+    SelectedElementsChanged = "selected_elements_changed",
+    ShowcaseFramesChanged = "showcase_frames_changed",
+    ShowcaseCurrentFrameChanged = "showcase_current_frame_changed"
+}
+export interface AppExtensionEvent<T = any> {
+    type: AppEventType;
+    data: T;
 }
 export declare const CONTEXT: AppContext;
 export declare function setAppContext(context: AppContext): void;
 export declare function getAppContext(): AppContext;
+export {};

package/lib/apps/app-context.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppContext = exports.setAppContext = exports.CONTEXT = exports.VibeIQAppType = void 0;
+exports.getAppContext = exports.setAppContext = exports.CONTEXT = exports.AppEventType = exports.VibeIQAppType = void 0;
 var VibeIQAppType;
 (function (VibeIQAppType) {
     VibeIQAppType["BOARDS"] = "boards";
@@ -8,6 +8,12 @@ var VibeIQAppType;
     VibeIQAppType["SHOWCASE"] = "showcase";
     VibeIQAppType["ADMIN_CONSOLE"] = "admin_console";
 })(VibeIQAppType = exports.VibeIQAppType || (exports.VibeIQAppType = {}));
+var AppEventType;
+(function (AppEventType) {
+    AppEventType["SelectedElementsChanged"] = "selected_elements_changed";
+    AppEventType["ShowcaseFramesChanged"] = "showcase_frames_changed";
+    AppEventType["ShowcaseCurrentFrameChanged"] = "showcase_current_frame_changed";
+})(AppEventType = exports.AppEventType || (exports.AppEventType = {}));
 exports.CONTEXT = {};
 function setAppContext(context) {
     Object.assign(exports.CONTEXT, context);

package/lib/apps/boards.js

@@ -30,7 +30,7 @@ class BoardsApp {
     static addElements(elements) {
         BoardsApp.validateBoardContext();
         if (elements === null || elements === void 0 ? void 0 : elements.length) {
-            (0, actions_1.getExtensionActions)().sendMessageToHost({
+            (0, actions_1.getExtensionActionsOrThrow)().sendMessageToHost({
                 command: BoardCommand.ADD_ELEMENTS,
                 data: elements,
             });
@@ -40,7 +40,7 @@ class BoardsApp {
         return __awaiter(this, void 0, void 0, function* () {
             BoardsApp.validateBoardContext();
             if (frames === null || frames === void 0 ? void 0 : frames.length) {
-                const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+                const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToHost({
                     command: BoardCommand.ADD_FRAMES_FROM_TEMPLATE,
                     data: frames,
                 });
@@ -53,13 +53,13 @@ class BoardsApp {
         BoardsApp.validateBoardContext();
         const elementsWithIds = elements.filter((element) => !!element.id);
         if (elementsWithIds === null || elementsWithIds === void 0 ? void 0 : elementsWithIds.length) {
-            (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.DELETE_ELEMENTS, data: elementsWithIds });
+            (0, actions_1.getExtensionActionsOrThrow)().sendMessageToHost({ command: BoardCommand.DELETE_ELEMENTS, data: elementsWithIds });
         }
     }
     static modifyElements(changeObjects) {
         BoardsApp.validateBoardContext();
         if (changeObjects === null || changeObjects === void 0 ? void 0 : changeObjects.length) {
-            (0, actions_1.getExtensionActions)().sendMessageToHost({
+            (0, actions_1.getExtensionActionsOrThrow)().sendMessageToHost({
                 command: BoardCommand.MODIFY_ELEMENTS,
                 data: changeObjects,
             });
@@ -68,7 +68,7 @@ class BoardsApp {
     static getElements(criteria) {
         return __awaiter(this, void 0, void 0, function* () {
             BoardsApp.validateBoardContext();
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToHost({
                 command: BoardCommand.GET_ELEMENTS,
                 data: criteria,
             });
@@ -83,7 +83,7 @@ class BoardsApp {
                 entity,
                 elements,
             };
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToHost({
                 command: BoardCommand.ADD_CONTENT_TO_ENTITY_FROM_ELEMENTS,
                 data,
             });
@@ -93,7 +93,7 @@ class BoardsApp {
     static recolorImages(imageElements, hexCode, hexMap = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             BoardsApp.validateBoardContext();
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToHost({
                 command: BoardCommand.RECOLOR_IMAGES,
                 data: { imageElements, hexCode, hexMap },
             });

package/lib/apps/plan.js

@@ -35,18 +35,18 @@ class PlanApp {
     static addRows(collectionElements) {
         PlanApp.validatePlanContext();
         if (collectionElements === null || collectionElements === void 0 ? void 0 : collectionElements.length) {
-            const actions = (0, actions_1.getExtensionActions)();
+            const actions = (0, actions_1.getExtensionActionsOrThrow)();
             actions.sendMessageToHost({ command: PlanCommand.ADD_ROWS, data: collectionElements });
         }
     }
     static clearSelectedRows() {
         PlanApp.validatePlanContext();
-        const actions = (0, actions_1.getExtensionActions)();
+        const actions = (0, actions_1.getExtensionActionsOrThrow)();
         actions.sendMessageToHost({ command: PlanCommand.CLEAR_SELECTED_ROWS });
     }
     static showMessage(message) {
         PlanApp.validatePlanContext();
-        const actions = (0, actions_1.getExtensionActions)();
+        const actions = (0, actions_1.getExtensionActionsOrThrow)();
         actions.sendMessageToHost({ command: PlanCommand.SHOW_MESSAGE, data: message });
     }
     static validatePlanContext() {

package/lib/entities/entities-client.js

@@ -17,7 +17,7 @@ class EntitiesClientUpdateOptions {
 class EntitiesClient {
     get(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToEntitiesClient({
                 method: entities_action_handler_1.EntitiesClientMethods.GET,
                 options,
             });
@@ -26,7 +26,7 @@ class EntitiesClient {
     }
     create(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToEntitiesClient({
                 method: entities_action_handler_1.EntitiesClientMethods.CREATE,
                 options,
             });
@@ -35,7 +35,7 @@ class EntitiesClient {
     }
     batchCreate(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToEntitiesClient({
                 method: entities_action_handler_1.EntitiesClientMethods.BATCH_CREATE,
                 options,
             });
@@ -44,7 +44,7 @@ class EntitiesClient {
     }
     update(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToEntitiesClient({
                 method: entities_action_handler_1.EntitiesClientMethods.UPDATE,
                 options,
             });
@@ -53,7 +53,7 @@ class EntitiesClient {
     }
     batchUpdate(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToEntitiesClient({
                 method: entities_action_handler_1.EntitiesClientMethods.BATCH_UPDATE,
                 options,
             });
@@ -62,7 +62,7 @@ class EntitiesClient {
     }
     delete(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToEntitiesClient({
                 method: entities_action_handler_1.EntitiesClientMethods.DELETE,
                 options,
             });
@@ -71,7 +71,7 @@ class EntitiesClient {
     }
     batchDelete(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToEntitiesClient({
                 method: entities_action_handler_1.EntitiesClientMethods.BATCH_DELETE,
                 options,
             });

package/lib/extensions/app-extension-host.d.ts

@@ -1,6 +1,11 @@
-import { AppContext } from '../apps/app-context';
+import { AppContext, AppExtensionEvent } from '../apps/app-context';
 import { AppExtensionMessageHandler } from './app-extension-message-handler';
+export interface RegisterHostWithAppExtensionOptions {
+    timeoutMs?: number;
+}
 export declare class AppExtensionHost {
-    static registerHostWithAppExtension(iframe: HTMLIFrameElement, context: AppContext, customMessageHandler: AppExtensionMessageHandler): Promise<void>;
+    private static appExtension;
+    static registerHostWithAppExtension(iframe: HTMLIFrameElement, context: AppContext, customMessageHandler: AppExtensionMessageHandler, options?: RegisterHostWithAppExtensionOptions): Promise<void>;
+    static emitEvent(event: AppExtensionEvent): void;
     private static getExtensionActionsToRunOnHost;
 }

package/lib/extensions/app-extension-host.js

@@ -13,18 +13,21 @@ exports.AppExtensionHost = void 0;
 const penpal_1 = require("penpal");
 const entities_action_handler_1 = require("../entities/entities-action-handler");
 const types_action_handler_1 = require("../types/types-action-handler");
+const connection_timeout_1 = require("./connection-timeout");
 class AppExtensionHost {
-    static registerHostWithAppExtension(iframe, context, customMessageHandler) {
+    static registerHostWithAppExtension(iframe, context, customMessageHandler, options) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const hostActions = AppExtensionHost.getExtensionActionsToRunOnHost(customMessageHandler);
                 const connection = (0, penpal_1.connectToChild)({ iframe, methods: Object.assign({}, hostActions) });
-                const iframeWindow = iframe.contentWindow;
-                iframeWindow.postMessage({ isConnected: true }, iframe.src);
                 console.log('[HostApp] Awaiting connection to app extension...');
-                const appExtension = yield connection.promise;
+                const connectionPromise = (options === null || options === void 0 ? void 0 : options.timeoutMs) !== undefined
+                    ? (0, connection_timeout_1.withConnectionTimeout)(connection.promise, options.timeoutMs, () => new connection_timeout_1.HostConnectionTimeoutError(options.timeoutMs))
+                    : connection.promise;
+                const appExtension = yield connectionPromise;
                 console.log('[HostApp] Connected to app extension.');
-                appExtension.init(context);
+                AppExtensionHost.appExtension = appExtension;
+                yield appExtension.init(context);
             }
             catch (error) {
                 console.error('Failed to connect host app with app extension:', error);
@@ -32,6 +35,13 @@ class AppExtensionHost {
             }
         });
     }
+    static emitEvent(event) {
+        if (!AppExtensionHost.appExtension) {
+            console.warn('[HostApp] Cannot emit event: no app extension connected.');
+            return;
+        }
+        AppExtensionHost.appExtension.emitEvent(event);
+    }
     static getExtensionActionsToRunOnHost(customMessageHandler) {
         return {
             close() {
@@ -50,3 +60,4 @@ class AppExtensionHost {
     }
 }
 exports.AppExtensionHost = AppExtensionHost;
+AppExtensionHost.appExtension = null;

package/lib/extensions/app-extension.d.ts

@@ -1,12 +1,15 @@
+import { AppEventType } from '../apps/app-context';
+export interface RegisterAppExtensionOptions {
+    timeoutMs?: number;
+}
 export declare class AppExtension {
     private static initPromiseResolver;
-    private static contextUpdateCallbacks;
-    private static messageListener;
-    static registerAppExtension(): Promise<void>;
+    private static eventListeners;
+    static registerAppExtension(options?: RegisterAppExtensionOptions): Promise<void>;
     private static getExtensionActions;
     private static initAppExtension;
+    private static handleEvent;
+    private static getCurrentValueForEvent;
+    static subscribe<T = any>(eventType: AppEventType, listener: (data: T) => void): () => void;
     static close(): void;
-    private static setupContextUpdateListener;
-    static onContextUpdate(callback: () => void): () => void;
-    static cleanup(): void;
 }

package/lib/extensions/app-extension.js

@@ -13,17 +13,20 @@ exports.AppExtension = void 0;
 const penpal_1 = require("penpal");
 const app_context_1 = require("../apps/app-context");
 const actions_1 = require("../actions/actions");
+const connection_timeout_1 = require("./connection-timeout");
 class AppExtension {
-    static registerAppExtension() {
+    static registerAppExtension(options) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 const extensionRegistrationActions = AppExtension.getExtensionActions();
                 const connection = (0, penpal_1.connectToParent)({ methods: Object.assign({}, extensionRegistrationActions) });
                 console.log('[AppExtension] Awaiting connection to host app...');
-                const hostApp = yield connection.promise;
+                const connectionPromise = (options === null || options === void 0 ? void 0 : options.timeoutMs) !== undefined
+                    ? (0, connection_timeout_1.withConnectionTimeout)(connection.promise, options.timeoutMs, () => new connection_timeout_1.ExtensionConnectionTimeoutError(options.timeoutMs))
+                    : connection.promise;
+                const hostApp = yield connectionPromise;
                 console.log('[AppExtension] Connected to host app.');
                 (0, actions_1.setExtensionActions)(hostApp);
-                AppExtension.setupContextUpdateListener();
                 yield new Promise((resolve) => {
                     AppExtension.initPromiseResolver = resolve;
                 });
@@ -39,6 +42,9 @@ class AppExtension {
             init(context) {
                 return AppExtension.initAppExtension(context);
             },
+            emitEvent(event) {
+                return AppExtension.handleEvent(event);
+            },
         };
     }
     static initAppExtension(context) {
@@ -50,48 +56,75 @@ class AppExtension {
             }
         });
     }
-    static close() {
-        (0, actions_1.getExtensionActions)().close();
+    static handleEvent(event) {
+        var _a, _b, _c, _d, _e, _f, _g;
+        const existing = (0, app_context_1.getAppContext)();
+        switch (event.type) {
+            case app_context_1.AppEventType.SelectedElementsChanged:
+                (0, app_context_1.setAppContext)(Object.assign(Object.assign({}, existing), { appContext: Object.assign(Object.assign({}, ((_a = existing.appContext) !== null && _a !== void 0 ? _a : {})), { selectedElements: event.data }) }));
+                break;
+            case app_context_1.AppEventType.ShowcaseFramesChanged:
+                (0, app_context_1.setAppContext)(Object.assign(Object.assign({}, existing), { appContext: Object.assign(Object.assign({}, ((_b = existing.appContext) !== null && _b !== void 0 ? _b : {})), { showcase: Object.assign(Object.assign({}, ((_d = (_c = existing.appContext) === null || _c === void 0 ? void 0 : _c.showcase) !== null && _d !== void 0 ? _d : {})), { frames: event.data }) }) }));
+                break;
+            case app_context_1.AppEventType.ShowcaseCurrentFrameChanged:
+                (0, app_context_1.setAppContext)(Object.assign(Object.assign({}, existing), { appContext: Object.assign(Object.assign({}, ((_e = existing.appContext) !== null && _e !== void 0 ? _e : {})), { showcase: Object.assign(Object.assign({}, ((_g = (_f = existing.appContext) === null || _f === void 0 ? void 0 : _f.showcase) !== null && _g !== void 0 ? _g : {})), { currentFrame: event.data }) }) }));
+                break;
+        }
+        const listeners = AppExtension.eventListeners.get(event.type);
+        if (listeners) {
+            listeners.forEach((listener) => {
+                try {
+                    listener(event.data);
+                }
+                catch (error) {
+                    console.error(`[AppExtension] Error in listener for event "${event.type}":`, error);
+                }
+            });
+        }
     }
-    static setupContextUpdateListener() {
-        if (AppExtension.messageListener) {
-            return;
+    static getCurrentValueForEvent(eventType) {
+        var _a, _b, _c, _d, _e;
+        const ctx = (0, app_context_1.getAppContext)();
+        switch (eventType) {
+            case app_context_1.AppEventType.SelectedElementsChanged:
+                return (_a = ctx.appContext) === null || _a === void 0 ? void 0 : _a.selectedElements;
+            case app_context_1.AppEventType.ShowcaseFramesChanged:
+                return (_c = (_b = ctx.appContext) === null || _b === void 0 ? void 0 : _b.showcase) === null || _c === void 0 ? void 0 : _c.frames;
+            case app_context_1.AppEventType.ShowcaseCurrentFrameChanged:
+                return (_e = (_d = ctx.appContext) === null || _d === void 0 ? void 0 : _d.showcase) === null || _e === void 0 ? void 0 : _e.currentFrame;
         }
-        AppExtension.messageListener = (event) => {
-            var _a, _b, _c;
-            if (((_a = event.data) === null || _a === void 0 ? void 0 : _a.type) === 'vibeiq:context_update' && ((_b = event.data) === null || _b === void 0 ? void 0 : _b.appContext)) {
-                const existing = (0, app_context_1.getAppContext)();
-                (0, app_context_1.setAppContext)(Object.assign(Object.assign({}, existing), { appContext: Object.assign(Object.assign({}, ((_c = existing.appContext) !== null && _c !== void 0 ? _c : {})), event.data.appContext) }));
-                AppExtension.contextUpdateCallbacks.forEach((callback) => {
-                    try {
-                        callback();
-                    }
-                    catch (error) {
-                        console.error('[AppExtension] Error in context update callback:', error);
-                    }
-                });
-            }
-        };
-        window.addEventListener('message', AppExtension.messageListener);
     }
-    static onContextUpdate(callback) {
-        AppExtension.contextUpdateCallbacks.push(callback);
+    static subscribe(eventType, listener) {
+        if (!AppExtension.eventListeners.has(eventType)) {
+            AppExtension.eventListeners.set(eventType, []);
+        }
+        AppExtension.eventListeners.get(eventType).push(listener);
+        const currentValue = AppExtension.getCurrentValueForEvent(eventType);
+        if (currentValue !== undefined) {
+            try {
+                listener(currentValue);
+            }
+            catch (error) {
+                console.error(`[AppExtension] Error emitting initial value for event "${eventType}":`, error);
+            }
+        }
         return () => {
-            const index = AppExtension.contextUpdateCallbacks.indexOf(callback);
-            if (index > -1) {
-                AppExtension.contextUpdateCallbacks.splice(index, 1);
+            const listeners = AppExtension.eventListeners.get(eventType);
+            if (listeners) {
+                const index = listeners.indexOf(listener);
+                if (index > -1) {
+                    listeners.splice(index, 1);
+                }
             }
         };
     }
-    static cleanup() {
-        if (AppExtension.messageListener) {
-            window.removeEventListener('message', AppExtension.messageListener);
-            AppExtension.messageListener = null;
+    static close() {
+        const actions = (0, actions_1.getExtensionActions)();
+        if (actions) {
+            actions.close();
         }
-        AppExtension.contextUpdateCallbacks = [];
     }
 }
 exports.AppExtension = AppExtension;
 AppExtension.initPromiseResolver = null;
-AppExtension.contextUpdateCallbacks = [];
-AppExtension.messageListener = null;
+AppExtension.eventListeners = new Map();

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/lib/extensions/index.d.ts

@@ -1,3 +1,4 @@
 export * from './app-extension-host';
 export * from './app-extension-message-handler';
 export * from './app-extension';
+export * from './connection-timeout';

package/lib/extensions/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./app-extension-host"), exports);
 __exportStar(require("./app-extension-message-handler"), exports);
 __exportStar(require("./app-extension"), exports);
+__exportStar(require("./connection-timeout"), exports);

package/lib/types/types-client.js

@@ -15,7 +15,7 @@ const types_action_handler_1 = require("./types-action-handler");
 class TypesClient {
     getType(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToTypesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToTypesClient({
                 method: types_action_handler_1.TypesClientMethods.GET_TYPE,
                 options,
             });
@@ -24,7 +24,7 @@ class TypesClient {
     }
     getByRootAndPath(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToTypesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToTypesClient({
                 method: types_action_handler_1.TypesClientMethods.GET_BY_ROOT_AND_PATH,
                 options,
             });
@@ -34,7 +34,7 @@ class TypesClient {
     getProperty(typeId, propertySlug) {
         return __awaiter(this, void 0, void 0, function* () {
             const getPropertyOptions = { typeId, propertySlug };
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToTypesClient({
+            const results = yield (0, actions_1.getExtensionActionsOrThrow)().sendMessageToTypesClient({
                 method: types_action_handler_1.TypesClientMethods.GET_PROPERTY,
                 options: getPropertyOptions,
             });

package/package.json

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