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

package/lib/actions/actions.d.ts

@@ -1,13 +1,15 @@
 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>;
-    sendMessageToHost(message: AppExtensionMessage): void;
+    sendMessageToTypesClient(message: TypesClientAction): Promise<any>;
+    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/entities/entities-action-handler.d.ts

@@ -1,7 +1,16 @@
 export interface EntitiesClientAction {
-    method: string;
+    method: EntitiesClientMethods;
     options: any;
 }
+export declare enum EntitiesClientMethods {
+    GET = "get",
+    CREATE = "create",
+    BATCH_CREATE = "batchCreate",
+    UPDATE = "update",
+    BATCH_UPDATE = "batchUpdate",
+    DELETE = "delete",
+    BATCH_DELETE = "batchDelete"
+}
 export interface EntitiesClientResults {
     success: boolean;
     data?: any;

package/lib/entities/entities-action-handler.js

@@ -9,8 +9,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EntitiesActionHandler = void 0;
+exports.EntitiesActionHandler = exports.EntitiesClientMethods = void 0;
 const sdk_1 = require("@contrail/sdk");
+var EntitiesClientMethods;
+(function (EntitiesClientMethods) {
+    EntitiesClientMethods["GET"] = "get";
+    EntitiesClientMethods["CREATE"] = "create";
+    EntitiesClientMethods["BATCH_CREATE"] = "batchCreate";
+    EntitiesClientMethods["UPDATE"] = "update";
+    EntitiesClientMethods["BATCH_UPDATE"] = "batchUpdate";
+    EntitiesClientMethods["DELETE"] = "delete";
+    EntitiesClientMethods["BATCH_DELETE"] = "batchDelete";
+})(EntitiesClientMethods = exports.EntitiesClientMethods || (exports.EntitiesClientMethods = {}));
 class EntitiesActionHandler {
     static handleActionFromExtension(action) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -26,19 +36,19 @@ class EntitiesActionHandler {
     static executeAction(action) {
         return __awaiter(this, void 0, void 0, function* () {
             switch (action.method) {
-                case 'get':
+                case EntitiesClientMethods.GET:
                     return yield new sdk_1.Entities().get(action.options);
-                case 'create':
+                case EntitiesClientMethods.CREATE:
                     return yield new sdk_1.Entities().create(action.options);
-                case 'batchCreate':
+                case EntitiesClientMethods.BATCH_CREATE:
                     return yield new sdk_1.Entities().batchCreate(action.options);
-                case 'update':
+                case EntitiesClientMethods.UPDATE:
                     return yield new sdk_1.Entities().update(action.options);
-                case 'batchUpdate':
+                case EntitiesClientMethods.BATCH_UPDATE:
                     return yield new sdk_1.Entities().batchUpdate(action.options);
-                case 'delete':
+                case EntitiesClientMethods.DELETE:
                     return yield new sdk_1.Entities().delete(action.options);
-                case 'batchDelete':
+                case EntitiesClientMethods.BATCH_DELETE:
                     return yield new sdk_1.Entities().batchDelete(action.options);
             }
         });

package/lib/entities/entities-client.d.ts

@@ -0,0 +1,22 @@
+import { EntitiesClientBatchCreateOptions, EntitiesClientBatchDeleteOptions, EntitiesClientBatchUpdateOptions, EntitiesClientCreateOptions, EntitiesClientDeleteOptions, EntitiesClientGetOptions, API_VERSION } from "@contrail/sdk";
+declare class EntitiesClientUpdateOptions {
+    entityName?: string;
+    object: any;
+    id?: string;
+    reference?: string;
+    relation?: string;
+    relationId?: string;
+    apiVersion?: API_VERSION;
+    suffix?: string;
+}
+export declare class EntitiesClient {
+    get(options: EntitiesClientGetOptions): Promise<any | any[]>;
+    create(options: EntitiesClientCreateOptions): Promise<any>;
+    batchCreate(options: EntitiesClientBatchCreateOptions): Promise<any[]>;
+    update(options: EntitiesClientUpdateOptions): Promise<any>;
+    batchUpdate(options: EntitiesClientBatchUpdateOptions): Promise<any[]>;
+    delete(options: EntitiesClientDeleteOptions): Promise<any>;
+    batchDelete(options: EntitiesClientBatchDeleteOptions): Promise<any[]>;
+    private validateAndReturnEntityClientResults;
+}
+export {};

package/lib/entities/entities-client.js

@@ -0,0 +1,68 @@
+"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.EntitiesClient = void 0;
+const actions_1 = require("../actions/actions");
+const entities_action_handler_1 = require("./entities-action-handler");
+class EntitiesClientUpdateOptions {
+}
+class EntitiesClient {
+    get(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({ method: entities_action_handler_1.EntitiesClientMethods.GET, options });
+            return this.validateAndReturnEntityClientResults(results);
+        });
+    }
+    create(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({ method: entities_action_handler_1.EntitiesClientMethods.CREATE, options });
+            return this.validateAndReturnEntityClientResults(results);
+        });
+    }
+    batchCreate(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({ method: entities_action_handler_1.EntitiesClientMethods.BATCH_CREATE, options });
+            return this.validateAndReturnEntityClientResults(results);
+        });
+    }
+    update(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({ method: entities_action_handler_1.EntitiesClientMethods.UPDATE, options });
+            return this.validateAndReturnEntityClientResults(results);
+        });
+    }
+    batchUpdate(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({ method: entities_action_handler_1.EntitiesClientMethods.BATCH_UPDATE, options });
+            return this.validateAndReturnEntityClientResults(results);
+        });
+    }
+    delete(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({ method: entities_action_handler_1.EntitiesClientMethods.DELETE, options });
+            return this.validateAndReturnEntityClientResults(results);
+        });
+    }
+    batchDelete(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({ method: entities_action_handler_1.EntitiesClientMethods.BATCH_DELETE, options });
+            return this.validateAndReturnEntityClientResults(results);
+        });
+    }
+    validateAndReturnEntityClientResults(results) {
+        var _a;
+        if (!results.success) {
+            throw new Error((_a = results.error) !== null && _a !== void 0 ? _a : 'Entity operation failed.');
+        }
+        return results.data;
+    }
+}
+exports.EntitiesClient = EntitiesClient;

