firetender 0.10.2 → 0.10.3

package/dist/FiretenderDoc.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.FiretenderDoc = void 0;
 const errors_1 = require("./errors");
 const firestore_deps_1 = require("./firestore-deps");
-const proxies_1 = require("./proxies");
+const proxy_1 = require("./proxy");
 const ts_helpers_1 = require("./ts-helpers");
 /**
  * A local representation of a Firestore document.
@@ -246,7 +246,7 @@ class FiretenderDoc {
                 // TODO #23: Consider being able to update a doc without loading it.
                 throw new errors_1.FiretenderUsageError("load() must be called before updating the document.");
             }
-            this.dataProxy = (0, proxies_1.watchFieldForChanges)([], this.schema, this.data, this.addToUpdateList.bind(this));
+            this.dataProxy = (0, proxy_1.watchForChanges)([], this.schema, this.data, this.addToUpdateList.bind(this));
         }
         return this.dataProxy;
     }

package/dist/FiretenderDoc.js.map

@@ -1 +1 @@
-{"version":3,"file":"FiretenderDoc.js","sourceRoot":"","sources":["../src/FiretenderDoc.ts"],"names":[],"mappings":";;;AAEA,qCAKkB;AAClB,qDAU0B;AAC1B,uCAAiD;AACjD,6CAA6D;AA8B7D;;GAEG;AACH,MAAa,aAAa;IAiCxB;;;;;;;OAOG;IACH,YACE,MAAkB,EAClB,GAA4C,EAC5C,UAAmC,EAAE;QArCvC,yEAAyE;QACjE,UAAK,GAAuB,SAAS,CAAC;QAQ9C,gEAAgE;QACxD,SAAI,GAAoC,SAAS,CAAC;QAE1D,6EAA6E;QACrE,cAAS,GAAkD,SAAS,CAAC;QAE7E,2EAA2E;QACnE,YAAO,GAAG,IAAI,GAAG,EAAe,CAAC;QAuBvC,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,CAAC,oBAAoB,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1C,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,YAAY,kCAAiB,EAAE;YACzC,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,+HAA+H,CAChI,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,YAAY,CACjB,MAAmB,EACnB,GAA4C,EAC5C,WAAiC,EACjC,UAAgC,EAAE;QAElC,MAAM,aAAa,GAA4B;YAC7C,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,IAAI,CACF,OAKgB,SAAS,EACzB,UAAmC,EAAE;QAErC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,6BAAoB,CAC5B,4CAA4C,CAC7C,CAAC;SACH;QACD,IAAI,GAA4C,CAAC;QACjD,IACE,IAAI,YAAY,kCAAiB;YACjC,IAAI,YAAY,oCAAmB,EACnC;YACA,GAAG,GAAG,IAAI,CAAC;SACZ;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE;gBACzB,qEAAqE;gBACrE,2CAA2C;gBAC3C,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;aAClB;YACD,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE;gBACtE,MAAM,IAAI,6BAAoB,CAC5B,6GAA6G,CAC9G,CAAC;aACH;YACD,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;gBACzB,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,GAAG;gBACD,IAAI,CAAC,MAAM,KAAK,eAAe;oBAC7B,CAAC,CAAC,IAAA,oBAAG,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACpD,CAAC,CAAC,IAAA,2BAAU,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACjE;aAAM;YACL,gCAAgC;YAChC,MAAM,aAAa,GACjB,IAAI,CAAC,GAAG,YAAY,kCAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YACrE,IAAI,IAAI,EAAE;gBACR,GAAG,GAAG,IAAA,oBAAG,EAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aAChC;iBAAM;gBACL,GAAG,GAAG,aAAa,CAAC;aACrB;SACF;QACD,MAAM,aAAa,GAA4B;YAC7C,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,IAAI,6BAAoB,CAC5B,6DAA6D,CAC9D,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,YAAY,kCAAiB,CAAC,EAAE;YAC5C,MAAM,IAAI,6BAAoB,CAC5B,iEAAiE,CAClE,CAAC;SACH;QACD,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK;QACtB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,YAAY,oCAAmB,EAAE;YAC5D,MAAM,IAAI,6BAAoB,CAC5B,gDAAgD,CACjD,CAAC;SACH;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,EAAE;YACvB,IAAI,IAAI,CAAC,sBAAsB,KAAK,SAAS,EAAE;gBAC7C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC1C,IAAA,4BAAe,EAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;oBAC7C,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;gBACxD,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC;gBACjC,IAAI,QAA0B,CAAC;gBAC/B,IAAI;oBACF,QAAQ,GAAG,MAAM,IAAA,uBAAM,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBACnC;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAA,0BAAiB,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC7C,MAAM,KAAK,CAAC;iBACb;gBACD,qDAAqD;gBACrD,sEAAsE;gBACtE,IACE,CAAC,OAAO,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC1D,CAAC,OAAO,QAAQ,CAAC,MAAM,KAAK,UAAU,IAAI,CAAE,QAAQ,CAAC,MAAc,EAAE,CAAC,EACtE;oBACA,MAAM,KAAK,GAAG,IAAI,0BAAiB,CACjC,6BAA6B,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAC9C,CAAC;oBACF,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;oBAClE,MAAM,KAAK,CAAC;iBACb;gBACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC/C,mEAAmE;gBACnE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC3B,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC9D,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;aACzC;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAI,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,6BAAoB,CAC5B,oDAAoD,CACrD,CAAC;SACH;QACD,OAAO,IAAI,CAAC,IAAyC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,oEAAoE;YACpE,OAAO,IAAI,CAAC,IAA2B,CAAC;SACzC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,oEAAoE;gBACpE,MAAM,IAAI,6BAAoB,CAC5B,qDAAqD,CACtD,CAAC;aACH;YACD,IAAI,CAAC,SAAS,GAAG,IAAA,8BAAoB,EACnC,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;SACH;QACD,OAAO,IAAI,CAAC,SAAgC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,CAAC,OAA4B;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,4DAA4D;QAC5D,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,IAAA,4BAAe,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,IAAI,CAAC,GAAG,YAAY,kCAAiB,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAA,uBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;iBACnC;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAA,0BAAiB,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;oBACxD,MAAM,KAAK,CAAC;iBACb;aACF;iBAAM;gBACL,IAAI;oBACF,IAAI,CAAC,GAAG,GAAG,MAAM,IAAA,uBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC9C;gBAAC,OAAO,KAAU,EAAE;oBACnB,IAAA,0BAAiB,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;oBACxD,MAAM,KAAK,CAAC;iBACb;gBACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,2BAA2B;aACzE;YACD,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;YAClC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;QACD,oEAAoE;aAC/D;YACH,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,YAAY,kCAAiB,CAAC,EAAE;gBAC5C,4BAA4B;gBAC5B,MAAM,IAAI,gCAAuB,CAC/B,sGAAsG,CACvG,CAAC;aACH;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;gBACzB,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACpD,IAAI;oBACF,MAAM,IAAA,0BAAS,EAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;iBACvC;gBAAC,OAAO,KAAU,EAAE;oBACnB,IAAA,0BAAiB,EAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;oBAC5D,MAAM,KAAK,CAAC;iBACb;gBACD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aACtB;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,OAA4C;QACvD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8EAA8E;IAC9E,oBAAoB;IAEpB;;;;OAIG;IACK,eAAe,CACrB,SAAmB,EACnB,QAAkC;QAElC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;YACzB,yEAAyE;YACzE,oEAAoE;YACpE,oEAAoE;YACpE,mEAAmE;YACnE,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;AA7aD,sCA6aC"}
+{"version":3,"file":"FiretenderDoc.js","sourceRoot":"","sources":["../src/FiretenderDoc.ts"],"names":[],"mappings":";;;AAEA,qCAKkB;AAClB,qDAU0B;AAC1B,mCAA0C;AAC1C,6CAA6D;AA8B7D;;GAEG;AACH,MAAa,aAAa;IAiCxB;;;;;;;OAOG;IACH,YACE,MAAkB,EAClB,GAA4C,EAC5C,UAAmC,EAAE;QArCvC,yEAAyE;QACjE,UAAK,GAAuB,SAAS,CAAC;QAQ9C,gEAAgE;QACxD,SAAI,GAAoC,SAAS,CAAC;QAE1D,6EAA6E;QACrE,cAAS,GAAkD,SAAS,CAAC;QAE7E,2EAA2E;QACnE,YAAO,GAAG,IAAI,GAAG,EAAe,CAAC;QAuBvC,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,CAAC,oBAAoB,GAAG,IAAI,CAAC,QAAQ,CAAC;QAC1C,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,YAAY,kCAAiB,EAAE;YACzC,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,+HAA+H,CAChI,CAAC;SACH;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,YAAY,CACjB,MAAmB,EACnB,GAA4C,EAC5C,WAAiC,EACjC,UAAgC,EAAE;QAElC,MAAM,aAAa,GAA4B;YAC7C,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;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,IAAI,CACF,OAKgB,SAAS,EACzB,UAAmC,EAAE;QAErC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,6BAAoB,CAC5B,4CAA4C,CAC7C,CAAC;SACH;QACD,IAAI,GAA4C,CAAC;QACjD,IACE,IAAI,YAAY,kCAAiB;YACjC,IAAI,YAAY,oCAAmB,EACnC;YACA,GAAG,GAAG,IAAI,CAAC;SACZ;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,EAAE;gBACzB,qEAAqE;gBACrE,2CAA2C;gBAC3C,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;aAClB;YACD,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;YAC9C,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,eAAe,EAAE;gBACtE,MAAM,IAAI,6BAAoB,CAC5B,6GAA6G,CAC9G,CAAC;aACH;YACD,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,KAAK,EAAE,EAAE;gBACzB,IAAI,CAAC,KAAK,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;YAC3B,CAAC,CAAC,CAAC;YACH,GAAG;gBACD,IAAI,CAAC,MAAM,KAAK,eAAe;oBAC7B,CAAC,CAAC,IAAA,oBAAG,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBACpD,CAAC,CAAC,IAAA,2BAAU,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACjE;aAAM;YACL,gCAAgC;YAChC,MAAM,aAAa,GACjB,IAAI,CAAC,GAAG,YAAY,kCAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;YACrE,IAAI,IAAI,EAAE;gBACR,GAAG,GAAG,IAAA,oBAAG,EAAC,aAAa,EAAE,IAAI,CAAC,CAAC;aAChC;iBAAM;gBACL,GAAG,GAAG,aAAa,CAAC;aACrB;SACF;QACD,MAAM,aAAa,GAA4B;YAC7C,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,IAAI,6BAAoB,CAC5B,6DAA6D,CAC9D,CAAC;SACH;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,IAAI,MAAM;QACR,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,YAAY,kCAAiB,CAAC,EAAE;YAC5C,MAAM,IAAI,6BAAoB,CAC5B,iEAAiE,CAClE,CAAC;SACH;QACD,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;OAEG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,QAAQ;QACN,OAAO,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,oBAAoB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,KAAK,GAAG,KAAK;QACtB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,GAAG,YAAY,oCAAmB,EAAE;YAC5D,MAAM,IAAI,6BAAoB,CAC5B,gDAAgD,CACjD,CAAC;SACH;QACD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,EAAE;YACvB,IAAI,IAAI,CAAC,sBAAsB,KAAK,SAAS,EAAE;gBAC7C,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC1C,IAAA,4BAAe,EAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;oBAC7C,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;gBACxD,CAAC,CAAC,CAAC;aACJ;iBAAM;gBACL,IAAI,CAAC,sBAAsB,GAAG,EAAE,CAAC;gBACjC,IAAI,QAA0B,CAAC;gBAC/B,IAAI;oBACF,QAAQ,GAAG,MAAM,IAAA,uBAAM,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBACnC;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAA,0BAAiB,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC7C,MAAM,KAAK,CAAC;iBACb;gBACD,qDAAqD;gBACrD,sEAAsE;gBACtE,IACE,CAAC,OAAO,QAAQ,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;oBAC1D,CAAC,OAAO,QAAQ,CAAC,MAAM,KAAK,UAAU,IAAI,CAAE,QAAQ,CAAC,MAAc,EAAE,CAAC,EACtE;oBACA,MAAM,KAAK,GAAG,IAAI,0BAAiB,CACjC,6BAA6B,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,CAC9C,CAAC;oBACF,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;oBAClE,MAAM,KAAK,CAAC;iBACb;gBACD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC/C,mEAAmE;gBACnE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;gBAC3B,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC9D,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAC;aACzC;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,IAAI,CAAC;QACH,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,6BAAoB,CAC5B,oDAAoD,CACrD,CAAC;SACH;QACD,OAAO,IAAI,CAAC,IAAyC,CAAC;IACxD,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC;QACH,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,oEAAoE;YACpE,OAAO,IAAI,CAAC,IAA2B,CAAC;SACzC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;gBACd,oEAAoE;gBACpE,MAAM,IAAI,6BAAoB,CAC5B,qDAAqD,CACtD,CAAC;aACH;YACD,IAAI,CAAC,SAAS,GAAG,IAAA,uBAAe,EAC9B,EAAE,EACF,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAChC,CAAC;SACH;QACD,OAAO,IAAI,CAAC,SAAgC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,CAAC,OAA4B;QAChC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK;QACT,4DAA4D;QAC5D,IAAI,IAAI,CAAC,oBAAoB,EAAE;YAC7B,IAAA,4BAAe,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC3B,IAAI,IAAI,CAAC,GAAG,YAAY,kCAAiB,EAAE;gBACzC,IAAI;oBACF,MAAM,IAAA,uBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;iBACnC;gBAAC,OAAO,KAAK,EAAE;oBACd,IAAA,0BAAiB,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;oBACxD,MAAM,KAAK,CAAC;iBACb;aACF;iBAAM;gBACL,IAAI;oBACF,IAAI,CAAC,GAAG,GAAG,MAAM,IAAA,uBAAM,EAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;iBAC9C;gBAAC,OAAO,KAAU,EAAE;oBACnB,IAAA,0BAAiB,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;oBACxD,MAAM,KAAK,CAAC;iBACb;gBACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,2BAA2B;aACzE;YACD,IAAI,CAAC,oBAAoB,GAAG,KAAK,CAAC;YAClC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;SACvB;QACD,oEAAoE;aAC/D;YACH,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,YAAY,kCAAiB,CAAC,EAAE;gBAC5C,4BAA4B;gBAC5B,MAAM,IAAI,gCAAuB,CAC/B,sGAAsG,CACvG,CAAC;aACH;YACD,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;gBACzB,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACpD,IAAI;oBACF,MAAM,IAAA,0BAAS,EAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;iBACvC;gBAAC,OAAO,KAAU,EAAE;oBACnB,IAAA,0BAAiB,EAAC,KAAK,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAC;oBAC5D,MAAM,KAAK,CAAC;iBACb;gBACD,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;aACtB;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,MAAM,CAAC,OAA4C;QACvD,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8EAA8E;IAC9E,oBAAoB;IAEpB;;;;OAIG;IACK,eAAe,CACrB,SAAmB,EACnB,QAAkC;QAElC,IAAI,UAAU,GAAG,EAAE,CAAC;QACpB,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE;YACzB,yEAAyE;YACzE,oEAAoE;YACpE,oEAAoE;YACpE,mEAAmE;YACnE,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;AA7aD,sCA6aC"}

package/dist/proxy.d.ts

@@ -0,0 +1,31 @@
+import { z } from "zod";
+/**
+ * Wraps an object based on a Zod schema in a proxy that watches for changes.
+ *
+ * Nested fields are monitored by creating a chain of proxies.  Consider this
+ * case:
+ *
+ *   testDoc.w.record1.record2.someStringValue = "foo";
+ *
+ * There is a top-level proxy (call it proxy 0) for the ".w" accessor.  Getting
+ * ".record1" from it returns a child proxy (1) wrapping that field.  Getting
+ * ".record2" from that returns another child proxy (2) wrapping that subfield.
+ * Finally, setting ".someStringValue" uses the setter of proxy 2 to set the new
+ * value locally and register an update to be sent to Firestore.
+ *
+ * If the wrapped field or one of its ancestors is an array, this won't work.
+ * Firestore supports limited modification of arrays; see the 2018 blog entry at
+ * https://firebase.blog/posts/2018/08/better-arrays-in-cloud-firestore for
+ * details and some history.  The tl;dr is that we can't update array entries,
+ * and arrayUnion() and arrayRemove() treat the array as a set.  So we have to
+ * update the entire top-level array.  Child proxies maintain a link to the
+ * top-level array ancestor and trigger a rewrite of the whole thing if there
+ * are any changes to the contents.
+ *
+ * @param updatePath the Firestore path to be updated, as an array of strings.
+ * @param fieldSchema schema of the object being wrapped.
+ * @param field reference to the field in the local document data.
+ * @param addToUpdateList callback to register updates to updatePath.
+ * @param arrayAncestor a reference to the top-level array, if any.
+ */
+export declare function watchForChanges<FieldSchemaType extends z.ZodTypeAny, ArrayElementType>(updatePath: string[], fieldSchema: FieldSchemaType, field: z.infer<FieldSchemaType>, addToUpdateList: (path: string[], newValue: any) => void, arrayAncestor?: ArrayElementType[] | undefined): z.infer<FieldSchemaType>;

