contentful-management 11.64.0-new-beta.5 → 11.64.0

package/dist/es-modules/constants/editor-interface-defaults/editors-defaults.js

@@ -0,0 +1,34 @@
+import { DEFAULT_EDITOR_ID, WidgetNamespace } from './types';
+export const EntryEditorWidgetTypes = {
+  DEFAULT_EDITOR: {
+    name: 'Editor',
+    id: DEFAULT_EDITOR_ID,
+    icon: 'Entry'
+  },
+  REFERENCE_TREE: {
+    name: 'References',
+    id: 'reference-tree',
+    icon: 'References'
+  },
+  TAGS_EDITOR: {
+    name: 'Tags',
+    id: 'tags-editor',
+    icon: 'Tags'
+  }
+};
+const DefaultEntryEditor = {
+  widgetId: EntryEditorWidgetTypes.DEFAULT_EDITOR.id,
+  widgetNamespace: WidgetNamespace.EDITOR_BUILTIN,
+  name: EntryEditorWidgetTypes.DEFAULT_EDITOR.name
+};
+const ReferencesEntryEditor = {
+  widgetId: EntryEditorWidgetTypes.REFERENCE_TREE.id,
+  widgetNamespace: WidgetNamespace.EDITOR_BUILTIN,
+  name: EntryEditorWidgetTypes.REFERENCE_TREE.name
+};
+const TagsEditor = {
+  widgetId: EntryEditorWidgetTypes.TAGS_EDITOR.id,
+  widgetNamespace: WidgetNamespace.EDITOR_BUILTIN,
+  name: EntryEditorWidgetTypes.TAGS_EDITOR.name
+};
+export const EntryConfiguration = [DefaultEntryEditor, ReferencesEntryEditor, TagsEditor];

package/dist/es-modules/constants/editor-interface-defaults/index.js

@@ -0,0 +1,9 @@
+import { SidebarAssetConfiguration, SidebarEntryConfiguration } from './sidebar-defaults';
+import { EntryConfiguration } from './editors-defaults';
+import getDefaultControlOfField from './controls-defaults';
+export default {
+  SidebarEntryConfiguration,
+  SidebarAssetConfiguration,
+  EntryConfiguration,
+  getDefaultControlOfField
+};

package/dist/es-modules/constants/editor-interface-defaults/sidebar-defaults.js

@@ -0,0 +1,57 @@
+import { WidgetNamespace } from './types';
+const SidebarWidgetTypes = {
+  USERS: 'users-widget',
+  CONTENT_PREVIEW: 'content-preview-widget',
+  TRANSLATION: 'translation-widget',
+  INCOMING_LINKS: 'incoming-links-widget',
+  PUBLICATION: 'publication-widget',
+  RELEASES: 'releases-widget',
+  VERSIONS: 'versions-widget',
+  INFO_PANEL: 'info-panel',
+  JOBS: 'jobs-widget',
+  COMMENTS_PANEL: 'comments-panel'
+};
+const Publication = {
+  widgetId: SidebarWidgetTypes.PUBLICATION,
+  widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+  name: 'Publish & Status',
+  description: 'Built-in - View entry status, publish, etc.'
+};
+const Releases = {
+  widgetId: SidebarWidgetTypes.RELEASES,
+  widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+  name: 'Release',
+  description: 'Built-in - View release, add to it, etc.'
+};
+const ContentPreview = {
+  widgetId: SidebarWidgetTypes.CONTENT_PREVIEW,
+  widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+  name: 'Preview',
+  description: 'Built-in - Displays preview functionality.'
+};
+const Links = {
+  widgetId: SidebarWidgetTypes.INCOMING_LINKS,
+  widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+  name: 'Links',
+  description: 'Built-in - Shows where an entry is linked.'
+};
+const Translation = {
+  widgetId: SidebarWidgetTypes.TRANSLATION,
+  widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+  name: 'Translation',
+  description: 'Built-in - Manage which translations are visible.'
+};
+const Versions = {
+  widgetId: SidebarWidgetTypes.VERSIONS,
+  widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+  name: 'Versions',
+  description: 'Built-in - View previously published versions. Available only for master environment.'
+};
+const Users = {
+  widgetId: SidebarWidgetTypes.USERS,
+  widgetNamespace: WidgetNamespace.SIDEBAR_BUILTIN,
+  name: 'Users',
+  description: 'Built-in - Displays users on the same entry.'
+};
+export const SidebarEntryConfiguration = [Publication, Releases, ContentPreview, Links, Translation, Versions, Users];
+export const SidebarAssetConfiguration = [Publication, Releases, Links, Translation, Users];

