@contentstack/cli-cm-export 0.1.1-beta.7 → 1.0.0

package/src/commands/cm/stacks/export.js

@@ -0,0 +1,177 @@
+/* eslint-disable complexity */
+const { Command, flags } = require('@contentstack/cli-command');
+const { printFlagDeprecation } = require('@contentstack/cli-utilities');
+
+const {
+  configWithMToken,
+  parameterWithMToken,
+  withoutParameterMToken,
+  configWithAuthToken,
+  parametersWithAuthToken,
+  withoutParametersWithAuthToken,
+} = require('../../../lib/util/export-flags');
+const { configHandler } = require('@contentstack/cli-utilities');
+
+class ExportCommand extends Command {
+  async run() {
+    const exportCommandFlags = this.parse(ExportCommand).flags;
+    const extConfig = exportCommandFlags.config;
+    let sourceStack = exportCommandFlags['stack-uid'] || exportCommandFlags['stack-api-key'];
+    const alias = exportCommandFlags['alias'] || exportCommandFlags['management-token-alias'];
+    const securedAssets = exportCommandFlags['secured-assets'];
+    const data = exportCommandFlags.data || exportCommandFlags['data-dir'];
+    const moduleName = exportCommandFlags.module;
+    const contentTypes = exportCommandFlags['content-types'];
+    const branchName = exportCommandFlags.branch;
+    let _authToken = configHandler.get('authtoken');
+    let host = this.region;
+    let cmaHost = host.cma.split('//');
+    let cdaHost = host.cda.split('//');
+    host.cma = cmaHost[1];
+    host.cda = cdaHost[1];
+
+    if (alias) {
+      let managementTokens = this.getToken(alias);
+      if (managementTokens) {
+        if (extConfig) {
+          await configWithMToken(
+            extConfig,
+            managementTokens,
+            host,
+            contentTypes,
+            branchName,
+            securedAssets,
+            moduleName,
+          );
+        } else if (data) {
+          await parameterWithMToken(
+            managementTokens,
+            data,
+            moduleName,
+            host,
+            _authToken,
+            contentTypes,
+            branchName,
+            securedAssets,
+          );
+        } else if (data === undefined && sourceStack === undefined) {
+          await withoutParameterMToken(
+            managementTokens,
+            moduleName,
+            host,
+            _authToken,
+            contentTypes,
+            branchName,
+            securedAssets,
+          );
+        } else {
+          this.log('Please provide a valid command. Run "csdx cm:export --help" command to view the command usage');
+        }
+      } else {
+        this.log(alias + ' management token is not present, please add managment token first');
+      }
+    } else if (_authToken) {
+      if (extConfig) {
+        configWithAuthToken(extConfig, _authToken, moduleName, host, contentTypes, branchName, securedAssets);
+      } else if (sourceStack && data) {
+        return parametersWithAuthToken(
+          _authToken,
+          sourceStack,
+          data,
+          moduleName,
+          host,
+          contentTypes,
+          branchName,
+          securedAssets,
+        );
+      } else if (data === undefined && sourceStack === undefined) {
+        withoutParametersWithAuthToken(_authToken, moduleName, host, contentTypes, branchName, securedAssets);
+      } else {
+        this.log('Please provide a valid command. Run "csdx cm:export --help" command to view the command usage');
+      }
+    } else {
+      this.log('Login or provide the alias for management token');
+    }
+    // return
+  }
+}
+
+ExportCommand.description = `Export content from a stack`;
+ExportCommand.examples = [
+  'csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>',
+  'csdx cm:stacks:export --config <path/to/config/dir>',
+  'csdx cm:stacks:export --alias <management_token_alias>',
+  'csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>',
+  'csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>',
+  'csdx cm:stacks:export --module <single module name>',
+  'csdx cm:stacks:export --branch [optional] branch name',
+];
+ExportCommand.usage =
+  'cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]';
+
+ExportCommand.flags = {
+  config: flags.string({
+    char: 'c',
+    description: '[optional] path of the config',
+  }),
+  'stack-uid': flags.string({
+    char: 's',
+    description: 'API key of the source stack',
+    hidden: true,
+    parse: printFlagDeprecation(['-s', '--stack-uid'], ['-k', '--stack-api-key']),
+  }),
+  'stack-api-key': flags.string({
+    char: 'k',
+    description: 'API key of the source stack',
+  }),
+  data: flags.string({
+    description: 'path or location to store the data',
+    hidden: true,
+    parse: printFlagDeprecation(['--data'], ['--data-dir']),
+  }),
+  'data-dir': flags.string({
+    char: 'd',
+    description: 'path or location to store the data',
+  }),
+  alias: flags.string({
+    char: 'a',
+    description: 'alias of the management token',
+  }),
+  'management-token-alias': flags.string({
+    description: 'alias of the management token',
+    hidden: true,
+    parse: printFlagDeprecation(['--management-token-alias'], ['-a', '--alias']),
+  }),
+  'auth-token': flags.boolean({
+    char: 'A',
+    description: 'to use auth token',
+    hidden: true,
+    parse: printFlagDeprecation(['-A', '--auth-token']),
+  }),
+  module: flags.string({
+    char: 'm',
+    description: '[optional] specific module name',
+    exclusive: ['content-types'],
+    parse: printFlagDeprecation(['-m'], ['--module']),
+  }),
+  'content-types': flags.string({
+    char: 't',
+    description: '[optional] content type',
+    multiple: true,
+    exclusive: ['module'],
+    parse: printFlagDeprecation(['-t'], ['--content-types']),
+  }),
+  branch: flags.string({
+    char: 'B',
+    // default: 'main',
+    description: '[optional] branch name',
+    parse: printFlagDeprecation(['-B'], ['--branch']),
+  }),
+  'secured-assets': flags.boolean({
+    description: '[optional] use when assets are secured',
+  }),
+};
+
+ExportCommand.aliases = ['cm:export'];
+
+module.exports = ExportCommand;

