@contentstack/cli-utilities 1.13.1 → 1.14.0

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;

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 } });
@@ -157,7 +173,7 @@ const formatError = function (error) {
         // message is not in JSON format, no need to parse
     }
     // Append detailed error information if available
-    if (parsedError.errors && Object.keys(parsedError.errors).length > 0) {
+    if (parsedError.errors && typeof parsedError.errors === 'object' && Object.keys(parsedError.errors).length > 0) {
         const entityNames = {
             authorization: 'Authentication',
             api_key: 'Stack API key',
@@ -165,11 +181,14 @@ const formatError = function (error) {
             // 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',
         };
-        message +=
-            ' ' +
-                Object.entries(parsedError.errors)
-                    .map(([key, value]) => `${entityNames[key] || key} ${value}`)
-                    .join(' ');
+        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;
 };

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

@@ -82,7 +82,7 @@ class CLIErrorHandler {
      * Extracts a clear, concise error message from various error types.
      */
     extractClearMessage(error) {
-        var _a, _b;
+        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;
         }
@@ -94,8 +94,14 @@ class CLIErrorHandler {
             const formattedMessage = (0, helpers_1.formatError)(error);
             return formattedMessage || 'An error occurred. Please try again.';
         }
-        catch (_c) {
-            return 'An error occurred. Please try again.';
+        catch (_e) {
+            // 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') {
+                return error.response.data.errorMessage;
+            }
+            if (typeof (error === null || error === void 0 ? void 0 : error.errorMessage) === 'string') {
+                return error.errorMessage;
+            }
         }
     }
     /**
@@ -117,7 +123,18 @@ class CLIErrorHandler {
                 const message = errorObj.message || errorObj.error || errorObj.statusText || 'Unknown error';
                 const normalizedError = new Error(message);
                 // Only copy essential properties
-                const essentialProps = ['code', 'status', 'statusText', 'response', 'request', 'config'];
+                const essentialProps = [
+                    'code',
+                    'status',
+                    'statusText',
+                    'response',
+                    'request',
+                    'message',
+                    'errorMessage',
+                    'error_message',
+                    'error',
+                    'errors',
+                ];
                 essentialProps.forEach((prop) => {
                     if (errorObj[prop] !== undefined) {
                         normalizedError[prop] = errorObj[prop];
@@ -163,7 +180,7 @@ class CLIErrorHandler {
      * Extracts only essential error payload information for clear debugging.
      */
     extractErrorPayload(error) {
-        var _a, _b;
+        var _a, _b, _c, _d;
         const { name, message, code, status, response, request, config, statusText } = error;
         const payload = {
             name,
@@ -174,6 +191,20 @@ class CLIErrorHandler {
             payload.code = code;
         if (status || (response === null || response === void 0 ? void 0 : response.status))
             payload.status = status || (response === null || response === void 0 ? void 0 : response.status);
+        // Add detailed field-level errors if available
+        if (((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.errors) && typeof response.data.errors === 'object') {
+            payload.errors = response.data.errors;
+        }
+        else if ((error === null || error === void 0 ? void 0 : error.errors) && typeof error.errors === 'object') {
+            payload.errors = error.errors;
+        }
+        // Add error code if available
+        if ((_b = response === null || response === void 0 ? void 0 : response.data) === null || _b === void 0 ? void 0 : _b.error_code) {
+            payload.errorCode = response.data.error_code;
+        }
+        else if (error === null || error === void 0 ? void 0 : error.error_code) {
+            payload.errorCode = error.error_code;
+        }
         // Add request context with sensitive data redaction
         if (request || config) {
             const requestData = {
@@ -200,12 +231,12 @@ class CLIErrorHandler {
             payload.response = (0, helpers_2.redactObject)(responseData);
         }
         // Extract user-friendly error message for API errors
-        if ((_a = response === null || response === void 0 ? void 0 : response.data) === null || _a === void 0 ? void 0 : _a.errorMessage) {
+        if ((_c = response === null || response === void 0 ? void 0 : response.data) === null || _c === void 0 ? void 0 : _c.errorMessage) {
             payload.userFriendlyMessage = response.data.errorMessage;
         }
         // Add stack trace only for non-API errors to avoid clutter
         if (![errorTypes_1.ERROR_TYPES.API_ERROR, errorTypes_1.ERROR_TYPES.SERVER_ERROR].includes(this.determineErrorType(error))) {
-            payload.stack = (_b = error.stack) === null || _b === void 0 ? void 0 : _b.split('\n').slice(0, 5).join('\n');
+            payload.stack = (_d = error.stack) === null || _d === void 0 ? void 0 : _d.split('\n').slice(0, 5).join('\n');
         }
         return payload;
     }

package/lib/logger/logger.d.ts

@@ -3,7 +3,8 @@ import { LoggerConfig } from '../interfaces/index';
 export default class Logger {
     private loggers;
     private config;
-    private sensitiveKeys;
+    private consoleSensitiveKeys;
+    private logSensitiveKeys;
     constructor(config: LoggerConfig);
     getLoggerInstance(level?: 'error' | 'info' | 'warn' | 'debug' | 'hidden'): winston.Logger;
     private get loggerOptions();

package/lib/logger/logger.js

@@ -8,9 +8,8 @@ const winston = tslib_1.__importStar(require("winston"));
 const logging_1 = require("../constants/logging");
 class Logger {
     constructor(config) {
-        this.sensitiveKeys = [
+        this.consoleSensitiveKeys = [
             /authtoken/i,
-            /^email$/i,
             /^password$/i,
             /secret/i,
             /token/i,
@@ -20,6 +19,7 @@ class Logger {
             /orgid/i,
             /stack/i,
         ];
+        this.logSensitiveKeys = [/authtoken/i, /secret/i, /token/i, /management[-._]?token/i, /delivery[-._]?token/i];
         this.config = config;
         winston.addColors(logging_1.levelColors);
         this.loggers = {
@@ -47,10 +47,15 @@ class Logger {
             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.json()) })),
+                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) => {
-                        const redactedInfo = this.redact(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;
@@ -60,24 +65,29 @@ class Logger {
             ],
         });
     }
-    isSensitiveKey(keyStr) {
-        return typeof keyStr === 'string' ? this.sensitiveKeys.some((regex) => regex.test(keyStr)) : false;
+    isSensitiveKey(keyStr, consoleMode = false) {
+        if (keyStr && typeof keyStr === 'string') {
+            const keysToCheck = consoleMode ? this.consoleSensitiveKeys : this.logSensitiveKeys;
+            return keysToCheck.some((regex) => regex.test(keyStr));
+        }
+        return false;
     }
-    redactObject(obj) {
+    redactObject(obj, consoleMode = false) {
         const self = this;
         (0, traverse_1.default)(obj).forEach(function redactor() {
-            if (this.key && self.isSensitiveKey(this.key)) {
+            if (this.key && self.isSensitiveKey(this.key, consoleMode)) {
                 this.update('[REDACTED]');
             }
         });
+        return obj;
     }
-    redact(info) {
+    redact(info, consoleMode = false) {
         try {
             const copy = (0, full_1.klona)(info);
-            this.redactObject(copy);
+            this.redactObject(copy, consoleMode);
             const splat = copy[Symbol.for('splat')];
             if (splat)
-                this.redactObject(splat);
+                this.redactObject(splat, consoleMode);
             return copy;
         }
         catch (_a) {

package/package.json

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