@contrail/extensions-sdk 1.0.8 → 1.0.9

package/.github/pull_request_template.md

@@ -1,30 +1,30 @@
-## What
-- [ ] Bugfix
-- [ ] Feature
-- [ ] Enhancement
-
-Description: 
-<!--
-Describe the functional changes of the PR.
-
-If the mechanism of your change are complex, describe them in detail as you
-would if you were explaining them to a team mate.
-
-If the PR is simple, there is no need to repeat yourself. A small description
-is sufficient.
--->
-
-## Why
-<!-- 
-why is this change needed? Same rules as with #What
- -->
-
-
-## Testing added
-<!-- 
-Describe the testing you added to this PR
- -->
-
-
-## Link to Jira ticket(s)
-
+## What
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Enhancement
+
+Description: 
+<!--
+Describe the functional changes of the PR.
+
+If the mechanism of your change are complex, describe them in detail as you
+would if you were explaining them to a team mate.
+
+If the PR is simple, there is no need to repeat yourself. A small description
+is sufficient.
+-->
+
+## Why
+<!-- 
+why is this change needed? Same rules as with #What
+ -->
+
+
+## Testing added
+<!-- 
+Describe the testing you added to this PR
+ -->
+
+
+## Link to Jira ticket(s)
+

package/.github/workflows/empty.yml

@@ -1,11 +1,11 @@
-name: empty-passing-test
-on:
-  pull_request
-jobs:
-  test:
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        node-version: [16.17.0]
-    steps:
-      - run: 'echo "empty test for passing status checks"'
+name: empty-passing-test
+on:
+  pull_request
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        node-version: [16.17.0]
+    steps:
+      - run: 'echo "empty test for passing status checks"'

package/.github/workflows/sdk-lib.yml

@@ -1,27 +1,27 @@
-name: sdk-lib-tests
-on:
-  pull_request:
-    # run this workflow when files these files change
-    paths:
-      - "**"
-  workflow_dispatch: # allow running in github actions manually
-jobs:
-  test:
-    runs-on: ubuntu-20.04
-    steps:
-      - name: Node.js
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - uses: actions/checkout@v3
-
-      - name: NPM Install
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm ci
-
-      - name: Unit Tests -
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm test
+name: sdk-lib-tests
+on:
+  pull_request:
+    # run this workflow when files these files change
+    paths:
+      - "**"
+  workflow_dispatch: # allow running in github actions manually
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - uses: actions/checkout@v3
+
+      - name: NPM Install
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm ci
+
+      - name: Unit Tests -
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm test

package/README.md

@@ -1,2 +1,2 @@
-# Contrail Extensions SDK
-Client library for interfacing with VibeIQ's services and apps from an extension.
+# Contrail Extensions SDK
+Client library for interfacing with VibeIQ's services and apps from an extension.

package/home-hero.svg

@@ -1,11 +1,11 @@
-<svg width="635" height="433" viewBox="0 0 635 433" fill="none" xmlns="http://www.w3.org/2000/svg">
-<g clip-path="url(#clip0_309_15692)">
-<path d="M656.604 384.076C457.662 384.076 414.538 48.9114 216.574 48.9114C172.144 48.9339 129.54 66.5999 98.1308 98.0252C66.7213 129.451 49.077 172.063 49.077 216.494" stroke="#202532" stroke-width="97.8221" stroke-miterlimit="10"/>
-<path d="M49.077 216.494C49.077 309.04 128.454 384.076 216.66 384.076C415.601 384.076 457.747 48.9114 656.689 48.9114C701.134 48.9114 743.76 66.5673 775.188 97.9952C806.615 129.423 824.272 172.048 824.272 216.494C824.272 260.94 806.615 303.565 775.188 334.993C743.76 366.421 701.134 384.076 656.689 384.076" stroke="#00ABE9" stroke-width="97.8221" stroke-miterlimit="10"/>
-</g>
-<defs>
-<clipPath id="clip0_309_15692">
-<rect width="873.016" height="432.987" fill="white" transform="translate(0.166809)"/>
-</clipPath>
-</defs>
-</svg>
+<svg width="635" height="433" viewBox="0 0 635 433" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_309_15692)">
+<path d="M656.604 384.076C457.662 384.076 414.538 48.9114 216.574 48.9114C172.144 48.9339 129.54 66.5999 98.1308 98.0252C66.7213 129.451 49.077 172.063 49.077 216.494" stroke="#202532" stroke-width="97.8221" stroke-miterlimit="10"/>
+<path d="M49.077 216.494C49.077 309.04 128.454 384.076 216.66 384.076C415.601 384.076 457.747 48.9114 656.689 48.9114C701.134 48.9114 743.76 66.5673 775.188 97.9952C806.615 129.423 824.272 172.048 824.272 216.494C824.272 260.94 806.615 303.565 775.188 334.993C743.76 366.421 701.134 384.076 656.689 384.076" stroke="#00ABE9" stroke-width="97.8221" stroke-miterlimit="10"/>
+</g>
+<defs>
+<clipPath id="clip0_309_15692">
+<rect width="873.016" height="432.987" fill="white" transform="translate(0.166809)"/>
+</clipPath>
+</defs>
+</svg>

