shelving 1.118.0 → 1.119.0

package/change/Change.d.ts

@@ -1,4 +1,4 @@
-import type { AbstractProvider, AsyncProvider, Provider } from "../db/Provider.js";
+import type { AsyncProvider, Provider } from "../db/Provider.js";
 import type { ImmutableArray } from "../util/array.js";
 import type { DataKey, Database } from "../util/data.js";
 import type { ItemQuery } from "../util/item.js";
@@ -64,20 +64,6 @@ export type DatabaseQueryChange<T extends Database> = QuerySetChange<T, DataKey<
 export type DatabaseChange<T extends Database> = ItemAddChange<T, DataKey<T>> | DatabaseItemChange<T> | DatabaseQueryChange<T>;
 /** Write an item or multiple items in a set of collection. */
 export type DatabaseChanges<T extends Database> = ImmutableArray<DatabaseChange<T>>;
-/** Get a set change for an item. */
-export declare function getItemAdd<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, data: T[K]): ItemAddChange<T, K>;
-/** Get a set change for an item. */
-export declare function getItemSet<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, id: string, data: T[K]): ItemSetChange<T, K>;
-/** Get an update change an item. */
-export declare function getItemUpdate<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, id: string, updates: Updates<T[K]>): ItemUpdateChange<T, K>;
-/** Get a set change for an item. */
-export declare function getItemDelete<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, id: string): ItemDeleteChange<T, K>;
-/** Get a set change for an query. */
-export declare function getQuerySet<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, query: ItemQuery<T[K]>, data: T[K]): QuerySetChange<T, K>;
-/** Get an update change an query. */
-export declare function getQueryUpdate<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, query: ItemQuery<T[K]>, updates: Updates<T[K]>): QueryUpdateChange<T, K>;
-/** Get a set change for an query. */
-export declare function getQueryDelete<T extends Database, K extends DataKey<T>>(provider: AbstractProvider<T>, collection: K, query: ItemQuery<T[K]>): QueryDeleteChange<T, K>;
 /** 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 single change to an asynchronous provider and return the change that was written. */

package/change/Change.js

@@ -1,31 +1,3 @@
-/** Get a set change for an item. */
-export function getItemAdd(provider, collection, data) {
-    return { action: "add", collection, data };
-}
-/** Get a set change for an item. */
-export function getItemSet(provider, collection, id, data) {
-    return { action: "set", collection, id, data };
-}
-/** Get an update change an item. */
-export function getItemUpdate(provider, collection, id, updates) {
-    return { action: "update", collection, id, updates };
-}
-/** Get a set change for an item. */
-export function getItemDelete(provider, collection, id) {
-    return { action: "delete", collection, id };
-}
-/** Get a set change for an query. */
-export function getQuerySet(provider, collection, query, data) {
-    return { action: "set", collection, query, data };
-}
-/** Get an update change an query. */
-export function getQueryUpdate(provider, collection, query, updates) {
-    return { action: "update", collection, query, updates };
-}
-/** Get a set change for an query. */
-export function getQueryDelete(provider, collection, query) {
-    return { action: "delete", collection, query };
-}
 /** 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;

package/db/OperationProvider.js

@@ -1,4 +1,4 @@
-import { getItemDelete, getItemSet, getItemUpdate, getQueryDelete, getQuerySet, getQueryUpdate, writeAsyncChange, writeChange } from "../change/Change.js";
+import { writeAsyncChange, writeChange } from "../change/Change.js";
 import { notOptional } from "../util/optional.js";
 import { AsyncThroughProvider, ThroughProvider } from "./ThroughProvider.js";
 /** Write a set of operations or changes to a synchronous provider and return an array of the changes that were written. */
