@contentstack/cli-audit 1.12.0 → 1.13.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.12.0 linux-x64 node-v22.14.0
+@contentstack/cli-audit/1.13.0 linux-x64 node-v22.15.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -282,7 +282,7 @@ DESCRIPTION
   Display help for csdx.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.28/src/commands/help.ts)_
 
 ## `csdx plugins`
 
@@ -305,7 +305,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:add PLUGIN`
 
@@ -379,7 +379,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN`
 
@@ -428,7 +428,7 @@ EXAMPLES
     $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PATH`
 
@@ -459,7 +459,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:remove [PLUGIN]`
 
@@ -500,7 +500,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall [PLUGIN]`
 
@@ -528,7 +528,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:unlink [PLUGIN]`
 
@@ -572,5 +572,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.39/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/lib/audit-base-command.js

@@ -194,6 +194,10 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     this.getAffectedData('custom-roles', dataModuleWise['custom-roles'], missingRefInCustomRoles);
                     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 modules_1.FieldRule((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingFieldRules);
                     this.getAffectedData('field-rules', dataModuleWise['content-types'], missingFieldRules);

package/lib/config/index.d.ts

@@ -4,6 +4,7 @@ declare const config: {
     skipFieldTypes: string[];
     modules: string[];
     'fix-fields': string[];
+    'schema-fields-data-type': string[];
     moduleConfig: {
         'content-types': {
             name: string;

package/lib/config/index.js

@@ -15,6 +15,7 @@ const config = {
         'field-rules',
     ],
     'fix-fields': ['reference', 'global_field', 'json:rte', 'json:extension', 'blocks', 'group', 'content_types'],
+    'schema-fields-data-type': ['blocks', 'group', 'global_field'],
     moduleConfig: {
         'content-types': {
             name: 'content type',

package/lib/modules/content-types.js

@@ -214,17 +214,35 @@ class ContentType {
      */
     async validateGlobalField(tree, field) {
         // 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(' ➜ '),
-            });
-            return void 0;
+        if (this.moduleName === 'global-fields') {
+            let { reference_to } = field;
+            const refExist = (0, find_1.default)(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;
+            }
         }
         await this.lookForReference(tree, field);
     }
@@ -339,8 +357,7 @@ class ContentType {
      */
     runFixOnSchema(tree, schema) {
         // NOTE Global field Fix
-        return schema
-            .map((field) => {
+        return schema === null || schema === void 0 ? void 0 : schema.map((field) => {
             var _a;
             const { data_type } = field;
             const fixTypes = (_a = this.config.flags['fix-only']) !== null && _a !== void 0 ? _a : this.config['fix-fields'];
@@ -377,13 +394,14 @@ class ContentType {
                 default:
                     return field;
             }
-        })
-            .filter((val) => {
+        }).filter((val) => {
             if (this.config.skipFieldTypes.includes(val === null || val === void 0 ? void 0 : val.data_type))
                 return true;
-            if ((val === null || val === void 0 ? void 0 : val.schema) && (0, isEmpty_1.default)(val === null || val === void 0 ? void 0 : val.schema))
+            if ((val === null || val === void 0 ? void 0 : val.schema) &&
+                (0, isEmpty_1.default)(val === null || val === void 0 ? void 0 : val.schema) &&
+                (!(val === null || val === void 0 ? void 0 : val.data_type) || this.config['schema-fields-data-type'].includes(val.data_type)))
                 return false;
-            if ((val === null || val === void 0 ? void 0 : val.reference_to) && (0, isEmpty_1.default)(val === null || val === void 0 ? void 0 : val.reference_to))
+            if ((val === null || val === void 0 ? void 0 : val.reference_to) && (0, isEmpty_1.default)(val === null || val === void 0 ? void 0 : val.reference_to) && val.data_type === 'reference')
                 return false;
             return !!val;
         });
@@ -398,7 +416,7 @@ class ContentType {
      * doesn't.
      */
     fixGlobalFieldReferences(tree, field) {
-        var _a;
+        var _a, _b;
         const { reference_to, display_name, data_type } = field;
         if (reference_to && data_type === 'global_field') {
             tree = [...tree, { uid: field.uid, name: field.display_name, data_type: field.data_type }];
@@ -415,10 +433,12 @@ class ContentType {
                     treeStr: tree.map(({ name }) => name).join(' ➜ '),
                 });
             }
-            else if (!field.schema) {
+            else if (!field.schema && this.moduleName === 'content-types') {
                 const gfSchema = (_a = (0, find_1.default)(this.gfSchema, { uid: field.reference_to })) === null || _a === void 0 ? void 0 : _a.schema;
                 if (gfSchema) {
                     field.schema = gfSchema;
+                }
+                else {
                     this.missingRefs[this.currentUid].push({
                         tree,
                         data_type,
@@ -431,6 +451,27 @@ class ContentType {
                     });
                 }
             }
+            else if (!field.schema && this.moduleName === 'global-fields') {
+                const gfSchema = (_b = (0, find_1.default)(this.gfSchema, { uid: field.reference_to })) === null || _b === void 0 ? void 0 : _b.schema;
+                if (gfSchema) {
+                    field.schema = gfSchema;
+                }
+                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 && !(0, isEmpty_1.default)(field.schema)) {
+                field.schema = this.runFixOnSchema(tree, field.schema);
+            }
             return refExist ? field : null;
         }
         return field;
@@ -444,8 +485,7 @@ class ContentType {
      * @returns an array of `ModularBlockType` objects.
      */
     fixModularBlocksReferences(tree, blocks) {
-        return blocks
-            .map((block) => {
+        return blocks === null || blocks === void 0 ? void 0 : blocks.map((block) => {
             const { reference_to, schema, title: display_name } = block;
             tree = [...tree, { uid: block.uid, name: block.title }];
             const refErrorObj = {
@@ -457,27 +497,30 @@ class ContentType {
                 fixStatus: this.fix ? 'Fixed' : undefined,
                 treeStr: tree.map(({ name }) => name).join(' ➜ '),
             };
-            if (!schema) {
+            if (!schema && this.moduleName === 'content-types') {
                 this.missingRefs[this.currentUid].push(refErrorObj);
                 return false;
             }
             // NOTE Global field section
             if (reference_to) {
                 const refExist = (0, find_1.default)(this.gfSchema, { uid: reference_to });
+                if (!refExist) {
+                    this.missingRefs[this.currentUid].push(refErrorObj);
+                    return false;
+                }
                 if (!refExist) {
                     this.missingRefs[this.currentUid].push(refErrorObj);
                     return block;
                 }
             }
             block.schema = this.runFixOnSchema(tree, block.schema);
-            if ((0, isEmpty_1.default)(block.schema)) {
+            if ((0, isEmpty_1.default)(block.schema) && this.moduleName === 'content-types') {
                 this.missingRefs[this.currentUid].push(Object.assign(Object.assign({}, refErrorObj), { missingRefs: 'Empty schema found', treeStr: tree.map(({ name }) => name).join(' ➜ ') }));
                 this.log((0, messages_1.$t)(messages_1.auditFixMsg.EMPTY_FIX_MSG, { path: tree.map(({ name }) => name).join(' ➜ ') }), 'info');
                 return null;
             }
             return block;
-        })
-            .filter((val) => val);
+        }).filter((val) => val);
     }
     /**
      * The function checks for missing extension or app references in a given tree and fixes them if the

package/lib/modules/entries.js

@@ -67,7 +67,9 @@ 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] = [];
                         }
@@ -80,7 +82,7 @@ class Entries {
                         if (this.fix) {
                             this.removeMissingKeysOnEntry(ctSchema.schema, 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 ((_a = this.missingRefs[this.currentUid]) === null || _a === void 0 ? void 0 : _a.length) {
                             this.missingRefs[this.currentUid].forEach((entry) => {
                                 entry.ct = ctSchema.uid;
@@ -179,7 +181,7 @@ class Entries {
             missingMandatoryFields: this.missingMandatoryFields,
             missingTitleFields: this.missingTitleFields,
             missingEnvLocale: this.missingEnvLocale,
-            missingMultipleFields: this.missingMultipleField
+            missingMultipleFields: this.missingMultipleField,
         };
     }
     /**
@@ -590,7 +592,7 @@ class Entries {
                         .map(({ name }) => name)
                         .filter(Boolean)
                         .join(' ➜ '),
-                    'fixStatus': 'Fixed',
+                    fixStatus: 'Fixed',
                 });
                 entry[uid] = [entry[uid]];
             }
@@ -643,7 +645,7 @@ class Entries {
      * Else empty array
      */
     removeEmojiAndImages(str) {
-        return str.replace(/[\p{Emoji}\p{Emoji_Presentation}\p{Emoji_Modifier}\p{Emoji_Modifier_Base}\p{Emoji_Component}]+/gu, '');
+        return str === null || str === void 0 ? void 0 : str.replace(/[\p{Emoji}\p{Emoji_Presentation}\p{Emoji_Modifier}\p{Emoji_Modifier_Base}\p{Emoji_Component}]+/gu, '');
     }
     validateSelectField(tree, fieldStructure, field) {
         const { display_name, enum: selectOptions, multiple, min_instance, display_type, data_type } = fieldStructure;

package/oclif.manifest.json

@@ -344,5 +344,5 @@
       ]
     }
   },
-  "version": "1.12.0"
+  "version": "1.13.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.12.0",
+  "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.0",
+    "@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",