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

package/dist/cjs/methods/action.cjs

@@ -1,53 +0,0 @@
-'use strict';
-
-var utils = require('./utils.cjs');
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-const DEFAULT_MAX_RETRIES = 30;
-const DEFAULT_INITIAL_DELAY_MS = 1000;
-const DEFAULT_RETRY_INTERVAL_MS = 2000;
-class AsyncActionProcessingError extends Error {
-    constructor(message, action) {
-        super(message);
-        this.action = action;
-        this.name = this.constructor.name;
-    }
-}
-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.
- */
-async function pollAsyncActionStatus(actionFunction, options) {
-    let retryCount = 0;
-    let done = false;
-    let action;
-    const maxRetries = options?.retryCount ?? DEFAULT_MAX_RETRIES;
-    const retryIntervalMs = options?.retryIntervalMs ?? DEFAULT_RETRY_INTERVAL_MS;
-    const initialDelayMs = options?.initialDelayMs ?? DEFAULT_INITIAL_DELAY_MS;
-    const throwOnFailedExecution = options?.throwOnFailedExecution ?? true;
-    // Initial delay for short-running Actions
-    await utils.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 utils.sleep(retryIntervalMs);
-        retryCount += 1;
-    }
-    throw new AsyncActionProcessingError(`${action?.sys.type} didn't finish processing within the expected timeframe.`, action);
-}
-
-exports.AsyncActionFailedError = AsyncActionFailedError;
-exports.AsyncActionProcessingError = AsyncActionProcessingError;
-exports.pollAsyncActionStatus = pollAsyncActionStatus;
-//# sourceMappingURL=action.cjs.map

