@contentstack/cli-cm-export 1.5.8 → 1.6.1

package/lib/utils/setup-branches.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const file_helper_1 = require("./file-helper");
+const setupBranches = async (config, stackAPIClient) => {
+    if (typeof config !== 'object') {
+        throw new Error('Invalid config to setup the branch');
+    }
+    let branches = [];
+    if (config.branchName) {
+        // check branch exists
+        const result = await stackAPIClient
+            .branch(config.branchName)
+            .fetch()
+            .catch((_err) => { });
+        if (result && typeof result === 'object') {
+            branches.push(result);
+        }
+        else {
+            throw new Error('No branch found with the given name ' + config.branchName);
+        }
+    }
+    else {
+        try {
+            const result = await stackAPIClient
+                .branch()
+                .query()
+                .find()
+                .catch((_err) => { });
+            if (result && result.items && Array.isArray(result.items) && result.items.length > 0) {
+                branches = result.items;
+            }
+            else {
+                return;
+            }
+        }
+        catch (error) {
+            // Note skips the error
+            return;
+        }
+    }
+    (0, file_helper_1.makeDirectory)(config.exportDir);
+    // create branch info file
+    (0, file_helper_1.writeFileSync)(path.join(config.exportDir, 'branches.json'), branches);
+    // add branches list in the
+    config.branches = branches;
+};
+exports.default = setupBranches;

package/lib/utils/setup-export-dir.d.ts

@@ -0,0 +1,2 @@
+import { ExportConfig } from '../types';
+export default function setupExportDir(exportConfig: ExportConfig): Promise<void[]>;

package/lib/utils/setup-export-dir.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const file_helper_1 = require("./file-helper");
+async function setupExportDir(exportConfig) {
+    (0, file_helper_1.makeDirectory)(exportConfig.exportDir);
+    if (exportConfig.branches) {
+        return Promise.all(exportConfig.branches.map((branch) => (0, file_helper_1.makeDirectory)(path_1.default.join(exportConfig.exportDir, branch.uid))));
+    }
+}
+exports.default = setupExportDir;

package/messages/index.json

