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

package/dist/types/entities/environment.js

@@ -0,0 +1,31 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import createEnvironmentApi from '../create-environment-api.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * This method creates the API for the given environment with all the methods for
+ * reading and creating other entities. It also passes down a clone of the
+ * http client with a environment id, so the base path for requests now has the
+ * environment id already set.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - API response for a Environment
+ * @return
+ */
+function wrapEnvironment(makeRequest, data) {
+    // do not pollute generated typings
+    const environment = toPlainObject(copy(data));
+    const environmentApi = createEnvironmentApi(makeRequest);
+    const enhancedEnvironment = enhanceWithMethods(environment, environmentApi);
+    return freezeSys(enhancedEnvironment);
+}
+/**
+ * This method wraps each environment in a collection with the environment API. See wrapEnvironment
+ * above for more details.
+ * @private
+ */
+const wrapEnvironmentCollection = wrapCollection(wrapEnvironment);
+
+export { wrapEnvironment, wrapEnvironmentCollection };

package/dist/types/entities/extension.js

@@ -0,0 +1,51 @@
+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 createExtensionApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        environmentId: data.sys.environment.sys.id,
+        extensionId: data.sys.id,
+    });
+    return {
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Extension',
+                action: 'update',
+                params: getParams(data),
+                payload: data,
+            }).then((response) => wrapExtension(makeRequest, response));
+        },
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Extension',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw UI Extension data
+ * @return Wrapped UI Extension data
+ */
+function wrapExtension(makeRequest, data) {
+    const extension = toPlainObject(copy(data));
+    const extensionWithMethods = enhanceWithMethods(extension, createExtensionApi(makeRequest));
+    return freezeSys(extensionWithMethods);
+}
+/**
+ * @private
+ */
+const wrapExtensionCollection = wrapCollection(wrapExtension);
+
+export { wrapExtension, wrapExtensionCollection };

package/dist/types/entities/function-log.js

