Merge pull request #1946 from contentstack/development

DX | 09-06-2025 | Release

Author: harshithad0703

.talismanrc

@@ -117,9 +117,21 @@ fileignoreconfig:
   - filename: packages/contentstack/package.json
     checksum: 9b0fdd100effcdbb5ee3809f7f102bfd11c88dd76e49db5103434f3aa29473dd
   - filename: pnpm-lock.yaml
+    checksum: 579849ef155d487ed7d1a8d30dab6ea906da2d571c725b3b033543a9a609f75c
+  - filename: packages/contentstack-audit/src/audit-base-command.ts
     checksum: bd99d269c0b6694577f4751fa96b3d85856e41bbef624b4ec1196630d6c1d168
-  - filename: package-lock.json
-    checksum: c085555b2afd1b5c22e20b3b5217aa009af5b1801e8de120179b50201a948c0a
   - filename: packages/contentstack-migrate-rte/test/commands/json-migration.test.js
     checksum: 1f5ee5b39119667bd4830f9dbbbf757fb922f4ec3b7f6fad06bbfbf214fe7f73
-version: '1.0'
+  - filename: packages/contentstack-bootstrap/src/bootstrap/utils.ts
+    checksum: 0b0af505ce1a74eb8df519f106291e319eb3ea74003ca63e03527f59a8821d39
+  - filename: packages/contentstack-bootstrap/test/bootstrap.test.js
+    checksum: 5f0355a5048183d61b605cbc160e6727a9de32832d9159e903fee49f9ab751d5
+  - filename: package-lock.json
+    checksum: 35c1a3c35a923ddf97a42edc85708a1bee9352710ebe135b6be6a32c95bde908
+  - filename: packages/contentstack-utilities/test/unit/logger.test.ts
+    checksum: c773181ea55c49d91363adacf0424b84c927e3cffd6bef1444ec2559ddf1b3b0
+  - filename: packages/contentstack-utilities/src/logger/cliErrorHandler.ts
+    checksum: 023cf08f215cd0778599fb8478c94419373d4687f04421c4eb99d87de86a4a3e
+  - filename: packages/contentstack-utilities/src/logger/logger.ts
+    checksum: 09f3b73dd995bafc253265c676f06308513e6b1842d9bc01d39e6b6945a54c7d
+version: "1.0"

package-lock.json

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