package/dist/proxy.js

@@ -0,0 +1,220 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.watchForChanges = void 0;
+const zod_1 = require("zod");
+const firestore_deps_1 = require("./firestore-deps");
+/**
+ * Getting this symbol from one of our proxies returns the proxy's target.
+ */
+const PROXY_TARGET_SYMBOL = Symbol("proxy_target");
+/**
+ * Wraps an object based on a Zod schema in a proxy that watches for changes.
+ *
+ * Nested fields are monitored by creating a chain of proxies.  Consider this
+ * case:
+ *
+ *   testDoc.w.record1.record2.someStringValue = "foo";
+ *
+ * There is a top-level proxy (call it proxy 0) for the ".w" accessor.  Getting
+ * ".record1" from it returns a child proxy (1) wrapping that field.  Getting
+ * ".record2" from that returns another child proxy (2) wrapping that subfield.
+ * Finally, setting ".someStringValue" uses the setter of proxy 2 to set the new
+ * value locally and register an update to be sent to Firestore.
+ *
+ * If the wrapped field or one of its ancestors is an array, this won't work.
+ * Firestore supports limited modification of arrays; see the 2018 blog entry at
+ * https://firebase.blog/posts/2018/08/better-arrays-in-cloud-firestore for
+ * details and some history.  The tl;dr is that we can't update array entries,
+ * and arrayUnion() and arrayRemove() treat the array as a set.  So we have to
+ * update the entire top-level array.  Child proxies maintain a link to the
+ * top-level array ancestor and trigger a rewrite of the whole thing if there
+ * are any changes to the contents.
+ *
+ * @param updatePath the Firestore path to be updated, as an array of strings.
+ * @param fieldSchema schema of the object being wrapped.
+ * @param field reference to the field in the local document data.
+ * @param addToUpdateList callback to register updates to updatePath.
+ * @param arrayAncestor a reference to the top-level array, if any.
+ */
+function watchForChanges(updatePath, fieldSchema, field, addToUpdateList, arrayAncestor = undefined) {
+    return new Proxy(field, {
+        get(target, propertyKey) {
+            const property = target[propertyKey];
+            if (property instanceof Function) {
+                const result = (...args) => property.apply(field, args);
+                if (arrayAncestor) {
+                    // All methods of an array or its children are presumed to make
+                    // modifications, thus triggering an update of the full array.
+                    //
+                    // TODO: #11 Only mark updates for mutating array methods.
+                    //
+                    // Methods of all other objects are ignored.  This is safe because the
+                    // only other allowed objects are Records, which do not have mutating
+                    // methods.
+                    addToUpdateList(updatePath, arrayAncestor);
+                }
+                return result;
+            }
+            if (typeof propertyKey === "symbol") {
+                // PROXY_TARGET_SYMBOL unwraps this proxy.
+                if (propertyKey === PROXY_TARGET_SYMBOL) {
+                    return target;
+                }
+                // Allow all other symbols to pass through.
+                return property;
+            }
+            if (property instanceof Object) {
+                // Child objects need to be wrapped with another watchForChanges() call.
+                let nextPath;
+                let nextArrayAncestor;
+                if (arrayAncestor) {
+                    // Array ancestors should continue pointing to the top-level array.
+                    nextPath = updatePath;
+                    nextArrayAncestor = arrayAncestor;
+                }
+                else {
+                    // Otherwise the next proxy should point to this child.  If it's an
+                    // array, establish it as a top-level array.
+                    nextPath = [...updatePath, propertyKey];
+                    if (property instanceof Array) {
+                        nextArrayAncestor = property;
+                    }
+                }
+                return watchForChanges(nextPath, getPropertySchema(field, fieldSchema, propertyKey), property, addToUpdateList, nextArrayAncestor);
+            }
+            // Otherwise we must be getting a primitive.  No need to wrap it.
+            return property;
+        },
+        set(target, propertyKey, value) {
+            if (typeof propertyKey === "symbol") {
+                // Allow symbols to pass through.
+                return Reflect.set(target, propertyKey, value);
+            }
+            let processedValue = value;
+            // If the new value is an object wrapped in a Firetender proxy, which can
+            // commonly happen when referencing it inside a mutator function passed to
+            // FiretenderDoc.prototype.update(), unwrap it.
+            if (value instanceof Object && value[PROXY_TARGET_SYMBOL]) {
+                processedValue = value[PROXY_TARGET_SYMBOL];
+            }
+            // A property of this object is being set to a new value.  Parse the new
+            // value with the appropriate schema, set it in the local data, and mark
+            // the property (if we aren't inside an array) or the entire top-level
+            // array (if we are) as needing to be written.  If the new value is
+            // undefined, delete the property.
+            const propertySchema = getPropertySchema(field, fieldSchema, propertyKey);
+            processedValue = propertySchema.parse(processedValue);
+            let result;
+            if (processedValue === undefined) {
+                processedValue = (0, firestore_deps_1.deleteField)();
+                result = Reflect.deleteProperty(target, propertyKey);
+            }
+            else {
+                processedValue = pruneUndefinedFields(processedValue);
+                result = Reflect.set(target, propertyKey, processedValue);
+            }
+            if (arrayAncestor) {
+                addToUpdateList(updatePath, arrayAncestor);
+            }
+            else {
+                addToUpdateList([...updatePath, propertyKey], processedValue);
+            }
+            return result;
+        },
+        deleteProperty(target, propertyKey) {
+            if (typeof propertyKey === "symbol") {
+                // Allow symbols to pass through.
+                return Reflect.deleteProperty(target, propertyKey);
+            }
+            let result = true;
+            if (target instanceof Array) {
+                // Calling Reflect.deleteProperty on an array item sets it to undefined,
+                // which causes Firestore writes to fail if ignoreUndefinedProperties is
+                // not set, and which is generally not what we want.  Hence splice.
+                if (!propertyKey.match(/^\d+$/)) {
+                    throw TypeError(`Failed to delete an invalid array index: "${propertyKey}".`);
+                }
+                const index = Number(propertyKey);
+                target.splice(index, 1);
+                // The delete operator pretty much always returns true, so do the same.
+            }
+            else {
+                result = Reflect.deleteProperty(target, propertyKey);
+            }
+            if (arrayAncestor) {
+                // Firestore's arrayRemove() deletes all matching entries, which is not
+                // desired.  So we have to rewrite the full array.
+                addToUpdateList(updatePath, arrayAncestor);
+            }
+            else {
+                addToUpdateList([...updatePath, propertyKey], (0, firestore_deps_1.deleteField)());
+            }
+            return result;
+        },
+    });
+}
+exports.watchForChanges = watchForChanges;
+/**
+ * Given a Zod schema representing a collection, returns the sub-schema of the
+ * specified property.
+ */
+function getPropertySchema(parent, parentSchema, propertyKey) {
+    let schema = parentSchema;
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        switch (schema._def.typeName) {
+            // If the schema object is wrapped (e.g., by being optional or having a
+            // default), unwrap it until we get to the underlying collection type.
+            case zod_1.z.ZodFirstPartyTypeKind.ZodOptional:
+            case zod_1.z.ZodFirstPartyTypeKind.ZodNullable:
+                schema = schema.unwrap();
+                continue;
+            case zod_1.z.ZodFirstPartyTypeKind.ZodDefault:
+                schema = schema.removeDefault();
+                continue;
+            case zod_1.z.ZodFirstPartyTypeKind.ZodEffects:
+                schema = schema.innerType();
+                continue;
+            // Return the sub-schemas of supported collection types.
+            case zod_1.z.ZodFirstPartyTypeKind.ZodRecord:
+                if (schema.keySchema._def.typeName !== zod_1.z.ZodFirstPartyTypeKind.ZodString) {
+                    throw TypeError(`The ZodRecord for property ${propertyKey} has keys of type ${schema.keySchema._def.typeName}.  Only strings are supported.`);
+                }
+                return schema.valueSchema;
+            case zod_1.z.ZodFirstPartyTypeKind.ZodArray:
+                return schema.element;
+            case zod_1.z.ZodFirstPartyTypeKind.ZodObject:
+                return schema.shape[propertyKey];
+            case zod_1.z.ZodFirstPartyTypeKind.ZodDiscriminatedUnion:
+                return schema.optionsMap.get(parent[schema.discriminator]);
+            // If the parent is of type ZodAny, so are its properties.
+            case zod_1.z.ZodFirstPartyTypeKind.ZodAny:
+                return zod_1.z.any();
+            default:
+                throw TypeError(`Unsupported schema type for property "${propertyKey}": ${schema._def.typeName}`);
+        }
+    }
+}
+/**
+ * Returns a deep copy of the given object, omitting any undefined fields.
+ *
+ * Note: Timestamps and server timestamps pass through unmodified, but all other
+ * objects will be stripped of their methods.
+ */
+function pruneUndefinedFields(obj) {
+    if (typeof obj !== "object" ||
+        obj === null ||
+        obj instanceof firestore_deps_1.Timestamp ||
+        (0, firestore_deps_1.isServerTimestamp)(obj)) {
+        return obj;
+    }
+    if (obj instanceof Array) {
+        return obj
+            .filter((v) => v !== undefined)
+            .map((v) => pruneUndefinedFields(v));
+    }
+    return Object.fromEntries(Object.entries(obj)
+        .filter(([_k, v]) => v !== undefined)
+        .map(([k, v]) => [k, pruneUndefinedFields(v)]));
+}
+//# sourceMappingURL=proxy.js.map

