contentful-management 12.0.0-beta.8 → 12.0.0-new-beta.1

package/dist/esm/entities/release.js

@@ -1,107 +0,0 @@
-import { toPlainObject, freezeSys } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import { ScheduledActionReferenceFilters } from '../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 */
-const ReleaseReferenceFilters = ScheduledActionReferenceFilters;
-/**
- * @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 === null || options === void 0 ? void 0 : options.payload,
-            })
-                .then((data) => wrapReleaseAction(makeRequest, data))
-                .then((action) => action.waitProcessing(options === null || options === void 0 ? void 0 : 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 { ReleaseReferenceFilters, wrapRelease, wrapReleaseCollection };

package/dist/esm/entities/resource-provider.js

@@ -1,137 +0,0 @@
-import { toPlainObject, freezeSys } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import enhanceWithMethods from '../enhance-with-methods.js';
-import entities from './index.js';
-
-/**
- * @private
- */
-function createResourceProviderApi(makeRequest) {
-    const { wrapResourceType } = entities.resourceType;
-    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.getOrganization('<org_id>')
-         * .then((org) => org.getAppDefinition('<app_def_id>'))
-         * .then((appDefinition) => appDefinition.getResourceProvider())
-         * .then((resourceProvider) => {
-         *    resourceProvider.function.sys.id = '<new_contentful_function_id>'
-         *    return resourceProvider.upsert()
-         * })
-         * .catch(console.error)
-         * ```
-         */
-        upsert: function upsert() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'ResourceProvider',
-                action: 'upsert',
-                params: getParams(data),
-                headers: {},
-                payload: getUpsertParams(data),
-            }).then((data) => wrapResourceProvider(makeRequest, data));
-        },
-        /**
-         * Deletes this object on the server.
-         * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
-         * @example ```javascript
-         * const contentful = require('contentful-management')
-         *
-         * const client = contentful.createClient({
-         *   accessToken: '<content_management_api_key>'
-         * })
-         *
-         * client.getOrganization('<org_id>')
-         * .then((org) => org.getAppDefinition('<app_def_id>'))
-         * .then((appDefinition) => appDefinition.getResourceProvider())
-         * .then((resourceProvider) => resourceProvider.delete())
-         * .catch(console.error)
-         * ```
-         */
-        delete: function del() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'ResourceProvider',
-                action: 'delete',
-                params: getParams(data),
-            });
-        },
-        getResourceType: function getResourceType(id) {
-            return makeRequest({
-                entityType: 'ResourceType',
-                action: 'get',
-                params: {
-                    organizationId: this.sys.organization.sys.id,
-                    appDefinitionId: this.sys.appDefinition.sys.id,
-                    resourceTypeId: id,
-                },
-            }).then((data) => wrapResourceType(makeRequest, data));
-        },
-        upsertResourceType: function upsertResourceType(id, data) {
-            return makeRequest({
-                entityType: 'ResourceType',
-                action: 'upsert',
-                params: {
-                    organizationId: this.sys.organization.sys.id,
-                    appDefinitionId: this.sys.appDefinition.sys.id,
-                    resourceTypeId: id,
-                },
-                headers: {},
-                payload: data,
-            }).then((data) => wrapResourceType(makeRequest, data));
-        },
-        getResourceTypes: function getResourceTypes() {
-            return makeRequest({
-                entityType: 'ResourceType',
-                action: 'getMany',
-                params: {
-                    organizationId: this.sys.organization.sys.id,
-                    appDefinitionId: this.sys.appDefinition.sys.id,
-                },
-            }).then((data) => {
-                data.items = data.items.map((item) => wrapResourceType(makeRequest, item));
-                return data;
-            });
-        },
-    };
-}
-/**
- * @private
- * @param data - raw ResourceProvider Object
- * @return Object containing the http params for the ResourceProvider request: organizationId and appDefinitionId
- */
-const getParams = (data) => ({
-    organizationId: data.sys.organization.sys.id,
-    appDefinitionId: data.sys.appDefinition.sys.id,
-});
-/**
- * @private
- * @param data - raw ResourceProvider Object
- * @return UpsertResourceProviderProps
- */
-const getUpsertParams = (data) => ({
-    sys: { id: data.sys.id },
-    type: data.type,
-    function: data.function,
-});
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw Resource Provider data
- * @return Wrapped Resource Provider data
- */
-function wrapResourceProvider(makeRequest, data) {
-    const resourceProvider = toPlainObject(copy(data));
-    const ResourceProviderWithMethods = enhanceWithMethods(resourceProvider, createResourceProviderApi(makeRequest));
-    return freezeSys(ResourceProviderWithMethods);
-}
-
-export { wrapResourceProvider };

package/dist/esm/entities/resource-type.js

@@ -1,94 +0,0 @@
-import { toPlainObject, freezeSys } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import enhanceWithMethods from '../enhance-with-methods.js';
-import { wrapCursorPaginatedCollection } from '../common-utils.js';
-
-/**
- * @private
- */
-function createResourceTypeApi(makeRequest) {
-    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.getOrganization('<org_id>')
-         * .then((org) => org.getAppDefinition('<app_def_id>'))
-         * .then((appDefinition) => appDefinition.getResourceType())
-         * .then((resourceType) => {
-         *    resourceType.name = '<new_name>'
-         *    return resourceType.upsert()
-         * })
-         * .catch(console.error)
-         * ```
-         */
-        upsert: function upsert() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'ResourceType',
-                action: 'upsert',
-                params: getParams(data),
-                headers: {},
-                payload: getUpsertParams(data),
-            }).then((data) => wrapResourceType(makeRequest, data));
-        },
-        /**
-         * Deletes this object on the server.
-         * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
-         * @example ```javascript
-         * const contentful = require('contentful-management')
-         *
-         * const client = contentful.createClient({
-         *   accessToken: '<content_management_api_key>'
-         * })
-         *
-         * client.getOrganization('<org_id>')
-         * .then((org) => org.getAppDefinition('<app_def_id>'))
-         * .then((appDefinition) => appDefinition.getResourceType())
-         * .then((resourceType) => resourceType.delete())
-         * .catch(console.error)
-         * ```
-         */
-        delete: function del() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'ResourceType',
-                action: 'delete',
-                params: getParams(data),
-            });
-        },
-    };
-}
-const getParams = (data) => ({
-    organizationId: data.sys.organization.sys.id,
-    appDefinitionId: data.sys.appDefinition.sys.id,
-    resourceTypeId: data.sys.id,
-});
-const getUpsertParams = (data) => ({
-    name: data.name,
-    defaultFieldMapping: data.defaultFieldMapping,
-});
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw Resource Type data
- * @return Wrapped Resource Type data
- */
-function wrapResourceType(makeRequest, data) {
-    const resourceType = toPlainObject(copy(data));
-    const ResourceTypeWithMethods = enhanceWithMethods(resourceType, createResourceTypeApi(makeRequest));
-    return freezeSys(ResourceTypeWithMethods);
-}
-function wrapResourceTypeforEnvironment(makeRequest, data) {
-    const resourceType = toPlainObject(data);
-    return freezeSys(resourceType);
-}
-const wrapResourceTypesForEnvironmentCollection = wrapCursorPaginatedCollection(wrapResourceTypeforEnvironment);
-
-export { wrapResourceType, wrapResourceTypeforEnvironment, wrapResourceTypesForEnvironmentCollection };

