shelving 1.10.2 → 1.12.1

package/api/Resource.d.ts

@@ -1,5 +1,4 @@
-import type { Arguments, AsyncFetcher } from "../util";
-import type { Validator } from "../schema";
+import type { Arguments, AsyncFetcher, Validator } from "../util";
 /**
  * An abstract API resource definition, used to specify types for e.g. serverless functions..
  *

package/db/Database.d.ts

@@ -1,5 +1,4 @@
-import type { Datas } from "../util/data";
-import type { Validators } from "../schema";
+import type { Datas, Validators } from "../util";
 import type { Provider } from "./Provider";
 import { Document } from "./Document";
 import { Documents } from "./Documents";

package/db/Document.js

@@ -1,4 +1,4 @@
-import { throwAsync, isAsync, } from "../util";
+import { throwAsync, isAsync, createObserver, } from "../util";
 import { DocumentState } from "./DocumentState";
 import { ReferenceRequiredError } from "./errors";
 import { Reference } from "./Reference";
@@ -94,7 +94,7 @@ export class Document extends Reference {
         return DocumentState.get(this);
     }
     subscribe(next, error, complete) {
-        return typeof next === "object" ? this.db.provider.onDocument(this, next) : this.db.provider.onDocument(this, { next, error, complete });
+        return this.db.provider.onDocument(this, createObserver(next, error, complete));
     }
     /**
      * Set the complete data of this document.

package/db/DocumentState.d.ts

@@ -26,16 +26,20 @@ export declare class DocumentState<T extends Data = Data> extends State<Result<T
      */
     stop(): void;
     /**
-     * Force refresh this state from the source provider.
+     * Refresh the state.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is undefined or falsy, always refresh the state.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
      */
-    refresh(): void;
+    refresh(maxAge?: number | true): void;
     /**
-     * Conditionally refresh a documents state if it's outdated.
-     * @param maxAge
-     * - If `maxAge` is a number this specifies how old (in milliseconds the data can be before a refresh will be issued).
-     * - If `maxAge` is `true` this will start a realtime subscription to the data that lasts for ten seconds.
+     * Get the current value, or refetch the data again if it's outdated.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
      */
-    refreshOutdated(maxAge: number | true): void;
+    get(maxAge?: number): Result<T> | Promise<Result<T>>;
     protected dispatchError(reason: Error | unknown): void;
     protected dispatchComplete(): void;
 }

package/db/DocumentState.js

