shelving 1.98.3 → 1.98.4

package/db/ItemReference.d.ts

@@ -15,6 +15,8 @@ export type ItemValue<T extends Data = Data> = ItemData<T> | undefined;
 export declare const getID: <T extends Data>({ id }: ItemData<T>) => string;
 /** Get the IDs of an iterable set item data. */
 export declare function getIDs<T extends Data>(entities: Iterable<ItemData<T>>): Iterable<string>;
+/** Merge an ID into a set of data to make an `ItemData` */
+export declare const getItemData: <T extends Data>(id: string, data: T | ItemData<T>) => ItemData<T>;
 /** An array of item data. */
 export type ItemArray<T extends Data = Data> = ImmutableArray<ItemData<T>>;
 /** A set of query constraints for item data. */

package/db/ItemReference.js

@@ -7,6 +7,8 @@ export function* getIDs(entities) {
     for (const { id } of entities)
         yield id;
 }
+/** Merge an ID into a set of data to make an `ItemData` */
+export const getItemData = (id, data) => (data.id === id ? data : { ...data, id });
 /** Get query that targets a single database item by its ID. */
 export const getItemQuery = (id) => ({ id, $limit: 1 });
 /** Reference to an item in a synchronous or asynchronous database. */

package/db/ItemState.d.ts

