@contrail/cli 2.1.14 → 2.1.16

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/2.1.14 darwin-arm64 node-v18.13.0
+@contrail/cli/2.1.16 darwin-arm64 node-v18.13.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND

package/dist/api/apps.d.ts

@@ -1,6 +1,6 @@
 import { App, AppOrg, AppVersion, WorkflowDefinition } from '../interfaces';
-export declare function getWorkflowTemplateDefinitionsForApp(options: {
-    appId: string;
+export declare function getWorkflowTemplateDefinitionsForAppVersion(options: {
+    appVersionId: string;
 }): Promise<WorkflowDefinition[]>;
 export declare function getAppVersions(app: any): Promise<AppVersion[]>;
 export declare function upgradeAppVersion(appOrg: any, appVersionId: any): Promise<AppOrg>;

package/dist/api/apps.js

@@ -1,17 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAvailableApps = exports.installAppToOrg = exports.getInstalledApps = exports.deleteAppOrg = exports.upgradeAppVersion = exports.getAppVersions = exports.getWorkflowTemplateDefinitionsForApp = void 0;
+exports.getAvailableApps = exports.installAppToOrg = exports.getInstalledApps = exports.deleteAppOrg = exports.upgradeAppVersion = exports.getAppVersions = exports.getWorkflowTemplateDefinitionsForAppVersion = void 0;
 const auth_1 = require("../auth/auth");
 const sdk_1 = require("@contrail/sdk");
-async function getWorkflowTemplateDefinitionsForApp(options) {
+async function getWorkflowTemplateDefinitionsForAppVersion(options) {
     return await new sdk_1.Entities().get({
         entityName: 'event-workflow-template-definition',
         criteria: {
-            ownerKey: `app:${options.appId}`
+            ownerKey: `appVersion:${options.appVersionId}`
         }
     });
 }
-exports.getWorkflowTemplateDefinitionsForApp = getWorkflowTemplateDefinitionsForApp;
+exports.getWorkflowTemplateDefinitionsForAppVersion = getWorkflowTemplateDefinitionsForAppVersion;
 async function getAppVersions(app) {
     return await new sdk_1.Entities().get({
         entityName: 'app-version',

package/dist/commands/app/install.js

@@ -82,7 +82,7 @@ class InstallApp extends core_1.Command {
             }
         }
         if (flags.installWorkflowTemplates) {
-            const workflowTemplateDefinitions = await (0, apps_1.getWorkflowTemplateDefinitionsForApp)({ appId: app.id });
+            const workflowTemplateDefinitions = await (0, apps_1.getWorkflowTemplateDefinitionsForAppVersion)({ appVersionId: appOrg.appVersionId });
             if (!workflowTemplateDefinitions.length) {
                 return;
             }

package/dist/helpers/app/actions-deployer.d.ts

@@ -1,5 +1,5 @@
 import { App, AppDeclaration, AppActionDeclaration } from '../../interfaces';
-export declare function getActionsForApp(app: App): Promise<any>;
+export declare function getActionsForAppVersion(app: App): Promise<any>;
 export declare function getActionDeclarationIdentifier(actionKey: any, app: App): string;
 export declare function deleteAction(actionId: any): Promise<any>;
 export declare class ActionsDeployer {

package/dist/helpers/app/actions-deployer.js

@@ -1,21 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionsDeployer = exports.deleteAction = exports.getActionDeclarationIdentifier = exports.getActionsForApp = void 0;
+exports.ActionsDeployer = exports.deleteAction = exports.getActionDeclarationIdentifier = exports.getActionsForAppVersion = void 0;
 const tslib_1 = require("tslib");
 const sdk_1 = require("@contrail/sdk");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
 const app_template_parsers_1 = require("./app-template-parsers");
 const common_1 = require("../../common");
 const fs_1 = tslib_1.__importDefault(require("fs"));
-async function getActionsForApp(app) {
+async function getActionsForAppVersion(app) {
     return await new sdk_1.Entities().get({
         entityName: 'event-workflow-action-definition',
-        criteria: { ownerKey: `app:${app.id}` },
+        criteria: { ownerKey: `appVersion:${app.latestAppVersionId}` },
     });
 }
-exports.getActionsForApp = getActionsForApp;
+exports.getActionsForAppVersion = getActionsForAppVersion;
 function getActionDeclarationIdentifier(actionKey, app) {
-    return app.identifier + ':' + actionKey;
+    return `${app.identifier}@${app.latestAppVersionId}:${actionKey}`;
 }
 exports.getActionDeclarationIdentifier = getActionDeclarationIdentifier;
 async function deleteAction(actionId) {
@@ -25,24 +25,17 @@ exports.deleteAction = deleteAction;
 class ActionsDeployer {
     async deployActions(appDeclaration, app) {
         // FETCH ALL ACTIONS FROM THE API.
-        const existingActions = await getActionsForApp(app);
+        const existingActions = await getActionsForAppVersion(app);
         // UPSERT / DELETE BASED ON ACTION IDENTIFIER
         console.log('%s \tDeploying actions.', chalk_1.default.yellow.bold('ACTION'));
-        let appActionIdentifiers = [];
         if (appDeclaration.actions) {
             const localActionKeys = Object.keys(appDeclaration.actions);
-            appActionIdentifiers = localActionKeys.map(x => getActionDeclarationIdentifier(x, app));
             if ((localActionKeys === null || localActionKeys === void 0 ? void 0 : localActionKeys.length) > 0) {
                 for (const actionKey of localActionKeys) {
                     await this.deployAction(actionKey, appDeclaration.actions[actionKey], app, existingActions);
                 }
             }
         }
-        const toDelete = existingActions.filter(x => !appActionIdentifiers.includes(x.identifier));
-        for (const action of toDelete) {
-            console.log(`%s \tDeleting action: ${action.identifier}`, chalk_1.default.yellow.bold('ACTION'));
-            await deleteAction(action.id);
-        }
     }
     async deployAction(actionKey, actionDeclaration, app, existingActions) {
         console.log(`%s \tDeploying action: ${actionKey}`, chalk_1.default.yellow.bold('ACTION'));
@@ -63,7 +56,8 @@ class ActionsDeployer {
         const newObject = {
             identifier: getActionDeclarationIdentifier(actionKey, app),
             name: actionDeclaration.name,
-            ownerKey: `app:${app.id}`,
+            internal: actionDeclaration.internal,
+            ownerKey: `appVersion:${app.latestAppVersionId}`,
             public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
             configProperties,
             async: actionDeclaration.async,
@@ -89,6 +83,8 @@ class ActionsDeployer {
         }
         const updates = {
             name: actionDeclaration.name,
+            internal: actionDeclaration.internal,
+            ownerKey: `appVersion:${app.latestAppVersionId}`,
             public: 'public' in actionDeclaration ? actionDeclaration.public : app.public,
             configProperties,
             async: actionDeclaration.async,

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

@@ -73,13 +73,13 @@ class AppDeployer {
             console.log('Dry run, not creating app');
             return {};
         }
-        const app = await new sdk_1.Entities().create({ entityName: 'app', object: newApp });
+        let app = await new sdk_1.Entities().create({ entityName: 'app', object: newApp });
         console.log(`%s      Created new app: ${app.name}`, chalk_1.default.yellow.bold('APP'));
         const isDocker = Object.hasOwnProperty.call(appDeclaration, 'dockerImageRef');
         if (!isDocker) { // this is the expected default behavior
             const appCodePackage = await createNodePackage(appDeclaration.appIdentifier, this.debug, this.dryRun);
             app.appCodePackageId = appCodePackage.id;
-            await new sdk_1.Entities().update({ entityName: 'app', object: app });
+            app = await new sdk_1.Entities().update({ entityName: 'app', id: app.id, object: app });
             console.log(`%s      Updated app with code package: ${app.name}`, chalk_1.default.yellow.bold('APP'));
         }
         return app;
@@ -129,7 +129,7 @@ class AppDeployer {
     async remove(appDeclaration) {
         let app = await this.getExistingApp(appDeclaration);
         if (app) {
-            const actions = await (0, actions_deployer_1.getActionsForApp)(app);
+            const actions = await (0, actions_deployer_1.getActionsForAppVersion)(app);
             for (const action of actions) {
                 console.log(`%s      Deleting action: ${action.identifier}`, chalk_1.default.yellow.bold('APP'));
                 await (0, actions_deployer_1.deleteAction)(action.id);

package/dist/helpers/workflow-template-definitions/workflow-template-definition-deployer.js

@@ -11,8 +11,8 @@ const actions_deployer_1 = require("../app/actions-deployer");
 const interface_converters_1 = require("../../interface-converters");
 class WorkflowTemplateDefinitionDeployer {
     async cliInstallWorkflowTemplateDefinitions() {
-        const installedApps = await (0, apps_1.getInstalledApps)();
-        if (!installedApps.length) {
+        const installedAppOrgs = await (0, apps_1.getInstalledApps)();
+        if (!installedAppOrgs.length) {
             console.log('%s \nNo apps are currently installed. You must install an app before installing its associated workflow template definitions.', chalk_1.default.red.bold('WORKFLOW DEFINITION'));
             return;
         }
@@ -20,10 +20,10 @@ class WorkflowTemplateDefinitionDeployer {
                 type: 'list',
                 name: 'appIdentifier',
                 message: 'Which app\'s workflow would you like to install?',
-                choices: installedApps.map(x => x.app.identifier)
+                choices: installedAppOrgs.map(x => x.app.identifier)
             }]);
-        const app = installedApps.find(x => x.app.identifier === answers.appIdentifier).app;
-        const workflowTemplateDefinitions = await (0, apps_1.getWorkflowTemplateDefinitionsForApp)({ appId: app.id });
+        const appOrg = installedAppOrgs.find(x => x.app.identifier === answers.appIdentifier);
+        const workflowTemplateDefinitions = await (0, apps_1.getWorkflowTemplateDefinitionsForAppVersion)({ appVersionId: appOrg.appVersionId });
         for (const definition of workflowTemplateDefinitions) {
             console.log(chalk_1.default.yellow.bold(`- ${definition.name}`));
         }
@@ -34,7 +34,7 @@ class WorkflowTemplateDefinitionDeployer {
                 type: 'checkbox',
                 name: 'workflowTemplateDefinitionsToInstall',
                 message: 'Which workflow templates would you like to install?',
-                choices: workflowTemplateDefinitions.map(x => { return { value: x.identifier, name: x.name }; }),
+                choices: workflowTemplateDefinitions.filter(x => !x.builtIn).map(x => { return { value: x.identifier, name: x.name }; }),
             }]);
         const workflowTemplateDefinitionsToInstall = workflowTemplateDefinitions.filter(x => answers.workflowTemplateDefinitionsToInstall.includes(x.identifier));
         answers = await inquirer_1.default.prompt([{
@@ -47,6 +47,7 @@ class WorkflowTemplateDefinitionDeployer {
         for (const definition of workflowTemplateDefinitionsToInstall) {
             const newObject = {
                 name: definition.name,
+                builtIn: definition.builtIn,
                 triggerKey: definition.triggerKey,
                 workflowDefinition: definition.workflowDefinition,
                 isActive: makeActive,
@@ -57,10 +58,10 @@ class WorkflowTemplateDefinitionDeployer {
         console.log(`%s \n ${workflowTemplateDefinitionsToInstall.length} workflows installed`, chalk_1.default.green.bold('WORKFLOW DEFINITION'));
     }
     async listWorkflowTemplateDefinitions() {
-        const installedApps = await (0, apps_1.getInstalledApps)();
+        const installedAppOrgs = await (0, apps_1.getInstalledApps)();
         const workflowTemplateDefinitions = [];
-        for (const appOrg of installedApps) {
-            workflowTemplateDefinitions.push(...await (await (0, apps_1.getWorkflowTemplateDefinitionsForApp)({ appId: appOrg.appId })).map(x => {
+        for (const appOrg of installedAppOrgs) {
+            workflowTemplateDefinitions.push(...await (await (0, apps_1.getWorkflowTemplateDefinitionsForAppVersion)({ appVersionId: appOrg.appVersionId })).map(x => {
                 return {
                     appName: appOrg.app.name,
                     workflowName: x.name,
@@ -73,7 +74,7 @@ class WorkflowTemplateDefinitionDeployer {
     }
     async deployWorkflowTemplateDefinitions(appDeclaration, app) {
         // FETCH ALL WORKFLOWS FROM THE API.
-        const existingWorkflows = await (0, apps_1.getWorkflowTemplateDefinitionsForApp)({ appId: app.id });
+        const existingWorkflows = await (0, apps_1.getWorkflowTemplateDefinitionsForAppVersion)({ appVersionId: app.latestAppVersionId });
         // UPSERT / DELETE BASED ON WORKFLOW IDENTIFIER
         console.log('%s \tDeploying workflow definitions.', chalk_1.default.yellow.bold('WORKFLOW DEFINITION'));
         if (appDeclaration.workflows) {
@@ -83,12 +84,6 @@ class WorkflowTemplateDefinitionDeployer {
                     await this.deployWorkflow(workflowKey, appDeclaration.workflows[workflowKey], app, existingWorkflows);
                 }
             }
-            // remove old templates that were removed by the app publisher
-            const localIdentifiers = localWorkflows.map(x => this.getWorkflowDeclarationIdentifier(x, app));
-            const workflowTemplateDefinitionsToDelete = existingWorkflows.filter(x => !localIdentifiers.includes(x.identifier));
-            for (const templateToDelete of workflowTemplateDefinitionsToDelete) {
-                await (0, event_workflow_template_definition_1.deleteWorkflowTemplateDefinition)(templateToDelete.id);
-            }
         }
     }
     async deployWorkflow(workflowKey, workflow, app, existingWorkflows) {
@@ -106,7 +101,8 @@ class WorkflowTemplateDefinitionDeployer {
         const newObject = {
             identifier: this.getWorkflowDeclarationIdentifier(workflowKey, app),
             name: workflowDeclaration.name,
-            ownerKey: `app:${app.id}`,
+            ownerKey: `appVersion:${app.latestAppVersionId}`,
+            builtIn: workflowDeclaration.builtIn,
             triggerKey: workflowDeclaration.triggerKey,
             workflowDefinition: workflowDeclaration.workflowDefinition,
             public: workflowDeclaration.public,
@@ -120,7 +116,7 @@ class WorkflowTemplateDefinitionDeployer {
     }
     async populateActionIds(workflowDefinition, app) {
         var _a;
-        const availableAppActions = await (0, actions_deployer_1.getActionsForApp)(app);
+        const availableAppActions = await (0, actions_deployer_1.getActionsForAppVersion)(app);
         if (!((_a = workflowDefinition.workflowDefinition) === null || _a === void 0 ? void 0 : _a.paths)) {
             return;
         }
@@ -142,6 +138,8 @@ class WorkflowTemplateDefinitionDeployer {
         await this.populateActionIds(workflowDefinition, app);
         const updates = Object.assign(new Object(), {
             name: workflowDefinition.name,
+            builtIn: workflowDefinition.builtIn,
+            ownerKey: `appVersion:${app.latestAppVersionId}`,
             triggerKey: workflowDefinition.triggerKey,
             workflowDefinition: workflowDefinition.workflowDefinition,
             messageGroupId: workflowDefinition.messageGroupId,
@@ -152,7 +150,7 @@ class WorkflowTemplateDefinitionDeployer {
         return updatedWorkflowDefinition;
     }
     getWorkflowDeclarationIdentifier(actionKey, app) {
-        return app.identifier + ':' + actionKey;
+        return `${app.identifier}@${app.latestAppVersionId}:${actionKey}`;
     }
 }
 exports.WorkflowTemplateDefinitionDeployer = WorkflowTemplateDefinitionDeployer;

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

@@ -78,6 +78,7 @@ class LocalWorkflowTemplateDeployer {
         const updates = Object.assign(new Object(), {
             name: workflowTemplate.name,
             triggerKey: workflowTemplate.triggerKey,
+            builtIn: workflowTemplate.builtIn,
             workflowDefinition: workflowTemplate.workflowDefinition,
             messageGroupId: (_a = workflowTemplate.messageGroupId) !== null && _a !== void 0 ? _a : existingWorkflowTemplate.messageGroupId,
             parallelWorkerCount: (_b = workflowTemplate.parallelWorkerCount) !== null && _b !== void 0 ? _b : existingWorkflowTemplate.parallelWorkerCount,

package/dist/interfaces.d.ts

@@ -39,6 +39,7 @@ export interface AppActionDeclaration {
     handler: string;
     public?: boolean;
     name: string;
+    internal?: boolean;
     description?: string;
     actionConfiguration?: ConfigPropertyElements;
     async?: boolean;
@@ -58,6 +59,7 @@ export interface WorkflowDefinition {
     ownerKey: string;
     isActive: boolean;
     public: boolean;
+    builtIn?: boolean;
     supportingAppId?: string;
     parallelism?: number;
     groupId?: string;
@@ -71,6 +73,7 @@ export interface WorkflowTemplate {
     id?: string;
     identifier?: string;
     name: string;
+    builtIn?: boolean;
     triggerKey: string;
     workflowDefinition: WorkflowDefinitionPaths;
     isActive: boolean;
@@ -201,6 +204,7 @@ export interface EventWorkflowActionDefinition {
     id?: string;
     identifier?: string;
     name?: string;
+    internal?: boolean;
     executeFunctionString?: string;
     ownerKey?: string;
     public?: boolean;

package/dist/templates/typescript/app.yml

@@ -26,8 +26,28 @@ actions:
       message:
         label: "Additional message to log."
         propertyType: "string"
+  sayHello:
+    internal: true
+    name: "Say Hello"
+    description: "Prints hello world to the log."
+    async: false
 
 workflows:
+  friendlyGreeting:
+    builtIn: true
+    name: "Friendly Greeting"
+    triggerKey: "helloFoo"
+    isActive: true
+    public: true
+    concurrency: 3  # The maximum number of concurrent jobs to run for this workflow. Defaults to 5
+    workflowDefinition:
+      paths:
+        - conditional: "true"
+          actionDefinitionConfigs:
+            - action: sayHello
+              name: Say Hello
+
+
   logItemUpdate:
     name: "Item Update -> Log"
     triggerKey: item|update

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.14",
+  "version": "2.1.16",
   "commands": {
     "app:create": {
       "id": "app:create",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.1.14",
+  "version": "2.1.16",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",