contentful-export 7.22.2 → 7.22.4

package/README.md

@@ -1,11 +1,7 @@
 # Contentful export tool
 
-[![npm](https://img.shields.io/npm/v/contentful-export.svg)](https://www.npmjs.com/package/contentful-export)
-[![Build Status](https://travis-ci.org/contentful/contentful-export.svg?branch=master)](https://travis-ci.org/contentful/contentful-export)
-[![Dependency Status](https://img.shields.io/david/contentful/contentful-export.svg)](https://david-dm.org/contentful/contentful-export)
-[![devDependency Status](https://img.shields.io/david/dev/contentful/contentful-import.svg)](https://david-dm.org/contentful/contentful-export#info=devDependencies)
-
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)
+[![CI](https://github.com/contentful/contentful-export/actions/workflows/main.yaml/badge.svg)](https://github.com/contentful/contentful-export/actions/workflows/main.yaml)
+[![npm](https://img.shields.io/npm/v/contentful-export.svg)](https://www.npmjs.com/package/contentful-export) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 [Contentful](https://www.contentful.com) provides a content infrastructure for digital teams to power content in websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship digital products faster.
 
@@ -14,11 +10,11 @@ This is a library that helps you backup your Content Model, Content and Assets o
 To import your exported data, please refer to the [contentful-import](https://github.com/contentful/contentful-import) repository.
 
 ## :exclamation: Usage as CLI
+
 > We moved the CLI version of this tool into our [Contentful CLI](https://github.com/contentful/contentful-cli). This allows our users to use and install only one single CLI tool to get the full Contentful experience.
 >
 > Please have a look at the [Contentful CLI export command documentation](https://github.com/contentful/contentful-cli/tree/master/docs/space/export) to learn more about how to use this as command line tool.
 
-
 ## :cloud: Pre-requisites && Installation
 
 ### Pre-requisites
@@ -33,6 +29,8 @@ npm install contentful-export
 
 ## :hand: Usage
 
+### CommonJS
+
 ```javascript
 const contentfulExport = require('contentful-export')
 
@@ -51,6 +49,21 @@ contentfulExport(options)
   })
 ```
 
+### ESM
+
+```javascript
+import contentfulExport from 'contentful-export'
+
+const options = {
+  spaceId: '<space_id>',
+  managementToken: '<content_management_api_key>',
+  ...
+}
+
+// contentfulExport returns a Promise so you can use async/await, etc.
+await contentfulExport(options)
+```
+
 ### Querying
 
 To scope your export, you are able to pass query parameters. All search parameters of our API are supported as documented in our [API documentation](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters).
@@ -108,15 +121,19 @@ contentfulExport(options)
 ### Basics
 
 #### `spaceId` [string] [required]
+
 ID of the space with source data
 
 #### `environmentId` [string] [default: 'master']
+
 ID of the environment in the source space
 
 #### `managementToken` [string] [required]
+
 Contentful management API token for the space to be exported
 
 #### `deliveryToken` [string]
+
 Contentful Content Delivery API (CDA) token for the space to be exported.
 
 Providing `deliveryToken` will export both entries and assets from the
@@ -145,17 +162,21 @@ Note: Tags are only available on the Contentful Management API, so they will not
 ### Output
 
 #### `exportDir` [string] [default: current process working directory]
+
 Defines the path for storing the export JSON file
 
 #### `saveFile` [boolean] [default: true]
+
 Save the export as a JSON file
 
 #### `contentFile` [string]
+
 The filename for the exported data
 
 ### Filtering
 
 #### `includeDrafts` [boolean] [default: false]
+
 Include drafts in the exported entries.
 
 The `deliveryToken` option is ignored
@@ -164,67 +185,87 @@ If you want to include drafts, there's no point of getting them through the
 Content Delivery API.
 
 #### `includeArchived` [boolean] [default: false]
+
 Include archived entries in the exported entries
 
 #### `skipContentModel` [boolean] [default: false]
+
 Skip exporting content models
 
 #### `skipEditorInterfaces` [boolean] [default: false]
+
 Skip exporting editor interfaces
 
 #### `skipContent` [boolean] [default: false]
+
 Skip exporting assets and entries.
 
 #### `skipRoles` [boolean] [default: false]
+
 Skip exporting roles and permissions
 
 #### `skipTags` [boolean] [default: false]
+
 Skip exporting tags
 
 #### `skipWebhooks` [boolean] [default: false]
+
 Skip exporting webhooks
 
 #### `stripTags` [boolean] [default: false]
+
 Untag assets and entries
 
 #### `contentOnly` [boolean] [default: false]
+
 Only export entries and assets
 
 #### `queryEntries` [array]
+
 Only export entries that match these queries
 
 #### `queryAssets` [array]
+
 Only export assets that match these queries
 
 #### `downloadAssets` [boolean]
+
 Download actual asset files
 
 ### Connection
 
 #### `host` [string] [default: 'api.contentful.com']
+
 The Management API host
 
 #### `hostDelivery` [string] [default: 'cdn.contentful.com']
+
 The Delivery API host
 
 #### `proxy` [string]
+
 Proxy configuration in HTTP auth format: `host:port` or `user:password@host:port`
 
 #### `rawProxy` [boolean]
+
 Pass proxy config to Axios instead of creating a custom httpsAgent
 
 #### `maxAllowedLimit` [number] [default: 1000]
+
 The number of items per page per request
 
 #### `headers` [object]
-Additional headers to attach to the requests. 
+
+Additional headers to attach to the requests.
 
 ### Other
 
 #### `errorLogFile` [string]
+
 Full path to the error log file
 
 #### `useVerboseRenderer` [boolean] [default: false]
+
 Display progress in new lines instead of displaying a busy spinner and the status in the same line. Useful for CI.
 
 ## :rescue_worker_helmet: Troubleshooting
@@ -259,15 +300,15 @@ contentfulExport({
 If a space is configured to use the [embargoed assets feature](https://www.contentful.com/help/media/embargoed-assets/), certain options will need to be set to use the export/import tooling. When exporting content, the `downloadAssets` option must be set to `true`. This will download the asset files to your local machine. Then, when importing content ([using `contentful-import`](https://github.com/contentful/contentful-import)), the `uploadAssets` option must be set to `true` and the `assetsDirectory` must be set to the directory that contains all of the exported asset folders.
 
 ```javascript
-const contentfulExport = require('contentful-export')
+const contentfulExport = require("contentful-export");
 
 const options = {
-  spaceId: '<space_id>',
-  managementToken: '<content_management_api_key>',
-  downloadAssets: true
-}
+  spaceId: "<space_id>",
+  managementToken: "<content_management_api_key>",
+  downloadAssets: true,
+};
 
-contentfulExport(options)
+contentfulExport(options);
 ```
 
 ## :card_file_box: Exported data structure
@@ -287,7 +328,7 @@ This is an overview of the exported data:
 }
 ```
 
-*Note:* Tags feature is not available for all users. If you do not have access to this feature, the tags array will always be empty.
+_Note:_ Tags feature is not available for all users. If you do not have access to this feature, the tags array will always be empty.
 
 ## :warning: Limitations
 
@@ -300,7 +341,7 @@ This is an overview of the exported data:
 Read the [releases](https://github.com/contentful/contentful-export/releases) page for more information.
 
 ## :scroll: License
- 
+
 This project is licensed under MIT license
 
 [1]: https://www.contentful.com

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-export",
-  "version": "7.22.2",
+  "version": "7.22.4",
   "description": "this tool allows you to export a space to a JSON dump",
   "main": "dist/index.js",
   "types": "types.d.ts",
@@ -46,7 +46,7 @@
   },
   "dependencies": {
     "axios": "^1.13.5",
-    "bfj": "^8.0.0",
+    "bfj": "^9.1.3",
     "bluebird": "^3.3.3",
     "cli-table3": "^0.6.0",
     "contentful": "^11.5.10",