@@ -0,0 +1,23 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - raw contentful-Function data
+ * @return Wrapped Function data
+ */
+function wrapFunctionLog(makeRequest, data) {
+    const functionLog = toPlainObject(copy(data));
+    return freezeSys(functionLog);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - raw contentful-function data
+ * @return Wrapped App Function collection data
+ */
+const wrapFunctionLogCollection = wrapCollection(wrapFunctionLog);
+
+export { wrapFunctionLog, wrapFunctionLogCollection };

package/dist/types/entities/function.js

@@ -0,0 +1,63 @@
+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 createFunctionApi(makeRequest) {
+    return {
+        getFunction: function getFunction() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Function',
+                action: 'get',
+                params: {
+                    organizationId: raw.sys.organization.sys.id,
+                    appDefinitionId: raw.sys.appDefinition.sys.id,
+                    functionId: raw.sys.id,
+                },
+            }).then((data) => wrapFunction(makeRequest, data));
+        },
+        getManyFunctions: function getManyFunctions() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Function',
+                action: 'getMany',
+                params: {
+                    appDefinitionId: raw.sys.appDefinition.sys.id,
+                    organizationId: raw.sys.organization.sys.id,
+                },
+            }).then((data) => wrapFunctionCollection(makeRequest, data));
+        },
+        getManyFunctionsForEnvironment(spaceId, environmentId, appInstallationId) {
+            return makeRequest({
+                entityType: 'Function',
+                action: 'getManyForEnvironment',
+                params: {
+                    spaceId: spaceId,
+                    environmentId: environmentId,
+                    appInstallationId: appInstallationId,
+                },
+            }).then((data) => wrapFunctionCollection(makeRequest, data));
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - (real) function to make requests via an adapter
+ * @param data - raw contentful-Function data
+ * @return Wrapped Function data
+ */
+function wrapFunction(makeRequest, data) {
+    const func = toPlainObject(copy(data));
+    const funcWithMethods = enhanceWithMethods(func, createFunctionApi(makeRequest));
+    return freezeSys(funcWithMethods);
+}
+/**
+ * @private
+ */
+const wrapFunctionCollection = wrapCollection(wrapFunction);
+
+export { wrapFunction, wrapFunctionCollection };

package/dist/types/entities/locale.js

@@ -0,0 +1,54 @@
+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 createLocaleApi(makeRequest) {
+    const getParams = (locale) => ({
+        spaceId: locale.sys.space.sys.id,
+        environmentId: locale.sys.environment.sys.id,
+        localeId: locale.sys.id,
+    });
+    return {
+        update: function () {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Locale',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            }).then((data) => wrapLocale(makeRequest, data));
+        },
+        delete: function () {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'Locale',
+                action: 'delete',
+                params: getParams(raw),
+            }).then(() => {
+                // noop
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw locale data
+ * @return Wrapped locale data
+ */
+function wrapLocale(makeRequest, data) {
+    delete data.internal_code;
+    const locale = toPlainObject(copy(data));
+    const localeWithMethods = enhanceWithMethods(locale, createLocaleApi(makeRequest));
+    return freezeSys(localeWithMethods);
+}
+/**
+ * @private
+ */
+const wrapLocaleCollection = wrapCollection(wrapLocale);
+
+export { wrapLocale, wrapLocaleCollection };

package/dist/types/entities/oauth-application.js

@@ -0,0 +1,63 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import copy from 'fast-copy';
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+
+var ScopeValues;
+(function (ScopeValues) {
+    ScopeValues["Read"] = "content_management_read";
+    ScopeValues["Manage"] = "content_management_manage";
+})(ScopeValues || (ScopeValues = {}));
+/**
+ * @private
+ */
+function createOAuthApplicationApi(makeRequest, userId) {
+    const getParams = (data) => ({
+        userId,
+        oauthApplicationId: data.sys.id,
+    });
+    return {
+        /**
+         * Updates an OAuth application
+         * @return Promise for the updated OAuth application
+         */
+        async update() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'OAuthApplication',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            });
+        },
+        /**
+         * Deletes an OAuth application
+         * @return Promise for the deleted OAuth application
+         */
+        async delete() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'OAuthApplication',
+                action: 'delete',
+                params: getParams(raw),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw OAuth application data
+ * @return Wrapped OAuth application data
+ */
+function wrapOAuthApplication(makeRequest, data, userId) {
+    const oauthApplication = toPlainObject(copy(data));
+    const oauthApplicationWithMethods = enhanceWithMethods(oauthApplication, createOAuthApplicationApi(makeRequest, userId));
+    return freezeSys(oauthApplicationWithMethods);
+}
+/**
+ * @private
+ */
+const wrapOAuthApplicationCollection = wrapCursorPaginatedCollection(wrapOAuthApplication);
+
+export { ScopeValues, wrapOAuthApplication, wrapOAuthApplicationCollection };

package/dist/types/entities/organization-invitation.js

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

package/dist/types/entities/organization-membership.js

@@ -0,0 +1,50 @@
+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 createOrganizationMembershipApi(makeRequest, organizationId) {
+    const getParams = (data) => ({
+        organizationMembershipId: data.sys.id,
+        organizationId,
+    });
+    return {
+        update: function () {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'OrganizationMembership',
+                action: 'update',
+                params: getParams(raw),
+                payload: raw,
+            }).then((data) => wrapOrganizationMembership(makeRequest, data, organizationId));
+        },
+        delete: function del() {
+            const raw = this.toPlainObject();
+            return makeRequest({
+                entityType: 'OrganizationMembership',
+                action: 'delete',
+                params: getParams(raw),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param {function} makeRequest - function to make requests via an adapter
+ * @param {Object} data - Raw organization membership data
+ * @return {OrganizationMembership} Wrapped organization membership data
+ */
+function wrapOrganizationMembership(makeRequest, data, organizationId) {
+    const organizationMembership = toPlainObject(copy(data));
+    const organizationMembershipWithMethods = enhanceWithMethods(organizationMembership, createOrganizationMembershipApi(makeRequest, organizationId));
+    return freezeSys(organizationMembershipWithMethods);
+}
+/**
+ * @private
+ */
+const wrapOrganizationMembershipCollection = wrapCollection(wrapOrganizationMembership);
+
+export { wrapOrganizationMembership, wrapOrganizationMembershipCollection };

package/dist/types/entities/organization.js

@@ -0,0 +1,29 @@
+import copy from 'fast-copy';
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import createOrganizationApi from '../create-organization-api.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * This method creates the API for the given organization with all the methods for
+ * reading and creating other entities. It also passes down a clone of the
+ * http client with an organization id, so the base path for requests now has the
+ * organization id already set.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - API response for an Organization
+ * @return {Organization}
+ */
+function wrapOrganization(makeRequest, data) {
+    const org = toPlainObject(copy(data));
+    const orgApi = createOrganizationApi(makeRequest);
+    const enhancedOrganization = enhanceWithMethods(org, orgApi);
+    return freezeSys(enhancedOrganization);
+}
+/**
+ * This method normalizes each organization in a collection.
+ * @private
+ */
+const wrapOrganizationCollection = wrapCollection(wrapOrganization);
+
+export { wrapOrganization, wrapOrganizationCollection };

package/dist/types/entities/personal-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  personal access token data
+ * @return Wrapped personal access token
+ */
+function wrapPersonalAccessToken(makeRequest, data) {
+    const personalAccessToken = toPlainObject(copy(data));
+    const personalAccessTokenWithMethods = enhanceWithMethods(personalAccessToken, {
+        revoke: function () {
+            return makeRequest({
+                entityType: 'PersonalAccessToken',
+                action: 'revoke',
+                params: { tokenId: data.sys.id },
+            }).then((data) => wrapPersonalAccessToken(makeRequest, data));
+        },
+    });
+    return freezeSys(personalAccessTokenWithMethods);
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw personal access collection data
+ * @return Wrapped personal access token collection data
+ */
+const wrapPersonalAccessTokenCollection = wrapCollection(wrapPersonalAccessToken);
+
+export { wrapPersonalAccessToken, wrapPersonalAccessTokenCollection };

package/dist/types/entities/preview-api-key.js

@@ -0,0 +1,28 @@
+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 createPreviewApiKeyApi() {
+    return {};
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw api key data
+ * @return Wrapped preview api key data
+ */
+function wrapPreviewApiKey(_makeRequest, data) {
+    const previewApiKey = toPlainObject(copy(data));
+    const previewApiKeyWithMethods = enhanceWithMethods(previewApiKey, createPreviewApiKeyApi());
+    return freezeSys(previewApiKeyWithMethods);
+}
+/**
+ * @private
+ */
+const wrapPreviewApiKeyCollection = wrapCollection(wrapPreviewApiKey);
+
+export { wrapPreviewApiKey, wrapPreviewApiKeyCollection };

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

@@ -0,0 +1,52 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils.js';
+import { pollAsyncActionStatus } from '../methods/action.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @private
+ */
+function createReleaseActionApi(makeRequest) {
+    const getParams = (self) => {
+        const action = self.toPlainObject();
+        return {
+            spaceId: action.sys.space.sys.id,
+            environmentId: action.sys.environment.sys.id,
+            releaseId: action.sys.release.sys.id,
+            actionId: action.sys.id,
+        };
+    };
+    return {
+        async get() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'ReleaseAction',
+                action: 'get',
+                params,
+            }).then((releaseAction) => wrapReleaseAction(makeRequest, releaseAction));
+        },
+        /** Waits for a Release Action to complete */
+        async waitProcessing(options) {
+            return pollAsyncActionStatus(async () => this.get(), options);
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Release data
+ * @return Wrapped Release data
+ */
+function wrapReleaseAction(makeRequest, data) {
+    const releaseAction = toPlainObject(copy(data));
+    const releaseActionWithApiMethods = enhanceWithMethods(releaseAction, createReleaseActionApi(makeRequest));
+    return freezeSys(releaseActionWithApiMethods);
+}
+/**
+ * @private
+ */
+const wrapReleaseActionCollection = wrapCollection(wrapReleaseAction);
+
+export { wrapReleaseAction, wrapReleaseActionCollection };

package/dist/types/entities/release.js

@@ -0,0 +1,106 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import '../common-types.js';
+import { wrapCursorPaginatedCollection } from '../common-utils.js';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapReleaseAction } from './release-action.js';
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/**
+ * @private
+ */
+function createReleaseApi(makeRequest) {
+    const getParams = (self) => {
+        const release = self.toPlainObject();
+        return {
+            spaceId: release.sys.space.sys.id,
+            environmentId: release.sys.environment.sys.id,
+            releaseId: release.sys.id,
+            version: release.sys.version,
+        };
+    };
+    return {
+        async archive() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'archive',
+                params,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async unarchive() {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'unarchive',
+                params,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async update(payload) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'update',
+                params,
+                payload,
+            }).then((release) => wrapRelease(makeRequest, release));
+        },
+        async delete() {
+            const params = getParams(this);
+            await makeRequest({
+                entityType: 'Release',
+                action: 'delete',
+                params,
+            });
+        },
+        async publish(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'publish',
+                params,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options));
+        },
+        async unpublish(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'unpublish',
+                params,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options));
+        },
+        async validate(options) {
+            const params = getParams(this);
+            return makeRequest({
+                entityType: 'Release',
+                action: 'validate',
+                params,
+                payload: options?.payload,
+            })
+                .then((data) => wrapReleaseAction(makeRequest, data))
+                .then((action) => action.waitProcessing(options?.processingOptions));
+        },
+    };
+}
+/**
+ * Return a Release object enhanced with its own API helper functions.
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw Release data
+ * @return Wrapped Release data
+ */
+function wrapRelease(makeRequest, data) {
+    const release = toPlainObject(copy(data));
+    const releaseWithApiMethods = enhanceWithMethods(release, createReleaseApi(makeRequest));
+    return freezeSys(releaseWithApiMethods);
+}
+/**
+ * @private
+ */
+const wrapReleaseCollection = wrapCursorPaginatedCollection(wrapRelease);
+
+export { wrapRelease, wrapReleaseCollection };

package/dist/types/entities/resource-provider.d.ts

@@ -1,5 +1,5 @@
 import type { BasicMetaSysProps, CollectionProp, DefaultElements, Link, MakeRequest } from '../common-types.js';
-import type { ResourceType, UpsertResourceTypeProps } from './resource-type.js';
+import { type ResourceType, type UpsertResourceTypeProps } from './resource-type.js';
 export type ResourceProviderProps = {
     /**
      * System metadata