package/lib/actions/actions.d.ts

@@ -1,16 +1,16 @@
-import { AppContext } 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;
-}
-export interface ExtensionActions {
-    close(): void;
-    sendMessageToEntitiesClient(message: EntitiesClientAction): Promise<any>;
-    sendMessageToTypesClient(message: TypesClientAction): Promise<any>;
-    sendMessageToHost(message: AppExtensionMessage): Promise<any>;
-}
-export declare let EXTENSION_ACTIONS: ExtensionActions;
-export declare function setExtensionActions(actions: ExtensionActions): void;
-export declare function getExtensionActions(): ExtensionActions;
+import { AppContext } 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;
+}
+export interface ExtensionActions {
+    close(): void;
+    sendMessageToEntitiesClient(message: EntitiesClientAction): Promise<any>;
+    sendMessageToTypesClient(message: TypesClientAction): Promise<any>;
+    sendMessageToHost(message: AppExtensionMessage): Promise<any>;
+}
+export declare let EXTENSION_ACTIONS: ExtensionActions;
+export declare function setExtensionActions(actions: ExtensionActions): void;
+export declare function getExtensionActions(): ExtensionActions;

package/lib/actions/actions.js

@@ -1,11 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExtensionActions = exports.setExtensionActions = exports.EXTENSION_ACTIONS = void 0;
-function setExtensionActions(actions) {
-    exports.EXTENSION_ACTIONS = actions;
-}
-exports.setExtensionActions = setExtensionActions;
-function getExtensionActions() {
-    return exports.EXTENSION_ACTIONS;
-}
-exports.getExtensionActions = getExtensionActions;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getExtensionActions = exports.setExtensionActions = exports.EXTENSION_ACTIONS = void 0;
+function setExtensionActions(actions) {
+    exports.EXTENSION_ACTIONS = actions;
+}
+exports.setExtensionActions = setExtensionActions;
+function getExtensionActions() {
+    return exports.EXTENSION_ACTIONS;
+}
+exports.getExtensionActions = getExtensionActions;

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

