@contentstack/cli-audit 1.9.0 → 1.10.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.9.0 linux-x64 node-v22.14.0
+@contentstack/cli-audit/1.10.0 linux-x64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

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

@@ -35,6 +35,7 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
         missingRefInCustomRoles: {} | undefined;
         missingEnvLocalesInAssets: Record<string, any> | undefined;
         missingEnvLocalesInEntries: Record<string, any> | undefined;
+        missingMultipleFields: Record<string, any> | undefined;
     }>;
     /**
      * The `promptQueue` function prompts the user to enter a data directory path if the `data-dir` flag

package/lib/audit-base-command.js

@@ -41,7 +41,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         await this.promptQueue();
         await this.createBackUp();
         this.sharedConfig.reportPath = (0, path_1.resolve)(this.flags['report-path'] || process.cwd(), 'audit-report');
-        const { missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries } = await this.scanAndFix();
+        const { missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingMultipleFields } = await this.scanAndFix();
         this.showOutputOnScreen([
             { module: 'Content types', missingRefs: missingCtRefs },
             { module: 'Global Fields', missingRefs: missingGfRefs },
@@ -59,6 +59,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Custom Roles', missingRefs: missingRefInCustomRoles }]);
         this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Assets', missingRefs: missingEnvLocalesInAssets }]);
         this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Entries Missing Locale and Environments', missingRefs: missingEnvLocalesInEntries }]);
+        this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Entries Changed Multiple Fields', missingRefs: missingMultipleFields }]);
         if (!(0, isEmpty_1.default)(missingCtRefs) ||
             !(0, isEmpty_1.default)(missingGfRefs) ||
             !(0, isEmpty_1.default)(missingEntryRefs) ||
@@ -68,7 +69,8 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             !(0, isEmpty_1.default)(missingTitleFields) ||
             !(0, isEmpty_1.default)(missingRefInCustomRoles) ||
             !(0, isEmpty_1.default)(missingEnvLocalesInAssets) ||
-            !(0, isEmpty_1.default)(missingEnvLocalesInEntries)) {
+            !(0, isEmpty_1.default)(missingEnvLocalesInEntries) ||
+            !(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');
             }
@@ -103,9 +105,9 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * and `missingEntryRefs`.
      */
     async scanAndFix() {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         let { ctSchema, gfSchema } = this.getCtAndGfSchema();
-        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries;
+        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries, missingMultipleFields;
         for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
             (0, log_1.print)([
                 {
@@ -142,11 +144,13 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     missingMandatoryFields = (_c = missingEntry.missingMandatoryFields) !== null && _c !== void 0 ? _c : {};
                     missingTitleFields = (_d = missingEntry.missingTitleFields) !== null && _d !== void 0 ? _d : {};
                     missingEnvLocalesInEntries = (_e = missingEntry.missingEnvLocale) !== null && _e !== void 0 ? _e : {};
+                    missingMultipleFields = (_f = missingEntry.missingMultipleFields) !== null && _f !== void 0 ? _f : {};
                     await this.prepareReport(module, missingEntryRefs);
                     await this.prepareReport(`Entries_Select_feild`, missingSelectFeild);
                     await this.prepareReport('Entries_Mandatory_feild', missingMandatoryFields);
                     await this.prepareReport('Entries_Title_feild', missingTitleFields);
                     await this.prepareReport('Entry_Missing_Locale_and_Env_in_Publish_Details', missingEnvLocalesInEntries);
+                    await this.prepareReport('Entry_Multiple_Fields', missingMultipleFields);
                     break;
                 case 'workflows':
                     missingCtRefsInWorkflow = await new modules_1.Workflows({
@@ -191,7 +195,8 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             missingTitleFields,
             missingRefInCustomRoles,
             missingEnvLocalesInAssets,
-            missingEnvLocalesInEntries
+            missingEnvLocalesInEntries,
+            missingMultipleFields
         };
     }
     /**

package/lib/config/index.d.ts

@@ -61,6 +61,7 @@ declare const config: {
         Entries_Title_feild: string;
         Entry_Missing_Locale_and_Env: string;
         Entry_Missing_Locale_and_Env_in_Publish_Details: string;
+        Entry_Multiple_Fields: string;
     };
     feild_level_modules: string[];
     fixSelectField: boolean;

package/lib/config/index.js

@@ -103,9 +103,10 @@ const config = {
         Entries_Mandatory_feild: 'Entries_Mandatory_feild',
         Entries_Title_feild: 'Entries_Title_feild',
         Entry_Missing_Locale_and_Env: 'Entry_Missing_Locale_and_Env',
-        Entry_Missing_Locale_and_Env_in_Publish_Details: 'Entry_Missing_Locale_and_Env_in_Publish_Details'
+        Entry_Missing_Locale_and_Env_in_Publish_Details: 'Entry_Missing_Locale_and_Env_in_Publish_Details',
+        Entry_Multiple_Fields: 'Entry_Multiple_Fields'
     },
-    feild_level_modules: ['Entries_Title_feild', 'Entries_Mandatory_feild', 'Entries_Select_feild', 'Entry_Missing_Locale_and_Env_in_Publish_Details'],
+    feild_level_modules: ['Entries_Title_feild', 'Entries_Mandatory_feild', 'Entries_Select_feild', 'Entry_Missing_Locale_and_Env_in_Publish_Details', 'Entry_Multiple_Fields'],
     fixSelectField: false
 };
 exports.default = config;

package/lib/modules/entries.d.ts

@@ -18,6 +18,7 @@ export default class Entries {
     protected missingMandatoryFields: Record<string, any>;
     protected missingTitleFields: Record<string, any>;
     protected missingEnvLocale: Record<string, any>;
+    protected missingMultipleField: Record<string, any>;
     environments: string[];
     entryMetaData: Record<string, any>[];
     moduleName: keyof typeof auditConfig.moduleConfig;
@@ -34,12 +35,14 @@ export default class Entries {
         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>;
     }>;
     /**
      * The function removes any properties from the `missingRefs` object that have an empty array value.

package/lib/modules/entries.js

@@ -21,6 +21,7 @@ class Entries {
         this.missingMandatoryFields = {};
         this.missingTitleFields = {};
         this.missingEnvLocale = {};
+        this.missingMultipleField = {};
         this.environments = [];
         this.entryMetaData = [];
         this.moduleName = 'entries';
@@ -177,6 +178,7 @@ class Entries {
             missingMandatoryFields: this.missingMandatoryFields,
             missingTitleFields: this.missingTitleFields,
             missingEnvLocale: this.missingEnvLocale,
+            missingMultipleFields: this.missingMultipleField
         };
     }
     /**
@@ -274,7 +276,24 @@ class Entries {
             entry = this.runFixOnSchema(tree, field.schema, entry);
         }
         for (const child of (_a = field === null || field === void 0 ? void 0 : field.schema) !== null && _a !== void 0 ? _a : []) {
-            const { uid } = child;
+            const { uid, multiple, data_type } = child;
+            if (multiple && entry[uid] && !Array.isArray(entry[uid])) {
+                if (!this.missingMultipleField[this.currentUid]) {
+                    this.missingMultipleField[this.currentUid] = [];
+                }
+                this.missingMultipleField[this.currentUid].push({
+                    uid: this.currentUid,
+                    name: this.currentTitle,
+                    field_uid: uid,
+                    data_type,
+                    multiple,
+                    tree,
+                    treeStr: tree
+                        .map(({ name }) => name)
+                        .filter((val) => val)
+                        .join(' ➜ '),
+                });
+            }
             this.missingMandatoryFields[this.currentUid].push(...this.validateMandatoryFields([...tree, { uid: field.uid, name: child.display_name, field: uid }], child, entry));
             if (!(entry === null || entry === void 0 ? void 0 : entry[uid]) && !child.hasOwnProperty('display_type')) {
                 continue;
@@ -551,10 +570,29 @@ class Entries {
     runFixOnSchema(tree, schema, entry) {
         // NOTE Global field Fix
         schema.forEach((field) => {
-            const { uid, data_type } = field;
+            var _a;
+            var _b, _c;
+            const { uid, data_type, multiple } = field;
             if (!Object(entry).hasOwnProperty(uid)) {
                 return;
             }
+            if (multiple && entry[uid] && !Array.isArray(entry[uid])) {
+                (_a = (_b = this.missingMultipleField)[_c = this.currentUid]) !== null && _a !== void 0 ? _a : (_b[_c] = []);
+                this.missingMultipleField[this.currentUid].push({
+                    uid: this.currentUid,
+                    name: this.currentTitle,
+                    field_uid: uid,
+                    data_type,
+                    multiple,
+                    tree,
+                    treeStr: tree
+                        .map(({ name }) => name)
+                        .filter(Boolean)
+                        .join(' ➜ '),
+                    'fixStatus': 'Fixed',
+                });
+                entry[uid] = [entry[uid]];
+            }
             switch (data_type) {
                 case 'global_field':
                     entry[uid] = this.fixGlobalFieldReferences([...tree, { uid: field.uid, name: field.display_name, data_type: field.data_type }], field, entry[uid]);

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

@@ -8,6 +8,7 @@ type ContentTypeStruct = {
     description: string;
     schema?: ContentTypeSchemaType[];
     mandatory: boolean;
+    multiple: boolean;
 };
 type ModuleConstructorParam = {
     log: LogFn;
@@ -28,6 +29,7 @@ type CommonDataTypeStruct = {
         allow_json_rte: boolean;
     } & AnyProperty;
     mandatory: boolean;
+    multiple: boolean;
 };
 type RefErrorReturnType = {
     name: string;
@@ -114,6 +116,8 @@ declare enum OutputColumn {
     'publish_environment' = "publish_environment",
     'asset_uid' = "asset_uid",
     'selectedValue' = "selectedValue",
-    'fixStatus' = "fixStatus"
+    'fixStatus' = "fixStatus",
+    'field_uid' = "field_uid",
+    'multiple' = "multiple"
 }
 export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, ExtensionOrAppFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, GlobalFieldSchemaTypes, WorkflowExtensionsRefErrorReturnType, SelectFeildStruct, };

package/lib/types/content-types.js

@@ -31,5 +31,7 @@ var OutputColumn;
     OutputColumn["asset_uid"] = "asset_uid";
     OutputColumn["selectedValue"] = "selectedValue";
     OutputColumn["fixStatus"] = "fixStatus";
+    OutputColumn["field_uid"] = "field_uid";
+    OutputColumn["multiple"] = "multiple";
 })(OutputColumn || (OutputColumn = {}));
 exports.OutputColumn = OutputColumn;

package/oclif.manifest.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -19,7 +19,7 @@
   ],
   "dependencies": {
     "@contentstack/cli-command": "~1.3.3",
-    "@contentstack/cli-utilities": "~1.8.4",
+    "@contentstack/cli-utilities": "~1.9.0",
     "@oclif/plugin-help": "^5.2.20",
     "@oclif/plugin-plugins": "^5.4.34",
     "chalk": "^4.1.2",
@@ -30,11 +30,11 @@
     "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@oclif/test": "^4.1.11",
+    "@oclif/test": "^4.1.12",
     "@types/chai": "^4.3.20",
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^20.17.19",
+    "@types/node": "^20.17.28",
     "@types/uuid": "^9.0.8",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
@@ -44,7 +44,7 @@
     "nyc": "^15.1.0",
     "oclif": "^3.17.2",
     "shx": "^0.3.4",
-    "sinon": "^19.0.2",
+    "sinon": "^19.0.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.3"
   },
@@ -74,7 +74,8 @@
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md",
     "clean": "rm -rf ./lib ./node_modules tsconfig.tsbuildinfo oclif.manifest.json",
-    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\""
+    "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
+    "test:unit": "mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.ts\""
   },
   "engines": {
     "node": ">=16"