@contentstack/cli-utilities 1.8.4 → 1.10.0

package/lib/cli-table.d.ts

@@ -0,0 +1,38 @@
+import { Header } from 'tty-table';
+import { FlagInput } from '.';
+export interface TableFlags {
+    extended?: boolean;
+    columns?: string;
+    csv?: boolean;
+    filter?: string;
+    'no-header'?: boolean;
+    'no-truncate'?: boolean;
+    output?: 'csv' | 'json' | 'yaml';
+    sort?: string;
+}
+/** Type for table headers */
+export type TableHeader = Header;
+/** Type for table columns mapping */
+export type TableColumn = {
+    [key: string]: {
+        minWidth?: number;
+        maxWidth?: number;
+        alias?: string;
+        align?: 'left' | 'center' | 'right';
+    };
+};
+export type TableData<T extends Record<string, unknown>> = T[];
+/** Options for CLI Table rendering */
+export type TableOptions = {
+    truncate?: boolean;
+    borderStyle?: 'solid' | 'dashed' | 'none';
+    paddingBottom?: number;
+    showHeader?: boolean;
+    align?: 'left' | 'center' | 'right';
+    enableHeaderTitle?: boolean;
+};
+export default class CLITable {
+    /** Returns CLI table flags */
+    static getTableFlags(columns?: string[]): FlagInput<TableFlags>;
+    static render(headers: TableHeader[], data: Record<string, unknown>[], flags: TableFlags, options?: TableOptions): void;
+}

package/lib/cli-table.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const tty_table_1 = tslib_1.__importDefault(require("tty-table"));
+const yaml = tslib_1.__importStar(require("js-yaml"));
+const papaparse_1 = require("papaparse");
+const core_1 = require("@oclif/core");
+const _1 = require(".");
+class CLITable {
+    /** Returns CLI table flags */
+    static getTableFlags(columns = ['columns', 'sort', 'filter', 'csv', 'no-truncate']) {
+        const flags = {
+            columns: core_1.Flags.string({
+                description: 'Specify columns to display, comma-separated.',
+                helpGroup: 'TABLE',
+            }),
+            sort: core_1.Flags.string({
+                description: 'Sort the table by a column. Use "-" for descending.',
+                helpGroup: 'TABLE',
+            }),
+            filter: core_1.Flags.string({
+                description: 'Filter rows by a column value (e.g., name=foo).',
+                helpGroup: 'TABLE',
+            }),
+            csv: core_1.Flags.boolean({
+                description: 'Output results in CSV format.',
+                helpGroup: 'TABLE',
+            }),
+            'no-truncate': core_1.Flags.boolean({
+                description: 'Prevent truncation of long text in columns.',
+                helpGroup: 'TABLE',
+            }),
+            'no-header': core_1.Flags.boolean({
+                description: 'Hide table headers in output.',
+                helpGroup: 'TABLE',
+            }),
+            output: core_1.Flags.string({
+                options: ['csv', 'json', 'yaml'],
+                description: 'Specify output format: csv, json, or yaml.',
+                helpGroup: 'TABLE',
+            }),
+        };
+        // Return only requested flags
+        return Object.entries(flags)
+            .filter(([key]) => columns.includes(key))
+            .reduce((acc, [key, value]) => {
+            acc[key] = value;
+            return acc;
+        }, {});
+    }
+    static render(headers, data, flags, options) {
+        let tableData = [...data];
+        if (flags) {
+            // **Filter Data**
+            if (flags.filter) {
+                const [key, value] = flags.filter.split('=');
+                tableData = tableData.filter((row) => { var _a; return (_a = row[key]) === null || _a === void 0 ? void 0 : _a.toString().toLowerCase().includes(value.toLowerCase()); });
+            }
+            // **Select Specific Columns**
+            if (flags.columns) {
+                const selectedColumns = flags.columns.split(',');
+                headers = headers.filter((header) => selectedColumns.includes(header.value));
+                tableData = tableData.map((row) => selectedColumns.reduce((acc, key) => {
+                    if (row[key] !== undefined) {
+                        acc[key] = row[key];
+                    }
+                    return acc;
+                }, {}));
+            }
+            // **Sort Data**
+            if (flags.sort) {
+                const sortKey = flags.sort.replace('-', '');
+                const descending = flags.sort.startsWith('-');
+                tableData.sort((a, b) => {
+                    if (a[sortKey] < b[sortKey])
+                        return descending ? 1 : -1;
+                    if (a[sortKey] > b[sortKey])
+                        return descending ? -1 : 1;
+                    return 0;
+                });
+            }
+            // **Format Output**
+            if (flags.output) {
+                switch (flags.output) {
+                    case 'json':
+                        console.log(JSON.stringify(tableData, null, 2));
+                        return;
+                    case 'yaml':
+                        console.log(yaml.dump(tableData));
+                        return;
+                    case 'csv':
+                        console.log((0, papaparse_1.parse)(tableData));
+                        return;
+                }
+            }
+            if (flags.csv) {
+                console.log((0, papaparse_1.parse)(tableData));
+            }
+        }
+        // **Render Table**
+        const config = {
+            truncate: !(flags === null || flags === void 0 ? void 0 : flags['no-header']),
+            borderStyle: 'solid',
+            paddingBottom: 0,
+            showHeader: !(flags === null || flags === void 0 ? void 0 : flags['no-header']),
+        };
+        _1.cliux.print((0, tty_table_1.default)(headers, tableData, config).render());
+    }
+}
+exports.default = CLITable;

