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

package/dist/es-modules/create-ui-config-api.js

@@ -0,0 +1,60 @@
+import entities from './entities';
+
+/**
+ * @private
+ */
+
+/**
+ * @private
+ */
+export default 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);
+    }
+  };
+}

package/dist/es-modules/create-user-ui-config-api.js

@@ -0,0 +1,60 @@
+import entities from './entities';
+
+/**
+ * @private
+ */
+
+/**
+ * @private
+ */
+export default 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);
+    }
+  };
+}

package/dist/es-modules/enhance-with-methods.js

@@ -0,0 +1,22 @@
+/**
+ * This method enhances a base object which would normally contain data, with
+ * methods from another object that might work on manipulating that data.
+ * All the added methods are set as non enumerable, non configurable, and non
+ * writable properties. This ensures that if we try to clone or stringify the
+ * base object, we don't have to worry about these additional methods.
+ * @private
+ * @param {object} baseObject - Base object with data
+ * @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);
+}

package/dist/es-modules/entities/access-token.js

@@ -0,0 +1,38 @@
+import copy from 'fast-copy';
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods';
+import { wrapCollection } from '../common-utils';
+
+/**
+ * @deprecated Use `AccessTokenProps` instead.
+ */
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw  access token data
+ * @return Wrapped access token
+ */
+export 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
+ */
+export const wrapAccessTokenCollection = wrapCollection(wrapAccessToken);

package/dist/es-modules/entities/ai-action-invocation.js

@@ -0,0 +1,34 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+export const AiActionOutputFormat = {
+  RichText: 'RichText',
+  Markdown: 'Markdown',
+  PlainText: 'PlainText'
+};
+
+/**
+ * The AI Action Invocation entity.
+ * This entity is read-only and primarily used to inspect the result of an AI action invocation.
+ */
+
+/**
+ * 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.
+ */
+export 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.
+ */
+export const wrapAiActionInvocationCollection = wrapCollection(wrapAiActionInvocation);

package/dist/es-modules/entities/ai-action.js

@@ -0,0 +1,69 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+import enhanceWithMethods from '../enhance-with-methods';
+import { wrapAiActionInvocation } from './ai-action-invocation';
+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));
+    }
+  };
+}
+export function wrapAiAction(makeRequest, data) {
+  const aiAction = toPlainObject(copy(data));
+  const aiActionWithMethods = enhanceWithMethods(aiAction, createAiActionApi(makeRequest));
+  return freezeSys(aiActionWithMethods);
+}
+export const wrapAiActionCollection = wrapCollection(wrapAiAction);

package/dist/es-modules/entities/api-key.js

