@contentstack/cli-utilities 1.5.4 → 1.5.5

package/lib/index.d.ts

@@ -1,3 +1,4 @@
+import Logger from './logger';
 export { LoggerService } from './logger';
 export { default as cliux } from './cli-ux';
 export { default as CLIError } from './cli-error';
@@ -15,3 +16,4 @@ export * from './interfaces';
 export { Args, CommandHelp, Config, Errors, Flags, loadHelpClass, Help, HelpBase, HelpSection, HelpSectionRenderer, HelpSectionKeyValueTable, Hook, Interfaces, Parser, Plugin, run, toCached, tsPath, toStandardizedId, toConfiguredId, settings, Settings, flush, ux, execute, stderr, stdout, } from '@oclif/core';
 export { FlagInput, ArgInput } from '@oclif/core/lib/interfaces/parser';
 export { default as TablePrompt } from './inquirer-table-prompt';
+export { Logger };

package/lib/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TablePrompt = exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.tsPath = exports.toCached = 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.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.Logger = exports.TablePrompt = exports.stdout = exports.stderr = exports.execute = exports.ux = exports.flush = exports.settings = exports.toConfiguredId = exports.toStandardizedId = exports.tsPath = exports.toCached = 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.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");
-var logger_1 = require("./logger");
-Object.defineProperty(exports, "LoggerService", { enumerable: true, get: function () { return logger_1.LoggerService; } });
+const logger_1 = tslib_1.__importDefault(require("./logger"));
+exports.Logger = logger_1.default;
+var logger_2 = require("./logger");
+Object.defineProperty(exports, "LoggerService", { enumerable: true, get: function () { return logger_2.LoggerService; } });
 var cli_ux_1 = require("./cli-ux");
 Object.defineProperty(exports, "cliux", { enumerable: true, get: function () { return tslib_1.__importDefault(cli_ux_1).default; } });
 var cli_error_1 = require("./cli-error");

package/lib/logger.d.ts

