@contentstack/cli-utilities 1.14.4 → 1.16.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Contentstack
+Copyright (c) 2026 Contentstack
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/auth-handler.js

@@ -114,7 +114,7 @@ class AuthHandler {
             await this.openOAuthURL();
         }
         catch (error) {
-            this.logger.error('OAuth login failed', error.message);
+            this.logger.error('OAuth login failed!', error.message);
             throw error;
         }
     }
@@ -123,20 +123,20 @@ class AuthHandler {
             const server = http_1.default.createServer(async (req, res) => {
                 const queryObject = url_1.default.parse(req.url, true).query;
                 if (!queryObject.code) {
-                    cli_ux_1.default.error('Error occoured while login with OAuth, please login with command - csdx auth:login --oauth');
+                    cli_ux_1.default.error('Error occurred while logging in with OAuth!');
                     return sendErrorResponse(res);
                 }
                 cli_ux_1.default.print('Auth code successfully fetched.');
                 try {
                     await this.getAccessToken(queryObject.code);
                     await this.setOAuthBaseURL();
-                    cli_ux_1.default.print('Access token fetched using auth code successfully.');
+                    cli_ux_1.default.print('Access token successfully fetched using auth code.');
                     cli_ux_1.default.print(`You can review the access permissions on the page - ${this.OAuthBaseURL}/#!/marketplace/authorized-apps`);
                     sendSuccessResponse(res);
                     stopServer();
                 }
                 catch (error) {
-                    cli_ux_1.default.error('Error occoured while login with OAuth, please login with command - csdx auth:login --oauth');
+                    cli_ux_1.default.error('Error occurred while logging in with OAuth!');
                     cli_ux_1.default.error(error);
                     sendErrorResponse(res);
                     stopServer();
@@ -301,8 +301,8 @@ class AuthHandler {
             }
         }
         else {
-            cli_ux_1.default.error('Invalid/Empty access token.');
-            throw new Error('Invalid/Empty access token');
+            cli_ux_1.default.error('Invalid or empty access token.');
+            throw new Error('Invalid or empty access token.');
         }
     }
     async oauthLogout() {
@@ -346,7 +346,7 @@ class AuthHandler {
             const oauthValidUpto = new Date();
             oauthValidUpto.setTime(oauthDate.getTime() + 59 * 60 * 1000);
             if (force) {
-                cli_ux_1.default.print('Force refreshing the token');
+                cli_ux_1.default.print('Forcing token refresh...');
                 return this.refreshToken();
             }
             else {
@@ -373,7 +373,7 @@ class AuthHandler {
             }
         }
         else {
-            cli_ux_1.default.print('No OAuth set');
+            cli_ux_1.default.print('No OAuth configuration set.');
             this.unsetConfigData();
         }
     }

package/lib/config-handler.js

@@ -47,7 +47,7 @@ class Config {
                 }
             }
             catch (error) {
-                console.log('No data to be imported from Old config file');
+                console.log('No data to import from old configuration file.');
             }
             this.set(OLD_CONFIG_BACKUP_FLAG, true);
         }

package/lib/flag-deprecation-check.js

@@ -22,17 +22,17 @@ function default_1(deprecatedFlags = [], suggestions = [], customMessage) {
             }
         });
         if (isCommandHasDeprecationFlag) {
-            let depreactionMessage = '';
+            let deprecationMessage = '';
             if (customMessage) {
-                depreactionMessage = customMessage;
+                deprecationMessage = customMessage;
             }
             else {
-                depreactionMessage = `WARNING!!! You're using the old (soon to be deprecated) Contentstack CLI flags (${deprecatedFlags.join(', ')}).`;
+                deprecationMessage = `WARNING!!! You're using the old (soon to be deprecated) Contentstack CLI flags (${deprecatedFlags.join(', ')}).`;
                 if (suggestions.length > 0) {
-                    depreactionMessage += ` We recommend you to use the updated flags (${suggestions.join(', ')}).`;
+                    deprecationMessage += ` We recommend you to use the updated flags (${suggestions.join(', ')}).`;
                 }
             }
-            cli_ux_1.default.print(depreactionMessage, { color: 'yellow' });
+            cli_ux_1.default.print(deprecationMessage, { color: 'yellow' });
         }
         return input;
     };

