@verdant-web/store 3.8.0 → 3.8.1

package/dist/esm/sync/PushPullSync.js

@@ -1,4 +1,4 @@
-import { EventSubscriber, VerdantErrorCode, isVerdantErrorResponse, } from '@verdant-web/common';
+import { EventSubscriber, VerdantErrorCode, isVerdantErrorResponse, throttle, } from '@verdant-web/common';
 import { Heartbeat } from './Heartbeat.js';
 export class PushPullSync extends EventSubscriber {
     constructor({ endpointProvider, meta, presence, interval = 15 * 1000, log = () => { }, fetch = window.fetch.bind(window), }) {
@@ -81,10 +81,16 @@ export class PushPullSync extends EventSubscriber {
             }
             this.emit('message', message);
         };
+        // reduce rate of presence messages sent; each one would trigger an HTTP
+        // request, which is not ideal if presence is updating rapidly.
+        this.throttledPresenceUpdate = throttle((message) => {
+            this.sendRequest([message]);
+        }, 3000);
         this.send = (message) => {
             // only certain messages are sent for pull-based sync.
             switch (message.type) {
                 case 'presence-update':
+                    return this.throttledPresenceUpdate(message);
                 case 'sync':
                 case 'heartbeat':
                     return this.sendRequest([message]);

package/dist/esm/sync/PushPullSync.js.map

@@ -1 +1 @@
-{"version":3,"file":"PushPullSync.js","sourceRoot":"","sources":["../../../src/sync/PushPullSync.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,eAAe,EAEf,gBAAgB,EAChB,sBAAsB,GACtB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAI3C,MAAM,OAAO,YACZ,SAAQ,eAAoC;IAgB5C,YAAY,EACX,gBAAgB,EAChB,IAAI,EACJ,QAAQ,EACR,QAAQ,GAAG,EAAE,GAAG,IAAI,EACpB,GAAG,GAAG,GAAG,EAAE,GAAE,CAAC,EACd,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAQjC;QACA,KAAK,EAAE,CAAC;QAtBA,SAAI,GAAG,MAAM,CAAC;QAGf,iBAAY,GAAG,KAAK,CAAC;QACrB,YAAO,GAAwB,QAAQ,CAAC;QACxC,eAAU,GAAG,KAAK,CAAC;QA+B3B,gBAAW,GAAG,CAAC,QAAgB,EAAE,EAAE;YAClC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC,CAAC;QAMM,gBAAW,GAAG,KAAK,EAAE,QAAyB,EAAE,EAAE;YACzD,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;YAC3C,IAAI,CAAC;gBACJ,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;gBACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;oBACvC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACR,cAAc,EAAE,kBAAkB;wBAClC,aAAa,EAAE,UAAU,KAAK,EAAE;qBAChC;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,QAAQ;qBACR,CAAC;oBACF,WAAW,EAAE,SAAS;iBACtB,CAAC,CAAC;gBACH,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;oBAC3B,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAElC,CAAC;oBACF,yCAAyC;oBACzC,sCAAsC;oBACtC,IAAI;oBACJ,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAC3C,CAAC;oBACF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;wBACxB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;wBACzB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;oBACjC,CAAC;oBACD,MAAM,aAAa,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACP,IAAI,CAAC,GAAG,CAAC,qBAAqB,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;oBAExE,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;wBACvB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;wBAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;oBAClC,CAAC;oBAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACnC,IAAI,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClC,uDAAuD;wBACvD,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,YAAY,EAAE,CAAC;4BACjD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;4BACnC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;wBAC5B,CAAC;oBACF,CAAC;oBAED,4CAA4C;oBAC5C,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;wBAC5B,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;oBAC5B,CAAC;gBACF,CAAC;YACF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBACvB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;oBAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;gBAClC,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAEhB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YAC5B,CAAC;QACF,CAAC,CAAC;QAEM,wBAAmB,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;YAC9D,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAClC,qEAAqE;gBACrE,4DAA4D;gBAC5D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACvB,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC1B,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;oBACnD,MAAM,IAAI,CAAC,WAAW,CAAC;wBACtB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC;qBAC9D,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,SAAI,GAAG,CAAC,OAAsB,EAAE,EAAE;YACjC,sDAAsD;YACtD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;gBACtB,KAAK,iBAAiB,CAAC;gBACvB,KAAK,MAAM,CAAC;gBACZ,KAAK,WAAW;oBACf,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpC,KAAK,IAAI;oBACR,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;wBACrB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;oBACpC,CAAC;oBACD,MAAM;YACR,CAAC;QACF,CAAC,CAAC;QAcF,YAAO,GAAG,GAAG,EAAE;YACd,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,EAAE,CAAC;QACb,CAAC,CAAC;QASF,4BAA4B;QACpB,gBAAW,GAAG,KAAK,IAAI,EAAE;YAChC,sEAAsE;YACtE,0EAA0E;YAC1E,6EAA6E;YAC7E,IAAI,CAAC,WAAW,CAAC;gBAChB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAClD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAC3B;gBACD,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE;aAChD,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,wEAAwE;QACxE,yCAAyC;QACjC,sBAAiB,GAAG,KAAK,IAAI,EAAE;YACtC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC3B,CAAC,CAAC;QAEF,aAAQ,GAAG,KAAK,IAAI,EAAE;YACrB,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC;QAlKD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC9B,QAAQ;SACR,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC5D,CAAC;IAMD,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IAChC,CAAC;IAgGD,KAAK;QACJ,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO;QACR,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;IACzB,CAAC;IACD,IAAI;QACH,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;IACzB,CAAC;IAMD,SAAS;QACR,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,cAAc;QACb,IAAI,CAAC,IAAI,EAAE,CAAC;IACb,CAAC;IA2BD,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IACD,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;CACD"}
+{"version":3,"file":"PushPullSync.js","sourceRoot":"","sources":["../../../src/sync/PushPullSync.ts"],"names":[],"mappings":"AAAA,OAAO,EAEN,eAAe,EAGf,gBAAgB,EAEhB,sBAAsB,EACtB,QAAQ,GACR,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAI3C,MAAM,OAAO,YACZ,SAAQ,eAAoC;IAgB5C,YAAY,EACX,gBAAgB,EAChB,IAAI,EACJ,QAAQ,EACR,QAAQ,GAAG,EAAE,GAAG,IAAI,EACpB,GAAG,GAAG,GAAG,EAAE,GAAE,CAAC,EACd,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,GAQjC;QACA,KAAK,EAAE,CAAC;QAtBA,SAAI,GAAG,MAAM,CAAC;QAGf,iBAAY,GAAG,KAAK,CAAC;QACrB,YAAO,GAAwB,QAAQ,CAAC;QACxC,eAAU,GAAG,KAAK,CAAC;QA+B3B,gBAAW,GAAG,CAAC,QAAgB,EAAE,EAAE;YAClC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACtC,CAAC,CAAC;QAMM,gBAAW,GAAG,KAAK,EAAE,QAAyB,EAAE,EAAE;YACzD,IAAI,CAAC,GAAG,CAAC,sBAAsB,EAAE,QAAQ,CAAC,CAAC;YAC3C,IAAI,CAAC;gBACJ,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC;gBACzE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;oBACvC,MAAM,EAAE,MAAM;oBACd,OAAO,EAAE;wBACR,cAAc,EAAE,kBAAkB;wBAClC,aAAa,EAAE,UAAU,KAAK,EAAE;qBAChC;oBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,QAAQ;qBACR,CAAC;oBACF,WAAW,EAAE,SAAS;iBACtB,CAAC,CAAC;gBACH,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;oBAC3B,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAElC,CAAC;oBACF,yCAAyC;oBACzC,sCAAsC;oBACtC,IAAI;oBACJ,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAChC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAC3C,CAAC;oBACF,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;wBACxB,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;wBACzB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;oBACjC,CAAC;oBACD,MAAM,aAAa,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACP,IAAI,CAAC,GAAG,CAAC,qBAAqB,EAAE,QAAQ,CAAC,MAAM,EAAE,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;oBAExE,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;wBACvB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;wBAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;oBAClC,CAAC;oBAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;oBACnC,IAAI,sBAAsB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClC,uDAAuD;wBACvD,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAgB,CAAC,YAAY,EAAE,CAAC;4BACjD,IAAI,CAAC,gBAAgB,CAAC,UAAU,EAAE,CAAC;4BACnC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;wBAC5B,CAAC;oBACF,CAAC;oBAED,4CAA4C;oBAC5C,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;wBAC5B,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;oBAC5B,CAAC;gBACF,CAAC;YACF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;oBACvB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;oBAC1B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;gBAClC,CAAC;gBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAEhB,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,CAAC;YAC5B,CAAC;QACF,CAAC,CAAC;QAEM,wBAAmB,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;YAC9D,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;gBAClC,qEAAqE;gBACrE,4DAA4D;gBAC5D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACvB,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;oBAC1B,IAAI,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;oBACnD,MAAM,IAAI,CAAC,WAAW,CAAC;wBACtB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,YAAY,CAAC;qBAC9D,CAAC,CAAC;gBACJ,CAAC;YACF,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC;QAEF,wEAAwE;QACxE,+DAA+D;QAC/D,4BAAuB,GAAG,QAAQ,CAAC,CAAC,OAA8B,EAAE,EAAE;YACrE,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAC7B,CAAC,EAAE,IAAI,CAAC,CAAC;QAET,SAAI,GAAG,CAAC,OAAsB,EAAE,EAAE;YACjC,sDAAsD;YACtD,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;gBACtB,KAAK,iBAAiB;oBACrB,OAAO,IAAI,CAAC,uBAAuB,CAAC,OAAO,CAAC,CAAC;gBAC9C,KAAK,MAAM,CAAC;gBACZ,KAAK,WAAW;oBACf,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;gBACpC,KAAK,IAAI;oBACR,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;wBACrB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;oBACpC,CAAC;oBACD,MAAM;YACR,CAAC;QACF,CAAC,CAAC;QAcF,YAAO,GAAG,GAAG,EAAE;YACd,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,EAAE,CAAC;QACb,CAAC,CAAC;QASF,4BAA4B;QACpB,gBAAW,GAAG,KAAK,IAAI,EAAE;YAChC,sEAAsE;YACtE,0EAA0E;YAC1E,6EAA6E;YAC7E,IAAI,CAAC,WAAW,CAAC;gBAChB,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAClD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAC3B;gBACD,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE;aAChD,CAAC,CAAC;QACJ,CAAC,CAAC;QAEF,wEAAwE;QACxE,yCAAyC;QACjC,sBAAiB,GAAG,KAAK,IAAI,EAAE;YACtC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;YACjC,IAAI,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC7B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAC3B,CAAC,CAAC;QAEF,aAAQ,GAAG,KAAK,IAAI,EAAE;YACrB,MAAM,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;QAC5E,CAAC,CAAC;QAzKD,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QACzC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QAEnB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC9B,QAAQ;SACR,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC5D,CAAC;IAMD,IAAI,QAAQ;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;IAChC,CAAC;IAuGD,KAAK;QACJ,IAAI,IAAI,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC9B,OAAO;QACR,CAAC;QACD,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;IACzB,CAAC;IACD,IAAI;QACH,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC;IACzB,CAAC;IAMD,SAAS;QACR,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAED,cAAc;QACb,IAAI,CAAC,IAAI,EAAE,CAAC;IACb,CAAC;IA2BD,IAAI,WAAW;QACd,OAAO,IAAI,CAAC,YAAY,CAAC;IAC1B,CAAC;IACD,IAAI,MAAM;QACT,OAAO,IAAI,CAAC,OAAO,CAAC;IACrB,CAAC;CACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdant-web/store",
-  "version": "3.8.0",
+  "version": "3.8.1",
   "access": "public",
   "type": "module",
   "exports": {
@@ -27,7 +27,7 @@
     "jwt-decode": "^3.1.2",
     "kysely": "^0.27.3",
     "weak-event": "^2.0.5",
-    "@verdant-web/common": "2.3.3"
+    "@verdant-web/common": "2.3.4"
   },
   "devDependencies": {
     "@types/node": "20.10.5",

package/src/client/Client.ts

@@ -1,27 +1,25 @@
 import {
-	assert,
 	debounce,
 	DocumentBaseline,
 	EventSubscriber,
 	Migration,
 	Operation,
-	SchemaCollection,
 } from '@verdant-web/common';
 import { Context } from '../context.js';
 import { DocumentManager } from '../DocumentManager.js';
+import { EntityStore } from '../entities/EntityStore.js';
 import { FileManager, FileManagerConfig } from '../files/FileManager.js';
+import { ReturnedFileData } from '../files/FileStorage.js';
 import {
 	closeDatabase,
 	deleteAllDatabases,
 	getSizeOfObjectStore,
 } from '../idb.js';
 import { ExportData, Metadata } from '../metadata/Metadata.js';
-import { openDocumentDatabase } from '../migration/openDatabase.js';
-import { EntityStore } from '../entities/EntityStore.js';
-import { NoSync, ServerSync, ServerSyncOptions, Sync } from '../sync/Sync.js';
+import { openQueryDatabase } from '../migration/openQueryDatabase.js';
 import { CollectionQueries } from '../queries/CollectionQueries.js';
 import { QueryCache } from '../queries/QueryCache.js';
-import { ReturnedFileData } from '../files/FileStorage.js';
+import { NoSync, ServerSync, ServerSyncOptions, Sync } from '../sync/Sync.js';
 
 interface ClientConfig<Presence = any> {
 	syncConfig?: ServerSyncOptions<Presence>;
@@ -382,7 +380,7 @@ export class Client<Presence = any, Profile = any> extends EventSubscriber<{
 		}
 		// now open the document DB empty at the specified version
 		// and initialize it from the meta DB
-		this.context.documentDb = await openDocumentDatabase({
+		this.context.documentDb = await openQueryDatabase({
 			meta: this.meta,
 			migrations: this.config.migrations,
 			context: this.context,
@@ -402,7 +400,7 @@ export class Client<Presence = any, Profile = any> extends EventSubscriber<{
 		this.context.log('Migrating up to latest schema...');
 		// put the schema back
 		this.context.schema = currentSchema;
-		this.context.documentDb = await openDocumentDatabase({
+		this.context.documentDb = await openQueryDatabase({
 			meta: this.meta,
 			migrations: this.config.migrations,
 			context: this.context,

package/src/client/ClientDescriptor.ts

@@ -12,10 +12,7 @@ import {
 	openMetadataDatabase,
 	openWIPMetadataDatabase,
 } from '../metadata/openMetadataDatabase.js';
-import {
-	openDocumentDatabase,
-	openWIPDocumentDatabase,
-} from '../migration/openDatabase.js';
+import { openWIPDatabase } from '../migration/openWIPDatabase.js';
 import { ServerSyncOptions } from '../sync/Sync.js';
 import { UndoHistory } from '../UndoHistory.js';
 import { Client } from './Client.js';
@@ -26,10 +23,12 @@ import {
 } from '../idb.js';
 import { FakeWeakRef } from '../FakeWeakRef.js';
 import { METADATA_VERSION_KEY } from './constants.js';
+import { openQueryDatabase } from '../migration/openQueryDatabase.js';
 
 export interface ClientDescriptorOptions<Presence = any, Profile = any> {
 	/** The schema used to create this client */
 	schema: StorageSchema<any>;
+	oldSchemas?: StorageSchema<any>[];
 	/** Migrations, in order, to upgrade to each successive version of the schema */
 	migrations: Migration<any>[];
 	/** Provide a sync config to turn on synchronization with a server */
@@ -177,6 +176,7 @@ export class ClientDescriptor<
 				}
 			},
 			migrations: init.migrations,
+			oldSchemas: init.oldSchemas,
 		};
 		const meta = new Metadata({
 			context,
@@ -191,7 +191,7 @@ export class ClientDescriptor<
 			getNow: () => meta.now,
 		});
 
-		const documentDb = await openDocumentDatabase({
+		const documentDb = await openQueryDatabase({
 			context: contextWithNow,
 			version: init.schema.version,
 			meta,
@@ -245,6 +245,7 @@ export class ClientDescriptor<
 				}
 			},
 			migrations: init.migrations,
+			oldSchemas: init.oldSchemas,
 		};
 		const meta = new Metadata({
 			context,
@@ -258,7 +259,7 @@ export class ClientDescriptor<
 		// verify schema integrity
 		await meta.updateSchema(init.schema, init.overrideSchemaConflict);
 
-		const documentDb = await openWIPDocumentDatabase({
+		const documentDb = await openWIPDatabase({
 			context: contextWithNow,
 			version: init.schema.version,
 			meta,

package/src/context.ts

@@ -17,6 +17,7 @@ export interface Context {
 	documentDb: IDBDatabase;
 	undoHistory: UndoHistory;
 	schema: StorageSchema;
+	oldSchemas?: StorageSchema[];
 	log: (...args: any[]) => void;
 	entityEvents: EventSubscriber<{
 		collectionsChanged: (names: string[]) => void;

package/src/entities/EntityStore.ts

@@ -42,12 +42,12 @@ export type EntityStoreEvents = {
 	resetAll: WeakEvent<EntityStore, void>;
 };
 
-type IncomingData = {
+export interface IncomingData {
 	operations?: Operation[];
 	baselines?: DocumentBaseline[];
 	reset?: boolean;
 	isLocal?: boolean;
-};
+}
 
 export class EntityStore extends Disposable {
 	private ctx;
@@ -137,6 +137,12 @@ export class EntityStore extends Disposable {
 		await this.processData(data);
 	};
 
+	empty = async () => {
+		await this.queryableStorage.reset();
+		this.events.resetAll.invoke(this);
+		this.cache.clear();
+	};
+
 	private resetData = async () => {
 		if (this.disposed) {
 			this.ctx.log('warn', 'EntityStore is disposed, not resetting local data');

package/src/idb.ts

@@ -1,5 +1,8 @@
 import { roughSizeOfObject } from '@verdant-web/common';
 
+export const globalIDB =
+	typeof window !== 'undefined' ? window.indexedDB : (undefined as any);
+
 export function isAbortError(err: unknown) {
 	return err instanceof Error && err.name === 'AbortError';
 }
@@ -109,7 +112,7 @@ export async function closeDatabase(db: IDBDatabase) {
 
 export async function deleteAllDatabases(
 	namespace: string,
-	indexedDB: IDBFactory = window.indexedDB,
+	indexedDB: IDBFactory = globalIDB,
 ) {
 	const req1 = indexedDB.deleteDatabase([namespace, 'meta'].join('_'));
 	const req2 = indexedDB.deleteDatabase([namespace, 'collections'].join('_'));
@@ -163,3 +166,19 @@ export function createAbortableTransaction(
 	}
 	return tx;
 }
+
+/**
+ * Empties all data in a database without changing
+ * its structure.
+ */
+export function emptyDatabase(db: IDBDatabase) {
+	const storeNames = Array.from(db.objectStoreNames);
+	const tx = db.transaction(storeNames, 'readwrite');
+	for (const storeName of storeNames) {
+		tx.objectStore(storeName).clear();
+	}
+	return new Promise<void>((resolve, reject) => {
+		tx.oncomplete = () => resolve();
+		tx.onerror = () => reject(tx.error);
+	});
+}

package/src/migration/db.ts

@@ -1,3 +1,6 @@
+import { closeDatabase, globalIDB, storeRequestPromise } from '../idb.js';
+import { OpenDocumentDbContext } from './types.js';
+
 export async function getDatabaseVersion(
 	indexedDB: IDBFactory,
 	namespace: string,
@@ -42,12 +45,6 @@ export async function getDatabaseVersion(
 	return currentVersion;
 }
 
-export async function closeDatabase(db: IDBDatabase) {
-	db.close();
-	// FIXME: this isn't right!!!!
-	await new Promise<void>((resolve) => resolve());
-}
-
 /**
  * Upgrades the database to the given version, using the given upgrader function.
  */
@@ -61,8 +58,11 @@ export async function upgradeDatabase(
 		event: IDBVersionChangeEvent,
 	) => void,
 	log?: (...args: any[]) => void,
-): Promise<void> {
-	function openAndUpgrade(resolve: () => void, reject: (err: Error) => void) {
+): Promise<IDBDatabase> {
+	function openAndUpgrade(
+		resolve: (db: IDBDatabase) => void,
+		reject: (err: Error) => void,
+	) {
 		const request = indexedDb.open(
 			[namespace, 'collections'].join('_'),
 			version,
@@ -74,9 +74,8 @@ export async function upgradeDatabase(
 			wasUpgraded = true;
 		};
 		request.onsuccess = (event) => {
-			request.result.close();
 			if (wasUpgraded) {
-				resolve();
+				resolve(request.result);
 			} else {
 				reject(
 					new Error(
@@ -95,7 +94,7 @@ export async function upgradeDatabase(
 			// }, 200);
 		};
 	}
-	return new Promise(openAndUpgrade);
+	return new Promise<IDBDatabase>(openAndUpgrade);
 }
 
 export async function acquireLock(
@@ -110,15 +109,20 @@ export async function acquireLock(
 	}
 }
 
-export async function openDatabase(
-	indexedDb: IDBFactory,
-	namespace: string,
-	version: number,
-	log?: (...args: any[]) => void,
-): Promise<IDBDatabase> {
-	log?.('debug', 'Opening database', namespace, 'at version', version);
+export async function openDatabase({
+	indexedDB = globalIDB,
+	namespace,
+	version,
+	context,
+}: {
+	indexedDB?: IDBFactory;
+	namespace: string;
+	version: number;
+	context: OpenDocumentDbContext;
+}): Promise<IDBDatabase> {
+	context.log('debug', 'Opening database', namespace, 'at version', version);
 	const db = await new Promise<IDBDatabase>((resolve, reject) => {
-		const request = indexedDb.open(
+		const request = indexedDB.open(
 			[namespace, 'collections'].join('_'),
 			version,
 		);
@@ -126,7 +130,7 @@ export async function openDatabase(
 			const transaction = request.transaction!;
 			transaction.abort();
 
-			log?.(
+			context.log(
 				'error',
 				'Database upgrade needed, but not expected',
 				'Expected',
@@ -158,3 +162,41 @@ export async function openDatabase(
 
 	return db;
 }
+
+export async function copyAll(
+	sourceDatabase: IDBDatabase,
+	targetDatabase: IDBDatabase,
+) {
+	// DOMStringList... doesn't have iterable... why
+	const sourceStoreNames = new Array<string>();
+	for (let i = 0; i < sourceDatabase.objectStoreNames.length; i++) {
+		sourceStoreNames.push(sourceDatabase.objectStoreNames[i]);
+	}
+
+	const copyFromTransaction = sourceDatabase.transaction(
+		sourceStoreNames,
+		'readonly',
+	);
+	const copyFromStores = sourceStoreNames.map((name) =>
+		copyFromTransaction.objectStore(name),
+	);
+	const allObjects = await Promise.all(
+		copyFromStores.map((store) => storeRequestPromise(store.getAll())),
+	);
+
+	const copyToTransaction = targetDatabase.transaction(
+		sourceStoreNames,
+		'readwrite',
+	);
+	const copyToStores = sourceStoreNames.map((name) =>
+		copyToTransaction.objectStore(name),
+	);
+
+	for (let i = 0; i < copyToStores.length; i++) {
+		await Promise.all(
+			allObjects[i].map((obj) => {
+				return storeRequestPromise(copyToStores[i].put(obj));
+			}),
+		);
+	}
+}

package/src/migration/engine.ts

@@ -0,0 +1,248 @@
+import {
+	CollectionFilter,
+	Migration,
+	MigrationEngine,
+	ObjectIdentifier,
+	addFieldDefaults,
+	assert,
+	assignOidsToAllSubObjects,
+	cloneDeep,
+	createOid,
+	diffToPatches,
+	getOid,
+	initialToPatches,
+	removeOidPropertiesFromAllSubObjects,
+} from '@verdant-web/common';
+import { Context } from '../context.js';
+import { Metadata } from '../metadata/Metadata.js';
+import { findAllOids, findOneOid } from '../queries/dbQueries.js';
+import { OpenDocumentDbContext } from './types.js';
+
+function getMigrationMutations({
+	migration,
+	meta,
+	getMigrationNow,
+	newOids,
+}: {
+	migration: Migration<any>;
+	newOids: string[];
+	getMigrationNow: () => string;
+	meta: Metadata;
+}) {
+	return migration.allCollections.reduce((acc, collectionName) => {
+		acc[collectionName] = {
+			put: async (doc: any) => {
+				// add defaults
+				addFieldDefaults(migration.newSchema.collections[collectionName], doc);
+				const primaryKey =
+					doc[migration.newSchema.collections[collectionName].primaryKey];
+				const oid = createOid(collectionName, primaryKey);
+				newOids.push(oid);
+				await meta.insertLocalOperations(
+					initialToPatches(doc, oid, getMigrationNow),
+				);
+				return doc;
+			},
+			delete: async (id: string) => {
+				const rootOid = createOid(collectionName, id);
+				const allOids = await meta.getAllDocumentRelatedOids(rootOid);
+				return meta.insertLocalOperations(
+					allOids.map((oid) => ({
+						oid,
+						timestamp: getMigrationNow(),
+						data: { op: 'delete' },
+					})),
+				);
+			},
+		};
+		return acc;
+	}, {} as any);
+}
+
+function getMigrationQueries({
+	migration,
+	context,
+	meta,
+}: {
+	migration: Migration<any>;
+	context: Context;
+	meta: Metadata;
+}) {
+	return migration.oldCollections.reduce((acc, collectionName) => {
+		acc[collectionName] = {
+			get: async (id: string) => {
+				const oid = createOid(collectionName, id);
+				const doc = await meta.getDocumentSnapshot(oid, {
+					// only get the snapshot up to the previous version (newer operations may have synced)
+					to: meta.time.now(migration.oldSchema.version),
+				});
+				return doc;
+			},
+			findOne: async (filter: CollectionFilter) => {
+				const oid = await findOneOid({
+					collection: collectionName,
+					index: filter,
+					context,
+				});
+				if (!oid) return null;
+				const doc = await meta.getDocumentSnapshot(oid, {
+					// only get the snapshot up to the previous version (newer operations may have synced)
+					to: meta.time.now(migration.oldSchema.version),
+				});
+				return doc;
+			},
+			findAll: async (filter: CollectionFilter) => {
+				const oids = await findAllOids({
+					collection: collectionName,
+					index: filter,
+					context,
+				});
+				const docs = await Promise.all(
+					oids.map((oid) =>
+						meta.getDocumentSnapshot(oid, {
+							// only get the snapshot up to the previous version (newer operations may have synced)
+							to: meta.time.now(migration.oldSchema.version),
+						}),
+					),
+				);
+				return docs;
+			},
+		};
+		return acc;
+	}, {} as any);
+}
+
+export function getMigrationEngine({
+	meta,
+	migration,
+	context,
+}: {
+	log?: (...args: any[]) => void;
+	migration: Migration;
+	meta: Metadata;
+	context: Context;
+}): MigrationEngine {
+	function getMigrationNow() {
+		return meta.time.zero(migration.version);
+	}
+
+	const newOids = new Array<ObjectIdentifier>();
+
+	const queries = getMigrationQueries({
+		migration,
+		context,
+		meta,
+	});
+	const mutations = getMigrationMutations({
+		migration,
+		getMigrationNow,
+		newOids,
+		meta,
+	});
+	const deleteCollection = async (collection: string) => {
+		const allOids = await meta.getAllCollectionRelatedOids(collection);
+		return meta.insertLocalOperations(
+			allOids.map((oid) => ({
+				oid,
+				timestamp: getMigrationNow(),
+				data: { op: 'delete' },
+			})),
+		);
+	};
+	const awaitables = new Array<Promise<any>>();
+	const engine: MigrationEngine = {
+		log: context.log,
+		newOids,
+		deleteCollection,
+		migrate: async (collection, strategy) => {
+			const docs = await queries[collection].findAll();
+
+			await Promise.all(
+				docs.filter(Boolean).map(async (doc: any) => {
+					const rootOid = getOid(doc);
+					assert(
+						!!rootOid,
+						`Document is missing an OID: ${JSON.stringify(doc)}`,
+					);
+					const original = cloneDeep(doc);
+					// @ts-ignore - excessive type resolution
+					const newValue = await strategy(doc);
+					if (newValue) {
+						// the migration has altered the shape of our document. we need
+						// to create the operation from the diff and write it to meta as
+						// a migration patch
+						removeOidPropertiesFromAllSubObjects(original);
+						removeOidPropertiesFromAllSubObjects(newValue);
+						assignOidsToAllSubObjects(newValue);
+						const patches = diffToPatches(
+							original,
+							newValue,
+							getMigrationNow,
+							undefined,
+							[],
+							{
+								mergeUnknownObjects: true,
+							},
+						);
+						if (patches.length > 0) {
+							await meta.insertLocalOperations(patches);
+						}
+					}
+				}),
+			);
+		},
+		queries,
+		mutations,
+		awaitables,
+	};
+	return engine;
+}
+
+export function getInitialMigrationEngine({
+	meta,
+	migration,
+	context,
+}: {
+	context: OpenDocumentDbContext;
+	migration: Migration;
+	meta: Metadata;
+}): MigrationEngine {
+	function getMigrationNow() {
+		return meta.time.zero(migration.version);
+	}
+
+	const newOids = new Array<ObjectIdentifier>();
+
+	const queries = new Proxy({} as any, {
+		get() {
+			throw new Error(
+				'Queries are not available in initial migrations; there is no database yet!',
+			);
+		},
+	}) as any;
+
+	const mutations = getMigrationMutations({
+		migration,
+		getMigrationNow,
+		newOids,
+		meta,
+	});
+	const engine: MigrationEngine = {
+		log: context.log,
+		newOids,
+		deleteCollection: () => {
+			throw new Error(
+				'Calling deleteCollection() in initial migrations is not supported! Use initial migrations to seed initial data using mutations.',
+			);
+		},
+		migrate: () => {
+			throw new Error(
+				'Calling migrate() in initial migrations is not supported! Use initial migrations to seed initial data using mutations.',
+			);
+		},
+		queries,
+		mutations,
+		awaitables: [],
+	};
+	return engine;
+}