zcatalyst-cli 1.9.0 → 1.9.1

package/README.md

@@ -70,36 +70,36 @@ Certain command are project specific and for it to work you must be inside a pro
 
 Command | Description
 ------- | -----------
-**login** | Authenticate your CLI to access Catalyst Details. *Requires access to a web browser*.
-**whoami** | Prints the current logged in user email Id.
-**token:generate** | Create a CLI token in order to use in CI systems.
-**token:revoke** | Revoke the token created from this CLI.
-**token:list** | List all the available tokens created from this CLI.
-**project:list** | List the Catalyst projects you have access to.
+**login** | Log the CLI in to your Catalyst account. *Requires access to a web browser*.
+**whoami** | Print the email address of the user currently logged in.
+**token:generate** | Generate a token to authenticate accessing the CLI from a remote system.
+**token:revoke** | Revoke a token generated in this CLI.
+**token:list** | List all the available tokens generated in this CLI.
+**project:list** | List all the Catalyst projects you have access to.
 **project:use** | Set an active Catalyst project for your working directory.
-**project:reset** | Clear an active selection of project and reset to base project.
-**init** | Initialize a Catalyst sample project in the current directory.
-**pull** | Pull an existing project from Catalyst.
-**apig:status** | Displays the status of Catalyst API Gateway and schedule progress.
-**apig:enable** | Enables API Gateway if not already enabled. *in both Console and Local*
-**apig:disable** | Disable API Gateway if not already disabled. *in both Console and Local*
-**ds:import** | Write bulk data to table in Catalyst datastore.
-**ds:export** | Read bulk data from table in Catalyst datastore.
-**ds:status** | Displays the status of Catalyst datastore bulk schedule progress.
-**client:setup** | Setup and configure Client files.
-**client:delete** | Removes the selected version of Client.
-**functions:setup** | Setup and configure function files for Catalyst functions.
-**functions:delete** | Removes the selected functions.
-**functions:add** | Add single function of desirable stack to catalyst functions.
-**functions:shell** | Launch a node shell with emulated functions for any stack pointing to production or local.
-**functions:config** | Configure the resources for the functions deployed to the Catalyst remote console.
-**event:generate \| generate:event** | Generate sample payloads from different event sources of Catalyst
-**event:generate:integ** | Generate sample payload for testing your integration functions in local.
-**serve** | Serve your code for local testing without affecting the production.
-**deploy** | Deploy your code from working directory to your Catalyst Project.
-**help** | Display help information.
-**run-script \| run** | Run a particular command script.
-**logout** |  Log the CLI out of your Zoho Catalyst account.
+**project:reset** | Clear an active project selection and reset to the base project.
+**init** | Initialize a Catalyst project, function, and client resources in the local directory.
+**pull** | Pull resources of your project from the remote console to the local directory.
+**apig:status** | Obtain the current status of API Gateway for your project and the schedule progress.
+**apig:enable** | Enable API Gateway for your project. *In both Console and Local*.
+**apig:disable** | Disable API Gateway for your project. *In both Console and Local*.
+**ds:import** | Bulk write records to a table in the Catalyst Data Store.
+**ds:export** | Bulk read records from a table in the Catalyst Data Store.
+**ds:status** | Display the job status of a Data Store import or export operation.
+**client:setup** | Set up the client directory in your project directory.
+**client:delete** | Delete a version of the client from the remote console or the local directory.
+**functions:setup** | Set up the function directory in your project directory.
+**functions:add** | Add a function of the required stack to the function directory.
+**functions:shell** | Launch a node shell to test emulated functions of any stack or type, other than Advanced I/O functions.
+**functions:config** | Configure the memory allocation of a function in your project.
+**functions:delete** | Delete a function from the remote console or the local directory.
+**event:generate \| generate:event** | Generate sample payloads from different components or custom event sources to test Event functions.
+**event:generate:integ** | Generate sample payloads for the required integration service to test Integration functions.
+**serve** | Serve Basic I/O and Advanced I/O functions, and the client, to test them locally.
+**deploy** | Deploy the Catalyst project and project resources to the remote console from the local directory.
+**help** | Display the command reference or help for a specific command.
+**run-script \| run** | Run a particular command script defined in *catalyst.json*.
+**logout** |  Log the CLI out of your Catalyst account.
 
 ---
 