@@ -1,55 +1,55 @@
-import { User } from "@contrail/entity-types";
-export declare enum VibeIQAppType {
-    BOARDS = "boards",
-    PLAN = "plan",
-    SHOWCASE = "showcase",
-    ADMIN_CONSOLE = "admin_console"
-}
-export interface AppContext {
-    appContext?: {
-        plan?: PlanContext;
-        board?: BoardContext;
-        selectedElements?: any[];
-        vibeIQApp?: VibeIQAppType;
-    };
-    user?: User;
-}
-export interface PlanContext {
-    id: string;
-    name: string;
-    orgId: string;
-    targetAssortmentId: string;
-    workspaceId: string;
-    itemIds?: string[];
-    planPlaceholders?: any[];
-    filteredPlanPlaceholderIds?: string[];
-    hasFilter: boolean;
-}
-export interface BoardContext {
-    id: string;
-    name: string;
-    orgId: string;
-    backingAssortmentId?: string;
-    documentId?: string;
-    document?: {
-        id: string;
-        name: string;
-        orgId: string;
-        ownedByReference: string;
-        size: {
-            width: string;
-            height: string;
-        };
-        elements: any[];
-        documentElementSortOrder: any;
-        modelBindings: any;
-        workspaceId: string;
-    };
-    previewFileId?: string;
-    rootWorkspaceId?: string;
-    typeId?: string;
-    workspaceId?: string;
-}
-export declare const CONTEXT: AppContext;
-export declare function setAppContext(context: AppContext): void;
-export declare function getAppContext(): AppContext;
+import { User } from "@contrail/entity-types";
+export declare enum VibeIQAppType {
+    BOARDS = "boards",
+    PLAN = "plan",
+    SHOWCASE = "showcase",
+    ADMIN_CONSOLE = "admin_console"
+}
+export interface AppContext {
+    appContext?: {
+        plan?: PlanContext;
+        board?: BoardContext;
+        selectedElements?: any[];
+        vibeIQApp?: VibeIQAppType;
+    };
+    user?: User;
+}
+export interface PlanContext {
+    id: string;
+    name: string;
+    orgId: string;
+    targetAssortmentId: string;
+    workspaceId: string;
+    itemIds?: string[];
+    planPlaceholders?: any[];
+    filteredPlanPlaceholderIds?: string[];
+    hasFilter: boolean;
+}
+export interface BoardContext {
+    id: string;
+    name: string;
+    orgId: string;
+    backingAssortmentId?: string;
+    documentId?: string;
+    document?: {
+        id: string;
+        name: string;
+        orgId: string;
+        ownedByReference: string;
+        size: {
+            width: string;
+            height: string;
+        };
+        elements: any[];
+        documentElementSortOrder: any;
+        modelBindings: any;
+        workspaceId: string;
+    };
+    previewFileId?: string;
+    rootWorkspaceId?: string;
+    typeId?: string;
+    workspaceId?: string;
+}
+export declare const CONTEXT: AppContext;
+export declare function setAppContext(context: AppContext): void;
+export declare function getAppContext(): AppContext;

package/lib/apps/app-context.js

@@ -1,19 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppContext = exports.setAppContext = exports.CONTEXT = exports.VibeIQAppType = void 0;
-var VibeIQAppType;
-(function (VibeIQAppType) {
-    VibeIQAppType["BOARDS"] = "boards";
-    VibeIQAppType["PLAN"] = "plan";
-    VibeIQAppType["SHOWCASE"] = "showcase";
-    VibeIQAppType["ADMIN_CONSOLE"] = "admin_console";
-})(VibeIQAppType = exports.VibeIQAppType || (exports.VibeIQAppType = {}));
-exports.CONTEXT = {};
-function setAppContext(context) {
-    Object.assign(exports.CONTEXT, context);
-}
-exports.setAppContext = setAppContext;
-function getAppContext() {
-    return exports.CONTEXT;
-}
-exports.getAppContext = getAppContext;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppContext = exports.setAppContext = exports.CONTEXT = exports.VibeIQAppType = void 0;
+var VibeIQAppType;
+(function (VibeIQAppType) {
+    VibeIQAppType["BOARDS"] = "boards";
+    VibeIQAppType["PLAN"] = "plan";
+    VibeIQAppType["SHOWCASE"] = "showcase";
+    VibeIQAppType["ADMIN_CONSOLE"] = "admin_console";
+})(VibeIQAppType = exports.VibeIQAppType || (exports.VibeIQAppType = {}));
+exports.CONTEXT = {};
+function setAppContext(context) {
+    Object.assign(exports.CONTEXT, context);
+}
+exports.setAppContext = setAppContext;
+function getAppContext() {
+    return exports.CONTEXT;
+}
+exports.getAppContext = getAppContext;

package/lib/apps/boards.d.ts

