contentful-export 7.14.58 → 7.16.0

package/bin/contentful-export

@@ -1,11 +1,14 @@
 #!/usr/bin/env node
+
+// eslint-disable-next-line
 const runContentfulExport = require('../dist/index')
+// eslint-disable-next-line
 const usageParams = require('../dist/usageParams')
 
 console.log('We moved the CLI version of this tool into our Contentful CLI.\nThis allows our users to use and install only one single CLI tool to get the full Contentful experience.\nFor more info please visit https://github.com/contentful/contentful-cli/tree/master/docs/space/export')
 
 runContentfulExport(usageParams)
-  .then((result) => {
+  .then(() => {
     process.exit(0)
   })
   .catch((err) => {

package/dist/index.js

@@ -104,7 +104,7 @@ function runContentfulExport(params) {
     skip: ctx => !options.downloadAssets || !Object.prototype.hasOwnProperty.call(ctx.data, 'assets')
   }, {
     title: 'Write export log file',
-    task: ctx => {
+    task: () => {
       return new _listr.default([{
         title: 'Lookup directory to store the logs',
         task: ctx => {
@@ -116,7 +116,7 @@ function runContentfulExport(params) {
         }
       }, {
         title: 'Create log directory',
-        task: ctx => {
+        task: () => {
           return (0, _mkdirp.default)(options.exportDir);
         },
         skip: ctx => !ctx.logDirectoryExists

package/dist/tasks/download-assets.js

@@ -11,9 +11,13 @@ var _bluebird = _interopRequireDefault(require("bluebird"));
 
 var _figures = _interopRequireDefault(require("figures"));
 
-var _fsExtra = _interopRequireDefault(require("fs-extra"));
+var _fs = require("fs");
 
-var _request = _interopRequireDefault(require("request"));
+var _nodeFetch = _interopRequireDefault(require("node-fetch"));
+
+var _stream = require("stream");
+
+var _util = require("util");
 
 var _embargoedAssets = require("../utils/embargoedAssets");
 
@@ -21,38 +25,37 @@ var _getEntityName = _interopRequireDefault(require("contentful-batch-libs/dist/
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-function downloadAsset({
+const streamPipeline = (0, _util.promisify)(_stream.pipeline);
+
+async function downloadAsset({
   url,
   directory
 }) {
-  return new _bluebird.default(function (resolve, reject) {
-    // handle urls without protocol
-    if (url.startsWith('//')) {
-      url = 'https:' + url;
-    } // build local file path from the url for the download
-
+  // handle urls without protocol
+  if (url.startsWith('//')) {
+    url = 'https:' + url;
+  } // build local file path from the url for the download
 
-    const parsedUrl = new URL(url);
 
-    const localFile = _path.default.join(directory, parsedUrl.host, parsedUrl.pathname); // ensure directory exists and create file stream
+  const parsedUrl = new URL(url);
 
+  const localFile = _path.default.join(directory, parsedUrl.host, parsedUrl.pathname); // ensure directory exists and create file stream
 
-    _fsExtra.default.mkdirsSync(_path.default.dirname(localFile));
 
-    const file = _fsExtra.default.createWriteStream(localFile); // download asset
+  await _fs.promises.mkdir(_path.default.dirname(localFile), {
+    recursive: true
+  });
+  const file = (0, _fs.createWriteStream)(localFile); // download asset
 
+  const assetRequest = await (0, _nodeFetch.default)(url);
 
-    const assetRequest = _request.default.get(url); // pipe response content to file
+  if (!assetRequest.ok) {
+    throw new Error(`error response status: ${assetRequest.status}`);
+  } // Wait for stream to be consumed before returning local file
 
 
-    assetRequest.on('error', err => {
-      reject(err);
-    }).on('response', response => {
-      if (response.statusCode >= 400) {
-        reject(new Error('error response status: ' + response.statusCode));
-      }
-    }).pipe(file).on('finish', () => resolve(localFile));
-  });
+  await streamPipeline(assetRequest.body, file);
+  return localFile;
 }
 
 function downloadAssets(options) {

package/dist/tasks/get-space-data.js

@@ -47,7 +47,7 @@ function getFullSourceSpace({
   };
   return new _listr.default([{
     title: 'Connecting to space',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       return client.getSpace(spaceId).then(space => {
         ctx.space = space;
         return space.getEnvironment(environmentId);
@@ -57,7 +57,7 @@ function getFullSourceSpace({
     })
   }, {
     title: 'Fetching content types data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       return pagedGet({
         source: ctx.environment,
         method: 'getContentTypes'
@@ -68,20 +68,20 @@ function getFullSourceSpace({
     skip: () => skipContentModel
   }, {
     title: 'Fetching tags data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       return pagedGet({
         source: ctx.environment,
         method: 'getTags'
       }).then(extractItems).then(items => {
         ctx.data.tags = items;
-      }).catch(e => {
+      }).catch(() => {
         ctx.data.tags = [];
       });
     }),
     skip: () => cdaClient
   }, {
     title: 'Fetching editor interfaces data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       return getEditorInterfaces(ctx.data.contentTypes).then(editorInterfaces => {
         ctx.data.editorInterfaces = editorInterfaces.filter(editorInterface => {
           return editorInterface !== null;
@@ -91,7 +91,7 @@ function getFullSourceSpace({
     skip: ctx => skipContentModel || skipEditorInterfaces || ctx.data.contentTypes.length === 0 && 'Skipped since no content types downloaded'
   }, {
     title: 'Fetching content entries data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       const source = cdaClient || ctx.environment;
 
       if (cdaClient) {
@@ -112,7 +112,7 @@ function getFullSourceSpace({
     skip: () => skipContent
   }, {
     title: 'Fetching assets data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       const source = cdaClient || ctx.environment;
       queryAssets = queryAssets || {};
       queryAssets.locale = '*';
@@ -127,7 +127,7 @@ function getFullSourceSpace({
     skip: () => skipContent
   }, {
     title: 'Fetching locales data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       return pagedGet({
         source: ctx.environment,
         method: 'getLocales'
@@ -138,7 +138,7 @@ function getFullSourceSpace({
     skip: () => skipContentModel
   }, {
     title: 'Fetching webhooks data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       return pagedGet({
         source: ctx.space,
         method: 'getWebhooks'
@@ -149,7 +149,7 @@ function getFullSourceSpace({
     skip: () => skipWebhooks || environmentId !== 'master' && 'Webhooks can only be exported from master environment'
   }, {
     title: 'Fetching roles data',
-    task: (0, _listr2.wrapTask)((ctx, task) => {
+    task: (0, _listr2.wrapTask)(ctx => {
       return pagedGet({
         source: ctx.space,
         method: 'getRoles'
@@ -162,7 +162,7 @@ function getFullSourceSpace({
 }
 
 function getEditorInterfaces(contentTypes) {
-  return _bluebird.default.map(contentTypes, (contentType, index, length) => {
+  return _bluebird.default.map(contentTypes, contentType => {
     return contentType.getEditorInterface().then(editorInterface => {
       _logging.logEmitter.emit('info', `Fetched editor interface for ${contentType.name}`);
 

package/dist/usageParams.js

@@ -5,11 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-const yargs = require('yargs');
+var _yargs = _interopRequireDefault(require("yargs"));
 
-const packageFile = require('../package');
+var _package = _interopRequireDefault(require("../package"));
 
-var _default = yargs.version(packageFile.version || 'Version only available on installed package').usage('Usage: $0 [options]').option('space-id', {
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var _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',
   type: 'string',
   demand: true
@@ -98,5 +100,6 @@ var _default = yargs.version(packageFile.version || 'Version only available on i
   type: 'string',
   describe: 'Pass an additional HTTP Header'
 }).config('config', 'An optional configuration JSON file containing all the options for a single run').argv;
+
 exports.default = _default;
 module.exports = exports.default;

package/dist/utils/embargoedAssets.js

@@ -7,32 +7,30 @@ exports.calculateExpiryTimestamp = calculateExpiryTimestamp;
 exports.isEmbargoedAsset = isEmbargoedAsset;
 exports.signUrl = signUrl;
 
-var _requestPromise = _interopRequireDefault(require("request-promise"));
-
 var _jsonwebtoken = _interopRequireDefault(require("jsonwebtoken"));
 
+var _nodeFetch = _interopRequireDefault(require("node-fetch"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const SIX_HOURS_IN_MS = 6 * 60 * 60 * 1000;
 const assetKeyCache = new Map();
 
 function createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs) {
-  const options = {
+  return (0, _nodeFetch.default)(`https://${host}/spaces/${spaceId}/environments/${environmentId}/asset_keys`, {
     method: 'POST',
-    uri: `https://${host}/spaces/${spaceId}/environments/${environmentId}/asset_keys`,
-    body: {
+    body: JSON.stringify({
       expiresAt: Math.floor(expiresAtMs / 1000) // in seconds
 
-    },
+    }),
     headers: {
-      Authorization: `Bearer ${accessToken}`
-    },
-    json: true
-  };
-  return (0, _requestPromise.default)(options);
+      Authorization: `Bearer ${accessToken}`,
+      'Content-Type': 'application/json'
+    }
+  });
 }
 
-function createCachedAssetKey(host, accessToken, spaceId, environmentId, minExpiresAtMs) {
+async function createCachedAssetKey(host, accessToken, spaceId, environmentId, minExpiresAtMs) {
   const cacheKey = `${host}:${spaceId}:${environmentId}`;
   let cacheItem = assetKeyCache.get(cacheKey);
 
@@ -43,7 +41,14 @@ function createCachedAssetKey(host, accessToken, spaceId, environmentId, minExpi
       throw new Error(`Cannot fetch an asset key so far in the future: ${minExpiresAtMs} > ${expiresAtMs}`);
     }
 
-    const promise = createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs).catch(err => {
+    try {
+      const assetKeyPromise = createAssetKey(host, accessToken, spaceId, environmentId, expiresAtMs);
+      cacheItem = {
+        expiresAtMs,
+        promise: assetKeyPromise
+      };
+      assetKeyCache.set(cacheKey, cacheItem);
+    } catch (err) {
       // If we encounter an error, make sure to clear the cache item if this is the most recent fetch.
       const curCacheItem = assetKeyCache.get(cacheKey);
 
@@ -52,15 +57,12 @@ function createCachedAssetKey(host, accessToken, spaceId, environmentId, minExpi
       }
 
       return Promise.reject(err);
-    });
-    cacheItem = {
-      expiresAtMs,
-      promise
-    };
-    assetKeyCache.set(cacheKey, cacheItem);
-  }
+    }
+  } // cacheItem.promise is the return type of node-fetch.
+
 
-  return cacheItem.promise;
+  const response = await cacheItem.promise;
+  return response.json();
 }
 
 function generateSignedToken(secret, urlWithoutQueryParams, expiresAtMs) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-export",
-  "version": "7.14.58",
+  "version": "7.16.0",
   "description": "this tool allows you to export a space to a JSON dump",
   "main": "dist/index.js",
   "types": "types.d.ts",
@@ -14,7 +14,7 @@
     "build": "npm run clean && babel lib --out-dir dist",
     "build:watch": "babel lib --out-dir dist --watch",
     "clean": "rimraf dist && rimraf coverage",
-    "lint": "eslint lib bin/*",
+    "lint": "eslint lib bin/* types.d.ts",
     "pretest": "npm run lint && npm run build && rimraf ./test/integration/tmp",
     "test": "npm run test:unit && npm run test:integration",
     "test:unit": "jest --testPathPattern=test/unit --coverage",
@@ -50,7 +50,6 @@
     "contentful-batch-libs": "^9.2.1",
     "contentful-management": "^10.0.0",
     "figures": "^3.2.0",
-    "fs-extra": "^10.0.0",
     "jsonwebtoken": "^8.5.1",
     "listr": "^0.14.1",
     "listr-update-renderer": "^0.5.0",
@@ -58,8 +57,7 @@
     "lodash": "^4.17.10",
     "mkdirp": "^1.0.3",
     "moment": "^2.22.2",
-    "request": "^2.87.0",
-    "request-promise": "^4.2.6",
+    "node-fetch": "^2.6.7",
     "yargs": "^17.1.1"
   },
   "devDependencies": {
@@ -70,7 +68,7 @@
     "@babel/template": "^7.0.0",
     "@babel/types": "^7.0.0",
     "@types/jest": "^27.0.2",
-    "babel-eslint": "^10.1.0",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
     "babel-jest": "^28.0.0",
     "babel-plugin-add-module-exports": "^1.0.2",
     "cz-conventional-changelog": "^3.3.0",

package/types.d.ts

@@ -28,10 +28,9 @@ export interface Options {
   skipRoles?: boolean;
   skipWebhooks?: boolean;
   useVerboseRenderer?: boolean;
-};
-
+}
 
 type ContentfulExportField = 'contentTypes' | 'entries' | 'assets' | 'locales' | 'tags' | 'webhooks' | 'roles' | 'editorInterfaces';
 
-declare const runContentfulExport: (params: Options) => Promise<Record<ContentfulExportField, unknown[]>>;
-export default runContentfulExport;
+declare const runContentfulExport: (params: Options) => Promise<Record<ContentfulExportField, unknown[]>>
+export default runContentfulExport