@contentstack/cli 1.9.0 → 1.10.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli/1.9.0 linux-x64 node-v18.18.0
+@contentstack/cli/1.10.0 linux-x64 node-v18.18.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -29,6 +29,8 @@ USAGE
 # Commands
 
 <!-- commands -->
+* [`csdx audit`](#csdx-audit)
+* [`csdx audit:fix`](#csdx-auditfix)
 * [`csdx auth:login`](#csdx-authlogin)
 * [`csdx auth:logout`](#csdx-authlogout)
 * [`csdx auth:tokens`](#csdx-authtokens)
@@ -69,6 +71,8 @@ USAGE
 * [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
 * [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value)
 * [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent)
+* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
+* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
 * [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent-1)
 * [`csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets-1)
 * [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1)
@@ -105,6 +109,90 @@ USAGE
 * [`csdx tokens`](#csdx-tokens)
 * [`csdx whoami`](#csdx-whoami)
 
+## `csdx audit`
+
+Perform audits and find possible errors in the exported Contentstack data
+
+```
+USAGE
+  $ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
+    --no-truncate]
+
+FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+  --columns=<value>       only show provided columns (comma-separated)
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
+
+DESCRIPTION
+  Perform audits and find possible errors in the exported Contentstack data
+
+ALIASES
+  $ csdx audit
+  $ csdx cm:stacks:audit
+
+EXAMPLES
+  $ csdx audit
+
+  $ csdx audit --report-path=<path>
+
+  $ csdx audit --report-path=<path> --csv
+
+  $ csdx audit --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
+```
+
+## `csdx audit:fix`
+
+Perform audits and fix possible errors in the exported Contentstack data.
+
+```
+USAGE
+  $ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--columns <value> | ] [--sort <value>]
+    [--filter <value>] [--csv | --no-truncate]
+
+FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+  --columns=<value>       only show provided columns (comma-separated)
+  --copy-dir              Create backup from the original data.
+  --copy-path=<value>     Provide the path to backup the copied data
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
+
+DESCRIPTION
+  Perform audits and fix possible errors in the exported Contentstack data.
+
+ALIASES
+  $ csdx audit:fix
+  $ csdx cm:stacks:audit:fix
+
+EXAMPLES
+  $ csdx audit:fix --copy-dir
+
+  $ csdx audit:fix --report-path=<path> --copy-dir
+
+  $ csdx audit:fix --report-path=<path> --copy-dir --csv
+
+  $ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
+```
+
 ## `csdx auth:login`
 
 User sessions login
@@ -1998,6 +2086,8 @@ FLAGS
   -y, --yes                         [optional] Override marketplace prompts
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
+  --replace-existing                Replaces the existing module in the target stack.
+  --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION
   Import content from a stack
@@ -2205,6 +2295,94 @@ EXAMPLES
   $ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias> --type <value a or b>
 ```
 
+## `csdx cm:stacks:audit`
+
+Perform audits and find possible errors in the exported Contentstack data
+
+```
+USAGE
+  $ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
+    --no-truncate]
+
+FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+  --columns=<value>       only show provided columns (comma-separated)
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
+
+DESCRIPTION
+  Perform audits and find possible errors in the exported Contentstack data
+
+ALIASES
+  $ csdx audit
+  $ csdx cm:stacks:audit
+
+EXAMPLES
+  $ csdx cm:stacks:audit
+
+  $ csdx cm:stacks:audit --report-path=<path>
+
+  $ csdx cm:stacks:audit --report-path=<path> --csv
+
+  $ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
+```
+
+_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts)_
+
+## `csdx cm:stacks:audit:fix`
+
+Perform audits and fix possible errors in the exported Contentstack data.
+
+```
+USAGE
+  $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
+    content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--columns <value> | ] [--sort <value>]
+    [--filter <value>] [--csv | --no-truncate]
+
+FLAGS
+  -c, --config=<value>    Path of the external config
+  -d, --data-dir=<value>  Path where the data is stored
+  --columns=<value>       only show provided columns (comma-separated)
+  --copy-dir              Create backup from the original data.
+  --copy-path=<value>     Provide the path to backup the copied data
+  --csv                   output is csv format [alias: --output=csv]
+  --filter=<value>        filter property by partial string matching, ex: name=foo
+  --modules=<option>...   Provide the list of modules to be audited
+                          <options: content-types|global-fields|entries>
+  --no-truncate           do not truncate output to fit screen
+  --report-path=<value>   Path to store the audit reports
+  --sort=<value>          property to sort by (prepend '-' for descending)
+
+DESCRIPTION
+  Perform audits and fix possible errors in the exported Contentstack data.
+
+ALIASES
+  $ csdx audit:fix
+  $ csdx cm:stacks:audit:fix
+
+EXAMPLES
+  $ csdx cm:stacks:audit:fix --copy-dir
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
+
+  $ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
+```
+
+_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
+
 ## `csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`
 
 Clone data (structure/content or both) of a stack into another stack
@@ -2320,6 +2498,8 @@ FLAGS
   -y, --yes                         [optional] Override marketplace prompts
   --import-webhook-status=<option>  [default: disable] [optional] Webhook state
                                     <options: disable|current>
+  --replace-existing                Replaces the existing module in the target stack.
+  --skip-existing                   Skips the module exists warning messages.
 
 DESCRIPTION
   Import content from a stack
@@ -2807,7 +2987,7 @@ DESCRIPTION
   Display help for csdx.
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.13/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.20/src/commands/help.ts)_
 
 ## `csdx launch`
 
@@ -3105,7 +3285,7 @@ EXAMPLES
   $ csdx plugins
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/index.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/index.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -3170,7 +3350,7 @@ EXAMPLES
   $ csdx plugins:inspect myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/inspect.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/inspect.ts)_
 
 ## `csdx plugins:install PLUGIN...`
 
@@ -3210,7 +3390,7 @@ EXAMPLES
   $ csdx plugins:install someuser/someplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/install.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/install.ts)_
 
 ## `csdx plugins:link PLUGIN`
 
@@ -3239,7 +3419,7 @@ EXAMPLES
   $ csdx plugins:link myplugin
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/link.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/link.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -3287,7 +3467,7 @@ ALIASES
   $ csdx plugins:remove
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/uninstall.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/uninstall.ts)_
 
 ## `csdx plugins:uninstall PLUGIN...`
 