@@ -7,9 +7,11 @@ import { State } from "../state/State.js";
 export declare class ItemState<T extends Data = Data> extends State<ItemValue<T>> {
     readonly ref: ItemReference<T> | AsyncItemReference<T>;
     readonly busy: BooleanState;
-    /** Get the data of the item (throws `RequiredError` if item doesn't exist). */
+    /** Get the data of this state (throws `RequiredError` if item doesn't exist). */
     get data(): ItemData<T>;
-    /** Does the item exist (i.e. its value isn't `null`)? */
+    /** Set the data of this state. */
+    set data(data: T | ItemData<T>);
+    /** Does the item exist? */
     get exists(): boolean;
     constructor(ref: ItemReference<T> | AsyncItemReference<T>);
     /** Refresh this state from the source provider. */

package/db/ItemState.js

@@ -4,13 +4,18 @@ import { BooleanState } from "../state/BooleanState.js";
 import { State } from "../state/State.js";
 import { getRequired } from "../util/null.js";
 import { getOptionalSource } from "../util/source.js";
+import { getItemData } from "./ItemReference.js";
 /** Hold the current state of a item. */
 export class ItemState extends State {
-    /** Get the data of the item (throws `RequiredError` if item doesn't exist). */
+    /** Get the data of this state (throws `RequiredError` if item doesn't exist). */
     get data() {
         return getRequired(this.value);
     }
-    /** Does the item exist (i.e. its value isn't `null`)? */
+    /** Set the data of this state. */
+    set data(data) {
+        this.value = getItemData(this.ref.id, data);
+    }
+    /** Does the item exist? */
     get exists() {
         return !!this.value;
     }
@@ -33,16 +38,16 @@ export class ItemState extends State {
             this.refresh();
     }
     async _refresh() {
-        this.busy.set(true);
+        this.busy.value = true;
         this.reason = undefined; // Optimistically clear the error.
         try {
-            this.set(await this.ref.value);
+            this.value = await this.ref.value;
         }
         catch (thrown) {
             this.reason = thrown;
         }
         finally {
-            this.busy.set(false);
+            this.busy.value = false;
         }
     }
     /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */

package/db/QueryState.js

@@ -65,18 +65,18 @@ export class QueryState extends State {
             this.refresh();
     }
     async _refresh() {
-        this.busy.set(true);
+        this.busy.value = true;
         this.reason = undefined; // Optimistically clear the error.
         try {
             const items = await this.ref.items;
             this._hasMore = items.length >= this.limit; // If the query returned {limit} or more items, we can assume there are more items waiting to be queried.
-            this.set(items);
+            this.value = items;
         }
         catch (thrown) {
-            this.next.reject(thrown);
+            this.reason = thrown;
         }
         finally {
-            this.busy.set(false);
+            this.busy.value = false;
         }
     }
     /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
@@ -89,20 +89,20 @@ export class QueryState extends State {
         return this.from(this.ref);
     }
     async _loadMore() {
-        this.busy.set(true);
+        this.busy.value = true;
         this.reason = undefined; // Optimistically clear the error.
         try {
             const last = this.last;
             const ref = last ? this.ref.with(getAfterQuery(this.ref.query, last)) : this.ref;
             const items = await ref.items;
-            this.set([...this.items, ...items]);
+            this.value = [...this.items, ...items];
             this._hasMore = items.length >= this.limit; // If the query returned {limit} or more items, we can assume there are more items waiting to be queried.
         }
         catch (thrown) {
             this.reason = thrown;
         }
         finally {
-            this.busy.set(false);
+            this.busy.value = false;
         }
     }
     /** Iterate over the items. */

package/firestore/client/FirestoreClientProvider.js

@@ -1,4 +1,5 @@
 import { addDoc, collection, deleteDoc, doc, documentId, getDoc, getDocs, increment, limit, onSnapshot, orderBy, query, setDoc, updateDoc, where } from "firebase/firestore";
+import { getItemData } from "../../db/ItemReference.js";
 import { SwitchingDeferredSequence } from "../../sequence/SwitchingDeferredSequence.js";
 import { getObject } from "../../util/object.js";
 import { getFilters, getLimit, getOrders } from "../../util/query.js";
@@ -36,12 +37,12 @@ function _getItems(snapshot) {
 }
 function _getItemData(snapshot) {
     const data = snapshot.data();
-    return { ...data, id: snapshot.id };
+    return getItemData(snapshot.id, data);
 }
 function _getItemValue(snapshot) {
     const data = snapshot.data();
     if (data)
-        return { ...data, id: snapshot.id };
+        return getItemData(snapshot.id, data);
 }
 /** Convert `Updates` object into corresponding Firestore `FieldValue` instances. */
 const _getFieldValues = (updates) => getObject(mapItems(getUpdates(updates), _getFieldValue));

package/firestore/lite/FirestoreLiteProvider.js

@@ -1,4 +1,5 @@
 import { addDoc, collection, deleteDoc, doc, documentId, getDoc, getDocs, increment, limit, orderBy, query, setDoc, updateDoc, where } from "firebase/firestore/lite";
+import { getItemData } from "../../db/ItemReference.js";
 import { UnsupportedError } from "../../error/UnsupportedError.js";
 import { getObject } from "../../util/object.js";
 import { getFilters, getLimit, getOrders } from "../../util/query.js";
@@ -33,12 +34,12 @@ function* _getConstraints(q) {
 }
 function _getItemData(snapshot) {
     const data = snapshot.data();
-    return { ...data, id: snapshot.id };
+    return getItemData(snapshot.id, data);
 }
 function _getItemValue(snapshot) {
     const data = snapshot.data();
     if (data)
-        return { ...data, id: snapshot.id };
+        return getItemData(snapshot.id, data);
 }
 /** Convert `Updates` object into corresponding Firestore `FieldValue` instances. */
 const _getFieldValues = (updates) => getObject(mapItems(getUpdates(updates), _getFieldValue));

package/firestore/server/FirestoreServerProvider.js

@@ -1,4 +1,5 @@
 import { FieldPath, FieldValue, Firestore } from "@google-cloud/firestore";
+import { getItemData } from "../../db/ItemReference.js";
 import { SwitchingDeferredSequence } from "../../sequence/SwitchingDeferredSequence.js";
 import { getObject } from "../../util/object.js";
 import { getFilters, getLimit, getOrders } from "../../util/query.js";
@@ -35,12 +36,12 @@ function _getItemArray(snapshot) {
 }
 function _getItemData(snapshot) {
     const data = snapshot.data();
-    return { ...data, id: snapshot.id };
+    return getItemData(snapshot.id, data);
 }
 function _getItemValue(snapshot) {
     const data = snapshot.data();
     if (data)
-        return { ...data, id: snapshot.id };
+        return getItemData(snapshot.id, data);
 }
 /** Convert `Update` instances into corresponding Firestore `FieldValue` instances. */
 const _getFieldValues = (updates) => getObject(mapItems(getUpdates(updates), _getFieldValue));

package/package.json

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

package/provider/MemoryProvider.d.ts

@@ -42,7 +42,7 @@ export declare class MemoryTable<T extends Data = Data> {
     getCachedItemSequence(id: string): AsyncIterable<ItemValue<T>>;
     addItem(data: T): string;
     setItemData(item: ItemData<T>): boolean;
-    setItem(id: string, item: ItemData<T> | T): boolean;
+    setItem(id: string, data: ItemData<T> | T): boolean;
     setItemValue(id: string, value: ItemData<T> | T | undefined): boolean;
     setItemValueSequence(id: string, sequence: AsyncIterable<ItemValue<T>>): AsyncIterable<ItemValue>;
     updateItem(id: string, updates: Updates<T>): boolean;

package/provider/MemoryProvider.js

@@ -1,3 +1,4 @@
+import { getItemData } from "../db/ItemReference.js";
 import { RequiredError } from "../error/RequiredError.js";
 import { DeferredSequence } from "../sequence/DeferredSequence.js";
 import { getArray } from "../util/array.js";
@@ -96,7 +97,7 @@ export class MemoryTable {
         let id = getRandomKey();
         while (this._data.has(id))
             id = getRandomKey(); // Regenerate ID until unique.
-        this.setItemData({ ...data, id });
+        this.setItemData(getItemData(id, data));
         return id;
     }
     setItemData(item) {
@@ -109,8 +110,8 @@ export class MemoryTable {
         }
         return false;
     }
-    setItem(id, item) {
-        return this.setItemData(item.id === id ? item : { ...item, id });
+    setItem(id, data) {
+        return this.setItemData(getItemData(id, data));
     }
     setItemValue(id, value) {
         return value ? this.setItem(id, value) : this.deleteItem(id);

package/react/useData.d.ts

@@ -11,8 +11,8 @@ export declare function useData<T extends Nullish<AsyncItemReference | AsyncQuer
 export declare function useData<T extends ImmutableArray<Nullish<AsyncItemReference | AsyncQueryReference>>>(...refs: T): {
     [K in keyof T]: NullishReferenceState<T[K]>;
 };
-/** Wrap components with `<DataCache>` to allow the use of `useData()`. */
-export declare const DataCache: ({ children }: {
+/** Wrap components with `<DataProvider>` to allow the use of `useData()`. */
+export declare const DataProvider: ({ children }: {
     children: import("react").ReactNode;
 }) => import("react").ReactElement<any, string | import("react").JSXElementConstructor<any>>;
 export {};

package/react/useData.js

@@ -17,5 +17,5 @@ function _getRefState(ref, cache) {
     const key = ref === null || ref === void 0 ? void 0 : ref.toString();
     return ref && key ? cache.get(key) || setMapItem(cache, key, ref instanceof AsyncItemReference ? new ItemState(ref) : new QueryState(ref)) : undefined;
 }
-/** Wrap components with `<DataCache>` to allow the use of `useData()`. */
-export const DataCache = Cache;
+/** Wrap components with `<DataProvider>` to allow the use of `useData()`. */
+export const DataProvider = Cache;

package/state/DataState.d.ts

@@ -3,8 +3,10 @@ import type { Updates } from "../util/update.js";
 import { State } from "./State.js";
 /** State that stores a data object and has additional methods to help with that. */
 export declare class DataState<T extends Data> extends State<T> {
-    /** Get the data value of this state. */
+    /** Get the data of this state. */
     get data(): T;
+    /** Set the data of this state. */
+    set data(data: T);
     /** Update several props in this data. */
     update(updates: Updates<T>): void;
     /** Update a single named prop in this data. */
@@ -16,6 +18,8 @@ export declare class DataState<T extends Data> extends State<T> {
 export declare class OptionalDataState<T extends Data> extends State<T | undefined> {
     /** Get current data value of this state (or throw `Promise` that resolves to the next required value). */
     get data(): T;
+    /** Set the data of this state. */
+    set data(data: T);
     /** Does the data exist or not? */
     get exists(): boolean;
     /** Update several props in this data. */

package/state/DataState.js

@@ -4,10 +4,14 @@ import { updateData } from "../util/update.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 {
-    /** Get the data value of this state. */
+    /** Get the data of this state. */
     get data() {
         return this.value;
     }
+    /** Set the data of this state. */
+    set data(data) {
+        this.value = data;
+    }
     /** Update several props in this data. */
     update(updates) {
         this.value = updateData(this.data, updates);
@@ -27,6 +31,10 @@ export class OptionalDataState extends State {
     get data() {
         return getRequired(this.value);
     }
+    /** Set the data of this state. */
+    set data(data) {
+        this.value = data;
+    }
     /** Does the data exist or not? */
     get exists() {
         return !!this.value;