package/lib/commands/apig/disable.js

@@ -20,7 +20,7 @@ const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('apig:disable')
-    .description('disable api gateway if not already disabled')
+    .description('Disable API Gateway for your project')
     .needs('auth', [constants_1.SCOPE.projects])
     .needs('config')
     .needs('rc')

package/lib/commands/apig/enable.js

@@ -20,7 +20,7 @@ const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('apig:enable')
-    .description('enables api gateway if not already enabled')
+    .description('Enable API Gateway for your project')
     .needs('auth', [constants_1.SCOPE.projects])
     .needs('config')
     .needs('rc')

package/lib/commands/apig/status.js

@@ -22,7 +22,7 @@ const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 const option_1 = require("../../util_modules/option");
 exports.default = new command_1.default('apig:status')
-    .description('Displays the status of catalyst api gateway and schedule progress')
+    .description('Obtain the current status of API Gateway for your project and the schedule progress')
     .option('--previous', 'show previous schedule status instead of current one')
     .needs('auth', [constants_1.SCOPE.projects])
     .needs('config')

package/lib/commands/client/delete.js

@@ -28,7 +28,7 @@ const logger_1 = require("../../util_modules/logger");
 const option_1 = require("../../util_modules/option");
 const project_1 = require("../../util_modules/project");
 exports.default = new command_1.default('client:delete [client_version]')
-    .description('Removes the selected version of client')
+    .description('Delete a version of the client from the remote console or the local directory')
     .option('--local', 'removes the client from local machine')
     .option('--remote', 'removes the selected client from remote console')
     .needs('auth', [constants_1.SCOPE.webapp])

package/lib/commands/client/setup.js

@@ -37,7 +37,7 @@ const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('client:setup')
-    .description('Setup and configure Client files')
+    .description('Set up the client directory in your project directory')
     .needs('auth', [constants_1.SCOPE.webapp])
     .needs('config')
     .needs('rc')

package/lib/commands/deploy.js

@@ -36,7 +36,7 @@ const runtime_store_1 = __importDefault(require("../runtime-store"));
 const constants_1 = require("../util_modules/constants");
 const logger_1 = require("../util_modules/logger");
 exports.default = new command_1.default('deploy')
-    .description('Deploy your code from working directory to your Catalyst Project')
+    .description('Deploy the Catalyst project and project resources to the remote console from the local directory')
     .option('--only <targets>', 'only deploy specified, comma-separated targets (e.g. "functions,client").' +
     ' For Functions you can specify which functions to deploy with colon notation' +
     ' (e.g. "--only functions:<function_name>,functions:<function_name>"). ')

package/lib/commands/ds/export.js

@@ -35,7 +35,7 @@ const getReadConfigFromPath = (pth) => __awaiter(void 0, void 0, void 0, functio
     return configJSON;
 });
 exports.default = new command_1.default('ds:export [table]')
-    .description('Read bulk data from table in catalyst datastore')
+    .description('Bulk read records from a table in the Catalyst Data Store')
     .option('--table <name|id>', 'Name or ID of the table from which data is to be read (eg. "UserDetails")')
     .option('--config <path>', 'Path of the configuration json file to be used for export.')
     .option('--page <page>', 'Number which denotes the range of rows to be fetched (eg. "1")')

package/lib/commands/ds/import.js

@@ -36,7 +36,7 @@ const getWriteConfigFromPath = (pth) => __awaiter(void 0, void 0, void 0, functi
     return configJSON;
 });
 exports.default = new command_1.default('ds:import [file]')
