shelving 1.59.1 → 1.61.1

package/db/Database.d.ts

@@ -1,7 +1,7 @@
-import { Entry, Observable, Observer, Result, Unsubscriber, Results, Validatable, Validator, Key, Data, Entries, Datas, Validators, ValidatorType, Dispatcher } from "../util/index.js";
-import { DataUpdate, PropUpdates } from "../update/index.js";
+import { Key, Datas, Validators, ValidatorType } from "../util/index.js";
 import type { Provider } from "../provider/Provider.js";
-import { Filters, Sorts, Query, FilterProps, SortKeys } from "../query/index.js";
+import { FilterProps, SortKeys } from "../query/index.js";
+import { DocumentReference, QueryReference } from "./Reference.js";
 /**
  * Combines a database model and a provider.
  *
@@ -14,9 +14,9 @@ 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): DatabaseQuery<ValidatorType<V[K]>>;
+    query<K extends Key<V>>(collection: K, filters?: FilterProps<ValidatorType<V[K]>>, sorts?: SortKeys<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): DatabaseDocument<ValidatorType<V[K]>>;
+    doc<K extends Key<V>>(collection: K, id: string): DocumentReference<ValidatorType<V[K]>>;
     /**
      * Create a new document with a random ID.
      * - Created document is guaranteed to have a unique ID.
@@ -27,148 +27,3 @@ export declare class Database<V extends Validators<Datas> = Validators<Datas>> {
      */
     add<K extends Key<V>>(collection: K, data: ValidatorType<V[K]>): string | PromiseLike<string>;
 }
