feat(contentful-export): Exprot Drafts

Author: Khaledgarbaya

dist/run-contentful-export.js

@@ -49,6 +49,10 @@ function runContentfulExport(usageParams) {
     opts.sourceSpace = opts.sourceSpace || usageParams.spaceId;
     opts.sourceManagementToken = opts.sourceManagementToken || usageParams.managementToken;
   }
+  if (opts.includeDrafts) {
+    opts.deliveryHost = 'preview.contentful.com';
+    opts.sourceDeliveryToken = opts.previewToken;
+  }
   var clients = (0, _createClients2.default)(opts);
   return (0, _getFullSourceSpace2.default)({
     managementClient: clients.source.management,

dist/usageParams.js

@@ -12,15 +12,22 @@ var opts = yargs.version(packageFile.version || 'Version only available on insta
   describe: 'Management API token for the space to be exported.',
   type: 'string',
   demand: true
+}).option('preview-token', {
+  describe: 'Preview API token for the space to be exported.',
+  type: 'string',
+  demand: true
 }).option('export-dir', {
   describe: 'Defines the path for storing the export json file (default path is the current directory)',
   type: 'string'
 }).option('download-assets', {
   describe: 'With this flags assets will also be downloaded',
   type: 'boolean'
 }).option('max-allowed-limit', {
-  describe: 'how many item per page per request default 1000',
+  describe: 'How many item per page per request default 1000',
   type: 'number'
+}).options('include-drafts', {
+  describe: 'Export Drafts entiries',
+  type: 'boolean'
 }).config('config', 'Configuration file with required values').check(function (argv) {
   if (!argv.spaceId) {
     log.error('Please provide --space-id to be used to export \n' + 'For more info See: https://www.npmjs.com/package/contentful-export');
@@ -30,6 +37,15 @@ var opts = yargs.version(packageFile.version || 'Version only available on insta
     log.error('Please provide --management-token to be used for export \n' + 'For more info See: https://www.npmjs.com/package/contentful-export');
     process.exit(1);
   }
+  if (argv.includeDrafts && !argv.previewToken) {
+    log.error('Please provide a preview API token to be able to get draft or set --include-drafts false');
+    process.exit(1);
+  }
+  if (!argv.includeDrafts && argv.previewToken) {
+    log.error('Please make sure to specify --include-drafts to be able to get drafts');
+    process.exit(1);
+  }
+
   return true;
 }).argv;
 

lib/run-contentful-export.js

@@ -17,6 +17,10 @@ export default function runContentfulExport (usageParams) {
     opts.sourceSpace = opts.sourceSpace || usageParams.spaceId
     opts.sourceManagementToken = opts.sourceManagementToken || usageParams.managementToken
   }
+  if (opts.includeDrafts) {
+    opts.deliveryHost = 'preview.contentful.com'
+    opts.sourceDeliveryToken = opts.previewToken
+  }
   const clients = createClients(opts)
   return getFullSourceSpace({
     managementClient: clients.source.management,

lib/usageParams.js

@@ -15,6 +15,11 @@ const opts = yargs
     type: 'string',
     demand: true
   })
+  .option('preview-token', {
+    describe: 'Preview API token for the space to be exported.',
+    type: 'string',
+    demand: true
+  })
   .option('export-dir', {
     describe: 'Defines the path for storing the export json file (default path is the current directory)',
     type: 'string'
@@ -24,9 +29,13 @@ const opts = yargs
     type: 'boolean'
   })
   .option('max-allowed-limit', {
-    describe: 'how many item per page per request default 1000',
+    describe: 'How many item per page per request default 1000',
     type: 'number'
   })
+  .options('include-drafts', {
+    describe: 'Export Drafts entiries',
+    type: 'boolean'
+  })
   .config('config', 'Configuration file with required values')
   .check(function (argv) {
     if (!argv.spaceId) {
@@ -41,6 +50,15 @@ const opts = yargs
       )
       process.exit(1)
     }
+    if (argv.includeDrafts && !argv.previewToken) {
+      log.error('Please provide a preview API token to be able to get draft or set --include-drafts false')
+      process.exit(1)
+    }
+    if (!argv.includeDrafts && argv.previewToken) {
+      log.error('Please make sure to specify --include-drafts to be able to get drafts')
+      process.exit(1)
+    }
+
     return true
   })
   .argv

package.json

@@ -34,7 +34,7 @@
     "contentful",
     "contentful-export"
   ],
-  "author": "Contentful <opensource@contentful.com>",
+  "author": "Khaled Garbaya <khaled@contentful.com>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/contentful/contentful-export/issues"
@@ -43,7 +43,7 @@
     "bluebird": "^3.3.3",
     "fs-extra": "^0.30.0",
     "request": "^2.78.0",
-    "contentful-batch-libs": "4.5.0",
+    "contentful-batch-libs": "4.7.0",
     "json-stringify-safe": "^5.0.1",
     "lodash": "^4.0.0",
     "npmlog": "^4.0.0",