package/dist/es-modules/constants/editor-interface-defaults/types.js

@@ -0,0 +1,14 @@
+export let WidgetNamespace = /*#__PURE__*/function (WidgetNamespace) {
+  WidgetNamespace["BUILTIN"] = "builtin";
+  WidgetNamespace["EXTENSION"] = "extension";
+  WidgetNamespace["SIDEBAR_BUILTIN"] = "sidebar-builtin";
+  WidgetNamespace["APP"] = "app";
+  WidgetNamespace["EDITOR_BUILTIN"] = "editor-builtin";
+  return WidgetNamespace;
+}({});
+export const DEFAULT_EDITOR_ID = 'default-editor';
+
+/**
+ * @private
+ */
+export const in_ = (key, object) => key in object;

package/dist/es-modules/contentful-management.js

@@ -0,0 +1,68 @@
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * Contentful Management API SDK. Allows you to create instances of a client
+ * with access to the Contentful Content Management API.
+ * @packageDocumentation
+ */
+
+import { getUserAgentHeader } from 'contentful-sdk-core';
+import { createAdapter } from './create-adapter';
+import createContentfulApi from './create-contentful-api';
+import { createPlainClient } from './plain/plain-client';
+import * as editorInterfaceDefaults from './constants/editor-interface-defaults';
+import { ScheduledActionStatus } from './entities/scheduled-action';
+export { asIterator } from './plain/as-iterator';
+export { fetchAll } from './plain/pagination-helper';
+export { isDraft, isPublished, isUpdated } from './plain/checks';
+export { createClient };
+export { RestAdapter } from './adapters/REST/rest-adapter';
+export { makeRequest } from './adapters/REST/make-request';
+export { editorInterfaceDefaults };
+export * from './export-types';
+export { ScheduledActionStatus };
+
+/**
+ * @deprecated
+ */
+
+/**
+ * Create a client instance
+ * @param params - Client initialization parameters
+ *
+ * ```javascript
+ * const client = contentfulManagement.createClient({
+ *  accessToken: 'myAccessToken'
+ * })
+ * ```
+ */
+
+// Usually, overloads with more specific signatures should come first but some IDEs are often not able to handle overloads with separate TSDocs correctly
+/**
+ * @deprecated The `alphaFeatures` option is no longer supported. Please use the function without this option.
+ */
+
+function createClient(params, opts = {}) {
+  const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
+  const userAgent = getUserAgentHeader(
+  // @ts-expect-error
+  `${sdkMain}/${"0.0.0-determined-by-semantic-release"}`, params.application, params.integration, params.feature);
+  const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
+    userAgent
+  }));
+
+  // Parameters<?> and ReturnType<?> only return the types of the last overload
+  // https://github.com/microsoft/TypeScript/issues/26591
+  // @ts-expect-error
+  const makeRequest = options => adapter.makeRequest(_objectSpread(_objectSpread({}, options), {}, {
+    userAgent
+  }));
+  if (opts.type === 'plain') {
+    return createPlainClient(makeRequest, opts.defaults);
+  } else {
+    return createContentfulApi(makeRequest);
+  }
+}

package/dist/es-modules/create-adapter.js

@@ -0,0 +1,16 @@
+/**
+ * @packageDocumentation
+ * @hidden
+ */
+
+import { RestAdapter } from './adapters/REST/rest-adapter';
+/**
+ * @private
+ */
+export function createAdapter(params) {
+  if ('apiAdapter' in params) {
+    return params.apiAdapter;
+  } else {
+    return new RestAdapter(params);
+  }
+}

package/dist/es-modules/create-app-definition-api.js

