@contrail/cli 3.5.4-alpha.f60c4df → 3.5.5-alpha.270bb0b

package/dist/helpers/app/extensions-deployer.spec.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const extensions_deployer_1 = require("./extensions-deployer");
+const app = {
+    id: 'app-1',
+    identifier: '@vibeiq.com/gap-design-poc',
+    latestAppVersionId: 'version-1',
+};
+describe('buildExtensionDefinition', () => {
+    it('should publish placement as declared, grouped under the app name', () => {
+        const definition = (0, extensions_deployer_1.buildExtensionDefinition)({
+            identifier: 'line-builder',
+            name: 'Line builder',
+            iframeUrl: 'http://localhost:4395/index.html#/line-builder',
+            icon: 'line-builder',
+            appliesTo: { typePaths: ['custom-entity:silhouette'], maxSelected: 20 },
+        }, app, 'Gap');
+        expect(definition).toMatchObject({
+            identifier: '@vibeiq.com/gap-design-poc:line-builder',
+            appVersionId: 'version-1',
+            icon: 'line-builder',
+            appliesTo: { typePaths: ['custom-entity:silhouette'], maxSelected: 20 },
+            group: 'Gap',
+        });
+    });
+    it("should keep an extension's own group", () => {
+        expect((0, extensions_deployer_1.buildExtensionDefinition)({ identifier: 'x', name: 'X', group: 'Tools' }, app, 'Gap').group).toBe('Tools');
+    });
+});

package/dist/helpers/error-helpers.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Returns a human readable message for an error thrown by the SDK or by the CLI.
+ *
+ * The SDK's ApiError is constructed with an undefined message and keeps the raw
+ * response body in `details` (usually a JSON string such as
+ * `{"message":"policy with identifier X not found","statusCode":400}`), so
+ * `${error}` only prints "Error". This digs the API message out of `details`.
+ */
+export declare function describeError(error: any): string;

package/dist/helpers/error-helpers.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.describeError = void 0;
+/**
+ * Returns a human readable message for an error thrown by the SDK or by the CLI.
+ *
+ * The SDK's ApiError is constructed with an undefined message and keeps the raw
+ * response body in `details` (usually a JSON string such as
+ * `{"message":"policy with identifier X not found","statusCode":400}`), so
+ * `${error}` only prints "Error". This digs the API message out of `details`.
+ */
+function describeError(error) {
+    const details = error?.details;
+    if (typeof details === 'string' && details.length) {
+        try {
+            const parsed = JSON.parse(details);
+            const message = parsed?.message;
+            if (Array.isArray(message)) {
+                return message.join(', ');
+            }
+            if (message) {
+                return String(message);
+            }
+        }
+        catch {
+            // not JSON, fall through and use the raw body
+        }
+        return details;
+    }
+    if (details?.message) {
+        return String(details.message);
+    }
+    return error?.message || String(error);
+}
+exports.describeError = describeError;

package/dist/helpers/file-helpers.d.ts

@@ -1,2 +1,4 @@
 export declare function safeFileOverwrite(fileLocation: string, overwrite: boolean): Promise<boolean>;
 export declare function parseCSVData(data: string): any;
+export declare function saveData(data: any, fileLocation: string, overwrite: boolean): Promise<void>;
+export declare function loadData(fileLocation: string): any;

package/dist/helpers/file-helpers.js

@@ -1,8 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseCSVData = exports.safeFileOverwrite = void 0;
+exports.loadData = exports.saveData = exports.parseCSVData = exports.safeFileOverwrite = void 0;
 const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
 const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const logger_1 = tslib_1.__importDefault(require("../logger"));
 const sync_1 = require("csv-parse/sync");
 const PASS_FORCE_TO_OVERWRITE = 'Pass --overwrite to overwrite without prompting';
@@ -34,3 +37,24 @@ function parseCSVData(data) {
     });
 }
 exports.parseCSVData = parseCSVData;