package/lib/helpers.d.ts

@@ -27,3 +27,28 @@ export declare const formatError: (error: any) => string;
  * from.
  */
 export declare const redactObject: (obj: any) => any;
+/**
+ * Get authentication method from config
+ * @returns Authentication method string ('OAuth', 'Basic Auth', or empty string)
+ */
+export declare function getAuthenticationMethod(): string;
+/**
+ * Creates a standardized context object for logging
+ * This context contains all session-level metadata that should be in session.json
+ * The apiKey is stored in configHandler so it's available for session.json generation
+ *
+ * @param commandId - The command ID (e.g., 'cm:stacks:export')
+ * @param apiKey - The API key for the stack (will be stored in configHandler for session.json)
+ * @param authenticationMethod - Optional authentication method
+ * @returns Context object with all session-level metadata
+ */
+export declare function createLogContext(commandId: string, apiKey: string, authenticationMethod?: string): {
+    command: string;
+    module: string;
+    userId: string;
+    email: string;
+    sessionId: string;
+    apiKey: string;
+    orgId: string;
+    authenticationMethod: string;
+};

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.getBranchFromAlias = exports.doesBranchExist = exports.isAuthenticated = void 0;
+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;
 const tslib_1 = require("tslib");
 const recheck_1 = require("recheck");
 const traverse_1 = tslib_1.__importDefault(require("traverse"));
@@ -238,3 +238,48 @@ const sensitiveKeys = [
     /management[-._]?token/i,
     /delivery[-._]?token/i,
 ];
+/**
+ * Get authentication method from config
+ * @returns Authentication method string ('OAuth', 'Basic Auth', or empty string)
+ */
+function getAuthenticationMethod() {
+    const authType = _1.configHandler.get('authorisationType');
+    if (authType === 'OAUTH') {
+        return 'OAuth';
+    }
+    else if (authType === 'BASIC') {
+        return 'Basic Auth';
+    }
+    // Management token detection is command-specific and not stored globally
+    // Return empty string if unknown
+    return '';
+}
+exports.getAuthenticationMethod = getAuthenticationMethod;
+/**
+ * Creates a standardized context object for logging
+ * This context contains all session-level metadata that should be in session.json
+ * The apiKey is stored in configHandler so it's available for session.json generation
+ *
+ * @param commandId - The command ID (e.g., 'cm:stacks:export')
+ * @param apiKey - The API key for the stack (will be stored in configHandler for session.json)
+ * @param authenticationMethod - Optional authentication method
+ * @returns Context object with all session-level metadata
+ */
+function createLogContext(commandId, apiKey, authenticationMethod) {
+    // Store apiKey in configHandler so it's available for session.json
+    if (apiKey) {
+        _1.configHandler.set('apiKey', apiKey);
+    }
+    const authMethod = authenticationMethod || getAuthenticationMethod();
+    return {
+        command: commandId,
+        module: '',
+        userId: _1.configHandler.get('clientId') || '',
+        email: _1.configHandler.get('email') || '',
+        sessionId: _1.configHandler.get('sessionId') || '',
+        apiKey: apiKey || '',
+        orgId: _1.configHandler.get('oauthOrgUid') || '',
+        authenticationMethod: authMethod,
+    };
+}
+exports.createLogContext = createLogContext;

package/lib/index.d.ts

@@ -13,6 +13,7 @@ export * from './fs-utility';
 export { default as NodeCrypto } from './encrypter';
 export { Args as args, Flags as flags, Command } from './cli-ux';
 export * from './helpers';
+export { createLogContext } from './helpers';
 export * from './interfaces';
 export * from './date-time';
 export * from './add-locale';

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.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.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;
@@ -34,6 +34,8 @@ Object.defineProperty(exports, "args", { enumerable: true, get: function () { re
 Object.defineProperty(exports, "flags", { enumerable: true, get: function () { return cli_ux_2.Flags; } });
 Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return cli_ux_2.Command; } });
 tslib_1.__exportStar(require("./helpers"), exports);
