shelving 1.65.1 → 1.66.0

package/observe/util.d.ts

@@ -15,10 +15,10 @@ export declare function connected<T, C extends ConnectableObserver<T>>(source: S
 export declare function connected<T>(source: Subscribable<T>, target: ConnectableObserver<T>): Subject<T>;
 export declare function connected<T>(source: Subscribable<T>): Subject<T>;
 /** Connect a connectable to a source subscribable but transform the value using a transform, and return the connected connectable. */
-export declare function connectedDerived<T, TT, C extends ConnectableObserver<T>>(source: Subscribable<T>, transformer: Transformer<T, TT>, target: C): C;
-export declare function connectedDerived<T, TT>(source: Subscribable<T>, transformer: Transformer<T, TT>, target: ConnectableObserver<T>): ConnectableObserver<TT>;
+export declare function connectedDerived<T, TT, C extends ConnectableObserver<TT>>(source: Subscribable<T>, transformer: Transformer<T, TT>, target: C): C;
+export declare function connectedDerived<T, TT>(source: Subscribable<T>, transformer: Transformer<T, TT>, target: ConnectableObserver<TT>): ConnectableObserver<TT>;
 export declare function connectedDerived<T, TT>(source: Subscribable<T>, transformer: Transformer<T, TT>): Subject<TT>;
 /** Connect a connectable to a source subscribable but transform the value using an async transform, and return the connected connectable. */
 export declare function connectedAsyncDerived<T, TT, C extends ConnectableObserver<TT>>(source: Subscribable<T>, transformer: Transformer<T, PromiseLike<TT>>, target: C): C;
-export declare function connectedAsyncDerived<T, TT>(source: Subscribable<T>, transformer: Transformer<T, PromiseLike<TT>>, target: ConnectableObserver<T>): ConnectableObserver<TT>;
+export declare function connectedAsyncDerived<T, TT>(source: Subscribable<T>, transformer: Transformer<T, PromiseLike<TT>>, target: ConnectableObserver<TT>): ConnectableObserver<TT>;
 export declare function connectedAsyncDerived<T, TT>(source: Subscribable<T>, transformer: Transformer<T, PromiseLike<TT>>): Subject<TT>;

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.65.1",
+	"version": "1.66.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",

package/react/useDocument.d.ts

@@ -14,10 +14,13 @@ export declare class DocumentState<T extends Data> extends State<OptionalEntity<
     get time(): number | undefined;
     /** How old this state's value is (in milliseconds). */
     get age(): number;
+    /** Get the data of the document (throws `RequiredError` if document doesn't exist). */
     get data(): Entity<T>;
+    /** Does the document exist (i.e. its value isn't `null`)? */
+    get exists(): boolean;
     constructor(ref: DocumentReference<T>);
     /** Refresh this state from the source provider. */
-    refresh(): Promise<void>;
+    readonly refresh: () => Promise<void>;
     /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge: number): void;
     /** Subscribe this state to the source provider. */

package/react/useDocument.js

@@ -5,7 +5,6 @@ import { State } from "../state/State.js";
 import { MatchObserver } from "../observe/MatchObserver.js";
 import { BooleanState } from "../state/BooleanState.js";
 import { ConditionError } from "../error/ConditionError.js";
-import { dispatch } from "../util/function.js";
 import { useReduce } from "./useReduce.js";
 import { useSubscribe } from "./useSubscribe.js";
 /** Hold the current state of a document. */