@@ -1,20 +1,22 @@
-import { DocumentElement } from '@contrail/documents';
-export declare enum BoardCommand {
-    ADD_ELEMENTS = "board:add_elements",
-    DELETE_ELEMENTS = "board:delete_elements",
-    MODIFY_ELEMENTS = "board:modify_elements"
-}
-export interface BoardDocumentElement extends DocumentElement {
-    [key: string]: any;
-}
-export interface BoardDocumentElementChanges {
-    id: string;
-    changes: BoardDocumentElement;
-}
-export declare class BoardsApp {
-    static getCurrentBoard(): any;
-    static addElements(elements: Array<BoardDocumentElement>): void;
-    static deleteElements(elements: Array<BoardDocumentElement>): void;
-    static modifyElements(changeObjects: Array<BoardDocumentElementChanges>): void;
-    private static validateBoardContext;
-}
+import { DocumentElement } from '@contrail/documents';
+export declare enum BoardCommand {
+    ADD_ELEMENTS = "board:add_elements",
+    DELETE_ELEMENTS = "board:delete_elements",
+    MODIFY_ELEMENTS = "board:modify_elements",
+    GET_ELEMENTS = "board:get_elements"
+}
+export interface BoardDocumentElement extends DocumentElement {
+    [key: string]: any;
+}
+export interface BoardDocumentElementChanges {
+    id: string;
+    changes: BoardDocumentElement;
+}
+export declare class BoardsApp {
+    static getCurrentBoard(): any;
+    static addElements(elements: Array<BoardDocumentElement>): void;
+    static deleteElements(elements: Array<BoardDocumentElement>): void;
+    static modifyElements(changeObjects: Array<BoardDocumentElementChanges>): void;
+    static getElements(criteria: object): Promise<Array<DocumentElement>>;
+    private static validateBoardContext;
+}

package/lib/apps/boards.js

@@ -1,43 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BoardsApp = exports.BoardCommand = void 0;
-const actions_1 = require("../actions/actions");
-const app_context_1 = require("./app-context");
-var BoardCommand;
-(function (BoardCommand) {
-    BoardCommand["ADD_ELEMENTS"] = "board:add_elements";
-    BoardCommand["DELETE_ELEMENTS"] = "board:delete_elements";
-    BoardCommand["MODIFY_ELEMENTS"] = "board:modify_elements";
-})(BoardCommand = exports.BoardCommand || (exports.BoardCommand = {}));
-class BoardsApp {
-    static getCurrentBoard() {
-        BoardsApp.validateBoardContext();
-        return (0, app_context_1.getAppContext)().appContext.board;
-    }
-    static addElements(elements) {
-        BoardsApp.validateBoardContext();
-        if (elements === null || elements === void 0 ? void 0 : elements.length) {
-            (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.ADD_ELEMENTS, data: elements });
-        }
-    }
-    static deleteElements(elements) {
-        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 });
-        }
-    }
-    static modifyElements(changeObjects) {
-        BoardsApp.validateBoardContext();
-        if (changeObjects === null || changeObjects === void 0 ? void 0 : changeObjects.length) {
-            (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.MODIFY_ELEMENTS, data: changeObjects });
-        }
-    }
-    static validateBoardContext() {
-        const context = (0, app_context_1.getAppContext)();
-        if (context.appContext.vibeIQApp !== app_context_1.VibeIQAppType.BOARDS || !context.appContext.board) {
-            throw new Error("App extension has not been initialized with Board context.");
-        }
-    }
-}
-exports.BoardsApp = BoardsApp;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BoardsApp = exports.BoardCommand = void 0;
+const actions_1 = require("../actions/actions");
+const app_context_1 = require("./app-context");
+var BoardCommand;
+(function (BoardCommand) {
+    BoardCommand["ADD_ELEMENTS"] = "board:add_elements";
+    BoardCommand["DELETE_ELEMENTS"] = "board:delete_elements";
+    BoardCommand["MODIFY_ELEMENTS"] = "board:modify_elements";
+    BoardCommand["GET_ELEMENTS"] = "board:get_elements";
+})(BoardCommand = exports.BoardCommand || (exports.BoardCommand = {}));
+class BoardsApp {
+    static getCurrentBoard() {
+        BoardsApp.validateBoardContext();
+        return (0, app_context_1.getAppContext)().appContext.board;
+    }
+    static addElements(elements) {
+        BoardsApp.validateBoardContext();
+        if (elements === null || elements === void 0 ? void 0 : elements.length) {
+            (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.ADD_ELEMENTS, data: elements });
+        }
+    }
+    static deleteElements(elements) {
+        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 });
+        }
+    }
+    static modifyElements(changeObjects) {
+        BoardsApp.validateBoardContext();
+        if (changeObjects === null || changeObjects === void 0 ? void 0 : changeObjects.length) {
+            (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.MODIFY_ELEMENTS, data: changeObjects });
+        }
+    }
+    static getElements(criteria) {
+        BoardsApp.validateBoardContext();
+        return (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.GET_ELEMENTS, data: criteria });
+    }
+    static validateBoardContext() {
+        const context = (0, app_context_1.getAppContext)();
+        if (context.appContext.vibeIQApp !== app_context_1.VibeIQAppType.BOARDS || !context.appContext.board) {
+            throw new Error("App extension has not been initialized with Board context.");
+        }
+    }
+}
+exports.BoardsApp = BoardsApp;

