@contrail/extensions-sdk 1.0.15 → 1.0.16

package/.github/pull_request_template.md

@@ -1,9 +1,11 @@
 ## What
+
 - [ ] Bugfix
 - [ ] Feature
 - [ ] Enhancement
 
-Description: 
+Description:
+
 <!--
 Describe the functional changes of the PR.
 
@@ -15,16 +17,15 @@ 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/check-code-formatting.yml

@@ -0,0 +1,34 @@
+name: Check Code Formatting
+on:
+  pull_request:
+    paths:
+      - '**'
+  workflow_dispatch: # allow running in github actions manually
+jobs:
+  check-formatting:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.13.0
+      - uses: actions/checkout@v3
+        with:
+          lfs: true
+      - name: Checkout LFS objects
+        run: git lfs checkout
+      - name: NPM Install
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npm ci
+      - name: Check Format
+        working-directory: ./
+        run: npx prettier --check .
+      - name: Fail On Warnings
+        run: |
+          if [ $? -eq 0 ]; then
+            echo "No formatting issues found"
+          else
+            echo "Formatting issues found. Run 'npx prettier --write .' to fix them."
+            exit 1
+          fi

package/.github/workflows/empty.yml

@@ -1,6 +1,5 @@
 name: empty-passing-test
-on:
-  pull_request
+on: pull_request
 jobs:
   test:
     runs-on: ubuntu-20.04

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

@@ -3,7 +3,7 @@ on:
   pull_request:
     # run this workflow when files these files change
     paths:
-      - "**"
+      - '**'
   workflow_dispatch: # allow running in github actions manually
 jobs:
   test:

package/.husky/pre-commit

@@ -0,0 +1,13 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+if [ "$BYPASS_FORMATTING_CHECK" = "true" ]; then
+  echo ""
+  echo "⚠️ ======== WARNING ======== ⚠️"
+  echo "   Formatting Check Bypassed"  # This looks off-center but prints correctly
+  echo "⚠️ ========================= ⚠️"
+  echo ""
+  exit 0
+fi
+
+npm run lint-staged:check

package/.lintstagedrc-check.json

@@ -0,0 +1,3 @@
+{
+  "*.{js,ts,html,css,json,yml,yaml}": "prettier --check"
+}

package/.lintstagedrc-format.json

@@ -0,0 +1,3 @@
+{
+  "*.{ts,js,html,css,yml,yaml}": "prettier --write"
+}

package/.prettierignore

