merged changes from dev

Author: shafeeqd959

package-lock.json

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.9.0 darwin-arm64 node-v22.13.1
+@contentstack/cli-audit/1.10.0 darwin-arm64 node-v22.13.1
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

packages/contentstack-audit/README.md

@@ -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",
@@ -20,7 +20,7 @@
   "dependencies": {
     "@contentstack/cli-command": "~1.4.0",
     "@oclif/plugin-help": "^6.2.25",
-    "@contentstack/cli-utilities": "~1.9.0",
+    "@contentstack/cli-utilities": "~1.10.0",
     "@oclif/plugin-plugins": "^5.4.24",
     "chalk": "^4.1.2",
     "fast-csv": "^4.3.6",
@@ -44,7 +44,7 @@
     "nyc": "^15.1.0",
     "oclif": "^4.17.30",
     "shx": "^0.3.4",
-    "sinon": "^19.0.2",
+    "sinon": "^19.0.5",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.3"
   },

packages/contentstack-audit/package.json

@@ -40,16 +40,16 @@ const config = {
       dirName: 'custom-roles',
       fileName: 'custom-roles.json',
     },
-    'assets': {
+    assets: {
       name: 'assets',
       dirName: 'assets',
       fileName: 'assets.json',
     },
-    'environments': {
+    environments: {
       name: 'environments',
       dirName: 'environments',
       fileName: 'environments.json',
-    }
+    },
   },
   entries: {
     systemKeys: [
@@ -93,16 +93,23 @@ const config = {
     'entry_uid',
     'publish_locale',
     'publish_environment',
-    'asset_uid'
+    'asset_uid',
+    'selectedValue',
   ],
   ReportTitleForEntries: {
     Entries_Select_feild: 'Entries_Select_feild',
     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',
   },
-  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',
+  ],
+  fixSelectField: false,
 };
 
 export default config;

packages/contentstack-audit/src/config/index.ts

@@ -40,7 +40,7 @@ const auditMsg = {
   SCAN_ASSET_SUCCESS_MSG: `Successfully completed the scanning of Asset with UID '{uid}'.`,
   SCAN_ASSET_WARN_MSG: `The locale '{locale}' or environment '{environment}' are not present for asset with uid '{uid}'`,
   ENTRY_PUBLISH_DETAILS: `Removing the publish detials for entry '{uid}' of ct '{ctuid}' in locale '{locale}' as locale '{publocale}' or environment '{environment}' does not exist`,
-  CT_REFERENCE_FIELD: `The mentioned Reference Field is not Array field name 'reference_to' having display name 'display_name'`,
+  CT_REFERENCE_FIELD: `The mentioned Reference field is not Array field reference is '{reference_to}' having display name '{display_name}''`,
   ASSET_NOT_EXIST: `The publish_details either does not exist or is not an array for asset uid '{uid}'`,
   ENTRY_PUBLISH_DETAILS_NOT_EXIST: `The publish_details either does not exist or is not an array for entry uid '{uid}'`,
 };

packages/contentstack-audit/src/messages/index.ts

@@ -1,8 +1,6 @@
 import { join, resolve } from 'path';
 import { existsSync, readFileSync, writeFileSync } from 'fs';
-
 import { FsUtility, sanitizePath, cliux } from '@contentstack/cli-utilities';
