@contrail/cli 3.2.0 → 3.3.0

package/README.md

@@ -17,7 +17,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/3.2.0 darwin-arm64 node-v20.18.0
+@contrail/cli/3.3.0 darwin-arm64 node-v21.7.1
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND

package/dist/commands/app/create.js

@@ -9,6 +9,7 @@ const setup_template_1 = require("../../helpers/app/setup-template");
 const logger_1 = tslib_1.__importDefault(require("../../logger"));
 const app_deployer_1 = require("../../helpers/app/app-deployer");
 const load_app_config_1 = require("../../helpers/app/load-app-config");
+const entity_types_1 = require("@contrail/entity-types");
 class CreateApp extends basecommand_1.BaseCommand {
     static description = 'Create a new app. The current organization will be set as the owner of the app';
     static examples = [
@@ -26,6 +27,7 @@ class CreateApp extends basecommand_1.BaseCommand {
         const defaultAppIdentifier = `@${username}/hello-world`;
         const defaultAppDescription = `Hello world app by ${currentUser.email}`;
         const defaultAppPublisher = `${currentUser.email}`;
+        const defaultNodeRuntime = entity_types_1.NodeRuntime.NODEJS_22_X;
         const answers = await inquirer_1.default.prompt([
             {
                 type: 'input',
@@ -55,6 +57,17 @@ class CreateApp extends basecommand_1.BaseCommand {
                 default: defaultAppPublisher,
                 required: true,
             },
+            {
+                type: 'list',
+                name: 'nodeRuntime',
+                message: 'Select the Node.js runtime for your app:',
+                choices: [
+                    { name: 'Node.js 22.x (recommended)', value: entity_types_1.NodeRuntime.NODEJS_22_X },
+                    { name: 'Node.js 18.x (deprecated)', value: entity_types_1.NodeRuntime.NODEJS_18_X },
+                ],
+                default: defaultNodeRuntime,
+                required: true,
+            },
         ]);
         let sanitizedIdentifier = answers.appIdentifier;
         if (!sanitizedIdentifier.startsWith('@')) {
@@ -68,6 +81,7 @@ class CreateApp extends basecommand_1.BaseCommand {
             public: false,
             description: answers.appDescription,
             frameworkVersion: 2,
+            nodeRuntime: answers.nodeRuntime,
         };
         try {
             await new sdk_1.Entities().create({ entityName: 'app', object: newApp });
@@ -81,6 +95,7 @@ class CreateApp extends basecommand_1.BaseCommand {
             appIdentifier: sanitizedIdentifier,
             appDescription: answers.appDescription,
             appPublisher: answers.appPublisher,
+            nodeRuntime: answers.nodeRuntime,
         });
         try {
             let appDeclaration = (0, load_app_config_1.loadAppConfig)();

package/dist/commands/app/init.js

@@ -6,6 +6,7 @@ const login_1 = require("../../auth/login");
 const basecommand_1 = require("../../basecommand");
 const setup_template_1 = require("../../helpers/app/setup-template");
 const sdk_1 = require("@contrail/sdk");
+const entity_types_1 = require("@contrail/entity-types");
 class InitApp extends basecommand_1.BaseCommand {
     static description = 'Initialize an app directory from a template';
     static examples = [
@@ -23,6 +24,7 @@ class InitApp extends basecommand_1.BaseCommand {
         const defaultAppIdentifier = `@${username}/hello-world`;
         const defaultAppDescription = `Hello world app by ${currentUser.email}`;
         const defaultAppPublisher = `${currentUser.email}`;
+        const defaultNodeRuntime = entity_types_1.NodeRuntime.NODEJS_22_X;
         const answers = await inquirer_1.default.prompt([
             {
                 type: 'input',
@@ -52,6 +54,17 @@ class InitApp extends basecommand_1.BaseCommand {
                 default: defaultAppPublisher,
                 required: true,
             },
+            {
+                type: 'list',
+                name: 'nodeRuntime',
+                message: 'Select the Node.js runtime for your app:',
+                choices: [
+                    { name: 'Node.js 22.x (recommended)', value: entity_types_1.NodeRuntime.NODEJS_22_X },
+                    { name: 'Node.js 18.x (deprecated)', value: entity_types_1.NodeRuntime.NODEJS_18_X },
+                ],
+                default: defaultNodeRuntime,
+                required: true,
+            },
         ]);
         let sanitizedIdentifier = answers.appIdentifier;
         if (!sanitizedIdentifier.startsWith('@')) {
@@ -62,6 +75,7 @@ class InitApp extends basecommand_1.BaseCommand {
             appIdentifier: sanitizedIdentifier,
             appDescription: answers.appDescription,
             appPublisher: answers.appPublisher,
+            nodeRuntime: answers.nodeRuntime,
         });
     }
 }

package/dist/commands/app/upgrade.js

@@ -64,13 +64,13 @@ class UpgradeApp extends basecommand_1.BaseCommand {
                     name: 'appVersion',
                     message: 'Which app version would you like to upgrade to?',
                     choices: versions
-                        .map((x) => {
-                        const number = x.semver;
-                        const name = x.id === appOrgToUpgrade.appVersionId
-                            ? `${number} - ${x.id} (${x.createdOn}) (${x.appRuntime}) (current)`
-                            : `${number} - ${x.id} (${x.createdOn}) (${x.appRuntime})`;
+                        .map((version) => {
+                        const number = version.semver;
+                        const name = version.id === appOrgToUpgrade.appVersionId
+                            ? `${number} - ${version.id} (${version.createdOn}) (current)`
+                            : `${number} - ${version.id} (${version.createdOn})`;
                         return {
-                            value: x.id,
+                            value: version.id,
                             name,
                         };
                     })

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

@@ -58,9 +58,11 @@ class AppDeployer {
         if (appDeclaration?.triggers) {
             triggerKeyDefinitions = app_template_parsers_1.TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
         }
-        let accessGrants = [];
-        if (appDeclaration?.accessGrants) {
-            accessGrants = await app_template_parsers_1.AccessGrantsParser.buildAccessGrants(appDeclaration);
+        const accessGrants = appDeclaration.accessGrants
+            ? await app_template_parsers_1.AccessGrantsParser.buildAccessGrants(appDeclaration)
+            : [];
+        if ('dockerImageRef' in appDeclaration) {
+            throw new Error('Docker apps are no longer supported. Please use a node app.');
         }
         const newApp = {
             identifier: appDeclaration.appIdentifier,
@@ -76,8 +78,8 @@ class AppDeployer {
             configProperties,
             externalLinks,
             triggerKeyDefinitions,
-            dockerImageRef: appDeclaration.dockerImageRef ?? null,
             frameworkVersion: 2,
+            nodeRuntime: appDeclaration.nodeRuntime,
         };
         if (this.dryRun) {
             logger_1.default.info('Dry run, not creating app');
@@ -85,14 +87,11 @@ class AppDeployer {
         }
         let app = await new sdk_1.Entities().create({ entityName: 'app', object: newApp });
         logger_1.default.info(`${chalk_1.default.yellow.bold('APP')}      Created new app: ${app.name}`);
-        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;
-            app = await new sdk_1.Entities().update({ entityName: 'app', id: app.id, object: app });
-            logger_1.default.info(`${chalk_1.default.yellow.bold('APP')}      Updated app with code package: ${app.name}`);
-        }
+        // this is the expected default behavior
+        const appCodePackage = await createNodePackage(appDeclaration.appIdentifier, this.debug, this.dryRun);
+        app.appCodePackageId = appCodePackage.id;
+        app = await new sdk_1.Entities().update({ entityName: 'app', id: app.id, object: app });
+        logger_1.default.info(`${chalk_1.default.yellow.bold('APP')}      Updated app with code package: ${app.name}`);
         return app;
     }
     async updateExistingApp(appDeclaration, existingApp) {
@@ -108,14 +107,11 @@ class AppDeployer {
         if (appDeclaration?.accessGrants) {
             accessGrants = await app_template_parsers_1.AccessGrantsParser.buildAccessGrants(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, this.dryRun);
-            appCodePackageId = appCodePackage.id;
+        if (appDeclaration.hasOwnProperty('dockerImageRef')) {
+            throw new Error('Docker apps are no longer supported. Please use a node app.');
         }
+        const appCodePackage = await createNodePackage(appDeclaration.appIdentifier, this.debug, this.dryRun);
+        const appCodePackageId = appCodePackage.id;
         const externalLinks = appDeclaration.externalLinks
             ? app_template_parsers_1.ExternalLinkParser.validateAndGetExternalLinks(appDeclaration.externalLinks)
             : [];
@@ -132,9 +128,9 @@ class AppDeployer {
             configProperties,
             externalLinks,
             triggerKeyDefinitions,
-            dockerImageRef: appDeclaration.dockerImageRef ?? null,
             appCodePackageId: appCodePackageId ?? null,
             frameworkVersion: 2,
+            nodeRuntime: appDeclaration.nodeRuntime,
         };
         logger_1.default.debug(`app update: ${JSON.stringify(updates, null, 2)}`);
         if (this.dryRun) {

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

@@ -1,8 +1,10 @@
+import { NodeRuntime } from '@contrail/entity-types';
 interface AppSetUpInputs {
     appName: string;
     appIdentifier: string;
     appDescription: string;
     appPublisher: string;
+    nodeRuntime: NodeRuntime;
 }
 export declare function setUpTemplate(appInput: AppSetUpInputs): Promise<void>;
 export {};

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

@@ -38,7 +38,8 @@ async function setUpTemplate(appInput) {
             .replace(/APP_IDENTIFIER_STUB/g, appInput.appIdentifier)
             .replace(/APP_NAME_STUB/g, appInput.appName)
             .replace(/APP_DESCRIPTION_STUB/g, appInput.appDescription)
-            .replace(/APP_PUBLISHER_STUB/g, appInput.appPublisher);
+            .replace(/APP_PUBLISHER_STUB/g, appInput.appPublisher)
+            .replace(/NODE_RUNTIME_STUB/g, appInput.nodeRuntime);
         fs_1.default.writeFileSync(appYmlFileLoc, newAppYml);
     }
     catch (e) {

package/dist/interfaces.d.ts

@@ -1,4 +1,4 @@
-import { AppExtensionType, AppExtensionUserApps } from '@contrail/entity-types';
+import { AppExtensionType, AppExtensionUserApps, NodeRuntime } from '@contrail/entity-types';
 import { ExternalLink } from '@contrail/entity-types';
 /** Describes the derivative JSON / object represented
  * in app.yml file.
@@ -26,7 +26,7 @@ export interface AppDeclaration {
     workflows?: {
         [key: string]: WorkflowDefinition | WorkflowTemplateDeclaration;
     };
-    dockerImageRef?: string;
+    nodeRuntime?: NodeRuntime;
 }
 export interface AccessGrantConfiguration {
     orgSlug: string;
@@ -149,7 +149,6 @@ export interface App {
     configProperties?: ConfigProperty[];
     triggerKeyDefinitions?: TriggerKeyDefinition[];
     latestAppVersionId?: string;
-    appRuntime?: AppRuntime;
 }
 export interface AppOrg {
     id: string;
@@ -195,10 +194,6 @@ 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;
@@ -217,8 +212,6 @@ export declare class AppVersion {
     eventWorkflowTriggerKeyMapping: string;
     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.AppExtensionPackageStatus = exports.AppExtensionDeploymentStatus = 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 = exports.AppAccessPermission = exports.AppAccessGrantScope = void 0;
+exports.AppExtensionPackageStatus = exports.AppExtensionDeploymentStatus = 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 = exports.AppAccessPermission = exports.AppAccessGrantScope = void 0;
 var AppAccessGrantScope;
 (function (AppAccessGrantScope) {
     AppAccessGrantScope["install"] = "INSTALL";
@@ -26,11 +26,6 @@ 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 {
     id;
     createdOn;
@@ -49,8 +44,6 @@ class AppVersion {
     eventWorkflowTriggerKeyMapping;
     configProperties;
     triggerKeyDefinitions;
-    dockerImageRef;
-    appRuntime;
 }
 exports.AppVersion = AppVersion;
 class AppApiKey {

package/dist/templates/typescript/app.yml

@@ -1,6 +1,7 @@
 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
+nodeRuntime: 'NODE_RUNTIME_STUB' # The Node.js runtime version to use for your app
 visibility: private # This should be private unless you want to develop an app for all VibeIQ customers to use
 # Access Grants
 # Use this section to share this app with other organizations.

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.2.0",
+  "version": "3.3.0",
   "commands": {
     "app:create": {
       "id": "app:create",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -22,7 +22,7 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@contrail/entity-types": "^1.1.17",
+    "@contrail/entity-types": "^1.3.0",
     "@contrail/org-config-migration": "^1.1.4",
     "@contrail/sdk": "^1.4.6",
     "@contrail/types": "^3.0.48",