@@ -0,0 +1,55 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+import enhanceWithMethods from '../enhance-with-methods';
+/**
+ * @private
+ */
+function createApiKeyApi(makeRequest) {
+  const getParams = data => {
+    var _data$sys$space$sys$i, _data$sys$space;
+    return {
+      spaceId: (_data$sys$space$sys$i = (_data$sys$space = data.sys.space) === null || _data$sys$space === void 0 ? void 0 : _data$sys$space.sys.id) !== null && _data$sys$space$sys$i !== void 0 ? _data$sys$space$sys$i : '',
+      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
+ */
+export 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
+ */
+export const wrapApiKeyCollection = wrapCollection(wrapApiKey);

package/dist/es-modules/entities/app-access-token.js

@@ -0,0 +1,12 @@
+import copy from 'fast-copy';
+import { freezeSys, toPlainObject } 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
+ */
+export function wrapAppAccessToken(_makeRequest, data) {
+  const appAccessToken = toPlainObject(copy(data));
+  return freezeSys(appAccessToken);
+}

package/dist/es-modules/entities/app-action-call.js

@@ -0,0 +1,69 @@
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods';
+/**
+ * @private
+ */
+export default function createAppActionCallApi(makeRequest, retryOptions) {
+  return {
+    createWithResponse: function (params, payload) {
+      return makeRequest({
+        entityType: 'AppActionCall',
+        action: 'createWithResponse',
+        params: _objectSpread(_objectSpread({}, params), retryOptions),
+        payload: payload
+      }).then(data => wrapAppActionCallResponse(makeRequest, data));
+    },
+    getCallDetails: function getCallDetails(params) {
+      return makeRequest({
+        entityType: 'AppActionCall',
+        action: 'getCallDetails',
+        params
+      }).then(data => wrapAppActionCallResponse(makeRequest, data));
+    },
+    get: function get(params) {
+      return makeRequest({
+        entityType: 'AppActionCall',
+        action: 'get',
+        params
+      }).then(data => wrapAppActionCall(makeRequest, data));
+    },
+    createWithResult: function (params, payload) {
+      return makeRequest({
+        entityType: 'AppActionCall',
+        action: 'createWithResult',
+        params: _objectSpread(_objectSpread({}, params), retryOptions),
+        payload: payload
+      }).then(data => wrapAppActionCall(makeRequest, data));
+    }
+  };
+}
+
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppActionCall data
+ * @return Wrapped AppActionCall data
+ */
+export 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
+ */
+export function wrapAppActionCallResponse(makeRequest, data, retryOptions) {
+  const appActionCallResponse = toPlainObject(copy(data));
+  const appActionCallResponseWithMethods = enhanceWithMethods(appActionCallResponse, createAppActionCallApi(makeRequest, retryOptions));
+  return appActionCallResponseWithMethods;
+}

package/dist/es-modules/entities/app-action.js

@@ -0,0 +1,53 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+import enhanceWithMethods from '../enhance-with-methods';
+
+/**
+ * 'function' is deprecated, use 'function-invocation' instead
+ */
+
+/**
+ * @deprecated Use FunctionAppActionProps instead
+ */
+
+/**
+ * @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
+ */
+export 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
+ */
+export const wrapAppActionCollection = wrapCollection(wrapAppAction);

package/dist/es-modules/entities/app-bundle.js

@@ -0,0 +1,44 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+import enhanceWithMethods from '../enhance-with-methods';
+/**
+ * @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
+ */
+export 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
+ */
+export const wrapAppBundleCollection = wrapCollection(wrapAppBundle);

package/dist/es-modules/entities/app-definition.js

@@ -0,0 +1,31 @@
+import copy from 'fast-copy';
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods';
+import { wrapCollection } from '../common-utils';
+import createAppDefinitionApi from '../create-app-definition-api';
+
+/**
+ * These locations are currently restricted to internal Contentful apps only.
+ * If you are interested in using these locations for your app,
+ * please reach out to Contentful Support (https://www.contentful.com/support/).
+ */
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Definition data
+ * @return Wrapped App Definition data
+ */
+export 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
+ */
+export const wrapAppDefinitionCollection = wrapCollection(wrapAppDefinition);

package/dist/es-modules/entities/app-details.js

@@ -0,0 +1,35 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods';
+/**
+ * @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
+ */
+export function wrapAppDetails(makeRequest, data) {
+  const appDetails = toPlainObject(copy(data));
+  return enhanceWithMethods(appDetails, createAppDetailsApi(makeRequest));
+}

package/dist/es-modules/entities/app-event-subscription.js

@@ -0,0 +1,30 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods';
+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
+ */
+export function wrapAppEventSubscription(makeRequest, data) {
+  const eventSubscription = toPlainObject(copy(data));
+  return enhanceWithMethods(eventSubscription, createEventSubscriptionApi(makeRequest));
+}

package/dist/es-modules/entities/app-installation.js

@@ -0,0 +1,51 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods';
+import { wrapCollection } from '../common-utils';
+/**
+ * @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
+ */
+export function wrapAppInstallation(makeRequest, data) {
+  const appInstallation = toPlainObject(copy(data));
+  const appInstallationWithMethods = enhanceWithMethods(appInstallation, createAppInstallationApi(makeRequest));
+  return freezeSys(appInstallationWithMethods);
+}
+
+/**
+ * @private
+ */
+export const wrapAppInstallationCollection = wrapCollection(wrapAppInstallation);