package/lib/cli-ux.d.ts

@@ -1,6 +1,6 @@
-import { Table } from '@oclif/core/lib/cli-ux';
 import { Args, Flags, Command } from '@oclif/core';
 import { Ora } from 'ora';
+import { TableFlags, TableHeader, TableData, TableOptions } from './cli-table';
 import { PrintOptions, InquirePayload, CliUXPromptOptions } from './interfaces';
 /**
  * CLI Interface
@@ -8,16 +8,15 @@ import { PrintOptions, InquirePayload, CliUXPromptOptions } from './interfaces';
 declare class CLIInterface {
     private loading;
     constructor();
-    get uxTable(): typeof Table.table;
     init(context: any): void;
     registerSearchPlugin(): void;
     print(message: string, opts?: PrintOptions): void;
     success(message: string): void;
     error(message: string, ...params: any): void;
     loader(message?: string): void;
-    table(data: Record<string, unknown>[], columns: Table.table.Columns<Record<string, unknown>>, options?: Table.table.Options): void;
+    table<T extends Record<string, unknown>>(headers: TableHeader[], data: TableData<T>, flags?: TableFlags, options?: TableOptions): void;
     inquire<T>(inquirePayload: InquirePayload | Array<InquirePayload>): Promise<T>;
-    prompt(name: string, options?: CliUXPromptOptions): Promise<any>;
+    prompt(message: string, options?: CliUXPromptOptions): Promise<any>;
     confirm(message?: string): Promise<boolean>;
     progress(options?: any): any;
     loaderV2(message?: string, spinner?: any): Ora | void;

package/lib/cli-ux.js

@@ -9,6 +9,8 @@ Object.defineProperty(exports, "Args", { enumerable: true, get: function () { re
 Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return core_1.Flags; } });
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return core_1.Command; } });
 const ora_1 = tslib_1.__importDefault(require("ora"));
+const cli_progress_1 = tslib_1.__importDefault(require("cli-progress"));
+const cli_table_1 = tslib_1.__importDefault(require("./cli-table"));
 const message_handler_1 = tslib_1.__importDefault(require("./message-handler"));
 inquirer_1.default.registerPrompt('table', require('./inquirer-table-prompt'));
 /**
@@ -18,9 +20,6 @@ class CLIInterface {
     constructor() {
         this.loading = false;
     }
-    get uxTable() {
-        return core_1.ux.table;
-    }
     init(context) { }
     registerSearchPlugin() {
         inquirer_1.default.registerPrompt('search-list', require('inquirer-search-list'));
@@ -33,16 +32,16 @@ class CLIInterface {
                 chalkFn = chalkFn[opts.color];
             if (opts.bold)
                 chalkFn = chalkFn.bold;
-            core_1.ux.log(chalkFn(message_handler_1.default.parse(message)));
+            core_1.ux.stdout(chalkFn(message_handler_1.default.parse(message)));
             return;
         }
-        core_1.ux.log(message_handler_1.default.parse(message));
+        core_1.ux.stdout(message_handler_1.default.parse(message));
     }
     success(message) {
-        core_1.ux.log(chalk_1.default.green(message_handler_1.default.parse(message)));
+        core_1.ux.stdout(chalk_1.default.green(message_handler_1.default.parse(message)));
     }
     error(message, ...params) {
-        core_1.ux.log(chalk_1.default.red(message_handler_1.default.parse(message) + (params && params.length > 0 ? ': ' : '')), ...params);
+        core_1.ux.stdout(chalk_1.default.red(message_handler_1.default.parse(message) + (params && params.length > 0 ? ': ' : '')), ...params);
     }
     loader(message = '') {
         if (!this.loading) {
@@ -53,10 +52,8 @@ class CLIInterface {
         }
         this.loading = !this.loading;
     }
-    table(data, columns, options) {
-        core_1.ux.log('\n');
-        core_1.ux.table(data, columns, options);
-        core_1.ux.log('\n');
+    table(headers, data, flags, options) {
+        cli_table_1.default.render(headers, data, flags, options);
     }
     async inquire(inquirePayload) {
         if (Array.isArray(inquirePayload)) {
@@ -68,14 +65,22 @@ class CLIInterface {
             return result[inquirePayload.name];
         }
     }
-    prompt(name, options) {
-        return core_1.ux.prompt(name, options);
+    async prompt(message, options) {
+        return await this.inquire({
+            type: 'input',
+            name: 'prompt',
+            message,
+        });
     }
-    confirm(message) {
-        return core_1.ux.confirm(message);
+    async confirm(message) {
+        return await this.inquire({
+            type: 'confirm',
+            name: 'prompt',
+            message,
+        });
     }
     progress(options) {
-        return core_1.ux.progress(options);
+        return new cli_progress_1.default.SingleBar(options);
     }
     loaderV2(message = '', spinner) {
         if (!spinner) {

package/lib/helpers.d.ts

@@ -18,3 +18,10 @@ export declare const validateUids: (uid: any) => boolean;
 export declare const validateFileName: (fileName: any) => boolean;
 export declare const validateRegex: (str: unknown) => import("recheck").Diagnostics;
 export declare const formatError: (error: any) => any;
+/**
+ * The function redactObject takes an object as input and replaces any sensitive keys with the string
+ * '[REDACTED]'.
+ * @param {any} obj - The `obj` parameter is an object that you want to redact sensitive information
+ * from.
+ */
+export declare const redactObject: (obj: any) => any;

