shelving 1.62.1 → 1.64.0

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/PaginationState.d.ts

@@ -1,14 +1,13 @@
-import type { Entries, Entry } from "../util/entry.js";
-import type { Data, Results } from "../util/data.js";
+import type { Data, Entity } from "../util/data.js";
 import { BooleanState } from "../stream/BooleanState.js";
-import { State } from "../stream/State.js";
+import { ArrayState } from "../stream/ArrayState.js";
 import { QueryReference } from "./Reference.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 PaginationState<T extends Data> extends State<Results<T>> implements Iterable<Entry<T>> {
+export declare class PaginationState<T extends Data> extends ArrayState<Entity<T>> {
     /** Whether this pagination is currently loading results. */
     readonly busy: BooleanState;
     /** Reference to the query this pagination is paginating. */
@@ -25,7 +24,5 @@ export declare class PaginationState<T extends Data> extends State<Results<T>> i
      * Merge more results into this pagination.
      * @return The change in the number of results.
      */
-    merge(more: Entries<T>): void;
-    /** Iterate over the entries of the values currently in the pagination. */
-    [Symbol.iterator](): Iterator<Entry<T>>;
+    merge(more: Iterable<Entity<T>>): void;
 }

package/db/PaginationState.js

@@ -1,17 +1,14 @@
 import { ConditionError } from "../error/ConditionError.js";
 import { BooleanState } from "../stream/BooleanState.js";
-import { State } from "../stream/State.js";
 import { getLastItem } from "../util/array.js";
-import { NOVALUE } from "../util/constants.js";
-import { yieldMerged } from "../util/iterate.js";
-import { getMap } from "../util/map.js";
 import { assertMax, assertNumber } from "../util/number.js";
