@contrail/extensions-sdk 1.0.2 → 1.0.3

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

@@ -1,18 +1,54 @@
 import { User } from "@contrail/entity-types";
 export declare enum VibeIQAppType {
-    boards = "boards",
-    plan = "plan",
-    showcase = "showcase"
+    BOARDS = "boards",
+    PLAN = "plan",
+    SHOWCASE = "showcase"
 }
 export interface AppContext {
     appContext?: {
-        plan?: any;
-        board?: any;
+        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

@@ -3,9 +3,9 @@ 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["BOARDS"] = "boards";
+    VibeIQAppType["PLAN"] = "plan";
+    VibeIQAppType["SHOWCASE"] = "showcase";
 })(VibeIQAppType = exports.VibeIQAppType || (exports.VibeIQAppType = {}));
 exports.CONTEXT = {};
 function setAppContext(context) {

package/lib/apps/boards.js

@@ -15,7 +15,7 @@ class BoardsApp {
     }
     static validateBoardContext() {
         const context = (0, app_context_1.getAppContext)();
-        if (context.appContext.vibeIQApp !== app_context_1.VibeIQAppType.boards || !context.appContext.board) {
+        if (context.appContext.vibeIQApp !== app_context_1.VibeIQAppType.BOARDS || !context.appContext.board) {
             throw new Error("App extension has not been initialized with Board context.");
         }
     }

package/lib/apps/plan.d.ts

@@ -1,5 +1,8 @@
+import { PlanContext } from "./app-context";
 export declare class PlanApp {
-    static getCurrentPlan(): any;
+    static getCurrentPlan(): PlanContext;
+    static getAllPlanPlaceholders(): any[];
+    static getFilteredPlanPlaceholders(): any[];
     static addRows(collectionElements: Array<any>): void;
     static clearSelectedRows(): void;
     static showMessage(message: string): void;

package/lib/apps/plan.js

@@ -8,6 +8,24 @@ class PlanApp {
         PlanApp.validatePlanContext();
         return (0, app_context_1.getAppContext)().appContext.plan;
     }
+    static getAllPlanPlaceholders() {
+        var _a;
+        PlanApp.validatePlanContext();
+        const plan = PlanApp.getCurrentPlan();
+        return (_a = plan === null || plan === void 0 ? void 0 : plan.planPlaceholders) !== null && _a !== void 0 ? _a : [];
+    }
+    static getFilteredPlanPlaceholders() {
+        var _a;
+        PlanApp.validatePlanContext();
+        const plan = PlanApp.getCurrentPlan();
+        const allPlanPlaceholders = PlanApp.getAllPlanPlaceholders();
+        if (!(plan === null || plan === void 0 ? void 0 : plan.hasFilter)) {
+            return allPlanPlaceholders;
+        }
+        const filteredPlanPlaceholderIds = (_a = plan.filteredPlanPlaceholderIds) !== null && _a !== void 0 ? _a : [];
+        const filteredResults = allPlanPlaceholders.filter((placeholder) => filteredPlanPlaceholderIds.includes(placeholder.id));
+        return filteredResults;
+    }
     static addRows(collectionElements) {
         PlanApp.validatePlanContext();
         const actions = (0, actions_1.getExtensionActions)();
@@ -25,7 +43,7 @@ class PlanApp {
     }
     static validatePlanContext() {
         const context = (0, app_context_1.getAppContext)();
-        if (context.appContext.vibeIQApp !== app_context_1.VibeIQAppType.plan || !context.appContext.plan) {
+        if (context.appContext.vibeIQApp !== app_context_1.VibeIQAppType.PLAN || !context.appContext.plan) {
             throw new Error("App extension has not been initialized with Plan context.");
         }
     }

package/package.json

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