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

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

@@ -0,0 +1,76 @@
+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); }
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+import enhanceWithMethods from '../enhance-with-methods';
+/**
+ * @private
+ */
+export default function createWorkflowApi(makeRequest) {
+  const getParams = Workflow => ({
+    spaceId: Workflow.sys.space.sys.id,
+    environmentId: Workflow.sys.environment.sys.id,
+    workflowId: Workflow.sys.id
+  });
+  return {
+    update: function () {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'Workflow',
+        action: 'update',
+        params: getParams(raw),
+        payload: raw
+      }).then(data => wrapWorkflow(makeRequest, data));
+    },
+    get: function () {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'Workflow',
+        action: 'get',
+        params: getParams(raw)
+      }).then(data => wrapWorkflow(makeRequest, data));
+    },
+    delete: function () {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'Workflow',
+        action: 'delete',
+        params: _objectSpread(_objectSpread({}, getParams(raw)), {}, {
+          version: raw.sys.version
+        })
+      }).then(() => {
+        // noop
+      });
+    },
+    complete: function () {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'Workflow',
+        action: 'complete',
+        params: _objectSpread(_objectSpread({}, getParams(raw)), {}, {
+          version: raw.sys.version
+        })
+      }).then(() => {
+        // noop
+      });
+    }
+  };
+}
+
+/**
+ * @private
+ */
+export function wrapWorkflow(makeRequest, data) {
+  const Workflow = toPlainObject(copy(data));
+  const WorkflowWithMethods = enhanceWithMethods(Workflow, createWorkflowApi(makeRequest));
+  return freezeSys(WorkflowWithMethods);
+}
+
+/**
+ * @private
+ */
+export const wrapWorkflowCollection = wrapCollection(wrapWorkflow);

package/dist/es-modules/entities/workflows-changelog-entry.js

@@ -0,0 +1,24 @@
+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 createWorkflowsChangelogEntryApi() {
+  return {};
+}
+
+/**
+ * @private
+ */
+export function wrapWorkflowsChangelogEntry(_makeRequest, data) {
+  const workflowsChangelogEntry = toPlainObject(copy(data));
+  const workflowsChangelogEntryWithMethods = enhanceWithMethods(workflowsChangelogEntry, createWorkflowsChangelogEntryApi());
+  return freezeSys(workflowsChangelogEntryWithMethods);
+}
+
+/**
+ * @private
+ */
+export const wrapWorkflowsChangelogEntryCollection = wrapCollection(wrapWorkflowsChangelogEntry);

package/dist/es-modules/export-types.js

@@ -0,0 +1,3 @@
+export * from './common-types';
+export * from './plain/common-types';
+export { WorkflowStepPermissionAction, WorkflowStepPermissionEffect, WorkflowStepPermissionType } from './entities/workflow-definition';

package/dist/es-modules/methods/action.js

@@ -0,0 +1,54 @@
+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); }
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { sleep } from './utils';
+const DEFAULT_MAX_RETRIES = 30;
+const DEFAULT_INITIAL_DELAY_MS = 1000;
+const DEFAULT_RETRY_INTERVAL_MS = 2000;
+
+/** Action is an interface that has a sys.status to be checked against */
+
+export class AsyncActionProcessingError extends Error {
+  constructor(message, action) {
+    super(message);
+    _defineProperty(this, "action", void 0);
+    this.action = action;
+    this.name = this.constructor.name;
+  }
+}
+export class AsyncActionFailedError extends AsyncActionProcessingError {}
+/**
+ * @description Waits for an Action to be completed and to be in one of the final states (failed or succeeded)
+ * @param {Function} actionFunction - GET function that will be called every interval to fetch an Action status
+ * @throws {ActionFailedError} throws an error if `throwOnFailedExecution = true` with the Action that failed.
+ * @throws {AsyncActionProcessingError} throws an error with a Action when processing takes too long.
+ */
+export async function pollAsyncActionStatus(actionFunction, options) {
+  var _options$retryCount, _options$retryInterva, _options$initialDelay, _options$throwOnFaile, _action;
+  let retryCount = 0;
+  let done = false;
+  let action;
+  const maxRetries = (_options$retryCount = options === null || options === void 0 ? void 0 : options.retryCount) !== null && _options$retryCount !== void 0 ? _options$retryCount : DEFAULT_MAX_RETRIES;
+  const retryIntervalMs = (_options$retryInterva = options === null || options === void 0 ? void 0 : options.retryIntervalMs) !== null && _options$retryInterva !== void 0 ? _options$retryInterva : DEFAULT_RETRY_INTERVAL_MS;
+  const initialDelayMs = (_options$initialDelay = options === null || options === void 0 ? void 0 : options.initialDelayMs) !== null && _options$initialDelay !== void 0 ? _options$initialDelay : DEFAULT_INITIAL_DELAY_MS;
+  const throwOnFailedExecution = (_options$throwOnFaile = options === null || options === void 0 ? void 0 : options.throwOnFailedExecution) !== null && _options$throwOnFaile !== void 0 ? _options$throwOnFaile : true;
+
+  // Initial delay for short-running Actions
+  await sleep(initialDelayMs);
+  while (retryCount < maxRetries && !done) {
+    action = await actionFunction();
+
+    // Terminal states
+    if (action && ['succeeded', 'failed'].includes(action.sys.status)) {
+      done = true;
+      if (action.sys.status === 'failed' && throwOnFailedExecution) {
+        throw new AsyncActionFailedError(`${action.sys.type} failed to execute.`, action);
+      }
+      return action;
+    }
+    await sleep(retryIntervalMs);
+    retryCount += 1;
+  }
+  throw new AsyncActionProcessingError(`${(_action = action) === null || _action === void 0 ? void 0 : _action.sys.type} didn't finish processing within the expected timeframe.`, action);
+}

