feat: add new logger in config

.talismanrc

@@ -1,8 +1,8 @@
 fileignoreconfig:
   - filename: package-lock.json
-    checksum: 25bcbb12c701b53f222c599fa8ce53f347853a1d96257cee79b5cf5878e50015
+    checksum: 666b363f8d07955c3b9dd679dbc7edad6ba399490d66f0c89d4936f97068be0c
   - filename: pnpm-lock.yaml
-    checksum: 448638c016e13e936e2dfa8297076162b0662de198908d994665579bab8f4b36
+    checksum: a9597b1dcbd72dd3ae9e12c1209084d8388d8f8282074802d18f5eae21fbc666
   - filename: packages/contentstack-import-setup/test/unit/backup-handler.test.ts
     checksum: 0582d62b88834554cf12951c8690a73ef3ddbb78b82d2804d994cf4148e1ef93
   - filename: packages/contentstack-import-setup/test/config.json

packages/contentstack-auth/src/base-command.ts

@@ -1,5 +1,12 @@
 import { Command } from '@contentstack/cli-command';
-import { configHandler, createLogContext, Flags, getAuthenticationMethod, Interfaces, log } from '@contentstack/cli-utilities';
+import {
+  configHandler,
+  createLogContext,
+  Flags,
+  getAuthenticationMethod,
+  Interfaces,
+  log,
+} from '@contentstack/cli-utilities';
 import { Context } from './interfaces';
 
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
@@ -17,8 +24,9 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
   public async init(): Promise<void> {
     await super.init();
     // this.contextDetails = { ...this.createExportContext() };
-    this.contextDetails = { ...createLogContext(this.context?.info?.command || 'auth', '',) };
-
+    this.contextDetails = {
+      ...createLogContext(this.context?.info?.command || 'auth', '', configHandler.get('authenticationMethod')),
+    };
   }
 
   /**

packages/contentstack-auth/test/run.test.ts

@@ -1,30 +1,30 @@
-import { join, resolve } from "path";
-import { existsSync, readdirSync } from "fs";
-import config from "./config.json" with { type: "json" };
-import filter from "lodash/filter.js";
-import forEach from "lodash/forEach.js";
-import isEmpty from "lodash/isEmpty.js";
-import isArray from "lodash/isArray.js";
-import includes from "lodash/includes.js";
+import { join, resolve } from 'path';
+import { existsSync, readdirSync } from 'fs';
+import config from './config.json';
+import filter from 'lodash/filter.js';
+import forEach from 'lodash/forEach.js';
+import isEmpty from 'lodash/isEmpty.js';
+import isArray from 'lodash/isArray.js';
+import includes from 'lodash/includes.js';
 import dotenv from 'dotenv';
 
 // NOTE init env variables
 dotenv.config();
 
 const { IS_TS, UNIT_EXECUTION_ORDER, INTEGRATION_EXECUTION_ORDER } = config;
 
-const testFileExtension = IS_TS ? ".ts" : ".js";
-process.env.TS_NODE_PROJECT = resolve("test/tsconfig.json");
+const testFileExtension = IS_TS ? '.ts' : '.js';
+process.env.TS_NODE_PROJECT = resolve('test/tsconfig.json');
 
 /**
  * @method getFileName
  * @param {string} file
  * @returns {string}
  */
 const getFileName = (file: string): string => {
-  if (includes(file, ".test") && includes(file, testFileExtension)) return file;
-  else if (includes(file, ".test")) return `${file}${testFileExtension}`;
-  else if (!includes(file, ".test")) return `${file}.test${testFileExtension}`;
+  if (includes(file, '.test') && includes(file, testFileExtension)) return file;
+  else if (includes(file, '.test')) return `${file}${testFileExtension}`;
+  else if (!includes(file, '.test')) return `${file}.test${testFileExtension}`;
   else return `${file}.test${testFileExtension}`;
 };
 
