@contentstack/cli-utilities 1.17.0 → 1.17.2

package/lib/auth-handler.d.ts

@@ -21,7 +21,6 @@ declare class AuthHandler {
     private authorisationTypeOAUTHValue;
     private authorisationTypeAUTHValue;
     private allAuthConfigItems;
-    private logger;
     private oauthHandler;
     private managementAPIClient;
     private isRefreshingToken;
@@ -29,7 +28,6 @@ declare class AuthHandler {
     set host(contentStackHost: any);
     constructor();
     private getCmaHost;
-    initLog(): void;
     setOAuthBaseURL(): Promise<void>;
     initSDK(): Promise<void>;
     oauth(): Promise<void>;

package/lib/auth-handler.js

@@ -7,7 +7,7 @@ const dotenv_1 = tslib_1.__importDefault(require("dotenv"));
 const open_1 = tslib_1.__importDefault(require("open"));
 const http_1 = tslib_1.__importDefault(require("http"));
 const url_1 = tslib_1.__importDefault(require("url"));
-const logger_1 = require("./logger");
+const log_1 = require("./logger/log");
 const contentstack_management_sdk_1 = tslib_1.__importDefault(require("./contentstack-management-sdk"));
 const helpers_1 = require("./helpers");
 dotenv_1.default.config();
@@ -77,9 +77,6 @@ class AuthHandler {
         }
         return cma;
     }
-    initLog() {
-        this.logger = new logger_1.LoggerService(process.cwd(), 'cli-log');
-    }
     async setOAuthBaseURL() {
         if (config_handler_1.default.get('region')['uiHost']) {
             this.OAuthBaseURL = config_handler_1.default.get('region')['uiHost'] || '';
@@ -108,13 +105,12 @@ class AuthHandler {
      */
     async oauth() {
         try {
-            this.initLog();
             await this.initSDK();
             await this.createHTTPServer();
             await this.openOAuthURL();
         }
         catch (error) {
-            this.logger.error('OAuth login failed!', error.message);
+            (0, log_1.handleAndLogError)(error, { module: 'auth-handler' }, 'OAuth login failed!');
             throw error;
         }
     }
@@ -375,6 +371,7 @@ class AuthHandler {
         else {
             cli_ux_1.default.print('No OAuth configuration set.');
             this.unsetConfigData();
+            return Promise.resolve();
         }
     }
     restoreOAuthConfig() {

package/lib/constants/logging.d.ts

@@ -13,3 +13,4 @@ export declare const levelColors: {
     info: string;
     debug: string;
 };
+export declare const PROGRESS_SUPPORTED_MODULES: readonly ["export", "import", "audit", "import-setup"];

package/lib/constants/logging.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.levelColors = exports.logLevels = void 0;
+exports.PROGRESS_SUPPORTED_MODULES = exports.levelColors = exports.logLevels = void 0;
 exports.logLevels = {
     error: 0,
     warn: 1,
     info: 2,
     success: 2,
     debug: 3,
-    verbose: 4
+    verbose: 4,
 };
 // 2. Create color mappings (for console only)
 exports.levelColors = {
@@ -15,5 +15,6 @@ exports.levelColors = {
     warn: 'yellow',
     success: 'green',
     info: 'white',
-    debug: 'blue'
+    debug: 'blue',
 };
+exports.PROGRESS_SUPPORTED_MODULES = ['export', 'import', 'audit', 'import-setup'];

package/lib/fs-utility/core.js

@@ -11,7 +11,6 @@ const node_fs_1 = require("node:fs");
 const helper_1 = require("./helper");
 class FsUtility {
     constructor(options = {}) {
-        var _a;
         this.isArray = false;
         this.prefixKey = '';
         this.currentFileName = '';
@@ -35,7 +34,7 @@ class FsUtility {
         this.metaPickKeys = metaPickKeys || [];
         this.moduleName = moduleName || 'chunk';
         this.chunkFileSize = chunkFileSize || 10;
-        this.keepMetadata = keepMetadata || ((_a = keepMetadata === undefined) !== null && _a !== void 0 ? _a : true);
+        this.keepMetadata = keepMetadata !== null && keepMetadata !== void 0 ? keepMetadata : true;
         this.indexFileName = indexFileName || 'index.json';
         this.pageInfo.hasNextPage = (0, keys_1.default)(this.indexFileContent).length > 0;
         this.defaultInitContent = defaultInitContent || this.isArray ? '[' : this.fileExt === 'json' ? '{' : '';

package/lib/helpers.d.ts

@@ -27,6 +27,7 @@ export declare const formatError: (error: any) => string;
  * from.
  */
 export declare const redactObject: (obj: any) => any;
+export declare function clearProgressModuleSetting(): void;
 /**
  * Get authentication method from config
  * @returns Authentication method string ('OAuth', 'Basic Auth', or empty string)

package/lib/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createLogContext = exports.getAuthenticationMethod = exports.redactObject = exports.formatError = exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.getBranchFromAlias = exports.doesBranchExist = exports.isAuthenticated = void 0;
+exports.createLogContext = exports.getAuthenticationMethod = exports.clearProgressModuleSetting = exports.redactObject = exports.formatError = exports.validateRegex = exports.validateFileName = exports.validateUids = exports.sanitizePath = exports.escapeRegExp = exports.validatePath = exports.createDeveloperHubUrl = exports.isManagementTokenValid = exports.getBranchFromAlias = exports.doesBranchExist = exports.isAuthenticated = void 0;
 const tslib_1 = require("tslib");
 const recheck_1 = require("recheck");
 const traverse_1 = tslib_1.__importDefault(require("traverse"));
@@ -191,8 +191,8 @@ const formatError = function (error) {
     // If message is in JSON format, parse it to extract the actual message string
     try {
         const parsedMessage = JSON.parse(message);
-        if (typeof parsedMessage === 'object') {
-            message = (parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.message) || message;
+        if (typeof parsedMessage === 'object' && parsedMessage !== null) {
+            message = (parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.message) || (parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.errorMessage) || (parsedMessage === null || parsedMessage === void 0 ? void 0 : parsedMessage.error) || message;
         }
     }
     catch (e) {
@@ -244,6 +244,14 @@ const sensitiveKeys = [
     /management[-._]?token/i,
     /delivery[-._]?token/i,
 ];
+function clearProgressModuleSetting() {
+    const logConfig = _1.configHandler.get('log') || {};
+    if (logConfig === null || logConfig === void 0 ? void 0 : logConfig.progressSupportedModule) {
+        delete logConfig.progressSupportedModule;
+        _1.configHandler.set('log', logConfig);
+    }
+}
+exports.clearProgressModuleSetting = clearProgressModuleSetting;
 /**
  * Get authentication method from config
  * @returns Authentication method string ('OAuth', 'Basic Auth', or empty string)

package/lib/index.d.ts

@@ -26,3 +26,4 @@ export { default as TablePrompt } from './inquirer-table-prompt';
 export { Logger };
 export { default as authenticationHandler } from './authentication-handler';
 export { v2Logger as log, cliErrorHandler, handleAndLogError, getLogPath } from './logger/log';
+export { CLIProgressManager, SummaryManager, PrimaryProcessStrategy, ProgressStrategyRegistry, CustomProgressStrategy, DefaultProgressStrategy } from './progress-summary';

package/lib/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogPath = exports.handleAndLogError = exports.cliErrorHandler = exports.log = 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.createLogContext = 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.DefaultProgressStrategy = exports.CustomProgressStrategy = exports.ProgressStrategyRegistry = exports.PrimaryProcessStrategy = exports.SummaryManager = exports.CLIProgressManager = exports.getLogPath = exports.handleAndLogError = exports.cliErrorHandler = exports.log = 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.createLogContext = 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;
@@ -71,3 +71,10 @@ Object.defineProperty(exports, "log", { enumerable: true, get: function () { ret
 Object.defineProperty(exports, "cliErrorHandler", { enumerable: true, get: function () { return log_1.cliErrorHandler; } });
 Object.defineProperty(exports, "handleAndLogError", { enumerable: true, get: function () { return log_1.handleAndLogError; } });
 Object.defineProperty(exports, "getLogPath", { enumerable: true, get: function () { return log_1.getLogPath; } });
+var progress_summary_1 = require("./progress-summary");
+Object.defineProperty(exports, "CLIProgressManager", { enumerable: true, get: function () { return progress_summary_1.CLIProgressManager; } });
+Object.defineProperty(exports, "SummaryManager", { enumerable: true, get: function () { return progress_summary_1.SummaryManager; } });
+Object.defineProperty(exports, "PrimaryProcessStrategy", { enumerable: true, get: function () { return progress_summary_1.PrimaryProcessStrategy; } });
+Object.defineProperty(exports, "ProgressStrategyRegistry", { enumerable: true, get: function () { return progress_summary_1.ProgressStrategyRegistry; } });
+Object.defineProperty(exports, "CustomProgressStrategy", { enumerable: true, get: function () { return progress_summary_1.CustomProgressStrategy; } });
+Object.defineProperty(exports, "DefaultProgressStrategy", { enumerable: true, get: function () { return progress_summary_1.DefaultProgressStrategy; } });

package/lib/interfaces/index.d.ts

@@ -1,4 +1,5 @@
-import { logLevels } from "../constants/logging";
+import { logLevels } from '../constants/logging';
+import ProgressBar from 'cli-progress';
 export interface IPromptOptions {
     prompt?: string;
     type?: 'normal' | 'mask' | 'hide' | 'single';
@@ -101,3 +102,51 @@ export interface ErrorContextBase {
 export type ErrorContext = ErrorContextBase & {
     [key: string]: unknown;
 };
+export interface Failure {
+    item: string;
+    error: string | null;
+    process?: string;
+}
+export interface ProcessProgress {
+    name: string;
+    total: number;
+    current: number;
+    status: 'pending' | 'active' | 'completed' | 'failed';
+    successCount: number;
+    failureCount: number;
+    failures: Failure[];
+    progressBar?: ProgressBar.SingleBar;
+}
+export interface ProgressManagerOptions {
+    showConsoleLogs?: boolean;
+    total?: number;
+    moduleName?: string;
+    enableNestedProgress?: boolean;
+}
+export interface ModuleResult {
+    name: string;
+    status: 'pending' | 'running' | 'completed' | 'failed';
+    startTime?: number;
+    endTime?: number;
+    totalItems: number;
+    successCount: number;
+    failureCount: number;
+    failures: Array<{
+        item: string;
+        error: string;
+    }>;
+    processes?: Array<{
+        processName: string;
+        [key: string]: any;
+    }>;
+}
+export interface SummaryOptions {
+    operationName: string;
+    context?: any;
+    branchName?: string;
+}
+export interface ProgressResult {
+    total: number;
+    success: number;
+    failures: number;
+}

package/lib/logger/cli-error-handler.js

@@ -114,8 +114,7 @@ class CLIErrorHandler {
         if (typeof error === 'object') {
             try {
                 const errorObj = error;
-                const message = errorObj.message || errorObj.error || errorObj.statusText || 'Unknown error';
-                const normalizedError = new Error(message);
+                const normalizedError = new Error('Error occurred');
                 // Only copy essential properties
                 const essentialProps = [
                     'code',

package/lib/logger/log.js

@@ -13,7 +13,7 @@ function createLoggerInstance() {
     var _a;
     const logConfig = __1.configHandler.get('log');
     const logLevel = (logConfig === null || logConfig === void 0 ? void 0 : logConfig.level) || 'info';
-    const showConsoleLogs = (_a = logConfig === null || logConfig === void 0 ? void 0 : logConfig['show-console-logs']) !== null && _a !== void 0 ? _a : false;
+    const showConsoleLogs = (_a = logConfig === null || logConfig === void 0 ? void 0 : logConfig.showConsoleLogs) !== null && _a !== void 0 ? _a : false;
     const config = {
         basePath: getLogPath(),
         logLevel: logLevel,

package/lib/logger/logger.js

@@ -6,6 +6,7 @@ const full_1 = require("klona/full");
 const path_1 = require("path");
 const winston = tslib_1.__importStar(require("winston"));
 const logging_1 = require("../constants/logging");
+const __1 = require("..");
 const session_path_1 = require("./session-path");
 class Logger {
     constructor(config) {
@@ -46,26 +47,45 @@ class Logger {
         };
     }
     createLogger(level, filePath) {
+        var _a;
+        const transports = [
+            new winston.transports.File(Object.assign(Object.assign({}, this.loggerOptions), { filename: `${filePath}/${level}.log`, format: winston.format.combine(winston.format.timestamp(), winston.format.printf((info) => {
+                    // Apply minimal redaction for files (debugging info preserved)
+                    const redactedInfo = this.redact(info, false);
+                    return JSON.stringify(redactedInfo);
+                })) })),
+        ];
+        // Determine console logging based on configuration
+        let showConsoleLogs = true;
+        if (__1.configHandler && typeof __1.configHandler.get === 'function') {
+            const logConfig = __1.configHandler.get('log') || {};
+            const currentModule = logConfig.progressSupportedModule;
+            const hasProgressSupport = currentModule && logging_1.PROGRESS_SUPPORTED_MODULES.includes(currentModule);
+            if (hasProgressSupport) {
+                // Plugin has progress bars - respect user's explicit setting, or default to false (show progress bars)
+                showConsoleLogs = (_a = logConfig.showConsoleLogs) !== null && _a !== void 0 ? _a : false;
+            }
+            else {
+                // Plugin doesn't have progress support - always show console logs
+                showConsoleLogs = true;
+            }
+        }
+        if (showConsoleLogs) {
+            transports.push(new winston.transports.Console({
+                format: winston.format.combine(winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), winston.format.printf((info) => {
+                    // Apply full redaction for console (user-facing)
+                    const redactedInfo = this.redact(info, true);
+                    const colorizer = winston.format.colorize();
+                    const levelText = redactedInfo.level.toUpperCase();
+                    const { timestamp, message } = redactedInfo;
+                    return colorizer.colorize(redactedInfo.level, `[${timestamp}] ${levelText}: ${message}`);
+                })),
+            }));
+        }
         return winston.createLogger({
             levels: logging_1.logLevels,
             level,
-            transports: [
-                new winston.transports.File(Object.assign(Object.assign({}, this.loggerOptions), { filename: `${filePath}/${level}.log`, format: winston.format.combine(winston.format.timestamp(), winston.format.printf((info) => {
-                        // Apply minimal redaction for files (debugging info preserved)
-                        const redactedInfo = this.redact(info, false);
-                        return JSON.stringify(redactedInfo);
-                    })) })),
-                new winston.transports.Console({
-                    format: winston.format.combine(winston.format.timestamp({ format: 'YYYY-MM-DD HH:mm:ss' }), winston.format.printf((info) => {
-                        // Apply full redaction for console (user-facing)
-                        const redactedInfo = this.redact(info, true);
-                        const colorizer = winston.format.colorize();
-                        const levelText = redactedInfo.level.toUpperCase();
-                        const { timestamp, message } = redactedInfo;
-                        return colorizer.colorize(redactedInfo.level, `[${timestamp}] ${levelText}: ${message}`);
-                    })),
-                }),
-            ],
+            transports,
         });
     }
     isSensitiveKey(keyStr, consoleMode = false) {

package/lib/progress-summary/cli-progress-manager.d.ts

@@ -0,0 +1,125 @@
+import SummaryManager from './summary-manager';
+import { ProgressManagerOptions } from '../interfaces';
+interface ProgressCallback {
+    onModuleStart?: (moduleName: string) => void;
+    onModuleComplete?: (moduleName: string, success: boolean, error?: string) => void;
+    onProgress?: (moduleName: string, success: boolean, itemName: string, error?: string) => void;
+}
+export default class CLIProgressManager {
+    private static globalSummary;
+    private showConsoleLogs;
+    private total;
+    private moduleName;
+    private enableNestedProgress;
+    private successCount;
+    private failureCount;
+    private failures;
+    private spinner;
+    private progressBar;
+    private processes;
+    private multiBar;
+    private currentProcess;
+    private callbacks;
+    private branchName;
+    constructor({ showConsoleLogs, total, moduleName, enableNestedProgress, }?: ProgressManagerOptions);
+    /**
+     * Initialize global summary manager for the entire operation
+     */
+    static initializeGlobalSummary(operationName: string, branchName: string, headerTitle?: string): SummaryManager;
+    /**
+     * Display operation header with branch information
+     */
+    static displayOperationHeader(branchName: string, headerTitle?: string): void;
+    /**
+     * Print the final summary for all modules using strategies
+     */
+    static printGlobalSummary(): void;
+    /**
+     * Check if there are any failures in the global summary
+     */
+    static hasFailures(): boolean;
+    /**
+     * Apply strategy-based corrections to module data
+     */
+    private static applyStrategyCorrections;
+    /**
+     * Clear global summary (for cleanup)
+     */
+    static clearGlobalSummary(): void;
+    /**
+     * Create a simple progress manager (no nested processes)
+     */
+    static createSimple(moduleName: string, total?: number, showConsoleLogs?: boolean): CLIProgressManager;
+    /**
+     * Create a nested progress manager (with sub-processes)
+     */
+    static createNested(moduleName: string, showConsoleLogs?: boolean): CLIProgressManager;
+    /**
+     * Show a loading spinner before initializing progress
+     */
+    static withLoadingSpinner<T>(message: string, asyncOperation: () => Promise<T>): Promise<T>;
+    private setupGlobalSummaryIntegration;
+    /**
+     * Register process data with summary manager for strategy calculations
+     */
+    private registerProcessDataWithSummary;
+    /**
+     * Set callbacks for external integration
+     */
+    setCallbacks(callbacks: ProgressCallback): void;
+    /**
+     * Convert module name from UPPERCASE to PascalCase
+     */
+    private formatModuleName;
+    /**
+     * Format process name with smart truncation (modules should use short names)
+     */
+    private formatProcessName;
+    /**
+     * Format percentage for consistent alignment (always 3 characters)
+     */
+    private formatPercentage;
+    private initializeProgress;
+    /**
+     * Add a new process to track (for nested progress)
+     */
+    addProcess(processName: string, total: number): this;
+    /**
+     * Update the total for a specific process (for dynamic totals after API calls)
+     */
+    updateProcessTotal(processName: string, newTotal: number): this;
+    /**
+     * Start a specific process
+     */
+    startProcess(processName: string): this;
+    /**
+     * Complete a specific process
+     */
+    completeProcess(processName: string, success?: boolean): this;
+    /**
+     * Update status message
+     */
+    updateStatus(message: string, processName?: string): this;
+    /**
+     * Update progress
+     */
+    tick(success?: boolean, itemName?: string, errorMessage?: string | null, processName?: string): this;
+    /**
+     * Complete the entire module
+     */
+    complete(success?: boolean, error?: string): this;
+    /**
+     * Log message (respects showConsoleLogs mode)
+     */
+    log(msg: string): void;
+    /**
+     * Stop all progress indicators
+     */
+    stop(): void;
+    private printSummary;
+    /**
+     * Get the current failure count
+     */
+    getFailureCount(): number;
+}
+export {};