@contentstack/cli-audit 1.14.2 → 1.16.0

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

@@ -1,7 +1,6 @@
-import { LogFn, ConfigType, CtConstructorParam, ModuleConstructorParam, CustomRole } from '../types';
+import { ConfigType, CtConstructorParam, ModuleConstructorParam, CustomRole } from '../types';
 import auditConfig from '../config';
 export default class CustomRoles {
-    log: LogFn;
     protected fix: boolean;
     fileName: any;
     config: ConfigType;
@@ -11,7 +10,7 @@ export default class CustomRoles {
     missingFieldsInCustomRoles: CustomRole[];
     customRolePath: string;
     isBranchFixDone: boolean;
-    constructor({ log, fix, config, moduleName }: ModuleConstructorParam & Pick<CtConstructorParam, 'ctSchema'>);
+    constructor({ fix, config, moduleName }: ModuleConstructorParam & Pick<CtConstructorParam, 'ctSchema'>);
     validateModules(moduleName: keyof typeof auditConfig.moduleConfig, moduleConfig: Record<string, unknown>): keyof typeof auditConfig.moduleConfig;
     /**
      * Check whether the given path for the custom role exists or not

package/lib/modules/custom-roles.js

@@ -7,9 +7,10 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
 const messages_1 = require("../messages");
 const lodash_2 = require("lodash");
 class CustomRoles {
-    constructor({ log, fix, config, moduleName }) {
-        this.log = log;
+    constructor({ fix, config, moduleName }) {
+        var _a;
         this.config = config;
+        cli_utilities_1.log.debug(`Initializing Custom Roles module`, this.config.auditContext);
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.customRoleSchema = [];
         this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
@@ -18,11 +19,19 @@ class CustomRoles {
         this.missingFieldsInCustomRoles = [];
         this.customRolePath = '';
         this.isBranchFixDone = false;
+        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);
+        cli_utilities_1.log.debug(`Branch filter: ${((_a = this.config) === null || _a === void 0 ? void 0 : _a.branch) || 'none'}`, this.config.auditContext);
     }
     validateModules(moduleName, moduleConfig) {
+        cli_utilities_1.log.debug(`Validating module: ${moduleName}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Available modules in config: ${Object.keys(moduleConfig).join(', ')}`, this.config.auditContext);
         if (Object.keys(moduleConfig).includes(moduleName)) {
+            cli_utilities_1.log.debug(`Module ${moduleName} found in config, returning: ${moduleName}`, this.config.auditContext);
             return moduleName;
         }
+        cli_utilities_1.log.debug(`Module ${moduleName} not found in config, defaulting to: custom-roles`, this.config.auditContext);
         return 'custom-roles';
     }
     /**
@@ -34,91 +43,162 @@ class CustomRoles {
     async run() {
         var _a, _b, _c, _d;
         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 {};
         }
         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;
+                    var _a, _b;
                     if (rule.module === 'branch') {
-                        branchesToBeRemoved = ((_a = rule === null || rule === void 0 ? void 0 : rule.branches) === null || _a === void 0 ? void 0 : _a.filter((branch) => { var _a; return branch !== ((_a = this.config) === null || _a === void 0 ? void 0 : _a.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);
                     }
                 });
             }
+            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);
             }
-            this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_CR_SUCCESS_MSG, {
+            cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditMsg.SCAN_CR_SUCCESS_MSG, {
                 name: customRole.name,
                 uid: customRole.uid,
-            }), 'info');
+            }), 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);
         }
+        else {
+            cli_utilities_1.log.debug('No fixes needed or fix mode disabled', this.config.auditContext);
+        }
+        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;
+        cli_utilities_1.log.debug('Starting custom role schema fix process', this.config.auditContext);
         const newCustomRoleSchema = (0, fs_1.existsSync)(this.customRolePath)
             ? JSON.parse((0, fs_1.readFileSync)(this.customRolePath, 'utf8'))
             : {};
+        cli_utilities_1.log.debug(`Loaded ${Object.keys(newCustomRoleSchema).length} custom roles from file`, this.config.auditContext);
         if (Object.keys(newCustomRoleSchema).length === 0 || !((_a = this.customRoleSchema) === null || _a === void 0 ? void 0 : _a.length)) {
+            cli_utilities_1.log.debug('No custom roles to fix or empty schema, skipping fix process', this.config.auditContext);
             return;
         }
+        cli_utilities_1.log.debug(`Processing ${this.customRoleSchema.length} custom roles for branch fixes`, this.config.auditContext);
         this.customRoleSchema.forEach((customRole) => {
             var _a, _b, _c, _d;
-            if (!this.config.branch)
+            cli_utilities_1.log.debug(`Fixing custom role: ${customRole.name} (${customRole.uid})`, this.config.auditContext);
+            if (!this.config.branch) {
+                cli_utilities_1.log.debug(`No branch configured, skipping fix for ${customRole.name}`, this.config.auditContext);
                 return;
+            }
+            cli_utilities_1.log.debug(`Looking for branch rules in custom role: ${customRole.name}`, this.config.auditContext);
             const fixedBranches = (_b = (_a = customRole.rules) === null || _a === void 0 ? void 0 : _a.filter((rule) => { var _a; return rule.module === 'branch' && ((_a = rule.branches) === null || _a === void 0 ? void 0 : _a.length); })) === null || _b === void 0 ? void 0 : _b.reduce((acc, rule) => {
-                var _a;
-                const relevantBranches = ((_a = rule.branches) === null || _a === void 0 ? void 0 : _a.filter((branch) => {
+                var _a, _b;
+                cli_utilities_1.log.debug(`Processing branch rule with branches: ${(_a = rule.branches) === null || _a === void 0 ? void 0 : _a.join(', ')}`, this.config.auditContext);
+                const relevantBranches = ((_b = rule.branches) === null || _b === void 0 ? void 0 : _b.filter((branch) => {
                     if (branch !== this.config.branch) {
-                        this.log((0, messages_1.$t)(messages_1.commonMsg.CR_BRANCH_REMOVAL, {
+                        cli_utilities_1.log.debug(`Removing branch ${branch} from custom role ${customRole.name}`, this.config.auditContext);
+                        cli_utilities_1.log.debug((0, messages_1.$t)(messages_1.commonMsg.CR_BRANCH_REMOVAL, {
                             uid: customRole.uid,
                             name: customRole.name,
                             branch,
-                        }), { color: 'yellow' });
+                        }), this.config.auditContext);
                         return false;
                     }
+                    else {
+                        cli_utilities_1.log.debug(`Keeping branch ${branch} for custom role ${customRole.name}`, this.config.auditContext);
+                    }
                     return true;
                 })) || [];
+                cli_utilities_1.log.debug(`Relevant branches after filtering: ${relevantBranches.join(', ')}`, this.config.auditContext);
                 return [...acc, ...relevantBranches];
             }, []);
+            cli_utilities_1.log.debug(`Fixed branches for ${customRole.name}: ${(fixedBranches === null || fixedBranches === void 0 ? void 0 : fixedBranches.join(', ')) || 'none'}`, this.config.auditContext);
             if (fixedBranches === null || fixedBranches === void 0 ? void 0 : fixedBranches.length) {
+                cli_utilities_1.log.debug(`Applying branch fix to custom role ${customRole.name}`, this.config.auditContext);
                 (_d = (_c = newCustomRoleSchema[customRole.uid].rules) === null || _c === void 0 ? void 0 : _c.filter((rule) => rule.module === 'branch')) === null || _d === void 0 ? void 0 : _d.forEach((rule) => {
+                    var _a;
+                    cli_utilities_1.log.debug(`Updating branch rule from ${(_a = rule.branches) === null || _a === void 0 ? void 0 : _a.join(', ')} to ${fixedBranches.join(', ')}`, this.config.auditContext);
                     rule.branches = fixedBranches;
                 });
             }
+            else {
+                cli_utilities_1.log.debug(`No branch fixes needed for custom role ${customRole.name}`, this.config.auditContext);
+            }
         });
+        cli_utilities_1.log.debug('Writing fixed custom role schema to file', this.config.auditContext);
         await this.writeFixContent(newCustomRoleSchema);
+        cli_utilities_1.log.debug('Custom role schema fix process completed', this.config.auditContext);
     }
     async writeFixContent(newCustomRoleSchema) {
         var _a;
-        if (this.fix &&
-            (this.config.flags['copy-dir'] ||
+        cli_utilities_1.log.debug('Starting writeFixContent process for custom roles', this.config.auditContext);
+        const filePath = (0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName);
+        cli_utilities_1.log.debug(`Target file path: ${filePath}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Custom roles to write: ${Object.keys(newCustomRoleSchema).length}`, this.config.auditContext);
+        if (this.fix) {
+            cli_utilities_1.log.debug('Fix mode enabled, checking write permissions', this.config.auditContext);
+            const skipConfirm = this.config.flags['copy-dir'] ||
                 ((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm) ||
-                this.config.flags.yes ||
-                (await cli_utilities_1.cliux.confirm(messages_1.commonMsg.FIX_CONFIRMATION)))) {
-            (0, fs_1.writeFileSync)((0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName), JSON.stringify(newCustomRoleSchema));
+                this.config.flags.yes;
+            if (skipConfirm) {
+                cli_utilities_1.log.debug('Skipping confirmation due to copy-dir, external-config, or yes flags', this.config.auditContext);
+            }
+            else {
+                cli_utilities_1.log.debug('Asking user for confirmation to write fix content', this.config.auditContext);
+            }
+            const canWrite = skipConfirm || (await cli_utilities_1.cliux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
+            if (canWrite) {
+                cli_utilities_1.log.debug(`Writing fixed custom roles to: ${filePath}`, this.config.auditContext);
+                (0, fs_1.writeFileSync)(filePath, JSON.stringify(newCustomRoleSchema));
+                cli_utilities_1.log.debug(`Successfully wrote ${Object.keys(newCustomRoleSchema).length} custom roles 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);
         }
     }
 }

package/lib/modules/entries.d.ts

@@ -1,7 +1,6 @@
 import auditConfig from '../config';
-import { LogFn, 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';
+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 {
-    log: LogFn;
     protected fix: boolean;
     fileName: string;
     locales: Locale[];
@@ -22,28 +21,14 @@ export default class Entries {
     environments: string[];
     entryMetaData: 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,
      * iterates over the schema and looks for references, and returns a list of missing references.
      * @returns the `missingRefs` object.
      */
-    run(): Promise<{
-        missingEntryRefs?: undefined;
-        missingSelectFeild?: undefined;
-        missingMandatoryFields?: undefined;
-        missingTitleFields?: undefined;
-        missingEnvLocale?: undefined;
-        missingMultipleFields?: undefined;
-    } | {
-        missingEntryRefs: Record<string, any>;
-        missingSelectFeild: Record<string, any>;
-        missingMandatoryFields: Record<string, any>;
-        missingTitleFields: Record<string, any>;
-        missingEnvLocale: Record<string, any>;
-        missingMultipleFields: Record<string, any>;
-    }>;
+    run(): Promise<{}>;
     /**
      * The function removes any properties from the `missingRefs` object that have an empty array value.
      */