@@ -33,7 +33,7 @@ const getFileName = (file: string): string => {
  * @param {Array<string>} files
  * @param {string} basePath
  */
-const includeTestFiles = (files: Array<string>, basePath = "integration") => {
+const includeTestFiles = (files: Array<string>, basePath = 'integration') => {
   forEach(files, (file) => {
     const filename = getFileName(file);
     const filePath = join(__dirname, basePath, filename);
@@ -52,27 +52,24 @@ const includeTestFiles = (files: Array<string>, basePath = "integration") => {
  * @param {Array<string> | undefined | null} executionOrder
  * @param {boolean} isIntegrationTest
  */
-const run = (
-  executionOrder: Array<string> | undefined | null,
-  isIntegrationTest = true
-) => {
-  const testFolder = isIntegrationTest ? "integration" : "unit";
+const run = (executionOrder: Array<string> | undefined | null, isIntegrationTest = true) => {
+  const testFolder = isIntegrationTest ? 'integration' : 'unit';
 
   if (executionOrder && isArray(executionOrder) && !isEmpty(executionOrder)) {
     includeTestFiles(executionOrder, testFolder);
   } else {
     const basePath = join(__dirname, testFolder);
     const allIntegrationTestFiles = filter(readdirSync(basePath), (file) =>
-      includes(file, `.test${testFileExtension}`)
+      includes(file, `.test${testFileExtension}`),
     );
     includeTestFiles(allIntegrationTestFiles);
   }
 };
 
 const args = process.argv.slice(2);
 
-if (includes(args, "--integration-test")) {
+if (includes(args, '--integration-test')) {
   run(INTEGRATION_EXECUTION_ORDER);
-} else if (includes(args, "--unit-test")) {
+} else if (includes(args, '--unit-test')) {
   // run(UNIT_EXECUTION_ORDER, false);
 }

packages/contentstack-bulk-publish/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-cm-bulk-publish
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-cm-bulk-publish/1.10.4 darwin-arm64 node-v22.14.0
+@contentstack/cli-cm-bulk-publish/1.10.5 darwin-arm64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

packages/contentstack-bulk-publish/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@contentstack/cli-cm-bulk-publish",
   "description": "Contentstack CLI plugin for bulk publish actions",
-  "version": "1.10.4",
+  "version": "1.10.5",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
     "@contentstack/cli-command": "~1.7.1",
-    "@contentstack/cli-config": "~1.16.2",
+    "@contentstack/cli-config": "~1.17.0",
     "@contentstack/cli-utilities": "~1.16.0",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",

packages/contentstack-config/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
 $ csdx COMMAND
 running command...
 $ csdx (--version)
-@contentstack/cli-config/1.16.2 darwin-arm64 node-v22.14.0
+@contentstack/cli-config/1.17.0 darwin-arm64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

packages/contentstack-config/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli-config",
   "description": "Contentstack CLI plugin for configuration",
-  "version": "1.16.2",
+  "version": "1.17.0",
   "author": "Contentstack",
   "scripts": {
     "build": "npm run clean && npm run compile",

packages/contentstack-config/src/base-command.ts

@@ -1,24 +1,35 @@
 import { Command } from '@contentstack/cli-command';
-import { ArgInput, FlagInput, Flags, Interfaces, LoggerService } from '@contentstack/cli-utilities';
+import { ArgInput, FlagInput, Flags, Interfaces, configHandler, createLogContext } from '@contentstack/cli-utilities';
 
 export type Args<T extends typeof Command> = Interfaces.InferredArgs<T['args']>;
 export type Flags<T extends typeof Command> = Interfaces.InferredFlags<(typeof BaseCommand)['baseFlags'] & T['flags']>;
 
 export abstract class BaseCommand<T extends typeof Command> extends Command {
-  public logger!: LoggerService;
+  public contextDetails!: {
+    command: string;
+    module: string;
+    userId: string;
+    email: string;
+    sessionId: string;
+    apiKey: string;
+    orgId: string;
+    authenticationMethod: string;
+  };
   protected args!: Args<T>;
   protected flags!: Flags<T>;
 
-  static args: ArgInput<{ [arg: string]: any; }>;
+  static args: ArgInput<{ [arg: string]: any }>;
   /**
    * The `init` function initializes the command by parsing arguments and flags, registering search
    * plugins, registering the configuration, and initializing the logger.
    */
   public async init(): Promise<void> {
     await super.init();
 
-    // Init logger
-    this.logger = new LoggerService(process.cwd(), 'cli-log');
+    // Init logger context
+    this.contextDetails = {
+      ...createLogContext(this.context?.info?.command || 'config', '', configHandler.get('authenticationMethod')),
+    };
   }
 
   /**
@@ -46,4 +57,4 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     // called after run and catch regardless of whether or not the command errored
     return super.finally(_);
   }
-}
+}

packages/contentstack-config/src/commands/config/get/base-branch.ts

@@ -1,5 +1,5 @@
 import { Command } from '@contentstack/cli-command';
-import { cliux, configHandler, messageHandler, TableHeader } from '@contentstack/cli-utilities';
+import { cliux, configHandler, messageHandler, TableHeader, handleAndLogError } from '@contentstack/cli-utilities';
 
 export default class BranchGetCommand extends Command {
   static description = 'Get current branch set for CLI';
@@ -25,7 +25,7 @@ export default class BranchGetCommand extends Command {
         cliux.print(`error: ${messageHandler.parse('CLI_CONFIG_BRANCH_LIST_NO_BRANCHES')}`, { color: 'red' });
       }
     } catch (error) {
-      cliux.error('Error', error);
+      handleAndLogError(error, { module: 'config-get-base-branch' });
     }
   }
 }

packages/contentstack-config/src/commands/config/get/early-access-header.ts

@@ -1,4 +1,4 @@
-import { cliux, configHandler } from '@contentstack/cli-utilities';
+import { cliux, configHandler, handleAndLogError } from '@contentstack/cli-utilities';
 import { Command } from '@contentstack/cli-command';
 
 export default class GetEarlyAccessHeaderCommand extends Command {
@@ -27,7 +27,7 @@ export default class GetEarlyAccessHeaderCommand extends Command {
         cliux.print(`Early Access header not found.`, { color: 'red' });
       }
     } catch (error) {
-      this.log('Unable to retrieve the Early Access header config', error instanceof Error ? error.message : error);
+      handleAndLogError(error, { module: 'config-get-early-access-header' });
     }
   }
 }

packages/contentstack-config/src/commands/config/get/log.ts

@@ -1,5 +1,5 @@
 import { Command } from '@contentstack/cli-command';
-import { cliux, configHandler, TableHeader } from '@contentstack/cli-utilities';
+import { cliux, configHandler, TableHeader, handleAndLogError } from '@contentstack/cli-utilities';
 import { getEffectiveLogConfig } from '../../../utils/log-config-defaults';
 
 export default class LogGetCommand extends Command {
@@ -34,7 +34,7 @@ export default class LogGetCommand extends Command {
         color: 'dim',
       });
     } catch (error) {
-      cliux.error('Error', error);
+      handleAndLogError(error, { module: 'config-get-log' });
     }
   }
 }

packages/contentstack-config/src/commands/config/get/rate-limit.ts

@@ -1,4 +1,4 @@
-import { cliux, configHandler, TableHeader } from '@contentstack/cli-utilities';
+import { cliux, configHandler, TableHeader, handleAndLogError } from '@contentstack/cli-utilities';
 import { Command } from '@contentstack/cli-command';
 import { RateLimitConfig } from '../../../interfaces';
 
@@ -34,7 +34,7 @@ export default class RateLimitGetCommand extends Command {
 
       cliux.table(headers, tableData);
     } catch (error) {
-      this.log('Unable to retrieve the rate limits configuration', error instanceof Error ? error.message : error);
+      handleAndLogError(error, { module: 'config-get-rate-limit' });
     }
   }
 }

packages/contentstack-config/src/commands/config/get/region.ts

@@ -1,5 +1,5 @@
 import { Command } from '@contentstack/cli-command';
-import { cliux } from '@contentstack/cli-utilities';
+import { cliux, log } from '@contentstack/cli-utilities';
 
 import { Region } from '../../../interfaces';
 import { BaseCommand } from '../../../base-command';
@@ -10,7 +10,7 @@ export default class RegionGetCommand extends BaseCommand<typeof RegionGetComman
   async run() {
     let currentRegion: Region = this.region;
     if (!currentRegion) {
-      this.logger.error('No region is set.');
+      log.error('No region is set.', this.contextDetails);
       cliux.error('CLI_CONFIG_GET_REGION_NOT_FOUND');
       this.exit();
     }
@@ -21,6 +21,6 @@ export default class RegionGetCommand extends BaseCommand<typeof RegionGetComman
     cliux.print(`Developer Hub URL: ${currentRegion.developerHubUrl}`);
     cliux.print(`Launch URL: ${currentRegion.launchHubUrl}`);
     cliux.print(`Personalize URL: ${currentRegion.personalizeUrl}`);
-    this.logger.error(`Currently using ${currentRegion.name} region`);
+    log.info(`Currently using ${currentRegion.name} region`, this.contextDetails);
   }
 }

packages/contentstack-config/src/commands/config/remove/base-branch.ts

@@ -1,5 +1,5 @@
 import { Command } from '@contentstack/cli-command';
-import { cliux, flags, configHandler, FlagInput } from '@contentstack/cli-utilities';
+import { cliux, flags, configHandler, FlagInput, handleAndLogError } from '@contentstack/cli-utilities';
 import { interactive } from '../../../utils';
 
 export default class RemoveBranchConfigCommand extends Command {
@@ -40,7 +40,7 @@ export default class RemoveBranchConfigCommand extends Command {
         }
       }
     } catch (error) {
-      cliux.error('error', error);
+      handleAndLogError(error, { module: 'config-remove-base-branch' });
     }
   }
 }

packages/contentstack-config/src/commands/config/remove/early-access-header.ts

@@ -1,4 +1,4 @@
-import { cliux, flags, configHandler, FlagInput } from '@contentstack/cli-utilities';
+import { cliux, flags, configHandler, FlagInput, handleAndLogError } from '@contentstack/cli-utilities';
 import { interactive } from '../../../utils';
 import { Command } from '@contentstack/cli-command';
 
@@ -7,7 +7,10 @@ export default class RemoveEarlyAccessHeader extends Command {
   static aliases: string[] = ['config:remove:ea-header'];
   static flags: FlagInput = {
     'header-alias': flags.string({ description: '(optional) Provide the Early Access header alias name.' }),
-    yes: flags.boolean({ char: 'y', description: '(optional) Force the removal of Early Access header configuration by skipping the confirmation.' }),
+    yes: flags.boolean({
+      char: 'y',
+      description: '(optional) Force the removal of Early Access header configuration by skipping the confirmation.',
+    }),
   };
   static examples: string[] = [
     '$ <%= config.bin %> <%= command.id %>',
@@ -35,7 +38,7 @@ export default class RemoveEarlyAccessHeader extends Command {
       configHandler.delete(`earlyAccessHeaders.${earlyAccessHeaderAlias}`);
       cliux.success(`Early Access header has been successfully removed`);
     } catch (error) {
-      this.log('Unable to remove the Early Access header config', error instanceof Error ? error.message : error);
+      handleAndLogError(error, { module: 'config-remove-early-access-header' });
     }
   }
 }

packages/contentstack-config/src/commands/config/remove/rate-limit.ts

@@ -1,4 +1,4 @@
-import { cliux, configHandler, FlagInput, flags } from '@contentstack/cli-utilities';
+import { cliux, configHandler, FlagInput, flags, handleAndLogError } from '@contentstack/cli-utilities';
 import { Command } from '@contentstack/cli-command';
 import { askOrgID } from '../../../utils/interactive';
 
@@ -27,7 +27,7 @@ export default class RateLimitRemoveCommand extends Command {
       configHandler.delete(`rateLimit.${org}`);
       cliux.print(`Rate limit entry for organization UID ${org} has been removed.`, { color: 'green' });
     } catch (error) {
-      this.log('Unable to remove the rate limit entry', error instanceof Error ? error.message : error);
+      handleAndLogError(error, { module: 'config-remove-rate-limit' });
     }
   }
 }

packages/contentstack-config/src/commands/config/set/base-branch.ts

@@ -1,5 +1,5 @@
 import { Command } from '@contentstack/cli-command';
-import { cliux, flags, configHandler, FlagInput } from '@contentstack/cli-utilities';
+import { cliux, flags, configHandler, FlagInput, handleAndLogError, log } from '@contentstack/cli-utilities';
 import { interactive } from '../../../utils';
 
 export default class BranchSetCommand extends Command {
@@ -35,7 +35,7 @@ export default class BranchSetCommand extends Command {
         `Base branch configuration for stack-api-key: ${apiKey} and branch: ${baseBranch} set successfully`,
       );
     } catch (error) {
-      cliux.error('error', error);
+      handleAndLogError(error, { module: 'config-set-base-branch' });
     }
   }
 }

packages/contentstack-config/src/commands/config/set/early-access-header.ts

@@ -1,4 +1,4 @@
-import { cliux, flags, configHandler, FlagInput } from '@contentstack/cli-utilities';
+import { cliux, flags, configHandler, FlagInput, handleAndLogError } from '@contentstack/cli-utilities';
 import { interactive } from '../../../utils';
 import { Command } from '@contentstack/cli-command';
 
@@ -26,11 +26,9 @@ export default class SetEarlyAccessHeaderCommand extends Command {
         earlyAccessHeader = (await interactive.askEarlyAccessHeaderValue())?.trim();
       }
       configHandler.set(`earlyAccessHeaders.${earlyAccessHeaderAlias}`, earlyAccessHeader);
-      cliux.success(
-        `Early Access header has been successfully set`,
-      );
+      cliux.success(`Early Access header has been successfully set`);
     } catch (error) {
-      this.log('Unable to set the Early Access header config', error instanceof Error ? error.message : error);
+      handleAndLogError(error, { module: 'config-set-early-access-header' });
     }
   }
 }