-    .description('Write bulk data to table in catalyst datastore')
+    .description('Bulk write records to a table in the Catalyst Data Store')
     .option('--table <name|id>', 'Name or ID of the table to which data to be written (e.g. "UserDetails")')
     .option('--config <path>', 'Path of the configuration json file to be used for import.')
     .option('--production', 'flag for pointing to production environment')

package/lib/commands/ds/status.js

@@ -25,7 +25,7 @@ const fs_1 = require("../../util_modules/fs");
 const logger_1 = require("../../util_modules/logger");
 const option_1 = require("../../util_modules/option");
 exports.default = new command_1.default('ds:status <operation> [jobid]')
-    .description('Displays the status of catalyst datastore bulk schedule progress')
+    .description('Display the job status of a Data Store import or export operation')
     .option('--production', 'flag for pointing to production environment.')
     .needs('auth', [constants_1.SCOPE.projects, constants_1.SCOPE.datastore, constants_1.SCOPE.row])
     .needs('config')

package/lib/commands/event/generate/index.js

@@ -42,7 +42,7 @@ const option_1 = require("../../../util_modules/option");
 const project_1 = require("../../../util_modules/project");
 exports.default = new command_1.default('event:generate <source> <action>')
     .alias('generate:event')
-    .description('Generate sample payloads from different event sources of catalyst')
+    .description('Generate sample payloads from different components or custom event sources to test Event functions')
     .option('-rid, --rule-id <rule_identifier>', 'rule_identifier that will be used if the source is custom')
     .option('-e, --event-bus <event_bus_name>', 'event bus name that should be used')
     .allowUnknownOpts()

package/lib/commands/event/generate/integ.js

@@ -37,7 +37,7 @@ const command_1 = __importDefault(require("../../../internal/command"));
 const constants_1 = require("../../../util_modules/constants");
 const option_1 = require("../../../util_modules/option");
 exports.default = new command_1.default('event:generate:integ <service>')
-    .description('Generate sample payload for testing your integration functions in local')
+    .description('Generate sample payloads for the required integration service to test Integration functions')
     .option('--inputs <inputs>', 'inputs to generate the integ event provided as comma seperated values')
     .needs('rc')
     .needs('auth')

package/lib/commands/functions/add.js

@@ -37,7 +37,7 @@ const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('functions:add')
-    .description('Add single function of desirable stack to catalyst functions')
+    .description('Add a function of the required stack to the function directory')
     .needs('auth', [constants_1.SCOPE.functions])
     .needs('config')
     .needs('rc')

package/lib/commands/functions/config.js

@@ -20,7 +20,7 @@ const ansi_colors_1 = require("ansi-colors");
 const prompt_1 = __importDefault(require("../../prompt"));
 const common_1 = require("../../fn-utils/lib/common");
 exports.default = new command_1.default('functions:config [function_name_or_id]')
-    .description('Configure the resources for the functions deployed to the Catalyst remote console')
+    .description('Configure the memory allocation of a function in your project')
     .option('--memory <value>', 'use this option to configure the memory for the function. ex: --memory 128')
     .needs('auth', [constants_1.SCOPE.functions])
     .needs('config')

package/lib/commands/functions/delete.js

@@ -26,7 +26,7 @@ const logger_1 = require("../../util_modules/logger");
 const option_1 = require("../../util_modules/option");
 const project_1 = require("../../util_modules/project");
 exports.default = new command_1.default('functions:delete [function_name_or_id]')
-    .description('Removes the selected functions')
+    .description('Delete a function from the remote console or the local directory')
     .option('--local', 'delete the functions in local machine.')
     .option('--remote', 'delete the functions in remote console.')
     .needs('auth', [constants_1.SCOPE.projects])

package/lib/commands/functions/setup.js

