@contentstack/cli-utilities 1.17.4 → 2.0.0-beta

package/lib/progress-summary/summary-manager.js

@@ -0,0 +1,188 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+class SummaryManager {
+    constructor({ operationName, context }) {
+        this.modules = new Map();
+        this.operationName = operationName;
+        this.context = context;
+        this.operationStartTime = Date.now();
+        this.branchName = (context === null || context === void 0 ? void 0 : context.branchName) || '';
+    }
+    getModules() {
+        return this.modules;
+    }
+    registerModule(moduleName, totalItems = 0) {
+        this.modules.set(moduleName, {
+            name: moduleName,
+            status: 'pending',
+            totalItems,
+            successCount: 0,
+            failureCount: 0,
+            failures: [],
+            processes: [],
+        });
+    }
+    startModule(moduleName) {
+        const module = this.modules.get(moduleName);
+        if (module) {
+            module.status = 'running';
+            module.startTime = Date.now();
+        }
+    }
+    completeModule(moduleName, success = true, error) {
+        const module = this.modules.get(moduleName);
+        if (module) {
+            module.status = success ? 'completed' : 'failed';
+            module.endTime = Date.now();
+            if (!success && error) {
+                module.failures.push({ item: 'module', error });
+            }
+        }
+    }
+    /**
+     * Register process data for strategy calculations
+     */
+    registerProcessData(moduleName, processName, processData) {
+        const module = this.modules.get(moduleName);
+        if (module) {
+            if (!module.processes) {
+                module.processes = [];
+            }
+            const existingIndex = module.processes.findIndex((p) => p.processName === processName);
+            if (existingIndex >= 0) {
+                module.processes[existingIndex] = Object.assign({ processName }, processData);
+            }
+            else {
+                module.processes.push(Object.assign({ processName }, processData));
+            }
+        }
+    }
+    updateModuleProgress(moduleName, success, itemName, error) {
+        const module = this.modules.get(moduleName);
+        if (module) {
+            if (success) {
+                module.successCount++;
+            }
+            else {
+                module.failureCount++;
+                if (error) {
+                    module.failures.push({ item: itemName, error });
+                }
+            }
+        }
+    }
+    printFinalSummary() {
+        const operationEndTime = Date.now();
+        const totalDuration = operationEndTime - this.operationStartTime;
+        // Overall Statistics
+        const totalModules = this.modules.size;
+        const completedModules = Array.from(this.modules.values()).filter((m) => m.status === 'completed').length;
+        const failedModules = Array.from(this.modules.values()).filter((m) => m.status === 'failed').length;
+        const totalItems = Array.from(this.modules.values()).reduce((sum, m) => sum + m.successCount + m.failureCount, 0);
+        const totalSuccess = Array.from(this.modules.values()).reduce((sum, m) => sum + m.successCount, 0);
+        const totalFailures = Array.from(this.modules.values()).reduce((sum, m) => sum + m.failureCount, 0);
+        console.log('\n' + chalk_1.default.bold('='.repeat(80)));
+        console.log(chalk_1.default.bold(`${this.operationName} SUMMARY`));
+        console.log('\n' + chalk_1.default.bold('Overall Statistics:'));
+        console.log(`  Total ${this.operationName} Time: ${chalk_1.default.cyan(this.formatDuration(totalDuration))}`);
+        console.log(`  Modules Processed: ${chalk_1.default.cyan(completedModules)}/${chalk_1.default.cyan(totalModules)}`);
+        console.log(`  Items Processed: ${chalk_1.default.green(totalSuccess)} success, ${chalk_1.default.red(totalFailures)} failed of ${chalk_1.default.cyan(totalItems)} total`);
+        console.log(`  Success Rate: ${chalk_1.default.cyan(this.calculateSuccessRate(totalSuccess, totalItems))}%`);
+        // Module Details
+        console.log('\n' + chalk_1.default.bold('Module Details:'));
+        console.log(chalk_1.default.gray('-'.repeat(80)));
+        Array.from(this.modules.values()).forEach((module) => {
+            const status = this.getStatusIcon(module.status);
+            const totalCount = module.successCount + module.failureCount;
+            const duration = module.endTime && module.startTime ? this.formatDuration(module.endTime - module.startTime) : 'N/A';
+            const successRate = this.calculateSuccessRate(module.successCount, totalCount);
+            console.log(`${status} ${module.name.padEnd(20)} | ` +
+                `${String(module.successCount).padStart(4)}/${String(totalCount).padStart(4)} items | ` +
+                `${this.formatSuccessRate(successRate).padStart(6)} | ` +
+                `${duration.padStart(8)}`);
+        });
+        // Final Status
+        console.log('\n' + chalk_1.default.bold('Final Status:'));
+        if (!this.hasFailures() && failedModules === 0) {
+            console.log(chalk_1.default.bold.green(`✅ ${this.operationName} completed successfully!`));
+        }
+        else if (this.hasFailures() || failedModules > 0) {
+            console.log(chalk_1.default.bold.yellow(`⚠️ ${this.operationName} completed with failures, see the logs for more details.`));
+        }
+        else {
+            console.log(chalk_1.default.bold.red(`❌ ${this.operationName} failed`));
+        }
+        console.log(chalk_1.default.bold('='.repeat(80)));
+        console.log(chalk_1.default.bold('='.repeat(80)));
+        // Simple failure summary with log reference
+        this.printFailureSummaryWithLogReference();
+    }
+    /**
+     * Check if there are any failures across all modules
+     */
+    hasFailures() {
+        return Array.from(this.modules.values()).some((m) => m.failures.length > 0 || m.failureCount > 0);
+    }
+    printFailureSummaryWithLogReference() {
+        const modulesWithFailures = Array.from(this.modules.values()).filter((m) => m.failures.length > 0);
+        if (modulesWithFailures.length === 0)
+            return;
+        const totalFailures = modulesWithFailures.reduce((sum, m) => sum + m.failures.length, 0);
+        console.log('\n' + chalk_1.default.bold.red('Failure Summary:'));
+        console.log(chalk_1.default.red('-'.repeat(50)));
+        modulesWithFailures.forEach((module) => {
+            console.log(`${chalk_1.default.bold.red('✗')} ${chalk_1.default.bold(module.name)}: ${chalk_1.default.red(module.failures.length)} failures`);
+            // Show just first 2-3 failures briefly
+            const preview = module.failures.slice(0, 2);
+            preview.forEach((failure) => {
+                console.log(`    • ${chalk_1.default.gray(failure.item)}`);
+            });
+            if (module.failures.length > 2) {
+                console.log(`    ${chalk_1.default.gray(`... and ${module.failures.length - 2} more`)}`);
+            }
+        });
+        console.log(chalk_1.default.blue('\n📋 For detailed error information, check the log files:'));
+        //console.log(chalk.blue(`   ${getSessionLogPath()}`));
+        console.log(chalk_1.default.gray('   Recent errors are logged with full context and stack traces.'));
+    }
+    getStatusIcon(status) {
+        switch (status) {
+            case 'completed':
+                return chalk_1.default.green('✓');
+            case 'failed':
+                return chalk_1.default.red('✗');
+            case 'running':
+                return chalk_1.default.yellow('●');
+            case 'pending':
+                return chalk_1.default.gray('○');
+            default:
+                return chalk_1.default.gray('?');
+        }
+    }
+    formatDuration(ms) {
+        if (ms < 1000)
+            return `${ms}ms`;
+        if (ms < 60000)
+            return `${(ms / 1000).toFixed(1)}s`;
+        return `${(ms / 60000).toFixed(1)}m`;
+    }
+    calculateSuccessRate(success, total) {
+        if (total === 0)
+            return '0';
+        return ((success / total) * 100).toFixed(1);
+    }
+    formatSuccessRate(rate) {
+        if (rate === '100.0') {
+            return '100%';
+        }
+        else if (parseFloat(rate) >= 10) {
+            return `${rate}%`;
+        }
+        else {
+            return ` ${rate}%`;
+        }
+    }
+}
+exports.default = SummaryManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.17.4",
+  "version": "2.0.0-beta",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",