package/dist/cjs/methods/action.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"action.cjs","sources":["../../../lib/methods/action.ts"],"sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport { sleep } from './utils.js'\n\nconst DEFAULT_MAX_RETRIES = 30\nconst DEFAULT_INITIAL_DELAY_MS = 1000\nconst DEFAULT_RETRY_INTERVAL_MS = 2000\n\n/** Action is an interface that has a sys.status to be checked against */\ninterface Action extends Record<string, any> {\n  sys: {\n    status: string\n    type: string\n  }\n}\n\nexport class AsyncActionProcessingError extends Error {\n  public action?: Action\n\n  constructor(message: string, action?: Action) {\n    super(message)\n    this.action = action\n    this.name = this.constructor.name\n  }\n}\n\nexport class AsyncActionFailedError extends AsyncActionProcessingError {}\n\nexport type AsyncActionProcessingOptions = {\n  /** The amount of times to retry.\n   * @default 30\n   * */\n  retryCount?: number\n  /** The interval between retries, in milliseconds (ms).\n   * @default 2000 (2s)\n   * */\n  retryIntervalMs?: number\n  /**\n   * Initial delay in milliseconds when performing the first check.\n   * This is used to prevent short running bulkActions of waiting too long for a result.\n   * @default 1000 (1s)\n   * */\n  initialDelayMs?: number\n  /**\n   * Throws an error if the Action does not complete with a successful (succeeded) status.\n   * @default true\n   */\n  throwOnFailedExecution?: boolean\n}\n\n/**\n * @description Waits for an Action to be completed and to be in one of the final states (failed or succeeded)\n * @param {Function} actionFunction - GET function that will be called every interval to fetch an Action status\n * @throws {ActionFailedError} throws an error if `throwOnFailedExecution = true` with the Action that failed.\n * @throws {AsyncActionProcessingError} throws an error with a Action when processing takes too long.\n */\nexport async function pollAsyncActionStatus<T extends Action = any>(\n  actionFunction: () => Promise<T>,\n  options?: AsyncActionProcessingOptions,\n): Promise<T> {\n  let retryCount = 0\n  let done = false\n  let action: T | undefined\n\n  const maxRetries = options?.retryCount ?? DEFAULT_MAX_RETRIES\n  const retryIntervalMs = options?.retryIntervalMs ?? DEFAULT_RETRY_INTERVAL_MS\n  const initialDelayMs = options?.initialDelayMs ?? DEFAULT_INITIAL_DELAY_MS\n  const throwOnFailedExecution = options?.throwOnFailedExecution ?? true\n\n  // Initial delay for short-running Actions\n  await sleep(initialDelayMs)\n\n  while (retryCount < maxRetries && !done) {\n    action = await actionFunction()\n\n    // Terminal states\n    if (action && ['succeeded', 'failed'].includes(action.sys.status)) {\n      done = true\n\n      if (action.sys.status === 'failed' && throwOnFailedExecution) {\n        throw new AsyncActionFailedError(`${action.sys.type} failed to execute.`, action)\n      }\n\n      return action\n    }\n\n    await sleep(retryIntervalMs)\n    retryCount += 1\n  }\n\n  throw new AsyncActionProcessingError(\n    `${action?.sys.type} didn't finish processing within the expected timeframe.`,\n    action,\n  )\n}\n"],"names":["sleep"],"mappings":";;;;AAAA;AAGA,MAAM,mBAAmB,GAAG,EAAE;AAC9B,MAAM,wBAAwB,GAAG,IAAI;AACrC,MAAM,yBAAyB,GAAG,IAAI;AAUhC,MAAO,0BAA2B,SAAQ,KAAK,CAAA;IAGnD,WAAY,CAAA,OAAe,EAAE,MAAe,EAAA;QAC1C,KAAK,CAAC,OAAO,CAAC;AACd,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI;;AAEpC;AAEK,MAAO,sBAAuB,SAAQ,0BAA0B,CAAA;AAAG;AAwBzE;;;;;AAKG;AACI,eAAe,qBAAqB,CACzC,cAAgC,EAChC,OAAsC,EAAA;IAEtC,IAAI,UAAU,GAAG,CAAC;IAClB,IAAI,IAAI,GAAG,KAAK;AAChB,IAAA,IAAI,MAAqB;AAEzB,IAAA,MAAM,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,mBAAmB;AAC7D,IAAA,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,yBAAyB;AAC7E,IAAA,MAAM,cAAc,GAAG,OAAO,EAAE,cAAc,IAAI,wBAAwB;AAC1E,IAAA,MAAM,sBAAsB,GAAG,OAAO,EAAE,sBAAsB,IAAI,IAAI;;AAGtE,IAAA,MAAMA,WAAK,CAAC,cAAc,CAAC;AAE3B,IAAA,OAAO,UAAU,GAAG,UAAU,IAAI,CAAC,IAAI,EAAE;AACvC,QAAA,MAAM,GAAG,MAAM,cAAc,EAAE;;AAG/B,QAAA,IAAI,MAAM,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YACjE,IAAI,GAAG,IAAI;YAEX,IAAI,MAAM,CAAC,GAAG,CAAC,MAAM,KAAK,QAAQ,IAAI,sBAAsB,EAAE;AAC5D,gBAAA,MAAM,IAAI,sBAAsB,CAAC,CAAA,EAAG,MAAM,CAAC,GAAG,CAAC,IAAI,CAAA,mBAAA,CAAqB,EAAE,MAAM,CAAC;;AAGnF,YAAA,OAAO,MAAM;;AAGf,QAAA,MAAMA,WAAK,CAAC,eAAe,CAAC;QAC5B,UAAU,IAAI,CAAC;;AAGjB,IAAA,MAAM,IAAI,0BAA0B,CAClC,CAAA,EAAG,MAAM,EAAE,GAAG,CAAC,IAAI,CAAA,wDAAA,CAA0D,EAC7E,MAAM,CACP;AACH;;;;;;"}

package/dist/cjs/methods/content-type.cjs