@@ -37,7 +37,7 @@ const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('functions:setup')
-    .description('Setup and configure Function files for Catalyst functions')
+    .description('Set up the function directory in your project directory')
     .needs('auth', [constants_1.SCOPE.functions])
     .needs('config')
     .needs('rc')

package/lib/commands/functions/shell.js

@@ -36,7 +36,7 @@ const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const constants_1 = require("../../util_modules/constants");
 const option_1 = require("../../util_modules/option");
 exports.default = new command_1.default('functions:shell')
-    .description('Launch a node shell with emulated functions for any stack pointing to production or local')
+    .description('Launch a node shell to test emulated functions of any stack or type, other than Advanced I/O functions')
     .option('--http [port]', 'enables http mode for the basicIO functions and start server at specified port' +
     `(default: ${constants_1.DEFAULT.serve_port.http.basicio})`)
     .option('--debug [port]', 'the functions are invoked from local environment enabling debugging options on provided port.' +

package/lib/commands/help.js

@@ -11,7 +11,7 @@ const logger_1 = require("../util_modules/logger");
 const option_1 = require("../util_modules/option");
 const project_1 = require("../util_modules/project");
 exports.default = new command_1.default('help [command]')
-    .description('Display help information')
+    .description('Display the command reference or help for a specific command')
     .action(function help(commandName) {
     var _a, _b, _c;
     if (option_1.getOptionValue('info', false)) {

package/lib/commands/init.js

@@ -42,7 +42,7 @@ const js_1 = require("../util_modules/js");
 const logger_1 = require("../util_modules/logger");
 const shell_1 = require("../util_modules/shell");
 exports.default = new command_1.default('init [feature]')
-    .description('Initialize a Catalyst sample project in the current directory')
+    .description('Initialize a Catalyst project, function, and client resources in the local directory')
     .option('--force', 'force initialise a project for this directory')
     .ignore(['project'])
     .needs('auth', [constants_1.SCOPE.projects, constants_1.SCOPE.stratus_create, constants_1.SCOPE.stratus_read])

package/lib/commands/login.js

@@ -33,7 +33,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = __importDefault(require("../internal/command"));
 exports.default = new command_1.default('login')
-    .description('Log the CLI in to your Zoho Catalyst account')
+    .description('Log the CLI in to your Catalyst account')
     .option('--no-localhost', 'login without browser')
     .option('--force', 'force reauthentication')
     .action(() => __awaiter(void 0, void 0, void 0, function* () {

package/lib/commands/logout.js

@@ -33,7 +33,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = __importDefault(require("../internal/command"));
 exports.default = new command_1.default('logout')
-    .description('Log the CLI out of your Zoho Catalyst account')
+    .description('Log the CLI out of your Catalyst account')
     .action(() => __awaiter(void 0, void 0, void 0, function* () {
     const auth = yield Promise.resolve().then(() => __importStar(require('../authentication')));
     return auth.logout();

package/lib/commands/project/list.js

@@ -38,7 +38,7 @@ const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 const project_1 = require("../../util_modules/project");
 exports.default = new command_1.default('project:list')
-    .description('List the Catalyst projects you have access to')
+    .description('List all the Catalyst projects you have access to')
     .needs('auth', [constants_1.SCOPE.projects])
     .needs('config', { optional: true, resolveOnNotFound: true })
     .needs('rc', { optional: true })

package/lib/commands/project/reset.js

@@ -17,7 +17,7 @@ const constants_1 = require("../../util_modules/constants");
 const logger_1 = require("../../util_modules/logger");
 const project_1 = require("../../util_modules/project");
 exports.default = new command_1.default('project:reset')
-    .description('Clear an active selection of project and reset to base project')
+    .description('Clear an active project selection and reset to the base project')
     .needs('auth', [constants_1.SCOPE.projects])
     .needs('config', { optional: true, resolveOnNotFound: true })
     .needs('rc')

package/lib/commands/pull.js

@@ -42,7 +42,7 @@ const fs_1 = require("../util_modules/fs");
 const js_1 = require("../util_modules/js");
 const logger_1 = require("../util_modules/logger");
 exports.default = new command_1.default('pull [feature]')
-    .description('Pull an existing project from Catalyst')
+    .description('Pull resources of your project from the remote console to the local directory')
     .needs('auth', [constants_1.SCOPE.functions, constants_1.SCOPE.webapp])
     .needs('config', { optional: true })
     .needs('rc')

package/lib/commands/run.js

@@ -38,7 +38,7 @@ const constants_1 = require("../util_modules/constants");
 const logger_1 = require("../util_modules/logger");
 exports.default = new command_1.default('run-script [command]')
     .alias('run')
-    .description('run a particular command script')
+    .description('Run a particular command script defined in catalyst.json')
     .needs('auth')
     .needs('config')
     .needs('rc', { optional: true, resolveOnNotFound: true })

package/lib/commands/serve.js

@@ -34,7 +34,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = __importDefault(require("../internal/command"));
 const constants_1 = require("../util_modules/constants");
 exports.default = new command_1.default('serve')
-    .description('Serve your code for local testing without affecting the production')
+    .description('Serve Basic I/O and Advanced I/O functions, and the client, to test them locally')
     .option('--http <port>', 'start the server at specified port ')
     .option('--debug <type:port>', 'the functions are invoked from local environment enabling debugging options on provided ports ' +
     `(example: advancedio:<name>:${constants_1.DEFAULT.serve_port.debug.advancedio},basicio:${constants_1.DEFAULT.serve_port.debug.basicio})`)

package/lib/commands/token/generate.js

@@ -34,7 +34,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = __importDefault(require("../../internal/command"));
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('token:generate')
-    .description('Create a CLI token in order to use in CI systems')
+    .description('Generate a token to authenticate accessing the CLI from a remote system')
     .option('--current', 'prints out the existing token used by this CLI')
     .needs('auth')
     .ignore(['token'])

package/lib/commands/token/list.js

@@ -35,7 +35,7 @@ const ansi_colors_1 = require("ansi-colors");
 const command_1 = __importDefault(require("../../internal/command"));
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('token:list')
-    .description('List all the available tokens created from this cli')
+    .description('List all the available tokens generated in this CLI')
     .ignore(['token'])
     .needs('auth')
     .action(() => __awaiter(void 0, void 0, void 0, function* () {

package/lib/commands/token/revoke.js

@@ -34,7 +34,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const command_1 = __importDefault(require("../../internal/command"));
 const logger_1 = require("../../util_modules/logger");
 exports.default = new command_1.default('token:revoke <id>')
-    .description('Revoke the token created from this CLI')
+    .description('Revoke a token generated in this CLI')
     .needs('auth')
     .ignore(['token'])
     .action((input) => __awaiter(void 0, void 0, void 0, function* () {

package/lib/commands/whoami.js

@@ -18,7 +18,7 @@ const dc_1 = require("../dc");
 const command_1 = __importDefault(require("../internal/command"));
 const logger_1 = require("../util_modules/logger");
 exports.default = new command_1.default('whoami')
-    .description('prints out the current logged in user email id')
+    .description('Print the email address of the user currently logged in')
     .action(() => __awaiter(void 0, void 0, void 0, function* () {
     const activeDC = dc_1.getActiveDC();
     const user = config_store_1.default.get(`${activeDC}.user`);

package/lib/index.js

@@ -12,11 +12,11 @@ const packageJson = runtime_store_1.default.get('context.cli.package');
 const { description, version } = packageJson;
 const program = new commander_1.Command();
 program.description(description);
-program.version(version, '-v, --version');
-program.option('-p, --project <name|project_id>', 'the catalyst project to use for this command');
-program.option('--token <token>', 'supply an auth token for this command');
-program.option('--dc <us|eu|in>', 'supply a DC to use for this command');
-program.option('--verbose', 'changes the log level to verbose for debug purpose');
+program.version(version, '-v, --version', 'Print the Catalyst CLI version number');
+program.option('-p, --project <name|project_id>', 'Specify the Catalyst project to be used for a command');
+program.option('--token <token>', 'Supply an authentication token for a command');
+program.option('--dc <us|eu|in>', 'Supply a data center for a command');
+program.option('--verbose', 'Change the log level to verbose for debugging purposes');
 const cli = new client_1.Client(program);
 cli.onUnknownCommand((_OPTS, cmd) => {
     const commandNames = cli.getAllCommandNames();

package/lib/serve/server/index.js

@@ -39,25 +39,26 @@ class Server {
     constructor() {
         this.targetDetailsArr = [];
     }
-    _spinUpMaster(masterPort, fnTargets) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const httpPort = parseInt(runtime_store_1.default.get('context.port.http.' + constants_1.REMOTE_REF.functions.type[constants_1.FN_TYPE.basic]), 10);
-            const debugPort = parseInt(runtime_store_1.default.get('context.port.debug.' + constants_1.REMOTE_REF.functions.type[constants_1.FN_TYPE.basic], '-1'), 10);
-            if (!isNaN(httpPort)) {
-                fnTargets
-                    .filter((t) => t.url !== undefined && t.type === constants_1.FN_TYPE.basic)
-                    .map((t) => js_1.JS.omit(t, ['zip_stream', 'localFn']))
-                    .forEach((t) => {
-                    this.targetDetailsArr.push({
-                        type: 'functions',
-                        httpPort,
-                        debugPort,
-                        target: t
-                    });
+    _addBasicFnDetails() {
+        const fnTargets = runtime_store_1.default.get('context.functions.targets', []);
+        if (fnTargets.length === 0) {
+            logger_1.debug('No basic functions to add');
+        }
+        const httpPort = parseInt(runtime_store_1.default.get('context.port.http.' + constants_1.REMOTE_REF.functions.type[constants_1.FN_TYPE.basic]), 10);
+        const debugPort = parseInt(runtime_store_1.default.get('context.port.debug.' + constants_1.REMOTE_REF.functions.type[constants_1.FN_TYPE.basic], '-1'), 10);
+        if (!isNaN(httpPort)) {
+            fnTargets
+                .filter((t) => t.url !== undefined && t.type === constants_1.FN_TYPE.basic)
+                .map((t) => js_1.JS.omit(t, ['zip_stream', 'localFn']))
+                .forEach((t) => {
+                this.targetDetailsArr.push({
+                    type: 'functions',
+                    httpPort,
+                    debugPort,
+                    target: t
                 });
-            }
-            return master_1.default(masterPort, this.targetDetailsArr);
-        });
+            });
+        }
     }
     _spinUpJavaServer(details, masterPort) {
         var _a, _b, _c, _d;
@@ -185,13 +186,13 @@ class Server {
                 throw new error_1.default('master port cannot be undefined', { exit: 2 });
             }
             yield Promise.all(this.targetDetailsArr.map((details) => __awaiter(this, void 0, void 0, function* () { return this.startServer(details, masterPort); })));
-            const fnTargets = runtime_store_1.default.get('context.functions.targets', []);
-            if (fnTargets.length === 0) {
+            this._addBasicFnDetails();
+            if (this.targetDetailsArr.length === 0) {
                 throw new error_1.default('Trying to start master server before other server', {
                     exit: 2
                 });
             }
-            const server = yield this._spinUpMaster(masterPort, fnTargets);
+            const server = yield master_1.default(masterPort, this.targetDetailsArr);
             this.masterServer = server;
             return new Promise((res) => {
                 server.on('listening', () => {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "zcatalyst-cli",
-	"version": "1.9.0",
+	"version": "1.9.1",
 	"description": "Command Line Tool for CATALYST",
 	"main": "./lib/index.js",
 	"bin": {