@contrail/cli 2.0.3 → 2.0.4

package/dist/helpers/file-helpers.d.ts

@@ -0,0 +1 @@
+export declare function safeFileOverwrite(fileLocation: string, overwrite: boolean): Promise<boolean>;

package/dist/helpers/file-helpers.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeFileOverwrite = void 0;
+const tslib_1 = require("tslib");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const PASS_FORCE_TO_OVERWRITE = 'Pass --force to overwrite without prompting';
+//throws an error if the user declines to overwrite the file
+async function safeFileOverwrite(fileLocation, overwrite) {
+    if (overwrite) {
+        console.log(`overwriting ${fileLocation}`);
+        return true;
+    }
+    const answers = await inquirer_1.default.prompt([{
+            type: 'confirm',
+            name: 'shouldOverwrite',
+            message: `The file ${fileLocation} already exists. Do you wish to overwrite it?\n${PASS_FORCE_TO_OVERWRITE}`,
+            default: false
+        }]);
+    if (!answers.shouldOverwrite) {
+        throw new Error('File was not overwritten. Cancelling process...');
+    }
+}
+exports.safeFileOverwrite = safeFileOverwrite;

package/dist/helpers/types/type-uploader.d.ts

@@ -1 +1 @@
-export declare function uploadTypes(): Promise<void>;
+export declare function uploadTypes(dir: string): Promise<void>;

package/dist/helpers/types/type-uploader.js

@@ -9,12 +9,12 @@ const path = tslib_1.__importStar(require("path"));
 const _ = tslib_1.__importStar(require("lodash"));
 const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
 const login_1 = require("../../auth/login");