@@ -13,6 +12,24 @@ export class DocumentState extends State {
     constructor(ref) {
         super();
         this.busy = new BooleanState();
+        /** Refresh this state from the source provider. */
+        this.refresh = async () => {
+            if (this.closed)
+                throw new ConditionError("State is closed");
+            if (!this.busy.value) {
+                this.busy.next(true);
+                try {
+                    const result = await this.ref.value;
+                    this.next(result);
+                }
+                catch (thrown) {
+                    this.error(thrown);
+                }
+                finally {
+                    this.busy.next(false);
+                }
+            }
+        };
         this._table = findSourceProvider(ref.db.provider, CacheProvider).memory.getTable(ref);
         this.ref = ref;
         // If the result is cached use it as the initial value.
@@ -20,7 +37,7 @@ export class DocumentState extends State {
         if (isCached)
             this.next(this._table.getDocument(ref.id)); // Use the existing cached value.
         else
-            dispatch(this.refresh); // Queue a request to refresh the value.
+            void this.refresh(); // Queue a request to refresh the value.
     }
     /** Time this state was last updated with a new value. */
     get time() {
@@ -31,29 +48,18 @@ export class DocumentState extends State {
         const time = this.time;
         return typeof time === "number" ? Date.now() - time : Infinity;
     }
+    /** Get the data of the document (throws `RequiredError` if document doesn't exist). */
     get data() {
         return getDocumentData(this.value, this.ref);
     }
-    /** Refresh this state from the source provider. */
-    async refresh() {
-        if (this.closed)
-            throw new ConditionError("State is closed");
-        if (!this.busy.value) {
-            try {
-                this.busy.next(true);
-                const result = await this.ref.value;
-                this.busy.next(false);
-                this.next(result);
-            }
-            catch (thrown) {
-                this.error(thrown);
-            }
-        }
+    /** Does the document exist (i.e. its value isn't `null`)? */
+    get exists() {
+        return !!this.value;
     }
     /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge) {
         if (this.age > maxAge)
-            dispatch(this.refresh);
+            void this.refresh();
     }
     /** Subscribe this state to the source provider. */
     connectSource() {

package/react/useQuery.d.ts

@@ -26,9 +26,13 @@ export declare class QueryState<T extends Data> extends State<Entities<T>> {
     get lastValue(): OptionalEntity<T>;
     /** Get the last document matched by this query. */
     get lastData(): Entity<T>;
+    /** Does the document have at least one result. */
+    get exists(): boolean;
+    /** Get the number of items matching this query. */
+    get count(): number;
     constructor(ref: QueryReference<T>);
     /** Refresh this state from the source provider. */
-    refresh: () => Promise<void>;
+    readonly refresh: () => Promise<void>;
     /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge: number): void;
     /** Subscribe this state to the source provider. */
@@ -39,7 +43,7 @@ export declare class QueryState<T extends Data> extends State<Entities<T>> {
      * Load more items after the last once.
      * - Promise that needs to be handled.
      */
-    loadMore: () => Promise<void>;
+    readonly loadMore: () => Promise<void>;
 }
 /**
  * Use a query in a React component.

package/react/useQuery.js

@@ -5,7 +5,6 @@ import { State } from "../state/State.js";
 import { MatchObserver } from "../observe/MatchObserver.js";
 import { ConditionError } from "../error/ConditionError.js";
 import { BooleanState } from "../state/BooleanState.js";
-import { dispatch } from "../util/function.js";
 import { useReduce } from "./useReduce.js";
 import { useSubscribe } from "./useSubscribe.js";
 /** Hold the current state of a query. */
@@ -20,16 +19,18 @@ export class QueryState extends State {
             if (this.closed)
                 throw new ConditionError("State is closed");
             if (!this.busy.value) {
+                this.busy.next(true);
                 try {
-                    this.busy.next(true);
                     const result = await this.ref.value;
                     this._hasMore = result.length < this.limit;
-                    this.busy.next(false);
                     this.next(result);
                 }
                 catch (thrown) {
                     this.error(thrown);
                 }
+                finally {
+                    this.busy.next(false);
+                }
             }
         };
         /**
@@ -40,16 +41,18 @@ export class QueryState extends State {
             if (this.closed)
                 throw new ConditionError("State is closed");
             if (!this.busy.value) {
+                this.busy.next(true);
                 try {
-                    this.busy.next(true);
                     const items = await this.ref.after(this.lastData).value;
                     this.next([...this.value, ...items]);
                     this._hasMore = items.length < this.limit;
-                    this.busy.next(false);
                 }
                 catch (thrown) {
                     this.error(thrown);
                 }
+                finally {
+                    this.busy.next(false);
+                }
             }
         };
         this._table = findSourceProvider(ref.db.provider, CacheProvider).memory.getTable(ref);
@@ -60,7 +63,7 @@ export class QueryState extends State {
         if (isCached)
             this.next(this._table.getQuery(ref)); // Use the existing cached value.
         else
-            dispatch(this.refresh); // Queue a request to refresh the value.
+            void this.refresh(); // Queue a request to refresh the value.
     }
     /** Time this state was last updated with a new value. */
     get time() {
@@ -91,10 +94,18 @@ export class QueryState extends State {
     get lastData() {
         return getQueryFirstData(this.value, this.ref);
     }
+    /** Does the document have at least one result. */
+    get exists() {
+        return !!this.value.length;
+    }
+    /** Get the number of items matching this query. */
+    get count() {
+        return this.value.length;
+    }
     /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge) {
-        if (!this.busy.value && this.age > maxAge)
-            dispatch(this.refresh);
+        if (this.age > maxAge)
+            void this.refresh();
     }
     /** Subscribe this state to the source provider. */
     connectSource() {

package/state/ArrayState.d.ts

@@ -4,7 +4,7 @@ import { State } from "./State.js";
 export declare class ArrayState<T> extends State<ImmutableArray<T>> implements Iterable<T> {
     constructor(initial?: ImmutableArray<T>);
     /** Get the length of the current value of this state. */
-    get length(): number;
+    get count(): number;
     /** Add an item to this array. */
     add(item: T): void;
     /** Remove an item from this array. */

package/state/ArrayState.js

@@ -6,7 +6,7 @@ export class ArrayState extends State {
         super(initial);
     }
     /** Get the length of the current value of this state. */
-    get length() {
+    get count() {
         return this.value.length;
     }
     /** Add an item to this array. */

package/state/DataState.d.ts

@@ -12,10 +12,10 @@ export declare class DataState<T extends Data> extends State<T> {
 }
 /** State that stores an optional data object and has additional methods to help with that. */
 export declare class OptionalDataState<T extends Data> extends State<OptionalData<T>> {
-    /** Get the result value of this state. */
-    get result(): OptionalData<T>;
     /** Get current data value of this state (or throw `Promise` that resolves to the next required value). */
     get data(): T;
+    /** Does the data exist or not? */
+    get exists(): boolean;
     /** Set a prop in this object to a new value. */
     set<K extends Key<T>>(key: K, value: T[K]): void;
     /** Update several props in this object. */

package/state/DataState.js

@@ -1,7 +1,5 @@
 import { getData, withProp } from "../util/data.js";
 import { transformData } from "../util/transform.js";
-import { awaitNext } from "../observe/util.js";
-import { NOERROR } from "../util/constants.js";
 import { State } from "./State.js";
 /** State that stores a data object and has additional methods to help with that. */
 export class DataState extends State {
@@ -20,18 +18,14 @@ export class DataState extends State {
 }
 /** State that stores an optional data object and has additional methods to help with that. */
 export class OptionalDataState extends State {
-    /** Get the result value of this state. */
-    get result() {
-        return this.value;
-    }
     /** Get current data value of this state (or throw `Promise` that resolves to the next required value). */
     get data() {
-        if (this.reason !== NOERROR)
-            throw this.reason;
-        if (this.loading)
-            throw awaitNext(this).then(getData);
         return getData(this.value);
     }
+    /** Does the data exist or not? */
+    get exists() {
+        return !!this.value;
+    }
     /** Set a prop in this object to a new value. */
     set(key, value) {
         this.next(withProp(this.data, key, value));

package/state/ObjectState.d.ts

@@ -5,7 +5,7 @@ import { State } from "./State.js";
 export declare class ObjectState<T> extends State<ImmutableObject<T>> implements Iterable<Entry<T>> {
     constructor(initial?: ImmutableObject<T>);
     /** Get the length of the current value of this state. */
-    get length(): number;
+    get count(): number;
     /** Remove a named entry from this object. */
     delete(key: string): void;
     /** Set a named entry in this object with a different value. */

package/state/ObjectState.js

@@ -6,7 +6,7 @@ export class ObjectState extends State {
         super(initial);
     }
     /** Get the length of the current value of this state. */
-    get length() {
+    get count() {
         return Object.keys(this.value).length;
     }
     /** Remove a named entry from this object. */