contentful-management 11.52.1 → 12.0.0-beta.1

package/dist/esm/create-ui-config-api.js

@@ -0,0 +1,53 @@
+import entities from './entities/index.js';
+
+/**
+ * @private
+ */
+function createUIConfigApi(makeRequest) {
+    const { wrapUIConfig } = entities.uiConfig;
+    const getParams = (self) => {
+        const uiConfig = self.toPlainObject();
+        return {
+            params: {
+                spaceId: uiConfig.sys.space.sys.id,
+                environmentId: uiConfig.sys.environment.sys.id,
+            },
+            raw: uiConfig,
+        };
+    };
+    return {
+        /**
+         * Sends an update to the server with any changes made to the object's properties
+         * @return Object returned from the server with updated changes.
+         * @example ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getSpace('<space_id>')
+         * .then((space) => space.getEnvironment('<environment_id>'))
+         * .then((environment) => environment.getUIConfig())
+         * .then((uiConfig) => {
+         *   uiConfig.entryListViews = [...]
+         *   return uiConfig.update()
+         * })
+         * .then((uiConfig) => console.log(`UIConfig updated.`))
+         * .catch(console.error)
+         * ```
+         */
+        update: async function update() {
+            const { raw, params } = getParams(this);
+            const data = await makeRequest({
+                entityType: 'UIConfig',
+                action: 'update',
+                params,
+                payload: raw,
+            });
+            return wrapUIConfig(makeRequest, data);
+        },
+    };
+}
+
+export { createUIConfigApi as default };

package/dist/esm/create-user-ui-config-api.js

@@ -0,0 +1,53 @@
+import entities from './entities/index.js';
+
+/**
+ * @private
+ */
+function createUserUIConfigApi(makeRequest) {
+    const { wrapUserUIConfig } = entities.userUIConfig;
+    const getParams = (self) => {
+        const userUIConfig = self.toPlainObject();
+        return {
+            params: {
+                spaceId: userUIConfig.sys.space.sys.id,
+                environmentId: userUIConfig.sys.environment.sys.id,
+            },
+            raw: userUIConfig,
+        };
+    };
+    return {
+        /**
+         * Sends an update to the server with any changes made to the object's properties
+         * @return Object returned from the server with updated changes.
+         * @example ```javascript
+         * const contentful = require('contentful-management')
+         *
+         * const client = contentful.createClient({
+         *   accessToken: '<content_management_api_key>'
+         * })
+         *
+         * client.getSpace('<space_id>')
+         * .then((space) => space.getEnvironment('<environment_id>'))
+         * .then((environment) => environment.getUserUIConfig())
+         * .then((uiConfig) => {
+         *   uiConfig.entryListViews = [...]
+         *   return uiConfig.update()
+         * })
+         * .then((uiConfig) => console.log(`UserUIConfig updated.`))
+         * .catch(console.error)
+         * ```
+         */
+        update: async function update() {
+            const { raw, params } = getParams(this);
+            const data = await makeRequest({
+                entityType: 'UserUIConfig',
+                action: 'update',
+                params,
+                payload: raw,
+            });
+            return wrapUserUIConfig(makeRequest, data);
+        },
+    };
+}
+
+export { createUserUIConfigApi as default };

package/dist/{es-modules → esm}/enhance-with-methods.js

@@ -9,14 +9,16 @@
  * @param {object} methodsObject - Object with methods as properties. The key
  * values used here will be the same that will be defined on the baseObject.
  */
-export default function enhanceWithMethods(baseObject, methodsObject) {
-  return Object.keys(methodsObject).reduce((enhancedObject, methodName) => {
-    Object.defineProperty(enhancedObject, methodName, {
-      enumerable: false,
-      configurable: true,
-      writable: false,
-      value: methodsObject[methodName]
-    });
-    return enhancedObject;
-  }, baseObject);
-}
+function enhanceWithMethods(baseObject, methodsObject) {
+    return Object.keys(methodsObject).reduce((enhancedObject, methodName) => {
+        Object.defineProperty(enhancedObject, methodName, {
+            enumerable: false,
+            configurable: true,
+            writable: false,
+            value: methodsObject[methodName],
+        });
+        return enhancedObject;
+    }, baseObject);
+}
+
+export { enhanceWithMethods as default };

