@contentstack/cli-audit 1.17.1 → 1.19.0-beta.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.17.1 linux-x64 node-v22.22.0
+@contentstack/cli-audit/1.19.0-beta.0 linux-x64 node-v22.22.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -309,7 +309,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:add PLUGIN`
 
@@ -383,7 +383,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN`
 
@@ -432,7 +432,7 @@ EXAMPLES
     $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PATH`
 
@@ -463,7 +463,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:remove [PLUGIN]`
 
@@ -504,7 +504,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall [PLUGIN]`
 
@@ -532,7 +532,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:unlink [PLUGIN]`
 
@@ -576,5 +576,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/lib/modules/entries.d.ts

@@ -23,6 +23,21 @@ export default class Entries {
     moduleName: keyof typeof auditConfig.moduleConfig;
     constructor({ fix, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam);
     validateModules(moduleName: keyof typeof auditConfig.moduleConfig, moduleConfig: Record<string, unknown>): keyof typeof auditConfig.moduleConfig;
+    /**
+     * Returns whether a referenced entry's content type is allowed by the schema's reference_to.
+     * @param refCtUid - Content type UID of the referenced entry (e.g. from _content_type_uid)
+     * @param referenceTo - Schema's reference_to (string or string[])
+     * @param configOverride - Optional config with skipRefs; falls back to this.config
+     * @returns true if allowed or check cannot be performed; false if refCtUid is not in reference_to
+     */
+    protected isRefContentTypeAllowed(refCtUid: string | undefined, referenceTo: string | string[] | undefined, configOverride?: {
+        skipRefs?: string[];
+    }): boolean;
+    /**
+     * If ref CT is not allowed, pushes to missingRefs.
+     * @returns true if invalid (pushed), false if valid
+     */
+    private addInvalidRefIfNeeded;
     /**
      * 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

@@ -46,6 +46,39 @@ class Entries {
         cli_utilities_1.log.debug(`Module ${moduleName} not found in config, defaulting to: entries`, this.config.auditContext);
         return 'entries';
     }
+    /**
+     * Returns whether a referenced entry's content type is allowed by the schema's reference_to.
+     * @param refCtUid - Content type UID of the referenced entry (e.g. from _content_type_uid)
+     * @param referenceTo - Schema's reference_to (string or string[])
+     * @param configOverride - Optional config with skipRefs; falls back to this.config
+     * @returns true if allowed or check cannot be performed; false if refCtUid is not in reference_to
+     */
+    isRefContentTypeAllowed(refCtUid, referenceTo, configOverride) {
+        var _a, _b;
+        if (refCtUid === undefined)
+            return true;
+        const skipRefs = (_b = (_a = configOverride === null || configOverride === void 0 ? void 0 : configOverride.skipRefs) !== null && _a !== void 0 ? _a : this.config.skipRefs) !== null && _b !== void 0 ? _b : [];
+        if (Array.isArray(skipRefs) && skipRefs.includes(refCtUid))
+            return true;
+        if (referenceTo === undefined || referenceTo === null)
+            return true;
+        const refToList = Array.isArray(referenceTo) ? referenceTo : [referenceTo];
+        if (refToList.length === 0)
+            return false;
+        return refToList.includes(refCtUid);
+    }
+    /**
+     * If ref CT is not allowed, pushes to missingRefs.
+     * @returns true if invalid (pushed), false if valid
+     */
+    addInvalidRefIfNeeded(missingRefs, uidValue, refCtUid, referenceTo, fullRef, logLabel) {
+        if (this.isRefContentTypeAllowed(refCtUid, referenceTo))
+            return false;
+        cli_utilities_1.log.debug(`${logLabel} has wrong content type: ${refCtUid} not in reference_to`);
+        const refList = Array.isArray(referenceTo) ? referenceTo : referenceTo != null ? [referenceTo] : [];
+        missingRefs.push(refList.length === 1 ? { uid: uidValue, _content_type_uid: refCtUid } : fullRef);
+        return true;
+    }
     /**
      * 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.
@@ -674,6 +707,7 @@ class Entries {
      * objects.
      */
     validateReferenceValues(tree, fieldStructure, field) {
+        var _a;
         cli_utilities_1.log.debug(`Validating reference values for field: ${fieldStructure.display_name}`);
         if (this.fix) {
             cli_utilities_1.log.debug('Fix mode enabled, skipping reference validation');
@@ -681,8 +715,9 @@ class Entries {
         }
         const missingRefs = [];
         const { uid: data_type, display_name, reference_to } = fieldStructure;
+        const refToList = Array.isArray(reference_to) ? reference_to : reference_to != null ? [reference_to] : [];
         cli_utilities_1.log.debug(`Reference field UID: ${data_type}`);
-        cli_utilities_1.log.debug(`Reference to: ${(reference_to === null || reference_to === void 0 ? void 0 : reference_to.join(', ')) || 'none'}`);
+        cli_utilities_1.log.debug(`Reference to: ${refToList.join(', ') || 'none'}`);
         cli_utilities_1.log.debug(`Found ${(field === null || field === void 0 ? void 0 : field.length) || 0} references to validate`);
         for (const index in field !== null && field !== void 0 ? field : []) {
             const reference = field[index];
@@ -701,7 +736,10 @@ class Entries {
                     }
                 }
                 else {
-                    cli_utilities_1.log.debug(`Reference ${reference} is valid`);
+                    const refCtUid = refExist.ctUid;
+                    if (!this.addInvalidRefIfNeeded(missingRefs, reference, refCtUid, reference_to, reference, `Reference ${reference}`)) {
+                        cli_utilities_1.log.debug(`Reference ${reference} is valid`);
+                    }
                 }
             }
             // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
@@ -714,7 +752,10 @@ class Entries {
                     missingRefs.push(reference);
                 }
                 else {
-                    cli_utilities_1.log.debug(`Reference ${uid} is valid`);
+                    const refCtUid = (_a = reference._content_type_uid) !== null && _a !== void 0 ? _a : refExist.ctUid;
+                    if (!this.addInvalidRefIfNeeded(missingRefs, uid, refCtUid, reference_to, reference, `Reference ${uid}`)) {
+                        cli_utilities_1.log.debug(`Reference ${uid} is valid`);
+                    }
                 }
             }
         }
@@ -1362,6 +1403,7 @@ class Entries {
             cli_utilities_1.log.debug(`Parsed entry: ${Array.isArray(entry) ? entry.length : 'N/A'} references`);
         }
         entry = entry === null || entry === void 0 ? void 0 : entry.map((reference, index) => {
+            var _a, _b;
             const { uid } = reference;
             const { reference_to } = field;
             cli_utilities_1.log.debug(`Processing reference ${index}: ${uid || reference}`);
@@ -1378,6 +1420,10 @@ class Entries {
                     }
                 }
                 else {
+                    const refCtUid = (_a = reference._content_type_uid) !== null && _a !== void 0 ? _a : refExist.ctUid;
+                    if (this.addInvalidRefIfNeeded(missingRefs, reference, refCtUid, reference_to, reference, `Blt reference ${reference}`)) {
+                        return null;
+                    }
                     cli_utilities_1.log.debug(`Blt reference ${reference} is valid`);
                     return { uid: reference, _content_type_uid: refExist.ctUid };
                 }
@@ -1391,6 +1437,10 @@ class Entries {
                     return null;
                 }
                 else {
+                    const refCtUid = (_b = reference._content_type_uid) !== null && _b !== void 0 ? _b : refExist.ctUid;
+                    if (this.addInvalidRefIfNeeded(missingRefs, uid, refCtUid, reference_to, reference, `Reference ${uid}`)) {
+                        return null;
+                    }
                     cli_utilities_1.log.debug(`Reference ${uid} is valid`);
                     return reference;
                 }
@@ -1506,6 +1556,25 @@ class Entries {
                 return null;
             }
             else {
+                const refCtUid = contentTypeUid !== null && contentTypeUid !== void 0 ? contentTypeUid : refExist.ctUid;
+                const referenceTo = schema.reference_to;
+                if (!this.isRefContentTypeAllowed(refCtUid, referenceTo)) {
+                    cli_utilities_1.log.debug(`JSON RTE embed ${entryUid} has wrong content type: ${refCtUid} not in reference_to`);
+                    this.missingRefs[this.currentUid].push({
+                        tree,
+                        uid: this.currentUid,
+                        name: this.currentTitle,
+                        data_type: schema.data_type,
+                        display_name: schema.display_name,
+                        fixStatus: this.fix ? 'Fixed' : undefined,
+                        treeStr: tree
+                            .map(({ name }) => name)
+                            .filter((val) => val)
+                            .join(' ➜ '),
+                        missingRefs: [{ uid: entryUid, 'content-type-uid': refCtUid }],
+                    });
+                    return this.fix ? null : true;
+                }
                 cli_utilities_1.log.debug(`Entry reference ${entryUid} is valid`);
             }
         }

package/oclif.manifest.json

@@ -346,5 +346,5 @@
       ]
     }
   },
