shelving 1.102.0 → 1.102.2

package/db/Change.d.ts

@@ -1,7 +1,7 @@
 import type { AsyncProvider, Provider } from "../provider/Provider.js";
 import type { ImmutableArray } from "../util/array.js";
 import type { Data } from "../util/data.js";
-import type { Nullish } from "../util/null.js";
+import type { Optional } from "../util/optional.js";
 import type { Updates } from "../util/update.js";
 /** Add on an item. */
 export interface AddChange<T extends Data> {
@@ -38,6 +38,6 @@ export type WriteChange<T extends Data> = ItemChange<T> | AddChange<T>;
 /** Array of write changes. */
 export type WriteChanges = ImmutableArray<WriteChange<Data>>;
 /** Apply a set of changes to a synchronous provider. */
-export declare function changeProvider(provider: Provider, ...changes: Nullish<WriteChange<Data>>[]): ItemChanges;
+export declare function changeProvider(provider: Provider, ...changes: Optional<WriteChange<Data>>[]): ItemChanges;
 /** Apply a set of changes to an asynchronous provider. */
-export declare function changeAsyncProvider(provider: AsyncProvider, ...changes: Nullish<WriteChange<Data>>[]): Promise<ItemChanges>;
+export declare function changeAsyncProvider(provider: AsyncProvider, ...changes: Optional<WriteChange<Data>>[]): Promise<ItemChanges>;

package/db/Database.d.ts

@@ -2,7 +2,7 @@ import type { AddChange, DeleteChange, ItemChanges, SetChange, UpdateChange, Wri
 import type { ItemQuery, ItemValue } from "./ItemReference.js";
 import type { AsyncProvider, Provider } from "../provider/Provider.js";
 import type { Data, DataKey, Datas } from "../util/data.js";
-import type { Nullish } from "../util/null.js";
+import type { Optional } from "../util/optional.js";
 import type { Updates } from "../util/update.js";
 import { AsyncCollectionReference, CollectionReference } from "./CollectionReference.js";
 import { AsyncItemReference, ItemReference } from "./ItemReference.js";
@@ -17,7 +17,7 @@ declare abstract class AbstractDatabase<T extends Datas> {
     /** Reference an item in a collection in this database. */
     abstract item<K extends DataKey<T>>(collection: K, id: string): ItemReference<T[K]> | AsyncItemReference<T[K]>;
     /** Run a set of changes in this database. */
-    abstract change(...changes: Nullish<WriteChange<Data>>[]): ItemChanges | Promise<ItemChanges>;
+    abstract change(...changes: Optional<WriteChange<Data>>[]): ItemChanges | Promise<ItemChanges>;
     /** Get a document from a collection in this database. */
     abstract get<K extends DataKey<T>>(collection: K, id: string): ItemValue<T[K]> | Promise<ItemValue<T[K]>>;
     /** Add a document to a collection in this database. */
@@ -44,7 +44,7 @@ export declare class Database<T extends Datas = Datas> extends AbstractDatabase<
     collection<K extends DataKey<T>>(collection: K): CollectionReference<T[K]>;
     query<K extends DataKey<T>>(collection: K, query?: ItemQuery<T[K]>): QueryReference<T[K]>;
     item<K extends DataKey<T>>(collection: K, id: string): ItemReference<T[K]>;
-    change(...changes: Nullish<WriteChange<Data>>[]): ItemChanges;
+    change(...changes: Optional<WriteChange<Data>>[]): ItemChanges;
     get<K extends DataKey<T>>(collection: K, id: string): ItemValue<T[K]>;
     add<K extends DataKey<T>>(collection: K, data: T[K]): string;
     set<K extends DataKey<T>>(collection: K, id: string, data: T[K]): void;
@@ -58,7 +58,7 @@ export declare class AsyncDatabase<T extends Datas = Datas> extends AbstractData
     collection<K extends DataKey<T>>(collection: K): AsyncCollectionReference<T[K]>;
     query<K extends DataKey<T>>(collection: K, query?: ItemQuery<T[K]>): AsyncQueryReference<T[K]>;
     item<K extends DataKey<T>>(collection: K, id: string): AsyncItemReference<T[K]>;
-    change(...changes: Nullish<WriteChange<Data>>[]): Promise<ItemChanges>;
+    change(...changes: Optional<WriteChange<Data>>[]): Promise<ItemChanges>;
     get<K extends DataKey<T>>(collection: K, id: string): Promise<ItemValue<T[K]>>;
     add<K extends DataKey<T>>(collection: K, data: T[K]): Promise<string>;
     set<K extends DataKey<T>>(collection: K, id: string, data: T[K]): Promise<void>;

package/db/ItemReference.js

@@ -1,4 +1,4 @@
-import { getRequired } from "../util/null.js";
+import { getRequired } from "../util/optional.js";
 import { runSequence } from "../util/sequence.js";
 /** Get the ID from item data. */
 export const getID = ({ id }) => id;

package/db/ItemState.js

@@ -2,7 +2,8 @@ import { CacheProvider } from "../provider/CacheProvider.js";
 import { BooleanState } from "../state/BooleanState.js";
 import { State } from "../state/State.js";
 import { call } from "../util/callback.js";
-import { getRequired } from "../util/null.js";
+import { NONE } from "../util/constants.js";
+import { getRequired } from "../util/optional.js";
 import { getOptionalSource } from "../util/source.js";
 import { getItemData } from "./ItemReference.js";
 /** Hold the current state of a item. */
@@ -17,14 +18,14 @@ export class ItemState extends State {
     }
     /** Does the item exist? */
     get exists() {
-        return !this.loading && !!this.value;
+        return !!this.value;
     }
     constructor(ref) {
         var _a;
         const { provider, collection, id } = ref;
         const memory = (_a = getOptionalSource(CacheProvider, provider)) === null || _a === void 0 ? void 0 : _a.memory;
         const time = memory ? memory.getItemTime(collection, id) : undefined;
-        super(memory && typeof time === "number" ? memory.getItem(collection, id) : undefined, time);
+        super(memory && typeof time === "number" ? memory.getItem(collection, id) : NONE, time);
         this.busy = new BooleanState();
         this._iterating = 0;
         this._stop = undefined;

package/db/QueryReference.js

@@ -1,6 +1,6 @@
 import { countArray, getOptionalFirstItem, getOptionalLastItem, isArrayLength } from "../util/array.js";
-import { getRequired } from "../util/null.js";
 import { cloneObjectWith } from "../util/object.js";
+import { getRequired } from "../util/optional.js";
 import { runSequence } from "../util/sequence.js";
 /** Reference to a set of items in a sync or async provider. */
 class AbstractQueryReference {

package/db/QueryState.js

@@ -4,7 +4,7 @@ import { State } from "../state/State.js";
 import { getOptionalFirstItem, getOptionalLastItem } from "../util/array.js";
 import { call } from "../util/callback.js";
 import { NONE } from "../util/constants.js";
-import { getRequired } from "../util/null.js";
+import { getRequired } from "../util/optional.js";
 import { getAfterQuery, getLimit } from "../util/query.js";
 import { getOptionalSource } from "../util/source.js";
 /** Hold the current state of a query. */
@@ -31,7 +31,7 @@ export class QueryState extends State {
     }
     /** Does the document have at least one result. */
     get exists() {
-        return !this.loading && !!this.value.length;
+        return !!this.value.length;
     }
     /** Get the number of items matching this query. */
     get count() {

package/package.json

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

package/react/useData.d.ts

@@ -1,13 +1,14 @@
 /// <reference types="react" />
 import type { AsyncQueryReference } from "../db/QueryReference.js";
 import type { Data } from "../util/data.js";
+import type { Optional } from "../util/optional.js";
 import { AsyncItemReference } from "../db/ItemReference.js";
 import { ItemState } from "../db/ItemState.js";
 import { QueryState } from "../db/QueryState.js";
 export declare function useData<T extends Data>(ref: AsyncItemReference<T>): ItemState<T>;
-export declare function useData<T extends Data>(ref: AsyncItemReference<T> | undefined): ItemState<T> | undefined;
+export declare function useData<T extends Data>(ref: Optional<AsyncItemReference<T>>): ItemState<T> | undefined;
 export declare function useData<T extends Data>(ref: AsyncQueryReference<T>): QueryState<T>;
-export declare function useData<T extends Data>(ref: AsyncQueryReference<T> | undefined): QueryState<T> | undefined;
+export declare function useData<T extends Data>(ref: Optional<AsyncQueryReference<T>>): QueryState<T> | undefined;
 /** Wrap components with `<DataProvider>` to allow the use of `useData()`. */
 export declare const DataProvider: ({ children }: {
     children: import("react").ReactNode;

package/react/useState.d.ts

@@ -1,3 +1,4 @@
 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?: T | undefined): T | undefined;
+export declare function useState<T extends AnyState>(state?: Optional<T>): T | undefined;

package/react/useState.js

@@ -3,5 +3,5 @@ import { NONE } from "../util/constants.js";
 import { BLACKHOLE } from "../util/function.js";
 export function useState(state) {
     useSyncExternalStore(useCallback(onStateChange => (state === null || state === void 0 ? void 0 : state.to(onStateChange, onStateChange)) || BLACKHOLE, [state]), () => (!state ? state : state.loading ? NONE : state.value));
-    return state;
+    return state !== null && state !== void 0 ? state : undefined;
 }

package/state/DataState.js

@@ -1,5 +1,5 @@
-import { getRequired } from "../util/null.js";
 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. */

package/util/index.d.ts

@@ -28,6 +28,7 @@ export * from "./merge.js";
 export * from "./null.js";
 export * from "./number.js";
 export * from "./object.js";
+export * from "./optional.js";
 export * from "./query.js";
 export * from "./random.js";
 export * from "./regexp.js";

package/util/index.js

@@ -28,6 +28,7 @@ export * from "./merge.js";
 export * from "./null.js";
 export * from "./number.js";
 export * from "./object.js";
+export * from "./optional.js";
 export * from "./query.js";
 export * from "./random.js";
 export * from "./regexp.js";

package/util/null.d.ts

@@ -24,5 +24,3 @@ export declare const notNullish: <T>(value: Nullish<T>) => value is T;
 export declare function assertNotNullish<T>(value: Nullish<T>): asserts value is T;
 /** Get the not-nullish version of value. */
 export declare function getNotNullish<T>(value: Nullish<T>): T;
-/** Get a required value. */
-export declare function getRequired<T>(value: Nullish<T>): T;

package/util/null.js

@@ -1,5 +1,4 @@
 import { AssertionError } from "../error/AssertionError.js";
-import { RequiredError } from "../error/RequiredError.js";
 /** Function that always returns null. */
 export const getNull = () => null;
 /** Is a value null? */
@@ -40,9 +39,3 @@ export function getNotNullish(value) {
     assertNotNullish(value);
     return value;
 }
-/** Get a required value. */
-export function getRequired(value) {
-    if (isNullish(value))
-        throw new RequiredError("Value is required");
-    return value;
-}

package/util/optional.d.ts

@@ -0,0 +1,4 @@
+/** Optional is the value or `null` or `undefined` (synonym for `Nullish`). */
+export type Optional<T> = T | null | undefined | void;
+/** Get a required value. */
+export declare function getRequired<T>(value: Optional<T>): T;

package/util/optional.js

@@ -0,0 +1,7 @@
+import { RequiredError } from "../error/RequiredError.js";
+/** Get a required value. */
+export function getRequired(value) {
+    if (value === null || value === undefined)
+        throw new RequiredError("Value is required");
+    return value;
+}