shelving 1.89.3 → 1.89.5

package/db/Change.d.ts

@@ -3,28 +3,27 @@ import type { ImmutableArray } from "../util/array.js";
 import type { Provider, AsyncProvider } from "../provider/Provider.js";
 import { Updates } from "../update/DataUpdate.js";
 import { Nullish } from "../util/null.js";
-import { DeepIterable } from "../util/iterate.js";
 /** Change on a collection. */
 export interface Change {
     readonly action: string;
     readonly collection: string;
 }
 /** Add on an item. */
-export interface AddChange extends Change {
+export interface AddChange<T extends Data> extends Change {
     readonly action: "ADD";
-    readonly data: Data;
+    readonly data: T;
 }
 /** Set on an item. */
-export interface SetChange extends Change {
+export interface SetChange<T extends Data = Data> extends Change {
     readonly action: "SET";
     readonly id: string;
-    readonly data: Data;
+    readonly data: T;
 }
 /** Update change on an item. */
-export interface UpdateChange extends Change {
+export interface UpdateChange<T extends Data = Data> extends Change {
     readonly action: "UPDATE";
     readonly id: string;
-    readonly updates: Updates;
+    readonly updates: Updates<T>;
 }
 /** Delete change on an item. */
 export interface DeleteChange extends Change {
@@ -32,14 +31,14 @@ export interface DeleteChange extends Change {
     readonly id: string;
 }
 /** Set, update, or delete change on an item. */
-export type ItemChange = SetChange | UpdateChange | DeleteChange;
+export type ItemChange<T extends Data = Data> = SetChange<T> | UpdateChange<T> | DeleteChange;
 /** Array of item changes. */
 export type ItemChanges = ImmutableArray<ItemChange>;
 /** Write change on an item. */
-export type WriteChange = ItemChange | AddChange;
+export type WriteChange<T extends Data = Data> = ItemChange<T> | AddChange<T>;
 /** Array of write changes. */
 export type WriteChanges = ImmutableArray<WriteChange>;
 /** Apply a set of changes to a synchronous provider. */
-export declare function changeProvider(provider: Provider, ...changes: DeepIterable<Nullish<WriteChange>>[]): ItemChanges;
+export declare function changeProvider(provider: Provider, ...changes: Nullish<WriteChange>[]): ItemChanges;
 /** Apply a set of changes to an asynchronous provider. */
-export declare function changeAsyncProvider(provider: AsyncProvider, ...changes: DeepIterable<Nullish<WriteChange>>[]): Promise<ItemChanges>;
+export declare function changeAsyncProvider(provider: AsyncProvider, ...changes: Nullish<WriteChange>[]): Promise<ItemChanges>;

package/db/Change.js

@@ -1,9 +1,8 @@
 import { notNullish } from "../util/null.js";
-import { flattenItems } from "../util/iterate.js";
 import { getItemConstraints } from "./Item.js";
 /** Apply a set of changes to a synchronous provider. */
 export function changeProvider(provider, ...changes) {
-    return Array.from(flattenItems(changes)).filter(notNullish).map(_changeItem, provider);
+    return changes.filter(notNullish).map(_changeItem, provider);
 }
 function _changeItem(change) {
     const { action, collection } = change;
@@ -19,7 +18,7 @@ function _changeItem(change) {
 }
 /** Apply a set of changes to an asynchronous provider. */
 export function changeAsyncProvider(provider, ...changes) {
-    return Promise.all(Array.from(flattenItems(changes)).filter(notNullish).map(_changeAsyncItem, provider));
+    return Promise.all(changes.filter(notNullish).map(_changeAsyncItem, provider));
 }
 async function _changeAsyncItem(change) {
     const { collection, action } = change;

package/db/Collection.d.ts

@@ -25,11 +25,11 @@ declare abstract class BaseCollection<T extends Data = Data> {
     /** Delete a document in this collection. */
     abstract delete(id: string): void | Promise<void>;
     /** Get an add change for this collection. */
-    getAdd(data: T): AddChange;
+    getAdd(data: T): AddChange<T>;
     /** Get a set change for this collection. */
-    getSet(id: string, data: T): SetChange;
+    getSet(id: string, data: T): SetChange<T>;
     /** Get an update change for this collection. */
-    getUpdate(id: string, updates: Updates<T>): UpdateChange;
+    getUpdate(id: string, updates: Updates<T>): UpdateChange<T>;
     /** Get a delete change for this collection. */
     getDelete(id: string): DeleteChange;
     toString(): string;

package/db/Database.d.ts

@@ -1,6 +1,5 @@
 import type { DataKey, Datas } from "../util/data.js";
 import type { Nullish } from "../util/null.js";
-import type { DeepIterable } from "../util/iterate.js";
 import type { AsyncProvider, Provider } from "../provider/Provider.js";
 import type { FilterList } from "../constraint/FilterConstraint.js";
 import type { SortList } from "../constraint/SortConstraint.js";
@@ -20,7 +19,7 @@ declare abstract class BaseDatabase<T extends Datas> {
     /** Reference an item in a collection in this database. */
     abstract item<K extends DataKey<T>>(collection: K, id: string): Item<T[K]> | AsyncItem<T[K]>;
     /** Run a set of changes in this database. */
-    abstract change(...changes: DeepIterable<Nullish<WriteChange>>[]): ItemChanges | Promise<ItemChanges>;
+    abstract change(...changes: Nullish<WriteChange>[]): 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. */
@@ -32,11 +31,11 @@ declare abstract class BaseDatabase<T extends Datas> {
     /** Delete a document from a collection in this database. */
     abstract delete<K extends DataKey<T>>(collection: K, id: string): void | Promise<void>;
     /** Get an add change for a collection in this database. */
-    getAdd<K extends DataKey<T>>(collection: K, data: T[K]): AddChange;
+    getAdd<K extends DataKey<T>>(collection: K, data: T[K]): AddChange<T[K]>;
     /** Get a set change for a collection in this database. */
-    getSet<K extends DataKey<T>>(collection: K, id: string, data: T[K]): SetChange;
+    getSet<K extends DataKey<T>>(collection: K, id: string, data: T[K]): SetChange<T[K]>;
     /** Get an update change for a collection in this database. */
-    getUpdate<K extends DataKey<T>>(collection: K, id: string, updates: Updates<T[K]>): UpdateChange;
+    getUpdate<K extends DataKey<T>>(collection: K, id: string, updates: Updates<T[K]>): UpdateChange<T[K]>;
     /** Get a delete change for a collection in this database. */
     getDelete<K extends DataKey<T>>(collection: K, id: string): DeleteChange;
 }
@@ -47,7 +46,7 @@ export declare class Database<T extends Datas = Datas> extends BaseDatabase<T> {
     collection<K extends DataKey<T>>(collection: K): Collection<T[K]>;
     query<K extends DataKey<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T[K]>;
     item<K extends DataKey<T>>(collection: K, id: string): Item<T[K]>;
-    change(...changes: DeepIterable<Nullish<WriteChange>>[]): ItemChanges;
+    change(...changes: Nullish<WriteChange>[]): 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;
@@ -61,7 +60,7 @@ export declare class AsyncDatabase<T extends Datas = Datas> extends BaseDatabase
     collection<K extends DataKey<T>>(collection: K): AsyncCollection<T[K]>;
     query<K extends DataKey<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): AsyncQuery<T[K]>;
     item<K extends DataKey<T>>(collection: K, id: string): AsyncItem<T[K]>;
-    change(...changes: DeepIterable<Nullish<WriteChange>>[]): Promise<ItemChanges>;
+    change(...changes: Nullish<WriteChange>[]): 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/Database.js

@@ -37,7 +37,7 @@ export class Database extends BaseDatabase {
         return new Item(this.provider, collection, id);
     }
     change(...changes) {
-        return changeProvider(this.provider, changes);
+        return changeProvider(this.provider, ...changes);
     }
     get(collection, id) {
         return this.provider.getItem(collection, id);
@@ -71,7 +71,7 @@ export class AsyncDatabase extends BaseDatabase {
         return new AsyncItem(this.provider, collection, id);
     }
     change(...changes) {
-        return changeAsyncProvider(this.provider, changes);
+        return changeAsyncProvider(this.provider, ...changes);
     }
     get(collection, id) {
         return this.provider.getItem(collection, id);

package/db/Item.d.ts

@@ -51,9 +51,9 @@ declare abstract class BaseItem<T extends Data = Data> implements AsyncIterable<
     /** Delete this item. */
     abstract delete(): void | PromiseLike<void>;
     /** Get a set change for this item. */
-    getSet(data: T): SetChange;
+    getSet(data: T): SetChange<T>;
     /** Get an update change for this item. */
-    getUpdate(updates: Updates<T>): UpdateChange;
+    getUpdate(updates: Updates<T>): UpdateChange<T>;
     /** Get a delete change for this item. */
     getDelete(): DeleteChange;
     toString(): string;

package/package.json

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

package/util/debug.d.ts

@@ -2,16 +2,15 @@
 import type { ImmutableArray } from "./array.js";
 import type { ImmutableMap } from "./map.js";
 import type { ImmutableSet } from "./set.js";
-import type { ImmutableObject } from "./object.js";
 /** Debug a random value as a string. */
-export declare function debug(value: unknown): string;
+export declare function debug(value: unknown, depth?: number): string;
 /** Debug a string. */
 export declare const debugString: (value: string) => string;
 /** Debug an array. */
-export declare function debugArray(value: ImmutableArray): string;
+export declare function debugArray(value: ImmutableArray, depth?: number): string;
 /** Debug a set. */
-export declare function debugSet(value: ImmutableSet): string;
+export declare function debugSet(value: ImmutableSet, depth?: number): string;
 /** Debug a map. */
-export declare function debugMap(value: ImmutableMap): string;
+export declare function debugMap(value: ImmutableMap, depth?: number): string;
 /** Debug an object. */
-export declare function debugObject(value: ImmutableObject): string;
+export declare function debugObject(value: object, depth?: number): string;

package/util/debug.js

@@ -1,6 +1,6 @@
 /* eslint-disable no-control-regex */
 /** Debug a random value as a string. */
-export function debug(value) {
+export function debug(value, depth = 1) {
     if (value === null)
         return "null";
     if (value === undefined)
@@ -21,12 +21,12 @@ export function debug(value) {
         if (value instanceof Error)
             return value.toString();
         if (value instanceof Array)
-            return debugArray(value);
+            return debugArray(value, depth);
         if (value instanceof Map)
-            return debugMap(value);
+            return debugMap(value, depth);
         if (value instanceof Set)
-            return debugSet(value);
-        return debugObject(value);
+            return debugSet(value, depth);
+        return debugObject(value, depth);
     }
     return typeof value;
 }
@@ -36,29 +36,42 @@ const ESCAPE_REGEXP = /[\x00-\x08\x0B-\x1F\x7F-\x9F"\\]/g; // Match control char
 const ESCAPE_LIST = { '"': '\\"', "\\": "\\\\", "\r": "\\r", "\n": "\\n", "\t": "\\t", "\b": "\\b", "\f": "\\f", "\v": "\\v" };
 const _escapeChar = (char) => ESCAPE_LIST[char] || `\\x${char.charCodeAt(0).toString(16).padStart(2, "00")}`;
 /** Debug an array. */
-export function debugArray(value) {
+export function debugArray(value, depth = 1) {
     const prototype = Object.getPrototypeOf(value);
     const name = prototype === Array.prototype ? "" : prototype.constructor.name || "";
-    return `${name ? `${name} ` : ""}${value.length ? `[\n\t${value.map(debug).join(",\n\t")}\n]` : "[]"}`;
+    const items = depth > 0 && value.length ? value.map(v => debug(v, depth - 1)).join(",\n\t") : "";
+    return `${name ? `${name} ` : ""}${value.length ? `[\n\t${items}\n]` : "[]"}`;
 }
 /** Debug a set. */
-export function debugSet(value) {
+export function debugSet(value, depth = 1) {
     const prototype = Object.getPrototypeOf(value);
     const name = prototype === Set.prototype ? "" : prototype.constructor.name || "Set";
-    return `${name}(value.size) ${value.size ? `{\n\t${Array.from(value).map(debug).join(",\n\t")}\n}` : "{}"}`;
+    const items = depth > 0 && value.size
+        ? Array.from(value)
+            .map(v => debug(v, depth - 1))
+            .join(",\n\t")
+        : "";
+    return `${name}(value.size) ${items ? `{\n\t${items}\n}` : "{}"}`;
 }
 /** Debug a map. */
-export function debugMap(value) {
+export function debugMap(value, depth = 1) {
     const prototype = Object.getPrototypeOf(value);
     const name = prototype === Map.prototype ? "" : prototype.constructor.name || "Map";
-    return `${name}(value.size) ${value.size ? `{\n\t${Array.from(value).map(_debugProp).join(",\n\t")}\n}` : "{}"}`;
+    const entries = depth > 0 && value.size
+        ? Array.from(value)
+            .map(([k, v]) => `${debug(k)}: ${debug(v, depth - 1)}`)
+            .join(",\n\t")
+        : "";
+    return `${name}(value.size) ${entries ? `{\n\t${entries}\n}` : "{}"}`;
 }
 /** Debug an object. */
-export function debugObject(value) {
+export function debugObject(value, depth = 1) {
     const prototype = Object.getPrototypeOf(value);
     const name = prototype === Object.prototype ? "" : prototype.constructor.name || "";
-    const props = Object.entries(value).map(_debugProp);
-    return `${name ? `${name} ` : ""}${props.length ? `{\n\t${props.join(",\n\t")}\n}` : "{}"}`;
+    const entries = depth > 0
+        ? Object.entries(value)
+            .map(([k, v]) => `${debug(k)}: ${debug(v, depth - 1)}`)
+            .join(",\n\t")
+        : "";
+    return `${name ? `${name} ` : ""}${entries ? `{\n\t${entries}\n}` : "{}"}`;
 }
-/** Debug a prop. */
-const _debugProp = ([key, value]) => `${debug(key)}: ${debug(value)}`;