-  "version": "1.17.1"
+  "version": "1.19.0-beta.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.17.1",
+  "version": "1.19.0-beta.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -18,15 +18,15 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@contentstack/cli-command": "~1.7.2",
-    "@contentstack/cli-utilities": "~1.17.0",
+    "@contentstack/cli-command": "~1.8.0-beta.0",
+    "@contentstack/cli-utilities": "~1.18.0-beta.0",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "@oclif/plugin-plugins": "^5.4.54",
     "chalk": "^4.1.2",
     "fast-csv": "^4.3.6",
     "fs-extra": "^11.3.0",
-    "lodash": "^4.17.21",
+    "lodash": "^4.17.23",
     "uuid": "^9.0.1",
     "winston": "^3.17.0"
   },
@@ -66,15 +66,15 @@
     "repositoryPrefix": "<%- repo %>/blob/main/packages/contentstack-audit/<%- commandPath %>"
   },
   "scripts": {
-    "build": "npm run clean && shx rm -rf lib && tsc -b",
+    "build": "pnpm compile && oclif manifest && oclif readme",
     "lint": "eslint . --ext .ts --config .eslintrc",
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "npm run lint",
-    "compile": "shx rm -rf lib tsconfig.tsbuildinfo && tsc -b",
+    "compile": "tsc -b tsconfig.json",
     "prepack": "pnpm compile && oclif manifest && oclif readme",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
     "version": "oclif readme && git add README.md",
-    "clean": "rm -rf ./lib ./node_modules .tsbuildinfo oclif.manifest.json",
+    "clean": "rm -rf ./lib ./node_modules tsconfig.tsbuildinfo",
     "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
     "test:unit": "mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.ts\""
   },