contentful-management 12.0.0-beta.8 → 12.0.0-beta.9

package/dist/types/entities/app-key.js

@@ -0,0 +1,41 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+function createKeyApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+        fingerprint: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppKey',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppKey data
+ * @return Wrapped AppKey data
+ */
+function wrapAppKey(makeRequest, data) {
+    const key = toPlainObject(copy(data));
+    return enhanceWithMethods(key, createKeyApi(makeRequest));
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Key collection data
+ * @return Wrapped App Key collection data
+ */
+const wrapAppKeyCollection = wrapCollection(wrapAppKey);
+
+export { wrapAppKey, wrapAppKeyCollection };

package/dist/types/entities/app-signed-request.js

@@ -0,0 +1,15 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppSignedRequest data
+ * @return Wrapped AppSignedRequest data
+ */
+function wrapAppSignedRequest(_makeRequest, data) {
+    const signedRequest = toPlainObject(copy(data));
+    return signedRequest;
+}
+
+export { wrapAppSignedRequest };

package/dist/types/entities/app-signing-secret.js

@@ -0,0 +1,32 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+function createSigningSecretApi(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: 'AppSigningSecret',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppSigningSecret data
+ * @return Wrapped AppSigningSecret data
+ */
+function wrapAppSigningSecret(makeRequest, data) {
+    const signingSecret = toPlainObject(copy(data));
+    return enhanceWithMethods(signingSecret, createSigningSecretApi(makeRequest));
+}
+
+export { wrapAppSigningSecret };

package/dist/types/entities/app-upload.js

@@ -0,0 +1,36 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createAppUploadApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appUploadId: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppUpload',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Upload data
+ * @return Wrapped App Upload data
+ */
+function wrapAppUpload(makeRequest, data) {
+    const appUpload = toPlainObject(copy(data));
+    const appUploadWithMethods = enhanceWithMethods(appUpload, createAppUploadApi(makeRequest));
+    return freezeSys(appUploadWithMethods);
+}
+
+export { wrapAppUpload };

package/dist/types/entities/asset-key.js

@@ -0,0 +1,15 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw asset key data
+ * @return Wrapped asset key data
+ */
+function wrapAssetKey(_makeRequest, data) {
+    const assetKey = toPlainObject(copy(data));
+    return assetKey;
+}
+
+export { wrapAssetKey };

package/dist/types/entities/asset.js

@@ -0,0 +1,129 @@
+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 { isPublished, isUpdated, isDraft, isArchived } from '../plain/checks.js';
+
+/**
+ * @private
+ */
+function createAssetApi(makeRequest) {
+    const getParams = (raw) => {
+        return {
+            spaceId: raw.sys.space.sys.id,
+            environmentId: raw.sys.environment.sys.id,
+            assetId: raw.sys.id,
+        };
+    };
+    return {
+        processForLocale: function processForLocale(locale, options) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'processForLocale',
+                params: {
+                    ...getParams(raw),
+                    locale,
+                    options,
+                    asset: raw,
+                },
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        processForAllLocales: function processForAllLocales(options) {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'processForAllLocales',
+                params: {
+                    ...getParams(raw),
+                    asset: raw,
+                    options,
+                },
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        update: function update() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+                headers: {},
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        delete: function del() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'delete',
+                params: getParams(raw),
+            });
+        },
+        publish: function publish() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'publish',
+                params: getParams(raw),
+                payload: raw,
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        unpublish: function unpublish() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'unpublish',
+                params: getParams(raw),
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        archive: function archive() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'archive',
+                params: getParams(raw),
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        unarchive: function unarchive() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Asset',
+                action: 'unarchive',
+                params: getParams(raw),
+            }).then((data) => wrapAsset(makeRequest, data));
+        },
+        isPublished: function isPublished$1() {
+            const raw = this.toPlainObject();
+            return isPublished(raw);
+        },
+        isUpdated: function isUpdated$1() {
+            const raw = this.toPlainObject();
+            return isUpdated(raw);
+        },
+        isDraft: function isDraft$1() {
+            const raw = this.toPlainObject();
+            return isDraft(raw);
+        },
+        isArchived: function isArchived$1() {
+            const raw = this.toPlainObject();
+            return isArchived(raw);
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw asset data
+ * @return Wrapped asset data
+ */
+function wrapAsset(makeRequest, data) {
+    const asset = toPlainObject(copy(data));
+    const assetWithMethods = enhanceWithMethods(asset, createAssetApi(makeRequest));
+    return freezeSys(assetWithMethods);
+}
+/**
+ * @private
+ */
+const wrapAssetCollection = wrapCollection(wrapAsset);
+
+export { wrapAsset, wrapAssetCollection };

package/dist/types/entities/bulk-action.js

@@ -0,0 +1,58 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { pollAsyncActionStatus } from '../methods/action.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/** Represents the state of the BulkAction */
+var BulkActionStatus;
+(function (BulkActionStatus) {
+    /** BulkAction is pending execution */
+    BulkActionStatus["created"] = "created";
+    /** BulkAction has been started and pending completion */
+    BulkActionStatus["inProgress"] = "inProgress";
+    /** BulkAction was completed successfully (terminal state) */
+    BulkActionStatus["succeeded"] = "succeeded";
+    /** BulkAction failed to complete (terminal state) */
+    BulkActionStatus["failed"] = "failed";
+})(BulkActionStatus || (BulkActionStatus = {}));
+Object.values(BulkActionStatus);
+/**
+ * @private
+ */
+function createBulkActionApi(makeRequest) {
+    const getParams = (self) => {
+        const bulkAction = self.toPlainObject();
+        return {
+            spaceId: bulkAction.sys.space.sys.id,
+            environmentId: bulkAction.sys.environment.sys.id,
+            bulkActionId: bulkAction.sys.id,
+        };
+    };
+    return {
+        async get() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'BulkAction',
+                action: 'get',
+                params,
+            }).then((bulkAction) => wrapBulkAction(makeRequest, bulkAction));
+        },
+        async waitProcessing(options) {
+            return pollAsyncActionStatus(async () => this.get(), options);
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw BulkAction data
+ * @return Wrapped BulkAction data
+ */
+function wrapBulkAction(makeRequest, data) {
+    const bulkAction = toPlainObject(copy(data));
+    const bulkActionWithApiMethods = enhanceWithMethods(bulkAction, createBulkActionApi(makeRequest));
+    return freezeSys(bulkActionWithApiMethods);
+}
+
+export { BulkActionStatus, wrapBulkAction };

package/dist/types/entities/comment.js

@@ -0,0 +1,60 @@
+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';
+
+// Remove and replace with BLOCKS as soon as rich-text-types supports mentions
+var CommentNode;
+(function (CommentNode) {
+    CommentNode["Document"] = "document";
+    CommentNode["Paragraph"] = "paragraph";
+    CommentNode["Mention"] = "mention";
+})(CommentNode || (CommentNode = {}));
+/**
+ * @private
+ */
+function createCommentApi(makeRequest) {
+    const getParams = (comment) => ({
+        spaceId: comment.sys.space.sys.id,
+        environmentId: comment.sys.environment.sys.id,
+        entryId: comment.sys.parentEntity.sys.id,
+        commentId: comment.sys.id,
+    });
+    return {
+        update: async function () {
+            const raw = this.toPlainObject();
+            const data = await makeRequest({
+                entityType: 'Comment',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            });
+            return wrapComment(makeRequest, data);
+        },
+        delete: async function () {
+            const raw = this.toPlainObject();
+            await makeRequest({
+                entityType: 'Comment',
+                action: 'delete',
+                params: {
+                    ...getParams(raw),
+                    version: raw.sys.version,
+                },
+            });
+        },
+    };
+}
+/**
+ * @private
+ */
+function wrapComment(makeRequest, data) {
+    const comment = toPlainObject(copy(data));
+    const commentWithMethods = enhanceWithMethods(comment, createCommentApi(makeRequest));
+    return freezeSys(commentWithMethods);
+}
+/**
+ * @private
+ */
+const wrapCommentCollection = wrapCollection(wrapComment);
+
+export { CommentNode, createCommentApi as default, wrapComment, wrapCommentCollection };

package/dist/types/entities/content-type.js

@@ -0,0 +1,117 @@
+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 { isPublished, isUpdated, isDraft } from '../plain/checks.js';
+import { wrapEditorInterface } from './editor-interface.js';
+import { wrapSnapshotCollection, wrapSnapshot } from './snapshot.js';
+import { omitAndDeleteField } from '../methods/content-type.js';
+
+/**
+ * @private
+ */
+function createContentTypeApi(makeRequest) {
+    const getParams = (self) => {
+        const contentType = self.toPlainObject();
+        return {
+            raw: contentType,
+            params: {
+                spaceId: contentType.sys.space.sys.id,
+                environmentId: contentType.sys.environment.sys.id,
+                contentTypeId: contentType.sys.id,
+            },
+        };
+    };
+    return {
+        update: function () {
+            const { raw, params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'update',
+                params,
+                payload: raw,
+            }).then((data) => wrapContentType(makeRequest, data));
+        },
+        delete: function () {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'delete',
+                params,
+            }).then(() => {
+                // noop
+            });
+        },
+        publish: function () {
+            const { raw, params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'publish',
+                params,
+                payload: raw,
+            }).then((data) => wrapContentType(makeRequest, data));
+        },
+        unpublish: function () {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'ContentType',
+                action: 'unpublish',
+                params,
+            }).then((data) => wrapContentType(makeRequest, data));
+        },
+        getEditorInterface: function () {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'EditorInterface',
+                action: 'get',
+                params,
+            }).then((data) => wrapEditorInterface(makeRequest, data));
+        },
+        getSnapshots: function (query = {}) {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'Snapshot',
+                action: 'getManyForContentType',
+                params: { ...params, query },
+            }).then((data) => wrapSnapshotCollection(makeRequest, data));
+        },
+        getSnapshot: function (snapshotId) {
+            const { params } = getParams(this);
+            return makeRequest({
+                entityType: 'Snapshot',
+                action: 'getForContentType',
+                params: { ...params, snapshotId },
+            }).then((data) => wrapSnapshot(makeRequest, data));
+        },
+        isPublished: function () {
+            return isPublished(this);
+        },
+        isUpdated: function () {
+            return isUpdated(this);
+        },
+        isDraft: function () {
+            return isDraft(this);
+        },
+        omitAndDeleteField: function (fieldId) {
+            const { raw, params } = getParams(this);
+            return omitAndDeleteField(makeRequest, { ...params, fieldId }, raw).then((data) => wrapContentType(makeRequest, data));
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw content type data
+ * @return Wrapped content type data
+ */
+function wrapContentType(makeRequest, data) {
+    const contentType = toPlainObject(copy(data));
+    const contentTypeWithMethods = enhanceWithMethods(contentType, createContentTypeApi(makeRequest));
+    return freezeSys(contentTypeWithMethods);
+}
+/**
+ * @private
+ */
+const wrapContentTypeCollection = wrapCollection(wrapContentType);
+
+export { wrapContentType, wrapContentTypeCollection };

package/dist/types/entities/editor-interface.js

@@ -0,0 +1,47 @@
+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
+ */
+function createEditorInterfaceApi(makeRequest) {
+    return {
+        update: function () {
+            const self = this;
+            const raw = self.toPlainObject();
+            return makeRequest({
+                entityType: 'EditorInterface',
+                action: 'update',
+                params: {
+                    spaceId: self.sys.space.sys.id,
+                    environmentId: self.sys.environment.sys.id,
+                    contentTypeId: self.sys.contentType.sys.id,
+                },
+                payload: raw,
+            }).then((response) => wrapEditorInterface(makeRequest, response));
+        },
+        getControlForField: function (fieldId) {
+            const self = this;
+            const result = (self.controls || []).filter((control) => {
+                return control.fieldId === fieldId;
+            });
+            return result && result.length > 0 ? result[0] : null;
+        },
+    };
+}
+/**
+ * @private
+ */
+function wrapEditorInterface(makeRequest, data) {
+    const editorInterface = toPlainObject(copy(data));
+    const editorInterfaceWithMethods = enhanceWithMethods(editorInterface, createEditorInterfaceApi(makeRequest));
+    return freezeSys(editorInterfaceWithMethods);
+}
+/**
+ * @private
+ */
+const wrapEditorInterfaceCollection = wrapCollection(wrapEditorInterface);
+
+export { wrapEditorInterface, wrapEditorInterfaceCollection };

package/dist/types/entities/entry.js

@@ -0,0 +1,24 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import createEntryApi from '../create-entry-api.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw entry data
+ * @return Wrapped entry data
+ */
+function wrapEntry(makeRequest, data) {
+    const entry = toPlainObject(copy(data));
+    const entryWithMethods = enhanceWithMethods(entry, createEntryApi(makeRequest));
+    return freezeSys(entryWithMethods);
+}
+/**
+ * Data is also mixed in with link getters if links exist and includes were requested
+ * @private
+ */
+const wrapEntryCollection = wrapCollection(wrapEntry);
+
+export { wrapEntry, wrapEntryCollection };

package/dist/types/entities/environment-alias.js

@@ -0,0 +1,55 @@
+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
+ */
+function createEnvironmentAliasApi(makeRequest) {
+    const getParams = (alias) => ({
+        spaceId: alias.sys.space.sys.id,
+        environmentAliasId: alias.sys.id,
+    });
+    return {
+        update: function () {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentAlias',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            }).then((data) => wrapEnvironmentAlias(makeRequest, data));
+        },
+        delete: function () {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'EnvironmentAlias',
+                action: 'delete',
+                params: getParams(raw),
+            }).then(() => {
+                // noop
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw environment alias data
+ * @return Wrapped environment alias data
+ */
+function wrapEnvironmentAlias(makeRequest, data) {
+    const alias = toPlainObject(copy(data));
+    const enhancedAlias = enhanceWithMethods(alias, createEnvironmentAliasApi(makeRequest));
+    return freezeSys(enhancedAlias);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw environment alias collection data
+ * @return Wrapped environment alias collection data
+ */
+const wrapEnvironmentAliasCollection = wrapCollection(wrapEnvironmentAlias);
+
+export { wrapEnvironmentAlias, wrapEnvironmentAliasCollection };

package/dist/types/entities/environment-template-installation.js

@@ -0,0 +1,20 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+
+var EnvironmentTemplateInstallationStatuses;
+(function (EnvironmentTemplateInstallationStatuses) {
+    EnvironmentTemplateInstallationStatuses["created"] = "created";
+    EnvironmentTemplateInstallationStatuses["inProgress"] = "inProgress";
+    EnvironmentTemplateInstallationStatuses["failed"] = "failed";
+    EnvironmentTemplateInstallationStatuses["succeeded"] = "succeeded";
+    EnvironmentTemplateInstallationStatuses["disconnected"] = "disconnected";
+    EnvironmentTemplateInstallationStatuses["inRetry"] = "inRetry";
+})(EnvironmentTemplateInstallationStatuses || (EnvironmentTemplateInstallationStatuses = {}));
+function wrapEnvironmentTemplateInstallation(makeRequest, data) {
+    const environmentTemplate = toPlainObject(copy(data));
+    return freezeSys(environmentTemplate);
+}
+const wrapEnvironmentTemplateInstallationCollection = wrapCursorPaginatedCollection(wrapEnvironmentTemplateInstallation);
+
+export { wrapEnvironmentTemplateInstallation, wrapEnvironmentTemplateInstallationCollection };

package/dist/types/entities/environment-template.js

@@ -0,0 +1,15 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+import { createEnvironmentTemplateApi } from '../create-environment-template-api.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+function wrapEnvironmentTemplate(makeRequest, data, organizationId) {
+    const environmentTemplate = toPlainObject(copy(data));
+    const environmentTemplateApi = createEnvironmentTemplateApi(makeRequest, organizationId);
+    const enhancedEnvironmentTemplate = enhanceWithMethods(environmentTemplate, environmentTemplateApi);
+    return freezeSys(enhancedEnvironmentTemplate);
+}
+const wrapEnvironmentTemplateCollection = wrapCursorPaginatedCollection(wrapEnvironmentTemplate);
+
+export { wrapEnvironmentTemplate, wrapEnvironmentTemplateCollection };