@contentstack/cli-audit 1.6.1 → 1.6.3

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.6.1 linux-x64 node-v18.20.2
+@contentstack/cli-audit/1.6.3 linux-x64 node-v18.20.3
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -267,7 +267,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.21/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:add PLUGIN`
 
@@ -292,7 +292,7 @@ GLOBAL FLAGS
 DESCRIPTION
   Installs a plugin into csdx.
 
-  Uses bundled npm executable to install plugins into /home/runner/.local/share/@contentstack/cli-audit
+  Uses npm to install plugins.
 
   Installation of a user-installed plugin will override a core plugin.
 
@@ -341,7 +341,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.21/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN`
 
@@ -366,7 +366,7 @@ GLOBAL FLAGS
 DESCRIPTION
   Installs a plugin into csdx.
 
-  Uses bundled npm executable to install plugins into /home/runner/.local/share/@contentstack/cli-audit
+  Uses npm to install plugins.
 
   Installation of a user-installed plugin will override a core plugin.
 
@@ -390,7 +390,7 @@ EXAMPLES
     $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.21/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PATH`
 
@@ -420,7 +420,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.21/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:remove [PLUGIN]`
 
@@ -461,7 +461,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.21/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall [PLUGIN]`
 
@@ -489,7 +489,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.21/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:unlink [PLUGIN]`
 
@@ -533,5 +533,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.0.21/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.3.3/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/lib/audit-base-command.js

@@ -317,7 +317,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             (0, fs_1.mkdirSync)(this.sharedConfig.reportPath, { recursive: true });
         }
         // NOTE write int json
-        (0, fs_1.writeFileSync)((0, path_1.join)(this.sharedConfig.reportPath, `${moduleName}.json`), JSON.stringify(listOfMissingRefs));
+        (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));
         // NOTE write into CSV
         return this.prepareCSV(moduleName, listOfMissingRefs);
     }
