@contrail/extensions-sdk 1.0.22 → 1.0.23

package/lib/apps/showcase.d.ts

@@ -3,7 +3,8 @@ export declare enum ShowcaseCommand {
     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"
+    MODIFY_ELEMENTS = "showcase:modify_elements",
+    NAVIGATE_TO_FRAME = "showcase:navigate_to_frame"
 }
 export interface ShowcaseDocumentElement extends DocumentElement {
     [key: string]: any;
@@ -30,6 +31,17 @@ export interface AddCanvasFrameToShowcasePayload {
         };
     };
 }
+export declare type NavigateToFrameInShowcasePayload = {
+    frameId: string;
+    frameIndex?: never;
+} | {
+    frameIndex: number;
+    frameId?: never;
+};
+export interface NavigateToFrameResult {
+    frameId: string;
+    frameIndex: number;
+}
 export declare class ShowcaseApp {
     static getCurrentShowcase(): any;
     static addElements(elements: Array<ShowcaseDocumentElement>, frameId?: string): void;
@@ -41,6 +53,7 @@ export declare class ShowcaseApp {
         };
     }): Promise<any>;
     static modifyElements(changeObjects: Array<ShowcaseDocumentElementChanges>, frameId?: string): void;
+    static navigateToFrame(target: NavigateToFrameInShowcasePayload): Promise<NavigateToFrameResult>;
     static addItemsToClipboard(clipboardItems: Array<{
         itemId: string;
         projectItemId?: string | null;

package/lib/apps/showcase.js

@@ -18,6 +18,7 @@ var ShowcaseCommand;
     ShowcaseCommand["ADD_ELEMENTS"] = "showcase:add_elements";
     ShowcaseCommand["ADD_CANVAS_FRAME"] = "showcase:add_canvas_frame";
     ShowcaseCommand["MODIFY_ELEMENTS"] = "showcase:modify_elements";
+    ShowcaseCommand["NAVIGATE_TO_FRAME"] = "showcase:navigate_to_frame";
 })(ShowcaseCommand = exports.ShowcaseCommand || (exports.ShowcaseCommand = {}));
 class ShowcaseApp {
     static getCurrentShowcase() {
@@ -52,6 +53,19 @@ class ShowcaseApp {
             (0, actions_1.getExtensionActions)().sendMessageToHost({ command: ShowcaseCommand.MODIFY_ELEMENTS, data });
         }
     }
+    static navigateToFrame(target) {
+        return __awaiter(this, void 0, void 0, function* () {
+            ShowcaseApp.validateShowcaseContext();
+            if (!target || (!('frameId' in target) && !('frameIndex' in target))) {
+                throw new Error('navigateToFrame requires either a frameId or a frameIndex.');
+            }
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+                command: ShowcaseCommand.NAVIGATE_TO_FRAME,
+                data: target,
+            });
+            return ShowcaseApp.validateAndReturnResults(results);
+        });
+    }
     static addItemsToClipboard(clipboardItems) {
         ShowcaseApp.validateShowcaseContext();
         if (clipboardItems === null || clipboardItems === void 0 ? void 0 : clipboardItems.length) {

package/package.json

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