shelving 1.73.2 → 1.75.0

package/db/Change.d.ts

@@ -0,0 +1,49 @@
+import type { Data, Datas, Key } from "../util/data.js";
+import type { ImmutableArray } from "../util/array.js";
+import type { Provider, AsyncProvider } from "../provider/Provider.js";
+import { DataUpdate } from "../update/DataUpdate.js";
+import { Nullish } from "../util/null.js";
+import type { ItemConstraints, ItemData } from "./Item.js";
+export interface Change<T extends Datas, K extends Key<T>> {
+    readonly action: string;
+    readonly collection: K;
+}
+/** Add on an item. */
+export interface AddChange<T extends Datas, K extends Key<T>> extends Change<T, K> {
+    readonly action: "ADD";
+    readonly collection: K;
+    readonly data: T[K];
+}
+/** Set on an item. */
+export interface SetChange<T extends Datas, K extends Key<T>> extends Change<T, K> {
+    readonly action: "SET";
+    readonly collection: K;
+    readonly id: string;
+    readonly data: T[K];
+}
+/** Update change on an item. */
+export interface UpdateChange<T extends Datas, K extends Key<T>> extends Change<T, K> {
+    readonly action: "UPDATE";
+    readonly collection: K;
+    readonly id: string;
+    readonly update: DataUpdate<T[K]>;
+}
+/** Delete change on an item. */
+export interface DeleteChange<T extends Datas, K extends Key<T>> extends Change<T, K> {
+    readonly action: "DELETE";
+    readonly collection: K;
+    readonly id: string;
+}
+/** Set, update, or delete change on an item. */
+export declare type ItemChange<T extends Datas, K extends Key<T> = Key<T>> = SetChange<T, K> | UpdateChange<T, K> | DeleteChange<T, K>;
+/** Array of item changes. */
+export declare type ItemChanges<T extends Datas, K extends Key<T> = Key<T>> = ImmutableArray<ItemChange<T, K>>;
+/** Write change on an item. */
+export declare type WriteChange<T extends Datas, K extends Key<T> = Key<T>> = ItemChange<T, K> | AddChange<T, K>;
+/** Array of write changes. */
+export declare type WriteChanges<T extends Datas, K extends Key<T> = Key<T>> = ImmutableArray<WriteChange<T, K>>;
+/** Apply a set of changes to a synchronous provider. */
+export declare function changeProvider<T extends Datas, K extends Key<T> = Key<T>>(provider: Provider<T>, changes: ImmutableArray<Nullish<WriteChange<T, K>>>): ItemChanges<T, K>;
+/** Apply a set of changes to an asynchronous provider. */
+export declare function changeAsyncProvider<T extends Datas, K extends Key<T>>(provider: AsyncProvider<T>, changes: ImmutableArray<Nullish<WriteChange<T, K>>>): Promise<ItemChanges<T, K>>;
+export declare function _getItemConstraint<T extends Data>(id: string): ItemConstraints<ItemData<T>>;

package/db/Change.js

@@ -0,0 +1,38 @@
+import { QueryConstraints } from "../constraint/QueryConstraints.js";
+import { FilterConstraint } from "../constraint/FilterConstraint.js";
+import { notNullish } from "../util/null.js";
+/** Apply a set of changes to a synchronous provider. */
+export function changeProvider(provider, changes) {
+    return changes.filter(notNullish).map(_changeItem, provider);
+}
+function _changeItem(change) {
+    const { action, collection } = change;
+    if (action === "ADD")
+        return { action: "SET", collection, id: this.addItem(collection, change.data), data: change.data };
+    else if (action === "SET")
+        this.setItem(collection, change.id, change.data);
+    else if (action === "UPDATE")
+        this.updateQuery(collection, _getItemConstraint(change.id), change.update);
+    else if (action === "DELETE")
+        this.deleteItem(collection, change.id);
+    return change;
+}
+/** Apply a set of changes to an asynchronous provider. */
+export function changeAsyncProvider(provider, changes) {
+    return Promise.all(changes.filter(notNullish).map(_changeAsyncItem, provider));
+}
+async function _changeAsyncItem(change) {
+    const { collection, action } = change;
+    if (action === "ADD")
+        return { action: "SET", collection, id: await this.addItem(collection, change.data), data: change.data };
+    else if (action === "SET")
+        await this.setItem(collection, change.id, change.data);
+    else if (action === "UPDATE")
+        await this.updateQuery(collection, _getItemConstraint(change.id), change.update);
+    else if (action === "DELETE")
+        await this.deleteItem(collection, change.id);
+    return change;
+}
+export function _getItemConstraint(id) {
+    return new QueryConstraints(new FilterConstraint("id", id), undefined, 1);
+}

