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

package/src/lib/util/export-flags.js

@@ -1,101 +1,172 @@
 /*!
-* Contentstack Export
-* Copyright (c) 2019 Contentstack LLC
-* MIT Licensed
-*/
-let defaultConfig = require('../../config/default')
-let message = require('../../../messages/index.json')
-let {initial} = require('../../app')
-let path = require('path')
+ * Contentstack Export
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
+let defaultConfig = require('../../config/default');
+let message = require('../../../messages/index.json');
+let { initial } = require('../../app');
+let path = require('path');
 const helper = require('../util/helper');
-let _ = require('lodash')
-const {cli} = require('cli-ux')
+let _ = require('lodash');
+const { cliux } = require('@contentstack/cli-utilities');
 
-exports.configWithMToken = function (config, managementTokens, host, securedAssets) {
-  let externalConfig = require(config)
-  defaultConfig.securedAssets = securedAssets
-  defaultConfig.management_token = managementTokens.token
-  defaultConfig.host = host.cma
-  defaultConfig.cdn = host.cda
-  defaultConfig = _.merge(defaultConfig, externalConfig)
-  initial(defaultConfig)
-}
+exports.configWithMToken = function (config, managementTokens, host, contentTypes, branchName, securedAssets, moduleName) {
+  let externalConfig = require(config);
+  defaultConfig.securedAssets = securedAssets;
+  defaultConfig.management_token = managementTokens.token;
+  defaultConfig.host = host.cma;
+  defaultConfig.cdn = host.cda;
+  defaultConfig.branchName = branchName;
+  defaultConfig.source_stack = managementTokens.apiKey;
+  if (moduleName) {
+    defaultConfig.moduleName = moduleName;
+    // Specfic content type setting is only for entries module
+    if (moduleName === 'entries' && Array.isArray(contentTypes) && contentTypes.length > 0) {
+      defaultConfig.contentTypes = contentTypes;
+    }
+  }
+  defaultConfig = _.merge(defaultConfig, externalConfig);
+  initial(defaultConfig);
+};
 