@@ -0,0 +1,9 @@
+**/.git
+**/.svn
+**/.hg
+**/node_modules
+**/.angular
+**/.nyc_output
+**/build
+**/coverage
+**/*.svg

package/.prettierrc.yaml

@@ -0,0 +1,2 @@
+singleQuote: true
+printWidth: 120

package/README.md

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

package/lib/actions/actions.d.ts

@@ -1,7 +1,7 @@
-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";
+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;
 }

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

@@ -1,4 +1,4 @@
-import { User } from "@contrail/entity-types";
+import { User } from '@contrail/entity-types';
 export declare enum VibeIQAppType {
     BOARDS = "boards",
     PLAN = "plan",

package/lib/apps/boards.d.ts

@@ -1,11 +1,13 @@
 import { DocumentElement } from '@contrail/documents';
+import { FrameDocumentTemplate } from '@contrail/document-generation';
 export declare enum BoardCommand {
     ADD_ELEMENTS = "board:add_elements",
     DELETE_ELEMENTS = "board:delete_elements",
     MODIFY_ELEMENTS = "board:modify_elements",
     GET_ELEMENTS = "board:get_elements",
     RECOLOR_IMAGES = "board:recolor_images",
-    ADD_CONTENT_TO_ENTITY_FROM_ELEMENTS = "board:add_content_to_entity_from_elements"
+    ADD_CONTENT_TO_ENTITY_FROM_ELEMENTS = "board:add_content_to_entity_from_elements",
+    ADD_FRAMES_FROM_TEMPLATE = "board:add_frames_from_template"
 }
 export interface BoardDocumentElement extends DocumentElement {
     [key: string]: any;
@@ -19,9 +21,29 @@ export interface AppClientResults {
     data?: any;
     error?: string;
 }
+export declare type FrameFromTemplateParams = {
+    frameTemplate: FrameDocumentTemplate;
+    frameOptions?: {
+        position: {
+            x: number;
+            y: number;
+        };
+    };
+    frameTemplateId?: never;
+} | {
+    frameTemplateId: string;
+    frameOptions?: {
+        position: {
+            x: number;
+            y: number;
+        };
+    };
+    frameTemplate?: never;
+};
 export declare class BoardsApp {
     static getCurrentBoard(): any;
     static addElements(elements: Array<BoardDocumentElement>): void;
+    static addFramesFromTemplate(frames: Array<FrameFromTemplateParams>): Promise<Array<DocumentElement>>;
     static deleteElements(elements: Array<BoardDocumentElement>): void;
     static modifyElements(changeObjects: Array<BoardDocumentElementChanges>): void;
     static getElements(criteria: object): Promise<Array<DocumentElement>>;

package/lib/apps/boards.js

@@ -20,6 +20,7 @@ var BoardCommand;
     BoardCommand["GET_ELEMENTS"] = "board:get_elements";
     BoardCommand["RECOLOR_IMAGES"] = "board:recolor_images";
     BoardCommand["ADD_CONTENT_TO_ENTITY_FROM_ELEMENTS"] = "board:add_content_to_entity_from_elements";
+    BoardCommand["ADD_FRAMES_FROM_TEMPLATE"] = "board:add_frames_from_template";
 })(BoardCommand = exports.BoardCommand || (exports.BoardCommand = {}));
 class BoardsApp {
     static getCurrentBoard() {
@@ -29,9 +30,25 @@ class BoardsApp {
     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 });
+            (0, actions_1.getExtensionActions)().sendMessageToHost({
+                command: BoardCommand.ADD_ELEMENTS,
+                data: elements,
+            });
         }
     }
+    static addFramesFromTemplate(frames) {
+        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({
+                    command: BoardCommand.ADD_FRAMES_FROM_TEMPLATE,
+                    data: frames,
+                });
+                return this.validateAndReturnResults(results);
+            }
+            return [];
+        });
+    }
     static deleteElements(elements) {
         BoardsApp.validateBoardContext();
         const elementsWithIds = elements.filter((element) => !!element.id);
@@ -42,13 +59,19 @@ class BoardsApp {
     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 });
+            (0, actions_1.getExtensionActions)().sendMessageToHost({
+                command: BoardCommand.MODIFY_ELEMENTS,
+                data: changeObjects,
+            });
         }
     }
     static getElements(criteria) {
         return __awaiter(this, void 0, void 0, function* () {
             BoardsApp.validateBoardContext();
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.GET_ELEMENTS, data: criteria });
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+                command: BoardCommand.GET_ELEMENTS,
+                data: criteria,
+            });
             return this.validateAndReturnResults(results);
         });
     }
@@ -58,23 +81,29 @@ class BoardsApp {
             const data = {
                 assignmentOptions,
                 entity,
-                elements
+                elements,
             };
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.ADD_CONTENT_TO_ENTITY_FROM_ELEMENTS, data });
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+                command: BoardCommand.ADD_CONTENT_TO_ENTITY_FROM_ELEMENTS,
+                data,
+            });
             return this.validateAndReturnResults(results);
         });
     }
     static recolorImages(imageElements, hexCode, hexMap = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             BoardsApp.validateBoardContext();
-            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({ command: BoardCommand.RECOLOR_IMAGES, data: { imageElements, hexCode, hexMap } });
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToHost({
+                command: BoardCommand.RECOLOR_IMAGES,
+                data: { imageElements, hexCode, hexMap },
+            });
             return this.validateAndReturnResults(results);
         });
     }
     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.");
+            throw new Error('App extension has not been initialized with Board context.');
         }
     }
     static validateAndReturnResults(results) {

package/lib/apps/plan.d.ts

@@ -1,4 +1,4 @@
-import { PlanContext } from "./app-context";
+import { PlanContext } from './app-context';
 export declare enum PlanCommand {
     ADD_ROWS = "plan:add_rows",
     SHOW_MESSAGE = "plan:show_message",

package/lib/apps/plan.js

@@ -52,7 +52,7 @@ class PlanApp {
     static validatePlanContext() {
         const context = (0, app_context_1.getAppContext)();
         if (context.appContext.vibeIQApp !== app_context_1.VibeIQAppType.PLAN || !context.appContext.plan) {
-            throw new Error("App extension has not been initialized with Plan context.");
+            throw new Error('App extension has not been initialized with Plan context.');
         }
     }
 }

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

@@ -1,4 +1,4 @@
-import { EntitiesClientBatchCreateOptions, EntitiesClientBatchDeleteOptions, EntitiesClientBatchUpdateOptions, EntitiesClientCreateOptions, EntitiesClientDeleteOptions, EntitiesClientGetOptions, API_VERSION } from "@contrail/sdk";
+import { EntitiesClientBatchCreateOptions, EntitiesClientBatchDeleteOptions, EntitiesClientBatchUpdateOptions, EntitiesClientCreateOptions, EntitiesClientDeleteOptions, EntitiesClientGetOptions, API_VERSION } from '@contrail/sdk';
 declare class EntitiesClientUpdateOptions {
     entityName?: string;
     object: any;

package/lib/entities/entities-client.js

@@ -17,43 +17,64 @@ 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 });
+            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 });
+            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 });
+            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 });
+            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 });
+            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 });
+            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 });
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToEntitiesClient({
+                method: entities_action_handler_1.EntitiesClientMethods.BATCH_DELETE,
+                options,
+            });
             return this.validateAndReturnEntityClientResults(results);
         });
     }

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

@@ -27,7 +27,7 @@ class AppExtensionHost {
                 appExtension.init(context);
             }
             catch (error) {
-                console.error("Failed to connect host app with app extension:", error);
+                console.error('Failed to connect host app with app extension:', error);
                 throw error;
             }
         });
@@ -45,7 +45,7 @@ class AppExtensionHost {
             },
             sendMessageToHost(message) {
                 return customMessageHandler.handleMessage(message);
-            }
+            },
         };
     }
 }

package/lib/extensions/app-extension.js

@@ -28,7 +28,7 @@ class AppExtension {
                 });
             }
             catch (error) {
-                console.error("Failed to connect app extension with host application:", error);
+                console.error('Failed to connect app extension with host application:', error);
                 throw error;
             }
         });
@@ -37,19 +37,18 @@ class AppExtension {
         return {
             init(context) {
                 return AppExtension.initAppExtension(context);
-            }
+            },
         };
     }
     static initAppExtension(context) {
         return __awaiter(this, void 0, void 0, function* () {
-            console.log("[AppExtension]: Initialized: Received context: ", context);
+            console.log('[AppExtension]: Initialized: Received context: ', context);
             (0, app_context_1.setAppContext)(context);
             if (AppExtension.initPromiseResolver) {
                 AppExtension.initPromiseResolver();
             }
         });
     }
-    ;
     static close() {
         (0, actions_1.getExtensionActions)().close();
     }

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

@@ -1,4 +1,4 @@
-import { TypeClientOptions } from "@contrail/sdk";
+import { TypeClientOptions } from '@contrail/sdk';
 import { Type, TypeProperty } from '@contrail/types';
 export declare class TypesClient {
     getType(options: TypeClientOptions): Promise<Type>;

package/lib/types/types-client.js

@@ -15,20 +15,29 @@ 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 });
+            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 });
+            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 });
+            const results = yield (0, actions_1.getExtensionActions)().sendMessageToTypesClient({
+                method: types_action_handler_1.TypesClientMethods.GET_PROPERTY,
+                options: getPropertyOptions,
+            });
             return this.validateAndReturnTypeClientResults(results);
         });
     }

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@contrail/extensions-sdk",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "Client library for interfacing with VibeIQ's services and apps from an extension.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
   "scripts": {
     "build": "tsc",
-    "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
-    "lint": "tslint -p tsconfig.json",
+    "prepare": "husky install",
+    "lint-staged:check": "lint-staged --config .lintstagedrc-check.json",
+    "lint-staged:format": "lint-staged --allow-empty --config .lintstagedrc-format.json",
     "generate-docs": "npx typedoc src/index.ts --disableSources --excludeInternal  --plugin typedoc-plugin-extras --favicon home-hero.svg",
     "test": "jest"
   },
@@ -16,21 +17,25 @@
   "license": "ISC",
   "dependencies": {
     "@contrail/documents": "^1.1.3",
+    "@contrail/document-generation": "^2.1.26",
     "@contrail/entity-types": "^1.1.35",
     "penpal": "^6.2.2"
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",
     "@types/node": "^14.10.1",
+    "husky": "^9.0.11",
     "jest": "^29.5.0",
-    "prettier": "^1.19.1",
+    "lint-staged": "^15.2.5",
+    "prettier": "^3.2.5",
     "ts-jest": "^29.1.1",
-    "tslint": "^5.11.0",
-    "tslint-config-prettier": "^1.18.0",
     "typedoc": "^0.25.7",
     "typedoc-plugin-extras": "^3.0.0",
     "typescript": "^4.0.0"
   },
+  "lint-staged": {
+    "*.{js,css,md}": "prettier --write"
+  },
   "peerDependencies": {
     "@contrail/sdk": "^1.3.7"
   },