zcatalyst-cli 1.26.1 → 1.27.0

package/lib/util_modules/fs/lib/sync.js

@@ -32,6 +32,7 @@ exports.emptyDir = emptyDir;
 exports.readJSONFile = readJSONFile;
 exports.writeJSONFile = writeJSONFile;
 exports.readPackageJson = readPackageJson;
+exports.getStdinType = getStdinType;
 exports.isDirEmpty = isDirEmpty;
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const os_1 = __importDefault(require("os"));
@@ -199,6 +200,24 @@ function readPackageJson() {
     });
     return pkg;
 }
+function getStdinType() {
+    if (process.stdin.isTTY) {
+        return 'tty';
+    }
+    try {
+        const stdinStat = fs_extra_1.default.fstatSync(process.stdin.fd);
+        if (stdinStat.isFIFO()) {
+            return 'pipe';
+        }
+        if (stdinStat.isFile()) {
+            return 'file';
+        }
+        return 'other';
+    }
+    catch (error) {
+        return 'other';
+    }
+}
 function isDirEmpty(pth) {
     const files = fs_extra_1.default.readdirSync(pth);
     return files.length === 0;

package/lib/util_modules/logger/utils.d.ts

@@ -6,6 +6,7 @@ export declare const CHAR: {
     info: string;
     error: string;
 };
+export declare function shellCommand(cmd: string): string;
 export declare class TTYPassThrough extends PassThrough {
     columns: number;
     rows: number;

package/lib/util_modules/logger/utils.js

@@ -7,10 +7,11 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 var _a, _LogStreamFactory_logStream;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogStreamFactory = exports.TTYPassThrough = exports.CHAR = void 0;
+exports.shellCommand = shellCommand;
 const ansi_colors_1 = require("ansi-colors");
-const env_js_1 = require("../env.js");
 const readline_1 = require("readline");
 const stream_1 = require("stream");
+const env_js_1 = require("../env.js");
 const option_1 = require("../option");
 const isSupported = !env_js_1.isWindows || process.env.CI || process.env.TERM === 'xterm-256color';
 exports.CHAR = {
@@ -19,6 +20,9 @@ exports.CHAR = {
     info: isSupported ? ansi_colors_1.bold.cyan('ℹ') : ansi_colors_1.bold.cyan('i'),
     error: isSupported ? ansi_colors_1.bold.red('✖') : ansi_colors_1.bold.red('×')
 };
+function shellCommand(cmd) {
+    return `${(0, ansi_colors_1.dim)('>')} ${(0, ansi_colors_1.italic)(cmd)} `;
+}
 class TTYPassThrough extends stream_1.PassThrough {
     constructor() {
         super(...arguments);

package/lib/util_modules/option.d.ts

@@ -3,3 +3,4 @@ export declare function getOptionValue<T = string | boolean>(key: string, fallba
 export declare function setGlobalOption(key: string, value: unknown): void;
 export declare function getGlobalOptionValue<T>(key: string, fallback?: T): T | string;
 export declare function getUnknownOpts<T>(fallback?: T): T | Array<string>;
+export declare function unsetOption(optKey: string): void;

package/lib/util_modules/option.js

@@ -8,6 +8,7 @@ exports.getOptionValue = getOptionValue;
 exports.setGlobalOption = setGlobalOption;
 exports.getGlobalOptionValue = getGlobalOptionValue;
 exports.getUnknownOpts = getUnknownOpts;
+exports.unsetOption = unsetOption;
 const runtime_store_1 = __importDefault(require("../runtime-store"));
 function getCurrentCommand(fallback) {
     return runtime_store_1.default.get('context.opts._name', fallback);
@@ -24,3 +25,10 @@ function getGlobalOptionValue(key, fallback) {
 function getUnknownOpts(fallback) {
     return runtime_store_1.default.get('context.opts.unknownOpts', fallback);
 }
+function unsetOption(optKey) {
+    const opts = runtime_store_1.default.get('context.opts', {});
+    if (opts[optKey] !== undefined) {
+        delete opts[optKey];
+        runtime_store_1.default.set('context.opts', opts);
+    }
+}

package/lib/util_modules/{server.js → server/index.js}

@@ -51,10 +51,10 @@ exports.getHostIP = getHostIP;
 exports.isPortListening = isPortListening;
 const http_proxy_1 = __importDefault(require("http-proxy"));
 const net_1 = require("net");
-const env_1 = require("./env");
 const child_process_1 = require("child_process");
-const logger_1 = require("./logger");
-const error_1 = __importDefault(require("../error"));
+const env_1 = require("../env");
+const logger_1 = require("../logger");
+const error_1 = __importDefault(require("../../error"));
 class ConnectionDestroyer {
     constructor(server) {
         this.server = server;

package/lib/util_modules/server/needed-scopes.d.ts

@@ -0,0 +1 @@
+export declare const SERVE_SCOPES: ("ZohoCatalyst.apigateway.apis.READ" | "ZohoCatalyst.apigateway.READ" | "ZohoCatalyst.segments.ALL" | "ZohoCatalyst.cache.READ" | "ZohoCatalyst.cache.CREATE" | "ZohoCatalyst.cache.DELETE" | "ZohoCatalyst.projects.ALL" | "ZohoCatalyst.cron.ALL" | "ZohoCatalyst.zcql.CREATE" | "ZohoCatalyst.projects.users.READ" | "ZohoCatalyst.projects.users.CREATE" | "ZohoCatalyst.projects.users.DELETE" | "ZohoCatalyst.projects.users.UPDATE" | "ZohoCatalyst.authentication.CREATE" | "ZohoCatalyst.email.CREATE" | "ZohoCatalyst.tables.ALL" | "ZohoCatalyst.tables.rows.ALL" | "ZohoCatalyst.tables.columns.ALL" | "ZohoCatalyst.tables.bulk.READ" | "ZohoCatalyst.tables.bulk.CREATE" | "ZohoCatalyst.nosql.READ" | "ZohoCatalyst.nosql.rows.ALL" | "ZohoCatalyst.folders.ALL" | "ZohoCatalyst.files.CREATE" | "ZohoCatalyst.files.READ" | "ZohoCatalyst.files.DELETE" | "ZohoCatalyst.functions.ALL" | "ZohoCatalyst.functions.EXECUTE" | "ZohoCatalyst.eventlistners.ALL" | "ZohoCatalyst.eventlisteners.produce" | "ZohoCatalyst.security.rules.Read" | "ZohoCatalyst.security.rules.Update" | "ZohoCatalyst.notifications.mobile" | "ZohoCatalyst.notifications.web" | "ZohoCatalyst.search.READ" | "ZohoCatalyst.mlkit.READ" | "QuickML.deployment.READ" | "ZohoCatalyst.pdfshot.execute" | "ZohoCatalyst.dataverse.execute" | "ZohoCatalyst.grid.READ" | "ZohoCatalyst.grid.terminate" | "ZohoCatalyst.circuits.execute" | "ZohoCatalyst.circuits.execution.READ" | "ZohoCatalyst.circuits.execution.DELETE" | "ZohoCatalyst.appsail.Read" | "ZohoCatalyst.jobpool.READ" | "ZohoCatalyst.job.ALL")[];

package/lib/util_modules/{constants/lib → server}/needed-scopes.js

@@ -4,9 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-const scopes_1 = __importDefault(require("../../../authentication/constants/scopes"));
-const login_1 = require("../../../authentication/login");
-const dc_1 = require("../../dc");
+exports.SERVE_SCOPES = void 0;
+const scopes_1 = __importDefault(require("../../authentication/constants/scopes"));
+const login_1 = require("../../authentication/login");
+const dc_1 = require("../dc");
 const serveScopes = [
     scopes_1.default.api_read,
     scopes_1.default.apig_read,
@@ -56,7 +57,6 @@ const serveScopes = [
     scopes_1.default.nosql_table,
     scopes_1.default.nosql_rows
 ];
-const _missingScope = ((_a = login_1.missingScopes[(0, dc_1.getActiveDC)()]) === null || _a === void 0 ? void 0 : _a.map((dvScope) => scopes_1.default[dvScope])) || [];
-exports.default = Object.freeze({
-    SERVE: serveScopes.filter((scope) => !_missingScope.includes(scope))
-});
+const dc = (0, dc_1.getActiveDC)({ throwError: false });
+const _missingScope = (dc && ((_a = login_1.missingScopes[dc]) === null || _a === void 0 ? void 0 : _a.map((dvScope) => scopes_1.default[dvScope]))) || [];
+exports.SERVE_SCOPES = serveScopes.filter((scope) => !_missingScope.includes(scope));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "zcatalyst-cli",
-	"version": "1.26.1",
+	"version": "1.27.0",
 	"description": "Command Line Tool for CATALYST",
 	"main": "./lib/index.js",
 	"bin": {
@@ -97,11 +97,12 @@
 		"build:watch": "gulp watch",
 		"clean": "gulp cleanup",
 		"test:unit": "jest --config jest.config.js",
+		"test:integration": "npm run build && jest --config jest.config.js --testPathPattern=test/integration --no-coverage",
 		"lint:nofix": "eslint --ext .ts src/ --color",
 		"lint:src": "eslint --ext .ts src/ --fix --color",
 		"lint:unit": "eslint --ext .js,.ts test/ --fix --color",
 		"lint": "run-p lint:src lint:unit",
-		"test": "run-s lint:unit test:unit",
+		"test": "run-s lint:unit test:unit test:integration",
 		"prepare": "npm run build",
 		"prepublishOnly": "npm test && npm run lint",
 		"preversion": "npm run lint",

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

@@ -1,273 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAppSailZip = getAppSailZip;
-exports.getAppSailName = getAppSailName;
-exports.getContainerImageTag = getContainerImageTag;
-exports.getCustomAppSailSource = getCustomAppSailSource;
-const image_1 = require("@zcatalyst/container-plugin/out/endpoints/image");
-const ansi_colors_1 = require("ansi-colors");
-const inquirer = __importStar(require("inquirer"));
-const path_1 = require("path");
-const archiver_1 = __importDefault(require("../../../archiver"));
-const endpoints_1 = require("../../../endpoints");
-const error_1 = __importDefault(require("../../../error"));
-const prompt_1 = __importDefault(require("../../../prompt"));
-const config_1 = require("../../../util_modules/config");
-const constants_1 = require("../../../util_modules/constants");
-const container_1 = require("../../../util_modules/container");
-const fs_1 = require("../../../util_modules/fs");
-const js_1 = require("../../../util_modules/js");
-const logger_1 = require("../../../util_modules/logger");
-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
-        };
-    });
-}
-function getAppSailName() {
-    return __awaiter(this, void 0, void 0, function* () {
-        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.appsail.name)
-                    ? true
-                    : 'Invalid AppSail name: Name must contain only alphanumeric and hyphen';
-                return typeof exists === 'string'
-                    ? exists
-                    : typeof match === 'string'
-                        ? match
-                        : true;
-            }
-        }));
-        return appName.name;
-    });
-}
-function getContainerImageTag() {
-    return __awaiter(this, void 0, void 0, function* () {
-        yield (0, container_1.isSocketAccessible)();
-        const images = (yield (0, image_1.getAllLocalImages)()).reduce((_images, img) => {
-            var _a;
-            (_a = img.RepoTags) === null || _a === void 0 ? void 0 : _a.forEach((tag) => _images.push({ imgName: tag, id: img.Id }));
-            return _images;
-        }, []);
-        const searchImages = (filter) => {
-            const filteredImages = [];
-            images.forEach((img) => {
-                var _a;
-                if (filter === '' ||
-                    img.id.includes(filter) ||
-                    ((_a = img.imgName) === null || _a === void 0 ? void 0 : _a.toLowerCase().includes(filter.toLowerCase()))) {
-                    filteredImages.push({
-                        name: `${img.imgName} ${(0, ansi_colors_1.dim)(img.id.substring(7, 17))}`,
-                        value: img.imgName || img.id
-                    });
-                    return;
-                }
-            });
-            return filteredImages;
-        };
-        yield prompt_1.default.register('search-box');
-        const image = yield inquirer.prompt([
-            {
-                type: 'search-box',
-                boxType: 'list',
-                name: 'name',
-                searchable: true,
-                pageSize: 10,
-                highlight: true,
-                notFoundMsg: 'No Images found!',
-                searchMsg: 'Searching images...',
-                message: 'Please search and select the image to link:',
-                source(_answersSoFar, input) {
-                    input || (input = '');
-                    return Promise.resolve(searchImages(input));
-                },
-                validate: (ansArr) => {
-                    if (js_1.JS.isEmpty(ansArr)) {
-                        return 'Must select an Image';
-                    }
-                    return true;
-                }
-            }
-        ]);
-        return `docker://${image.name}`;
-    });
-}
-function getCustomAppSailSource() {
-    return __awaiter(this, void 0, void 0, function* () {
-        const dockerProtocol = yield prompt_1.default.ask(prompt_1.default.question('type', 'Please choose one of the supported protocols:', {
-            type: 'list',
-            choices: [
-                prompt_1.default.choice(`Docker image ${(0, ansi_colors_1.italic)('(docker://)')}`, {
-                    value: 'image',
-                    short: 'Docker image'
-                }),
-                prompt_1.default.choice(`Docker archive ${(0, ansi_colors_1.italic)('(docker-archive://)')}`, {
-                    value: 'docker-archive',
-                    short: 'Docker archive'
-                })
-            ]
-        }));
-        switch (dockerProtocol.type) {
-            case 'image': {
-                return getContainerImageTag();
-            }
-            case 'docker-archive': {
-                const archivePath = yield prompt_1.default.ask(prompt_1.default.question('archive', 'Please provide the path to the docker archive file: ', {
-                    type: 'input',
-                    validate: (pth) => __awaiter(this, void 0, void 0, function* () {
-                        if (!(0, path_1.isAbsolute)(pth)) {
-                            return 'Please provide an absolute path';
-                        }
-                        if (!(yield fs_1.ASYNC.fileExists(pth))) {
-                            return 'Provided path does not exists';
-                        }
-                        if (!pth.endsWith('.tar')) {
-                            return 'Provided file is not a valid docker archive. Please provide a .tar file';
-                        }
-                        return true;
-                    })
-                }));
-                const path = (0, path_1.relative)((0, project_1.getProjectRoot)(), archivePath.archive);
-                return `docker-archive://${path}`;
-            }
-            default: {
-                throw new error_1.default('Unsupported protocol selected for AppSail source', {
-                    exit: 2
-                });
-            }
-        }
-    });
-}

package/lib/util_modules/constants/lib/needed-scopes.d.ts

@@ -1,4 +0,0 @@
-declare const _default: Readonly<{
-    SERVE: ("ZohoCatalyst.apigateway.apis.READ" | "ZohoCatalyst.apigateway.READ" | "ZohoCatalyst.segments.ALL" | "ZohoCatalyst.cache.READ" | "ZohoCatalyst.cache.CREATE" | "ZohoCatalyst.cache.DELETE" | "ZohoCatalyst.projects.ALL" | "ZohoCatalyst.cron.ALL" | "ZohoCatalyst.zcql.CREATE" | "ZohoCatalyst.projects.users.READ" | "ZohoCatalyst.projects.users.CREATE" | "ZohoCatalyst.projects.users.DELETE" | "ZohoCatalyst.projects.users.UPDATE" | "ZohoCatalyst.authentication.CREATE" | "ZohoCatalyst.email.CREATE" | "ZohoCatalyst.tables.ALL" | "ZohoCatalyst.tables.rows.ALL" | "ZohoCatalyst.tables.columns.ALL" | "ZohoCatalyst.tables.bulk.READ" | "ZohoCatalyst.tables.bulk.CREATE" | "ZohoCatalyst.nosql.READ" | "ZohoCatalyst.nosql.rows.ALL" | "ZohoCatalyst.folders.ALL" | "ZohoCatalyst.files.CREATE" | "ZohoCatalyst.files.READ" | "ZohoCatalyst.files.DELETE" | "ZohoCatalyst.functions.ALL" | "ZohoCatalyst.functions.EXECUTE" | "ZohoCatalyst.eventlistners.ALL" | "ZohoCatalyst.eventlisteners.produce" | "ZohoCatalyst.security.rules.Read" | "ZohoCatalyst.security.rules.Update" | "ZohoCatalyst.notifications.mobile" | "ZohoCatalyst.notifications.web" | "ZohoCatalyst.search.READ" | "ZohoCatalyst.mlkit.READ" | "QuickML.deployment.READ" | "ZohoCatalyst.pdfshot.execute" | "ZohoCatalyst.dataverse.execute" | "ZohoCatalyst.grid.READ" | "ZohoCatalyst.grid.terminate" | "ZohoCatalyst.circuits.execute" | "ZohoCatalyst.circuits.execution.READ" | "ZohoCatalyst.circuits.execution.DELETE" | "ZohoCatalyst.appsail.Read" | "ZohoCatalyst.jobpool.READ" | "ZohoCatalyst.job.ALL")[];
-}>;
-export default _default;