package/lib/apps/index.d.ts

@@ -1,3 +1,3 @@
-export { getAppContext, AppContext, BoardContext, PlanContext, VibeIQAppType } from './app-context';
-export * from './boards';
-export * from './plan';
+export { getAppContext, AppContext, BoardContext, PlanContext, VibeIQAppType } from './app-context';
+export * from './boards';
+export * from './plan';

package/lib/apps/index.js

@@ -1,22 +1,22 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.VibeIQAppType = exports.getAppContext = void 0;
-var app_context_1 = require("./app-context");
-Object.defineProperty(exports, "getAppContext", { enumerable: true, get: function () { return app_context_1.getAppContext; } });
-Object.defineProperty(exports, "VibeIQAppType", { enumerable: true, get: function () { return app_context_1.VibeIQAppType; } });
-__exportStar(require("./boards"), exports);
-__exportStar(require("./plan"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VibeIQAppType = exports.getAppContext = void 0;
+var app_context_1 = require("./app-context");
+Object.defineProperty(exports, "getAppContext", { enumerable: true, get: function () { return app_context_1.getAppContext; } });
+Object.defineProperty(exports, "VibeIQAppType", { enumerable: true, get: function () { return app_context_1.VibeIQAppType; } });
+__exportStar(require("./boards"), exports);
+__exportStar(require("./plan"), exports);

package/lib/apps/plan.d.ts

@@ -1,15 +1,15 @@
-import { PlanContext } from "./app-context";
-export declare enum PlanCommand {
-    ADD_ROWS = "plan:add_rows",
-    SHOW_MESSAGE = "plan:show_message",
-    CLEAR_SELECTED_ROWS = "plan:clear_selected_rows"
-}
-export declare class PlanApp {
-    static getCurrentPlan(): PlanContext;
-    static getAllPlanPlaceholders(): any[];
-    static getFilteredPlanPlaceholders(): any[];
-    static addRows(collectionElements: Array<any>): void;
-    static clearSelectedRows(): void;
-    static showMessage(message: string): void;
-    private static validatePlanContext;
-}
+import { PlanContext } from "./app-context";
+export declare enum PlanCommand {
+    ADD_ROWS = "plan:add_rows",
+    SHOW_MESSAGE = "plan:show_message",
+    CLEAR_SELECTED_ROWS = "plan:clear_selected_rows"
+}
+export declare class PlanApp {
+    static getCurrentPlan(): PlanContext;
+    static getAllPlanPlaceholders(): any[];
+    static getFilteredPlanPlaceholders(): any[];
+    static addRows(collectionElements: Array<any>): void;
+    static clearSelectedRows(): void;
+    static showMessage(message: string): void;
+    private static validatePlanContext;
+}