contentful-management 11.44.0 → 11.45.0-beta.2

package/dist/es-modules/entities/function.js

@@ -1,24 +0,0 @@
-import { freezeSys, toPlainObject } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import { wrapCollection } from '../common-utils';
-import enhanceWithMethods from '../enhance-with-methods';
-import createFunctionApi from '../create-function-api';
-/**
- * @private
- * @param makeRequest - (real) function to make requests via an adapter
- * @param data - raw contentful-Function data
- * @return Wrapped Function data
- */
-export function wrapFunction(makeRequest, data) {
-  const appAction = toPlainObject(copy(data));
-  const appActionWithMethods = enhanceWithMethods(appAction, createFunctionApi(makeRequest));
-  return freezeSys(appActionWithMethods);
-}
-
-/**
- * @private
- * @param makeRequest - real) function to make requests via an adapter
- * @param data - raw contentful-function data
- * @return Wrapped App Function collection data
- */
-export const wrapFunctionCollection = wrapCollection(wrapFunction);

package/dist/es-modules/entities/index.js

@@ -1,118 +0,0 @@
-import * as apiKey from './api-key';
-import * as appAction from './app-action';
-import * as appActionCall from './app-action-call';
-import * as appBundle from './app-bundle';
-import * as appDefinition from './app-definition';
-import * as appDetails from './app-details';
-import * as appInstallation from './app-installation';
-import * as appSignedRequest from './app-signed-request';
-import * as appSigningSecret from './app-signing-secret';
-import * as appEventSubscription from './app-event-subscription';
-import * as appKey from './app-key';
-import * as appAccessToken from './app-access-token';
-import * as appUpload from './app-upload';
-import * as asset from './asset';
-import * as assetKey from './asset-key';
-import * as bulkAction from './bulk-action';
-import * as comment from './comment';
-import * as contentType from './content-type';
-import * as editorInterface from './editor-interface';
-import * as entry from './entry';
-import * as environment from './environment';
-import * as environmentAlias from './environment-alias';
-import * as environmentTemplate from './environment-template';
-import * as environmentTemplateInstallation from './environment-template-installation';
-import * as extension from './extension';
-import * as func from './function';
-import * as locale from './locale';
-import * as organization from './organization';
-import * as organizationInvitation from './organization-invitation';
-import * as organizationMembership from './organization-membership';
-import * as personalAccessToken from './personal-access-token';
-import * as accessToken from './access-token';
-import * as previewApiKey from './preview-api-key';
-import * as release from './release';
-import * as releaseAction from './release-action';
-import * as role from './role';
-import * as scheduledAction from './scheduled-action';
-import * as snapshot from './snapshot';
-import * as space from './space';
-import * as spaceMember from './space-member';
-import * as spaceMembership from './space-membership';
-import * as tag from './tag';
-import * as task from './task';
-import * as team from './team';
-import * as teamMembership from './team-membership';
-import * as teamSpaceMembership from './team-space-membership';
-import * as uiConfig from './ui-config';
-import * as upload from './upload';
-import * as usage from './usage';
-import * as user from './user';
-import * as userUIConfig from './user-ui-config';
-import * as webhook from './webhook';
-import * as workflowDefinition from './workflow-definition';
-import * as concept from './concept';
-import * as conceptScheme from './concept-scheme';
-import * as resourceProvider from './resource-provider';
-import * as resourceType from './resource-type';
-import * as resource from './resource';
-export default {
-  accessToken,
-  appAction,
-  appActionCall,
-  appBundle,
-  apiKey,
-  appDefinition,
-  appInstallation,
-  appUpload,
-  appDetails,
-  appSignedRequest,
-  appSigningSecret,
-  appEventSubscription,
-  appKey,
-  appAccessToken,
-  asset,
-  assetKey,
-  bulkAction,
-  comment,
-  concept,
-  conceptScheme,
-  contentType,
-  editorInterface,
-  entry,
-  environment,
-  environmentAlias,
-  environmentTemplate,
-  environmentTemplateInstallation,
-  extension,
-  func,
-  locale,
-  organization,
-  organizationInvitation,
-  organizationMembership,
-  personalAccessToken,
-  previewApiKey,
-  release,
-  releaseAction,
-  resourceProvider,
-  resourceType,
-  resource,
-  role,
-  scheduledAction,
-  snapshot,
-  space,
-  spaceMember,
-  spaceMembership,
-  tag,
-  task,
-  team,
-  teamMembership,
-  teamSpaceMembership,
-  uiConfig,
-  upload,
-  usage,
-  user,
-  userUIConfig,
-  webhook,
-  workflowDefinition
-};

package/dist/es-modules/entities/locale.js