package/dist/es-modules/methods/content-type.js

@@ -0,0 +1,47 @@
+const _excluded = ["fieldId"];
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+/**
+ * @private
+ * @param id - unique ID of the field
+ * @param key - the attribute on the field to change
+ * @param value - the value to set the attribute to
+ */
+const findAndUpdateField = function (contentType, fieldId, omitOrDelete) {
+  const field = contentType.fields.find(field => field.id === fieldId);
+  if (!field) {
+    return Promise.reject(new Error(`Tried to omitAndDeleteField on a nonexistent field, ${fieldId}, on the content type ${contentType.name}.`));
+  }
+  field[omitOrDelete] = true;
+  return Promise.resolve(contentType);
+};
+export const omitAndDeleteField = (makeRequest, _ref, contentType) => {
+  let {
+      fieldId
+    } = _ref,
+    params = _objectWithoutProperties(_ref, _excluded);
+  return findAndUpdateField(contentType, fieldId, 'omitted').then(newContentType => {
+    return makeRequest({
+      entityType: 'ContentType',
+      action: 'update',
+      params,
+      payload: newContentType
+    });
+  }).then(newContentType => {
+    return makeRequest({
+      entityType: 'ContentType',
+      action: 'publish',
+      params,
+      payload: newContentType
+    });
+  }).then(newContentType => {
+    return findAndUpdateField(newContentType, fieldId, 'deleted');
+  }).then(newContentType => {
+    return makeRequest({
+      entityType: 'ContentType',
+      action: 'update',
+      params,
+      payload: newContentType
+    });
+  });
+};

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

@@ -0,0 +1,17 @@
+import { pollAsyncActionStatus } from './action';
+/** Waits for a ReleaseAction status to be either succeeded or failed.
+ * Used by the Plain client */
+export async function waitForReleaseActionProcessing({
+  plainClient,
+  spaceId,
+  environmentId,
+  releaseId,
+  actionId
+}, options) {
+  return pollAsyncActionStatus(async () => plainClient.releaseAction.get({
+    releaseId,
+    spaceId,
+    environmentId,
+    actionId
+  }), options);
+}

package/dist/es-modules/methods/utils.js

@@ -0,0 +1,7 @@
+/**
+ * Helper function that resolves a Promise after the specified duration (in milliseconds)
+ * @private
+ */
+export function sleep(durationMs) {
+  return new Promise(resolve => setTimeout(resolve, durationMs));
+}

package/dist/es-modules/plain/as-iterator.js