@@ -67,15 +67,17 @@ export class DocumentState extends State {
      * - The realtime subscription will clean itself up when the last observer unsubscribes.
      */
     start(observer) {
+        var _b;
         if (this.closed)
             throw new StreamClosedError(this);
-        __classPrivateFieldSet(this, _DocumentState_realtime, +__classPrivateFieldGet(this, _DocumentState_realtime, "f") + 1, "f");
+        __classPrivateFieldSet(this, _DocumentState_realtime, (_b = __classPrivateFieldGet(this, _DocumentState_realtime, "f"), _b++, _b), "f");
         if (!__classPrivateFieldGet(this, _DocumentState_stop, "f"))
             __classPrivateFieldSet(this, _DocumentState_stop, __classPrivateFieldGet(this, _DocumentState_ref, "f").subscribe(this), "f");
         if (observer)
             this.on(observer);
         return () => {
-            __classPrivateFieldSet(this, _DocumentState_realtime, +__classPrivateFieldGet(this, _DocumentState_realtime, "f") - 1, "f");
+            var _b;
+            __classPrivateFieldSet(this, _DocumentState_realtime, (_b = __classPrivateFieldGet(this, _DocumentState_realtime, "f"), _b--, _b), "f");
             if (__classPrivateFieldGet(this, _DocumentState_realtime, "f") <= 0)
                 this.stop();
             if (observer)
@@ -91,20 +93,13 @@ export class DocumentState extends State {
             __classPrivateFieldSet(this, _DocumentState_stop, void dispatch(__classPrivateFieldGet(this, _DocumentState_stop, "f")), "f");
     }
     /**
-     * Force refresh this state from the source provider.
+     * Refresh the state.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is undefined or falsy, always refresh the state.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
      */
-    refresh() {
-        if (this.closed)
-            throw new StreamClosedError(this);
-        this.next(__classPrivateFieldGet(this, _DocumentState_ref, "f").get());
-    }
-    /**
-     * Conditionally refresh a documents state if it's outdated.
-     * @param maxAge
-     * - If `maxAge` is a number this specifies how old (in milliseconds the data can be before a refresh will be issued).
-     * - If `maxAge` is `true` this will start a realtime subscription to the data that lasts for ten seconds.
-     */
-    refreshOutdated(maxAge) {
+    refresh(maxAge) {
         if (this.closed)
             throw new StreamClosedError(this);
         // No need to refresh if there's an active subscription.
@@ -114,12 +109,27 @@ export class DocumentState extends State {
                 setTimeout(this.start(), 10000);
             }
             else {
-                // Fetch the refeshed data once if there isn't an existing subscription, and a fetch isn't already pending, and the data is older than `maxAge`
-                if (!this.pending && this.age < maxAge)
-                    this.refresh();
+                // Refresh the data if a fetch isn't already pending, and either `maxAge` is falsy or the existing state is older than `maxAge`
+                if (!this.pending && (!maxAge || this.age > maxAge))
+                    this.next(__classPrivateFieldGet(this, _DocumentState_ref, "f").get());
             }
         }
     }
+    /**
+     * Get the current value, or refetch the data again if it's outdated.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
+     */
+    get(maxAge = 0) {
+        // Return the current state if its not loading and there's a subscription or the existing state is younger than `maxAge`
+        if (!this.loading && (__classPrivateFieldGet(this, _DocumentState_stop, "f") || this.age < maxAge))
+            return this.value;
+        // Refresh the state and return the next value after the refresh.
+        const next = __classPrivateFieldGet(this, _DocumentState_ref, "f").get();
+        this.next(next);
+        return next;
+    }
     // Override to stop any realtime subscription on error or complete.
     dispatchError(reason) {
         this.stop();

package/db/Documents.js

@@ -1,4 +1,4 @@
-import { throwAsync, isAsync, countEntries, getFirstProp, getLastProp, } from "../util";
+import { throwAsync, isAsync, countEntries, getFirstProp, getLastProp, createObserver, } from "../util";
 import { Query } from "../query";
 import { Document } from "./Document";
 import { DocumentsState } from "./DocumentsState";
@@ -94,7 +94,7 @@ export class Documents extends Reference {
         return isAsync(results) ? results.then(Object.keys) : Object.keys(results);
     }
     subscribe(next, error, complete) {
-        return typeof next === "object" ? this.db.provider.onDocuments(this, next) : this.db.provider.onDocuments(this, { next, error, complete });
+        return this.db.provider.onDocuments(this, createObserver(next, error, complete));
     }
     /**
      * Get an entry for the first result in this set of documents (synchronously).

package/db/DocumentsState.d.ts

@@ -25,15 +25,21 @@ export declare class DocumentsState<T extends Data = Data> extends State<Results
      */
     stop(): void;
     /**
-     * Force refresh this state from the source provider.
+     * Refresh the state.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is undefined or falsy, always refresh the state.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
      */
-    refresh(): void;
+    refresh(maxAge?: number | true): void;
     /**
-     * Conditionally refresh a documents state if it's outdated.
-     * @param maxAge
-     * - If `maxAge` is a number this specifies how old (in milliseconds
+     * Get the current value, or refetch the data again if it's outdated.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is undefined or falsy, always return fresh state.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
      */
-    refreshOutdated(maxAge: number | true): void;
+    get(maxAge?: number): Results<T> | Promise<Results<T>>;
     protected dispatchNext(results: Results<T>): void;
     protected dispatchError(reason: Error | unknown): void;
     protected dispatchComplete(): void;

package/db/DocumentsState.js

@@ -11,7 +11,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _a, _DocumentsState_states, _DocumentsState_ref, _DocumentsState_realtime, _DocumentsState_stop;
 import { AssertionError } from "../errors";
-import { State } from "../stream";
+import { State, StreamClosedError } from "../stream";
 import { dispatch, LOADING } from "../util";
 import { DocumentState } from "./DocumentState";
 /**
@@ -63,15 +63,17 @@ export class DocumentsState extends State {
      * - The realtime subscription will clean itself up when the last observer unsubscribes.
      */
     start(observer) {
+        var _b;
         if (!this.closed)
             throw new AssertionError("State must not be closed", this.closed);
-        __classPrivateFieldSet(this, _DocumentsState_realtime, +__classPrivateFieldGet(this, _DocumentsState_realtime, "f") + 1, "f");
+        __classPrivateFieldSet(this, _DocumentsState_realtime, (_b = __classPrivateFieldGet(this, _DocumentsState_realtime, "f"), _b++, _b), "f");
         if (!__classPrivateFieldGet(this, _DocumentsState_stop, "f"))
             __classPrivateFieldSet(this, _DocumentsState_stop, __classPrivateFieldGet(this, _DocumentsState_ref, "f").subscribe(this), "f");
         if (observer)
             this.on(observer);
         return () => {
-            __classPrivateFieldSet(this, _DocumentsState_realtime, +__classPrivateFieldGet(this, _DocumentsState_realtime, "f") - 1, "f");
+            var _b;
+            __classPrivateFieldSet(this, _DocumentsState_realtime, (_b = __classPrivateFieldGet(this, _DocumentsState_realtime, "f"), _b--, _b), "f");
             if (__classPrivateFieldGet(this, _DocumentsState_realtime, "f") <= 0)
                 this.stop();
             if (observer)
@@ -87,17 +89,15 @@ export class DocumentsState extends State {
             __classPrivateFieldSet(this, _DocumentsState_stop, void dispatch(__classPrivateFieldGet(this, _DocumentsState_stop, "f")), "f");
     }
     /**
-     * Force refresh this state from the source provider.
-     */
-    refresh() {
-        this.next(__classPrivateFieldGet(this, _DocumentsState_ref, "f").get());
-    }
-    /**
-     * Conditionally refresh a documents state if it's outdated.
-     * @param maxAge
-     * - If `maxAge` is a number this specifies how old (in milliseconds
+     * Refresh the state.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is undefined or falsy, always refresh the state.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
      */
-    refreshOutdated(maxAge) {
+    refresh(maxAge) {
+        if (this.closed)
+            throw new StreamClosedError(this);
         // No need to refresh if there's an active subscription.
         if (!__classPrivateFieldGet(this, _DocumentsState_stop, "f")) {
             if (maxAge === true) {
@@ -105,12 +105,28 @@ export class DocumentsState extends State {
                 setTimeout(__classPrivateFieldGet(this, _DocumentsState_ref, "f").subscribe({}), 10000);
             }
             else {
-                // Fetch the refeshed data once if there isn't an existing subscription, and a fetch isn't already pending, and the data is older than `maxAge`
-                if (!this.pending && this.age < maxAge)
-                    this.refresh();
+                // Refresh the data if a fetch isn't already pending, and either `maxAge` is falsy or the existing state is older than `maxAge`
+                if (!this.pending && (!maxAge || this.age > maxAge))
+                    this.next(__classPrivateFieldGet(this, _DocumentsState_ref, "f").get());
             }
         }
     }
+    /**
+     * Get the current value, or refetch the data again if it's outdated.
+     * @param maxAge How old the data can be before it's outdated.
+     * - If `maxAge` is undefined or falsy, always return fresh state.
+     * - If `maxAge` is a number this specifies how old (in milliseconds) the data can be before it's refreshed.
+     * - If `maxAge` is `true` a subscription to the data is started for 10 seconds.
+     */
+    get(maxAge = 0) {
+        // Return the current state if its not loading and there's a subscription or the existing state is younger than `maxAge`
+        if (!this.loading && (__classPrivateFieldGet(this, _DocumentsState_stop, "f") || this.age < maxAge))
+            return this.value;
+        // Refresh the state and return the next value after the refresh.
+        const next = __classPrivateFieldGet(this, _DocumentsState_ref, "f").get();
+        this.next(next);
+        return next;
+    }
     // Override dispatchNext to set the state for every individual document too.
     dispatchNext(results) {
         super.dispatchNext(results);

package/db/Pagination.js

@@ -4,6 +4,9 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
 var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
     if (kind === "m") throw new TypeError("Private method is not writable");
     if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
@@ -91,8 +94,14 @@ async function _PaginationState_mergeReference(ref) {
     }
 };
 __decorate([
-    bindMethod
+    bindMethod,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
 ], PaginationState.prototype, "backward", null);
 __decorate([
-    bindMethod
+    bindMethod,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
 ], PaginationState.prototype, "forward", null);

package/db/Reference.d.ts

@@ -1,5 +1,5 @@
-import { ObjectSchema, Validator } from "../schema";
-import { Data } from "../util";
+import { ObjectSchema } from "../schema";
+import { Data, Validator } from "../util";
 import type { Database } from "./Database";
 /**
  * Reference: a location in a database

package/firestore-client/FirestoreClientProvider.d.ts

@@ -1,10 +1,10 @@
-import "firebase/firestore";
-import type { FirebaseFirestore as Firestore } from "@firebase/firestore-types";
+import type { Firestore } from "firebase/firestore";
 import { Data, Results, Provider, Document, Documents, Result, Observer, Transforms } from "..";
 /**
  * Firestore client database provider.
- * - Works with the JS client SDK.
- * @todo Maybe find a way to generate a unique hash of
+ * - Works with the Firebase JS SDK.
+ * - Supports offline mode.
+ * - Supports realtime subscriptions.
  */
 export declare class FirestoreClientProvider implements Provider {
     readonly firestore: Firestore;

package/firestore-client/FirestoreClientProvider.js

@@ -1,7 +1,5 @@
-import firebase from "firebase/app";
-import "firebase/firestore";
-import { dispatchNext, dispatchError } from "..";
-import { AddItemsTransform, AddEntriesTransform, IncrementTransform, isTransform, RemoveItemsTransform, RemoveEntriesTransform } from "../util";
+import { getDoc, orderBy, where, limit, addDoc, increment, arrayUnion, arrayRemove, deleteField, collection as getFirestoreCollection, doc as getFirestoreDoc, query as getFirestoreQuery, onSnapshot, setDoc, updateDoc, deleteDoc, getDocs, } from "firebase/firestore";
+import { dispatchNext, dispatchError, AddItemsTransform, AddEntriesTransform, IncrementTransform, isTransform, RemoveItemsTransform, RemoveEntriesTransform, } from "..";
 // Constants.
 // const ID = "__name__"; // DH: `__name__` is the entire path of the document. `__id__` is just ID.
 const ID = "__id__"; // Internal way Firestore Queries can reference the ID of the current document.
@@ -22,24 +20,24 @@ const DIRECTIONS = {
     DESC: "desc",
 };
 /** Get a Firestore DocumentReference for a given Shelving `Document` instance. */
-function getDocument(firestore, { path }) {
-    return firestore.doc(path);
+function getDocumentReference(firestore, { path }) {
+    return getFirestoreDoc(firestore, path);
 }
 /** Get a Firestore CollectionReference for a given Shelving `Document` instance. */
-function getCollection(firestore, { path }) {
-    return firestore.collection(path);
+function getCollectionReference(firestore, { path }) {
+    return getFirestoreCollection(firestore, path);
 }
 /** Create a corresponding `QueryReference` from a Query. */
-function getQuery(firestore, ref) {
+function getQueryReference(firestore, ref) {
     const { sorts, filters, slice } = ref.query;
-    let query = getCollection(firestore, ref);
+    const constraints = [];
     for (const { key, direction } of sorts)
-        query = query.orderBy(key === "id" ? ID : key, DIRECTIONS[direction]);
+        constraints.push(orderBy(key === "id" ? ID : key, DIRECTIONS[direction]));
     for (const { operator, key, value } of filters)
-        query = query.where(key === "id" ? ID : key, OPERATORS[operator], value);
+        constraints.push(where(key === "id" ? ID : key, OPERATORS[operator], value));
     if (slice.limit !== null)
-        query = query.limit(slice.limit);
-    return query;
+        constraints.push(limit(slice.limit));
+    return getFirestoreQuery(getCollectionReference(firestore, ref), ...constraints);
 }
 /** Create a set of results from a collection snapshot. */
 function getResults(snapshot) {
@@ -54,13 +52,13 @@ function convertTransforms(transforms) {
     for (const [key, transform] of Object.entries(transforms)) {
         if (isTransform(transform)) {
             if (transform instanceof IncrementTransform) {
-                output[key] = firebase.firestore.FieldValue.increment(transform.amount);
+                output[key] = increment(transform.amount);
             }
             else if (transform instanceof AddItemsTransform) {
-                output[key] = firebase.firestore.FieldValue.arrayUnion(...transform.items);
+                output[key] = arrayUnion(...transform.items);
             }
             else if (transform instanceof RemoveItemsTransform) {
-                output[key] = firebase.firestore.FieldValue.arrayRemove(...transform.items);
+                output[key] = arrayRemove(...transform.items);
             }
             else if (transform instanceof AddEntriesTransform) {
                 for (const [k, v] of Object.entries(transform.props))
@@ -68,62 +66,64 @@ function convertTransforms(transforms) {
             }
             else if (transform instanceof RemoveEntriesTransform) {
                 for (const k of transform.props)
-                    output[`${key}.${k}`] = firebase.firestore.FieldValue.delete();
+                    output[`${key}.${k}`] = deleteField();
             }
             else
                 throw Error("Unsupported transform");
         }
-        else
+        else if (transform !== undefined) {
             output[key] = transform;
+        }
     }
     return output;
 }
 /**
  * Firestore client database provider.
- * - Works with the JS client SDK.
- * @todo Maybe find a way to generate a unique hash of
+ * - Works with the Firebase JS SDK.
+ * - Supports offline mode.
+ * - Supports realtime subscriptions.
  */
 export class FirestoreClientProvider {
     constructor(firestore) {
         this.firestore = firestore;
     }
     async getDocument(ref) {
-        const snapshot = await getDocument(this.firestore, ref).get();
+        const snapshot = await getDoc(getDocumentReference(this.firestore, ref));
         return snapshot.data();
     }
     onDocument(ref, observer) {
-        return getDocument(this.firestore, ref).onSnapshot(snapshot => dispatchNext(observer, snapshot.data()), error => dispatchError(observer, error));
+        return onSnapshot(getDocumentReference(this.firestore, ref), snapshot => dispatchNext(observer, snapshot.data()), error => dispatchError(observer, error));
     }
     async addDocument(ref, data) {
-        return (await getCollection(this.firestore, ref).add(data)).id;
+        const reference = await addDoc(getCollectionReference(this.firestore, ref), data); // eslint-disable-line @typescript-eslint/no-explicit-any
+        return reference.id;
     }
     async setDocument(ref, data) {
-        await getDocument(this.firestore, ref).set(data);
+        await setDoc(getDocumentReference(this.firestore, ref), data); // eslint-disable-line @typescript-eslint/no-explicit-any
     }
     async updateDocument(ref, transforms) {
-        const updates = convertTransforms(transforms);
-        await getDocument(this.firestore, ref).update(updates);
+        await updateDoc(getDocumentReference(this.firestore, ref), convertTransforms(transforms)); // eslint-disable-line @typescript-eslint/no-explicit-any
     }
     async deleteDocument(ref) {
-        await getDocument(this.firestore, ref).delete();
+        await deleteDoc(getDocumentReference(this.firestore, ref));
     }
     async getDocuments(ref) {
-        return getResults(await getQuery(this.firestore, ref).get());
+        return getResults(await getDocs(getQueryReference(this.firestore, ref)));
     }
     onDocuments(ref, observer) {
-        return getQuery(this.firestore, ref).onSnapshot(snapshot => dispatchNext(observer, getResults(snapshot)), error => dispatchError(observer, error));
+        return onSnapshot(getQueryReference(this.firestore, ref), snapshot => dispatchNext(observer, getResults(snapshot)), error => dispatchError(observer, error));
     }
     async setDocuments(ref, data) {
-        const snapshot = await getQuery(this.firestore, ref).get();
-        await Promise.all(snapshot.docs.map(s => s.ref.set(data)));
+        const snapshot = await getDocs(getQueryReference(this.firestore, ref));
+        await Promise.all(snapshot.docs.map(s => setDoc(s.ref, data))); // eslint-disable-line @typescript-eslint/no-explicit-any
     }
     async updateDocuments(ref, transforms) {
-        const snapshot = await getQuery(this.firestore, ref).get();
+        const snapshot = await getDocs(getQueryReference(this.firestore, ref));
         const updates = convertTransforms(transforms);
-        await Promise.all(snapshot.docs.map(s => s.ref.update(updates)));
+        await Promise.all(snapshot.docs.map(s => updateDoc(s.ref, updates))); // eslint-disable-line @typescript-eslint/no-explicit-any
     }
     async deleteDocuments(ref) {
-        const snapshot = await getQuery(this.firestore, ref).get();
-        await Promise.all(snapshot.docs.map(s => s.ref.delete()));
+        const snapshot = await getDocs(getQueryReference(this.firestore, ref));
+        await Promise.all(snapshot.docs.map(s => deleteDoc(s.ref)));
     }
 }

package/firestore-lite/FirestoreLiteProvider.d.ts

@@ -0,0 +1,23 @@
+import type { Firestore } from "firebase/firestore/lite";
+import { Data, Results, Provider, Document, Documents, Result, Transforms } from "..";
+/**
+ * Firestore Lite client database provider.
+ * - Works with the Firebase JS SDK.
+ * - Does not support offline mode.
+ * - Does not support realtime subscriptions.
+ */
+export declare class FirestoreClientProvider implements Provider {
+    readonly firestore: Firestore;
+    constructor(firestore: Firestore);
+    getDocument<X extends Data>(ref: Document<X>): Promise<Result<X>>;
+    onDocument(): () => void;
+    addDocument<X extends Data>(ref: Documents<X>, data: X): Promise<string>;
+    setDocument<X extends Data>(ref: Document<X>, data: X): Promise<void>;
+    updateDocument<X extends Data>(ref: Document<X>, transforms: Transforms<X>): Promise<void>;
+    deleteDocument<X extends Data>(ref: Document<X>): Promise<void>;
+    getDocuments<X extends Data>(ref: Documents<X>): Promise<Results<X>>;
+    onDocuments(): () => void;
+    setDocuments<X extends Data>(ref: Documents<X>, data: X): Promise<void>;
+    updateDocuments<X extends Data>(ref: Documents<X>, transforms: Transforms<X>): Promise<void>;
+    deleteDocuments<X extends Data>(ref: Documents<X>): Promise<void>;
+}

package/firestore-lite/FirestoreLiteProvider.js

@@ -0,0 +1,129 @@
+import { getDoc, orderBy, where, limit, addDoc, increment, arrayUnion, arrayRemove, deleteField, collection as getFirestoreCollection, doc as getFirestoreDoc, query as getFirestoreQuery, setDoc, updateDoc, deleteDoc, getDocs, } from "firebase/firestore/lite";
+import { AddItemsTransform, AddEntriesTransform, IncrementTransform, isTransform, RemoveItemsTransform, RemoveEntriesTransform, } from "..";
+// Constants.
+// const ID = "__name__"; // DH: `__name__` is the entire path of the document. `__id__` is just ID.
+const ID = "__id__"; // Internal way Firestore Queries can reference the ID of the current document.
+// Map `Filter.types` to `WhereFilterOp`
+const OPERATORS = {
+    IS: "==",
+    NOT: "!=",
+    IN: "in",
+    GT: ">",
+    GTE: ">=",
+    LT: "<",
+    LTE: "<=",
+    CONTAINS: "array-contains",
+};
+// Map `Filter.types` to `OrderByDirection`
+const DIRECTIONS = {
+    ASC: "asc",
+    DESC: "desc",
+};
+/** Get a Firestore DocumentReference for a given Shelving `Document` instance. */
+function getDocumentReference(firestore, { path }) {
+    return getFirestoreDoc(firestore, path);
+}
+/** Get a Firestore CollectionReference for a given Shelving `Document` instance. */
+function getCollectionReference(firestore, { path }) {
+    return getFirestoreCollection(firestore, path);
+}
+/** Create a corresponding `QueryReference` from a Query. */
+function getQueryReference(firestore, ref) {
+    const { sorts, filters, slice } = ref.query;
+    const constraints = [];
+    for (const { key, direction } of sorts)
+        constraints.push(orderBy(key === "id" ? ID : key, DIRECTIONS[direction]));
+    for (const { operator, key, value } of filters)
+        constraints.push(where(key === "id" ? ID : key, OPERATORS[operator], value));
+    if (slice.limit !== null)
+        constraints.push(limit(slice.limit));
+    return getFirestoreQuery(getCollectionReference(firestore, ref), ...constraints);
+}
+/** Create a set of results from a collection snapshot. */
+function getResults(snapshot) {
+    const results = {};
+    for (const s of snapshot.docs)
+        results[s.id] = s.data();
+    return results;
+}
+/** Convert a set of Shelving `Transform` instances into the corresponding Firestore `FieldValue` instances. */
+function convertTransforms(transforms) {
+    const output = {};
+    for (const [key, transform] of Object.entries(transforms)) {
+        if (isTransform(transform)) {
+            if (transform instanceof IncrementTransform) {
+                output[key] = increment(transform.amount);
+            }
+            else if (transform instanceof AddItemsTransform) {
+                output[key] = arrayUnion(...transform.items);
+            }
+            else if (transform instanceof RemoveItemsTransform) {
+                output[key] = arrayRemove(...transform.items);
+            }
+            else if (transform instanceof AddEntriesTransform) {
+                for (const [k, v] of Object.entries(transform.props))
+                    output[`${key}.${k}`] = v;
+            }
+            else if (transform instanceof RemoveEntriesTransform) {
+                for (const k of transform.props)
+                    output[`${key}.${k}`] = deleteField();
+            }
+            else
+                throw Error("Unsupported transform");
+        }
+        else if (transform !== undefined) {
+            output[key] = transform;
+        }
+    }
+    return output;
+}
+/**
+ * Firestore Lite client database provider.
+ * - Works with the Firebase JS SDK.
+ * - Does not support offline mode.
+ * - Does not support realtime subscriptions.
+ */
+export class FirestoreClientProvider {
+    constructor(firestore) {
+        this.firestore = firestore;
+    }
+    async getDocument(ref) {
+        const snapshot = await getDoc(getDocumentReference(this.firestore, ref));
+        return snapshot.data();
+    }
+    onDocument() {
+        throw new Error("FirestoreLiteProvider does not support realtime subscriptions");
+    }
+    async addDocument(ref, data) {
+        const reference = await addDoc(getCollectionReference(this.firestore, ref), data); // eslint-disable-line @typescript-eslint/no-explicit-any
+        return reference.id;
+    }
+    async setDocument(ref, data) {
+        await setDoc(getDocumentReference(this.firestore, ref), data); // eslint-disable-line @typescript-eslint/no-explicit-any
+    }
+    async updateDocument(ref, transforms) {
+        await updateDoc(getDocumentReference(this.firestore, ref), convertTransforms(transforms)); // eslint-disable-line @typescript-eslint/no-explicit-any
+    }
+    async deleteDocument(ref) {
+        await deleteDoc(getDocumentReference(this.firestore, ref));
+    }
+    async getDocuments(ref) {
+        return getResults(await getDocs(getQueryReference(this.firestore, ref)));
+    }
+    onDocuments() {
+        throw new Error("FirestoreLiteProvider does not support realtime subscriptions");
+    }
+    async setDocuments(ref, data) {
+        const snapshot = await getDocs(getQueryReference(this.firestore, ref));
+        await Promise.all(snapshot.docs.map(s => setDoc(s.ref, data))); // eslint-disable-line @typescript-eslint/no-explicit-any
+    }
+    async updateDocuments(ref, transforms) {
+        const snapshot = await getDocs(getQueryReference(this.firestore, ref));
+        const updates = convertTransforms(transforms);
+        await Promise.all(snapshot.docs.map(s => updateDoc(s.ref, updates))); // eslint-disable-line @typescript-eslint/no-explicit-any
+    }
+    async deleteDocuments(ref) {
+        const snapshot = await getDocs(getQueryReference(this.firestore, ref));
+        await Promise.all(snapshot.docs.map(s => deleteDoc(s.ref)));
+    }
+}

package/firestore-lite/index.d.ts

@@ -0,0 +1 @@
+export * from "./FirestoreLiteProvider";

package/firestore-lite/index.js

@@ -0,0 +1 @@
+export * from "./FirestoreLiteProvider";

package/firestore-server/FirestoreServerProvider.d.ts

@@ -2,8 +2,7 @@ import type { Firestore } from "@google-cloud/firestore";
 import { Data, Results, Provider, Document, Documents, Observer, Result, Transforms } from "..";
 /**
  * Firestore server database provider.
- * - Works with the Node.JS admin SDK.
- * - Equality hash is set on returned values so `deepEqual()` etc can use it to quickly compare results without needing to look deeply.
+ * - Works with the Firebase Admin SDK for Node.JS
  */
 export declare class FirestoreServerProvider implements Provider {
     readonly firestore: Firestore;