@@ -23,32 +23,32 @@ export class OperationProvider extends ThroughProvider {
     _written = [];
     addItem(collection, data) {
         const id = super.addItem(collection, data);
-        this._written.push(getItemSet(this, collection, id, data));
+        this._written.push({ action: "set", collection, id, data });
         return id;
     }
     setItem(collection, id, data) {
         super.setItem(collection, id, data);
-        this._written.push(getItemSet(this, collection, id, data));
+        this._written.push({ action: "set", collection, id, data });
     }
     updateItem(collection, id, updates) {
         super.updateItem(collection, id, updates);
-        this._written.push(getItemUpdate(this, collection, id, updates));
+        this._written.push({ action: "update", collection, id, updates });
     }
     deleteItem(collection, id) {
         super.deleteItem(collection, id);
-        this._written.push(getItemDelete(this, collection, id));
+        this._written.push({ action: "delete", collection, id });
     }
     setQuery(collection, query, data) {
         super.setQuery(collection, query, data);
-        this._written.push(getQuerySet(this, collection, query, data));
+        this._written.push({ action: "set", collection, query, data });
     }
     updateQuery(collection, query, updates) {
         super.updateQuery(collection, query, updates);
-        this._written.push(getQueryUpdate(this, collection, query, updates));
+        this._written.push({ action: "update", collection, query, updates });
     }
     deleteQuery(collection, query) {
         super.deleteQuery(collection, query);
-        this._written.push(getQueryDelete(this, collection, query));
+        this._written.push({ action: "delete", collection, query });
     }
 }
 /** Write a set of operations or changes to an asynchronous provider and return an array of the changes that were written. */
@@ -73,31 +73,31 @@ export class AsyncOperationProvider extends AsyncThroughProvider {
     _written = [];
     async addItem(collection, data) {
         const id = await super.addItem(collection, data);
-        this._written.push(getItemSet(this, collection, id, data));
+        this._written.push({ action: "set", collection, id, data });
         return id;
     }
     async setItem(collection, id, data) {
         await super.setItem(collection, id, data);
-        this._written.push(getItemSet(this, collection, id, data));
+        this._written.push({ action: "set", collection, id, data });
     }
     async updateItem(collection, id, updates) {
         await super.updateItem(collection, id, updates);
-        this._written.push(getItemUpdate(this, collection, id, updates));
+        this._written.push({ action: "update", collection, id, updates });
     }
     async deleteItem(collection, id) {
         await super.deleteItem(collection, id);
-        this._written.push(getItemDelete(this, collection, id));
+        this._written.push({ action: "delete", collection, id });
     }
     async setQuery(collection, query, data) {
         await super.setQuery(collection, query, data);
-        this._written.push(getQuerySet(this, collection, query, data));
+        this._written.push({ action: "set", collection, query, data });
     }
     async updateQuery(collection, query, updates) {
         await super.updateQuery(collection, query, updates);
-        this._written.push(getQueryUpdate(this, collection, query, updates));
+        this._written.push({ action: "update", collection, query, updates });
     }
     async deleteQuery(collection, query) {
         await super.deleteQuery(collection, query);
-        this._written.push(getQueryDelete(this, collection, query));
+        this._written.push({ action: "delete", collection, query });
     }
 }

package/db/index.d.ts

@@ -3,7 +3,6 @@ export * from "./QueryStore.js";
 export * from "./Provider.js";
 export * from "./ThroughProvider.js";
 export * from "./CacheProvider.js";
-export * from "./ChangeProvider.js";
 export * from "./DebugProvider.js";
 export * from "./MemoryProvider.js";
 export * from "./OperationProvider.js";

package/db/index.js

@@ -5,7 +5,6 @@ export * from "./QueryStore.js";
 export * from "./Provider.js";
 export * from "./ThroughProvider.js";
 export * from "./CacheProvider.js";
-export * from "./ChangeProvider.js";
 export * from "./DebugProvider.js";
 export * from "./MemoryProvider.js";
 export * from "./OperationProvider.js";

package/package.json

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

package/db/ChangeProvider.d.ts

