shelving 1.36.0 → 1.40.0

package/api/Resource.js

@@ -1,4 +1,4 @@
-import { GET_UNDEFINED, validate } from "../util/index.js";
+import { UNDEFINED, validate } from "../util/index.js";
 import { Feedback } from "../feedback/index.js";
 import { ResourceValidationError } from "./errors.js";
 /**
@@ -37,6 +37,6 @@ export class Resource {
         }
     }
 }
-export function RESOURCE(payload = GET_UNDEFINED, result = GET_UNDEFINED) {
+export function RESOURCE(payload = UNDEFINED, result = UNDEFINED) {
     return new Resource(payload, result);
 }

package/db/Database.d.ts

@@ -1,4 +1,4 @@
-import { Entry, Observable, Observer, Result, Unsubscriber, ResultsMap, Validatable, Validator, Key, Data, Results, Datas, Validators, ValidatorType, Dispatcher, Nullish } from "../util/index.js";
+import { Entry, Observable, Observer, Result, Unsubscriber, Results, Validatable, Validator, Key, Data, Entries, Datas, Validators, ValidatorType, Dispatcher, Nullish } from "../util/index.js";
 import { PropUpdates, Update } from "../update/index.js";
 import type { Provider } from "../provider/Provider.js";
 import { Filters, Sorts, Query } from "../query/index.js";
@@ -15,22 +15,22 @@ export declare class Database<V extends Validators<Datas> = Validators<Datas>> {
     readonly provider: Provider;
     constructor(validators: V, provider: Provider);
     /** Create a query on a collection in this model. */
-    query<K extends Key<V>>(collection: K, filters?: Filters<ValidatorType<V[K]>>, sorts?: Sorts<ValidatorType<V[K]>>, limit?: number | null): DataQuery<ValidatorType<V[K]>>;
+    query<K extends Key<V>>(collection: K, filters?: Filters<ValidatorType<V[K]>>, sorts?: Sorts<ValidatorType<V[K]>>, limit?: number | null): DatabaseQuery<ValidatorType<V[K]>>;
     /** Reference a document in a collection in this model. */
-    doc<K extends Key<V>>(collection: K, id: string): DataDocument<ValidatorType<V[K]>>;
+    doc<K extends Key<V>>(collection: K, id: string): DatabaseDocument<ValidatorType<V[K]>>;
     /** Create a writer for this database from a set of separate writes. */
     writer(...writes: Nullish<Write>[]): Write;
     /** Perform one or more writes on this database and return the `Writes` instance representing the combined changes. */
     write(...writes: Nullish<Write>[]): Promise<Write>;
 }
 /** A documents reference within a specific database. */
