@contentstack/cli-audit 1.14.1 → 1.15.0

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.14.1 linux-x64 node-v22.18.0
+@contentstack/cli-audit/1.15.0 linux-x64 node-v22.20.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -282,7 +282,7 @@ DESCRIPTION
   Display help for csdx.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.32/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.33/src/commands/help.ts)_
 
 ## `csdx plugins`
 
@@ -305,7 +305,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:add PLUGIN`
 
@@ -379,7 +379,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN`
 
@@ -428,7 +428,7 @@ EXAMPLES
     $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PATH`
 
@@ -459,7 +459,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:remove [PLUGIN]`
 
@@ -500,7 +500,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall [PLUGIN]`
 
@@ -528,7 +528,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:unlink [PLUGIN]`
 
@@ -572,5 +572,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.46/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.50/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/lib/audit-base-command.d.ts

@@ -1,9 +1,10 @@
 import config from './config';
 import { BaseCommand } from './base-command';
-import { CommandNames, ContentTypeStruct } from './types';
+import { CommandNames, ContentTypeStruct, AuditContext } from './types';
 export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseCommand> {
     private currentCommand;
     private readonly summaryDataToPrint;
+    protected auditContext: AuditContext;
     get fixStatus(): {
         fixStatus: {
             minWidth: number;
@@ -11,6 +12,10 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
             get: (row: any) => string;
         };
     };
+    /**
+     * Create audit context object similar to export command
+     */
+    private createAuditContext;
     /**
      * The `start` function performs an audit on content types, global fields, entries, and workflows and displays
      * any missing references.

package/lib/audit-base-command.js

@@ -33,6 +33,19 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             },
         };
     }
+    /**
+     * Create audit context object similar to export command
+     */
+    createAuditContext(moduleName) {
+        var _a, _b, _c;
+        return {
+            command: ((_b = (_a = this.context) === null || _a === void 0 ? void 0 : _a.info) === null || _b === void 0 ? void 0 : _b.command) || 'cm:stacks:audit',
+            module: moduleName || 'audit',
+            email: cli_utilities_1.configHandler.get('email') || '',
+            sessionId: ((_c = this.context) === null || _c === void 0 ? void 0 : _c.sessionId) || '',
+            authenticationMethod: cli_utilities_1.configHandler.get('authenticationMethod') || '',
+        };
+    }
     /**
      * The `start` function performs an audit on content types, global fields, entries, and workflows and displays
      * any missing references.
@@ -41,9 +54,15 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      */
     async start(command) {
         this.currentCommand = command;
+        // Initialize audit context
+        this.auditContext = this.createAuditContext();
+        cli_utilities_1.log.debug(`Starting audit command: ${command}`, this.auditContext);
+        cli_utilities_1.log.info(`Starting audit command: ${command}`, this.auditContext);
         await this.promptQueue();
         await this.createBackUp();
         this.sharedConfig.reportPath = (0, path_1.resolve)(this.flags['report-path'] || process.cwd(), 'audit-report');
+        cli_utilities_1.log.debug(`Data directory: ${this.flags['data-dir']}`, this.auditContext);
+        cli_utilities_1.log.debug(`Report path: ${this.flags['report-path'] || process.cwd()}`, this.auditContext);
         const { missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingFieldRules, missingMultipleFields, } = await this.scanAndFix();
         if (this.flags['show-console-output']) {
             this.showOutputOnScreen([
@@ -86,15 +105,15 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             !(0, isEmpty_1.default)(missingFieldRules) ||
             !(0, isEmpty_1.default)(missingMultipleFields)) {
             if (this.currentCommand === 'cm:stacks:audit') {
-                this.log(this.$t(messages_1.auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
+                cli_utilities_1.log.warn(this.$t(messages_1.auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), this.auditContext);
             }
             else {
-                this.log(this.$t(this.messages.FIXED_CONTENT_PATH_MAG, { path: this.sharedConfig.basePath }), 'warn');
+                cli_utilities_1.log.warn(this.$t(this.messages.FIXED_CONTENT_PATH_MAG, { path: this.sharedConfig.basePath }), this.auditContext);
             }
         }
         else {
-            this.log(this.messages.NO_MISSING_REF_FOUND, 'info');
-            this.log('');
+            cli_utilities_1.log.info(this.messages.NO_MISSING_REF_FOUND, this.auditContext);
+            cli_utilities_1.cliux.print('');
             if (this.flags['copy-dir'] &&
                 this.currentCommand === 'cm:stacks:audit:fix' &&
                 (0, fs_1.existsSync)(this.sharedConfig.basePath)) {
@@ -121,17 +140,23 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      */
     async scanAndFix() {
         var _a, _b, _c, _d, _e, _f;
+        cli_utilities_1.log.debug('Starting scan and fix process', this.auditContext);
         let { ctSchema, gfSchema } = this.getCtAndGfSchema();
-        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingFieldRules, missingMultipleFields;
+        cli_utilities_1.log.info(`Retrieved ${(ctSchema === null || ctSchema === void 0 ? void 0 : ctSchema.length) || 0} content types and ${(gfSchema === null || gfSchema === void 0 ? void 0 : gfSchema.length) || 0} global fields`, this.auditContext);
+        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry = {}, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingFieldRules, missingMultipleFields;
         const constructorParam = {
             ctSchema,
             gfSchema,
-            log: this.log,
-            config: this.sharedConfig,
+            config: Object.assign(Object.assign({}, this.sharedConfig), { auditContext: this.auditContext }),
             fix: this.currentCommand === 'cm:stacks:audit:fix',
         };
         let dataModuleWise = await new modules_1.ModuleDataReader((0, cloneDeep_1.default)(constructorParam)).run();
+        cli_utilities_1.log.debug(`Data module wise: ${JSON.stringify(dataModuleWise)}`, this.auditContext);
         for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
+            // Update audit context with current module
+            this.auditContext = this.createAuditContext(module);
+            cli_utilities_1.log.debug(`Starting audit for module: ${module}`, this.auditContext);
+            cli_utilities_1.log.info(`Starting audit for module: ${module}`, this.auditContext);
             (0, log_1.print)([
                 {
                     bold: true,
@@ -142,21 +167,28 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             constructorParam['moduleName'] = module;
             switch (module) {
                 case 'assets':
+                    cli_utilities_1.log.info('Executing assets audit', this.auditContext);
                     missingEnvLocalesInAssets = await new modules_1.Assets((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingEnvLocalesInAssets);
                     this.getAffectedData('assets', dataModuleWise['assets'], missingEnvLocalesInAssets);
+                    cli_utilities_1.log.success(`Assets audit completed. Found ${Object.keys(missingEnvLocalesInAssets || {}).length} issues`, this.auditContext);
                     break;
                 case 'content-types':
+                    cli_utilities_1.log.info('Executing content-types audit', this.auditContext);
                     missingCtRefs = await new modules_1.ContentType((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingCtRefs);
                     this.getAffectedData('content-types', dataModuleWise['content-types'], missingCtRefs);
+                    cli_utilities_1.log.success(`Content-types audit completed. Found ${Object.keys(missingCtRefs || {}).length} issues`, this.auditContext);
                     break;
                 case 'global-fields':
+                    cli_utilities_1.log.info('Executing global-fields audit', this.auditContext);
                     missingGfRefs = await new modules_1.GlobalField((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingGfRefs);
                     this.getAffectedData('global-fields', dataModuleWise['global-fields'], missingGfRefs);
+                    cli_utilities_1.log.success(`Global-fields audit completed. Found ${Object.keys(missingGfRefs || {}).length} issues`, this.auditContext);
                     break;
                 case 'entries':
+                    cli_utilities_1.log.info('Executing entries audit', this.auditContext);
                     missingEntry = await new modules_1.Entries((0, cloneDeep_1.default)(constructorParam)).run();
                     missingEntryRefs = (_a = missingEntry.missingEntryRefs) !== null && _a !== void 0 ? _a : {};
                     missingSelectFeild = (_b = missingEntry.missingSelectFeild) !== null && _b !== void 0 ? _b : {};
@@ -171,29 +203,36 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     await this.prepareReport('Entry_Missing_Locale_and_Env_in_Publish_Details', missingEnvLocalesInEntries);
                     await this.prepareReport('Entry_Multiple_Fields', missingMultipleFields);
                     this.getAffectedData('entries', dataModuleWise['entries'], missingEntry);
+                    cli_utilities_1.log.success(`Entries audit completed. Found ${Object.keys(missingEntryRefs || {}).length} reference issues`, this.auditContext);
                     break;
                 case 'workflows':
+                    cli_utilities_1.log.info('Executing workflows audit', this.auditContext);
                     missingCtRefsInWorkflow = await new modules_1.Workflows({
                         ctSchema,
-                        log: this.log,
                         moduleName: module,
                         config: this.sharedConfig,
                         fix: this.currentCommand === 'cm:stacks:audit:fix',
                     }).run();
                     await this.prepareReport(module, missingCtRefsInWorkflow);
                     this.getAffectedData('workflows', dataModuleWise['workflows'], missingCtRefsInWorkflow);
+                    cli_utilities_1.log.success(`Workflows audit completed. Found ${Object.keys(missingCtRefsInWorkflow || {}).length} issues`, this.auditContext);
                     break;
                 case 'extensions':
+                    cli_utilities_1.log.info('Executing extensions audit', this.auditContext);
                     missingCtRefsInExtensions = await new modules_1.Extensions((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingCtRefsInExtensions);
                     this.getAffectedData('extensions', dataModuleWise['extensions'], missingCtRefsInExtensions);
+                    cli_utilities_1.log.success(`Extensions audit completed. Found ${Object.keys(missingCtRefsInExtensions || {}).length} issues`, this.auditContext);
                     break;
                 case 'custom-roles':
+                    cli_utilities_1.log.info('Executing custom-roles audit', this.auditContext);
                     missingRefInCustomRoles = await new modules_1.CustomRoles((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingRefInCustomRoles);
                     this.getAffectedData('custom-roles', dataModuleWise['custom-roles'], missingRefInCustomRoles);
+                    cli_utilities_1.log.success(`Custom-roles audit completed. Found ${Object.keys(missingRefInCustomRoles || {}).length} issues`, this.auditContext);
                     break;
                 case 'field-rules':
+                    cli_utilities_1.log.info('Executing field-rules audit', this.auditContext);
                     // NOTE: We are using the fixed content-type for validation of field rules
                     const data = this.getCtAndGfSchema();
                     constructorParam.ctSchema = data.ctSchema;
@@ -201,6 +240,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     missingFieldRules = await new modules_1.FieldRule((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingFieldRules);
                     this.getAffectedData('field-rules', dataModuleWise['content-types'], missingFieldRules);
+                    cli_utilities_1.log.success(`Field-rules audit completed. Found ${Object.keys(missingFieldRules || {}).length} issues`, this.auditContext);
                     break;
             }
             (0, log_1.print)([
@@ -216,6 +256,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 },
             ]);
         }
+        cli_utilities_1.log.debug('Scan and fix process completed', this.auditContext);
         this.prepareReport('Summary', this.summaryDataToPrint);
         this.prepareCSV('Summary', this.summaryDataToPrint);
         return {
@@ -290,7 +331,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
     showOutputOnScreen(allMissingRefs) {
         var _a;
         if (this.sharedConfig.showTerminalOutput && !((_a = this.flags['external-config']) === null || _a === void 0 ? void 0 : _a.noTerminalOutput)) {
-            this.log(''); // NOTE adding new line
+            cli_utilities_1.cliux.print(''); // NOTE adding new line
             for (const { module, missingRefs } of allMissingRefs) {
                 if (!(0, isEmpty_1.default)(missingRefs)) {
                     (0, log_1.print)([
@@ -335,7 +376,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                         },
                     ];
                     cli_utilities_1.cliux.table(tableHeaders, tableValues, Object.assign({}, this.flags));
-                    this.log(''); // NOTE adding new line
+                    cli_utilities_1.cliux.print(''); // NOTE adding new line
                 }
             }
         }
@@ -346,7 +387,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         if (!this.sharedConfig.showTerminalOutput || ((_a = this.flags['external-config']) === null || _a === void 0 ? void 0 : _a.noTerminalOutput)) {
             return;
         }
-        this.log(''); // Adding a new line
+        cli_utilities_1.cliux.print(''); // Adding a new line
         for (let { module, missingRefs } of allMissingRefs) {
             if ((0, isEmpty_1.default)(missingRefs)) {
                 continue;
@@ -378,7 +419,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 },
             }));
             cli_utilities_1.cliux.table(tableHeaders, tableValues, Object.assign({}, this.flags));
-            this.log(''); // Adding a new line
+            cli_utilities_1.cliux.print(''); // Adding a new line
         }
     }
     /**
@@ -392,14 +433,26 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * @returns The function `prepareReport` returns a Promise that resolves to `void`.
      */
     prepareReport(moduleName, listOfMissingRefs) {
-        if ((0, isEmpty_1.default)(listOfMissingRefs))
+        cli_utilities_1.log.debug(`Preparing report for module: ${moduleName}`, this.auditContext);
+        cli_utilities_1.log.debug(`Report path: ${this.sharedConfig.reportPath}`, this.auditContext);
+        cli_utilities_1.log.info(`Missing references count: ${Object.keys(listOfMissingRefs).length}`, this.auditContext);
+        if ((0, isEmpty_1.default)(listOfMissingRefs)) {
+            cli_utilities_1.log.debug(`No missing references found for ${moduleName}, skipping report generation`, this.auditContext);
             return Promise.resolve(void 0);
+        }
         if (!(0, fs_1.existsSync)(this.sharedConfig.reportPath)) {
+            cli_utilities_1.log.debug(`Creating report directory: ${this.sharedConfig.reportPath}`, this.auditContext);
             (0, fs_1.mkdirSync)(this.sharedConfig.reportPath, { recursive: true });
         }
+        else {
+            cli_utilities_1.log.debug(`Report directory already exists: ${this.sharedConfig.reportPath}`, this.auditContext);
+        }
         // NOTE write int json
-        (0, fs_1.writeFileSync)((0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.sharedConfig.reportPath), `${(0, cli_utilities_1.sanitizePath)(moduleName)}.json`), JSON.stringify(listOfMissingRefs));
+        const jsonFilePath = (0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.sharedConfig.reportPath), `${(0, cli_utilities_1.sanitizePath)(moduleName)}.json`);
+        cli_utilities_1.log.debug(`Writing JSON report to: ${jsonFilePath}`, this.auditContext);
+        (0, fs_1.writeFileSync)(jsonFilePath, JSON.stringify(listOfMissingRefs));
         // NOTE write into CSV
+        cli_utilities_1.log.debug(`Preparing CSV report for: ${moduleName}`, this.auditContext);
         return this.prepareCSV(moduleName, listOfMissingRefs);
     }
     /**

package/lib/base-command.d.ts

@@ -1,13 +1,10 @@
 import { Command } from '@contentstack/cli-command';
 import { FlagInput, Interfaces } from '@contentstack/cli-utilities';
-import { Logger } from './util';
-import { ConfigType, LogFn } from './types';
+import { ConfigType } from './types';
 import messages, { $t } from './messages';
 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 declare abstract class BaseCommand<T extends typeof Command> extends Command {
-    log: LogFn;
-    logger: Logger;
     readonly $t: typeof $t;
     protected sharedConfig: ConfigType;
     readonly messages: typeof messages;

package/lib/base-command.js

@@ -8,9 +8,7 @@ const fs_1 = require("fs");
 const cli_command_1 = require("@contentstack/cli-command");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const config_1 = tslib_1.__importDefault(require("./config"));
-const util_1 = require("./util");
 const messages_1 = tslib_1.__importStar(require("./messages"));
-const noLog = (_message, _logType) => { };
 class BaseCommand extends cli_command_1.Command {
     constructor() {
         super(...arguments);
@@ -41,14 +39,9 @@ class BaseCommand extends cli_command_1.Command {
         this.registerConfig();
         // Init logger
         if ((_c = this.flags['external-config']) === null || _c === void 0 ? void 0 : _c.noLog) {
-            this.log = noLog;
             cli_utilities_1.ux.action.start = () => { };
             cli_utilities_1.ux.action.stop = () => { };
         }
-        else {
-            const logger = new util_1.Logger(this.sharedConfig);
-            this.log = logger.log.bind(logger);
-        }
     }
     /**
      * The catch function is used to handle errors from a command, either by adding custom logic or
@@ -83,7 +76,7 @@ class BaseCommand extends cli_command_1.Command {
                 this.sharedConfig = (0, merge_1.default)(this.sharedConfig, JSON.parse((0, fs_1.readFileSync)(this.flags.config, { encoding: 'utf-8' })));
             }
             catch (error) {
-                this.log(error, 'error');
+                (0, cli_utilities_1.handleAndLogError)(error);
             }
         }
     }

package/lib/commands/cm/stacks/audit/fix.js

@@ -21,8 +21,7 @@ class AuditFix extends audit_base_command_1.AuditBaseCommand {
             }
         }
         catch (error) {
-            this.log(error instanceof Error ? error.message : error, 'error');
-            console.trace(error);
+            (0, cli_utilities_1.handleAndLogError)(error);
             cli_utilities_1.ux.action.stop('Process failed.!');
             this.exit(1);
         }

package/lib/commands/cm/stacks/audit/index.js

@@ -16,8 +16,7 @@ class Audit extends audit_base_command_1.AuditBaseCommand {
             await this.start('cm:stacks:audit');
         }
         catch (error) {
-            console.trace(error);
-            this.log(error instanceof Error ? error.message : error, 'error');
+            (0, cli_utilities_1.handleAndLogError)(error);
             cli_utilities_1.ux.action.stop('Process failed.!');
             this.exit(1);
         }

package/lib/modules/assets.d.ts

@@ -1,7 +1,6 @@
-import { LogFn, ConfigType, ContentTypeStruct, CtConstructorParam, ModuleConstructorParam, EntryStruct } from '../types';
+import { ConfigType, ContentTypeStruct, CtConstructorParam, ModuleConstructorParam, EntryStruct } from '../types';
 import auditConfig from '../config';
 export default class Assets {
-    log: LogFn;
     protected fix: boolean;
     fileName: string;
     config: ConfigType;
@@ -14,7 +13,7 @@ export default class Assets {
     protected schema: ContentTypeStruct[];
     protected missingEnvLocales: Record<string, any>;
     moduleName: keyof typeof auditConfig.moduleConfig;
-    constructor({ log, fix, config, moduleName }: ModuleConstructorParam & CtConstructorParam);
+    constructor({ fix, config, moduleName }: ModuleConstructorParam & CtConstructorParam);
     validateModules(moduleName: keyof typeof auditConfig.moduleConfig, moduleConfig: Record<string, unknown>): keyof typeof auditConfig.moduleConfig;
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,

package/lib/modules/assets.js

@@ -10,12 +10,11 @@ const lodash_1 = require("lodash");
 /* The `ContentType` class is responsible for scanning content types, looking for references, and
 generating a report in JSON and CSV formats. */
 class Assets {
-    constructor({ log, fix, config, moduleName }) {
+    constructor({ fix, config, moduleName }) {
         this.locales = [];
         this.environments = [];
         this.schema = [];
         this.missingEnvLocales = {};
-        this.log = log;
         this.config = config;
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
@@ -34,16 +33,25 @@ class Assets {
      * @returns the `missingEnvLocales` object.
      */
     async run(returnFixSchema = false) {
+        var _a;
+        cli_utilities_1.log.debug(`Starting ${this.moduleName} audit process`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Data directory: ${this.folderPath}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Fix mode: ${this.fix}`, this.config.auditContext);
         if (!(0, fs_1.existsSync)(this.folderPath)) {
-            this.log(`Skipping ${this.moduleName} audit`, 'warn');
-            this.log((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
+            cli_utilities_1.log.debug(`Skipping ${this.moduleName} audit - path does not exist`, this.config.auditContext);
+            cli_utilities_1.log.warn(`Skipping ${this.moduleName} audit`, this.config.auditContext);
+            cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
             return returnFixSchema ? [] : {};
         }
+        cli_utilities_1.log.debug('Loading prerequisite data (locales and environments)', this.config.auditContext);
         await this.prerequisiteData();
+        cli_utilities_1.log.debug('Starting asset Reference, Environment and Locale validation', this.config.auditContext);
         await this.lookForReference();
         if (returnFixSchema) {
+            cli_utilities_1.log.debug(`Returning fixed schema with ${((_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) || 0} items`, this.config.auditContext);
             return this.schema;
         }
+        cli_utilities_1.log.debug('Cleaning up empty missing environment/locale references', this.config.auditContext);
         for (let propName in this.missingEnvLocales) {
             if (Array.isArray(this.missingEnvLocales[propName])) {
                 if (!this.missingEnvLocales[propName].length) {
@@ -51,6 +59,8 @@ class Assets {
                 }
             }
         }
+        const totalIssues = Object.keys(this.missingEnvLocales).length;
+        cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${totalIssues} assets with missing environment/locale references`, this.config.auditContext);
         return this.missingEnvLocales;
     }
     /**
@@ -59,17 +69,33 @@ class Assets {
      * app data, and stores them in the `extensions` array.
      */
     async prerequisiteData() {
-        this.log(messages_1.auditMsg.PREPARING_ENTRY_METADATA, 'info');
+        cli_utilities_1.log.debug('Loading prerequisite data (locales and environments)', this.config.auditContext);
+        cli_utilities_1.log.info(messages_1.auditMsg.PREPARING_ENTRY_METADATA, this.config.auditContext);
         const localesFolderPath = (0, path_1.resolve)(this.config.basePath, this.config.moduleConfig.locales.dirName);
         const localesPath = (0, path_1.join)(localesFolderPath, this.config.moduleConfig.locales.fileName);
         const masterLocalesPath = (0, path_1.join)(localesFolderPath, 'master-locale.json');
+        cli_utilities_1.log.debug(`Loading locales from: ${localesFolderPath}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Master locales path: ${masterLocalesPath}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Locales path: ${localesPath}`, this.config.auditContext);
         this.locales = (0, fs_1.existsSync)(masterLocalesPath) ? (0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(masterLocalesPath, 'utf8'))) : [];
+        cli_utilities_1.log.debug(`Loaded ${this.locales.length} locales from master-locale.json`, this.config.auditContext);
         if ((0, fs_1.existsSync)(localesPath)) {
-            this.locales.push(...(0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(localesPath, 'utf8'))));
+            cli_utilities_1.log.debug(`Loading additional locales from: ${localesPath}`, this.config.auditContext);
+            const additionalLocales = (0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(localesPath, 'utf8')));
+            this.locales.push(...additionalLocales);
+            cli_utilities_1.log.debug(`Added ${additionalLocales.length} additional locales`, this.config.auditContext);
+        }
+        else {
+            cli_utilities_1.log.debug('No additional locales file found', this.config.auditContext);
         }
         this.locales = this.locales.map((locale) => locale.code);
+        cli_utilities_1.log.debug(`Total locales loaded: ${this.locales.length}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Locale codes: ${this.locales.join(', ')}`, this.config.auditContext);
         const environmentPath = (0, path_1.resolve)(this.config.basePath, this.config.moduleConfig.environments.dirName, this.config.moduleConfig.environments.fileName);
+        cli_utilities_1.log.debug(`Loading environments from: ${environmentPath}`, this.config.auditContext);
         this.environments = (0, fs_1.existsSync)(environmentPath) ? (0, lodash_1.keys)(JSON.parse((0, fs_1.readFileSync)(environmentPath, 'utf8'))) : [];
+        cli_utilities_1.log.debug(`Total environments loaded: ${this.environments.length}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Environment names: ${this.environments.join(', ')}`, this.config.auditContext);
     }
     /**
      * The function checks if it can write the fix content to a file and if so, it writes the content as
@@ -77,61 +103,93 @@ class Assets {
      */
     async writeFixContent(filePath, schema) {
         var _a;
+        cli_utilities_1.log.debug(`Starting writeFixContent process for: ${filePath}`, this.config.auditContext);
         let canWrite = true;
         if (this.fix) {
+            cli_utilities_1.log.debug('Fix mode enabled, checking write permissions', this.config.auditContext);
             if (!this.config.flags['copy-dir'] && !((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm)) {
+                cli_utilities_1.log.debug(`Asking user for confirmation to write fix content (--yes flag: ${this.config.flags.yes})`, this.config.auditContext);
                 canWrite = this.config.flags.yes || (await cli_utilities_1.cliux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
             }
+            else {
+                cli_utilities_1.log.debug('Skipping confirmation due to copy-dir or external-config flags', this.config.auditContext);
+            }
             if (canWrite) {
+                cli_utilities_1.log.debug(`Writing fixed assets to: ${filePath}`, this.config.auditContext);
                 (0, fs_1.writeFileSync)(filePath, JSON.stringify(schema));
+                cli_utilities_1.log.debug(`Successfully wrote ${Object.keys(schema).length} assets to file`, this.config.auditContext);
             }
+            else {
+                cli_utilities_1.log.debug('User declined to write fix content', this.config.auditContext);
+            }
+        }
+        else {
+            cli_utilities_1.log.debug('Skipping writeFixContent - not in fix mode', this.config.auditContext);
         }
     }
     /**
      * This function traverse over the publish detials of the assets and remove the publish details where the locale or environment does not exist
      */
     async lookForReference() {
-        var _a, _b;
+        var _a, _b, _c, _d;
+        cli_utilities_1.log.debug('Starting asset reference validation', this.config.auditContext);
         let basePath = (0, path_1.join)(this.folderPath);
+        cli_utilities_1.log.debug(`Assets base path: ${basePath}`, this.config.auditContext);
         let fsUtility = new cli_utilities_1.FsUtility({ basePath, indexFileName: 'assets.json' });
         let indexer = fsUtility.indexFileContent;
+        cli_utilities_1.log.debug(`Found ${Object.keys(indexer).length} asset files to process`, this.config.auditContext);
         for (const fileIndex in indexer) {
+            cli_utilities_1.log.debug(`Processing asset file: ${indexer[fileIndex]}`, this.config.auditContext);
             const assets = (await fsUtility.readChunkFiles.next());
             this.assets = assets;
+            cli_utilities_1.log.debug(`Loaded ${Object.keys(assets).length} assets from file`, this.config.auditContext);
             for (const assetUid in assets) {
+                cli_utilities_1.log.debug(`Processing asset: ${assetUid}`, this.config.auditContext);
                 if (((_a = this.assets[assetUid]) === null || _a === void 0 ? void 0 : _a.publish_details) && !Array.isArray(this.assets[assetUid].publish_details)) {
-                    this.log((0, messages_1.$t)(messages_1.auditMsg.ASSET_NOT_EXIST, { uid: assetUid }), { color: 'red' });
+                    cli_utilities_1.log.debug(`Asset ${assetUid} has invalid publish_details format`, this.config.auditContext);
+                    cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.ASSET_NOT_EXIST, { uid: assetUid }), { color: 'red' });
                 }
-                this.assets[assetUid].publish_details = (_b = this.assets[assetUid]) === null || _b === void 0 ? void 0 : _b.publish_details.filter((pd) => {
+                const publishDetails = (_b = this.assets[assetUid]) === null || _b === void 0 ? void 0 : _b.publish_details;
+                cli_utilities_1.log.debug(`Asset ${assetUid} has ${(publishDetails === null || publishDetails === void 0 ? void 0 : publishDetails.length) || 0} publish details`, this.config.auditContext);
+                this.assets[assetUid].publish_details = (_c = this.assets[assetUid]) === null || _c === void 0 ? void 0 : _c.publish_details.filter((pd) => {
                     var _a, _b;
+                    cli_utilities_1.log.debug(`Checking publish detail: locale=${pd === null || pd === void 0 ? void 0 : pd.locale}, environment=${pd === null || pd === void 0 ? void 0 : pd.environment}`, this.config.auditContext);
                     if (((_a = this.locales) === null || _a === void 0 ? void 0 : _a.includes(pd === null || pd === void 0 ? void 0 : pd.locale)) && ((_b = this.environments) === null || _b === void 0 ? void 0 : _b.includes(pd === null || pd === void 0 ? void 0 : pd.environment))) {
-                        this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), { color: 'green' });
+                        cli_utilities_1.log.debug(`Publish detail valid for asset ${assetUid}: locale=${pd.locale}, environment=${pd.environment}`, this.config.auditContext);
+                        cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), this.config.auditContext);
                         return true;
                     }
                     else {
-                        this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_WARN_MSG, { uid: assetUid, locale: pd.locale, environment: pd.environment }), { color: 'yellow' });
+                        cli_utilities_1.log.debug(`Publish detail invalid for asset ${assetUid}: locale=${pd.locale}, environment=${pd.environment}`, this.config.auditContext);
+                        cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_WARN_MSG, { uid: assetUid, locale: pd.locale, environment: pd.environment }), { color: 'yellow' });
                         if (!Object.keys(this.missingEnvLocales).includes(assetUid)) {
+                            cli_utilities_1.log.debug(`Creating new missing reference entry for asset ${assetUid}`, this.config.auditContext);
                             this.missingEnvLocales[assetUid] = [
                                 { asset_uid: assetUid, publish_locale: pd.locale, publish_environment: pd.environment },
                             ];
                         }
                         else {
+                            cli_utilities_1.log.debug(`Adding to existing missing reference entry for asset ${assetUid}`, this.config.auditContext);
                             this.missingEnvLocales[assetUid].push({
                                 asset_uid: assetUid,
                                 publish_locale: pd.locale,
                                 publish_environment: pd.environment,
                             });
                         }
-                        this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), { color: 'green' });
+                        cli_utilities_1.log.success((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), this.config.auditContext);
                         return false;
                     }
                 });
+                const remainingPublishDetails = ((_d = this.assets[assetUid].publish_details) === null || _d === void 0 ? void 0 : _d.length) || 0;
+                cli_utilities_1.log.debug(`Asset ${assetUid} now has ${remainingPublishDetails} valid publish details`, this.config.auditContext);
                 if (this.fix) {
-                    this.log((0, messages_1.$t)(messages_1.auditFixMsg.ASSET_FIX, { uid: assetUid }), { color: 'green' });
+                    cli_utilities_1.log.debug(`Fixing asset ${assetUid}`, this.config.auditContext);
+                    cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditFixMsg.ASSET_FIX, { uid: assetUid }), this.config.auditContext);
                     await this.writeFixContent(`${basePath}/${indexer[fileIndex]}`, this.assets);
                 }
             }
         }
+        cli_utilities_1.log.debug(`Asset reference validation completed. Processed ${Object.keys(this.missingEnvLocales).length} assets with issues`, this.config.auditContext);
     }
 }
 exports.default = Assets;

package/lib/modules/content-types.d.ts

@@ -1,7 +1,6 @@
-import { LogFn, ConfigType, ModularBlockType, ContentTypeStruct, GroupFieldDataType, RefErrorReturnType, CtConstructorParam, GlobalFieldDataType, JsonRTEFieldDataType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, ContentTypeSchemaType, ExtensionOrAppFieldDataType } from '../types';
+import { ConfigType, ModularBlockType, ContentTypeStruct, GroupFieldDataType, RefErrorReturnType, CtConstructorParam, GlobalFieldDataType, JsonRTEFieldDataType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, ContentTypeSchemaType, ExtensionOrAppFieldDataType } from '../types';
 import auditConfig from '../config';
 export default class ContentType {
-    log: LogFn;
     protected fix: boolean;
     fileName: string;
     config: ConfigType;
@@ -15,7 +14,7 @@ export default class ContentType {
     protected schema: ContentTypeStruct[];
     protected missingRefs: Record<string, any>;
     moduleName: keyof typeof auditConfig.moduleConfig;
-    constructor({ log, fix, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam);
+    constructor({ fix, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam);
     validateModules(moduleName: keyof typeof auditConfig.moduleConfig, moduleConfig: Record<string, unknown>): keyof typeof auditConfig.moduleConfig;
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
@@ -127,7 +126,7 @@ export default class ContentType {
      * contains properties such as `data_type`, `field_metadata`, `uid`, `name`, etc.
      * @returns an array of ContentTypeSchemaType objects.
      */
-    runFixOnSchema(tree: Record<string, unknown>[], schema: ContentTypeSchemaType[]): ContentTypeSchemaType[];
+    runFixOnSchema(tree: Record<string, unknown>[], schema: ContentTypeSchemaType[]): any[];
     /**
      * The function fixes global field references in a tree structure by adding missing references and
      * returning the field if the reference exists, otherwise returning null.