@contentstack/cli-audit 2.0.0-beta.4 → 2.0.0-beta.6

package/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/2.0.0-beta.4 linux-x64 node-v22.22.0
+@contentstack/cli-audit/2.0.0-beta.6 linux-x64 node-v22.22.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND

package/lib/audit-base-command.js

@@ -341,10 +341,10 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * `gfSchema`. The values of these properties are the parsed JSON data from two different files.
      */
     getCtAndGfSchema() {
-        const ctPath = (0, path_1.join)(this.sharedConfig.basePath, this.sharedConfig.moduleConfig['content-types'].dirName, this.sharedConfig.moduleConfig['content-types'].fileName);
+        const ctDirPath = (0, path_1.join)(this.sharedConfig.basePath, this.sharedConfig.moduleConfig['content-types'].dirName);
         const gfPath = (0, path_1.join)(this.sharedConfig.basePath, this.sharedConfig.moduleConfig['global-fields'].dirName, this.sharedConfig.moduleConfig['global-fields'].fileName);
         const gfSchema = (0, fs_1.existsSync)(gfPath) ? JSON.parse((0, fs_1.readFileSync)(gfPath, 'utf8')) : [];
-        const ctSchema = (0, fs_1.existsSync)(ctPath) ? JSON.parse((0, fs_1.readFileSync)(ctPath, 'utf8')) : [];
+        const ctSchema = ((0, cli_utilities_1.readContentTypeSchemas)(ctDirPath) || []);
         return { ctSchema, gfSchema };
     }
     /**

package/lib/config/index.js

@@ -20,7 +20,7 @@ const config = {
     moduleConfig: {
         'content-types': {
             name: 'content type',
-            fileName: 'schema.json',
+            fileName: 'schema.json', // Not used - reads from individual files
             dirName: 'content_types',
         },
         'global-fields': {

package/lib/modules/content-types.js

@@ -152,7 +152,7 @@ class ContentType extends base_class_1.default {
      * JSON to the specified file path.
      */
     async writeFixContent() {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e;
         cli_utilities_1.log.debug('Starting writeFixContent process', this.config.auditContext);
         let canWrite = true;
         if (!this.inMemoryFix && this.fix) {
@@ -165,10 +165,19 @@ class ContentType extends base_class_1.default {
                 cli_utilities_1.log.debug('Skipping confirmation due to copy-dir or external-config flags', this.config.auditContext);
             }
             if (canWrite) {
-                const filePath = (0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName);
-                cli_utilities_1.log.debug(`Writing fixed schema to: ${filePath}`, this.config.auditContext);
-                (0, fs_1.writeFileSync)(filePath, JSON.stringify(this.schema));
-                cli_utilities_1.log.debug(`Successfully wrote ${((_c = this.schema) === null || _c === void 0 ? void 0 : _c.length) || 0} schemas to file`, this.config.auditContext);
+                // For content-types, write individual files instead of schema.json
+                cli_utilities_1.log.debug(`Writing ${((_c = this.schema) === null || _c === void 0 ? void 0 : _c.length) || 0} content types to individual files`, this.config.auditContext);
+                for (const contentType of (_d = this.schema) !== null && _d !== void 0 ? _d : []) {
+                    if (contentType.uid) {
+                        const filePath = (0, path_1.join)(this.folderPath, `${contentType.uid}.json`);
+                        cli_utilities_1.log.debug(`Writing fixed content type to: ${filePath}`, this.config.auditContext);
+                        (0, fs_1.writeFileSync)(filePath, JSON.stringify(contentType));
+                    }
+                    else {
+                        cli_utilities_1.log.warn(`Skipping content type without uid: ${JSON.stringify(contentType).substring(0, 100)}`, this.config.auditContext);
+                    }
+                }
+                cli_utilities_1.log.debug(`Successfully wrote ${((_e = this.schema) === null || _e === void 0 ? void 0 : _e.length) || 0} content types to individual files`, this.config.auditContext);
             }
             else {
                 cli_utilities_1.log.debug('User declined to write fix content', this.config.auditContext);

package/lib/modules/entries.d.ts

@@ -23,6 +23,21 @@ export default class Entries extends BaseClass {
     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

@@ -47,6 +47,39 @@ class Entries extends base_class_1.default {
         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.
@@ -633,7 +666,7 @@ class Entries extends base_class_1.default {
         cli_utilities_1.log.debug(`Validating modular blocks field: ${fieldStructure.display_name}`, this.config.auditContext);
         cli_utilities_1.log.debug(`Modular blocks field UID: ${fieldStructure.uid}`, this.config.auditContext);
         cli_utilities_1.log.debug(`Found ${field.length} modular blocks`, this.config.auditContext);
-        cli_utilities_1.log.debug(`Available blocks: ${fieldStructure.blocks.map(b => b.title).join(', ')}`);
+        cli_utilities_1.log.debug(`Available blocks: ${fieldStructure.blocks.map((b) => b.title).join(', ')}`);
         if (!this.fix) {
             cli_utilities_1.log.debug('Checking modular block references (non-fix mode)');
             for (const index in field) {
@@ -696,6 +729,7 @@ class Entries extends base_class_1.default {
      * 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');
@@ -703,8 +737,9 @@ class Entries extends base_class_1.default {
         }
         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];
@@ -723,7 +758,10 @@ class Entries extends base_class_1.default {
                     }
                 }
                 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)
@@ -736,7 +774,10 @@ class Entries extends base_class_1.default {
                     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`);
+                    }
                 }
             }
         }
@@ -1384,6 +1425,7 @@ class Entries extends base_class_1.default {
             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}`);
@@ -1400,6 +1442,10 @@ class Entries extends base_class_1.default {
                     }
                 }
                 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 };
                 }
@@ -1413,6 +1459,10 @@ class Entries extends base_class_1.default {
                     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;
                 }
@@ -1460,7 +1510,7 @@ class Entries extends base_class_1.default {
      */
     modularBlockRefCheck(tree, blocks, entryBlock, index) {
         cli_utilities_1.log.debug(`Checking modular block references for block ${index}`);
-        cli_utilities_1.log.debug(`Available block UIDs: ${blocks.map(b => b.uid).join(', ')}`);
+        cli_utilities_1.log.debug(`Available block UIDs: ${blocks.map((b) => b.uid).join(', ')}`);
         cli_utilities_1.log.debug(`Entry block keys: ${Object.keys(entryBlock).join(', ')}`);
         const validBlockUid = blocks.map((block) => block.uid);
         const invalidKeys = Object.keys(entryBlock).filter((key) => !validBlockUid.includes(key));
@@ -1528,6 +1578,25 @@ class Entries extends base_class_1.default {
                 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/lib/modules/field_rules.js

@@ -183,12 +183,10 @@ class FieldRule extends base_class_1.default {
             cli_utilities_1.log.debug(`Fixing field rule ${index + 1}`, this.config.auditContext);
             cli_utilities_1.log.debug(`Original actions count: ${((_a = fr.actions) === null || _a === void 0 ? void 0 : _a.length) || 0}`, this.config.auditContext);
             cli_utilities_1.log.debug(`Original conditions count: ${((_b = fr.conditions) === null || _b === void 0 ? void 0 : _b.length) || 0}`, this.config.auditContext);
-            const validActions = (_d = (_c = fr.actions) === null || _c === void 0 ? void 0 : _c.filter(action => {
+            const validActions = (_d = (_c = fr.actions) === null || _c === void 0 ? void 0 : _c.filter((action) => {
                 const isValid = this.schemaMap.includes(action.target_field);
                 cli_utilities_1.log.debug(`Action target_field=${action.target_field}, valid=${isValid}`, this.config.auditContext);
-                const logMsg = isValid
-                    ? messages_1.auditMsg.FIELD_RULE_TARGET_SCAN_MESSAGE
-                    : messages_1.auditMsg.FIELD_RULE_TARGET_ABSENT;
+                const logMsg = isValid ? messages_1.auditMsg.FIELD_RULE_TARGET_SCAN_MESSAGE : messages_1.auditMsg.FIELD_RULE_TARGET_ABSENT;
                 if (isValid) {
                     cli_utilities_1.log.info((0, messages_1.$t)(logMsg, Object.assign({ num: index.toString(), ctUid: schema.uid }, (action.target_field && { target_field: action.target_field }))), this.config.auditContext);
                 }
@@ -200,18 +198,16 @@ class FieldRule extends base_class_1.default {
                     this.addMissingReferences(action, 'Fixed');
                     cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditFixMsg.FIELD_RULE_FIX_MESSAGE, {
                         num: index.toString(),
-                        ctUid: schema.uid
+                        ctUid: schema.uid,
                     }), this.config.auditContext);
                 }
                 return isValid;
             })) !== null && _d !== void 0 ? _d : [];
             cli_utilities_1.log.debug(`Valid actions after filtering: ${validActions.length}`, this.config.auditContext);
-            const validConditions = (_f = (_e = fr.conditions) === null || _e === void 0 ? void 0 : _e.filter(condition => {
+            const validConditions = (_f = (_e = fr.conditions) === null || _e === void 0 ? void 0 : _e.filter((condition) => {
                 const isValid = this.schemaMap.includes(condition.operand_field);
                 cli_utilities_1.log.debug(`Condition operand_field=${condition.operand_field}, valid=${isValid}`, this.config.auditContext);
-                const logMsg = isValid
-                    ? messages_1.auditMsg.FIELD_RULE_CONDITION_SCAN_MESSAGE
-                    : messages_1.auditMsg.FIELD_RULE_CONDITION_ABSENT;
+                const logMsg = isValid ? messages_1.auditMsg.FIELD_RULE_CONDITION_SCAN_MESSAGE : messages_1.auditMsg.FIELD_RULE_CONDITION_ABSENT;
                 if (isValid) {
                     cli_utilities_1.log.info((0, messages_1.$t)(logMsg, Object.assign({ num: index.toString(), ctUid: schema.uid }, (condition.operand_field && { condition_field: condition.operand_field }))), this.config.auditContext);
                 }
@@ -223,7 +219,7 @@ class FieldRule extends base_class_1.default {
                     this.addMissingReferences(condition, 'Fixed');
                     cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditFixMsg.FIELD_RULE_FIX_MESSAGE, {
                         num: index.toString(),
-                        ctUid: schema.uid
+                        ctUid: schema.uid,
                     }), this.config.auditContext);
                 }
                 return isValid;
@@ -231,7 +227,8 @@ class FieldRule extends base_class_1.default {
             cli_utilities_1.log.debug(`Valid conditions after filtering: ${validConditions.length}`, this.config.auditContext);
             const shouldKeepRule = validActions.length && validConditions.length;
             cli_utilities_1.log.debug(`Field rule ${index + 1} ${shouldKeepRule ? 'kept' : 'removed'} (actions: ${validActions.length}, conditions: ${validConditions.length})`, this.config.auditContext);
-            return shouldKeepRule ? Object.assign(Object.assign({}, fr), { actions: validActions, conditions: validConditions }) : null;
+            return shouldKeepRule
+                ? Object.assign(Object.assign({}, fr), { actions: validActions, conditions: validConditions }) : null;
         })
             .filter(Boolean);
         cli_utilities_1.log.debug(`Field rules fix completed for schema: ${schema.uid}. ${schema.field_rules.length} rules remaining`, this.config.auditContext);
@@ -322,11 +319,20 @@ class FieldRule extends base_class_1.default {
                 cli_utilities_1.log.debug(`Skipping confirmation due to flags`, this.config.auditContext);
             }
             if (canWrite) {
-                const outputPath = (0, path_1.join)(this.folderPath, this.config.moduleConfig[this.moduleName].fileName);
-                cli_utilities_1.log.debug(`Writing fixed schema to: ${outputPath}`, this.config.auditContext);
-                cli_utilities_1.log.debug(`Schema items to write: ${((_d = this.schema) === null || _d === void 0 ? void 0 : _d.length) || 0}`, this.config.auditContext);
-                (0, fs_1.writeFileSync)(outputPath, JSON.stringify(this.schema));
-                cli_utilities_1.log.debug(`Successfully wrote fixed schema to file`, this.config.auditContext);
+                // const outputPath = join(this.folderPath, this.config.moduleConfig[this.moduleName].fileName);
+                // log.debug(`Writing fixed schema to: ${outputPath}`, this.config.auditContext);
+                // log.debug(`Schema items to write: ${this.schema?.length || 0}`, this.config.auditContext);
+                // writeFileSync(outputPath, JSON.stringify(this.schema));
+                // log.debug(`Successfully wrote fixed schema to file`, this.config.auditContext);
+                for (const schema of (_d = this.schema) !== null && _d !== void 0 ? _d : []) {
+                    if (!(schema === null || schema === void 0 ? void 0 : schema.uid)) {
+                        cli_utilities_1.log.warn(`Skipping schema with missing uid`, this.config.auditContext);
+                        continue;
+                    }
+                    const filePath = (0, path_1.join)(this.folderPath, `${schema.uid}.json`);
+                    (0, fs_1.writeFileSync)(filePath, JSON.stringify(schema));
+                    cli_utilities_1.log.debug(`Wrote fixed schema: ${schema.uid} → ${filePath}`, this.config.auditContext);
+                }
             }
             else {
                 cli_utilities_1.log.debug(`Skipping file write - user declined confirmation`, this.config.auditContext);

package/oclif.manifest.json

@@ -340,5 +340,5 @@
       ]
     }
   },
-  "version": "2.0.0-beta.4"
+  "version": "2.0.0-beta.6"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.6",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -18,8 +18,8 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@contentstack/cli-command": "~2.0.0-beta",
-    "@contentstack/cli-utilities": "~2.0.0-beta",
+    "@contentstack/cli-command": "~2.0.0-beta.2",
+    "@contentstack/cli-utilities": "~2.0.0-beta.2",
     "@oclif/core": "^4.3.0",
     "@oclif/plugin-help": "^6.2.28",
     "chalk": "^4.1.2",
@@ -64,15 +64,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 oclif.manifest.json",
     "test:unit:report": "nyc --extension .ts mocha --forbid-only \"test/unit/**/*.test.ts\"",
     "test:unit": "mocha --timeout 10000 --forbid-only \"test/unit/**/*.test.ts\""
   },
@@ -83,4 +83,4 @@
   "keywords": [
     "oclif"
   ]
-}
+}