package/lib/flag-deprecation-check.d.ts

@@ -1,7 +0,0 @@
-/**
- * checks the deprecation and prints it
- * @param {Array} deprecatedFlags flags to be deprecated
- * @param {String} customMessage [optional] a custom message
- * @returns flag parser
- */
-export default function (deprecatedFlags?: any[], suggestions?: any[], customMessage?: string): (input: any, command: any) => any;

package/lib/flag-deprecation-check.js

@@ -1,40 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const cli_ux_1 = tslib_1.__importDefault(require("./cli-ux"));
-/**
- * checks the deprecation and prints it
- * @param {Array} deprecatedFlags flags to be deprecated
- * @param {String} customMessage [optional] a custom message
- * @returns flag parser
- */
-function default_1(deprecatedFlags = [], suggestions = [], customMessage) {
-    return (input, command) => {
-        const { context: { flagWarningPrintState = {} } = {} } = command;
-        let isCommandHasDeprecationFlag = false;
-        deprecatedFlags.forEach((item) => {
-            if (command.argv.indexOf(item) !== -1) {
-                if (flagWarningPrintState[command.id + item]) {
-                    return input;
-                }
-                flagWarningPrintState[command.id + item] = true;
-                isCommandHasDeprecationFlag = true;
-            }
-        });
-        if (isCommandHasDeprecationFlag) {
-            let deprecationMessage = '';
-            if (customMessage) {
-                deprecationMessage = customMessage;
-            }
-            else {
-                deprecationMessage = `WARNING!!! You're using the old (soon to be deprecated) Contentstack CLI flags (${deprecatedFlags.join(', ')}).`;
-                if (suggestions.length > 0) {
-                    deprecationMessage += ` We recommend you to use the updated flags (${suggestions.join(', ')}).`;
-                }
-            }
-            cli_ux_1.default.print(deprecationMessage, { color: 'yellow' });
-        }
-        return input;
-    };
-}
-exports.default = default_1;