@contrail/cli 2.1.27 → 2.2.1

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

@@ -2,40 +2,44 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.populateActionIdentifiers = exports.localDeployWorkflowTemplate = exports.deleteWorkflowTemplates = exports.WorkflowTemplateDeployer = exports.getActionByIdentifier = exports.getWorkflowTemplateIdentifier = exports.LocalWorkflowTemplateDeployer = void 0;
 const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
+const util_1 = require("@contrail/util");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 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 path = tslib_1.__importStar(require("path"));
+const apps_1 = require("../../api/apps");
 const event_workflow_action_definition_1 = require("../../api/event-workflow-action-definition");
 const event_workflow_templates_1 = require("../../api/event-workflow-templates");
+const schedules_1 = require("../../api/schedules");
 const login_1 = require("../../auth/login");
 const interface_converters_1 = require("../../interface-converters");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 class LocalWorkflowTemplateDeployer {
     async deployWorkflows(wtDeclaration) {
         // FETCH ALL WORKFLOWS FROM THE API.
         const existingWorkflows = await (0, event_workflow_templates_1.getExistingWorkflowTemplates)();
         // UPSERT / DELETE BASED ON WORKFLOW TEMPLATES IDENTIFIER
         logger_1.default.info('%s \tDeploying workflow templates.', chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
-        for (const workflow of wtDeclaration.workflows) {
-            await this.deployWorkflowTemplate(workflow, existingWorkflows);
+        logger_1.default.info(wtDeclaration);
+        for (const workflowKey of Object.keys(wtDeclaration.workflows)) {
+            await this.deployWorkflowTemplate(wtDeclaration.workflows[workflowKey], existingWorkflows, wtDeclaration.appIdentifier);
         }
     }
-    async deployWorkflowTemplate(workflow, existingWorkflows) {
-        logger_1.default.info(`%s \tDeploying workflow: ${workflow.triggerKey}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
-        const identifier = getWorkflowTemplateIdentifier(workflow.identifier);
+    async deployWorkflowTemplate(workflow, existingWorkflows, appIdentifier) {
+        logger_1.default.info(`WORKFLOW TEMPLATES \tDeploying workflow: ${workflow.triggerKey}`);
+        const identifier = getWorkflowTemplateIdentifier(workflow);
         const existingTemplate = existingWorkflows.find((ad) => ad.identifier === identifier);
         (0, interface_converters_1.convertWorkflow)(workflow);
         if (existingTemplate) {
-            return await this.updateWorkflowTemplate(identifier, existingTemplate, workflow);
+            return await this.updateWorkflowTemplate(identifier, existingTemplate, workflow, appIdentifier);
         }
-        return await this.createNewWorkflowTemplate(identifier, workflow);
+        return await this.createNewWorkflowTemplate(identifier, workflow, appIdentifier);
     }
-    async createNewWorkflowTemplate(workflowKey, workflowTemplate) {
-        await this.populateActionIds(workflowTemplate, workflowKey);
+    async createNewWorkflowTemplate(workflowKey, workflowTemplate, appIdentifier) {
+        await this.populateActionIds(workflowTemplate, workflowKey, appIdentifier);
         const newObject = {
-            identifier: getWorkflowTemplateIdentifier(workflowKey),
+            identifier: getWorkflowTemplateIdentifier(workflowTemplate),
             name: workflowTemplate.name,
             triggerKey: workflowTemplate.triggerKey,
             workflowDefinition: workflowTemplate.workflowDefinition,
@@ -45,11 +49,16 @@ class LocalWorkflowTemplateDeployer {
             parallelWorkerCount: workflowTemplate.parallelWorkerCount,
         };
         const newWorkflowTemplate = await (0, event_workflow_templates_1.createWorkflowTemplate)(newObject);
+        if (workflowTemplate.crons) {
+            await this.createWorkflowSchedule(workflowTemplate, newWorkflowTemplate.id);
+        }
         logger_1.default.info(`%s      Created new workflow definition: ${workflowKey}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
         return newWorkflowTemplate;
     }
-    async populateActionIds(workflowTemplate, workflowKey) {
+    async populateActionIds(workflowTemplate, workflowKey, appIdentifier) {
         var _a;
+        const installedApps = await (0, apps_1.getInstalledApps)();
+        const appOrg = installedApps.find((x) => x.app.identifier === appIdentifier);
         logger_1.default.info('workflow template:', JSON.stringify(workflowTemplate, null, 2));
         if (!((_a = workflowTemplate === null || workflowTemplate === void 0 ? void 0 : workflowTemplate.workflowDefinition) === null || _a === void 0 ? void 0 : _a.paths)) {
             return;
@@ -61,8 +70,14 @@ class LocalWorkflowTemplateDeployer {
             for (const actionConfiguration of path.actionDefinitionConfigs) {
                 const actionKey = actionConfiguration.action;
                 try {
-                    const actionEntity = await getActionByIdentifier(actionKey);
+                    const actionIdentifier = util_1.AppUtil.createActionIdentifier({
+                        actionNameIdentifier: actionKey,
+                        appIdentifier,
+                        versionId: appOrg.appVersionId,
+                    });
+                    const actionEntity = await getActionByIdentifier(actionIdentifier);
                     actionConfiguration.id = actionEntity.id;
+                    actionConfiguration.identifier = actionEntity.identifier;
                 }
                 catch (e) {
                     logger_1.default.info(e);
@@ -73,9 +88,77 @@ class LocalWorkflowTemplateDeployer {
             }
         }
     }
-    async updateWorkflowTemplate(workflowKey, existingWorkflowTemplate, workflowTemplate) {
+    async createWorkflowSchedule(workflowTemplate, workflowId) {
+        var _a;
+        if (!((_a = workflowTemplate === null || workflowTemplate === void 0 ? void 0 : workflowTemplate.crons) === null || _a === void 0 ? void 0 : _a.length) || !workflowTemplate.id) {
+            return;
+        }
+        const crons = [];
+        for (const cron of workflowTemplate.crons) {
+            crons.push(await (0, schedules_1.createSchedule)({
+                cron: cron.cron,
+                entityReference: `event-workflow-template:${workflowId}`,
+                name: cron.name,
+                requestMethod: 'POST',
+                entityName: 'event-workflow-request',
+                isActive: true,
+                payload: {
+                    event: {},
+                    triggerKey: workflowTemplate.triggerKey,
+                },
+            }));
+        }
+        return crons;
+    }
+    async updateWorkflowSchedule(workflowTemplate, workflowId) {
+        var _a, _b, _c, _d;
+        const existingSchedules = (_a = (await (0, schedules_1.getExistingSchedules)()).filter((x) => (x === null || x === void 0 ? void 0 : x.ownerReference) === `event-workflow-template:${workflowId}`)) !== null && _a !== void 0 ? _a : [];
+        const newSchedules = (_b = workflowTemplate === null || workflowTemplate === void 0 ? void 0 : workflowTemplate.crons) !== null && _b !== void 0 ? _b : [];
+        const existingCronNames = (_c = existingSchedules.map((x) => x.name)) !== null && _c !== void 0 ? _c : [];
+        const newCronNames = (_d = newSchedules.map((x) => x.name)) !== null && _d !== void 0 ? _d : [];
+        const cronsToAdd = newSchedules.filter((x) => !existingCronNames.includes(x.name));
+        const cronsToRemove = existingSchedules.filter((x) => !newCronNames.includes(x.name));
+        const cronsToEdit = existingSchedules.filter((x) => newCronNames.includes(x.name));
+        for (const cron of cronsToAdd) {
+            logger_1.default.info(`%s      Adding new schedule: ${cron.name}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
+            await (0, schedules_1.createSchedule)({
+                cron: cron.cron,
+                entityReference: `event-workflow-template:${workflowId}`,
+                name: cron.name,
+                requestMethod: 'POST',
+                entityName: 'event-workflow-request',
+                isActive: true,
+                payload: {
+                    event: {},
+                    triggerKey: workflowTemplate.triggerKey,
+                },
+            });
+        }
+        for (const cron of cronsToRemove) {
+            logger_1.default.info(`%s      Removing schedule: ${cron.name}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
+            await (0, schedules_1.deleteSchedule)(cron.id);
+        }
+        for (const cron of cronsToEdit) {
+            logger_1.default.info(`%s      Updating schedule: ${cron.name}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
+            const newCron = workflowTemplate.crons.find((x) => x.name === cron.name);
+            await (0, schedules_1.updateSchedule)({
+                id: cron.id,
+                updates: {
+                    cron: newCron.cron,
+                    requestMethod: 'POST',
+                    entityName: 'event-workflow-request',
+                    isActive: true,
+                    payload: {
+                        event: {},
+                        triggerKey: workflowTemplate.triggerKey,
+                    },
+                },
+            });
+        }
+    }
+    async updateWorkflowTemplate(workflowKey, existingWorkflowTemplate, workflowTemplate, appIdentifier) {
         var _a, _b;
-        await this.populateActionIds(workflowTemplate, workflowKey);
+        await this.populateActionIds(workflowTemplate, workflowKey, appIdentifier);
         const updates = Object.assign(new Object(), {
             name: workflowTemplate.name,
             triggerKey: workflowTemplate.triggerKey,
@@ -88,34 +171,35 @@ class LocalWorkflowTemplateDeployer {
             id: existingWorkflowTemplate.id,
             updates,
         });
-        logger_1.default.info(`%s      Updated existing workflow template: ${updatedWorkflowTemplate.identifier}`, chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
+        await this.updateWorkflowSchedule(workflowTemplate, updatedWorkflowTemplate.id);
+        logger_1.default.info(`WORKFLOW TEMPLATES  Updated existing workflow template: ${updatedWorkflowTemplate.identifier}`);
         return updatedWorkflowTemplate;
     }
     async deleteWorkflowTemplates(wtDeclaration) {
         // FETCH ALL WORKFLOWS FROM THE API.
         const existingWorkflows = await (0, event_workflow_templates_1.getExistingWorkflowTemplates)();
         // UPSERT / DELETE BASED ON WORKFLOW TEMPLATES IDENTIFIER
-        logger_1.default.info('%s \tDELETING workflow templates.', chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'));
+        logger_1.default.info('WORKFLOW TEMPLATES \tDELETING workflow templates.');
         for (const workflowKey of Object.keys(wtDeclaration.workflows)) {
-            const identifier = getWorkflowTemplateIdentifier(workflowKey);
+            const identifier = getWorkflowTemplateIdentifier(wtDeclaration.workflows[workflowKey]);
             const existingTemplate = existingWorkflows.find((ad) => ad.identifier === identifier);
             if (existingTemplate) {
                 try {
                     await (0, event_workflow_templates_1.deleteWorkflowTemplate)(identifier);
                 }
                 catch (e) {
-                    logger_1.default.info('%s \tFAILED to delete workflow template %s.', chalk_1.default.red.bold('WORKFLOW TEMPLATES'), identifier);
+                    logger_1.default.warn('WORKFLOW TEMPLATES \tFAILED to delete workflow template WORKFLOW TEMPLATES.', chalk_1.default.red.bold('WORKFLOW TEMPLATES'), identifier);
                 }
             }
             else {
-                logger_1.default.info('%s \tUnable to locate workflow template %s.', chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'), identifier);
+                logger_1.default.info('WORKFLOW TEMPLATES \tUnable to locate workflow template WORKFLOW TEMPLATES.', chalk_1.default.yellow.bold('WORKFLOW TEMPLATES'), identifier);
             }
         }
     }
 }
 exports.LocalWorkflowTemplateDeployer = LocalWorkflowTemplateDeployer;
-function getWorkflowTemplateIdentifier(workflowKey) {
-    return workflowKey;
+function getWorkflowTemplateIdentifier(workflowTemplate) {
+    return workflowTemplate.identifier;
 }
 exports.getWorkflowTemplateIdentifier = getWorkflowTemplateIdentifier;
 async function getActionByIdentifier(identifier) {
@@ -140,7 +224,7 @@ class WorkflowTemplateDeployer {
         for (const idToDelete of answers.wfTemplatesToDelete) {
             await (0, event_workflow_templates_1.deleteWorkflowTemplate)(idToDelete);
         }
-        logger_1.default.info('%s \tDeleted workflow templates!', chalk_1.default.green.bold('WORKFLOW TEMPLATES'));
+        logger_1.default.info('WORKFLOW TEMPLATES \tDeleted workflow templates!');
     }
     async listExistingWorkflowTemplates() {
         const templates = await (0, event_workflow_templates_1.getExistingWorkflowTemplates)();
@@ -163,7 +247,7 @@ async function localDeployWorkflowTemplate(saveFileLocation) {
         wtDeclaration = loadTemplateConfig(saveFileLocation);
     }
     catch (e) {
-        logger_1.default.info(`%s Workflow Deletion Failed. ${e}`, chalk_1.default.red.bold('FAIL'));
+        logger_1.default.error(`FAIL Workflow Deletion Failed . ${e}`);
         return;
     }
     await (0, login_1.authUser)();

package/dist/interfaces.d.ts

@@ -77,6 +77,7 @@ export interface WorkflowDefinition {
     parallelWorkerCount?: number;
 }
 export interface WorkflowTemplateDeclaration {
+    appIdentifier: string;
     workflows?: WorkflowTemplate[];
 }
 export interface WorkflowTemplate {
@@ -88,6 +89,7 @@ export interface WorkflowTemplate {
     workflowDefinition: WorkflowDefinitionPaths;
     isActive: boolean;
     ownerKey?: string;
+    crons?: CronDeclaration[];
     supportingAppId?: string;
     parallelism?: number;
     groupId?: string;
@@ -327,7 +329,7 @@ export interface ReducedTypeProperty {
     editable: boolean;
     searchable: boolean;
     core: boolean;
-    typePropertyOptionSetName: string;
+    typePropertyOptionSetSlug: string;
     formula: string;
     referencedTypePath: string;
     referencedTypeRootSlug: string;
@@ -341,6 +343,7 @@ export interface ReducedTypeProperty {
 }
 export interface ReducedOptionSet {
     name: string;
+    identifier: string;
     isArchived: boolean;
     optionSet: any[];
 }
@@ -368,3 +371,7 @@ export declare enum PropertyType {
     Image = "image",
     Json = "json"
 }
+export interface CronDeclaration {
+    name: string;
+    cron: string;
+}

package/dist/templates/typescript/app.yml

@@ -4,7 +4,7 @@ appDescription: "APP_DESCRIPTION_STUB" # Give your app a description
 visibility: private  # This should be private unless you want to develop an app for all VibeIQ customers to use
 hidden: false # can be used with a public app to prevent it from showing on the marketplace, but still installable by other orgs
 publisher: "Your company name" # Your company name, used for public apps
-version: 1.0
+version: 1.0.0
 
 # Properties you can configure when you install the app.
 # These property values will be available to all of your actions when they run
@@ -29,6 +29,7 @@ actions:
 
 workflows:
   logItemUpdate:
+    identifier: "logItemUpdate"
     name: "Item Update -> Log"
     triggerKey: item|update
     isActive: true

package/dist/templates/typescript/package.json

@@ -14,7 +14,8 @@
     "build": "tsc; npx copyfiles  assets/**/* dist/",
     "start": "nodemon --watch \"src/**/*.ts\" --exec ts-node src/main.ts",
     "debug": "nodemon -r ts-node/register --inspect=127.0.0.1:60002 --watch 'actions/**/*.ts' --exec node src/main.ts",
-    "lint": "eslint . --fix",
+    "lint": "eslint --config eslintrc.json .",
+    "lint-fix": "eslint --fix --config eslintrc.json .",
     "test": "jest",
     "test-watch": "jest --watch"
   },
@@ -22,8 +23,8 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@contrail/app-framework": "^1.2.2",
-    "@contrail/sdk": "^1.1.54",
+    "@contrail/app-framework": "^1.2",
+    "@contrail/sdk": "^1.3",
     "chalk": "^4.0.0",
     "js-yaml": "^4.1.0"
   },

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.27",
+  "version": "2.2.1",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -120,6 +120,43 @@
       },
       "args": {}
     },
+    "app:init": {
+      "id": "app:init",
+      "description": "Create an app from a template",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail app init\n"
+      ],
+      "flags": {
+        "logLevel": {
+          "name": "logLevel",
+          "type": "option",
+          "char": "l",
+          "description": "The Log Level",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "error",
+            "warn",
+            "info",
+            "debug"
+          ]
+        },
+        "alwaysConfirmEnv": {
+          "name": "alwaysConfirmEnv",
+          "type": "boolean",
+          "char": "e",
+          "description": "The Environment variables",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "app:install": {
       "id": "app:install",
       "description": "Install an app from the marketplace",
@@ -1945,7 +1982,7 @@
           "name": "dir",
           "type": "option",
           "char": "d",
-          "description": "The directory from which to export the usage info data. Defaults to the current directory. The option set data will be loaded from $dir/usage-info.yml",
+          "description": "The directory from which to export the usage info data. Defaults to the current directory. The usage info data will be loaded from $dir/usage-info.yml",
           "required": false,
           "multiple": false,
           "default": "."
@@ -2475,6 +2512,117 @@
         }
       }
     },
+    "app:version:major": {
+      "id": "app:version:major",
+      "description": "Upgrade the Major app version",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail app version major\n"
+      ],
+      "flags": {
+        "logLevel": {
+          "name": "logLevel",
+          "type": "option",
+          "char": "l",
+          "description": "The Log Level",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "error",
+            "warn",
+            "info",
+            "debug"
+          ]
+        },
+        "alwaysConfirmEnv": {
+          "name": "alwaysConfirmEnv",
+          "type": "boolean",
+          "char": "e",
+          "description": "The Environment variables",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "app:version:minor": {
+      "id": "app:version:minor",
+      "description": "Upgrade the Minor app version",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail app version minor\n"
+      ],
+      "flags": {
+        "logLevel": {
+          "name": "logLevel",
+          "type": "option",
+          "char": "l",
+          "description": "The Log Level",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "error",
+            "warn",
+            "info",
+            "debug"
+          ]
+        },
+        "alwaysConfirmEnv": {
+          "name": "alwaysConfirmEnv",
+          "type": "boolean",
+          "char": "e",
+          "description": "The Environment variables",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "app:version:patch": {
+      "id": "app:version:patch",
+      "description": "Upgrade the Patch app version",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail app version patch\n"
+      ],
+      "flags": {
+        "logLevel": {
+          "name": "logLevel",
+          "type": "option",
+          "char": "l",
+          "description": "The Log Level",
+          "required": false,
+          "multiple": false,
+          "options": [
+            "error",
+            "warn",
+            "info",
+            "debug"
+          ]
+        },
+        "alwaysConfirmEnv": {
+          "name": "alwaysConfirmEnv",
+          "type": "boolean",
+          "char": "e",
+          "description": "The Environment variables",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "config:environments:list": {
       "id": "config:environments:list",
       "description": "List the environment configurations",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.1.27",
+  "version": "2.2.1",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -24,7 +24,7 @@
   "dependencies": {
     "@contrail/entity-types": "^1.1.17",
     "@contrail/sdk": "^1.2.17",
-    "@contrail/types": "^3.0.20",
+    "@contrail/types": "^3.0.48",
     "@contrail/util": "^1.0.41",
     "@oclif/core": "^2",
     "@oclif/plugin-autocomplete": "^2.1.4",
@@ -47,6 +47,7 @@
     "lodash": "^4.17.21",
     "ncp": "^2.0.0",
     "pkg-install": "^1.0.0",
+    "semver": "^7.5.4",
     "winston": "^3.10.0",
     "zip-a-folder": "^1.1.5"
   },
@@ -61,7 +62,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^5.0.0",
     "jest": "^29.5.0",
-    "oclif": "^3",
+    "oclif": "3.16",
     "prettier": "^3.0.0",
     "shx": "^0.3.3",
     "ts-jest": "^29.0.5",