package/lib/helpers.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatError = exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.doesBranchExist = exports.isAuthenticated = void 0;
+exports.redactObject = exports.formatError = exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.doesBranchExist = exports.isAuthenticated = void 0;
 const tslib_1 = require("tslib");
 const recheck_1 = require("recheck");
+const traverse_1 = tslib_1.__importDefault(require("traverse"));
 const auth_handler_1 = tslib_1.__importDefault(require("./auth-handler"));
 const _1 = require(".");
 const isAuthenticated = () => auth_handler_1.default.isAuthenticated();
@@ -62,7 +63,12 @@ exports.validatePath = validatePath;
 const escapeRegExp = (str) => str === null || str === void 0 ? void 0 : str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
 exports.escapeRegExp = escapeRegExp;
 // To remove the relative path
-const sanitizePath = (str) => str === null || str === void 0 ? void 0 : str.replace(/^(\.\.(\/|\\|$))+/, '');
+const sanitizePath = (str) => {
+    if (typeof str !== 'string')
+        return;
+    const decodedStr = decodeURIComponent(str);
+    return decodedStr === null || decodedStr === void 0 ? void 0 : decodedStr.replace(/^([\/\\]){2,}/, "./").replace(/[\/\\]+/g, "/").replace(/(\.\.(\/|\\|$))+/g, ""); // Remove directory traversal (../ or ..\)
+};
 exports.sanitizePath = sanitizePath;
 // To validate the UIDs of assets
 const validateUids = (uid) => /^[a-zA-Z0-9]+$/.test(uid);
