firetender 0.1.0 → 0.3.1

package/README.md

@@ -1,8 +1,8 @@
-# FireTender
+# Firetender
 
-FireTender is a wrapper for Firestore documents to make reading and writing them
-simpler and safer.  A Firestore doc looks like any other Typescript object, and
-they are validated upon reading and writing.
+The goal of Firetender is to make Firestore documents look (almost) like any
+other Typescript objects, reducing boilerplate and conceptual overhead and
+providing type safety and data validation.
 
 Querying and concurrency are not yet supported.  I'm adding features as I need
 them, but contributions are most welcome.  See the list of [alternative
@@ -11,23 +11,38 @@ something more mature.
 
 ## Usage
 
-To illustrate, let's run through the basics of defining, creating, reading, and
-modifying a Firestore document.
+To illustrate, let's run through the basics of defining, creating, modifying,
+and copying a Firestore document.
 
-### Define your schemas
+### Initialize Cloud Firestore
 
-First, we define the document schemas and their validation criteria with
-[Zod](https://github.com/colinhacks/zod).  If you've used Joi or Yup, you will
-find Zod very similar.  Optional collections should use `.default({})` or
-`.default([])` to simplify later access.  Here we define a schema for types of
-pizza, because I was hungry when I first wrote this.
+The first step is the usual Firestore configuration and initialization.  See
+the [Firestore
+quickstart](https://firebase.google.com/docs/firestore/quickstart) for details.
 
-Then create `pizzaWrapper`, which is a factory that makes objects to wrap
-Firestore documents and enforce the given schema.
+```javascript
+import { doc, initializeApp } from "firebase/app";
+import { getFirestore } from "firebase/firestore";
+
+// TODO: Replace the following with your app's Firebase project configuration.
+// See: https://firebase.google.com/docs/web/learn-more#config-object
+const firebaseConfig = {
+    // ...
+};
+
+const app = initializeApp(firebaseConfig);
+const firestore = getFirestore(app);
+```
+
+### Define the schema
+
+Firetender uses [Zod](https://github.com/colinhacks/zod) to define the
+document's schema and validation rules; if you've used Joi or Yup, you will find
+Zod very similar.  In the example below, I've defined a schema for types of
+pizza.  I was a little hungry when I wrote this.
 
 ```javascript
-import { doc } from "firebase/firestore";
-import { DocWrapper } from "firetender";
+import { FiretenderDoc } from "firetender";
 import { z } from "zod";
 
 const pizzaSchema = z.object({
@@ -48,81 +63,107 @@ const pizzaSchema = z.object({
   tags: z.array(z.string()).default([]),
 });
 
-const pizzaWrapper = new DocWrapper(pizzaSchema);
+const pizzaFactory = FiretenderDoc.makeClassFactoryFor(pizzaSchema);
 ```
 
+The static `FiretenderDoc.makeClassFactory()` method simplifies document
+creation by capturing the schema.
+
+Optional records and arrays should typically use `.default()` to provide an
+empty collection when missing.  That isn't required, but it makes accessing
+these fields simpler because they will always be defined.  The downside is that
+empty collection fields are not pruned and will appear in Firestore.
+
 ### Add a document
 
-Let's add a document to the `pizzas` collection with an ID of `margherita`.  We
-use `DocWrapper.prototype.createNew()` to create a validated local object
-representing a new document in the collection.  We then add the doc to Firestore
-by calling its `.write()` method.
+Let's add a document to the `pizzas` collection, with an ID of `margherita`.  We
+use the factory's `.createNewDoc()` to produce a `FiretenderDoc` representing a
+new document, initialized with validated data.  This object is purely local
+until it is written to Firestore by calling `.write()`.  Don't forget to do
+that.
 
 ```javascript
 const docRef = doc(db, "pizzas", "margherita");
-const pizza = pizzaWrapper.createNew(docRef, {
+const pizza = pizzaFactory.createNewDoc(docRef, {
   name: "Margherita",
+  description: "Neapolitan style pizza"
   toppings: { "fresh mozzarella": {}, "fresh basil": {} },
   tags: ["traditional"],
 });
 await pizza.write();
 ```
 
-If we don't care about the doc ID, we can also pass a collection reference
-(e.g., `collection(db, "pizzas")`) to `.createNew()`.  Firestore will assign a
-random ID.
+If you don't care about the doc ID, pass a collection reference to
+`.createNewDoc()` and Firestore will assign an ID at random.  It can be read
+from `.id` or `.docRef`.
 
 ### Read and modify a document
 
-To read or modify an existing document, we instantiate a doc wrapper using
-`DocWrapper.prototype.wrapExisting()`, passing in the doc's Firestore reference.
-To read from it, we call `.load()` and access the data with `.ro` (read only);
-to write, we modify the `.rw` accessor and then call `.write()`.  They can be
-used in combination, like so:
+To access an existing document, pass its reference to the `.wrapExistingDoc()`
+factory method.  To read it, call `.load()` and access its data with the `.r`
+property; see the example below.  To make changes, use `.w` then call
+`.write()`.  Reading and updating can be done in combination:
 
 ```javascript
 const meats = ["pepperoni", "chicken", "sausage"];
-const pizza = await pizzaWrapper.wrapExisting(docRef).load();
-const isMeatIncluded = Object.entries(pizza.ro.toppings).some(
+const pizza = await pizzaFactory.wrapExistingDoc(docRef).load();
+const isMeatIncluded = Object.entries(pizza.r.toppings).some(
   ([name, topping]) => topping.isIncluded && name in meats
 );
 if (!isMeatIncluded) {
-  pizza.rw.toppings.tags.push("vegetarian");
+  pizza.w.toppings.tags.push("vegetarian");
 }
 await pizza.write();
 ```
 
+The `.r` and `.w` properties point to the same data, with the read-only accessor
+typed accordingly.  Reading from `.r` is more efficient, as `.w` builds a chain
+of proxies to track updates.
+
 ### Make a copy
 
-Here we create a new pizza in the same collection.  Alternatively, a document
-can be copied to elsewhere by specifying a document or collection reference.
+Finally, use `.copy()` to get a deep copy of the document.  If an ID is not
+specified, it will be assigned randomly when the new doc is added to Firestore.
+The copy is solely local until `.write()` is called.
 
 ```javascript
 const sourceRef = doc(db, "pizza", "margherita");
-const sourcePizza = await pizzaWrapper.wrapExisting(sourceRef).load();
+const sourcePizza = await pizzaFactory.wrapExistingDoc(sourceRef).load();
 const newPizza = sourcePizza.copy("meaty margh");
 newPizza.name = "Meaty Margh";
 newPizza.toppings.sausage = {};
 newPizza.toppings.pepperoni = { included: false, surcharge: 1.25 };
 newPizza.toppings.chicken = { included: false, surcharge: 1.50 };
+delete newPizza.description;
 delete newPizza.toppings["fresh basil"];
 delete newPizza.tags.vegetarian;
 newPizza.write();
 ```
 
+Note the use of the `delete` operator to remove optional fields and record and
+array items.
+
 ## TODO
 
+* Javadoc
+  * Compile them to an API reference page in markdown.
 * Concurrency
   * Listen for changes and update the object if it has not been locally
     modified.  Provide an onChange() callback option.
   * Support the Firestore transaction API.
 * Queries
 * Document deletion
-* Improved timestamp handling
-* Prod releases
-  * Block on failing tests
+* Improved timestamp handling, tests
+* Releases
   * Minify code (esbuild?)
-  * Release on github
+  * Automate github & npm releases, either using semantic versioning
+    ([video](https://egghead.io/lessons/javascript-automating-releases-with-semantic-release),
+    [package](https://github.com/semantic-release/semantic-release)) or github
+    workflows
+    ([tutorial](https://writeabout.net/2021/10/15/releasing-github-npm-packages/),
+    [Zod's
+    yaml](https://github.com/colinhacks/zod/blob/master/.github/workflows/release.yml))
+    or some combination.
 
 ## Alternatives
 
@@ -136,10 +177,11 @@ Firestore helper, check out:
 * [Fireschema](https://github.com/yarnaimo/fireschema): Another strongly typed
   framework for building and using schemas in Firestore.
   
-* [firestore-fp](https://github.com/mobily/firestore-fp): If you are a
-  functional programming aficionado.
+* [firestore-fp](https://github.com/mobily/firestore-fp): If you like functional
+  programming.
 
-* [simplyfire](https://github.com/coturiv/simplyfire): A brilliantly named
-  simplified API that is focused more on querying.
+* [simplyfire](https://github.com/coturiv/simplyfire): Another
+  simplified API that is focused more on querying.  (And kudos to the author for
+  its great name.)
 
 I'm sure there are many more, and apologies if I missed your favorite.

package/dist/FiretenderDoc.d.ts

@@ -0,0 +1,39 @@
+import { CollectionReference, DocumentReference } from "firebase/firestore";
+import { z } from "zod";
+import { DeepReadonly } from "./ts-helpers";
+export declare type FiretenderDocOptions = {
+    createDoc?: true;
+    initialData?: any;
+};
+/**
+ * Helper class for reading and writing Firestore data based on Zod schemas.
+ */
+export declare class FiretenderDoc<SchemaType extends z.SomeZodObject, DataType extends {
+    [x: string]: any;
+} = z.infer<SchemaType>> {
+    readonly schema: SchemaType;
+    private ref;
+    private isNewDoc;
+    private docID;
+    private data;
+    private dataProxy;
+    private updates;
+    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>>;
+    static makeClassFactoryFor<SchemaType1 extends z.SomeZodObject, InputType extends {
+        [x: string]: any;
+    } = z.input<SchemaType1>>(schema: SchemaType1): {
+        createNewDoc: (ref: DocumentReference | CollectionReference, initialData: InputType, options?: FiretenderDocOptions) => FiretenderDoc<SchemaType1, z.TypeOf<SchemaType1>>;
+        wrapExistingDoc: (ref: DocumentReference | CollectionReference, options?: FiretenderDocOptions) => FiretenderDoc<SchemaType1, z.TypeOf<SchemaType1>>;
+    };
+    get id(): string | undefined;
+    get docRef(): DocumentReference;
+    copy(dest?: DocumentReference | CollectionReference | string | undefined, options?: FiretenderDocOptions): FiretenderDoc<SchemaType, DataType>;
+    load(force?: boolean): Promise<this>;
+    get r(): DeepReadonly<DataType>;
+    get w(): DataType;
+    write(): Promise<void>;
+    private onChange;
+}

package/dist/{FireTenderDoc.js → FiretenderDoc.js}

@@ -1,17 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FireTenderDoc = void 0;
+exports.FiretenderDoc = void 0;
 const firestore_1 = require("firebase/firestore");
 const proxies_1 = require("./proxies");
-function assertIsDefined(value) {
-    if (value === undefined || value === null) {
-        throw new TypeError(`${value} is not defined`);
-    }
-}
+const ts_helpers_1 = require("./ts-helpers");
 /**
  * Helper class for reading and writing Firestore data based on Zod schemas.
  */
-class FireTenderDoc {
+class FiretenderDoc {
     constructor(schema, ref, options = {}) {
         this.docID = undefined;
         this.data = undefined;
@@ -20,7 +16,6 @@ class FireTenderDoc {
         this.schema = schema;
         this.ref = ref;
         this.isNewDoc = options.createDoc ?? false;
-        console.log(ref, ref instanceof firestore_1.DocumentReference, options);
         if (this.isNewDoc) {
             if (!options.initialData) {
                 throw ReferenceError("Initial data must be given when creating a new doc.");
@@ -31,9 +26,23 @@ class FireTenderDoc {
             this.docID = this.ref.path.split("/").pop();
         }
         else if (!this.isNewDoc) {
-            throw TypeError("FireTender can only take a collection reference when creating a new document.  Use FireTender.createDoc() if this is your intent.");
+            throw TypeError("Firetender can only take a collection reference when creating a new document.  Use Firetender.createDoc() if this is your intent.");
         }
     }
+    static createNewDoc(schema, ref, initialData, options = {}) {
+        const mergedOptions = {
+            ...options,
+            createDoc: true,
+            initialData,
+        };
+        return new FiretenderDoc(schema, ref, mergedOptions);
+    }
+    static makeClassFactoryFor(schema) {
+        return {
+            createNewDoc: (ref, initialData, options = {}) => FiretenderDoc.createNewDoc(schema, ref, initialData, options),
+            wrapExistingDoc: (ref, options = {}) => new FiretenderDoc(schema, ref, options),
+        };
+    }
     get id() {
         return this.docID;
     }
@@ -65,7 +74,7 @@ class FireTenderDoc {
             createDoc: true,
             initialData: this.data,
         };
-        return new FireTenderDoc(this.schema, ref, mergedOptions);
+        return new FiretenderDoc(this.schema, ref, mergedOptions);
     }
     async load(force = false) {
         if (this.isNewDoc || this.ref.type === "collection") {
@@ -82,20 +91,20 @@ class FireTenderDoc {
         }
         return this;
     }
-    get ro() {
+    get r() {
         if (!this.data) {
-            throw Error("You must call load() before using the .ro accessor.");
+            throw Error("load() must be called before reading the document.");
         }
         return this.data;
     }
-    get rw() {
+    get w() {
         if (this.isNewDoc) {
             // No need to monitor changes if we're creating rather than updating.
             return this.data;
         }
         if (!this.dataProxy) {
             if (!this.data) {
-                throw Error("You must call load() before using the .rw accessor.");
+                throw Error("load() must be called before updating the document.");
             }
             this.dataProxy = (0, proxies_1.watchFieldForChanges)([], this.schema, this.data, this.onChange.bind(this));
         }
@@ -103,7 +112,7 @@ class FireTenderDoc {
     }
     async write() {
         if (this.isNewDoc) {
-            assertIsDefined(this.data);
+            (0, ts_helpers_1.assertIsDefined)(this.data);
             if (this.ref.type === "document") {
                 await (0, firestore_1.setDoc)(this.ref, this.data);
             }
@@ -116,7 +125,7 @@ class FireTenderDoc {
         else {
             if (!(this.ref.type === "document")) {
                 // We should never get here.
-                throw Error("Internal error.  FireTender object should always reference a document when updating an existing doc.");
+                throw Error("Internal error.  Firetender object should always reference a document when updating an existing doc.");
             }
             if (this.updates.size === 0) {
                 return;
@@ -129,5 +138,5 @@ class FireTenderDoc {
         this.updates.set(fieldPath.join("."), newValue);
     }
 }
-exports.FireTenderDoc = FireTenderDoc;
-//# sourceMappingURL=FireTenderDoc.js.map
+exports.FiretenderDoc = FiretenderDoc;
+//# sourceMappingURL=FiretenderDoc.js.map

package/dist/FiretenderDoc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FiretenderDoc.js","sourceRoot":"","sources":["../src/FiretenderDoc.ts"],"names":[],"mappings":";;;AAAA,kDAQ4B;AAE5B,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,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;gBACxB,MAAM,cAAc,CAClB,qDAAqD,CACtD,CAAC;aACH;YACD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SAC/C;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,mIAAmI,CACpI,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,MAAM,CAAC,mBAAmB,CAGxB,MAAmB;QACnB,OAAO;YACL,YAAY,EAAE,CACZ,GAA4C,EAC5C,WAAsB,EACtB,UAAgC,EAAE,EAClC,EAAE,CAAC,aAAa,CAAC,YAAY,CAAC,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC;YAClE,eAAe,EAAE,CACf,GAA4C,EAC5C,UAAgC,EAAE,EAClC,EAAE,CAAC,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC;SAC7C,CAAC;IACJ,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;aAAM;YACL,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,KAAK,CAAC,EAAE;gBAC3B,OAAO;aACR;YACD,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACjE,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;SACH;IACH,CAAC;IAEO,QAAQ,CACd,SAAmB,EACnB,QAAkC;QAElC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;CACF;AAjMD,sCAiMC"}

package/dist/Timestamps.js

@@ -10,8 +10,6 @@ exports.timestampSchema = zod_1.z.object({
     seconds: zod_1.z.number().positive().int(),
     nanoseconds: zod_1.z.number().nonnegative().int(),
 });
-// TODO: probably want to move these timestamp functions into their own helper
-// module
 function dateFromTimestamp(timestamp) {
     return new Date(timestamp.seconds * 1e3 + timestamp.nanoseconds / 1e6);
 }

package/dist/Timestamps.js.map

@@ -1 +1 @@
-{"version":3,"file":"Timestamps.js","sourceRoot":"","sources":["../src/Timestamps.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE;IACpC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE;CAC5C,CAAC,CAAC;AAGH,8EAA8E;AAC9E,SAAS;AAET,SAAgB,iBAAiB,CAAC,SAAwB;IACxD,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,GAAG,GAAG,SAAS,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC;AACzE,CAAC;AAFD,8CAEC;AAED,SAAgB,OAAO,CAAC,WAAW,GAAG,EAAE;IACtC,sEAAsE;IACtE,OAAO,uBAAuB,CAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAC/C,CAAC;AACJ,CAAC;AALD,0BAKC;AAED,SAAgB,iBAAiB,CAAC,IAAU;IAC1C,OAAO,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACjD,CAAC;AAFD,8CAEC;AAED,SAAgB,uBAAuB,CAAC,YAAoB;IAC1D,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QACxC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC;KACzD,CAAC;AACJ,CAAC;AALD,0DAKC;AAED,SAAgB,YAAY;IAC1B,sEAAsE;IACtE,OAAO,uBAAuB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;AAC7C,CAAC;AAHD,oCAGC"}
+{"version":3,"file":"Timestamps.js","sourceRoot":"","sources":["../src/Timestamps.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB;;;GAGG;AACU,QAAA,eAAe,GAAG,OAAC,CAAC,MAAM,CAAC;IACtC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE;IACpC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,CAAC,GAAG,EAAE;CAC5C,CAAC,CAAC;AAGH,SAAgB,iBAAiB,CAAC,SAAwB;IACxD,OAAO,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,GAAG,GAAG,GAAG,SAAS,CAAC,WAAW,GAAG,GAAG,CAAC,CAAC;AACzE,CAAC;AAFD,8CAEC;AAED,SAAgB,OAAO,CAAC,WAAW,GAAG,EAAE;IACtC,sEAAsE;IACtE,OAAO,uBAAuB,CAC5B,IAAI,CAAC,GAAG,EAAE,GAAG,WAAW,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAC/C,CAAC;AACJ,CAAC;AALD,0BAKC;AAED,SAAgB,iBAAiB,CAAC,IAAU;IAC1C,OAAO,uBAAuB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;AACjD,CAAC;AAFD,8CAEC;AAED,SAAgB,uBAAuB,CAAC,YAAoB;IAC1D,OAAO;QACL,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QACxC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,YAAY,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC;KACzD,CAAC;AACJ,CAAC;AALD,0DAKC;AAED,SAAgB,YAAY;IAC1B,sEAAsE;IACtE,OAAO,uBAAuB,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;AAC7C,CAAC;AAHD,oCAGC"}

package/dist/index.d.ts

@@ -1,3 +1,2 @@
-export { DocWrapper } from "./DocWrapper";
-export { FireTenderDoc } from "./FireTenderDoc";
+export { FiretenderDoc } from "./FiretenderDoc";
 export * from "./Timestamps";

package/dist/index.js

@@ -14,10 +14,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FireTenderDoc = exports.DocWrapper = void 0;
-var DocWrapper_1 = require("./DocWrapper");
-Object.defineProperty(exports, "DocWrapper", { enumerable: true, get: function () { return DocWrapper_1.DocWrapper; } });
-var FireTenderDoc_1 = require("./FireTenderDoc");
-Object.defineProperty(exports, "FireTenderDoc", { enumerable: true, get: function () { return FireTenderDoc_1.FireTenderDoc; } });
+exports.FiretenderDoc = void 0;
+var FiretenderDoc_1 = require("./FiretenderDoc");
+Object.defineProperty(exports, "FiretenderDoc", { enumerable: true, get: function () { return FiretenderDoc_1.FiretenderDoc; } });
 __exportStar(require("./Timestamps"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2CAA0C;AAAjC,wGAAA,UAAU,OAAA;AACnB,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,iDAAgD;AAAvC,8GAAA,aAAa,OAAA;AACtB,+CAA6B"}

package/dist/proxies.js

@@ -1,13 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.watchFieldForChanges = exports.watchArrayForChanges = void 0;
+const ts_helpers_1 = require("./ts-helpers");
 const firestore_1 = require("firebase/firestore");
 const zod_1 = require("zod");
-function assertKeyIsString(key) {
-    if (typeof key !== "string") {
-        throw TypeError("Property access using symbols is not supported.");
-    }
-}
 function unwrapSchema(schema) {
     if (schema instanceof zod_1.z.ZodOptional || schema instanceof zod_1.z.ZodNullable) {
         return unwrapSchema(schema.unwrap());
@@ -36,7 +32,7 @@ function getPropertySchema(parentSchema, propertyKey) {
 function watchArrayForChanges(arrayPath, array, fieldSchema, field, onChange) {
     return new Proxy(field, {
         get(target, propertyKey) {
-            assertKeyIsString(propertyKey);
+            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
             const property = target[propertyKey];
             if (property instanceof Function) {
                 const result = (...args) => property.apply(field, args);
@@ -52,7 +48,7 @@ function watchArrayForChanges(arrayPath, array, fieldSchema, field, onChange) {
             return property;
         },
         set(target, propertyKey, value) {
-            assertKeyIsString(propertyKey);
+            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
             const propertySchema = getPropertySchema(fieldSchema, propertyKey);
             const parsedValue = propertySchema.parse(value);
             const result = Reflect.set(target, propertyKey, parsedValue);
@@ -60,7 +56,7 @@ function watchArrayForChanges(arrayPath, array, fieldSchema, field, onChange) {
             return result;
         },
         deleteProperty(target, propertyKey) {
-            assertKeyIsString(propertyKey);
+            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
             // Calling Reflect.deleteProperty on an array item sets it to undefined,
             // which causes Firestore updates to fail unless ignoreUndefinedProperties
             // is set, and which is generally not what we want.  Hence splice.
@@ -82,7 +78,7 @@ exports.watchArrayForChanges = watchArrayForChanges;
 function watchFieldForChanges(fieldPath, fieldSchema, field, onChange) {
     return new Proxy(field, {
         get(target, propertyKey) {
-            assertKeyIsString(propertyKey);
+            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
             const property = target[propertyKey];
             if (property instanceof Function) {
                 return (...args) => property.apply(field, args);
@@ -96,14 +92,14 @@ function watchFieldForChanges(fieldPath, fieldSchema, field, onChange) {
             return property;
         },
         set(target, propertyKey, value) {
-            assertKeyIsString(propertyKey);
+            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
             const propertySchema = getPropertySchema(fieldSchema, propertyKey);
             const parsedValue = propertySchema.parse(value);
             onChange([...fieldPath, propertyKey], parsedValue);
             return Reflect.set(target, propertyKey, parsedValue);
         },
         deleteProperty(target, propertyKey) {
-            assertKeyIsString(propertyKey);
+            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
             onChange([...fieldPath, propertyKey], (0, firestore_1.deleteField)());
             return Reflect.deleteProperty(target, propertyKey);
         },

package/dist/proxies.js.map

@@ -1 +1 @@
-{"version":3,"file":"proxies.js","sourceRoot":"","sources":["../src/proxies.ts"],"names":[],"mappings":";;;AAAA,kDAA8D;AAC9D,6BAAwB;AAExB,SAAS,iBAAiB,CAAC,GAAQ;IACjC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,MAAM,SAAS,CAAC,iDAAiD,CAAC,CAAC;KACpE;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAoB;IACxC,IAAI,MAAM,YAAY,OAAC,CAAC,WAAW,IAAI,MAAM,YAAY,OAAC,CAAC,WAAW,EAAE;QACtE,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;KACtC;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,UAAU,EAAE;QAClC,OAAO,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;KAC7C;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,UAAU,EAAE;QAClC,OAAO,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;KACzC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,iBAAiB,CACxB,YAA0B,EAC1B,WAAmB;IAEnB,MAAM,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;IAC1C,IAAI,MAAM,YAAY,OAAC,CAAC,SAAS,EAAE;QACjC,OAAO,MAAM,CAAC,WAAW,CAAC;KAC3B;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,QAAQ,EAAE;QAChC,OAAO,MAAM,CAAC,OAAO,CAAC;KACvB;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,SAAS,EAAE;QACjC,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;KAClC;IACD,MAAM,SAAS,CACb,yCAAyC,WAAW,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CACpF,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAIlC,SAAmB,EACnB,KAAyB,EACzB,WAA4B,EAC5B,KAA+B,EAC/B,QAAiD;IAEjD,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;QACtB,GAAG,CAAC,MAAM,EAAE,WAAW;YACrB,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,QAAQ,YAAY,QAAQ,EAAE;gBAChC,MAAM,MAAM,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC/D,qEAAqE;gBACrE,wEAAwE;gBACxE,kDAAkD;gBAClD,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBAC3B,OAAO,MAAM,CAAC;aACf;YACD,IAAI,QAAQ,YAAY,MAAM,EAAE;gBAC9B,OAAO,oBAAoB,CACzB,SAAS,EACT,KAAK,EACL,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,EAC3C,QAAQ,EACR,QAAQ,CACT,CAAC;aACH;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK;YAC5B,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,cAAc,GAAG,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YAC7D,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,cAAc,CAAC,MAAM,EAAE,WAAW;YAChC,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAC/B,wEAAwE;YACxE,0EAA0E;YAC1E,kEAAkE;YAClE,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3D,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC9B,MAAM,UAAU,CACd,0CAA0C,WAAW,mBAAmB,CACzE,CAAC;aACH;YACD,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,QAAQ,CAAC,SAAS,EAAE,IAAA,uBAAW,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACpD;iBAAM;gBACL,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;aAC5B;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AA5DD,oDA4DC;AAED,SAAgB,oBAAoB,CAClC,SAAmB,EACnB,WAA4B,EAC5B,KAA+B,EAC/B,QAAiD;IAEjD,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;QACtB,GAAG,CAAC,MAAM,EAAE,WAAW;YACrB,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,QAAQ,YAAY,QAAQ,EAAE;gBAChC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;aACxD;YACD,IAAI,QAAQ,YAAY,KAAK,EAAE;gBAC7B,OAAO,oBAAoB,CACzB,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAC3B,QAAQ,EACR,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,EAC3C,QAAQ,EACR,QAAQ,CACT,CAAC;aACH;YACD,IAAI,QAAQ,YAAY,MAAM,EAAE;gBAC9B,OAAO,oBAAoB,CACzB,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAC3B,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,EAC3C,QAAQ,EACR,QAAQ,CACT,CAAC;aACH;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK;YAC5B,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,cAAc,GAAG,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,QAAQ,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC;YACnD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QACvD,CAAC;QACD,cAAc,CAAC,MAAM,EAAE,WAAW;YAChC,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAC/B,QAAQ,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,IAAA,uBAAW,GAAE,CAAC,CAAC;YACrD,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AA7CD,oDA6CC"}
+{"version":3,"file":"proxies.js","sourceRoot":"","sources":["../src/proxies.ts"],"names":[],"mappings":";;;AAAA,6CAAiD;AACjD,kDAA8D;AAC9D,6BAAwB;AAExB,SAAS,YAAY,CAAC,MAAoB;IACxC,IAAI,MAAM,YAAY,OAAC,CAAC,WAAW,IAAI,MAAM,YAAY,OAAC,CAAC,WAAW,EAAE;QACtE,OAAO,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;KACtC;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,UAAU,EAAE;QAClC,OAAO,YAAY,CAAC,MAAM,CAAC,aAAa,EAAE,CAAC,CAAC;KAC7C;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,UAAU,EAAE;QAClC,OAAO,YAAY,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;KACzC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,iBAAiB,CACxB,YAA0B,EAC1B,WAAmB;IAEnB,MAAM,MAAM,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;IAC1C,IAAI,MAAM,YAAY,OAAC,CAAC,SAAS,EAAE;QACjC,OAAO,MAAM,CAAC,WAAW,CAAC;KAC3B;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,QAAQ,EAAE;QAChC,OAAO,MAAM,CAAC,OAAO,CAAC;KACvB;IACD,IAAI,MAAM,YAAY,OAAC,CAAC,SAAS,EAAE;QACjC,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;KAClC;IACD,MAAM,SAAS,CACb,yCAAyC,WAAW,MAAM,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,CACpF,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAIlC,SAAmB,EACnB,KAAyB,EACzB,WAA4B,EAC5B,KAA+B,EAC/B,QAAiD;IAEjD,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;QACtB,GAAG,CAAC,MAAM,EAAE,WAAW;YACrB,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,QAAQ,YAAY,QAAQ,EAAE;gBAChC,MAAM,MAAM,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC/D,qEAAqE;gBACrE,wEAAwE;gBACxE,kDAAkD;gBAClD,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBAC3B,OAAO,MAAM,CAAC;aACf;YACD,IAAI,QAAQ,YAAY,MAAM,EAAE;gBAC9B,OAAO,oBAAoB,CACzB,SAAS,EACT,KAAK,EACL,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,EAC3C,QAAQ,EACR,QAAQ,CACT,CAAC;aACH;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK;YAC5B,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,cAAc,GAAG,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YAC7D,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAC3B,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,cAAc,CAAC,MAAM,EAAE,WAAW;YAChC,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,wEAAwE;YACxE,0EAA0E;YAC1E,kEAAkE;YAClE,MAAM,aAAa,GAAG,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;YAC3D,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;gBAC9B,MAAM,UAAU,CACd,0CAA0C,WAAW,mBAAmB,CACzE,CAAC;aACH;YACD,IAAI,MAAM,KAAK,KAAK,EAAE;gBACpB,QAAQ,CAAC,SAAS,EAAE,IAAA,uBAAW,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACpD;iBAAM;gBACL,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;aAC5B;YACD,OAAO,IAAI,CAAC;QACd,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AA5DD,oDA4DC;AAED,SAAgB,oBAAoB,CAClC,SAAmB,EACnB,WAA4B,EAC5B,KAA+B,EAC/B,QAAiD;IAEjD,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;QACtB,GAAG,CAAC,MAAM,EAAE,WAAW;YACrB,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,QAAQ,YAAY,QAAQ,EAAE;gBAChC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;aACxD;YACD,IAAI,QAAQ,YAAY,KAAK,EAAE;gBAC7B,OAAO,oBAAoB,CACzB,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAC3B,QAAQ,EACR,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,EAC3C,QAAQ,EACR,QAAQ,CACT,CAAC;aACH;YACD,IAAI,QAAQ,YAAY,MAAM,EAAE;gBAC9B,OAAO,oBAAoB,CACzB,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAC3B,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,EAC3C,QAAQ,EACR,QAAQ,CACT,CAAC;aACH;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK;YAC5B,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,MAAM,cAAc,GAAG,iBAAiB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACnE,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAChD,QAAQ,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC;YACnD,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;QACvD,CAAC;QACD,cAAc,CAAC,MAAM,EAAE,WAAW;YAChC,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,QAAQ,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,IAAA,uBAAW,GAAE,CAAC,CAAC;YACrD,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AA7CD,oDA6CC"}

package/dist/ts-helpers.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Typescript-related helper functions and types.
+ */
+export declare type DeepReadonly<T> = T extends Array<infer ArrKey> ? ReadonlyArray<DeepReadonly<ArrKey>> : T extends Map<infer MapKey, infer MapVal> ? ReadonlyMap<DeepReadonly<MapKey>, DeepReadonly<MapVal>> : T extends Set<infer SetKey> ? ReadonlySet<DeepReadonly<SetKey>> : T extends Record<any, unknown> ? {
+    readonly [ObjKey in keyof T]: DeepReadonly<T[ObjKey]>;
+} : T;
+export declare type MakeFieldsWithDefaultsOptional<T> = T extends Array<infer ArrKey> ? ReadonlyArray<DeepReadonly<ArrKey>> : T extends Map<infer MapKey, infer MapVal> ? ReadonlyMap<DeepReadonly<MapKey>, DeepReadonly<MapVal>> : T extends Set<infer SetKey> ? ReadonlySet<DeepReadonly<SetKey>> : T extends Record<any, unknown> ? {
+    readonly [ObjKey in keyof T]: DeepReadonly<T[ObjKey]>;
+} : T;
+export declare function assertIsDefined<T>(value: T): asserts value is NonNullable<T>;
+export declare function assertKeyIsString(key: any): asserts key is string;

package/dist/ts-helpers.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * Typescript-related helper functions and types.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertKeyIsString = exports.assertIsDefined = void 0;
+function assertIsDefined(value) {
+    if (value === undefined || value === null) {
+        throw new TypeError(`${value} is not defined`);
+    }
+}
+exports.assertIsDefined = assertIsDefined;
+function assertKeyIsString(key) {
+    if (typeof key !== "string") {
+        throw TypeError("Property access using symbols is not supported.");
+    }
+}
+exports.assertKeyIsString = assertKeyIsString;
+//# sourceMappingURL=ts-helpers.js.map

package/dist/ts-helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ts-helpers.js","sourceRoot":"","sources":["../src/ts-helpers.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAsBH,SAAgB,eAAe,CAAI,KAAQ;IACzC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;QACzC,MAAM,IAAI,SAAS,CAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC;KAChD;AACH,CAAC;AAJD,0CAIC;AAED,SAAgB,iBAAiB,CAAC,GAAQ;IACxC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,MAAM,SAAS,CAAC,iDAAiD,CAAC,CAAC;KACpE;AACH,CAAC;AAJD,8CAIC"}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "firetender",
-  "displayName": "FireTender",
+  "displayName": "Firetender",
   "description": "Typescript wrapper for Firestore documents",
-  "version": "0.1.0",
+  "version": "0.3.1",
   "author": "Jake Hartman",
   "license": "MIT",
   "homepage": "https://github.com/jakes-space/firetender",
@@ -27,8 +27,18 @@
     "/dist"
   ],
   "scripts": {
-    "lint": "eslint",
-    "test": "jest"
+    "lint:check": "eslint src --ext .ts",
+    "lint:fix": "eslint --fix src --ext .ts",
+    "prettier:check": "prettier --check src/*.ts src/**/*.ts",
+    "prettier:fix": "prettier --write src/*.ts src/**/*.ts",
+    "check": "npm run lint:check && npm run prettier:check",
+    "fix": "npm run lint:fix && npm run prettier:fix",
+    "emulate-db": "firebase emulators:start --project=firetender",
+    "test": "jest --forceExit --detectOpenHandles",
+    "prepare": "husky install",
+    "clean": "rm -rf dist/*",
+    "build": "npm run clean && tsc && rm -rf dist/__tests__",
+    "prepublishOnly": "npm run check && npm run test && npm run build"
   },
   "dependencies": {
     "firebase": "^9.13.0",
@@ -44,6 +54,8 @@
     "eslint-config-prettier": "^8.5.0",
     "eslint-import-resolver-typescript": "^3.5.2",
     "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
     "jest": "^29.2.2",
     "prettier": "^2.7.1",
     "ts-jest": "^29.0.3",

package/dist/DocWrapper.d.ts

@@ -1,15 +0,0 @@
-import { CollectionReference, DocumentReference } from "firebase/firestore";
-import { z } from "zod";
-import { FireTenderDoc, FireTenderDocOptions } from "./FireTenderDoc";
-/**
- * Factory for FireTenderDoc objects based on the given schema.
- */
-export declare class DocWrapper<SchemaType extends z.SomeZodObject, DataType extends {
-    [x: string]: any;
-} = z.infer<SchemaType>> {
-    private schema;
-    constructor(schema: SchemaType);
-    createNew(ref: DocumentReference | CollectionReference, initialData: any, // TODO: change to "DataType," after defaults are dropped.
-    options?: FireTenderDocOptions): FireTenderDoc<SchemaType, DataType>;
-    wrapExisting(ref: DocumentReference | CollectionReference, options?: FireTenderDocOptions): FireTenderDoc<SchemaType, DataType>;
-}

package/dist/DocWrapper.js

@@ -1,26 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DocWrapper = void 0;
-const FireTenderDoc_1 = require("./FireTenderDoc");
-/**
- * Factory for FireTenderDoc objects based on the given schema.
- */
-class DocWrapper {
-    constructor(schema) {
-        this.schema = schema;
-    }
-    createNew(ref, initialData, // TODO: change to "DataType," after defaults are dropped.
-    options = {}) {
-        const mergedOptions = {
-            ...options,
-            createDoc: true,
-            initialData,
-        };
-        return new FireTenderDoc_1.FireTenderDoc(this.schema, ref, mergedOptions);
-    }
-    wrapExisting(ref, options = {}) {
-        return new FireTenderDoc_1.FireTenderDoc(this.schema, ref, options);
-    }
-}
-exports.DocWrapper = DocWrapper;
-//# sourceMappingURL=DocWrapper.js.map

package/dist/DocWrapper.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"DocWrapper.js","sourceRoot":"","sources":["../src/DocWrapper.ts"],"names":[],"mappings":";;;AAEA,mDAAsE;AAEtE;;GAEG;AACH,MAAa,UAAU;IAErB,YAAoB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE1C,SAAS,CACP,GAA4C,EAC5C,WAAgB,EAAE,0DAA0D;IAC5E,UAAgC,EAAE;QAElC,MAAM,aAAa,GAAyB;YAC1C,GAAG,OAAO;YACV,SAAS,EAAE,IAAI;YACf,WAAW;SACZ,CAAC;QACF,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,CAAC,CAAC;IAC5D,CAAC;IAED,YAAY,CACV,GAA4C,EAC5C,UAAgC,EAAE;QAElC,OAAO,IAAI,6BAAa,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;CACF;AAvBD,gCAuBC"}

package/dist/FireTenderDoc.d.ts

@@ -1,32 +0,0 @@
-import { CollectionReference, DocumentReference } from "firebase/firestore";
-import { z } from "zod";
-export declare type DeepReadonly<T> = T extends Array<infer ArrKey> ? ReadonlyArray<DeepReadonly<ArrKey>> : T extends Map<infer MapKey, infer MapVal> ? ReadonlyMap<DeepReadonly<MapKey>, DeepReadonly<MapVal>> : T extends Set<infer SetKey> ? ReadonlySet<DeepReadonly<SetKey>> : T extends Record<any, unknown> ? {
-    readonly [ObjKey in keyof T]: DeepReadonly<T[ObjKey]>;
-} : T;
-export declare type FireTenderDocOptions = {
-    createDoc?: true;
-    initialData?: any;
-};
-/**
- * Helper class for reading and writing Firestore data based on Zod schemas.
- */
-export declare class FireTenderDoc<SchemaType extends z.SomeZodObject, DataType extends {
-    [x: string]: any;
-} = z.infer<SchemaType>> {
-    readonly schema: SchemaType;
-    private ref;
-    private isNewDoc;
-    private docID;
-    private data;
-    private dataProxy;
-    private updates;
-    constructor(schema: SchemaType, ref: DocumentReference | CollectionReference, options?: FireTenderDocOptions);
-    get id(): string | undefined;
-    get docRef(): DocumentReference;
-    copy(dest?: DocumentReference | CollectionReference | string | undefined, options?: FireTenderDocOptions): FireTenderDoc<SchemaType, DataType>;
-    load(force?: boolean): Promise<this>;
-    get ro(): DeepReadonly<DataType>;
-    get rw(): DataType;
-    write(): Promise<void>;
-    private onChange;
-}

package/dist/FireTenderDoc.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"FireTenderDoc.js","sourceRoot":"","sources":["../src/FireTenderDoc.ts"],"names":[],"mappings":";;;AAAA,kDAQ4B;AAC5B,uCAAiD;AAajD,SAAS,eAAe,CAAI,KAAQ;IAClC,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE;QACzC,MAAM,IAAI,SAAS,CAAC,GAAG,KAAK,iBAAiB,CAAC,CAAC;KAChD;AACH,CAAC;AAQD;;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,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,YAAY,6BAAiB,EAAE,OAAO,CAAC,CAAC;QAC5D,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;gBACxB,MAAM,cAAc,CAClB,qDAAqD,CACtD,CAAC;aACH;YACD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;SAC/C;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,mIAAmI,CACpI,CAAC;SACH;IACH,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,EAAE;QACJ,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,KAAK,CAAC,qDAAqD,CAAC,CAAC;SACpE;QACD,OAAO,IAAI,CAAC,IAA8B,CAAC;IAC7C,CAAC;IAED,IAAI,EAAE;QACJ,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,eAAe,CAAC,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;aAAM;YACL,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,KAAK,CAAC,EAAE;gBAC3B,OAAO;aACR;YACD,MAAM,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;YACjE,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;SACH;IACH,CAAC;IAEO,QAAQ,CACd,SAAmB,EACnB,QAAkC;QAElC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;CACF;AAhKD,sCAgKC"}