@@ -1,49 +0,0 @@
-'use strict';
-
-/**
- * @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);
-};
-const omitAndDeleteField = (makeRequest, { fieldId, ...params }, contentType) => {
-    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,
-        });
-    });
-};
-
-exports.omitAndDeleteField = omitAndDeleteField;
-//# sourceMappingURL=content-type.cjs.map

package/dist/cjs/methods/content-type.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"content-type.cjs","sources":["../../../lib/methods/content-type.ts"],"sourcesContent":["import type { GetContentTypeParams, MakeRequest } from '../common-types.js'\nimport type { ContentTypeProps } from '../entities/content-type.js'\n\ntype OmitOrDelete = 'omitted' | 'deleted'\n\n/**\n * @private\n * @param id - unique ID of the field\n * @param key - the attribute on the field to change\n * @param value - the value to set the attribute to\n */\nconst findAndUpdateField = function (\n  contentType: ContentTypeProps,\n  fieldId: string,\n  omitOrDelete: OmitOrDelete,\n) {\n  const field = contentType.fields.find((field) => field.id === fieldId)\n  if (!field) {\n    return Promise.reject(\n      new Error(\n        `Tried to omitAndDeleteField on a nonexistent field, ${fieldId}, on the content type ${contentType.name}.`,\n      ),\n    )\n  }\n\n  field[omitOrDelete] = true\n\n  return Promise.resolve(contentType)\n}\n\nexport const omitAndDeleteField = (\n  makeRequest: MakeRequest,\n  {\n    fieldId,\n    ...params\n  }: {\n    fieldId: string\n  } & GetContentTypeParams,\n  contentType: ContentTypeProps,\n) => {\n  return findAndUpdateField(contentType, fieldId, 'omitted')\n    .then((newContentType) => {\n      return makeRequest({\n        entityType: 'ContentType',\n        action: 'update',\n        params,\n        payload: newContentType,\n      })\n    })\n    .then((newContentType) => {\n      return makeRequest({\n        entityType: 'ContentType',\n        action: 'publish',\n        params,\n        payload: newContentType,\n      })\n    })\n    .then((newContentType) => {\n      return findAndUpdateField(newContentType, fieldId, 'deleted')\n    })\n    .then((newContentType) => {\n      return makeRequest({\n        entityType: 'ContentType',\n        action: 'update',\n        params,\n        payload: newContentType,\n      })\n    })\n}\n"],"names":[],"mappings":";;AAKA;;;;;AAKG;AACH,MAAM,kBAAkB,GAAG,UACzB,WAA6B,EAC7B,OAAe,EACf,YAA0B,EAAA;AAE1B,IAAA,MAAM,KAAK,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,KAAK,CAAC,EAAE,KAAK,OAAO,CAAC;IACtE,IAAI,CAAC,KAAK,EAAE;AACV,QAAA,OAAO,OAAO,CAAC,MAAM,CACnB,IAAI,KAAK,CACP,CAAA,oDAAA,EAAuD,OAAO,CAAA,sBAAA,EAAyB,WAAW,CAAC,IAAI,CAAG,CAAA,CAAA,CAC3G,CACF;;AAGH,IAAA,KAAK,CAAC,YAAY,CAAC,GAAG,IAAI;AAE1B,IAAA,OAAO,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;AACrC,CAAC;AAEY,MAAA,kBAAkB,GAAG,CAChC,WAAwB,EACxB,EACE,OAAO,EACP,GAAG,MAAM,EAGa,EACxB,WAA6B,KAC3B;AACF,IAAA,OAAO,kBAAkB,CAAC,WAAW,EAAE,OAAO,EAAE,SAAS;AACtD,SAAA,IAAI,CAAC,CAAC,cAAc,KAAI;AACvB,QAAA,OAAO,WAAW,CAAC;AACjB,YAAA,UAAU,EAAE,aAAa;AACzB,YAAA,MAAM,EAAE,QAAQ;YAChB,MAAM;AACN,YAAA,OAAO,EAAE,cAAc;AACxB,SAAA,CAAC;AACJ,KAAC;AACA,SAAA,IAAI,CAAC,CAAC,cAAc,KAAI;AACvB,QAAA,OAAO,WAAW,CAAC;AACjB,YAAA,UAAU,EAAE,aAAa;AACzB,YAAA,MAAM,EAAE,SAAS;YACjB,MAAM;AACN,YAAA,OAAO,EAAE,cAAc;AACxB,SAAA,CAAC;AACJ,KAAC;AACA,SAAA,IAAI,CAAC,CAAC,cAAc,KAAI;QACvB,OAAO,kBAAkB,CAAC,cAAc,EAAE,OAAO,EAAE,SAAS,CAAC;AAC/D,KAAC;AACA,SAAA,IAAI,CAAC,CAAC,cAAc,KAAI;AACvB,QAAA,OAAO,WAAW,CAAC;AACjB,YAAA,UAAU,EAAE,aAAa;AACzB,YAAA,MAAM,EAAE,QAAQ;YAChB,MAAM;AACN,YAAA,OAAO,EAAE,cAAc;AACxB,SAAA,CAAC;AACJ,KAAC,CAAC;AACN;;;;"}