@@ -137,3 +143,45 @@ const formatError = function (error) {
     return message;
 };
 exports.formatError = formatError;
+/**
+ * The function checks if a given key string matches any of the sensitive keys defined in an array.
+ * @param {string} keyStr - The parameter `keyStr` is a string that represents a key.
+ * @returns a boolean value. It returns true if the keyStr matches any of the regular expressions in
+ * the sensitiveKeys array, and false otherwise.
+ */
+const isSensitiveKey = function (keyStr) {
+    if (keyStr && typeof keyStr === 'string') {
+        return sensitiveKeys.some((regex) => regex.test(keyStr));
+    }
+};
+/**
+ * The function redactObject takes an object as input and replaces any sensitive keys with the string
+ * '[REDACTED]'.
+ * @param {any} obj - The `obj` parameter is an object that you want to redact sensitive information
+ * from.
+ */
+const redactObject = function (obj) {
+    (0, traverse_1.default)(obj).forEach(function redactor() {
+        // Check if the current key is sensitive
+        if (isSensitiveKey(this.key)) {
+            // Update the current value with '[REDACTED]'
+            this.update('[REDACTED]');
+        }
+    });
+    return obj;
+};
+exports.redactObject = redactObject;
+/* The `sensitiveKeys` array is used to store regular expressions that match sensitive keys. These
+  keys are used to redact sensitive information from log messages. When logging an object, any keys
+  that match the regular expressions in the `sensitiveKeys` array will be replaced with the string
+  '[REDACTED]'. This helps to prevent sensitive information from being logged or displayed. */
+const sensitiveKeys = [
+    /authtoken/i,
+    /^email$/,
+    /^password$/i,
+    /secret/i,
+    /token/i,
+    /api[-._]?key/i,
+    /management[-._]?token/i,
+    /delivery[-._]?token/i,
+];

package/lib/index.d.ts

@@ -17,8 +17,9 @@ export * from './interfaces';
 export * from './date-time';
 export * from './add-locale';
 export * from './path-validator';
+export { default as CLITable, TableFlags, TableHeader, TableOptions, TableData } from './cli-table';
 export { App, AppData, Installation, marketplaceSDKClient, MarketplaceSDKInitiator, marketplaceSDKInitiator, ContentstackMarketplaceClient, ContentstackMarketplaceConfig, };
-export { Args, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase, HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable, Hook, Interfaces, Parser, Plugin, run, toStandardizedId, toConfiguredId, settings, Settings, flush, ux, execute, stderr, stdout, } from '@oclif/core';
+export { Args, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase, HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable, Hook, Interfaces, Parser, Plugin, run, toStandardizedId, toConfiguredId, settings, Settings, flush, ux, execute, } from '@oclif/core';
 export { FlagInput, ArgInput, FlagDefinition } from '@oclif/core/lib/interfaces/parser';
 export { default as TablePrompt } from './inquirer-table-prompt';
 export { Logger };

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.authenticationHandler = exports.Logger = exports.TablePrompt = exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.marketplaceSDKInitiator = exports.MarketplaceSDKInitiator = exports.marketplaceSDKClient = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
+exports.authenticationHandler = exports.Logger = exports.TablePrompt = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.run = exports.Plugin = exports.Parser = exports.Interfaces = exports.HelpBase = exports.Help = exports.loadHelpClass = exports.Flags = exports.Errors = exports.Config = exports.CommandHelp = exports.Args = exports.marketplaceSDKInitiator = exports.MarketplaceSDKInitiator = exports.marketplaceSDKClient = exports.CLITable = exports.Command = exports.flags = exports.args = exports.NodeCrypto = exports.printFlagDeprecation = exports.managementSDKInitiator = exports.managementSDKClient = exports.configHandler = exports.authHandler = exports.messageHandler = exports.CLIError = exports.cliux = exports.LoggerService = void 0;
 const tslib_1 = require("tslib");
 const logger_1 = tslib_1.__importDefault(require("./logger"));
 exports.Logger = logger_1.default;