@@ -1,7 +1 @@
-{
-    "promptMessageList": {
-      "promptMasterLocale": "Provide the master locale of the source stack",
-      "promptSourceStack": "Provide the API Key of the source stack",
-      "promptPathStoredData": "Provide the path to store the content"
-    }
-}
+{}

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.5.8",
+  "version": "1.6.1",
   "commands": {
     "cm:stacks:export": {
       "id": "cm:stacks:export",

package/package.json

@@ -1,33 +1,38 @@
 {
   "name": "@contentstack/cli-cm-export",
   "description": "Contentstack CLI plugin to export content from stack",
-  "version": "1.5.8",
+  "version": "1.6.1",
   "author": "Contentstack",
   "bugs": "https://github.com/contentstack/cli/issues",
   "dependencies": {
-    "@contentstack/cli-command": "^1.2.8",
-    "@contentstack/cli-utilities": "^1.4.4",
+    "@contentstack/cli-command": "^1.2.0",
+    "@contentstack/cli-utilities": "^1.5.0",
     "@oclif/command": "^1.8.16",
     "@oclif/config": "^1.18.3",
+    "@oclif/core": "^2.3.0",
     "async": "^3.2.4",
     "big-json": "^3.2.0",
     "bluebird": "^3.7.2",
     "chalk": "^4.1.2",
     "is-valid-path": "^0.1.1",
     "lodash": "^4.17.20",
-    "mkdirp": "^2.1.3",
+    "merge": "^2.1.1",
+    "mkdirp": "^1.0.4",
     "path": "^0.12.7",
     "progress-stream": "^2.0.0",
     "promise-limit": "^2.7.0",
     "proxyquire": "^2.1.3",
+    "tslib": "^2.4.1",
     "winston": "^3.7.2"
   },
   "devDependencies": {
-    "@contentstack/cli-auth": "^1.3.8",
-    "@contentstack/cli-config": "^1.4.6",
+    "@contentstack/cli-auth": "^1.3.11",
+    "@contentstack/cli-config": "^1.4.9",
     "@contentstack/cli-dev-dependencies": "^1.2.3",
     "@oclif/plugin-help": "^5.1.19",
     "@oclif/test": "^1.2.6",
+    "@types/mkdirp": "^1.0.2",
+    "@types/progress-stream": "^2.0.2",
     "assert": "^2.0.0",
     "chai": "^4.2.0",
     "dotenv": "^16.0.1",
@@ -37,17 +42,35 @@
     "globby": "^10.0.2",
     "mocha": "10.1.0",
     "nyc": "^15.1.0",
+    "oclif": "^3.8.1",
     "sinon": "^15.0.1",
-    "oclif": "^3.8.1"
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.3"
+  },
+  "scripts": {
+    "build": "npm run clean && npm run compile",
+    "clean": "rm -rf ./lib ./node_modules tsconfig.build.tsbuildinfo",
+    "compile": "tsc -b tsconfig.json",
+    "postpack": "rm -f oclif.manifest.json",
+    "prepack": "pnpm compile && oclif manifest && oclif readme",
+    "version": "oclif readme && git add README.md",
+    "test:report": "tsc -p test && nyc --reporter=lcov --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "pretest": "tsc -p test",
+    "test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
+    "posttest": "npm run lint",
+    "lint": "eslint src/**/*.ts",
+    "format": "eslint src/**/*.ts --fix",
+    "test:integration": "INTEGRATION_TEST=true mocha --config ./test/.mocharc.js --forbid-only \"test/run.test.js\"",
+    "test:unit": "mocha --forbid-only \"test/unit/*.test.ts\""
   },
   "engines": {
     "node": ">=14.0.0"
   },
   "files": [
+    "/lib",
+    "/messages",
     "/npm-shrinkwrap.json",
-    "/oclif.manifest.json",
-    "/src",
-    "/messages"
+    "/oclif.manifest.json"
   ],
   "homepage": "https://github.com/contentstack/cli",
   "keywords": [
@@ -56,17 +79,9 @@
     "plugin"
   ],
   "license": "MIT",
-  "scripts": {
-    "postpack": "rm -f oclif.manifest.json",
-    "prepack": "oclif manifest && oclif readme",
-    "test": "nyc mocha --forbid-only \"test/**/*.test.js\"",
-    "version": "oclif readme && git add README.md",
-    "clean": "rm -rf ./node_modules tsconfig.build.tsbuildinfo",
-    "test:integration": "INTEGRATION_TEST=true mocha --config ./test/.mocharc.js --forbid-only \"test/run.test.js\"",
-    "test:unit": "mocha --forbid-only \"test/unit/*.test.js\" --unit-test"
-  },
+  "main": "./lib/commands/cm/stacks/export.js",
   "oclif": {
-    "commands": "./src/commands",
+    "commands": "./lib/commands",
     "bin": "csdx",
     "devPlugins": [
       "@oclif/plugin-help"
@@ -79,9 +94,8 @@
     },
     "shortCommandName": {
       "cm:stacks:export": "EXPRT",
-      "cm:export": "O-EXPRT"
+      "cm:export": "EXPRT"
     }
   },
-  "main": "./src/commands/cm/stacks/export.js",
   "repository": "https://github.com/contentstack/cli"
-}
+}

package/src/app.js

@@ -1,161 +0,0 @@
-/* eslint-disable no-redeclare */
-const _ = require('lodash');
-const path = require('path');
-const chalk = require('chalk');
-const util = require('./lib/util');
-const login = require('./lib/util/login');
-const setupBranches = require('./lib/util/setup-branches');
-const { addlogs, unlinkFileLogger } = require('./lib/util/log');
-const { managementSDKClient, isAuthenticated } = require('@contentstack/cli-utilities');
-
-exports.initial = async (config) => {
-  return new Promise(async (resolve, reject) => {
-    config = util.buildAppConfig(config);
-    util.validateConfig(config);
-    exports.getConfig = () => {
-      return config;
-    };
-
-    const APIClient = await managementSDKClient(config);
-    const stackAPIClient = APIClient.stack({
-      api_key: config.source_stack,
-      management_token: config.management_token,
-    });
-
-    const fetchBranchAndExport = async (APIClient, stackAPIClient) => {
-      await setupBranches(config, config.branchName, stackAPIClient);
-      let types = config.modules.types;
-
-      if (Array.isArray(config.branches) && config.branches.length > 0) {
-        for (let branch of config.branches) {
-          config.branchName = branch.uid;
-          try {
-            if (config.moduleName) {
-              await singleExport(APIClient, stackAPIClient, config.moduleName, types, config, branch.uid);
-            } else {
-              await allExport(APIClient, stackAPIClient, config, types, branch.uid);
-            }
-          } catch (error) {
-            addlogs(config, `failed export contents ${branch.uid} ${util.formatError(error)}`, 'error');
-          }
-        }
-      } else {
-        try {
-          if (config.moduleName) {
-            await singleExport(APIClient, stackAPIClient, config.moduleName, types, config);
-          } else {
-            await allExport(APIClient, stackAPIClient, config, types);
-          }
-        } catch (error) {
-          addlogs(config, `failed export contents ${util.formatError(error)}`, 'error');
-        }
-      }
-    };
-
-    if (config.management_token || config.isAuthenticated) {
-      try {
-        await fetchBranchAndExport(APIClient, stackAPIClient);
-      } catch (error) {
-        addlogs(config, `${util.formatError(error)}`, 'error');
-      }
-      resolve();
-    } else if (
-      (config.email && config.password) ||
-      (!config.email && !config.password && config.source_stack && config.access_token) ||
-      (isAuthenticated() && !config.management_token)
-    ) {
-      login
-        .login(config, APIClient, stackAPIClient)
-        .then(async function () {
-          // setup branches
-          try {
-            await fetchBranchAndExport(APIClient, stackAPIClient);
-            unlinkFileLogger();
-          } catch (error) {
-            addlogs(config, `${util.formatError(error)}`, 'error');
-          }
-          resolve();
-        })
-        .catch((error) => {
-          console.log('error', error && error.message);
-          if (error && error.errors && error.errors.api_key) {
-            addlogs(config, chalk.red('Stack Api key ' + error.errors.api_key[0], 'Please enter valid Key', 'error'));
-            addlogs(config, 'The log for this is stored at ' + config.data + '/export/logs', 'success');
-          } else {
-            addlogs(config, `${util.formatError(error)}`, 'error');
-          }
-        });
-    } else {
-      reject('Kindly login or provide management_token');
-    }
-  });
-};
-
-const singleExport = async (APIClient, stackAPIClient, moduleName, types, config, branchName) => {
-  try {
-    if (types.indexOf(moduleName) > -1) {
-      let iterateList;
-      if (config.modules.dependency && config.modules.dependency[moduleName]) {
-        iterateList = config.modules.dependency[moduleName];
-      } else {
-        iterateList = ['stack'];
-      }
-      iterateList.push(moduleName);
-
-      for (let element of iterateList) {
-        const ExportModule = require('./lib/export/' + element);
-        const result = await new ExportModule(config, stackAPIClient, APIClient).start(config, branchName);
-        if (result && element === 'stack') {
-          let master_locale = {
-            master_locale: { code: result.code },
-          };
-          config = _.merge(config, master_locale);
-        }
-      }
-      addlogs(config, moduleName + ' was exported successfully!', 'success');
-      addlogs(config, 'The log for this is stored at ' + path.join(config.data, 'logs', 'export'), 'success');
-    } else {
-      addlogs(config, 'Please provide valid module name.', 'error');
-    }
-    return true;
-  } catch (error) {
-    addlogs(config, `${util.formatError(error)}`, 'error');
-    addlogs(config, 'Failed to migrate ' + moduleName, 'error');
-    addlogs(config, 'The log for this is stored at ' + path.join(config.data, 'logs', 'export'), 'error');
-  }
-};
-
-const allExport = async (APIClient, stackAPIClient, config, types, branchName) => {
-  try {
-    for (let type of types) {
-      const ExportModule = require('./lib/export/' + type);
-      const result = await new ExportModule(config, stackAPIClient, APIClient).start(config, branchName);
-
-      if (result && type === 'stack') {
-        let master_locale = { master_locale: { code: result.code } };
-        config = _.merge(config, master_locale);
-      }
-    }
-    addlogs(
-      config,
-      chalk.green(
-        'The content of stack ' + (config.sourceStackName || config.source_stack) + ' has been exported successfully!',
-      ),
-      'success',
-    );
-    addlogs(config, 'The log for this is stored at ' + path.join(config.data, 'logs', 'export'), 'success');
-    return true;
-  } catch (error) {
-    addlogs(config, util.formatError(error), 'error');
-    addlogs(
-      config,
-      chalk.red(
-        'Failed to migrate stack: ' +
-          (config.sourceStackName || config.source_stack) +
-          '. Please check error logs for more info',
-      ),
-      'error',
-    );
-    addlogs(config, 'The log for this is stored at ' + path.join(config.data, 'logs', 'export'), 'error');
-  }
-};

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

@@ -1,202 +0,0 @@
-/* eslint-disable complexity */
-const { Command } = require('@contentstack/cli-command');
-const { printFlagDeprecation, configHandler, flags, isAuthenticated } = require('@contentstack/cli-utilities');
-const {
-  configWithMToken,
-  parameterWithMToken,
-  withoutParameterMToken,
-  configWithAuthToken,
-  parametersWithAuthToken,
-  withoutParametersWithAuthToken,
-} = require('../../../lib/util/export-flags');
-const config = require('../../../config/default');
-
-class ExportCommand extends Command {
-  async run() {
-    const { flags: exportCommandFlags } = await this.parse(ExportCommand);
-    const extConfig = exportCommandFlags.config;
-    const 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 host = this.region;
-    let cmaHost = host.cma.split('//');
-    let cdaHost = host.cda.split('//');
-    host.cma = cmaHost[1];
-    host.cda = cdaHost[1];
-    exportCommandFlags['isAuthenticated'] = isAuthenticated();
-
-    config.forceStopMarketplaceAppsPrompt = exportCommandFlags.yes;
-
-    if (alias) {
-      const managementTokens = this.getToken(alias);
-      const listOfTokens = configHandler.get('tokens');
-      config.management_token_data = listOfTokens[alias];
-
-      if (managementTokens) {
-        if (extConfig) {
-          await configWithMToken(
-            extConfig,
-            managementTokens,
-            host,
-            contentTypes,
-            branchName,
-            securedAssets,
-            moduleName,
-            data,
-            exportCommandFlags,
-          );
-        } else if (data) {
-          await parameterWithMToken(
-            managementTokens,
-            data,
-            moduleName,
-            host,
-            contentTypes,
-            branchName,
-            securedAssets,
-            exportCommandFlags,
-          );
-        } else if (data === undefined && sourceStack === undefined) {
-          await withoutParameterMToken(
-            managementTokens,
-            moduleName,
-            host,
-            contentTypes,
-            branchName,
-            securedAssets,
-            exportCommandFlags,
-          );
-        } 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 (isAuthenticated()) {
-      if (extConfig) {
-        await configWithAuthToken(
-          extConfig,
-          moduleName,
-          host,
-          contentTypes,
-          branchName,
-          securedAssets,
-          exportCommandFlags,
-        );
-      } else if (sourceStack && data) {
-        return await parametersWithAuthToken(
-          sourceStack,
-          data,
-          moduleName,
-          host,
-          contentTypes,
-          branchName,
-          securedAssets,
-          exportCommandFlags,
-        );
-      } else if (data === undefined && sourceStack === undefined) {
-        await withoutParametersWithAuthToken(
-          moduleName,
-          host,
-          contentTypes,
-          branchName,
-          securedAssets,
-          exportCommandFlags,
-        );
-      } 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');
-    }
-  }
-}
-
-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',
-  }),
-  yes: flags.boolean({
-    char: 'y',
-    required: false,
-    description: '[optional] Override marketplace apps related prompts',
-  }),
-};
-
-ExportCommand.aliases = ['cm:export'];
-
-module.exports = ExportCommand;