package/lib/entities/index.d.ts

@@ -1 +1 @@
-export * from './entities-web-client';
+export * from './entities-client';

package/lib/entities/index.js

@@ -14,4 +14,4 @@ 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 });
-__exportStar(require("./entities-web-client"), exports);
+__exportStar(require("./entities-client"), exports);

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

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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");
 class AppExtensionHost {
     static registerHostWithAppExtension(iframe, context, customMessageHandler) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -39,8 +40,11 @@ class AppExtensionHost {
             sendMessageToEntitiesClient(message) {
                 return entities_action_handler_1.EntitiesActionHandler.handleActionFromExtension(message);
             },
+            sendMessageToTypesClient(message) {
+                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/lib/index.d.ts

@@ -1,3 +1,4 @@
 export * from './apps';
 export * from './entities';
 export * from './extensions';
+export * from './types';

package/lib/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./apps"), exports);
 __exportStar(require("./entities"), exports);
 __exportStar(require("./extensions"), exports);
+__exportStar(require("./types"), exports);

package/lib/types/index.d.ts

@@ -0,0 +1 @@
+export * from './types-client';

package/lib/types/index.js

@@ -0,0 +1,17 @@
+"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 });
+__exportStar(require("./types-client"), exports);

package/lib/types/types-action-handler.d.ts

@@ -0,0 +1,18 @@
+export interface TypesClientAction {
+    method: TypesClientMethods;
+    options: any;
+}
+export declare enum TypesClientMethods {
+    GET_TYPE = "getType",
+    GET_BY_ROOT_AND_PATH = "getByRootAndPath",
+    GET_PROPERTY = "getProperty"
+}
+export interface TypesClientResults {
+    success: boolean;
+    data?: any;
+    error?: string;
+}
+export declare class TypesActionHandler {
+    static handleActionFromExtension(action: TypesClientAction): Promise<TypesClientResults>;
+    private static executeAction;
+}

package/lib/types/types-action-handler.js

@@ -0,0 +1,45 @@
+"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.TypesActionHandler = exports.TypesClientMethods = void 0;
+const sdk_1 = require("@contrail/sdk");
+var TypesClientMethods;
+(function (TypesClientMethods) {
+    TypesClientMethods["GET_TYPE"] = "getType";
+    TypesClientMethods["GET_BY_ROOT_AND_PATH"] = "getByRootAndPath";
+    TypesClientMethods["GET_PROPERTY"] = "getProperty";
+})(TypesClientMethods = exports.TypesClientMethods || (exports.TypesClientMethods = {}));
+class TypesActionHandler {
+    static handleActionFromExtension(action) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const data = yield TypesActionHandler.executeAction(action);
+                return { success: true, data };
+            }
+            catch (e) {
+                return { success: false, error: e.message };
+            }
+        });
+    }
+    static executeAction(action) {
+        return __awaiter(this, void 0, void 0, function* () {
+            switch (action.method) {
+                case TypesClientMethods.GET_TYPE:
+                    return yield new sdk_1.Types().getType(action.options);
+                case TypesClientMethods.GET_BY_ROOT_AND_PATH:
+                    return yield new sdk_1.Types().getByRootAndPath(action.options);
+                case TypesClientMethods.GET_PROPERTY:
+                    return yield new sdk_1.Types().getProperty(action.options.typeId, action.options.propertySlug);
+            }
+        });
+    }
+}
+exports.TypesActionHandler = TypesActionHandler;

package/lib/types/types-client.d.ts

@@ -0,0 +1,8 @@
+import { TypeClientOptions } from "@contrail/sdk";
+import { Type, TypeProperty } from '@contrail/types';
+export declare class TypesClient {
+    getType(options: TypeClientOptions): Promise<Type>;
+    getByRootAndPath(options: TypeClientOptions): Promise<Type>;
+    getProperty(typeId: string, propertySlug: string): Promise<TypeProperty>;
+    private validateAndReturnTypeClientResults;
+}

package/lib/types/types-client.js

@@ -0,0 +1,43 @@
+"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.TypesClient = void 0;
+const actions_1 = require("../actions/actions");
+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({ method: types_action_handler_1.TypesClientMethods.GET_TYPE, options });
+            return this.validateAndReturnTypeClientResults(results);
+        });
+    }
+    getByRootAndPath(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToTypesClient({ method: types_action_handler_1.TypesClientMethods.GET_BY_ROOT_AND_PATH, options });
+            return this.validateAndReturnTypeClientResults(results);
+        });
+    }
+    getProperty(typeId, propertySlug) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const getPropertyOptions = { typeId, propertySlug };
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToTypesClient({ method: types_action_handler_1.TypesClientMethods.GET_PROPERTY, options: getPropertyOptions });
+            return this.validateAndReturnTypeClientResults(results);
+        });
+    }
+    validateAndReturnTypeClientResults(results) {
+        var _a;
+        if (!results.success) {
+            throw new Error((_a = results.error) !== null && _a !== void 0 ? _a : 'Type operation failed.');
+        }
+        return results.data;
+    }
+}
+exports.TypesClient = TypesClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/extensions-sdk",
-  "version": "1.0.5",
+  "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": {