zcatalyst-cli 1.21.0 → 1.22.0

package/lib/iac/status/deploy.js

@@ -15,23 +15,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const iac_1 = __importDefault(require("../../endpoints/lib/iac"));
 const api_timer_1 = __importDefault(require("../../api-timer"));
 const option_1 = require("../../util_modules/option");
-const error_1 = __importDefault(require("../../error"));
+const index_js_1 = __importDefault(require("../../error/index.js"));
 const throbber_1 = __importDefault(require("../../throbber"));
-const logger_1 = require("../../util_modules/logger");
+const index_1 = require("../../util_modules/logger/index");
 const util_1 = require("./util");
 const ansi_colors_1 = require("ansi-colors");
 const code_deck_1 = require("../../code-deck");
 exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
     const getSpinnerTxt = (0, util_1.getSpinnerTxt)(process.env.PARENT_COMMAND === 'codedeck' ? 'codedeck' : 'deploy');
-    const idOpt = (0, option_1.getOptionValue)('id', false);
+    const idOpt = (0, option_1.getOptionValue)('id', undefined);
     const iacAPI = new iac_1.default();
     const allDeploys = yield iacAPI.allDeploys();
     if (allDeploys.length <= 0) {
-        throw new error_1.default('No import projects available in server.');
+        throw new index_js_1.default('No import projects available in server.');
     }
     const neededDeploys = allDeploys.filter((deploy) => deploy.id === idOpt || deploy.status === 'Scheduled');
     if (neededDeploys.length <= 0) {
-        throw new error_1.default(idOpt
+        throw new index_js_1.default(idOpt
             ? 'No import projects with given id exists.'
             : 'No import projects currently scheduled.');
     }
@@ -67,13 +67,13 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
                 timerAPI.end(undefined, true);
                 break;
             default:
-                (0, logger_1.debug)('Unknown status received : ', data.status);
+                (0, index_1.debug)('Unknown status received : ', data.status);
                 timerAPI.end();
         }
         lastStatus = data.status;
     }));
     timerAPI.on('error', (e) => {
-        (0, logger_1.debug)('Error encountered : ', e);
+        (0, index_1.debug)('Error encountered : ', e);
     });
     timerAPI.on('end', () => {
         throbber.stopAll();
@@ -81,10 +81,10 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
     process.env.PARENT_COMMAND === 'codedeck' &&
         process.on('exit', () => {
             if (lastStatus === 'Scheduled' || lastStatus === 'Processing') {
-                (0, logger_1.info)();
-                (0, logger_1.message)((0, ansi_colors_1.bold)('You can listen to the status of this CodeLib install by executing the below command'));
+                (0, index_1.info)();
+                (0, index_1.message)((0, ansi_colors_1.bold)('You can listen to the status of this CodeLib install by executing the below command'));
                 process.env.GIT_URL &&
-                    (0, logger_1.info)(`catalyst codelib:install --continue ${code_deck_1.CodeDeckToken.createToken(deployDetails.id, process.env.GIT_URL)}`);
+                    (0, index_1.info)(`catalyst codelib:install --continue ${code_deck_1.CodeDeckToken.createToken(deployDetails.id, process.env.GIT_URL)}`);
             }
         });
     timerAPI.start();

package/lib/iac/status/util/index.d.ts

@@ -0,0 +1,2 @@
+import { IIacResponse } from '../../../endpoints/lib/iac';
+export declare const getSpinnerTxt: (type: 'bundle' | 'deploy' | 'codedeck') => (deployDetails: IIacResponse, status?: string) => string;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+import { Client } from './client';
+export declare const Catalyst: Client;

package/lib/index.js

@@ -3,14 +3,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.Catalyst = void 0;
 const commander_1 = require("commander");
 const client_1 = require("./client");
 const runtime_store_1 = __importDefault(require("./runtime-store"));
 const fs_1 = require("./util_modules/fs");
 const constants_1 = require("./util_modules/constants");
 const ansi_colors_1 = require("ansi-colors");
-const packageJson = runtime_store_1.default.get('context.cli.package');
-const { description, version } = packageJson;
+const packageJson = runtime_store_1.default.get('cli.package');
+const { description, version } = packageJson
+    ? packageJson
+    : (() => {
+        const pkg = fs_1.SYNC.readPackageJson();
+        if (!pkg) {
+            console.error('Package corrupted!!. Re-install zcatalyst-cli and try again.');
+            process.exit(1);
+        }
+        runtime_store_1.default.set('cli.package', pkg);
+        return pkg;
+    })();
 const program = new commander_1.Command();
 program.description(description);
 program.version(version, '-v, --version', 'Print the Catalyst CLI version number');
@@ -24,5 +35,5 @@ program.showSuggestionAfterError();
 program.showHelpAfterError(`For more usage information use the ${(0, ansi_colors_1.bold)('catalyst help')} command`);
 program.addHelpText('before', fs_1.SYNC.readFile(constants_1.TEMPLATE.banner, 'utf-8') || '');
 program.addHelpText('afterAll', `\nFor detailed documentations please visit ${(0, ansi_colors_1.underline)('https://docs.catalyst.zoho.com/en/cli/v1/cli-command-reference/')}`);
-const cli = new client_1.Client(program);
-exports.default = cli;
+process.env['ZCATALYST_CLI_VERSION'] = version;
+exports.Catalyst = new client_1.Client(program);

package/lib/init/dependencies/npm-install.d.ts

@@ -0,0 +1,3 @@
+import { asyncSpawnResposne } from '../../util_modules/shell';
+declare const _default: (pth: string, skipPrompt?: boolean) => Promise<asyncSpawnResposne | Array<asyncSpawnResposne> | undefined>;
+export default _default;

package/lib/init/dependencies/npm-install.js

@@ -12,8 +12,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const error_1 = __importDefault(require("../../error"));
+const index_js_1 = __importDefault(require("../../error/index.js"));
 const prompt_1 = __importDefault(require("../../prompt"));
+const env_js_1 = require("../../util_modules/env.js");
 const shell_1 = require("../../util_modules/shell");
 exports.default = (pth, skipPrompt = false) => __awaiter(void 0, void 0, void 0, function* () {
     const ans = yield prompt_1.default.ask(prompt_1.default.question('NPMinstall', 'Do you wish to install all dependencies now ? ', {
@@ -22,10 +23,10 @@ exports.default = (pth, skipPrompt = false) => __awaiter(void 0, void 0, void 0,
         when: () => !skipPrompt
     }));
     if (ans.NPMinstall === undefined || ans.NPMinstall) {
-        return (0, shell_1.spawn)('npm', ['install'], { cwd: pth })
+        return (0, shell_1.spawn)('npm', ['install'], { cwd: pth, detached: env_js_1.isVsCode })
             .ASYNC()
             .catch((err) => {
-            throw error_1.default.getErrorInstance(err, {
+            throw index_js_1.default.getErrorInstance(err, {
                 message: 'Failure when executing npm install.'
             });
         });

package/lib/init/dependencies/package-json.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (keys: Array<string>) => Promise<Record<string, string>>;
+export default _default;

package/lib/init/dependencies/package-json.js

@@ -18,7 +18,7 @@ const prompt_1 = __importDefault(require("../../prompt"));
 const runtime_store_1 = __importDefault(require("../../runtime-store"));
 const constants_1 = require("../../util_modules/constants");
 const js_1 = require("../../util_modules/js");
-const logger_1 = require("../../util_modules/logger");
+const index_1 = require("../../util_modules/logger/index");
 const project_1 = require("../../util_modules/project");
 exports.default = (keys) => __awaiter(void 0, void 0, void 0, function* () {
     const qns = keys.map((qn) => {
@@ -51,10 +51,10 @@ exports.default = (keys) => __awaiter(void 0, void 0, void 0, function* () {
                 throw new error_1.default('unknown key provided', { exit: 2 });
         }
     });
-    (0, logger_1.info)('This utility will ask series of questions with sensible defaults for creating ' +
+    (0, index_1.info)('This utility will ask series of questions with sensible defaults for creating ' +
         (0, ansi_colors_1.cyan)('package.json') +
         '\nFeel free to modify them if needed.\n');
-    (0, logger_1.info)('Use `' +
+    (0, index_1.info)('Use `' +
         (0, ansi_colors_1.bold)('npm install <pkg> --save') +
         '` afterwards to install a package and \nsave it as a dependency in the package.json file.\n');
     return prompt_1.default.ask(...qns);

package/lib/init/dependencies/python/ensure-python.d.ts

@@ -0,0 +1,2 @@
+export declare function ensurePython(version: string, fallBackNeeded: boolean, skipHelp: boolean): Promise<void>;
+export declare function ensurePythonWithPip(version: string, fallBackNeeded?: boolean, skipHelp?: boolean): Promise<void>;

package/lib/init/dependencies/python/pip-install.d.ts

@@ -0,0 +1,7 @@
+import { asyncSpawnResposne } from '../../../util_modules/shell';
+declare const _default: (pth: string, stack: string, isIntegFn?: boolean, integService?: string | boolean) => Promise<asyncSpawnResposne | Array<asyncSpawnResposne> | void>;
+export default _default;
+export declare function ensurePyRuntime(pth: string, stack: string): Promise<void>;
+export declare const pypiRes: (pkg: string) => Promise<Record<string, unknown>>;
+export declare function installRequirements(reqFile: string, pth: string, stackVersion: string, linuxMode?: boolean): Promise<void>;
+export declare function installPkgs(pkgs: Array<string>, stackVersion: string, pth?: string | undefined): Promise<asyncSpawnResposne>;

package/lib/init/dependencies/python/pip-install.js

@@ -24,7 +24,7 @@ const runtime_1 = __importDefault(require("../../../util_modules/constants/lib/r
 const env_1 = require("../../../util_modules/env");
 const ensure_python_1 = require("./ensure-python");
 const userConfig_1 = __importDefault(require("../../../userConfig"));
-const logger_1 = require("../../../util_modules/logger");
+const index_1 = require("../../../util_modules/logger/index");
 const sdkPipOpts = (0, env_1.envOverride)('CATALYST_SDK_PIP_OPTS', 'zcatalyst-sdk');
 const cliqSdkPipOpts = (0, env_1.envOverride)('CATALYST_CLIQ_SDK_PIP_OPTS', 'zcatalyst-cliq');
 const testPypi = (0, env_1.envOverride)('CATALYST_TEST_PYPI', 'false');
@@ -91,7 +91,7 @@ function ensurePyRuntime(pth, stack) {
                 errData.push(chunk);
             });
             child.on('error', (err) => {
-                (0, logger_1.info)(Buffer.concat(errData).toString());
+                (0, index_1.info)(Buffer.concat(errData).toString());
                 reject(new error_1.default(`Error while installing python${stackVersion.replace('_', '.')} runtime`, {
                     original: err,
                     exit: 2
@@ -170,7 +170,7 @@ function installRequirements(reqFile, pth, stackVersion, linuxMode = false) {
                 errData.push(chunk);
             });
             child.on('error', (err) => {
-                (0, logger_1.info)(Buffer.concat(errData).toString());
+                (0, index_1.info)(Buffer.concat(errData).toString());
                 reject(new error_1.default('unable to process requirements.txt', {
                     exit: 2,
                     original: err

package/lib/init/features/appsail/index.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Promise<void>;
+export default _default;

package/lib/init/features/appsail/index.js

@@ -14,172 +14,96 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const ansi_colors_1 = require("ansi-colors");
 const path_1 = require("path");
-const archiver_1 = __importDefault(require("../../../archiver"));
-const endpoints_1 = require("../../../endpoints");
 const prompt_1 = __importDefault(require("../../../prompt"));
 const runtime_store_1 = __importDefault(require("../../../runtime-store"));
-const config_1 = require("../../../util_modules/config");
 const constants_1 = require("../../../util_modules/constants");
 const fs_1 = require("../../../util_modules/fs");
-const logger_1 = require("../../../util_modules/logger");
+const index_1 = require("../../../util_modules/logger/index");
 const option_1 = require("../../../util_modules/option");
 const common_1 = require("../../util/common");
 const project_1 = require("../../../util_modules/project");
-function getAppSailZip() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const _gitHubAPI = yield (0, endpoints_1.gitHubAPI)();
-        const gitRepo = yield prompt_1.default.ask(prompt_1.default.question('repo', 'Please choose from the list of recommended projects to get started', {
-            type: 'list',
-            choices: [
-                prompt_1.default.choice(`appsail-nodejs - ${(0, ansi_colors_1.underline)('https://github.com/catalystbyzoho/appsail-nodejs')}`, {
-                    value: {
-                        api: _gitHubAPI.appsailNodejs.bind(_gitHubAPI),
-                        command: 'node index.js',
-                        source: (0, project_1.resolveProjectPath)('appsail-nodejs'),
-                        build: './',
-                        stack: {
-                            runtime: 'node16',
-                            lang: 'node'
-                        },
-                        scripts: {
-                            preserve: 'npm install',
-                            predeploy: 'npm install'
-                        },
-                        memory: 256
-                    },
-                    short: 'appsail-nodejs'
-                }),
-                prompt_1.default.choice(`appsail-java - ${(0, ansi_colors_1.underline)('https://github.com/catalystbyzoho/appsail-java')}`, {
-                    value: {
-                        api: _gitHubAPI.appsailJava.bind(_gitHubAPI),
-                        command: 'java -jar demo-0.0.1-SNAPSHOT.jar',
-                        source: (0, project_1.resolveProjectPath)('appsail-java'),
-                        build: (0, path_1.join)('target', 'demo-0.0.1-SNAPSHOT.jar'),
-                        stack: {
-                            runtime: 'java8',
-                            lang: 'java'
-                        },
-                        scripts: {
-                            preserve: './mvnw clean install',
-                            predeploy: './mvnw clean install'
-                        },
-                        memory: 512,
-                        platform: 'javase'
-                    },
-                    short: 'appsail-java'
-                }),
-                prompt_1.default.choice(`appsail-python - ${(0, ansi_colors_1.underline)('https://github.com/catalystbyzoho/appsail-python')}`, {
-                    value: {
-                        api: _gitHubAPI.appsailPython.bind(_gitHubAPI),
-                        command: 'python3 app.py',
-                        source: (0, project_1.resolveProjectPath)('appsail-python'),
-                        build: './',
-                        stack: {
-                            runtime: 'python_3_9',
-                            lang: 'python'
-                        },
-                        scripts: {
-                            preserve: 'python3 -m pip install -r ./requirements.txt -t ./ --upgrade',
-                            predeploy: 'python3 -m pip install -r ./requirements.txt -t ./ --upgrade'
-                        },
-                        memory: 256
-                    },
-                    short: 'appsail-python'
-                })
-            ]
-        }));
-        (0, logger_1.info)();
-        (0, logger_1.info)((0, ansi_colors_1.white)('=>') + ' Downloading code');
-        const code = (yield gitRepo.repo.api());
-        const repoDir = gitRepo.repo.source;
-        yield fs_1.ASYNC.ensureDir(repoDir);
-        const zip = new archiver_1.default();
-        zip.load(code);
-        zip.extract(repoDir, '/', {
-            isFolder: true,
-            ignoreLevel: 1
-        });
-        yield zip.finalize();
-        (0, logger_1.success)(`Successfully downloaded the code to ${ansi_colors_1.bold.green(gitRepo.repo.source)}`);
-        return {
-            source: gitRepo.repo.source,
-            build: gitRepo.repo.build,
-            stack: gitRepo.repo.stack,
-            command: gitRepo.repo.command,
-            scripts: gitRepo.repo.scripts,
-            memory: gitRepo.repo.memory,
-            platform: gitRepo.repo.platform
-        };
-    });
-}
+const utils_1 = require("./utils");
 exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
+    (0, index_1.info)();
+    (0, index_1.info)((0, ansi_colors_1.white)('=> ') + 'Configure AppSail');
+    const descArr = [
+        '',
+        `  Catalyst let's you choose the runtime of your choice for your AppSail. You can either select`,
+        `  "Catalyst-Managed Runtime" to select one of the Catalyst offered runtimes or you can select `,
+        `  "Docker Image" to use a docker image, which can utilize OCI compliant containers to host your AppSail`,
+        `  For more info: ${(0, ansi_colors_1.underline)('https://docs.catalyst.zoho.com/en/serverless/help/appsail/introduction/')}`,
+        ''
+    ];
+    yield prompt_1.default.register('with-desc');
+    const runtimeQuestion = yield prompt_1.default.ask(prompt_1.default.question('runtime', 'Please select the runtime for your AppSail to continue:', {
+        type: 'with-desc',
+        description: (0, ansi_colors_1.italic)(descArr.join('\n')),
+        choices: [
+            prompt_1.default.choice('Catalyst-Managed Runtime', {
+                value: 'catalyst',
+                short: 'Catalyst-Managed Runtime'
+            }),
+            prompt_1.default.choice('Docker Image', {
+                value: 'custom',
+                short: 'Docker Image'
+            })
+        ]
+    }));
+    if (runtimeQuestion.runtime === 'custom') {
+        const payload = {
+            source: yield (0, utils_1.getCustomAppSailSource)(),
+            name: yield (0, utils_1.getAppSailName)()
+        };
+        runtime_store_1.default.set('context.payload.appsail.targets', [payload]);
+        return;
+    }
     const curCommand = (0, option_1.getCurrentCommand)();
     const gitPrompt = yield prompt_1.default.ask(prompt_1.default.question('gitClone', 'Do you want to get-started with a list of example AppSails?', {
         type: 'confirm',
         default: true,
         when: curCommand === 'init'
     }));
-    const pulledSource = gitPrompt.gitClone && (yield getAppSailZip());
-    const sourcePath = yield prompt_1.default.ask(prompt_1.default.question('currentDir', 'Do you want to initialize an AppSail service in this directory?', {
+    const pulledSource = gitPrompt.gitClone && (yield (0, utils_1.getAppSailZip)());
+    const sourcePath = yield prompt_1.default.ask(prompt_1.default.question('currentDir', 'Do you want to initialize an AppSail in this directory?', {
         type: 'confirm',
         default: true,
         when: !pulledSource
     }));
-    (0, logger_1.info)();
-    (0, logger_1.info)((0, ansi_colors_1.white)('=> ') + 'Configure AppSail service');
     const _appSailConfig = sourcePath.currentDir
         ? { source: runtime_store_1.default.get('cwd') }
         : pulledSource || {
-            source: (yield prompt_1.default.ask(prompt_1.default.question('source', "Please provide the exact path to your AppSail service's source directory: ", {
+            source: (yield prompt_1.default.ask(prompt_1.default.question('source', "Please provide the exact path to your AppSail's source directory:", {
                 type: 'input',
                 validate: (pth) => __awaiter(void 0, void 0, void 0, function* () {
                     return (0, path_1.isAbsolute)(pth)
                         ? (yield fs_1.ASYNC.dirExists(pth))
                             ? true
                             : 'Provided path does not exists'
-                        : 'Please provide provide an absolute path';
+                        : 'Please provide an absolute path';
                 })
             }))).source
         };
-    const existingSails = config_1.appSailConfig.raw() || [];
-    const appName = yield prompt_1.default.ask(prompt_1.default.question('name', 'Please provide the name for your AppSail: ', {
-        type: 'input',
-        default: 'AppSail',
-        validate: (name) => {
-            const exists = existingSails.findIndex((appSail) => appSail.name === name) !== -1
-                ? 'AppSail already exists'
-                : true;
-            const match = name.match(constants_1.REGEX.functions.package.name)
-                ? true
-                : `Invalid AppSail name. It should be in the following format: ${constants_1.REGEX.functions.package.name}`;
-            return typeof exists === 'string'
-                ? exists
-                : typeof match === 'string'
-                    ? match
-                    : true;
-        }
-    }));
     const payload = {
         source: (0, path_1.relative)((0, project_1.getProjectRoot)(), _appSailConfig.source) || '.',
-        name: appName.name
+        name: yield (0, utils_1.getAppSailName)()
     };
     const appConfigPth = (0, path_1.join)(_appSailConfig.source, constants_1.FILENAME.app_config);
     const isAppConfig = yield fs_1.ASYNC.fileExists(appConfigPth);
     if (isAppConfig) {
-        (0, logger_1.info)();
-        (0, logger_1.warning)(`The ${(0, ansi_colors_1.bold)(constants_1.FILENAME.app_config)} file is already present in the appsail directory`);
+        (0, index_1.info)();
+        (0, index_1.warning)(`The ${(0, ansi_colors_1.bold)(constants_1.FILENAME.app_config)} file is already present in the appsail directory`);
     }
-    const overWrite = yield prompt_1.default.ask(prompt_1.default.question('appConfig', 'Do you wish to overwrite the ' + constants_1.FILENAME.app_config, {
+    const overWrite = yield prompt_1.default.ask(prompt_1.default.question('appConfig', 'Do you wish to overwrite the ' + constants_1.FILENAME.app_config + '?', {
         type: 'confirm',
         default: false,
         when: isAppConfig
     }));
     const activeWrite = overWrite.appConfig !== false;
     if (!activeWrite) {
-        runtime_store_1.default.set('payload.appsail.targets', [payload]);
+        runtime_store_1.default.set('context.payload.appsail.targets', [payload]);
         return;
     }
-    const buildPath = yield prompt_1.default.ask(prompt_1.default.question('path', 'Please provide the build path of your AppSail service: ', {
+    const buildPath = yield prompt_1.default.ask(prompt_1.default.question('path', 'Please provide the build path of your AppSail:', {
         type: 'input',
         rootPath: _appSailConfig.source,
         when: !_appSailConfig.build && activeWrite
@@ -199,7 +123,7 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
         scripts: _appSailConfig.scripts || {}
     };
     if (appSailStack.lang === 'java') {
-        const platform = yield prompt_1.default.ask(prompt_1.default.question('value', 'Please choose a platform for your AppSail: ', {
+        const platformQ = yield prompt_1.default.ask(prompt_1.default.question('platform', 'Please choose a platform for your AppSail: ', {
             type: 'list',
             choices: [
                 prompt_1.default.choice('JavaSE', {
@@ -213,11 +137,11 @@ exports.default = () => __awaiter(void 0, void 0, void 0, function* () {
             ],
             when: !_appSailConfig.platform
         }));
-        appConfig.platform = _appSailConfig.platform || platform.value;
+        appConfig.platform = _appSailConfig.platform || platformQ.platform;
         if (appConfig.platform === 'war') {
             delete appConfig.command;
         }
     }
-    runtime_store_1.default.set('payload.appsail.targets', [payload]);
+    runtime_store_1.default.set('context.payload.appsail.targets', [payload]);
     activeWrite && (yield fs_1.ASYNC.writeJSONFile(appConfigPth, appConfig));
 });

package/lib/init/features/appsail/utils.d.ts

@@ -0,0 +1,16 @@
+export type _TAppSailInitConfig = {
+    source: string;
+    build?: string;
+    stack?: {
+        runtime: string;
+        lang: string;
+    };
+    command?: string;
+    scripts?: Record<string, string>;
+    memory?: number;
+    platform?: 'javase' | 'war';
+};
+export declare function getAppSailZip(): Promise<_TAppSailInitConfig>;
+export declare function getAppSailName(): Promise<string>;
+export declare function getContainerImageTag(): Promise<string>;
+export declare function getCustomAppSailSource(): Promise<string>;