package/dist/cjs/methods/utils.cjs

@@ -1,12 +0,0 @@
-'use strict';
-
-/**
- * Helper function that resolves a Promise after the specified duration (in milliseconds)
- * @private
- */
-function sleep(durationMs) {
-    return new Promise((resolve) => setTimeout(resolve, durationMs));
-}
-
-exports.sleep = sleep;
-//# sourceMappingURL=utils.cjs.map

package/dist/cjs/methods/utils.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.cjs","sources":["../../../lib/methods/utils.ts"],"sourcesContent":["/**\n * Helper function that resolves a Promise after the specified duration (in milliseconds)\n * @private\n */\nexport function sleep(durationMs: number): Promise<void> {\n  return new Promise((resolve) => setTimeout(resolve, durationMs))\n}\n"],"names":[],"mappings":";;AAAA;;;AAGG;AACG,SAAU,KAAK,CAAC,UAAkB,EAAA;AACtC,IAAA,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,KAAK,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AAClE;;;;"}

package/dist/cjs/plain/as-iterator.cjs

@@ -1,39 +0,0 @@
-'use strict';
-
-var copy = require('fast-copy');
-
-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 = {
-                            ...options,
-                            query: {
-                                ...options.query,
-                                skip: skip + limit,
-                            },
-                        };
-                        currentResult = get();
-                    }
-                    return { done: false, value };
-                },
-            };
-        },
-    };
-};
-
-exports.asIterator = asIterator;
-//# sourceMappingURL=as-iterator.cjs.map