-export declare class DataQuery<T extends Data = Data> extends Query<T> implements Observable<Results<T>>, Validatable<Results<T>>, Iterable<Entry<T>> {
+export declare class DatabaseQuery<T extends Data = Data> extends Query<T> implements Observable<Results<T>>, Validatable<Entries<T>>, Iterable<Entry<T>> {
     readonly provider: Provider;
     readonly validator: Validator<T>;
     readonly collection: string;
     constructor(provider: Provider, validator: Validator<T>, collection: string, filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null);
     /** Reference a document in this query's collection. */
-    doc(id: string): DataDocument<T>;
+    doc(id: string): DatabaseDocument<T>;
     /**
      * Create a new document with a random ID.
      * - Created document is guaranteed to have a unique ID.
@@ -43,17 +43,22 @@ export declare class DataQuery<T extends Data = Data> extends Query<T> implement
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
-    get results(): Results<T> | PromiseLike<Results<T>>;
+    get entries(): Entries<T> | PromiseLike<Entries<T>>;
     /**
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
-    get resultsMap(): ResultsMap<T> | PromiseLike<ResultsMap<T>>;
+    get results(): Results<T> | PromiseLike<Results<T>>;
     /**
      * Count the number of results of this set of documents.
-     * @return Number of documents in the collection (possibly promised).
+     * @return Number of documents matching the query (possibly promised).
      */
     get count(): number | PromiseLike<number>;
+    /**
+     * Does at least one document exist for this query?
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
+     */
+    get exists(): boolean | PromiseLike<boolean>;
     /**
      * Get an entry for the first document matched by this query or `undefined` if this query has no results.
      *
@@ -76,14 +81,6 @@ export declare class DataQuery<T extends Data = Data> extends Query<T> implement
      * @return Function that ends the subscription.
      */
     subscribe(next: Observer<Results<T>> | Dispatcher<[Results<T>]>): Unsubscriber;
-    /**
-     * Subscribe to all matching documents.
-     * - `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.
-     */
-    subscribeMap(next: Observer<ResultsMap<T>> | Dispatcher<[ResultsMap<T>]>): Unsubscriber;
     /**
      * Set all matching documents to the same exact value.
      *
@@ -106,31 +103,29 @@ export declare class DataQuery<T extends Data = Data> extends Query<T> implement
     /** Iterate over the resuls (will throw `Promise` if the results are asynchronous). */
     [Symbol.iterator](): Iterator<Entry<T>, void>;
     /** Validate a set of results for this query reference. */
-    validate(unsafeEntries: Results): Results<T>;
+    validate(unsafeEntries: Entries): Entries<T>;
     toString(): string;
 }
 /** Get the data for a document from a result for that document. */
-export declare function getQueryData<T extends Data>(results: Results<T>, ref: DataQuery<T>): Entry<T>;
+export declare function getQueryData<T extends Data>(entries: Entries<T>, ref: DatabaseQuery<T>): Entry<T>;
 /** A document reference within a specific database. */
-export declare class DataDocument<T extends Data = Data> implements Observable<Result<T>>, Validatable<T> {
+export declare class DatabaseDocument<T extends Data = Data> implements Observable<Result<T>>, Validatable<T> {
     readonly provider: Provider;
     readonly validator: Validator<T>;
     readonly collection: string;
     readonly id: string;
     constructor(provider: Provider, validator: Validator<T>, collection: string, id: string);
     /** Create a query on this document's collection. */
-    query(filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null): DataQuery<T>;
+    query(filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null): DatabaseQuery<T>;
     /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
-    get optional(): DataQuery<T>;
+    get optional(): DatabaseQuery<T>;
     /**
      * Does this document exist?
-     *
-     * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
      */
     get exists(): boolean | PromiseLike<boolean>;
     /**
      * Get the result of this document.
-     *
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
     get result(): Result<T> | PromiseLike<Result<T>>;
@@ -159,7 +154,7 @@ export declare class DataDocument<T extends Data = Data> implements Observable<R
     /** Represent a write that sets the complete data of this document in a database. */
     setter(data: T): DocumentSet<T>;
     /** Represent a write that updates this document in a database. */
-    updater(updates: Update<T> | PropUpdates<T>): DocumentUpdate<T>;
+    updater(updates: PropUpdates<T>): DocumentUpdate<T>;
     /** Represent a write that deletes this document in a database. */
     deleter(): DocumentDelete<T>;
     /** Validate data for this query reference. */
@@ -167,4 +162,4 @@ export declare class DataDocument<T extends Data = Data> implements Observable<R
     toString(): string;
 }
 /** Get the data for a document from a result for that document. */
-export declare function getDocumentData<T extends Data>(result: Result<T>, ref: DataDocument<T>): T;
+export declare function getDocumentData<T extends Data>(result: Result<T>, ref: DatabaseDocument<T>): T;

package/db/Database.js

@@ -1,4 +1,4 @@
-import { callAsync, getFirstItem, throwAsync, validate, toMap, countItems, TransformObserver, NOT_NULLISH, } from "../util/index.js";
+import { callAsync, getFirstItem, throwAsync, validate, getMap, countItems, isNotNullish, hasItems, ResultsObserver, } from "../util/index.js";
 import { DataUpdate, Update } from "../update/index.js";
 import { Feedback, InvalidFeedback } from "../feedback/index.js";
 import { Filters, Query, EqualFilter } from "../query/index.js";
@@ -19,25 +19,25 @@ export class Database {
     }
     /** Create a query on a collection in this model. */
     query(collection, filters, sorts, limit) {
-        return new DataQuery(this.provider, this.validators[collection], collection, filters, sorts, limit);
+        return new DatabaseQuery(this.provider, this.validators[collection], collection, filters, sorts, limit);
     }
     /** Reference a document in a collection in this model. */
     doc(collection, id) {
-        return new DataDocument(this.provider, this.validators[collection], collection, id);
+        return new DatabaseDocument(this.provider, this.validators[collection], collection, id);
     }
     /** Create a writer for this database from a set of separate writes. */
     writer(...writes) {
-        return new Writes(...writes.filter(NOT_NULLISH));
+        return new Writes(...writes.filter(isNotNullish));
     }
     /** Perform one or more writes on this database and return the `Writes` instance representing the combined changes. */
     async write(...writes) {
-        const write = new Writes(...writes.filter(NOT_NULLISH));
+        const write = new Writes(...writes.filter(isNotNullish));
         await write.transform(this);
         return write;
     }
 }
 /** A documents reference within a specific database. */
-export class DataQuery extends Query {
+export class DatabaseQuery extends Query {
     constructor(provider, validator, collection, filters, sorts, limit) {
         super(filters, sorts, limit);
         this.provider = provider;
@@ -46,7 +46,7 @@ export class DataQuery extends Query {
     }
     /** Reference a document in this query's collection. */
     doc(id) {
-        return new DataDocument(this.provider, this.validator, this.collection, id);
+        return new DatabaseDocument(this.provider, this.validator, this.collection, id);
     }
     /**
      * Create a new document with a random ID.
@@ -62,22 +62,29 @@ export class DataQuery extends Query {
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
-    get results() {
+    get entries() {
         return this.provider.getQuery(this);
     }
     /**
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
-    get resultsMap() {
-        return callAsync(toMap, this.provider.getQuery(this));
+    get results() {
+        return callAsync(getMap, this.provider.getQuery(this));
     }
     /**
      * Count the number of results of this set of documents.
-     * @return Number of documents in the collection (possibly promised).
+     * @return Number of documents matching the query (possibly promised).
      */
     get count() {
-        return callAsync(countItems, this.results);
+        return callAsync(countItems, this.entries);
+    }
+    /**
+     * Does at least one document exist for this query?
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
+     */
+    get exists() {
+        return callAsync(hasItems, this.provider.getQuery(this.max(1)));
     }
     /**
      * Get an entry for the first document matched by this query or `undefined` if this query has no results.
@@ -86,7 +93,7 @@ export class DataQuery extends Query {
      * @throws RequiredError if there were no results for this query.
      */
     get result() {
-        return callAsync(getFirstItem, this.max(1).results);
+        return callAsync(getFirstItem, this.provider.getQuery(this.max(1)));
     }
     /**
      * Get an entry for the first document matched by this query.
@@ -95,7 +102,7 @@ export class DataQuery extends Query {
      * @throws RequiredError if there were no results for this query.
      */
     get data() {
-        return callAsync(getQueryData, this.max(1).results, this);
+        return callAsync(getQueryData, this.provider.getQuery(this.max(1)), this);
     }
     /**
      * Subscribe to all matching documents.
@@ -105,17 +112,7 @@ export class DataQuery extends Query {
      * @return Function that ends the subscription.
      */
     subscribe(next) {
-        return this.provider.subscribeQuery(this, typeof next === "function" ? { next } : next);
-    }
-    /**
-     * Subscribe to all matching documents.
-     * - `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.
-     */
-    subscribeMap(next) {
-        return this.provider.subscribeQuery(this, new TransformObserver(toMap, typeof next === "function" ? { next } : next));
+        return this.provider.subscribeQuery(this, new ResultsObserver(typeof next === "function" ? { next } : next));
     }
     /**
      * Set all matching documents to the same exact value.
@@ -144,7 +141,7 @@ export class DataQuery extends Query {
     }
     /** Iterate over the resuls (will throw `Promise` if the results are asynchronous). */
     [Symbol.iterator]() {
-        return throwAsync(this.results)[Symbol.iterator]();
+        return throwAsync(this.entries)[Symbol.iterator]();
     }
     /** Validate a set of results for this query reference. */
     *validate(unsafeEntries) {
@@ -170,14 +167,14 @@ export class DataQuery extends Query {
     }
 }
 /** Get the data for a document from a result for that document. */
-export function getQueryData(results, ref) {
-    const first = getFirstItem(results);
+export function getQueryData(entries, ref) {
+    const first = getFirstItem(entries);
     if (first)
         return first;
     throw new QueryRequiredError(ref);
 }
 /** A document reference within a specific database. */
-export class DataDocument {
+export class DatabaseDocument {
     constructor(provider, validator, collection, id) {
         this.provider = provider;
         this.validator = validator;
@@ -186,23 +183,21 @@ export class DataDocument {
     }
     /** Create a query on this document's collection. */
     query(filters, sorts, limit) {
-        return new DataQuery(this.provider, this.validator, this.collection, filters, sorts, limit);
+        return new DatabaseQuery(this.provider, this.validator, this.collection, filters, sorts, limit);
     }
     /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
     get optional() {
-        return new DataQuery(this.provider, this.validator, this.collection, new Filters(new EqualFilter("id", this.id)));
+        return new DatabaseQuery(this.provider, this.validator, this.collection, new Filters(new EqualFilter("id", this.id)));
     }
     /**
      * Does this document exist?
-     *
-     * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
+     * @return `true` if a document exists or `false` otherwise (possibly promised).
      */
     get exists() {
         return callAsync(Boolean, this.provider.get(this));
     }
     /**
      * Get the result of this document.
-     *
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
     get result() {

package/db/Pagination.d.ts

@@ -1,16 +1,16 @@
-import { ResultsMap, Entry, Results, Data } from "../util/index.js";
+import { Results, Entry, Entries, Data } from "../util/index.js";
 import { State } from "../stream/index.js";
-import { DataQuery } from "./Database.js";
+import { DatabaseQuery } from "./Database.js";
 /**
  * State that wraps a `Documents` reference to enable pagination.
  * - If you pass in initial values, it will use that as the first page.
  * - If you don't pass in initial values, it will autoload the first page.
  */
-export declare class Pagination<T extends Data> extends State<ResultsMap<T>> implements Iterable<Entry<T>> {
+export declare class Pagination<T extends Data> extends State<Results<T>> implements Iterable<Entry<T>> {
     protected _pending: boolean;
-    readonly ref: DataQuery<T>;
+    readonly ref: DatabaseQuery<T>;
     readonly limit: number;
-    constructor(ref: DataQuery<T>);
+    constructor(ref: DatabaseQuery<T>);
     /**
      * Load more results after the end.
      * - Promise that needs to be handled.
@@ -20,7 +20,7 @@ export declare class Pagination<T extends Data> extends State<ResultsMap<T>> imp
      * Merge more results into this pagination.
      * @return The change in the number of results.
      */
-    merge(more: Results<T>): void;
+    merge(more: Entries<T>): void;
     /** Iterate over the entries of the values currently in the pagination. */
     [Symbol.iterator](): Iterator<Entry<T>>;
 }

package/db/Pagination.js

@@ -1,4 +1,4 @@
-import { getLastItem, assertNumber, yieldMerged, toMap, LOADING, assertMaximum } from "../util/index.js";
+import { getLastItem, assertNumber, yieldMerged, getMap, LOADING, assertMax } from "../util/index.js";
 import { State } from "../stream/index.js";
 import { ConditionError } from "../index.js";
 /**
@@ -22,7 +22,7 @@ export class Pagination extends State {
                 if (!this.loading) {
                     const lastItem = getLastItem(this.value);
                     if (lastItem) {
-                        const next = await this.ref.after(lastItem[0], lastItem[1]).resultsMap;
+                        const next = await this.ref.after(lastItem[0], lastItem[1]).results;
                         this.merge(next);
                         if (next.size < this.limit)
                             this.complete();
@@ -31,7 +31,7 @@ export class Pagination extends State {
                     }
                 }
                 this._value === LOADING;
-                const next = await this.ref.resultsMap;
+                const next = await this.ref.results;
                 this.next(next);
                 if (next.size < this.limit)
                     this.complete();
@@ -40,7 +40,7 @@ export class Pagination extends State {
         };
         this.ref = ref;
         assertNumber(ref.limit); // Collection must have a numeric limit to paginate (otherwise you'd be retrieving the entire set of documents).
-        assertMaximum(ref.sorts.size, 1); // Collection must have at least one sort order to paginate.
+        assertMax(ref.sorts.size, 1); // Collection must have at least one sort order to paginate.
         this.limit = ref.limit;
     }
     /**
@@ -48,7 +48,7 @@ export class Pagination extends State {
      * @return The change in the number of results.
      */
     merge(more) {
-        this.next(toMap(this.ref.sorts.transform(yieldMerged(more, this.value))));
+        this.next(getMap(this.ref.sorts.transform(yieldMerged(more, this.value))));
     }
     /** Iterate over the entries of the values currently in the pagination. */
     [Symbol.iterator]() {

package/db/Write.d.ts

@@ -1,6 +1,6 @@
 import { PropUpdates, Update } from "../update/index.js";
-import { ImmutableArray, Data, Transformable } from "../util/index.js";
-import type { Database, DataDocument } from "./Database.js";
+import { ImmutableArray, Data, Transformable, Key, Nullish } from "../util/index.js";
+import type { Database, DatabaseDocument } from "./Database.js";
 /** Represent a write made to a database. */
 export declare abstract class Write implements Transformable<Database, void | PromiseLike<void>> {
     abstract transform(db: Database): void | PromiseLike<void>;
@@ -19,19 +19,23 @@ export declare class Writes extends Write {
 export declare abstract class DocumentWrite<T extends Data> extends Write {
     readonly collection: string;
     readonly id: string;
-    constructor({ collection, id }: DataDocument<T>);
+    constructor({ collection, id }: DatabaseDocument<T>);
 }
 /** Represent a set operation made to a single document in a database. */
 export declare class DocumentSet<T extends Data> extends DocumentWrite<T> {
     readonly data: T;
-    constructor(ref: DataDocument<T>, data: T);
+    constructor(ref: DatabaseDocument<T>, data: T);
     transform(db: Database): Promise<void>;
+    /** Set one of the props on this set operation to a different value. */
+    set<K extends Key<T>>(key: Nullish<K>, value: T[K]): this;
 }
 /** Represent an update operation made to a single document in a database. */
 export declare class DocumentUpdate<T extends Data> extends DocumentWrite<T> {
-    readonly updates: Update<T>;
-    constructor(ref: DataDocument<T>, updates: Update<T> | PropUpdates<T>);
+    readonly updates: PropUpdates<T>;
+    constructor(ref: DatabaseDocument<T>, updates: PropUpdates<T>);
     transform(db: Database): Promise<void>;
+    /** update one of the props on this set operation to a different value. */
+    update<K extends Key<T>>(key: Nullish<K>, value: T[K] | Update<T[K]>): this;
 }
 /** Represent a delete operation made to a single document in a database. */
 export declare class DocumentDelete<T extends Data> extends DocumentWrite<T> {

package/db/Write.js

@@ -1,5 +1,4 @@
-import { DataUpdate, Update } from "../update/index.js";
-import { transform } from "../util/index.js";
+import { transform, isNullish } from "../util/index.js";
 /** Represent a write made to a database. */
 export class Write {
 }
@@ -35,16 +34,28 @@ export class DocumentSet extends DocumentWrite {
     async transform(db) {
         await db.doc(this.collection, this.id).set(this.data);
     }
+    /** Set one of the props on this set operation to a different value. */
+    set(key, value) {
+        if (isNullish(key))
+            return this;
+        return { __proto__: Object.getPrototypeOf(this), ...this, data: { ...this.data, [key]: value } };
+    }
 }
 /** Represent an update operation made to a single document in a database. */
 export class DocumentUpdate extends DocumentWrite {
     constructor(ref, updates) {
         super(ref);
-        this.updates = updates instanceof Update ? updates : new DataUpdate(updates);
+        this.updates = updates;
     }
     async transform(db) {
         await db.doc(this.collection, this.id).update(this.updates);
     }
+    /** update one of the props on this set operation to a different value. */
+    update(key, value) {
+        if (isNullish(key))
+            return this;
+        return { __proto__: Object.getPrototypeOf(this), ...this, updates: { ...this.updates, [key]: value } };
+    }
 }
 /** Represent a delete operation made to a single document in a database. */
 export class DocumentDelete extends DocumentWrite {

package/db/errors.d.ts

@@ -1,24 +1,24 @@
 import type { Data } from "../util/index.js";
 import { RequiredError, ValidationError } from "../error/index.js";
 import type { Feedback } from "../feedback/index.js";
-import type { DataDocument, DataQuery } from "./Database.js";
+import type { DatabaseDocument, DatabaseQuery } from "./Database.js";
 /** Thrown if a document doesn't exist. */
 export declare class DocumentRequiredError<T extends Data> extends RequiredError {
-    ref: DataDocument<T>;
-    constructor(ref: DataDocument<T>);
+    ref: DatabaseDocument<T>;
+    constructor(ref: DatabaseDocument<T>);
 }
 /** Thrown if a query doesn't exist. */
 export declare class QueryRequiredError<T extends Data> extends RequiredError {
-    ref: DataQuery<T>;
-    constructor(ref: DataQuery<T>);
+    ref: DatabaseQuery<T>;
+    constructor(ref: DatabaseQuery<T>);
 }
 /** Thrown if a document can't validate. */
 export declare class DocumentValidationError<T extends Data> extends ValidationError {
-    ref: DataDocument<T>;
-    constructor(ref: DataDocument<T>, feedback: Feedback);
+    ref: DatabaseDocument<T>;
+    constructor(ref: DatabaseDocument<T>, feedback: Feedback);
 }
 /** Thrown if a query can't validate a set of results. */
 export declare class QueryValidationError<T extends Data> extends ValidationError {
-    ref: DataQuery<T>;
-    constructor(ref: DataQuery<T>, feedback: Feedback);
+    ref: DatabaseQuery<T>;
+    constructor(ref: DatabaseQuery<T>, feedback: Feedback);
 }

package/firestore/client/FirestoreClientProvider.d.ts

@@ -1,5 +1,5 @@
 import type { Firestore } from "firebase/firestore";
-import { Results, Provider, DataDocument, DataQuery, Result, Observer, Update, AsynchronousProvider, Data, Unsubscriber } from "../../index.js";
+import { Entries, Provider, DatabaseDocument, DatabaseQuery, Result, Observer, Update, AsynchronousProvider, Data, Unsubscriber } from "../../index.js";
 /**
  * Firestore client database provider.
  * - Works with the Firebase JS SDK.
@@ -9,15 +9,15 @@ import { Results, Provider, DataDocument, DataQuery, Result, Observer, Update, A
 export declare class FirestoreClientProvider extends Provider implements AsynchronousProvider {
     readonly firestore: Firestore;
     constructor(firestore: Firestore);
-    get<T extends Data>(ref: DataDocument<T>): Promise<Result<T>>;
-    subscribe<T extends Data>(ref: DataDocument<T>, observer: Observer<Result<T>>): Unsubscriber;
-    add<T extends Data>(ref: DataQuery<T>, data: T): Promise<string>;
-    set<T extends Data>(ref: DataDocument<T>, data: T): Promise<void>;
-    update<T extends Data>(ref: DataDocument<T>, updates: Update<T>): Promise<void>;
-    delete<T extends Data>(ref: DataDocument<T>): Promise<void>;
-    getQuery<T extends Data>(ref: DataQuery<T>): Promise<Results<T>>;
-    subscribeQuery<T extends Data>(ref: DataQuery<T>, observer: Observer<Results<T>>): Unsubscriber;
-    setQuery<T extends Data>(ref: DataQuery<T>, data: T): Promise<number>;
-    updateQuery<T extends Data>(ref: DataQuery<T>, updates: Update<T>): Promise<number>;
-    deleteQuery<T extends Data>(ref: DataQuery<T>): Promise<number>;
+    get<T extends Data>(ref: DatabaseDocument<T>): Promise<Result<T>>;
+    subscribe<T extends Data>(ref: DatabaseDocument<T>, observer: Observer<Result<T>>): Unsubscriber;
+    add<T extends Data>(ref: DatabaseQuery<T>, data: T): Promise<string>;
+    set<T extends Data>(ref: DatabaseDocument<T>, data: T): Promise<void>;
+    update<T extends Data>(ref: DatabaseDocument<T>, updates: Update<T>): Promise<void>;
+    delete<T extends Data>(ref: DatabaseDocument<T>): Promise<void>;
+    getQuery<T extends Data>(ref: DatabaseQuery<T>): Promise<Entries<T>>;
+    subscribeQuery<T extends Data>(ref: DatabaseQuery<T>, observer: Observer<Entries<T>>): Unsubscriber;
+    setQuery<T extends Data>(ref: DatabaseQuery<T>, data: T): Promise<number>;
+    updateQuery<T extends Data>(ref: DatabaseQuery<T>, updates: Update<T>): Promise<number>;
+    deleteQuery<T extends Data>(ref: DatabaseQuery<T>): Promise<number>;
 }

package/firestore/lite/FirestoreLiteProvider.d.ts

@@ -1,5 +1,5 @@
 import type { Firestore } from "firebase/firestore/lite";
-import { Provider, DataDocument, DataQuery, Result, Update, AsynchronousProvider, Data, Results, Unsubscriber } from "../../index.js";
+import { Provider, DatabaseDocument, DatabaseQuery, Result, Update, AsynchronousProvider, Data, Entries, Unsubscriber } from "../../index.js";
 /**
  * Firestore Lite client database provider.
  * - Works with the Firebase JS SDK.
@@ -9,15 +9,15 @@ import { Provider, DataDocument, DataQuery, Result, Update, AsynchronousProvider
 export declare class FirestoreClientProvider extends Provider implements AsynchronousProvider {
     readonly firestore: Firestore;
     constructor(firestore: Firestore);
-    get<T extends Data>(ref: DataDocument<T>): Promise<Result<T>>;
+    get<T extends Data>(ref: DatabaseDocument<T>): Promise<Result<T>>;
     subscribe(): Unsubscriber;
-    add<T extends Data>(ref: DataQuery<T>, data: T): Promise<string>;
-    set<T extends Data>(ref: DataDocument<T>, data: T): Promise<void>;
-    update<T extends Data>(ref: DataDocument<T>, updates: Update<T>): Promise<void>;
-    delete<T extends Data>(ref: DataDocument<T>): Promise<void>;
-    getQuery<T extends Data>(ref: DataQuery<T>): Promise<Results<T>>;
+    add<T extends Data>(ref: DatabaseQuery<T>, data: T): Promise<string>;
+    set<T extends Data>(ref: DatabaseDocument<T>, data: T): Promise<void>;
+    update<T extends Data>(ref: DatabaseDocument<T>, updates: Update<T>): Promise<void>;
+    delete<T extends Data>(ref: DatabaseDocument<T>): Promise<void>;
+    getQuery<T extends Data>(ref: DatabaseQuery<T>): Promise<Entries<T>>;
     subscribeQuery(): Unsubscriber;
-    setQuery<T extends Data>(ref: DataQuery<T>, data: T | Update<T> | undefined): Promise<number>;
-    updateQuery<T extends Data>(ref: DataQuery<T>, updates: Update<T>): Promise<number>;
-    deleteQuery<T extends Data>(ref: DataQuery<T>): Promise<number>;
+    setQuery<T extends Data>(ref: DatabaseQuery<T>, data: T | Update<T> | undefined): Promise<number>;
+    updateQuery<T extends Data>(ref: DatabaseQuery<T>, updates: Update<T>): Promise<number>;
+    deleteQuery<T extends Data>(ref: DatabaseQuery<T>): Promise<number>;
 }

package/firestore/server/FirestoreServerProvider.d.ts

@@ -1,5 +1,5 @@
 import { Firestore } from "@google-cloud/firestore";
-import { Provider, DataDocument, DataQuery, Observer, Result, Update, Data, AsynchronousProvider, Entry, Results, Unsubscriber } from "../../index.js";
+import { Provider, DatabaseDocument, DatabaseQuery, Observer, Result, Update, Data, AsynchronousProvider, Entry, Entries, Unsubscriber } from "../../index.js";
 /**
  * Firestore server database provider.
  * - Works with the Firebase Admin SDK for Node.JS
@@ -7,15 +7,15 @@ import { Provider, DataDocument, DataQuery, Observer, Result, Update, Data, Asyn
 export declare class FirestoreServerProvider extends Provider implements AsynchronousProvider {
     readonly firestore: Firestore;
     constructor(firestore?: Firestore);
-    get<T extends Data>(ref: DataDocument<T>): Promise<Result<T>>;
-    subscribe<T extends Data>(ref: DataDocument<T>, observer: Observer<Result<T>>): Unsubscriber;
-    add<T extends Data>(ref: DataQuery<T>, data: T): Promise<string>;
-    set<T extends Data>(ref: DataDocument<T>, data: T): Promise<void>;
-    update<T extends Data>(ref: DataDocument<T>, updates: Update<T>): Promise<void>;
-    delete<T extends Data>(ref: DataDocument<T>): Promise<void>;
-    getQuery<T extends Data>(ref: DataQuery<T>): Promise<Iterable<Entry<T>>>;
-    subscribeQuery<T extends Data>(ref: DataQuery<T>, observer: Observer<Results<T>>): Unsubscriber;
-    setQuery<T extends Data>(ref: DataQuery<T>, data: T | Update<T> | undefined): Promise<number>;
-    updateQuery<T extends Data>(ref: DataQuery<T>, updates: Update<T>): Promise<number>;
-    deleteQuery<T extends Data>(ref: DataQuery<T>): Promise<number>;
+    get<T extends Data>(ref: DatabaseDocument<T>): Promise<Result<T>>;
+    subscribe<T extends Data>(ref: DatabaseDocument<T>, observer: Observer<Result<T>>): Unsubscriber;
+    add<T extends Data>(ref: DatabaseQuery<T>, data: T): Promise<string>;
+    set<T extends Data>(ref: DatabaseDocument<T>, data: T): Promise<void>;
+    update<T extends Data>(ref: DatabaseDocument<T>, updates: Update<T>): Promise<void>;
+    delete<T extends Data>(ref: DatabaseDocument<T>): Promise<void>;
+    getQuery<T extends Data>(ref: DatabaseQuery<T>): Promise<Iterable<Entry<T>>>;
+    subscribeQuery<T extends Data>(ref: DatabaseQuery<T>, observer: Observer<Entries<T>>): Unsubscriber;
+    setQuery<T extends Data>(ref: DatabaseQuery<T>, data: T | Update<T> | undefined): Promise<number>;
+    updateQuery<T extends Data>(ref: DatabaseQuery<T>, updates: Update<T>): Promise<number>;
+    deleteQuery<T extends Data>(ref: DatabaseQuery<T>): Promise<number>;
 }

package/package.json

@@ -11,7 +11,7 @@
 		"state-management",
 		"query-builder"
 	],
-	"version": "1.36.0",
+	"version": "1.40.0",
 	"repository": "https://github.com/dhoulb/shelving",
 	"author": "Dave Houlbrooke <dave@shax.com>",
 	"license": "0BSD",
@@ -60,12 +60,12 @@
 	},
 	"devDependencies": {
 		"@google-cloud/firestore": "^4.15.1",
-		"@types/jest": "^27.0.3",
-		"@types/react": "^17.0.37",
+		"@types/jest": "^27.4.0",
+		"@types/react": "^17.0.38",
 		"@types/react-dom": "^17.0.11",
-		"@typescript-eslint/eslint-plugin": "^5.7.0",
-		"@typescript-eslint/parser": "^5.7.0",
-		"eslint": "^8.5.0",
+		"@typescript-eslint/eslint-plugin": "^5.8.1",
+		"@typescript-eslint/parser": "^5.8.1",
+		"eslint": "^8.6.0",
 		"eslint-config-prettier": "^8.3.0",
 		"eslint-plugin-import": "^2.25.3",
 		"eslint-plugin-prettier": "^4.0.0",