package/dist/esm/entities/resource.js

@@ -1,10 +0,0 @@
-import { wrapCursorPaginatedCollection } from '../common-utils.js';
-import { toPlainObject, freezeSys } from 'contentful-sdk-core';
-
-function wrapResource(makeRequest, data) {
-    const resource = toPlainObject(data);
-    return freezeSys(resource);
-}
-const wrapResourceCollection = wrapCursorPaginatedCollection(wrapResource);
-
-export { wrapResource, wrapResourceCollection };

package/dist/esm/entities/role.js

@@ -1,50 +0,0 @@
-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 createRoleApi(makeRequest) {
-    const getParams = (data) => ({
-        spaceId: data.sys.space.sys.id,
-        roleId: data.sys.id,
-    });
-    return {
-        update: function update() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'Role',
-                action: 'update',
-                params: getParams(data),
-                payload: data,
-            }).then((data) => wrapRole(makeRequest, data));
-        },
-        delete: function del() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'Role',
-                action: 'delete',
-                params: getParams(data),
-            });
-        },
-    };
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw role data
- * @return Wrapped role data
- */
-function wrapRole(makeRequest, data) {
-    const role = toPlainObject(copy(data));
-    const roleWithMethods = enhanceWithMethods(role, createRoleApi(makeRequest));
-    return freezeSys(roleWithMethods);
-}
-/**
- * @private
- */
-const wrapRoleCollection = wrapCollection(wrapRole);
-
-export { wrapRole, wrapRoleCollection };

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

