shelving 1.120.0 → 1.121.0

package/{change → db}/Change.d.ts

@@ -1,8 +1,9 @@
-import type { AsyncProvider, Provider } from "../db/Provider.js";
+import type { AsyncProvider, Provider } from "./Provider.js";
 import type { ImmutableArray } from "../util/array.js";
 import type { DataKey, Database } from "../util/data.js";
 import type { ItemQuery } from "../util/item.js";
 import type { Updates } from "../util/update.js";
+import { type Optional } from "../util/optional.js";
 /** A change to a database. */
 export interface Change {
     readonly action: string;
@@ -66,5 +67,9 @@ export type DatabaseChange<T extends Database> = ItemAddChange<T, DataKey<T>> |
 export type DatabaseChanges<T extends Database> = ImmutableArray<DatabaseChange<T>>;
 /** Write a single change to a synchronous provider and return an array of the changes that were written. */
 export declare function writeChange<T extends Database>(provider: Provider<T>, change: DatabaseChange<T>): DatabaseChange<T>;
+/** Write a set of changes to a synchronous provider. */
+export declare function writeChanges<T extends Database>(provider: Provider<T>, ...changes: Optional<DatabaseChange<T>>[]): DatabaseChanges<T>;
 /** Write a single change to an asynchronous provider and return the change that was written. */
 export declare function writeAsyncChange<T extends Database>(provider: AsyncProvider<T>, change: DatabaseChange<T>): Promise<DatabaseChange<T>>;
+/** Write a set of changes to an asynchronous provider. */
+export declare function writeAsyncChanges<T extends Database>(provider: AsyncProvider<T>, ...changes: Optional<DatabaseChange<T>>[]): Promise<DatabaseChanges<T>>;

package/{change → db}/Change.js

@@ -1,3 +1,4 @@
+import { notOptional } from "../util/optional.js";
 /** Write a single change to a synchronous provider and return an array of the changes that were written. */
 export function writeChange(provider, change) {
     const { action, collection, id, query } = change;
@@ -23,6 +24,10 @@ export function writeChange(provider, change) {
     }
     return change;
 }
+/** Write a set of changes to a synchronous provider. */
+export function writeChanges(provider, ...changes) {
+    return changes.filter(notOptional).map(change => writeChange(provider, change));
+}
 /** Write a single change to an asynchronous provider and return the change that was written. */
 export async function writeAsyncChange(provider, change) {
     const { collection, action, id, query } = change;
@@ -48,3 +53,7 @@ export async function writeAsyncChange(provider, change) {
     }
     return change;
 }
+/** Write a set of changes to an asynchronous provider. */
+export function writeAsyncChanges(provider, ...changes) {
+    return Promise.all(changes.filter(notOptional).map(change => writeAsyncChange(provider, change)));
+}

package/db/{LoggedProvider.d.ts → ChangesProvider.d.ts}

@@ -1,13 +1,13 @@
-import type { DatabaseChange, DatabaseChanges } from "../change/Change.js";
+import type { DatabaseChange, DatabaseChanges } from "./Change.js";
 import type { MutableArray } from "../util/array.js";
 import type { DataKey, Database } from "../util/data.js";
 import type { ItemQuery } from "../util/item.js";
 import type { Updates } from "../util/update.js";
 import { AsyncThroughProvider, ThroughProvider } from "./ThroughProvider.js";
-/** Synchronous provider that keeps a log of any written changes to its `.written` property. */
-export declare class LoggedProvider<T extends Database> extends ThroughProvider<T> {
-    get written(): DatabaseChanges<T>;
-    readonly _written: MutableArray<DatabaseChange<T>>;
+/** Synchronous provider that keeps a log of any written changes to its `.changes` property. */
+export declare class ChangesProvider<T extends Database> extends ThroughProvider<T> {
+    get changes(): DatabaseChanges<T>;
+    readonly _changes: MutableArray<DatabaseChange<T>>;
     addItem<K extends DataKey<T>>(collection: K, data: T[K]): string;
     setItem<K extends DataKey<T>>(collection: K, id: string, data: T[K]): void;
     updateItem<K extends DataKey<T>>(collection: K, id: string, updates: Updates<T[K]>): void;

package/db/{LoggedProvider.js → ChangesProvider.js}

@@ -1,38 +1,38 @@
 import { AsyncThroughProvider, ThroughProvider } from "./ThroughProvider.js";
-/** Synchronous provider that keeps a log of any written changes to its `.written` property. */
-export class LoggedProvider extends ThroughProvider {
-    get written() {
-        return this._written;
+/** Synchronous provider that keeps a log of any written changes to its `.changes` property. */
+export class ChangesProvider extends ThroughProvider {
+    get changes() {
+        return this._changes;
     }
-    _written = [];
+    _changes = [];
     addItem(collection, data) {
         const id = super.addItem(collection, data);
-        this._written.push({ action: "set", collection, id, data });
+        this._changes.push({ action: "set", collection, id, data });
         return id;
     }
     setItem(collection, id, data) {
         super.setItem(collection, id, data);
-        this._written.push({ action: "set", collection, id, data });
+        this._changes.push({ action: "set", collection, id, data });
     }
     updateItem(collection, id, updates) {
         super.updateItem(collection, id, updates);
-        this._written.push({ action: "update", collection, id, updates });
+        this._changes.push({ action: "update", collection, id, updates });
     }
     deleteItem(collection, id) {
         super.deleteItem(collection, id);
-        this._written.push({ action: "delete", collection, id });
+        this._changes.push({ action: "delete", collection, id });
     }
     setQuery(collection, query, data) {
         super.setQuery(collection, query, data);
-        this._written.push({ action: "set", collection, query, data });
+        this._changes.push({ action: "set", collection, query, data });
     }
     updateQuery(collection, query, updates) {
         super.updateQuery(collection, query, updates);
-        this._written.push({ action: "update", collection, query, updates });
+        this._changes.push({ action: "update", collection, query, updates });
     }
     deleteQuery(collection, query) {
         super.deleteQuery(collection, query);
-        this._written.push({ action: "delete", collection, query });
+        this._changes.push({ action: "delete", collection, query });
     }
 }
 /** Asynchronous provider that keeps a log of any written changes to its `.written` property. */

package/db/index.d.ts

@@ -3,7 +3,8 @@ export * from "./QueryStore.js";
 export * from "./Provider.js";
 export * from "./ThroughProvider.js";
 export * from "./CacheProvider.js";
+export * from "./ChangesProvider.js";
 export * from "./DebugProvider.js";
-export * from "./LoggedProvider.js";
 export * from "./MemoryProvider.js";
 export * from "./ValidationProvider.js";
+export * from "./Change.js";

package/db/index.js

@@ -5,7 +5,9 @@ export * from "./QueryStore.js";
 export * from "./Provider.js";
 export * from "./ThroughProvider.js";
 export * from "./CacheProvider.js";
+export * from "./ChangesProvider.js";
 export * from "./DebugProvider.js";
-export * from "./LoggedProvider.js";
 export * from "./MemoryProvider.js";
 export * from "./ValidationProvider.js";
+// Util.
+export * from "./Change.js";

package/index.d.ts

@@ -4,7 +4,6 @@
  * - Modules that are for internal use, like `shelving/test`
  */
 export * from "./api/index.js";
-export * from "./change/index.js";
 export * from "./db/index.js";
 export * from "./error/index.js";
 export * from "./feedback/index.js";

package/index.js

@@ -4,7 +4,6 @@
  * - Modules that are for internal use, like `shelving/test`
  */
 export * from "./api/index.js";
-export * from "./change/index.js";
 export * from "./db/index.js";
 export * from "./error/index.js";
 export * from "./feedback/index.js";

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.120.0",
+	"version": "1.121.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -22,7 +22,6 @@
 	"exports": {
 		".": "./index.js",
 		"./api": "./api/index.js",
-		"./change": "./change/index.js",
 		"./db": "./db/index.js",
 		"./error": "./error/index.js",
 		"./feedback": "./feedback/index.js",
@@ -31,7 +30,6 @@
 		"./firestore/server": "./firestore/server/index.js",
 		"./iterate": "./iterate/index.js",
 		"./markup": "./markup/index.js",
-		"./provider": "./provider/index.js",
 		"./react": "./react/index.js",
 		"./schema": "./schema/index.js",
 		"./sequence": "./sequence/index.js",

package/change/index.d.ts

@@ -1 +0,0 @@
-export * from "./Change.js";

package/change/index.js

@@ -1 +0,0 @@
-export * from "./Change.js";