Feat: Added Check for publish details for Assets and Entries

packages/contentstack-audit/README.md

@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.7.5 darwin-arm64 node-v22.14.0
+@contentstack/cli-audit/1.8.0 darwin-arm64 node-v23.6.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,17 +94,17 @@ 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.
   --copy-path=<value>     Provide the path to backup the copied data
   --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,17 +185,17 @@ 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.
   --copy-path=<value>     Provide the path to backup the copied data
   --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

packages/contentstack-audit/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.7.5",
+  "version": "1.8.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",
@@ -21,32 +21,32 @@
     "@contentstack/cli-command": "~1.3.3",
     "@contentstack/cli-utilities": "~1.8.3",
     "@oclif/plugin-help": "^5.2.20",
-    "@oclif/plugin-plugins": "^5.4.24",
+    "@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": {
-    "@oclif/test": "^4.1.6",
+    "@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-node": "^10.9.2",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.3"
   },
   "oclif": {
     "bin": "csdx",

packages/contentstack-audit/src/audit-base-command.ts

@@ -12,7 +12,7 @@ import config from './config';
 import { print } from './util/log';
 import { auditMsg } from './messages';
 import { BaseCommand } from './base-command';
-import { Entries, GlobalField, ContentType, Extensions, Workflows } from './modules';
+import { Entries, GlobalField, ContentType, Extensions, Workflows, Assets } from './modules';
 import {
   CommandNames,
   ContentTypeStruct,
@@ -58,7 +58,9 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingSelectFeild,
       missingMandatoryFields,
       missingTitleFields,
-      missingRefInCustomRoles
+      missingRefInCustomRoles,
+      missingEnvLocalesInAssets,
+      missingEnvLocalesInEntries
     } = await this.scanAndFix();
 
     this.showOutputOnScreen([
@@ -76,6 +78,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       { 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 (
       !isEmpty(missingCtRefs) ||
       !isEmpty(missingGfRefs) ||
@@ -84,7 +88,9 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       !isEmpty(missingCtRefsInExtensions) ||
       !isEmpty(missingSelectFeild) ||
       !isEmpty(missingTitleFields) ||
-      !isEmpty(missingRefInCustomRoles) 
+      !isEmpty(missingRefInCustomRoles) ||
+      !isEmpty(missingEnvLocalesInAssets) ||
+      !isEmpty(missingEnvLocalesInEntries)
     ) {
       if (this.currentCommand === 'cm:stacks:audit') {
         this.log(this.$t(auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
@@ -112,7 +118,9 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       !isEmpty(missingCtRefsInWorkflow) ||
       !isEmpty(missingCtRefsInExtensions) ||
       !isEmpty(missingSelectFeild) || 
-      !isEmpty(missingRefInCustomRoles)
+      !isEmpty(missingRefInCustomRoles) ||
+      !isEmpty(missingEnvLocalesInAssets) ||
+      !isEmpty(missingEnvLocalesInEntries)
     );
   }
 
@@ -133,7 +141,9 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingEntry,
       missingMandatoryFields,
       missingTitleFields,
-      missingRefInCustomRoles;
+      missingRefInCustomRoles,
+      missingEnvLocalesInAssets,
+      missingEnvLocalesInEntries;
 
     for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
       print([
@@ -153,6 +163,10 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
         fix: this.currentCommand === 'cm:stacks:audit:fix',
       };
       switch (module) {
+        case 'assets':
+          missingEnvLocalesInAssets = await new Assets(cloneDeep(constructorParam)).run();
+          await this.prepareReport(module, missingEnvLocalesInAssets);
+          break;
         case 'content-types':
           missingCtRefs = await new ContentType(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingCtRefs);
@@ -167,6 +181,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
           missingSelectFeild = missingEntry.missingSelectFeild ?? {};
           missingMandatoryFields = missingEntry.missingMandatoryFields ?? {};
           missingTitleFields = missingEntry.missingTitleFields ?? {};
+          missingEnvLocalesInEntries = missingEntry.missingEnvLocale??{};
           await this.prepareReport(module, missingEntryRefs);
 
           await this.prepareReport(`Entries_Select_feild`, missingSelectFeild);
@@ -175,6 +190,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
 
           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 Workflows({
@@ -220,6 +237,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingMandatoryFields,
       missingTitleFields,
       missingRefInCustomRoles,
+      missingEnvLocalesInAssets,
+      missingEnvLocalesInEntries
     };
   }
 

packages/contentstack-audit/src/config/index.ts

@@ -2,7 +2,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': {
@@ -40,6 +40,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: [
@@ -76,13 +86,23 @@ 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'],
 };
 
 export default config;

packages/contentstack-audit/src/messages/index.ts

@@ -37,6 +37,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}'`,
 };
 
 const auditFixMsg = {
@@ -49,6 +55,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}'`,
 };
 
 const messages: typeof errors &