package/db/Collection.d.ts

@@ -1,39 +1,43 @@
 import type { Datas, Key } from "../util/data.js";
+import type { Nullish } from "../util/null.js";
 import type { FilterList } from "../constraint/FilterConstraint.js";
 import type { SortList } from "../constraint/SortConstraint.js";
 import type { ItemData, AsyncItem, Item } from "./Item.js";
 import type { AsyncDatabase, Database } from "./Database.js";
 import type { AsyncQuery, Query } from "./Query.js";
+import type { ItemChanges, WriteChange } from "./Change.js";
 /** Reference to a collection in a synchronous or asynchronous provider. */
-interface CollectionInterface<T extends Datas = Datas, K extends Key<T> = Key<T>> {
-    readonly db: Database<T> | AsyncDatabase<T>;
-    readonly collection: K;
+declare abstract class BaseCollection<T extends Datas = Datas, K extends Key<T> = Key<T>> {
+    abstract readonly db: Database<T> | AsyncDatabase<T>;
+    abstract readonly collection: K;
     /** Create a query on this item's collection. */
-    query(filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
+    abstract query(filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
     /** Create a query on this item's collection. */
-    item(id: string): Item<T, K> | AsyncItem<T, K>;
+    abstract item(id: string): Item<T, K> | AsyncItem<T, K>;
     /** Add an item to this collection. */
-    add(data: T[K]): string | Promise<string>;
+    abstract add(data: T[K]): string | Promise<string>;
+    /** Run a set of changes on this database. */
+    abstract change(...changes: Nullish<WriteChange<T, K>>[]): ItemChanges<T, K> | Promise<ItemChanges<T, K>>;
     toString(): K;
 }
 /** Reference to a collection in a synchronous provider. */
-export declare class Collection<T extends Datas = Datas, K extends Key<T> = Key<T>> implements CollectionInterface<T, K> {
+export declare class Collection<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseCollection<T, K> {
     readonly db: Database<T>;
     readonly collection: K;
     constructor(db: Database<T>, collection: K);
     query(filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K>;
     item(id: string): Item<T, K>;
     add(data: T[K]): string;
-    toString(): K;
+    change(...changes: Nullish<WriteChange<T, K>>[]): ItemChanges<T, K>;
 }
 /** Reference to a collection in an asynchronous provider. */
-export declare class AsyncCollection<T extends Datas = Datas, K extends Key<T> = Key<T>> implements CollectionInterface<T, K> {
+export declare class AsyncCollection<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseCollection<T, K> {
     readonly db: AsyncDatabase<T>;
     readonly collection: K;
     constructor(db: AsyncDatabase<T>, collection: K);
     query(filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): AsyncQuery<T, K>;
     item(id: string): AsyncItem<T, K>;
     add(data: T[K]): Promise<string>;
-    toString(): K;
+    change(...changes: Nullish<WriteChange<T, K>>[]): Promise<ItemChanges<T, K>>;
 }
 export {};

package/db/Collection.js

@@ -1,6 +1,14 @@
+/** Reference to a collection in a synchronous or asynchronous provider. */
+class BaseCollection {
+    // Implement toString()
+    toString() {
+        return this.collection;
+    }
+}
 /** Reference to a collection in a synchronous provider. */
-export class Collection {
+export class Collection extends BaseCollection {
     constructor(db, collection) {
+        super();
         this.db = db;
         this.collection = collection;
     }
@@ -13,13 +21,14 @@ export class Collection {
     add(data) {
         return this.db.provider.addItem(this.collection, data);
     }
-    toString() {
-        return this.collection;
+    change(...changes) {
+        return this.db.change(...changes);
     }
 }
 /** Reference to a collection in an asynchronous provider. */
-export class AsyncCollection {
+export class AsyncCollection extends BaseCollection {
     constructor(db, collection) {
+        super();
         this.db = db;
         this.collection = collection;
     }
@@ -32,7 +41,7 @@ export class AsyncCollection {
     add(data) {
         return this.db.provider.addItem(this.collection, data);
     }
-    toString() {
-        return this.collection;
+    change(...changes) {
+        return this.db.change(...changes);
     }
 }

package/db/Database.d.ts

@@ -3,33 +3,39 @@ import type { AsyncProvider, Provider } from "../provider/Provider.js";
 import type { FilterList } from "../constraint/FilterConstraint.js";
 import type { SortList } from "../constraint/SortConstraint.js";
 import type { ItemData } from "../db/Item.js";
+import type { Nullish } from "../util/null.js";
 import { Item, AsyncItem } from "./Item.js";
 import { Query, AsyncQuery } from "./Query.js";
 import { Collection, AsyncCollection } from "./Collection.js";
+import { ItemChanges, WriteChange } from "./Change.js";
 /** Database with a synchronous or asynchronous provider. */
-interface AbstractDatabase<T extends Datas> {
-    readonly provider: Provider<T> | AsyncProvider<T>;
+declare abstract class BaseDatabase<T extends Datas> {
+    abstract readonly provider: Provider<T> | AsyncProvider<T>;
     /** Create a query on a collection in this database. */
-    collection<K extends Key<T>>(collection: K): Collection<T, K> | AsyncCollection<T, K>;
+    abstract collection<K extends Key<T>>(collection: K): Collection<T, K> | AsyncCollection<T, K>;
     /** Create a query on a collection in this database. */
-    query<K extends Key<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
+    abstract query<K extends Key<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K> | AsyncQuery<T, K>;
     /** Reference an item in a collection in this database. */
-    item<K extends Key<T>>(collection: K, id: string): Item<T, K> | AsyncItem<T, K>;
+    abstract item<K extends Key<T>>(collection: K, id: string): Item<T, K> | AsyncItem<T, K>;
+    /** Run a set of changes on this database. */
+    abstract change<K extends Key<T>>(...changes: Nullish<WriteChange<T, K>>[]): ItemChanges<T, K> | Promise<ItemChanges<T, K>>;
 }
 /** Database with a synchronous provider. */
-export declare class Database<T extends Datas = Datas> implements AbstractDatabase<T> {
+export declare class Database<T extends Datas = Datas> implements BaseDatabase<T> {
     readonly provider: Provider<T>;
     constructor(provider: Provider<T>);
     collection<K extends Key<T>>(collection: K): Collection<T, K>;
     query<K extends Key<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): Query<T, K>;
     item<K extends Key<T>>(collection: K, id: string): Item<T, K>;
+    change<K extends Key<T>>(...changes: Nullish<WriteChange<T, K>>[]): ItemChanges<T, K>;
 }
 /** Database with a synchronous provider. */
-export declare class AsyncDatabase<T extends Datas = Datas> implements AbstractDatabase<T> {
+export declare class AsyncDatabase<T extends Datas = Datas> implements BaseDatabase<T> {
     readonly provider: AsyncProvider<T>;
     constructor(provider: AsyncProvider<T>);
     collection<K extends Key<T>>(collection: K): AsyncCollection<T, K>;
     query<K extends Key<T>>(collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null): AsyncQuery<T, K>;
     item<K extends Key<T>>(collection: K, id: string): AsyncItem<T, K>;
+    change<K extends Key<T>>(...changes: Nullish<WriteChange<T, K>>[]): Promise<ItemChanges<T, K>>;
 }
 export {};

package/db/Database.js

@@ -1,6 +1,10 @@
 import { Item, AsyncItem } from "./Item.js";
 import { Query, AsyncQuery } from "./Query.js";
 import { Collection, AsyncCollection } from "./Collection.js";
+import { changeAsyncProvider, changeProvider } from "./Change.js";
+/** Database with a synchronous or asynchronous provider. */
+class BaseDatabase {
+}
 /** Database with a synchronous provider. */
 export class Database {
     constructor(provider) {
@@ -15,6 +19,9 @@ export class Database {
     item(collection, id) {
         return new Item(this, collection, id);
     }
+    change(...changes) {
+        return changeProvider(this.provider, changes);
+    }
 }
 /** Database with a synchronous provider. */
 export class AsyncDatabase {
@@ -30,4 +37,7 @@ export class AsyncDatabase {
     item(collection, id) {
         return new AsyncItem(this, collection, id);
     }
+    change(...changes) {
+        return changeAsyncProvider(this.provider, changes);
+    }
 }

package/db/Item.d.ts

@@ -7,6 +7,7 @@ import { DataUpdate, PropUpdates } from "../update/DataUpdate.js";
 import type { QueryConstraints } from "../constraint/QueryConstraints.js";
 import type { AsyncDatabase, Database } from "./Database.js";
 import type { AsyncQuery, Query } from "./Query.js";
+import type { DeleteChange, SetChange, UpdateChange } from "./Change.js";
 /** Item data with a string ID that uniquely identifies it. */
 export declare type ItemData<T extends Data = Data> = T & {
     id: string;
@@ -18,21 +19,22 @@ export declare type ItemArray<T extends Data = Data> = ImmutableArray<ItemData<T
 /** A set of query constraints for item data. */
 export declare type ItemConstraints<T extends Data = Data> = QueryConstraints<ItemData<T>>;
 /** Reference to an item in a synchronous or asynchronous provider. */
-interface ItemInterface<T extends Datas = Datas, K extends Key<T> = Key<T>> extends Observable<ItemValue<T[K]>> {
-    readonly collection: K;
-    readonly id: string;
+declare abstract class BaseItem<T extends Datas = Datas, K extends Key<T> = Key<T>> implements Observable<ItemValue<T[K]>> {
+    abstract readonly db: Database<T> | AsyncDatabase<T>;
+    abstract readonly collection: K;
+    abstract readonly id: string;
     /** Get an 'optional' reference to this item (uses a `ModelQuery` with an `id` filter). */
-    optional: Query<T, K> | AsyncQuery<T, K>;
+    abstract optional: Query<T, K> | AsyncQuery<T, K>;
     /**
      * Does this item exist?
      * @return `true` if an item exists or `false` otherwise (possibly promised).
      */
-    exists: boolean | PromiseLike<boolean>;
+    abstract exists: boolean | PromiseLike<boolean>;
     /**
      * Get the optional data of this item.
      * @return Document's data, or `null` if the item doesn't exist (possibly promised).
      */
-    value: ItemValue<T[K]> | PromiseLike<ItemValue<T[K]>>;
+    abstract value: ItemValue<T[K]> | PromiseLike<ItemValue<T[K]>>;
     /**
      * Get the data of this item.
      * - Useful for destructuring, e.g. `{ name, title } = await itemThatMustExist.asyncData`
@@ -40,7 +42,7 @@ interface ItemInterface<T extends Datas = Datas, K extends Key<T> = Key<T>> exte
      * @return Document's data (possibly promised).
      * @throws RequiredError if the item does not exist.
      */
-    data: ItemData<T[K]> | PromiseLike<ItemData<T[K]>>;
+    abstract data: ItemData<T[K]> | PromiseLike<ItemData<T[K]>>;
     /**
      * Subscribe to the result of this item (indefinitely).
      * - `next()` is called once with the initial result, and again any time the result changes.
@@ -50,15 +52,21 @@ interface ItemInterface<T extends Datas = Datas, K extends Key<T> = Key<T>> exte
      */
     subscribe(next: PartialObserver<ItemValue<T[K]>> | Dispatch<[ItemValue<T[K]>]>): Unsubscribe;
     /** Set the complete data of this item. */
-    set(data: T[K]): void | PromiseLike<void>;
+    abstract set(data: T[K]): void | PromiseLike<void>;
     /** Update this item. */
-    update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): void | PromiseLike<void>;
+    abstract update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): void | PromiseLike<void>;
     /** Delete this item. */
-    delete(): void | PromiseLike<void>;
+    abstract delete(): void | PromiseLike<void>;
+    /** Get a set change for this item. */
+    getSet(data: T[K]): SetChange<T, K>;
+    /** Get an update change for this item. */
+    getUpdate(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): UpdateChange<T, K>;
+    /** Get a delete change for this item. */
+    getDelete(): DeleteChange<T, K>;
     toString(): `${K}/${string}`;
 }
 /** Reference to an item in a synchronous provider. */
-export declare class Item<T extends Datas = Datas, K extends Key<T> = Key<T>> implements ItemInterface<T, K> {
+export declare class Item<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseItem<T, K> {
     readonly db: Database<T>;
     readonly collection: K;
     readonly id: string;
@@ -67,14 +75,12 @@ export declare class Item<T extends Datas = Datas, K extends Key<T> = Key<T>> im
     get exists(): boolean;
     get value(): ItemValue<T[K]>;
     get data(): ItemData<T[K]>;
-    subscribe(next: PartialObserver<ItemValue<T[K]>> | Dispatch<[ItemValue<T[K]>]>): Unsubscribe;
     set(data: T[K]): void;
     update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): void;
     delete(): void;
-    toString(): `${K}/${string}`;
 }
 /** Reference to an item in an asynchronous provider. */
-export declare class AsyncItem<T extends Datas = Datas, K extends Key<T> = Key<T>> implements ItemInterface<T, K> {
+export declare class AsyncItem<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseItem<T, K> {
     readonly db: AsyncDatabase<T>;
     readonly collection: K;
     readonly id: string;
@@ -83,11 +89,9 @@ export declare class AsyncItem<T extends Datas = Datas, K extends Key<T> = Key<T
     get exists(): Promise<boolean>;
     get value(): Promise<ItemValue<T[K]>>;
     get data(): Promise<ItemData<T[K]>>;
-    subscribe(next: PartialObserver<ItemValue<T[K]>> | Dispatch<[ItemValue<T[K]>]>): Unsubscribe;
     set(data: T[K]): Promise<void>;
     update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): Promise<void>;
     delete(): Promise<void>;
-    toString(): `${K}/${string}`;
 }
 /** Get the ID from item data. */
 export declare const getID: <T extends Data>({ id }: ItemData<T>) => string;

package/db/Item.js

@@ -1,9 +1,40 @@
 import { getData } from "../util/data.js";
 import { FilterConstraint } from "../constraint/FilterConstraint.js";
 import { DataUpdate } from "../update/DataUpdate.js";
+import { isTransformable } from "../util/transform.js";
+/** Reference to an item in a synchronous or asynchronous provider. */
+class BaseItem {
+    /**
+     * Subscribe to the result of this item (indefinitely).
+     * - `next()` is called once with the initial result, and again any time the result changes.
+     *
+     * @param next Observer with `next`, `error`, or `complete` methods or a `next()` dispatcher.
+     * @return Function that ends the subscription.
+     */
+    subscribe(next) {
+        return this.db.provider.subscribeItem(this.collection, this.id, typeof next === "function" ? { next } : next);
+    }
+    /** Get a set change for this item. */
+    getSet(data) {
+        return { action: "SET", collection: this.collection, id: this.id, data };
+    }
+    /** Get an update change for this item. */
+    getUpdate(updates) {
+        return { action: "UPDATE", collection: this.collection, id: this.id, update: updates instanceof DataUpdate ? updates : new DataUpdate(updates) };
+    }
+    /** Get a delete change for this item. */
+    getDelete() {
+        return { action: "DELETE", collection: this.collection, id: this.id };
+    }
+    // Implement toString()
+    toString() {
+        return `${this.collection}/${this.id}`;
+    }
+}
 /** Reference to an item in a synchronous provider. */
-export class Item {
+export class Item extends BaseItem {
     constructor(db, collection, id) {
+        super();
         this.db = db;
         this.collection = collection;
         this.id = id;
@@ -20,25 +51,20 @@ export class Item {
     get data() {
         return getData(this.value);
     }
-    subscribe(next) {
-        return this.db.provider.subscribeItem(this.collection, this.id, typeof next === "function" ? { next } : next);
-    }
     set(data) {
         return this.db.provider.setItem(this.collection, this.id, data);
     }
     update(updates) {
-        return this.db.provider.updateItem(this.collection, this.id, updates instanceof DataUpdate ? updates : new DataUpdate(updates));
+        return this.db.provider.updateItem(this.collection, this.id, isTransformable(updates) ? updates : new DataUpdate(updates));
     }
     delete() {
         return this.db.provider.deleteItem(this.collection, this.id);
     }
-    toString() {
-        return `${this.collection}/${this.id}`;
-    }
 }
 /** Reference to an item in an asynchronous provider. */
-export class AsyncItem {
+export class AsyncItem extends BaseItem {
     constructor(provider, collection, id) {
+        super();
         this.db = provider;
         this.collection = collection;
         this.id = id;
@@ -55,21 +81,15 @@ export class AsyncItem {
     get data() {
         return this.value.then(getData);
     }
-    subscribe(next) {
-        return this.db.provider.subscribeItem(this.collection, this.id, typeof next === "function" ? { next } : next);
-    }
     set(data) {
         return this.db.provider.setItem(this.collection, this.id, data);
     }
     update(updates) {
-        return this.db.provider.updateItem(this.collection, this.id, updates instanceof DataUpdate ? updates : new DataUpdate(updates));
+        return this.db.provider.updateItem(this.collection, this.id, isTransformable(updates) ? updates : new DataUpdate(updates));
     }
     delete() {
         return this.db.provider.deleteItem(this.collection, this.id);
     }
-    toString() {
-        return `${this.collection}/${this.id}`;
-    }
 }
 /** Get the ID from item data. */
 export const getID = ({ id }) => id;

package/db/Query.d.ts

@@ -9,43 +9,44 @@ import { DataUpdate, PropUpdates } from "../update/DataUpdate.js";
 import type { ItemArray, ItemValue, ItemData } from "./Item.js";
 import type { AsyncDatabase, Database } from "./Database.js";
 /** Reference to a set of items in a sync or async provider. */
-interface QueryInterface<T extends Datas = Datas, K extends Key<T> = Key<T>> extends QueryConstraints<ItemData<T[K]>>, Observable<ItemArray<T[K]>> {
-    readonly collection: K;
+declare abstract class BaseQuery<T extends Datas = Datas, K extends Key<T> = Key<T>> extends QueryConstraints<ItemData<T[K]>> implements Observable<ItemArray<T[K]>> {
+    abstract readonly db: Database<T> | AsyncDatabase<T>;
+    abstract readonly collection: K;
     /**
      * Get array of entities for this query.
      * @return Array of entities.
      */
-    value: ItemArray<T[K]> | PromiseLike<ItemArray<T[K]>>;
+    abstract value: ItemArray<T[K]> | PromiseLike<ItemArray<T[K]>>;
     /**
      * Count the number of results of this set of items.
      * @return Number of items matching the query (possibly promised).
      */
-    count: number | PromiseLike<number>;
+    abstract count: number | PromiseLike<number>;
     /**
      * Does at least one item exist for this query?
      * @return `true` if a item exists or `false` otherwise (possibly promised).
      */
-    exists: boolean | PromiseLike<boolean>;
+    abstract exists: boolean | PromiseLike<boolean>;
     /**
      * Get the first item matched by this query or `null` if this query has no results.
      * @throws RequiredError if there were no results for this query.
      */
-    firstValue: ItemValue<T[K]> | PromiseLike<ItemValue<T[K]>>;
+    abstract firstValue: ItemValue<T[K]> | PromiseLike<ItemValue<T[K]>>;
     /**
      * Get the first item matched by this query.
      * @throws RequiredError if there were no results for this query.
      */
-    firstData: ItemData<T[K]> | PromiseLike<ItemData<T[K]>>;
+    abstract firstData: ItemData<T[K]> | PromiseLike<ItemData<T[K]>>;
     /**
      * Get the last item matched by this query or `null` if this query has no results.
      * @throws RequiredError if there were no results for this query.
      */
-    lastValue: ItemValue<T[K]> | PromiseLike<ItemValue<T[K]>>;
+    abstract lastValue: ItemValue<T[K]> | PromiseLike<ItemValue<T[K]>>;
     /**
      * Get the last item matched by this query.
      * @throws RequiredError if there were no results for this query.
      */
-    lastData: ItemData<T[K]> | PromiseLike<ItemData<T[K]>>;
+    abstract lastData: ItemData<T[K]> | PromiseLike<ItemData<T[K]>>;
     /**
      * Subscribe to all matching items.
      * - `next()` is called once with the initial results, and again any time the results change.
@@ -60,22 +61,23 @@ interface QueryInterface<T extends Datas = Datas, K extends Key<T> = Key<T>> ext
      * @param data Complete data to set the item to.
      * @return Nothing (possibly promised).
      */
-    set(data: T[K]): number | PromiseLike<number>;
+    abstract set(data: T[K]): number | PromiseLike<number>;
     /**
      * Update all matching items with the same partial value.
      *
      * @param updates `Update` instance or set of updates to apply to every matching item.
      * @return Nothing (possibly promised).
      */
-    update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): number | PromiseLike<number>;
+    abstract update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): number | PromiseLike<number>;
     /**
      * Delete all matching items.
      * @return Nothing (possibly promised).
      */
-    delete(): number | PromiseLike<number>;
+    abstract delete(): number | PromiseLike<number>;
+    toString(): string;
 }
 /** Reference to a set of items in a provider. */
-export declare class Query<T extends Datas = Datas, K extends Key<T> = Key<T>> extends QueryConstraints<ItemData<T[K]>> implements QueryInterface<T, K> {
+export declare class Query<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseQuery<T, K> implements BaseQuery<T, K> {
     readonly db: Database<T>;
     readonly collection: K;
     constructor(db: Database<T>, collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null);
@@ -86,18 +88,15 @@ export declare class Query<T extends Datas = Datas, K extends Key<T> = Key<T>> e
     get firstData(): ItemData<T[K]>;
     get lastValue(): ItemValue<T[K]>;
     get lastData(): ItemData<T[K]>;
-    subscribe(next: PartialObserver<ItemArray<T[K]>> | Dispatch<[ItemArray<T[K]>]>): Unsubscribe;
     set(data: T[K]): number;
     update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): number;
     delete(): number;
-    toString(): string;
 }
 /** Reference to a set of items in a provider. */
-export declare class AsyncQuery<T extends Datas = Datas, K extends Key<T> = Key<T>> extends QueryConstraints<ItemData<T[K]>> implements QueryInterface<T, K> {
+export declare class AsyncQuery<T extends Datas = Datas, K extends Key<T> = Key<T>> extends BaseQuery<T, K> implements BaseQuery<T, K> {
     readonly db: AsyncDatabase<T>;
     readonly collection: K;
     constructor(db: AsyncDatabase<T>, collection: K, filters?: FilterList<ItemData<T[K]>>, sorts?: SortList<ItemData<T[K]>>, limit?: number | null);
-    closed?: boolean;
     get value(): Promise<ItemArray<T[K]>>;
     get count(): Promise<number>;
     get exists(): Promise<boolean>;
@@ -105,10 +104,8 @@ export declare class AsyncQuery<T extends Datas = Datas, K extends Key<T> = Key<
     get firstData(): Promise<ItemData<T[K]>>;
     get lastValue(): Promise<ItemValue<T[K]>>;
     get lastData(): Promise<ItemData<T[K]>>;
-    subscribe(next: PartialObserver<ItemArray<T[K]>> | Dispatch<[ItemArray<T[K]>]>): Unsubscribe;
     set(data: T[K]): Promise<number>;
     update(updates: DataUpdate<T[K]> | PropUpdates<T[K]>): PromiseLike<number>;
     delete(): PromiseLike<number>;
-    toString(): string;
 }
 export {};

package/db/Query.js

@@ -2,8 +2,25 @@ import { getFirstItem, getLastItem, getOptionalFirstItem, getOptionalLastItem }
 import { QueryConstraints } from "../constraint/QueryConstraints.js";
 import { countItems, hasItems } from "../util/iterate.js";
 import { DataUpdate } from "../update/DataUpdate.js";
+/** Reference to a set of items in a sync or async provider. */
+class BaseQuery extends QueryConstraints {
+    /**
+     * Subscribe to all matching items.
+     * - `next()` is called once with the initial results, and again any time the results change.
+     *
+     * @param next Observer with `next`, `error`, or `complete` methods or a `next()` dispatcher.
+     * @return Function that ends the subscription.
+     */
+    subscribe(next) {
+        return this.db.provider.subscribeQuery(this.collection, this, typeof next === "function" ? { next } : next);
+    }
+    // Override to include the collection name.
+    toString() {
+        return `${this.collection}?${super.toString()}`;
+    }
+}
 /** Reference to a set of items in a provider. */
-export class Query extends QueryConstraints {
+export class Query extends BaseQuery {
     constructor(db, collection, filters, sorts, limit) {
         super(filters, sorts, limit);
         this.db = db;
@@ -30,9 +47,6 @@ export class Query extends QueryConstraints {
     get lastData() {
         return getLastItem(this.value);
     }
-    subscribe(next) {
-        return this.db.provider.subscribeQuery(this.collection, this, typeof next === "function" ? { next } : next);
-    }
     set(data) {
         return this.db.provider.setQuery(this.collection, this, data);
     }
@@ -42,12 +56,9 @@ export class Query extends QueryConstraints {
     delete() {
         return this.db.provider.deleteQuery(this.collection, this);
     }
-    toString() {
-        return `${this.collection}?${super.toString()}`;
-    }
 }
 /** Reference to a set of items in a provider. */
-export class AsyncQuery extends QueryConstraints {
+export class AsyncQuery extends BaseQuery {
     constructor(db, collection, filters, sorts, limit) {
         super(filters, sorts, limit);
         this.db = db;
@@ -74,9 +85,6 @@ export class AsyncQuery extends QueryConstraints {
     get lastData() {
         return this.value.then(getLastItem);
     }
-    subscribe(next) {
-        return this.db.provider.subscribeQuery(this.collection, this, typeof next === "function" ? { next } : next);
-    }
     set(data) {
         return this.db.provider.setQuery(this.collection, this, data);
     }
@@ -86,7 +94,4 @@ export class AsyncQuery extends QueryConstraints {
     delete() {
         return this.db.provider.deleteQuery(this.collection, this);
     }
-    toString() {
-        return `${this.collection}?${super.toString()}`;
-    }
 }

package/db/index.d.ts

@@ -2,4 +2,4 @@ export * from "./Database.js";
 export * from "./Collection.js";
 export * from "./Item.js";
 export * from "./Query.js";
-export * from "./Changes.js";
+export * from "./Change.js";

package/db/index.js

@@ -2,4 +2,4 @@ export * from "./Database.js";
 export * from "./Collection.js";
 export * from "./Item.js";
 export * from "./Query.js";
-export * from "./Changes.js";
+export * from "./Change.js";

package/package.json

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

package/util/index.d.ts

@@ -28,6 +28,7 @@ export * from "./random.js";
 export * from "./regexp.js";
 export * from "./serialise.js";
 export * from "./sort.js";
+export * from "./source.js";
 export * from "./string.js";
 export * from "./template.js";
 export * from "./timeout.js";

package/util/index.js

@@ -28,6 +28,7 @@ export * from "./random.js";
 export * from "./regexp.js";
 export * from "./serialise.js";
 export * from "./sort.js";
+export * from "./source.js";
 export * from "./string.js";
 export * from "./template.js";
 export * from "./timeout.js";

package/util/transform.d.ts

@@ -6,7 +6,7 @@ import type { ArrayType, ImmutableArray } from "./array.js";
 export interface Transformable<I, O> {
     transform(input: I): O;
 }
-/** Is an unknown value a derivable. */
+/** Is an unknown value a transformable. */
 export declare const isTransformable: <T extends Transformable<unknown, unknown>>(v: unknown) => v is T;
 /** Function that can transform an input value into an output value. */
 export declare type Transform<I, O> = (input: I) => O;

package/util/transform.js

@@ -1,7 +1,7 @@
 import { isFunction } from "./function.js";
 import { getProps, isData } from "./data.js";
 import { getEntries } from "./entry.js";
-/** Is an unknown value a derivable. */
+/** Is an unknown value a transformable. */
 export const isTransformable = (v) => isData(v) && typeof v.transform === "function";
 export function transform(input, transformer) {
     return isFunction(transformer) ? transformer(input) : isTransformable(transformer) ? transformer.transform(input) : transformer;

package/db/Changes.d.ts

@@ -1,22 +0,0 @@
-import type { Datas, Key } from "../util/data.js";
-import { DataUpdate } from "../update/DataUpdate.js";
-import type { Provider, AsyncProvider } from "../provider/Provider.js";
-import type { Database, AsyncDatabase } from "./Database.js";
-/**
- * Change set of operations to run against a database in `{ "collection/id": data | DataUpdate | null }`  format.
- * - If data is an object, sets the item.
- * - If data is a `DataUpdate` instance, updates the item.
- * - If data is null, deletes the item.
- * - If data is undefined, skip the item.
- */
-export declare type Changes<DB extends Datas> = {
-    [K in Key<DB> as `${K}/${string}`]: DB[K] | DataUpdate<DB[K]> | null | undefined;
-};
-/** Apply a set of changes to a synchronous database. */
-export declare function changeDatabase<T extends Datas>({ provider }: Database<T>, changes: Changes<T>): Changes<T>;
-/** Apply a set of changes to an asynchronous database. */
-export declare function changeAsyncDatabase<T extends Datas>({ provider }: AsyncDatabase<T>, changes: Changes<T>): Promise<Changes<T>>;
-/** Apply a set of changes to a synchronous provider. */
-export declare function changeProvider<T extends Datas>(provider: Provider<T>, changes: Changes<T>): Changes<T>;
-/** Apply a set of changes to an asynchronous provider. */
-export declare function changeAsyncProvider<T extends Datas>(provider: AsyncProvider<T>, changes: Changes<T>): Promise<Changes<T>>;

package/db/Changes.js

@@ -1,40 +0,0 @@
-import { splitString } from "../util/string.js";
-import { DataUpdate } from "../update/DataUpdate.js";
-/** Apply a set of changes to a synchronous database. */
-export function changeDatabase({ provider }, changes) {
-    return changeProvider(provider, changes);
-}
-/** Apply a set of changes to an asynchronous database. */
-export function changeAsyncDatabase({ provider }, changes) {
-    return changeAsyncProvider(provider, changes);
-}
-/** Apply a set of changes to a synchronous provider. */
-export function changeProvider(provider, changes) {
-    for (const [key, change] of Object.entries(changes)) {
-        const [collection, id] = splitString(key, "/", 2);
-        if (change === undefined)
-            continue;
-        else if (change === null)
-            provider.deleteItem(collection, id);
-        else if (change instanceof DataUpdate)
-            provider.updateItem(collection, id, change);
-        else
-            provider.setItem(collection, id, change);
-    }
-    return changes;
-}
-/** Apply a set of changes to an asynchronous provider. */
-export async function changeAsyncProvider(provider, changes) {
-    for (const [key, change] of Object.entries(changes)) {
-        const [collection, id] = splitString(key, "/", 2);
-        if (change === undefined)
-            continue;
-        else if (change === null)
-            await provider.deleteItem(collection, id);
-        else if (change instanceof DataUpdate)
-            await provider.updateItem(collection, id, change);
-        else
-            await provider.setItem(collection, id, change);
-    }
-    return changes;
-}

package/db/Changes.test.d.ts

@@ -1 +0,0 @@
-export {};

package/db/Changes.test.js

@@ -1,11 +0,0 @@
-import { DataUpdate } from "../index.js";
-test("Typescript", () => {
-    const operations = {
-        "collection1/a1": { a: 1, one: false },
-        "collection1/b2": null,
-        "collection1/b3": new DataUpdate({ one: true }),
-        "collection2/a1": { b: 1, one: false },
-        "collection2/b2": null,
-        "collection2/c3": new DataUpdate({ one: true }),
-    };
-});