@@ -1,53 +0,0 @@
-import copy from 'fast-copy';
-import { freezeSys, toPlainObject } from 'contentful-sdk-core';
-import enhanceWithMethods from '../enhance-with-methods';
-import { wrapCollection } from '../common-utils';
-/**
- * @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
- */
-export function wrapLocale(makeRequest, data) {
-  delete data.internal_code;
-  const locale = toPlainObject(copy(data));
-  const localeWithMethods = enhanceWithMethods(locale, createLocaleApi(makeRequest));
-  return freezeSys(localeWithMethods);
-}
-
-/**
- * @private
- */
-export const wrapLocaleCollection = wrapCollection(wrapLocale);

package/dist/es-modules/entities/organization-invitation.js

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

package/dist/es-modules/entities/organization-membership.js

@@ -1,49 +0,0 @@
-import copy from 'fast-copy';
-import { freezeSys, toPlainObject } from 'contentful-sdk-core';
-import enhanceWithMethods from '../enhance-with-methods';
-import { wrapCollection } from '../common-utils';
-/**
- * @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
- */
-export function wrapOrganizationMembership(makeRequest, data, organizationId) {
-  const organizationMembership = toPlainObject(copy(data));
-  const organizationMembershipWithMethods = enhanceWithMethods(organizationMembership, createOrganizationMembershipApi(makeRequest, organizationId));
-  return freezeSys(organizationMembershipWithMethods);
-}
-
-/**
- * @private
- */
-export const wrapOrganizationMembershipCollection = wrapCollection(wrapOrganizationMembership);

package/dist/es-modules/entities/organization.js

@@ -1,32 +0,0 @@
-import copy from 'fast-copy';
-import { freezeSys, toPlainObject } from 'contentful-sdk-core';
-import enhanceWithMethods from '../enhance-with-methods';
-import createOrganizationApi from '../create-organization-api';
-import { wrapCollection } from '../common-utils';
-
-/**
- * @deprecated Use `OrganizationProps` instead.
- */
-
-/**
- * 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}
- */
-export 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
- */
-export const wrapOrganizationCollection = wrapCollection(wrapOrganization);

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

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

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

@@ -1,27 +0,0 @@
-import { freezeSys, toPlainObject } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import { wrapCollection } from '../common-utils';
-import enhanceWithMethods from '../enhance-with-methods';
-/**
- * @private
- */
-function createPreviewApiKeyApi() {
-  return {};
-}
-
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw api key data
- * @return Wrapped preview api key data
- */
-export function wrapPreviewApiKey(_makeRequest, data) {
-  const previewApiKey = toPlainObject(copy(data));
-  const previewApiKeyWithMethods = enhanceWithMethods(previewApiKey, createPreviewApiKeyApi());
-  return freezeSys(previewApiKeyWithMethods);
-}
-
-/**
- * @private
- */
-export const wrapPreviewApiKeyCollection = wrapCollection(wrapPreviewApiKey);

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

@@ -1,53 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { freezeSys, toPlainObject } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import { wrapCollection } from '../common-utils';
-import { pollAsyncActionStatus } from '../methods/action';
-import enhanceWithMethods from '../enhance-with-methods';
-
-/** The object returned by the Releases API */
-
-/**
- * @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
- */
-export function wrapReleaseAction(makeRequest, data) {
-  const releaseAction = toPlainObject(copy(data));
-  const releaseActionWithApiMethods = enhanceWithMethods(releaseAction, createReleaseActionApi(makeRequest));
-  return freezeSys(releaseActionWithApiMethods);
-}
-
-/**
- * @private
- */
-export const wrapReleaseActionCollection = wrapCollection(wrapReleaseAction);

package/dist/es-modules/entities/release.js

@@ -1,105 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { freezeSys, toPlainObject } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import { ScheduledActionReferenceFilters } from '../common-types';
-import { wrapCursorPaginatedCollection } from '../common-utils';
-import enhanceWithMethods from '../enhance-with-methods';
-import { wrapReleaseAction } from './release-action';
-
-/** Entity types supported by the Release API */
-
-export const ReleaseReferenceFilters = ScheduledActionReferenceFilters;
-
-/** The object returned by the Releases API */
-
-/**
- * @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
- */
-export function wrapRelease(makeRequest, data) {
-  const release = toPlainObject(copy(data));
-  const releaseWithApiMethods = enhanceWithMethods(release, createReleaseApi(makeRequest));
-  return freezeSys(releaseWithApiMethods);
-}
-
-/**
- * @private
- */
-export const wrapReleaseCollection = wrapCursorPaginatedCollection(wrapRelease);

package/dist/es-modules/entities/resource-provider.js

@@ -1,139 +0,0 @@
-import { toPlainObject, freezeSys } from 'contentful-sdk-core';
-import copy from 'fast-copy';
-import enhanceWithMethods from '../enhance-with-methods';
-import entities from '.';
-/**
- * @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
- */
-export function wrapResourceProvider(makeRequest, data) {
-  const resourceProvider = toPlainObject(copy(data));
-  const ResourceProviderWithMethods = enhanceWithMethods(resourceProvider, createResourceProviderApi(makeRequest));
-  return freezeSys(ResourceProviderWithMethods);
-}