@dereekb/rxjs 10.0.19 → 10.0.21

package/index.cjs.js

@@ -3233,16 +3233,21 @@ function iteratorNextPageUntilPage(iteration, page) {
     const maxLimit = Math.min(pageLimit, (_a = iteration.maxPageLoadLimit) !== null && _a !== void 0 ? _a : Number.MAX_SAFE_INTEGER);
     return page + 1 < maxLimit;
   }
-  return new Promise(resolve => {
-    iteration.latestLoadedPage$.pipe(rxjs.first()).subscribe(firstLatestPage => {
-      const promise = util.performTaskLoop({
-        initValue: firstLatestPage,
-        checkContinue: latestPage => checkPageLimit(latestPage),
-        next: () => __awaiter(this, void 0, void 0, function* () {
-          return yield iteration.nextPage();
-        })
-      });
-      resolve(promise);
+  return new Promise((resolve, reject) => {
+    iteration.latestLoadedPage$.pipe(rxjs.first()).subscribe({
+      next: firstLatestPage => {
+        const promise = util.performTaskLoop({
+          initValue: firstLatestPage,
+          checkContinue: latestPage => checkPageLimit(latestPage),
+          next: () => __awaiter(this, void 0, void 0, function* () {
+            return yield iteration.nextPage();
+          })
+        });
+        resolve(promise);
+      },
+      error: error => {
+        reject(error);
+      }
     });
   });
 }
@@ -4775,6 +4780,58 @@ function itemAccumulator(itemIteration, mapItem) {
   }
   return new ItemAccumulatorInstance(itemIteration, mapItem);
 }
+/**
+ * Automatically calls next on the accumulator's page item iteration up to the target number of results. Returns the total number of items loaded.
+ *
+ * The promise will reject with an error if an error is encountered.
+ *
+ * @param iteration
+ * @param maxResultsLimit
+ * @returns
+ */
+function itemAccumulatorNextPageUntilResultsCount(config) {
+  const {
+    accumulator,
+    maxResultsLimit,
+    countResultsFunction: countResults
+  } = config;
+  const getMaxResultsLimit = util.asGetter(maxResultsLimit);
+  function checkResultsLimit() {
+    return __awaiter(this, void 0, void 0, function* () {
+      const allItems = yield rxjs.firstValueFrom(accumulator.allItems$);
+      const currentCount = yield countResults(allItems);
+      const maxResultsLimit = getMaxResultsLimit();
+      return {
+        shouldContinue: currentCount < maxResultsLimit,
+        currentCount
+      };
+    });
+  }
+  return new Promise((resolve, reject) => {
+    accumulator.allItems$.pipe(rxjs.first(), rxjs.switchMap(allItems => rxjs.from(util.asPromise(countResults(allItems))))).subscribe({
+      next: currentResultsCount => __awaiter(this, void 0, void 0, function* () {
+        const page = yield util.performTaskLoop({
+          initValue: currentResultsCount,
+          checkContinue: () => __awaiter(this, void 0, void 0, function* () {
+            const result = yield checkResultsLimit();
+            currentResultsCount = result.currentCount;
+            return result.shouldContinue;
+          }),
+          next: () => __awaiter(this, void 0, void 0, function* () {
+            return yield accumulator.itemIteration.nextPage();
+          })
+        });
+        resolve({
+          page,
+          resultsCount: currentResultsCount
+        });
+      }),
+      error: error => {
+        reject(error);
+      }
+    });
+  });
+}
 
 /**
  * Used for ItemAccumulators that have an array of results returned per page instead of a single item.
@@ -4815,6 +4872,15 @@ function accumulatorCurrentPageListLoadingState(accumulator) {
     mapValue: () => values
   })), rxjs.shareReplay(1));
 }
+/**
+ * Returns the latest loaded page number from the input PageItemAccumulator.
+ *
+ * @param pageItemAccumulator
+ * @returns
+ */
+function pageItemAccumulatorCurrentPage(pageItemAccumulator) {
+  return pageItemAccumulator.itemIteration.latestLoadedPage$;
+}
 
 class MappedItemIterationInstance {
   constructor(itemIterator, config) {
@@ -5535,6 +5601,7 @@ exports.isLoading = isLoading;
 exports.isNot = isNot;
 exports.isSuccessLoadingState = isSuccessLoadingState;
 exports.itemAccumulator = itemAccumulator;
+exports.itemAccumulatorNextPageUntilResultsCount = itemAccumulatorNextPageUntilResultsCount;
 exports.iterationHasNextAndCanLoadMore = iterationHasNextAndCanLoadMore;
 exports.iteratorNextPageUntilMaxPageLoadLimit = iteratorNextPageUntilMaxPageLoadLimit;
 exports.iteratorNextPageUntilPage = iteratorNextPageUntilPage;
@@ -5576,6 +5643,7 @@ exports.onFalseToTrue = onFalseToTrue;
 exports.onLockSetNextUnlock = onLockSetNextUnlock;
 exports.onMatchDelta = onMatchDelta;
 exports.onTrueToFalse = onTrueToFalse;
+exports.pageItemAccumulatorCurrentPage = pageItemAccumulatorCurrentPage;
 exports.pageLoadingStateFromObs = pageLoadingStateFromObs;
 exports.pipeIf = pipeIf;
 exports.preventComplete = preventComplete;

package/index.esm.js

@@ -3325,14 +3325,19 @@ function iteratorNextPageUntilPage(iteration, page) {
     const maxLimit = Math.min(pageLimit, (_iteration$maxPageLoa = iteration.maxPageLoadLimit) != null ? _iteration$maxPageLoa : Number.MAX_SAFE_INTEGER);
     return page + 1 < maxLimit;
   }
-  return new Promise(resolve => {
-    iteration.latestLoadedPage$.pipe(first()).subscribe(firstLatestPage => {
-      const promise = performTaskLoop({
-        initValue: firstLatestPage,
-        checkContinue: latestPage => checkPageLimit(latestPage),
-        next: async () => await iteration.nextPage()
-      });
-      resolve(promise);
+  return new Promise((resolve, reject) => {
+    iteration.latestLoadedPage$.pipe(first()).subscribe({
+      next: firstLatestPage => {
+        const promise = performTaskLoop({
+          initValue: firstLatestPage,
+          checkContinue: latestPage => checkPageLimit(latestPage),
+          next: async () => await iteration.nextPage()
+        });
+        resolve(promise);
+      },
+      error: error => {
+        reject(error);
+      }
     });
   });
 }
@@ -5097,6 +5102,57 @@ function itemAccumulator(itemIteration, mapItem) {
   return new ItemAccumulatorInstance(itemIteration, mapItem);
 }
 
+// MARK: Utility
+
+/**
+ * Automatically calls next on the accumulator's page item iteration up to the target number of results. Returns the total number of items loaded.
+ *
+ * The promise will reject with an error if an error is encountered.
+ *
+ * @param iteration
+ * @param maxResultsLimit
+ * @returns
+ */
+function itemAccumulatorNextPageUntilResultsCount(config) {
+  const {
+    accumulator,
+    maxResultsLimit,
+    countResultsFunction: countResults
+  } = config;
+  const getMaxResultsLimit = asGetter(maxResultsLimit);
+  async function checkResultsLimit() {
+    const allItems = await firstValueFrom(accumulator.allItems$);
+    const currentCount = await countResults(allItems);
+    const maxResultsLimit = getMaxResultsLimit();
+    return {
+      shouldContinue: currentCount < maxResultsLimit,
+      currentCount
+    };
+  }
+  return new Promise((resolve, reject) => {
+    accumulator.allItems$.pipe(first(), switchMap(allItems => from(asPromise(countResults(allItems))))).subscribe({
+      next: async currentResultsCount => {
+        const page = await performTaskLoop({
+          initValue: currentResultsCount,
+          checkContinue: async () => {
+            const result = await checkResultsLimit();
+            currentResultsCount = result.currentCount;
+            return result.shouldContinue;
+          },
+          next: async () => await accumulator.itemIteration.nextPage()
+        });
+        resolve({
+          page,
+          resultsCount: currentResultsCount
+        });
+      },
+      error: error => {
+        reject(error);
+      }
+    });
+  });
+}
+
 /**
  * Used for ItemAccumulators that have an array of results returned per page instead of a single item.
  *
@@ -5139,6 +5195,16 @@ function accumulatorCurrentPageListLoadingState(accumulator) {
   })), shareReplay(1));
 }
 
+/**
+ * Returns the latest loaded page number from the input PageItemAccumulator.
+ *
+ * @param pageItemAccumulator
+ * @returns
+ */
+function pageItemAccumulatorCurrentPage(pageItemAccumulator) {
+  return pageItemAccumulator.itemIteration.latestLoadedPage$;
+}
+
 /**
  * An object that maps loading states from one mapping to another.
  */
@@ -5839,4 +5905,4 @@ function workFactoryForConfigFactory(configFactory) {
   };
 }
 
-export { AbstractLoadingStateContextInstance, DEFAULT_ASYNC_PUSHER_THROTTLE, DEFAULT_FACTORY_TIMER_INTERVAL, DEFAULT_ITEM_PAGE_ITERATOR_MAX, DEFAULT_LOCK_SET_TIME_LOCK_KEY, FilterMap, FilterMapKeyInstance, FilterSource, FilterSourceConnector, FilterSourceInstance, ItemAccumulatorInstance, ItemPageIterationInstance, ItemPageIterator, ListLoadingStateContextInstance, LoadingStateContextInstance, LoadingStateType, LockSet, MappedItemIterationInstance, MappedPageItemIterationInstance, MultiSubscriptionObject, PresetFilterSource, SimpleLoadingContext, SubscriptionObject, ValuesLoadingContext, WorkInstance, accumulatorCurrentPageListLoadingState, accumulatorFlattenPageListLoadingState, allLoadingStatesHaveFinishedLoading, asObservable, asObservableFromGetter, asyncPusher, asyncPusherCache, beginLoading, beginLoadingPage, checkIs, cleanup, cleanupDestroyable, combineLatestFromArrayObsFn, combineLatestFromMapValuesObsFn, combineLatestFromObject, combineLatestMapFrom, combineLoadingStates, combineLoadingStatesStatus, distinctLoadingState, distinctUntilArrayLengthChanges, distinctUntilHasDifferentValues, distinctUntilItemsHaveDifferentValues, distinctUntilItemsValueChanges, distinctUntilKeysChange, distinctUntilMapHasDifferentKeys, distinctUntilModelIdChange, distinctUntilModelKeyChange, distinctUntilObjectKeyChange, distinctUntilObjectValuesChanged, emitAfterDelay, emitDelayObs, errorFromLoadingState, errorPageResult, errorResult, factoryTimer, filterIfObjectValuesUnchanged, filterItemsWithObservableDecision, filterMaybe, filterUnique, filterWithSearchString, flattenAccumulatorResultItemArray, idleLoadingState, incrementingNumberTimer, initialize, invertObservableDecision, isErrorLoadingState, isItemPageIteratorResultEndResult, isListLoadingStateEmpty, isLoading, isNot, isSuccessLoadingState, itemAccumulator, iterationHasNextAndCanLoadMore, iteratorNextPageUntilMaxPageLoadLimit, iteratorNextPageUntilPage, keyValueMap, lazyFrom, listLoadingStateContext, listLoadingStateIsEmpty, loadingStateContext, loadingStateFromObs, loadingStateHasError, loadingStateHasFinishedLoading, loadingStateHasFinishedLoadingWithError, loadingStateHasFinishedLoadingWithValue, loadingStateHasValue, loadingStateIsIdle, loadingStateIsLoading, loadingStateType, loadingStatesHaveEquivalentMetadata, makeCheckIsFunction, makeMapFilterWithPresetFn, makeReturnIfIsFunction, mapEachAsync, mapFilterWithPreset, mapForEach, mapIf, mapItemIteration, mapKeysIntersectionToArray, mapLoadingState, mapLoadingStateResults, mapLoadingStateValueFunction, mapLoadingStateValueWithOperator, mapMaybe, mapMultipleLoadingStateResults, mapPageItemIteration, maybeValueFromObservableOrValueGetter, mergeLoadingStates, multiKeyValueMap, onFalseToTrue, onLockSetNextUnlock, onMatchDelta, onTrueToFalse, pageLoadingStateFromObs, pipeIf, preventComplete, promiseFromLoadingState, randomDelay, randomDelayWithRandomFunction, returnIfIs, scanBuildArray, scanCount, scanIntoArray, setContainsAllValuesFrom, setContainsAnyValueFrom, setContainsNoValueFrom, skipFirstMaybe, startWithBeginLoading, successPageResult, successResult, switchMapMaybeDefault, switchMapMaybeObs, switchMapObject, switchMapOnBoolean, switchMapToDefault, switchMapWhileFalse, switchMapWhileTrue, tapAfterTimeout, tapFirst, tapLog, tapOnLoadingStateSuccess, tapOnLoadingStateType, throwErrorAfterTimeout, timeoutStartWith, unknownLoadingStatesIsLoading, updatedStateForSetError, updatedStateForSetLoading, updatedStateForSetValue, useAsObservable, useFirst, valueFromFinishedLoadingState, valueFromLoadingState, valueFromObservableOrValue, valueFromObservableOrValueGetter, workFactory, workFactoryForConfigFactory };
+export { AbstractLoadingStateContextInstance, DEFAULT_ASYNC_PUSHER_THROTTLE, DEFAULT_FACTORY_TIMER_INTERVAL, DEFAULT_ITEM_PAGE_ITERATOR_MAX, DEFAULT_LOCK_SET_TIME_LOCK_KEY, FilterMap, FilterMapKeyInstance, FilterSource, FilterSourceConnector, FilterSourceInstance, ItemAccumulatorInstance, ItemPageIterationInstance, ItemPageIterator, ListLoadingStateContextInstance, LoadingStateContextInstance, LoadingStateType, LockSet, MappedItemIterationInstance, MappedPageItemIterationInstance, MultiSubscriptionObject, PresetFilterSource, SimpleLoadingContext, SubscriptionObject, ValuesLoadingContext, WorkInstance, accumulatorCurrentPageListLoadingState, accumulatorFlattenPageListLoadingState, allLoadingStatesHaveFinishedLoading, asObservable, asObservableFromGetter, asyncPusher, asyncPusherCache, beginLoading, beginLoadingPage, checkIs, cleanup, cleanupDestroyable, combineLatestFromArrayObsFn, combineLatestFromMapValuesObsFn, combineLatestFromObject, combineLatestMapFrom, combineLoadingStates, combineLoadingStatesStatus, distinctLoadingState, distinctUntilArrayLengthChanges, distinctUntilHasDifferentValues, distinctUntilItemsHaveDifferentValues, distinctUntilItemsValueChanges, distinctUntilKeysChange, distinctUntilMapHasDifferentKeys, distinctUntilModelIdChange, distinctUntilModelKeyChange, distinctUntilObjectKeyChange, distinctUntilObjectValuesChanged, emitAfterDelay, emitDelayObs, errorFromLoadingState, errorPageResult, errorResult, factoryTimer, filterIfObjectValuesUnchanged, filterItemsWithObservableDecision, filterMaybe, filterUnique, filterWithSearchString, flattenAccumulatorResultItemArray, idleLoadingState, incrementingNumberTimer, initialize, invertObservableDecision, isErrorLoadingState, isItemPageIteratorResultEndResult, isListLoadingStateEmpty, isLoading, isNot, isSuccessLoadingState, itemAccumulator, itemAccumulatorNextPageUntilResultsCount, iterationHasNextAndCanLoadMore, iteratorNextPageUntilMaxPageLoadLimit, iteratorNextPageUntilPage, keyValueMap, lazyFrom, listLoadingStateContext, listLoadingStateIsEmpty, loadingStateContext, loadingStateFromObs, loadingStateHasError, loadingStateHasFinishedLoading, loadingStateHasFinishedLoadingWithError, loadingStateHasFinishedLoadingWithValue, loadingStateHasValue, loadingStateIsIdle, loadingStateIsLoading, loadingStateType, loadingStatesHaveEquivalentMetadata, makeCheckIsFunction, makeMapFilterWithPresetFn, makeReturnIfIsFunction, mapEachAsync, mapFilterWithPreset, mapForEach, mapIf, mapItemIteration, mapKeysIntersectionToArray, mapLoadingState, mapLoadingStateResults, mapLoadingStateValueFunction, mapLoadingStateValueWithOperator, mapMaybe, mapMultipleLoadingStateResults, mapPageItemIteration, maybeValueFromObservableOrValueGetter, mergeLoadingStates, multiKeyValueMap, onFalseToTrue, onLockSetNextUnlock, onMatchDelta, onTrueToFalse, pageItemAccumulatorCurrentPage, pageLoadingStateFromObs, pipeIf, preventComplete, promiseFromLoadingState, randomDelay, randomDelayWithRandomFunction, returnIfIs, scanBuildArray, scanCount, scanIntoArray, setContainsAllValuesFrom, setContainsAnyValueFrom, setContainsNoValueFrom, skipFirstMaybe, startWithBeginLoading, successPageResult, successResult, switchMapMaybeDefault, switchMapMaybeObs, switchMapObject, switchMapOnBoolean, switchMapToDefault, switchMapWhileFalse, switchMapWhileTrue, tapAfterTimeout, tapFirst, tapLog, tapOnLoadingStateSuccess, tapOnLoadingStateType, throwErrorAfterTimeout, timeoutStartWith, unknownLoadingStatesIsLoading, updatedStateForSetError, updatedStateForSetLoading, updatedStateForSetValue, useAsObservable, useFirst, valueFromFinishedLoadingState, valueFromLoadingState, valueFromObservableOrValue, valueFromObservableOrValueGetter, workFactory, workFactoryForConfigFactory };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/rxjs",
-  "version": "10.0.19",
+  "version": "10.0.21",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",

package/src/lib/iterator/iteration.accumulator.d.ts

@@ -1,5 +1,5 @@
 import { type Observable } from 'rxjs';
-import { type MapFunctionOutputPair, type Destroyable, type IndexRef } from '@dereekb/util';
+import { type MapFunctionOutputPair, type Destroyable, type IndexRef, type GetterOrValue, type MapFunction, type PromiseOrValue, type Page } from '@dereekb/util';
 import { type ItemIteration, type PageItemIteration } from './iteration';
 import { type LoadingState, type MapLoadingStateValueMapFunction } from '../loading';
 export type ItemAccumulatorMapFunction<O, I> = MapLoadingStateValueMapFunction<O, I>;
@@ -83,3 +83,22 @@ export declare class ItemAccumulatorInstance<O, I = unknown, N extends ItemItera
  */
 export declare function itemAccumulator<I, N extends ItemIteration<I> = ItemIteration<I>>(itemIteration: N): ItemAccumulatorInstance<I, I, N>;
 export declare function itemAccumulator<O, I, N extends ItemIteration<I> = ItemIteration<I>>(itemIteration: N, mapItem?: ItemAccumulatorMapFunction<O, I>): ItemAccumulatorInstance<O, I, N>;
+export type ItemAccumulatorNextPageUntilResultsCountFunction<O> = MapFunction<O[], PromiseOrValue<number>>;
+export interface ItemAccumulatorNextPageUntilResultsCountConfig<O> {
+    readonly accumulator: ItemAccumulator<O, any, PageItemIteration<any>>;
+    readonly maxResultsLimit: GetterOrValue<number>;
+    readonly countResultsFunction: ItemAccumulatorNextPageUntilResultsCountFunction<O>;
+}
+export interface ItemAccumulatorNextPageUntilResultsCountResult extends Page {
+    readonly resultsCount: number;
+}
+/**
+ * Automatically calls next on the accumulator's page item iteration up to the target number of results. Returns the total number of items loaded.
+ *
+ * The promise will reject with an error if an error is encountered.
+ *
+ * @param iteration
+ * @param maxResultsLimit
+ * @returns
+ */
+export declare function itemAccumulatorNextPageUntilResultsCount<O>(config: ItemAccumulatorNextPageUntilResultsCountConfig<O>): Promise<ItemAccumulatorNextPageUntilResultsCountResult>;

package/src/lib/iterator/iteration.accumulator.rxjs.d.ts

@@ -16,3 +16,10 @@ export declare function accumulatorFlattenPageListLoadingState<T, I = unknown>(a
  * A PageListLoadingState that captures all the values that have been loaded so far, and the current loading state of currentPageResult$.
  */
 export declare function accumulatorCurrentPageListLoadingState<V, I = unknown>(accumulator: PageItemAccumulator<V, I>): Observable<PageListLoadingState<V>>;
+/**
+ * Returns the latest loaded page number from the input PageItemAccumulator.
+ *
+ * @param pageItemAccumulator
+ * @returns
+ */
+export declare function pageItemAccumulatorCurrentPage(pageItemAccumulator: PageItemAccumulator<any, any>): Observable<number>;

package/src/lib/iterator/iteration.d.ts

@@ -14,7 +14,21 @@ export interface ItemIteratorNextRequest {
     retry?: boolean;
 }
 export interface ItemIteration<V = unknown, L extends LoadingState<V> = LoadingState<V>> extends Destroyable {
+    /**
+     * Whether or not there are more items to be loaded.
+     *
+     * This emits every time a page has finished loading.
+     *
+     * This will not return false when the max page limit has been reached.
+     */
     readonly hasNext$: Observable<boolean>;
+    /**
+     * Whether or not more items can be loaded.
+     *
+     * Similar to hasNext$ but does not emit until the value changes.
+     *
+     * This returns false if the max page limit has been reached.
+     */
     readonly canLoadMore$: Observable<boolean>;
     /**
      * The first stable state that has finished loading.
@@ -50,7 +64,7 @@ export interface PageItemIteration<V = unknown, L extends PageLoadingState<V> =
     /**
      * Attempts to loads the next page of results and returns a promise.
      *
-     * The promise will return when the next action has completed.
+     * The promise will return when the next action has completed, and returns the page number of the loaded page.
      *
      * If the page result ends in an error, this promise will throw that error.
      *

package/src/lib/iterator/iterator.page.d.ts

@@ -165,7 +165,7 @@ export declare class ItemPageIterationInstance<V, F, C extends ItemPageIteration
     nextPage(request?: ItemIteratorNextRequest): Promise<number>;
     readonly currentState$: Observable<PageLoadingState<V>>;
     readonly latestLoadedPage$: Observable<PageNumber>;
-    readonly numberOfPagesLoaded$: Observable<PageNumber>;
+    readonly numberOfPagesLoaded$: Observable<number>;
     /**
      * Whether or not there are more results to load.
      */