@@ -1,148 +0,0 @@
-import { __rest } from 'tslib';
-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';
-
-/**
- * Represents that state of the scheduled action
- */
-var ScheduledActionStatus;
-(function (ScheduledActionStatus) {
-    /** action is pending execution */
-    ScheduledActionStatus["scheduled"] = "scheduled";
-    /** action has been started and pending completion */
-    ScheduledActionStatus["inProgress"] = "inProgress";
-    /** action was completed successfully (terminal state) */
-    ScheduledActionStatus["succeeded"] = "succeeded";
-    /** action failed to complete (terminal state) */
-    ScheduledActionStatus["failed"] = "failed";
-    /** action was canceled by a user (terminal state) */
-    ScheduledActionStatus["canceled"] = "canceled";
-})(ScheduledActionStatus || (ScheduledActionStatus = {}));
-function getInstanceMethods(makeRequest) {
-    const getParams = (self) => {
-        var _a;
-        const scheduledAction = self.toPlainObject();
-        return {
-            spaceId: scheduledAction.sys.space.sys.id,
-            environmentId: (_a = scheduledAction.environment) === null || _a === void 0 ? void 0 : _a.sys.id,
-            scheduledActionId: scheduledAction.sys.id,
-            version: scheduledAction.sys.version,
-        };
-    };
-    return {
-        /**
-         * Cancels the current Scheduled Action schedule.
-         *
-         * @example ```javascript
-         *  const contentful = require('contentful-management');
-         *
-         *  const client = contentful.createClient({
-         *    accessToken: '<content_management_api_key>'
-         *  })
-         *
-         *  client.getSpace('<space_id>')
-         *    .then((space) => {
-         *      return space.createScheduledAction({
-         *        entity: {
-         *          sys: {
-         *            type: 'Link',
-         *            linkType: 'Entry',
-         *            id: '<entry_id>'
-         *          }
-         *        },
-         *        environment: {
-         *          sys: {
-         *            type: 'Link',
-         *            linkType: 'Environment',
-         *            id: '<environment_id>'
-         *          }
-         *        },
-         *        action: 'publish',
-         *        scheduledFor: {
-         *          datetime: <ISO_date_string>,
-         *          timezone: 'Europe/Berlin'
-         *        }
-         *      })
-         *    .then((scheduledAction) => scheduledAction.delete())
-         *    .then((deletedScheduledAction) => console.log(deletedScheduledAction))
-         *    .catch(console.error);
-         * ```
-         */
-        async delete() {
-            const params = getParams(this);
-            return makeRequest({
-                entityType: 'ScheduledAction',
-                action: 'delete',
-                params,
-            }).then((data) => wrapScheduledAction(makeRequest, data));
-        },
-        /**
-         * Update the current scheduled action. Currently, only changes made to the `scheduledFor` property will be saved.
-         *
-         * @example ```javascript
-         *  const contentful = require('contentful-management');
-         *
-         *  const client = contentful.createClient({
-         *    accessToken: '<content_management_api_key>'
-         *  })
-         *
-         *  client.getSpace('<space_id>')
-         *    .then((space) => {
-         *      return space.createScheduledAction({
-         *        entity: {
-         *          sys: {
-         *            type: 'Link',
-         *            linkType: 'Entry',
-         *            id: '<entry_id>'
-         *          }
-         *        },
-         *        environment: {
-         *          sys: {
-         *            type: 'Link',
-         *            linkType: 'Environment',
-         *            id: '<environment_id>'
-         *          }
-         *        },
-         *        action: 'publish',
-         *        scheduledFor: {
-         *          datetime: <ISO_date_string>,
-         *          timezone: 'Europe/Berlin'
-         *        }
-         *      })
-         *    .then((scheduledAction) => {
-         *      scheduledAction.scheduledFor.timezone = 'Europe/Paris';
-         *      return scheduledAction.update();
-         *    })
-         *    .then((scheduledAction) => console.log(scheduledAction))
-         *    .catch(console.error);
-         * ```
-         */
-        async update() {
-            const params = getParams(this);
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-            const _a = this.toPlainObject(), payload = __rest(_a, ["sys"]);
-            return makeRequest({
-                entityType: 'ScheduledAction',
-                action: 'update',
-                params,
-                payload,
-            }).then((data) => wrapScheduledAction(makeRequest, data));
-        },
-    };
-}
-/**
- * @private
- */
-function wrapScheduledAction(makeRequest, data) {
-    const scheduledAction = toPlainObject(copy(data));
-    const scheduledActionWithMethods = enhanceWithMethods(scheduledAction, getInstanceMethods(makeRequest));
-    return freezeSys(scheduledActionWithMethods);
-}
-/**
- * @private
- */
-const wrapScheduledActionCollection = wrapCollection(wrapScheduledAction);
-
-export { ScheduledActionStatus, getInstanceMethods as default, wrapScheduledAction, wrapScheduledActionCollection };