package/src/config/default.js

@@ -1,5 +1,10 @@
 module.exports = {
   versioning: false,
+  host: 'https://api.contentstack.io/v3',
+  // use below hosts for eu region
+  // host:'https://eu-api.contentstack.com/v3',
+  // use below hosts for azure-na region
+  // host:'https://azure-na-api.contentstack.com/v3',
   modules: {
     types: [
       'stack',
@@ -17,12 +22,7 @@ module.exports = {
     locales: {
       dirName: 'locales',
       fileName: 'locales.json',
-      requiredKeys: [
-        'code',
-        'uid',
-        'name',
-        'fallback_locale',
-      ],
+      requiredKeys: ['code', 'uid', 'name', 'fallback_locale'],
     },
     environments: {
       dirName: 'environments',
@@ -31,15 +31,7 @@ module.exports = {
     labels: {
       dirName: 'labels',
       fileName: 'labels.json',
-      invalidKeys: [
-        'stackHeaders',
-        'uid',
-        'urlPath',
-        'created_at',
-        'updated_at',
-        'created_by',
-        'updated_by',
-      ],
+      invalidKeys: ['stackHeaders', 'uid', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
     },
     webhooks: {
       dirName: 'webhooks',
@@ -49,68 +41,33 @@ module.exports = {
       dirName: 'releases',
       fileName: 'releases.json',
       releasesList: 'releasesList.json',
-      invalidKeys: [
-        'stackHeaders',
-        'urlPath',
-        'created_at',
-        'updated_at',
-        'created_by',
-        'updated_by',
-      ],
+      invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
     },
     workflows: {
       dirName: 'workflows',
       fileName: 'workflows.json',
-      invalidKeys: [
-        'stackHeaders',
-        'urlPath',
-        'created_at',
-        'updated_at',
-        'created_by',
-        'updated_by',
-      ],
+      invalidKeys: ['stackHeaders', 'urlPath', 'created_at', 'updated_at', 'created_by', 'updated_by'],
     },
     globalfields: {
       dirName: 'global_fields',
       fileName: 'globalfields.json',
-      validKeys: [
-        'title',
-        'uid',
-        'schema',
-        'options',
-        'singleton',
-        'description',
-      ],
+      validKeys: ['title', 'uid', 'schema', 'options', 'singleton', 'description'],
     },
     assets: {
       dirName: 'assets',
       fileName: 'assets.json',
       // This is the total no. of asset objects fetched in each 'get assets' call
       batchLimit: 20,
-      host: 'https://stag-images.contentstack.io',
-      invalidKeys: [
-        'created_at',
-        'updated_at',
-        'created_by',
-        'updated_by',
-        '_metadata',
-        'published',
-      ],
+      host: 'https://images.contentstack.io',
+      invalidKeys: ['created_at', 'updated_at', 'created_by', 'updated_by', '_metadata', 'published'],
       // no of asset version files (of a single asset) that'll be downloaded parallelly
       downloadLimit: 5,
+      enableDownloadStatus: false,
     },
     content_types: {
       dirName: 'content_types',
       fileName: 'content_types.json',
-      validKeys: [
-        'title',
-        'uid',
-        'field_rules',
-        'schema',
-        'options',
-        'singleton',
-        'description',
-      ],
+      validKeys: ['title', 'uid', 'field_rules', 'schema', 'options', 'singleton', 'description'],
       // total no of content types fetched in each 'get content types' call
       limit: 100,
     },
@@ -141,6 +98,9 @@ module.exports = {
       dirName: 'stack',
       fileName: 'stack.json',
     },
+    dependency: {
+      entries: ['stack', 'locales', 'content-types'],
+    },
   },
   languagesCode: [
     'af-za',
@@ -367,4 +327,4 @@ module.exports = {
     stacks: '/stacks/',
   },
   preserveStackVersion: false,
-}
+};