@@ -332,44 +332,51 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * @returns The function `prepareCSV` returns a Promise that resolves to `void`.
      */
     prepareCSV(moduleName, listOfMissingRefs) {
-        const csvPath = (0, path_1.join)(this.sharedConfig.reportPath, `${moduleName}.csv`);
-        return new Promise((resolve, reject) => {
-            // file deepcode ignore MissingClose: Will auto close once csv stream end
-            const ws = (0, fs_1.createWriteStream)(csvPath).on('error', reject);
-            const defaultColumns = Object.keys(types_1.OutputColumn);
-            const userDefinedColumns = this.sharedConfig.flags.columns ? this.sharedConfig.flags.columns.split(',') : null;
-            let missingRefs = Object.values(listOfMissingRefs).flat();
-            const columns = userDefinedColumns
-                ? [...userDefinedColumns, ...defaultColumns.filter((val) => !userDefinedColumns.includes(val))]
-                : defaultColumns;
-            if (this.sharedConfig.flags.filter) {
-                const [column, value] = this.sharedConfig.flags.filter.split('=');
-                // Filter the missingRefs array
-                missingRefs = missingRefs.filter((row) => {
-                    if (types_1.OutputColumn[column] in row) {
-                        const rowKey = types_1.OutputColumn[column];
-                        return row[rowKey] === value;
+        if (Object.keys(config_1.default.moduleConfig).includes(moduleName)) {
+            const csvPath = (0, path_1.join)((0, cli_utilities_1.sanitizePath)(this.sharedConfig.reportPath), `${(0, cli_utilities_1.sanitizePath)(moduleName)}.csv`);
+            return new Promise((resolve, reject) => {
+                // file deepcode ignore MissingClose: Will auto close once csv stream end
+                const ws = (0, fs_1.createWriteStream)(csvPath).on('error', reject);
+                const defaultColumns = Object.keys(types_1.OutputColumn);
+                const userDefinedColumns = this.sharedConfig.flags.columns ? this.sharedConfig.flags.columns.split(',') : null;
+                let missingRefs = Object.values(listOfMissingRefs).flat();
+                const columns = userDefinedColumns
+                    ? [...userDefinedColumns, ...defaultColumns.filter((val) => !userDefinedColumns.includes(val))]
+                    : defaultColumns;
+                if (this.sharedConfig.flags.filter) {
+                    const [column, value] = this.sharedConfig.flags.filter.split('=');
+                    // Filter the missingRefs array
+                    missingRefs = missingRefs.filter((row) => {
+                        if (types_1.OutputColumn[column] in row) {
+                            const rowKey = types_1.OutputColumn[column];
+                            return row[rowKey] === value;
+                        }
+                        return false;
+                    });
+                }
+                const rowData = [];
+                for (const issue of missingRefs) {
+                    let row = {};
+                    for (const column of columns) {
+                        if (Object.keys(issue).includes(types_1.OutputColumn[column])) {
+                            const issueKey = types_1.OutputColumn[column];
+                            row[column] = issue[issueKey];
+                            row[column] = typeof row[column] === 'object' ? JSON.stringify(row[column]) : row[column];
+                        }
                     }
-                    return false;
-                });
-            }
-            const rowData = [];
-            for (const issue of missingRefs) {
-                let row = {};
-                for (const column of columns) {
-                    if (Object.keys(issue).includes(types_1.OutputColumn[column])) {
-                        const issueKey = types_1.OutputColumn[column];
-                        row[column] = issue[issueKey];
-                        row[column] = typeof row[column] === 'object' ? JSON.stringify(row[column]) : row[column];
+                    if (this.currentCommand === 'cm:stacks:audit:fix') {
+                        row['Fix status'] = row.fixStatus;
                     }
+                    rowData.push(row);
                 }
-                if (this.currentCommand === 'cm:stacks:audit:fix') {
-                    row['Fix status'] = row.fixStatus;
-                }
-                rowData.push(row);
-            }
-            csv.write(rowData, { headers: true }).pipe(ws).on('error', reject).on('finish', resolve);
-        });
+                csv.write(rowData, { headers: true }).pipe(ws).on('error', reject).on('finish', resolve);
+            });
+        }
+        else {
+            return new Promise((reject) => {
+                return reject();
+            });
+        }
     }
 }
 exports.AuditBaseCommand = AuditBaseCommand;

package/lib/messages/index.js

@@ -49,8 +49,8 @@ const auditFixMsg = {
     EMPTY_FIX_MSG: 'Successfully removed the empty field/block found at {path} from the schema.',
     AUDIT_FIX_CMD_DESCRIPTION: 'Perform audits and fix possible errors in the exported Contentstack data.',
     WF_FIX_MSG: 'Successfully removed the workflow {uid} named {name}.',
-    ENTRY_MANDATORY_FIELD_FIX: `Removing the publish details from entry uid '{uid}' from locale '{locale}'`,
-    ENTRY_SELECT_FIELD_FIX: `Adding the value '{value}' in select field of uid '{uid}'`
+    ENTRY_MANDATORY_FIELD_FIX: `Removing the publish details from the entry with UID '{uid}' in Locale '{locale}'...`,
+    ENTRY_SELECT_FIELD_FIX: `Adding the value '{value}' in the select field of entry UID '{uid}'...`
 };
 exports.auditFixMsg = auditFixMsg;
 const messages = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, errors), commonMsg), auditMsg), auditFixMsg), tableColumnDescriptions);
@@ -69,7 +69,12 @@ function $t(msg, args) {
             return '';
         for (const key of Object.keys(args)) {
             const escapedKey = (0, cli_utilities_1.escapeRegExp)(key);
-            msg = msg.replace(new RegExp(`{${escapedKey}}`, 'g'), (0, cli_utilities_1.escapeRegExp)(args[key]) || escapedKey);
+            const escapedKeyRegex = new RegExp(`{${escapedKey}}`, 'g');
+            let { status } = (0, cli_utilities_1.validateRegex)(escapedKeyRegex);
+            if (status === 'safe') {
+                const sanitizedValue = args[key] ? (0, cli_utilities_1.escapeRegExp)(args[key]) : '';
+                msg = msg.replace(escapedKeyRegex, sanitizedValue || escapedKey);
+            }
         }
         return msg;
     });

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

