@dereekb/util 11.0.8 → 11.0.9

package/fetch/index.cjs.js

@@ -5302,7 +5302,7 @@ function fetchPageFactory(config) {
 }
 
 /**
- * Iterates through the pages of a created FetchPage instance.
+ * Iterates through the pages of a created FetchPage instance by each item individually.
  *
  * @param config
  * @returns
@@ -5397,6 +5397,12 @@ const iterateFetchPages = _async(function (config) {
     return result;
   });
 });
+/**
+ * Iterates through the pages of a created FetchPage instance.
+ *
+ * @param config
+ * @returns
+ */
 const iterateFetchPagesByItems = _async(function (config) {
   const {
     readItemsFromPageResult,
@@ -5415,7 +5421,7 @@ const iterateFetchPagesByItems = _async(function (config) {
     iteratePage: _async(function (fetchPageResult) {
       const items = readItemsFromPageResult(fetchPageResult);
       return _await(filterPageItems(items, fetchPageResult), function (filteredItems) {
-        return _await(iteratePageItems(filteredItems, fetchPageResult), function (results) {
+        return _await(iteratePageItems(filteredItems, fetchPageResult, totalItemsVisited), function (results) {
           totalItemsLoaded += items.length;
           totalItemsVisited += filteredItems.length;
           hasReachedFinalItem = totalItemsLoaded >= loadItemLimit || totalItemsVisited >= iterateItemsLimit;
@@ -5427,6 +5433,22 @@ const iterateFetchPagesByItems = _async(function (config) {
   });
   return iterateFetchPages(fetchPagesConfig);
 });
+const iterateFetchPagesByEachItem = _async(function (config) {
+  const {
+    iterateEachPageItem,
+    iteratePerformTasksConfig
+  } = config;
+  return iterateFetchPagesByItems(Object.assign({}, config, {
+    iteratePageItems: _async(function (items, fetchPageResult, startIndex) {
+      const itemIndexPairs = items.map((x, i) => [x, i + startIndex]);
+      return util.performAsyncTasks(itemIndexPairs, ([item, i]) => {
+        return iterateEachPageItem(item, i, fetchPageResult);
+      }, Object.assign({
+        sequential: true
+      }, iteratePerformTasksConfig));
+    })
+  }));
+});
 
 /**
  * Creates URLSearchParams from the input objects. The input objects are merged together.
@@ -5702,6 +5724,7 @@ exports.isFetchRequest = isFetchRequest;
 exports.isURL = isURL;
 exports.isURLSearchParams = isURLSearchParams;
 exports.iterateFetchPages = iterateFetchPages;
+exports.iterateFetchPagesByEachItem = iterateFetchPagesByEachItem;
 exports.iterateFetchPagesByItems = iterateFetchPagesByItems;
 exports.makeUrlSearchParams = makeUrlSearchParams;
 exports.mergeRequestHeaders = mergeRequestHeaders;

package/fetch/index.esm.js

@@ -1,4 +1,4 @@
-import { removeTrailingSlashes, asGetter, multiValueMapBuilder, filterMaybeValues, objectToTuples, fixMultiSlashesInSlashPath, isPromiseLike, cachedGetter, FIRST_PAGE, mapIdentityFunction, performTasksFromFactoryInParallelFunction, mergeObjects, useIterableOrValue, isEmptyIterable, fixExtraQueryParameters, forEachInIterable, isIterable, forEachKeyValue } from '@dereekb/util';
+import { removeTrailingSlashes, asGetter, multiValueMapBuilder, filterMaybeValues, objectToTuples, fixMultiSlashesInSlashPath, isPromiseLike, cachedGetter, FIRST_PAGE, performAsyncTasks, mapIdentityFunction, performTasksFromFactoryInParallelFunction, mergeObjects, useIterableOrValue, isEmptyIterable, fixExtraQueryParameters, forEachInIterable, isIterable, forEachKeyValue } from '@dereekb/util';
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -5219,6 +5219,37 @@ function fetchPageFactory(config) {
  * @deprecated Use FetchPageResult instead.
  */
 
+// MARK: IterateFetchPagesByEachItem
+/**
+ * Function called for each item that was fetched, along with the index and fetch results.
+ *
+ * The index is the overall index this item is from the returned items.
+ */
+
+/**
+ * Iterates through the pages of a created FetchPage instance by each item individually.
+ *
+ * @param config
+ * @returns
+ */
+async function iterateFetchPagesByEachItem(config) {
+  const {
+    iterateEachPageItem,
+    iteratePerformTasksConfig
+  } = config;
+  return iterateFetchPagesByItems(Object.assign({}, config, {
+    iteratePageItems: async (items, fetchPageResult, startIndex) => {
+      const itemIndexPairs = items.map((x, i) => [x, i + startIndex]);
+      const performTasksResults = await performAsyncTasks(itemIndexPairs, ([item, i]) => {
+        return iterateEachPageItem(item, i, fetchPageResult);
+      }, Object.assign({
+        sequential: true
+      }, iteratePerformTasksConfig));
+      return performTasksResults;
+    }
+  }));
+}
+
 // MARK: IterateFetchPagesByItems
 /**
  * Filter function used to filter out items.
@@ -5251,7 +5282,7 @@ async function iterateFetchPagesByItems(config) {
     iteratePage: async fetchPageResult => {
       const items = readItemsFromPageResult(fetchPageResult);
       const filteredItems = await filterPageItems(items, fetchPageResult);
-      const results = await iteratePageItems(filteredItems, fetchPageResult);
+      const results = await iteratePageItems(filteredItems, fetchPageResult, totalItemsVisited);
       totalItemsLoaded += items.length;
       totalItemsVisited += filteredItems.length;
       hasReachedFinalItem = totalItemsLoaded >= loadItemLimit || totalItemsVisited >= iterateItemsLimit;
@@ -5595,4 +5626,4 @@ const nodeFetchService = fetchService({
   makeRequest: (x, y) => new Request(x, y)
 });
 
-export { FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE, FetchPageLimitReachedError, FetchPageNoNextPageError, FetchRequestFactoryError, FetchResponseError, FetchTimeoutError, JsonResponseParseError, configureFetch, fetchJsonBodyString, fetchJsonFunction, fetchJsonRequestInit, fetchJsonRequestInitFunction, fetchOk, fetchPageFactory, fetchRequestFactory, fetchService, fetchTimeout, fetchURL, fetchURLQueryKeyValueStringTuples, fetchURLSearchParamsObjectToURLSearchParams, headersToHeadersTuple, isFetchRequest, isURL, isURLSearchParams, iterateFetchPages, iterateFetchPagesByItems, makeUrlSearchParams, mergeRequestHeaders, mergeRequestInits, nodeFetchService, queryParamsToSearchParams, requireOkResponse, returnNullHandleFetchJsonParseErrorFunction, throwJsonResponseParseErrorFunction };
+export { FETCH_PAGE_FACTORY_DEFAULT_MAX_PAGE, FetchPageLimitReachedError, FetchPageNoNextPageError, FetchRequestFactoryError, FetchResponseError, FetchTimeoutError, JsonResponseParseError, configureFetch, fetchJsonBodyString, fetchJsonFunction, fetchJsonRequestInit, fetchJsonRequestInitFunction, fetchOk, fetchPageFactory, fetchRequestFactory, fetchService, fetchTimeout, fetchURL, fetchURLQueryKeyValueStringTuples, fetchURLSearchParamsObjectToURLSearchParams, headersToHeadersTuple, isFetchRequest, isURL, isURLSearchParams, iterateFetchPages, iterateFetchPagesByEachItem, iterateFetchPagesByItems, makeUrlSearchParams, mergeRequestHeaders, mergeRequestInits, nodeFetchService, queryParamsToSearchParams, requireOkResponse, returnNullHandleFetchJsonParseErrorFunction, throwJsonResponseParseErrorFunction };

package/fetch/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util/fetch",
-  "version": "11.0.8",
+  "version": "11.0.9",
   ".": {
     "types": "./src/index.d.ts",
     "node": {

package/fetch/src/lib/fetch.page.iterate.d.ts

@@ -1,13 +1,41 @@
-import { type DecisionFunction, type IndexNumber, type IndexRef, type Maybe, type Milliseconds, type PromiseOrValue } from '@dereekb/util';
+import { type DecisionFunction, type IndexNumber, type IndexRef, type Maybe, type Milliseconds, type PromiseOrValue, type PerformAsyncTasksConfig, type PerformAsyncTasksResult } from '@dereekb/util';
 import { type FetchPage, type FetchPageFactory, type FetchPageFactoryInputOptions, type FetchPageResult, type FetchPageResultWithInput } from './fetch.page';
+/**
+ * Function called for each item that was fetched, along with the index and fetch results.
+ *
+ * The index is the overall index this item is from the returned items.
+ */
+export type IterateFetchPagesByEachItemFunction<I, O, T, R> = (item: T, i: IndexNumber, fetchPageResult: FetchPageResultWithInput<I, O>) => Promise<R>;
+export type IterateFetchPagesByEachItemPair<T> = readonly [T, IndexNumber];
+export interface IterateFetchPagesByEachItemConfig<I, O, T, R> extends Omit<IterateFetchPagesByItemsConfig<I, O, T, IterateFetchPagesByEachItemResult<T, R>>, 'iteratePageItems'> {
+    /**
+     * The iterate function per each page result.
+     */
+    readonly iterateEachPageItem: IterateFetchPagesByEachItemFunction<I, O, T, R>;
+    /**
+     * Optional additional configuration to pass to the
+     *
+     * By default, sequential is true.
+     */
+    readonly iteratePerformTasksConfig?: Partial<PerformAsyncTasksConfig<IterateFetchPagesByEachItemPair<T>>>;
+}
+export type IterateFetchPagesByEachItemResult<T, R> = PerformAsyncTasksResult<IterateFetchPagesByEachItemPair<T>, R>;
+/**
+ * Iterates through the pages of a created FetchPage instance by each item individually.
+ *
+ * @param config
+ * @returns
+ */
+export declare function iterateFetchPagesByEachItem<I, O, T, R>(config: IterateFetchPagesByEachItemConfig<I, O, T, R>): Promise<IterateFetchPagesResult>;
 /**
  * Filter function used to filter out items.
  *
  * @param snapshot
  * @returns
  */
-export type IterateFetchPagesByItemsFilterFunction<I, O, T> = (items: T[], pageResult: FetchPageResult<O>) => PromiseOrValue<T[]>;
-export interface IterateFetchPagesByItemsConfig<I, O, T, R> extends Omit<IterateFetchPagesConfig<I, O, R[]>, 'iteratePage'> {
+export type IterateFetchPagesByItemsFilterFunction<I, O, T> = (items: T[], pageResult: FetchPageResultWithInput<I, O>) => PromiseOrValue<T[]>;
+export type IterateFetchPagesByItemsFunction<I, O, T, R> = (items: T[], fetchPageResult: FetchPageResultWithInput<I, O>, totalItemsVisited: number) => Promise<R>;
+export interface IterateFetchPagesByItemsConfig<I, O, T, R> extends Omit<IterateFetchPagesConfig<I, O, R>, 'iteratePage'> {
     /**
      * Read individual items from page result.
      *
@@ -42,7 +70,7 @@ export interface IterateFetchPagesByItemsConfig<I, O, T, R> extends Omit<Iterate
     /**
      * The iterate function per each page result.
      */
-    iteratePageItems(items: T[], fetchPageResult: FetchPageResult<O>): Promise<R[]>;
+    readonly iteratePageItems: IterateFetchPagesByItemsFunction<I, O, T, R>;
 }
 /**
  * Iterates through the pages of a created FetchPage instance.
@@ -84,7 +112,7 @@ export interface BaseIterateFetchPagesConfig<I, O, R> extends FetchPageFactoryIn
     /**
      * The iterate function per each page result.
      */
-    iteratePage(result: FetchPageResult<O>): Promise<R>;
+    iteratePage(result: FetchPageResultWithInput<I, O>): Promise<R>;
     /**
      * (Optional) Called at the end of each page.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util",
-  "version": "11.0.8",
+  "version": "11.0.9",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/test/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [11.0.9](https://github.com/dereekb/dbx-components/compare/v11.0.8-dev...v11.0.9) (2024-11-23)
+
+
+
 ## [11.0.8](https://github.com/dereekb/dbx-components/compare/v11.0.7-dev...v11.0.8) (2024-11-23)
 
 

package/test/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/util/test",
-  "version": "11.0.8",
+  "version": "11.0.9",
   "type": "commonjs",
   "peerDependencies": {
     "@dereekb/util": "*"