@@ -38,6 +38,8 @@ tslib_1.__exportStar(require("./interfaces"), exports);
 tslib_1.__exportStar(require("./date-time"), exports);
 tslib_1.__exportStar(require("./add-locale"), exports);
 tslib_1.__exportStar(require("./path-validator"), exports);
+var cli_table_1 = require("./cli-table");
+Object.defineProperty(exports, "CLITable", { enumerable: true, get: function () { return tslib_1.__importDefault(cli_table_1).default; } });
 // NOTE Exporting all @oclif/core modules: So that all the module can be acessed through cli-utility
 var core_1 = require("@oclif/core");
 Object.defineProperty(exports, "Args", { enumerable: true, get: function () { return core_1.Args; } });
@@ -58,8 +60,6 @@ Object.defineProperty(exports, "settings", { enumerable: true, get: function ()
 Object.defineProperty(exports, "flush", { enumerable: true, get: function () { return core_1.flush; } });
 Object.defineProperty(exports, "ux", { enumerable: true, get: function () { return core_1.ux; } });
 Object.defineProperty(exports, "execute", { enumerable: true, get: function () { return core_1.execute; } });
-Object.defineProperty(exports, "stderr", { enumerable: true, get: function () { return core_1.stderr; } });
-Object.defineProperty(exports, "stdout", { enumerable: true, get: function () { return core_1.stdout; } });
 var inquirer_table_prompt_1 = require("./inquirer-table-prompt");
 Object.defineProperty(exports, "TablePrompt", { enumerable: true, get: function () { return tslib_1.__importDefault(inquirer_table_prompt_1).default; } });
 var authentication_handler_1 = require("./authentication-handler");

package/lib/interfaces/index.d.ts

@@ -1,4 +1,10 @@
-import { IPromptOptions } from '@oclif/core/lib/cli-ux';
+export interface IPromptOptions {
+    prompt?: string;
+    type?: 'normal' | 'mask' | 'hide' | 'single';
+    timeout?: number;
+    required?: boolean;
+    default?: string;
+}
 export interface PrintOptions {
     bold?: boolean;
     color?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.8.4",
+  "version": "1.10.0",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -34,10 +34,11 @@
   "dependencies": {
     "@contentstack/management": "~1.18.4",
     "@contentstack/marketplace-sdk": "^1.2.5",
-    "@oclif/core": "^3.27.0",
+    "@oclif/core": "^4.2.7",
     "axios": "^1.8.2",
     "chalk": "^4.1.2",
     "cli-cursor": "^3.1.0",
+    "cli-progress": "^3.12.0",
     "cli-table": "^0.3.11",
     "conf": "^10.2.0",
     "dotenv": "^16.4.7",
@@ -45,14 +46,17 @@
     "inquirer": "8.2.6",
     "inquirer-search-checkbox": "^1.0.0",
     "inquirer-search-list": "^1.2.6",
+    "js-yaml": "^4.1.0",
     "klona": "^2.0.6",
     "lodash": "^4.17.21",
     "mkdirp": "^1.0.4",
     "open": "^8.4.2",
     "ora": "^5.4.1",
+    "papaparse": "^5.5.2",
     "recheck": "~4.4.5",
     "rxjs": "^6.6.7",
     "traverse": "^0.6.11",
+    "tty-table": "^4.2.3",
     "unique-string": "^2.0.0",
     "uuid": "^9.0.1",
     "winston": "^3.17.0",
@@ -68,7 +72,7 @@
     "@types/traverse": "^0.6.37",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
-    "eslint-config-oclif": "^4.0.0",
+    "eslint-config-oclif": "^6.0.15",
     "eslint-config-oclif-typescript": "^3.1.14",
     "fancy-test": "^2.0.42",
     "mocha": "10.8.2",