+var helpers_1 = require("./helpers");
+Object.defineProperty(exports, "createLogContext", { enumerable: true, get: function () { return helpers_1.createLogContext; } });
 tslib_1.__exportStar(require("./interfaces"), exports);
 tslib_1.__exportStar(require("./date-time"), exports);
 tslib_1.__exportStar(require("./add-locale"), exports);

package/lib/logger/log.d.ts

@@ -29,4 +29,5 @@ declare function handleAndLogError(error: unknown, context?: ErrorContext, error
  * 4. Home directory (~/contentstack/logs) (fallback)
  */
 declare function getLogPath(): string;
+export { getSessionLogPath } from './session-path';
 export { v2Logger, cliErrorHandler, handleAndLogError, getLogPath };

package/lib/logger/log.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLogPath = exports.handleAndLogError = exports.cliErrorHandler = exports.v2Logger = void 0;
+exports.getLogPath = exports.handleAndLogError = exports.cliErrorHandler = exports.v2Logger = exports.getSessionLogPath = void 0;
 const tslib_1 = require("tslib");
 const fs = tslib_1.__importStar(require("fs"));
 const os = tslib_1.__importStar(require("os"));
@@ -103,3 +103,6 @@ function getLogPath() {
     return path.join(os.homedir(), 'contentstack', 'logs');
 }
 exports.getLogPath = getLogPath;
+// Re-export getSessionLogPath for external use
+var session_path_1 = require("./session-path");
+Object.defineProperty(exports, "getSessionLogPath", { enumerable: true, get: function () { return session_path_1.getSessionLogPath; } });

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 session_path_1 = require("./session-path");
 class Logger {
     constructor(config) {
         this.consoleSensitiveKeys = [
@@ -31,7 +32,9 @@ class Logger {
         };
     }
     getLoggerInstance(level = 'info') {
-        const filePath = (0, path_1.normalize)(process.env.CS_CLI_LOG_PATH || this.config.basePath).replace(/^(\.\.(\/|\\|$))+/, '');
+        // Use session-based path for date-organized logging
+        const sessionPath = (0, session_path_1.getSessionLogPath)();
+        const filePath = (0, path_1.normalize)(sessionPath).replace(/^(\.\.(\/|\\|$))+/, '');
         return this.createLogger(level === 'hidden' ? 'error' : level, filePath);
     }
     get loggerOptions() {

package/lib/logger/session-path.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the session-based log path for date-organized logging
+ * Structure: {basePath}/{YYYY-MM-DD}/{command}-{YYYYMMDD-HHMMSS}-{sessionId}/
+ *
+ * @returns The session-specific log directory path
+ */
+export declare function getSessionLogPath(): string;

package/lib/logger/session-path.js

@@ -0,0 +1,96 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSessionLogPath = void 0;
+const tslib_1 = require("tslib");
+const fs = tslib_1.__importStar(require("fs"));
+const os = tslib_1.__importStar(require("os"));
+const path = tslib_1.__importStar(require("path"));
+const __1 = require("..");
+const log_1 = require("./log");
+/**
+ * Extract module name from command ID
+ * Example: "cm:stacks:audit" -> "audit"
+ */
+function extractModule(commandId) {
+    if (!commandId || commandId === 'unknown') {
+        return '';
+    }
+    // Split by colon and get the last part
+    const parts = commandId.split(':');
+    return parts[parts.length - 1] || '';
+}
+/**
+ * Generate session metadata object for session.json
+ * Uses createLogContext() to get base context, then adds session-specific metadata
+ */
+function generateSessionMetadata(commandId, sessionId, startTimestamp) {
+    const originalCommandId = __1.configHandler.get('currentCommandId') || commandId;
+    const module = extractModule(originalCommandId);
+    const apiKey = __1.configHandler.get('apiKey') || '';
+    const baseContext = (0, __1.createLogContext)(originalCommandId, apiKey);
+    return Object.assign(Object.assign({}, baseContext), { module: module, sessionId: sessionId, startTimestamp: startTimestamp.toISOString(), MachineEnvironment: {
+            nodeVersion: process.version,
+            os: os.platform(),
+            hostname: os.hostname(),
+            CLI_VERSION: __1.configHandler.get('CLI_VERSION') || '',
+        } });
+}
+/**
+ * Create session.json metadata file in the session directory
+ */
+function createSessionMetadataFile(sessionPath, metadata) {
+    const metadataPath = path.join(sessionPath, 'session.json');
+    try {
+        fs.writeFileSync(metadataPath, JSON.stringify(metadata, null, 2), 'utf8');
+    }
+    catch (error) {
+        // Silently fail if metadata file cannot be created
+        // Logging here would cause circular dependency
+        // The session folder and logs will still be created
+    }
+}
+/**
+ * Get the session-based log path for date-organized logging
+ * Structure: {basePath}/{YYYY-MM-DD}/{command}-{YYYYMMDD-HHMMSS}-{sessionId}/
+ *
+ * @returns The session-specific log directory path
+ */
+function getSessionLogPath() {
+    // Get base log path
+    const basePath = (0, log_1.getLogPath)();
+    // Get current date in YYYY-MM-DD format
+    const now = new Date();
+    const dateStr = now.toISOString().split('T')[0]; // YYYY-MM-DD
+    // Get command ID (fallback to 'unknown' if not set)
+    let commandId = __1.configHandler.get('currentCommandId') || 'unknown';
+    // Sanitize command ID - remove colons and replace with hyphens for folder name
+    commandId = commandId === null || commandId === void 0 ? void 0 : commandId.replace(/:/g, '-');
+    // Use helper methods to format date and time
+    const dateStrFormatted = (0, __1.formatDate)(now); // YYYYMMDD
+    const timeStrFormatted = (0, __1.formatTime)(now); // HHMMSS
+    const timestamp = `${dateStrFormatted}-${timeStrFormatted}`; // YYYYMMDD-HHMMSS
+    let sessionId = __1.configHandler.get('sessionId');
+    if (!sessionId) {
+        // Format: first 8 chars of command + timestamp (YYYYMMDDHHMMSS)
+        const timestampForId = `${dateStrFormatted}${timeStrFormatted}`; // YYYYMMDDHHMMSS
+        const commandHash = commandId.substring(0, 8).padEnd(8, '0'); // Use first 8 chars of command
+        sessionId = `${commandHash}-${timestampForId}`;
+    }
+    // Create session folder name: command-YYYYMMDD-HHMMSS-sessionId
+    const sessionFolderName = `${commandId}-${timestamp}-${sessionId}`;
+    // Build full session path
+    const sessionPath = path.join(basePath, dateStr, sessionFolderName);
+    // Ensure directory exists
+    const isNewSession = !fs.existsSync(sessionPath);
+    if (isNewSession) {
+        fs.mkdirSync(sessionPath, { recursive: true });
+    }
+    // Create session.json metadata file for new sessions
+    // This ensures metadata is created before any logs are written
+    if (isNewSession) {
+        const metadata = generateSessionMetadata(__1.configHandler.get('currentCommandId') || commandId, sessionId, now);
+        createSessionMetadataFile(sessionPath, metadata);
+    }
+    return sessionPath;
+}
+exports.getSessionLogPath = getSessionLogPath;

package/lib/logger.js

@@ -26,7 +26,7 @@ class LoggerService {
                     stringifiedParam = JSON.stringify(info.obj);
                 }
                 catch (error) {
-                    console.log('warning: failed to log the result');
+                    console.log('Warning: Failed to log the result');
                 }
                 // parse message
                 info.message = index_1.messageHandler.parse(info.message);

package/lib/message-handler.js

@@ -23,7 +23,7 @@ class Messages {
                 this.messages = {};
             }
             else {
-                throw new cli_error_1.default(error.message);
+                throw new cli_error_1.default(`Error: ${error.message}`);
             }
         }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-utilities",
-  "version": "1.14.4",
+  "version": "1.16.0",
   "description": "Utilities for contentstack projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -43,10 +43,10 @@
     "conf": "^10.2.0",
     "dotenv": "^16.5.0",
     "figures": "^3.2.0",
-    "inquirer": "8.2.6",
+    "inquirer": "8.2.7",
     "inquirer-search-checkbox": "^1.0.0",
     "inquirer-search-list": "^1.2.6",
-    "js-yaml": "^4.1.0",
+    "js-yaml": "^4.1.1",
     "klona": "^2.0.6",
     "lodash": "^4.17.21",
     "mkdirp": "^1.0.4",