@contentstack/cli-utilities 1.13.2 → 1.14.1

package/lib/authentication-handler.js

@@ -26,16 +26,17 @@ class AuthenticationHandler {
                         index_1.cliux.print('Session timed out, please login to proceed', {
                             color: 'yellow',
                         });
-                        process.exit(1);
+                        throw new Error('Session timed out, please login to proceed');
                     }
                     break;
             }
         }
         catch (error) {
-            index_1.cliux.print(`Error occurred while fetching auth details: ${error.message}`, {
+            const formattedError = (0, index_1.formatError)(error);
+            index_1.cliux.print(`Error occurred while fetching auth details: ${formattedError}`, {
                 color: 'red',
             });
-            process.exit(1);
+            throw error;
         }
     }
     get isOauthEnabled() {
@@ -48,6 +49,7 @@ class AuthenticationHandler {
         return this.token;
     }
     async refreshAccessToken(error, maxRetryCount = 1) {
+        var _a, _b;
         // Add configurable delay only for CI/CD pipelines
         const delayMs = process.env.DELAY_MS;
         if (delayMs) {
@@ -71,7 +73,8 @@ class AuthenticationHandler {
                         if (refreshed) {
                             return this.refreshAccessToken(error, maxRetryCount); // Retry after refreshing the token
                         }
-                        console.log('API(401) case error:-', error.response);
+                        const errorDetails = (0, index_1.formatError)(error);
+                        index_1.cliux.print(`Authentication failed: ${errorDetails}`, { color: 'red' });
                         // For Basic Auth, exit immediately without retrying
                         return;
                     }
@@ -79,10 +82,12 @@ class AuthenticationHandler {
                 case 429:
                 case 408:
                     if (maxRetryCount >= 3) {
-                        index_1.cliux.print('Max retry count reached, please login to proceed', {
-                            color: 'yellow',
-                        });
-                        process.exit(1);
+                        const errorDetails = (0, index_1.formatError)(error);
+                        const statusText = ((_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.status) === 429 ? 'Rate Limited' : 'Request Timeout';
+                        index_1.cliux.print(`Max retry attempts exceeded (${maxRetryCount}/3)`, { color: 'red' });
+                        index_1.cliux.print(`Status: ${(_b = error === null || error === void 0 ? void 0 : error.response) === null || _b === void 0 ? void 0 : _b.status} - ${statusText}`, { color: 'yellow' });
+                        index_1.cliux.print(`Error: ${errorDetails}`, { color: 'white' });
+                        return;
                     }
                     maxRetryCount++; // Increment for the next retry attempt
                     // These cases require a wait, adding a delay before retrying
@@ -99,7 +104,9 @@ class AuthenticationHandler {
                 index_1.cliux.print('Session timed out, please login to proceed', {
                     color: 'yellow',
                 });
-                process.exit();
+                index_1.cliux.print('\nTo fix this:', { color: 'cyan' });
+                index_1.cliux.print('• Run: "csdx auth:login"', { color: 'white' });
+                resolve(false);
             }
             else if (this.authType === 'OAUTH') {
                 index_1.authHandler.host = hostName;
@@ -111,7 +118,9 @@ class AuthenticationHandler {
                     resolve(true);
                 })
                     .catch((error) => {
-                    console.log(error);
+                    const errorDetails = (0, index_1.formatError)(error);
+                    index_1.cliux.print('OAuth Token Refresh Failed', { color: 'red' });
+                    index_1.cliux.print(`Error: ${errorDetails}`, { color: 'white' });
                     resolve(false);
                 });
             }
@@ -119,7 +128,7 @@ class AuthenticationHandler {
                 index_1.cliux.print('You do not have the permissions to perform this action, please login to proceed', {
                     color: 'yellow',
                 });
-                process.exit();
+                resolve(false);
             }
         });
     }

package/lib/helpers.d.ts

@@ -1,5 +1,7 @@
+import { ContentstackClient } from '.';
 export declare const isAuthenticated: () => boolean;
 export declare const doesBranchExist: (stack: any, branchName: any) => Promise<any>;
+export declare const getBranchFromAlias: (stack: ReturnType<ContentstackClient['stack']>, branchAlias: string) => Promise<string>;
 export declare const isManagementTokenValid: (stackAPIKey: any, managementToken: any) => Promise<{
     valid: boolean;
     message?: undefined;
@@ -17,7 +19,7 @@ export declare const sanitizePath: (str: string) => string;
 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;
+export declare const formatError: (error: any) => string;
 /**
  * The function redactObject takes an object as input and replaces any sensitive keys with the string
  * '[REDACTED]'.

package/lib/helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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"));
@@ -17,6 +17,22 @@ const doesBranchExist = async (stack, branchName) => {
     });
 };
 exports.doesBranchExist = doesBranchExist;
+const getBranchFromAlias = async (stack, branchAlias) => {
+    if (!stack || !branchAlias || typeof branchAlias !== 'string') {
+        throw new Error('Invalid input. Both stack and branch alias are required.');
+    }
+    try {
+        const response = await stack.branchAlias(branchAlias).fetch();
+        if (!(response === null || response === void 0 ? void 0 : response.uid)) {
+            throw new Error(`Invalid Branch Alias. No Branch found for the branch alias: ${branchAlias}`);
+        }
+        return response.uid;
+    }
+    catch (error) {
+        throw error;
+    }
+};
+exports.getBranchFromAlias = getBranchFromAlias;
 const isManagementTokenValid = async (stackAPIKey, managementToken) => {
     var _a;
     const httpClient = new _1.HttpClient({ headers: { api_key: stackAPIKey, authorization: managementToken } });
@@ -86,7 +102,7 @@ const validateRegex = (str) => {
 };
 exports.validateRegex = validateRegex;
 const formatError = function (error) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f;
     let parsedError;
     // Parse the error
     try {
@@ -103,6 +119,26 @@ const formatError = function (error) {
     catch (e) {
         parsedError = error;
     }
+    // Helper function to append error details
+    const appendErrorDetails = (message, errorObj) => {
+        if (errorObj.errors && typeof errorObj.errors === 'object' && Object.keys(errorObj.errors).length > 0) {
+            const entityNames = {
+                authorization: 'Authentication',
+                api_key: 'Stack API key',
+                uid: 'Content Type',
+                access_token: 'Delivery Token',
+            };
+            const errorList = Object.entries(errorObj.errors)
+                .map(([field, errors]) => {
+                const errorArray = Array.isArray(errors) ? errors : [errors];
+                const fieldName = entityNames[field] || field;
+                return `  • ${fieldName}: ${errorArray.join(', ')}`;
+            })
+                .join('\n');
+            return `${message}\n\nError Details:\n${errorList}\n`;
+        }
+        return message;
+    };
     if (parsedError && typeof parsedError === 'object' && Object.keys(parsedError).length === 0) {
         if (!parsedError.message &&
             !parsedError.code &&
@@ -113,21 +149,21 @@ const formatError = function (error) {
         }
     }
     if ((_b = (_a = parsedError === null || parsedError === void 0 ? void 0 : parsedError.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.errorMessage) {
-        return parsedError.response.data.errorMessage;
+        return appendErrorDetails(parsedError.response.data.errorMessage, ((_c = parsedError === null || parsedError === void 0 ? void 0 : parsedError.response) === null || _c === void 0 ? void 0 : _c.data) || parsedError);
     }
     if (parsedError === null || parsedError === void 0 ? void 0 : parsedError.errorMessage) {
-        return parsedError.errorMessage;
+        return appendErrorDetails(parsedError.errorMessage, parsedError);
     }
-    const status = (parsedError === null || parsedError === void 0 ? void 0 : parsedError.status) || ((_c = parsedError === null || parsedError === void 0 ? void 0 : parsedError.response) === null || _c === void 0 ? void 0 : _c.status);
-    const errorCode = (parsedError === null || parsedError === void 0 ? void 0 : parsedError.errorCode) || ((_e = (_d = parsedError === null || parsedError === void 0 ? void 0 : parsedError.response) === null || _d === void 0 ? void 0 : _d.data) === null || _e === void 0 ? void 0 : _e.errorCode);
+    const status = (parsedError === null || parsedError === void 0 ? void 0 : parsedError.status) || ((_d = parsedError === null || parsedError === void 0 ? void 0 : parsedError.response) === null || _d === void 0 ? void 0 : _d.status);
+    const errorCode = (parsedError === null || parsedError === void 0 ? void 0 : parsedError.errorCode) || ((_f = (_e = parsedError === null || parsedError === void 0 ? void 0 : parsedError.response) === null || _e === void 0 ? void 0 : _e.data) === null || _f === void 0 ? void 0 : _f.errorCode);
     if (status === 422 && errorCode === 104) {
-        return 'Invalid email or password. Please check your credentials and try again.';
+        return appendErrorDetails('Invalid email or password. Please check your credentials and try again.', parsedError);
     }
     if (status === 401) {
-        return 'Authentication failed. Please check your credentials.';
+        return appendErrorDetails('Authentication failed. Please check your credentials.', parsedError);
     }
     if (status === 403) {
-        return 'Access denied. Please check your permissions.';
+        return appendErrorDetails('Access denied. Please check your permissions.', parsedError);
     }
     // Check for specific SSL error
     if ((parsedError === null || parsedError === void 0 ? void 0 : parsedError.code) === 'UNABLE_TO_GET_ISSUER_CERT_LOCALLY') {
@@ -156,25 +192,8 @@ const formatError = function (error) {
     catch (e) {
         // message is not in JSON format, no need to parse
     }
-    // Append detailed error information if available
-    if (parsedError.errors && typeof parsedError.errors === 'object' && Object.keys(parsedError.errors).length > 0) {
-        const entityNames = {
-            authorization: 'Authentication',
-            api_key: 'Stack API key',
-            uid: 'Content Type',
-            // deepcode ignore HardcodedNonCryptoSecret: The hardcoded value 'access_token' is used as a key in an error message mapping object and does not represent a sensitive secret or cryptographic key.
-            access_token: 'Delivery Token',
-        };
-        const errorList = Object.entries(parsedError.errors)
-            .map(([field, errors]) => {
-            const errorArray = Array.isArray(errors) ? errors : [errors];
-            const fieldName = entityNames[field] || field;
-            return `  • ${fieldName}: ${errorArray.join(', ')}`;
-        })
-            .join('\n');
-        message += `\n\nAPI Errors:\n${errorList}`;
-    }
-    return message;
+    // Always append error details at the end
+    return appendErrorDetails(message, parsedError);
 };
 exports.formatError = formatError;
 /**

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

@@ -82,21 +82,15 @@ class CLIErrorHandler {
      * Extracts a clear, concise error message from various error types.
      */
     extractClearMessage(error) {
-        var _a, _b, _c, _d;
-        if ((_b = (_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.errorMessage) {
-            return error.response.data.errorMessage;
-        }
-        if (error === null || error === void 0 ? void 0 : error.errorMessage) {
-            return error.errorMessage;
-        }
+        var _a, _b;
         // Use existing formatError function for other cases
         try {
             const formattedMessage = (0, helpers_1.formatError)(error);
             return formattedMessage || 'An error occurred. Please try again.';
         }
-        catch (_e) {
+        catch (_c) {
             // Fallback to basic error message extraction if formatError fails
-            if (typeof ((_d = (_c = error === null || error === void 0 ? void 0 : error.response) === null || _c === void 0 ? void 0 : _c.data) === null || _d === void 0 ? void 0 : _d.errorMessage) === 'string') {
+            if (typeof ((_b = (_a = error === null || error === void 0 ? void 0 : error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.errorMessage) === 'string') {
                 return error.response.data.errorMessage;
             }
             if (typeof (error === null || error === void 0 ? void 0 : error.errorMessage) === 'string') {

package/lib/logger/log.js

@@ -10,9 +10,15 @@ const cli_error_handler_1 = require("./cli-error-handler");
 const __1 = require("..");
 let loggerInstance = null;
 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 config = {
         basePath: getLogPath(),
-        logLevel: __1.configHandler.get('log.level') || 'info',
+        logLevel: logLevel,
+        consoleLoggingEnabled: showConsoleLogs,
+        consoleLogLevel: logLevel,
     };
     return new logger_1.default(config);
 }

package/lib/logger/logger.js

@@ -95,6 +95,10 @@ class Logger {
         }
     }
     shouldLog(level, target) {
+        // If console logging is disabled, don't log to console
+        if (target === 'console' && this.config.consoleLoggingEnabled === false) {
+            return false;
+        }
         const configLevel = target === 'console' ? this.config.consoleLogLevel : this.config.logLevel;
         const minLevel = configLevel ? logging_1.logLevels[configLevel] : 2;
         return logging_1.logLevels[level] <= minLevel;

package/package.json

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