packages/contentstack-audit/README.md

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.12.1",
+  "version": "1.13.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -19,8 +19,8 @@
   ],
   "dependencies": {
     "@contentstack/cli-command": "~1.5.0",
-    "@oclif/plugin-help": "^6.2.27",
-    "@contentstack/cli-utilities": "~1.11.1",
+    "@oclif/plugin-help": "^6.2.28",
+    "@contentstack/cli-utilities": "~1.12.0",
     "@oclif/plugin-plugins": "^5.4.36",
     "chalk": "^4.1.2",
     "fast-csv": "^4.3.6",
@@ -30,19 +30,19 @@
     "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@oclif/test": "^4.1.12",
+    "@oclif/test": "^4.1.13",
     "@types/chai": "^4.3.20",
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^20.17.30",
+    "@types/node": "^20.17.50",
     "@types/uuid": "^9.0.8",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
-    "eslint-config-oclif": "^6.0.42",
+    "eslint-config-oclif": "^6.0.62",
     "eslint-config-oclif-typescript": "^3.1.14",
     "mocha": "^10.8.2",
     "nyc": "^15.1.0",
-    "oclif": "^4.17.43",
+    "oclif": "^4.17.46",
     "shx": "^0.4.0",
     "sinon": "^19.0.5",
     "ts-node": "^10.9.2",

packages/contentstack-audit/package.json

@@ -259,6 +259,10 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
 
           break;
         case 'field-rules':
+          // NOTE: We are using the fixed content-type for validation of field rules
+          const data =  this.getCtAndGfSchema();
+          constructorParam.ctSchema = data.ctSchema;
+          constructorParam.gfSchema = data.gfSchema;
           missingFieldRules = await new FieldRule(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingFieldRules);
           this.getAffectedData('field-rules', dataModuleWise['content-types'], missingFieldRules);
@@ -456,7 +460,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
               key === 'missingCTSelectFieldValues' ||
               key === 'missingFieldUid' ||
               key === 'action' ||
-              key === 'Non-Fixable' || 
+              key === 'Non-Fixable' ||
               key === 'Not-Fixed'
             ) {
               return chalk.red(typeof cellValue === 'object' ? JSON.stringify(cellValue) : cellValue);

packages/contentstack-audit/src/audit-base-command.ts

@@ -149,7 +149,7 @@ export default class ContentType {
    */
   async writeFixContent() {
     let canWrite = true;
-
+    
     if (!this.inMemoryFix && this.fix) {
       if (!this.config.flags['copy-dir'] && !this.config.flags['external-config']?.skipConfirm) {
         canWrite = this.config.flags.yes ?? (await cliux.confirm(commonMsg.FIX_CONFIRMATION));
@@ -301,18 +301,35 @@ export default class ContentType {
    */
   async validateGlobalField(tree: Record<string, unknown>[], field: GlobalFieldDataType): Promise<void> {
     // NOTE Any GlobalField related logic can be added here
-    if (!field.schema && !this.fix) {
-      this.missingRefs[this.currentUid].push({
-        tree,
-        ct_uid: this.currentUid,
-        name: this.currentTitle,
-        data_type: field.data_type,
-        display_name: field.display_name,
-        missingRefs: 'Empty schema found',
-        treeStr: tree.map(({ name }) => name).join(' ➜ '),
-      });
+    if (this.moduleName === 'global-fields') {
+      let { reference_to } = field;
+      const refExist = find(this.schema, { uid: reference_to });
+      if (!refExist) {
+        this.missingRefs[this.currentUid].push({
+          tree,
+          ct: this.currentUid,
+          name: this.currentTitle,
+          data_type: field.data_type,
+          display_name: field.display_name,
+          missingRefs: 'Referred Global Field Does not Exist',
+          treeStr: tree.map(({ name }) => name).join(' ➜ '),
+        });
+        return void 0;
+      }
+    } else if (this.moduleName === 'content-types') {
+      if (!field.schema && !this.fix) {
+        this.missingRefs[this.currentUid].push({
+          tree,
+          ct_uid: this.currentUid,
+          name: this.currentTitle,
+          data_type: field.data_type,
+          display_name: field.display_name,
+          missingRefs: 'Empty schema found',
+          treeStr: tree.map(({ name }) => name).join(' ➜ '),
+        });
 
-      return void 0;
+        return void 0;
+      }
     }
 
     await this.lookForReference(tree, field);
@@ -443,7 +460,7 @@ export default class ContentType {
   runFixOnSchema(tree: Record<string, unknown>[], schema: ContentTypeSchemaType[]) {
     // NOTE Global field Fix
     return schema
-      .map((field) => {
+      ?.map((field) => {
         const { data_type } = field;
         const fixTypes = this.config.flags['fix-only'] ?? this.config['fix-fields'];
 
@@ -524,12 +541,11 @@ export default class ContentType {
           missingRefs: [reference_to],
           treeStr: tree.map(({ name }) => name).join(' ➜ '),
         });
-      } else if (!field.schema) {
+      } else if (!field.schema && this.moduleName === 'content-types') {
         const gfSchema = find(this.gfSchema, { uid: field.reference_to })?.schema;
-
         if (gfSchema) {
           field.schema = gfSchema as GlobalFieldSchemaTypes[];
-
+        } else {
           this.missingRefs[this.currentUid].push({
             tree,
             data_type,
@@ -541,8 +557,27 @@ export default class ContentType {
             treeStr: tree.map(({ name }) => name).join(' ➜ '),
           });
         }
+      } else if (!field.schema && this.moduleName === 'global-fields') {
+        const gfSchema = find(this.gfSchema, { uid: field.reference_to })?.schema;
+        if (gfSchema) {
+          field.schema = gfSchema as GlobalFieldSchemaTypes[];
+        } else {
+          this.missingRefs[this.currentUid].push({
+            tree,
+            data_type,
+            display_name,
+            fixStatus: 'Fixed',
+            ct_uid: this.currentUid,
+            name: this.currentTitle,
+            missingRefs: 'Referred Global Field Does not exist',
+            treeStr: tree.map(({ name }) => name).join(' ➜ '),
+          });
+        }
       }
 
+      if(field.schema && !isEmpty(field.schema)){
+        field.schema = this.runFixOnSchema(tree, field.schema as ContentTypeSchemaType[]);
+      }
       return refExist ? field : null;
     }
 
@@ -559,7 +594,7 @@ export default class ContentType {
    */
   fixModularBlocksReferences(tree: Record<string, unknown>[], blocks: ModularBlockType[]) {
     return blocks
-      .map((block) => {
+      ?.map((block) => {
         const { reference_to, schema, title: display_name } = block;
         tree = [...tree, { uid: block.uid, name: block.title }];
         const refErrorObj = {
@@ -572,7 +607,7 @@ export default class ContentType {
           treeStr: tree.map(({ name }) => name).join(' ➜ '),
         };
 
-        if (!schema) {
+        if (!schema && this.moduleName === 'content-types') {
           this.missingRefs[this.currentUid].push(refErrorObj);
 
           return false;
@@ -581,7 +616,11 @@ export default class ContentType {
         // NOTE Global field section
         if (reference_to) {
           const refExist = find(this.gfSchema, { uid: reference_to });
+          if (!refExist) {
+            this.missingRefs[this.currentUid].push(refErrorObj);
 
+            return false;
+          }
           if (!refExist) {
             this.missingRefs[this.currentUid].push(refErrorObj);
 
@@ -591,7 +630,7 @@ export default class ContentType {
 
         block.schema = this.runFixOnSchema(tree, block.schema as ContentTypeSchemaType[]);
 
-        if (isEmpty(block.schema)) {
+        if (isEmpty(block.schema) && this.moduleName === 'content-types') {
           this.missingRefs[this.currentUid].push({
             ...refErrorObj,
             missingRefs: 'Empty schema found',

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

@@ -116,7 +116,9 @@ export default class Entries {
             const { uid, title } = entry;
             this.currentUid = uid;
             this.currentTitle = title;
-            this.currentTitle = this.removeEmojiAndImages(this.currentTitle)
+            if (this.currentTitle) {
+              this.currentTitle = this.removeEmojiAndImages(this.currentTitle);
+            }
 
             if (!this.missingRefs[this.currentUid]) {
               this.missingRefs[this.currentUid] = [];
@@ -133,7 +135,11 @@ export default class Entries {
               this.removeMissingKeysOnEntry(ctSchema.schema as ContentTypeSchemaType[], this.entries[entryUid]);
             }
 
-            this.lookForReference([{ locale: code, uid, name: this.removeEmojiAndImages(title) }], ctSchema, this.entries[entryUid]);
+            this.lookForReference(
+              [{ locale: code, uid, name: this.removeEmojiAndImages(this.currentTitle) }],
+              ctSchema,
+              this.entries[entryUid],
+            );
 
             if (this.missingRefs[this.currentUid]?.length) {
               this.missingRefs[this.currentUid].forEach((entry: any) => {
@@ -242,7 +248,7 @@ export default class Entries {
       missingMandatoryFields: this.missingMandatoryFields,
       missingTitleFields: this.missingTitleFields,
       missingEnvLocale: this.missingEnvLocale,
-      missingMultipleFields: this.missingMultipleField
+      missingMultipleFields: this.missingMultipleField,
     };
   }
 
@@ -354,11 +360,11 @@ export default class Entries {
     for (const child of field?.schema ?? []) {
       const { uid, multiple, data_type } = child;
 
-      if(multiple && entry[uid] && !Array.isArray(entry[uid])) {
-       if (!this.missingMultipleField[this.currentUid]) {
-         this.missingMultipleField[this.currentUid] = [];
-       }
-        
+      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,
@@ -371,7 +377,7 @@ export default class Entries {
             .filter((val) => val)
             .join(' ➜ '),
         });
-      } 
+      }
       this.missingMandatoryFields[this.currentUid].push(
         ...this.validateMandatoryFields(
           [...tree, { uid: field.uid, name: child.display_name, field: uid }],
@@ -758,7 +764,7 @@ export default class Entries {
             .map(({ name }) => name)
             .filter(Boolean)
             .join(' ➜ '),
-          'fixStatus': 'Fixed',
+          fixStatus: 'Fixed',
         });
 
         entry[uid] = [entry[uid]];
@@ -842,7 +848,7 @@ export default class Entries {
    * Else empty array
    */
   removeEmojiAndImages(str: string) {
-    return str.replace(
+    return str?.replace(
       /[\p{Emoji}\p{Emoji_Presentation}\p{Emoji_Modifier}\p{Emoji_Modifier_Base}\p{Emoji_Component}]+/gu,
       '',
     );

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

@@ -83,7 +83,7 @@ export default class FieldRule {
     }
 
     this.schema = this.moduleName === 'content-types' ? this.ctSchema : this.gfSchema;
-
+    
     await this.prerequisiteData();
     await this.prepareEntryMetaData();
     for (const schema of this.schema ?? []) {