@contrail/cli 2.2.2 → 2.2.3

package/README.md

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

package/dist/commands/app/create.js

@@ -52,6 +52,7 @@ class CreateApp extends basecommand_1.BaseCommand {
         }
         const newApp = {
             identifier: sanitizedIdentifier,
+            version: '1.0.0',
             name: answers.appName,
             publisher: answers.appPublisher,
             public: false,

package/dist/commands/app/version/major.js

@@ -14,7 +14,7 @@ class AppMajorVersionUpgrade extends basecommand_1.BaseCommand {
     async run() {
         let appDeclaration;
         try {
-            appDeclaration = (0, load_app_config_1.loadAppConfig)();
+            appDeclaration = (0, load_app_config_1.loadAppConfig)({ skipValidation: true });
         }
         catch (e) {
             logger_1.default.error(`Application Load Configuration Failed: ${e}`);

package/dist/commands/app/version/minor.js

@@ -14,7 +14,7 @@ class AppMinorVersionUpgrade extends basecommand_1.BaseCommand {
     async run() {
         let appDeclaration;
         try {
-            appDeclaration = (0, load_app_config_1.loadAppConfig)();
+            appDeclaration = (0, load_app_config_1.loadAppConfig)({ skipValidation: true });
         }
         catch (e) {
             logger_1.default.error(`Application Load Configuration Failed: ${e}`);

package/dist/commands/app/version/patch.js

@@ -14,7 +14,7 @@ class AppPatchVersionUpgrade extends basecommand_1.BaseCommand {
     async run() {
         let appDeclaration;
         try {
-            appDeclaration = (0, load_app_config_1.loadAppConfig)();
+            appDeclaration = (0, load_app_config_1.loadAppConfig)({ skipValidation: true });
         }
         catch (e) {
             logger_1.default.error(`Application Load Configuration Failed: ${e}`);

package/dist/helpers/app/app-config-validators.d.ts

@@ -0,0 +1,7 @@
+import { AppDeclaration } from '../../interfaces';
+export interface AppConfigValidationError {
+    error: string;
+}
+export declare function validateAppConfig(appConfig: AppDeclaration): void;
+export declare function appVersionValidator(appDeclaration: AppDeclaration): AppConfigValidationError;
+export declare function visibilityValidator(appDeclaration: AppDeclaration): AppConfigValidationError;

package/dist/helpers/app/app-config-validators.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.visibilityValidator = exports.appVersionValidator = exports.validateAppConfig = void 0;
+const VALIDATORS = [appVersionValidator, visibilityValidator];
+function validateAppConfig(appConfig) {
+    const errors = [];
+    for (const validator of VALIDATORS) {
+        const error = validator(appConfig);
+        if (error) {
+            errors.push(error);
+        }
+    }
+    if (errors.length) {
+        throw new Error(`Invalid app config: \n ${errors.map((x) => x.error).join('\n')}`);
+    }
+}
+exports.validateAppConfig = validateAppConfig;
+function appVersionValidator(appDeclaration) {
+    if (!appDeclaration.version) {
+        return {
+            error: 'Missing "version" field". Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+        };
+    }
+    if (typeof appDeclaration.version !== 'string') {
+        return {
+            error: '"version" field is not a string. Expecting a version like "1.0.0". Manually update the "version" field to be a string in the app.yml file.',
+        };
+    }
+    const parts = appDeclaration.version.split('.');
+    if (parts.length !== 3) {
+        return {
+            error: 'Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+        };
+    }
+}
+exports.appVersionValidator = appVersionValidator;
+function visibilityValidator(appDeclaration) {
+    if (!['public', 'private'].includes(appDeclaration.visibility)) {
+        return {
+            error: 'Invalid visibility. Visibility must be "public" or "private".',
+        };
+    }
+    if (appDeclaration.visibility === 'private' && appDeclaration.hidden !== true) {
+        return {
+            error: 'Apps can not be private and hidden.',
+        };
+    }
+}
+exports.visibilityValidator = visibilityValidator;

package/dist/helpers/app/app-config-validators.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/app/app-config-validators.spec.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const app_config_validators_1 = require("./app-config-validators");
+describe('appVersionValidator', () => {
+    it('should return an error if "version" field is missing', () => {
+        const appDeclaration = {};
+        const expectedError = {
+            error: 'Missing "version" field". Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+        };
+        const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should return an error if app version is invalid', () => {
+        const appDeclaration = {
+            version: 'invalidVersion',
+        };
+        const expectedError = {
+            error: 'Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+        };
+        const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should not return an error if app version is valid', () => {
+        const appDeclaration = {
+            version: '1.0.0',
+        };
+        const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
+        expect(validationResult).toBeUndefined();
+    });
+    it('should gracefully handle bad versions', () => {
+        const appDeclaration = {
+            version: '1',
+        };
+        const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
+        expect(validationResult.error).toEqual('Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.');
+    });
+});
+it('should return an error if "version" field is not a string', () => {
+    const appDeclaration = {
+        version: 123,
+    };
+    const expectedError = {
+        error: '"version" field is not a string. Expecting a version like "1.0.0". Manually update the "version" field to be a string in the app.yml file.',
+    };
+    const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
+    expect(validationResult).toEqual(expectedError);
+});
+it('should return an error if "version" field is empty', () => {
+    const appDeclaration = {
+        version: '',
+    };
+    const expectedError = {
+        error: 'Missing "version" field". Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+    };
+    const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
+    expect(validationResult).toEqual(expectedError);
+});
+it('should return an error if app version has invalid format', () => {
+    const appDeclaration = {
+        version: '1.0',
+    };
+    const expectedError = {
+        error: 'Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+    };
+    const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
+    expect(validationResult).toEqual(expectedError);
+});

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

@@ -61,6 +61,7 @@ class AppDeployer {
         const newApp = {
             identifier: appDeclaration.appIdentifier,
             name: appDeclaration.appName,
+            version: appDeclaration.version,
             public: appDeclaration.visibility === 'public',
             hidden: appDeclaration.hidden,
             description: appDeclaration.appDescription,

package/dist/helpers/app/load-app-config.d.ts

@@ -1,2 +1,4 @@
 import { AppDeclaration } from '../../interfaces';
-export declare function loadAppConfig(): AppDeclaration;
+export declare function loadAppConfig(config?: {
+    skipValidation: boolean;
+}): AppDeclaration;

package/dist/helpers/app/load-app-config.js

@@ -5,10 +5,14 @@ const tslib_1 = require("tslib");
 const path = tslib_1.__importStar(require("path"));
 const fs_1 = tslib_1.__importDefault(require("fs"));
 const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
-function loadAppConfig() {
+const app_config_validators_1 = require("./app-config-validators");
+function loadAppConfig(config = { skipValidation: false }) {
     const TARGET_DIR = process.cwd();
     try {
         const doc = js_yaml_1.default.load(fs_1.default.readFileSync(path.resolve(path.join(TARGET_DIR, 'app.yml')), 'utf8'));
+        if (!(config === null || config === void 0 ? void 0 : config.skipValidation)) {
+            (0, app_config_validators_1.validateAppConfig)(doc);
+        }
         return doc;
     }
     catch (e) {

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.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

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.2.2",
+  "version": "2.2.3",
   "commands": {
     "app:create": {
       "id": "app:create",

package/package.json

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