@contentstack/cli-audit 1.17.0 → 2.0.0-beta.1

package/lib/modules/base-class.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+class BaseClass {
+    constructor({ config }) {
+        this.progressManager = null;
+        this.currentModuleName = '';
+        this.config = config;
+    }
+    /**
+     * Create simple progress manager
+     */
+    createSimpleProgress(moduleName, total) {
+        var _a;
+        this.currentModuleName = moduleName;
+        const logConfig = cli_utilities_1.configHandler.get('log') || {};
+        const showConsoleLogs = (_a = logConfig.showConsoleLogs) !== null && _a !== void 0 ? _a : false;
+        this.progressManager = cli_utilities_1.CLIProgressManager.createSimple(moduleName, total, showConsoleLogs);
+        return this.progressManager;
+    }
+    /**
+     * Create nested progress manager
+     */
+    createNestedProgress(moduleName) {
+        var _a;
+        this.currentModuleName = moduleName;
+        const logConfig = cli_utilities_1.configHandler.get('log') || {};
+        const showConsoleLogs = (_a = logConfig.showConsoleLogs) !== null && _a !== void 0 ? _a : false;
+        this.progressManager = cli_utilities_1.CLIProgressManager.createNested(moduleName, showConsoleLogs);
+        return this.progressManager;
+    }
+    /**
+     * Complete progress manager
+     */
+    completeProgress(success = true, error) {
+        var _a;
+        (_a = this.progressManager) === null || _a === void 0 ? void 0 : _a.complete(success, error);
+        this.progressManager = null;
+    }
+    /**
+     * Execute action with loading spinner (if console logs are disabled)
+     */
+    async withLoadingSpinner(message, action) {
+        var _a;
+        const logConfig = cli_utilities_1.configHandler.get('log') || {};
+        const showConsoleLogs = (_a = logConfig.showConsoleLogs) !== null && _a !== void 0 ? _a : false;
+        if (showConsoleLogs) {
+            // If console logs are enabled, don't show spinner, just execute the action
+            return await action();
+        }
+        return await cli_utilities_1.CLIProgressManager.withLoadingSpinner(message, action);
+    }
+}
+exports.default = BaseClass;

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

@@ -1,9 +1,9 @@
-import { ConfigType, ModularBlockType, ContentTypeStruct, GroupFieldDataType, RefErrorReturnType, CtConstructorParam, GlobalFieldDataType, JsonRTEFieldDataType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, ContentTypeSchemaType, ExtensionOrAppFieldDataType } from '../types';
+import { ModularBlockType, ContentTypeStruct, GroupFieldDataType, RefErrorReturnType, CtConstructorParam, GlobalFieldDataType, JsonRTEFieldDataType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, ContentTypeSchemaType, ExtensionOrAppFieldDataType } from '../types';
 import auditConfig from '../config';