@@ -0,0 +1,263 @@
+import entities from './entities';
+import { wrapAppDefinition } from './entities/app-definition';
+
+/**
+ * @private
+ */
+
+/**
+ * @private
+ */
+export default function createAppDefinitionApi(makeRequest) {
+  const {
+    wrapAppBundle,
+    wrapAppBundleCollection
+  } = entities.appBundle;
+  const {
+    wrapResourceProvider
+  } = entities.resourceProvider;
+  const getParams = data => ({
+    appDefinitionId: data.sys.id,
+    organizationId: data.sys.organization.sys.id
+  });
+  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.name = 'New App Definition name'
+     *   return appDefinition.update()
+     * })
+     * .then((appDefinition) => console.log(`App Definition ${appDefinition.sys.id} updated.`))
+     * .catch(console.error)
+     * ```
+     */
+    update: function update() {
+      const data = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AppDefinition',
+        action: 'update',
+        params: getParams(data),
+        headers: {},
+        payload: data
+      }).then(data => wrapAppDefinition(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.delete())
+     * .then(() => console.log(`App Definition deleted.`))
+     * .catch(console.error)
+     * ```
+     */
+    delete: function del() {
+      const data = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AppDefinition',
+        action: 'delete',
+        params: getParams(data)
+      });
+    },
+    /**
+     * Gets an app bundle
+     * @param id - AppBundle ID
+     * @return Promise for an AppBundle
+     * @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.getAppBundle('<app_upload_id>'))
+     * .then((appBundle) => console.log(appBundle))
+     * .catch(console.error)
+     * ```
+     */
+    getAppBundle(id) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AppBundle',
+        action: 'get',
+        params: {
+          appBundleId: id,
+          appDefinitionId: raw.sys.id,
+          organizationId: raw.sys.organization.sys.id
+        }
+      }).then(data => wrapAppBundle(makeRequest, data));
+    },
+    /**
+     * Gets a collection of AppBundles
+     * @return Promise for a collection of AppBundles
+     * @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.getAppBundles())
+     * .then((response) => console.log(response.items))
+     * .catch(console.error)
+     * ```
+     */
+    getAppBundles(query = {}) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AppBundle',
+        action: 'getMany',
+        params: {
+          organizationId: raw.sys.organization.sys.id,
+          appDefinitionId: raw.sys.id,
+          query
+        }
+      }).then(data => wrapAppBundleCollection(makeRequest, data));
+    },
+    /**
+     * Creates an app bundle
+     * @param Object representation of the App Bundle to be created
+     * @return Promise for the newly created AppBundle
+     * @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.createAppBundle('<app_upload_id>'))
+     * .then((appBundle) => console.log(appBundle))
+     * .catch(console.error)
+     * ```
+     */
+    createAppBundle(data) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AppBundle',
+        action: 'create',
+        params: {
+          appDefinitionId: raw.sys.id,
+          organizationId: raw.sys.organization.sys.id
+        },
+        payload: data
+      }).then(data => wrapAppBundle(makeRequest, data));
+    },
+    /**
+     * Gets a list of App Installations across an org for given organization and App Definition
+     * If a spaceId is provided in the query object, it will return the App Installations for that specific space.
+     * @return Promise for the newly created AppBundle
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     * client.getAppDefinition('<organization_id>', '<app_definition_id>')
+     * .then((appDefinition) => appDefinition.getInstallationsForOrg(
+     *   { spaceId: '<space_id>' } // optional
+     * ))
+     * .then((appInstallationsForOrg) => console.log(appInstallationsForOrg.items))
+     * .catch(console.error)
+     * ```
+     */
+    getInstallationsForOrg(query = {}) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AppDefinition',
+        action: 'getInstallationsForOrg',
+        params: {
+          appDefinitionId: raw.sys.id,
+          organizationId: raw.sys.organization.sys.id,
+          query
+        }
+      });
+    },
+    /**
+     * Creates or updates a resource provider
+     * @param data representation of the ResourceProvider
+     * @return Promise for the newly created or updated ResourceProvider
+     * @example ```javascript
+     * const contentful = require('contentful-management')
+     * const client = contentful.createClient({
+     *   accessToken: '<content_management_api_key>'
+     * })
+     *
+     * // You need a valid AppDefinition with an activated AppBundle that has a contentful function configured
+     * client.getOrganization('<org_id>')
+     * .then((org) => org.getAppDefinition('<app_def_id>'))
+     * .then((appDefinition) => appDefinition.upsertResourceProvider({
+     *    sys: {
+     *      id: '<resource_provider_id>'
+     *    },
+     *    type: 'function',
+     *    function: {
+     *      sys: {
+     *        id: '<contentful_function_id>',
+     *        type: 'Link'
+     *        linkType: 'Function'
+     *      }
+     *    }
+     * }))
+     * .then((resourceProvider) => console.log(resourceProvider))
+     * .catch(console.error)
+     * ```
+     */
+    upsertResourceProvider(data) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'ResourceProvider',
+        action: 'upsert',
+        params: {
+          appDefinitionId: raw.sys.id,
+          organizationId: raw.sys.organization.sys.id
+        },
+        payload: data
+      }).then(payload => wrapResourceProvider(makeRequest, payload));
+    },
+    /**
+     * Gets a Resource Provider
+     * @return Promise for a Resource Provider
+     * @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) => console.log(resourceProvider))
+     * .catch(console.error)
+     * ```
+     */
+    getResourceProvider() {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'ResourceProvider',
+        action: 'get',
+        params: {
+          appDefinitionId: raw.sys.id,
+          organizationId: raw.sys.organization.sys.id
+        }
+      }).then(payload => wrapResourceProvider(makeRequest, payload));
+    }
+  };
+}