@contrail/cli 2.2.1 → 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.1 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/delete.js

@@ -13,7 +13,7 @@ class DeleteApp extends basecommand_1.BaseCommand {
             appDeclaration = (0, load_app_config_1.loadAppConfig)();
         }
         catch (e) {
-            this.error(`%s Application Removal Failed. ${e}`);
+            logger_1.default.error(`%s Application Removal Failed. ${e}`);
             return;
         }
         logger_1.default.info(`Removing Application. ${appDeclaration.appIdentifier}`);

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/commands/types/uploadOptionSetHierarchies.js

@@ -99,7 +99,7 @@ async function uploadOSH(loadedOSHs) {
                 if (!transformOSHNameToID(osh.hierarchy, optionSets)) {
                     continue;
                 }
-                logger_1.default.debug(`Creating: ': ${JSON.stringify(osh)}`);
+                logger_1.default.debug(`Creating:  ${JSON.stringify(osh)}`);
                 await new sdk_1.Entities().create({
                     entityName: 'option-set-hierarchy',
                     object: osh,
@@ -201,7 +201,7 @@ async function uploadOSHLinks(reducedOSHLinks) {
                 if (!transformReducedLink(loadedLink, typesWithProperties, currentOSHs)) {
                     continue;
                 }
-                logger_1.default.debug(`Creating: ': ${JSON.stringify(loadedLink)}`);
+                logger_1.default.debug(`Creating:  ${JSON.stringify(loadedLink)}`);
                 await new sdk_1.Entities().create({
                     entityName: 'type-option-set-hierarchy-link',
                     object: {

package/dist/commands/types/uploadOptionSetsHierarchyLocalFile.js

@@ -101,7 +101,7 @@ async function uploadOptionSetHierarchiesLocalFile(fileLocation, name) {
     });
     const existing = currentOptionSetHierarchies.find((osh) => osh.name === name);
     if (existing) {
-        logger_1.default.info(`Updating: ': ${optionSetHierarchy.name}`);
+        logger_1.default.info(`Updating:  ${optionSetHierarchy.name}`);
         await new sdk_1.Entities().update({
             entityName: 'option-set-hierarchy',
             id: existing.id,
@@ -109,7 +109,7 @@ async function uploadOptionSetHierarchiesLocalFile(fileLocation, name) {
         });
     }
     else {
-        logger_1.default.info(`Creating: ': ${optionSetHierarchy.name}`);
+        logger_1.default.info(`Creating:  ${optionSetHierarchy.name}`);
         await new sdk_1.Entities().create({
             entityName: 'option-set-hierarchy',
             object: optionSetHierarchy,

package/dist/commands/types/uploadTypePolicies.js

@@ -117,14 +117,14 @@ async function uploadTypePolicyObjects(reducedTypePolicies) {
         try {
             const found = currentTypePolicyByIdentifier[identifier];
             if (!found) {
-                logger_1.default.info(`Creating: ': ${identifier}`);
+                logger_1.default.info(`Creating:  ${identifier}`);
                 await new sdk_1.Entities().create({
                     entityName: 'type-policy',
                     object: loadedTPP,
                 });
             }
             else {
-                logger_1.default.info(`Updating: ': ${identifier}`);
+                logger_1.default.info(`Updating:  ${identifier}`);
                 await new sdk_1.Entities().update({
                     entityName: 'type-policy',
                     id: found.id,
@@ -140,7 +140,7 @@ async function uploadTypePolicyObjects(reducedTypePolicies) {
         try {
             const found = loadedTypePolicyByIdentifier[identifier];
             if (!found) {
-                logger_1.default.info(`Deleting: ': ${identifier}`);
+                logger_1.default.info(`Deleting:  ${identifier}`);
                 await new sdk_1.Entities().delete({
                     entityName: 'type-policy',
                     id: currentTPP['id'],
@@ -165,7 +165,7 @@ async function uploadTypePolicyLinks(reducedTypePolicyLinks) {
         const foundType = types.find((type) => type.id === currentLink.typeId);
         const foundTypePolicy = currentTypePolicies.find((tp) => tp.id === currentLink.typePolicyId);
         if (!foundType || !foundTypePolicy) {
-            logger_1.default.info(`skipping unhashable, invalid policy link:': ${currentLink}`);
+            logger_1.default.info(`skipping unhashable, invalid policy link: ${currentLink}`);
         }
         const hash = `${foundType.slug}|${foundTypePolicy.identifier}`;
         currentLinksHashes[hash] = currentLink;
@@ -204,7 +204,7 @@ async function uploadTypePolicyLinks(reducedTypePolicyLinks) {
         try {
             const found = reducedLinksByHashes[currentLinkHash];
             if (!found) {
-                logger_1.default.info(`Deleting: ': ${currentLinkHash}`);
+                logger_1.default.info(`Deleting:  ${currentLinkHash}`);
                 await new sdk_1.Entities().delete({
                     entityName: 'type-policy-link',
                     id: currentLink['id'],

package/dist/commands/types/uploadTypePropertyPolicies.js

@@ -119,14 +119,14 @@ async function uploadTPPolicyObjects(reducedTypePropertyPolicies) {
         try {
             const found = currentTPPByLabel[label];
             if (!found) {
-                logger_1.default.info(`Creating: ': ${label}`);
+                logger_1.default.info(`Creating:  ${label}`);
                 await new sdk_1.Entities().create({
                     entityName: 'type-property-policy',
                     object: loadedTPP,
                 });
             }
             else {
-                logger_1.default.info(`Updating: ': ${label}`);
+                logger_1.default.info(`Updating:  ${label}`);
                 await new sdk_1.Entities().update({
                     entityName: 'type-property-policy',
                     id: found.id,
@@ -142,7 +142,7 @@ async function uploadTPPolicyObjects(reducedTypePropertyPolicies) {
         try {
             const found = loadedTPPByName[label];
             if (!found) {
-                logger_1.default.info(`Deleting: ': ${label}`);
+                logger_1.default.info(`Deleting:  ${label}`);
                 await new sdk_1.Entities().delete({
                     entityName: 'type-property-policy',
                     id: currentTPP['id'],
@@ -177,7 +177,7 @@ async function uploadTypePropertyPolicyLinks(reducedTypePropertyPolicyLinks) {
         const foundTypeProperty = typeProperties.find((tp) => tp.id === currentLink.typePropertyId);
         const foundTPP = currentTPPs.find((tpp) => tpp.id === currentLink.typePropertyPolicyId);
         if (!foundTypeProperty || !foundTPP) {
-            logger_1.default.info(`skipping unhashable, invalid policy link:': ${currentLink}`);
+            logger_1.default.info(`skipping unhashable, invalid policy link: ${currentLink}`);
         }
         const hash = `${foundTypeProperty.typeSlug}${foundTypeProperty.slug}|${foundTPP.identifier}`;
         currentLinksHashes[hash] = currentLink;
@@ -216,7 +216,7 @@ async function uploadTypePropertyPolicyLinks(reducedTypePropertyPolicyLinks) {
         try {
             const found = reducedLinksByHashes[currentLinkHash];
             if (!found) {
-                logger_1.default.info(`Deleting: ': ${currentLinkHash}`);
+                logger_1.default.info(`Deleting:  ${currentLinkHash}`);
                 await new sdk_1.Entities().delete({
                     entityName: 'type-property-policy-link',
                     id: currentLink['id'],

package/dist/commands/types/uploadUsageInfo.js

@@ -70,7 +70,7 @@ async function uploadUsageInfoObjects(loadedUsageInfo) {
         const foundType = typesWithProperties.find((t) => t.id === currentUI.typeId);
         const foundTypeProperty = typeProperties.find((tp) => tp.id === currentUI.typePropertyId);
         if (!foundType || !foundTypeProperty) {
-            logger_1.default.info(`skipping unhashable, invalid usage info:': ${currentUI}`);
+            logger_1.default.info(`skipping unhashable, invalid usage info: ${currentUI}`);
             continue;
         }
         const hash = `${foundType.slug}|${foundTypeProperty.slug}`;
@@ -81,7 +81,7 @@ async function uploadUsageInfoObjects(loadedUsageInfo) {
         const hash = `${loadedUI.typeSlug}|${loadedUI.typePropertySlug}`;
         reducedUsageInfoHashes[hash] = loadedUI;
     }
-    logger_1.default.debug(`current usage info:': ${currentUsageInfo}`);
+    logger_1.default.debug(`current usage info: ${currentUsageInfo}`);
     logger_1.default.debug('loaded usage info:', loadedUsageInfo);
     for (const loadedUI of loadedUsageInfo) {
         try {
@@ -90,7 +90,7 @@ async function uploadUsageInfoObjects(loadedUsageInfo) {
                 if (!transformReducedUI(loadedUI, typesWithProperties, typeProperties)) {
                     continue;
                 }
-                logger_1.default.debug(`Creating: ': ${loadedUI}`);
+                logger_1.default.debug(`Creating:  ${loadedUI}`);
                 await new sdk_1.Entities().create({
                     entityName: 'type-property-usage-info',
                     object: {
@@ -110,7 +110,7 @@ async function uploadUsageInfoObjects(loadedUsageInfo) {
                 if (!transformReducedUI(loadedUI, typesWithProperties, typeProperties)) {
                     continue;
                 }
-                logger_1.default.info(`Updating: ': ${loadedUI}`);
+                logger_1.default.info(`Updating:  ${loadedUI}`);
                 await new sdk_1.Entities().update({
                     entityName: 'type-property-usage-info',
                     id: found.id,
@@ -129,7 +129,7 @@ async function uploadUsageInfoObjects(loadedUsageInfo) {
         try {
             const found = reducedUsageInfoHashes[hash];
             if (!found) {
-                logger_1.default.debug(`Creating: ': ${hash}`);
+                logger_1.default.debug(`Creating:  ${hash}`);
                 await new sdk_1.Entities().delete({
                     entityName: 'type-property-usage-info',
                     id: currentUI['id'],

package/dist/commands/webhooks/list.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const core_1 = require("@oclif/core");
-const login_1 = require("../../auth/login");
 const webhooks_1 = require("../../api/webhooks");
+const login_1 = require("../../auth/login");
 const basecommand_1 = require("../../basecommand");
 class ListWebhooks extends basecommand_1.BaseCommand {
     async run() {

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,
@@ -113,6 +114,7 @@ class AppDeployer {
             : [];
         const updates = {
             name: appDeclaration.appName,
+            version: appDeclaration.version,
             public: appDeclaration.visibility === 'public',
             hidden: appDeclaration.hidden,
             description: appDeclaration.appDescription,
@@ -127,6 +129,7 @@ class AppDeployer {
             appCodePackageId: appCodePackageId !== null && appCodePackageId !== void 0 ? appCodePackageId : null,
             frameworkVersion: 2,
         };
+        logger_1.default.debug(`app update: ${JSON.stringify(updates, null, 2)}`);
         if (this.dryRun) {
             logger_1.default.info('Dry run, not creating app');
             return {};

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/helpers/types/type-uploader.js

@@ -69,7 +69,7 @@ async function uploadReducedTypes(dir) {
                     logger_1.default.info(`Cannot create a base type. Skipping: ${type.slug}`);
                     continue;
                 }
-                logger_1.default.info(`Creating Type: ': ${type.slug}`);
+                logger_1.default.info(`Creating Type:  ${type.slug}`);
                 const createdType = await new sdk_1.Entities().create({
                     entityName: 'type',
                     object: {
@@ -84,7 +84,7 @@ async function uploadReducedTypes(dir) {
                 await uploadReducedTypeProperties(createdType, newTypeProperties, type.typeProperties);
             }
             else {
-                logger_1.default.info(`Updating Type: ': ${type.slug}`);
+                logger_1.default.info(`Updating Type:  ${type.slug}`);
                 const updatedType = await new sdk_1.Entities().update({
                     entityName: 'type',
                     id: found.id,
@@ -124,7 +124,7 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
         try {
             const found = currentPropertyTypeBySlug[newPropertyType.slug];
             if (!found && !newPropertyType.inherited) {
-                logger_1.default.info(`Creating Type-Property: ': ${newPropertyType.slug}`);
+                logger_1.default.info(`Creating Type-Property:  ${newPropertyType.slug}`);
                 await sdk_1.Request.request(`/types/${type.id}/type-properties`, {
                     method: 'POST',
                     body: JSON.stringify({
@@ -155,7 +155,7 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
             else if (found &&
                 !newPropertyType.inherited &&
                 !typePropertiesEqual(found, newPropertyType, optionSetIdByIdentifier)) {
-                logger_1.default.info(`Updating Type-Property: ': ${newPropertyType.slug}`);
+                logger_1.default.info(`Updating Type-Property:  ${newPropertyType.slug}`);
                 await new sdk_1.Entities().update({
                     entityName: 'type-property',
                     id: found.id,
@@ -189,7 +189,7 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
         try {
             const found = newPropertyTypesBySlug[currentPropertyType.slug];
             if (!found && !currentPropertyType.inherited) {
-                logger_1.default.info(`Deleting Type-Property: ': ${currentPropertyType.slug}`);
+                logger_1.default.info(`Deleting Type-Property:  ${currentPropertyType.slug}`);
                 await sdk_1.Request.request(`/types/${type.id}/type-properties/${currentPropertyType.id}`, {
                     method: 'DELETE',
                     headers: {

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.1",
+  "version": "2.2.3",
   "commands": {
     "app:create": {
       "id": "app:create",

package/package.json

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