package/dist/cjs/plain/as-iterator.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"as-iterator.cjs","sources":["../../../lib/plain/as-iterator.ts"],"sourcesContent":["import copy from 'fast-copy'\nimport type { CollectionProp, QueryParams } from '../common-types.js'\n\ntype IterableFn<P = any, T = any> = (params: P) => Promise<CollectionProp<T>>\ntype ParamsType<T extends IterableFn> = T extends (params: infer P) => any ? P : never\n\nexport const asIterator = <P extends QueryParams, T, F extends IterableFn<P, T>>(\n  fn: F,\n  params: ParamsType<F>,\n): AsyncIterable<T> => {\n  return {\n    [Symbol.asyncIterator]() {\n      let options = copy(params)\n      const get = () => fn(copy(options))\n      let currentResult = get()\n\n      return {\n        current: 0,\n        async next() {\n          const { total = 0, items = [], skip = 0, limit = 100 } = await currentResult\n\n          if (total === this.current) {\n            return { done: true, value: null }\n          }\n\n          const value = items[this.current++ - skip]\n          const endOfPage = this.current % limit === 0\n          const endOfList = this.current === total\n\n          if (endOfPage && !endOfList) {\n            options = {\n              ...options,\n              query: {\n                ...options.query,\n                skip: skip + limit,\n              },\n            }\n            currentResult = get()\n          }\n\n          return { done: false, value }\n        },\n      }\n    },\n  }\n}\n"],"names":[],"mappings":";;;;MAMa,UAAU,GAAG,CACxB,EAAK,EACL,MAAqB,KACD;IACpB,OAAO;QACL,CAAC,MAAM,CAAC,aAAa,CAAC,GAAA;AACpB,YAAA,IAAI,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC;AAC1B,YAAA,MAAM,GAAG,GAAG,MAAM,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACnC,YAAA,IAAI,aAAa,GAAG,GAAG,EAAE;YAEzB,OAAO;AACL,gBAAA,OAAO,EAAE,CAAC;AACV,gBAAA,MAAM,IAAI,GAAA;oBACR,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC,EAAE,KAAK,GAAG,GAAG,EAAE,GAAG,MAAM,aAAa;AAE5E,oBAAA,IAAI,KAAK,KAAK,IAAI,CAAC,OAAO,EAAE;wBAC1B,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;;oBAGpC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC;oBAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,GAAG,KAAK,KAAK,CAAC;AAC5C,oBAAA,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,KAAK,KAAK;AAExC,oBAAA,IAAI,SAAS,IAAI,CAAC,SAAS,EAAE;AAC3B,wBAAA,OAAO,GAAG;AACR,4BAAA,GAAG,OAAO;AACV,4BAAA,KAAK,EAAE;gCACL,GAAG,OAAO,CAAC,KAAK;gCAChB,IAAI,EAAE,IAAI,GAAG,KAAK;AACnB,6BAAA;yBACF;wBACD,aAAa,GAAG,GAAG,EAAE;;AAGvB,oBAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE;iBAC9B;aACF;SACF;KACF;AACH;;;;"}

package/dist/cjs/plain/checks.cjs

@@ -1,16 +0,0 @@
-'use strict';
-
-const isPublished = (data) => !!data.sys.publishedVersion;
-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);
-};
-const isDraft = (data) => !data.sys.publishedVersion;
-const isArchived = (data) => !!data.sys.archivedVersion;
-
-exports.isArchived = isArchived;
-exports.isDraft = isDraft;
-exports.isPublished = isPublished;
-exports.isUpdated = isUpdated;
-//# sourceMappingURL=checks.cjs.map

package/dist/cjs/plain/checks.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"checks.cjs","sources":["../../../lib/plain/checks.ts"],"sourcesContent":["import type { MetaSysProps } from '../common-types.js'\n\nexport const isPublished = <T extends string>(data: { sys: MetaSysProps<T> }) =>\n  !!data.sys.publishedVersion\n\nexport const isUpdated = <T extends string>(data: { sys: MetaSysProps<T> }) => {\n  // The act of publishing an entity increases its version by 1, so any entry which has\n  // 2 versions higher or more than the publishedVersion has unpublished changes.\n  return !!(data.sys.publishedVersion && data.sys.version > data.sys.publishedVersion + 1)\n}\n\nexport const isDraft = <T extends string>(data: { sys: MetaSysProps<T> }) =>\n  !data.sys.publishedVersion\n\nexport const isArchived = <T extends string>(data: { sys: MetaSysProps<T> }) =>\n  !!data.sys.archivedVersion\n"],"names":[],"mappings":";;AAEa,MAAA,WAAW,GAAG,CAAmB,IAA8B,KAC1E,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AAEA,MAAA,SAAS,GAAG,CAAmB,IAA8B,KAAI;;;IAG5E,OAAO,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,gBAAgB,GAAG,CAAC,CAAC;AAC1F;AAEO,MAAM,OAAO,GAAG,CAAmB,IAA8B,KACtE,CAAC,IAAI,CAAC,GAAG,CAAC;AAEC,MAAA,UAAU,GAAG,CAAmB,IAA8B,KACzE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;;;;;;;"}

package/dist/cjs/plain/pagination-helper.cjs

