contentful-management 11.60.3 → 12.0.0-beta.10

package/README.md

@@ -43,29 +43,44 @@
 
 <!-- TOC -->
 
-- [Features](#features)
-- [Supported Environments](#supported-environments)
-- [Getting Started](#getting-started)
+- [Getting started](#getting-started)
   - [Installation](#installation)
-    - [Node](#node-)
-    - [Browser](#browser-)
-    - [Typings](#typings)
+    - [Node:](#node)
+      - [Using in Legacy Environments Without ESM/Import Support](#using-in-legacy-environments-without-esmimport-support)
+    - [Browser:](#browser)
+  - [Typings](#typings)
   - [Authentication](#authentication)
-  - [Using ES6 import](#using-es6-import)
-  - [Your first Request](#your-first-request)
-  - [Alternative plain API](#alternative-plain-api)
-- [App Framework](#app-framework)
-- [Troubleshooting](#troubleshooting)
-- [Documentation/References](#documentationreferences)
+  - [Your first request](#your-first-request)
+  - [Legacy Client Interface](#legacy-client-interface)
+  - [App Framework](#app-framework)
+  - [Troubleshooting](#troubleshooting)
+  - [Documentation/References](#documentationreferences)
   - [Configuration](#configuration)
-  - [Reference Documentation](#reference-documentation)
-  - [Contentful Javascript resources](#contentful-javascript-resources)
-  - [REST API reference](#rest-api-reference)
-- [Versioning](#versioning)
-- [Reach out to us](#reach-out-to-us)
-- [Get involved](#get-involved)
-- [License](#license)
-- [Code of Conduct](#code-of-conduct)
+    - [accessToken (required, when `apiAdapter` is not set)](#accesstoken-required-when-apiadapter-is-not-set)
+    - [host (default: `'api.contentful.com'`)](#host-default-apicontentfulcom)
+    - [hostUpload (default: `'upload.contentful.com'`)](#hostupload-default-uploadcontentfulcom)
+    - [basePath (default: \`\`)](#basepath-default-)
+    - [httpAgent (default: `undefined`)](#httpagent-default-undefined)
+    - [httpsAgent (default: `undefined`)](#httpsagent-default-undefined)
+    - [headers (default: `{}`)](#headers-default-)
+    - [proxy (default: `undefined`)](#proxy-default-undefined)
+    - [retryOnError (default: `true`)](#retryonerror-default-true)
+    - [logHandler (default: `function (level, data) {}`)](#loghandler-default-function-level-data-)
+    - [requestLogger (default: `function (config) {}`)](#requestlogger-default-function-config-)
+    - [responseLogger (default: `function (response) {}`)](#responselogger-default-function-response-)
+    - [apiAdapter (default: `new RestAdapter(configuration)`)](#apiadapter-default-new-restadapterconfiguration)
+    - [throttle (default: `0`)](#throttle-default-0)
+    - [Reference documentation](#reference-documentation)
+    - [Contentful JavaScript resources](#contentful-javascript-resources)
+    - [REST API reference](#rest-api-reference)
+  - [Versioning](#versioning)
+  - [Reach out to us](#reach-out-to-us)
+    - [You have questions about how to use this library?](#you-have-questions-about-how-to-use-this-library)
+    - [You found a bug or want to propose a feature?](#you-found-a-bug-or-want-to-propose-a-feature)
+    - [You need to share confidential information or have other questions?](#you-need-to-share-confidential-information-or-have-other-questions)
+  - [Get involved](#get-involved)
+  - [License](#license)
+  - [Code of Conduct](#code-of-conduct)
 
 <!-- /TOC -->
 </details>
@@ -85,8 +100,17 @@ Browsers and Node.js:
 - Edge
 - Safari
 - node.js (LTS)
+- React Native (Metro bundler)
+
+> For the minimum supported browser versions, refer to the [package.json of this library.](https://github.com/contentful/contentful-management.js/blob/master/package.json#L12)
+
+To ensure compatibility across various JavaScript environments, this library is built as an ECMAScript Module (ESM) by default, using the `"type": "module"` declaration in `package.json`.
+
+We also offer a bundle for the legacy CommonJS (CJS) require syntax, allowing usage in environments that do not support ESM.
 
-Other browsers should also work, but at the moment we're only running automated tests on the browsers and Node.js versions specified above.
+Additionally, there is a bundle available for direct usage within browsers.
+
+For more details on the different variants of this library, see [Installation](#installation).
 
 # Getting started
 
@@ -94,7 +118,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)
 - [Your first request](#your-first-request)
 - [Troubleshooting](#troubleshooting)
 - [Documentation/References](#documentationreferences)
@@ -115,6 +138,36 @@ Using [yarn](https://yarnpkg.com/lang/en/):
 yarn add contentful-management
 ```
 
+In a modern environment, you can import this library using:
+
+```js
+import * as contentful from 'contentful-management'
+```
+
+#### Using in Legacy Environments Without ESM/Import Support
+
+Typically, your system will default to our CommonJS export when you use the require syntax:
+
+```js
+const contentful = require('contentful-management')
+```
+
+If this does not work, you can directly require the CJS-compatible code:
+
+```js
+// pure cjs files
+const contentful = require('contentful-management/dist/cjs/index.cjs')
+
+// node bundle
+const contentful = require('contentful-management/dist/contentful-management.node.cjs')
+
+// react-native bundle
+const contentful = require('contentful-management/dist/contentful-management.react-native.js')
+
+// browser bundle
+const contentful = require('contentful-management/dist/contentful-management.browser.js')
+```
+
 ### Browser:
 
 For browsers, we recommend to download the library via npm or yarn to ensure 100% availability.
@@ -127,11 +180,11 @@ If you'd like to use a standalone built file you can use the following script ta
 
 **It's not recommended to use the above URL for production.**
 
-Using `contentful@latest` will always get you the latest version, but you can also specify a specific version number:
+Using `contentful-management@latest` will always get you the latest version, but you can also specify a specific version number:
 
 ```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>
+<script src="https://cdn.jsdelivr.net/npm/contentful-management@12.0.0/dist/contentful-management.browser.min.js"></script>
 ```
 
 The Contentful Management library will be accessible via the `contentfulManagement` global variable.
@@ -150,34 +203,18 @@ If you want to use this library for a simple tool or a local app that you won't
 
 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)
 
-## Using ES6 import
-
-You can use the es6 import with the library as follows
-
-```js
-// import createClient directly
-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
-    accessToken: 'YOUR_ACCESS_TOKEN',
-  },
-  { type: 'plain' }
-)
-//....
-```
-
 ## Your first request
 
 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
-const contentful = require('contentful-management')
+import * as contentful from 'contentful-management'
+
 const plainClient = contentful.createClient(
   {
     accessToken: 'YOUR_ACCESS_TOKEN',
   },
-  { type: 'plain' }
+  { type: 'plain' },
 )
 
 const environment = await plainClient.environment.get({
@@ -205,7 +242,7 @@ const scopedPlainClient = contentful.createClient(
       spaceId: '<space_id>',
       environmentId: '<environment_id>',
     },
-  }
+  },
 )
 
 // entries from '<space_id>' & '<environment_id>'
@@ -232,7 +269,8 @@ The benefits of using the "plain" version of the client, over the legacy version
 The following code snippet is an example of the legacy client interface, which reads and writes data as a sequence of nested requests:
 
 ```js
-const contentful = require('contentful-management')
+import * as contentful from 'contentful-management'
+
 const client = contentful.createClient({
   accessToken: 'YOUR_ACCESS_TOKEN',
 })
@@ -267,8 +305,8 @@ grants your apps access to the supported space-environment scoped entities witho
 need to expose a management token, and without coding any additional backend middleware.
 
 ```javascript
-const contentfulApp = require('@contentful/app-sdk')
-const contentful = require('contentful-management')
+import contentfulApp from '@contentful/app-sdk'
+import * as contentful from 'contentful-management'
 
 contentfulApp.init((sdk) => {
   const cma = contentful.createClient(
@@ -279,7 +317,7 @@ contentfulApp.init((sdk) => {
         environmentId: sdk.ids.environmentAlias ?? sdk.ids.environment,
         spaceId: sdk.ids.space,
       },
-    }
+    },
   )
 
   // ...rest of initialization code
@@ -294,9 +332,6 @@ contentfulApp.init((sdk) => {
 
 ## Troubleshooting
 
-- **I can't Install the package via npm** - Check your internet connection - It is called `contentful-management` and not `contenful-management` ¯\\\_(ツ)\_/¯
-- **Can I use the library in react native projects** - Yes it is possible
-- **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')`
 - **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
 - 😱 **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
 

package/dist/cjs/adapters/REST/endpoints/access-token.cjs

@@ -0,0 +1,137 @@
+'use strict';
+
+var raw = require('./raw.cjs');
+
+/**
+ * Retrieves an access token by its unique token ID for the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - An Axios HTTP client instance.
+ * @param {Object} params - Parameters for the request.
+ * @param {string} params.tokenId - The unique token ID of the access token to retrieve.
+ * @returns {Promise<AccessTokenProps>} A Promise that resolves with the retrieved access token information.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *   accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.get({tokenId: 'TestTokenTd'})
+ *  .then(token => console.log(token))
+ *  .catch(console.error)
+ * ```
+ */
+const get = (http, params) => {
+    return raw.get(http, `/users/me/access_tokens/${params.tokenId}`);
+};
+/**
+ * Retrieves multiple access tokens associated with the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - An Axios HTTP client instance.
+ * @param {QueryParams} params - Query parameters to filter and customize the request.
+ * @returns {Promise<CollectionProp<AccessTokenProps>>} A Promise that resolves with a collection of access token properties.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.getMany()
+ *  .then(result => console.log(result.items))
+ *  .catch(console.error)
+ * ```
+ */
+const getMany = (http, params) => {
+    return raw.get(http, '/users/me/access_tokens', {
+        params: params.query,
+    });
+};
+/**
+ * Creates a personal access token for the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - Axios instance for making the HTTP request.
+ * @param {Object} _params - Unused parameters (can be an empty object).
+ * @param {CreatePersonalAccessTokenProps} rawData - Data for creating the personal access token.
+ * @param {RawAxiosRequestHeaders} [headers] - Optional HTTP headers for the request.
+ * @returns {Promise<AccessTokenProps>} A Promise that resolves with the created personal access token.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>',
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.createPersonalAccessToken({name: 'Test-Name', scope: ['content_management_manage'], expiresIn: 777596.92})
+ *  .then(token => console.log(token))
+ *  .catch(console.error)
+ * ```
+ */
+const createPersonalAccessToken = (http, _params, rawData, headers) => {
+    return raw.post(http, '/users/me/access_tokens', rawData, {
+        headers,
+    });
+};
+/**
+ * Revokes an access token associated with the currently authenticated user.
+ *
+ * @param {AxiosInstance} http - The Axios HTTP client instance.
+ * @param {Object} params - The parameters for revoking the access token.
+ * @param {string} params.tokenId - The unique identifier of the access token to revoke.
+ * @returns {Promise<AccessTokenProps>} A Promise that resolves with the updated access token information after revocation.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.revoke({tokenId: 'TestTokenTd'})
+ *  .then(token => console.log(token))
+ *  .catch(console.error)
+ * ```
+ */
+const revoke = (http, params) => {
+    return raw.put(http, `/users/me/access_tokens/${params.tokenId}/revoked`, null);
+};
+/**
+ * Retrieves a list of redacted versions of access tokens for an organization, accessible to owners or administrators of an organization.
+ *
+ * @param {AxiosInstance} http - The Axios HTTP client instance.
+ * @param {GetOrganizationParams & QueryParams} params - Parameters for the request, including organization ID and query parameters.
+ * @param {string} params.organizationId - The unique identifier of the organization.
+ * @returns {Promise<CollectionProp<AccessTokenProps>>} A promise that resolves to a collection of access tokens.
+ * @example ```javascript
+ * const contentful = require('contentful-management')
+ *
+ * const plainClient = contentful.createClient(
+ *  {
+ *    accessToken: '<content_management_api_key>'
+ *  },
+ *  { type: 'plain' }
+ * )
+ * plainClient.getManyForOrganization({organizationId: 'OrgId'})
+ *  .then(result => console.log(result.items))
+ *  .catch(console.error)
+ * ```
+ */
+const getManyForOrganization = (http, params) => {
+    return raw.get(http, `/organizations/${params.organizationId}/access_tokens`, {
+        params: params.query,
+    });
+};
+
+exports.createPersonalAccessToken = createPersonalAccessToken;
+exports.get = get;
+exports.getMany = getMany;
+exports.getManyForOrganization = getManyForOrganization;
+exports.revoke = revoke;
+//# sourceMappingURL=access-token.cjs.map

package/dist/cjs/adapters/REST/endpoints/access-token.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"access-token.cjs","sources":["../../../../../lib/adapters/REST/endpoints/access-token.ts"],"sourcesContent":["import type { RawAxiosRequestHeaders } from 'axios'\nimport type { AxiosInstance } from 'contentful-sdk-core'\nimport type { CollectionProp, GetOrganizationParams, QueryParams } from '../../../common-types.js'\nimport type {\n  CreatePersonalAccessTokenProps,\n  AccessTokenProps,\n} from '../../../entities/access-token.js'\nimport type { RestEndpoint } from '../types.js'\nimport * as raw from './raw.js'\n\n/**\n * Retrieves an access token by its unique token ID for the currently authenticated user.\n *\n * @param {AxiosInstance} http - An Axios HTTP client instance.\n * @param {Object} params - Parameters for the request.\n * @param {string} params.tokenId - The unique token ID of the access token to retrieve.\n * @returns {Promise<AccessTokenProps>} A Promise that resolves with the retrieved access token information.\n * @example ```javascript\n * const contentful = require('contentful-management')\n *\n * const plainClient = contentful.createClient(\n *  {\n *   accessToken: '<content_management_api_key>'\n *  },\n *  { type: 'plain' }\n * )\n * plainClient.get({tokenId: 'TestTokenTd'})\n *  .then(token => console.log(token))\n *  .catch(console.error)\n * ```\n */\nexport const get: RestEndpoint<'AccessToken', 'get'> = (\n  http: AxiosInstance,\n  params: { tokenId: string },\n) => {\n  return raw.get<AccessTokenProps>(http, `/users/me/access_tokens/${params.tokenId}`)\n}\n\n/**\n * Retrieves multiple access tokens associated with the currently authenticated user.\n *\n * @param {AxiosInstance} http - An Axios HTTP client instance.\n * @param {QueryParams} params - Query parameters to filter and customize the request.\n * @returns {Promise<CollectionProp<AccessTokenProps>>} A Promise that resolves with a collection of access token properties.\n * @example ```javascript\n * const contentful = require('contentful-management')\n *\n * const plainClient = contentful.createClient(\n *  {\n *    accessToken: '<content_management_api_key>'\n *  },\n *  { type: 'plain' }\n * )\n * plainClient.getMany()\n *  .then(result => console.log(result.items))\n *  .catch(console.error)\n * ```\n */\nexport const getMany: RestEndpoint<'AccessToken', 'getMany'> = (\n  http: AxiosInstance,\n  params: QueryParams,\n) => {\n  return raw.get<CollectionProp<AccessTokenProps>>(http, '/users/me/access_tokens', {\n    params: params.query,\n  })\n}\n\n/**\n * Creates a personal access token for the currently authenticated user.\n *\n * @param {AxiosInstance} http - Axios instance for making the HTTP request.\n * @param {Object} _params - Unused parameters (can be an empty object).\n * @param {CreatePersonalAccessTokenProps} rawData - Data for creating the personal access token.\n * @param {RawAxiosRequestHeaders} [headers] - Optional HTTP headers for the request.\n * @returns {Promise<AccessTokenProps>} A Promise that resolves with the created personal access token.\n * @example ```javascript\n * const contentful = require('contentful-management')\n *\n * const plainClient = contentful.createClient(\n *  {\n *    accessToken: '<content_management_api_key>',\n *  },\n *  { type: 'plain' }\n * )\n * plainClient.createPersonalAccessToken({name: 'Test-Name', scope: ['content_management_manage'], expiresIn: 777596.92})\n *  .then(token => console.log(token))\n *  .catch(console.error)\n * ```\n */\nexport const createPersonalAccessToken: RestEndpoint<'AccessToken', 'createPersonalAccessToken'> = (\n  http: AxiosInstance,\n  _params: {},\n  rawData: CreatePersonalAccessTokenProps,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.post<AccessTokenProps>(http, '/users/me/access_tokens', rawData, {\n    headers,\n  })\n}\n\n/**\n * Revokes an access token associated with the currently authenticated user.\n *\n * @param {AxiosInstance} http - The Axios HTTP client instance.\n * @param {Object} params - The parameters for revoking the access token.\n * @param {string} params.tokenId - The unique identifier of the access token to revoke.\n * @returns {Promise<AccessTokenProps>} A Promise that resolves with the updated access token information after revocation.\n * @example ```javascript\n * const contentful = require('contentful-management')\n *\n * const plainClient = contentful.createClient(\n *  {\n *    accessToken: '<content_management_api_key>'\n *  },\n *  { type: 'plain' }\n * )\n * plainClient.revoke({tokenId: 'TestTokenTd'})\n *  .then(token => console.log(token))\n *  .catch(console.error)\n * ```\n */\nexport const revoke: RestEndpoint<'AccessToken', 'revoke'> = (\n  http: AxiosInstance,\n  params: { tokenId: string },\n) => {\n  return raw.put<AccessTokenProps>(http, `/users/me/access_tokens/${params.tokenId}/revoked`, null)\n}\n\n/**\n * Retrieves a list of redacted versions of access tokens for an organization, accessible to owners or administrators of an organization.\n *\n * @param {AxiosInstance} http - The Axios HTTP client instance.\n * @param {GetOrganizationParams & QueryParams} params - Parameters for the request, including organization ID and query parameters.\n * @param {string} params.organizationId - The unique identifier of the organization.\n * @returns {Promise<CollectionProp<AccessTokenProps>>} A promise that resolves to a collection of access tokens.\n * @example ```javascript\n * const contentful = require('contentful-management')\n *\n * const plainClient = contentful.createClient(\n *  {\n *    accessToken: '<content_management_api_key>'\n *  },\n *  { type: 'plain' }\n * )\n * plainClient.getManyForOrganization({organizationId: 'OrgId'})\n *  .then(result => console.log(result.items))\n *  .catch(console.error)\n * ```\n */\nexport const getManyForOrganization: RestEndpoint<'AccessToken', 'getManyForOrganization'> = (\n  http: AxiosInstance,\n  params: GetOrganizationParams & QueryParams,\n) => {\n  return raw.get<CollectionProp<AccessTokenProps>>(\n    http,\n    `/organizations/${params.organizationId}/access_tokens`,\n    {\n      params: params.query,\n    },\n  )\n}\n"],"names":["raw.get","raw.post","raw.put"],"mappings":";;;;AAUA;;;;;;;;;;;;;;;;;;;;AAoBG;MACU,GAAG,GAAuC,CACrD,IAAmB,EACnB,MAA2B,KACzB;AACF,IAAA,OAAOA,OAAO,CAAmB,IAAI,EAAE,CAA2B,wBAAA,EAAA,MAAM,CAAC,OAAO,CAAE,CAAA,CAAC;AACrF;AAEA;;;;;;;;;;;;;;;;;;;AAmBG;MACU,OAAO,GAA2C,CAC7D,IAAmB,EACnB,MAAmB,KACjB;AACF,IAAA,OAAOA,OAAO,CAAmC,IAAI,EAAE,yBAAyB,EAAE;QAChF,MAAM,EAAE,MAAM,CAAC,KAAK;AACrB,KAAA,CAAC;AACJ;AAEA;;;;;;;;;;;;;;;;;;;;;AAqBG;AACI,MAAM,yBAAyB,GAA6D,CACjG,IAAmB,EACnB,OAAW,EACX,OAAuC,EACvC,OAAgC,KAC9B;IACF,OAAOC,QAAQ,CAAmB,IAAI,EAAE,yBAAyB,EAAE,OAAO,EAAE;QAC1E,OAAO;AACR,KAAA,CAAC;AACJ;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;MACU,MAAM,GAA0C,CAC3D,IAAmB,EACnB,MAA2B,KACzB;AACF,IAAA,OAAOC,OAAO,CAAmB,IAAI,EAAE,CAAA,wBAAA,EAA2B,MAAM,CAAC,OAAO,CAAA,QAAA,CAAU,EAAE,IAAI,CAAC;AACnG;AAEA;;;;;;;;;;;;;;;;;;;;AAoBG;MACU,sBAAsB,GAA0D,CAC3F,IAAmB,EACnB,MAA2C,KACzC;IACF,OAAOF,OAAO,CACZ,IAAI,EACJ,CAAA,eAAA,EAAkB,MAAM,CAAC,cAAc,CAAA,cAAA,CAAgB,EACvD;QACE,MAAM,EAAE,MAAM,CAAC,KAAK;AACrB,KAAA,CACF;AACH;;;;;;;;"}

package/dist/cjs/adapters/REST/endpoints/ai-action-invocation.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+var raw = require('./raw.cjs');
+
+const get = (http, params, headers) => {
+    return raw.get(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invocations/${params.invocationId}`, { headers });
+};
+
+exports.get = get;
+//# sourceMappingURL=ai-action-invocation.cjs.map

package/dist/cjs/adapters/REST/endpoints/ai-action-invocation.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-action-invocation.cjs","sources":["../../../../../lib/adapters/REST/endpoints/ai-action-invocation.ts"],"sourcesContent":["import type { RawAxiosRequestHeaders } from 'axios'\nimport type { AxiosInstance } from 'contentful-sdk-core'\nimport type { GetSpaceEnvironmentParams } from '../../../common-types.js'\nimport type { RestEndpoint } from '../types.js'\nimport * as raw from './raw.js'\n\nexport const get: RestEndpoint<'AiActionInvocation', 'get'> = (\n  http: AxiosInstance,\n  params: GetSpaceEnvironmentParams & { aiActionId: string; invocationId: string },\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.get(\n    http,\n    `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invocations/${params.invocationId}`,\n    { headers },\n  )\n}\n"],"names":["raw.get"],"mappings":";;;;AAMa,MAAA,GAAG,GAA8C,CAC5D,IAAmB,EACnB,MAAgF,EAChF,OAAgC,KAC9B;AACF,IAAA,OAAOA,OAAO,CACZ,IAAI,EACJ,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,CAAiB,cAAA,EAAA,MAAM,CAAC,aAAa,CAAe,YAAA,EAAA,MAAM,CAAC,UAAU,CAAgB,aAAA,EAAA,MAAM,CAAC,YAAY,CAAE,CAAA,EACnI,EAAE,OAAO,EAAE,CACZ;AACH;;;;"}

package/dist/cjs/adapters/REST/endpoints/ai-action.cjs

@@ -0,0 +1,58 @@
+'use strict';
+
+var copy = require('fast-copy');
+var raw = require('./raw.cjs');
+
+const get = (http, params, headers) => {
+    return raw.get(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, {
+        headers,
+    });
+};
+const getMany = (http, params, headers) => {
+    return raw.get(http, `/spaces/${params.spaceId}/ai/actions`, {
+        params: params.query,
+        headers,
+    });
+};
+const create = (http, params, data, headers) => {
+    return raw.post(http, `/spaces/${params.spaceId}/ai/actions`, data, { headers });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    const { sys, ...payload } = data;
+    return raw.put(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, payload, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, params, headers) => {
+    return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, { headers });
+};
+const publish = (http, params, rawData, headers) => {
+    return raw.put(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, null, {
+        headers: {
+            'X-Contentful-Version': params.version,
+            ...headers,
+        },
+    });
+};
+const unpublish = (http, params, headers) => {
+    return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, {
+        headers,
+    });
+};
+const invoke = (http, params, data, headers) => {
+    return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invoke`, data, { headers });
+};
+
+exports.create = create;
+exports.del = del;
+exports.get = get;
+exports.getMany = getMany;
+exports.invoke = invoke;
+exports.publish = publish;
+exports.unpublish = unpublish;
+exports.update = update;
+//# sourceMappingURL=ai-action.cjs.map

package/dist/cjs/adapters/REST/endpoints/ai-action.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ai-action.cjs","sources":["../../../../../lib/adapters/REST/endpoints/ai-action.ts"],"sourcesContent":["import type { RawAxiosRequestHeaders } from 'axios'\nimport type { AxiosInstance } from 'contentful-sdk-core'\nimport copy from 'fast-copy'\nimport type {\n  CollectionProp,\n  GetSpaceEnvironmentParams,\n  GetSpaceParams,\n  QueryParams,\n} from '../../../common-types.js'\nimport type { RestEndpoint } from '../types.js'\nimport * as raw from './raw.js'\nimport type { AiActionProps, CreateAiActionProps } from '../../../entities/ai-action.js'\nimport type { AiActionInvocationType } from '../../../entities/ai-action-invocation.js'\n\nexport const get: RestEndpoint<'AiAction', 'get'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { aiActionId: string },\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.get<AiActionProps>(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, {\n    headers,\n  })\n}\n\nexport const getMany: RestEndpoint<'AiAction', 'getMany'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & QueryParams,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.get<CollectionProp<AiActionProps>>(http, `/spaces/${params.spaceId}/ai/actions`, {\n    params: params.query,\n    headers,\n  })\n}\n\nexport const create: RestEndpoint<'AiAction', 'create'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams,\n  data: CreateAiActionProps,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.post<AiActionProps>(http, `/spaces/${params.spaceId}/ai/actions`, data, { headers })\n}\n\nexport const update: RestEndpoint<'AiAction', 'update'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { aiActionId: string },\n  rawData: AiActionProps,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  const data = copy(rawData)\n  const { sys, ...payload } = data\n  return raw.put<AiActionProps>(\n    http,\n    `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`,\n    payload,\n    {\n      headers: {\n        'X-Contentful-Version': rawData.sys.version ?? 0,\n        ...headers,\n      },\n    },\n  )\n}\n\nexport const del: RestEndpoint<'AiAction', 'delete'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { aiActionId: string },\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, { headers })\n}\n\nexport const publish: RestEndpoint<'AiAction', 'publish'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { aiActionId: string; version: number },\n  rawData?: unknown,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.put<AiActionProps>(\n    http,\n    `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`,\n    null,\n    {\n      headers: {\n        'X-Contentful-Version': params.version,\n        ...headers,\n      },\n    },\n  )\n}\n\nexport const unpublish: RestEndpoint<'AiAction', 'unpublish'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { aiActionId: string },\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, {\n    headers,\n  })\n}\n\nexport const invoke: RestEndpoint<'AiAction', 'invoke'> = (\n  http: AxiosInstance,\n  params: GetSpaceEnvironmentParams & { aiActionId: string },\n  data: AiActionInvocationType,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.post(\n    http,\n    `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invoke`,\n    data,\n    { headers },\n  )\n}\n"],"names":["raw.get","raw.post","raw.put","raw.del"],"mappings":";;;;;AAca,MAAA,GAAG,GAAoC,CAClD,IAAmB,EACnB,MAA+C,EAC/C,OAAgC,KAC9B;AACF,IAAA,OAAOA,OAAO,CAAgB,IAAI,EAAE,CAAA,QAAA,EAAW,MAAM,CAAC,OAAO,CAAe,YAAA,EAAA,MAAM,CAAC,UAAU,EAAE,EAAE;QAC/F,OAAO;AACR,KAAA,CAAC;AACJ;AAEa,MAAA,OAAO,GAAwC,CAC1D,IAAmB,EACnB,MAAoC,EACpC,OAAgC,KAC9B;IACF,OAAOA,OAAO,CAAgC,IAAI,EAAE,CAAA,QAAA,EAAW,MAAM,CAAC,OAAO,CAAA,WAAA,CAAa,EAAE;QAC1F,MAAM,EAAE,MAAM,CAAC,KAAK;QACpB,OAAO;AACR,KAAA,CAAC;AACJ;AAEO,MAAM,MAAM,GAAuC,CACxD,IAAmB,EACnB,MAAsB,EACtB,IAAyB,EACzB,OAAgC,KAC9B;AACF,IAAA,OAAOC,QAAQ,CAAgB,IAAI,EAAE,WAAW,MAAM,CAAC,OAAO,CAAA,WAAA,CAAa,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC;AACjG;AAEO,MAAM,MAAM,GAAuC,CACxD,IAAmB,EACnB,MAA+C,EAC/C,OAAsB,EACtB,OAAgC,KAC9B;AACF,IAAA,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC;IAC1B,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,GAAG,IAAI;AAChC,IAAA,OAAOC,OAAO,CACZ,IAAI,EACJ,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,eAAe,MAAM,CAAC,UAAU,CAAE,CAAA,EAC3D,OAAO,EACP;AACE,QAAA,OAAO,EAAE;AACP,YAAA,sBAAsB,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC;AAChD,YAAA,GAAG,OAAO;AACX,SAAA;AACF,KAAA,CACF;AACH;AAEa,MAAA,GAAG,GAAuC,CACrD,IAAmB,EACnB,MAA+C,EAC/C,OAAgC,KAC9B;IACF,OAAOC,OAAO,CAAC,IAAI,EAAE,CAAA,QAAA,EAAW,MAAM,CAAC,OAAO,eAAe,MAAM,CAAC,UAAU,CAAE,CAAA,EAAE,EAAE,OAAO,EAAE,CAAC;AAChG;AAEO,MAAM,OAAO,GAAwC,CAC1D,IAAmB,EACnB,MAAgE,EAChE,OAAiB,EACjB,OAAgC,KAC9B;AACF,IAAA,OAAOD,OAAO,CACZ,IAAI,EACJ,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,eAAe,MAAM,CAAC,UAAU,CAAY,UAAA,CAAA,EACrE,IAAI,EACJ;AACE,QAAA,OAAO,EAAE;YACP,sBAAsB,EAAE,MAAM,CAAC,OAAO;AACtC,YAAA,GAAG,OAAO;AACX,SAAA;AACF,KAAA,CACF;AACH;AAEa,MAAA,SAAS,GAA0C,CAC9D,IAAmB,EACnB,MAA+C,EAC/C,OAAgC,KAC9B;AACF,IAAA,OAAOC,OAAO,CAAC,IAAI,EAAE,CAAA,QAAA,EAAW,MAAM,CAAC,OAAO,CAAe,YAAA,EAAA,MAAM,CAAC,UAAU,YAAY,EAAE;QAC1F,OAAO;AACR,KAAA,CAAC;AACJ;AAEO,MAAM,MAAM,GAAuC,CACxD,IAAmB,EACnB,MAA0D,EAC1D,IAA4B,EAC5B,OAAgC,KAC9B;IACF,OAAOF,QAAQ,CACb,IAAI,EACJ,CAAA,QAAA,EAAW,MAAM,CAAC,OAAO,CAAA,cAAA,EAAiB,MAAM,CAAC,aAAa,CAAe,YAAA,EAAA,MAAM,CAAC,UAAU,CAAS,OAAA,CAAA,EACvG,IAAI,EACJ,EAAE,OAAO,EAAE,CACZ;AACH;;;;;;;;;;;"}

package/dist/cjs/adapters/REST/endpoints/api-key.cjs

@@ -0,0 +1,51 @@
+'use strict';
+
+var copy = require('fast-copy');
+var raw = require('./raw.cjs');
+
+const get = (http, params) => {
+    return raw.get(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`);
+};
+const getMany = (http, params) => {
+    return raw.get(http, `/spaces/${params.spaceId}/api_keys`, {
+        params: params.query,
+    });
+};
+const create = (http, params, data, headers) => {
+    return raw.post(http, `/spaces/${params.spaceId}/api_keys`, data, { headers });
+};
+const createWithId = (http, params, data, headers) => {
+    return raw.put(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`, data, {
+        headers,
+    });
+};
+const update = (http, params, rawData, headers) => {
+    const data = copy(rawData);
+    if ('accessToken' in data) {
+        delete data.accessToken;
+    }
+    if ('preview_api_key' in data) {
+        delete data.preview_api_key;
+    }
+    if ('policies' in data) {
+        delete data.policies;
+    }
+    delete data.sys;
+    return raw.put(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`, data, {
+        headers: {
+            'X-Contentful-Version': rawData.sys.version ?? 0,
+            ...headers,
+        },
+    });
+};
+const del = (http, params) => {
+    return raw.del(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`);
+};
+
+exports.create = create;
+exports.createWithId = createWithId;
+exports.del = del;
+exports.get = get;
+exports.getMany = getMany;
+exports.update = update;
+//# sourceMappingURL=api-key.cjs.map

package/dist/cjs/adapters/REST/endpoints/api-key.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.cjs","sources":["../../../../../lib/adapters/REST/endpoints/api-key.ts"],"sourcesContent":["import type { RawAxiosRequestHeaders } from 'axios'\nimport type { AxiosInstance } from 'contentful-sdk-core'\nimport copy from 'fast-copy'\nimport type { SetOptional } from 'type-fest'\nimport type { CollectionProp, GetSpaceParams, QueryParams } from '../../../common-types.js'\nimport type { ApiKeyProps, CreateApiKeyProps } from '../../../entities/api-key.js'\nimport type { RestEndpoint } from '../types.js'\nimport * as raw from './raw.js'\n\nexport const get: RestEndpoint<'ApiKey', 'get'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { apiKeyId: string },\n) => {\n  return raw.get<ApiKeyProps>(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`)\n}\n\nexport const getMany: RestEndpoint<'ApiKey', 'getMany'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & QueryParams,\n) => {\n  return raw.get<CollectionProp<ApiKeyProps>>(http, `/spaces/${params.spaceId}/api_keys`, {\n    params: params.query,\n  })\n}\n\nexport const create: RestEndpoint<'ApiKey', 'create'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams,\n  data: CreateApiKeyProps,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.post<ApiKeyProps>(http, `/spaces/${params.spaceId}/api_keys`, data, { headers })\n}\n\nexport const createWithId: RestEndpoint<'ApiKey', 'createWithId'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { apiKeyId: string },\n  data: CreateApiKeyProps,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  return raw.put<ApiKeyProps>(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`, data, {\n    headers,\n  })\n}\n\nexport const update: RestEndpoint<'ApiKey', 'update'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { apiKeyId: string },\n  rawData: ApiKeyProps,\n  headers?: RawAxiosRequestHeaders,\n) => {\n  const data: SetOptional<typeof rawData, 'accessToken' | 'preview_api_key' | 'policies' | 'sys'> =\n    copy(rawData)\n  if ('accessToken' in data) {\n    delete data.accessToken\n  }\n  if ('preview_api_key' in data) {\n    delete data.preview_api_key\n  }\n  if ('policies' in data) {\n    delete data.policies\n  }\n  delete data.sys\n  return raw.put<ApiKeyProps>(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`, data, {\n    headers: {\n      'X-Contentful-Version': rawData.sys.version ?? 0,\n      ...headers,\n    },\n  })\n}\n\nexport const del: RestEndpoint<'ApiKey', 'delete'> = (\n  http: AxiosInstance,\n  params: GetSpaceParams & { apiKeyId: string },\n) => {\n  return raw.del(http, `/spaces/${params.spaceId}/api_keys/${params.apiKeyId}`)\n}\n"],"names":["raw.get","raw.post","raw.put","raw.del"],"mappings":";;;;;MASa,GAAG,GAAkC,CAChD,IAAmB,EACnB,MAA6C,KAC3C;AACF,IAAA,OAAOA,OAAO,CAAc,IAAI,EAAE,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,aAAa,MAAM,CAAC,QAAQ,CAAA,CAAE,CAAC;AAC5F;MAEa,OAAO,GAAsC,CACxD,IAAmB,EACnB,MAAoC,KAClC;IACF,OAAOA,OAAO,CAA8B,IAAI,EAAE,CAAA,QAAA,EAAW,MAAM,CAAC,OAAO,CAAA,SAAA,CAAW,EAAE;QACtF,MAAM,EAAE,MAAM,CAAC,KAAK;AACrB,KAAA,CAAC;AACJ;AAEO,MAAM,MAAM,GAAqC,CACtD,IAAmB,EACnB,MAAsB,EACtB,IAAuB,EACvB,OAAgC,KAC9B;AACF,IAAA,OAAOC,QAAQ,CAAc,IAAI,EAAE,WAAW,MAAM,CAAC,OAAO,CAAA,SAAA,CAAW,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,CAAC;AAC7F;AAEO,MAAM,YAAY,GAA2C,CAClE,IAAmB,EACnB,MAA6C,EAC7C,IAAuB,EACvB,OAAgC,KAC9B;AACF,IAAA,OAAOC,OAAO,CAAc,IAAI,EAAE,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,aAAa,MAAM,CAAC,QAAQ,CAAE,CAAA,EAAE,IAAI,EAAE;QAC/F,OAAO;AACR,KAAA,CAAC;AACJ;AAEO,MAAM,MAAM,GAAqC,CACtD,IAAmB,EACnB,MAA6C,EAC7C,OAAoB,EACpB,OAAgC,KAC9B;AACF,IAAA,MAAM,IAAI,GACR,IAAI,CAAC,OAAO,CAAC;AACf,IAAA,IAAI,aAAa,IAAI,IAAI,EAAE;QACzB,OAAO,IAAI,CAAC,WAAW;;AAEzB,IAAA,IAAI,iBAAiB,IAAI,IAAI,EAAE;QAC7B,OAAO,IAAI,CAAC,eAAe;;AAE7B,IAAA,IAAI,UAAU,IAAI,IAAI,EAAE;QACtB,OAAO,IAAI,CAAC,QAAQ;;IAEtB,OAAO,IAAI,CAAC,GAAG;AACf,IAAA,OAAOA,OAAO,CAAc,IAAI,EAAE,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,aAAa,MAAM,CAAC,QAAQ,CAAE,CAAA,EAAE,IAAI,EAAE;AAC/F,QAAA,OAAO,EAAE;AACP,YAAA,sBAAsB,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC;AAChD,YAAA,GAAG,OAAO;AACX,SAAA;AACF,KAAA,CAAC;AACJ;MAEa,GAAG,GAAqC,CACnD,IAAmB,EACnB,MAA6C,KAC3C;AACF,IAAA,OAAOC,OAAO,CAAC,IAAI,EAAE,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,aAAa,MAAM,CAAC,QAAQ,CAAA,CAAE,CAAC;AAC/E;;;;;;;;;"}

package/dist/cjs/adapters/REST/endpoints/app-access-token.cjs

@@ -0,0 +1,10 @@
+'use strict';
+
+var raw = require('./raw.cjs');
+
+const create = (http, params, data) => {
+    return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appDefinitionId}/access_tokens`, undefined, { headers: { Authorization: `Bearer ${data.jwt}` } });
+};
+
+exports.create = create;
+//# sourceMappingURL=app-access-token.cjs.map

package/dist/cjs/adapters/REST/endpoints/app-access-token.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-access-token.cjs","sources":["../../../../../lib/adapters/REST/endpoints/app-access-token.ts"],"sourcesContent":["import type { AxiosInstance } from 'contentful-sdk-core'\nimport type {\n  AppAccessTokenProps,\n  CreateAppAccessTokenProps,\n} from '../../../entities/app-access-token.js'\nimport * as raw from './raw.js'\nimport type { RestEndpoint } from '../types.js'\nimport type { GetAppInstallationParams } from '../../../common-types.js'\n\nexport const create: RestEndpoint<'AppAccessToken', 'create'> = (\n  http: AxiosInstance,\n  params: GetAppInstallationParams,\n  data: CreateAppAccessTokenProps,\n) => {\n  return raw.post<AppAccessTokenProps>(\n    http,\n    `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appDefinitionId}/access_tokens`,\n    undefined,\n    { headers: { Authorization: `Bearer ${data.jwt}` } },\n  )\n}\n"],"names":["raw.post"],"mappings":";;;;AASa,MAAA,MAAM,GAA6C,CAC9D,IAAmB,EACnB,MAAgC,EAChC,IAA+B,KAC7B;AACF,IAAA,OAAOA,QAAQ,CACb,IAAI,EACJ,CAAW,QAAA,EAAA,MAAM,CAAC,OAAO,iBAAiB,MAAM,CAAC,aAAa,CAAA,mBAAA,EAAsB,MAAM,CAAC,eAAe,CAAgB,cAAA,CAAA,EAC1H,SAAS,EACT,EAAE,OAAO,EAAE,EAAE,aAAa,EAAE,CAAU,OAAA,EAAA,IAAI,CAAC,GAAG,CAAA,CAAE,EAAE,EAAE,CACrD;AACH;;;;"}