package/dist/esm/entities/snapshot.js

@@ -1,33 +0,0 @@
-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 createSnapshotApi() {
-    return {
-    /* In case the snapshot object evolve later */
-    };
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw snapshot data
- * @return Wrapped snapshot data
- */
-function wrapSnapshot(_makeRequest, data) {
-    const snapshot = toPlainObject(copy(data));
-    const snapshotWithMethods = enhanceWithMethods(snapshot, createSnapshotApi());
-    return freezeSys(snapshotWithMethods);
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw snapshot collection data
- * @return Wrapped snapshot collection data
- */
-const wrapSnapshotCollection = wrapCollection(wrapSnapshot);
-
-export { wrapSnapshot, wrapSnapshotCollection };

package/dist/esm/entities/space-member.js

@@ -1,20 +0,0 @@
-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 space member data
- * @return Wrapped space member data
- */
-function wrapSpaceMember(_makeRequest, data) {
-    const spaceMember = toPlainObject(copy(data));
-    return freezeSys(spaceMember);
-}
-/**
- * @private
- */
-const wrapSpaceMemberCollection = wrapCollection(wrapSpaceMember);
-
-export { wrapSpaceMember, wrapSpaceMemberCollection };

package/dist/esm/entities/space-membership.js

@@ -1,50 +0,0 @@
-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 createSpaceMembershipApi(makeRequest) {
-    const getParams = (data) => ({
-        spaceId: data.sys.space.sys.id,
-        spaceMembershipId: data.sys.id,
-    });
-    return {
-        update: function update() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'SpaceMembership',
-                action: 'update',
-                params: getParams(data),
-                payload: data,
-            }).then((data) => wrapSpaceMembership(makeRequest, data));
-        },
-        delete: function del() {
-            const data = this.toPlainObject();
-            return makeRequest({
-                entityType: 'SpaceMembership',
-                action: 'delete',
-                params: getParams(data),
-            });
-        },
-    };
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw space membership data
- * @return Wrapped space membership data
- */
-function wrapSpaceMembership(makeRequest, data) {
-    const spaceMembership = toPlainObject(copy(data));
-    const spaceMembershipWithMethods = enhanceWithMethods(spaceMembership, createSpaceMembershipApi(makeRequest));
-    return freezeSys(spaceMembershipWithMethods);
-}
-/**
- * @private
- */
-const wrapSpaceMembershipCollection = wrapCollection(wrapSpaceMembership);
-
-export { wrapSpaceMembership, wrapSpaceMembershipCollection };

package/dist/esm/entities/space.js

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