firetender 0.5.2 → 0.5.3

package/README.md

@@ -193,13 +193,15 @@ const cityLandmarkCollection = new FiretenderCollection(
   {}
 );
 
-const beijingParks = cityLandmarkCollection.query(
+const beijingParks = await cityLandmarkCollection.query(
   "BJ",
   where("type", "==", "park"))
 );
 // Resulting array contains the document for Jingshan Park.
 
-const allParks = cityLandmarkCollection.query(where("type", "==", "park"));
+const allParks = await cityLandmarkCollection.query(
+  where("type", "==", "park")
+);
 // Resulting array has docs for Griffith Park, Ueno Park, and Jingshan Park.
 ```
 
@@ -212,7 +214,7 @@ const citySchema = z.object({ /* ... */ });
 const cityCollection = new FiretenderCollection(
   citySchema, [firestore, "cities"], {}
 );
-cityCollection.delete("LA");
+await cityCollection.delete("LA");
 ```
 
 Subcollections are not deleted; in this example, the LA landmark docs would
@@ -226,10 +228,8 @@ server environment.
 The [full list of issues](https://github.com/jakes-space/firetender/issues) is
 tracked on Github.  Here are some features on the roadmap:
 
-* Javadoc
-  * Document the code!
-    ([#12](https://github.com/jakes-space/firetender/issues/12))
-  * Compile them to an API reference page in markdown.
+* Dcoumentation
+  * Compile JSDoc to an API reference page in markdown.
     ([#13](https://github.com/jakes-space/firetender/issues/13))
 * Concurrency
   * Listen for changes and update the object if it has not been locally

package/dist/FiretenderCollection.d.ts

@@ -1,30 +1,95 @@
 import { Firestore, QueryConstraint } from "firebase/firestore";
 import { z } from "zod";
-import { FiretenderDoc, FiretenderDocOptions } from "./FiretenderDoc";
+import { FiretenderDoc, PublicFiretenderDocOptions } from "./FiretenderDoc";
 import { DeepPartial } from "./ts-helpers";
-export declare class FiretenderCollection<SchemaType extends z.SomeZodObject> {
+/**
+ * A representation of a Firestore collection or subcollection.
+ */
+export declare class FiretenderCollection<SchemaType extends z.SomeZodObject, DataType extends z.infer<SchemaType> = z.infer<SchemaType>, InputType extends z.input<SchemaType> = z.input<SchemaType>> {
     readonly schema: SchemaType;
     readonly firestore: Firestore;
     readonly collectionNames: string[];
-    readonly baseInitialData: DeepPartial<z.infer<SchemaType>>;
-    constructor(schema: SchemaType, collectionPath: [Firestore, ...string[]], baseInitialData: DeepPartial<z.infer<SchemaType>>);
-    createNewDoc(id?: string[] | string | undefined, initialData?: DeepPartial<z.infer<SchemaType>> | undefined, options?: FiretenderDocOptions): FiretenderDoc<SchemaType, z.TypeOf<SchemaType>>;
-    getExistingDoc(id: string[] | string, options?: FiretenderDocOptions): FiretenderDoc<SchemaType, z.TypeOf<SchemaType>>;
-    getAllDocs(id?: string[] | string | undefined): Promise<FiretenderDoc<SchemaType, z.TypeOf<SchemaType>>[]>;
-    query(idOrWhereClause: string | string[] | QueryConstraint, ...moreWhereClauses: QueryConstraint[]): Promise<FiretenderDoc<SchemaType, z.TypeOf<SchemaType>>[]>;
+    readonly baseInitialData: DeepPartial<InputType> | undefined;
+    /**
+     * @param schema the Zod object schema describing the documents in this
+     *   collection.
+     * @param collectionPath the path of this collection in Firestore.  The first
+     *   entry must be a Firestore object, followed by the names of any parent
+     *   collections and of this collection.
+     * @param baseInitialData (optional) default field values for this collection.
+     */
+    constructor(schema: SchemaType, collectionPath: [Firestore, ...string[]], baseInitialData?: DeepPartial<z.input<SchemaType>> | undefined);
+    /**
+     * 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.
+     */
+    createNewDoc(id?: string[] | string | undefined, initialData?: DeepPartial<InputType> | undefined, options?: PublicFiretenderDocOptions): FiretenderDoc<SchemaType, DataType>;
+    /**
+     * 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.
+     */
+    getExistingDoc(id: string[] | string, options?: PublicFiretenderDocOptions): FiretenderDoc<SchemaType, DataType>;
+    /**
+     * 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() contraints to paginate the results.
+     *
+     * @param id (optional) when querying a subcollection, the ID(s) of its parent
+     *   collection(s).
+     */
+    getAllDocs(id?: string[] | string | undefined): Promise<FiretenderDoc<SchemaType, DataType>[]>;
+    /**
+     * 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.
+     */
+    query(idOrWhereClause: string | string[] | QueryConstraint, ...moreWhereClauses: QueryConstraint[]): Promise<FiretenderDoc<SchemaType, DataType>[]>;
     /**
      * Deletes the given document from this collection.
      *
-     * Subcollections (if any) are not deleted.  To also delete a document's
-     * subcollections, use query() to get lists of the subcollections' 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.
+     * 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.
      */
     delete(id: string[] | string): Promise<void>;
+    /**
+     * Builds a doc ref from the given IDs, or returns "undefined" if the IDs do
+     * not correctly specify a doc path.
+     */
     private makeDocRef;
+    /**
+     * Builds a collection ref from the given IDs, or returns "undefined" if the
+     * IDs do not correctly specify a collection path.
+     */
     private makeCollectionRef;
+    /**
+     * Executes the given query and returns an array of the results, wrapped in
+     * FiretenderDoc objects.
+     */
     private getAndWrapDocs;
 }

package/dist/FiretenderCollection.js

@@ -3,13 +3,40 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FiretenderCollection = void 0;
 const firestore_1 = require("firebase/firestore");
 const FiretenderDoc_1 = require("./FiretenderDoc");
+/**
+ * A representation of a Firestore collection or subcollection.
+ */
 class FiretenderCollection {
-    constructor(schema, collectionPath, baseInitialData) {
+    /**
+     * @param schema the Zod object schema describing the documents in this
+     *   collection.
+     * @param collectionPath the path of this collection in Firestore.  The first
+     *   entry must be a Firestore object, followed by the names of any parent
+     *   collections and of this collection.
+     * @param baseInitialData (optional) default field values for this collection.
+     */
+    constructor(schema, collectionPath, baseInitialData = undefined) {
         this.schema = schema;
         this.firestore = collectionPath[0];
         this.collectionNames = collectionPath.slice(1);
-        this.baseInitialData = baseInitialData;
+        if (baseInitialData) {
+            this.baseInitialData = 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.
+     */
     createNewDoc(id = undefined, initialData = undefined, options = {}) {
         const ids = id instanceof Array ? id : id ? [id] : [];
         let ref = this.makeDocRef(ids);
@@ -17,29 +44,61 @@ class FiretenderCollection {
             ref = this.makeCollectionRef(ids);
         }
         if (!ref) {
-            throw Error("createNewDoc() requires an ID for all collections and subcollections except optionally the last.");
+            throw Error("createNewDoc() requires an ID path for all collections and subcollections, except optionally the last.");
+        }
+        const data = {};
+        if (this.baseInitialData) {
+            Object.assign(data, this.baseInitialData);
         }
-        const data = this.baseInitialData;
         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.
+     */
     getExistingDoc(id, options = {}) {
         const ref = this.makeDocRef([id].flat());
         if (!ref) {
-            throw Error("getExistingDoc() requires an ID for the collection and IDs for each of its subcollections (if any).");
+            throw Error("getExistingDoc() 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() contraints 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.makeCollectionRef(ids);
         if (!collectionRef) {
-            throw Error("getAllDocs() requires an ID for all collections and subcollections except the last.");
+            throw Error("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;
@@ -64,11 +123,10 @@ class FiretenderCollection {
     /**
      * Deletes the given document from this collection.
      *
-     * Subcollections (if any) are not deleted.  To also delete a document's
-     * subcollections, use query() to get lists of the subcollections' 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.
+     * 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.
      */
@@ -79,6 +137,12 @@ class FiretenderCollection {
         }
         await (0, firestore_1.deleteDoc)(ref);
     }
+    //////////////////////////////////////////////////////////////////////////////
+    // Private functions
+    /**
+     * Builds a doc ref from the given IDs, or returns "undefined" if the IDs do
+     * not correctly specify a doc path.
+     */
     makeDocRef(ids) {
         if (ids.length !== this.collectionNames.length) {
             return undefined;
@@ -86,6 +150,10 @@ class FiretenderCollection {
         const path = ids.flatMap((id, i) => [this.collectionNames[i], id]);
         return (0, firestore_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.
+     */
     makeCollectionRef(ids) {
         if (ids.length !== this.collectionNames.length - 1) {
             return undefined;
@@ -93,6 +161,10 @@ class FiretenderCollection {
         const subPath = ids.flatMap((id, i) => [id, this.collectionNames[i + 1]]);
         return (0, firestore_1.collection)(this.firestore, this.collectionNames[0], ...subPath);
     }
+    /**
+     * Executes the given query and returns an array of the results, wrapped in
+     * FiretenderDoc objects.
+     */
     async getAndWrapDocs(query) {
         const querySnapshot = await (0, firestore_1.getDocs)(query);
         return querySnapshot.docs.map((queryDoc) => new FiretenderDoc_1.FiretenderDoc(this.schema, queryDoc.ref, {

package/dist/FiretenderCollection.js.map

@@ -1 +1 @@
-{"version":3,"file":"FiretenderCollection.js","sourceRoot":"","sources":["../src/FiretenderCollection.ts"],"names":[],"mappings":";;;AAAA,kDAY4B;AAG5B,mDAAsE;AAGtE,MAAa,oBAAoB;IAM/B,YACE,MAAkB,EAClB,cAAwC,EACxC,eAAiD;QAEjD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAa,CAAC;QAC3D,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED,YAAY,CACV,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,UAAU,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,KAAK,CACT,kGAAkG,CACnG,CAAC;SACH;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAAC;QAClC,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,cAAc,CAAC,EAAqB,EAAE,UAAgC,EAAE;QACtE,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,KAAK,CACT,qGAAqG,CACtG,CAAC;SACH;QACD,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,KAAoC,SAAS;QAC5D,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,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,KAAK,CACT,qFAAqF,CACtF,CAAC;SACH;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IAC5C,CAAC;IAED,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,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,GAAG,IAAA,2BAAe,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CACtD,CAAC;SACH;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAA,iBAAK,EAAC,GAAG,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,EAAqB;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC3E;QACD,MAAM,IAAA,qBAAS,EAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAEO,UAAU,CAAC,GAAa;QAC9B,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YAC9C,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACnE,OAAO,IAAA,eAAG,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAEO,iBAAiB,CAAC,GAAa;QACrC,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YAClD,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,OAAO,IAAA,sBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;IACzE,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,KAAkC;QAC7D,MAAM,aAAa,GAAG,MAAM,IAAA,mBAAO,EAAC,KAAK,CAAC,CAAC;QAC3C,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;AApID,oDAoIC"}
+{"version":3,"file":"FiretenderCollection.js","sourceRoot":"","sources":["../src/FiretenderCollection.ts"],"names":[],"mappings":";;;AAAA,kDAY4B;AAG5B,mDAA4E;AAG5E;;GAEG;AACH,MAAa,oBAAoB;IAU/B;;;;;;;OAOG;IACH,YACE,MAAkB,EAClB,cAAwC,EACxC,kBAAgE,SAAS;QAEzE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;QACnC,IAAI,CAAC,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAa,CAAC;QAC3D,IAAI,eAAe,EAAE;YACnB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;SACxC;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CACV,KAAoC,SAAS,EAC7C,cAAkD,SAAS,EAC3D,UAAsC,EAAE;QAExC,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,UAAU,CAAC,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;SACnC;QACD,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,KAAK,CACT,wGAAwG,CACzG,CAAC;SACH;QACD,MAAM,IAAI,GAAG,EAAE,CAAC;QAChB,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;SAC3C;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,cAAc,CACZ,EAAqB,EACrB,UAAsC,EAAE;QAExC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,KAAK,CACT,kGAAkG,CACnG,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,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAClD,IAAI,CAAC,aAAa,EAAE;YAClB,MAAM,KAAK,CACT,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,iBAAiB,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,EAAE;YACR,GAAG,GAAG,IAAA,2BAAe,EACnB,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,CAAC,CACtD,CAAC;SACH;QACD,OAAO,IAAI,CAAC,cAAc,CAAC,IAAA,iBAAK,EAAC,GAAG,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC;IAC1D,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,EAAqB;QAChC,MAAM,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,KAAK,CAAC,4DAA4D,CAAC,CAAC;SAC3E;QACD,MAAM,IAAA,qBAAS,EAAC,GAAG,CAAC,CAAC;IACvB,CAAC;IAED,8EAA8E;IAC9E,oBAAoB;IAEpB;;;OAGG;IACK,UAAU,CAAC,GAAa;QAC9B,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YAC9C,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACnE,OAAO,IAAA,eAAG,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACK,iBAAiB,CAAC,GAAa;QACrC,IAAI,GAAG,CAAC,MAAM,KAAK,IAAI,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC,EAAE;YAClD,OAAO,SAAS,CAAC;SAClB;QACD,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1E,OAAO,IAAA,sBAAU,EAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,CAAC;IACzE,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,cAAc,CAC1B,KAAkC;QAElC,MAAM,aAAa,GAAG,MAAM,IAAA,mBAAO,EAAC,KAAK,CAAC,CAAC;QAC3C,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;AArND,oDAqNC"}

package/dist/FiretenderDoc.d.ts

@@ -1,16 +1,29 @@
 import { CollectionReference, DocumentReference } from "firebase/firestore";
 import { z } from "zod";
 import { DeepReadonly } from "./ts-helpers";
+/**
+ * Options when initializing a FiretenderDoc object.
+ */
 export declare type 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>;
 };
 /**
- * Helper class for reading and writing Firestore data based on Zod schemas.
+ * Options when initializing a FiretenderDoc object, omitting options that are
+ * intended principally for internal use.
+ */
+export declare type PublicFiretenderDocOptions = Omit<FiretenderDocOptions, "createDoc" | "initialData">;
+/**
+ * A representation of a Firestore document.
  */
-export declare class FiretenderDoc<SchemaType extends z.SomeZodObject, DataType extends {
-    [x: string]: any;
-} = z.infer<SchemaType>> {
+export declare class FiretenderDoc<SchemaType extends z.SomeZodObject, DataType extends z.infer<SchemaType> = z.infer<SchemaType>> {
     readonly schema: SchemaType;
     private ref;
     private isNewDoc;
@@ -18,16 +31,84 @@ export declare class FiretenderDoc<SchemaType extends z.SomeZodObject, DataType
     private data;
     private dataProxy;
     private updates;
+    /**
+     * @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?: FiretenderDocOptions);
-    static createNewDoc<SchemaType1 extends z.SomeZodObject, InputType extends {
-        [x: string]: any;
-    } = z.input<SchemaType1>>(schema: SchemaType1, ref: DocumentReference | CollectionReference, initialData: InputType, options?: FiretenderDocOptions): FiretenderDoc<SchemaType1, z.TypeOf<SchemaType1>>;
-    get id(): string | undefined;
-    get docRef(): DocumentReference;
+    /**
+     * 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, InputType extends z.input<SchemaType1> = z.input<SchemaType1>>(schema: SchemaType1, ref: DocumentReference | CollectionReference, initialData: InputType, options?: PublicFiretenderDocOptions): FiretenderDoc<SchemaType1, z.infer<SchemaType1>>;
+    /**
+     * Create a copy of this document.  Returns a deep copy of its data with a new
+     * Firestore ID and reference.
+     *
+     * This method does not create the document in Firestore.  To do so, call the
+     * write() method.
+     *
+     * @param dest the destination can be a string or undefined to create a copy
+     *   in the same collection, or a document or collection reference to create
+     *   it elsewhere.  Firestore will assign a random doc ID if dest is undefined
+     *   or a collection reference.
+     * @param options optional parameters for the resulting FiretenderDoc; see
+     *   FiretenderDocOptions for detail.
+     */
     copy(dest?: DocumentReference | CollectionReference | string | undefined, options?: FiretenderDocOptions): FiretenderDoc<SchemaType, DataType>;
+    /**
+     * 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;
+    /**
+     * Load 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<DataType>;
+    /**
+     * Writable accessor to 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(): DataType;
+    /**
+     * Write the document or any updates to Firestore.
+     */
     write(): Promise<this>;
+    /**
+     * Does this document contain data that has not yet been written to Firestore?
+     */
+    isPendingWrite(): boolean;
+    /** Add the field and its new value to the list of updates. */
     private onChange;
 }

package/dist/FiretenderDoc.js

@@ -5,9 +5,17 @@ const firestore_1 = require("firebase/firestore");
 const proxies_1 = require("./proxies");
 const ts_helpers_1 = require("./ts-helpers");
 /**
- * Helper class for reading and writing Firestore data based on Zod schemas.
+ * A representation of a Firestore document.
  */
 class FiretenderDoc {
+    /**
+     * @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, ref, options = {}) {
         this.docID = undefined;
         this.data = undefined;
@@ -29,6 +37,21 @@ class FiretenderDoc {
             throw TypeError("Firetender can only take a collection reference when creating a new document.  Use Firetender.createNewDoc() if this is your intent.");
         }
     }
+    /**
+     * 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(schema, ref, initialData, options = {}) {
         const mergedOptions = {
             ...options,
@@ -37,15 +60,20 @@ class FiretenderDoc {
         };
         return new FiretenderDoc(schema, ref, mergedOptions);
     }
-    get id() {
-        return this.docID;
-    }
-    get docRef() {
-        if (this.ref.type === "document") {
-            return this.ref;
-        }
-        throw Error("docRef can only be accessed after the new doc has been written.");
-    }
+    /**
+     * Create a copy of this document.  Returns a deep copy of its data with a new
+     * Firestore ID and reference.
+     *
+     * This method does not create the document in Firestore.  To do so, call the
+     * write() method.
+     *
+     * @param dest the destination can be a string or undefined to create a copy
+     *   in the same collection, or a document or collection reference to create
+     *   it elsewhere.  Firestore will assign a random doc ID if dest is undefined
+     *   or a collection reference.
+     * @param options optional parameters for the resulting FiretenderDoc; see
+     *   FiretenderDocOptions for detail.
+     */
     copy(dest = undefined, options = {}) {
         if (!this.data) {
             throw Error("You must call load() before making a copy.");
@@ -70,6 +98,34 @@ class FiretenderDoc {
         };
         return new FiretenderDoc(this.schema, ref, mergedOptions);
     }
+    /**
+     * The document's ID string.
+     *
+     * @throws Throws an error if the document does not yet have an ID.
+     */
+    get id() {
+        if (!this.docID) {
+            throw Error("id can only be accessed after the new doc has been written.");
+        }
+        return this.docID;
+    }
+    /**
+     * The document's Firestore reference.
+     *
+     * @throws Throws an error if the document does not yet have a reference.
+     */
+    get docRef() {
+        if (this.ref.type !== "document") {
+            throw Error("docRef can only be accessed after the new doc has been written.");
+        }
+        return this.ref;
+    }
+    /**
+     * Load this document's data from Firestore.
+     *
+     * @param force force a read from Firestore.  Normally load() does nothing if
+     *   the document already contains data.
+     */
     async load(force = false) {
         if (this.isNewDoc || this.ref.type === "collection") {
             throw Error("load() should not be called for new documents.");
@@ -85,12 +141,21 @@ class FiretenderDoc {
         }
         return this;
     }
+    /**
+     * Read-only accessor to the contents of this document.
+     */
     get r() {
         if (!this.data) {
             throw Error("load() must be called before reading the document.");
         }
         return this.data;
     }
+    /**
+     * Writable accessor to 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() {
         if (this.isNewDoc) {
             // No need to monitor changes if we're creating rather than updating.
@@ -104,6 +169,9 @@ class FiretenderDoc {
         }
         return this.dataProxy;
     }
+    /**
+     * Write the document or any updates to Firestore.
+     */
     async write() {
         if (this.isNewDoc) {
             (0, ts_helpers_1.assertIsDefined)(this.data);
@@ -125,10 +193,20 @@ class FiretenderDoc {
             if (this.updates.size > 0) {
                 const flatUpdateList = Array.from(this.updates.entries()).flat();
                 await (0, firestore_1.updateDoc)(this.ref, flatUpdateList[0], flatUpdateList[1], ...flatUpdateList.slice(2));
+                this.updates.clear();
             }
         }
         return this;
     }
+    /**
+     * Does this document contain data that has not yet been written to Firestore?
+     */
+    isPendingWrite() {
+        return this.isNewDoc || this.updates.size > 0;
+    }
+    //////////////////////////////////////////////////////////////////////////////
+    // Private functions
+    /** Add the field and its new value to the list of updates. */
     onChange(fieldPath, newValue) {
         let pathString = "";
         if (this.updates.size > 0) {

package/dist/FiretenderDoc.js.map

@@ -1 +1 @@
-{"version":3,"file":"FiretenderDoc.js","sourceRoot":"","sources":["../src/FiretenderDoc.ts"],"names":[],"mappings":";;;AAAA,kDAQ4B;AAG5B,uCAAiD;AACjD,6CAA6D;AAQ7D;;GAEG;AACH,MAAa,aAAa;IAYxB,YACE,MAAkB,EAClB,GAA4C,EAC5C,UAAgC,EAAE;QAR5B,UAAK,GAAuB,SAAS,CAAC;QACtC,SAAI,GAAyB,SAAS,CAAC;QACvC,cAAS,GAAuC,SAAS,CAAC;QAC1D,YAAO,GAAG,IAAI,GAAG,EAAe,CAAC;QAOvC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;QAC3C,IAAI,OAAO,CAAC,WAAW,EAAE;YACvB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SAC/C;aAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;YACxB,MAAM,cAAc,CAClB,qDAAqD,CACtD,CAAC;SACH;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;YAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;SAC7C;aAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzB,MAAM,SAAS,CACb,sIAAsI,CACvI,CAAC;SACH;IACH,CAAC;IAED,MAAM,CAAC,YAAY,CAIjB,MAAmB,EACnB,GAA4C,EAC5C,WAAsB,EACtB,UAAgC,EAAE;QAElC,MAAM,aAAa,GAAyB;YAC1C,GAAG,OAAO;YACV,SAAS,EAAE,IAAI;YACf,WAAW;SACZ,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IACvD,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAI,MAAM;QACR,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;YAChC,OAAO,IAAI,CAAC,GAAG,CAAC;SACjB;QACD,MAAM,KAAK,CACT,iEAAiE,CAClE,CAAC;IACJ,CAAC;IAED,IAAI,CACF,OAIgB,SAAS,EACzB,UAAgC,EAAE;QAElC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC3D;QACD,IAAI,GAA4C,CAAC;QACjD,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACpC,GAAG,GAAG,IAAI,CAAC;SACZ;aAAM;YACL,MAAM,aAAa,GACjB,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YAC5D,IAAI,IAAI,EAAE;gBACR,GAAG,GAAG,IAAA,eAAG,EAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aAChC;iBAAM;gBACL,GAAG,GAAG,aAAa,CAAC;aACrB;SACF;QACD,MAAM,aAAa,GAAyB;YAC1C,GAAG,OAAO;YACV,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,IAAI;SACvB,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK;QACtB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,EAAE;YACnD,MAAM,KAAK,CAAC,gDAAgD,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,EAAE;YACvB,MAAM,QAAQ,GAAG,MAAM,IAAA,kBAAM,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;aAC7C;YACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/C,mEAAmE;YACnE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;SAC5B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,KAAK,CAAC,oDAAoD,CAAC,CAAC;SACnE;QACD,OAAO,IAAI,CAAC,IAA8B,CAAC;IAC7C,CAAC;IAED,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,qEAAqE;YACrE,OAAO,IAAI,CAAC,IAAgB,CAAC;SAC9B;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,MAAM,KAAK,CAAC,qDAAqD,CAAC,CAAC;aACpE;YACD,IAAI,CAAC,SAAS,GAAG,IAAA,8BAAoB,EACnC,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CACzB,CAAC;SACH;QACD,OAAO,IAAI,CAAC,SAAqB,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAA,4BAAe,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;gBAChC,MAAM,IAAA,kBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;aACnC;iBAAM;gBACL,IAAI,CAAC,GAAG,GAAG,MAAM,IAAA,kBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;aAC7C;YACD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;QACD,mBAAmB;aACd;YACH,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,EAAE;gBACnC,4BAA4B;gBAC5B,MAAM,KAAK,CACT,sGAAsG,CACvG,CAAC;aACH;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;gBACzB,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBACjE,MAAM,IAAA,qBAAS,EACb,IAAI,CAAC,GAAG,EACR,cAAc,CAAC,CAAC,CAAC,EACjB,cAAc,CAAC,CAAC,CAAC,EACjB,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAC3B,CAAC;aACH;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,QAAQ,CACd,SAAmB,EACnB,QAAkC;QAElC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;YACzB,0EAA0E;YAC1E,wEAAwE;YACxE,yEAAyE;YACzE,8CAA8C;YAC9C,IACE,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBAC1B,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC3D,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAClE,CAAC,CAAC,EACF;gBACA,OAAO;aACR;YACD,wDAAwD;YACxD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBAClC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;oBAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;iBAC1B;YACH,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,8DAA8D;YAC9D,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAClC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AAzMD,sCAyMC"}
+{"version":3,"file":"FiretenderDoc.js","sourceRoot":"","sources":["../src/FiretenderDoc.ts"],"names":[],"mappings":";;;AAAA,kDAQ4B;AAG5B,uCAAiD;AACjD,6CAA6D;AA6B7D;;GAEG;AACH,MAAa,aAAa;IAYxB;;;;;;;OAOG;IACH,YACE,MAAkB,EAClB,GAA4C,EAC5C,UAAgC,EAAE;QAhB5B,UAAK,GAAuB,SAAS,CAAC;QACtC,SAAI,GAAyB,SAAS,CAAC;QACvC,cAAS,GAAuC,SAAS,CAAC;QAC1D,YAAO,GAAG,IAAI,GAAG,EAAe,CAAC;QAevC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,SAAS,IAAI,KAAK,CAAC;QAC3C,IAAI,OAAO,CAAC,WAAW,EAAE;YACvB,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SAC/C;aAAM,IAAI,IAAI,CAAC,QAAQ,EAAE;YACxB,MAAM,cAAc,CAClB,qDAAqD,CACtD,CAAC;SACH;QACD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;YAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;SAC7C;aAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YACzB,MAAM,SAAS,CACb,sIAAsI,CACvI,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,YAAY,CAIjB,MAAmB,EACnB,GAA4C,EAC5C,WAAsB,EACtB,UAAsC,EAAE;QAExC,MAAM,aAAa,GAAyB;YAC1C,GAAG,OAAO;YACV,SAAS,EAAE,IAAI;YACf,WAAW;SACZ,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CACF,OAIgB,SAAS,EACzB,UAAgC,EAAE;QAElC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,KAAK,CAAC,4CAA4C,CAAC,CAAC;SAC3D;QACD,IAAI,GAA4C,CAAC;QACjD,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YACpC,GAAG,GAAG,IAAI,CAAC;SACZ;aAAM;YACL,MAAM,aAAa,GACjB,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YAC5D,IAAI,IAAI,EAAE;gBACR,GAAG,GAAG,IAAA,eAAG,EAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aAChC;iBAAM;gBACL,GAAG,GAAG,aAAa,CAAC;aACrB;SACF;QACD,MAAM,aAAa,GAAyB;YAC1C,GAAG,OAAO;YACV,SAAS,EAAE,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,IAAI;SACvB,CAAC;QACF,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,IAAI,EAAE;QACJ,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE;YACf,MAAM,KAAK,CACT,6DAA6D,CAC9D,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;YAChC,MAAM,KAAK,CACT,iEAAiE,CAClE,CAAC;SACH;QACD,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK;QACtB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,YAAY,EAAE;YACnD,MAAM,KAAK,CAAC,gDAAgD,CAAC,CAAC;SAC/D;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,EAAE;YACvB,MAAM,QAAQ,GAAG,MAAM,IAAA,kBAAM,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE;gBACtB,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;aAC7C;YACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YAC/C,mEAAmE;YACnE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;SAC5B;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAI,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,KAAK,CAAC,oDAAoD,CAAC,CAAC;SACnE;QACD,OAAO,IAAI,CAAC,IAA8B,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,qEAAqE;YACrE,OAAO,IAAI,CAAC,IAAgB,CAAC;SAC9B;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,MAAM,KAAK,CAAC,qDAAqD,CAAC,CAAC;aACpE;YACD,IAAI,CAAC,SAAS,GAAG,IAAA,8BAAoB,EACnC,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CACzB,CAAC;SACH;QACD,OAAO,IAAI,CAAC,SAAqB,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAA,4BAAe,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,EAAE;gBAChC,MAAM,IAAA,kBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;aACnC;iBAAM;gBACL,IAAI,CAAC,GAAG,GAAG,MAAM,IAAA,kBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC7C,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;aAC7C;YACD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;QACD,mBAAmB;aACd;YACH,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,UAAU,CAAC,EAAE;gBACnC,4BAA4B;gBAC5B,MAAM,KAAK,CACT,sGAAsG,CACvG,CAAC;aACH;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;gBACzB,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBACjE,MAAM,IAAA,qBAAS,EACb,IAAI,CAAC,GAAG,EACR,cAAc,CAAC,CAAC,CAAC,EACjB,cAAc,CAAC,CAAC,CAAC,EACjB,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAC3B,CAAC;gBACF,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aACtB;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAChD,CAAC;IAED,8EAA8E;IAC9E,oBAAoB;IAEpB,8DAA8D;IACtD,QAAQ,CACd,SAAmB,EACnB,QAAkC;QAElC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;YACzB,0EAA0E;YAC1E,wEAAwE;YACxE,yEAAyE;YACzE,8CAA8C;YAC9C,IACE,SAAS,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;gBAC1B,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;gBAC3D,OAAO,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YAClE,CAAC,CAAC,EACF;gBACA,OAAO;aACR;YACD,wDAAwD;YACxD,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;gBAClC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;oBAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;iBAC1B;YACH,CAAC,CAAC,CAAC;SACJ;aAAM;YACL,8DAA8D;YAC9D,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;SAClC;QACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IACzC,CAAC;CACF;AA3RD,sCA2RC"}

package/package.json

@@ -2,7 +2,7 @@
   "name": "firetender",
   "displayName": "Firetender",
   "description": "Typescript wrapper for Firestore documents",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "author": "Jake Hartman",
   "license": "MIT",
   "homepage": "https://github.com/jakes-space/firetender",