contentful-management 12.0.0-beta.1 → 12.0.0-beta.3

package/dist/cjs/create-ui-config-api.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+var index = require('./entities/index.js');
+
+/**
+ * @private
+ */
+function createUIConfigApi(makeRequest) {
+    const { wrapUIConfig } = index.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);
+        },
+    };
+}
+
+module.exports = createUIConfigApi;

package/dist/cjs/create-user-ui-config-api.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+var index = require('./entities/index.js');
+
+/**
+ * @private
+ */
+function createUserUIConfigApi(makeRequest) {
+    const { wrapUserUIConfig } = index.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);
+        },
+    };
+}
+
+module.exports = createUserUIConfigApi;

package/dist/cjs/enhance-with-methods.cjs

@@ -0,0 +1,26 @@
+'use strict';
+
+/**
+ * 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.
+ */
+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);
+}
+
+module.exports = enhanceWithMethods;

package/dist/cjs/entities/access-token.cjs

@@ -0,0 +1,36 @@
+'use strict';
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('contentful-sdk-core');
+var enhanceWithMethods = require('../enhance-with-methods.js');
+var commonUtils = require('../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 = contentfulSdkCore.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 contentfulSdkCore.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 = commonUtils.wrapCollection(wrapAccessToken);
+
+exports.wrapAccessToken = wrapAccessToken;
+exports.wrapAccessTokenCollection = wrapAccessTokenCollection;

package/dist/cjs/entities/ai-action-invocation.cjs

@@ -0,0 +1,46 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.js');
+
+exports.InvocationStatus = void 0;
+(function (InvocationStatus) {
+    InvocationStatus["Scheduled"] = "SCHEDULED";
+    InvocationStatus["InProgress"] = "IN_PROGRESS";
+    InvocationStatus["Failed"] = "FAILED";
+    InvocationStatus["Completed"] = "COMPLETED";
+    InvocationStatus["Cancelled"] = "CANCELLED";
+})(exports.InvocationStatus || (exports.InvocationStatus = {}));
+exports.InvocationResultType = void 0;
+(function (InvocationResultType) {
+    InvocationResultType["Text"] = "text";
+})(exports.InvocationResultType || (exports.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 = contentfulSdkCore.toPlainObject(copy(data));
+    return contentfulSdkCore.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 = commonUtils.wrapCollection(wrapAiActionInvocation);
+
+exports.AiActionOutputFormat = AiActionOutputFormat;
+exports.wrapAiActionInvocation = wrapAiActionInvocation;
+exports.wrapAiActionInvocationCollection = wrapAiActionInvocationCollection;

package/dist/cjs/entities/ai-action.cjs

@@ -0,0 +1,94 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.js');
+var enhanceWithMethods = require('../enhance-with-methods.js');
+var aiActionInvocation = require('./ai-action-invocation.js');
+
+exports.StatusFilter = void 0;
+(function (StatusFilter) {
+    StatusFilter["ALL"] = "all";
+    StatusFilter["PUBLISHED"] = "published";
+})(exports.StatusFilter || (exports.StatusFilter = {}));
+exports.VariableType = void 0;
+(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";
+})(exports.VariableType || (exports.VariableType = {}));
+exports.EntityTypeEntry = void 0;
+(function (EntityTypeEntry) {
+    EntityTypeEntry["ENTRY"] = "Entry";
+})(exports.EntityTypeEntry || (exports.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) => aiActionInvocation.wrapAiActionInvocation(makeRequest, data));
+        },
+    };
+}
+function wrapAiAction(makeRequest, data) {
+    const aiAction = contentfulSdkCore.toPlainObject(copy(data));
+    const aiActionWithMethods = enhanceWithMethods(aiAction, createAiActionApi(makeRequest));
+    return contentfulSdkCore.freezeSys(aiActionWithMethods);
+}
+const wrapAiActionCollection = commonUtils.wrapCollection(wrapAiAction);
+
+exports.wrapAiAction = wrapAiAction;
+exports.wrapAiActionCollection = wrapAiActionCollection;

package/dist/cjs/entities/api-key.cjs

