shelving 1.106.0 → 1.107.0

package/README.md

@@ -9,7 +9,7 @@
 - Schemas (validation)
 - Databases (via providers including in-memory, Firestore, IndexedDB)
 - Querying (sorting, filtering, slicing)
-- State (events and state)
+- Store (events and state)
 - React (hooks and state)
 - Helpers (errors, arrays, objects, strings, dates, equality, merging, diffing, cloning, debug)
 

package/db/{ItemState.d.ts → ItemStore.d.ts}

@@ -2,27 +2,27 @@ import type { AbstractProvider } from "../provider/Provider.js";
 import type { StopCallback } from "../util/callback.js";
 import type { Data } from "../util/data.js";
 import type { ItemData, ItemValue } from "../util/item.js";
-import { BooleanState } from "../state/BooleanState.js";
-import { State } from "../state/State.js";
-/** Hold the current state of a item. */
-export declare class ItemState<T extends Data = Data> extends State<ItemValue<T>> {
+import { BooleanStore } from "../store/BooleanStore.js";
+import { Store } from "../store/Store.js";
+/** Store a single item. */
+export declare class ItemStore<T extends Data = Data> extends Store<ItemValue<T>> {
     readonly provider: AbstractProvider;
     readonly collection: string;
     readonly id: string;
-    readonly busy: BooleanState;
-    /** Get the data of this state (throws `RequiredError` if item doesn't exist). */
+    readonly busy: BooleanStore;
+    /** Get the data of this store (throws `RequiredError` if item doesn't exist). */
     get data(): ItemData<T>;
-    /** Set the data of this state. */
+    /** Set the data of this store. */
     set data(data: T | ItemData<T>);
     /** Does the item exist? */
     get exists(): boolean;
     constructor(provider: AbstractProvider, collection: string, id: string);
-    /** Refresh this state from the source provider. */
+    /** Refresh this store from the source provider. */
     refresh(provider?: AbstractProvider): void;
     private _refresh;
-    /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
+    /** Refresh this store if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge: number, provider?: AbstractProvider): void;
-    /** Subscribe this state to a provider. */
+    /** Subscribe this store to a provider. */
     connect(provider?: AbstractProvider): StopCallback;
     [Symbol.asyncIterator](): AsyncGenerator<ItemValue<T>, void, void>;
     private _iterating;

package/db/{ItemState.js → ItemStore.js}

@@ -1,23 +1,23 @@
 import { CacheProvider } from "../provider/CacheProvider.js";
-import { BooleanState } from "../state/BooleanState.js";
-import { State } from "../state/State.js";
+import { BooleanStore } from "../store/BooleanStore.js";
+import { Store } from "../store/Store.js";
 import { call } from "../util/callback.js";
 import { NONE } from "../util/constants.js";
 import { getItemData } from "../util/item.js";
 import { getRequired } from "../util/optional.js";
 import { runSequence } from "../util/sequence.js";
 import { getOptionalSource } from "../util/source.js";
-/** Hold the current state of a item. */
-export class ItemState extends State {
+/** Store a single item. */
+export class ItemStore extends Store {
     provider;
     collection;
     id;
-    busy = new BooleanState();
-    /** Get the data of this state (throws `RequiredError` if item doesn't exist). */
+    busy = new BooleanStore();
+    /** Get the data of this store (throws `RequiredError` if item doesn't exist). */
     get data() {
         return getRequired(this.value);
     }
-    /** Set the data of this state. */
+    /** Set the data of this store. */
     set data(data) {
         this.value = getItemData(this.id, data);
     }
@@ -36,7 +36,7 @@ export class ItemState extends State {
         if (this.loading)
             this.refresh();
     }
-    /** Refresh this state from the source provider. */
+    /** Refresh this store from the source provider. */
     refresh(provider = this.provider) {
         if (!this.busy.value)
             void this._refresh(provider);
@@ -54,16 +54,16 @@ export class ItemState extends State {
             this.busy.value = false;
         }
     }
-    /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
+    /** Refresh this store if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge, provider) {
         if (this.age > maxAge)
             this.refresh(provider);
     }
-    /** Subscribe this state to a provider. */
+    /** Subscribe this store to a provider. */
     connect(provider = this.provider) {
         return runSequence(this.through(provider.getItemSequence(this.collection, this.id)));
     }
-    // Override to subscribe to `MemoryProvider` while things are iterating over this state.
+    // Override to subscribe to `MemoryProvider` while things are iterating over this store.
     async *[Symbol.asyncIterator]() {
         this.start();
         this._iterating++;

package/db/{QueryState.d.ts → QueryStore.d.ts}

@@ -2,14 +2,14 @@ import type { AbstractProvider } from "../provider/Provider.js";
 import type { StopCallback } from "../util/callback.js";
 import type { Data } from "../util/data.js";
 import type { ItemArray, ItemData, ItemQuery, ItemValue } from "../util/item.js";
-import { BooleanState } from "../state/BooleanState.js";
-import { State } from "../state/State.js";
-/** Hold the current state of a query. */
-export declare class QueryState<T extends Data = Data> extends State<ItemArray<T>> implements Iterable<ItemData<T>> {
+import { BooleanStore } from "../store/BooleanStore.js";
+import { Store } from "../store/Store.js";
+/** Store a set of multiple items. */
+export declare class QueryStore<T extends Data = Data> extends Store<ItemArray<T>> implements Iterable<ItemData<T>> {
     readonly provider: AbstractProvider;
     readonly collection: string;
     readonly query: ItemQuery<T>;
-    readonly busy: BooleanState;
+    readonly busy: BooleanStore;
     readonly limit: number;
     /** Can more items be loaded after the current result. */
     get hasMore(): boolean;
@@ -27,12 +27,12 @@ export declare class QueryState<T extends Data = Data> extends State<ItemArray<T
     /** Get the number of items matching this query. */
     get count(): number;
     constructor(provider: AbstractProvider, collection: string, query: ItemQuery<T>);
-    /** Refresh this state from the source provider. */
+    /** Refresh this store from the source provider. */
     refresh(provider?: AbstractProvider): void;
     private _refresh;
-    /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
+    /** Refresh this store if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge: number): void;
-    /** Subscribe this state to a provider. */
+    /** Subscribe this store to a provider. */
     connect(provider?: AbstractProvider): StopCallback;
     /**
      * Load more items after the last once.

package/db/{QueryState.js → QueryStore.js}

@@ -1,6 +1,6 @@
 import { CacheProvider } from "../provider/CacheProvider.js";
-import { BooleanState } from "../state/BooleanState.js";
-import { State } from "../state/State.js";
+import { BooleanStore } from "../store/BooleanStore.js";
+import { Store } from "../store/Store.js";
 import { getOptionalFirstItem, getOptionalLastItem } from "../util/array.js";
 import { call } from "../util/callback.js";
 import { NONE } from "../util/constants.js";
@@ -8,12 +8,12 @@ import { getRequired } from "../util/optional.js";
 import { getAfterQuery, getLimit } from "../util/query.js";
 import { runSequence } from "../util/sequence.js";
 import { getOptionalSource } from "../util/source.js";
-/** Hold the current state of a query. */
-export class QueryState extends State {
+/** Store a set of multiple items. */
+export class QueryStore extends Store {
     provider;
     collection;
     query;
-    busy = new BooleanState();
+    busy = new BooleanStore();
     limit;
     /** Can more items be loaded after the current result. */
     get hasMore() {
@@ -56,7 +56,7 @@ export class QueryState extends State {
         if (this.loading)
             this.refresh();
     }
-    /** Refresh this state from the source provider. */
+    /** Refresh this store from the source provider. */
     refresh(provider = this.provider) {
         if (!this.busy.value)
             void this._refresh(provider);
@@ -76,12 +76,12 @@ export class QueryState extends State {
             this.busy.value = false;
         }
     }
-    /** Refresh this state if data in the cache is older than `maxAge` (in milliseconds). */
+    /** Refresh this store if data in the cache is older than `maxAge` (in milliseconds). */
     refreshStale(maxAge) {
         if (this.age > maxAge)
             this.refresh();
     }
-    /** Subscribe this state to a provider. */
+    /** Subscribe this store to a provider. */
     connect(provider = this.provider) {
         return runSequence(this.through(provider.getQuerySequence(this.collection, this.query)));
     }
@@ -110,7 +110,7 @@ export class QueryState extends State {
             this.busy.value = false;
         }
     }
-    // Override to subscribe to `MemoryProvider` while things are iterating over this state.
+    // Override to subscribe to `MemoryProvider` while things are iterating over this store.
     async *[Symbol.asyncIterator]() {
         this.start();
         this._iterating++;

package/db/index.d.ts

@@ -1,6 +1,6 @@
 export * from "./Database.js";
 export * from "./CollectionReference.js";
 export * from "./ItemReference.js";
-export * from "./ItemState.js";
+export * from "./ItemStore.js";
 export * from "./QueryReference.js";
-export * from "./QueryState.js";
+export * from "./QueryStore.js";

package/db/index.js

@@ -1,6 +1,6 @@
 export * from "./Database.js";
 export * from "./CollectionReference.js";
 export * from "./ItemReference.js";
-export * from "./ItemState.js";
+export * from "./ItemStore.js";
 export * from "./QueryReference.js";
-export * from "./QueryState.js";
+export * from "./QueryStore.js";

package/index.d.ts

@@ -13,5 +13,5 @@ export * from "./markup/index.js";
 export * from "./provider/index.js";
 export * from "./schema/index.js";
 export * from "./sequence/index.js";
-export * from "./state/index.js";
+export * from "./store/index.js";
 export * from "./util/index.js";

package/index.js

@@ -17,6 +17,6 @@ export * from "./provider/index.js";
 // export * from "./react/index.js"; // Not exported.
 export * from "./schema/index.js";
 export * from "./sequence/index.js";
-export * from "./state/index.js";
+export * from "./store/index.js";
 // export * from "./test/index.js"; // Not exported.
 export * from "./util/index.js";

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.106.0",
+	"version": "1.107.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -35,7 +35,7 @@
 		"./react": "./react/index.js",
 		"./schema": "./schema/index.js",
 		"./sequence": "./sequence/index.js",
-		"./state": "./state/index.js",
+		"./store": "./store/index.js",
 		"./test": "./test/index.js",
 		"./util": "./util/index.js"
 	},

package/react/createDataContext.d.ts

@@ -2,17 +2,17 @@
 import type { AsyncDatabase, Database } from "../db/Database.js";
 import type { DataKey, Datas } from "../util/data.js";
 import type { ItemQuery } from "../util/item.js";
-import { ItemState } from "../db/ItemState.js";
-import { QueryState } from "../db/QueryState.js";
+import { ItemStore } from "../db/ItemStore.js";
+import { QueryStore } from "../db/QueryStore.js";
 import { type Optional } from "../util/optional.js";
 /**
  * Create a data context that can be provided to React elements and allows them to call `useItem()` and `useQuery()`
  */
 export declare function createDataContext<T extends Datas>({ provider, }: Database<T> | AsyncDatabase<T>): {
-    readonly useItem: <K extends DataKey<T>>(collection: K, id: string) => ItemState<T[K]>;
-    readonly useQuery: <K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>) => QueryState<T[K]>;
-    readonly useOptionalItem: <K extends DataKey<T>>(collection: K, id: Optional<string>) => ItemState<T[K]> | undefined;
-    readonly useOptionalQuery: <K extends DataKey<T>>(collection: K, query: Optional<ItemQuery<T[K]>>) => QueryState<T[K]> | undefined;
+    readonly useItem: <K extends DataKey<T>>(collection: K, id: string) => ItemStore<T[K]>;
+    readonly useQuery: <K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>) => QueryStore<T[K]>;
+    readonly useOptionalItem: <K extends DataKey<T>>(collection: K, id: Optional<string>) => ItemStore<T[K]> | undefined;
+    readonly useOptionalQuery: <K extends DataKey<T>>(collection: K, query: Optional<ItemQuery<T[K]>>) => QueryStore<T[K]> | undefined;
     readonly DataProvider: ({ children }: {
         children: React.ReactNode;
     }) => React.ReactElement;

package/react/createDataContext.js

@@ -1,9 +1,9 @@
-import { ItemState } from "../db/ItemState.js";
-import { QueryState } from "../db/QueryState.js";
+import { ItemStore } from "../db/ItemStore.js";
+import { QueryStore } from "../db/QueryStore.js";
 import { setMapItem } from "../util/map.js";
 import { getRequired } from "../util/optional.js";
 import { createCacheContext } from "./createCacheContext.js";
-import { useState } from "./useState.js";
+import { useStore } from "./useStore.js";
 /**
  * Create a data context that can be provided to React elements and allows them to call `useItem()` and `useQuery()`
  */
@@ -12,12 +12,12 @@ export function createDataContext({ provider, }) {
     const useOptionalItem = (collection, id) => {
         const cache = useCache();
         const key = id && `${collection}/${id}`;
-        return useState(id && key ? cache.get(key) || setMapItem(cache, key, new ItemState(provider, collection, id)) : undefined);
+        return useStore(id && key ? cache.get(key) || setMapItem(cache, key, new ItemStore(provider, collection, id)) : undefined);
     };
     const useOptionalQuery = (collection, query) => {
         const cache = useCache();
         const key = `${collection}?${JSON.stringify(query)}`;
-        return useState(query && key ? cache.get(key) || setMapItem(cache, key, new QueryState(provider, collection, query)) : undefined);
+        return useStore(query && key ? cache.get(key) || setMapItem(cache, key, new QueryStore(provider, collection, query)) : undefined);
     };
     return {
         useOptionalItem,

package/react/index.d.ts

@@ -5,4 +5,4 @@ export * from "./useInstance.js";
 export * from "./useLazy.js";
 export * from "./useReduce.js";
 export * from "./useSequence.js";
-export * from "./useState.js";
+export * from "./useStore.js";

package/react/index.js

@@ -5,4 +5,4 @@ export * from "./useInstance.js";
 export * from "./useLazy.js";
 export * from "./useReduce.js";
 export * from "./useSequence.js";
-export * from "./useState.js";
+export * from "./useStore.js";

package/react/useSequence.d.ts

@@ -4,6 +4,5 @@
  * @param sequence An object implementing the `AsyncIterable` interface.
  * - Subscription is recreated every time this value changes.
  * - Memoise this value to persist the subscription for the lifetime of the component.
- * - If the value is a `State` instance
  */
 export declare function useSequence<T>(sequence?: AsyncIterable<T>): T | undefined;

package/react/useSequence.js

@@ -7,7 +7,6 @@ import { runSequence } from "../util/sequence.js";
  * @param sequence An object implementing the `AsyncIterable` interface.
  * - Subscription is recreated every time this value changes.
  * - Memoise this value to persist the subscription for the lifetime of the component.
- * - If the value is a `State` instance
  */
 export function useSequence(sequence) {
     const [value, setValue] = useState(undefined);

package/react/useStore.d.ts

@@ -0,0 +1,5 @@
+import type { AnyStore } from "../store/Store.js";
+import type { Optional } from "../util/optional.js";
+/** Subscribe to a Shelving `Store` instance to refresh this component when its value changes. */
+export declare function useStore<T extends AnyStore>(store: T): T;
+export declare function useStore<T extends AnyStore>(store?: Optional<T>): T | undefined;

package/react/useStore.js

@@ -0,0 +1,8 @@
+import { useCallback, useSyncExternalStore } from "react";
+import { NONE } from "../util/constants.js";
+import { BLACKHOLE } from "../util/function.js";
+import { runSequence } from "../util/sequence.js";
+export function useStore(store) {
+    useSyncExternalStore(useCallback(onStoreChange => (store ? runSequence(store, onStoreChange, onStoreChange) : BLACKHOLE), [store]), () => (!store ? store : store.loading ? NONE : store.value));
+    return store ?? undefined;
+}

package/{state/ArrayState.d.ts → store/ArrayStore.d.ts}

@@ -1,9 +1,9 @@
 import type { ImmutableArray } from "../util/array.js";
-import { State } from "./State.js";
-/** State that stores an array and has additional methods to help with that. */
-export declare class ArrayState<T> extends State<ImmutableArray<T>> implements Iterable<T> {
+import { Store } from "./Store.js";
+/** Store an array. */
+export declare class ArrayStore<T> extends Store<ImmutableArray<T>> implements Iterable<T> {
     constructor(value?: ImmutableArray<T>, time?: number);
-    /** Get the length of the current value of this state. */
+    /** Get the length of the current value of this store. */
     get count(): number;
     /** Add items to this array. */
     add(...items: T[]): void;

package/{state/ArrayState.js → store/ArrayStore.js}

@@ -1,11 +1,11 @@
 import { omitArrayItems, toggleArrayItems, withArrayItems } from "../util/array.js";
-import { State } from "./State.js";
-/** State that stores an array and has additional methods to help with that. */
-export class ArrayState extends State {
+import { Store } from "./Store.js";
+/** Store an array. */
+export class ArrayStore extends Store {
     constructor(value = [], time) {
         super(value, time);
     }
-    /** Get the length of the current value of this state. */
+    /** Get the length of the current value of this store. */
     get count() {
         return this.value.length;
     }

package/{state/BooleanState.d.ts → store/BooleanStore.d.ts}

@@ -1,7 +1,7 @@
 import type { NONE } from "../util/constants.js";
-import { State } from "./State.js";
-/** State that stores a boolean and has additional methods to help with that. */
-export declare class BooleanState extends State<boolean> {
+import { Store } from "./Store.js";
+/** Store a boolean. */
+export declare class BooleanStore extends Store<boolean> {
     constructor(value?: boolean | typeof NONE, time?: number);
     /** Toggle the current boolean value. */
     toggle(): void;

package/{state/BooleanState.js → store/BooleanStore.js}

@@ -1,6 +1,6 @@
-import { State } from "./State.js";
-/** State that stores a boolean and has additional methods to help with that. */
-export class BooleanState extends State {
+import { Store } from "./Store.js";
+/** Store a boolean. */
+export class BooleanStore extends Store {
     constructor(value = false, time) {
         super(value, time);
     }

package/{state/DataState.d.ts → store/DataStore.d.ts}

@@ -1,11 +1,11 @@
 import type { Data, DataKey } from "../util/data.js";
 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 of this state. */
+import { Store } from "./Store.js";
+/** Store a data object. */
+export declare class DataStore<T extends Data> extends Store<T> {
+    /** Get the data of this store. */
     get data(): T;
-    /** Set the data of this state. */
+    /** Set the data of this store. */
     set data(data: T);
     /** Update several props in this data. */
     update(updates: Updates<T>): void;
@@ -14,11 +14,11 @@ export declare class DataState<T extends Data> extends State<T> {
     /** Update a single named prop in this data. */
     setProp<K extends DataKey<T>>(name: K, value: T[K]): void;
 }
-/** State that stores an optional data object and has additional methods to help with that. */
-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). */
+/** Store an optional data object. */
+export declare class OptionalDataStore<T extends Data> extends Store<T | undefined> {
+    /** Get current data value of this store (or throw `Promise` that resolves to the next required value). */
     get data(): T;
-    /** Set the data of this state. */
+    /** Set the data of this store. */
     set data(data: T);
     /** Does the data exist or not? */
     get exists(): boolean;

package/{state/DataState.js → store/DataStore.js}

@@ -1,14 +1,14 @@
 import { withProp } from "../util/object.js";
 import { getRequired } from "../util/optional.js";
 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 of this state. */
+import { Store } from "./Store.js";
+/** Store a data object. */
+export class DataStore extends Store {
+    /** Get the data of this store. */
     get data() {
         return this.value;
     }
-    /** Set the data of this state. */
+    /** Set the data of this store. */
     set data(data) {
         this.value = data;
     }
@@ -25,13 +25,13 @@ export class DataState extends State {
         this.value = withProp(this.data, name, value);
     }
 }
-/** State that stores an optional data object and has additional methods to help with that. */
-export class OptionalDataState extends State {
-    /** Get current data value of this state (or throw `Promise` that resolves to the next required value). */
+/** Store an optional data object. */
+export class OptionalDataStore extends Store {
+    /** Get current data value of this store (or throw `Promise` that resolves to the next required value). */
     get data() {
         return getRequired(this.value);
     }
-    /** Set the data of this state. */
+    /** Set the data of this store. */
     set data(data) {
         this.value = data;
     }

package/{state/DictionaryState.d.ts → store/DictionaryStore.d.ts}

@@ -1,10 +1,10 @@
 import type { DictionaryItem, ImmutableDictionary } from "../util/dictionary.js";
 import type { Updates } from "../util/update.js";
-import { State } from "./State.js";
-/** State that stores a dictionary object and has additional methods to help with that. */
-export declare class DictionaryState<T> extends State<ImmutableDictionary<T>> implements Iterable<DictionaryItem<T>> {
+import { Store } from "./Store.js";
+/** Store a dictionary object. */
+export declare class DictionaryStore<T> extends Store<ImmutableDictionary<T>> implements Iterable<DictionaryItem<T>> {
     constructor(value?: ImmutableDictionary<T>, time?: number);
-    /** Get the length of the current value of this state. */
+    /** Get the length of the current value of this store. */
     get count(): number;
     /** Set a named entry in this object with a different value. */
     update(updates: Updates<ImmutableDictionary<T>>): void;

package/{state/DictionaryState.js → store/DictionaryStore.js}

@@ -1,13 +1,13 @@
 import { getDictionaryItems, omitDictionaryItems } from "../util/dictionary.js";
 import { withProp } from "../util/object.js";
 import { updateData } from "../util/update.js";
-import { State } from "./State.js";
-/** State that stores a dictionary object and has additional methods to help with that. */
-export class DictionaryState extends State {
+import { Store } from "./Store.js";
+/** Store a dictionary object. */
+export class DictionaryStore extends Store {
     constructor(value = {}, time) {
         super(value, time);
     }
-    /** Get the length of the current value of this state. */
+    /** Get the length of the current value of this store. */
     get count() {
         return Object.keys(this.value).length;
     }

package/store/Store.d.ts

@@ -0,0 +1,42 @@
+import { DeferredSequence } from "../sequence/DeferredSequence.js";
+import { NONE } from "../util/constants.js";
+/** Any `Store` instance. */
+export type AnyStore = Store<any>;
+/**
+ * Store that retains its most recent value and is async-iterable to allow values to be observed.
+ * - Current value can be read at `store.value` and `store.data`
+ * - Stores also send their most-recent value to any new subscribers immediately when a new subscriber is added.
+ * - Stores can also be in a loading store where they do not have a current value.
+ *
+ * @param initial The initial value for the store, a `Promise` that resolves to the initial value, a source `Subscribable` to subscribe to, or another `Store` instance to take the initial value from and subscribe to.
+ * - To set the store to be loading, use the `NONE` constant or a `Promise` value.
+ * - To set the store to an explicit value, use that value or another `Store` instance with a value.
+ * */
+export declare class Store<T> implements AsyncIterable<T> {
+    /** Deferred sequence this store uses to issue values as they change. */
+    readonly next: DeferredSequence<T>;
+    /** Current value of the store (or throw a promise that resolves when this store receives its next value or error). */
+    get value(): T;
+    set value(value: T);
+    private _value;
+    /** Is there a current value, or is it still loading. */
+    get loading(): boolean;
+    /** Time (in milliseconds) this store was last updated with a new value, or `undefined` if this store is currently loading. */
+    get time(): number | undefined;
+    private _time;
+    /** How old this store's value is (in milliseconds). */
+    get age(): number;
+    /** Current error of this store (or `undefined` if there is no reason). */
+    get reason(): unknown;
+    set reason(reason: Error | unknown);
+    private _reason;
+    /** Store is initiated with an initial store. */
+    constructor(value: T | typeof NONE, time?: number);
+    /** Set the value of the store. */
+    set(next: T): void;
+    /** Set the value of the store as values are pulled from a sequence. */
+    through(sequence: AsyncIterable<T>): AsyncIterable<T>;
+    [Symbol.asyncIterator](): AsyncGenerator<T, void, void>;
+}
+/** Is an unknown value a `Store` instance. */
+export declare const isStore: <T extends AnyStore>(value: unknown) => value is T;

package/{state/State.js → store/Store.js}

@@ -1,19 +1,19 @@
 import { DeferredSequence } from "../sequence/DeferredSequence.js";
 import { NONE } from "../util/constants.js";
 /**
- * Stream that retains its most recent value
- * - Current value can be read at `state.value` and `state.data`
- * - States also send their most-recent value to any new subscribers immediately when a new subscriber is added.
- * - States can also be in a loading state where they do not have a current value.
+ * Store that retains its most recent value and is async-iterable to allow values to be observed.
+ * - Current value can be read at `store.value` and `store.data`
+ * - Stores also send their most-recent value to any new subscribers immediately when a new subscriber is added.
+ * - Stores can also be in a loading store where they do not have a current value.
  *
- * @param initial The initial value for the state, a `Promise` that resolves to the initial value, a source `Subscribable` to subscribe to, or another `State` instance to take the initial value from and subscribe to.
- * - To set the state to be loading, use the `NONE` constant or a `Promise` value.
- * - To set the state to an explicit value, use that value or another `State` instance with a value.
+ * @param initial The initial value for the store, a `Promise` that resolves to the initial value, a source `Subscribable` to subscribe to, or another `Store` instance to take the initial value from and subscribe to.
+ * - To set the store to be loading, use the `NONE` constant or a `Promise` value.
+ * - To set the store to an explicit value, use that value or another `Store` instance with a value.
  * */
-export class State {
-    /** Deferred sequence this state uses to issue values as they change. */
+export class Store {
+    /** Deferred sequence this store uses to issue values as they change. */
     next = new DeferredSequence();
-    /** Current value of the state (or throw a promise that resolves when this state receives its next value or error). */
+    /** Current value of the store (or throw a promise that resolves when this store receives its next value or error). */
     get value() {
         if (this._reason !== undefined)
             throw this._reason;
@@ -34,17 +34,17 @@ export class State {
     get loading() {
         return this._value === NONE;
     }
-    /** Time (in milliseconds) this state was last updated with a new value, or `undefined` if this state is currently loading. */
+    /** Time (in milliseconds) this store was last updated with a new value, or `undefined` if this store is currently loading. */
     get time() {
         return this._value === NONE ? undefined : this._time;
     }
     _time;
-    /** How old this state's value is (in milliseconds). */
+    /** How old this store's value is (in milliseconds). */
     get age() {
         const time = this.time;
         return typeof time === "number" ? Date.now() - time : Infinity;
     }
-    /** Current error of this state (or `undefined` if there is no reason). */
+    /** Current error of this store (or `undefined` if there is no reason). */
     get reason() {
         return this._reason;
     }
@@ -55,16 +55,16 @@ export class State {
         }
     }
     _reason = undefined;
-    /** State is initiated with an initial state. */
+    /** Store is initiated with an initial store. */
     constructor(value, time = Date.now()) {
         this._value = value;
         this._time = time;
     }
-    /** Set the value of the state. */
+    /** Set the value of the store. */
     set(next) {
         this.value = next;
     }
-    /** Set the value of the state as values are pulled from a sequence. */
+    /** Set the value of the store as values are pulled from a sequence. */
     async *through(sequence) {
         for await (const value of sequence) {
             this.value = value;
@@ -72,7 +72,7 @@ export class State {
         }
     }
     // Implement `AsyncIterable`
-    // Issues the current value of the state first, then any subsequent values that are issued.
+    // Issues the current value of the store first, then any subsequent values that are issued.
     async *[Symbol.asyncIterator]() {
         await Promise.resolve(); // Introduce a slight delay, i.e. don't immediately yield `this.value` in case it is changed synchronously.
         if (!this.loading)
@@ -80,5 +80,5 @@ export class State {
         yield* this.next;
     }
 }
-/** Is an unknown value a `State` instance. */
-export const isState = (value) => value instanceof State;
+/** Is an unknown value a `Store` instance. */
+export const isStore = (value) => value instanceof Store;

package/store/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./Store.js";
+export * from "./ArrayStore.js";
+export * from "./BooleanStore.js";
+export * from "./DataStore.js";
+export * from "./DictionaryStore.js";

package/store/index.js

@@ -0,0 +1,5 @@
+export * from "./Store.js";
+export * from "./ArrayStore.js";
+export * from "./BooleanStore.js";
+export * from "./DataStore.js";
+export * from "./DictionaryStore.js";

package/react/useState.d.ts

@@ -1,4 +0,0 @@
-import type { AnyState } from "../state/State.js";
-import type { Optional } from "../util/optional.js";
-export declare function useState<T extends AnyState>(state: T): T;
-export declare function useState<T extends AnyState>(state?: Optional<T>): T | undefined;

package/react/useState.js

@@ -1,8 +0,0 @@
-import { useCallback, useSyncExternalStore } from "react";
-import { NONE } from "../util/constants.js";
-import { BLACKHOLE } from "../util/function.js";
-import { runSequence } from "../util/sequence.js";
-export function useState(state) {
-    useSyncExternalStore(useCallback(onStateChange => (state ? runSequence(state, onStateChange, onStateChange) : BLACKHOLE), [state]), () => (!state ? state : state.loading ? NONE : state.value));
-    return state ?? undefined;
-}

package/state/State.d.ts

@@ -1,42 +0,0 @@
-import { DeferredSequence } from "../sequence/DeferredSequence.js";
-import { NONE } from "../util/constants.js";
-/** Any `State` instance. */
-export type AnyState = State<any>;
-/**
- * Stream that retains its most recent value
- * - Current value can be read at `state.value` and `state.data`
- * - States also send their most-recent value to any new subscribers immediately when a new subscriber is added.
- * - States can also be in a loading state where they do not have a current value.
- *
- * @param initial The initial value for the state, a `Promise` that resolves to the initial value, a source `Subscribable` to subscribe to, or another `State` instance to take the initial value from and subscribe to.
- * - To set the state to be loading, use the `NONE` constant or a `Promise` value.
- * - To set the state to an explicit value, use that value or another `State` instance with a value.
- * */
-export declare class State<T> implements AsyncIterable<T> {
-    /** Deferred sequence this state uses to issue values as they change. */
-    readonly next: DeferredSequence<T>;
-    /** Current value of the state (or throw a promise that resolves when this state receives its next value or error). */
-    get value(): T;
-    set value(value: T);
-    private _value;
-    /** Is there a current value, or is it still loading. */
-    get loading(): boolean;
-    /** Time (in milliseconds) this state was last updated with a new value, or `undefined` if this state is currently loading. */
-    get time(): number | undefined;
-    private _time;
-    /** How old this state's value is (in milliseconds). */
-    get age(): number;
-    /** Current error of this state (or `undefined` if there is no reason). */
-    get reason(): unknown;
-    set reason(reason: Error | unknown);
-    private _reason;
-    /** State is initiated with an initial state. */
-    constructor(value: T | typeof NONE, time?: number);
-    /** Set the value of the state. */
-    set(next: T): void;
-    /** Set the value of the state as values are pulled from a sequence. */
-    through(sequence: AsyncIterable<T>): AsyncIterable<T>;
-    [Symbol.asyncIterator](): AsyncGenerator<T, void, void>;
-}
-/** Is an unknown value a `State` instance. */
-export declare const isState: <T extends AnyState>(value: unknown) => value is T;

package/state/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./State.js";
-export * from "./ArrayState.js";
-export * from "./BooleanState.js";
-export * from "./DataState.js";
-export * from "./DictionaryState.js";

package/state/index.js

@@ -1,5 +0,0 @@
-export * from "./State.js";
-export * from "./ArrayState.js";
-export * from "./BooleanState.js";
-export * from "./DataState.js";
-export * from "./DictionaryState.js";