-
 import {
   LogFn,
   ConfigType,

packages/contentstack-audit/src/modules/assets.ts

@@ -389,16 +389,28 @@ export default class ContentType {
     const missingRefs: string[] = [];
     let { reference_to, display_name, data_type } = field;
 
-    for (const reference of reference_to ?? []) {
-      // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
-      if (this.config.skipRefs.includes(reference)) {
-        continue;
+    if (!Array.isArray(reference_to)) {
+      this.log($t(auditMsg.CT_REFERENCE_FIELD, { reference_to, data_type, display_name }), 'error');
+      this.log($t(auditMsg.CT_REFERENCE_FIELD, { reference_to, display_name }), 'info');
+      if (!this.config.skipRefs.includes(reference_to)) {
+        const refExist = find(this.ctSchema, { uid: reference_to });
+
+        if (!refExist) {
+          missingRefs.push(reference_to);
+        }
       }
+    } else {
+      for (const reference of reference_to ?? []) {
+        // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
+        if (this.config.skipRefs.includes(reference)) {
+          continue;
+        }
 
-      const refExist = find(this.ctSchema, { uid: reference });
+        const refExist = find(this.ctSchema, { uid: reference });
 
-      if (!refExist) {
-        missingRefs.push(reference);
+        if (!refExist) {
+          missingRefs.push(reference);
+        }
       }
     }
 
@@ -641,19 +653,34 @@ export default class ContentType {
     let fixStatus;
     const missingRefs: string[] = [];
     const { reference_to, data_type, display_name } = field;
-    if(!Array.isArray(reference_to)) {
-      this.log($t(auditMsg.CT_REFERENCE_FIELD, { reference_to, data_type, display_name }), { color: 'green' });
-    }
-    for (const reference of reference_to ?? []) {
-      // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
-      if (this.config.skipRefs.includes(reference)) {
-        continue;
+    if (!Array.isArray(reference_to)) {
+      this.log($t(auditMsg.CT_REFERENCE_FIELD, { reference_to, display_name }), 'error');
+      this.log($t(auditMsg.CT_REFERENCE_FIELD, { reference_to, display_name }), 'info');
+      if (!this.config.skipRefs.includes(reference_to)) {
+        const refExist = find(this.ctSchema, { uid: reference_to });
+
+        if (!refExist) {
+          missingRefs.push(reference_to);
+        }
       }
 
-      const refExist = find(this.ctSchema, { uid: reference });
+      field.reference_to = [reference_to];
+      field.field_metadata = {
+        ...field.field_metadata,
+        ref_multiple_content_types: true,
+      };
+    } else {
+      for (const reference of reference_to ?? []) {
+        // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
+        if (this.config.skipRefs.includes(reference)) {
+          continue;
+        }
 
-      if (!refExist) {
-        missingRefs.push(reference);
+        const refExist = find(this.ctSchema, { uid: reference });
+
+        if (!refExist) {
+          missingRefs.push(reference);
+        }
       }
     }
 

packages/contentstack-audit/src/modules/content-types.ts

@@ -175,7 +175,7 @@ export default class Entries {
 
             const localKey = this.locales.map((locale: any) => locale.code);
 
-            if(this.entries[entryUid]?.publish_details && !Array.isArray(this.entries[entryUid].publish_details)) {
+            if (this.entries[entryUid]?.publish_details && !Array.isArray(this.entries[entryUid].publish_details)) {
               this.log($t(auditMsg.ENTRY_PUBLISH_DETAILS_NOT_EXIST, { uid: entryUid }), { color: 'red' });
             }
 
@@ -194,11 +194,23 @@ export default class Entries {
                   { color: 'red' },
                 );
                 if (!Object.keys(this.missingEnvLocale).includes(entryUid)) {
-                  this.missingEnvLocale[entryUid] = [{ entry_uid: entryUid, publish_locale: pd.locale, publish_environment: pd.environment, ctUid: ctSchema.uid, ctLocale: code }];
+                  this.missingEnvLocale[entryUid] = [
+                    {
+                      entry_uid: entryUid,
+                      publish_locale: pd.locale,
+                      publish_environment: pd.environment,
+                      ctUid: ctSchema.uid,
+                      ctLocale: code,
+                    },
+                  ];
                 } else {
-                  this.missingEnvLocale[entryUid].push(
-                    { entry_uid: entryUid, publish_locale: pd.locale, publish_environment: pd.environment, ctUid: ctSchema.uid, ctLocale: code },
-                  );
+                  this.missingEnvLocale[entryUid].push({
+                    entry_uid: entryUid,
+                    publish_locale: pd.locale,
+                    publish_environment: pd.environment,
+                    ctUid: ctSchema.uid,
+                    ctLocale: code,
+                  });
                 }
                 return false;
               }
@@ -630,18 +642,29 @@ export default class Entries {
     if (this.fix) return [];
 
     const missingRefs: Record<string, any>[] = [];
-    const { uid: data_type, display_name } = fieldStructure;
+    const { uid: data_type, display_name, reference_to } = fieldStructure;
 
     for (const index in field ?? []) {
-      const reference = field[index];
+      const reference: any = field[index];
       const { uid } = reference;
+      if (!uid && reference.startsWith('blt')) {
+        const refExist = find(this.entryMetaData, { uid: reference });
+        if (!refExist) {
+          if (Array.isArray(reference_to) && reference_to.length === 1) {
+            missingRefs.push({ uid: reference, _content_type_uid: reference_to[0] });
+          } else {
+            missingRefs.push(reference);
+          }
+        }
+      }
       // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
       // if (this.config.skipRefs.includes(reference)) continue;
+      else {
+        const refExist = find(this.entryMetaData, { uid });
 
-      const refExist = find(this.entryMetaData, { uid });
-
-      if (!refExist) {
-        missingRefs.push(reference);
+        if (!refExist) {
+          missingRefs.push(reference);
+        }
       }
     }
 
@@ -846,11 +869,14 @@ export default class Entries {
    * @returns
    */
   fixSelectField(tree: Record<string, unknown>[], field: SelectFeildStruct, entry: any) {
+    if (!this.config.fixSelectField) {
+      return entry;
+    }
     const { enum: selectOptions, multiple, min_instance, display_type, display_name, uid } = field;
 
     let missingCTSelectFieldValues;
     let isMissingValuePresent = false;
-
+    let selectedValue: unknown = '';
     if (multiple) {
       let obj = this.findNotPresentSelectField(entry, selectOptions);
       let { notPresent, filteredFeild } = obj;
@@ -868,13 +894,15 @@ export default class Entries {
             .slice(0, missingInstances)
             .map((choice) => choice.value);
           entry.push(...newValues);
+          selectedValue = newValues;
           this.log($t(auditFixMsg.ENTRY_SELECT_FIELD_FIX, { value: newValues.join(' '), uid }), 'error');
         }
       } else {
         if (entry.length === 0) {
           isMissingValuePresent = true;
           const defaultValue = selectOptions.choices.length > 0 ? selectOptions.choices[0].value : null;
           entry.push(defaultValue);
+          selectedValue = defaultValue;
           this.log($t(auditFixMsg.ENTRY_SELECT_FIELD_FIX, { value: defaultValue as string, uid }), 'error');
         }
       }
@@ -885,6 +913,7 @@ export default class Entries {
         isMissingValuePresent = true;
         let defaultValue = selectOptions.choices.length > 0 ? selectOptions.choices[0].value : null;
         entry = defaultValue;
+        selectedValue = defaultValue;
         this.log($t(auditFixMsg.ENTRY_SELECT_FIELD_FIX, { value: defaultValue as string, uid }), 'error');
       }
     }
@@ -895,6 +924,7 @@ export default class Entries {
         display_name,
         display_type,
         missingCTSelectFieldValues,
+        selectedValue,
         min_instance: min_instance ?? 'NA',
         tree,
         treeStr: tree
@@ -909,7 +939,7 @@ export default class Entries {
 
   validateMandatoryFields(tree: Record<string, unknown>[], fieldStructure: any, entry: any) {
     const { display_name, multiple, data_type, mandatory, field_metadata, uid } = fieldStructure;
-    
+
     const isJsonRteEmpty = () => {
       const jsonNode = multiple
         ? entry[uid]?.[0]?.children?.[0]?.children?.[0]?.text
@@ -922,6 +952,9 @@ export default class Entries {
       if (data_type === 'number' && !multiple) {
         fieldValue = entry[uid] || entry[uid] === 0 ? true : false;
       }
+      if (data_type === 'text' && !multiple) {
+        fieldValue = entry[uid] || entry[uid] === 0 ? true : false;
+      }
       if (Array.isArray(entry[uid]) && data_type === 'reference') {
         fieldValue = entry[uid]?.length ? true : false;
       }
@@ -1186,16 +1219,29 @@ export default class Entries {
       entry = JSON.parse(stringReference);
     }
     entry = entry
-      ?.map((reference) => {
+      ?.map((reference: any) => {
         const { uid } = reference;
-        const refExist = find(this.entryMetaData, { uid });
-
-        if (!refExist) {
-          missingRefs.push(reference);
-          return null;
+        const { reference_to } = field;
+        if (!uid && reference.startsWith('blt')) {
+          const refExist = find(this.entryMetaData, { uid: reference });
+          if (!refExist) {
+            if (Array.isArray(reference_to) && reference_to.length === 1) {
+              missingRefs.push({ uid: reference, _content_type_uid: reference_to[0] });
+            } else {
+              missingRefs.push(reference);
+            }
+          } else {
+            return { uid: reference, _content_type_uid: refExist.ctUid };
+          }
+        } else {
+          const refExist = find(this.entryMetaData, { uid });
+          if (!refExist) {
+            missingRefs.push(reference);
+            return null;
+          } else {
+            return reference;
+          }
         }
-
-        return reference;
       })
       .filter((val) => val) as EntryReferenceFieldDataType[];
 
@@ -1353,7 +1399,7 @@ export default class Entries {
                 `error`,
               );
             }
-            this.entryMetaData.push({ uid: entryUid, title });
+            this.entryMetaData.push({ uid: entryUid, title, ctUid: uid });
           }
         }
       }

packages/contentstack-audit/src/modules/entries.ts

@@ -158,7 +158,9 @@ enum OutputColumn {
   'entry_uid' = 'entry_uid',
   'publish_locale' = 'publish_locale',
   'publish_environment' = 'publish_environment',
-  'asset_uid' = 'asset_uid'
+  'asset_uid' = 'asset_uid',
+  'selectedValue' = 'selectedValue',
+  'fixStatus' = 'fixStatus',
 }
 
 export {

packages/contentstack-audit/src/types/content-types.ts

@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "@contentstack/cli-command": "~1.4.0",
-    "@contentstack/cli-utilities": "~1.9.0"
+    "@contentstack/cli-utilities": "~1.10.0"
   },
   "devDependencies": {
     "@fancy-test/nock": "^0.1.1",