@@ -1,29 +0,0 @@
-import type { DatabaseChange, ItemAddChange, ItemDeleteChange, ItemSetChange, ItemUpdateChange, QueryDeleteChange, QuerySetChange, QueryUpdateChange } from "../change/Change.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 offers additional helper methods for working with `Change` items. */
-export declare class ChangeProvider<T extends Database> extends ThroughProvider<T> {
-    getItemAdd<K extends DataKey<T>>(collection: K, data: T[K]): ItemAddChange<T, K>;
-    getItemSet<K extends DataKey<T>>(collection: K, id: string, data: T[K]): ItemSetChange<T, K>;
-    getItemUpdate<K extends DataKey<T>>(collection: K, id: string, updates: Updates<T[K]>): ItemUpdateChange<T, K>;
-    getItemDelete<K extends DataKey<T>>(collection: K, id: string): ItemDeleteChange<T, K>;
-    getQuerySet<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>, data: T[K]): QuerySetChange<T, K>;
-    getQueryUpdate<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>, updates: Updates<T[K]>): QueryUpdateChange<T, K>;
-    getQueryDelete<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>): QueryDeleteChange<T, K>;
-    /** Write a single change to a synchronous provider and return an array of the changes that were written. */
-    change(change: DatabaseChange<T>): DatabaseChange<T>;
-}
-/** Asynchronous provider that offers additional helper methods for working with `Change` items. */
-export declare class AsyncConvenienceProvider<T extends Database> extends AsyncThroughProvider<T> {
-    getItemAdd<K extends DataKey<T>>(collection: K, data: T[K]): ItemAddChange<T, K>;
-    getItemSet<K extends DataKey<T>>(collection: K, id: string, data: T[K]): ItemSetChange<T, K>;
-    getItemUpdate<K extends DataKey<T>>(collection: K, id: string, updates: Updates<T[K]>): ItemUpdateChange<T, K>;
-    getItemDelete<K extends DataKey<T>>(collection: K, id: string): ItemDeleteChange<T, K>;
-    getQuerySet<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>, data: T[K]): QuerySetChange<T, K>;
-    getQueryUpdate<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>, updates: Updates<T[K]>): QueryUpdateChange<T, K>;
-    getQueryDelete<K extends DataKey<T>>(collection: K, query: ItemQuery<T[K]>): QueryDeleteChange<T, K>;
-    /** Write a single change to a synchronous provider and return an array of the changes that were written. */
-    change(change: DatabaseChange<T>): Promise<DatabaseChange<T>>;
-}

package/db/ChangeProvider.js

@@ -1,58 +0,0 @@
-import { getItemAdd, getItemDelete, getItemSet, getItemUpdate, getQueryDelete, getQuerySet, getQueryUpdate, writeAsyncChange, writeChange } from "../change/Change.js";
-import { AsyncThroughProvider, ThroughProvider } from "./ThroughProvider.js";
-/** Synchronous provider that offers additional helper methods for working with `Change` items. */
-export class ChangeProvider extends ThroughProvider {
-    getItemAdd(collection, data) {
-        return getItemAdd(this, collection, data);
-    }
-    getItemSet(collection, id, data) {
-        return getItemSet(this, collection, id, data);
-    }
-    getItemUpdate(collection, id, updates) {
-        return getItemUpdate(this, collection, id, updates);
-    }
-    getItemDelete(collection, id) {
-        return getItemDelete(this, collection, id);
-    }
-    getQuerySet(collection, query, data) {
-        return getQuerySet(this, collection, query, data);
-    }
-    getQueryUpdate(collection, query, updates) {
-        return getQueryUpdate(this, collection, query, updates);
-    }
-    getQueryDelete(collection, query) {
-        return getQueryDelete(this, collection, query);
-    }
-    /** Write a single change to a synchronous provider and return an array of the changes that were written. */
-    change(change) {
-        return writeChange(this, change);
-    }
-}
-/** Asynchronous provider that offers additional helper methods for working with `Change` items. */
-export class AsyncConvenienceProvider extends AsyncThroughProvider {
-    getItemAdd(collection, data) {
-        return getItemAdd(this, collection, data);
-    }
-    getItemSet(collection, id, data) {
-        return getItemSet(this, collection, id, data);
-    }
-    getItemUpdate(collection, id, updates) {
-        return getItemUpdate(this, collection, id, updates);
-    }
-    getItemDelete(collection, id) {
-        return getItemDelete(this, collection, id);
-    }
-    getQuerySet(collection, query, data) {
-        return getQuerySet(this, collection, query, data);
-    }
-    getQueryUpdate(collection, query, updates) {
-        return getQueryUpdate(this, collection, query, updates);
-    }
-    getQueryDelete(collection, query) {
-        return getQueryDelete(this, collection, query);
-    }
-    /** Write a single change to a synchronous provider and return an array of the changes that were written. */
-    change(change) {
-        return writeAsyncChange(this, change);
-    }
-}