contentful-management 11.64.0-new-beta.5 → 11.65.0

package/README.md

@@ -46,19 +46,20 @@
 - [Supported Environments](#supported-environments)
 - [Getting Started](#getting-started)
   - [Installation](#installation)
-    - [Node](#node)
-    - [Browser](#browser-bundle-in-script-tag)
+    - [Node](#node-)
+    - [Browser](#browser-)
     - [Typings](#typings)
   - [Authentication](#authentication)
   - [Using ES6 import](#using-es6-import)
   - [Your first Request](#your-first-request)
-  - [Legacy Client Interface](#legacy-client-interface)
+  - [Alternative plain API](#alternative-plain-api)
 - [App Framework](#app-framework)
 - [Troubleshooting](#troubleshooting)
 - [Documentation/References](#documentationreferences)
   - [Configuration](#configuration)
   - [Reference Documentation](#reference-documentation)
   - [Contentful Javascript resources](#contentful-javascript-resources)
+  - [Cursor Based Pagination](#cursor-based-pagination)
   - [REST API reference](#rest-api-reference)
 - [Versioning](#versioning)
 - [Reach out to us](#reach-out-to-us)
@@ -79,13 +80,13 @@
 
 Browsers and Node.js:
 
-- Chrome v110+
-- Firefox v110+
-- Edge v110+
-- Safari v16.4+
-- Node.js (LTS)
+- Chrome
+- Firefox
+- Edge
+- Safari
+- node.js (LTS)
 
-Other browsers might work (if they support ES2023), but at the moment we only support the browsers and Node.js versions specified above in 'contentful-management' v12+.
+Other browsers should also work, but at the moment we're only running automated tests on the browsers and Node.js versions specified above.
 
 # Getting started
 
@@ -94,7 +95,6 @@ To get started with the Contentful Management JS library you'll need to install
 - [Installation](#installation)
 - [Authentication](#authentication)
 - [Using ES6 import](#using-es6-import)
-- [Using CommonJS require imports](#using-commonjs-require-imports)
 - [Your first request](#your-first-request)
 - [Troubleshooting](#troubleshooting)
 - [Documentation/References](#documentationreferences)
@@ -115,32 +115,32 @@ Using [yarn](https://yarnpkg.com/lang/en/):
 yarn add contentful-management
 ```
 
-### Browser bundle in script tag:
+### Browser:
 
-For most modern web applications, we recommend to download and install the library via npm or yarn as described above.
+For browsers, we recommend to download the library via npm or yarn to ensure 100% availability.
 
-However, if you need to include contentful-management via a script tag, we recommend using [jsDelivr](https://www.jsdelivr.com/package/npm/contentful-management) like so:
+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:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/contentful-management@12"></script>
+<script src="https://cdn.jsdelivr.net/npm/contentful-management@latest/dist/contentful-management.browser.min.js"></script>
 ```
 
-> It is recommended to specify the version in the URL.
-> Using 'contentful@{major-version-number}'' will always get you the latest version in that release, but you can also specify a specific version number, ie: 'contentful@11.6.1'
+**It's not recommended to use the above URL for production.**
 
-The Contentful Management library will be accessible via the `contentfulManagement` global variable:
+Using `contentful@latest` will always get you the latest version, but you can also specify a specific version number:
 
-```js
-const client = contentfulManagement.createClient({
-  accessToken: 'YOUR_ACCESS_TOKEN',
-})
+```html
+<!-- Avoid using the following url for production. You can not rely on its availability. -->
+<script src="https://cdn.jsdelivr.net/npm/contentful-management@7.3.0/dist/contentful-management.browser.min.js"></script>
 ```
 
+The Contentful Management library will be accessible via the `contentfulManagement` global variable.
+
 Check the [releases](https://github.com/contentful/contentful-management.js/releases) page to know which versions are available.
 
 ## Typings
 
-This library is built in TypeScript and has fully typings available.
+This library also comes with typings to use with typescript.
 
 ## Authentication
 
@@ -156,24 +156,7 @@ You can use the es6 import with the library as follows
 
 ```js
 // import createClient directly
-import { createClient } from 'contentful-management'
-const client = createClient(
-  {
-    // This is the access token for this space. Normally you get the token in the Contentful web app
-    accessToken: 'YOUR_ACCESS_TOKEN',
-  },
-  { type: 'plain' }
-)
-//....
-```
-
-## Using CommonJS require imports
-
-You can use the commonjs require with the library as follows
-
-```js
-// import createClient directly
-const contentful = require('contentful-management');
+import contentful from 'contentful-management'
 const client = contentful.createClient(
   {
     // This is the access token for this space. Normally you get the token in the Contentful web app
@@ -189,8 +172,8 @@ const client = contentful.createClient(
 Beginning with `contentful-management@7` this library provides a client which exposes all CMA endpoints in a simple flat API surface, as opposed to the waterfall structure exposed by legacy versions of the SDK.
 
 ```javascript
-import { createClient } from 'contentful-management'
-const plainClient = createClient(
+const contentful = require('contentful-management')
+const plainClient = contentful.createClient(
   {
     accessToken: 'YOUR_ACCESS_TOKEN',
   },
@@ -212,7 +195,7 @@ const entries = await plainClient.entry.getMany({
 })
 
 // With scoped space and environment
-const scopedPlainClient = createClient(
+const scopedPlainClient = contentful.createClient(
   {
     accessToken: 'YOUR_ACCESS_TOKEN',
   },
@@ -233,8 +216,8 @@ const entries = await scopedPlainClient.entry.getMany({
   },
 })
 ```
- 
-You can try and change the above example on [Runkit](https://npm.runkit.com/contentful-management). 
+
+You can try and change the above example on [Runkit](https://npm.runkit.com/contentful-management).
 
 The benefits of using the "plain" version of the client, over the legacy version, are:
 
@@ -244,13 +227,32 @@ The benefits of using the "plain" version of the client, over the legacy version
 - The ability to scope CMA client instance to a specific `spaceId`, `environmentId`, and `organizationId` when initializing the client.
   - You can pass a concrete values to `defaults` and omit specifying these params in actual CMA methods calls.
 
+## Cursor Based Pagination
+
+Cursor-based pagination is supported on collection endpoints for content types, entries, and assets. To use cursor-based pagination, use the related entity methods `getAssetsWithCursor`, `getContentTypesWithCursor`, and `getEntriesWithCursor`
+
+```js
+const response = await environment.getEntriesWithCursor({ limit: 10 });
+console.log(response.items); // Array of items
+console.log(response.pages?.next); // Cursor for next page
+```
+Use the value from `response.pages.next` to fetch the next page.
+
+```js
+const secondPage = await environment.getEntriesWithCursor({
+  limit: 2,
+  pageNext: response.pages?.next,
+});
+console.log(secondPage.items); // Array of items
+```
+
 ## Legacy Client Interface
 
 The following code snippet is an example of the legacy client interface, which reads and writes data as a sequence of nested requests:
 
 ```js
-import { createClient } from 'contentful-management'
-const client = createClient({
+const contentful = require('contentful-management')
+const client = contentful.createClient({
   accessToken: 'YOUR_ACCESS_TOKEN',
 })
 
@@ -326,7 +328,7 @@ To help you get the most out of this library, we've prepared reference documenta
 The `createClient` method supports several options you may set to achieve the expected behavior:
 
 ```js
-createClient({
+contentful.createClient({
   ... your config here ...
 })
 ```