shelving 1.63.0 → 1.65.0

package/api/Resource.js

@@ -1,7 +1,7 @@
 import { validate } from "../util/validate.js";
 import { getUndefined } from "../util/undefined.js";
 import { Feedback } from "../feedback/Feedback.js";
-import { ResourceValidationError } from "./errors.js";
+import { ValidationError } from "../error/ValidationError.js";
 /**
  * An abstract API resource definition, used to specify types for e.g. serverless functions..
  *
@@ -34,7 +34,7 @@ export class Resource {
             return validate(unsafeResult, this.result);
         }
         catch (thrown) {
-            throw thrown instanceof Feedback ? new ResourceValidationError(this, thrown) : thrown;
+            throw thrown instanceof Feedback ? new ValidationError(`Invalid result for resource`, thrown) : thrown;
         }
     }
 }

package/db/Database.d.ts

@@ -3,6 +3,7 @@ import type { Key, Datas } from "../util/data.js";
 import type { Provider } from "../provider/Provider.js";
 import type { SortKeys } from "../query/Sort.js";
 import type { FilterProps } from "../query/Filter.js";
+import { Entity } from "../util/data.js";
 import { DocumentReference, QueryReference } from "./Reference.js";
 /**
  * Combines a database model and a provider.
@@ -16,7 +17,7 @@ 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?: FilterProps<ValidatorType<V[K]>>, sorts?: SortKeys<ValidatorType<V[K]>>, limit?: number | null): QueryReference<ValidatorType<V[K]>>;
+    query<K extends Key<V>>(collection: K, filters?: FilterProps<Entity<ValidatorType<V[K]>>>, sorts?: SortKeys<Entity<ValidatorType<V[K]>>>, limit?: number | null): QueryReference<ValidatorType<V[K]>>;
     /** Reference a document in a collection in this model. */
     doc<K extends Key<V>>(collection: K, id: string): DocumentReference<ValidatorType<V[K]>>;
     /**

package/db/Reference.d.ts

@@ -1,15 +1,15 @@
-import type { Data, Result, Results } from "../util/data.js";
-import type { Dispatcher } from "../util/function.js";
+import type { Data, OptionalData, Entity, OptionalEntity, Entities } from "../util/data.js";
+import type { Dispatch } from "../util/function.js";
 import type { SortKeys } from "../query/Sort.js";
-import { Observable, Observer, Unsubscriber } from "../util/observe.js";
-import { Validatable, Validator } from "../util/validate.js";
+import { ImmutableArray } from "../util/array.js";
+import type { PartialObserver } from "../observe/Observer.js";
+import type { Validator } from "../util/validate.js";
 import { Query } from "../query/Query.js";
-import { Entries, Entry } from "../util/entry.js";
 import { Filters } from "../query/Filters.js";
 import { Sorts } from "../query/Sorts.js";
 import { DataUpdate, PropUpdates } from "../update/DataUpdate.js";
 import { FilterProps } from "../query/Filter.js";
-import { DocumentData, DocumentResult } from "./util.js";
+import { Observable, Unsubscribe } from "../observe/Observable.js";
 import type { Database } from "./Database.js";
 /** A refence to a location in a database. */
 export interface Reference {
@@ -17,11 +17,11 @@ export interface Reference {
     toString(): string;
 }
 /** A query reference within a specific database. */
-export declare class QueryReference<T extends Data = Data> extends Query<T> implements Observable<Results<T>>, Validatable<Entries<T>>, Iterable<Entry<T>>, Reference {
+export declare class QueryReference<T extends Data = Data> extends Query<Entity<T>> implements Observable<ImmutableArray<Entity<T>>>, Reference {
     readonly db: Database;
     readonly validator: Validator<T>;
     readonly collection: string;
-    constructor(db: Database, validator: Validator<T>, collection: string, filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null);
+    constructor(db: Database, validator: Validator<T>, collection: string, filters?: Filters<Entity<T>>, sorts?: Sorts<Entity<T>>, limit?: number | null);
     /** Reference a document in this query's collection. */
     doc(id: string): DocumentReference<T>;
     /**
@@ -33,15 +33,10 @@ export declare class QueryReference<T extends Data = Data> extends Query<T> impl
      */
     add(data: T): string | PromiseLike<string>;
     /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
+     * Get array of entities for this query.
+     * @return Array of entities.
      */
-    get entries(): Entries<T> | PromiseLike<Entries<T>>;
-    /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
-     */
-    get results(): Results<T> | PromiseLike<Results<T>>;
+    get value(): Entities<T> | PromiseLike<Entities<T>>;
     /**
      * Count the number of results of this set of documents.
      * @return Number of documents matching the query (possibly promised).
@@ -53,19 +48,25 @@ export declare class QueryReference<T extends Data = Data> extends Query<T> impl
      */
     get exists(): boolean | PromiseLike<boolean>;
     /**
-     * Get an entry for the first document matched by this query or `undefined` if this query has no results.
-     *
-     * @return Entry in `[id, data]` format for the first document.
+     * Get the first document matched by this query or `null` if this query has no results.
      * @throws RequiredError if there were no results for this query.
      */
-    get result(): DocumentResult<T> | PromiseLike<DocumentResult<T>>;
+    get firstValue(): OptionalEntity<T> | PromiseLike<OptionalEntity<T>>;
     /**
-     * Get an entry for the first document matched by this query.
-     *
-     * @return Entry in `[id, data]` format for the first document.
+     * Get the first document matched by this query.
+     * @throws RequiredError if there were no results for this query.
+     */
+    get firstData(): Entity<T> | PromiseLike<Entity<T>>;
+    /**
+     * Get the last document matched by this query or `null` if this query has no results.
+     * @throws RequiredError if there were no results for this query.
+     */
+    get lastValue(): OptionalEntity<T> | PromiseLike<OptionalEntity<T>>;
+    /**
+     * Get the last document matched by this query.
      * @throws RequiredError if there were no results for this query.
      */
-    get data(): DocumentData<T> | PromiseLike<DocumentData<T>>;
+    get lastData(): Entity<T> | PromiseLike<Entity<T>>;
     /**
      * Subscribe to all matching documents.
      * - `next()` is called once with the initial results, and again any time the results change.
@@ -73,7 +74,7 @@ export declare class QueryReference<T extends Data = Data> extends Query<T> impl
      * @param next Observer with `next`, `error`, or `complete` methods or a `next()` dispatcher.
      * @return Function that ends the subscription.
      */
-    subscribe(next: Observer<Results<T>> | Dispatcher<[Results<T>]>): Unsubscriber;
+    subscribe(next: PartialObserver<ImmutableArray<Entity<T>>> | Dispatch<[ImmutableArray<Entity<T>>]>): Unsubscribe;
     /**
      * Set all matching documents to the same exact value.
      *
@@ -93,21 +94,17 @@ export declare class QueryReference<T extends Data = Data> extends Query<T> impl
      * @return Nothing (possibly promised).
      */
     delete(): number | PromiseLike<number>;
-    /** 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: Entries): Entries<T>;
     toString(): string;
 }
 /** A document reference within a specific database. */
-export declare class DocumentReference<T extends Data = Data> implements Observable<Result<T>>, Validatable<T>, Reference {
+export declare class DocumentReference<T extends Data = Data> implements Observable<OptionalData<T>>, Reference {
     readonly db: Database;
     readonly validator: Validator<T>;
     readonly collection: string;
     readonly id: string;
     constructor(db: Database, validator: Validator<T>, collection: string, id: string);
     /** Create a query on this document's collection. */
-    query(filters?: FilterProps<T>, sorts?: SortKeys<T>, limit?: number | null): QueryReference<T>;
+    query(filters?: FilterProps<Entity<T>>, sorts?: SortKeys<Entity<T>>, limit?: number | null): QueryReference<T>;
     /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
     get optional(): QueryReference<T>;
     /**
@@ -116,18 +113,18 @@ export declare class DocumentReference<T extends Data = Data> implements Observa
      */
     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 the optional data of this document.
+     * @return Document's data, or `null` if the document doesn't exist (possibly promised).
      */
-    get result(): DocumentResult<T> | PromiseLike<DocumentResult<T>>;
+    get value(): OptionalEntity<T> | PromiseLike<OptionalEntity<T>>;
     /**
      * Get the data of this document.
      * - Useful for destructuring, e.g. `{ name, title } = await documentThatMustExist.asyncData`
      *
      * @return Document's data (possibly promised).
-     * @throws RequiredError if the document's result was undefined.
+     * @throws RequiredError if the document does not exist.
      */
-    get data(): DocumentData<T> | PromiseLike<DocumentData<T>>;
+    get data(): Entity<T> | PromiseLike<Entity<T>>;
     /**
      * Subscribe to the result of this document (indefinitely).
      * - `next()` is called once with the initial result, and again any time the result changes.
@@ -135,14 +132,24 @@ export declare class DocumentReference<T extends Data = Data> implements Observa
      * @param next Observer with `next`, `error`, or `complete` methods or a `next()` dispatcher.
      * @return Function that ends the subscription.
      */
-    subscribe(next: Observer<DocumentResult<T>> | Dispatcher<[DocumentResult<T>]>): Unsubscriber;
+    subscribe(next: PartialObserver<OptionalEntity<T>> | Dispatch<[OptionalEntity<T>]>): Unsubscribe;
     /** Set the complete data of this document. */
     set(data: T): void | PromiseLike<void>;
     /** Update this document. */
     update(updates: DataUpdate<T> | PropUpdates<T>): void | PromiseLike<void>;
     /** Delete this document. */
     delete(): void | PromiseLike<void>;
-    /** Validate data for this query reference. */
-    validate(unsafeData: Data): T;
     toString(): string;
 }
+/** Get the data for a document from a result for that document. */
+export declare function getDocumentData<T extends Data>(entity: OptionalEntity<T>, ref: DocumentReference<T>): Entity<T>;
+/** Get the data for a document from a set of queried entities. */
+export declare function getQueryFirstData<T extends Data>(entities: Entities<T>, ref: QueryReference<T>): Entity<T>;
+/** Get the data for a document from a set of queried entities. */
+export declare function getQueryLastData<T extends Data>(entities: Entities<T>, ref: QueryReference<T>): Entity<T>;
+/** Get the optional data for a document from a set of queried entities. */
+export declare function getQueryFirstValue<T extends Data>(entities: Entities<T>): OptionalEntity<T>;
+/** Get the optional data for a document from a set of queried entities. */
+export declare function getQueryLastValue<T extends Data>(entities: Entities<T>): OptionalEntity<T>;
+/** Are two database references equal? */
+export declare const isSameReference: (left: Reference, right: Reference) => boolean;

package/db/Reference.js

@@ -1,17 +1,12 @@
-import { ResultsObserver } from "../util/observe.js";
-import { validate } from "../util/validate.js";
+import { getFirstItem, getLastItem } from "../util/array.js";
 import { Query } from "../query/Query.js";
 import { Filters } from "../query/Filters.js";
 import { Sorts } from "../query/Sorts.js";
-import { callAsync, throwAsync } from "../util/async.js";
-import { getMap } from "../util/map.js";
+import { callAsync } from "../util/async.js";
 import { countItems, hasItems } from "../util/iterate.js";
 import { DataUpdate } from "../update/DataUpdate.js";
-import { Feedback } from "../feedback/Feedback.js";
-import { InvalidFeedback } from "../feedback/InvalidFeedback.js";
 import { Filter } from "../query/Filter.js";
-import { DocumentValidationError, QueryValidationError } from "./errors.js";
-import { DocumentResultObserver, getDocumentData, getDocumentResult, getQueryData, getQueryResult } from "./util.js";
+import { RequiredError } from "../error/RequiredError.js";
 /** A query reference within a specific database. */
 export class QueryReference extends Query {
     constructor(db, validator, collection, filters, sorts, limit) {
@@ -32,28 +27,21 @@ export class QueryReference extends Query {
      * @return String ID for the created document (possibly promised).
      */
     add(data) {
-        return this.db.provider.add(this, data);
+        return this.db.provider.addDocument(this, data);
     }
     /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
+     * Get array of entities for this query.
+     * @return Array of entities.
      */
-    get entries() {
+    get value() {
         return this.db.provider.getQuery(this);
     }
-    /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
-     */
-    get results() {
-        return callAsync(getMap, this.db.provider.getQuery(this));
-    }
     /**
      * Count the number of results of this set of documents.
      * @return Number of documents matching the query (possibly promised).
      */
     get count() {
-        return callAsync(countItems, this.entries);
+        return callAsync(countItems, this.value);
     }
     /**
      * Does at least one document exist for this query?
@@ -63,22 +51,32 @@ export class QueryReference extends Query {
         return callAsync(hasItems, this.db.provider.getQuery(this.max(1)));
     }
     /**
-     * Get an entry for the first document matched by this query or `undefined` if this query has no results.
-     *
-     * @return Entry in `[id, data]` format for the first document.
+     * Get the first document matched by this query or `null` if this query has no results.
      * @throws RequiredError if there were no results for this query.
      */
-    get result() {
-        return callAsync(getQueryResult, this.db.provider.getQuery(this.max(1)), this);
+    get firstValue() {
+        return callAsync(getQueryFirstValue, this.db.provider.getQuery(this.max(1)));
     }
     /**
-     * Get an entry for the first document matched by this query.
-     *
-     * @return Entry in `[id, data]` format for the first document.
+     * Get the first document matched by this query.
      * @throws RequiredError if there were no results for this query.
      */
-    get data() {
-        return callAsync(getQueryData, this.db.provider.getQuery(this.max(1)), this);
+    get firstData() {
+        return callAsync(getQueryFirstData, this.db.provider.getQuery(this.max(1)), this);
+    }
+    /**
+     * Get the last document matched by this query or `null` if this query has no results.
+     * @throws RequiredError if there were no results for this query.
+     */
+    get lastValue() {
+        return callAsync(getQueryLastValue, this.db.provider.getQuery(this.max(1)));
+    }
+    /**
+     * Get the last document matched by this query.
+     * @throws RequiredError if there were no results for this query.
+     */
+    get lastData() {
+        return callAsync(getQueryLastData, this.db.provider.getQuery(this.max(1)), this);
     }
     /**
      * Subscribe to all matching documents.
@@ -88,7 +86,7 @@ export class QueryReference extends Query {
      * @return Function that ends the subscription.
      */
     subscribe(next) {
-        return this.db.provider.subscribeQuery(this, new ResultsObserver(typeof next === "function" ? { next } : next));
+        return this.db.provider.subscribeQuery(this, typeof next === "function" ? { next } : next);
     }
     /**
      * Set all matching documents to the same exact value.
@@ -115,28 +113,6 @@ export class QueryReference extends Query {
     delete() {
         return this.db.provider.deleteQuery(this);
     }
-    /** Iterate over the resuls (will throw `Promise` if the results are asynchronous). */
-    [Symbol.iterator]() {
-        return throwAsync(this.entries)[Symbol.iterator]();
-    }
-    /** Validate a set of results for this query reference. */
-    *validate(unsafeEntries) {
-        let invalid = false;
-        const details = {};
-        for (const [id, unsafeValue] of unsafeEntries) {
-            try {
-                yield [id, validate(unsafeValue, this.validator)];
-            }
-            catch (thrown) {
-                if (!(thrown instanceof Feedback))
-                    throw thrown;
-                invalid = true;
-                details[id] = thrown;
-            }
-        }
-        if (invalid)
-            throw new QueryValidationError(this, new InvalidFeedback("Invalid results", details));
-    }
     // Override to include the collection name.
     toString() {
         return `${this.collection}?${super.toString()}`;
@@ -163,24 +139,24 @@ export class DocumentReference {
      * @return `true` if a document exists or `false` otherwise (possibly promised).
      */
     get exists() {
-        return callAsync(Boolean, this.db.provider.get(this));
+        return callAsync(Boolean, this.db.provider.getDocument(this));
     }
     /**
-     * Get the result of this document.
-     * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
+     * Get the optional data of this document.
+     * @return Document's data, or `null` if the document doesn't exist (possibly promised).
      */
-    get result() {
-        return callAsync(getDocumentResult, this.db.provider.get(this), this);
+    get value() {
+        return this.db.provider.getDocument(this);
     }
     /**
      * Get the data of this document.
      * - Useful for destructuring, e.g. `{ name, title } = await documentThatMustExist.asyncData`
      *
      * @return Document's data (possibly promised).
-     * @throws RequiredError if the document's result was undefined.
+     * @throws RequiredError if the document does not exist.
      */
     get data() {
-        return callAsync(getDocumentData, this.db.provider.get(this), this);
+        return callAsync(getDocumentData, this.db.provider.getDocument(this), this);
     }
     /**
      * Subscribe to the result of this document (indefinitely).
@@ -190,31 +166,52 @@ export class DocumentReference {
      * @return Function that ends the subscription.
      */
     subscribe(next) {
-        return this.db.provider.subscribe(this, new DocumentResultObserver(typeof next === "function" ? { next } : next, this));
+        return this.db.provider.subscribeDocument(this, typeof next === "function" ? { next } : next);
     }
     /** Set the complete data of this document. */
     set(data) {
-        return this.db.provider.set(this, data);
+        return this.db.provider.setDocument(this, data);
     }
     /** Update this document. */
     update(updates) {
-        return this.db.provider.update(this, updates instanceof DataUpdate ? updates : new DataUpdate(updates));
+        return this.db.provider.updateDocument(this, updates instanceof DataUpdate ? updates : new DataUpdate(updates));
     }
     /** Delete this document. */
     delete() {
-        return this.db.provider.delete(this);
-    }
-    /** Validate data for this query reference. */
-    validate(unsafeData) {
-        try {
-            return validate(unsafeData, this.validator);
-        }
-        catch (thrown) {
-            throw thrown instanceof Feedback ? new DocumentValidationError(this, thrown) : thrown;
-        }
+        return this.db.provider.deleteDocument(this);
     }
     // Implement toString()
     toString() {
         return `${this.collection}/${this.id}`;
     }
 }
+/** Get the data for a document from a result for that document. */
+export function getDocumentData(entity, ref) {
+    if (entity)
+        return entity;
+    throw new RequiredError(`Document "${ref}" does not exist`);
+}
+/** Get the data for a document from a set of queried entities. */
+export function getQueryFirstData(entities, ref) {
+    const entity = getQueryFirstValue(entities);
+    if (entity)
+        return entity;
+    throw new RequiredError(`Query "${ref}" has no documents`);
+}
+/** Get the data for a document from a set of queried entities. */
+export function getQueryLastData(entities, ref) {
+    const entity = getQueryLastValue(entities);
+    if (entity)
+        return entity;
+    throw new RequiredError(`Query "${ref}" has no documents`);
+}
+/** Get the optional data for a document from a set of queried entities. */
+export function getQueryFirstValue(entities) {
+    return getFirstItem(entities) || null;
+}
+/** Get the optional data for a document from a set of queried entities. */
+export function getQueryLastValue(entities) {
+    return getLastItem(entities) || null;
+}
+/** Are two database references equal? */
+export const isSameReference = (left, right) => left === right || left.toString() === right.toString();

package/db/index.d.ts

@@ -1,6 +1,3 @@
 export * from "./Database.js";
 export * from "./Reference.js";
 export * from "./Operation.js";
-export * from "./PaginationState.js";
-export * from "./util.js";
-export * from "./errors.js";

package/db/index.js

@@ -1,6 +1,3 @@
 export * from "./Database.js";
 export * from "./Reference.js";
 export * from "./Operation.js";
-export * from "./PaginationState.js";
-export * from "./util.js";
-export * from "./errors.js";

package/error/ThroughError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Thrown to wrap an error with another error.
+ * - Merges the message and stack of the previous message.
+ */
+export declare class ThroughError extends Error {
+    readonly cause: Error | unknown;
+    constructor(message: string, cause: Error | unknown);
+}

package/error/ThroughError.js

@@ -0,0 +1,13 @@
+import { debug } from "../util/debug.js";
+/**
+ * Thrown to wrap an error with another error.
+ * - Merges the message and stack of the previous message.
+ */
+export class ThroughError extends Error {
+    constructor(message, cause) {
+        super(message);
+        this.cause = cause;
+        this.stack = `${this.stack}\nCause: ${cause instanceof Error ? cause.stack : debug(cause)}`;
+    }
+}
+ThroughError.prototype.name = "ThroughError";

package/firestore/client/FirestoreClientProvider.d.ts

@@ -1,10 +1,10 @@
 import type { Firestore } from "firebase/firestore";
 import type { DocumentReference, QueryReference } from "../../db/Reference.js";
-import type { Data, Result } from "../../util/data.js";
-import type { Entries } from "../../util/entry.js";
+import type { Data, Entities, OptionalEntity } from "../../util/data.js";
+import type { Unsubscribe } from "../../observe/Observable.js";
 import { AsynchronousProvider, Provider } from "../../provider/Provider.js";
 import { DataUpdate } from "../../update/DataUpdate.js";
-import { Observer, Unsubscriber } from "../../util/observe.js";
+import { Observer } from "../../observe/Observer.js";
 /**
  * Firestore client database provider.
  * - Works with the Firebase JS SDK.
@@ -14,14 +14,14 @@ import { Observer, Unsubscriber } from "../../util/observe.js";
 export declare class FirestoreClientProvider extends Provider implements AsynchronousProvider {
     readonly firestore: Firestore;
     constructor(firestore: Firestore);
-    get<T extends Data>(ref: DocumentReference<T>): Promise<Result<T>>;
-    subscribe<T extends Data>(ref: DocumentReference<T>, observer: Observer<Result<T>>): Unsubscriber;
-    add<T extends Data>(ref: QueryReference<T>, data: T): Promise<string>;
-    set<T extends Data>(ref: DocumentReference<T>, data: T): Promise<void>;
-    update<T extends Data>(ref: DocumentReference<T>, update: DataUpdate<T>): Promise<void>;
-    delete<T extends Data>(ref: DocumentReference<T>): Promise<void>;
-    getQuery<T extends Data>(ref: QueryReference<T>): Promise<Entries<T>>;
-    subscribeQuery<T extends Data>(ref: QueryReference<T>, observer: Observer<Entries<T>>): Unsubscriber;
+    getDocument<T extends Data>(ref: DocumentReference<T>): Promise<OptionalEntity<T>>;
+    subscribeDocument<T extends Data>(ref: DocumentReference<T>, observer: Observer<OptionalEntity<T>>): Unsubscribe;
+    addDocument<T extends Data>(ref: QueryReference<T>, data: T): Promise<string>;
+    setDocument<T extends Data>(ref: DocumentReference<T>, data: T): Promise<void>;
+    updateDocument<T extends Data>(ref: DocumentReference<T>, update: DataUpdate<T>): Promise<void>;
+    deleteDocument<T extends Data>(ref: DocumentReference<T>): Promise<void>;
+    getQuery<T extends Data>(ref: QueryReference<T>): Promise<Entities<T>>;
+    subscribeQuery<T extends Data>(ref: QueryReference<T>, observer: Observer<Entities<T>>): Unsubscribe;
     setQuery<T extends Data>(ref: QueryReference<T>, data: T): Promise<number>;
     updateQuery<T extends Data>(ref: QueryReference<T>, update: DataUpdate<T>): Promise<number>;
     deleteQuery<T extends Data>(ref: QueryReference<T>): Promise<number>;

package/firestore/client/FirestoreClientProvider.js

@@ -5,7 +5,7 @@ import { ArrayUpdate } from "../../update/ArrayUpdate.js";
 import { DataUpdate } from "../../update/DataUpdate.js";
 import { Increment } from "../../update/Increment.js";
 import { ObjectUpdate } from "../../update/ObjectUpdate.js";
-import { dispatchError, dispatchNext } from "../../util/observe.js";
+import { dispatchError, dispatchNext } from "../../observe/Observer.js";
 // Constants.
 // const ID = "__name__"; // DH: `__name__` is the entire path of the document. `__id__` is just ID.
 const ID = "__id__"; // Internal way Firestore Queries can reference the ID of the current document.
@@ -46,10 +46,16 @@ function getQuery(firestore, ref) {
         constraints.push(firestoreLimit(limit));
     return firestoreQuery(getCollection(firestore, ref), ...constraints);
 }
-/** Create a set of results from a collection snapshot. */
-function* getResults(snapshot) {
-    for (const s of snapshot.docs)
-        yield [s.id, s.data()];
+function getEntities(snapshot) {
+    return snapshot.docs.map(getEntity);
+}
+function getEntity(snapshot) {
+    const data = snapshot.data();
+    return { ...data, id: snapshot.id };
+}
+function getOptionalEntity(snapshot) {
+    const data = snapshot.data();
+    return data ? { ...data, id: snapshot.id } : null;
 }
 /** Convert `Update` instances into corresponding Firestore `FieldValue` instances. */
 function* yieldFieldValues(updates, prefix = "") {
@@ -83,31 +89,31 @@ export class FirestoreClientProvider extends Provider {
         super();
         this.firestore = firestore;
     }
-    async get(ref) {
-        return (await getDoc(getDocument(this.firestore, ref))).data() || null;
+    async getDocument(ref) {
+        return getOptionalEntity(await getDoc(getDocument(this.firestore, ref)));
     }
-    subscribe(ref, observer) {
-        return onSnapshot(getDocument(this.firestore, ref), snapshot => dispatchNext(observer, snapshot.data() || null), thrown => dispatchError(observer, thrown));
+    subscribeDocument(ref, observer) {
+        return onSnapshot(getDocument(this.firestore, ref), snapshot => dispatchNext(observer, getOptionalEntity(snapshot)), thrown => dispatchError(observer, thrown));
     }
-    async add(ref, data) {
+    async addDocument(ref, data) {
         const reference = await addDoc(getCollection(this.firestore, ref), data);
         return reference.id;
     }
-    async set(ref, data) {
+    async setDocument(ref, data) {
         await setDoc(getDocument(this.firestore, ref), data);
     }
-    async update(ref, update) {
+    async updateDocument(ref, update) {
         const fieldValues = Object.fromEntries(yieldFieldValues(update));
         await updateDoc(getDocument(this.firestore, ref), fieldValues);
     }
-    async delete(ref) {
+    async deleteDocument(ref) {
         await deleteDoc(getDocument(this.firestore, ref));
     }
     async getQuery(ref) {
-        return getResults(await getDocs(getQuery(this.firestore, ref)));
+        return getEntities(await getDocs(getQuery(this.firestore, ref)));
     }
     subscribeQuery(ref, observer) {
-        return onSnapshot(getQuery(this.firestore, ref), snapshot => dispatchNext(observer, getResults(snapshot)), thrown => dispatchError(observer, thrown));
+        return onSnapshot(getQuery(this.firestore, ref), snapshot => dispatchNext(observer, getEntities(snapshot)), thrown => dispatchError(observer, thrown));
     }
     async setQuery(ref, data) {
         const snapshot = await getDocs(getQuery(this.firestore, ref));

package/firestore/lite/FirestoreLiteProvider.d.ts

@@ -1,8 +1,7 @@
 import type { Firestore } from "firebase/firestore/lite";
 import type { DocumentReference, QueryReference } from "../../db/Reference.js";
-import type { Data, Result } from "../../util/data.js";
-import type { Entries } from "../../util/entry.js";
-import type { Unsubscriber } from "../../util/observe.js";
+import type { Data, Entities, OptionalEntity } from "../../util/data.js";
+import type { Unsubscribe } from "../../observe/Observable.js";
 import { AsynchronousProvider, Provider } from "../../provider/Provider.js";
 import { DataUpdate } from "../../update/DataUpdate.js";
 /**
@@ -14,14 +13,14 @@ import { DataUpdate } from "../../update/DataUpdate.js";
 export declare class FirestoreClientProvider extends Provider implements AsynchronousProvider {
     readonly firestore: Firestore;
     constructor(firestore: Firestore);
-    get<T extends Data>(ref: DocumentReference<T>): Promise<Result<T>>;
-    subscribe(): Unsubscriber;
-    add<T extends Data>(ref: QueryReference<T>, data: T): Promise<string>;
-    set<T extends Data>(ref: DocumentReference<T>, data: T): Promise<void>;
-    update<T extends Data>(ref: DocumentReference<T>, update: DataUpdate<T>): Promise<void>;
-    delete<T extends Data>(ref: DocumentReference<T>): Promise<void>;
-    getQuery<T extends Data>(ref: QueryReference<T>): Promise<Entries<T>>;
-    subscribeQuery(): Unsubscriber;
+    getDocument<T extends Data>(ref: DocumentReference<T>): Promise<OptionalEntity<T>>;
+    subscribeDocument(): Unsubscribe;
+    addDocument<T extends Data>(ref: QueryReference<T>, data: T): Promise<string>;
+    setDocument<T extends Data>(ref: DocumentReference<T>, data: T): Promise<void>;
+    updateDocument<T extends Data>(ref: DocumentReference<T>, update: DataUpdate<T>): Promise<void>;
+    deleteDocument<T extends Data>(ref: DocumentReference<T>): Promise<void>;
+    getQuery<T extends Data>(ref: QueryReference<T>): Promise<Entities<T>>;
+    subscribeQuery(): Unsubscribe;
     setQuery<T extends Data>(ref: QueryReference<T>, data: T): Promise<number>;
     updateQuery<T extends Data>(ref: QueryReference<T>, update: DataUpdate<T>): Promise<number>;
     deleteQuery<T extends Data>(ref: QueryReference<T>): Promise<number>;