shelving 1.19.0 → 1.20.3

package/db/Change.d.ts

@@ -1,36 +1,34 @@
 import { Transforms, Transform } from "../transform/index.js";
-import { Datas, ImmutableArray, Key } from "../util/index.js";
-import type { Database, DatabaseDocument } from "./Database.js";
+import { ImmutableArray, Data } from "../util/index.js";
+import type { Database, DataDocument } from "./Database.js";
 /** A single change that can be made to a database. */
-export declare abstract class Change<T extends Datas> {
+export declare abstract class Change {
     /** Apply this change to a database. */
-    abstract apply(db: Database<T>): void | Promise<void>;
+    abstract apply(db: Database): void | PromiseLike<void>;
 }
 /** A change that writes a document in a database. */
-export declare class Write<D extends Datas, C extends Key<D>> extends Change<D> {
-    static on<X extends Datas, Y extends Key<X>>({ collection, id }: DatabaseDocument<X, Y>, value: X[Y] | Transform<X[Y]> | undefined): Write<X, Y>;
-    readonly collection: C;
+export declare class Write<T extends Data> extends Change {
+    readonly collection: string;
     readonly id: string;
-    readonly value: D[C] | Transform<D[C]> | undefined;
-    constructor(collection: C, id: string, value: D[C] | Transform<D[C]> | undefined);
-    apply(db: Database<D>): void | Promise<void>;
+    readonly value: Data | Transform<Data> | undefined;
+    constructor({ collection, id }: DataDocument<T>, value: T | Transform<T> | undefined);
+    apply(db: Database): void | PromiseLike<void>;
 }
 /**
  * Set of writes that can be applied to documents in a database.
  * - Sets of changes are predictable and repeatable, so unpredictable operations like `create()` and query operations are not supported.
  * - Every change must be applied to a specific database document in a specific collection.
  */
-export declare class Writes<D extends Datas> extends Change<D> {
-    static on<X extends Datas>(db: Database<X>, ...changes: ImmutableArray<Change<X>>): Writes<X>;
-    readonly changes: ImmutableArray<Change<D>>;
-    constructor(...changes: ImmutableArray<Change<D>>);
+export declare class Writes extends Change {
+    readonly changes: ImmutableArray<Change>;
+    constructor(...changes: Change[]);
     /** Return a new `Changes` instance with an additional `Write` instance in its changes list. */
-    set<C extends Key<D>>({ collection, id }: DatabaseDocument<D, C>, data: D[C]): this;
+    set<T extends Data>(ref: DataDocument<T>, data: T): this;
     /** Return a new `Changes` instance with an additional `Write` instance in its changes list. */
-    delete<C extends Key<D>>({ collection, id }: DatabaseDocument<D, C>): this;
+    delete<T extends Data>(ref: DataDocument<T>): this;
     /** Return a new `Changes` instance with an additional `Write` instance in its changes list. */
-    update<C extends Key<D>>({ collection, id }: DatabaseDocument<D, C>, transforms: Transforms<D[C]> | Transform<D[C]>): this;
-    apply(db: Database<D>): Promise<void> | undefined;
+    update<T extends Data>(ref: DataDocument<T>, transforms: Transforms<T> | Transform<T>): this;
+    apply(db: Database): Promise<void> | undefined;
 }
 /** Set of hydrations for all change classes. */
 export declare const CHANGE_HYDRATIONS: {

package/db/Change.js

@@ -5,15 +5,12 @@ export class Change {
 }
 /** A change that writes a document in a database. */
 export class Write extends Change {
-    constructor(collection, id, value) {
+    constructor({ collection, id }, value) {
         super();
         this.collection = collection;
         this.id = id;
         this.value = value;
     }
-    static on({ collection, id }, value) {
-        return new Write(collection, id, value);
-    }
     apply(db) {
         return db.doc(this.collection, this.id).write(this.value);
     }
@@ -28,23 +25,20 @@ export class Writes extends Change {
         super();
         this.changes = changes;
     }
-    static on(db, ...changes) {
-        return new Writes(...changes);
-    }
     /** Return a new `Changes` instance with an additional `Write` instance in its changes list. */
-    set({ collection, id }, data) {
-        return { __proto__: Object.getPrototypeOf(this), ...this, changes: [...this.changes, new Write(collection, id, data)] };
+    set(ref, data) {
+        return { __proto__: Object.getPrototypeOf(this), ...this, changes: [...this.changes, new Write(ref, data)] };
     }
     /** Return a new `Changes` instance with an additional `Write` instance in its changes list. */
-    delete({ collection, id }) {
-        return { __proto__: Object.getPrototypeOf(this), ...this, changes: [...this.changes, new Write(collection, id, undefined)] };
+    delete(ref) {
+        return { __proto__: Object.getPrototypeOf(this), ...this, changes: [...this.changes, new Write(ref, undefined)] };
     }
     /** Return a new `Changes` instance with an additional `Write` instance in its changes list. */
-    update({ collection, id }, transforms) {
+    update(ref, transforms) {
         return {
             __proto__: Object.getPrototypeOf(this),
             ...this,
-            changes: [...this.changes, new Write(collection, id, transforms instanceof Transform ? transforms : new DataTransform(transforms))],
+            changes: [...this.changes, new Write(ref, transforms instanceof Transform ? transforms : new DataTransform(transforms))],
         };
     }
     apply(db) {

package/db/Database.d.ts

@@ -1,4 +1,4 @@
-import { Dispatcher, Entry, Observable, Observer, Result, Unsubscriber, Datas, Results, Validatable, Validator, Validators, Key, Data, ImmutableMap } from "../util/index.js";
+import { Dispatcher, Entry, Observable, Observer, Result, Unsubscriber, ResultsMap, Validatable, Validator, Key, Data, Results, Datas, Validators, ValidatorType } from "../util/index.js";
 import { Transform, Transforms } from "../transform/index.js";
 import type { Provider } from "../provider/Provider.js";
 import { Filters, Sorts, Query } from "../query/index.js";
@@ -9,23 +9,23 @@ import { Filters, Sorts, Query } from "../query/index.js";
  * @param collections Set of loci describing collections at the root level of the database.
  * @param provider Provider that allows data to be read/written.
  */
-export declare class Database<D extends Datas> {
-    readonly validators: Validators<D>;
-    readonly provider: Provider<D>;
-    constructor(validators: Validators<D>, provider: Provider<D>);
+export declare class Database<V extends Validators<Datas> = Validators<Datas>> {
+    readonly validators: V;
+    readonly provider: Provider;
+    constructor(validators: V, provider: Provider);
     /** Create a query on a collection in this model. */
-    query<C extends Key<D>>(collection: C, filters?: Filters<D[C]>, sorts?: Sorts<D[C]>, limit?: number | null): DatabaseQuery<D, C>;
+    query<K extends Key<V>>(collection: K, filters?: Filters<ValidatorType<V[K]>>, sorts?: Sorts<ValidatorType<V[K]>>, limit?: number | null): DataQuery<ValidatorType<V[K]>>;
     /** Reference a document in a collection in this model. */
-    doc<C extends Key<D>>(collection: C, id: string): DatabaseDocument<D, C>;
+    doc<K extends Key<V>>(collection: K, id: string): DataDocument<ValidatorType<V[K]>>;
 }
 /** A documents reference within a specific database. */
-export declare class DatabaseQuery<D extends Datas, C extends Key<D>> extends Query<D[C]> implements Observable<Results<D[C]>>, Validatable<Results<D[C]>>, Iterable<Entry<D[C]>> {
-    readonly db: Database<D>;
-    readonly validator: Validator<D[C]>;
-    readonly collection: C;
-    constructor(db: Database<D>, collection: C, filters?: Filters<D[C]>, sorts?: Sorts<D[C]>, limit?: number | null);
+export declare class DataQuery<T extends Data = Data> extends Query<T> implements Observable<Results<T>>, Validatable<Results<T>>, Iterable<Entry<T>> {
+    readonly provider: Provider;
+    readonly validator: Validator<T>;
+    readonly collection: string;
+    constructor(provider: Provider, validator: Validator<T>, collection: string, filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null);
     /** Reference a document in this query's collection. */
-    doc(id: string): DatabaseDocument<D, C>;
+    doc(id: string): DataDocument<T>;
     /**
      * Create a new document with a random ID.
      * - Created document is guaranteed to have a unique ID.
@@ -33,22 +33,27 @@ export declare class DatabaseQuery<D extends Datas, C extends Key<D>> extends Qu
      * @param data Complete data to set the document to.
      * @return String ID for the created document (possibly promised).
      */
-    add(data: D[C]): string | Promise<string>;
+    add(data: T): string | PromiseLike<string>;
     /**
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
-    get results(): Results<D[C]> | Promise<Results<D[C]>>;
+    get results(): Results<T> | PromiseLike<Results<T>>;
     /**
-     * Read the results of this query into a map.
-     * @return Set of results in `id: data` format (possibly promised).
+     * Get an iterable that yields the results of this entry.
+     * @return Map containing the results.
      */
-    get map(): ImmutableMap<D[C]> | Promise<ImmutableMap<D[C]>>;
+    get resultsMap(): ResultsMap<T> | PromiseLike<ResultsMap<T>>;
     /**
      * Count the number of results of this set of documents.
      * @return Number of documents in the collection (possibly promised).
      */
-    get count(): number | Promise<number>;
+    get count(): number | PromiseLike<number>;
+    /**
+     * Get an entry for the first document matching this query.
+     * @return Entry in `[id, data]` format for the first document, or `undefined` if there are no matching documents (possibly promised).
+     */
+    get first(): Entry<T> | undefined | PromiseLike<Entry<T> | undefined>;
     /**
      * Subscribe to all matching documents.
      * - `next()` is called once with the initial results, and again any time the results change.
@@ -60,19 +65,26 @@ export declare class DatabaseQuery<D extends Datas, C extends Key<D>> extends Qu
      *
      * @return Function that ends the subscription.
      */
-    subscribe(next: Observer<Results<D[C]>> | Dispatcher<Results<D[C]>>, error?: Dispatcher<Error | unknown>, complete?: Dispatcher<void>): Unsubscriber;
+    subscribe(next: Observer<Results<T>> | Dispatcher<Results<T>>, error?: Dispatcher<Error | unknown>, complete?: Dispatcher<void>): Unsubscriber;
     /**
-     * Get an entry for the first document matching this query.
-     * @return Entry in `[id, data]` format for the first document, or `undefined` if there are no matching documents (possibly promised).
+     * Subscribe to all matching documents.
+     * - `next()` is called once with the initial results, and again any time the results change.
+     *
+     * @param observer Observer with `next`, `error`, or `complete` methods that the document results are reported back to.
+     * @param next Callback that is called once initially and again whenever the results change.
+     * @param error Callback that is called if an error occurs.
+     * @param complete Callback that is called when the subscription is done.
+     *
+     * @return Function that ends the subscription.
      */
-    get first(): Entry<D[C]> | undefined | Promise<Entry<D[C]> | undefined>;
+    subscribeMap(next: Observer<ResultsMap<T>> | Dispatcher<ResultsMap<T>>, error?: Dispatcher<Error | unknown>, complete?: Dispatcher<void>): 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: D[C]): void | Promise<void>;
+    set(data: T): void | PromiseLike<void>;
     /**
      * Update all matching documents with the same partial value.
      *
@@ -81,46 +93,46 @@ export declare class DatabaseQuery<D extends Datas, C extends Key<D>> extends Qu
      *
      * @return Nothing (possibly promised).
      */
-    update(transform: Transform<D[C]> | Transforms<D[C]>): void | Promise<void>;
+    update(transform: Transform<T> | Transforms<T>): void | PromiseLike<void>;
     /**
      * Delete all matching documents.
      * @return Nothing (possibly promised).
      */
-    delete(): void | Promise<void>;
+    delete(): void | PromiseLike<void>;
     /**
      * Combine `set()`, `update()`, `delete()` into a single method.
      * @return Nothing (possibly promised).
      */
-    write(value: Result<D[C]> | Transform<D[C]>): void | Promise<void>;
+    write(value: Result<T> | Transform<T>): void | PromiseLike<void>;
     /** Iterate over the resuls (will throw `Promise` if the results are asynchronous). */
-    [Symbol.iterator](): Iterator<Entry<D[C]>, void>;
+    [Symbol.iterator](): Iterator<Entry<T>, void>;
     /** Validate a set of results for this query reference. */
-    validate(unsafeEntries: Results): Results<D[C]>;
+    validate(unsafeEntries: Results): Results<T>;
     toString(): string;
 }
 /** A document reference within a specific database. */
-export declare class DatabaseDocument<D extends Datas, C extends Key<D>> implements Observable<Result<D[C]>>, Validatable<D[C]> {
-    readonly db: Database<D>;
-    readonly validator: Validator<D[C]>;
-    readonly collection: C;
+export declare class DataDocument<T extends Data = Data> implements Observable<Result<T>>, Validatable<T> {
+    readonly provider: Provider;
+    readonly validator: Validator<T>;
+    readonly collection: string;
     readonly id: string;
-    constructor(db: Database<D>, collection: C, id: string);
+    constructor(provider: Provider, validator: Validator<T>, collection: string, id: string);
     /** Create a query on this document's collection. */
-    query(filters?: Filters<D[C]>, sorts?: Sorts<D[C]>, limit?: number | null): DatabaseQuery<D, C>;
+    query(filters?: Filters<T>, sorts?: Sorts<T>, limit?: number | null): DataQuery<T>;
     /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
-    get optional(): DatabaseQuery<D, C>;
+    get optional(): DataQuery<T>;
     /**
      * Does this document exist?
      *
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
-    get exists(): boolean | Promise<boolean>;
+    get exists(): boolean | PromiseLike<boolean>;
     /**
      * Get the result of this document.
      *
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
-    get result(): Result<D[C]> | Promise<Result<D[C]>>;
+    get result(): Result<T> | PromiseLike<Result<T>>;
     /**
      * Get the data of this document.
      * - Useful for destructuring, e.g. `{ name, title } = await documentThatMustExist.asyncData`
@@ -128,7 +140,7 @@ export declare class DatabaseDocument<D extends Datas, C extends Key<D>> impleme
      * @return Document's data (possibly promised).
      * @throws RequiredError if the document's result was undefined.
      */
-    get data(): D[C] | Promise<D[C]>;
+    get data(): T | PromiseLike<T>;
     /**
      * Subscribe to the result of this document (indefinitely).
      * - `next()` is called once with the initial result, and again any time the result changes.
@@ -140,7 +152,7 @@ export declare class DatabaseDocument<D extends Datas, C extends Key<D>> impleme
      *
      * @return Function that ends the subscription.
      */
-    subscribe(next: Observer<Result<D[C]>> | Dispatcher<Result<D[C]>>, error?: Dispatcher<Error | unknown>, complete?: Dispatcher<void>): Unsubscriber;
+    subscribe(next: Observer<Result<T>> | Dispatcher<Result<T>>, error?: Dispatcher<Error | unknown>, complete?: Dispatcher<void>): Unsubscriber;
     /**
      * Set the complete data of this document.
      *
@@ -148,7 +160,7 @@ export declare class DatabaseDocument<D extends Datas, C extends Key<D>> impleme
      *
      * @return Nothing (possibly promised).
      */
-    set(data: D[C]): void | Promise<void>;
+    set(data: T): void | PromiseLike<void>;
     /**
      * Update this document with partial data.
      * - If the document exists, merge the partial data into it.
@@ -160,19 +172,21 @@ export declare class DatabaseDocument<D extends Datas, C extends Key<D>> impleme
      * @return Nothing (possibly promised).
      * @throws Error If the document does not exist (ideally a `RequiredError` but may be provider-specific).
      */
-    update(transforms: Transform<D[C]> | Transforms<D[C]>): void | Promise<void>;
+    update(transforms: Transform<T> | Transforms<T>): void | PromiseLike<void>;
     /**
      * Delete this document.
      * - Will not throw an error if the document doesn't exist.
      *
      * @return Nothing (possibly promised).
      */
-    delete(): void | Promise<void>;
+    delete(): void | PromiseLike<void>;
     /**
      * Combine `set()`, `update()`, `delete()` into a single method.
      */
-    write(value: Result<D[C]> | Transform<D[C]>): void | Promise<void>;
+    write(value: Result<T> | Transform<T>): void | PromiseLike<void>;
     /** Validate data for this query reference. */
-    validate(unsafeData: Data): D[C];
+    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>(result: Result<T>, ref: DataDocument<T>): T;

package/db/Database.js

@@ -1,4 +1,4 @@
-import { deriveAsync, createObserver, getFirstItem, isAsync, throwAsync, validate, toMap, countItems, } from "../util/index.js";
+import { callAsync, createObserver, getFirstItem, throwAsync, validate, toMap, countItems, DeriveObserver, } from "../util/index.js";
 import { DataTransform, Transform } from "../transform/index.js";
 import { Feedback, InvalidFeedback } from "../feedback/index.js";
 import { Filters, Query, EqualFilter } from "../query/index.js";
@@ -10,6 +10,7 @@ import { DocumentRequiredError, DocumentValidationError, QueryValidationError }
  * @param collections Set of loci describing collections at the root level of the database.
  * @param provider Provider that allows data to be read/written.
  */
+// Note: typing this with `Validators` rather than raw `Datas` works better for inference — type for props in each collection tends to get lost.
 export class Database {
     constructor(validators, provider) {
         this.validators = validators;
@@ -17,24 +18,24 @@ export class Database {
     }
     /** Create a query on a collection in this model. */
     query(collection, filters, sorts, limit) {
-        return new DatabaseQuery(this, collection, filters, sorts, limit);
+        return new DataQuery(this.provider, this.validators[collection], collection, filters, sorts, limit);
     }
     /** Reference a document in a collection in this model. */
     doc(collection, id) {
-        return new DatabaseDocument(this, collection, id);
+        return new DataDocument(this.provider, this.validators[collection], collection, id);
     }
 }
 /** A documents reference within a specific database. */
-export class DatabaseQuery extends Query {
-    constructor(db, collection, filters, sorts, limit) {
+export class DataQuery extends Query {
+    constructor(provider, validator, collection, filters, sorts, limit) {
         super(filters, sorts, limit);
-        this.db = db;
-        this.validator = db.validators[collection];
+        this.provider = provider;
+        this.validator = validator;
         this.collection = collection;
     }
     /** Reference a document in this query's collection. */
     doc(id) {
-        return new DatabaseDocument(this.db, this.collection, id);
+        return new DataDocument(this.provider, this.validator, this.collection, id);
     }
     /**
      * Create a new document with a random ID.
@@ -44,28 +45,35 @@ export class DatabaseQuery extends Query {
      * @return String ID for the created document (possibly promised).
      */
     add(data) {
-        return this.db.provider.add(this, data);
+        return this.provider.add(this, data);
     }
     /**
      * Get an iterable that yields the results of this entry.
      * @return Map containing the results.
      */
     get results() {
-        return this.db.provider.getQuery(this);
+        return this.provider.getQuery(this);
     }
     /**
-     * Read the results of this query into a map.
-     * @return Set of results in `id: data` format (possibly promised).
+     * Get an iterable that yields the results of this entry.
+     * @return Map containing the results.
      */
-    get map() {
-        return deriveAsync(this.db.provider.getQuery(this), toMap);
+    get resultsMap() {
+        return callAsync(toMap, this.provider.getQuery(this));
     }
     /**
      * Count the number of results of this set of documents.
      * @return Number of documents in the collection (possibly promised).
      */
     get count() {
-        return deriveAsync(this.db.provider.getQuery(this), countItems);
+        return callAsync(countItems, this.results);
+    }
+    /**
+     * Get an entry for the first document matching this query.
+     * @return Entry in `[id, data]` format for the first document, or `undefined` if there are no matching documents (possibly promised).
+     */
+    get first() {
+        return callAsync(getFirstItem, this.max(1).results);
     }
     /**
      * Subscribe to all matching documents.
@@ -79,14 +87,21 @@ export class DatabaseQuery extends Query {
      * @return Function that ends the subscription.
      */
     subscribe(next, error, complete) {
-        return this.db.provider.subscribeQuery(this, createObserver(next, error, complete));
+        return this.provider.subscribeQuery(this, createObserver(next, error, complete));
     }
     /**
-     * Get an entry for the first document matching this query.
-     * @return Entry in `[id, data]` format for the first document, or `undefined` if there are no matching documents (possibly promised).
+     * Subscribe to all matching documents.
+     * - `next()` is called once with the initial results, and again any time the results change.
+     *
+     * @param observer Observer with `next`, `error`, or `complete` methods that the document results are reported back to.
+     * @param next Callback that is called once initially and again whenever the results change.
+     * @param error Callback that is called if an error occurs.
+     * @param complete Callback that is called when the subscription is done.
+     *
+     * @return Function that ends the subscription.
      */
-    get first() {
-        return deriveAsync(this.max(1).results, getFirstItem);
+    subscribeMap(next, error, complete) {
+        return this.provider.subscribeQuery(this, new DeriveObserver(toMap, createObserver(next, error, complete)));
     }
     /**
      * Set all matching documents to the same exact value.
@@ -120,7 +135,7 @@ export class DatabaseQuery extends Query {
      * @return Nothing (possibly promised).
      */
     write(value) {
-        return this.db.provider.writeQuery(this, value);
+        return this.provider.writeQuery(this, value);
     }
     /** Iterate over the resuls (will throw `Promise` if the results are asynchronous). */
     [Symbol.iterator]() {
@@ -150,20 +165,20 @@ export class DatabaseQuery extends Query {
     }
 }
 /** A document reference within a specific database. */
-export class DatabaseDocument {
-    constructor(db, collection, id) {
-        this.db = db;
-        this.validator = db.validators[collection];
+export class DataDocument {
+    constructor(provider, validator, collection, id) {
+        this.provider = provider;
+        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.collection, filters, sorts, limit);
+        return new DataQuery(this.provider, this.validator, this.collection, filters, sorts, limit);
     }
     /** Get an 'optional' reference to this document (uses a `ModelQuery` with an `id` filter). */
     get optional() {
-        return new DatabaseQuery(this.db, this.collection, new Filters(new EqualFilter("id", this.id)));
+        return new DataQuery(this.provider, this.validator, this.collection, new Filters(new EqualFilter("id", this.id)));
     }
     /**
      * Does this document exist?
@@ -171,8 +186,7 @@ export class DatabaseDocument {
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
     get exists() {
-        const result = this.db.provider.get(this);
-        return isAsync(result) ? result.then(Boolean) : !!result;
+        return callAsync(Boolean, this.provider.get(this));
     }
     /**
      * Get the result of this document.
@@ -180,7 +194,7 @@ export class DatabaseDocument {
      * @return Document's data, or `undefined` if the document doesn't exist (possibly promised).
      */
     get result() {
-        return this.db.provider.get(this);
+        return this.provider.get(this);
     }
     /**
      * Get the data of this document.
@@ -190,12 +204,7 @@ export class DatabaseDocument {
      * @throws RequiredError if the document's result was undefined.
      */
     get data() {
-        const result = this.db.provider.get(this);
-        if (isAsync(result))
-            return _awaitRequired(this, result);
-        if (!result)
-            throw new DocumentRequiredError(this);
-        return result;
+        return callAsync(getDocumentData, this.provider.get(this), this);
     }
     /**
      * Subscribe to the result of this document (indefinitely).
@@ -209,7 +218,7 @@ export class DatabaseDocument {
      * @return Function that ends the subscription.
      */
     subscribe(next, error, complete) {
-        return this.db.provider.subscribe(this, createObserver(next, error, complete));
+        return this.provider.subscribe(this, createObserver(next, error, complete));
     }
     /**
      * Set the complete data of this document.
@@ -248,7 +257,7 @@ export class DatabaseDocument {
      * Combine `set()`, `update()`, `delete()` into a single method.
      */
     write(value) {
-        return this.db.provider.write(this, value);
+        return this.provider.write(this, value);
     }
     /** Validate data for this query reference. */
     validate(unsafeData) {
@@ -264,10 +273,9 @@ export class DatabaseDocument {
         return `${this.collection}/${this.id}`;
     }
 }
-/** Wait for a result and throw a `DocumentRequiredError` if the document doesn't exist. */
-async function _awaitRequired(ref, asyncResult) {
-    const result = await asyncResult;
-    if (!result)
-        throw new DocumentRequiredError(ref);
-    return result;
+/** Get the data for a document from a result for that document. */
+export function getDocumentData(result, ref) {
+    if (result)
+        return result;
+    throw new DocumentRequiredError(ref);
 }

package/db/Pagination.d.ts

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