shelving 1.56.0 → 1.58.0

package/db/{Pagination.d.ts → PaginationState.d.ts}

@@ -1,14 +1,17 @@
 import { Results, Entry, Entries, Data } from "../util/index.js";
-import { State } from "../stream/index.js";
+import { BooleanState, State } from "../stream/index.js";
 import { DatabaseQuery } from "./Database.js";
 /**
  * State that wraps a `Documents` reference to enable pagination.
  * - If you pass in initial values, it will use that as the first page.
  * - If you don't pass in initial values, it will autoload the first page.
  */
-export declare class Pagination<T extends Data> extends State<Results<T>> implements Iterable<Entry<T>> {
-    protected _pending: boolean;
+export declare class PaginationState<T extends Data> extends State<Results<T>> implements Iterable<Entry<T>> {
+    /** Whether this pagination is currently loading results. */
+    readonly busy: BooleanState;
+    /** Reference to the query this pagination is paginating. */
     readonly ref: DatabaseQuery<T>;
+    /** Limit set on this pagination's query. */
     readonly limit: number;
     constructor(ref: DatabaseQuery<T>);
     /**

package/db/{Pagination.js → PaginationState.js}

@@ -1,15 +1,16 @@
 import { getLastItem, assertNumber, yieldMerged, getMap, LOADING, assertMax } from "../util/index.js";
-import { State } from "../stream/index.js";
+import { BooleanState, State } from "../stream/index.js";
 import { ConditionError } from "../index.js";
 /**
  * State that wraps a `Documents` reference to enable pagination.
  * - If you pass in initial values, it will use that as the first page.
  * - If you don't pass in initial values, it will autoload the first page.
  */
-export class Pagination extends State {
+export class PaginationState extends State {
     constructor(ref) {
         super();
-        this._pending = false; // Prevents double-loading.
+        /** Whether this pagination is currently loading results. */
+        this.busy = new BooleanState();
         /**
          * Load more results after the end.
          * - Promise that needs to be handled.
@@ -17,25 +18,29 @@ export class Pagination extends State {
         this.more = async () => {
             if (this.closed)
                 throw new ConditionError("Pagination is closed");
-            if (!this._pending) {
-                this._pending = true;
-                if (!this.loading) {
+            if (!this.busy.value) {
+                this.busy.next(true);
+                if (!this.exists) {
+                    // First set of results.
+                    this._value === LOADING;
+                    const next = await this.ref.results;
+                    this.next(next);
+                    if (next.size < this.limit)
+                        this.complete();
+                    this.busy.next(false);
+                }
+                else {
+                    // Additional set of results.
                     const lastItem = getLastItem(this.value);
                     if (lastItem) {
                         const next = await this.ref.after(lastItem[0], lastItem[1]).results;
                         this.merge(next);
                         if (next.size < this.limit)
                             this.complete();
-                        this._pending = false;
+                        this.busy.next(false);
                         return;
                     }
                 }
-                this._value === LOADING;
-                const next = await this.ref.results;
-                this.next(next);
-                if (next.size < this.limit)
-                    this.complete();
-                this._pending = false;
             }
         };
         this.ref = ref;
@@ -48,7 +53,7 @@ export class Pagination extends State {
      * @return The change in the number of results.
      */
     merge(more) {
-        this.next(getMap(this.ref.sorts.transform(yieldMerged(more, this.value))));
+        this.next(this.exists ? getMap(this.ref.sorts.transform(yieldMerged(more, this.value))) : getMap(more));
     }
     /** Iterate over the entries of the values currently in the pagination. */
     [Symbol.iterator]() {

package/db/index.d.ts

@@ -1,4 +1,4 @@
 export * from "./Database.js";
 export * from "./Operation.js";
-export * from "./Pagination.js";
+export * from "./PaginationState.js";
 export * from "./errors.js";

package/db/index.js

@@ -1,4 +1,4 @@
 export * from "./Database.js";
 export * from "./Operation.js";
-export * from "./Pagination.js";
+export * from "./PaginationState.js";
 export * from "./errors.js";

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.56.0",
+	"version": "1.58.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -62,21 +62,21 @@
 		"@google-cloud/firestore": "^5.0.2",
 		"@types/jest": "^27.4.1",
 		"@types/react": "^17.0.44",
-		"@types/react-dom": "^17.0.15",
-		"@typescript-eslint/eslint-plugin": "^5.20.0",
-		"@typescript-eslint/parser": "^5.20.0",
+		"@types/react-dom": "^17.0.16",
+		"@typescript-eslint/eslint-plugin": "^5.21.0",
+		"@typescript-eslint/parser": "^5.21.0",
 		"eslint": "^8.14.0",
 		"eslint-config-prettier": "^8.5.0",
 		"eslint-plugin-import": "^2.26.0",
 		"eslint-plugin-prettier": "^4.0.0",
-		"firebase": "^9.6.11",
+		"firebase": "^9.7.0",
 		"jest": "^27.5.1",
 		"jest-ts-webcompat-resolver": "^1.0.0",
 		"prettier": "^2.6.2",
 		"react": "^17.0.2",
 		"react-dom": "^17.0.2",
 		"ts-jest": "^27.1.4",
-		"typescript": "^4.6.3"
+		"typescript": "^4.6.4"
 	},
 	"peerDependencies": {
 		"@google-cloud/firestore": ">=4.0.0",

package/react/usePagination.d.ts

@@ -1,6 +1,6 @@
-import { DatabaseQuery, Results, Pagination, Data } from "../index.js";
+import { DatabaseQuery, Results, PaginationState, Data } from "../index.js";
 /**
  * Use a `Pagination` for a collection.
  * - Doesn't persist the state, so if the component or anything beneath it throws the currently paginated results will be lost.
  */
-export declare function usePagination<T extends Data>(ref: DatabaseQuery<T>, initial?: Results<T>): Pagination<T>;
+export declare function usePagination<T extends Data>(ref: DatabaseQuery<T>, initial?: Results<T>): PaginationState<T>;

package/react/usePagination.js

@@ -1,4 +1,4 @@
-import { Pagination } from "../index.js";
+import { PaginationState } from "../index.js";
 import { useSubscribe } from "./useSubscribe.js";
 import { useLazy } from "./useLazy.js";
 /**
@@ -11,7 +11,7 @@ export function usePagination(ref, initial) {
     return pagination;
 }
 function _createPagination(ref, initial) {
-    const pagination = new Pagination(ref);
+    const pagination = new PaginationState(ref);
     if (initial)
         pagination.next(initial);
     return pagination;

package/stream/LazyState.d.ts

@@ -1,12 +1,11 @@
-import type { Observer } from "../util/index.js";
+import { Observer } from "../util/index.js";
 import { State } from "./State.js";
 /**
  * State that tidies up after itself by completing itself after all its subscribers unsubscribe.
  * @param delay How long to wait (in ms) before the source subscription is stopped.
  */
 export declare class LazyState<T> extends State<T> {
-    private _delay;
-    private _timeout?;
-    constructor(delay?: number);
+    private _timeout;
+    constructor(delay?: number | null);
     _removeObserver(observer: Observer<T>): void;
 }

package/stream/LazyState.js

@@ -1,24 +1,23 @@
+import { Timeout } from "../util/index.js";
 import { State } from "./State.js";
 /**
  * State that tidies up after itself by completing itself after all its subscribers unsubscribe.
  * @param delay How long to wait (in ms) before the source subscription is stopped.
  */
 export class LazyState extends State {
-    constructor(delay = 0) {
+    constructor(delay = null) {
         super();
-        this._delay = delay;
+        this._timeout = delay ? new Timeout(delay) : null;
     }
     // Override to stop the source subscription when the last subscriber unsubscribes.
     _removeObserver(observer) {
         super._removeObserver(observer);
-        if (this._delay) {
+        if (this._timeout) {
             // Maybe stop in a bit (if there are still no subscribers).
-            if (this._timeout)
-                clearTimeout(this._timeout);
-            this._timeout = setTimeout(() => {
+            this._timeout.set(() => {
                 if (!this._observers.size && !this.closed)
                     this.complete();
-            }, this._delay);
+            });
         }
         else {
             // Stop now.

package/stream/State.d.ts

@@ -32,7 +32,7 @@ export declare class State<T> extends Stream<T> {
     get value(): T;
     protected _value: T | typeof LOADING;
     /** Is there a current value, or is it still loading. */
-    get loading(): boolean;
+    get exists(): boolean;
     /** Apply a transformer to this state. */
     apply(transformer: Transformer<T, T>): void;
     error(reason: Error | unknown): void;

package/stream/State.js

@@ -23,8 +23,8 @@ export class State extends Stream {
         return this._value;
     }
     /** Is there a current value, or is it still loading. */
-    get loading() {
-        return this._value === LOADING;
+    get exists() {
+        return this._value !== LOADING;
     }
     /** Apply a transformer to this state. */
     apply(transformer) {

package/util/async.d.ts

@@ -59,7 +59,3 @@ export declare class Signal extends AbstractPromise<typeof DONE> {
     /** Send this signal now. */
     done(): void;
 }
-/** Resolve to `DONE` after a specified delay. */
-export declare class Timeout extends AbstractPromise<typeof DONE> {
-    constructor(ms: number);
-}

package/util/async.js

@@ -95,10 +95,3 @@ export class Signal extends AbstractPromise {
         this._resolve(DONE);
     }
 }
-/** Resolve to `DONE` after a specified delay. */
-export class Timeout extends AbstractPromise {
-    constructor(ms) {
-        super();
-        setTimeout(this._resolve, ms, DONE);
-    }
-}

package/util/index.d.ts

@@ -31,6 +31,7 @@ export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./string.js";
 export * from "./template.js";
+export * from "./timeout.js";
 export * from "./transform.js";
 export * from "./undefined.js";
 export * from "./units.js";

package/util/index.js

@@ -31,6 +31,7 @@ export * from "./serialise.js";
 export * from "./sort.js";
 export * from "./string.js";
 export * from "./template.js";
+export * from "./timeout.js";
 export * from "./transform.js";
 export * from "./undefined.js";
 export * from "./units.js";

package/util/observable.d.ts

@@ -40,7 +40,7 @@ export interface Observer<T> {
      */
     readonly from?: (source: Subscribable<T>) => this;
     /** Receive the next value. */
-    readonly next: Dispatcher<[T]>;
+    readonly next?: Dispatcher<[T]>;
     /** End the subscription with an error. */
     readonly error?: Handler;
     /** End the subscription with success. */

package/util/observable.js

@@ -17,8 +17,9 @@ export function subscribe(source, target) {
 }
 /** Dispatch the next value to an observer (and if the next value errors, calls a handler). */
 export function dispatchNext(observer, value) {
+    var _a;
     try {
-        observer.next(value);
+        (_a = observer.next) === null || _a === void 0 ? void 0 : _a.call(observer, value);
     }
     catch (thrown) {
         logError(thrown);

package/util/timeout.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Create a new Timeout.
+ *
+ * Wrapper for `setTimeout()` that...
+ * - Keeps track of the reference returned from `setTimeout()`
+ * - Clears the any existing timeout when a new timeout is set.
+ * - Allows a default delay to be set that is applied to all new timeouts that don't have a delay set.
+ *
+ * @param ms The default delay for any created timeouts (in ms).
+ */
+export declare class Timeout {
+    private _ms;
+    private _timeout;
+    constructor(ms?: number);
+    /**
+     * Cancel any existing timeout and set a new one.
+     * @param callback
+     * @param ms The delay for this timeout (in ms).
+     */
+    set(callback: () => void, ms?: number): void;
+    /** Cancel any existing timeout.. */
+    clear(): void;
+}

package/util/timeout.js

@@ -0,0 +1,30 @@
+/**
+ * Create a new Timeout.
+ *
+ * Wrapper for `setTimeout()` that...
+ * - Keeps track of the reference returned from `setTimeout()`
+ * - Clears the any existing timeout when a new timeout is set.
+ * - Allows a default delay to be set that is applied to all new timeouts that don't have a delay set.
+ *
+ * @param ms The default delay for any created timeouts (in ms).
+ */
+export class Timeout {
+    constructor(ms = 0) {
+        this._timeout = undefined;
+        this._ms = ms;
+    }
+    /**
+     * Cancel any existing timeout and set a new one.
+     * @param callback
+     * @param ms The delay for this timeout (in ms).
+     */
+    set(callback, ms = this._ms) {
+        this.clear();
+        this._timeout = setTimeout(callback, ms);
+    }
+    /** Cancel any existing timeout.. */
+    clear() {
+        if (this._timeout)
+            this._timeout = void clearTimeout(this._timeout);
+    }
+}