package/dist/esm/entities/access-token.js

@@ -0,0 +1,33 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw  access token data
+ * @return Wrapped access token
+ */
+function wrapAccessToken(makeRequest, data) {
+    const AccessToken = toPlainObject(copy(data));
+    const accessTokenWithMethods = enhanceWithMethods(AccessToken, {
+        revoke: function () {
+            return makeRequest({
+                entityType: 'AccessToken',
+                action: 'revoke',
+                params: { tokenId: data.sys.id },
+            }).then((data) => wrapAccessToken(makeRequest, data));
+        },
+    });
+    return freezeSys(accessTokenWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw access collection data
+ * @return Wrapped access token collection data
+ */
+const wrapAccessTokenCollection = wrapCollection(wrapAccessToken);
+
+export { wrapAccessToken, wrapAccessTokenCollection };

package/dist/esm/entities/ai-action-invocation.js

@@ -0,0 +1,42 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+
+var InvocationStatus;
+(function (InvocationStatus) {
+    InvocationStatus["Scheduled"] = "SCHEDULED";
+    InvocationStatus["InProgress"] = "IN_PROGRESS";
+    InvocationStatus["Failed"] = "FAILED";
+    InvocationStatus["Completed"] = "COMPLETED";
+    InvocationStatus["Cancelled"] = "CANCELLED";
+})(InvocationStatus || (InvocationStatus = {}));
+var InvocationResultType;
+(function (InvocationResultType) {
+    InvocationResultType["Text"] = "text";
+})(InvocationResultType || (InvocationResultType = {}));
+const AiActionOutputFormat = {
+    RichText: 'RichText',
+    Markdown: 'Markdown',
+    PlainText: 'PlainText',
+};
+/**
+ * Wraps raw AI Action Invocation data with SDK helper methods.
+ *
+ * @param makeRequest - Function to make API requests.
+ * @param data - Raw AI Action Invocation data.
+ * @returns The AI Action Invocation entity.
+ */
+function wrapAiActionInvocation(makeRequest, data) {
+    const invocation = toPlainObject(copy(data));
+    return freezeSys(invocation);
+}
+/**
+ * Wraps a collection of raw AI Action Invocation data.
+ *
+ * @param makeRequest - Function to make API requests.
+ * @param data - Raw collection data.
+ * @returns A collection of AI Action Invocation entities.
+ */
+const wrapAiActionInvocationCollection = wrapCollection(wrapAiActionInvocation);
+
+export { AiActionOutputFormat, InvocationResultType, InvocationStatus, wrapAiActionInvocation, wrapAiActionInvocationCollection };

package/dist/esm/entities/ai-action.js

@@ -0,0 +1,91 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapAiActionInvocation } from './ai-action-invocation.js';
+
+var StatusFilter;
+(function (StatusFilter) {
+    StatusFilter["ALL"] = "all";
+    StatusFilter["PUBLISHED"] = "published";
+})(StatusFilter || (StatusFilter = {}));
+var VariableType;
+(function (VariableType) {
+    VariableType["RESOURCE_LINK"] = "ResourceLink";
+    VariableType["TEXT"] = "Text";
+    VariableType["STANDARD_INPUT"] = "StandardInput";
+    VariableType["LOCALE"] = "Locale";
+    VariableType["MEDIA_REFERENCE"] = "MediaReference";
+    VariableType["REFERENCE"] = "Reference";
+    VariableType["SMART_CONTEXT"] = "SmartContext";
+})(VariableType || (VariableType = {}));
+var EntityTypeEntry;
+(function (EntityTypeEntry) {
+    EntityTypeEntry["ENTRY"] = "Entry";
+})(EntityTypeEntry || (EntityTypeEntry = {}));
+function createAiActionApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        aiActionId: data.sys.id,
+    });
+    return {
+        update: function update() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'update',
+                params: getParams(self),
+                payload: self,
+            }).then((data) => wrapAiAction(makeRequest, data));
+        },
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+        publish: function publish() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'publish',
+                params: {
+                    aiActionId: self.sys.id,
+                    spaceId: self.sys.space.sys.id,
+                    version: self.sys.version,
+                },
+            }).then((data) => wrapAiAction(makeRequest, data));
+        },
+        unpublish: function unpublish() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'unpublish',
+                params: getParams(self),
+            }).then((data) => wrapAiAction(makeRequest, data));
+        },
+        invoke: function invoke(environmentId, payload) {
+            const self = this;
+            return makeRequest({
+                entityType: 'AiAction',
+                action: 'invoke',
+                params: {
+                    spaceId: self.sys.space.sys.id,
+                    environmentId,
+                    aiActionId: self.sys.id,
+                },
+                payload,
+            }).then((data) => wrapAiActionInvocation(makeRequest, data));
+        },
+    };
+}
+function wrapAiAction(makeRequest, data) {
+    const aiAction = toPlainObject(copy(data));
+    const aiActionWithMethods = enhanceWithMethods(aiAction, createAiActionApi(makeRequest));
+    return freezeSys(aiActionWithMethods);
+}
+const wrapAiActionCollection = wrapCollection(wrapAiAction);
+
+export { EntityTypeEntry, StatusFilter, VariableType, wrapAiAction, wrapAiActionCollection };