@@ -0,0 +1,47 @@
+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); }
+import copy from 'fast-copy';
+export const asIterator = (fn, params) => {
+  return {
+    [Symbol.asyncIterator]() {
+      let options = copy(params);
+      const get = () => fn(copy(options));
+      let currentResult = get();
+      return {
+        current: 0,
+        async next() {
+          const {
+            total = 0,
+            items = [],
+            skip = 0,
+            limit = 100
+          } = await currentResult;
+          if (total === this.current) {
+            return {
+              done: true,
+              value: null
+            };
+          }
+          const value = items[this.current++ - skip];
+          const endOfPage = this.current % limit === 0;
+          const endOfList = this.current === total;
+          if (endOfPage && !endOfList) {
+            options = _objectSpread(_objectSpread({}, options), {}, {
+              query: _objectSpread(_objectSpread({}, options.query), {}, {
+                skip: skip + limit
+              })
+            });
+            currentResult = get();
+          }
+          return {
+            done: false,
+            value
+          };
+        }
+      };
+    }
+  };
+};

package/dist/es-modules/plain/checks.js

@@ -0,0 +1,8 @@
+export const isPublished = data => !!data.sys.publishedVersion;
+export const isUpdated = data => {
+  // The act of publishing an entity increases its version by 1, so any entry which has
+  // 2 versions higher or more than the publishedVersion has unpublished changes.
+  return !!(data.sys.publishedVersion && data.sys.version > data.sys.publishedVersion + 1);
+};
+export const isDraft = data => !data.sys.publishedVersion;
+export const isArchived = data => !!data.sys.archivedVersion;

package/dist/es-modules/plain/common-types.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/ai-action-invocation.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/ai-action.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-access-token.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-action-call.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-action.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-bundle.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-definition.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-details.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-event-subscription.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-installation.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-key.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-signed-request.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-signing-secret.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/app-upload.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/comment.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/concept-scheme.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/concept.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/editor-interface.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/environment-alias.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/environment.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/extension.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/oauth-application.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/resource-type.js

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/role.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/space-member.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/space-membership.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/space.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/tag.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/task.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/team-membership.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/team-space-membership.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/team.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/ui-config.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/upload-credential.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/upload.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/usage.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/user-ui-config.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/user.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/webhook.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/workflow-definition.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/workflow.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/workflows-changelog.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/pagination-helper.js

@@ -0,0 +1,76 @@
+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); }
+/**
+ * `sys.type` tends to cause type clashes downstream because it more commonly types less strict
+ * as 'string'. Because we don't rely on it for this functionality, we are fine with omitting it.
+ */
+
+function isOffsetBasedCollection(collection) {
+  return 'total' in collection;
+}
+function isCursorBasedCollection(collection) {
+  return 'pages' in collection;
+}
+function getSearchParam(url, paramName) {
+  const searchIndex = url.indexOf('?');
+  if (searchIndex < 0) {
+    return null;
+  }
+  const rawSearchParams = url.slice(searchIndex + 1);
+  const searchParams = new URLSearchParams(rawSearchParams);
+  return searchParams.get(paramName);
+}
+function range(from, to) {
+  return Array.from(Array(Math.abs(to - from)), (_, i) => from + i);
+}
+
+/**
+ * Parameters for endpoint methods that can be paginated are inconsistent, `fetchAll` will only
+ * work with the more common version of supplying the limit, skip, and pageNext parameters via a distinct `query` property in the
+ * parameters.
+ */
+export async function fetchAll(fetchFn, params) {
+  const response = await fetchFn(_objectSpread({}, params));
+  if (isOffsetBasedCollection(response)) {
+    const {
+      total,
+      limit,
+      items
+    } = response;
+    const hasMorePages = total > items.length;
+    if (!hasMorePages) {
+      return items;
+    }
+    const pageCount = Math.ceil(total / limit);
+    const promises = range(1, pageCount).map(page => fetchFn(_objectSpread(_objectSpread({}, params), {}, {
+      query: _objectSpread(_objectSpread({}, params.query), {}, {
+        limit,
+        skip: page * limit
+      })
+    })).then(result => result.items));
+    const remainingItems = await Promise.all(promises);
+    return [...items, ...remainingItems.flat(1)];
+  }
+  if (isCursorBasedCollection(response)) {
+    const {
+      pages,
+      items
+    } = response;
+    if (!pages.next) {
+      return items;
+    }
+    const pageNext = getSearchParam(pages.next, 'pageNext');
+    if (!pageNext) {
+      throw new Error('Missing "pageNext" query param from pages.next from response.');
+    }
+    return [...items, ...(await fetchAll(fetchFn, _objectSpread(_objectSpread({}, params), {}, {
+      query: _objectSpread(_objectSpread({}, params.query), {}, {
+        pageNext
+      })
+    })))];
+  }
+  throw new Error(`Can not determine collection type of response, neither property "total" nor "pages" are present.`);
+}