+import { ArrayState } from "../stream/ArrayState.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 class PaginationState extends State {
+export class PaginationState extends ArrayState {
     constructor(ref) {
         super();
         /** Whether this pagination is currently loading results. */
@@ -27,10 +24,9 @@ export class PaginationState extends State {
                 this.busy.next(true);
                 if (!this.exists) {
                     // First set of results.
-                    this._value === NOVALUE;
-                    const next = await this.ref.results;
+                    const next = await this.ref.array;
                     this.next(next);
-                    if (next.size < this.limit)
+                    if (next.length < this.limit)
                         this.complete();
                     this.busy.next(false);
                 }
@@ -38,9 +34,9 @@ export class PaginationState extends State {
                     // Additional set of results.
                     const lastItem = getLastItem(this.value);
                     if (lastItem) {
-                        const next = await this.ref.after(lastItem[0], lastItem[1]).results;
+                        const next = await this.ref.after(lastItem).array;
                         this.merge(next);
-                        if (next.size < this.limit)
+                        if (next.length < this.limit)
                             this.complete();
                         this.busy.next(false);
                         return;
@@ -58,10 +54,6 @@ export class PaginationState extends State {
      * @return The change in the number of results.
      */
     merge(more) {
-        this.next(this.exists ? getMap(this.ref.sorts.transform(yieldMerged(more, this.value))) : getMap(more));
-    }
-    /** Iterate over the entries of the values currently in the pagination. */
-    [Symbol.iterator]() {
-        return this.value[Symbol.iterator]();
+        this.next(this.exists ? [...this.value, ...more] : [...more]);
     }
 }

package/db/Reference.d.ts

@@ -1,15 +1,14 @@
-import type { Data, Result, Results } from "../util/data.js";
+import type { Data, Result, Entity } from "../util/data.js";
 import type { Dispatcher } from "../util/function.js";
 import type { SortKeys } from "../query/Sort.js";
+import { ImmutableArray } from "../util/array.js";
 import { Observable, Observer, Unsubscriber } from "../util/observe.js";
-import { Validatable, Validator } from "../util/validate.js";
+import { 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 type { Database } from "./Database.js";
 /** A refence to a location in a database. */
 export interface Reference {
@@ -17,11 +16,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 +32,15 @@ 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.
+     * Get an iterable that yields the entities of this query.
      * @return Map containing the results.
      */
-    get entries(): Entries<T> | PromiseLike<Entries<T>>;
+    get items(): Iterable<Entity<T>> | PromiseLike<Iterable<Entity<T>>>;
     /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
+     * Get an array of the results of this .
+     * @return Array containing the entities.
      */
-    get results(): Results<T> | PromiseLike<Results<T>>;
+    get array(): ImmutableArray<Entity<T>> | PromiseLike<ImmutableArray<Entity<T>>>;
     /**
      * Count the number of results of this set of documents.
      * @return Number of documents matching the query (possibly promised).
@@ -53,19 +52,19 @@ 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.
+     * Get the first document matched by this query or `null` if this query has no results.
      *
      * @return Entry in `[id, data]` format for the first document.
      * @throws RequiredError if there were no results for this query.
      */
-    get result(): DocumentResult<T> | PromiseLike<DocumentResult<T>>;
+    get result(): Result<Entity<T>> | PromiseLike<Result<Entity<T>>>;
     /**
-     * Get an entry for the first document matched by this query.
+     * Get the first document matched by this query.
      *
      * @return Entry in `[id, data]` format for the first document.
      * @throws RequiredError if there were no results for this query.
      */
-    get data(): DocumentData<T> | PromiseLike<DocumentData<T>>;
+    get data(): 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 +72,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: Observer<ImmutableArray<Entity<T>>> | Dispatcher<[ImmutableArray<Entity<T>>]>): Unsubscriber;
     /**
      * Set all matching documents to the same exact value.
      *
@@ -93,21 +92,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<Result<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>;
     /**
@@ -117,17 +112,17 @@ 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).
+     * @return Document's data, or `null` if the document doesn't exist (possibly promised).
      */
-    get result(): DocumentResult<T> | PromiseLike<DocumentResult<T>>;
+    get result(): Result<Entity<T>> | PromiseLike<Result<Entity<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 +130,12 @@ 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: Observer<Result<Entity<T>>> | Dispatcher<[Result<Entity<T>>]>): Unsubscriber;
     /** 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;
 }

package/db/Reference.js

@@ -1,17 +1,13 @@
-import { ResultsObserver } from "../util/observe.js";
-import { validate } from "../util/validate.js";
+import { getArray } from "../util/array.js";
+import { ArrayObserver } from "../util/observe.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 { getDocumentData, getQueryData, getQueryResult } from "./util.js";
 /** A query reference within a specific database. */
 export class QueryReference extends Query {
     constructor(db, validator, collection, filters, sorts, limit) {
@@ -35,25 +31,25 @@ export class QueryReference extends Query {
         return this.db.provider.add(this, data);
     }
     /**
-     * Get an iterable that yields the results of this entry.
+     * Get an iterable that yields the entities of this query.
      * @return Map containing the results.
      */
-    get entries() {
+    get items() {
         return this.db.provider.getQuery(this);
     }
     /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
+     * Get an array of the results of this .
+     * @return Array containing the entities.
      */
-    get results() {
-        return callAsync(getMap, this.db.provider.getQuery(this));
+    get array() {
+        return callAsync(getArray, 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.items);
     }
     /**
      * Does at least one document exist for this query?
@@ -63,16 +59,16 @@ 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.
+     * Get the first document matched by this query or `null` if this query has no results.
      *
      * @return Entry in `[id, data]` format for the first document.
      * @throws RequiredError if there were no results for this query.
      */
     get result() {
-        return callAsync(getQueryResult, this.db.provider.getQuery(this.max(1)), this);
+        return callAsync(getQueryResult, this.db.provider.getQuery(this.max(1)));
     }
     /**
-     * Get an entry for the first document matched by this query.
+     * Get the first document matched by this query.
      *
      * @return Entry in `[id, data]` format for the first document.
      * @throws RequiredError if there were no results for this query.
@@ -88,7 +84,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, new ArrayObserver(typeof next === "function" ? { next } : next));
     }
     /**
      * Set all matching documents to the same exact value.
@@ -115,28 +111,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()}`;
@@ -167,17 +141,17 @@ export class DocumentReference {
     }
     /**
      * Get the result of this document.
-     * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
+     * @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);
+        return this.db.provider.get(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);
@@ -190,7 +164,7 @@ 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.subscribe(this, typeof next === "function" ? { next } : next);
     }
     /** Set the complete data of this document. */
     set(data) {
@@ -204,15 +178,6 @@ export class DocumentReference {
     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;
-        }
-    }
     // Implement toString()
     toString() {
         return `${this.collection}/${this.id}`;

package/db/errors.d.ts

@@ -1,6 +1,4 @@
 import type { Data } from "../util/data.js";
-import type { Feedback } from "../feedback/Feedback.js";
-import { ValidationError } from "../error/ValidationError.js";
 import { RequiredError } from "../error/RequiredError.js";
 import type { DocumentReference, QueryReference } from "./Reference.js";
 /** Thrown if a document doesn't exist. */
@@ -8,18 +6,8 @@ export declare class DocumentRequiredError<T extends Data> extends RequiredError
     ref: DocumentReference<T>;
     constructor(ref: DocumentReference<T>);
 }
-/** Thrown if a document can't validate. */
-export declare class DocumentValidationError<T extends Data> extends ValidationError {
-    ref: DocumentReference<T>;
-    constructor(ref: DocumentReference<T>, feedback: Feedback);
-}
 /** Thrown if a query doesn't exist. */
 export declare class QueryRequiredError<T extends Data> extends RequiredError {
     ref: QueryReference<T>;
     constructor(ref: QueryReference<T>);
 }
-/** Thrown if a query can't validate a set of results. */
-export declare class QueryValidationError<T extends Data> extends ValidationError {
-    ref: QueryReference<T>;
-    constructor(ref: QueryReference<T>, feedback: Feedback);
-}

package/db/errors.js

@@ -1,4 +1,3 @@
-import { ValidationError } from "../error/ValidationError.js";
 import { RequiredError } from "../error/RequiredError.js";
 /** Thrown if a document doesn't exist. */
 export class DocumentRequiredError extends RequiredError {
@@ -8,14 +7,6 @@ export class DocumentRequiredError extends RequiredError {
     }
 }
 DocumentRequiredError.prototype.name = "DocumentRequiredError";
-/** Thrown if a document can't validate. */
-export class DocumentValidationError extends ValidationError {
-    constructor(ref, feedback) {
-        super(`Invalid data for ${ref.toString()}`, feedback);
-        this.ref = ref;
-    }
-}
-DocumentValidationError.prototype.name = "DocumentValidationError";
 /** Thrown if a query doesn't exist. */
 export class QueryRequiredError extends RequiredError {
     constructor(ref) {
@@ -24,11 +15,3 @@ export class QueryRequiredError extends RequiredError {
     }
 }
 QueryRequiredError.prototype.name = "QueryRequiredError";
-/** Thrown if a query can't validate a set of results. */
-export class QueryValidationError extends ValidationError {
-    constructor(ref, feedback) {
-        super(`Invalid documents for "${ref.collection}"`, feedback);
-        this.ref = ref;
-    }
-}
-QueryValidationError.prototype.name = "QueryValidationError";

package/db/util.d.ts

@@ -1,37 +1,11 @@
-import { TransformableObserver, Observer } from "../util/observe.js";
+import type { Entity } from "../util/data.js";
 import { Data, Result } from "../util/data.js";
-import type { Entries } from "../util/entry.js";
 import type { DocumentReference, QueryReference, Reference } from "./Reference.js";
-/** Database data embeds the corresponding `Document` instance and string ID into the data. */
-export declare type DocumentData<T extends Data> = T & {
-    id: string;
-    doc: DocumentReference<T>;
-};
 /** Get the data for a document from a result for that document. */
-export declare function getDocumentData<T extends Data>(result: DocumentResult<T> | Result<T>, ref: DocumentReference<T>): DocumentData<T>;
-/** Is an unknown value a DocumentResult. */
-export declare const isDocumentData: <T extends Data>(v: unknown) => v is DocumentData<T>;
-/** Oserver that transforms a result into a document result. */
-export declare class DocumentDataObserver<T extends Data> extends TransformableObserver<Result<T>, DocumentData<T>> {
-    protected _ref: DocumentReference<T>;
-    constructor(target: Observer<DocumentData<T>>, ref: DocumentReference<T>);
-    transform(result: Result<T>): DocumentData<T>;
-}
-/** Database result embeds the corresponding `Document` instance and string ID into the result. */
-export declare type DocumentResult<T extends Data> = DocumentData<T> | null;
+export declare function getDocumentData<T extends Data>(result: Result<Entity<T>>, ref: DocumentReference<T>): Entity<T>;
 /** Get the data for a document from a result for that document. */
-export declare function getDocumentResult<T extends Data>(result: Result<T>, ref: DocumentReference<T>): DocumentResult<T>;
-/** Is an unknown value a DocumentResult. */
-export declare const isDocumentResult: <T extends Data>(v: unknown) => v is DocumentResult<T>;
-/** Oserver that transforms a set of entries into a results map. */
-export declare class DocumentResultObserver<T extends Data> extends TransformableObserver<Result<T>, DocumentResult<T>> {
-    protected _ref: DocumentReference<T>;
-    constructor(target: Observer<DocumentResult<T>>, ref: DocumentReference<T>);
-    transform(result: Result<T>): DocumentResult<T>;
-}
+export declare function getQueryData<T extends Data>(entities: Iterable<Entity<T>>, ref: QueryReference<T>): Entity<T>;
 /** Get the data for a document from a result for that document. */
-export declare function getQueryData<T extends Data>(entries: Entries<T>, ref: QueryReference<T>): DocumentData<T>;
-/** Get the data for a document from a result for that document. */
-export declare function getQueryResult<T extends Data>(entries: Entries<T>, ref: QueryReference<T>): DocumentResult<T>;
+export declare function getQueryResult<T extends Data>(entities: Iterable<Entity<T>>): Entity<T> | null;
 /** Are two database references equal? */
 export declare const isSameReference: (left: Reference, right: Reference) => boolean;

package/db/util.js

@@ -1,54 +1,21 @@
-import { TransformableObserver } from "../util/observe.js";
-import { isData } from "../util/data.js";
 import { getFirstItem } from "../util/array.js";
 import { DocumentRequiredError, QueryRequiredError } from "./errors.js";
 /** Get the data for a document from a result for that document. */
 export function getDocumentData(result, ref) {
     if (result)
-        return isDocumentData(result) ? result : { ...result, id: ref.id, doc: ref };
+        return result;
     throw new DocumentRequiredError(ref);
 }
-/** Is an unknown value a DocumentResult. */
-export const isDocumentData = (v) => isData(v) && "id" in v && "doc" in v;
-/** Oserver that transforms a result into a document result. */
-export class DocumentDataObserver extends TransformableObserver {
-    constructor(target, ref) {
-        super(target);
-        this._ref = ref;
-    }
-    transform(result) {
-        return getDocumentData(result, this._ref);
-    }
-}
-/** Get the data for a document from a result for that document. */
-export function getDocumentResult(result, ref) {
-    return result ? getDocumentData(result, ref) : null;
-}
-/** Is an unknown value a DocumentResult. */
-export const isDocumentResult = (v) => isData(v) && "id" in v && "doc" in v;
-/** Oserver that transforms a set of entries into a results map. */
-export class DocumentResultObserver extends TransformableObserver {
-    constructor(target, ref) {
-        super(target);
-        this._ref = ref;
-    }
-    transform(result) {
-        return getDocumentResult(result, this._ref);
-    }
-}
 /** Get the data for a document from a result for that document. */
-export function getQueryData(entries, ref) {
-    const data = getQueryResult(entries, ref);
-    if (data)
-        return data;
+export function getQueryData(entities, ref) {
+    const entity = getQueryResult(entities);
+    if (entity)
+        return entity;
     throw new QueryRequiredError(ref);
 }
 /** Get the data for a document from a result for that document. */
-export function getQueryResult(entries, ref) {
-    const first = getFirstItem(entries);
-    if (first)
-        return getDocumentData(first[1], ref.doc(first[0]));
-    return null;
+export function getQueryResult(entities) {
+    return getFirstItem(entities) || null;
 }
 /** Are two database references equal? */
 export const isSameReference = (left, right) => left === right || left.toString() === right.toString();

package/firestore/client/FirestoreClientProvider.d.ts

@@ -1,7 +1,6 @@
 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, Result, Entity } from "../../util/data.js";
 import { AsynchronousProvider, Provider } from "../../provider/Provider.js";
 import { DataUpdate } from "../../update/DataUpdate.js";
 import { Observer, Unsubscriber } from "../../util/observe.js";
@@ -14,14 +13,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;
+    get<T extends Data>(ref: DocumentReference<T>): Promise<Result<Entity<T>>>;
+    subscribe<T extends Data>(ref: DocumentReference<T>, observer: Observer<Result<Entity<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;
+    getQuery<T extends Data>(ref: QueryReference<T>): Promise<Iterable<Entity<T>>>;
+    subscribeQuery<T extends Data>(ref: QueryReference<T>, observer: Observer<Iterable<Entity<T>>>): Unsubscriber;
     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

@@ -49,7 +49,12 @@ function getQuery(firestore, ref) {
 /** Create a set of results from a collection snapshot. */
 function* getResults(snapshot) {
     for (const s of snapshot.docs)
-        yield [s.id, s.data()];
+        yield { ...s.data(), id: s.id };
+}
+/** Get a result from a document snapshot. */
+function getResult(snapshot) {
+    const data = snapshot.data();
+    return data ? { ...data, id: snapshot.id } : null;
 }
 /** Convert `Update` instances into corresponding Firestore `FieldValue` instances. */
 function* yieldFieldValues(updates, prefix = "") {
@@ -84,10 +89,10 @@ export class FirestoreClientProvider extends Provider {
         this.firestore = firestore;
     }
     async get(ref) {
-        return (await getDoc(getDocument(this.firestore, ref))).data() || null;
+        return getResult(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));
+        return onSnapshot(getDocument(this.firestore, ref), snapshot => dispatchNext(observer, getResult(snapshot)), thrown => dispatchError(observer, thrown));
     }
     async add(ref, data) {
         const reference = await addDoc(getCollection(this.firestore, ref), data);