@@ -1,4 +1,5 @@
-import winston from 'winston';
+import winston, { LogEntry } from 'winston';
+import { PrintOptions } from './index';
 export declare class LoggerService {
     name: string;
     data: object | null;
@@ -13,3 +14,68 @@ export declare class LoggerService {
     error(message: string, param?: any): Promise<any>;
     warn(message: string, param?: any): Promise<any>;
 }
+export type LogType = 'info' | 'warn' | 'error' | 'debug';
+export type LogsType = LogType | PrintOptions | undefined;
+export type MessageType = string | Error | Record<string, any> | Record<string, any>[];
+export default class Logger {
+    private logger;
+    private errorLogger;
+    private hiddenErrorLogger;
+    private config;
+    private sensitiveKeys;
+    /**
+     * The function returns an object with options for a file logger in the winston library.
+     * @returns an object of type `winston.transports.FileTransportOptions`.
+     */
+    get loggerOptions(): winston.transports.FileTransportOptions;
+    /**
+     * The constructor function initializes the class with a configuration object and creates logger
+     * instances.
+     * @param config - The `config` parameter is an object that contains various configuration options
+     * for the constructor. It is of type `Record<string, any>`, which means it can have any number of
+     * properties of any type.
+     */
+    constructor(config: Record<string, any>);
+    /**
+     * The function getLoggerInstance creates and returns a winston logger instance with specified log
+     * level and transports.
+     * @param {'error' | 'info' | 'hidden'} [level=info] - The `level` parameter is an optional parameter
+     * that specifies the logging level. It can have one of three values: 'error', 'info', or 'hidden'.
+     * The default value is 'info'.
+     * @returns an instance of the winston.Logger class.
+     */
+    getLoggerInstance(level?: 'error' | 'info' | 'hidden'): winston.Logger;
+    /**
+     * 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.
+     */
+    isSensitiveKey(keyStr: string): boolean;
+    /**
+     * 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.
+     */
+    redactObject(obj: any): void;
+    /**
+     * The redact function takes an object, creates a copy of it, redacts sensitive information from the
+     * copy, and returns the redacted copy.
+     * @param {any} obj - The `obj` parameter is of type `any`, which means it can accept any type of
+     * value. It is the object that needs to be redacted.
+     * @returns The `redact` function is returning a copy of the `obj` parameter with certain properties
+     * redacted.
+     */
+    redact(obj: any): any;
+    /**
+     * The function checks if an object is a LogEntry by verifying if it has the properties 'level' and
+     * 'message'.
+     * @param {any} obj - The `obj` parameter is of type `any`, which means it can be any type of value.
+     * @returns a boolean value.
+     */
+    isLogEntry(obj: any): obj is LogEntry;
+    log(entry: LogEntry): void;
+    log(message: MessageType, logType: LogsType): void;
+    log(message: MessageType, logType: 'error', hidden: boolean): void;
+}

package/lib/logger.js

@@ -2,9 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LoggerService = void 0;
 const tslib_1 = require("tslib");
+const traverse_1 = tslib_1.__importDefault(require("traverse"));
+const full_1 = require("klona/full");
+const path_1 = tslib_1.__importStar(require("path"));
 const winston_1 = tslib_1.__importDefault(require("winston"));
-const path_1 = tslib_1.__importDefault(require("path"));
-const message_handler_1 = tslib_1.__importDefault(require("./message-handler"));
+const index_1 = require("./index");
 class LoggerService {
     static dateFormat() {
         return new Date(Date.now()).toUTCString();
@@ -14,7 +16,6 @@ class LoggerService {
         this.name = null;
         const logger = winston_1.default.createLogger({
             transports: [
-                // new winston.transports.Console(),
                 new winston_1.default.transports.File({
                     filename: path_1.default.resolve(process.env.CS_CLI_LOG_PATH || `${pathToLog}/logs`, `${name}.log`),
                 }),
@@ -28,21 +29,18 @@ class LoggerService {
                     console.log('warning: failed to log the result');
                 }
                 // parse message
-                info.message = message_handler_1.default.parse(info.message);
+                info.message = index_1.messageHandler.parse(info.message);
                 let message = `${LoggerService.dateFormat()} : ${name}: ${info.level} : ${info.message}`;
                 message = info.obj ? message + `:${stringifiedParam}` : message;
                 message = this.data ? message + `:${JSON.stringify(this.data)}` : message;
                 return message;
             })),
-            // // level: (config.get('logger.level') as string) || 'error',
-            // level: 'error',
-            // silent: true
-            // silent: config.get('logger.enabled') && process.env.CLI_ENV !== 'TEST' ? false : false,
         });
         this.logger = logger;
     }
     init(context) {
-        this.name = (context && context.plugin && context.plugin.name) || 'cli';
+        var _a, _b;
+        this.name = (_b = (_a = context === null || context === void 0 ? void 0 : context.plugin) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : 'cli';
     }
     set loggerName(name) {
         this.name = name;
@@ -92,3 +90,152 @@ class LoggerService {
     }
 }
 exports.LoggerService = LoggerService;
+/* The Logger class is a TypeScript class that provides logging functionality using the winston
+library, with support for redacting sensitive information and different log levels. */
+class Logger {
+    /**
+     * The function returns an object with options for a file logger in the winston library.
+     * @returns an object of type `winston.transports.FileTransportOptions`.
+     */
+    get loggerOptions() {
+        return {
+            filename: '',
+            maxFiles: 20,
+            tailable: true,
+            maxsize: 1000000,
+        };
+    }
+    /**
+     * The constructor function initializes the class with a configuration object and creates logger
+     * instances.
+     * @param config - The `config` parameter is an object that contains various configuration options
+     * for the constructor. It is of type `Record<string, any>`, which means it can have any number of
+     * properties of any type.
+     */
+    constructor(config) {
+        /* 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. */
+        this.sensitiveKeys = [
+            /authtoken/i,
+            /^email$/,
+            /^password$/i,
+            /secret/i,
+            /token/i,
+            /api[-._]?key/i,
+            /management[-._]?token/i,
+        ];
+        this.config = config;
+        this.logger = this.getLoggerInstance();
+        this.errorLogger = this.getLoggerInstance('error');
+        this.hiddenErrorLogger = this.getLoggerInstance('hidden');
+    }
+    /**
+     * The function getLoggerInstance creates and returns a winston logger instance with specified log
+     * level and transports.
+     * @param {'error' | 'info' | 'hidden'} [level=info] - The `level` parameter is an optional parameter
+     * that specifies the logging level. It can have one of three values: 'error', 'info', or 'hidden'.
+     * The default value is 'info'.
+     * @returns an instance of the winston.Logger class.
+     */
+    getLoggerInstance(level = 'info') {
+        const filePath = (0, path_1.normalize)(process.env.CS_CLI_LOG_PATH || this.config.basePath).replace(/^(\.\.(\/|\\|$))+/, '');
+        const transports = [];
+        if (level !== 'hidden') {
+            transports.push(new winston_1.default.transports.Console({
+                format: winston_1.default.format.combine(winston_1.default.format.colorize({ all: true })),
+            }));
+        }
+        transports.push(new winston_1.default.transports.File(Object.assign(Object.assign({}, this.loggerOptions), { level: level === 'hidden' ? 'error' : level, filename: `${filePath}/${level === 'hidden' ? 'error' : level}.log` })));
+        return winston_1.default.createLogger({
+            levels: level === 'error' || level === 'hidden'
+                ? { error: 0 }
+                : {
+                    warn: 1,
+                    info: 2,
+                    debug: 3,
+                },
+            level,
+            transports,
+            format: winston_1.default.format.combine(winston_1.default.format((info) => this.redact(info))(), winston_1.default.format.errors({ stack: level === 'hidden' }), // NOTE keep stack only for the hidden type
+            winston_1.default.format.simple(), winston_1.default.format.timestamp(), winston_1.default.format.metadata()),
+        });
+    }
+    /**
+     * 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.
+     */
+    isSensitiveKey(keyStr) {
+        if (keyStr) {
+            return this.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.
+     */
+    redactObject(obj) {
+        const self = this;
+        (0, traverse_1.default)(obj).forEach(function redactor() {
+            if (self.isSensitiveKey(this.key)) {
+                this.update('[REDACTED]');
+            }
+        });
+    }
+    /**
+     * The redact function takes an object, creates a copy of it, redacts sensitive information from the
+     * copy, and returns the redacted copy.
+     * @param {any} obj - The `obj` parameter is of type `any`, which means it can accept any type of
+     * value. It is the object that needs to be redacted.
+     * @returns The `redact` function is returning a copy of the `obj` parameter with certain properties
+     * redacted.
+     */
+    redact(obj) {
+        const copy = (0, full_1.klona)(obj);
+        this.redactObject(copy);
+        const splat = copy[Symbol.for('splat')];
+        this.redactObject(splat);
+        return copy;
+    }
+    /**
+     * The function checks if an object is a LogEntry by verifying if it has the properties 'level' and
+     * 'message'.
+     * @param {any} obj - The `obj` parameter is of type `any`, which means it can be any type of value.
+     * @returns a boolean value.
+     */
+    isLogEntry(obj) {
+        return typeof obj === 'object' && 'level' in obj && 'message' in obj;
+    }
+    log(entryOrMessage, logType, hidden) {
+        if (this.isLogEntry(entryOrMessage)) {
+            this.logger.log(entryOrMessage);
+        }
+        else {
+            switch (logType) {
+                case 'info':
+                case 'debug':
+                case 'warn':
+                    this.logger.log(logType, entryOrMessage);
+                    break;
+                case 'error':
+                    if (hidden) {
+                        this.hiddenErrorLogger.error(entryOrMessage);
+                    }
+                    else {
+                        this.errorLogger.error(entryOrMessage);
+                        this.hiddenErrorLogger.error(entryOrMessage);
+                    }
+                    break;
+                default:
+                    index_1.cliux.print(entryOrMessage, logType || {});
+                    break;
+            }
+        }
+    }
+}
+exports.default = Logger;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.5.4",
+  "version": "1.5.5",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -32,9 +32,9 @@
   "author": "contentstack",
   "license": "MIT",
   "dependencies": {
-    "@contentstack/management": "~1.10.2",
+    "@contentstack/management": "~1.11.0",
     "@oclif/core": "^2.9.3",
-    "axios": "1.3.4",
+    "axios": "^1.6.0",
     "chalk": "^4.0.0",
     "cli-cursor": "^3.1.0",
     "cli-table": "^0.3.11",
@@ -44,11 +44,13 @@
     "inquirer": "8.2.4",
     "inquirer-search-checkbox": "^1.0.0",
     "inquirer-search-list": "^1.2.6",
-    "mkdirp": "^1.0.4",
+    "klona": "^2.0.6",
     "lodash": "^4.17.15",
+    "mkdirp": "^1.0.4",
     "open": "^8.4.2",
     "ora": "^5.4.0",
     "rxjs": "^6.6.7",
+    "traverse": "^0.6.7",
     "unique-string": "^2.0.0",
     "uuid": "^9.0.0",
     "winston": "^3.7.2",
@@ -62,6 +64,7 @@
     "@types/mocha": "^8.2.2",
     "@types/node": "^14.14.32",
     "@types/sinon": "^10.0.2",
+    "@types/traverse": "^0.6.34",
     "chai": "^4.3.4",
     "eslint": "^8.18.0",
     "eslint-config-oclif": "^4.0.0",