contentful-export 7.20.0 → 7.21.0

package/dist/index.js

@@ -170,7 +170,9 @@ function runContentfulExport(params) {
       return (0, _contentfulBatchLibs.writeErrorLogFile)(options.errorLogFile, errorLog).then(() => {
         const multiError = new Error('Errors occured');
         multiError.name = 'ContentfulMultiError';
-        multiError.errors = errorLog;
+        Object.assign(multiError, {
+          errors: errorLog
+        });
         throw multiError;
       });
     }

package/dist/parseOptions.js

@@ -8,7 +8,7 @@ var _contentfulBatchLibs = require("contentful-batch-libs");
 var _format = require("date-fns/format");
 var _path = require("path");
 var _querystring = _interopRequireDefault(require("querystring"));
-var _package = require("../package");
+var _package = require("../package.json");
 var _headers = require("./utils/headers");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 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; }
@@ -48,11 +48,6 @@ function parseOptions(params) {
   if (!options.managementToken) {
     throw new Error('The `managementToken` option is required.');
   }
-  const proxySimpleExp = /.+:\d+/;
-  const proxyAuthExp = /.+:.+@.+:\d+/;
-  if (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();
   options.contentFile = options.contentFile || `contentful-export-${options.spaceId}-${options.environmentId}-${(0, _format.format)(options.startTime, "yyyy-MM-dd'T'HH-mm-ss")}.json`;
   options.logFilePath = (0, _path.resolve)(options.exportDir, options.contentFile);
@@ -64,12 +59,19 @@ function parseOptions(params) {
 
   // Further processing
   options.accessToken = options.managementToken;
-  if (typeof options.proxy === 'string') {
-    options.proxy = (0, _contentfulBatchLibs.proxyStringToObject)(options.proxy);
-  }
-  if (!options.rawProxy && options.proxy) {
-    options.httpsAgent = (0, _contentfulBatchLibs.agentFromProxy)(options.proxy);
-    delete options.proxy;
+  if (options.proxy) {
+    if (typeof options.proxy === 'string') {
+      const proxySimpleExp = /.+:\d+/;
+      const proxyAuthExp = /.+:.+@.+:\d+/;
+      if (!(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.proxy = (0, _contentfulBatchLibs.proxyStringToObject)(options.proxy);
+    }
+    if (!options.rawProxy) {
+      options.httpsAgent = (0, _contentfulBatchLibs.agentFromProxy)(options.proxy);
+      delete options.proxy;
+    }
   }
   if (options.queryEntries && options.queryEntries.length > 0) {
     const querystr = options.queryEntries.join('&');

package/dist/tasks/download-assets.js

@@ -8,16 +8,24 @@ var _bluebird = _interopRequireDefault(require("bluebird"));
 var _contentfulBatchLibs = require("contentful-batch-libs");
 var _figures = _interopRequireDefault(require("figures"));
 var _fs = require("fs");
-var _nodeFetch = _interopRequireDefault(require("node-fetch"));
 var _path = _interopRequireDefault(require("path"));
 var _stream = require("stream");
 var _util = require("util");
 var _embargoedAssets = require("../utils/embargoedAssets");
+var _axios = _interopRequireDefault(require("axios"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const streamPipeline = (0, _util.promisify)(_stream.pipeline);
+
+/**
+ * @param {Object} options - The options for downloading the asset.
+ * @param {string} options.url - The URL of the asset to download.
+ * @param {string} options.directory - The directory where the asset should be saved.
+ * @param {import('axios').AxiosInstance} options.httpClient - The HTTP client to use for downloading the asset.
+ */
 async function downloadAsset({
   url,
-  directory
+  directory,
+  httpClient
 }) {
   // handle urls without protocol
   if (url.startsWith('//')) {
@@ -33,22 +41,35 @@ async function downloadAsset({
     recursive: true
   });
   const file = (0, _fs.createWriteStream)(localFile);
+  try {
+    // download asset
+    const assetRequest = await httpClient.get(url, {
+      responseType: 'blob'
+    });
 
-  // download asset
-  const assetRequest = await (0, _nodeFetch.default)(url);
-  if (!assetRequest.ok) {
-    throw new Error(`error response status: ${assetRequest.status}`);
+    // Wait for stream to be consumed before returning local file
+    await streamPipeline(assetRequest.data, file);
+    return localFile;
+  } catch (e) {
+    /**
+     * @type {import('axios').AxiosError}
+     */
+    const axiosError = e;
+    throw new Error(`error response status: ${axiosError.response.status}`);
   }
-
-  // Wait for stream to be consumed before returning local file
-  await streamPipeline(assetRequest.body, file);
-  return localFile;
 }
 function downloadAssets(options) {
   return (ctx, task) => {
     let successCount = 0;
     let warningCount = 0;
     let errorCount = 0;
+    const httpClient = _axios.default.create({
+      headers: options.headers,
+      timeout: options.timeout,
+      httpAgent: options.httpAgent,
+      httpsAgent: options.httpsAgent,
+      proxy: options.proxy
+    });
     return _bluebird.default.map(ctx.data.assets, asset => {
       if (!asset.fields.file) {
         task.output = `${_figures.default.warning} asset ${(0, _contentfulBatchLibs.getEntityName)(asset)} has no file(s)`;
@@ -65,7 +86,8 @@ function downloadAssets(options) {
         }
         let startingPromise = _bluebird.default.resolve({
           url,
-          directory: options.exportDir
+          directory: options.exportDir,
+          httpClient
         });
         if ((0, _embargoedAssets.isEmbargoedAsset)(url)) {
           const {
@@ -75,9 +97,10 @@ function downloadAssets(options) {
             environmentId
           } = options;
           const expiresAtMs = (0, _embargoedAssets.calculateExpiryTimestamp)();
-          startingPromise = (0, _embargoedAssets.signUrl)(host, accessToken, spaceId, environmentId, url, expiresAtMs).then(signedUrl => ({
+          startingPromise = (0, _embargoedAssets.signUrl)(host, accessToken, spaceId, environmentId, url, expiresAtMs, httpClient).then(signedUrl => ({
             url: signedUrl,
-            directory: options.exportDir
+            directory: options.exportDir,
+            httpClient
           }));
         }
         return startingPromise.then(downloadAsset).then(downLoadedFile => {

package/dist/usageParams.js

@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _yargs = _interopRequireDefault(require("yargs"));
-var _package = _interopRequireDefault(require("../package"));
+var _package = _interopRequireDefault(require("../package.json"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 var _default = exports.default = _yargs.default.version(_package.default.version || 'Version only available on installed package').usage('Usage: $0 [options]').option('space-id', {
   describe: 'ID of Space with source data',

package/dist/utils/embargoedAssets.js

@@ -8,14 +8,22 @@ exports.isEmbargoedAsset = isEmbargoedAsset;
 exports.shouldCreateNewCacheItem = void 0;
 exports.signUrl = signUrl;
 var _jsonwebtoken = _interopRequireDefault(require("jsonwebtoken"));
-var _nodeFetch = _interopRequireDefault(require("node-fetch"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const SIX_HOURS_IN_MS = 6 * 60 * 60 * 1000;
 const assetKeyCache = new Map();
-function createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs) {
-  return (0, _nodeFetch.default)(`https://${host}/spaces/${spaceId}/environments/${environmentId}/asset_keys`, {
+
+/**
+ * @param {string} host - The Contentful API host.
+ * @param {string} accessToken - The access token for the Contentful API.
+ * @param {string} spaceId - The ID of the Contentful space.
+ * @param {string} environmentId - The ID of the Contentful environment.
+ * @param {number} expiresAtMs - The expiration time in milliseconds.
+ * @param {import('axios').AxiosInstance} httpClient - The HTTP client to use for requests.
+ */
+function createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs, httpClient) {
+  return httpClient(`https://${host}/spaces/${spaceId}/environments/${environmentId}/asset_keys`, {
     method: 'POST',
-    body: JSON.stringify({
+    data: JSON.stringify({
       expiresAt: Math.floor(expiresAtMs / 1000) // in seconds
     }),
     headers: {
@@ -26,7 +34,7 @@ function createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs)
 }
 const shouldCreateNewCacheItem = (cacheItem, currentExpiresAtMs) => !cacheItem || currentExpiresAtMs - cacheItem.expiresAtMs > SIX_HOURS_IN_MS;
 exports.shouldCreateNewCacheItem = shouldCreateNewCacheItem;
-async function createCachedAssetKey(host, accessToken, spaceId, environmentId, minExpiresAtMs) {
+async function createCachedAssetKey(host, accessToken, spaceId, environmentId, minExpiresAtMs, httpClient) {
   const cacheKey = `${host}:${spaceId}:${environmentId}`;
   let cacheItem = assetKeyCache.get(cacheKey);
   if (shouldCreateNewCacheItem(cacheItem, minExpiresAtMs)) {
@@ -35,12 +43,10 @@ async function createCachedAssetKey(host, accessToken, spaceId, environmentId, m
       throw new Error(`Cannot fetch an asset key so far in the future: ${minExpiresAtMs} > ${expiresAtMs}`);
     }
     try {
-      const assetKeyPromise = createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs);
-      const resolvedAssetKeyPromise = await assetKeyPromise;
-      const result = await resolvedAssetKeyPromise.json();
+      const assetKeyResponse = await createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs, httpClient);
       cacheItem = {
         expiresAtMs,
-        result
+        result: assetKeyResponse.data
       };
       assetKeyCache.set(cacheKey, cacheItem);
     } catch (err) {
@@ -79,12 +85,22 @@ function isEmbargoedAsset(url) {
 function calculateExpiryTimestamp() {
   return Date.now() + SIX_HOURS_IN_MS;
 }
-function signUrl(host, accessToken, spaceId, environmentId, url, expiresAtMs) {
+
+/**
+ * @param {string} host - The Contentful API host.
+ * @param {string} accessToken - The access token for the Contentful API.
+ * @param {string} spaceId - The ID of the Contentful space.
+ * @param {string} environmentId - The ID of the Contentful environment.
+ * @param {string} url - The URL to be signed.
+ * @param {number} expiresAtMs - The expiration time in milliseconds.
+ * @param {import('axios').AxiosInstance} httpClient - The HTTP client to use for requests.
+ */
+function signUrl(host, accessToken, spaceId, environmentId, url, expiresAtMs, httpClient) {
   // handle urls without protocol
   if (url.startsWith('//')) {
     url = 'https:' + url;
   }
-  return createCachedAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs).then(({
+  return createCachedAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs, httpClient).then(({
     policy,
     secret
   }) => generateSignedUrl(policy, secret, url, expiresAtMs));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-export",
-  "version": "7.20.0",
+  "version": "7.21.0",
   "description": "this tool allows you to export a space to a JSON dump",
   "main": "dist/index.js",
   "types": "types.d.ts",
@@ -11,8 +11,9 @@
     "contentful-export": "./bin/contentful-export"
   },
   "scripts": {
-    "build": "npm run clean && babel lib --out-dir dist",
+    "build": "npm run clean && npm run check && babel lib --out-dir dist",
     "build:watch": "babel lib --out-dir dist --watch",
+    "check": "tsc",
     "clean": "rimraf dist && rimraf coverage",
     "lint": "eslint lib bin/* types.d.ts",
     "lint:fix": "npm run lint -- --fix",
@@ -44,6 +45,7 @@
     "url": "https://github.com/contentful/contentful-export/issues"
   },
   "dependencies": {
+    "axios": "^1.7.8",
     "bfj": "^8.0.0",
     "bluebird": "^3.3.3",
     "cli-table3": "^0.6.0",
@@ -58,7 +60,6 @@
     "listr-verbose-renderer": "^0.6.0",
     "lodash.startcase": "^4.4.0",
     "mkdirp": "^2.0.0",
-    "node-fetch": "^2.6.7",
     "yargs": "^17.1.1"
   },
   "devDependencies": {
@@ -136,5 +137,8 @@
     "coveragePathIgnorePatterns": [
       "usageParams.js"
     ]
+  },
+  "overrides": {
+    "cross-spawn": "^7.0.6"
   }
 }