@dereekb/rxjs 0.0.1

package/README.md

@@ -0,0 +1,7 @@
+# rxjs
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test rxjs` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@dereekb/rxjs",
+  "version": "0.0.1",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "dependencies": {
+    "rxjs": "^7.5.2",
+    "@dereekb/util": "0.0.1",
+    "extra-set": "^2.2.11",
+    "ms": "^3.0.0-canary.1"
+  },
+  "peerDependencies": {}
+}

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './lib';

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./lib"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/rxjs/src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAsB"}

package/src/lib/index.d.ts

@@ -0,0 +1,6 @@
+export * from './iterator';
+export * from './loading';
+export * from './lock';
+export * from './object';
+export * from './rxjs';
+export * from './subscription';

package/src/lib/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./iterator"), exports);
+(0, tslib_1.__exportStar)(require("./loading"), exports);
+(0, tslib_1.__exportStar)(require("./lock"), exports);
+(0, tslib_1.__exportStar)(require("./object"), exports);
+(0, tslib_1.__exportStar)(require("./rxjs"), exports);
+(0, tslib_1.__exportStar)(require("./subscription"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../packages/rxjs/src/lib/index.ts"],"names":[],"mappings":";;;AAAA,0DAA2B;AAC3B,yDAA0B;AAC1B,sDAAuB;AACvB,wDAAyB;AACzB,sDAAuB;AACvB,8DAA+B"}

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

@@ -0,0 +1,6 @@
+export * from './iteration.next';
+export * from './iteration.accumulator.rxjs';
+export * from './iteration';
+export * from './iteration.mapped';
+export * from './iteration.mapped.page';
+export * from './iterator.page';

package/src/lib/iterator/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./iteration.next"), exports);
+(0, tslib_1.__exportStar)(require("./iteration.accumulator.rxjs"), exports);
+(0, tslib_1.__exportStar)(require("./iteration"), exports);
+(0, tslib_1.__exportStar)(require("./iteration.mapped"), exports);
+(0, tslib_1.__exportStar)(require("./iteration.mapped.page"), exports);
+(0, tslib_1.__exportStar)(require("./iterator.page"), exports);
+//# sourceMappingURL=index.js.map

package/src/lib/iterator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/rxjs/src/lib/iterator/index.ts"],"names":[],"mappings":";;;AAAA,gEAAiC;AACjC,4EAA6C;AAC7C,2DAA4B;AAC5B,kEAAmC;AACnC,uEAAwC;AACxC,+DAAgC"}

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

@@ -0,0 +1,56 @@
+import { Destroyable, Maybe } from "@dereekb/util";
+import { Observable } from "rxjs";
+import { ItemIteration, PageItemIteration } from "./iteration";
+import { LoadingState } from '../loading';
+/**
+ * An object that accumulates and exposes values from an ItemIteration.
+ */
+export interface ItemAccumulator<O, I = any, N extends ItemIteration<I> = ItemIteration<I>> {
+    /**
+     * Iteration being accumulated.
+     */
+    readonly itemIteration: N;
+    /**
+     * Returns all items loaded so far in the iteration in a single array.
+     */
+    readonly allItems$: Observable<O[]>;
+}
+/**
+ * An object that accumulates and exposes values from a PageItemIteration.
+ */
+export declare type PageItemAccumulator<O, I = any, N extends PageItemIteration<I> = PageItemIteration<I>> = ItemAccumulator<O, I, N>;
+/**
+ * An accumulator with no mapping.
+ */
+export declare type MonotypeItemAccumulator<I, N extends ItemIteration<I> = ItemIteration<I>> = ItemAccumulator<I, I, N>;
+/**
+ * A page accumulator with no mapping.
+ */
+export declare type MonotypePageItemAccumulator<I, N extends PageItemIteration<I> = PageItemIteration<I>> = ItemAccumulator<I, I, N>;
+export declare type ItemAccumulatorMapFunction<O, I> = ((item: I) => Maybe<O>) | ((item: I, state: LoadingState<I>) => Maybe<O>);
+/**
+ * ItemAccumulator implementation.
+ */
+export declare class ItemAccumulatorInstance<O, I = any, N extends ItemIteration<I> = ItemIteration<I>> implements ItemAccumulator<O, I, N>, Destroyable {
+    readonly itemIteration: N;
+    readonly mapItemFunction: ItemAccumulatorMapFunction<O, I>;
+    constructor(itemIteration: N, mapItemFunction: ItemAccumulatorMapFunction<O, I>);
+    readonly latestSuccessfulState$: Observable<LoadingState<I>>;
+    /**
+     * All successful page results in a single array.
+     */
+    readonly allSuccessfulStates$: Observable<LoadingState<I>[]>;
+    readonly successfulLoadCount$: Observable<number>;
+    readonly allItems$: Observable<O[]>;
+    private _sub;
+    destroy(): void;
+}
+/**
+ * Creates a new ItemAccumulator instance give the input ItemIteration.
+ *
+ * @param itemIteration
+ * @param mapItem
+ * @returns
+ */
+export declare function itemAccumulator<I, N extends ItemIteration<I>>(itemIteration: N): ItemAccumulatorInstance<I, I, N>;
+export declare function itemAccumulator<O, I, N extends ItemIteration<I>>(itemIteration: N, mapItem?: ItemAccumulatorMapFunction<O, I>): ItemAccumulatorInstance<O, I, N>;

package/src/lib/iterator/iteration.accumulator.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.itemAccumulator = exports.ItemAccumulatorInstance = void 0;
+const subscription_1 = require("../subscription");
+const operators_1 = require("rxjs/operators");
+const rxjs_1 = require("../rxjs");
+const util_1 = require("@dereekb/util");
+const rxjs_2 = require("rxjs");
+const loading_1 = require("../loading");
+/**
+ * ItemAccumulator implementation.
+ */
+class ItemAccumulatorInstance {
+    constructor(itemIteration, mapItemFunction) {
+        this.itemIteration = itemIteration;
+        this.mapItemFunction = mapItemFunction;
+        this.latestSuccessfulState$ = this.itemIteration.latestState$.pipe((0, operators_1.filter)(x => !(0, loading_1.loadingStateHasError)(x)), (0, operators_1.distinctUntilChanged)(), (0, rxjs_2.shareReplay)(1));
+        /**
+         * All successful page results in a single array.
+         */
+        this.allSuccessfulStates$ = this.latestSuccessfulState$.pipe((0, rxjs_1.scanIntoArray)({ immutable: false }), (0, rxjs_1.distinctUntilArrayLengthChanges)(), (0, rxjs_2.shareReplay)(1));
+        this.successfulLoadCount$ = this.allSuccessfulStates$.pipe((0, rxjs_2.map)(x => x.length), (0, rxjs_2.shareReplay)(1));
+        // MARK: ItemAccumulator
+        this.allItems$ = this.allSuccessfulStates$.pipe((0, rxjs_1.scanBuildArray)((allSuccessfulStates) => {
+            const mapStateToItem = (state) => {
+                let result;
+                if (state.model != null) {
+                    result = this.mapItemFunction(state.model, state);
+                }
+                return result;
+            };
+            /*
+            We start with allSuccessfulPageResults$ since it contains all page results since the start of the iterator,
+            and subscription to allItems may not have started at the same time.
+      
+            We use scan to add in all models coming in afterwards by pushing them into the accumulator.
+            This is to prevent performance issues with very large iteration sets, since we can
+            append onto the array, rather than concat/copy the array each time.
+            */
+            const allPageResultsUpToFirstSubscription = allSuccessfulStates;
+            const firstLatestState = (0, util_1.lastValue)(allPageResultsUpToFirstSubscription);
+            const seed = (0, util_1.filterMaybeValues)(allPageResultsUpToFirstSubscription.map(mapStateToItem));
+            const accumulatorObs = this.latestSuccessfulState$.pipe((0, rxjs_2.skipWhile)(x => x === firstLatestState), (0, rxjs_2.map)(mapStateToItem), (0, rxjs_1.filterMaybe)());
+            return {
+                seed,
+                accumulatorObs
+            };
+        }));
+        this._sub = new subscription_1.SubscriptionObject(this.allSuccessfulStates$.subscribe());
+    }
+    destroy() {
+        this._sub.destroy();
+    }
+}
+exports.ItemAccumulatorInstance = ItemAccumulatorInstance;
+function itemAccumulator(itemIteration, mapItemFunction) {
+    if (!mapItemFunction) {
+        mapItemFunction = (a) => a;
+    }
+    return new ItemAccumulatorInstance(itemIteration, mapItemFunction);
+}
+exports.itemAccumulator = itemAccumulator;
+//# sourceMappingURL=iteration.accumulator.js.map

package/src/lib/iterator/iteration.accumulator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iteration.accumulator.js","sourceRoot":"","sources":["../../../../../../packages/rxjs/src/lib/iterator/iteration.accumulator.ts"],"names":[],"mappings":";;;AAAA,kDAAqD;AACrD,8CAA8D;AAC9D,kCAAsG;AACtG,wCAAiF;AACjF,+BAA+D;AAE/D,wCAAgE;AAqChE;;GAEG;AACH,MAAa,uBAAuB;IAElC,YAAqB,aAAgB,EAAW,eAAiD;QAA5E,kBAAa,GAAb,aAAa,CAAG;QAAW,oBAAe,GAAf,eAAe,CAAkC;QAExF,2BAAsB,GAAgC,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CACjG,IAAA,kBAAM,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAA,8BAAoB,EAAC,CAAC,CAAC,CAAC,EACrC,IAAA,gCAAoB,GAAE,EACtB,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;QAEF;;WAEG;QACM,yBAAoB,GAAkC,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAC7F,IAAA,oBAAa,EAAC,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,EACnC,IAAA,sCAA+B,GAAE,EACjC,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;QAEO,yBAAoB,GAAuB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAChF,IAAA,UAAG,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,EAClB,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;QAEF,wBAAwB;QACf,cAAS,GAAoB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAClE,IAAA,qBAAc,EAAC,CAAC,mBAAmB,EAAE,EAAE;YACrC,MAAM,cAAc,GAAyC,CAAC,KAAK,EAAE,EAAE;gBACrE,IAAI,MAAgB,CAAC;gBAErB,IAAI,KAAK,CAAC,KAAK,IAAI,IAAI,EAAE;oBACvB,MAAM,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;iBACnD;gBAED,OAAO,MAAM,CAAC;YAChB,CAAC,CAAC;YAEF;;;;;;;cAOE;YACF,MAAM,mCAAmC,GAAG,mBAAmB,CAAC;YAChE,MAAM,gBAAgB,GAAG,IAAA,gBAAS,EAAC,mCAAmC,CAAC,CAAC;YACxE,MAAM,IAAI,GAAQ,IAAA,wBAAiB,EAAC,mCAAmC,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;YAE7F,MAAM,cAAc,GAAkB,IAAI,CAAC,sBAAsB,CAAC,IAAI,CACpE,IAAA,gBAAS,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,gBAAgB,CAAC,EACtC,IAAA,UAAG,EAAC,cAAc,CAAC,EACnB,IAAA,kBAAW,GAAE,CACd,CAAC;YAEF,OAAO;gBACL,IAAI;gBACJ,cAAc;aACf,CAAC;QACJ,CAAC,CAAC,CACH,CAAC;QAEM,SAAI,GAAG,IAAI,iCAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE,CAAC,CAAC;IA5DwB,CAAC;IA8DtG,OAAO;QACL,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;CAEF;AApED,0DAoEC;AAWD,SAAgB,eAAe,CAAmC,aAAgB,EAAE,eAAkD;IACpI,IAAI,CAAC,eAAe,EAAE;QACpB,eAAe,GAAG,CAAC,CAAM,EAAE,EAAE,CAAC,CAAC,CAAC;KACjC;IAED,OAAO,IAAI,uBAAuB,CAAU,aAAa,EAAE,eAAe,CAAC,CAAC;AAC9E,CAAC;AAND,0CAMC"}

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

@@ -0,0 +1,14 @@
+import { Observable } from 'rxjs';
+import { PageListLoadingState } from '../loading';
+import { ItemAccumulator, PageItemAccumulator } from './iteration.accumulator';
+/**
+ * Used for ItemAccumulators that have an array of results returned per page instead of a single item.
+ *
+ * @param iteration
+ * @returns
+ */
+export declare function flattenIterationResultItemArray<T>(iteration: ItemAccumulator<T[]>): Observable<T[]>;
+/**
+ * A PageListLoadingState that captures all the values that have been loaded so far, and the current loading state of currentPageResult$.
+ */
+export declare function iterationCurrentPageListLoadingState<V>(iteration: PageItemAccumulator<V>): Observable<PageListLoadingState<V>>;

package/src/lib/iterator/iteration.accumulator.rxjs.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.iterationCurrentPageListLoadingState = exports.flattenIterationResultItemArray = void 0;
+const util_1 = require("@dereekb/util");
+const rxjs_1 = require("../rxjs");
+const rxjs_2 = require("rxjs");
+const loading_1 = require("../loading");
+/**
+ * Used for ItemAccumulators that have an array of results returned per page instead of a single item.
+ *
+ * @param iteration
+ * @returns
+ */
+function flattenIterationResultItemArray(iteration) {
+    return iteration.allItems$.pipe((0, rxjs_1.scanBuildArray)((allItems) => {
+        const seed = (0, util_1.flattenArray)(allItems);
+        const latestItem = (0, util_1.lastValue)(allItems);
+        const accumulatorObs = iteration.itemIteration.latestState$.pipe((0, rxjs_2.skipWhile)(x => x.model === latestItem), (0, rxjs_2.map)(x => x.model), (0, rxjs_1.filterMaybe)());
+        return {
+            seed,
+            accumulatorObs
+        };
+    }));
+}
+exports.flattenIterationResultItemArray = flattenIterationResultItemArray;
+/**
+ * A PageListLoadingState that captures all the values that have been loaded so far, and the current loading state of currentPageResult$.
+ */
+function iterationCurrentPageListLoadingState(iteration) {
+    return (0, rxjs_2.combineLatest)([iteration.itemIteration.currentState$, iteration.allItems$]).pipe((0, rxjs_2.map)(([state, values]) => (0, loading_1.mapLoadingStateResults)(state, {
+        mapValue: () => values
+    })), (0, rxjs_2.shareReplay)(1));
+}
+exports.iterationCurrentPageListLoadingState = iterationCurrentPageListLoadingState;
+//# sourceMappingURL=iteration.accumulator.rxjs.js.map

package/src/lib/iterator/iteration.accumulator.rxjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iteration.accumulator.rxjs.js","sourceRoot":"","sources":["../../../../../../packages/rxjs/src/lib/iterator/iteration.accumulator.rxjs.ts"],"names":[],"mappings":";;;AAAA,wCAAwD;AACxD,kCAAsD;AACtD,+BAA8E;AAC9E,wCAA0E;AAG1E;;;;;GAKG;AACH,SAAgB,+BAA+B,CAAI,SAA+B;IAChF,OAAO,SAAS,CAAC,SAAS,CAAC,IAAI,CAC7B,IAAA,qBAAc,EAAC,CAAC,QAAe,EAAE,EAAE;QACjC,MAAM,IAAI,GAAG,IAAA,mBAAY,EAAC,QAAQ,CAAC,CAAC;QACpC,MAAM,UAAU,GAAG,IAAA,gBAAS,EAAC,QAAQ,CAAC,CAAC;QAEvC,MAAM,cAAc,GAAoB,SAAS,CAAC,aAAa,CAAC,YAAY,CAAC,IAAI,CAC/E,IAAA,gBAAS,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,UAAU,CAAC,EACtC,IAAA,UAAG,EAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,EACjB,IAAA,kBAAW,GAAE,CACd,CAAC;QAEF,OAAO;YACL,IAAI;YACJ,cAAc;SACR,CAAC;IACX,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAlBD,0EAkBC;AAED;;GAEG;AACH,SAAgB,oCAAoC,CAAI,SAAiC;IACvF,OAAO,IAAA,oBAAa,EAAC,CAAC,SAAS,CAAC,aAAa,CAAC,aAAa,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CACrF,IAAA,UAAG,EAAC,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,IAAA,gCAAsB,EAAC,KAAK,EAAE;QACrD,QAAQ,EAAE,GAAG,EAAE,CAAC,MAAM;KACvB,CAA4B,CAAC,EAC9B,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;AACJ,CAAC;AAPD,oFAOC"}

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

@@ -0,0 +1,58 @@
+import { Observable } from 'rxjs';
+import { Destroyable, PageNumber } from "@dereekb/util";
+import { LoadingState, PageLoadingState } from '../loading';
+export interface ItemIteratorNextRequest {
+    /**
+     * The expected page to request.
+     *
+     * If provided, the page must equal the target page, otherwise the next is ignored.
+     */
+    page?: number;
+    /**
+     * Whether or not to retry loading the page.
+     */
+    retry?: boolean;
+}
+export interface ItemIteration<V = any, L extends LoadingState<V> = LoadingState<V>> extends Destroyable {
+    readonly hasNext$: Observable<boolean>;
+    readonly canLoadMore$: Observable<boolean>;
+    /**
+     * The latest stable state that has finished loading.
+     */
+    readonly latestState$: Observable<L>;
+    /**
+     * The "current" page state.
+     */
+    readonly currentState$: Observable<L>;
+    /**
+     * Triggers a loading of the next page.
+     */
+    next(request?: ItemIteratorNextRequest): void;
+}
+/**
+ * An ItemIteration that has pages.
+ */
+export interface PageItemIteration<V = any, L extends PageLoadingState<V> = PageLoadingState<V>> extends ItemIteration<V, L> {
+    /**
+     * The maximum number of pages allowed to be loaded.
+     *
+     * A page of 15 means that pages 0-14 can be loaded, but not page 15.
+     */
+    maxPageLoadLimit: PageNumber;
+    /**
+     * Attempts to loads the next page of results and returns a promise.
+     *
+     * The promise will return when the next action has completed.
+     *
+     * If the page result ends in an error, this promise will throw that error.
+     *
+     * @param request
+     */
+    nextPage(request?: ItemIteratorNextRequest): Promise<PageNumber>;
+    /**
+     * Returns the latest page that has been fully loaded.
+     *
+     * This page can be different than the page returned in currentPageState$.
+     */
+    readonly latestLoadedPage$: Observable<PageNumber>;
+}

package/src/lib/iterator/iteration.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=iteration.js.map

package/src/lib/iterator/iteration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iteration.js","sourceRoot":"","sources":["../../../../../../packages/rxjs/src/lib/iterator/iteration.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,38 @@
+import { LoadingState, MapLoadingStateResultsConfiguration, PageLoadingState } from '../loading';
+import { Destroyable } from "@dereekb/util";
+import { Observable } from "rxjs";
+import { ItemIteration, ItemIteratorNextRequest } from "./iteration";
+/**
+ * An object that maps loading states from one mapping to another.
+ */
+export interface MappedItemIteration<O, I = any, M extends LoadingState<O> = LoadingState<O>, L extends LoadingState<I> = LoadingState<I>, N extends ItemIteration<I, L> = ItemIteration<I, L>> extends ItemIteration<O, M> {
+    /**
+     * Iteration being accumulated.
+     */
+    readonly itemIteration: N;
+}
+export interface MappedItemIterationInstanceMapConfig<O, I, M extends LoadingState<O> = PageLoadingState<O>, L extends LoadingState<I> = PageLoadingState<I>> extends MapLoadingStateResultsConfiguration<I, O, L, M> {
+    /**
+     * Whether or not to forward the destroy() call to the base itemIteration.
+     */
+    forwardDestroy?: boolean;
+}
+export declare class MappedItemIterationInstance<O, I = any, M extends LoadingState<O> = LoadingState<O>, L extends LoadingState<I> = LoadingState<I>, N extends ItemIteration<I, L> = ItemIteration<I, L>> implements ItemIteration<O>, Destroyable {
+    readonly itemIterator: N;
+    readonly config: MappedItemIterationInstanceMapConfig<O, I, M, L>;
+    constructor(itemIterator: N, config: MappedItemIterationInstanceMapConfig<O, I, M, L>);
+    readonly hasNext$: Observable<boolean>;
+    readonly canLoadMore$: Observable<boolean>;
+    readonly latestState$: Observable<M>;
+    readonly currentState$: Observable<M>;
+    next(request?: ItemIteratorNextRequest): void;
+    destroy(): void;
+}
+/**
+ * Creates a new MappedItemIteration instance given the input ItemIteration and config.
+ *
+ * @param itemIteration
+ * @param config
+ * @returns
+ */
+export declare function mapItemIteration<O, I = any, M extends LoadingState<O> = LoadingState<O>, L extends LoadingState<I> = LoadingState<I>, N extends ItemIteration<I, L> = ItemIteration<I, L>>(itemIteration: N, config: MappedItemIterationInstanceMapConfig<O, I, M, L>): MappedItemIterationInstance<O, I, M, L, N>;

package/src/lib/iterator/iteration.mapped.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapItemIteration = exports.MappedItemIterationInstance = void 0;
+const loading_1 = require("../loading");
+const rxjs_1 = require("rxjs");
+class MappedItemIterationInstance {
+    constructor(itemIterator, config) {
+        this.itemIterator = itemIterator;
+        this.config = config;
+        this.hasNext$ = this.itemIterator.hasNext$;
+        this.canLoadMore$ = this.itemIterator.canLoadMore$;
+        this.latestState$ = this.itemIterator.latestState$.pipe((0, rxjs_1.map)(state => (0, loading_1.mapLoadingStateResults)(state, this.config)), (0, rxjs_1.shareReplay)(1));
+        this.currentState$ = this.itemIterator.currentState$.pipe((0, rxjs_1.map)(state => (0, loading_1.mapLoadingStateResults)(state, this.config)), (0, rxjs_1.shareReplay)(1));
+    }
+    next(request) {
+        return this.itemIterator.next(request);
+    }
+    destroy() {
+        if (this.config.forwardDestroy !== false) {
+            this.itemIterator.destroy();
+        }
+    }
+}
+exports.MappedItemIterationInstance = MappedItemIterationInstance;
+/**
+ * Creates a new MappedItemIteration instance given the input ItemIteration and config.
+ *
+ * @param itemIteration
+ * @param config
+ * @returns
+ */
+function mapItemIteration(itemIteration, config) {
+    return new MappedItemIterationInstance(itemIteration, config);
+}
+exports.mapItemIteration = mapItemIteration;
+//# sourceMappingURL=iteration.mapped.js.map

package/src/lib/iterator/iteration.mapped.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iteration.mapped.js","sourceRoot":"","sources":["../../../../../../packages/rxjs/src/lib/iterator/iteration.mapped.ts"],"names":[],"mappings":";;;AAAA,wCAAyH;AAEzH,+BAAoD;AAoCpD,MAAa,2BAA2B;IAQtC,YAAqB,YAAe,EAAW,MAAwD;QAAlF,iBAAY,GAAZ,YAAY,CAAG;QAAW,WAAM,GAAN,MAAM,CAAkD;QAE9F,aAAQ,GAAwB,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC;QAC3D,iBAAY,GAAwB,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC;QAEnE,iBAAY,GAAkB,IAAI,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CACxE,IAAA,UAAG,EAAC,KAAK,CAAC,EAAE,CAAC,IAAA,gCAAsB,EAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,EACxD,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;QAEO,kBAAa,GAAkB,IAAI,CAAC,YAAY,CAAC,aAAa,CAAC,IAAI,CAC1E,IAAA,UAAG,EAAC,KAAK,CAAC,EAAE,CAAC,IAAA,gCAAsB,EAAa,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,EACpE,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;IAbyG,CAAC;IAe5G,IAAI,CAAC,OAAiC;QACpC,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IAED,OAAO;QACL,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,KAAK,KAAK,EAAE;YACxC,IAAI,CAAC,YAAY,CAAC,OAAO,EAAE,CAAC;SAC7B;IACH,CAAC;CAEF;AAjCD,kEAiCC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAM9B,aAAgB,EAAE,MAAwD;IAC1E,OAAO,IAAI,2BAA2B,CAAgB,aAAa,EAAE,MAAM,CAAC,CAAC;AAC/E,CAAC;AARD,4CAQC"}

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

@@ -0,0 +1,25 @@
+import { PageLoadingState } from '../loading';
+import { Observable } from "rxjs";
+import { ItemIteratorNextRequest, PageItemIteration } from "./iteration";
+import { MappedItemIteration, MappedItemIterationInstance, MappedItemIterationInstanceMapConfig } from './iteration.mapped';
+/**
+ * MappedItemIteration for PageItemIteration
+ */
+export declare type MappedPageItemIteration<O, I = any, M extends PageLoadingState<O> = PageLoadingState<O>, L extends PageLoadingState<I> = PageLoadingState<I>, N extends PageItemIteration<I, L> = PageItemIteration<I, L>> = MappedItemIteration<O, I, M, L, N>;
+/**
+ * MappedItemIterationInstance extension that implements PageItemIteration.
+ */
+export declare class MappedPageItemIterationInstance<O, I = any, M extends PageLoadingState<O> = PageLoadingState<O>, L extends PageLoadingState<I> = PageLoadingState<I>, N extends PageItemIteration<I, L> = PageItemIteration<I, L>> extends MappedItemIterationInstance<O, I, M, L, N> implements PageItemIteration<O, M> {
+    get maxPageLoadLimit(): number;
+    set maxPageLoadLimit(maxPageLoadLimit: number);
+    readonly latestLoadedPage$: Observable<number>;
+    nextPage(request?: ItemIteratorNextRequest): Promise<number>;
+}
+/**
+ * Creates a new MappedItemIteration instance given the input ItemIteration and config.
+ *
+ * @param itemIteration
+ * @param config
+ * @returns
+ */
+export declare function mapPageItemIteration<O, I = any, M extends PageLoadingState<O> = PageLoadingState<O>, L extends PageLoadingState<I> = PageLoadingState<I>, N extends PageItemIteration<I, L> = PageItemIteration<I, L>>(itemIteration: N, config: MappedItemIterationInstanceMapConfig<O, I, M, L>): MappedPageItemIterationInstance<O, I, M, L, N>;

package/src/lib/iterator/iteration.mapped.page.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapPageItemIteration = exports.MappedPageItemIterationInstance = void 0;
+const iteration_mapped_1 = require("./iteration.mapped");
+/**
+ * MappedItemIterationInstance extension that implements PageItemIteration.
+ */
+class MappedPageItemIterationInstance extends iteration_mapped_1.MappedItemIterationInstance {
+    constructor() {
+        super(...arguments);
+        this.latestLoadedPage$ = this.itemIterator.latestLoadedPage$;
+    }
+    // MARK: PageItemIteration
+    get maxPageLoadLimit() {
+        return this.itemIterator.maxPageLoadLimit;
+    }
+    set maxPageLoadLimit(maxPageLoadLimit) {
+        this.itemIterator.maxPageLoadLimit = maxPageLoadLimit;
+    }
+    nextPage(request) {
+        return this.itemIterator.nextPage(request);
+    }
+}
+exports.MappedPageItemIterationInstance = MappedPageItemIterationInstance;
+/**
+ * Creates a new MappedItemIteration instance given the input ItemIteration and config.
+ *
+ * @param itemIteration
+ * @param config
+ * @returns
+ */
+function mapPageItemIteration(itemIteration, config) {
+    return new MappedPageItemIterationInstance(itemIteration, config);
+}
+exports.mapPageItemIteration = mapPageItemIteration;
+//# sourceMappingURL=iteration.mapped.page.js.map

package/src/lib/iterator/iteration.mapped.page.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iteration.mapped.page.js","sourceRoot":"","sources":["../../../../../../packages/rxjs/src/lib/iterator/iteration.mapped.page.ts"],"names":[],"mappings":";;;AAGA,yDAA4H;AAc5H;;GAEG;AACH,MAAa,+BAMT,SAAQ,8CAA0C;IANtD;;QAiBW,sBAAiB,GAAuB,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC;IAMvF,CAAC;IAfC,0BAA0B;IAC1B,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC;IAC5C,CAAC;IAED,IAAI,gBAAgB,CAAC,gBAAwB;QAC3C,IAAI,CAAC,YAAY,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IACxD,CAAC;IAID,QAAQ,CAAC,OAAiC;QACxC,OAAO,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;CAEF;AAvBD,0EAuBC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAMlC,aAAgB,EAAE,MAAwD;IAC1E,OAAO,IAAI,+BAA+B,CAAgB,aAAa,EAAE,MAAM,CAAC,CAAC;AACnF,CAAC;AARD,oDAQC"}

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

@@ -0,0 +1,27 @@
+import { Observable } from "rxjs";
+import { ItemIteration, PageItemIteration } from "./iteration";
+/**
+ * Creates an observable from the input iteration that checks both the hasNext$ and canLoadMore$ states.
+ *
+ * @param iteration
+ * @returns
+ */
+export declare function iterationHasNextAndCanLoadMore<V>(iteration: ItemIteration<V>): Observable<boolean>;
+/**
+ * Automatically calls next up to the current maxPageLoadLimit.
+ *
+ * The promise will reject with an error if an error is encountered.
+ *
+ * @returns
+ */
+export declare function iteratorNextPageUntilMaxPageLoadLimit(iterator: PageItemIteration): Promise<number>;
+/**
+ * Automatically calls next on the PageItemIteration up to the target page, the number of total pages that should be loaded.
+ *
+ * The promise will reject with an error if an error is encountered.
+ *
+ * @param iteration
+ * @param page
+ * @returns
+ */
+export declare function iteratorNextPageUntilPage(iteration: PageItemIteration, page: number | (() => number)): Promise<number>;

package/src/lib/iterator/iteration.next.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.iteratorNextPageUntilPage = exports.iteratorNextPageUntilMaxPageLoadLimit = exports.iterationHasNextAndCanLoadMore = void 0;
+const tslib_1 = require("tslib");
+const rxjs_1 = require("rxjs");
+const util_1 = require("@dereekb/util");
+/**
+ * Creates an observable from the input iteration that checks both the hasNext$ and canLoadMore$ states.
+ *
+ * @param iteration
+ * @returns
+ */
+function iterationHasNextAndCanLoadMore(iteration) {
+    return (0, rxjs_1.combineLatest)([iteration.hasNext$, iteration.canLoadMore$]).pipe((0, rxjs_1.map)((0, util_1.reduceBooleansWithAndFn)(true)), (0, rxjs_1.shareReplay)(1));
+}
+exports.iterationHasNextAndCanLoadMore = iterationHasNextAndCanLoadMore;
+/**
+ * Automatically calls next up to the current maxPageLoadLimit.
+ *
+ * The promise will reject with an error if an error is encountered.
+ *
+ * @returns
+ */
+function iteratorNextPageUntilMaxPageLoadLimit(iterator) {
+    return iteratorNextPageUntilPage(iterator, () => iterator.maxPageLoadLimit);
+}
+exports.iteratorNextPageUntilMaxPageLoadLimit = iteratorNextPageUntilMaxPageLoadLimit;
+/**
+ * Automatically calls next on the PageItemIteration up to the target page, the number of total pages that should be loaded.
+ *
+ * The promise will reject with an error if an error is encountered.
+ *
+ * @param iteration
+ * @param page
+ * @returns
+ */
+function iteratorNextPageUntilPage(iteration, page) {
+    const getPageLimit = (typeof page === 'function') ? page : () => page;
+    function checkPageLimit(page) {
+        const pageLimit = getPageLimit();
+        return (page + 1) < Math.min(pageLimit, iteration.maxPageLoadLimit);
+    }
+    return new Promise((resolve) => {
+        iteration.latestLoadedPage$.pipe((0, rxjs_1.first)()).subscribe((firstLatestPage) => {
+            const promise = (0, util_1.performTaskLoop)({
+                initValue: firstLatestPage,
+                checkContinue: (latestPage) => checkPageLimit(latestPage),
+                next: () => (0, tslib_1.__awaiter)(this, void 0, void 0, function* () { return yield iteration.nextPage(); })
+            });
+            resolve(promise);
+        });
+    });
+}
+exports.iteratorNextPageUntilPage = iteratorNextPageUntilPage;
+//# sourceMappingURL=iteration.next.js.map

package/src/lib/iterator/iteration.next.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iteration.next.js","sourceRoot":"","sources":["../../../../../../packages/rxjs/src/lib/iterator/iteration.next.ts"],"names":[],"mappings":";;;;AAAA,+BAA0E;AAE1E,wCAAyE;AAEzE;;;;;GAKG;AACH,SAAgB,8BAA8B,CAAI,SAA2B;IAC3E,OAAO,IAAA,oBAAa,EAAC,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CACrE,IAAA,UAAG,EAAC,IAAA,8BAAuB,EAAC,IAAI,CAAC,CAAC,EAClC,IAAA,kBAAW,EAAC,CAAC,CAAC,CACf,CAAC;AACJ,CAAC;AALD,wEAKC;AAED;;;;;;GAMG;AACH,SAAgB,qCAAqC,CAAC,QAA2B;IAC/E,OAAO,yBAAyB,CAAC,QAAQ,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;AAC9E,CAAC;AAFD,sFAEC;AAED;;;;;;;;GAQG;AACH,SAAgB,yBAAyB,CAAC,SAA4B,EAAE,IAA6B;IACnG,MAAM,YAAY,GAAG,CAAC,OAAO,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;IAEtE,SAAS,cAAc,CAAC,IAAY;QAClC,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;QACjC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACtE,CAAC;IAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC7B,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAC9B,IAAA,YAAK,GAAE,CACR,CAAC,SAAS,CAAC,CAAC,eAAuB,EAAE,EAAE;YACtC,MAAM,OAAO,GAAoB,IAAA,sBAAe,EAAS;gBACvD,SAAS,EAAE,eAAe;gBAC1B,aAAa,EAAE,CAAC,UAAkB,EAAE,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC;gBACjE,IAAI,EAAE,GAAS,EAAE,6DAAC,OAAA,MAAM,SAAS,CAAC,QAAQ,EAAE,CAAA,GAAA;aAC7C,CAAC,CAAC;YAEH,OAAO,CAAC,OAAO,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AArBD,8DAqBC"}