-async function uploadTypes() {
+async function uploadTypes(dir) {
     try {
         const userConfig = await (0, login_1.authUser)();
         console.log(`%s Getting all types for orgId: ${userConfig.orgId}`, chalk_1.default.blue.bold('START'));
         console.log('%s Uploading', chalk_1.default.yellow.bold('TYPES'));
-        await uploadReducedTypes();
+        await uploadReducedTypes(dir);
         console.log('%s Uploaded', chalk_1.default.yellow.bold('TYPES'));
     }
     catch (e) {
@@ -24,13 +24,13 @@ async function uploadTypes() {
     console.log('%s Types Upload Complete.', chalk_1.default.green.bold('COMPLETE'));
 }
 exports.uploadTypes = uploadTypes;
-function loadReducedTypes() {
-    const TARGET_DIR = process.cwd();
+function loadReducedTypes(fromDir) {
     try {
-        const files = fs_1.default.readdirSync(path.join(TARGET_DIR, 'types'));
+        const dir = path.resolve(path.join(fromDir, 'types'));
+        const files = fs_1.default.readdirSync(dir);
         const types = [];
         for (const file of files) {
-            types.push(...js_yaml_1.default.load(fs_1.default.readFileSync(path.join(TARGET_DIR, 'types', file), 'utf8')));
+            types.push(...js_yaml_1.default.load(fs_1.default.readFileSync(path.join(dir, file), 'utf8')));
         }
         return types;
     }
@@ -38,8 +38,8 @@ function loadReducedTypes() {
         throw new Error(`ERROR PARSING YAML: ${e}`);
     }
 }
-async function uploadReducedTypes() {
-    const types = loadReducedTypes();
+async function uploadReducedTypes(dir) {
+    const types = loadReducedTypes(dir);
     const currentTypesWithoutProperties = await new sdk_1.Entities().get({
         entityName: 'type',
     });

package/dist/templates/typescript/src/actions/logItem.ts

@@ -1,21 +1,16 @@
-import { login, Entities, setAppCredentials } from "@contrail/sdk";
+import { Entities } from "@contrail/sdk";
 import { AppActionCallBack, AppActionCallbackStatus } from "../framework";
 import { Logger } from "../framework/logger";
 
 export async function execute(event, config: any, logger: Logger): Promise<AppActionCallBack> {
   logger.log('Starting Example Action');
-
-
-  logger.log('Loggin in');
-  // Fetch items from the SDK
-  await setAppCredentials(config.apiKey, config.orgSlug);
   logger.log('Getting item from SDK');
 
   const item = await new Entities().get({
     entityName: 'item',
     id: event.id,
-  })
-  logger.log('Got item: ', item);  
+  });
+  logger.log('Got item: ', item);
 
   return {
     output: {

package/dist/templates/typescript/src/framework/app-config.ts

@@ -1,19 +1,16 @@
-/** 
+/**
  * WARNING:  Do not modify this file, it is part of the generic runtime handling logic
  * for VibeIQ app actions.
  */
 
-
 import fs from 'fs';
 const yaml = require('js-yaml');
 
 export function loadAppConfig(){
   const TARGET_DIR = process.cwd();
-  console.log("TARGET_DIR: ", TARGET_DIR)
   try {
     const separator = getSeparatorByPlatform();
     const doc = yaml.load(fs.readFileSync(TARGET_DIR + separator + 'app.yml', 'utf8'));
-    console.log(doc);
     return doc;
   } catch (e) {
     throw new Error(`ERROR PARSING YAML: ${e}`);

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.0.3",
+  "version": "2.0.4",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -287,6 +287,59 @@
       },
       "args": {}
     },
+    "instance:export": {
+      "id": "instance:export",
+      "description": "Exports an data of an instance including types and users",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail instance export\n"
+      ],
+      "flags": {
+        "outDir": {
+          "name": "outDir",
+          "type": "option",
+          "description": "The directory to which to export the instance data. Defaults to the current directory",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "description": "Replaces any existing export files in outDir",
+          "required": false,
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "instance:import": {
+      "id": "instance:import",
+      "description": "Import the data to an instance, including types and users",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "$ contrail instance import\n"
+      ],
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "description": "The directory from which to export the instance data. Defaults to the current directory",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
+      "args": {}
+    },
     "loader-process:load": {
       "id": "loader-process:load",
       "description": "Upload a csv file and kick off a load job for the uploaded file. The config path must be a reference to a .json or a .yml file.",
@@ -411,21 +464,47 @@
       "examples": [
         "$ contrail types getAll\n"
       ],
-      "flags": {},
+      "flags": {
+        "outDir": {
+          "name": "outDir",
+          "type": "option",
+          "description": "The directory to which to export the type data. Defaults to the current directory",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "description": "Replaces any existing export files in outDir",
+          "required": false,
+          "allowNo": false
+        }
+      },
       "args": {}
     },
     "types:loadAll": {
       "id": "types:loadAll",
-      "description": "Get all Types and associated data for your Org",
+      "description": "loads all the type data that has been exported by getAll",
       "strict": true,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
       "pluginType": "core",
       "aliases": [],
       "examples": [
-        "$ contrail types getAll\n"
+        "$ contrail types loadAll\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to load the types data. Defaults to the current directory.",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:mergeOptionSets": {
@@ -636,7 +715,7 @@
     },
     "types:uploadOptionSetHierarchies": {
       "id": "types:uploadOptionSetHierarchies",
-      "description": "Upload OptionSets for your Org. OptionSets are loaded from .yml files in the option-sets directory.",
+      "description": "Upload Option Set Hierarchies for your Org. Option set hierarchies are loaded from .yml files in the option-set-hierarchies directory.",
       "strict": true,
       "pluginName": "@contrail/cli",
       "pluginAlias": "@contrail/cli",
@@ -645,7 +724,17 @@
       "examples": [
         "$ contrail types uploadOptionSetHierarchies\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the option set hierarchies data. Defaults to the current directory. The option set data will be loaded from $dir/option-set-hierarchies",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadOptionSets": {
@@ -659,7 +748,17 @@
       "examples": [
         "$ contrail types uploadOptionSets\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the option set data. Defaults to the current directory. The option set data will be loaded from $dir/option-sets",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadOptionSetsHierarchyLocalFile": {
@@ -698,7 +797,17 @@
       "examples": [
         "$ contrail types uploadRuleSets\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the rule set data. Defaults to the current directory. The rule set data will be loaded from $dir/rule-sets/*.yml",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadTypePropertyPolicies": {
@@ -712,7 +821,17 @@
       "examples": [
         "$ contrail types uploadTypePropertyPolicies\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the type property policy data. Defaults to the current directory. The type property policy data will be loaded from $dir/type-property-policies/*.yml",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "types:uploadUsageInfo": {
@@ -726,7 +845,17 @@
       "examples": [
         "$ contrail types uploadUsageInfo\n"
       ],
-      "flags": {},
+      "flags": {
+        "dir": {
+          "name": "dir",
+          "type": "option",
+          "char": "d",
+          "description": "The directory from which to export the usage info data. Defaults to the current directory. The option set data will be loaded from $dir/usage-info.yml",
+          "required": false,
+          "multiple": false,
+          "default": "."
+        }
+      },
       "args": {}
     },
     "users:export": {
@@ -748,6 +877,13 @@
           "description": "The location for the file to be saved",
           "required": false,
           "multiple": false
+        },
+        "overwrite": {
+          "name": "overwrite",
+          "type": "boolean",
+          "description": "Replaces existing files if they exist",
+          "required": false,
+          "allowNo": false
         }
       },
       "args": {}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",
@@ -26,6 +26,7 @@
     "@contrail/types": "^3.0.20",
     "@contrail/util": "^1.0.17",
     "@oclif/core": "^2",
+    "@oclif/plugin-autocomplete": "^2.1.4",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^2.3.2",
     "@typescript-eslint/eslint-plugin": "^5.54.1",
@@ -64,12 +65,13 @@
     "typescript": "^4.9.5"
   },
   "oclif": {
-    "bin": "contrail-cli",
+    "bin": "contrail",
     "dirname": "contrail-cli",
     "commands": "./dist/commands",
     "plugins": [
       "@oclif/plugin-help",
-      "@oclif/plugin-plugins"
+      "@oclif/plugin-plugins",
+      "@oclif/plugin-autocomplete"
     ],
     "topicSeparator": " ",
     "topics": {
@@ -96,6 +98,9 @@
       },
       "workflow-templates": {
         "description": "Manage workflow templates"
+      },
+      "instance": {
+        "description": "Manage instance (org) configuration data"
       }
     }
   },