@@ -1,70 +0,0 @@
-'use strict';
-
-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.
- */
-async function fetchAll(fetchFn, params) {
-    const response = await fetchFn({ ...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({
-            ...params,
-            query: {
-                ...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, {
-                ...params,
-                query: {
-                    ...params.query,
-                    pageNext,
-                },
-            })),
-        ];
-    }
-    throw new Error(`Can not determine collection type of response, neither property "total" nor "pages" are present.`);
-}
-
-exports.fetchAll = fetchAll;
-//# sourceMappingURL=pagination-helper.cjs.map

package/dist/cjs/plain/pagination-helper.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"pagination-helper.cjs","sources":["../../../lib/plain/pagination-helper.ts"],"sourcesContent":["import type {\n  BasicCursorPaginationOptions,\n  CollectionProp,\n  CursorPaginatedCollectionProp,\n  PaginationQueryOptions,\n} from '../common-types.js'\n\nexport type OffsetBasedParams = { query?: PaginationQueryOptions }\nexport type CursorBasedParams = { query?: BasicCursorPaginationOptions }\n\ntype ExpectedParams = OffsetBasedParams | CursorBasedParams\n/**\n * `sys.type` tends to cause type clashes downstream because it more commonly types less strict\n * as 'string'. Because we don't rely on it for this functionality, we are fine with omitting it.\n */\ntype IterableCollection<T> = Omit<CollectionProp<T> | CursorPaginatedCollectionProp<T>, 'sys'>\nexport type FetchFn<P extends ExpectedParams, T = unknown> = (\n  params: P,\n) => Promise<IterableCollection<T>>\ntype ParamsType<P extends ExpectedParams, T extends FetchFn<P>> = T extends (\n  params: infer P,\n) => unknown\n  ? P\n  : never\n\nfunction isOffsetBasedCollection<T>(collection: any): collection is CollectionProp<T> {\n  return 'total' in collection\n}\n\ntype CursorBasedCollection<T> = Required<Pick<CursorPaginatedCollectionProp<T>, 'pages'>> &\n  Omit<CursorPaginatedCollectionProp<T>, 'pages'>\n\nfunction isCursorBasedCollection<T>(collection: any): collection is CursorBasedCollection<T> {\n  return 'pages' in collection\n}\n\nfunction getSearchParam(url: string, paramName: string): string | null {\n  const searchIndex = url.indexOf('?')\n  if (searchIndex < 0) {\n    return null\n  }\n\n  const rawSearchParams = url.slice(searchIndex + 1)\n  const searchParams = new URLSearchParams(rawSearchParams)\n  return searchParams.get(paramName)\n}\n\nfunction range(from: number, to: number): number[] {\n  return Array.from(Array(Math.abs(to - from)), (_, i) => from + i)\n}\n\n/**\n * Parameters for endpoint methods that can be paginated are inconsistent, `fetchAll` will only\n * work with the more common version of supplying the limit, skip, and pageNext parameters via a distinct `query` property in the\n * parameters.\n */\nexport async function fetchAll<\n  Params extends ExpectedParams,\n  Entity,\n  F extends FetchFn<Params, Entity>,\n>(fetchFn: FetchFn<Params, Entity>, params: ParamsType<Params, F>): Promise<Entity[]> {\n  const response = await fetchFn({ ...params })\n\n  if (isOffsetBasedCollection(response)) {\n    const { total, limit, items } = response\n    const hasMorePages = total > items.length\n\n    if (!hasMorePages) {\n      return items\n    }\n\n    const pageCount = Math.ceil(total / limit)\n    const promises = range(1, pageCount).map((page) =>\n      fetchFn({\n        ...params,\n        query: {\n          ...params.query,\n          limit,\n          skip: page * limit,\n        },\n      }).then((result) => result.items),\n    )\n    const remainingItems = await Promise.all(promises)\n\n    return [...items, ...remainingItems.flat(1)]\n  }\n\n  if (isCursorBasedCollection(response)) {\n    const { pages, items } = response\n    if (!pages.next) {\n      return items\n    }\n\n    const pageNext = getSearchParam(pages.next, 'pageNext')\n    if (!pageNext) {\n      throw new Error('Missing \"pageNext\" query param from pages.next from response.')\n    }\n\n    return [\n      ...items,\n      ...(await fetchAll(fetchFn, {\n        ...params,\n        query: {\n          ...params.query,\n          pageNext,\n        },\n      })),\n    ]\n  }\n\n  throw new Error(\n    `Can not determine collection type of response, neither property \"total\" nor \"pages\" are present.`,\n  )\n}\n"],"names":[],"mappings":";;AAyBA,SAAS,uBAAuB,CAAI,UAAe,EAAA;IACjD,OAAO,OAAO,IAAI,UAAU;AAC9B;AAKA,SAAS,uBAAuB,CAAI,UAAe,EAAA;IACjD,OAAO,OAAO,IAAI,UAAU;AAC9B;AAEA,SAAS,cAAc,CAAC,GAAW,EAAE,SAAiB,EAAA;IACpD,MAAM,WAAW,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC;AACpC,IAAA,IAAI,WAAW,GAAG,CAAC,EAAE;AACnB,QAAA,OAAO,IAAI;;IAGb,MAAM,eAAe,GAAG,GAAG,CAAC,KAAK,CAAC,WAAW,GAAG,CAAC,CAAC;AAClD,IAAA,MAAM,YAAY,GAAG,IAAI,eAAe,CAAC,eAAe,CAAC;AACzD,IAAA,OAAO,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC;AACpC;AAEA,SAAS,KAAK,CAAC,IAAY,EAAE,EAAU,EAAA;IACrC,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC;AACnE;AAEA;;;;AAIG;AACI,eAAe,QAAQ,CAI5B,OAAgC,EAAE,MAA6B,EAAA;IAC/D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,EAAE,GAAG,MAAM,EAAE,CAAC;AAE7C,IAAA,IAAI,uBAAuB,CAAC,QAAQ,CAAC,EAAE;QACrC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ;AACxC,QAAA,MAAM,YAAY,GAAG,KAAK,GAAG,KAAK,CAAC,MAAM;QAEzC,IAAI,CAAC,YAAY,EAAE;AACjB,YAAA,OAAO,KAAK;;QAGd,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;AAC1C,QAAA,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,KAC5C,OAAO,CAAC;AACN,YAAA,GAAG,MAAM;AACT,YAAA,KAAK,EAAE;gBACL,GAAG,MAAM,CAAC,KAAK;gBACf,KAAK;gBACL,IAAI,EAAE,IAAI,GAAG,KAAK;AACnB,aAAA;AACF,SAAA,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,MAAM,CAAC,KAAK,CAAC,CAClC;QACD,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;AAElD,QAAA,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;;AAG9C,IAAA,IAAI,uBAAuB,CAAC,QAAQ,CAAC,EAAE;AACrC,QAAA,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,QAAQ;AACjC,QAAA,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;AACf,YAAA,OAAO,KAAK;;QAGd,MAAM,QAAQ,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,EAAE,UAAU,CAAC;QACvD,IAAI,CAAC,QAAQ,EAAE;AACb,YAAA,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC;;QAGlF,OAAO;AACL,YAAA,GAAG,KAAK;AACR,YAAA,IAAI,MAAM,QAAQ,CAAC,OAAO,EAAE;AAC1B,gBAAA,GAAG,MAAM;AACT,gBAAA,KAAK,EAAE;oBACL,GAAG,MAAM,CAAC,KAAK;oBACf,QAAQ;AACT,iBAAA;AACF,aAAA,CAAC,CAAC;SACJ;;AAGH,IAAA,MAAM,IAAI,KAAK,CACb,CAAA,gGAAA,CAAkG,CACnG;AACH;;;;"}