@contrail/extensions-sdk 1.0.6 → 1.0.7-alpha.0

package/lib/actions/actions.d.ts

@@ -9,7 +9,7 @@ export interface ExtensionActions {
     close(): void;
     sendMessageToEntitiesClient(message: EntitiesClientAction): Promise<any>;
     sendMessageToTypesClient(message: TypesClientAction): Promise<any>;
-    sendMessageToHost(message: AppExtensionMessage): void;
+    sendMessageToHost(message: AppExtensionMessage): Promise<any>;
 }
 export declare let EXTENSION_ACTIONS: ExtensionActions;
 export declare function setExtensionActions(actions: ExtensionActions): void;

package/lib/apps/boards.d.ts

@@ -1,5 +1,20 @@
+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<any>): void;
+    static addElements(elements: Array<BoardDocumentElement>): void;
+    static deleteElements(elements: Array<BoardDocumentElement>): void;
+    static modifyElements(changeObjects: Array<BoardDocumentElementChanges>): void;
     private static validateBoardContext;
 }

package/lib/apps/boards.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BoardsApp = void 0;
+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();
@@ -10,8 +16,22 @@ class BoardsApp {
     }
     static addElements(elements) {
         BoardsApp.validateBoardContext();
-        const actions = (0, actions_1.getExtensionActions)();
-        actions.sendMessageToHost({ command: 'board:add_elements', data: elements });
+        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)();

package/lib/apps/plan.d.ts

@@ -1,4 +1,9 @@
 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[];

package/lib/apps/plan.js

@@ -1,8 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PlanApp = void 0;
+exports.PlanApp = exports.PlanCommand = void 0;
 const actions_1 = require("../actions/actions");
 const app_context_1 = require("./app-context");
+var PlanCommand;
+(function (PlanCommand) {
+    PlanCommand["ADD_ROWS"] = "plan:add_rows";
+    PlanCommand["SHOW_MESSAGE"] = "plan:show_message";
+    PlanCommand["CLEAR_SELECTED_ROWS"] = "plan:clear_selected_rows";
+})(PlanCommand = exports.PlanCommand || (exports.PlanCommand = {}));
 class PlanApp {
     static getCurrentPlan() {
         PlanApp.validatePlanContext();
@@ -28,18 +34,20 @@ class PlanApp {
     }
     static addRows(collectionElements) {
         PlanApp.validatePlanContext();
-        const actions = (0, actions_1.getExtensionActions)();
-        actions.sendMessageToHost({ command: 'plan:add_rows', data: collectionElements });
+        if (collectionElements === null || collectionElements === void 0 ? void 0 : collectionElements.length) {
+            const actions = (0, actions_1.getExtensionActions)();
+            actions.sendMessageToHost({ command: PlanCommand.ADD_ROWS, data: collectionElements });
+        }
     }
     static clearSelectedRows() {
         PlanApp.validatePlanContext();
         const actions = (0, actions_1.getExtensionActions)();
-        actions.sendMessageToHost({ command: 'plan:clear_selected_rows' });
+        actions.sendMessageToHost({ command: PlanCommand.CLEAR_SELECTED_ROWS });
     }
     static showMessage(message) {
         PlanApp.validatePlanContext();
         const actions = (0, actions_1.getExtensionActions)();
-        actions.sendMessageToHost({ command: 'plan:show_message', data: message });
+        actions.sendMessageToHost({ command: PlanCommand.SHOW_MESSAGE, data: message });
     }
     static validatePlanContext() {
         const context = (0, app_context_1.getAppContext)();

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

@@ -44,7 +44,7 @@ class AppExtensionHost {
                 return types_action_handler_1.TypesActionHandler.handleActionFromExtension(message);
             },
             sendMessageToHost(message) {
-                customMessageHandler.handleMessage(message);
+                return customMessageHandler.handleMessage(message);
             }
         };
     }

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

@@ -3,5 +3,5 @@ export interface AppExtensionMessage {
     data?: any;
 }
 export interface AppExtensionMessageHandler {
-    handleMessage: (message: AppExtensionMessage) => {};
+    handleMessage: (message: AppExtensionMessage) => Promise<any>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/extensions-sdk",
-  "version": "1.0.6",
+  "version": "1.0.7-alpha.0",
   "description": "Client library for interfacing with VibeIQ's services and apps from an extension.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -16,6 +16,7 @@
   "license": "ISC",
   "dependencies": {
     "@contrail/entity-types": "^1.1.35",
+    "@contrail/documents": "^1.0.86",
     "penpal": "^6.2.2"
   },
   "devDependencies": {