@@ -0,0 +1,59 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.js');
+var enhanceWithMethods = require('../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 = contentfulSdkCore.toPlainObject(copy(data));
+    const apiKeyWithMethods = enhanceWithMethods(apiKey, createApiKeyApi(makeRequest));
+    return contentfulSdkCore.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 = commonUtils.wrapCollection(wrapApiKey);
+
+exports.wrapApiKey = wrapApiKey;
+exports.wrapApiKeyCollection = wrapApiKeyCollection;

package/dist/cjs/entities/app-access-token.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('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 = contentfulSdkCore.toPlainObject(copy(data));
+    return contentfulSdkCore.freezeSys(appAccessToken);
+}
+
+exports.wrapAppAccessToken = wrapAppAccessToken;

package/dist/cjs/entities/app-action-call.cjs

@@ -0,0 +1,67 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('contentful-sdk-core');
+var enhanceWithMethods = require('../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 = contentfulSdkCore.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 = contentfulSdkCore.toPlainObject(copy(data));
+    const appActionCallResponseWithMethods = enhanceWithMethods(appActionCallResponse, createAppActionCallApi(makeRequest, retryOptions));
+    return appActionCallResponseWithMethods;
+}
+
+exports.default = createAppActionCallApi;
+exports.wrapAppActionCall = wrapAppActionCall;
+exports.wrapAppActionCallResponse = wrapAppActionCallResponse;

package/dist/cjs/entities/app-action.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.js');
+var enhanceWithMethods = require('../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 = contentfulSdkCore.toPlainObject(copy(data));
+    const appActionWithMethods = enhanceWithMethods(appAction, createAppActionApi(makeRequest));
+    return contentfulSdkCore.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 = commonUtils.wrapCollection(wrapAppAction);
+
+exports.wrapAppAction = wrapAppAction;
+exports.wrapAppActionCollection = wrapAppActionCollection;

package/dist/cjs/entities/app-bundle.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+var contentfulSdkCore = require('contentful-sdk-core');
+var copy = require('fast-copy');
+var commonUtils = require('../common-utils.js');
+var enhanceWithMethods = require('../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 = contentfulSdkCore.toPlainObject(copy(data));
+    const appBundleWithMethods = enhanceWithMethods(appBundle, createAppBundleApi(makeRequest));
+    return contentfulSdkCore.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 = commonUtils.wrapCollection(wrapAppBundle);
+
+exports.wrapAppBundle = wrapAppBundle;
+exports.wrapAppBundleCollection = wrapAppBundleCollection;

package/dist/cjs/entities/app-definition.cjs

@@ -0,0 +1,29 @@
+'use strict';
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('contentful-sdk-core');
+var enhanceWithMethods = require('../enhance-with-methods.js');
+var commonUtils = require('../common-utils.js');
+var createAppDefinitionApi = require('../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 = contentfulSdkCore.toPlainObject(copy(data));
+    const appDefinitionWithMethods = enhanceWithMethods(appDefinition, createAppDefinitionApi(makeRequest));
+    return contentfulSdkCore.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 = commonUtils.wrapCollection(wrapAppDefinition);
+
+exports.wrapAppDefinition = wrapAppDefinition;
+exports.wrapAppDefinitionCollection = wrapAppDefinitionCollection;

package/dist/cjs/entities/app-details.cjs

@@ -0,0 +1,39 @@
+'use strict';
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('contentful-sdk-core');
+var enhanceWithMethods = require('../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 = contentfulSdkCore.toPlainObject(copy(data));
+    return enhanceWithMethods(appDetails, createAppDetailsApi(makeRequest));
+}
+
+exports.wrapAppDetails = wrapAppDetails;

package/dist/cjs/entities/app-event-subscription.cjs

@@ -0,0 +1,34 @@
+'use strict';
+
+var copy = require('fast-copy');
+var contentfulSdkCore = require('contentful-sdk-core');
+var enhanceWithMethods = require('../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 = contentfulSdkCore.toPlainObject(copy(data));
+    return enhanceWithMethods(eventSubscription, createEventSubscriptionApi(makeRequest));
+}
+
+exports.wrapAppEventSubscription = wrapAppEventSubscription;