@@ -16,6 +16,7 @@ export default class ContentType {
     protected missingRefs: Record<string, any>;
     moduleName: keyof typeof auditConfig.moduleConfig;
     constructor({ log, 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.

package/lib/modules/content-types.js

@@ -21,9 +21,15 @@ class ContentType {
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.ctSchema = ctSchema;
         this.gfSchema = gfSchema;
-        this.moduleName = moduleName !== null && moduleName !== void 0 ? moduleName : 'content-types';
+        this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
         this.fileName = config.moduleConfig[this.moduleName].fileName;
-        this.folderPath = (0, path_1.resolve)(config.basePath, config.moduleConfig[this.moduleName].dirName);
+        this.folderPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.basePath), (0, cli_utilities_1.sanitizePath)(config.moduleConfig[this.moduleName].dirName));
+    }
+    validateModules(moduleName, moduleConfig) {
+        if (Object.keys(moduleConfig).includes(moduleName)) {
+            return moduleName;
+        }
+        return 'content-types';
     }
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,

package/lib/modules/entries.d.ts

@@ -18,8 +18,8 @@ export default class Entries {
     protected missingMandatoryFields: Record<string, any>;
     entryMetaData: Record<string, any>[];
     moduleName: keyof typeof auditConfig.moduleConfig;
-    isEntryWithoutTitleField: boolean;
     constructor({ log, 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.

package/lib/modules/entries.js

@@ -20,15 +20,20 @@ class Entries {
         this.missingMandatoryFields = {};
         this.entryMetaData = [];
         this.moduleName = 'entries';
-        this.isEntryWithoutTitleField = false;
         this.log = log;
         this.config = config;
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.ctSchema = ctSchema;
         this.gfSchema = gfSchema;
-        this.moduleName = moduleName !== null && moduleName !== void 0 ? moduleName : 'entries';
+        this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
         this.fileName = config.moduleConfig[this.moduleName].fileName;
-        this.folderPath = (0, path_1.resolve)(config.basePath, config.moduleConfig.entries.dirName);
+        this.folderPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.basePath), (0, cli_utilities_1.sanitizePath)(config.moduleConfig.entries.dirName));
+    }
+    validateModules(moduleName, moduleConfig) {
+        if (Object.keys(moduleConfig).includes(moduleName)) {
+            return moduleName;
+        }
+        return 'entries';
     }
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
@@ -36,6 +41,7 @@ class Entries {
      * @returns the `missingRefs` object.
      */
     async run() {
+        var _a;
         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' });
@@ -70,7 +76,7 @@ class Entries {
                         }
                         this.lookForReference([{ locale: code, uid, name: title }], ctSchema, this.entries[entryUid]);
                         const fields = this.missingMandatoryFields[uid];
-                        const isPublished = entry.publish_details.length > 0;
+                        const isPublished = ((_a = entry.publish_details) === null || _a === void 0 ? void 0 : _a.length) > 0;
                         if ((this.fix && fields.length && isPublished) || (!this.fix && fields)) {
                             const fixStatus = this.fix ? 'Fixed' : '';
                             fields === null || fields === void 0 ? void 0 : fields.forEach((field) => {
@@ -977,21 +983,16 @@ class Entries {
                     for (const entryUid in entries) {
                         let { title } = entries[entryUid];
                         if (entries[entryUid].hasOwnProperty('title') && !title) {
-                            this.isEntryWithoutTitleField = true;
                             this.log(`The 'title' field in Entry with UID '${entryUid}' of Content Type '${uid}' in Locale '${code}' is empty.`, `error`);
                         }
                         else if (!title) {
-                            this.isEntryWithoutTitleField = true;
-                            this.log(`Entry with UID '${entryUid}' of Content Type '${uid}' in Locale '${code}' does not have a 'title' field.`, `error`);
+                            this.log(`The 'title' field in Entry with UID '${entryUid}' of Content Type '${uid}' in Locale '${code}' is empty.`, `error`);
                         }
                         this.entryMetaData.push({ uid: entryUid, title });
                     }
                 }
             }
         }
-        if (this.isEntryWithoutTitleField) {
-            // throw Error(`Entries found with missing 'title' field! Please make the data corrections and re-run the audit.`);
-        }
     }
 }
 exports.default = Entries;

package/lib/modules/extensions.d.ts

@@ -14,6 +14,7 @@ export default class Extensions {
     missingCts: Set<string>;
     extensionsPath: string;
     constructor({ log, fix, config, moduleName, ctSchema, }: ModuleConstructorParam & Pick<CtConstructorParam, 'ctSchema'>);
+    validateModules(moduleName: keyof typeof auditConfig.moduleConfig, moduleConfig: Record<string, unknown>): keyof typeof auditConfig.moduleConfig;
     run(): Promise<{}>;
     fixExtensionsScope(missingCtInExtensions: Extension[]): Promise<void>;
     writeFixContent(fixedExtensions: Record<string, Extension>): Promise<void>;

package/lib/modules/extensions.js

@@ -14,15 +14,22 @@ class Extensions {
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.ctSchema = ctSchema;
         this.extensionsSchema = [];
-        this.moduleName = moduleName !== null && moduleName !== void 0 ? moduleName : 'extensions';
+        this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
         this.fileName = config.moduleConfig[this.moduleName].fileName;
-        this.folderPath = (0, path_1.resolve)(config.basePath, config.moduleConfig[this.moduleName].dirName);
+        this.folderPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.basePath), (0, cli_utilities_1.sanitizePath)(config.moduleConfig[this.moduleName].dirName));
         this.ctUidSet = new Set(['$all']);
         this.missingCtInExtensions = [];
         this.missingCts = new Set();
         this.extensionsPath = '';
     }
+    validateModules(moduleName, moduleConfig) {
+        if (Object.keys(moduleConfig).includes(moduleName)) {
+            return moduleName;
+        }
+        return 'extensions';
+    }
     async run() {
+        var _a;
         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' });
@@ -38,8 +45,8 @@ class Extensions {
             const ctNotPresent = scope === null || scope === void 0 ? void 0 : scope.content_types.filter((ct) => !this.ctUidSet.has(ct));
             if ((ctNotPresent === null || ctNotPresent === void 0 ? void 0 : ctNotPresent.length) && ext.scope) {
                 ext.content_types = ctNotPresent;
-                ctNotPresent.forEach((ct) => this.missingCts.add(ct));
-                this.missingCtInExtensions.push((0, lodash_1.cloneDeep)(ext));
+                ctNotPresent.forEach((ct) => { var _a; return (_a = this.missingCts) === null || _a === void 0 ? void 0 : _a.add(ct); });
+                (_a = this.missingCtInExtensions) === null || _a === void 0 ? void 0 : _a.push((0, lodash_1.cloneDeep)(ext));
             }
             this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_EXT_SUCCESS_MSG, {
                 title,

package/lib/modules/workflows.d.ts

@@ -15,6 +15,7 @@ export default class Workflows {
     workflowPath: string;
     isBranchFixDone: boolean;
     constructor({ log, fix, config, moduleName, ctSchema, }: 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 workflow exists or not
      * If path exist read

package/lib/modules/workflows.js

@@ -13,15 +13,21 @@ class Workflows {
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.ctSchema = ctSchema;
         this.workflowSchema = [];
-        this.moduleName = moduleName !== null && moduleName !== void 0 ? moduleName : 'workflows';
+        this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
         this.fileName = config.moduleConfig[this.moduleName].fileName;
-        this.folderPath = (0, path_1.resolve)(config.basePath, config.moduleConfig[this.moduleName].dirName);
+        this.folderPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.basePath), (0, cli_utilities_1.sanitizePath)(config.moduleConfig[this.moduleName].dirName));
         this.ctUidSet = new Set(['$all']);
         this.missingCtInWorkflows = [];
         this.missingCts = new Set();
         this.workflowPath = '';
         this.isBranchFixDone = false;
     }
+    validateModules(moduleName, moduleConfig) {
+        if (Object.keys(moduleConfig).includes(moduleName)) {
+            return moduleName;
+        }
+        return 'workflows';
+    }
     /**
      * Check whether the given path for the workflow exists or not
      * If path exist read

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.6.1",
+  "version": "1.6.3",
   "commands": {
     "cm:stacks:audit:fix": {
       "id": "cm:stacks:audit:fix",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.6.1",
+  "version": "1.6.3",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -19,7 +19,7 @@
   ],
   "dependencies": {
     "@contentstack/cli-command": "~1.2.18",
-    "@contentstack/cli-utilities": "~1.6.1",
+    "@contentstack/cli-utilities": "~1.6.3",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-plugins": "^5.0.0",
     "chalk": "^4.1.2",