package/dist/proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.js","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,qDAA6E;AAE7E;;GAEG;AACH,MAAM,mBAAmB,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,SAAgB,eAAe,CAI7B,UAAoB,EACpB,WAA4B,EAC5B,KAA+B,EAC/B,eAAwD,EACxD,gBAAgD,SAAS;IAEzD,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;QACtB,GAAG,CAAC,MAAM,EAAE,WAAW;YACrB,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,IAAI,aAAa,EAAE;oBACjB,+DAA+D;oBAC/D,8DAA8D;oBAC9D,EAAE;oBACF,0DAA0D;oBAC1D,EAAE;oBACF,sEAAsE;oBACtE,qEAAqE;oBACrE,WAAW;oBACX,eAAe,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;iBAC5C;gBACD,OAAO,MAAM,CAAC;aACf;YACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACnC,0CAA0C;gBAC1C,IAAI,WAAW,KAAK,mBAAmB,EAAE;oBACvC,OAAO,MAAM,CAAC;iBACf;gBACD,2CAA2C;gBAC3C,OAAO,QAAQ,CAAC;aACjB;YACD,IAAI,QAAQ,YAAY,MAAM,EAAE;gBAC9B,wEAAwE;gBACxE,IAAI,QAAkB,CAAC;gBACvB,IAAI,iBAAoC,CAAC;gBACzC,IAAI,aAAa,EAAE;oBACjB,mEAAmE;oBACnE,QAAQ,GAAG,UAAU,CAAC;oBACtB,iBAAiB,GAAG,aAAa,CAAC;iBACnC;qBAAM;oBACL,mEAAmE;oBACnE,4CAA4C;oBAC5C,QAAQ,GAAG,CAAC,GAAG,UAAU,EAAE,WAAW,CAAC,CAAC;oBACxC,IAAI,QAAQ,YAAY,KAAK,EAAE;wBAC7B,iBAAiB,GAAG,QAAQ,CAAC;qBAC9B;iBACF;gBACD,OAAO,eAAe,CACpB,QAAQ,EACR,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,EAClD,QAAQ,EACR,eAAe,EACf,iBAAiB,CAClB,CAAC;aACH;YACD,iEAAiE;YACjE,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK;YAC5B,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACnC,iCAAiC;gBACjC,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;aAChD;YACD,IAAI,cAAc,GAAG,KAAK,CAAC;YAC3B,yEAAyE;YACzE,0EAA0E;YAC1E,+CAA+C;YAC/C,IAAI,KAAK,YAAY,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,EAAE;gBACzD,cAAc,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;aAC7C;YACD,wEAAwE;YACxE,wEAAwE;YACxE,sEAAsE;YACtE,mEAAmE;YACnE,kCAAkC;YAClC,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YAC1E,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACtD,IAAI,MAAe,CAAC;YACpB,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,cAAc,GAAG,IAAA,4BAAW,GAAE,CAAC;gBAC/B,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;aACtD;iBAAM;gBACL,cAAc,GAAG,oBAAoB,CAAC,cAAc,CAAC,CAAC;gBACtD,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;aAC3D;YACD,IAAI,aAAa,EAAE;gBACjB,eAAe,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;aAC5C;iBAAM;gBACL,eAAe,CAAC,CAAC,GAAG,UAAU,EAAE,WAAW,CAAC,EAAE,cAAc,CAAC,CAAC;aAC/D;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,cAAc,CAAC,MAAM,EAAE,WAAW;YAChC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACnC,iCAAiC;gBACjC,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;aACpD;YACD,IAAI,MAAM,GAAG,IAAI,CAAC;YAClB,IAAK,MAAc,YAAY,KAAK,EAAE;gBACpC,wEAAwE;gBACxE,wEAAwE;gBACxE,mEAAmE;gBACnE,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;oBAC/B,MAAM,SAAS,CACb,6CAA6C,WAAW,IAAI,CAC7D,CAAC;iBACH;gBACD,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;gBAClC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;gBACxB,uEAAuE;aACxE;iBAAM;gBACL,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;aACtD;YACD,IAAI,aAAa,EAAE;gBACjB,uEAAuE;gBACvE,kDAAkD;gBAClD,eAAe,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;aAC5C;iBAAM;gBACL,eAAe,CAAC,CAAC,GAAG,UAAU,EAAE,WAAW,CAAC,EAAE,IAAA,4BAAW,GAAE,CAAC,CAAC;aAC9D;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAhID,0CAgIC;AAED;;;GAGG;AACH,SAAS,iBAAiB,CACxB,MAAW,EACX,YAA0B,EAC1B,WAAmB;IAEnB,IAAI,MAAM,GAAQ,YAAY,CAAC;IAC/B,iDAAiD;IACjD,OAAO,IAAI,EAAE;QACX,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC5B,uEAAuE;YACvE,sEAAsE;YACtE,KAAK,OAAC,CAAC,qBAAqB,CAAC,WAAW,CAAC;YACzC,KAAK,OAAC,CAAC,qBAAqB,CAAC,WAAW;gBACtC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBACzB,SAAS;YACX,KAAK,OAAC,CAAC,qBAAqB,CAAC,UAAU;gBACrC,MAAM,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;gBAChC,SAAS;YACX,KAAK,OAAC,CAAC,qBAAqB,CAAC,UAAU;gBACrC,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBAC5B,SAAS;YACX,wDAAwD;YACxD,KAAK,OAAC,CAAC,qBAAqB,CAAC,SAAS;gBACpC,IACE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,KAAK,OAAC,CAAC,qBAAqB,CAAC,SAAS,EACpE;oBACA,MAAM,SAAS,CACb,8BAA8B,WAAW,qBAAqB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,gCAAgC,CAC7H,CAAC;iBACH;gBACD,OAAO,MAAM,CAAC,WAAW,CAAC;YAC5B,KAAK,OAAC,CAAC,qBAAqB,CAAC,QAAQ;gBACnC,OAAO,MAAM,CAAC,OAAO,CAAC;YACxB,KAAK,OAAC,CAAC,qBAAqB,CAAC,SAAS;gBACpC,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACnC,KAAK,OAAC,CAAC,qBAAqB,CAAC,qBAAqB;gBAChD,OAAQ,MAAc,CAAC,UAAU,CAAC,GAAG,CACnC,MAAM,CAAE,MAAc,CAAC,aAAa,CAAC,CACtC,CAAC;YACJ,0DAA0D;YAC1D,KAAK,OAAC,CAAC,qBAAqB,CAAC,MAAM;gBACjC,OAAO,OAAC,CAAC,GAAG,EAAE,CAAC;YACjB;gBACE,MAAM,SAAS,CACb,yCAAyC,WAAW,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CACjF,CAAC;SACL;KACF;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,oBAAoB,CAAI,GAAM;IACrC,IACE,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,GAAG,YAAY,0BAAS;QACxB,IAAA,kCAAiB,EAAC,GAAG,CAAC,EACtB;QACA,OAAO,GAAG,CAAC;KACZ;IACD,IAAI,GAAG,YAAY,KAAK,EAAE;QACxB,OAAO,GAAG;aACP,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;aAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAM,CAAC;KAC7C;IACD,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,OAAO,CAAC,GAAgD,CAAC;SAC7D,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC;SACpC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAC5C,CAAC;AACT,CAAC"}