+//saves data as yaml to fileLocation (resolved against the current directory), prompting before overwriting unless overwrite is passed
+async function saveData(data, fileLocation, overwrite) {
+    const yamlStr = js_yaml_1.default.dump(data);
+    const pathToWrite = path.resolve(fileLocation);
+    if (fs_1.default.existsSync(pathToWrite)) {
+        await safeFileOverwrite(pathToWrite, overwrite);
+    }
+    fs_1.default.writeFileSync(pathToWrite, yamlStr, 'utf8');
+}
+exports.saveData = saveData;
+//loads yaml data from fileLocation (resolved against the current directory)
+function loadData(fileLocation) {
+    const pathToRead = path.resolve(fileLocation);
+    try {
+        return js_yaml_1.default.load(fs_1.default.readFileSync(pathToRead, 'utf8'));
+    }
+    catch (e) {
+        throw new Error(`ERROR PARSING YAML: ${e}`);
+    }
+}
+exports.loadData = loadData;

package/dist/helpers/projects/helpers.js

@@ -8,6 +8,7 @@ const fs_1 = tslib_1.__importDefault(require("fs"));
 const sdk_1 = require("@contrail/sdk");
 const util_1 = require("@contrail/util");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
+const file_helpers_1 = require("../file-helpers");
 function getProjectFile(fileName) {
     const CURRENT_DIR = process.cwd();
     try {
@@ -42,7 +43,7 @@ async function exportProject(name) {
     const allAssortments = [];
     await getAssortmentsAndSubFolders(workspace.id, projectConfiguration.assortments, projectConfiguration.subFolders, allAssortments);
     await convertRelationshipsInFolders(projectConfiguration, allAssortments);
-    saveData({ projectConfiguration: projectConfiguration }, name);
+    await (0, file_helpers_1.saveData)({ projectConfiguration: projectConfiguration }, `${name}-export.yml`, true);
 }
 exports.exportProject = exportProject;
 async function getAssortmentsAndSubFolders(parentId, assortments, subFolders, allAssortments) {
@@ -160,8 +161,3 @@ function deleteNonUserKeys(assortment) {
     delete assortment.updatedOn;
     delete assortment.workspaceId;
 }
-function saveData(data, name) {
-    const yamlStr = js_yaml_1.default.dump(data);
-    const CURRENT_DIR = process.cwd();
-    fs_1.default.writeFileSync(path.join(CURRENT_DIR, `${name}-export.yml`), yamlStr, 'utf8');
-}

package/dist/helpers/types/type-parser.js

@@ -4,12 +4,11 @@ exports.parseTypesFromFiles = exports.parseTypesFromTemplateAndDataFromLocalFile
 const tslib_1 = require("tslib");
 const path = tslib_1.__importStar(require("path"));
 const types_1 = require("@contrail/types");
-const fs_1 = tslib_1.__importDefault(require("fs"));
 const csvToJson = tslib_1.__importStar(require("csvtojson"));
 const login_1 = require("../../auth/login");
 const csv_parser_1 = require("../../helpers/types/csv-parser");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const file_helpers_1 = require("../file-helpers");
 async function loadDataFromLocalCSV(fileName) {
     const CURRENT_DIR = process.cwd();
     try {
@@ -37,8 +36,8 @@ async function parseTypesFromLocalFiles(fileLocations) {
     }
     logger_1.default.info(`CSV imports were successful. ${csvJSONData?.length} total rows found.`);
     const suggestions = (0, types_1.GetSuggestedTypes)(csvJSONData);
-    saveData(suggestions.OptionSets, 'parsed_optionSets.yml');
-    saveData({ typeProperties: suggestions.TypeProperties }, 'parsed_typeProperties.yml');
+    await (0, file_helpers_1.saveData)(suggestions.OptionSets, 'parsed_optionSets.yml', true);
+    await (0, file_helpers_1.saveData)({ typeProperties: suggestions.TypeProperties }, 'parsed_typeProperties.yml', true);
 }
 exports.parseTypesFromLocalFiles = parseTypesFromLocalFiles;
 async function parseTypesFromTemplateFromLocalFiles(templateFileLocation, dataFileLocation) {
@@ -57,8 +56,8 @@ async function parseTypesFromTemplateFromLocalFiles(templateFileLocation, dataFi
         throw e;
     }
     const types = (0, types_1.GetTypesFromTemplate)(templateCSVData, dataCSVData);
-    saveData(types.OptionSets, 'parsed_optionSets.yml');
-    saveData({ TypePropertiesByEntity: types.TypePropertiesByEntity }, 'parsed_TypePropertiesByEntity.yml');
+    await (0, file_helpers_1.saveData)(types.OptionSets, 'parsed_optionSets.yml', true);
+    await (0, file_helpers_1.saveData)({ TypePropertiesByEntity: types.TypePropertiesByEntity }, 'parsed_TypePropertiesByEntity.yml', true);
 }
 exports.parseTypesFromTemplateFromLocalFiles = parseTypesFromTemplateFromLocalFiles;
 async function parseTypesFromTemplateAndDataFromLocalFiles(templateFileLocation, dataFileLocations) {
@@ -86,8 +85,8 @@ async function parseTypesFromTemplateAndDataFromLocalFiles(templateFileLocation,
         }
     }
     const types = (0, types_1.GetTypesFromTemplateWithOptionSetsFromData)(templateCSVData, dataCSVData);
-    saveData(types.OptionSets, 'parsed_optionSets.yml');
-    saveData({ TypePropertiesByEntity: types.TypePropertiesByEntity }, 'parsed_TypePropertiesByEntity.yml');
+    await (0, file_helpers_1.saveData)(types.OptionSets, 'parsed_optionSets.yml', true);
+    await (0, file_helpers_1.saveData)({ TypePropertiesByEntity: types.TypePropertiesByEntity }, 'parsed_TypePropertiesByEntity.yml', true);
 }
 exports.parseTypesFromTemplateAndDataFromLocalFiles = parseTypesFromTemplateAndDataFromLocalFiles;
 async function parseTypesFromFiles(fileIds) {
@@ -108,12 +107,7 @@ async function parseTypesFromFiles(fileIds) {
     }
     logger_1.default.info(`CSV downloads were successful. ${csvJSONData?.length} total rows found.`);
     const suggestions = (0, types_1.GetSuggestedTypes)(csvJSONData);
-    saveData(suggestions.OptionSets, 'parsed_optionSets.yml');
-    saveData({ typeProperties: suggestions.TypeProperties }, 'parsed_typeProperties.yml');
+    await (0, file_helpers_1.saveData)(suggestions.OptionSets, 'parsed_optionSets.yml', true);
+    await (0, file_helpers_1.saveData)({ typeProperties: suggestions.TypeProperties }, 'parsed_typeProperties.yml', true);
 }
 exports.parseTypesFromFiles = parseTypesFromFiles;
-function saveData(data, name) {
-    const yamlStr = js_yaml_1.default.dump(data);
-    const CURRENT_DIR = process.cwd();
-    fs_1.default.writeFileSync(path.resolve(path.join(CURRENT_DIR, name, yamlStr)), 'utf8');
-}

package/dist/helpers/workflow-templates/helper.d.ts

@@ -1,7 +1,7 @@
 import { EventWorkflowActionDefinition, WorkflowTemplate, WorkflowTemplateDeclaration } from '../../interfaces';
 export declare class LocalWorkflowTemplateDeployer {
     deployWorkflows(wtDeclaration: WorkflowTemplateDeclaration): Promise<void>;
-    deployWorkflowTemplate(workflow: WorkflowTemplate, existingWorkflows: WorkflowTemplate[], appIdentifier: string | undefined): Promise<WorkflowTemplate>;
+    deployWorkflowTemplate(workflow: WorkflowTemplate, existingWorkflows: WorkflowTemplate[], appIdentifier: string): Promise<WorkflowTemplate>;
     private createNewWorkflowTemplate;
     private populateActionIds;
     createWorkflowSchedule(workflowTemplate: WorkflowTemplate, workflowId: string): Promise<any>;
@@ -18,4 +18,3 @@ export declare class WorkflowTemplateDeployer {
 export declare function deleteWorkflowTemplates(): Promise<void>;
 export declare function localDeployWorkflowTemplate(saveFileLocation: string): Promise<void>;
 export declare function populateActionIdentifiers(workflowTemplate: WorkflowTemplate): Promise<void>;
-export declare function extractShortActionKeys(workflowTemplate: WorkflowTemplate): void;

package/dist/helpers/workflow-templates/helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extractShortActionKeys = exports.populateActionIdentifiers = exports.localDeployWorkflowTemplate = exports.deleteWorkflowTemplates = exports.WorkflowTemplateDeployer = exports.getActionByIdentifier = exports.getWorkflowTemplateIdentifier = exports.LocalWorkflowTemplateDeployer = void 0;
+exports.populateActionIdentifiers = exports.localDeployWorkflowTemplate = exports.deleteWorkflowTemplates = exports.WorkflowTemplateDeployer = exports.getActionByIdentifier = exports.getWorkflowTemplateIdentifier = exports.LocalWorkflowTemplateDeployer = void 0;
 const tslib_1 = require("tslib");
 const util_1 = require("@contrail/util");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
@@ -35,17 +35,15 @@ class LocalWorkflowTemplateDeployer {
         return await this.createNewWorkflowTemplate(identifier, workflow, appIdentifier);
     }
     async createNewWorkflowTemplate(workflowKey, workflowTemplate, appIdentifier) {
-        const appId = await this.populateActionIds(workflowTemplate, workflowKey, appIdentifier);
+        await this.populateActionIds(workflowTemplate, workflowKey, appIdentifier);
         const newObject = {
             identifier: getWorkflowTemplateIdentifier(workflowTemplate),
             name: workflowTemplate.name,
             triggerKey: workflowTemplate.triggerKey,
             workflowDefinition: workflowTemplate.workflowDefinition,
             isActive: workflowTemplate.isActive,
-            supportingAppId: appId,
+            supportingAppId: workflowTemplate.supportingAppId,
             messageGroupId: workflowTemplate.messageGroupId,
-            messageGroup: workflowTemplate.messageGroup,
-            dynamicMessageGroupId: workflowTemplate.dynamicMessageGroupId,
             parallelWorkerCount: workflowTemplate.parallelWorkerCount,
         };
         const newWorkflowTemplate = await (0, event_workflow_templates_1.createWorkflowTemplate)(newObject);
@@ -56,18 +54,11 @@ class LocalWorkflowTemplateDeployer {
         return newWorkflowTemplate;
     }
     async populateActionIds(workflowTemplate, workflowKey, appIdentifier) {
-        if (!appIdentifier) {
-            logger_1.default.info(`WORKFLOW TEMPLATES  No appIdentifier for "${workflowKey}" — skipping action ID resolution.`);
-            return undefined;
-        }
         const installedApps = await (0, apps_1.getInstalledApps)();
-        const appOrg = installedApps.find((x) => x.app?.identifier === appIdentifier);
+        const appOrg = installedApps.find((x) => x.app.identifier === appIdentifier);
         logger_1.default.info('workflow template:', JSON.stringify(workflowTemplate, null, 2));
-        if (!appOrg) {
-            throw new Error(`Could not find installed app with identifier "${appIdentifier}". Make sure the app is installed in this org before importing workflows.`);
-        }
         if (!workflowTemplate?.workflowDefinition?.paths) {
-            return appOrg.appId;
+            return;
         }
         for (const path of workflowTemplate.workflowDefinition.paths) {
             if (!path?.actionDefinitionConfigs) {
@@ -93,10 +84,9 @@ class LocalWorkflowTemplateDeployer {
                 }
             }
         }
-        return appOrg.appId;
     }
     async createWorkflowSchedule(workflowTemplate, workflowId) {
-        if (!workflowTemplate?.crons?.length) {
+        if (!workflowTemplate?.crons?.length || !workflowTemplate.id) {
             return;
         }
         const crons = [];
@@ -168,8 +158,6 @@ class LocalWorkflowTemplateDeployer {
             triggerKey: workflowTemplate.triggerKey,
             builtIn: workflowTemplate.builtIn,
             workflowDefinition: workflowTemplate.workflowDefinition,
-            messageGroupId: workflowTemplate.messageGroupId ?? existingWorkflowTemplate.messageGroupId,
-            messageGroup: workflowTemplate.messageGroup ?? existingWorkflowTemplate.messageGroup,
             dynamicMessageGroupId: workflowTemplate.dynamicMessageGroupId ?? existingWorkflowTemplate.dynamicMessageGroupId,
             parallelWorkerCount: workflowTemplate.parallelWorkerCount ?? existingWorkflowTemplate.parallelWorkerCount,
         });
@@ -295,21 +283,3 @@ async function populateActionIdentifiers(workflowTemplate) {
     }
 }
 exports.populateActionIdentifiers = populateActionIdentifiers;
-function extractShortActionKeys(workflowTemplate) {
-    if (!workflowTemplate?.workflowDefinition?.paths) {
-        return;
-    }
-    for (const wfPath of workflowTemplate.workflowDefinition.paths) {
-        if (!wfPath?.actionDefinitionConfigs) {
-            continue;
-        }
-        for (const actionConfig of wfPath.actionDefinitionConfigs) {
-            if (actionConfig.action?.includes(':')) {
-                // Full identifier format: "app-id@version:action-name" -> "action-name"
-                actionConfig.action = actionConfig.action.split(':').pop() ?? actionConfig.action;
-            }
-            delete actionConfig.identifier;
-        }
-    }
-}
-exports.extractShortActionKeys = extractShortActionKeys;

package/dist/interfaces.d.ts

@@ -55,6 +55,32 @@ export interface ExtensionDefinitionDeclaration {
     modalDimensions?: any;
     display?: AppExtensionDisplayConfiguration;
     iframeUrl?: string;
+    /** A default icon's name, `{ material: <icon name> }`, or `{ url: <one-color SVG, absolute or beside iframeUrl> }`.
+     * An extension without an icon shows none. */
+    icon?: ExtensionIconDeclaration;
+    /** What the extension acts on. Apps offer it beside a selection it fits (Boards: the property bar's app row and the
+     * top of the context menu); without it, it is offered as before. */
+    appliesTo?: ExtensionAppliesToDeclaration;
+    /** The name the app's extensions are grouped under; defaults to appName. */
+    group?: string;
+}
+export type ExtensionIconDeclaration = string | {
+    material: string;
+} | {
+    url: string;
+};
+export interface ExtensionAppliesToDeclaration {
+    /** Type paths, each matching itself and its subtypes: item:product matches item:product:footwear. */
+    typePaths?: string[];
+    /** Type paths left out, with their subtypes: item:material. */
+    excludeTypePaths?: string[];
+    /** Item roles the selection must have: family, option. */
+    roles?: string[];
+    /** Fewest records selected; 1 when left out. */
+    minSelected?: number;
+    maxSelected?: number;
+    /** What to select, for the hint shown while the selection doesn't fit: "a Design". */
+    label?: string;
 }
 export interface ConfigPropertyElements {
     [key: string]: ConfigPropertyElement;
@@ -98,7 +124,7 @@ export interface WorkflowDefinition {
     dynamicMessageGroupId?: string;
 }
 export interface WorkflowTemplateDeclaration {
-    appIdentifier?: string;
+    appIdentifier: string;
     workflows?: WorkflowTemplate[];
 }
 export interface WorkflowTemplate {