@contentstack/cli-audit 1.7.4 → 1.8.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.7.4 linux-x64 node-v18.20.5
+@contentstack/cli-audit/1.8.0 linux-x64 node-v22.14.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -53,12 +53,12 @@ Perform audits and find possible errors in the exported Contentstack data
 ```
 USAGE
   $ csdx audit [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles] [--columns <value> | ] [--sort <value>]
-    [--filter <value>] [--csv | --no-truncate]
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
+    <value>] [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
   --modules=<option>...  Provide the list of modules to be audited
-                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
+                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
   --report-path=<value>  Path to store the audit reports
 
 TABLE FLAGS
@@ -94,9 +94,9 @@ Perform audits and fix possible errors in the exported Contentstack data.
 ```
 USAGE
   $ csdx audit:fix [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles] [--copy-path <value> --copy-dir] [--fix-only
-    reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ] [--sort <value>]
-    [--filter <value>] [--csv | --no-truncate]
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
+    [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
+    [--sort <value>] [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
   --copy-dir              Create backup from the original data.
@@ -104,7 +104,7 @@ FLAGS
   --fix-only=<option>...  Provide the list of fix options
                           <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
   --modules=<option>...   Provide the list of modules to be audited
-                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
+                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
   --report-path=<value>   Path to store the audit reports
 
 TABLE FLAGS
@@ -142,12 +142,12 @@ Perform audits and find possible errors in the exported Contentstack data
 ```
 USAGE
   $ csdx cm:stacks:audit [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles] [--columns <value> | ] [--sort <value>]
-    [--filter <value>] [--csv | --no-truncate]
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
+    <value>] [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
   --modules=<option>...  Provide the list of modules to be audited
-                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
+                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
   --report-path=<value>  Path to store the audit reports
 
 TABLE FLAGS
@@ -185,9 +185,9 @@ Perform audits and fix possible errors in the exported Contentstack data.
 ```
 USAGE
   $ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
-    content-types|global-fields|entries|extensions|workflows|custom-roles] [--copy-path <value> --copy-dir] [--fix-only
-    reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ] [--sort <value>]
-    [--filter <value>] [--csv | --no-truncate]
+    content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
+    [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
+    [--sort <value>] [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
   --copy-dir              Create backup from the original data.
@@ -195,7 +195,7 @@ FLAGS
   --fix-only=<option>...  Provide the list of fix options
                           <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
   --modules=<option>...   Provide the list of modules to be audited
-                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
+                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
   --report-path=<value>   Path to store the audit reports
 
 TABLE FLAGS
@@ -269,7 +269,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:add PLUGIN`
 
@@ -343,7 +343,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN`
 
@@ -392,7 +392,7 @@ EXAMPLES
     $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PATH`
 
@@ -423,7 +423,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:remove [PLUGIN]`
 
@@ -464,7 +464,7 @@ FLAGS
   --reinstall  Reinstall all plugins after uninstalling.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/reset.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/reset.ts)_
 
 ## `csdx plugins:uninstall [PLUGIN]`
 
@@ -492,7 +492,7 @@ EXAMPLES
   $ csdx plugins:uninstall myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:unlink [PLUGIN]`
 
@@ -536,5 +536,5 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.22/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.34/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

package/lib/audit-base-command.d.ts

@@ -33,6 +33,8 @@ export declare abstract class AuditBaseCommand extends BaseCommand<typeof AuditB
         missingMandatoryFields: Record<string, any> | undefined;
         missingTitleFields: Record<string, any> | undefined;
         missingRefInCustomRoles: {} | undefined;
+        missingEnvLocalesInAssets: Record<string, any> | undefined;
+        missingEnvLocalesInEntries: Record<string, any> | undefined;
     }>;
     /**
      * The `promptQueue` function prompts the user to enter a data directory path if the `data-dir` flag

package/lib/audit-base-command.js

@@ -41,7 +41,7 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
         await this.promptQueue();
         await this.createBackUp();
         this.sharedConfig.reportPath = (0, path_1.resolve)(this.flags['report-path'] || process.cwd(), 'audit-report');
-        const { missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles } = await this.scanAndFix();
+        const { missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries } = await this.scanAndFix();
         this.showOutputOnScreen([
             { module: 'Content types', missingRefs: missingCtRefs },
             { module: 'Global Fields', missingRefs: missingGfRefs },
@@ -57,6 +57,8 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             { module: 'Entries Title Field', missingRefs: missingTitleFields },
         ]);
         this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Custom Roles', missingRefs: missingRefInCustomRoles }]);
+        this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Assets', missingRefs: missingEnvLocalesInAssets }]);
+        this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Entries Missing Locale and Environments', missingRefs: missingEnvLocalesInEntries }]);
         if (!(0, isEmpty_1.default)(missingCtRefs) ||
             !(0, isEmpty_1.default)(missingGfRefs) ||
             !(0, isEmpty_1.default)(missingEntryRefs) ||
@@ -64,7 +66,9 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             !(0, isEmpty_1.default)(missingCtRefsInExtensions) ||
             !(0, isEmpty_1.default)(missingSelectFeild) ||
             !(0, isEmpty_1.default)(missingTitleFields) ||
-            !(0, isEmpty_1.default)(missingRefInCustomRoles)) {
+            !(0, isEmpty_1.default)(missingRefInCustomRoles) ||
+            !(0, isEmpty_1.default)(missingEnvLocalesInAssets) ||
+            !(0, isEmpty_1.default)(missingEnvLocalesInEntries)) {
             if (this.currentCommand === 'cm:stacks:audit') {
                 this.log(this.$t(messages_1.auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
             }
@@ -88,7 +92,9 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             !(0, isEmpty_1.default)(missingCtRefsInWorkflow) ||
             !(0, isEmpty_1.default)(missingCtRefsInExtensions) ||
             !(0, isEmpty_1.default)(missingSelectFeild) ||
-            !(0, isEmpty_1.default)(missingRefInCustomRoles));
+            !(0, isEmpty_1.default)(missingRefInCustomRoles) ||
+            !(0, isEmpty_1.default)(missingEnvLocalesInAssets) ||
+            !(0, isEmpty_1.default)(missingEnvLocalesInEntries));
     }
     /**
      * The `scan` function performs an audit on different modules (content-types, global-fields, and
@@ -97,9 +103,9 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
      * and `missingEntryRefs`.
      */
     async scanAndFix() {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e;
         let { ctSchema, gfSchema } = this.getCtAndGfSchema();
-        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles;
+        let missingCtRefs, missingGfRefs, missingEntryRefs, missingCtRefsInExtensions, missingCtRefsInWorkflow, missingSelectFeild, missingEntry, missingMandatoryFields, missingTitleFields, missingRefInCustomRoles, missingEnvLocalesInAssets, missingEnvLocalesInEntries;
         for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
             (0, log_1.print)([
                 {
@@ -117,6 +123,10 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                 fix: this.currentCommand === 'cm:stacks:audit:fix',
             };
             switch (module) {
+                case 'assets':
+                    missingEnvLocalesInAssets = await new modules_1.Assets((0, cloneDeep_1.default)(constructorParam)).run();
+                    await this.prepareReport(module, missingEnvLocalesInAssets);
+                    break;
                 case 'content-types':
                     missingCtRefs = await new modules_1.ContentType((0, cloneDeep_1.default)(constructorParam)).run();
                     await this.prepareReport(module, missingCtRefs);
@@ -131,10 +141,12 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
                     missingSelectFeild = (_b = missingEntry.missingSelectFeild) !== null && _b !== void 0 ? _b : {};
                     missingMandatoryFields = (_c = missingEntry.missingMandatoryFields) !== null && _c !== void 0 ? _c : {};
                     missingTitleFields = (_d = missingEntry.missingTitleFields) !== null && _d !== void 0 ? _d : {};
+                    missingEnvLocalesInEntries = (_e = missingEntry.missingEnvLocale) !== null && _e !== void 0 ? _e : {};
                     await this.prepareReport(module, missingEntryRefs);
                     await this.prepareReport(`Entries_Select_feild`, missingSelectFeild);
                     await this.prepareReport('Entries_Mandatory_feild', missingMandatoryFields);
                     await this.prepareReport('Entries_Title_feild', missingTitleFields);
+                    await this.prepareReport('Entry_Missing_Locale_and_Env_in_Publish_Details', missingEnvLocalesInEntries);
                     break;
                 case 'workflows':
                     missingCtRefsInWorkflow = await new modules_1.Workflows({
@@ -178,6 +190,8 @@ class AuditBaseCommand extends base_command_1.BaseCommand {
             missingMandatoryFields,
             missingTitleFields,
             missingRefInCustomRoles,
+            missingEnvLocalesInAssets,
+            missingEnvLocalesInEntries
         };
     }
     /**

package/lib/config/index.d.ts

@@ -40,6 +40,16 @@ declare const config: {
             dirName: string;
             fileName: string;
         };
+        assets: {
+            name: string;
+            dirName: string;
+            fileName: string;
+        };
+        environments: {
+            name: string;
+            dirName: string;
+            fileName: string;
+        };
     };
     entries: {
         systemKeys: string[];
@@ -49,6 +59,8 @@ declare const config: {
         Entries_Select_feild: string;
         Entries_Mandatory_feild: string;
         Entries_Title_feild: string;
+        Entry_Missing_Locale_and_Env: string;
+        Entry_Missing_Locale_and_Env_in_Publish_Details: string;
     };
     feild_level_modules: string[];
 };

package/lib/config/index.js

@@ -4,7 +4,7 @@ const config = {
     showTerminalOutput: true,
     skipRefs: ['sys_assets'],
     skipFieldTypes: ['taxonomy', 'group'],
-    modules: ['content-types', 'global-fields', 'entries', 'extensions', 'workflows', 'custom-roles'],
+    modules: ['content-types', 'global-fields', 'entries', 'extensions', 'workflows', 'custom-roles', 'assets'],
     'fix-fields': ['reference', 'global_field', 'json:rte', 'json:extension', 'blocks', 'group', 'content_types'],
     moduleConfig: {
         'content-types': {
@@ -42,6 +42,16 @@ const config = {
             dirName: 'custom-roles',
             fileName: 'custom-roles.json',
         },
+        'assets': {
+            name: 'assets',
+            dirName: 'assets',
+            fileName: 'assets.json',
+        },
+        'environments': {
+            name: 'environments',
+            dirName: 'environments',
+            fileName: 'environments.json',
+        }
     },
     entries: {
         systemKeys: [
@@ -78,12 +88,22 @@ const config = {
         'min_instance',
         'missingFieldUid',
         'isPublished',
+        'locale',
+        'environment',
+        'ctUid',
+        'ctLocale',
+        'entry_uid',
+        'publish_locale',
+        'publish_environment',
+        'asset_uid'
     ],
     ReportTitleForEntries: {
         Entries_Select_feild: 'Entries_Select_feild',
         Entries_Mandatory_feild: 'Entries_Mandatory_feild',
         Entries_Title_feild: 'Entries_Title_feild',
+        Entry_Missing_Locale_and_Env: 'Entry_Missing_Locale_and_Env',
+        Entry_Missing_Locale_and_Env_in_Publish_Details: 'Entry_Missing_Locale_and_Env_in_Publish_Details'
     },
-    feild_level_modules: ['Entries_Title_feild', 'Entries_Mandatory_feild', 'Entries_Select_feild'],
+    feild_level_modules: ['Entries_Title_feild', 'Entries_Mandatory_feild', 'Entries_Select_feild', 'Entry_Missing_Locale_and_Env_in_Publish_Details'],
 };
 exports.default = config;

package/lib/messages/index.d.ts

@@ -32,6 +32,12 @@ declare const auditMsg: {
     AUDIT_CMD_DESCRIPTION: string;
     SCAN_WF_SUCCESS_MSG: string;
     SCAN_CR_SUCCESS_MSG: string;
+    SCAN_ASSET_SUCCESS_MSG: string;
+    SCAN_ASSET_WARN_MSG: string;
+    ENTRY_PUBLISH_DETAILS: string;
+    CT_REFERENCE_FIELD: string;
+    ASSET_NOT_EXIST: string;
+    ENTRY_PUBLISH_DETAILS_NOT_EXIST: string;
 };
 declare const auditFixMsg: {
     COPY_DATA: string;
@@ -43,6 +49,7 @@ declare const auditFixMsg: {
     WF_FIX_MSG: string;
     ENTRY_MANDATORY_FIELD_FIX: string;
     ENTRY_SELECT_FIELD_FIX: string;
+    ASSET_FIX: string;
 };
 declare const messages: typeof errors & typeof commonMsg & typeof auditMsg & typeof auditFixMsg & typeof tableColumnDescriptions;
 /**

package/lib/messages/index.js

@@ -40,6 +40,12 @@ const auditMsg = {
     AUDIT_CMD_DESCRIPTION: 'Perform audits and find possible errors in the exported Contentstack data',
     SCAN_WF_SUCCESS_MSG: 'Successfully completed the scanning of workflow with UID {uid} and name {name}.',
     SCAN_CR_SUCCESS_MSG: 'Successfully completed the scanning of custom role with UID {uid} and name {name}.',
+    SCAN_ASSET_SUCCESS_MSG: `Successfully completed the scanning of Asset with UID '{uid}'.`,
+    SCAN_ASSET_WARN_MSG: `The locale '{locale}' or environment '{environment}' are not present for asset with uid '{uid}'`,
+    ENTRY_PUBLISH_DETAILS: `Removing the publish detials for entry '{uid}' of ct '{ctuid}' in locale '{locale}' as locale '{publocale}' or environment '{environment}' does not exist`,
+    CT_REFERENCE_FIELD: `The mentioned Reference Field is not Array field name 'reference_to' having display name 'display_name'`,
+    ASSET_NOT_EXIST: `The publish_details either does not exist or is not an array for asset uid '{uid}'`,
+    ENTRY_PUBLISH_DETAILS_NOT_EXIST: `The publish_details either does not exist or is not an array for entry uid '{uid}'`,
 };
 exports.auditMsg = auditMsg;
 const auditFixMsg = {
@@ -52,6 +58,7 @@ const auditFixMsg = {
     WF_FIX_MSG: 'Successfully removed the workflow {uid} named {name}.',
     ENTRY_MANDATORY_FIELD_FIX: `Removing the publish details from the entry with UID '{uid}' in Locale '{locale}'...`,
     ENTRY_SELECT_FIELD_FIX: `Adding the value '{value}' in the select field of entry UID '{uid}'...`,
+    ASSET_FIX: `Fixed publish detials for Asset with UID '{uid}'`,
 };
 exports.auditFixMsg = auditFixMsg;
 const messages = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, errors), commonMsg), auditMsg), auditFixMsg), tableColumnDescriptions);

package/lib/modules/assets.d.ts

@@ -0,0 +1,40 @@
+import { LogFn, ConfigType, ContentTypeStruct, CtConstructorParam, ModuleConstructorParam, EntryStruct } from '../types';
+import auditConfig from '../config';
+export default class Assets {
+    log: LogFn;
+    protected fix: boolean;
+    fileName: string;
+    config: ConfigType;
+    folderPath: string;
+    currentUid: string;
+    currentTitle: string;
+    assets: Record<string, any>;
+    locales: string[];
+    environments: string[];
+    protected schema: ContentTypeStruct[];
+    protected missingEnvLocales: Record<string, any>;
+    moduleName: keyof typeof auditConfig.moduleConfig;
+    constructor({ log, fix, config, moduleName }: 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,
+     * iterates over the schema and looks for references, and returns a list of missing references.
+     * @returns the `missingEnvLocales` object.
+     */
+    run(returnFixSchema?: boolean): Promise<Record<string, any>>;
+    /**
+     * @method prerequisiteData
+     * The `prerequisiteData` function reads and parses JSON files to retrieve extension and marketplace
+     * app data, and stores them in the `extensions` array.
+     */
+    prerequisiteData(): Promise<void>;
+    /**
+     * The function checks if it can write the fix content to a file and if so, it writes the content as
+     * JSON to the specified file path.
+     */
+    writeFixContent(filePath: string, schema: Record<string, EntryStruct>): Promise<void>;
+    /**
+     * This function traverse over the publish detials of the assets and remove the publish details where the locale or environment does not exist
+     */
+    lookForReference(): Promise<void>;
+}

package/lib/modules/assets.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const cli_utilities_1 = require("@contentstack/cli-utilities");
+const messages_1 = require("../messages");
+const values_1 = tslib_1.__importDefault(require("lodash/values"));
+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 }) {
+        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);
+        this.fileName = config.moduleConfig[this.moduleName].fileName;
+        this.folderPath = (0, path_1.resolve)((0, cli_utilities_1.sanitizePath)(config.basePath), (0, cli_utilities_1.sanitizePath)(config.moduleConfig[this.moduleName].dirName));
+    }
+    validateModules(moduleName, moduleConfig) {
+        if (Object.keys(moduleConfig).includes(moduleName)) {
+            return moduleName;
+        }
+        return 'assets';
+    }
+    /**
+     * 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.
+     * @returns the `missingEnvLocales` object.
+     */
+    async run(returnFixSchema = false) {
+        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' });
+            return returnFixSchema ? [] : {};
+        }
+        await this.prerequisiteData();
+        await this.lookForReference();
+        if (returnFixSchema) {
+            return this.schema;
+        }
+        for (let propName in this.missingEnvLocales) {
+            if (Array.isArray(this.missingEnvLocales[propName])) {
+                if (!this.missingEnvLocales[propName].length) {
+                    delete this.missingEnvLocales[propName];
+                }
+            }
+        }
+        return this.missingEnvLocales;
+    }
+    /**
+     * @method prerequisiteData
+     * The `prerequisiteData` function reads and parses JSON files to retrieve extension and marketplace
+     * app data, and stores them in the `extensions` array.
+     */
+    async prerequisiteData() {
+        this.log(messages_1.auditMsg.PREPARING_ENTRY_METADATA, 'info');
+        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');
+        this.locales = (0, fs_1.existsSync)(masterLocalesPath) ? (0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(masterLocalesPath, 'utf8'))) : [];
+        if ((0, fs_1.existsSync)(localesPath)) {
+            this.locales.push(...(0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(localesPath, 'utf8'))));
+        }
+        this.locales = this.locales.map((locale) => locale.code);
+        const environmentPath = (0, path_1.resolve)(this.config.basePath, this.config.moduleConfig.environments.dirName, this.config.moduleConfig.environments.fileName);
+        this.environments = (0, fs_1.existsSync)(environmentPath) ? (0, lodash_1.keys)(JSON.parse((0, fs_1.readFileSync)(environmentPath, 'utf8'))) : [];
+    }
+    /**
+     * The function checks if it can write the fix content to a file and if so, it writes the content as
+     * JSON to the specified file path.
+     */
+    async writeFixContent(filePath, schema) {
+        var _a;
+        let canWrite = true;
+        if (this.fix) {
+            if (!this.config.flags['copy-dir'] && !((_a = this.config.flags['external-config']) === null || _a === void 0 ? void 0 : _a.skipConfirm)) {
+                canWrite = this.config.flags.yes || (await cli_utilities_1.ux.confirm(messages_1.commonMsg.FIX_CONFIRMATION));
+            }
+            if (canWrite) {
+                (0, fs_1.writeFileSync)(filePath, JSON.stringify(schema));
+            }
+        }
+    }
+    /**
+     * 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;
+        let basePath = (0, path_1.join)(this.folderPath);
+        let fsUtility = new cli_utilities_1.FsUtility({ basePath, indexFileName: 'assets.json' });
+        let indexer = fsUtility.indexFileContent;
+        for (const fileIndex in indexer) {
+            const assets = (await fsUtility.readChunkFiles.next());
+            this.assets = assets;
+            for (const assetUid in assets) {
+                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' });
+                }
+                this.assets[assetUid].publish_details = (_b = this.assets[assetUid]) === null || _b === void 0 ? void 0 : _b.publish_details.filter((pd) => {
+                    var _a, _b;
+                    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' });
+                        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' });
+                        if (!Object.keys(this.missingEnvLocales).includes(assetUid)) {
+                            this.missingEnvLocales[assetUid] = [
+                                { asset_uid: assetUid, publish_locale: pd.locale, publish_environment: pd.environment },
+                            ];
+                        }
+                        else {
+                            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' });
+                        return false;
+                    }
+                });
+                if (this.fix) {
+                    this.log((0, messages_1.$t)(messages_1.auditFixMsg.ASSET_FIX, { uid: assetUid }), { color: 'green' });
+                    await this.writeFixContent(`${basePath}/${indexer[fileIndex]}`, this.assets);
+                }
+            }
+        }
+    }
+}
+exports.default = Assets;

package/lib/modules/content-types.js

@@ -510,6 +510,9 @@ class ContentType {
         let fixStatus;
         const missingRefs = [];
         const { reference_to, data_type, display_name } = field;
+        if (!Array.isArray(reference_to)) {
+            this.log((0, messages_1.$t)(messages_1.auditMsg.CT_REFERENCE_FIELD, { reference_to, data_type, display_name }), { color: 'green' });
+        }
         for (const reference of reference_to !== null && reference_to !== void 0 ? reference_to : []) {
             // NOTE Can skip specific references keys (Ex, system defined keys can be skipped)
             if (this.config.skipRefs.includes(reference)) {

package/lib/modules/entries.d.ts

@@ -17,6 +17,8 @@ export default class Entries {
     protected missingSelectFeild: Record<string, any>;
     protected missingMandatoryFields: Record<string, any>;
     protected missingTitleFields: Record<string, any>;
+    protected missingEnvLocale: Record<string, any>;
+    environments: string[];
     entryMetaData: Record<string, any>[];
     moduleName: keyof typeof auditConfig.moduleConfig;
     constructor({ log, fix, config, moduleName, ctSchema, gfSchema }: ModuleConstructorParam & CtConstructorParam);
@@ -31,11 +33,13 @@ export default class Entries {
         missingSelectFeild?: undefined;
         missingMandatoryFields?: undefined;
         missingTitleFields?: undefined;
+        missingEnvLocale?: undefined;
     } | {
         missingEntryRefs: Record<string, any>;
         missingSelectFeild: Record<string, any>;
         missingMandatoryFields: Record<string, any>;
         missingTitleFields: Record<string, any>;
+        missingEnvLocale: Record<string, any>;
     }>;
     /**
      * The function removes any properties from the `missingRefs` object that have an empty array value.

package/lib/modules/entries.js

@@ -12,6 +12,7 @@ const content_types_1 = tslib_1.__importDefault(require("./content-types"));
 const messages_1 = require("../messages");
 const util_1 = require("../util");
 const global_fields_1 = tslib_1.__importDefault(require("./global-fields"));
+const lodash_1 = require("lodash");
 class Entries {
     constructor({ log, fix, config, moduleName, ctSchema, gfSchema }) {
         this.extensions = [];
@@ -19,6 +20,8 @@ class Entries {
         this.missingSelectFeild = {};
         this.missingMandatoryFields = {};
         this.missingTitleFields = {};
+        this.missingEnvLocale = {};
+        this.environments = [];
         this.entryMetaData = [];
         this.moduleName = 'entries';
         this.log = log;
@@ -42,7 +45,7 @@ class Entries {
      * @returns the `missingRefs` object.
      */
     async run() {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         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' });
@@ -112,6 +115,32 @@ class Entries {
                         else {
                             delete this.missingMandatoryFields[uid];
                         }
+                        const localKey = this.locales.map((locale) => locale.code);
+                        if (((_e = this.entries[entryUid]) === null || _e === void 0 ? void 0 : _e.publish_details) && !Array.isArray(this.entries[entryUid].publish_details)) {
+                            this.log((0, messages_1.$t)(messages_1.auditMsg.ENTRY_PUBLISH_DETAILS_NOT_EXIST, { uid: entryUid }), { color: 'red' });
+                        }
+                        this.entries[entryUid].publish_details = (_f = this.entries[entryUid]) === null || _f === void 0 ? void 0 : _f.publish_details.filter((pd) => {
+                            var _a;
+                            if ((localKey === null || localKey === void 0 ? void 0 : localKey.includes(pd.locale)) && ((_a = this.environments) === null || _a === void 0 ? void 0 : _a.includes(pd.environment))) {
+                                return true;
+                            }
+                            else {
+                                this.log((0, messages_1.$t)(messages_1.auditMsg.ENTRY_PUBLISH_DETAILS, {
+                                    uid: entryUid,
+                                    ctuid: ctSchema.uid,
+                                    locale: code,
+                                    publocale: pd.locale,
+                                    environment: pd.environment,
+                                }), { color: 'red' });
+                                if (!Object.keys(this.missingEnvLocale).includes(entryUid)) {
+                                    this.missingEnvLocale[entryUid] = [{ entry_uid: entryUid, publish_locale: pd.locale, publish_environment: pd.environment, ctUid: ctSchema.uid, ctLocale: code }];
+                                }
+                                else {
+                                    this.missingEnvLocale[entryUid].push({ entry_uid: entryUid, publish_locale: pd.locale, publish_environment: pd.environment, ctUid: ctSchema.uid, ctLocale: code });
+                                }
+                                return false;
+                            }
+                        });
                         const message = (0, messages_1.$t)(messages_1.auditMsg.SCAN_ENTRY_SUCCESS_MSG, {
                             title,
                             local: code,
@@ -133,6 +162,7 @@ class Entries {
             missingSelectFeild: this.missingSelectFeild,
             missingMandatoryFields: this.missingMandatoryFields,
             missingTitleFields: this.missingTitleFields,
+            missingEnvLocale: this.missingEnvLocale,
         };
     }
     /**
@@ -231,7 +261,7 @@ class Entries {
         }
         for (const child of (_a = field === null || field === void 0 ? void 0 : field.schema) !== null && _a !== void 0 ? _a : []) {
             const { uid } = child;
-            this.missingMandatoryFields[this.currentUid].push(...(this.validateMandatoryFields([...tree, { uid: field.uid, name: child.display_name, field: uid }], child, entry)));
+            this.missingMandatoryFields[this.currentUid].push(...this.validateMandatoryFields([...tree, { uid: field.uid, name: child.display_name, field: uid }], child, entry));
             if (!(entry === null || entry === void 0 ? void 0 : entry[uid]) && !child.hasOwnProperty('display_type')) {
                 continue;
             }
@@ -548,7 +578,10 @@ class Entries {
      */
     validateSelectField(tree, fieldStructure, field) {
         const { display_name, enum: selectOptions, multiple, min_instance, display_type, data_type } = fieldStructure;
-        if (field === null || field === '' || (Array.isArray(field) && field.length === 0) || (!field && data_type !== 'number')) {
+        if (field === null ||
+            field === '' ||
+            (Array.isArray(field) && field.length === 0) ||
+            (!field && data_type !== 'number')) {
             let missingCTSelectFieldValues = 'Not Selected';
             return [
                 {
@@ -1001,6 +1034,8 @@ class Entries {
         if ((0, fs_1.existsSync)(localesPath)) {
             this.locales.push(...(0, values_1.default)(JSON.parse((0, fs_1.readFileSync)(localesPath, 'utf8'))));
         }
+        const environmentPath = (0, path_1.resolve)(this.config.basePath, this.config.moduleConfig.environments.dirName, this.config.moduleConfig.environments.fileName);
+        this.environments = (0, fs_1.existsSync)(environmentPath) ? (0, lodash_1.keys)(JSON.parse((0, fs_1.readFileSync)(environmentPath, 'utf8'))) : [];
         for (const { code } of this.locales) {
             for (const { uid } of this.ctSchema) {
                 let basePath = (0, path_1.join)(this.folderPath, uid, code);
@@ -1014,7 +1049,7 @@ class Entries {
                             this.missingTitleFields[entryUid] = {
                                 'Entry UID': entryUid,
                                 'Content Type UID': uid,
-                                "Locale": code,
+                                Locale: code,
                             };
                             this.log(`The 'title' field in Entry with UID '${entryUid}' of Content Type '${uid}' in Locale '${code}' is empty.`, `error`);
                         }

package/lib/modules/index.d.ts

@@ -3,4 +3,5 @@ import GlobalField from './global-fields';
 import ContentType from './content-types';
 import Workflows from './workflows';
 import Extensions from './extensions';
-export { Entries, GlobalField, ContentType, Workflows, Extensions };
+import Assets from './assets';
+export { Entries, GlobalField, ContentType, Workflows, Extensions, Assets };

package/lib/modules/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Extensions = exports.Workflows = exports.ContentType = exports.GlobalField = exports.Entries = void 0;
+exports.Assets = exports.Extensions = exports.Workflows = exports.ContentType = exports.GlobalField = exports.Entries = void 0;
 const tslib_1 = require("tslib");
 const entries_1 = tslib_1.__importDefault(require("./entries"));
 exports.Entries = entries_1.default;
@@ -12,3 +12,5 @@ const workflows_1 = tslib_1.__importDefault(require("./workflows"));
 exports.Workflows = workflows_1.default;
 const extensions_1 = tslib_1.__importDefault(require("./extensions"));
 exports.Extensions = extensions_1.default;
+const assets_1 = tslib_1.__importDefault(require("./assets"));
+exports.Assets = assets_1.default;

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

@@ -103,8 +103,15 @@ declare enum OutputColumn {
     'isPublished' = "isPublished",
     'Entry UID' = "Entry UID",
     'Content Type UID' = "Content Type UID",
-    "Locale" = "Locale",
-    "Content Type" = "ct",
-    "locale" = "locale"
+    'Locale' = "Locale",
+    'Content Type' = "ct",
+    'locale' = "locale",
+    'environment' = "environment",
+    'ctUid' = "ctUid",
+    'ctLocale' = "ctLocale",
+    'entry_uid' = "entry_uid",
+    'publish_locale' = "publish_locale",
+    'publish_environment' = "publish_environment",
+    'asset_uid' = "asset_uid"
 }
 export { CtConstructorParam, ContentTypeStruct, ModuleConstructorParam, ReferenceFieldDataType, GlobalFieldDataType, ExtensionOrAppFieldDataType, JsonRTEFieldDataType, GroupFieldDataType, ModularBlocksDataType, RefErrorReturnType, ModularBlocksSchemaTypes, ModularBlockType, OutputColumn, ContentTypeSchemaType, GlobalFieldSchemaTypes, WorkflowExtensionsRefErrorReturnType, SelectFeildStruct, };

package/lib/types/content-types.js

@@ -22,5 +22,12 @@ var OutputColumn;
     OutputColumn["Locale"] = "Locale";
     OutputColumn["Content Type"] = "ct";
     OutputColumn["locale"] = "locale";
+    OutputColumn["environment"] = "environment";
+    OutputColumn["ctUid"] = "ctUid";
+    OutputColumn["ctLocale"] = "ctLocale";
+    OutputColumn["entry_uid"] = "entry_uid";
+    OutputColumn["publish_locale"] = "publish_locale";
+    OutputColumn["publish_environment"] = "publish_environment";
+    OutputColumn["asset_uid"] = "asset_uid";
 })(OutputColumn || (OutputColumn = {}));
 exports.OutputColumn = OutputColumn;

package/lib/types/entries.d.ts

@@ -8,7 +8,7 @@ type Locale = {
 type EntryStruct = {
     uid: string;
     title: string;
-    publish_details: [];
+    publish_details: any[];
 } & {
     [key: string]: EntryReferenceFieldDataType[] | EntryGlobalFieldDataType | EntryJsonRTEFieldDataType | EntryGroupFieldDataType | EntryModularBlocksDataType[];
 };

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.7.4",
+  "version": "1.8.0",
   "commands": {
     "cm:stacks:audit:fix": {
       "id": "cm:stacks:audit:fix",
@@ -46,7 +46,8 @@
             "entries",
             "extensions",
             "workflows",
-            "custom-roles"
+            "custom-roles",
+            "assets"
           ]
         },
         "copy-dir": {
@@ -185,7 +186,8 @@
             "entries",
             "extensions",
             "workflows",
-            "custom-roles"
+            "custom-roles",
+            "assets"
           ]
         },
         "columns": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.7.4",
+  "version": "1.8.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -18,38 +18,35 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@contentstack/cli-command": "~1.3.2",
-    "@contentstack/cli-utilities": "~1.8.0",
+    "@contentstack/cli-command": "~1.3.3",
+    "@contentstack/cli-utilities": "~1.8.4",
     "@oclif/plugin-help": "^5.2.20",
-    "@oclif/plugin-plugins": "^5.4.22",
+    "@oclif/plugin-plugins": "^5.4.34",
     "chalk": "^4.1.2",
     "fast-csv": "^4.3.6",
-    "fs-extra": "^11.2.0",
+    "fs-extra": "^11.3.0",
     "lodash": "^4.17.21",
     "uuid": "^9.0.1",
     "winston": "^3.17.0"
   },
   "devDependencies": {
-    "@contentstack/cli-dev-dependencies": "^1.2.4",
-    "@oclif/test": "^4.1.4",
+    "@oclif/test": "^4.1.11",
     "@types/chai": "^4.3.20",
     "@types/fs-extra": "^11.0.4",
     "@types/mocha": "^10.0.10",
-    "@types/node": "^20.17.10",
+    "@types/node": "^20.17.19",
     "@types/uuid": "^9.0.8",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
     "eslint-config-oclif": "^4.0.0",
-    "eslint-config-oclif-typescript": "^3.1.13",
+    "eslint-config-oclif-typescript": "^3.1.14",
     "mocha": "^10.8.2",
     "nyc": "^15.1.0",
     "oclif": "^3.17.2",
     "shx": "^0.3.4",
     "sinon": "^19.0.2",
-    "ts-jest": "^29.2.5",
     "ts-node": "^10.9.2",
-    "tslib": "^2.8.1",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "oclif": {
     "bin": "csdx",