package/dist/ts-helpers.d.ts

@@ -11,4 +11,3 @@ export type MakeFieldsWithDefaultsOptional<T> = T extends Array<infer ArrKey> ?
     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

@@ -3,17 +3,11 @@
  * Typescript-related helper functions and types.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertKeyIsString = exports.assertIsDefined = void 0;
+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

@@ -1 +1 @@
-{"version":3,"file":"ts-helpers.js","sourceRoot":"","sources":["../src/ts-helpers.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA0BH,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"}
+{"version":3,"file":"ts-helpers.js","sourceRoot":"","sources":["../src/ts-helpers.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AA0BH,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"}

package/package.json

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

package/src/FiretenderDoc.ts

@@ -17,7 +17,7 @@ import {
   setDoc,
   updateDoc,
 } from "./firestore-deps";
-import { watchFieldForChanges } from "./proxies";
+import { watchForChanges } from "./proxy";
 import { assertIsDefined, DeepReadonly } from "./ts-helpers";
 
 /**
@@ -358,7 +358,7 @@ export class FiretenderDoc<SchemaType extends z.SomeZodObject> {
           "load() must be called before updating the document."
         );
       }
-      this.dataProxy = watchFieldForChanges(
+      this.dataProxy = watchForChanges(
         [],
         this.schema,
         this.data,

package/src/proxy.ts

@@ -0,0 +1,248 @@
+import { z } from "zod";
+
+import { deleteField, isServerTimestamp, Timestamp } from "./firestore-deps";
+
+/**
+ * Getting this symbol from one of our proxies returns the proxy's target.
+ */
+const PROXY_TARGET_SYMBOL = Symbol("proxy_target");
+
+/**
+ * Wraps an object based on a Zod schema in a proxy that watches for changes.
+ *
+ * Nested fields are monitored by creating a chain of proxies.  Consider this
+ * case:
+ *
+ *   testDoc.w.record1.record2.someStringValue = "foo";
+ *
+ * There is a top-level proxy (call it proxy 0) for the ".w" accessor.  Getting
+ * ".record1" from it returns a child proxy (1) wrapping that field.  Getting
+ * ".record2" from that returns another child proxy (2) wrapping that subfield.
+ * Finally, setting ".someStringValue" uses the setter of proxy 2 to set the new
+ * value locally and register an update to be sent to Firestore.
+ *
+ * If the wrapped field or one of its ancestors is an array, this won't work.
+ * Firestore supports limited modification of arrays; see the 2018 blog entry at
+ * https://firebase.blog/posts/2018/08/better-arrays-in-cloud-firestore for
+ * details and some history.  The tl;dr is that we can't update array entries,
+ * and arrayUnion() and arrayRemove() treat the array as a set.  So we have to
+ * update the entire top-level array.  Child proxies maintain a link to the
+ * top-level array ancestor and trigger a rewrite of the whole thing if there
+ * are any changes to the contents.
+ *
+ * @param updatePath the Firestore path to be updated, as an array of strings.
+ * @param fieldSchema schema of the object being wrapped.
+ * @param field reference to the field in the local document data.
+ * @param addToUpdateList callback to register updates to updatePath.
+ * @param arrayAncestor a reference to the top-level array, if any.
+ */
+export function watchForChanges<
+  FieldSchemaType extends z.ZodTypeAny,
+  ArrayElementType
+>(
+  updatePath: string[],
+  fieldSchema: FieldSchemaType,
+  field: z.infer<FieldSchemaType>,
+  addToUpdateList: (path: string[], newValue: any) => void,
+  arrayAncestor: ArrayElementType[] | undefined = undefined
+): z.infer<FieldSchemaType> {
+  return new Proxy(field, {
+    get(target, propertyKey) {
+      const property = target[propertyKey];
+      if (property instanceof Function) {
+        const result = (...args: any[]) => property.apply(field, args);
+        if (arrayAncestor) {
+          // All methods of an array or its children are presumed to make
+          // modifications, thus triggering an update of the full array.
+          //
+          // TODO: #11 Only mark updates for mutating array methods.
+          //
+          // Methods of all other objects are ignored.  This is safe because the
+          // only other allowed objects are Records, which do not have mutating
+          // methods.
+          addToUpdateList(updatePath, arrayAncestor);
+        }
+        return result;
+      }
+      if (typeof propertyKey === "symbol") {
+        // PROXY_TARGET_SYMBOL unwraps this proxy.
+        if (propertyKey === PROXY_TARGET_SYMBOL) {
+          return target;
+        }
+        // Allow all other symbols to pass through.
+        return property;
+      }
+      if (property instanceof Object) {
+        // Child objects need to be wrapped with another watchForChanges() call.
+        let nextPath: string[];
+        let nextArrayAncestor: any[] | undefined;
+        if (arrayAncestor) {
+          // Array ancestors should continue pointing to the top-level array.
+          nextPath = updatePath;
+          nextArrayAncestor = arrayAncestor;
+        } else {
+          // Otherwise the next proxy should point to this child.  If it's an
+          // array, establish it as a top-level array.
+          nextPath = [...updatePath, propertyKey];
+          if (property instanceof Array) {
+            nextArrayAncestor = property;
+          }
+        }
+        return watchForChanges(
+          nextPath,
+          getPropertySchema(field, fieldSchema, propertyKey),
+          property,
+          addToUpdateList,
+          nextArrayAncestor
+        );
+      }
+      // Otherwise we must be getting a primitive.  No need to wrap it.
+      return property;
+    },
+    set(target, propertyKey, value) {
+      if (typeof propertyKey === "symbol") {
+        // Allow symbols to pass through.
+        return Reflect.set(target, propertyKey, value);
+      }
+      let processedValue = value;
+      // If the new value is an object wrapped in a Firetender proxy, which can
+      // commonly happen when referencing it inside a mutator function passed to
+      // FiretenderDoc.prototype.update(), unwrap it.
+      if (value instanceof Object && value[PROXY_TARGET_SYMBOL]) {
+        processedValue = value[PROXY_TARGET_SYMBOL];
+      }
+      // A property of this object is being set to a new value.  Parse the new
+      // value with the appropriate schema, set it in the local data, and mark
+      // the property (if we aren't inside an array) or the entire top-level
+      // array (if we are) as needing to be written.  If the new value is
+      // undefined, delete the property.
+      const propertySchema = getPropertySchema(field, fieldSchema, propertyKey);
+      processedValue = propertySchema.parse(processedValue);
+      let result: boolean;
+      if (processedValue === undefined) {
+        processedValue = deleteField();
+        result = Reflect.deleteProperty(target, propertyKey);
+      } else {
+        processedValue = pruneUndefinedFields(processedValue);
+        result = Reflect.set(target, propertyKey, processedValue);
+      }
+      if (arrayAncestor) {
+        addToUpdateList(updatePath, arrayAncestor);
+      } else {
+        addToUpdateList([...updatePath, propertyKey], processedValue);
+      }
+      return result;
+    },
+    deleteProperty(target, propertyKey) {
+      if (typeof propertyKey === "symbol") {
+        // Allow symbols to pass through.
+        return Reflect.deleteProperty(target, propertyKey);
+      }
+      let result = true;
+      if ((target as any) instanceof Array) {
+        // Calling Reflect.deleteProperty on an array item sets it to undefined,
+        // which causes Firestore writes to fail if ignoreUndefinedProperties is
+        // not set, and which is generally not what we want.  Hence splice.
+        if (!propertyKey.match(/^\d+$/)) {
+          throw TypeError(
+            `Failed to delete an invalid array index: "${propertyKey}".`
+          );
+        }
+        const index = Number(propertyKey);
+        target.splice(index, 1);
+        // The delete operator pretty much always returns true, so do the same.
+      } else {
+        result = Reflect.deleteProperty(target, propertyKey);
+      }
+      if (arrayAncestor) {
+        // Firestore's arrayRemove() deletes all matching entries, which is not
+        // desired.  So we have to rewrite the full array.
+        addToUpdateList(updatePath, arrayAncestor);
+      } else {
+        addToUpdateList([...updatePath, propertyKey], deleteField());
+      }
+      return result;
+    },
+  });
+}
+
+/**
+ * Given a Zod schema representing a collection, returns the sub-schema of the
+ * specified property.
+ */
+function getPropertySchema(
+  parent: any,
+  parentSchema: z.ZodTypeAny,
+  propertyKey: string
+): z.ZodTypeAny {
+  let schema: any = parentSchema;
+  // eslint-disable-next-line no-constant-condition
+  while (true) {
+    switch (schema._def.typeName) {
+      // If the schema object is wrapped (e.g., by being optional or having a
+      // default), unwrap it until we get to the underlying collection type.
+      case z.ZodFirstPartyTypeKind.ZodOptional:
+      case z.ZodFirstPartyTypeKind.ZodNullable:
+        schema = schema.unwrap();
+        continue;
+      case z.ZodFirstPartyTypeKind.ZodDefault:
+        schema = schema.removeDefault();
+        continue;
+      case z.ZodFirstPartyTypeKind.ZodEffects:
+        schema = schema.innerType();
+        continue;
+      // Return the sub-schemas of supported collection types.
+      case z.ZodFirstPartyTypeKind.ZodRecord:
+        if (
+          schema.keySchema._def.typeName !== z.ZodFirstPartyTypeKind.ZodString
+        ) {
+          throw TypeError(
+            `The ZodRecord for property ${propertyKey} has keys of type ${schema.keySchema._def.typeName}.  Only strings are supported.`
+          );
+        }
+        return schema.valueSchema;
+      case z.ZodFirstPartyTypeKind.ZodArray:
+        return schema.element;
+      case z.ZodFirstPartyTypeKind.ZodObject:
+        return schema.shape[propertyKey];
+      case z.ZodFirstPartyTypeKind.ZodDiscriminatedUnion:
+        return (schema as any).optionsMap.get(
+          parent[(schema as any).discriminator]
+        );
+      // If the parent is of type ZodAny, so are its properties.
+      case z.ZodFirstPartyTypeKind.ZodAny:
+        return z.any();
+      default:
+        throw TypeError(
+          `Unsupported schema type for property "${propertyKey}": ${schema._def.typeName}`
+        );
+    }
+  }
+}
+
+/**
+ * Returns a deep copy of the given object, omitting any undefined fields.
+ *
+ * Note: Timestamps and server timestamps pass through unmodified, but all other
+ * objects will be stripped of their methods.
+ */
+function pruneUndefinedFields<T>(obj: T): T {
+  if (
+    typeof obj !== "object" ||
+    obj === null ||
+    obj instanceof Timestamp ||
+    isServerTimestamp(obj)
+  ) {
+    return obj;
+  }
+  if (obj instanceof Array) {
+    return obj
+      .filter((v) => v !== undefined)
+      .map((v) => pruneUndefinedFields(v)) as T;
+  }
+  return Object.fromEntries(
+    Object.entries(obj as Record<string | number | symbol, unknown>)
+      .filter(([_k, v]) => v !== undefined)
+      .map(([k, v]) => [k, pruneUndefinedFields(v)])
+  ) as T;
+}

package/src/ts-helpers.ts

@@ -31,9 +31,3 @@ export function assertIsDefined<T>(value: T): asserts value is NonNullable<T> {
     throw new TypeError(`${value} is not defined`);
   }
 }
-
-export function assertKeyIsString(key: any): asserts key is string {
-  if (typeof key !== "string") {
-    throw TypeError("Property access using symbols is not supported.");
-  }
-}

package/dist/proxies.d.ts

@@ -1,62 +0,0 @@
-import { z } from "zod";
-/**
- * Wraps a top-level array, its elements, or its elements' subfields in a proxy
- * that watches for changes.
- *
- * Firestore supports limited modification of arrays; see the 2018 blog entry at
- * https://firebase.blog/posts/2018/08/better-arrays-in-cloud-firestore for
- * details and some history.  The tl;dr is that we can't update array entries;
- * we can only append or remove them.
- *
- * For this reason, this proxy only works with top-level arrays: the wrapped
- * array cannot be inside a parent array, though it may be in a record or nested
- * records.  Child proxies maintain a link to the top-level array and trigger a
- * rewrite of the whole thing if there are any changes to the contents.  As a
- * consequence, the watchFieldForChanges proxy (below) can produce child
- * watchArrayForChanges proxies, but all children of watchArrayForChanges will
- * always use the watchArrayForChanges proxy to maintain a reference to the
- * top-level array.
- *
- * Appending an element to the top-level array could in theory be supported, but
- * Firestore's arrayUnion operator only appends entries that don't already
- * exist.  That is not how Javascript arrays work, so to reduce logical overhead
- * we don't bother with it.
- *
- * Deletion of entries in the top-level array are handled using Firestore's
- * arrayRemove operator.  The deleted element gets removed entirely, so the
- * resulting array remains dense.  Note that this behavior differs from how
- * Javascript's delete operator normally works with arrays, but here we favor
- * Firestore's array semantics.
- *
- * @param arrayPath the dot-delimited path of the top-level array.
- * @param array a reference to the top-level array.
- * @param fieldSchema schema of the array element or a field nested within it.
- * @param field reference to the array element or one of its subfields.
- * @param addToUpdateList callback to register modifications to this array.
- */
-export declare function watchArrayForChanges<ArrayElementType, FieldSchemaType extends z.ZodTypeAny>(arrayPath: string[], array: ArrayElementType[], fieldSchema: FieldSchemaType, field: z.infer<FieldSchemaType>, addToUpdateList: (path: string[], newValue: any) => void): z.infer<FieldSchemaType>;
-/**
- * Wraps an object based on a Zod schema in a proxy that watches for changes.
- *
- * Nested fields are monitored by creating a chain of proxies.  Consider this
- * case:
- *
- *   testDoc.w.record1.record2.someStringValue = "foo";
- *
- * There is a top-level proxy (call it proxy 0) for the ".w" accessor.  Getting
- * ".record1" from it returns a child proxy (1) wrapping that field.  Getting
- * ".record2" from that returns another child proxy (2) wrapping that subfield.
- * Finally, setting ".someStringValue" uses the setter of proxy 2 to set the new
- * value locally and register an update to be sent to Firestore.
- *
- * The proxy returned by watchFieldForChanges is used for fields and subfields
- * when no parent is an array.  If a field or subfield is an array, the proxy
- * returned by watchArrayForChanges is used for it and all of its children,
- * regardless of whether they are arrays.
- *
- * @param fieldPath the dot-delimited path of the object being wrapped.
- * @param fieldSchema schema of the object's field.
- * @param field reference to the field in the local document data.
- * @param addToUpdateList callback to register modifications to this field.
- */
-export declare function watchFieldForChanges<FieldSchemaType extends z.ZodTypeAny>(fieldPath: string[], fieldSchema: FieldSchemaType, field: z.infer<FieldSchemaType>, addToUpdateList: (path: string[], newValue: any) => void): z.infer<FieldSchemaType>;

package/dist/proxies.js

@@ -1,258 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.watchFieldForChanges = exports.watchArrayForChanges = void 0;
-const zod_1 = require("zod");
-const firestore_deps_1 = require("./firestore-deps");
-const ts_helpers_1 = require("./ts-helpers");
-/**
- * Given a Zod schema representing a collection, returns the sub-schema of the
- * specified property.
- */
-function getPropertySchema(parent, parentSchema, propertyKey) {
-    let schema = parentSchema;
-    // eslint-disable-next-line no-constant-condition
-    while (true) {
-        switch (schema._def.typeName) {
-            // If the schema object is wrapped (e.g., by being optional or having a
-            // default), unwrap it until we get to the underlying collection type.
-            case zod_1.z.ZodFirstPartyTypeKind.ZodOptional:
-            case zod_1.z.ZodFirstPartyTypeKind.ZodNullable:
-                schema = schema.unwrap();
-                continue;
-            case zod_1.z.ZodFirstPartyTypeKind.ZodDefault:
-                schema = schema.removeDefault();
-                continue;
-            case zod_1.z.ZodFirstPartyTypeKind.ZodEffects:
-                schema = schema.innerType();
-                continue;
-            // Return the sub-schemas of supported collection types.
-            case zod_1.z.ZodFirstPartyTypeKind.ZodRecord:
-                if (schema.keySchema._def.typeName !== zod_1.z.ZodFirstPartyTypeKind.ZodString) {
-                    throw TypeError(`The ZodRecord for property ${propertyKey} has keys of type ${schema.keySchema._def.typeName}.  Only strings are supported.`);
-                }
-                return schema.valueSchema;
-            case zod_1.z.ZodFirstPartyTypeKind.ZodArray:
-                return schema.element;
-            case zod_1.z.ZodFirstPartyTypeKind.ZodObject:
-                return schema.shape[propertyKey];
-            case zod_1.z.ZodFirstPartyTypeKind.ZodDiscriminatedUnion:
-                return schema.optionsMap.get(parent[schema.discriminator]);
-            // If the parent is of type ZodAny, so are its properties.
-            case zod_1.z.ZodFirstPartyTypeKind.ZodAny:
-                return zod_1.z.any();
-            default:
-                throw TypeError(`Unsupported schema type for property "${propertyKey}": ${schema._def.typeName}`);
-        }
-    }
-}
-/**
- * Getting this symbol from one of our proxies returns the proxy's target.
- */
-const PROXY_TARGET_SYMBOL = Symbol("proxy_target");
-/**
- * Wraps a top-level array, its elements, or its elements' subfields in a proxy
- * that watches for changes.
- *
- * Firestore supports limited modification of arrays; see the 2018 blog entry at
- * https://firebase.blog/posts/2018/08/better-arrays-in-cloud-firestore for
- * details and some history.  The tl;dr is that we can't update array entries;
- * we can only append or remove them.
- *
- * For this reason, this proxy only works with top-level arrays: the wrapped
- * array cannot be inside a parent array, though it may be in a record or nested
- * records.  Child proxies maintain a link to the top-level array and trigger a
- * rewrite of the whole thing if there are any changes to the contents.  As a
- * consequence, the watchFieldForChanges proxy (below) can produce child
- * watchArrayForChanges proxies, but all children of watchArrayForChanges will
- * always use the watchArrayForChanges proxy to maintain a reference to the
- * top-level array.
- *
- * Appending an element to the top-level array could in theory be supported, but
- * Firestore's arrayUnion operator only appends entries that don't already
- * exist.  That is not how Javascript arrays work, so to reduce logical overhead
- * we don't bother with it.
- *
- * Deletion of entries in the top-level array are handled using Firestore's
- * arrayRemove operator.  The deleted element gets removed entirely, so the
- * resulting array remains dense.  Note that this behavior differs from how
- * Javascript's delete operator normally works with arrays, but here we favor
- * Firestore's array semantics.
- *
- * @param arrayPath the dot-delimited path of the top-level array.
- * @param array a reference to the top-level array.
- * @param fieldSchema schema of the array element or a field nested within it.
- * @param field reference to the array element or one of its subfields.
- * @param addToUpdateList callback to register modifications to this array.
- */
-function watchArrayForChanges(arrayPath, array, fieldSchema, field, addToUpdateList) {
-    return new Proxy(field, {
-        get(target, propertyKey) {
-            const property = target[propertyKey];
-            if (property instanceof Function) {
-                // All methods of an array or its children are presumed to make
-                // modifications, thus triggering an update of the full array.
-                // TODO: #11 Only mark the change for mutating function calls.
-                const result = (...args) => property.apply(field, args);
-                addToUpdateList(arrayPath, array);
-                return result;
-            }
-            if (typeof propertyKey === "symbol") {
-                if (propertyKey === PROXY_TARGET_SYMBOL) {
-                    return target;
-                }
-                // Allow all other symbols to pass through.
-                return property;
-            }
-            if (property instanceof Object) {
-                // Wrap nested objects, including nested arrays, in child proxies.
-                return watchArrayForChanges(arrayPath, array, getPropertySchema(field, fieldSchema, propertyKey), property, addToUpdateList);
-            }
-            // Otherwise we must be getting a primitive.  No need to wrap it.
-            return property;
-        },
-        set(target, propertyKey, value) {
-            if (typeof propertyKey === "symbol") {
-                // Allow symbols to pass through.
-                return Reflect.set(target, propertyKey, value);
-            }
-            let processedValue = value;
-            // If the new value is an object wrapped in a Firetender proxy, which can
-            // commonly happen when referencing it inside a mutator function passed to
-            // FiretenderDoc.prototype.update(), unwrap it.
-            if (value instanceof Object) {
-                const valueTarget = value[PROXY_TARGET_SYMBOL];
-                if (valueTarget !== undefined) {
-                    processedValue = valueTarget;
-                }
-            }
-            // An array element or one of its subfields is being set to a new value.
-            // Parse the new value with the appropriate schema, set it in the local
-            // data, and mark the entire top-level array as needing to be written.
-            const propertySchema = getPropertySchema(field, fieldSchema, propertyKey);
-            processedValue = propertySchema.parse(processedValue);
-            let result = true;
-            if (processedValue === undefined) {
-                result = Reflect.deleteProperty(target, propertyKey);
-            }
-            else {
-                result = Reflect.set(target, propertyKey, processedValue);
-            }
-            addToUpdateList(arrayPath, array);
-            return result;
-        },
-        deleteProperty(target, propertyKey) {
-            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
-            let result = true;
-            if (target instanceof Array) {
-                // Calling Reflect.deleteProperty on an array item sets it to undefined,
-                // which causes Firestore writes to fail if ignoreUndefinedProperties is
-                // not set, and which is generally not what we want.  Hence splice.
-                const index = Number(propertyKey);
-                if (target.splice(index, 1).length !== 1) {
-                    throw RangeError(`Failed to delete array item with index ${propertyKey}.  Out of bounds?`);
-                }
-            }
-            else {
-                result = Reflect.deleteProperty(target, propertyKey);
-            }
-            // Firestore's arrayRemove() deletes all matching entries, which is not
-            // desired.  So we have to rewrite the full array.
-            addToUpdateList(arrayPath, array);
-            return result;
-        },
-    });
-}
-exports.watchArrayForChanges = watchArrayForChanges;
-/**
- * Wraps an object based on a Zod schema in a proxy that watches for changes.
- *
- * Nested fields are monitored by creating a chain of proxies.  Consider this
- * case:
- *
- *   testDoc.w.record1.record2.someStringValue = "foo";
- *
- * There is a top-level proxy (call it proxy 0) for the ".w" accessor.  Getting
- * ".record1" from it returns a child proxy (1) wrapping that field.  Getting
- * ".record2" from that returns another child proxy (2) wrapping that subfield.
- * Finally, setting ".someStringValue" uses the setter of proxy 2 to set the new
- * value locally and register an update to be sent to Firestore.
- *
- * The proxy returned by watchFieldForChanges is used for fields and subfields
- * when no parent is an array.  If a field or subfield is an array, the proxy
- * returned by watchArrayForChanges is used for it and all of its children,
- * regardless of whether they are arrays.
- *
- * @param fieldPath the dot-delimited path of the object being wrapped.
- * @param fieldSchema schema of the object's field.
- * @param field reference to the field in the local document data.
- * @param addToUpdateList callback to register modifications to this field.
- */
-function watchFieldForChanges(fieldPath, fieldSchema, field, addToUpdateList) {
-    return new Proxy(field, {
-        get(target, propertyKey) {
-            const property = target[propertyKey];
-            if (property instanceof Function) {
-                // Provide methods with a "this" reference for the underlying field.
-                return (...args) => property.apply(field, args);
-            }
-            if (typeof propertyKey === "symbol") {
-                if (propertyKey === PROXY_TARGET_SYMBOL) {
-                    return target;
-                }
-                // Allow all other symbols to pass through.
-                return property;
-            }
-            if (property instanceof Array) {
-                // Wrap array subfields in the watchArrayForChanges proxy.  It is
-                // necessarily a top-level array, because otherwise we would be in
-                // watchArrayForChanges already.
-                return watchArrayForChanges([...fieldPath, propertyKey], property, getPropertySchema(field, fieldSchema, propertyKey), property, addToUpdateList);
-            }
-            if (property instanceof Object) {
-                // Wrap nested objects in another instance of this proxy.
-                return watchFieldForChanges([...fieldPath, propertyKey], getPropertySchema(field, fieldSchema, propertyKey), property, addToUpdateList);
-            }
-            // Otherwise we must be getting a primitive.  No need to wrap it.
-            return property;
-        },
-        set(target, propertyKey, value) {
-            if (typeof propertyKey === "symbol") {
-                // Allow symbols to pass through.
-                return Reflect.set(target, propertyKey, value);
-            }
-            let processedValue = value;
-            // If the new value is an object wrapped in a Firetender proxy, which can
-            // commonly happen when referencing it inside a mutator function passed to
-            // FiretenderDoc.prototype.update(), unwrap it.
-            if (value instanceof Object) {
-                const valueTarget = value[PROXY_TARGET_SYMBOL];
-                if (valueTarget !== undefined) {
-                    processedValue = valueTarget;
-                }
-            }
-            // A property of this object is being set to a new value.  Parse the new
-            // value with the appropriate schema, set it in the local data, and mark
-            // the entire top-level array as needing to be written.  If the new value
-            // is undefined, delete the property.
-            const propertySchema = getPropertySchema(field, fieldSchema, propertyKey);
-            processedValue = propertySchema.parse(processedValue);
-            if (processedValue === undefined) {
-                addToUpdateList([...fieldPath, propertyKey], (0, firestore_deps_1.deleteField)());
-                return Reflect.deleteProperty(target, propertyKey);
-            }
-            else {
-                addToUpdateList([...fieldPath, propertyKey], processedValue);
-                return Reflect.set(target, propertyKey, processedValue);
-            }
-        },
-        deleteProperty(target, propertyKey) {
-            (0, ts_helpers_1.assertKeyIsString)(propertyKey);
-            // Delete the field in Firestore by marking it with the deleteField
-            // operator.
-            addToUpdateList([...fieldPath, propertyKey], (0, firestore_deps_1.deleteField)());
-            return Reflect.deleteProperty(target, propertyKey);
-        },
-    });
-}
-exports.watchFieldForChanges = watchFieldForChanges;
-//# sourceMappingURL=proxies.js.map

package/dist/proxies.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"proxies.js","sourceRoot":"","sources":["../src/proxies.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAExB,qDAA+C;AAC/C,6CAAiD;AAEjD;;;GAGG;AACH,SAAS,iBAAiB,CACxB,MAAW,EACX,YAA0B,EAC1B,WAAmB;IAEnB,IAAI,MAAM,GAAQ,YAAY,CAAC;IAC/B,iDAAiD;IACjD,OAAO,IAAI,EAAE;QACX,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE;YAC5B,uEAAuE;YACvE,sEAAsE;YACtE,KAAK,OAAC,CAAC,qBAAqB,CAAC,WAAW,CAAC;YACzC,KAAK,OAAC,CAAC,qBAAqB,CAAC,WAAW;gBACtC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;gBACzB,SAAS;YACX,KAAK,OAAC,CAAC,qBAAqB,CAAC,UAAU;gBACrC,MAAM,GAAG,MAAM,CAAC,aAAa,EAAE,CAAC;gBAChC,SAAS;YACX,KAAK,OAAC,CAAC,qBAAqB,CAAC,UAAU;gBACrC,MAAM,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;gBAC5B,SAAS;YACX,wDAAwD;YACxD,KAAK,OAAC,CAAC,qBAAqB,CAAC,SAAS;gBACpC,IACE,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,KAAK,OAAC,CAAC,qBAAqB,CAAC,SAAS,EACpE;oBACA,MAAM,SAAS,CACb,8BAA8B,WAAW,qBAAqB,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,gCAAgC,CAC7H,CAAC;iBACH;gBACD,OAAO,MAAM,CAAC,WAAW,CAAC;YAC5B,KAAK,OAAC,CAAC,qBAAqB,CAAC,QAAQ;gBACnC,OAAO,MAAM,CAAC,OAAO,CAAC;YACxB,KAAK,OAAC,CAAC,qBAAqB,CAAC,SAAS;gBACpC,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACnC,KAAK,OAAC,CAAC,qBAAqB,CAAC,qBAAqB;gBAChD,OAAQ,MAAc,CAAC,UAAU,CAAC,GAAG,CACnC,MAAM,CAAE,MAAc,CAAC,aAAa,CAAC,CACtC,CAAC;YACJ,0DAA0D;YAC1D,KAAK,OAAC,CAAC,qBAAqB,CAAC,MAAM;gBACjC,OAAO,OAAC,CAAC,GAAG,EAAE,CAAC;YACjB;gBACE,MAAM,SAAS,CACb,yCAAyC,WAAW,MAAM,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CACjF,CAAC;SACL;KACF;AACH,CAAC;AAED;;GAEG;AACH,MAAM,mBAAmB,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;AAEnD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,SAAgB,oBAAoB,CAIlC,SAAmB,EACnB,KAAyB,EACzB,WAA4B,EAC5B,KAA+B,EAC/B,eAAwD;IAExD,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;QACtB,GAAG,CAAC,MAAM,EAAE,WAAW;YACrB,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,QAAQ,YAAY,QAAQ,EAAE;gBAChC,+DAA+D;gBAC/D,8DAA8D;gBAC9D,8DAA8D;gBAC9D,MAAM,MAAM,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBAC/D,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;gBAClC,OAAO,MAAM,CAAC;aACf;YACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACnC,IAAI,WAAW,KAAK,mBAAmB,EAAE;oBACvC,OAAO,MAAM,CAAC;iBACf;gBACD,2CAA2C;gBAC3C,OAAO,QAAQ,CAAC;aACjB;YACD,IAAI,QAAQ,YAAY,MAAM,EAAE;gBAC9B,kEAAkE;gBAClE,OAAO,oBAAoB,CACzB,SAAS,EACT,KAAK,EACL,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,EAClD,QAAQ,EACR,eAAe,CAChB,CAAC;aACH;YACD,iEAAiE;YACjE,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK;YAC5B,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACnC,iCAAiC;gBACjC,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;aAChD;YACD,IAAI,cAAc,GAAG,KAAK,CAAC;YAC3B,yEAAyE;YACzE,0EAA0E;YAC1E,+CAA+C;YAC/C,IAAI,KAAK,YAAY,MAAM,EAAE;gBAC3B,MAAM,WAAW,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBAC/C,IAAI,WAAW,KAAK,SAAS,EAAE;oBAC7B,cAAc,GAAG,WAAW,CAAC;iBAC9B;aACF;YACD,wEAAwE;YACxE,uEAAuE;YACvE,sEAAsE;YACtE,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YAC1E,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACtD,IAAI,MAAM,GAAG,IAAI,CAAC;YAClB,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;aACtD;iBAAM;gBACL,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;aAC3D;YACD,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAClC,OAAO,MAAM,CAAC;QAChB,CAAC;QACD,cAAc,CAAC,MAAM,EAAE,WAAW;YAChC,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,IAAI,MAAM,GAAG,IAAI,CAAC;YAClB,IAAK,MAAc,YAAY,KAAK,EAAE;gBACpC,wEAAwE;gBACxE,wEAAwE;gBACxE,mEAAmE;gBACnE,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;gBAClC,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;oBACxC,MAAM,UAAU,CACd,0CAA0C,WAAW,mBAAmB,CACzE,CAAC;iBACH;aACF;iBAAM;gBACL,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;aACtD;YACD,uEAAuE;YACvE,kDAAkD;YAClD,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;YAClC,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AA5FD,oDA4FC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,oBAAoB,CAClC,SAAmB,EACnB,WAA4B,EAC5B,KAA+B,EAC/B,eAAwD;IAExD,OAAO,IAAI,KAAK,CAAC,KAAK,EAAE;QACtB,GAAG,CAAC,MAAM,EAAE,WAAW;YACrB,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YACrC,IAAI,QAAQ,YAAY,QAAQ,EAAE;gBAChC,oEAAoE;gBACpE,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;aACxD;YACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACnC,IAAI,WAAW,KAAK,mBAAmB,EAAE;oBACvC,OAAO,MAAM,CAAC;iBACf;gBACD,2CAA2C;gBAC3C,OAAO,QAAQ,CAAC;aACjB;YACD,IAAI,QAAQ,YAAY,KAAK,EAAE;gBAC7B,iEAAiE;gBACjE,kEAAkE;gBAClE,gCAAgC;gBAChC,OAAO,oBAAoB,CACzB,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAC3B,QAAQ,EACR,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,EAClD,QAAQ,EACR,eAAe,CAChB,CAAC;aACH;YACD,IAAI,QAAQ,YAAY,MAAM,EAAE;gBAC9B,yDAAyD;gBACzD,OAAO,oBAAoB,CACzB,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAC3B,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,EAClD,QAAQ,EACR,eAAe,CAChB,CAAC;aACH;YACD,iEAAiE;YACjE,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK;YAC5B,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;gBACnC,iCAAiC;gBACjC,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,KAAK,CAAC,CAAC;aAChD;YACD,IAAI,cAAc,GAAG,KAAK,CAAC;YAC3B,yEAAyE;YACzE,0EAA0E;YAC1E,+CAA+C;YAC/C,IAAI,KAAK,YAAY,MAAM,EAAE;gBAC3B,MAAM,WAAW,GAAG,KAAK,CAAC,mBAAmB,CAAC,CAAC;gBAC/C,IAAI,WAAW,KAAK,SAAS,EAAE;oBAC7B,cAAc,GAAG,WAAW,CAAC;iBAC9B;aACF;YACD,wEAAwE;YACxE,wEAAwE;YACxE,yEAAyE;YACzE,qCAAqC;YACrC,MAAM,cAAc,GAAG,iBAAiB,CAAC,KAAK,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC;YAC1E,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACtD,IAAI,cAAc,KAAK,SAAS,EAAE;gBAChC,eAAe,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,IAAA,4BAAW,GAAE,CAAC,CAAC;gBAC5D,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;aACpD;iBAAM;gBACL,eAAe,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,cAAc,CAAC,CAAC;gBAC7D,OAAO,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,CAAC,CAAC;aACzD;QACH,CAAC;QACD,cAAc,CAAC,MAAM,EAAE,WAAW;YAChC,IAAA,8BAAiB,EAAC,WAAW,CAAC,CAAC;YAC/B,mEAAmE;YACnE,YAAY;YACZ,eAAe,CAAC,CAAC,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,IAAA,4BAAW,GAAE,CAAC,CAAC;YAC5D,OAAO,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACrD,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAjFD,oDAiFC"}

package/src/proxies.ts

@@ -1,299 +0,0 @@
-import { z } from "zod";
-
-import { deleteField } from "./firestore-deps";
-import { assertKeyIsString } from "./ts-helpers";
-
-/**
- * Given a Zod schema representing a collection, returns the sub-schema of the
- * specified property.
- */
-function getPropertySchema(
-  parent: any,
-  parentSchema: z.ZodTypeAny,
-  propertyKey: string
-): z.ZodTypeAny {
-  let schema: any = parentSchema;
-  // eslint-disable-next-line no-constant-condition
-  while (true) {
-    switch (schema._def.typeName) {
-      // If the schema object is wrapped (e.g., by being optional or having a
-      // default), unwrap it until we get to the underlying collection type.
-      case z.ZodFirstPartyTypeKind.ZodOptional:
-      case z.ZodFirstPartyTypeKind.ZodNullable:
-        schema = schema.unwrap();
-        continue;
-      case z.ZodFirstPartyTypeKind.ZodDefault:
-        schema = schema.removeDefault();
-        continue;
-      case z.ZodFirstPartyTypeKind.ZodEffects:
-        schema = schema.innerType();
-        continue;
-      // Return the sub-schemas of supported collection types.
-      case z.ZodFirstPartyTypeKind.ZodRecord:
-        if (
-          schema.keySchema._def.typeName !== z.ZodFirstPartyTypeKind.ZodString
-        ) {
-          throw TypeError(
-            `The ZodRecord for property ${propertyKey} has keys of type ${schema.keySchema._def.typeName}.  Only strings are supported.`
-          );
-        }
-        return schema.valueSchema;
-      case z.ZodFirstPartyTypeKind.ZodArray:
-        return schema.element;
-      case z.ZodFirstPartyTypeKind.ZodObject:
-        return schema.shape[propertyKey];
-      case z.ZodFirstPartyTypeKind.ZodDiscriminatedUnion:
-        return (schema as any).optionsMap.get(
-          parent[(schema as any).discriminator]
-        );
-      // If the parent is of type ZodAny, so are its properties.
-      case z.ZodFirstPartyTypeKind.ZodAny:
-        return z.any();
-      default:
-        throw TypeError(
-          `Unsupported schema type for property "${propertyKey}": ${schema._def.typeName}`
-        );
-    }
-  }
-}
-
-/**
- * Getting this symbol from one of our proxies returns the proxy's target.
- */
-const PROXY_TARGET_SYMBOL = Symbol("proxy_target");
-
-/**
- * Wraps a top-level array, its elements, or its elements' subfields in a proxy
- * that watches for changes.
- *
- * Firestore supports limited modification of arrays; see the 2018 blog entry at
- * https://firebase.blog/posts/2018/08/better-arrays-in-cloud-firestore for
- * details and some history.  The tl;dr is that we can't update array entries;
- * we can only append or remove them.
- *
- * For this reason, this proxy only works with top-level arrays: the wrapped
- * array cannot be inside a parent array, though it may be in a record or nested
- * records.  Child proxies maintain a link to the top-level array and trigger a
- * rewrite of the whole thing if there are any changes to the contents.  As a
- * consequence, the watchFieldForChanges proxy (below) can produce child
- * watchArrayForChanges proxies, but all children of watchArrayForChanges will
- * always use the watchArrayForChanges proxy to maintain a reference to the
- * top-level array.
- *
- * Appending an element to the top-level array could in theory be supported, but
- * Firestore's arrayUnion operator only appends entries that don't already
- * exist.  That is not how Javascript arrays work, so to reduce logical overhead
- * we don't bother with it.
- *
- * Deletion of entries in the top-level array are handled using Firestore's
- * arrayRemove operator.  The deleted element gets removed entirely, so the
- * resulting array remains dense.  Note that this behavior differs from how
- * Javascript's delete operator normally works with arrays, but here we favor
- * Firestore's array semantics.
- *
- * @param arrayPath the dot-delimited path of the top-level array.
- * @param array a reference to the top-level array.
- * @param fieldSchema schema of the array element or a field nested within it.
- * @param field reference to the array element or one of its subfields.
- * @param addToUpdateList callback to register modifications to this array.
- */
-export function watchArrayForChanges<
-  ArrayElementType,
-  FieldSchemaType extends z.ZodTypeAny
->(
-  arrayPath: string[],
-  array: ArrayElementType[],
-  fieldSchema: FieldSchemaType,
-  field: z.infer<FieldSchemaType>,
-  addToUpdateList: (path: string[], newValue: any) => void
-): z.infer<FieldSchemaType> {
-  return new Proxy(field, {
-    get(target, propertyKey) {
-      const property = target[propertyKey];
-      if (property instanceof Function) {
-        // All methods of an array or its children are presumed to make
-        // modifications, thus triggering an update of the full array.
-        // TODO: #11 Only mark the change for mutating function calls.
-        const result = (...args: any[]) => property.apply(field, args);
-        addToUpdateList(arrayPath, array);
-        return result;
-      }
-      if (typeof propertyKey === "symbol") {
-        if (propertyKey === PROXY_TARGET_SYMBOL) {
-          return target;
-        }
-        // Allow all other symbols to pass through.
-        return property;
-      }
-      if (property instanceof Object) {
-        // Wrap nested objects, including nested arrays, in child proxies.
-        return watchArrayForChanges(
-          arrayPath,
-          array,
-          getPropertySchema(field, fieldSchema, propertyKey),
-          property,
-          addToUpdateList
-        );
-      }
-      // Otherwise we must be getting a primitive.  No need to wrap it.
-      return property;
-    },
-    set(target, propertyKey, value) {
-      if (typeof propertyKey === "symbol") {
-        // Allow symbols to pass through.
-        return Reflect.set(target, propertyKey, value);
-      }
-      let processedValue = value;
-      // If the new value is an object wrapped in a Firetender proxy, which can
-      // commonly happen when referencing it inside a mutator function passed to
-      // FiretenderDoc.prototype.update(), unwrap it.
-      if (value instanceof Object) {
-        const valueTarget = value[PROXY_TARGET_SYMBOL];
-        if (valueTarget !== undefined) {
-          processedValue = valueTarget;
-        }
-      }
-      // An array element or one of its subfields is being set to a new value.
-      // Parse the new value with the appropriate schema, set it in the local
-      // data, and mark the entire top-level array as needing to be written.
-      const propertySchema = getPropertySchema(field, fieldSchema, propertyKey);
-      processedValue = propertySchema.parse(processedValue);
-      let result = true;
-      if (processedValue === undefined) {
-        result = Reflect.deleteProperty(target, propertyKey);
-      } else {
-        result = Reflect.set(target, propertyKey, processedValue);
-      }
-      addToUpdateList(arrayPath, array);
-      return result;
-    },
-    deleteProperty(target, propertyKey) {
-      assertKeyIsString(propertyKey);
-      let result = true;
-      if ((target as any) instanceof Array) {
-        // Calling Reflect.deleteProperty on an array item sets it to undefined,
-        // which causes Firestore writes to fail if ignoreUndefinedProperties is
-        // not set, and which is generally not what we want.  Hence splice.
-        const index = Number(propertyKey);
-        if (target.splice(index, 1).length !== 1) {
-          throw RangeError(
-            `Failed to delete array item with index ${propertyKey}.  Out of bounds?`
-          );
-        }
-      } else {
-        result = Reflect.deleteProperty(target, propertyKey);
-      }
-      // Firestore's arrayRemove() deletes all matching entries, which is not
-      // desired.  So we have to rewrite the full array.
-      addToUpdateList(arrayPath, array);
-      return result;
-    },
-  });
-}
-
-/**
- * Wraps an object based on a Zod schema in a proxy that watches for changes.
- *
- * Nested fields are monitored by creating a chain of proxies.  Consider this
- * case:
- *
- *   testDoc.w.record1.record2.someStringValue = "foo";
- *
- * There is a top-level proxy (call it proxy 0) for the ".w" accessor.  Getting
- * ".record1" from it returns a child proxy (1) wrapping that field.  Getting
- * ".record2" from that returns another child proxy (2) wrapping that subfield.
- * Finally, setting ".someStringValue" uses the setter of proxy 2 to set the new
- * value locally and register an update to be sent to Firestore.
- *
- * The proxy returned by watchFieldForChanges is used for fields and subfields
- * when no parent is an array.  If a field or subfield is an array, the proxy
- * returned by watchArrayForChanges is used for it and all of its children,
- * regardless of whether they are arrays.
- *
- * @param fieldPath the dot-delimited path of the object being wrapped.
- * @param fieldSchema schema of the object's field.
- * @param field reference to the field in the local document data.
- * @param addToUpdateList callback to register modifications to this field.
- */
-export function watchFieldForChanges<FieldSchemaType extends z.ZodTypeAny>(
-  fieldPath: string[],
-  fieldSchema: FieldSchemaType,
-  field: z.infer<FieldSchemaType>,
-  addToUpdateList: (path: string[], newValue: any) => void
-): z.infer<FieldSchemaType> {
-  return new Proxy(field, {
-    get(target, propertyKey) {
-      const property = target[propertyKey];
-      if (property instanceof Function) {
-        // Provide methods with a "this" reference for the underlying field.
-        return (...args: any[]) => property.apply(field, args);
-      }
-      if (typeof propertyKey === "symbol") {
-        if (propertyKey === PROXY_TARGET_SYMBOL) {
-          return target;
-        }
-        // Allow all other symbols to pass through.
-        return property;
-      }
-      if (property instanceof Array) {
-        // Wrap array subfields in the watchArrayForChanges proxy.  It is
-        // necessarily a top-level array, because otherwise we would be in
-        // watchArrayForChanges already.
-        return watchArrayForChanges(
-          [...fieldPath, propertyKey],
-          property,
-          getPropertySchema(field, fieldSchema, propertyKey),
-          property,
-          addToUpdateList
-        );
-      }
-      if (property instanceof Object) {
-        // Wrap nested objects in another instance of this proxy.
-        return watchFieldForChanges(
-          [...fieldPath, propertyKey],
-          getPropertySchema(field, fieldSchema, propertyKey),
-          property,
-          addToUpdateList
-        );
-      }
-      // Otherwise we must be getting a primitive.  No need to wrap it.
-      return property;
-    },
-    set(target, propertyKey, value) {
-      if (typeof propertyKey === "symbol") {
-        // Allow symbols to pass through.
-        return Reflect.set(target, propertyKey, value);
-      }
-      let processedValue = value;
-      // If the new value is an object wrapped in a Firetender proxy, which can
-      // commonly happen when referencing it inside a mutator function passed to
-      // FiretenderDoc.prototype.update(), unwrap it.
-      if (value instanceof Object) {
-        const valueTarget = value[PROXY_TARGET_SYMBOL];
-        if (valueTarget !== undefined) {
-          processedValue = valueTarget;
-        }
-      }
-      // A property of this object is being set to a new value.  Parse the new
-      // value with the appropriate schema, set it in the local data, and mark
-      // the entire top-level array as needing to be written.  If the new value
-      // is undefined, delete the property.
-      const propertySchema = getPropertySchema(field, fieldSchema, propertyKey);
-      processedValue = propertySchema.parse(processedValue);
-      if (processedValue === undefined) {
-        addToUpdateList([...fieldPath, propertyKey], deleteField());
-        return Reflect.deleteProperty(target, propertyKey);
-      } else {
-        addToUpdateList([...fieldPath, propertyKey], processedValue);
-        return Reflect.set(target, propertyKey, processedValue);
-      }
-    },
-    deleteProperty(target, propertyKey) {
-      assertKeyIsString(propertyKey);
-      // Delete the field in Firestore by marking it with the deleteField
-      // operator.
-      addToUpdateList([...fieldPath, propertyKey], deleteField());
-      return Reflect.deleteProperty(target, propertyKey);
-    },
-  });
-}