@@ -3328,7 +3508,7 @@ DESCRIPTION
   Update installed plugins.
 ```
 
-_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.3.2/src/commands/plugins/update.ts)_
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.8.4/src/commands/plugins/update.ts)_
 
 ## `csdx tokens`
 

package/lib/hooks/init/utils-init.js

@@ -6,7 +6,7 @@ const cli_utilities_1 = require("@contentstack/cli-utilities");
  */
 function default_1(_opts) {
     const { context } = this.config;
-    cli_utilities_1.logger.init(context);
+    // logger.init(context);
     cli_utilities_1.messageHandler.init(context);
     cli_utilities_1.cliux.init(context);
     cli_utilities_1.managementSDKInitiator.init(context);

package/lib/hooks/prerun/auth-guard.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const cli_utilities_1 = require("@contentstack/cli-utilities");
+const cli_utilities_2 = require("@contentstack/cli-utilities");
 // TBD: run region command if region is not there
 async function default_1(opts) {
+    const newLogger = new cli_utilities_2.LoggerService(process.cwd(), 'cli-log');
     const { context: { plugin: { config: { protectedCommands = {} } = {} } = {}, region = null } = {} } = this.config;
     if (opts.Command.id !== 'config:set:region') {
         if (!region) {
@@ -15,7 +17,7 @@ async function default_1(opts) {
     // Auth guard
     if (protectedCommands[opts.Command.id]) {
         if (!(0, cli_utilities_1.isAuthenticated)()) {
-            cli_utilities_1.logger.error('No auth token found for command', opts.Command.id);
+            newLogger.error('No auth token found for command', opts.Command.id);
             cli_utilities_1.cliux.error('Please login to execute the command');
             this.exit();
         }
@@ -23,14 +25,14 @@ async function default_1(opts) {
         try {
             const result = await client.getUser();
             if (!result) {
-                cli_utilities_1.logger.error('error in auth validation');
+                newLogger.error('error in auth validation');
                 cli_utilities_1.cliux.error('Please login to execute the command');
                 this.exit();
             }
-            cli_utilities_1.logger.debug('logged in user', result.data);
+            newLogger.debug('logged in user', result.data);
         }
         catch (error) {
-            cli_utilities_1.logger.error('error in auth validation', error);
+            newLogger.error('error in auth validation', error);
             cli_utilities_1.cliux.error('Please login to execute the command');
             process.exit();
         }

package/oclif.manifest.json

@@ -1,4 +1,4 @@
 {
-  "version": "1.9.0",
+  "version": "1.10.0",
   "commands": {}
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli",
   "description": "Command-line tool (CLI) to interact with Contentstack",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "author": "Contentstack",
   "bin": {
     "csdx": "./bin/run"
@@ -22,26 +22,27 @@
     "prepack": "pnpm compile && oclif manifest && oclif readme"
   },
   "dependencies": {
-    "@contentstack/cli-auth": "~1.3.13",
-    "@contentstack/cli-cm-bootstrap": "~1.5.0",
-    "@contentstack/cli-cm-bulk-publish": "~1.3.11",
-    "@contentstack/cli-cm-clone": "~1.5.0",
-    "@contentstack/cli-cm-export": "~1.9.0",
-    "@contentstack/cli-cm-import": "~1.9.0",
-    "@contentstack/cli-cm-export-to-csv": "~1.4.2",
-    "@contentstack/cli-cm-migrate-rte": "~1.4.11",
-    "@contentstack/cli-cm-seed": "~1.5.0",
-    "@contentstack/cli-command": "~1.2.12",
-    "@contentstack/cli-config": "~1.4.11",
-    "@contentstack/cli-launch": "~1.0.12",
-    "@contentstack/cli-migration": "~1.3.13",
-    "@contentstack/cli-utilities": "~1.5.2",
+    "@contentstack/cli-audit": "~1.2.0",
+    "@contentstack/cli-auth": "~1.3.15",
+    "@contentstack/cli-cm-bootstrap": "~1.6.0",
+    "@contentstack/cli-cm-branches": "~1.0.15",
+    "@contentstack/cli-cm-bulk-publish": "~1.3.13",
+    "@contentstack/cli-cm-clone": "~1.6.0",
+    "@contentstack/cli-cm-export": "~1.9.2",
+    "@contentstack/cli-cm-export-to-csv": "~1.4.4",
+    "@contentstack/cli-cm-import": "~1.10.0",
+    "@contentstack/cli-cm-migrate-rte": "~1.4.13",
+    "@contentstack/cli-cm-seed": "~1.6.0",
+    "@contentstack/cli-command": "~1.2.14",
+    "@contentstack/cli-config": "~1.4.13",
+    "@contentstack/cli-launch": "~1.0.13",
+    "@contentstack/cli-migration": "~1.3.14",
+    "@contentstack/cli-utilities": "~1.5.4",
     "@contentstack/management": "~1.10.0",
-    "@contentstack/cli-cm-branches": "~1.0.13",
+    "@oclif/core": "^2.9.3",
     "@oclif/plugin-help": "^5",
     "@oclif/plugin-not-found": "^2.4.0",
-    "@oclif/plugin-plugins": "^3.3.2",
-    "@oclif/core": "^2.9.3",
+    "@oclif/plugin-plugins": "^3.3.0",
     "chalk": "^4.1.2",
     "debug": "^4.1.1",
     "figlet": "^1.5.2",
@@ -145,7 +146,8 @@
       "@contentstack/cli-migration",
       "@contentstack/cli-cm-bulk-publish",
       "@contentstack/cli-cm-branches",
-      "@contentstack/cli-launch"
+      "@contentstack/cli-launch",
+      "@contentstack/cli-audit"
     ],
     "hooks": {
       "prerun": [