@contrail/cli 2.0.15 → 2.0.17

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/2.0.15 darwin-arm64 node-v18.13.0
+@contrail/cli/2.0.17 darwin-arm64 node-v18.13.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -159,9 +159,10 @@ Publish the app
 
 ```
 USAGE
-  $ contrail app publish [-u]
+  $ contrail app publish [-u] [-d]
 
 FLAGS
+  -d, --debug    Debug the app deployment step and do not remove the intermediate build artifacts.
   -u, --upgrade  In addition to deploying, upgrade the installed version of the app in this org to the latest one.
 
 DESCRIPTION

package/dist/auth/login.d.ts

@@ -1,2 +1,3 @@
 import { AuthContext } from './auth';
 export declare function authUser(): Promise<AuthContext>;
+export declare function getCurrentUser(): Promise<any>;

package/dist/auth/login.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.authUser = void 0;
+exports.getCurrentUser = exports.authUser = void 0;
 const tslib_1 = require("tslib");
 const AmazonCognitoIdentity = require('amazon-cognito-identity-js');
 const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
@@ -12,13 +12,13 @@ const CONFIGURATION = {
     clientId: process.env.CONTRAIL_COGNITO_CLIENT_ID || '7knkt34gfacbgd0ghnuspefdfg',
 };
 async function authUser() {
-    console.debug('authorizing user');
+    console.debug('authorizing user...');
     const config = await (0, config_1.getConfig)();
     if (config &&
         config.apiUserToken &&
         config.apiGateway &&
         config.orgSlug) {
-        console.debug('populating auth config from fs config');
+        console.debug('populating auth config from fs config...');
         auth_1.Auth.config = {
             apiUserToken: config.apiUserToken,
             apiGateway: config.apiGateway,
@@ -124,15 +124,19 @@ async function setAuthContext(user, params) {
     (0, sdk_1.setConfig)(auth_1.Auth.config);
     return refreshCurrentUserOrg();
 }
-async function refreshCurrentUserOrg() {
-    console.debug('refreshing current user org');
-    const currentUser = await sdk_1.Request.request('/users/current', {
+async function getCurrentUser() {
+    return await sdk_1.Request.request('/users/current', {
         method: 'GET',
         headers: {
             Accept: 'application/json',
             'Content-Type': 'application/json',
         },
     });
+}
+exports.getCurrentUser = getCurrentUser;
+async function refreshCurrentUserOrg() {
+    console.debug('refreshing current user org...');
+    const currentUser = await getCurrentUser();
     if (!currentUser) {
         throw Error('Could not get current user');
     }

package/dist/commands/app/create.js

@@ -1,10 +1,68 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const core_1 = require("@oclif/core");
 const setup_template_1 = require("../../helpers/app/setup-template");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const login_1 = require("../../auth/login");
+const sdk_1 = require("@contrail/sdk");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
 class CreateApp extends core_1.Command {
     async run() {
-        await (0, setup_template_1.setUpTemplate)();
+        await (0, login_1.authUser)();
+        const currentUser = await (0, login_1.getCurrentUser)();
+        const defaultAppName = `Hello World by ${currentUser.email}`;
+        const defaultAppIdentifier = `${currentUser.email}/hello-world`;
+        const defaultAppDescription = `Hello world app by ${currentUser.email}`;
+        const defaultAppPublisher = `${currentUser.email}`;
+        const answers = await inquirer_1.default.prompt([{
+                type: 'input',
+                name: 'appName',
+                message: 'What is the Name of your app?',
+                default: defaultAppName,
+                required: true
+            },
+            {
+                type: 'input',
+                name: 'appIdentifier',
+                message: 'App Identifier (must be unique):',
+                default: defaultAppIdentifier,
+                required: true
+            },
+            {
+                type: 'input',
+                name: 'appDescription',
+                message: 'App description:',
+                default: defaultAppDescription,
+                required: true
+            },
+            {
+                type: 'input',
+                name: 'appPublisher',
+                message: 'App Publisher:',
+                default: defaultAppPublisher,
+                required: true
+            }]);
+        const newApp = {
+            identifier: answers.appIdentifier,
+            name: answers.appName,
+            publisher: answers.appPublisher,
+            public: false,
+            hidden: false,
+            description: answers.appDescription
+        };
+        try {
+            await new sdk_1.Entities().create({ entityName: 'app', object: newApp });
+        }
+        catch (e) {
+            console.error(`%s      Failed to create new app: ${answers.appIdentifier}`, chalk_1.default.red.bold('APP'));
+            this.exit(1);
+        }
+        await (0, setup_template_1.setUpTemplate)({
+            appName: answers.appName,
+            appIdentifier: answers.appIdentifier,
+            appDescription: answers.appDescription
+        });
     }
 }
 exports.default = CreateApp;

package/dist/commands/app/install.js

@@ -77,6 +77,9 @@ class InstallApp extends core_1.Command {
                 console.log('%s Not installing associated app workflows', chalk_1.default.yellow.bold('APP INSTALLATION'));
                 flags.installWorkflowTemplates = false;
             }
+            else {
+                flags.installWorkflowTemplates = true;
+            }
         }
         if (flags.installWorkflowTemplates) {
             const workflowTemplateDefinitions = await (0, apps_1.getWorkflowTemplateDefinitionsForApp)({ appId: app.id });

package/dist/commands/app/publish.d.ts

@@ -5,6 +5,7 @@ export default class PublishApp extends Command {
     static strict: boolean;
     static flags: {
         upgrade: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        debug: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
     };
     run(): Promise<void>;
 }

package/dist/commands/app/publish.js

@@ -22,7 +22,7 @@ class PublishApp extends core_1.Command {
         console.log(`%s Deploying Application. ${appDeclaration.appIdentifier}`, chalk_1.default.blue.bold('START'));
         try {
             await (0, login_1.authUser)();
-            const app = await new app_deployer_1.AppDeployer().deploy(appDeclaration);
+            const app = await new app_deployer_1.AppDeployer(flags.debug).deploy(appDeclaration);
             if (flags.upgrade) {
                 const installedApps = await (0, apps_1.getInstalledApps)();
                 const installedAppOrg = installedApps.find(x => x.appId === app.id);
@@ -51,4 +51,5 @@ PublishApp.examples = [
 PublishApp.strict = true;
 PublishApp.flags = {
     upgrade: core_1.Flags.boolean({ char: 'u', description: 'In addition to deploying, upgrade the installed version of the app in this org to the latest one.', required: false }),
+    debug: core_1.Flags.boolean({ char: 'd', description: 'Debug the app deployment step and do not remove the intermediate build artifacts.', required: false }),
 };

package/dist/commands/app/uninstall.js

@@ -22,6 +22,9 @@ class UninstallApp extends core_1.Command {
             flags.appIdentifier = answers.appIdentifier;
         }
         const appToDelete = installedApps.find(x => x.app.identifier === flags.appIdentifier);
+        if (!appToDelete) {
+            throw new Error(`App ${flags.appIdentifier} not found`);
+        }
         this.log('%s Uninstalling app', chalk_1.default.green.bold('APP UNINSTALLATION'));
         await (0, apps_1.deleteAppOrg)(appToDelete.id);
         // eslint-disable-next-line no-constant-condition

package/dist/commands/app/upgrade.js

@@ -40,7 +40,7 @@ class UpgradeApp extends core_1.Command {
                     message: 'Which app version would you like to upgrade to?',
                     choices: versions.map(x => {
                         const number = x.versionNumber.toString().padStart(4, '0');
-                        const name = x.id === appOrgToUpgrade.appVersionId ? `${number} (${x.createdOn}) (current)` : `${number} (${x.createdOn})`;
+                        const name = x.id === appOrgToUpgrade.appVersionId ? `${number} (${x.createdOn}) (${x.appRuntime}) (current)` : `${number} (${x.createdOn}) (${x.appRuntime})`;
                         return {
                             value: x.id, name
                         };

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

@@ -1,8 +1,11 @@
-import { App, AppDeclaration } from '../../interfaces';
+import { App, AppCodePackage, AppDeclaration } from '../../interfaces';
 export declare class AppDeployer {
+    private debug;
+    constructor(debug?: boolean);
     deploy(appDeclaration: AppDeclaration): Promise<App>;
     getExistingApp(appDeclaration: AppDeclaration): Promise<App>;
     private createNewApp;
     updateExistingApp(appDeclaration: AppDeclaration, existingApp: any): Promise<any>;
     remove(appDeclaration: AppDeclaration): Promise<void>;
 }
+export declare function createNodePackage(appIdentifier: string, debug: boolean): Promise<AppCodePackage>;

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

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AppDeployer = void 0;
+exports.createNodePackage = exports.AppDeployer = void 0;
 const tslib_1 = require("tslib");
 const sdk_1 = require("@contrail/sdk");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
@@ -9,7 +9,15 @@ const actions_deployer_1 = require("./actions-deployer");
 const app_template_parsers_1 = require("./app-template-parsers");
 const workflow_template_definition_deployer_1 = require("../workflow-template-definitions/workflow-template-definition-deployer");
 const apps_1 = require("../../api/apps");
+const zip_a_folder_1 = require("zip-a-folder");
+const axios_1 = tslib_1.__importDefault(require("axios"));
+const child_process = require('child_process');
+const fs = require('fs');
 class AppDeployer {
+    constructor(debug = false) {
+        this.debug = debug;
+        //pass
+    }
     async deploy(appDeclaration) {
         let app = await this.getExistingApp(appDeclaration);
         if (!app) {
@@ -30,6 +38,7 @@ class AppDeployer {
         return apps.find(app => app.identifier === appDeclaration.appIdentifier);
     }
     async createNewApp(appDeclaration) {
+        var _a;
         let configProperties;
         if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.appConfiguration) {
             configProperties = app_template_parsers_1.ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
@@ -38,6 +47,13 @@ class AppDeployer {
         if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.triggers) {
             triggerKeyDefinitions = app_template_parsers_1.TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
         }
+        // does appDeclaration have dockerImageRef
+        const isDocker = Object.hasOwnProperty.call(appDeclaration, 'dockerImageRef');
+        let appCodePackageId;
+        if (!isDocker) { // this is the expected default behavior
+            const appCodePackage = await createNodePackage(appDeclaration.appIdentifier, this.debug);
+            appCodePackageId = appCodePackage.id;
+        }
         const newApp = {
             identifier: appDeclaration.appIdentifier,
             name: appDeclaration.appName,
@@ -50,13 +66,15 @@ class AppDeployer {
             keywords: appDeclaration.keywords,
             configProperties,
             triggerKeyDefinitions,
-            dockerImageRef: appDeclaration.dockerImageRef,
+            dockerImageRef: (_a = appDeclaration.dockerImageRef) !== null && _a !== void 0 ? _a : null,
+            appCodePackageId: appCodePackageId !== null && appCodePackageId !== void 0 ? appCodePackageId : null,
         };
         const 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'));
         return app;
     }
     async updateExistingApp(appDeclaration, existingApp) {
+        var _a;
         let configProperties;
         if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.appConfiguration) {
             configProperties = app_template_parsers_1.ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
@@ -65,6 +83,13 @@ class AppDeployer {
         if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.triggers) {
             triggerKeyDefinitions = app_template_parsers_1.TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
         }
+        // does appDeclaration have dockerImageRef
+        const isDocker = Object.hasOwnProperty.call(appDeclaration, 'dockerImageRef');
+        let appCodePackageId;
+        if (!isDocker) { // this is the expected default behavior
+            const appCodePackage = await createNodePackage(appDeclaration.appIdentifier, this.debug);
+            appCodePackageId = appCodePackage.id;
+        }
         const updates = {
             name: appDeclaration.appName,
             public: appDeclaration.visibility === 'public',
@@ -76,7 +101,8 @@ class AppDeployer {
             keywords: appDeclaration.keywords,
             configProperties,
             triggerKeyDefinitions,
-            dockerImageRef: appDeclaration.dockerImageRef,
+            dockerImageRef: (_a = appDeclaration.dockerImageRef) !== null && _a !== void 0 ? _a : null,
+            appCodePackageId: appCodePackageId !== null && appCodePackageId !== void 0 ? appCodePackageId : null,
         };
         const app = await new sdk_1.Entities().update({ entityName: 'app', id: existingApp.id, object: updates });
         console.log(`%s      Updated app: ${app.name}`, chalk_1.default.yellow.bold('APP'));
@@ -99,3 +125,71 @@ class AppDeployer {
     }
 }
 exports.AppDeployer = AppDeployer;
+async function createNodePackage(appIdentifier, debug) {
+    // zip src code and package.json and package-lock.json files into a zip file
+    // and upload as a code package.
+    const entitiesClient = new sdk_1.Entities();
+    try {
+        // clear and make temp directory
+        fs.rmSync('tmp/', { recursive: true, force: true });
+        fs.cpSync('package.json', 'tmp/package.json');
+        fs.cpSync('app.yml', 'tmp/app.yml');
+        //copy package-lock.json if it exists
+        if (fs.existsSync('package-lock.json')) {
+            fs.cpSync('package-lock.json', 'tmp/package-lock.json');
+        }
+        fs.mkdirSync('tmp/node_modules', { recursive: true });
+        console.log('Installing production dependencies started...');
+        child_process.execSync('npm install --omit=dev --prefix tmp/');
+        console.log('Installing production dependencies done.');
+        console.log('Building package...');
+        child_process.execSync('npx tsc --outDir tmp/dist');
+        console.log('Building package done.');
+        console.log('Zipping package...');
+        await (0, zip_a_folder_1.zip)('tmp/', 'tmp.zip');
+        console.log('Zipping package done.');
+        console.log('Uploading package to S3...');
+        let apps = await entitiesClient.get({ entityName: 'app', criteria: { hidden: true } });
+        apps = apps.concat(await entitiesClient.get({ entityName: 'app', criteria: { private: true } }));
+        const thisApp = apps.find(x => x.identifier === appIdentifier);
+        if (!thisApp) {
+            throw new Error('App not found');
+        }
+        const appCodePackage = await entitiesClient.create({ entityName: 'app-code-package', object: { appId: thisApp.id } });
+        // upload an s3 object using a signed url with an https put request
+        const readStream = fs.readFileSync('tmp.zip');
+        const postBody = Buffer.from(readStream);
+        // await axios.put(uploadUrlObject.signedUrl, postBody.toString());
+        await axios_1.default.request({
+            method: 'PUT',
+            url: appCodePackage.uploadURL,
+            data: postBody,
+            headers: {
+                // explicitly do not include content type because that breaks S3
+                'content-type': '',
+            }
+        });
+        // update app with the most recent code package
+        await entitiesClient.update({ entityName: 'app', id: thisApp.id, object: { appCodePackageId: appCodePackage.id } });
+        return appCodePackage;
+    }
+    catch (e) {
+        console.error('%s      Failed to create app package.', chalk_1.default.red.bold('APP'));
+        throw e;
+    }
+    finally {
+        if (!debug) {
+            cleanUp();
+        }
+    }
+}
+exports.createNodePackage = createNodePackage;
+function cleanUp() {
+    console.log('cleaning up');
+    if (fs.existsSync('tmp')) {
+        fs.rmSync('tmp', { recursive: true, force: true });
+    }
+    if (fs.existsSync('tmp.zip')) {
+        fs.rmSync('tmp.zip');
+    }
+}

package/dist/helpers/app/setup-template.d.ts

@@ -1 +1,7 @@
-export declare function setUpTemplate(): Promise<void>;
+interface AppSetUpInputs {
+    appName: string;
+    appIdentifier: string;
+    appDescription: string;
+}
+export declare function setUpTemplate(appInput: AppSetUpInputs): Promise<void>;
+export {};

package/dist/helpers/app/setup-template.js

@@ -7,6 +7,7 @@ const path_1 = tslib_1.__importDefault(require("path"));
 const util_1 = require("util");
 const Listr = require('listr');
 const pkg_install_1 = require("pkg-install");
+const fs_1 = tslib_1.__importDefault(require("fs"));
 const copy = (0, util_1.promisify)(ncp_1.default);
 const TARGET_DIR = process.cwd();
 function copyTemplate(templateDir) {
@@ -14,7 +15,7 @@ function copyTemplate(templateDir) {
         clobber: false,
     });
 }
-async function setUpTemplate() {
+async function setUpTemplate(appInput) {
     const templateDir = path_1.default.resolve(path_1.default.join(__dirname, '../../templates/typescript'));
     try {
         const tasks = new Listr([
@@ -30,6 +31,13 @@ async function setUpTemplate() {
             },
         ]);
         await tasks.run();
+        // replace properties in yml file with appName
+        const appYmlFileLoc = path_1.default.join(TARGET_DIR, 'app.yml');
+        const appYml = fs_1.default.readFileSync(appYmlFileLoc, 'utf8');
+        const newAppYml = appYml.replace(/APP_IDENTIFIER_STUB/g, appInput.appIdentifier)
+            .replace(/APP_NAME_STUB/g, appInput.appName)
+            .replace(/APP_DESCRIPTION_STUB/g, appInput.appDescription);
+        fs_1.default.writeFileSync(appYmlFileLoc, newAppYml);
     }
     catch (e) {
         throw new Error(`Error copying template: ${e}`);

package/dist/interfaces.d.ts

@@ -108,6 +108,7 @@ export interface App {
     configProperties?: ConfigProperty[];
     triggerKeyDefinitions?: TriggerKeyDefinition[];
     latestAppVersionId?: string;
+    appRuntime?: AppRuntime;
 }
 export interface AppOrg {
     id: string;
@@ -126,6 +127,11 @@ export interface AppOrg {
     apiKey?: AppApiKey;
     appConfig?: any;
 }
+export interface AppCodePackage {
+    id: string;
+    appId: string;
+    uploadURL: string;
+}
 export declare enum AppOrgStatus {
     INSTALLING = "INSTALLING",
     FAILED_INSTALLING = "FAILED_INSTALLING",
@@ -141,6 +147,10 @@ export declare enum AppVersionStatus {
     FAILED_ARCHIVING = "FAILED_ARCHIVING",
     ARCHIVED = "ARCHIVED"
 }
+export declare enum AppRuntime {
+    DOCKER = "DOCKER",
+    NODE = "NODE"
+}
 export declare class AppVersion {
     id: string;
     createdOn?: Date;
@@ -159,6 +169,7 @@ export declare class AppVersion {
     configProperties?: ConfigProperty[];
     triggerKeyDefinitions?: TriggerKeyDefinition[];
     dockerImageRef?: string;
+    appRuntime?: AppRuntime;
 }
 export declare class AppApiKey {
     id: string;

package/dist/interfaces.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssortmentConfigurationRelationships = exports.AssortmentConfigurationSlim = exports.FolderSlim = exports.ProjectConfigurationTemplate = exports.ProjectConfiguration = exports.Folder = exports.AssortmentConfiguration = exports.AssortmentType = exports.CommonConfiguration = exports.TriggerKeyDefinition = exports.ConfigProperty = exports.AppApiKey = exports.AppVersion = exports.AppVersionStatus = exports.AppOrgStatus = void 0;
+exports.AssortmentConfigurationRelationships = exports.AssortmentConfigurationSlim = exports.FolderSlim = exports.ProjectConfigurationTemplate = exports.ProjectConfiguration = exports.Folder = exports.AssortmentConfiguration = exports.AssortmentType = exports.CommonConfiguration = exports.TriggerKeyDefinition = exports.ConfigProperty = exports.AppApiKey = exports.AppVersion = exports.AppRuntime = exports.AppVersionStatus = exports.AppOrgStatus = void 0;
 var AppOrgStatus;
 (function (AppOrgStatus) {
     AppOrgStatus["INSTALLING"] = "INSTALLING";
@@ -18,6 +18,11 @@ var AppVersionStatus;
     AppVersionStatus["FAILED_ARCHIVING"] = "FAILED_ARCHIVING";
     AppVersionStatus["ARCHIVED"] = "ARCHIVED";
 })(AppVersionStatus = exports.AppVersionStatus || (exports.AppVersionStatus = {}));
+var AppRuntime;
+(function (AppRuntime) {
+    AppRuntime["DOCKER"] = "DOCKER";
+    AppRuntime["NODE"] = "NODE";
+})(AppRuntime = exports.AppRuntime || (exports.AppRuntime = {}));
 class AppVersion {
 }
 exports.AppVersion = AppVersion;

package/dist/templates/typescript/app.yml

@@ -1,11 +1,11 @@
-appIdentifier: "@your-co/app-name"  # Change to be your company root domain and the name of the app
-appName: "Your App Name" # Give your app a name
-appDescription: "Your app description." # Give your app a description
+appIdentifier: "APP_IDENTIFIER_STUB"  # Change to be your company root domain and the name of the app
+appName: "APP_NAME_STUB" # Give your app a name
+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
-dockerImageRef: CHANGE_ME  # For VibeIQ Deployment... for use by VibeIQ employees only
+# dockerImageRef: CHANGE_ME  # Deprecated. For VibeIQ Deployment... for use by VibeIQ employees only
 
 # Properties you can configure when you install the app.
 # These property values will be available to all of your actions when they run

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.15",
+  "version": "2.0.17",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -109,6 +109,14 @@
           "description": "In addition to deploying, upgrade the installed version of the app in this org to the latest one.",
           "required": false,
           "allowNo": false
+        },
+        "debug": {
+          "name": "debug",
+          "type": "boolean",
+          "char": "d",
+          "description": "Debug the app deployment step and do not remove the intermediate build artifacts.",
+          "required": false,
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.0.15",
+  "version": "2.0.17",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -45,13 +45,15 @@
     "listr": "^0.14.3",
     "lodash": "^4.17.21",
     "ncp": "^2.0.0",
-    "pkg-install": "^1.0.0"
+    "pkg-install": "^1.0.0",
+    "zip-a-folder": "^1.1.5"
   },
   "devDependencies": {
     "@oclif/test": "^2.3.8",
     "@types/chai": "^4",
     "@types/jest": "^29.5.0",
     "@types/node": "^16.18.14",
+    "axios": "^1.3.5",
     "chai": "^4",
     "eslint": "^8.35.0",
     "eslint-config-oclif": "^4",