-exports.parameterWithMToken = function (managementTokens, data, moduleName, host, _authToken, securedAssets) {
-  defaultConfig.management_token = managementTokens.token
-  defaultConfig.auth_token = _authToken
-  defaultConfig.host = host.cma
-  defaultConfig.cdn = host.cda
-  defaultConfig.securedAssets = securedAssets
-  if (moduleName && moduleName !== undefined) {
-    defaultConfig.moduleName = moduleName
+exports.parameterWithMToken = async function (
+  managementTokens,
+  data,
+  moduleName,
+  host,
+  _authToken,
+  contentTypes,
+  branchName,
+  securedAssets,
+) {
+  defaultConfig.management_token = managementTokens.token;
+  defaultConfig.auth_token = _authToken;
+  defaultConfig.host = host.cma;
+  defaultConfig.cdn = host.cda;
+  defaultConfig.branchName = branchName;
+  defaultConfig.securedAssets = securedAssets;
+  if (!moduleName) {
+    defaultConfig.contentTypes = contentTypes;
+  } else {
+    defaultConfig.moduleName = moduleName;
+    // Specfic content type setting is only for entries module
+    if (moduleName === 'entries' && Array.isArray(contentTypes) && contentTypes.length > 0) {
+      defaultConfig.contentTypes = contentTypes;
+    }
   }
-  defaultConfig.source_stack = managementTokens.apiKey
-  defaultConfig.data = data
-  initial(defaultConfig)
-}
+  defaultConfig.source_stack = managementTokens.apiKey;
+  defaultConfig.data = data;
+  await initial(defaultConfig);
+};
 
 // using ManagementToken
-exports.withoutParameterMToken = async (managementTokens, moduleName, host, _authToken, securedAssets) => {
-  const stackUid = managementTokens.apiKey
-  const pathOfExport = await cli.prompt(message.promptMessageList.promptPathStoredData)
-  defaultConfig.management_token = managementTokens.token
-  defaultConfig.host = host.cma
-  defaultConfig.cdn = host.cda
-  defaultConfig.auth_token = _authToken
-  defaultConfig.securedAssets = securedAssets
-  if (moduleName && moduleName !== undefined) {
-    defaultConfig.moduleName = moduleName
+exports.withoutParameterMToken = async (
+  managementTokens,
+  moduleName,
+  host,
+  _authToken,
+  contentTypes,
+  branchName,
+  securedAssets,
+) => {
+  const stackUid = managementTokens.apiKey;
+  const pathOfExport = await cliux.prompt(message.promptMessageList.promptPathStoredData);
+  defaultConfig.management_token = managementTokens.token;
+  defaultConfig.host = host.cma;
+  defaultConfig.cdn = host.cda;
+  defaultConfig.branchName = branchName;
+  defaultConfig.auth_token = _authToken;
+  defaultConfig.securedAssets = securedAssets;
+  if (moduleName) {
+    defaultConfig.moduleName = moduleName;
+    // Specfic content type setting is only for entries module
+    if (moduleName === 'entries' && Array.isArray(contentTypes) && contentTypes.length > 0) {
+      defaultConfig.contentTypes = contentTypes;
+    }
   }
-  defaultConfig.source_stack = stackUid
-  defaultConfig.data = pathOfExport
-  initial(defaultConfig)
-}
+  defaultConfig.source_stack = stackUid;
+  defaultConfig.data = pathOfExport;
+  initial(defaultConfig);
+};
 
-exports.configWithAuthToken = function (config, _authToken, moduleName, host, securedAssets) {
-  let externalConfig = helper.readFile(path.resolve(config))
-  defaultConfig.auth_token = _authToken
-  defaultConfig.host = host.cma
-  defaultConfig.cdn = host.cda
-  defaultConfig.securedAssets = securedAssets
-  if (moduleName && moduleName !== undefined) {
-    defaultConfig.moduleName = moduleName
+exports.configWithAuthToken = function (config, _authToken, moduleName, host, contentTypes, branchName, securedAssets) {
+  let externalConfig = helper.readFile(path.resolve(config));
+  defaultConfig.auth_token = _authToken;
+  defaultConfig.host = host.cma;
+  defaultConfig.cdn = host.cda;
+  defaultConfig.branchName = branchName;
+  defaultConfig.securedAssets = securedAssets;
+  if (moduleName) {
+    defaultConfig.moduleName = moduleName;
+    // Specfic content type setting is only for entries module
+    if (moduleName === 'entries' && Array.isArray(contentTypes) && contentTypes.length > 0) {
+      defaultConfig.contentTypes = contentTypes;
+    }
   }
-  defaultConfig = _.merge(defaultConfig, externalConfig)
-  initial(defaultConfig)
-}
+  defaultConfig = _.merge(defaultConfig, externalConfig);
+  initial(defaultConfig);
+};
 
-exports.parametersWithAuthToken = function (_authToken, sourceStack, data, moduleName, host, securedAssets) {
-  return new Promise(async(resolve, reject) => {
-    defaultConfig.auth_token = _authToken
-    defaultConfig.source_stack = sourceStack
-    if (moduleName && moduleName !== undefined) {
-      defaultConfig.moduleName = moduleName
+exports.parametersWithAuthToken = function (
+  _authToken,
+  sourceStack,
+  data,
+  moduleName,
+  host,
+  contentTypes,
+  branchName,
+  securedAssets,
+) {
+  return new Promise(async (resolve, reject) => {
+    defaultConfig.auth_token = _authToken;
+    defaultConfig.source_stack = sourceStack;
+    if (moduleName) {
+      defaultConfig.moduleName = moduleName;
+      // Specfic content type setting is only for entries module
+      if (moduleName === 'entries' && Array.isArray(contentTypes) && contentTypes.length > 0) {
+        defaultConfig.contentTypes = contentTypes;
+      }
     }
-    defaultConfig.host = host.cma
-    defaultConfig.cdn = host.cda
-    defaultConfig.data = data
-    defaultConfig.securedAssets = securedAssets
-    var exportStart = initial(defaultConfig)
-    exportStart.then(() => {
-      return resolve()
-    }).catch((error) => {
-      return reject(error)
-    })
-  })
-}
+    defaultConfig.branchName = branchName;
+    defaultConfig.host = host.cma;
+    defaultConfig.cdn = host.cda;
+    defaultConfig.data = data;
+    defaultConfig.securedAssets = securedAssets;
+    var exportStart = initial(defaultConfig);
+    exportStart
+      .then(() => {
+        return resolve();
+      })
+      .catch((error) => {
+        return reject(error);
+      });
+  });
+};
 
-exports.withoutParametersWithAuthToken = async (_authToken, moduleName, host, securedAssets) => {
-  const stackUid = await cli.prompt(message.promptMessageList.promptSourceStack)
-  const pathOfExport = await cli.prompt(message.promptMessageList.promptPathStoredData)
-  defaultConfig.auth_token = _authToken
-  defaultConfig.source_stack = stackUid
-  defaultConfig.securedAssets = securedAssets
-  if (moduleName && moduleName !== undefined) {
-    defaultConfig.moduleName = moduleName
+exports.withoutParametersWithAuthToken = async (
+  _authToken,
+  moduleName,
+  host,
+  contentTypes,
+  branchName,
+  securedAssets,
+) => {
+  const stackUid = await cliux.prompt(message.promptMessageList.promptSourceStack);
+  const pathOfExport = await cliux.prompt(message.promptMessageList.promptPathStoredData);
+  defaultConfig.auth_token = _authToken;
+  defaultConfig.source_stack = stackUid;
+  defaultConfig.securedAssets = securedAssets;
+  if (moduleName) {
+    defaultConfig.moduleName = moduleName;
+    // Specfic content type setting is only for entries module
+    if (moduleName === 'entries' && Array.isArray(contentTypes) && contentTypes.length > 0) {
+      defaultConfig.contentTypes = contentTypes;
+    }
   }
-  defaultConfig.data = pathOfExport
-  defaultConfig.host = host.cma
-  defaultConfig.cdn = host.cda
-  initial(defaultConfig)
-}
+  defaultConfig.branchName = branchName;
+  defaultConfig.data = pathOfExport;
+  defaultConfig.host = host.cma;
+  defaultConfig.cdn = host.cda;
+  initial(defaultConfig);
+};

package/src/lib/util/helper.js

@@ -1,41 +1,41 @@
 /*!
-* Contentstack Export
-* Copyright (c) 2019 Contentstack LLC
-* MIT Licensed
-*/
+ * Contentstack Export
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
 
-var fs = require('fs')
-var path = require('path')
-var mkdirp = require('mkdirp')
+var fs = require('fs');
+var path = require('path');
+var mkdirp = require('mkdirp');
 
 exports.readFile = function (filePath, parse) {
-  var data
-  parse = (typeof parse === 'undefined') ? true : parse
-  filePath = path.resolve(filePath)
+  var data;
+  parse = typeof parse === 'undefined' ? true : parse;
+  filePath = path.resolve(filePath);
   if (fs.existsSync(filePath)) {
-    data = (parse) ? JSON.parse(fs.readFileSync(filePath, 'utf-8')) : data
+    data = parse ? JSON.parse(fs.readFileSync(filePath, 'utf-8')) : data;
   }
-  return data
+  return data;
 };
 
 exports.writeFile = function (filePath, data) {
-  data = (typeof data === 'object') ? JSON.stringify(data) : data || '{}'
-  fs.writeFileSync(filePath, data)
+  data = typeof data === 'object' ? JSON.stringify(data) : data || '{}';
+  fs.writeFileSync(filePath, data);
 };
 
 exports.makeDirectory = function () {
   for (var key in arguments) {
-    var dirname = path.resolve(arguments[key])
+    var dirname = path.resolve(arguments[key]);
     if (!fs.existsSync(dirname)) {
-      mkdirp.sync(dirname)
+      mkdirp.sync(dirname);
     }
   }
-}
+};
 
 exports.readdir = function (dirPath) {
   if (fs.existsSync(path)) {
-    return fs.readdirSync(dirPath)
+    return fs.readdirSync(dirPath);
   } else {
-    return []
+    return [];
   }
-}
+};

package/src/lib/util/index.js

@@ -1,13 +1,13 @@
 /*!
-* Contentstack Export
-* Copyright (c) 2019 Contentstack LLC
-* MIT Licensed
-*/
+ * Contentstack Export
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
 
-var _ = require('lodash')
-var defaultConfig = require('../../config/default')
-var {addlogs} = require('../util/log')
-const chalk = require('chalk')
+var _ = require('lodash');
+var defaultConfig = require('../../config/default');
+var { addlogs } = require('../util/log');
+const chalk = require('chalk');
 
 exports.validateConfig = function (config) {
   if (!config.host || !config.cdn) {
@@ -15,18 +15,31 @@ exports.validateConfig = function (config) {
   }
 
   if (config.email && config.password && !config.access_token && !config.source_stack) {
-    throw new Error('Kindly provide access_token or api_token')
-  } else if (!config.email && !config.password && !config.management_token && config.source_stack && !config.access_token && !config.auth_token) {
-    throw new Error('Kindly provide management_token or email and password')
-  } else if (config.email && config.password && !config.access_token && config.source_stack && !config.management_token && !config.auth_token) {
-    throw new Error('Kindly provide access_token or management_token')
+    throw new Error('Kindly provide access_token or api_token');
+  } else if (
+    !config.email &&
+    !config.password &&
+    !config.management_token &&
+    config.source_stack &&
+    !config.access_token &&
+    !config.auth_token
+  ) {
+    throw new Error('Kindly provide management_token or email and password');
+  } else if (
+    config.email &&
+    config.password &&
+    !config.access_token &&
+    config.source_stack &&
+    !config.management_token &&
+    !config.auth_token
+  ) {
+    throw new Error('Kindly provide access_token or management_token');
   } else if (!config.email && !config.password && config.preserveStackVersion) {
-    throw new Error('Kindly provide Email and password for stack details')
+    throw new Error('Kindly provide Email and password for stack details');
   }
-}
+};
 
 exports.buildAppConfig = function (config) {
-  config = _.merge(defaultConfig, config)
-  return config
-}
-
+  config = _.merge(defaultConfig, config);
+  return config;
+};

package/src/lib/util/log.js

@@ -1,99 +1,155 @@
 /*!
-* Contentstack Export
-* Copyright (c) 2019 Contentstack LLC
-* MIT Licensed
-*/
+ * Contentstack Export
+ * Copyright (c) 2019 Contentstack LLC
+ * MIT Licensed
+ */
 
-var winston = require('winston')
-var path = require('path')
-var mkdirp = require('mkdirp')
-var slice = Array.prototype.slice
+var winston = require('winston');
+var path = require('path');
+var mkdirp = require('mkdirp');
+var slice = Array.prototype.slice;
+
+const ansiRegexPattern = [
+  '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]+)*|[a-zA-Z\\d]+(?:;[-a-zA-Z\\d\\/#&.:=?%@~_]*)*)?\\u0007)',
+'(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))'
+].join('|');
 
 function returnString(args) {
-  var returnStr = ''
+  var returnStr = '';
   if (args && args.length) {
-    returnStr = args.map(function (item) {
-      if (item && typeof (item) === 'object') {
-        return JSON.stringify(item)
-      }
-      return item
-    }).join('  ').trim()
+    returnStr = args
+      .map(function (item) {
+        if (item && typeof item === 'object') {
+          return JSON.stringify(item).replace(/authtoken\":\"blt................/g, 'authtoken":"blt....');
+        }
+        return item;
+      })
+      .join('  ')
+      .trim();
   }
-  return returnStr
+  returnStr = returnStr.replace(new RegExp(ansiRegexPattern, 'g'), "").trim();
+  return returnStr;
 }
-
 var myCustomLevels = {
   levels: {
-    error: 0,
     warn: 1,
     info: 2,
     debug: 3,
   },
   colors: {
+    //colors aren't being used anywhere as of now, we're using chalk to add colors while logging
     info: 'blue',
     debug: 'green',
     warn: 'yellow',
     error: 'red',
   },
-}
+};
 
-function init (_logPath, logfileName) {
-  var logsDir = path.resolve(_logPath, 'logs', 'export')
-  // Create dir if doesn't already exist
-  mkdirp.sync(logsDir)
-  var logPath = path.join(logsDir, logfileName + '.log')
+let logger;
+let errorLogger;
 
-  var transports = [new (winston.transports.File)({
-    filename: logPath,
-    maxFiles: 20,
-    maxsize: 1000000,
-    tailable: true,
-    json: true,
-  })]
+let successTransport;
+let errorTransport;
 
-  transports.push(new (winston.transports.Console)())
+function init(_logPath) {
+  if (!logger || !errorLogger) {
+    var logsDir = path.resolve(_logPath, 'logs', 'export');
+    // Create dir if doesn't already exist
+    mkdirp.sync(logsDir);
 
-  var logger = new(winston.Logger)({
-    transports: transports,
-    levels: myCustomLevels.levels
-  })
+    successTransport = {
+      filename: path.join(logsDir, 'success.log'),
+      maxFiles: 20,
+      maxsize: 1000000,
+      tailable: true,
+      json: true,
+      level: 'info',
+    };
+
+    errorTransport = {
+      filename: path.join(logsDir, 'error.log'),
+      maxFiles: 20,
+      maxsize: 1000000,
+      tailable: true,
+      json: true,
+      level: 'error',
+    };
+
+    logger = winston.createLogger({
+      transports: [
+        new winston.transports.File(successTransport),
+        new winston.transports.Console({ format: winston.format.simple() }),
+      ],
+      levels: myCustomLevels.levels,
+    });
+
+    errorLogger = winston.createLogger({
+      transports: [
+        new winston.transports.File(errorTransport),
+        new winston.transports.Console({ level: 'error', format: winston.format.simple() }),
+      ],
+      levels: { error: 0 },
+    });
+  }
 
   return {
     log: function () {
-      var args = slice.call(arguments)
-      var logString = returnString(args)
+      let args = slice.call(arguments);
+      let logString = returnString(args);
       if (logString) {
-        logger.log('info', logString)
+        logger.log('info', logString);
       }
     },
     warn: function () {
-      var args = slice.call(arguments)
-      var logString = returnString(args)
+      let args = slice.call(arguments);
+      let logString = returnString(args);
       if (logString) {
-        logger.log('warn', logString)
+        logger.log('warn', logString);
       }
     },
-    error: function (args) {
-      var args = slice.call(arguments)
-      var logString = returnString(args)
+    error: function () {
+      let args = slice.call(arguments);
+      let logString = returnString(args);
       if (logString) {
-        logger.log('error', logString)
+        errorLogger.log('error', logString);
       }
     },
     debug: function () {
-      // var args = slice.call(arguments)
-      var logString = returnString(args)
+      let args = slice.call(arguments);
+      let logString = returnString(args);
       if (logString) {
-        logger.log('debug', logString)
+        logger.log('debug', logString);
       }
     },
-  }
+  };
 }
 
 exports.addlogs = async (config, message, type) => {
+  // ignoring the type argument, as we are not using it to create a logfile anymore
   if (type !== 'error') {
-    init(config.data, type).log(message)
+    // removed type argument from init method
+    init(config.data).log(message);
   } else {
-    init(config.data, type).error(message)
+    init(config.data).error(message);
   }
-}
+};
+
+exports.unlinkFileLogger = () => {
+  if (logger) {
+    const transports = logger.transports;
+    transports.forEach((transport) => {
+      if (transport.name === 'file') {
+        logger.remove(transport);
+      }
+    });
+  }
+
+  if (errorLogger) {
+    const transports = errorLogger.transports;
+    transports.forEach((transport) => {
+      if (transport.name === 'file') {
+        errorLogger.remove(transport);
+      }
+    });
+  }
+};