-/** A documents reference within a specific database. */
-export declare class DatabaseQuery<T extends Data = Data> extends Query<T> implements Observable<Results<T>>, Validatable<Entries<T>>, Iterable<Entry<T>> {
-    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);
-    /** Reference a document in this query's collection. */
-    doc(id: string): DatabaseDocument<T>;
-    /**
-     * Create a new document with a random ID.
-     * - Created document is guaranteed to have a unique ID.
-     *
-     * @param data Complete data to set the document to.
-     * @return String ID for the created document (possibly promised).
-     */
-    add(data: T): string | PromiseLike<string>;
-    /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
-     */
-    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>>;
-    /**
-     * Count the number of results of this set of documents.
-     * @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.
-     *
-     * @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 an entry for 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>>;
-    /**
-     * 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.
-     */
-    subscribe(next: Observer<Results<T>> | Dispatcher<[Results<T>]>): Unsubscriber;
-    /**
-     * Set all matching documents to the same exact value.
-     *
-     * @param data Complete data to set the document to.
-     * @return Nothing (possibly promised).
-     */
-    set(data: T): number | PromiseLike<number>;
-    /**
-     * Update all matching documents with the same partial value.
-     *
-     * @param updates `Update` instance or set of updates to apply to every matching document.
-     * @return Nothing (possibly promised).
-     */
-    update(updates: DataUpdate<T> | PropUpdates<T>): number | PromiseLike<number>;
-    /**
-     * Delete all matching documents.
-     * @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;
-}
-/** Get the data for a document from a result for that document. */
-export declare function getQueryData<T extends Data>(entries: Entries<T>, ref: DatabaseQuery<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: DatabaseQuery<T>): DocumentResult<T>;
-/** A document reference within a specific database. */
-export declare class DatabaseDocument<T extends Data = Data> implements Observable<Result<T>>, Validatable<T> {
-    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): DatabaseQuery<T>;
-    /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
-    get optional(): DatabaseQuery<T>;
-    /**
-     * Does this document exist?
-     * @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(): DocumentResult<T> | PromiseLike<DocumentResult<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.
-     */
-    get data(): DocumentData<T> | PromiseLike<DocumentData<T>>;
-    /**
-     * Subscribe to the result of this document (indefinitely).
-     * - `next()` is called once with the initial result, and again any time the result changes.
-     *
-     * @param next Observer with `next`, `error`, or `complete` methods or a `next()` dispatcher.
-     * @return Function that ends the subscription.
-     */
-    subscribe(next: Observer<Result<T>> | Dispatcher<[Result<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;
-}
-/** Database data embeds the corresponding `Document` instance and string ID into the data. */
-export declare type DocumentData<T extends Data> = T & {
-    id: string;
-    doc: DatabaseDocument<T>;
-};
-/** Get the data for a document from a result for that document. */
-export declare function getDocumentData<T extends Data>(result: Result<T>, ref: DatabaseDocument<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;
-/** Get the data for a document from a result for that document. */
-export declare function getDocumentResult<T extends Data>(result: Result<T>, ref: DatabaseDocument<T>): DocumentResult<T>;

package/db/Database.js

@@ -1,8 +1,5 @@
-import { callAsync, getFirstItem, throwAsync, validate, getMap, countItems, hasItems, ResultsObserver, } from "../util/index.js";
-import { DataUpdate } from "../update/index.js";
-import { Feedback, InvalidFeedback } from "../feedback/index.js";
-import { Filters, Sorts, Query, Filter } from "../query/index.js";
-import { DocumentRequiredError, DocumentValidationError, QueryRequiredError, QueryValidationError } from "./errors.js";
+import { Filters, Sorts } from "../query/index.js";
+import { DocumentReference, QueryReference } from "./Reference.js";
 /**
  * Combines a database model and a provider.
  *
@@ -18,11 +15,11 @@ export class Database {
     }
     /** Create a query on a collection in this model. */
     query(collection, filters, sorts, limit) {
-        return new DatabaseQuery(this, this.validators[collection], collection, filters && Filters.on(filters), sorts && Sorts.on(sorts), limit);
+        return new QueryReference(this, this.validators[collection], collection, filters && Filters.on(filters), sorts && Sorts.on(sorts), limit);
     }
     /** Reference a document in a collection in this model. */
     doc(collection, id) {
-        return new DatabaseDocument(this, this.validators[collection], collection, id);
+        return new DocumentReference(this, this.validators[collection], collection, id);
     }
     /**
      * Create a new document with a random ID.
@@ -36,233 +33,3 @@ export class Database {
         return this.query(collection).add(data);
     }
 }
-/** A documents reference within a specific database. */
-export class DatabaseQuery extends Query {
-    constructor(db, validator, collection, filters, sorts, limit) {
-        super(filters, sorts, limit);
-        this.db = db;
-        this.validator = validator;
-        this.collection = collection;
-    }
-    /** Reference a document in this query's collection. */
-    doc(id) {
-        return new DatabaseDocument(this.db, this.validator, this.collection, id);
-    }
-    /**
-     * Create a new document with a random ID.
-     * - Created document is guaranteed to have a unique ID.
-     *
-     * @param data Complete data to set the document to.
-     * @return String ID for the created document (possibly promised).
-     */
-    add(data) {
-        return this.db.provider.add(this, data);
-    }
-    /**
-     * Get an iterable that yields the results of this entry.
-     * @return Map containing the results.
-     */
-    get entries() {
-        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);
-    }
-    /**
-     * 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.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.
-     * @throws RequiredError if there were no results for this query.
-     */
-    get result() {
-        return callAsync(getQueryResult, this.db.provider.getQuery(this.max(1)), this);
-    }
-    /**
-     * Get an entry for 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() {
-        return callAsync(getQueryData, this.db.provider.getQuery(this.max(1)), this);
-    }
-    /**
-     * 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.
-     */
-    subscribe(next) {
-        return this.db.provider.subscribeQuery(this, new ResultsObserver(typeof next === "function" ? { next } : next));
-    }
-    /**
-     * Set all matching documents to the same exact value.
-     *
-     * @param data Complete data to set the document to.
-     * @return Nothing (possibly promised).
-     */
-    set(data) {
-        return this.db.provider.setQuery(this, data);
-    }
-    /**
-     * Update all matching documents with the same partial value.
-     *
-     * @param updates `Update` instance or set of updates to apply to every matching document.
-     * @return Nothing (possibly promised).
-     */
-    update(updates) {
-        return this.db.provider.updateQuery(this, updates instanceof DataUpdate ? updates : new DataUpdate(updates));
-    }
-    /**
-     * Delete all matching documents.
-     * @return Nothing (possibly promised).
-     */
-    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()}`;
-    }
-}
-/** 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;
-    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;
-}
-/** A document reference within a specific database. */
-export class DatabaseDocument {
-    constructor(db, validator, collection, id) {
-        this.db = db;
-        this.validator = validator;
-        this.collection = collection;
-        this.id = id;
-    }
-    /** Create a query on this document's collection. */
-    query(filters, sorts, limit) {
-        return new DatabaseQuery(this.db, this.validator, this.collection, filters && Filters.on(filters), sorts && Sorts.on(sorts), limit);
-    }
-    /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
-    get optional() {
-        return new DatabaseQuery(this.db, this.validator, this.collection, new Filters(new Filter("id", "IS", this.id)));
-    }
-    /**
-     * Does this document exist?
-     * @return `true` if a document exists or `false` otherwise (possibly promised).
-     */
-    get exists() {
-        return callAsync(Boolean, this.db.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() {
-        return callAsync(getDocumentResult, this.db.provider.get(this), 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.
-     */
-    get data() {
-        return callAsync(getDocumentData, this.db.provider.get(this), this);
-    }
-    /**
-     * Subscribe to the result of this document (indefinitely).
-     * - `next()` is called once with the initial result, and again any time the result changes.
-     *
-     * @param next Observer with `next`, `error`, or `complete` methods or a `next()` dispatcher.
-     * @return Function that ends the subscription.
-     */
-    subscribe(next) {
-        return this.db.provider.subscribe(this, typeof next === "function" ? { next } : next);
-    }
-    /** Set the complete data of this document. */
-    set(data) {
-        return this.db.provider.set(this, data);
-    }
-    /** Update this document. */
-    update(updates) {
-        return this.db.provider.update(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;
-        }
-    }
-    // Implement toString()
-    toString() {
-        return `${this.collection}/${this.id}`;
-    }
-}
-/** Get the data for a document from a result for that document. */
-export function getDocumentData(result, ref) {
-    if (result)
-        return { ...result, id: ref.id, doc: ref };
-    throw new DocumentRequiredError(ref);
-}
-/** Get the data for a document from a result for that document. */
-export function getDocumentResult(result, ref) {
-    return result ? getDocumentData(result, ref) : null;
-}

package/db/Operation.d.ts

@@ -1,6 +1,7 @@
 import { PropUpdates, Update } from "../update/index.js";
 import { ImmutableArray, Nullish, Data, Key } from "../util/index.js";
-import type { Database, DatabaseDocument, DatabaseQuery } from "./Database.js";
+import type { Database } from "./Database.js";
+import type { DocumentReference, QueryReference } from "./Reference.js";
 /** Represent a write operation on a database. */
 export declare abstract class Operation {
     /** Run this operation and return the result operation. */
@@ -21,9 +22,9 @@ export declare class Operations extends Operation {
 /** Represent a add operation made to a collection in a database. */
 export declare class AddOperation<T extends Data> extends Operation {
     /** Create a new add operation on a collection. */
-    static on<X extends Data>({ collection }: DatabaseDocument<X> | DatabaseQuery<X>, data: X): AddOperation<X>;
+    static on<X extends Data>({ collection }: DocumentReference<X> | QueryReference<X>, data: X): AddOperation<X>;
     /** Run a new add operation on a collection and return the result operation. */
-    static run<X extends Data>({ collection, db }: DatabaseDocument<X> | DatabaseQuery<X>, data: X): Promise<SetOperation<X>>;
+    static run<X extends Data>({ collection, db }: DocumentReference<X> | QueryReference<X>, data: X): Promise<SetOperation<X>>;
     readonly collection: string;
     readonly data: T;
     constructor(collection: string, data: T);
@@ -34,9 +35,9 @@ export declare class AddOperation<T extends Data> extends Operation {
 /** Represent a set operation made to a single document in a database. */
 export declare class SetOperation<T extends Data> extends Operation {
     /** Create a new add operation on a collection. */
-    static on<X extends Data>({ collection, id }: DatabaseDocument<X>, data: X): SetOperation<X>;
+    static on<X extends Data>({ collection, id }: DocumentReference<X>, data: X): SetOperation<X>;
     /** Run a new set operation on a collection and return the result operation. */
-    static run<X extends Data>({ collection, id, db }: DatabaseDocument<X>, data: X): Promise<SetOperation<X>>;
+    static run<X extends Data>({ collection, id, db }: DocumentReference<X>, data: X): Promise<SetOperation<X>>;
     readonly collection: string;
     readonly id: string;
     readonly data: T;
@@ -48,9 +49,9 @@ export declare class SetOperation<T extends Data> extends Operation {
 /** Represent an update operation made to a single document in a database. */
 export declare class UpdateOperation<T extends Data> extends Operation {
     /** Create a new update operation on a document. */
-    static on<X extends Data>({ collection, id }: DatabaseDocument<X>, updates: PropUpdates<X>): UpdateOperation<X>;
+    static on<X extends Data>({ collection, id }: DocumentReference<X>, updates: PropUpdates<X>): UpdateOperation<X>;
     /** Run a new set operation on a collection and return the result operation. */
-    static run<X extends Data>({ collection, id, db }: DatabaseDocument<X>, updates: PropUpdates<X>): Promise<UpdateOperation<X>>;
+    static run<X extends Data>({ collection, id, db }: DocumentReference<X>, updates: PropUpdates<X>): Promise<UpdateOperation<X>>;
     readonly collection: string;
     readonly id: string;
     readonly updates: PropUpdates<T>;
@@ -62,9 +63,9 @@ export declare class UpdateOperation<T extends Data> extends Operation {
 /** Represent a delete operation made to a single document in a database. */
 export declare class DeleteOperation extends Operation {
     /** Create a new delete operation on a document. */
-    static on<X extends Data>({ collection, id }: DatabaseDocument<X>): DeleteOperation;
+    static on<X extends Data>({ collection, id }: DocumentReference<X>): DeleteOperation;
     /** Run a new delete operation on a document. */
-    static run<X extends Data>({ collection, id, db }: DatabaseDocument<X>): Promise<DeleteOperation>;
+    static run<X extends Data>({ collection, id, db }: DocumentReference<X>): Promise<DeleteOperation>;
     readonly collection: string;
     readonly id: string;
     constructor(collection: string, id: string);

package/db/PaginationState.d.ts

@@ -1,6 +1,6 @@
 import { Results, Entry, Entries, Data } from "../util/index.js";
 import { BooleanState, State } from "../stream/index.js";
-import { DatabaseQuery } from "./Database.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.
@@ -10,10 +10,10 @@ export declare class PaginationState<T extends Data> extends State<Results<T>> i
     /** Whether this pagination is currently loading results. */
     readonly busy: BooleanState;
     /** Reference to the query this pagination is paginating. */
-    readonly ref: DatabaseQuery<T>;
+    readonly ref: QueryReference<T>;
     /** Limit set on this pagination's query. */
     readonly limit: number;
-    constructor(ref: DatabaseQuery<T>);
+    constructor(ref: QueryReference<T>);
     /**
      * Load more results after the end.
      * - Promise that needs to be handled.

package/db/Reference.d.ts

@@ -0,0 +1,140 @@
+import { Entry, Observable, Observer, Result, Unsubscriber, Results, Validatable, Validator, Data, Entries, Dispatcher } from "../util/index.js";
+import { DataUpdate, PropUpdates } from "../update/index.js";
+import { Filters, Sorts, Query, FilterProps, SortKeys } from "../query/index.js";
+import { DocumentData, DocumentResult } from "./helpers.js";
+import type { Database } from "./Database.js";
+/** A refence to a location in a database. */
+export interface Reference {
+    readonly db: Database;
+    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 {
+    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);
+    /** Reference a document in this query's collection. */
+    doc(id: string): DocumentReference<T>;
+    /**
+     * Create a new document with a random ID.
+     * - Created document is guaranteed to have a unique ID.
+     *
+     * @param data Complete data to set the document to.
+     * @return String ID for the created document (possibly promised).
+     */
+    add(data: T): string | PromiseLike<string>;
+    /**
+     * Get an iterable that yields the results of this entry.
+     * @return Map containing the results.
+     */
+    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>>;
+    /**
+     * Count the number of results of this set of documents.
+     * @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.
+     *
+     * @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 an entry for 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>>;
+    /**
+     * 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.
+     */
+    subscribe(next: Observer<Results<T>> | Dispatcher<[Results<T>]>): Unsubscriber;
+    /**
+     * Set all matching documents to the same exact value.
+     *
+     * @param data Complete data to set the document to.
+     * @return Nothing (possibly promised).
+     */
+    set(data: T): number | PromiseLike<number>;
+    /**
+     * Update all matching documents with the same partial value.
+     *
+     * @param updates `Update` instance or set of updates to apply to every matching document.
+     * @return Nothing (possibly promised).
+     */
+    update(updates: DataUpdate<T> | PropUpdates<T>): number | PromiseLike<number>;
+    /**
+     * Delete all matching documents.
+     * @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 {
+    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>;
+    /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
+    get optional(): QueryReference<T>;
+    /**
+     * Does this document exist?
+     * @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(): DocumentResult<T> | PromiseLike<DocumentResult<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.
+     */
+    get data(): DocumentData<T> | PromiseLike<DocumentData<T>>;
+    /**
+     * Subscribe to the result of this document (indefinitely).
+     * - `next()` is called once with the initial result, and again any time the result changes.
+     *
+     * @param next Observer with `next`, `error`, or `complete` methods or a `next()` dispatcher.
+     * @return Function that ends the subscription.
+     */
+    subscribe(next: Observer<DocumentResult<T>> | Dispatcher<[DocumentResult<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;
+}