-export default class ContentType {
+import BaseClass from './base-class';
+export default class ContentType extends BaseClass {
     protected fix: boolean;
     fileName: string;
-    config: ConfigType;
     folderPath: string;
     currentUid: string;
     currentTitle: string;
@@ -19,9 +19,11 @@ export default class ContentType {
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
      * iterates over the schema and looks for references, and returns a list of missing references.
+     * @param returnFixSchema - If true, returns the fixed schema instead of missing references
+     * @param totalCount - Total number of items to process (for progress tracking)
      * @returns the `missingRefs` object.
      */
-    run(returnFixSchema?: boolean): Promise<Record<string, any> | ContentTypeStruct[]>;
+    run(returnFixSchema?: boolean, totalCount?: number): Promise<Record<string, any> | ContentTypeStruct[]>;
     /**
      * @method prerequisiteData
      * The `prerequisiteData` function reads and parses JSON files to retrieve extension and marketplace

package/lib/modules/content-types.js

@@ -8,15 +8,16 @@ const path_1 = require("path");
 const fs_1 = require("fs");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const messages_1 = require("../messages");
+const base_class_1 = tslib_1.__importDefault(require("./base-class"));
 /* The `ContentType` class is responsible for scanning content types, looking for references, and
 generating a report in JSON and CSV formats. */
-class ContentType {
+class ContentType extends base_class_1.default {
     constructor({ fix, config, moduleName, ctSchema, gfSchema }) {
+        super({ config });
         this.extensions = [];
         this.inMemoryFix = false;
         this.schema = [];
         this.missingRefs = {};
-        this.config = config;
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.ctSchema = ctSchema;
         this.gfSchema = gfSchema;
@@ -38,49 +39,70 @@ class ContentType {
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
      * iterates over the schema and looks for references, and returns a list of missing references.
+     * @param returnFixSchema - If true, returns the fixed schema instead of missing references
+     * @param totalCount - Total number of items to process (for progress tracking)
      * @returns the `missingRefs` object.
      */
-    async run(returnFixSchema = false) {
+    async run(returnFixSchema = false, totalCount) {
         var _a, _b, _c;
-        this.inMemoryFix = returnFixSchema;
-        if (!(0, fs_1.existsSync)(this.folderPath)) {
-            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 ? [] : {};
-        }
-        this.schema = this.moduleName === 'content-types' ? this.ctSchema : this.gfSchema;
-        cli_utilities_1.log.debug(`Found ${((_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) || 0} ${this.moduleName} schemas to audit`, this.config.auditContext);
-        await this.prerequisiteData();
-        for (const schema of (_b = this.schema) !== null && _b !== void 0 ? _b : []) {
-            this.currentUid = schema.uid;
-            this.currentTitle = schema.title;
-            this.missingRefs[this.currentUid] = [];
-            const { uid, title } = schema;
-            cli_utilities_1.log.debug(`Auditing ${this.moduleName}: ${title} (${uid})`, this.config.auditContext);
-            await this.lookForReference([{ uid, name: title }], schema);
-            cli_utilities_1.log.debug((0, messages_1.$t)(messages_1.auditMsg.SCAN_CT_SUCCESS_MSG, { title, module: this.config.moduleConfig[this.moduleName].name }), this.config.auditContext);
-        }
-        if (returnFixSchema) {
-            cli_utilities_1.log.debug(`Returning fixed schema with ${((_c = this.schema) === null || _c === void 0 ? void 0 : _c.length) || 0} items`, this.config.auditContext);
-            return this.schema;
-        }
-        if (this.fix) {
-            cli_utilities_1.log.debug('Writing fix content to files', this.config.auditContext);
-            await this.writeFixContent();
-        }
-        cli_utilities_1.log.debug('Cleaning up empty missing references', this.config.auditContext);
-        cli_utilities_1.log.debug(`Total missing reference properties: ${Object.keys(this.missingRefs).length}`, this.config.auditContext);
-        for (let propName in this.missingRefs) {
-            const refCount = this.missingRefs[propName].length;
-            cli_utilities_1.log.debug(`Property ${propName}: ${refCount} missing references`, this.config.auditContext);
-            if (!refCount) {
-                cli_utilities_1.log.debug(`Removing empty property: ${propName}`, this.config.auditContext);
-                delete this.missingRefs[propName];
+        try {
+            this.inMemoryFix = returnFixSchema;
+            if (!(0, fs_1.existsSync)(this.folderPath)) {
+                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 ? [] : {};
+            }
+            this.schema = this.moduleName === 'content-types' ? this.ctSchema : this.gfSchema;
+            cli_utilities_1.log.debug(`Found ${((_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) || 0} ${this.moduleName} schemas to audit`, this.config.auditContext);
+            // Load prerequisite data with loading spinner
+            await this.withLoadingSpinner(`${this.moduleName.toUpperCase()}: Loading prerequisite data...`, async () => {
+                await this.prerequisiteData();
+            });
+            // Create progress manager if we have a total count
+            if (totalCount && totalCount > 0) {
+                const progress = this.createSimpleProgress(this.moduleName, totalCount);
+                progress.updateStatus('Validating references...');
+            }
+            for (const schema of (_b = this.schema) !== null && _b !== void 0 ? _b : []) {
+                this.currentUid = schema.uid;
+                this.currentTitle = schema.title;
+                this.missingRefs[this.currentUid] = [];
+                const { uid, title } = schema;
+                cli_utilities_1.log.debug(`Auditing ${this.moduleName}: ${title} (${uid})`, this.config.auditContext);
+                await this.lookForReference([{ uid, name: title }], schema);
+                cli_utilities_1.log.debug((0, messages_1.$t)(messages_1.auditMsg.SCAN_CT_SUCCESS_MSG, { title, module: this.config.moduleConfig[this.moduleName].name }), this.config.auditContext);
+                // Track progress for each schema processed
+                if (this.progressManager) {
+                    this.progressManager.tick(true, `${this.moduleName}: ${title}`, null);
+                }
             }
+            if (returnFixSchema) {
+                cli_utilities_1.log.debug(`Returning fixed schema with ${((_c = this.schema) === null || _c === void 0 ? void 0 : _c.length) || 0} items`, this.config.auditContext);
+                return this.schema;
+            }
+            if (this.fix) {
+                cli_utilities_1.log.debug('Writing fix content to files', this.config.auditContext);
+                await this.writeFixContent();
+            }
+            cli_utilities_1.log.debug('Cleaning up empty missing references', this.config.auditContext);
+            cli_utilities_1.log.debug(`Total missing reference properties: ${Object.keys(this.missingRefs).length}`, this.config.auditContext);
+            for (let propName in this.missingRefs) {
+                const refCount = this.missingRefs[propName].length;
+                cli_utilities_1.log.debug(`Property ${propName}: ${refCount} missing references`, this.config.auditContext);
+                if (!refCount) {
+                    cli_utilities_1.log.debug(`Removing empty property: ${propName}`, this.config.auditContext);
+                    delete this.missingRefs[propName];
+                }
+            }
+            const totalIssues = Object.keys(this.missingRefs).length;
+            cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${totalIssues} schemas with issues`, this.config.auditContext);
+            this.completeProgress(true);
+            return this.missingRefs;
+        }
+        catch (error) {
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || `${this.moduleName} audit failed`);
+            throw error;
         }
-        const totalIssues = Object.keys(this.missingRefs).length;
-        cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${totalIssues} schemas with issues`, this.config.auditContext);
-        return this.missingRefs;
     }
     /**
      * @method prerequisiteData

package/lib/modules/custom-roles.d.ts

@@ -1,9 +1,9 @@
-import { ConfigType, CtConstructorParam, ModuleConstructorParam, CustomRole } from '../types';
+import { CtConstructorParam, ModuleConstructorParam, CustomRole } from '../types';
 import auditConfig from '../config';
-export default class CustomRoles {
+import BaseClass from './base-class';
+export default class CustomRoles extends BaseClass {
     protected fix: boolean;
     fileName: any;
-    config: ConfigType;
     folderPath: string;
     customRoleSchema: CustomRole[];
     moduleName: keyof typeof auditConfig.moduleConfig;
@@ -18,7 +18,7 @@ export default class CustomRoles {
      * From the ctSchema add all the content type UID into ctUidSet to check whether the content-type is present or not
      * @returns Array of object containing the custom role name, uid and content_types that are missing
      */
-    run(): Promise<{}>;
+    run(totalCount?: number): Promise<{}>;
     fixCustomRoleSchema(): Promise<void>;
     writeFixContent(newCustomRoleSchema: Record<string, CustomRole>): Promise<void>;
 }

package/lib/modules/custom-roles.js

@@ -1,15 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
 const path_1 = require("path");
 const fs_1 = require("fs");
 const lodash_1 = require("lodash");
 const cli_utilities_1 = require("@contentstack/cli-utilities");
 const messages_1 = require("../messages");
 const lodash_2 = require("lodash");
-class CustomRoles {
+const base_class_1 = tslib_1.__importDefault(require("./base-class"));
+class CustomRoles extends base_class_1.default {
     constructor({ fix, config, moduleName }) {
         var _a;
-        this.config = config;
+        super({ config });
         cli_utilities_1.log.debug(`Initializing Custom Roles module`, this.config.auditContext);
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.customRoleSchema = [];
@@ -40,77 +42,96 @@ class CustomRoles {
      * From the ctSchema add all the content type UID into ctUidSet to check whether the content-type is present or not
      * @returns Array of object containing the custom role name, uid and content_types that are missing
      */
-    async run() {
+    async run(totalCount) {
         var _a, _b, _c, _d;
-        if (!(0, fs_1.existsSync)(this.folderPath)) {
-            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 {};
-        }
-        this.customRolePath = (0, path_1.join)(this.folderPath, this.fileName);
-        cli_utilities_1.log.debug(`Custom roles file path: ${this.customRolePath}`, this.config.auditContext);
-        this.customRoleSchema = (0, fs_1.existsSync)(this.customRolePath)
-            ? (0, lodash_2.values)(JSON.parse((0, fs_1.readFileSync)(this.customRolePath, 'utf8')))
-            : [];
-        cli_utilities_1.log.debug(`Found ${this.customRoleSchema.length} custom roles to audit`, this.config.auditContext);
-        for (let index = 0; index < ((_a = this.customRoleSchema) === null || _a === void 0 ? void 0 : _a.length); index++) {
-            const customRole = this.customRoleSchema[index];
-            cli_utilities_1.log.debug(`Processing custom role: ${customRole.name} (${customRole.uid})`, this.config.auditContext);
-            let branchesToBeRemoved = [];
-            if ((_b = this.config) === null || _b === void 0 ? void 0 : _b.branch) {
-                cli_utilities_1.log.debug(`Config branch : ${this.config.branch}`, this.config.auditContext);
-                cli_utilities_1.log.debug(`Checking branch rules for custom role: ${customRole.name}`, this.config.auditContext);
-                (_c = customRole === null || customRole === void 0 ? void 0 : customRole.rules) === null || _c === void 0 ? void 0 : _c.filter((rule) => {
-                    var _a, _b;
-                    if (rule.module === 'branch') {
-                        cli_utilities_1.log.debug(`Found branch rule with branches: ${((_a = rule === null || rule === void 0 ? void 0 : rule.branches) === null || _a === void 0 ? void 0 : _a.join(', ')) || 'none'}`, this.config.auditContext);
-                        branchesToBeRemoved = ((_b = rule === null || rule === void 0 ? void 0 : rule.branches) === null || _b === void 0 ? void 0 : _b.filter((branch) => { var _a; return branch !== ((_a = this.config) === null || _a === void 0 ? void 0 : _a.branch); })) || [];
-                        cli_utilities_1.log.debug(`Branches to be removed: ${branchesToBeRemoved.join(', ') || 'none'}`, this.config.auditContext);
-                    }
-                });
+        try {
+            if (!(0, fs_1.existsSync)(this.folderPath)) {
+                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 {};
             }
-            else {
-                cli_utilities_1.log.debug(`No branch filter configured, skipping branch validation`, this.config.auditContext);
+            this.customRolePath = (0, path_1.join)(this.folderPath, this.fileName);
+            cli_utilities_1.log.debug(`Custom roles file path: ${this.customRolePath}`, this.config.auditContext);
+            // Load custom roles schema with loading spinner
+            await this.withLoadingSpinner('CUSTOM-ROLES: Loading custom roles schema...', async () => {
+                this.customRoleSchema = (0, fs_1.existsSync)(this.customRolePath)
+                    ? (0, lodash_2.values)(JSON.parse((0, fs_1.readFileSync)(this.customRolePath, 'utf8')))
+                    : [];
+            });
+            cli_utilities_1.log.debug(`Found ${this.customRoleSchema.length} custom roles to audit`, this.config.auditContext);
+            // Create progress manager if we have a total count
+            if (totalCount && totalCount > 0) {
+                const progress = this.createSimpleProgress(this.moduleName, totalCount);
+                progress.updateStatus('Validating custom roles...');
             }
-            if (branchesToBeRemoved === null || branchesToBeRemoved === void 0 ? void 0 : branchesToBeRemoved.length) {
-                cli_utilities_1.log.debug(`Custom role ${customRole.name} has branches to be removed: ${branchesToBeRemoved.join(', ')}`, this.config.auditContext);
-                this.isBranchFixDone = true;
-                const tempCR = (0, lodash_1.cloneDeep)(customRole);
-                if ((customRole === null || customRole === void 0 ? void 0 : customRole.rules) && ((_d = this.config) === null || _d === void 0 ? void 0 : _d.branch)) {
-                    cli_utilities_1.log.debug(`Applying branch fix to custom role: ${customRole.name}`, this.config.auditContext);
-                    tempCR.rules.forEach((rule) => {
-                        var _a;
+            for (let index = 0; index < ((_a = this.customRoleSchema) === null || _a === void 0 ? void 0 : _a.length); index++) {
+                const customRole = this.customRoleSchema[index];
+                cli_utilities_1.log.debug(`Processing custom role: ${customRole.name} (${customRole.uid})`, this.config.auditContext);
+                let branchesToBeRemoved = [];
+                if ((_b = this.config) === null || _b === void 0 ? void 0 : _b.branch) {
+                    cli_utilities_1.log.debug(`Config branch : ${this.config.branch}`, this.config.auditContext);
+                    cli_utilities_1.log.debug(`Checking branch rules for custom role: ${customRole.name}`, this.config.auditContext);
+                    (_c = customRole === null || customRole === void 0 ? void 0 : customRole.rules) === null || _c === void 0 ? void 0 : _c.filter((rule) => {
+                        var _a, _b;
                         if (rule.module === 'branch') {
-                            cli_utilities_1.log.debug(`Updating branch rule branches from ${(_a = rule.branches) === null || _a === void 0 ? void 0 : _a.join(', ')} to ${branchesToBeRemoved.join(', ')}`, this.config.auditContext);
-                            rule.branches = branchesToBeRemoved;
+                            cli_utilities_1.log.debug(`Found branch rule with branches: ${((_a = rule === null || rule === void 0 ? void 0 : rule.branches) === null || _a === void 0 ? void 0 : _a.join(', ')) || 'none'}`, this.config.auditContext);
+                            branchesToBeRemoved = ((_b = rule === null || rule === void 0 ? void 0 : rule.branches) === null || _b === void 0 ? void 0 : _b.filter((branch) => { var _a; return branch !== ((_a = this.config) === null || _a === void 0 ? void 0 : _a.branch); })) || [];
+                            cli_utilities_1.log.debug(`Branches to be removed: ${branchesToBeRemoved.join(', ') || 'none'}`, this.config.auditContext);
                         }
                     });
                 }
-                this.missingFieldsInCustomRoles.push(tempCR);
-                cli_utilities_1.log.debug(`Added custom role ${customRole.name} to missing fields list`, this.config.auditContext);
+                else {
+                    cli_utilities_1.log.debug(`No branch filter configured, skipping branch validation`, this.config.auditContext);
+                }
+                if (branchesToBeRemoved === null || branchesToBeRemoved === void 0 ? void 0 : branchesToBeRemoved.length) {
+                    cli_utilities_1.log.debug(`Custom role ${customRole.name} has branches to be removed: ${branchesToBeRemoved.join(', ')}`, this.config.auditContext);
+                    this.isBranchFixDone = true;
+                    const tempCR = (0, lodash_1.cloneDeep)(customRole);
+                    if ((customRole === null || customRole === void 0 ? void 0 : customRole.rules) && ((_d = this.config) === null || _d === void 0 ? void 0 : _d.branch)) {
+                        cli_utilities_1.log.debug(`Applying branch fix to custom role: ${customRole.name}`, this.config.auditContext);
+                        tempCR.rules.forEach((rule) => {
+                            var _a;
+                            if (rule.module === 'branch') {
+                                cli_utilities_1.log.debug(`Updating branch rule branches from ${(_a = rule.branches) === null || _a === void 0 ? void 0 : _a.join(', ')} to ${branchesToBeRemoved.join(', ')}`, this.config.auditContext);
+                                rule.branches = branchesToBeRemoved;
+                            }
+                        });
+                    }
+                    this.missingFieldsInCustomRoles.push(tempCR);
+                    cli_utilities_1.log.debug(`Added custom role ${customRole.name} to missing fields list`, this.config.auditContext);
+                }
+                else {
+                    cli_utilities_1.log.debug(`Custom role ${customRole.name} has no branch issues`, this.config.auditContext);
+                }
+                cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditMsg.SCAN_CR_SUCCESS_MSG, {
+                    name: customRole.name,
+                    uid: customRole.uid,
+                }), this.config.auditContext);
+                // Track progress for each custom role processed
+                if (this.progressManager) {
+                    this.progressManager.tick(true, `custom-role: ${customRole.name}`, null);
+                }
+            }
+            cli_utilities_1.log.debug(`Found ${this.missingFieldsInCustomRoles.length} custom roles with issues`, this.config.auditContext);
+            cli_utilities_1.log.debug(`Branch fix done: ${this.isBranchFixDone}`, this.config.auditContext);
+            if (this.fix && (this.missingFieldsInCustomRoles.length || this.isBranchFixDone)) {
+                cli_utilities_1.log.debug('Fix mode enabled and issues found, applying fixes', this.config.auditContext);
+                await this.fixCustomRoleSchema();
+                this.missingFieldsInCustomRoles.forEach((cr) => (cr.fixStatus = 'Fixed'));
+                cli_utilities_1.log.debug(`Applied fixes to ${this.missingFieldsInCustomRoles.length} custom roles`, this.config.auditContext);
             }
             else {
-                cli_utilities_1.log.debug(`Custom role ${customRole.name} has no branch issues`, this.config.auditContext);
+                cli_utilities_1.log.debug('No fixes needed or fix mode disabled', this.config.auditContext);
             }
-            cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditMsg.SCAN_CR_SUCCESS_MSG, {
-                name: customRole.name,
-                uid: customRole.uid,
-            }), this.config.auditContext);
-        }
-        cli_utilities_1.log.debug(`Found ${this.missingFieldsInCustomRoles.length} custom roles with issues`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Branch fix done: ${this.isBranchFixDone}`, this.config.auditContext);
-        if (this.fix && (this.missingFieldsInCustomRoles.length || this.isBranchFixDone)) {
-            cli_utilities_1.log.debug('Fix mode enabled and issues found, applying fixes', this.config.auditContext);
-            await this.fixCustomRoleSchema();
-            this.missingFieldsInCustomRoles.forEach((cr) => (cr.fixStatus = 'Fixed'));
-            cli_utilities_1.log.debug(`Applied fixes to ${this.missingFieldsInCustomRoles.length} custom roles`, this.config.auditContext);
+            cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${this.missingFieldsInCustomRoles.length} custom roles with issues`, this.config.auditContext);
+            this.completeProgress(true);
+            return this.missingFieldsInCustomRoles;
         }
-        else {
-            cli_utilities_1.log.debug('No fixes needed or fix mode disabled', this.config.auditContext);
+        catch (error) {
+            this.completeProgress(false, (error === null || error === void 0 ? void 0 : error.message) || 'Custom roles audit failed');
+            throw error;
         }
-        cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${this.missingFieldsInCustomRoles.length} custom roles with issues`, this.config.auditContext);
-        return this.missingFieldsInCustomRoles;
     }
     async fixCustomRoleSchema() {
         var _a;

package/lib/modules/entries.d.ts

@@ -1,10 +1,10 @@
 import auditConfig from '../config';
-import { Locale, ConfigType, EntryStruct, EntryFieldType, ModularBlockType, ContentTypeStruct, CtConstructorParam, GroupFieldDataType, GlobalFieldDataType, JsonRTEFieldDataType, ContentTypeSchemaType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, EntryRefErrorReturnType, EntryGroupFieldDataType, EntryGlobalFieldDataType, EntryJsonRTEFieldDataType, EntryModularBlocksDataType, EntryReferenceFieldDataType, ExtensionOrAppFieldDataType, EntryExtensionOrAppFieldDataType, SelectFeildStruct } from '../types';
-export default class Entries {
+import BaseClass from './base-class';
+import { Locale, EntryStruct, EntryFieldType, ModularBlockType, ContentTypeStruct, CtConstructorParam, GroupFieldDataType, GlobalFieldDataType, JsonRTEFieldDataType, ContentTypeSchemaType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, EntryRefErrorReturnType, EntryGroupFieldDataType, EntryGlobalFieldDataType, EntryJsonRTEFieldDataType, EntryModularBlocksDataType, EntryReferenceFieldDataType, ExtensionOrAppFieldDataType, EntryExtensionOrAppFieldDataType, SelectFeildStruct } from '../types';
+export default class Entries extends BaseClass {
     protected fix: boolean;
     fileName: string;
     locales: Locale[];
-    config: ConfigType;
     folderPath: string;
     currentUid: string;
     currentTitle: string;
@@ -26,9 +26,10 @@ export default class Entries {
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
      * iterates over the schema and looks for references, and returns a list of missing references.
+     * @param totalCount - Total number of entries to process (for progress tracking)
      * @returns the `missingRefs` object.
      */
-    run(): Promise<{}>;
+    run(totalCount?: number): Promise<{}>;
     /**
      * The function removes any properties from the `missingRefs` object that have an empty array value.
      */