package/dist/esm/entities/api-key.js

@@ -0,0 +1,56 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createApiKeyApi(makeRequest) {
+    const getParams = (data) => {
+        var _a, _b;
+        return ({
+            spaceId: (_b = (_a = data.sys.space) === null || _a === void 0 ? void 0 : _a.sys.id) !== null && _b !== void 0 ? _b : '',
+            apiKeyId: data.sys.id,
+        });
+    };
+    return {
+        update: function update() {
+            const self = this;
+            return makeRequest({
+                entityType: 'ApiKey',
+                action: 'update',
+                params: getParams(self),
+                payload: self,
+                headers: {},
+            }).then((data) => wrapApiKey(makeRequest, data));
+        },
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'ApiKey',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key data
+ */
+function wrapApiKey(makeRequest, data) {
+    const apiKey = toPlainObject(copy(data));
+    const apiKeyWithMethods = enhanceWithMethods(apiKey, createApiKeyApi(makeRequest));
+    return freezeSys(apiKeyWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key collection data
+ * @return Wrapped api key collection data
+ */
+const wrapApiKeyCollection = wrapCollection(wrapApiKey);
+
+export { wrapApiKey, wrapApiKeyCollection };

package/dist/esm/entities/app-access-token.js

@@ -0,0 +1,15 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw app access token data
+ * @return {AppAccessToken} Wrapped AppAccessToken data
+ */
+function wrapAppAccessToken(_makeRequest, data) {
+    const appAccessToken = toPlainObject(copy(data));
+    return freezeSys(appAccessToken);
+}
+
+export { wrapAppAccessToken };

package/dist/esm/entities/app-action-call.js

@@ -0,0 +1,61 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createAppActionCallApi(makeRequest, retryOptions) {
+    return {
+        createWithResponse: function () {
+            const payload = {
+                parameters: {
+                    recipient: 'Alice <alice@my-company.com>',
+                    message_body: 'Hello from Bob!',
+                },
+            };
+            return makeRequest({
+                entityType: 'AppActionCall',
+                action: 'createWithResponse',
+                params: Object.assign({ spaceId: 'space-id', environmentId: 'environment-id', appDefinitionId: 'app-definiton-id', appActionId: 'app-action-id' }, retryOptions),
+                payload: payload,
+            }).then((data) => wrapAppActionCallResponse(makeRequest, data));
+        },
+        getCallDetails: function getCallDetails() {
+            return makeRequest({
+                entityType: 'AppActionCall',
+                action: 'getCallDetails',
+                params: {
+                    spaceId: 'space-id',
+                    environmentId: 'environment-id',
+                    callId: 'call-id',
+                    appActionId: 'app-action-id',
+                },
+            }).then((data) => wrapAppActionCallResponse(makeRequest, data));
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppActionCall data
+ * @return Wrapped AppActionCall data
+ */
+function wrapAppActionCall(makeRequest, data) {
+    const signedRequest = toPlainObject(copy(data));
+    const signedRequestWithMethods = enhanceWithMethods(signedRequest, createAppActionCallApi(makeRequest));
+    return signedRequestWithMethods;
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppActionCall data
+ * @return Wrapped AppActionCall data
+ */
+function wrapAppActionCallResponse(makeRequest, data, retryOptions) {
+    const appActionCallResponse = toPlainObject(copy(data));
+    const appActionCallResponseWithMethods = enhanceWithMethods(appActionCallResponse, createAppActionCallApi(makeRequest, retryOptions));
+    return appActionCallResponseWithMethods;
+}
+
+export { createAppActionCallApi as default, wrapAppActionCall, wrapAppActionCallResponse };

package/dist/esm/entities/app-action.js

@@ -0,0 +1,45 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createAppActionApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+        appActionId: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppAction',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Bundle data
+ * @return Wrapped App Bundle data
+ */
+function wrapAppAction(makeRequest, data) {
+    const appAction = toPlainObject(copy(data));
+    const appActionWithMethods = enhanceWithMethods(appAction, createAppActionApi(makeRequest));
+    return freezeSys(appActionWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Bundle collection data
+ * @return Wrapped App Bundle collection data
+ */
+const wrapAppActionCollection = wrapCollection(wrapAppAction);
+
+export { wrapAppAction, wrapAppActionCollection };

package/dist/esm/entities/app-bundle.js

@@ -0,0 +1,45 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createAppBundleApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+        appBundleId: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppBundle',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Bundle data
+ * @return Wrapped App Bundle data
+ */
+function wrapAppBundle(makeRequest, data) {
+    const appBundle = toPlainObject(copy(data));
+    const appBundleWithMethods = enhanceWithMethods(appBundle, createAppBundleApi(makeRequest));
+    return freezeSys(appBundleWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Bundle collection data
+ * @return Wrapped App Bundle collection data
+ */
+const wrapAppBundleCollection = wrapCollection(wrapAppBundle);
+
+export { wrapAppBundle, wrapAppBundleCollection };

package/dist/esm/entities/app-definition.js

@@ -0,0 +1,26 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+import createAppDefinitionApi from '../create-app-definition-api.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Definition data
+ * @return Wrapped App Definition data
+ */
+function wrapAppDefinition(makeRequest, data) {
+    const appDefinition = toPlainObject(copy(data));
+    const appDefinitionWithMethods = enhanceWithMethods(appDefinition, createAppDefinitionApi(makeRequest));
+    return freezeSys(appDefinitionWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Definition collection data
+ * @return Wrapped App Definition collection data
+ */
+const wrapAppDefinitionCollection = wrapCollection(wrapAppDefinition);
+
+export { wrapAppDefinition, wrapAppDefinitionCollection };

package/dist/esm/entities/app-details.js

@@ -0,0 +1,37 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @return Wrapped App Details data
+ */
+function createAppDetailsApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppDetails',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppDetails data
+ * @return Wrapped AppDetails data
+ */
+function wrapAppDetails(makeRequest, data) {
+    const appDetails = toPlainObject(copy(data));
+    return enhanceWithMethods(appDetails, createAppDetailsApi(makeRequest));
+}
+
+export { wrapAppDetails };

package/dist/esm/entities/app-event-subscription.js

@@ -0,0 +1,32 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+function createEventSubscriptionApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppEventSubscription',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppEventSubscription data
+ * @return Wrapped AppEventSubscription data
+ */
+function wrapAppEventSubscription(makeRequest, data) {
+    const eventSubscription = toPlainObject(copy(data));
+    return enhanceWithMethods(eventSubscription, createEventSubscriptionApi(makeRequest));
+}
+
+export { wrapAppEventSubscription };

package/dist/esm/entities/app-installation.js

@@ -0,0 +1,52 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ */
+function createAppInstallationApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        environmentId: data.sys.environment.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppInstallation',
+                action: 'upsert',
+                params: getParams(data),
+                headers: {},
+                payload: data,
+            }).then((data) => wrapAppInstallation(makeRequest, data));
+        },
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppInstallation',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Installation data
+ * @return Wrapped App installation data
+ */
+function wrapAppInstallation(makeRequest, data) {
+    const appInstallation = toPlainObject(copy(data));
+    const appInstallationWithMethods = enhanceWithMethods(appInstallation, createAppInstallationApi(makeRequest));
+    return freezeSys(appInstallationWithMethods);
+}
+/**
+ * @private
+ */
+const wrapAppInstallationCollection = wrapCollection(wrapAppInstallation);
+
+export { wrapAppInstallation, wrapAppInstallationCollection };