firetender-admin 0.10.0

package/dist/FiretenderCollection.js

@@ -0,0 +1,225 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FiretenderCollection = void 0;
+const errors_1 = require("./errors");
+const firestore_deps_1 = require("./firestore-deps");
+const FiretenderDoc_1 = require("./FiretenderDoc");
+/**
+ * A representation of a Firestore collection or subcollection.
+ *
+ * It represents a given "collection path": the collection names from a document
+ * reference, sans IDs.  All docs at /databases/{db}/documents/foo/{*}/bar/{*}
+ * are covered by a FiretenderCollection for the path ["foo", "bar"].
+ */
+class FiretenderCollection {
+    /**
+     * @param schema the Zod object schema describing the documents in this
+     *   collection.
+     * @param firestore the thing you get from getFirestore().
+     * @param collectionPath the path of this collection in Firestore: the names
+     *   of any parent collections and of this collection.
+     * @param baseInitialData (optional) an object or object factory providing
+     *   default field values for this collection.
+     */
+    constructor(schema, firestore, collectionPath, baseInitialData = undefined) {
+        this.schema = schema;
+        this.firestore = firestore;
+        this.collectionPath = [collectionPath].flat();
+        if (baseInitialData) {
+            if (typeof baseInitialData === "function") {
+                this.baseInitialDataFactory = baseInitialData;
+            }
+            else {
+                this.baseInitialDataFactory = () => baseInitialData;
+            }
+        }
+    }
+    /**
+     * Returns a FiretenderDoc representing a new document in this collection.
+     *
+     * This method initializes the FiretenderDoc but does not create it in
+     * Firestore.  To do so, call the doc's write() method.
+     *
+     * @param id the ID or array of IDs giving the path of the new document.
+     *   Firestore will generate a random doc ID if it is omitted.  If this is a
+     *   subcollection, the ID(s) for the parent collection(s) are required.
+     * @param initialData the document's initial data, which is merged with (and
+     *   potentially overwrites) field values specified in the constructor.
+     * @param options optional parameters for the resulting FiretenderDoc; see
+     *   FiretenderDocOptions for detail.
+     */
+    newDoc(id = undefined, initialData = undefined, options = {}) {
+        const ids = id instanceof Array ? id : id ? [id] : [];
+        let ref = this.makeDocRefInternal(ids);
+        if (!ref) {
+            ref = this.makeCollectionRefInternal(ids);
+        }
+        if (!ref) {
+            throw new errors_1.FiretenderUsageError("newDoc() requires an ID path for all collections and subcollections, except optionally the last.");
+        }
+        const data = {};
+        if (this.baseInitialDataFactory) {
+            Object.assign(data, this.baseInitialDataFactory());
+        }
+        if (initialData) {
+            Object.assign(data, initialData);
+        }
+        return FiretenderDoc_1.FiretenderDoc.createNewDoc(this.schema, ref, data, options);
+    }
+    /**
+     * Returns a FiretenderDoc representing an existing Firestore document in this
+     * collection.
+     *
+     * This method initializes the FiretenderDoc but does not load its data.  If
+     * the doc does not exist in Firestore, calling load() will throw an error.
+     *
+     * @param id the ID or array of IDs specifying the desired document.
+     * @param options optional parameters for the resulting FiretenderDoc; see
+     *   FiretenderDocOptions for detail.
+     */
+    existingDoc(id, options = {}) {
+        const ref = this.makeDocRefInternal([id].flat());
+        if (!ref) {
+            throw new errors_1.FiretenderUsageError("existingDoc() requires a full ID path for this collection and its parent collections, if any.");
+        }
+        return new FiretenderDoc_1.FiretenderDoc(this.schema, ref, options);
+    }
+    /**
+     * Returns an array of all the documents in this collection.
+     *
+     * If the collection may contain a large number of documents, use query() with
+     * the limit() and startAfter() constraints to paginate the results.
+     *
+     * @param id (optional) when querying a subcollection, the ID(s) of its parent
+     *   collection(s).
+     */
+    async getAllDocs(id = undefined) {
+        const ids = id instanceof Array ? id : id ? [id] : [];
+        const collectionRef = this.makeCollectionRefInternal(ids);
+        if (!collectionRef) {
+            throw new errors_1.FiretenderUsageError("When querying a subcollection, getAllDocs() requires the IDs of all parent collections.");
+        }
+        return this.getAndWrapDocs(collectionRef);
+    }
+    /**
+     * Returns an array of the documents matching the given query.
+     *
+     * @param id (optional) when querying a subcollection, the ID(s) of its parent
+     *   collection(s); omit when querying a top-level collection or when querying
+     *   all docs in this subcollection, regardless of parent.
+     * @param ...whereClauses the where(), limit(), orderBy(), startAfter(), etc.
+     *   constraints defining this query.
+     */
+    async query(idOrWhereClause, ...moreWhereClauses) {
+        let ids;
+        let whereClauses;
+        if (idOrWhereClause instanceof Array) {
+            ids = idOrWhereClause;
+            whereClauses = moreWhereClauses;
+        }
+        else if (typeof idOrWhereClause === "string") {
+            ids = [idOrWhereClause];
+            whereClauses = moreWhereClauses;
+        }
+        else {
+            ids = [];
+            whereClauses = [idOrWhereClause, ...moreWhereClauses];
+        }
+        let ref = this.makeCollectionRefInternal(ids);
+        if (!ref) {
+            ref = (0, firestore_deps_1.collectionGroup)(this.firestore, this.collectionPath[this.collectionPath.length - 1]);
+        }
+        return this.getAndWrapDocs((0, firestore_deps_1.query)(ref, ...whereClauses));
+    }
+    /**
+     * Deletes the given document from this collection.
+     *
+     * The document's subcollections (if any) are not deleted.  To delete them,
+     * first use query() to get its subcollection docs, then call delete() on each
+     * one.  Please note that the Firestore guide recommends only performing such
+     * unbounded batched deletions from a trusted server environment.
+     *
+     * @param id full path ID of the target document.
+     */
+    async delete(id) {
+        const ref = this.makeDocRefInternal([id].flat());
+        if (!ref) {
+            throw new errors_1.FiretenderUsageError("delete() requires the full ID path of the target document.");
+        }
+        try {
+            await (0, firestore_deps_1.deleteDoc)(ref);
+        }
+        catch (error) {
+            (0, errors_1.addContextToError)(error, "deleteDoc", ref);
+        }
+    }
+    /**
+     * Returns a document reference for the specified ID.
+     *
+     * @param id the ID or array of IDs specifying the desired document.
+     */
+    makeDocRef(id) {
+        const ids = [id].flat();
+        const ref = this.makeDocRefInternal(ids);
+        if (!ref) {
+            throw new errors_1.FiretenderUsageError(`Document refs for /${this.collectionPath.join("/*")}/* require ${this.collectionPath.length} document IDs; received ${ids.length}.`);
+        }
+        return ref;
+    }
+    /**
+     * Returns a collection reference for the specified ID.
+     *
+     * @param id the ID or array of IDs specifying the desired collection.
+     */
+    makeCollectionRef(id = undefined) {
+        const ids = id ? [id].flat() : [];
+        const ref = this.makeCollectionRefInternal(ids);
+        if (!ref) {
+            throw new errors_1.FiretenderUsageError(`Collection refs for /${this.collectionPath.join("/*")} require ${this.collectionPath.length - 1} document IDs; received ${ids.length}.`);
+        }
+        return ref;
+    }
+    //////////////////////////////////////////////////////////////////////////////
+    // Private functions
+    /**
+     * Builds a doc ref from the given IDs, or returns "undefined" if the IDs do
+     * not correctly specify a doc path.
+     */
+    makeDocRefInternal(ids) {
+        if (ids.length !== this.collectionPath.length) {
+            return undefined;
+        }
+        const path = ids.flatMap((id, i) => [this.collectionPath[i], id]);
+        return (0, firestore_deps_1.doc)(this.firestore, path[0], ...path.slice(1));
+    }
+    /**
+     * Builds a collection ref from the given IDs, or returns "undefined" if the
+     * IDs do not correctly specify a collection path.
+     */
+    makeCollectionRefInternal(ids) {
+        if (ids.length !== this.collectionPath.length - 1) {
+            return undefined;
+        }
+        const subPath = ids.flatMap((id, i) => [id, this.collectionPath[i + 1]]);
+        return (0, firestore_deps_1.collection)(this.firestore, this.collectionPath[0], ...subPath);
+    }
+    /**
+     * Executes the given query and returns an array of the results, wrapped in
+     * FiretenderDoc objects.
+     */
+    async getAndWrapDocs(query) {
+        let querySnapshot;
+        try {
+            querySnapshot = await (0, firestore_deps_1.getDocs)(query);
+        }
+        catch (error) {
+            (0, errors_1.addContextToError)(error, "getDocs", query instanceof firestore_deps_1.CollectionReference ? query : undefined);
+            throw error;
+        }
+        return querySnapshot.docs.map((queryDoc) => new FiretenderDoc_1.FiretenderDoc(this.schema, queryDoc.ref, {
+            initialData: queryDoc.data(),
+        }));
+    }
+}
+exports.FiretenderCollection = FiretenderCollection;
+//# sourceMappingURL=FiretenderCollection.js.map

