@contrail/cli 1.0.6 → 1.0.9

package/lib/apps/deploy-app/app-deployer.js

@@ -7,9 +7,11 @@ export class AppDeployer {
     async deploy(appDeclaration) {
         let app = await this.getExistingApp(appDeclaration);
         if (!app) {
+            console.log(`%s      Creating new app.`, chalk.yellow.bold('APP'));
             app = await this.createNewApp(appDeclaration);
         }
         else {
+            console.log(`%s      Updating existing app.`, chalk.yellow.bold('APP'));
             app = await this.updateExistingApp(appDeclaration, app);
         }
         await new ActionsDeployer().deployActions(appDeclaration, app);
@@ -34,6 +36,14 @@ export class AppDeployer {
         return apps.find(app => app.identifier === appDeclaration.appIdentifier);
     }
     async createNewApp(appDeclaration) {
+        let configProperties;
+        if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.appConfiguration) {
+            configProperties = ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
+        }
+        let triggerKeyDefinitions;
+        if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.triggers) {
+            triggerKeyDefinitions = TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
+        }
         const newApp = {
             identifier: appDeclaration.appIdentifier,
             name: appDeclaration.appName,
@@ -43,14 +53,22 @@ export class AppDeployer {
             thumbnail: appDeclaration.thumbnail,
             eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
             keywords: appDeclaration.keywords,
-            configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
-            triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+            configProperties,
+            triggerKeyDefinitions,
         };
         const app = await new Entities().create({ entityName: 'app', object: newApp });
         console.log(`%s      Created new app: ${app.name}`, chalk.yellow.bold('APP'));
         return app;
     }
     async updateExistingApp(appDeclaration, existingApp) {
+        let configProperties;
+        if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.appConfiguration) {
+            configProperties = ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
+        }
+        let triggerKeyDefinitions;
+        if (appDeclaration === null || appDeclaration === void 0 ? void 0 : appDeclaration.triggers) {
+            triggerKeyDefinitions = TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
+        }
         const updates = {
             name: appDeclaration.appName,
             public: appDeclaration.visibility === 'public',
@@ -59,8 +77,8 @@ export class AppDeployer {
             thumbnail: appDeclaration.thumbnail,
             eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
             keywords: appDeclaration.keywords,
-            configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
-            triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+            configProperties,
+            triggerKeyDefinitions,
         };
         const app = await new Entities().update({ entityName: 'app', id: existingApp.id, object: updates });
         console.log(`%s      Updated app: ${app.name}`, chalk.yellow.bold('APP'));

package/lib/cli.js

@@ -2,35 +2,119 @@ import { create } from './apps/create-app/create';
 import { deployApp, removeApp } from './apps/deploy-app/deploy';
 import { getTypes } from './types/types-extractor';
 import { uploadTypes } from './types/types-uploader';
+import { parseOptionSet } from './types/parse-optionSet';
+const cliUsage = require('command-line-usage');
 /**
  *  Built using documentation here:
  *  https://www.twilio.com/blog/how-to-build-a-cli-with-node-js
  */
 export async function cli(args) {
-    const command = args[2];
-    switch (command) {
-        case 'create-app': {
-            create(args);
-            break;
-        }
-        case 'deploy-app': {
-            deployApp(args);
-            break;
-        }
-        case 'remove-app': {
-            removeApp(args);
+    const fullCommand = args[2];
+    let domain;
+    let command;
+    const commandParts = fullCommand.split('.');
+    if (!(commandParts === null || commandParts === void 0 ? void 0 : commandParts.length)) {
+        printIllegalCommand();
+        return;
+    }
+    if ((commandParts === null || commandParts === void 0 ? void 0 : commandParts.length) < 2 && commandParts[0].toLowerCase() !== 'help' && commandParts[0].toLowerCase() !== '-help' && commandParts[0].toLowerCase() !== '--help') {
+        printIllegalCommand();
+        return;
+    }
+    domain = commandParts[0];
+    command = commandParts[1];
+    switch (domain) {
+        case 'app': {
+            switch (command) {
+                case 'create': {
+                    create(args);
+                    break;
+                }
+                case 'deploy': {
+                    deployApp(args);
+                    break;
+                }
+                case 'remove': {
+                    removeApp(args);
+                    break;
+                }
+                default: {
+                    printIllegalCommand();
+                }
+            }
             break;
         }
-        case 'extract-types': {
-            getTypes(args);
+        case 'types': {
+            switch (command) {
+                case 'getAll': {
+                    getTypes(args);
+                    break;
+                }
+                case 'upload': {
+                    uploadTypes(args);
+                    break;
+                }
+                case 'parseOptionSet': {
+                    parseOptionSet(args);
+                    break;
+                }
+                default: {
+                    printIllegalCommand();
+                }
+            }
             break;
         }
-        case 'upload-types': {
-            uploadTypes(args);
+        case 'help':
+        case '-help':
+        case '--help': {
+            printHelp();
             break;
         }
         default: {
-            console.log('Illegal command.');
+            printIllegalCommand();
         }
     }
 }
+function printHelp() {
+    const sections = [
+        {
+            header: 'VibeIQ CLI',
+            content: 'From your friends at VibeIQ!',
+        },
+        ...helpSections,
+    ];
+    const usage = cliUsage(sections);
+    console.log(usage);
+}
+function printIllegalCommand() {
+    console.log('Illegal command.');
+    const usage = cliUsage(helpSections);
+    console.log(usage);
+}
+const helpSections = [
+    {
+        header: 'General Usage',
+        content: [
+            'Commands are run by pairing a domain with a command, joining them using a "."',
+            'e.g. app.create',
+            '',
+            'All <File Path> options should use the file path relative to the folder the command is being run in and include the file ext.',
+        ],
+    },
+    {
+        header: 'App Commands - Domain: app',
+        content: [
+            'create                       Create a new app workspace.',
+            'deploy                       Deploy your app.',
+            'remove                       Remove your app.',
+        ],
+    },
+    {
+        header: 'Type Commands - Domain: types',
+        content: [
+            'getAll                       Get all OptionSets and Types for your Org.',
+            'upload                       Upload OptionSets and Types for your Org.',
+            'parseOptionSet <File Path>   Parse a CSV file into OptionSets.',
+        ],
+    },
+];

package/lib/types/interfaces.d.ts

@@ -13,7 +13,7 @@ export interface ReducedTypeProperties {
     label: string;
     editable: boolean;
     core: boolean;
-    typePropertyOptionSetId: string;
+    typePropertyOptionSetName: string;
     formula: string;
     referencedTypeRootSlug: string;
     defaultValue: string;
@@ -21,7 +21,6 @@ export interface ReducedTypeProperties {
     inherited: boolean;
 }
 export interface ReducedOptionSet {
-    id: string;
     name: string;
     isArchived: boolean;
     optionSet: any[];

package/lib/types/parse-optionSet.d.ts

@@ -0,0 +1,2 @@
+export declare function parseOptionSet(args: any): Promise<void>;
+export declare function parseOptionSets(fileName: any): Promise<void>;

package/lib/types/parse-optionSet.js

@@ -0,0 +1,79 @@
+import { StringUtil } from '@contrail/util';
+import chalk from 'chalk';
+import fs from 'fs';
+import { getSeparatorByPlatform } from '../common';
+import * as csvToJson from 'csvtojson';
+const yaml = require('js-yaml');
+export async function parseOptionSet(args) {
+    try {
+        if ((args === null || args === void 0 ? void 0 : args.length) < 4) {
+            throw new Error('File name must be included.');
+        }
+        console.log(`%s Parsing`, chalk.yellow.bold('OPTION SETS'));
+        await parseOptionSets(args[3]);
+        console.log(`%s Parsed`, chalk.yellow.bold('OPTION SETS'));
+    }
+    catch (e) {
+        console.log(`%s Parsing Failed. ${e}`, chalk.red.bold('FAIL'));
+        return;
+    }
+    console.log('%s Parsing Complete.', chalk.green.bold('COMPLETE'));
+}
+async function loadDataFromCSV(fileName) {
+    const CURRENT_DIR = process.cwd();
+    try {
+        const separator = getSeparatorByPlatform();
+        const csvData = await csvToJson.default().fromFile(CURRENT_DIR + separator + fileName);
+        return csvData;
+    }
+    catch (e) {
+        throw new Error(`ERROR PARSING CSV: ${e}`);
+    }
+}
+export async function parseOptionSets(fileName) {
+    const csvData = await loadDataFromCSV(fileName);
+    const removedFields = new Set();
+    const valuesByFieldName = {};
+    for (const row of csvData) {
+        for (const [key, value] of Object.entries(row)) {
+            // Dont parse boolean fields - later log removed fields
+            if (value.toLowerCase() === 'false' || value.toLowerCase() === 'true') {
+                removedFields.add(key);
+                continue;
+            }
+            if (!value) {
+                continue;
+            }
+            if (!valuesByFieldName[key]) {
+                valuesByFieldName[key] = new Set();
+            }
+            valuesByFieldName[key].add(value);
+        }
+    }
+    for (const removed of removedFields.values()) {
+        console.log(`Removed Boolean Field: ${removed}`);
+    }
+    const reducedOptionSets = [];
+    for (const [key, value] of Object.entries(valuesByFieldName)) {
+        const optionSet = [];
+        for (const entry of value.values()) {
+            optionSet.push({
+                value: StringUtil.convertToCamelCase(entry),
+                display: isUpperCase(entry) ? entry : StringUtil.convertToTitleCase(entry),
+            });
+        }
+        const reducedOptionSet = {
+            name: StringUtil.convertToTitleCase(key),
+            isArchived: false,
+            optionSet,
+        };
+        reducedOptionSets.push(reducedOptionSet);
+    }
+    const yamlStr = yaml.dump(reducedOptionSets);
+    const CURRENT_DIR = process.cwd();
+    const separator = getSeparatorByPlatform();
+    fs.writeFileSync(CURRENT_DIR + separator + 'parsed_option_sets.yml', yamlStr, 'utf8');
+}
+function isUpperCase(str) {
+    return str === str.toUpperCase();
+}

package/lib/types/types-extractor.js

@@ -9,10 +9,13 @@ export async function getTypes(args) {
         const userConfig = await authUser();
         console.log(`%s Getting all types for orgId: ${userConfig.orgId}`, chalk.blue.bold('START'));
         console.log(`%s Retrieving`, chalk.yellow.bold('OPTION SETS'));
-        await getOptionSets();
+        const optionSets = await new Entities().get({
+            entityName: 'type-property-option-set',
+        });
+        await getOptionSets(optionSets);
         console.log(`%s Retrieved`, chalk.yellow.bold('OPTION SETS'));
         console.log(`%s Retrieving`, chalk.yellow.bold('TYPES'));
-        await getReducedTypes();
+        await getReducedTypes(optionSets);
         console.log(`%s Retrieved`, chalk.yellow.bold('TYPES'));
     }
     catch (e) {
@@ -21,15 +24,11 @@ export async function getTypes(args) {
     }
     console.log('%s Types Retrieval Complete.', chalk.green.bold('COMPLETE'));
 }
-async function getOptionSets() {
-    const optionSets = await new Entities().get({
-        entityName: 'type-property-option-set',
-    });
+async function getOptionSets(optionSets) {
     let reducedOptionSets = [];
     for (const optionSet of optionSets) {
         const reducedOptionSet = {
             name: optionSet.name,
-            id: optionSet.id,
             isArchived: optionSet.isArchived,
             optionSet: optionSet.optionSet,
         };
@@ -44,7 +43,7 @@ async function getOptionSets() {
     const yamlStr = yaml.dump(optionSetsHolder);
     fs.writeFileSync(CURRENT_DIR + separator + 'option_sets.yml', yamlStr, 'utf8');
 }
-async function getReducedTypes() {
+async function getReducedTypes(optionSets) {
     const types = await new Entities().get({
         entityName: 'type',
     });
@@ -56,6 +55,10 @@ async function getReducedTypes() {
             id: type.id,
             relations: ['typeProperties'],
         });
+        const optionSetNameById = {};
+        for (const optionSet of optionSets) {
+            optionSetNameById[optionSet.id] = optionSet.name;
+        }
         const reducedTypeProperties = [];
         for (const typeProperty of typeWithProperties.typeProperties) {
             const reducedTypeProperty = {
@@ -66,7 +69,7 @@ async function getReducedTypes() {
                 label: typeProperty.label,
                 editable: typeProperty.editable,
                 core: typeProperty.core,
-                typePropertyOptionSetId: typeProperty.typePropertyOptionSetId,
+                typePropertyOptionSetName: optionSetNameById[typeProperty.typePropertyOptionSetId],
                 formula: typeProperty.formula,
                 referencedTypeRootSlug: typeProperty.referencedTypeRootSlug,
                 defaultValue: typeProperty.defaultValue,

package/lib/types/types-uploader.js

@@ -4,6 +4,7 @@ import chalk from 'chalk';
 import fs from 'fs';
 import { authUser } from '../auth/login';
 import { getSeparatorByPlatform } from '../common';
+import * as _ from 'lodash';
 const yaml = require('js-yaml');
 export async function uploadTypes(args) {
     try {
@@ -119,6 +120,13 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
     for (const newPropertyType of newPropertyTypes) {
         newPropertyTypesBySlug[newPropertyType.slug] = newPropertyType;
     }
+    const optionSets = await new Entities().get({
+        entityName: 'type-property-option-set',
+    });
+    const optionSetIdByName = {};
+    for (const optionSet of optionSets) {
+        optionSetIdByName[optionSet.name] = optionSet.id;
+    }
     for (const newPropertyType of newPropertyTypes) {
         try {
             const found = currentPropertyTypeBySlug[newPropertyType.slug];
@@ -133,7 +141,7 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
                         label: newPropertyType.label,
                         editable: newPropertyType.editable,
                         core: newPropertyType.core,
-                        typePropertyOptionSetId: newPropertyType.typePropertyOptionSetId,
+                        typePropertyOptionSetId: optionSetIdByName[newPropertyType.typePropertyOptionSetName],
                         formula: newPropertyType.formula,
                         referencedTypeRootSlug: newPropertyType.referencedTypeRootSlug,
                         defaultValue: newPropertyType.defaultValue,
@@ -145,6 +153,26 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
                     },
                 });
             }
+            else if (found && !newPropertyType.inherited && !typePropertiesEqual(found, newPropertyType, optionSetIdByName)) {
+                console.log('Updating Type-Property: ', newPropertyType.slug);
+                await new Entities().update({
+                    entityName: 'type-property',
+                    id: found.id,
+                    object: {
+                        isArchived: newPropertyType.isArchived,
+                        propertyType: newPropertyType.propertyType,
+                        slug: newPropertyType.slug,
+                        label: newPropertyType.label,
+                        editable: newPropertyType.editable,
+                        core: newPropertyType.core,
+                        typePropertyOptionSetId: optionSetIdByName[newPropertyType.typePropertyOptionSetName],
+                        formula: newPropertyType.formula,
+                        referencedTypeRootSlug: newPropertyType.referencedTypeRootSlug,
+                        defaultValue: newPropertyType.defaultValue,
+                        propertyLevel: newPropertyType.propertyLevel,
+                    },
+                });
+            }
         }
         catch (err) {
             console.log('Error Creating Properties: ', err);
@@ -169,3 +197,32 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
         }
     }
 }
+function typePropertiesEqual(typeProperty1, typeProperty2, optionSetIdByName) {
+    const reducedProperty1 = {
+        isArchived: typeProperty1.isArchived,
+        propertyType: typeProperty1.propertyType,
+        slug: typeProperty1.slug,
+        label: typeProperty1.label,
+        editable: typeProperty1.editable,
+        core: typeProperty1.core,
+        typePropertyOptionSetId: optionSetIdByName[typeProperty1.typePropertyOptionSetName],
+        formula: typeProperty1.formula,
+        referencedTypeRootSlug: typeProperty1.referencedTypeRootSlug,
+        defaultValue: typeProperty1.defaultValue,
+        propertyLevel: typeProperty1.propertyLevel,
+    };
+    const reducedProperty2 = {
+        isArchived: typeProperty2.isArchived,
+        propertyType: typeProperty2.propertyType,
+        slug: typeProperty2.slug,
+        label: typeProperty2.label,
+        editable: typeProperty2.editable,
+        core: typeProperty2.core,
+        typePropertyOptionSetId: optionSetIdByName[typeProperty2.typePropertyOptionSetName],
+        formula: typeProperty2.formula,
+        referencedTypeRootSlug: typeProperty2.referencedTypeRootSlug,
+        defaultValue: typeProperty2.defaultValue,
+        propertyLevel: typeProperty2.propertyLevel,
+    };
+    return _.isEqual(reducedProperty1, reducedProperty2);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "1.0.6",
+  "version": "1.0.9",
   "description": "VibeIQ's Contrail Platform CLI.",
   "main": "lib/index.js",
   "bin": {
@@ -24,27 +24,32 @@
   "license": "ISC",
   "dependencies": {
     "@contrail/sdk": "^1.0.91",
+    "@contrail/util": "^1.0.17",
     "amazon-cognito-identity-js": "^5.2.3",
     "arg": "^4.0.1",
     "aws-sdk": "^2.1044.0",
     "chalk": "^4.0.0",
+    "command-line-usage": "^6.1.1",
+    "csvtojson": "^2.0.10",
     "esm": "^3.2.25",
     "execa": "^5.0.0",
     "inquirer": "^8.2.0",
     "js-yaml": "^4.1.0",
     "listr": "^0.14.3",
+    "lodash": "^4.17.21",
     "ncp": "^2.0.0",
     "pkg-install": "^1.0.0"
   },
   "devDependencies": {
     "@types/jest": "^23.3.14",
+    "@types/lodash": "^4.14.178",
+    "@types/node": "^14.6.4",
     "jest": "^23.6.0",
     "prettier": "^1.19.1",
     "ts-jest": "^23.10.5",
     "tslint": "^5.11.0",
     "tslint-config-prettier": "^1.18.0",
-    "typescript": "^3.0.1",
-    "@types/node": "^14.6.4"
+    "typescript": "^3.0.1"
   },
   "jest": {
     "moduleFileExtensions": [

package/src/apps/deploy-app/app-deployer.ts

@@ -9,8 +9,10 @@ export class AppDeployer {
   public async deploy(appDeclaration: AppDeclaration) {
     let app = await this.getExistingApp(appDeclaration);
     if (!app) {
+      console.log(`%s      Creating new app.`, chalk.yellow.bold('APP'));
       app = await this.createNewApp(appDeclaration);
     } else {
+      console.log(`%s      Updating existing app.`, chalk.yellow.bold('APP'));
       app = await this.updateExistingApp(appDeclaration, app);
     }
     await new ActionsDeployer().deployActions(appDeclaration, app);
@@ -39,6 +41,17 @@ export class AppDeployer {
   }
 
   private async createNewApp(appDeclaration: AppDeclaration) {
+
+    let configProperties;
+    if (appDeclaration?.appConfiguration) {
+      configProperties = ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
+    }
+
+    let triggerKeyDefinitions;
+    if (appDeclaration?.triggers) {
+      triggerKeyDefinitions = TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
+    }
+
     const newApp = {
       identifier: appDeclaration.appIdentifier,
       name: appDeclaration.appName,
@@ -48,8 +61,8 @@ export class AppDeployer {
       thumbnail: appDeclaration.thumbnail,
       eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
       keywords: appDeclaration.keywords,
-      configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
-      triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+      configProperties,
+      triggerKeyDefinitions,
     };
     const app = await new Entities().create({ entityName: 'app', object: newApp });
     console.log(`%s      Created new app: ${app.name}`, chalk.yellow.bold('APP'));
@@ -57,6 +70,17 @@ export class AppDeployer {
   }
 
   public async updateExistingApp(appDeclaration: AppDeclaration, existingApp) {
+
+    let configProperties;
+    if (appDeclaration?.appConfiguration) {
+      configProperties = ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration);
+    }
+
+    let triggerKeyDefinitions;
+    if (appDeclaration?.triggers) {
+      triggerKeyDefinitions = TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
+    }
+
     const updates = {
       name: appDeclaration.appName,
       public: appDeclaration.visibility === 'public',
@@ -65,8 +89,8 @@ export class AppDeployer {
       thumbnail: appDeclaration.thumbnail,
       eventWorkflowTriggerKeyMapping: appDeclaration.eventWorkflowTriggerKeyMapping,
       keywords: appDeclaration.keywords,
-      configProperties: ConfigPropertiesParser.getConfigProperties(appDeclaration.appConfiguration),
-      triggerKeyDefinitions: TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration),
+      configProperties,
+      triggerKeyDefinitions,
     };
     const app = await new Entities().update({ entityName: 'app', id: existingApp.id, object: updates });
     console.log(`%s      Updated app: ${app.name}`, chalk.yellow.bold('APP'));

package/src/cli.ts

@@ -3,36 +3,130 @@ import { create } from './apps/create-app/create';
 import { deployApp, removeApp } from './apps/deploy-app/deploy';
 import { getTypes } from './types/types-extractor';
 import { uploadTypes } from './types/types-uploader';
+import { parseOptionSet } from './types/parse-optionSet';
+const cliUsage = require('command-line-usage');
+
 /**
  *  Built using documentation here:
  *  https://www.twilio.com/blog/how-to-build-a-cli-with-node-js
  */
 
 export async function cli(args) {
-  const command = args[2];
-  switch (command) {
-    case 'create-app': {
-      create(args);
-      break;
-    }
-    case 'deploy-app': {
-      deployApp(args);
-      break;
-    }
-    case 'remove-app': {
-      removeApp(args);
+  const fullCommand = args[2];
+  let domain;
+  let command;
+  const commandParts = fullCommand.split('.');
+
+  if (!commandParts?.length) {
+    printIllegalCommand();
+    return;
+  }
+
+  if (commandParts?.length < 2 && commandParts[0].toLowerCase() !== 'help'  && commandParts[0].toLowerCase() !== '-help' && commandParts[0].toLowerCase() !== '--help') {
+    printIllegalCommand();
+    return;
+  }
+
+  domain = commandParts[0];
+  command = commandParts[1];
+
+  switch (domain) {
+    case 'app': {
+      switch (command) {
+        case 'create': {
+          create(args);
+          break;
+        }
+        case 'deploy': {
+          deployApp(args);
+          break;
+        }
+        case 'remove': {
+          removeApp(args);
+          break;
+        }
+        default: {
+          printIllegalCommand();
+        }
+      }
       break;
     }
-    case 'extract-types': {
-      getTypes(args);
+    case 'types': {
+      switch (command) {
+        case 'getAll': {
+          getTypes(args);
+          break;
+        }
+        case 'upload': {
+          uploadTypes(args);
+          break;
+        }
+        case 'parseOptionSet': {
+          parseOptionSet(args);
+          break;
+        }
+        default: {
+          printIllegalCommand();
+        }
+      }
       break;
     }
-    case 'upload-types': {
-      uploadTypes(args);
+    case 'help':
+    case '-help':
+    case '--help': {
+      printHelp();
       break;
     }
     default: {
-      console.log('Illegal command.');
+      printIllegalCommand();
     }
   }
 }
+
+function printHelp() {
+  const sections = [
+    {
+      header: 'VibeIQ CLI',
+      content: 'From your friends at VibeIQ!',
+    },
+    ...helpSections,
+  ];
+
+  const usage = cliUsage(sections);
+  console.log(usage);
+}
+
+function printIllegalCommand() {
+  console.log('Illegal command.');
+
+  const usage = cliUsage(helpSections);
+  console.log(usage);
+}
+
+const helpSections = [
+  {
+    header: 'General Usage',
+    content: [
+      'Commands are run by pairing a domain with a command, joining them using a "."',
+      'e.g. app.create',
+      '',
+      'All <File Path> options should use the file path relative to the folder the command is being run in and include the file ext.',
+    ],
+  },
+  {
+    header: 'App Commands - Domain: app',
+    content: [
+      'create                       Create a new app workspace.',
+      'deploy                       Deploy your app.',
+      'remove                       Remove your app.',
+    ],
+  },
+  {
+    header: 'Type Commands - Domain: types',
+    content: [
+      'getAll                       Get all OptionSets and Types for your Org.',
+      'upload                       Upload OptionSets and Types for your Org.',
+      'parseOptionSet <File Path>   Parse a CSV file into OptionSets.',
+    ],
+  },
+];

package/src/types/interfaces.ts

@@ -14,7 +14,7 @@ export interface ReducedTypeProperties {
   label: string;
   editable: boolean;
   core: boolean;
-  typePropertyOptionSetId: string;
+  typePropertyOptionSetName: string;
   formula: string;
   referencedTypeRootSlug: string;
   defaultValue: string;
@@ -23,7 +23,6 @@ export interface ReducedTypeProperties {
 }
 
 export interface ReducedOptionSet {
-  id: string;
   name: string;
   isArchived: boolean;
   optionSet: any[];

package/src/types/parse-optionSet.ts

@@ -0,0 +1,96 @@
+import { StringUtil } from '@contrail/util';
+import { ReducedOptionSet } from './interfaces';
+import chalk from 'chalk';
+import fs from 'fs';
+import { getSeparatorByPlatform } from '../common';
+import * as csvToJson from 'csvtojson';
+
+const yaml = require('js-yaml');
+
+export async function parseOptionSet(args) {
+  try {
+    if (args?.length < 4) {
+      throw new Error('File name must be included.');
+    }
+    console.log(`%s Parsing`, chalk.yellow.bold('OPTION SETS'));
+    await parseOptionSets(args[3]);
+    console.log(`%s Parsed`, chalk.yellow.bold('OPTION SETS'));
+
+  }
+  catch (e) {
+    console.log(`%s Parsing Failed. ${e}`, chalk.red.bold('FAIL'));
+    return;
+  }
+
+  console.log('%s Parsing Complete.', chalk.green.bold('COMPLETE'));
+}
+
+async function loadDataFromCSV(fileName) {
+  const CURRENT_DIR = process.cwd();
+  try {
+    const separator = getSeparatorByPlatform();
+    const csvData = await csvToJson.default().fromFile(CURRENT_DIR + separator + fileName);
+
+    return csvData;
+  } catch (e) {
+    throw new Error(`ERROR PARSING CSV: ${e}`);
+  }
+}
+
+export async function parseOptionSets(fileName) {
+  const csvData = await loadDataFromCSV(fileName);
+
+  const removedFields = new Set<string>();
+  const valuesByFieldName = {};
+  for (const row of csvData) {
+    for (const [key, value] of Object.entries(row)) {
+
+      // Dont parse boolean fields - later log removed fields
+      if ((value as string).toLowerCase() === 'false' || (value as string).toLowerCase() === 'true') {
+        removedFields.add(key);
+        continue;
+      }
+
+      if (!value) {
+        continue;
+      }
+
+      if (!valuesByFieldName[key]) {
+        valuesByFieldName[key] = new Set<string>();
+      }
+      (valuesByFieldName[key] as Set<string>).add(value as string);
+    }
+  }
+
+  for (const removed of removedFields.values()) {
+    console.log(`Removed Boolean Field: ${removed}`);
+  }
+
+  const reducedOptionSets = [];
+  for (const [key, value] of Object.entries(valuesByFieldName)) {
+    const optionSet = [];
+    for (const entry of (value as Set<string>).values()) {
+      optionSet.push({
+        value: StringUtil.convertToCamelCase(entry),
+        display: isUpperCase(entry) ? entry : StringUtil.convertToTitleCase(entry), // if all uppercase dont convert
+      });
+    }
+
+    const reducedOptionSet: ReducedOptionSet = {
+      name: StringUtil.convertToTitleCase(key),
+      isArchived: false,
+      optionSet,
+    };
+
+    reducedOptionSets.push(reducedOptionSet);
+  }
+
+  const yamlStr = yaml.dump(reducedOptionSets);
+  const CURRENT_DIR = process.cwd();
+  const separator = getSeparatorByPlatform();
+  fs.writeFileSync(CURRENT_DIR + separator + 'parsed_option_sets.yml', yamlStr, 'utf8');
+}
+
+function isUpperCase(str) {
+  return str === str.toUpperCase();
+}

package/src/types/types-extractor.ts

@@ -11,13 +11,18 @@ export async function getTypes(args) {
   try {
     const userConfig = await authUser();
     console.log(`%s Getting all types for orgId: ${userConfig.orgId}`, chalk.blue.bold('START'));
-
     console.log(`%s Retrieving`, chalk.yellow.bold('OPTION SETS'));
-    await getOptionSets();
-    console.log(`%s Retrieved`, chalk.yellow.bold('OPTION SETS'));
 
+    const optionSets = await new Entities().get({
+      entityName: 'type-property-option-set',
+    });
+    await getOptionSets(optionSets);
+
+    console.log(`%s Retrieved`, chalk.yellow.bold('OPTION SETS'));
     console.log(`%s Retrieving`, chalk.yellow.bold('TYPES'));
-    await getReducedTypes();
+
+    await getReducedTypes(optionSets);
+
     console.log(`%s Retrieved`, chalk.yellow.bold('TYPES'));
 
   }
@@ -29,16 +34,11 @@ export async function getTypes(args) {
   console.log('%s Types Retrieval Complete.', chalk.green.bold('COMPLETE'));
 }
 
-async function getOptionSets() {
-  const optionSets = await new Entities().get({
-    entityName: 'type-property-option-set',
-  });
-
+async function getOptionSets(optionSets) {
   let reducedOptionSets = [];
   for (const optionSet of optionSets) {
     const reducedOptionSet: ReducedOptionSet = {
       name: optionSet.name,
-      id: optionSet.id,
       isArchived: optionSet.isArchived,
       optionSet: optionSet.optionSet,
     };
@@ -59,7 +59,7 @@ async function getOptionSets() {
   fs.writeFileSync(CURRENT_DIR + separator + 'option_sets.yml', yamlStr, 'utf8');
 }
 
-async function getReducedTypes() {
+async function getReducedTypes(optionSets) {
   const types = await new Entities().get({
     entityName: 'type',
   });
@@ -74,6 +74,11 @@ async function getReducedTypes() {
       relations: ['typeProperties'],
     });
 
+    const optionSetNameById = {};
+    for (const optionSet of optionSets) {
+      optionSetNameById[optionSet.id] = optionSet.name;
+    }
+
     const reducedTypeProperties = [];
     for (const typeProperty of typeWithProperties.typeProperties) {
       const reducedTypeProperty: ReducedTypeProperties = {
@@ -84,7 +89,7 @@ async function getReducedTypes() {
         label: typeProperty.label,
         editable: typeProperty.editable,
         core: typeProperty.core,
-        typePropertyOptionSetId: typeProperty.typePropertyOptionSetId,
+        typePropertyOptionSetName: optionSetNameById[typeProperty.typePropertyOptionSetId],
         formula: typeProperty.formula,
         referencedTypeRootSlug: typeProperty.referencedTypeRootSlug,
         defaultValue: typeProperty.defaultValue,

package/src/types/types-uploader.ts

@@ -5,6 +5,7 @@ import chalk from 'chalk';
 import fs from 'fs';
 import { authUser } from '../auth/login';
 import { getSeparatorByPlatform } from '../common';
+import * as _ from 'lodash';
 
 const yaml = require('js-yaml');
 
@@ -141,6 +142,15 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
     newPropertyTypesBySlug[newPropertyType.slug] = newPropertyType;
   }
 
+  const optionSets = await new Entities().get({
+    entityName: 'type-property-option-set',
+  });
+
+  const optionSetIdByName = {};
+  for (const optionSet of optionSets) {
+    optionSetIdByName[optionSet.name] = optionSet.id;
+  }
+
   for (const newPropertyType of newPropertyTypes) {
     try {
       const found = currentPropertyTypeBySlug[newPropertyType.slug];
@@ -158,7 +168,7 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
             label: newPropertyType.label,
             editable: newPropertyType.editable,
             core: newPropertyType.core,
-            typePropertyOptionSetId: newPropertyType.typePropertyOptionSetId,
+            typePropertyOptionSetId: optionSetIdByName[newPropertyType.typePropertyOptionSetName],
             formula: newPropertyType.formula,
             referencedTypeRootSlug: newPropertyType.referencedTypeRootSlug,
             defaultValue: newPropertyType.defaultValue,
@@ -170,6 +180,26 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
           },
       });
       }
+      else if (found && !newPropertyType.inherited && !typePropertiesEqual(found, newPropertyType, optionSetIdByName)) {
+        console.log('Updating Type-Property: ', newPropertyType.slug);
+        await new Entities().update({
+          entityName: 'type-property',
+          id: found.id,
+          object: {
+            isArchived: newPropertyType.isArchived,
+            propertyType: newPropertyType.propertyType,
+            slug: newPropertyType.slug,
+            label: newPropertyType.label,
+            editable: newPropertyType.editable,
+            core: newPropertyType.core,
+            typePropertyOptionSetId: optionSetIdByName[newPropertyType.typePropertyOptionSetName],
+            formula: newPropertyType.formula,
+            referencedTypeRootSlug: newPropertyType.referencedTypeRootSlug,
+            defaultValue: newPropertyType.defaultValue,
+            propertyLevel: newPropertyType.propertyLevel,
+          },
+        });
+      }
 
     } catch (err) {
       console.log('Error Creating Properties: ', err);
@@ -195,4 +225,37 @@ async function uploadReducedTypeProperties(type, currentPropertyTypes, newProper
       throw new Error(`Error Deleting Properties: ${err}`);
     }
   }
+}
+
+function typePropertiesEqual(typeProperty1, typeProperty2, optionSetIdByName): boolean {
+
+  const reducedProperty1 = {
+    isArchived: typeProperty1.isArchived,
+    propertyType: typeProperty1.propertyType,
+    slug: typeProperty1.slug,
+    label: typeProperty1.label,
+    editable: typeProperty1.editable,
+    core: typeProperty1.core,
+    typePropertyOptionSetId: optionSetIdByName[typeProperty1.typePropertyOptionSetName],
+    formula: typeProperty1.formula,
+    referencedTypeRootSlug: typeProperty1.referencedTypeRootSlug,
+    defaultValue: typeProperty1.defaultValue,
+    propertyLevel: typeProperty1.propertyLevel,
+  };
+
+  const reducedProperty2 = {
+    isArchived: typeProperty2.isArchived,
+    propertyType: typeProperty2.propertyType,
+    slug: typeProperty2.slug,
+    label: typeProperty2.label,
+    editable: typeProperty2.editable,
+    core: typeProperty2.core,
+    typePropertyOptionSetId: optionSetIdByName[typeProperty2.typePropertyOptionSetName],
+    formula: typeProperty2.formula,
+    referencedTypeRootSlug: typeProperty2.referencedTypeRootSlug,
+    defaultValue: typeProperty2.defaultValue,
+    propertyLevel: typeProperty2.propertyLevel,
+  };
+
+  return _.isEqual(reducedProperty1, reducedProperty2);
 }