@contentstack/cli-audit 1.14.2 → 1.16.0

package/lib/modules/assets.js

@@ -10,12 +10,11 @@ const lodash_1 = require("lodash");
 /* The `ContentType` class is responsible for scanning content types, looking for references, and
 generating a report in JSON and CSV formats. */
 class Assets {
-    constructor({ log, fix, config, moduleName }) {
+    constructor({ fix, config, moduleName }) {
         this.locales = [];
         this.environments = [];
         this.schema = [];
         this.missingEnvLocales = {};
-        this.log = log;
         this.config = config;
         this.fix = fix !== null && fix !== void 0 ? fix : false;
         this.moduleName = this.validateModules(moduleName, this.config.moduleConfig);
@@ -34,16 +33,25 @@ class Assets {
      * @returns the `missingEnvLocales` object.
      */
     async run(returnFixSchema = false) {
+        var _a;
+        cli_utilities_1.log.debug(`Starting ${this.moduleName} audit process`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Data directory: ${this.folderPath}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Fix mode: ${this.fix}`, this.config.auditContext);
         if (!(0, fs_1.existsSync)(this.folderPath)) {
-            this.log(`Skipping ${this.moduleName} audit`, 'warn');
-            this.log((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
+            cli_utilities_1.log.debug(`Skipping ${this.moduleName} audit - path does not exist`, this.config.auditContext);
+            cli_utilities_1.log.warn(`Skipping ${this.moduleName} audit`, this.config.auditContext);
+            cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.NOT_VALID_PATH, { path: this.folderPath }), { color: 'yellow' });
             return returnFixSchema ? [] : {};
         }
+        cli_utilities_1.log.debug('Loading prerequisite data (locales and environments)', this.config.auditContext);
         await this.prerequisiteData();
+        cli_utilities_1.log.debug('Starting asset Reference, Environment and Locale validation', this.config.auditContext);
         await this.lookForReference();
         if (returnFixSchema) {
+            cli_utilities_1.log.debug(`Returning fixed schema with ${((_a = this.schema) === null || _a === void 0 ? void 0 : _a.length) || 0} items`, this.config.auditContext);
             return this.schema;
         }
+        cli_utilities_1.log.debug('Cleaning up empty missing environment/locale references', this.config.auditContext);
         for (let propName in this.missingEnvLocales) {
             if (Array.isArray(this.missingEnvLocales[propName])) {
                 if (!this.missingEnvLocales[propName].length) {
@@ -51,6 +59,8 @@ class Assets {
                 }
             }
         }
+        const totalIssues = Object.keys(this.missingEnvLocales).length;
+        cli_utilities_1.log.debug(`${this.moduleName} audit completed. Found ${totalIssues} assets with missing environment/locale references`, this.config.auditContext);
         return this.missingEnvLocales;
     }
     /**
@@ -59,17 +69,33 @@ class Assets {
      * app data, and stores them in the `extensions` array.
      */
     async prerequisiteData() {
-        this.log(messages_1.auditMsg.PREPARING_ENTRY_METADATA, 'info');
+        cli_utilities_1.log.debug('Loading prerequisite data (locales and environments)', this.config.auditContext);
+        cli_utilities_1.log.info(messages_1.auditMsg.PREPARING_ENTRY_METADATA, this.config.auditContext);
         const localesFolderPath = (0, path_1.resolve)(this.config.basePath, this.config.moduleConfig.locales.dirName);
         const localesPath = (0, path_1.join)(localesFolderPath, this.config.moduleConfig.locales.fileName);
         const masterLocalesPath = (0, path_1.join)(localesFolderPath, 'master-locale.json');
+        cli_utilities_1.log.debug(`Loading locales from: ${localesFolderPath}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Master locales path: ${masterLocalesPath}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Locales path: ${localesPath}`, this.config.auditContext);
         this.locales = (0, fs_1.existsSync)(masterLocalesPath) ? (0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(masterLocalesPath, 'utf8'))) : [];
+        cli_utilities_1.log.debug(`Loaded ${this.locales.length} locales from master-locale.json`, this.config.auditContext);
         if ((0, fs_1.existsSync)(localesPath)) {
-            this.locales.push(...(0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(localesPath, 'utf8'))));
+            cli_utilities_1.log.debug(`Loading additional locales from: ${localesPath}`, this.config.auditContext);
+            const additionalLocales = (0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(localesPath, 'utf8')));
+            this.locales.push(...additionalLocales);
+            cli_utilities_1.log.debug(`Added ${additionalLocales.length} additional locales`, this.config.auditContext);
+        }
+        else {
+            cli_utilities_1.log.debug('No additional locales file found', this.config.auditContext);
         }
         this.locales = this.locales.map((locale) => locale.code);
+        cli_utilities_1.log.debug(`Total locales loaded: ${this.locales.length}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Locale codes: ${this.locales.join(', ')}`, this.config.auditContext);
         const environmentPath = (0, path_1.resolve)(this.config.basePath, this.config.moduleConfig.environments.dirName, this.config.moduleConfig.environments.fileName);
+        cli_utilities_1.log.debug(`Loading environments from: ${environmentPath}`, this.config.auditContext);
         this.environments = (0, fs_1.existsSync)(environmentPath) ? (0, lodash_1.keys)(JSON.parse((0, fs_1.readFileSync)(environmentPath, 'utf8'))) : [];
+        cli_utilities_1.log.debug(`Total environments loaded: ${this.environments.length}`, this.config.auditContext);
+        cli_utilities_1.log.debug(`Environment names: ${this.environments.join(', ')}`, this.config.auditContext);
     }
     /**
      * The function checks if it can write the fix content to a file and if so, it writes the content as
@@ -77,61 +103,93 @@ class Assets {
      */
     async writeFixContent(filePath, schema) {
         var _a;
+        cli_utilities_1.log.debug(`Starting writeFixContent process for: ${filePath}`, this.config.auditContext);
         let canWrite = true;
         if (this.fix) {
+            cli_utilities_1.log.debug('Fix mode enabled, checking write permissions', this.config.auditContext);
             if (!this.config.flags['copy-dir'] && !((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm)) {
+                cli_utilities_1.log.debug(`Asking user for confirmation to write fix content (--yes flag: ${this.config.flags.yes})`, this.config.auditContext);
                 canWrite = this.config.flags.yes || (await cli_utilities_1.cliux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
             }
+            else {
+                cli_utilities_1.log.debug('Skipping confirmation due to copy-dir or external-config flags', this.config.auditContext);
+            }
             if (canWrite) {
+                cli_utilities_1.log.debug(`Writing fixed assets to: ${filePath}`, this.config.auditContext);
                 (0, fs_1.writeFileSync)(filePath, JSON.stringify(schema));
+                cli_utilities_1.log.debug(`Successfully wrote ${Object.keys(schema).length} assets to file`, this.config.auditContext);
             }
+            else {
+                cli_utilities_1.log.debug('User declined to write fix content', this.config.auditContext);
+            }
+        }
+        else {
+            cli_utilities_1.log.debug('Skipping writeFixContent - not in fix mode', this.config.auditContext);
         }
     }
     /**
      * This function traverse over the publish detials of the assets and remove the publish details where the locale or environment does not exist
      */
     async lookForReference() {
-        var _a, _b;
+        var _a, _b, _c, _d;
+        cli_utilities_1.log.debug('Starting asset reference validation', this.config.auditContext);
         let basePath = (0, path_1.join)(this.folderPath);
+        cli_utilities_1.log.debug(`Assets base path: ${basePath}`, this.config.auditContext);
         let fsUtility = new cli_utilities_1.FsUtility({ basePath, indexFileName: 'assets.json' });
         let indexer = fsUtility.indexFileContent;
+        cli_utilities_1.log.debug(`Found ${Object.keys(indexer).length} asset files to process`, this.config.auditContext);
         for (const fileIndex in indexer) {
+            cli_utilities_1.log.debug(`Processing asset file: ${indexer[fileIndex]}`, this.config.auditContext);
             const assets = (await fsUtility.readChunkFiles.next());
             this.assets = assets;
+            cli_utilities_1.log.debug(`Loaded ${Object.keys(assets).length} assets from file`, this.config.auditContext);
             for (const assetUid in assets) {
+                cli_utilities_1.log.debug(`Processing asset: ${assetUid}`, this.config.auditContext);
                 if (((_a = this.assets[assetUid]) === null || _a === void 0 ? void 0 : _a.publish_details) && !Array.isArray(this.assets[assetUid].publish_details)) {
-                    this.log((0, messages_1.$t)(messages_1.auditMsg.ASSET_NOT_EXIST, { uid: assetUid }), { color: 'red' });
+                    cli_utilities_1.log.debug(`Asset ${assetUid} has invalid publish_details format`, this.config.auditContext);
+                    cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.ASSET_NOT_EXIST, { uid: assetUid }), { color: 'red' });
                 }
-                this.assets[assetUid].publish_details = (_b = this.assets[assetUid]) === null || _b === void 0 ? void 0 : _b.publish_details.filter((pd) => {
+                const publishDetails = (_b = this.assets[assetUid]) === null || _b === void 0 ? void 0 : _b.publish_details;
+                cli_utilities_1.log.debug(`Asset ${assetUid} has ${(publishDetails === null || publishDetails === void 0 ? void 0 : publishDetails.length) || 0} publish details`, this.config.auditContext);
+                this.assets[assetUid].publish_details = (_c = this.assets[assetUid]) === null || _c === void 0 ? void 0 : _c.publish_details.filter((pd) => {
                     var _a, _b;
+                    cli_utilities_1.log.debug(`Checking publish detail: locale=${pd === null || pd === void 0 ? void 0 : pd.locale}, environment=${pd === null || pd === void 0 ? void 0 : pd.environment}`, this.config.auditContext);
                     if (((_a = this.locales) === null || _a === void 0 ? void 0 : _a.includes(pd === null || pd === void 0 ? void 0 : pd.locale)) && ((_b = this.environments) === null || _b === void 0 ? void 0 : _b.includes(pd === null || pd === void 0 ? void 0 : pd.environment))) {
-                        this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), { color: 'green' });
+                        cli_utilities_1.log.debug(`Publish detail valid for asset ${assetUid}: locale=${pd.locale}, environment=${pd.environment}`, this.config.auditContext);
+                        cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), this.config.auditContext);
                         return true;
                     }
                     else {
-                        this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_WARN_MSG, { uid: assetUid, locale: pd.locale, environment: pd.environment }), { color: 'yellow' });
+                        cli_utilities_1.log.debug(`Publish detail invalid for asset ${assetUid}: locale=${pd.locale}, environment=${pd.environment}`, this.config.auditContext);
+                        cli_utilities_1.cliux.print((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_WARN_MSG, { uid: assetUid, locale: pd.locale, environment: pd.environment }), { color: 'yellow' });
                         if (!Object.keys(this.missingEnvLocales).includes(assetUid)) {
+                            cli_utilities_1.log.debug(`Creating new missing reference entry for asset ${assetUid}`, this.config.auditContext);
                             this.missingEnvLocales[assetUid] = [
                                 { asset_uid: assetUid, publish_locale: pd.locale, publish_environment: pd.environment },
                             ];
                         }
                         else {
+                            cli_utilities_1.log.debug(`Adding to existing missing reference entry for asset ${assetUid}`, this.config.auditContext);
                             this.missingEnvLocales[assetUid].push({
                                 asset_uid: assetUid,
                                 publish_locale: pd.locale,
                                 publish_environment: pd.environment,
                             });
                         }
-                        this.log((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), { color: 'green' });
+                        cli_utilities_1.log.success((0, messages_1.$t)(messages_1.auditMsg.SCAN_ASSET_SUCCESS_MSG, { uid: assetUid }), this.config.auditContext);
                         return false;
                     }
                 });
+                const remainingPublishDetails = ((_d = this.assets[assetUid].publish_details) === null || _d === void 0 ? void 0 : _d.length) || 0;
+                cli_utilities_1.log.debug(`Asset ${assetUid} now has ${remainingPublishDetails} valid publish details`, this.config.auditContext);
                 if (this.fix) {
-                    this.log((0, messages_1.$t)(messages_1.auditFixMsg.ASSET_FIX, { uid: assetUid }), { color: 'green' });
+                    cli_utilities_1.log.debug(`Fixing asset ${assetUid}`, this.config.auditContext);
+                    cli_utilities_1.log.info((0, messages_1.$t)(messages_1.auditFixMsg.ASSET_FIX, { uid: assetUid }), this.config.auditContext);
                     await this.writeFixContent(`${basePath}/${indexer[fileIndex]}`, this.assets);
                 }
             }
         }
+        cli_utilities_1.log.debug(`Asset reference validation completed. Processed ${Object.keys(this.missingEnvLocales).length} assets with issues`, this.config.auditContext);
     }
 }
 exports.default = Assets;

package/lib/modules/content-types.d.ts

@@ -1,7 +1,6 @@
-import { LogFn, ConfigType, ModularBlockType, ContentTypeStruct, GroupFieldDataType, RefErrorReturnType, CtConstructorParam, GlobalFieldDataType, JsonRTEFieldDataType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, ContentTypeSchemaType, ExtensionOrAppFieldDataType } from '../types';
+import { ConfigType, ModularBlockType, ContentTypeStruct, GroupFieldDataType, RefErrorReturnType, CtConstructorParam, GlobalFieldDataType, JsonRTEFieldDataType, ModularBlocksDataType, ModuleConstructorParam, ReferenceFieldDataType, ContentTypeSchemaType, ExtensionOrAppFieldDataType } from '../types';
 import auditConfig from '../config';
 export default class ContentType {
-    log: LogFn;
     protected fix: boolean;
     fileName: string;
     config: ConfigType;
@@ -15,7 +14,7 @@ export default class ContentType {
     protected schema: ContentTypeStruct[];
     protected missingRefs: Record<string, any>;
     moduleName: keyof typeof auditConfig.moduleConfig;
-    constructor({ log, fix, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam);
+    constructor({ fix, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam);
     validateModules(moduleName: keyof typeof auditConfig.moduleConfig, moduleConfig: Record<string, unknown>): keyof typeof auditConfig.moduleConfig;
     /**
      * The `run` function checks if a folder path exists, sets the schema based on the module name,
@@ -127,7 +126,7 @@ export default class ContentType {
      * contains properties such as `data_type`, `field_metadata`, `uid`, `name`, etc.
      * @returns an array of ContentTypeSchemaType objects.
      */
-    runFixOnSchema(tree: Record<string, unknown>[], schema: ContentTypeSchemaType[]): ContentTypeSchemaType[];
+    runFixOnSchema(tree: Record<string, unknown>[], schema: ContentTypeSchemaType[]): any[];
     /**
      * The function fixes global field references in a tree structure by adding missing references and
      * returning the field if the reference exists, otherwise returning null.