package/dist/FiretenderCollection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FiretenderCollection.js","sourceRoot":"","sources":["../src/FiretenderCollection.ts"],"names":[],"mappings":";;;AAEA,qCAAmE;AACnE,qDAa0B;AAC1B,mDAAsE;AAGtE;;;;;;GAMG;AACH,MAAa,oBAAoB;IAe/B;;;;;;;;OAQG;IACH,YACE,MAAkB,EAClB,SAAoB,EACpB,cAA8C,EAC9C,kBAGgB,SAAS;QAEzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9C,IAAI,eAAe,EAAE;YACnB,IAAI,OAAO,eAAe,KAAK,UAAU,EAAE;gBACzC,IAAI,CAAC,sBAAsB,GAAG,eAAe,CAAC;aAC/C;iBAAM;gBACL,IAAI,CAAC,sBAAsB,GAAG,GAAG,EAAE,CAAC,eAAe,CAAC;aACrD;SACF;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,KAAoC,SAAS,EAC7C,cAA4D,SAAS,EACrE,UAAgC,EAAE;QAElC,MAAM,GAAG,GAAG,EAAE,YAAY,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,IAAI,GAAG,GACL,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,GAAG,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;SAC3C;QACD,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,6BAAoB,CAC5B,kGAAkG,CACnG,CAAC;SACH;QACD,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,sBAAsB,EAAE;YAC/B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,sBAAsB,EAAE,CAAC,CAAC;SACpD;QACD,IAAI,WAAW,EAAE;YACf,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;SAClC;QACD,OAAO,6BAAa,CAAC,YAAY,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;IAED;;;;;;;;;;OAUG;IACH,WAAW,CACT,EAAqB,EACrB,UAAgC,EAAE;QAElC,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,6BAAoB,CAC5B,+FAA+F,CAChG,CAAC;SACH;QACD,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CACd,KAAoC,SAAS;QAE7C,MAAM,GAAG,GAAG,EAAE,YAAY,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACtD,MAAM,aAAa,GAAG,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,IAAI,6BAAoB,CAC5B,yFAAyF,CAC1F,CAAC;SACH;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,KAAK,CACT,eAAoD,EACpD,GAAG,gBAAmC;QAEtC,IAAI,GAAa,CAAC;QAClB,IAAI,YAA+B,CAAC;QACpC,IAAI,eAAe,YAAY,KAAK,EAAE;YACpC,GAAG,GAAG,eAAe,CAAC;YACtB,YAAY,GAAG,gBAAgB,CAAC;SACjC;aAAM,IAAI,OAAO,eAAe,KAAK,QAAQ,EAAE;YAC9C,GAAG,GAAG,CAAC,eAAe,CAAC,CAAC;YACxB,YAAY,GAAG,gBAAgB,CAAC;SACjC;aAAM;YACL,GAAG,GAAG,EAAE,CAAC;YACT,YAAY,GAAG,CAAC,eAAe,EAAE,GAAG,gBAAgB,CAAC,CAAC;SACvD;QACD,IAAI,GAAG,GACL,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,GAAG,IAAA,gCAAe,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CACpD,CAAC;SACH;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAA,sBAAK,EAAC,GAAG,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,EAAqB;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,6BAAoB,CAC5B,4DAA4D,CAC7D,CAAC;SACH;QACD,IAAI;YACF,MAAM,IAAA,0BAAS,EAAC,GAAG,CAAC,CAAC;SACtB;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,0BAAiB,EAAC,KAAK,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC;SAC5C;IACH,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,EAAqB;QAC9B,MAAM,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACxB,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,6BAAoB,CAC5B,sBAAsB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,cAClD,IAAI,CAAC,cAAc,CAAC,MACtB,2BAA2B,GAAG,CAAC,MAAM,GAAG,CACzC,CAAC;SACH;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CACf,KAAoC,SAAS;QAE7C,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,MAAM,GAAG,GAAG,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAChD,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,6BAAoB,CAC5B,wBAAwB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,YACpD,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAC/B,2BAA2B,GAAG,CAAC,MAAM,GAAG,CACzC,CAAC;SACH;QACD,OAAO,GAAG,CAAC;IACb,CAAC;IAED,8EAA8E;IAC9E,oBAAoB;IAEpB;;;OAGG;IACK,kBAAkB,CAAC,GAAa;QACtC,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC7C,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAClE,OAAO,IAAA,oBAAG,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACK,yBAAyB,CAC/B,GAAa;QAEb,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE;YACjD,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QACzE,OAAO,IAAA,2BAAU,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,cAAc,CAC1B,KAAkC;QAElC,IAAI,aAA4B,CAAC;QACjC,IAAI;YACF,aAAa,GAAG,MAAM,IAAA,wBAAO,EAAC,KAAK,CAAC,CAAC;SACtC;QAAC,OAAO,KAAK,EAAE;YACd,IAAA,0BAAiB,EACf,KAAK,EACL,SAAS,EACT,KAAK,YAAY,oCAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CACzD,CAAC;YACF,MAAM,KAAK,CAAC;SACb;QACD,OAAO,aAAa,CAAC,IAAI,CAAC,GAAG,CAC3B,CAAC,QAAQ,EAAE,EAAE,CACX,IAAI,6BAAa,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,EAAE;YAC3C,WAAW,EAAE,QAAQ,CAAC,IAAI,EAAE;SAC7B,CAAC,CACL,CAAC;IACJ,CAAC;CACF;AA3RD,oDA2RC"}

