contentful-management 7.32.0 → 7.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +2 -2
- package/README.md +15 -15
- package/dist/contentful-management.browser.js +1 -1
- package/dist/contentful-management.browser.js.map +1 -1
- package/dist/contentful-management.browser.min.js +1 -1
- package/dist/contentful-management.legacy.js +1 -1
- package/dist/contentful-management.legacy.js.map +1 -1
- package/dist/contentful-management.legacy.min.js +1 -1
- package/dist/contentful-management.node.js +1 -1
- package/dist/contentful-management.node.js.map +1 -1
- package/dist/contentful-management.node.min.js +1 -1
- package/dist/es-modules/contentful-management.js +1 -1
- package/dist/typings/entities/api-key.d.ts +2 -22
- package/dist/typings/entities/app-bundle.d.ts +2 -22
- package/dist/typings/entities/app-definition.d.ts +3 -22
- package/dist/typings/entities/app-installation.d.ts +2 -22
- package/dist/typings/entities/app-upload.d.ts +2 -22
- package/dist/typings/entities/asset.d.ts +2 -22
- package/dist/typings/entities/content-type-fields.d.ts +1 -1
- package/dist/typings/entities/content-type.d.ts +2 -22
- package/dist/typings/entities/editor-interface.d.ts +35 -29
- package/dist/typings/entities/entry.d.ts +2 -22
- package/dist/typings/entities/environment-alias.d.ts +2 -22
- package/dist/typings/entities/environment.d.ts +2 -22
- package/dist/typings/entities/extension.d.ts +5 -23
- package/dist/typings/entities/locale.d.ts +2 -22
- package/dist/typings/entities/organization-membership.d.ts +2 -22
- package/dist/typings/entities/organization.d.ts +2 -22
- package/dist/typings/entities/personal-access-token.d.ts +2 -22
- package/dist/typings/entities/preview-api-key.d.ts +2 -22
- package/dist/typings/entities/release-action.d.ts +2 -22
- package/dist/typings/entities/role.d.ts +2 -22
- package/dist/typings/entities/scheduled-action.d.ts +2 -22
- package/dist/typings/entities/snapshot.d.ts +2 -22
- package/dist/typings/entities/space-member.d.ts +2 -22
- package/dist/typings/entities/space-membership.d.ts +2 -22
- package/dist/typings/entities/space.d.ts +2 -22
- package/dist/typings/entities/tag.d.ts +2 -22
- package/dist/typings/entities/task.d.ts +2 -22
- package/dist/typings/entities/team-membership.d.ts +2 -22
- package/dist/typings/entities/team-space-membership.d.ts +2 -22
- package/dist/typings/entities/team.d.ts +2 -22
- package/dist/typings/entities/usage.d.ts +2 -22
- package/dist/typings/entities/user.d.ts +2 -22
- package/dist/typings/entities/webhook.d.ts +2 -22
- package/dist/typings/export-types.d.ts +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
# [7.
|
|
1
|
+
# [7.34.0](https://github.com/contentful/contentful-management.js/compare/v7.33.1...v7.34.0) (2021-08-31)
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
### Features
|
|
5
5
|
|
|
6
|
-
*
|
|
6
|
+
* add shared to app def [EXT-2709] ([#899](https://github.com/contentful/contentful-management.js/issues/899)) ([bc81abc](https://github.com/contentful/contentful-management.js/commit/bc81abcf8b1ba5ef25d47766b8334fcdb992234a))
|
|
7
7
|
|
|
8
8
|
# CHANGELOG
|
|
9
9
|
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# contentful-management.js
|
|
2
2
|
|
|
3
|
-
> JavaScript
|
|
3
|
+
> JavaScript Library for [Contentful's](https://www.contentful.com) Content Management API.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/contentful-management)
|
|
6
6
|
[](https://circleci.com/gh/contentful/contentful-management.js)
|
|
@@ -35,7 +35,7 @@ Other browsers should also work, but at the moment we're only running automated
|
|
|
35
35
|
|
|
36
36
|
# Getting started
|
|
37
37
|
|
|
38
|
-
To get started with the Contentful Management JS
|
|
38
|
+
To get started with the Contentful Management JS library you'll need to install it, and then get credentials which will allow you to access your content in Contentful.
|
|
39
39
|
|
|
40
40
|
- [Installation](#installation)
|
|
41
41
|
- [Authentication](#authentication)
|
|
@@ -62,7 +62,7 @@ yarn add contentful-management
|
|
|
62
62
|
|
|
63
63
|
### Browser:
|
|
64
64
|
|
|
65
|
-
For browsers, we recommend to download the
|
|
65
|
+
For browsers, we recommend to download the library via npm or yarn to ensure 100% availability.
|
|
66
66
|
|
|
67
67
|
If you'd like to use a standalone built file you can use the following script tag or download it from [jsDelivr](https://www.jsdelivr.com/package/npm/contentful-management), under the `dist` directory:
|
|
68
68
|
|
|
@@ -80,7 +80,7 @@ Using `contentful@latest` will always get you the latest version, but you can al
|
|
|
80
80
|
<script src="https://cdn.jsdelivr.net/npm/contentful-management@7.3.0/dist/contentful-management.browser.min.js"></script>
|
|
81
81
|
```
|
|
82
82
|
|
|
83
|
-
The Contentful Management
|
|
83
|
+
The Contentful Management library will be accessible via the `contentfulManagement` global variable.
|
|
84
84
|
|
|
85
85
|
Check the [releases](https://github.com/contentful/contentful-management.js/releases) page to know which versions are available.
|
|
86
86
|
|
|
@@ -92,13 +92,13 @@ This library also comes with typings to use with typescript.
|
|
|
92
92
|
|
|
93
93
|
To get content from Contentful, an app should authenticate with an OAuth bearer token.
|
|
94
94
|
|
|
95
|
-
If you want to use this
|
|
95
|
+
If you want to use this library for a simple tool or a local app that you won't redistribute or make available to other users, you can get an API key for the Management API at our [Authentication page](https://www.contentful.com/developers/docs/references/authentication/).
|
|
96
96
|
|
|
97
|
-
If you'd like to create an app which would make use of this
|
|
97
|
+
If you'd like to create an app which would make use of this library but that would be available for other users, where they could authenticate with their own Contentful credentials, make sure to also check out the section about [Creating an OAuth Application](https://www.contentful.com/developers/docs/references/authentication/#creating-an-oauth-20-application)
|
|
98
98
|
|
|
99
99
|
## Using ES6 import
|
|
100
100
|
|
|
101
|
-
You can use the es6 import with the
|
|
101
|
+
You can use the es6 import with the library as follow
|
|
102
102
|
|
|
103
103
|
```js
|
|
104
104
|
// import createClient directly
|
|
@@ -124,7 +124,7 @@ const client = contentful.createClient({
|
|
|
124
124
|
|
|
125
125
|
## Your first request
|
|
126
126
|
|
|
127
|
-
The following code snippet is the most basic one you can use to get content from Contentful with this
|
|
127
|
+
The following code snippet is the most basic one you can use to get content from Contentful with this library:
|
|
128
128
|
|
|
129
129
|
```js
|
|
130
130
|
const contentful = require('contentful-management')
|
|
@@ -158,7 +158,7 @@ You can try and change the above example at [Tonic](https://tonicdev.com/npm/con
|
|
|
158
158
|
|
|
159
159
|
### Alternative plain API
|
|
160
160
|
|
|
161
|
-
Starting `contentful-management@7` this library provides an alternative plain
|
|
161
|
+
Starting `contentful-management@7` this library provides an alternative plain client which exposes all CMA endpoints in a simple flat manner oppose to a default waterfall structure.
|
|
162
162
|
|
|
163
163
|
```javascript
|
|
164
164
|
const contentful = require('contentful-management')
|
|
@@ -208,7 +208,7 @@ const entries = await scopedPlainClient.entry.getMany({
|
|
|
208
208
|
})
|
|
209
209
|
```
|
|
210
210
|
|
|
211
|
-
The benefits of using the plain version of
|
|
211
|
+
The benefits of using the plain version of the library are:
|
|
212
212
|
|
|
213
213
|
- The ability to reach any possible CMA endpoint without the necessity to call any async functions beforehand.
|
|
214
214
|
- It's especially important if you're using this CMA client for non-linear scripts (for example, a complex Front-end application)
|
|
@@ -219,14 +219,14 @@ The benefits of using the plain version of SDK are:
|
|
|
219
219
|
## Troubleshooting
|
|
220
220
|
|
|
221
221
|
- **I can't Install the package via npm** - Check your internet connection - It is called `contentful-management` and not `contenful-management` ¯\\\_(ツ)\_/¯
|
|
222
|
-
- **Can I use the
|
|
223
|
-
- **I get the error: Unable to resolve module `http`** - Our
|
|
222
|
+
- **Can I use the library in react native projects** - Yes it is possible
|
|
223
|
+
- **I get the error: Unable to resolve module `http`** - Our library is supplied as node and browser version. Most non-node environments, like React Native, act like a browser. To force using of the browser version, you can require it via: `const { createClient } = require('contentful-management/dist/contentful-management.browser.min.js')`
|
|
224
224
|
- **I am not sure what payload to send when creating and entity (Asset/Entity/ContentType etc...)** - Check the Content Management API [docs](https://www.contentful.com/developers/docs/references/content-management-api/) or the examples in the reference [docs](https://contentful.github.io/contentful-management.js) - Feel free to open an issue if you didn't find what you need in the above links
|
|
225
225
|
- 😱 **something is wrong what should I do** - If it is a bug related to the code create a GitHub issue and make sure to remove any credential for your code before sharing it. - If you need to share your credentials, for example you have an issue with your space, please create a support ticket. - Please **do not** share your management token in a GitHub issue
|
|
226
226
|
|
|
227
227
|
## Documentation/References
|
|
228
228
|
|
|
229
|
-
To help you get the most out of this
|
|
229
|
+
To help you get the most out of this library, we've prepared reference documentation, tutorials and other examples that will help you learn and understand how to use this library.
|
|
230
230
|
|
|
231
231
|
### Configuration
|
|
232
232
|
|
|
@@ -276,7 +276,7 @@ Axios proxy configuration. See the [axios request config documentation](https://
|
|
|
276
276
|
|
|
277
277
|
#### retryOnError (default: `true`)
|
|
278
278
|
|
|
279
|
-
By default, this
|
|
279
|
+
By default, this library is retrying requests which resulted in a 500 server error and 429 rate limit response. Set this to `false` to disable this behavior.
|
|
280
280
|
|
|
281
281
|
#### logHandler (default: `function (level, data) {}`)
|
|
282
282
|
|
|
@@ -292,7 +292,7 @@ Interceptor called on every response. Takes Axios response object as an arg. Def
|
|
|
292
292
|
|
|
293
293
|
### Reference documentation
|
|
294
294
|
|
|
295
|
-
The [Contentful's JS
|
|
295
|
+
The [Contentful's JS library reference](https://contentful.github.io/contentful-management.js) documents what objects and methods are exposed by this library, what arguments they expect and what kind of data is returned.
|
|
296
296
|
|
|
297
297
|
Most methods also have examples which show you how to use them.
|
|
298
298
|
|
|
@@ -8823,7 +8823,7 @@ function createClient(params) {
|
|
|
8823
8823
|
var opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
|
|
8824
8824
|
var sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
|
|
8825
8825
|
var userAgent = Object(contentful_sdk_core__WEBPACK_IMPORTED_MODULE_0__["getUserAgentHeader"])( // @ts-expect-error
|
|
8826
|
-
"".concat(sdkMain, "/").concat("7.
|
|
8826
|
+
"".concat(sdkMain, "/").concat("7.34.0"), params.application, params.integration, params.feature);
|
|
8827
8827
|
var adapter = Object(_create_adapter__WEBPACK_IMPORTED_MODULE_1__["createAdapter"])(params); // Parameters<?> and ReturnType<?> only return the types of the last overload
|
|
8828
8828
|
// https://github.com/microsoft/TypeScript/issues/26591
|
|
8829
8829
|
// @ts-expect-error
|