contentful-import 9.0.20 → 9.1.0

package/dist/index.js

@@ -1,172 +1,167 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = runContentfulImport;
-var _cliTable = _interopRequireDefault(require("cli-table3"));
-var _differenceInSeconds = _interopRequireDefault(require("date-fns/differenceInSeconds"));
-var _formatDistance = _interopRequireDefault(require("date-fns/formatDistance"));
-var _listr = _interopRequireDefault(require("listr"));
-var _listrUpdateRenderer = _interopRequireDefault(require("listr-update-renderer"));
-var _listrVerboseRenderer = _interopRequireDefault(require("listr-verbose-renderer"));
-var _lodash = require("lodash");
-var _pQueue = _interopRequireDefault(require("p-queue"));
-var _logging = require("contentful-batch-libs/dist/logging");
-var _listr2 = require("contentful-batch-libs/dist/listr");
-var _initClient = _interopRequireDefault(require("./tasks/init-client"));
-var _getDestinationData = _interopRequireDefault(require("./tasks/get-destination-data"));
-var _pushToSpace = _interopRequireDefault(require("./tasks/push-to-space/push-to-space"));
-var _transformSpace = _interopRequireDefault(require("./transform/transform-space"));
-var _validations = require("./utils/validations");
-var _parseOptions = _interopRequireDefault(require("./parseOptions"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const cli_table3_1 = __importDefault(require("cli-table3"));
+const differenceInSeconds_1 = __importDefault(require("date-fns/differenceInSeconds"));
+const formatDistance_1 = __importDefault(require("date-fns/formatDistance"));
+const listr_1 = __importDefault(require("listr"));
+const listr_update_renderer_1 = __importDefault(require("listr-update-renderer"));
+const listr_verbose_renderer_1 = __importDefault(require("listr-verbose-renderer"));
+const lodash_1 = require("lodash");
+const p_queue_1 = __importDefault(require("p-queue"));
+const logging_1 = require("contentful-batch-libs/dist/logging");
+const listr_2 = require("contentful-batch-libs/dist/listr");
+const init_client_1 = __importDefault(require("./tasks/init-client"));
+const get_destination_data_1 = __importDefault(require("./tasks/get-destination-data"));
+const push_to_space_1 = __importDefault(require("./tasks/push-to-space/push-to-space"));
+const transform_space_1 = __importDefault(require("./transform/transform-space"));
+const validations_1 = require("./utils/validations");
+const parseOptions_1 = __importDefault(require("./parseOptions"));
 const ONE_SECOND = 1000;
 function createListrOptions(options) {
-  if (options.useVerboseRenderer) {
+    if (options.useVerboseRenderer) {
+        return {
+            renderer: listr_verbose_renderer_1.default
+        };
+    }
     return {
-      renderer: _listrVerboseRenderer.default
+        renderer: listr_update_renderer_1.default,
+        collapse: false
     };
-  }
-  return {
-    renderer: _listrUpdateRenderer.default,
-    collapse: false
-  };
 }
 async function runContentfulImport(params) {
-  const log = [];
-  const options = await (0, _parseOptions.default)(params);
-  const listrOptions = createListrOptions(options);
-  const requestQueue = new _pQueue.default({
-    interval: ONE_SECOND,
-    intervalCap: options.rateLimit,
-    carryoverConcurrencyCount: true
-  });
-
-  // Setup custom log listener to store log messages for later
-  (0, _logging.setupLogging)(log);
-  const infoTable = new _cliTable.default();
-  infoTable.push([{
-    colSpan: 2,
-    content: 'The following entities are going to be imported:'
-  }]);
-  Object.keys(options.content).forEach(type => {
-    if (options.skipLocales && type === 'locales') {
-      return;
-    }
-    if (options.skipContentModel && ['contentTypes', 'editorInterfaces'].indexOf(type) >= 0) {
-      return;
-    }
-    if (options.contentModelOnly && !(['contentTypes', 'editorInterfaces', 'locales'].indexOf(type) >= 0)) {
-      return;
-    }
-    infoTable.push([(0, _lodash.startCase)(type), options.content[type].length]);
-  });
-  console.log(infoTable.toString());
-  const tasks = new _listr.default([{
-    title: 'Validating content-file',
-    task: ctx => {
-      (0, _validations.assertPayload)(options.content);
-    }
-  }, {
-    title: 'Initialize client',
-    task: (0, _listr2.wrapTask)(async ctx => {
-      ctx.client = (0, _initClient.default)(_objectSpread(_objectSpread({}, options), {}, {
-        content: undefined
-      }));
+    const log = [];
+    const options = await (0, parseOptions_1.default)(params);
+    const listrOptions = createListrOptions(options);
+    const requestQueue = new p_queue_1.default({
+        interval: ONE_SECOND,
+        intervalCap: options.rateLimit,
+        carryoverConcurrencyCount: true
+    });
+    // Setup custom log listener to store log messages for later
+    (0, logging_1.setupLogging)(log);
+    const infoTable = new cli_table3_1.default();
+    infoTable.push([{ colSpan: 2, content: 'The following entities are going to be imported:' }]);
+    Object.keys(options.content).forEach((type) => {
+        if (options.skipLocales && type === 'locales') {
+            return;
+        }
+        if (options.skipContentModel && (['contentTypes', 'editorInterfaces'].indexOf(type) >= 0)) {
+            return;
+        }
+        if (options.contentModelOnly && !(['contentTypes', 'editorInterfaces', 'locales'].indexOf(type) >= 0)) {
+            return;
+        }
+        infoTable.push([(0, lodash_1.startCase)(type), options.content[type].length]);
+    });
+    console.log(infoTable.toString());
+    const tasks = new listr_1.default([
+        {
+            title: 'Validating content-file',
+            task: (ctx) => {
+                (0, validations_1.assertPayload)(options.content);
+            }
+        },
+        {
+            title: 'Initialize client',
+            task: (0, listr_2.wrapTask)(async (ctx) => {
+                ctx.client = (0, init_client_1.default)({ ...options, content: undefined });
+            })
+        },
+        {
+            title: 'Checking if destination space already has any content and retrieving it',
+            task: (0, listr_2.wrapTask)(async (ctx, task) => {
+                const destinationData = await (0, get_destination_data_1.default)({
+                    client: ctx.client,
+                    spaceId: options.spaceId,
+                    environmentId: options.environmentId,
+                    sourceData: options.content,
+                    skipLocales: options.skipLocales,
+                    skipContentModel: options.skipContentModel,
+                    requestQueue
+                });
+                ctx.sourceDataUntransformed = options.content;
+                ctx.destinationData = destinationData;
+                (0, validations_1.assertDefaultLocale)(ctx.sourceDataUntransformed, ctx.destinationData);
+            })
+        },
+        {
+            title: 'Apply transformations to source data',
+            task: (0, listr_2.wrapTask)(async (ctx) => {
+                const transformedSourceData = (0, transform_space_1.default)(ctx.sourceDataUntransformed, ctx.destinationData);
+                ctx.sourceData = transformedSourceData;
+            })
+        },
+        {
+            title: 'Push content to destination space',
+            task: (ctx, task) => {
+                return (0, push_to_space_1.default)({
+                    sourceData: ctx.sourceData,
+                    destinationData: ctx.destinationData,
+                    client: ctx.client,
+                    spaceId: options.spaceId,
+                    environmentId: options.environmentId,
+                    contentModelOnly: options.contentModelOnly,
+                    skipLocales: options.skipLocales,
+                    skipContentModel: options.skipContentModel,
+                    skipContentPublishing: options.skipContentPublishing,
+                    timeout: options.timeout,
+                    retryLimit: options.retryLimit,
+                    uploadAssets: options.uploadAssets,
+                    assetsDirectory: options.assetsDirectory,
+                    listrOptions,
+                    requestQueue
+                });
+            }
+        }
+    ], listrOptions);
+    return tasks.run({
+        data: {}
     })
-  }, {
-    title: 'Checking if destination space already has any content and retrieving it',
-    task: (0, _listr2.wrapTask)(async (ctx, task) => {
-      const destinationData = await (0, _getDestinationData.default)({
-        client: ctx.client,
-        spaceId: options.spaceId,
-        environmentId: options.environmentId,
-        sourceData: options.content,
-        skipLocales: options.skipLocales,
-        skipContentModel: options.skipContentModel,
-        requestQueue
-      });
-      ctx.sourceDataUntransformed = options.content;
-      ctx.destinationData = destinationData;
-      (0, _validations.assertDefaultLocale)(ctx.sourceDataUntransformed, ctx.destinationData);
+        .then((ctx) => {
+        console.log('Finished importing all data');
+        const resultTypes = Object.keys(ctx.data);
+        if (resultTypes.length) {
+            const resultTable = new cli_table3_1.default();
+            resultTable.push([{ colSpan: 2, content: 'Imported entities' }]);
+            resultTypes.forEach((type) => {
+                resultTable.push([(0, lodash_1.startCase)(type), ctx.data[type].length]);
+            });
+            console.log(resultTable.toString());
+        }
+        else {
+            console.log('No data was imported');
+        }
+        const endTime = new Date();
+        const durationHuman = (0, formatDistance_1.default)(endTime, options.startTime);
+        const durationSeconds = (0, differenceInSeconds_1.default)(endTime, options.startTime);
+        console.log(`The import took ${durationHuman} (${durationSeconds}s)`);
+        return ctx.data;
     })
-  }, {
-    title: 'Apply transformations to source data',
-    task: (0, _listr2.wrapTask)(async ctx => {
-      const transformedSourceData = (0, _transformSpace.default)(ctx.sourceDataUntransformed, ctx.destinationData);
-      ctx.sourceData = transformedSourceData;
+        .catch((err) => {
+        log.push({
+            ts: (new Date()).toJSON(),
+            level: 'error',
+            error: err
+        });
     })
-  }, {
-    title: 'Push content to destination space',
-    task: (ctx, task) => {
-      return (0, _pushToSpace.default)({
-        sourceData: ctx.sourceData,
-        destinationData: ctx.destinationData,
-        client: ctx.client,
-        spaceId: options.spaceId,
-        environmentId: options.environmentId,
-        contentModelOnly: options.contentModelOnly,
-        skipLocales: options.skipLocales,
-        skipContentModel: options.skipContentModel,
-        skipContentPublishing: options.skipContentPublishing,
-        timeout: options.timeout,
-        retryLimit: options.retryLimit,
-        uploadAssets: options.uploadAssets,
-        assetsDirectory: options.assetsDirectory,
-        listrOptions,
-        requestQueue
-      });
-    }
-  }], listrOptions);
-  return tasks.run({
-    data: {}
-  }).then(ctx => {
-    console.log('Finished importing all data');
-    const resultTypes = Object.keys(ctx.data);
-    if (resultTypes.length) {
-      const resultTable = new _cliTable.default();
-      resultTable.push([{
-        colSpan: 2,
-        content: 'Imported entities'
-      }]);
-      resultTypes.forEach(type => {
-        resultTable.push([(0, _lodash.startCase)(type), ctx.data[type].length]);
-      });
-      console.log(resultTable.toString());
-    } else {
-      console.log('No data was imported');
-    }
-    const endTime = new Date();
-    const durationHuman = (0, _formatDistance.default)(endTime, options.startTime);
-    const durationSeconds = (0, _differenceInSeconds.default)(endTime, options.startTime);
-    console.log(`The import took ${durationHuman} (${durationSeconds}s)`);
-    return ctx.data;
-  }).catch(err => {
-    log.push({
-      ts: new Date().toJSON(),
-      level: 'error',
-      error: err
+        .then((data) => {
+        const errorLog = log.filter((logMessage) => logMessage.level !== 'info' && logMessage.level !== 'warning');
+        const displayLog = log.filter((logMessage) => logMessage.level !== 'info');
+        (0, logging_1.displayErrorLog)(displayLog);
+        if (errorLog.length) {
+            return (0, logging_1.writeErrorLogFile)(options.errorLogFile, errorLog)
+                .then(() => {
+                const multiError = new Error('Errors occurred');
+                multiError.name = 'ContentfulMultiError';
+                multiError.errors = errorLog;
+                throw multiError;
+            });
+        }
+        console.log('The import was successful.');
+        return data;
     });
-  }).then(data => {
-    const errorLog = log.filter(logMessage => logMessage.level !== 'info' && logMessage.level !== 'warning');
-    const displayLog = log.filter(logMessage => logMessage.level !== 'info');
-    (0, _logging.displayErrorLog)(displayLog);
-    if (errorLog.length) {
-      return (0, _logging.writeErrorLogFile)(options.errorLogFile, errorLog).then(() => {
-        const multiError = new Error('Errors occurred');
-        multiError.name = 'ContentfulMultiError';
-        multiError.errors = errorLog;
-        throw multiError;
-      });
-    }
-    console.log('The import was successful.');
-    return data;
-  });
 }
-module.exports = exports.default;
+exports.default = runContentfulImport;

package/dist/parseOptions.js

@@ -1,94 +1,97 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = parseOptions;
-var _fs = _interopRequireDefault(require("fs"));
-var _path = require("path");
-var _format = _interopRequireDefault(require("date-fns/format"));
-var _package = require("../package");
-var _headers = require("./utils/headers");
-var _proxy = require("contentful-batch-libs/dist/proxy");
-var _addSequenceHeader = _interopRequireDefault(require("contentful-batch-libs/dist/add-sequence-header"));
-var _jsonExt = require("@discoveryjs/json-ext");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
-function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-const SUPPORTED_ENTITY_TYPES = ['contentTypes', 'tags', 'entries', 'assets', 'locales', 'webhooks', 'editorInterfaces'];
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+const path_1 = require("path");
+const format_1 = __importDefault(require("date-fns/format"));
+const package_1 = require("../package");
+const headers_1 = require("./utils/headers");
+const proxy_1 = require("contentful-batch-libs/dist/proxy");
+const add_sequence_header_1 = __importDefault(require("contentful-batch-libs/dist/add-sequence-header"));
+const json_ext_1 = require("@discoveryjs/json-ext");
+const SUPPORTED_ENTITY_TYPES = [
+    'contentTypes',
+    'tags',
+    'entries',
+    'assets',
+    'locales',
+    'webhooks',
+    'editorInterfaces'
+];
 async function parseOptions(params) {
-  const defaultOptions = {
-    skipContentModel: false,
-    skipLocales: false,
-    skipContentPublishing: false,
-    useVerboseRenderer: false,
-    environmentId: 'master',
-    rawProxy: false,
-    uploadAssets: false,
-    rateLimit: 7
-  };
-  const configFile = params.config ? require((0, _path.resolve)(process.cwd(), params.config)) : {};
-  const options = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, defaultOptions), configFile), params), {}, {
-    headers: (0, _addSequenceHeader.default)(params.headers || (0, _headers.getHeadersConfig)(params.header))
-  });
-
-  // Validation
-  if (!options.spaceId) {
-    throw new Error('The `spaceId` option is required.');
-  }
-  if (!options.managementToken) {
-    throw new Error('The `managementToken` option is required.');
-  }
-  if (!options.contentFile && !options.content) {
-    throw new Error('Either the `contentFile` or `content` option are required.');
-  }
-  if (options.contentModelOnly && options.skipContentModel) {
-    throw new Error('`contentModelOnly` and `skipContentModel` cannot be used together');
-  }
-  if (options.skipLocales && !options.contentModelOnly) {
-    throw new Error('`skipLocales` can only be used together with `contentModelOnly`');
-  }
-  const proxySimpleExp = /.+:\d+/;
-  const proxyAuthExp = /.+:.+@.+:\d+/;
-  if (typeof options.proxy === 'string' && options.proxy && !(proxySimpleExp.test(options.proxy) || proxyAuthExp.test(options.proxy))) {
-    throw new Error('Please provide the proxy config in the following format:\nhost:port or user:password@host:port');
-  }
-  options.startTime = new Date();
-  if (!options.errorLogFile) {
-    options.errorLogFile = (0, _path.resolve)(process.cwd(), `contentful-import-error-log-${options.spaceId}-${(0, _format.default)(options.startTime, "yyyy-MM-dd'T'HH-mm-ss")}.json`);
-  } else {
-    options.errorLogFile = (0, _path.resolve)(process.cwd(), options.errorLogFile);
-  }
-  options.accessToken = options.managementToken;
-  if (!options.content) {
-    // using a stream parser allows input files > 512 MB
-    const fileStream = _fs.default.createReadStream(options.contentFile, {
-      encoding: 'utf8'
+    const defaultOptions = {
+        skipContentModel: false,
+        skipLocales: false,
+        skipContentPublishing: false,
+        useVerboseRenderer: false,
+        environmentId: 'master',
+        rawProxy: false,
+        uploadAssets: false,
+        rateLimit: 7
+    };
+    const configFile = params.config
+        ? require((0, path_1.resolve)(process.cwd(), params.config))
+        : {};
+    const options = {
+        ...defaultOptions,
+        ...configFile,
+        ...params,
+        headers: (0, add_sequence_header_1.default)(params.headers || (0, headers_1.getHeadersConfig)(params.header))
+    };
+    // Validation
+    if (!options.spaceId) {
+        throw new Error('The `spaceId` option is required.');
+    }
+    if (!options.managementToken) {
+        throw new Error('The `managementToken` option is required.');
+    }
+    if (!options.contentFile && !options.content) {
+        throw new Error('Either the `contentFile` or `content` option are required.');
+    }
+    if (options.contentModelOnly && options.skipContentModel) {
+        throw new Error('`contentModelOnly` and `skipContentModel` cannot be used together');
+    }
+    if (options.skipLocales && !options.contentModelOnly) {
+        throw new Error('`skipLocales` can only be used together with `contentModelOnly`');
+    }
+    const proxySimpleExp = /.+:\d+/;
+    const proxyAuthExp = /.+:.+@.+:\d+/;
+    if (typeof options.proxy === 'string' && options.proxy && !(proxySimpleExp.test(options.proxy) || proxyAuthExp.test(options.proxy))) {
+        throw new Error('Please provide the proxy config in the following format:\nhost:port or user:password@host:port');
+    }
+    options.startTime = new Date();
+    if (!options.errorLogFile) {
+        options.errorLogFile = (0, path_1.resolve)(process.cwd(), `contentful-import-error-log-${options.spaceId}-${(0, format_1.default)(options.startTime, "yyyy-MM-dd'T'HH-mm-ss")}.json`);
+    }
+    else {
+        options.errorLogFile = (0, path_1.resolve)(process.cwd(), options.errorLogFile);
+    }
+    options.accessToken = options.managementToken;
+    if (!options.content) {
+        // using a stream parser allows input files > 512 MB
+        const fileStream = fs_1.default.createReadStream(options.contentFile, { encoding: 'utf8' });
+        options.content = await (0, json_ext_1.parseChunked)(fileStream);
+    }
+    // Clean up content to only include supported entity types
+    Object.keys(options.content).forEach((type) => {
+        if (SUPPORTED_ENTITY_TYPES.indexOf(type) === -1) {
+            delete options.content[type];
+        }
     });
-    options.content = await (0, _jsonExt.parseChunked)(fileStream);
-  }
-
-  // Clean up content to only include supported entity types
-  Object.keys(options.content).forEach(type => {
-    if (SUPPORTED_ENTITY_TYPES.indexOf(type) === -1) {
-      delete options.content[type];
+    SUPPORTED_ENTITY_TYPES.forEach((type) => {
+        options.content[type] = options.content[type] || [];
+    });
+    if (typeof options.proxy === 'string') {
+        options.proxy = (0, proxy_1.proxyStringToObject)(options.proxy);
+    }
+    if (!options.rawProxy && options.proxy) {
+        options.httpsAgent = (0, proxy_1.agentFromProxy)(options.proxy);
+        delete options.proxy;
     }
-  });
-  SUPPORTED_ENTITY_TYPES.forEach(type => {
-    options.content[type] = options.content[type] || [];
-  });
-  if (typeof options.proxy === 'string') {
-    options.proxy = (0, _proxy.proxyStringToObject)(options.proxy);
-  }
-  if (!options.rawProxy && options.proxy) {
-    options.httpsAgent = (0, _proxy.agentFromProxy)(options.proxy);
-    delete options.proxy;
-  }
-  options.application = options.managementApplication || `contentful.import/${_package.version}`;
-  options.feature = options.managementFeature || 'library-import';
-  return options;
+    options.application = options.managementApplication || `contentful.import/${package_1.version}`;
+    options.feature = options.managementFeature || 'library-import';
+    return options;
 }
-module.exports = exports.default;
+exports.default = parseOptions;