package/dist/FiretenderDoc.d.ts

@@ -0,0 +1,172 @@
+import { z } from "zod";
+import { CollectionReference, DocumentReference } from "./firestore-deps";
+import { DeepReadonly } from "./ts-helpers";
+/**
+ * Public options for initializing a FiretenderDoc object.
+ *
+ * These will be added as needed (e.g., "readonly" for issue #1, possibly
+ * "queryPageLength" for issue #21).
+ */
+export type FiretenderDocOptions = {};
+/**
+ * All options when initializing a FiretenderDoc object.
+ *
+ * This type includes options meant for internal use (createDoc, initialData)
+ * as well as the options in FiretenderDocOptions.
+ */
+export type AllFiretenderDocOptions = FiretenderDocOptions & {
+    /**
+     * Does this FiretenderDoc represent a new document in Firestore?
+     */
+    createDoc?: true;
+    /**
+     * The document's initial data, which must define a valid instance of the
+     * document according to its schema.
+     */
+    initialData?: Record<string, any>;
+};
+/**
+ * A local representation of a Firestore document.
+ */
+export declare class FiretenderDoc<SchemaType extends z.SomeZodObject> {
+    /** Zod schema used to parse and validate the document's data */
+    readonly schema: SchemaType;
+    /** Firestore reference to this doc, or collection in which to create it */
+    private ref;
+    /** Firestore document ID; undefined for new docs not yet on Firestore */
+    private docID;
+    /** Is this a doc we presume does not yet exist in Firestore? */
+    private isNewDoc;
+    /** Use addDoc or setDoc to write all the data?  If not, use updateDoc. */
+    private isSettingNewContents;
+    /** Local copy of the document data, parsed into the Zod type */
+    private data;
+    /** Proxy to intercept write (.w) access to the data and track the changes */
+    private dataProxy;
+    /** Map from the dot-delimited field path (per updateDoc()) to new value */
+    private updates;
+    /**
+     * If a load() call is already in progress, this is a list of promise
+     * resolutions to be called once the load is complete.  Otherwise undefined.
+     */
+    private resolvesWaitingForLoad;
+    /**
+     * @param schema the Zod object schema describing this document's data.
+     * @param ref either a document reference specifying the full path of the
+     *   document, or a collection reference specifying where a new document will
+     *   be created.
+     * @param options optional parameters for the resulting FiretenderDoc; see
+     *   FiretenderDocOptions for detail.
+     */
+    constructor(schema: SchemaType, ref: DocumentReference | CollectionReference, options?: AllFiretenderDocOptions);
+    /**
+     * Returns a FiretenderDoc representing a new Firestore document.
+     *
+     * This method does not create the document in Firestore.  To do so, call the
+     * write() method.
+     *
+     * @param schema the Zod object schema describing this document's data.
+     * @param ref either a document reference specifying the full path of the
+     *   document, or a collection reference specifying where a new document will
+     *   be created.
+     * @param initialData the document's initial data, which must define a valid
+     *   instance of this document according to its schema.
+     * @param options optional parameters for the resulting FiretenderDoc; see
+     *   FiretenderDocOptions for detail.
+     */
+    static createNewDoc<SchemaType1 extends z.SomeZodObject>(schema: SchemaType1, ref: DocumentReference | CollectionReference, initialData: z.input<SchemaType1>, options?: FiretenderDocOptions): FiretenderDoc<SchemaType1>;
+    /**
+     * Creates a copy of this document.  Returns a deep copy of its data with a
+     * specified or undefined Firestore ID and reference.
+     *
+     * This method does not create the document in Firestore.  To do so, call the
+     * write() method.  If a document ID or reference is not provided, those will
+     * be unset until the write.
+     *
+     * The location of the new document depends on the type of the `dest`
+     * argument:
+     * - `undefined` (default): It will be in the same collection and will be
+     *   assigned a random ID when written to Firestore.
+     * - `string`: It will be in the same collection and have a document ID given
+     *   by `dest`.
+     * - `string[]`: It will be in the specified subcollection and receive a
+     *   random ID (if `type` does not give an ID for the deepest subcollection)
+     *   or have the fully specified Firestore path (if `type` does).
+     * - `DocumentReference`: It will have the given Firestore reference.
+     * - `CollectionReference`: It will be in the given subcollection and have a
+     *   randomly assigned ID upon writing.
+     *
+     * @param dest the location of the new document; see above for details.
+     * @param options optional parameters for the resulting FiretenderDoc; see
+     *   FiretenderDocOptions for detail.
+     */
+    copy(dest?: DocumentReference | CollectionReference | string | string[] | undefined, options?: AllFiretenderDocOptions): FiretenderDoc<SchemaType>;
+    /**
+     * The document's ID string.
+     *
+     * @throws Throws an error if the document does not yet have an ID.
+     */
+    get id(): string;
+    /**
+     * The document's Firestore reference.
+     *
+     * @throws Throws an error if the document does not yet have a reference.
+     */
+    get docRef(): DocumentReference;
+    /**
+     * Is this a new doc that has not yet been written to Firestore?
+     */
+    isNew(): boolean;
+    /**
+     * Does the document contain data, either because it was successfully loaded
+     * or is newly created?
+     */
+    isLoaded(): boolean;
+    /**
+     * Does this document contain data that has not yet been written to Firestore?
+     */
+    isPendingWrite(): boolean;
+    /**
+     * Loads this document's data from Firestore.
+     *
+     * @param force force a read from Firestore.  Normally load() does nothing if
+     *   the document already contains data.
+     */
+    load(force?: boolean): Promise<this>;
+    /**
+     * Read-only accessor to the contents of this document.
+     */
+    get r(): DeepReadonly<z.infer<SchemaType>>;
+    /**
+     * Writable accessor to update the contents of this document.
+     *
+     * Only use this accessor when making changes to the doc.  The .r accessor is
+     * considerably more efficient when reading.
+     */
+    get w(): z.infer<SchemaType>;
+    /**
+     * Writable accessor to overwrite all the document data.
+     */
+    set w(newData: z.input<SchemaType>);
+    /**
+     * Writes the document or any updates to Firestore.
+     */
+    write(): Promise<this>;
+    /**
+     * Updates the document's data with a single call.
+     *
+     * This function loads the document's data, if necessary; calls the given
+     * function to make changes to the data; then write the changes to Firestore.
+     * If nothing else, it helps you avoid forgetting to call .write()!
+     *
+     * @param mutator function that accepts a writable data object and makes
+     *   changes to it.
+     */
+    update(mutator: (data: z.infer<SchemaType>) => void): Promise<this>;
+    /**
+     * Adds a field and its new value to the list of updates to be passed to
+     * Firestore's updateDoc().  Called when the proxies detect changes to the
+     * document data.
+     */
+    private addToUpdateList;
+}