@verdant-web/store 2.0.1

package/dist/cjs/SyncHarness.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Heartbeat = exports.SyncHarness = void 0;
+const common_1 = require("@lo-fi/common");
+/**
+  Bridges sync messages and the local storage, interpreting messages and
+  handling initial sync and heartbeat.
+ */
+class SyncHarness {
+    constructor({ sync, meta, initialPresence, entities, }) {
+        this.handleOnlineChange = async (online) => {
+            if (!online) {
+                this.heartbeat.stop();
+            }
+            else {
+                const lastSyncTimestamp = await this.meta.lastSyncedTimestamp();
+                this.sync.send(await this.meta.messageCreator.createSyncStep1(!lastSyncTimestamp));
+                this.sync.send(await this.meta.messageCreator.createPresenceUpdate(this.initialPresence));
+                this.heartbeat.start();
+            }
+        };
+        this.handleMessage = async (message) => {
+            let affectedOids = undefined;
+            switch (message.type) {
+                case 'op-re':
+                    // rebroadcasted operations
+                    affectedOids = await this.meta.insertRemoteOperations(message.operations);
+                    break;
+                case 'sync-resp':
+                    if (message.overwriteLocalData) {
+                        await this.meta.reset();
+                        await this.entities.reset();
+                    }
+                    affectedOids = await this.meta.insertRemoteOperations(message.operations);
+                    await this.meta.ackInfo.setGlobalAck(message.globalAckTimestamp);
+                    // respond to the server
+                    this.sync.send(await this.meta.messageCreator.createSyncStep2(message.provideChangesSince));
+                    await this.meta.updateLastSynced();
+                    break;
+                case 'rebases':
+                    const affectedSet = new Set();
+                    for (const rebase of message.rebases) {
+                        await this.meta.rebase(rebase.oid, rebase.upTo);
+                        affectedSet.add((0, common_1.getOidRoot)(rebase.oid));
+                    }
+                    affectedOids = Array.from(affectedSet);
+                    break;
+            }
+            if (affectedOids === null || affectedOids === void 0 ? void 0 : affectedOids.length) {
+                this.entities.refreshAll(affectedOids);
+            }
+        };
+        this.send = async (message) => {
+            this.sync.send(message);
+        };
+        this.sync = sync;
+        this.meta = meta;
+        this.initialPresence = initialPresence;
+        this.entities = entities;
+        this.heartbeat = new Heartbeat({
+            sync: this.sync,
+            meta: this.meta,
+        });
+        sync.subscribe('onlineChange', this.handleOnlineChange);
+        sync.subscribe('message', this.handleMessage);
+    }
+}
+exports.SyncHarness = SyncHarness;
+class Heartbeat extends common_1.EventSubscriber {
+    constructor({ sync, meta, interval = 15 * 1000, deadlineLength = 3 * 1000, }) {
+        super();
+        this.nextBeat = null;
+        this.deadline = null;
+        this.handleSyncMessage = (message) => {
+            if (message.type === 'heartbeat-response') {
+                if (this.deadline) {
+                    clearTimeout(this.deadline);
+                    this.deadline = null;
+                    this.start();
+                }
+            }
+        };
+        this.start = () => {
+            this.nextBeat = setTimeout(this.beat, this.interval);
+        };
+        this.stop = () => {
+            if (this.nextBeat) {
+                clearTimeout(this.nextBeat);
+            }
+            if (this.deadline) {
+                clearTimeout(this.deadline);
+            }
+        };
+        this.beat = async () => {
+            this.sync.send(await this.meta.messageCreator.createHeartbeat());
+            this.deadline = setTimeout(this.onDeadline, this.deadlineLength);
+        };
+        this.onDeadline = () => {
+            this.deadline = null;
+            this.emit('missed');
+        };
+        this.sync = sync;
+        this.meta = meta;
+        this.interval = interval;
+        this.deadlineLength = deadlineLength;
+        sync.subscribe('message', this.handleSyncMessage);
+    }
+}
+exports.Heartbeat = Heartbeat;
+//# sourceMappingURL=SyncHarness.js.map

package/dist/cjs/SyncHarness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SyncHarness.js","sourceRoot":"","sources":["../../src/SyncHarness.ts"],"names":[],"mappings":";;;AAAA,0CAMuB;AAKvB;;;GAGG;AACH,MAAa,WAAW;IAOvB,YAAY,EACX,IAAI,EACJ,IAAI,EACJ,eAAe,EACf,QAAQ,GAMR;QAaO,uBAAkB,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YACtD,IAAI,CAAC,MAAM,EAAE;gBACZ,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;aACtB;iBAAM;gBACN,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBAChE,IAAI,CAAC,IAAI,CAAC,IAAI,CACb,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC,iBAAiB,CAAC,CAClE,CAAC;gBACF,IAAI,CAAC,IAAI,CAAC,IAAI,CACb,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,oBAAoB,CAClD,IAAI,CAAC,eAAe,CACpB,CACD,CAAC;gBACF,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;aACvB;QACF,CAAC,CAAC;QAEM,kBAAa,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;YACxD,IAAI,YAAY,GAAmC,SAAS,CAAC;YAC7D,QAAQ,OAAO,CAAC,IAAI,EAAE;gBACrB,KAAK,OAAO;oBACX,2BAA2B;oBAC3B,YAAY,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,sBAAsB,CACpD,OAAO,CAAC,UAAU,CAClB,CAAC;oBACF,MAAM;gBACP,KAAK,WAAW;oBACf,IAAI,OAAO,CAAC,kBAAkB,EAAE;wBAC/B,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;wBACxB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;qBAC5B;oBAED,YAAY,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,sBAAsB,CACpD,OAAO,CAAC,UAAU,CAClB,CAAC;oBAEF,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;oBAEjE,wBAAwB;oBACxB,IAAI,CAAC,IAAI,CAAC,IAAI,CACb,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,CAC7C,OAAO,CAAC,mBAAmB,CAC3B,CACD,CAAC;oBACF,MAAM,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBACnC,MAAM;gBACP,KAAK,SAAS;oBACb,MAAM,WAAW,GAAG,IAAI,GAAG,EAAoB,CAAC;oBAChD,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE;wBACrC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;wBAChD,WAAW,CAAC,GAAG,CAAC,IAAA,mBAAU,EAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;qBACxC;oBACD,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;oBACvC,MAAM;aACP;YAED,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,EAAE;gBACzB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC;aACvC;QACF,CAAC,CAAC;QAEF,SAAI,GAAG,KAAK,EAAE,OAAsB,EAAE,EAAE;YACvC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC,CAAC;QA3ED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,SAAS,GAAG,IAAI,SAAS,CAAC;YAC9B,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC,CAAC;QACH,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACxD,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/C,CAAC;CAkED;AA9FD,kCA8FC;AAED,MAAa,SAAU,SAAQ,wBAE7B;IAQD,YAAY,EACX,IAAI,EACJ,IAAI,EACJ,QAAQ,GAAG,EAAE,GAAG,IAAI,EACpB,cAAc,GAAG,CAAC,GAAG,IAAI,GAMzB;QACA,KAAK,EAAE,CAAC;QAdD,aAAQ,GAA0B,IAAI,CAAC;QACvC,aAAQ,GAA0B,IAAI,CAAC;QAqBvC,sBAAiB,GAAG,CAAC,OAAsB,EAAE,EAAE;YACtD,IAAI,OAAO,CAAC,IAAI,KAAK,oBAAoB,EAAE;gBAC1C,IAAI,IAAI,CAAC,QAAQ,EAAE;oBAClB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBAC5B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;oBACrB,IAAI,CAAC,KAAK,EAAE,CAAC;iBACb;aACD;QACF,CAAC,CAAC;QAEF,UAAK,GAAG,GAAG,EAAE;YACZ,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACtD,CAAC,CAAC;QAEF,SAAI,GAAG,GAAG,EAAE;YACX,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAClB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC5B;YACD,IAAI,IAAI,CAAC,QAAQ,EAAE;gBAClB,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;aAC5B;QACF,CAAC,CAAC;QAEM,SAAI,GAAG,KAAK,IAAI,EAAE;YACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC,CAAC;YACjE,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAClE,CAAC,CAAC;QAEM,eAAU,GAAG,GAAG,EAAE;YACzB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,CAAC;QAtCD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACnD,CAAC;CAkCD;AA7DD,8BA6DC"}

package/dist/cjs/UndoHistory.d.ts

@@ -0,0 +1,16 @@
+import { EventSubscriber } from '@verdant-web/common';
+type Undoable = () => Undoable | Promise<Undoable>;
+export declare class UndoHistory extends EventSubscriber<{
+    change: () => void;
+}> {
+    private _undoable;
+    private _undone;
+    get canUndo(): boolean;
+    get canRedo(): boolean;
+    undo: () => Promise<boolean>;
+    redo: () => Promise<boolean>;
+    addUndo: (undoPoint: Undoable) => void;
+    addRedo: (redoPoint: Undoable) => void;
+    clear: () => void;
+}
+export {};

package/dist/cjs/UndoHistory.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UndoHistory = void 0;
+const common_1 = require("@verdant-web/common");
+class UndoHistory extends common_1.EventSubscriber {
+    constructor() {
+        super(...arguments);
+        this._undoable = [];
+        this._undone = [];
+        this.undo = async () => {
+            const next = this._undoable.pop();
+            if (next) {
+                this._undone.push(await next());
+                this.emit('change');
+                return true;
+            }
+            return false;
+        };
+        this.redo = async () => {
+            const next = this._undone.pop();
+            if (next) {
+                this._undoable.push(await next());
+                this.emit('change');
+                return true;
+            }
+            return false;
+        };
+        this.addUndo = (undoPoint) => {
+            this._undoable.push(undoPoint);
+            this._undone = [];
+            this.emit('change');
+        };
+        this.addRedo = (redoPoint) => {
+            this._undone.push(redoPoint);
+            this.emit('change');
+        };
+        this.clear = () => {
+            this._undoable = [];
+            this._undone = [];
+            this.emit('change');
+        };
+    }
+    get canUndo() {
+        return this._undoable.length > 0;
+    }
+    get canRedo() {
+        return this._undone.length > 0;
+    }
+}
+exports.UndoHistory = UndoHistory;
+//# sourceMappingURL=UndoHistory.js.map

package/dist/cjs/UndoHistory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"UndoHistory.js","sourceRoot":"","sources":["../../src/UndoHistory.ts"],"names":[],"mappings":";;;AAAA,gDAAsD;AAItD,MAAa,WAAY,SAAQ,wBAAuC;IAAxE;;QACS,cAAS,GAAe,EAAE,CAAC;QAC3B,YAAO,GAAe,EAAE,CAAC;QASjC,SAAI,GAAG,KAAK,IAAI,EAAE;YACjB,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC;YAClC,IAAI,IAAI,EAAE;gBACT,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;gBAChC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpB,OAAO,IAAI,CAAC;aACZ;YACD,OAAO,KAAK,CAAC;QACd,CAAC,CAAC;QAEF,SAAI,GAAG,KAAK,IAAI,EAAE;YACjB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YAChC,IAAI,IAAI,EAAE;gBACT,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;gBAClC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;gBACpB,OAAO,IAAI,CAAC;aACZ;YACD,OAAO,KAAK,CAAC;QACd,CAAC,CAAC;QAEF,YAAO,GAAG,CAAC,SAAmB,EAAE,EAAE;YACjC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,CAAC;QAEF,YAAO,GAAG,CAAC,SAAmB,EAAE,EAAE;YACjC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7B,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,CAAC;QAEF,UAAK,GAAG,GAAG,EAAE;YACZ,IAAI,CAAC,SAAS,GAAG,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC;YAClB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACrB,CAAC,CAAC;IACH,CAAC;IA3CA,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,OAAO;QACV,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC;IAChC,CAAC;CAsCD;AA/CD,kCA+CC"}

package/dist/cjs/__tests__/batching.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/__tests__/batching.test.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const testStorage_js_1 = require("./fixtures/testStorage.js");
+(0, vitest_1.describe)('batching operations', () => {
+    (0, vitest_1.it)('should allow multiple runs with manual flush', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item = await storage.todos.put({
+            content: 'hello world',
+            category: 'general',
+            attachments: [
+                {
+                    name: 'thing',
+                },
+            ],
+        });
+        // disable timeout for manual control
+        const batch = storage.batch({ timeout: null });
+        batch.run(() => {
+            item.set('content', 'hello world 2');
+            item.set('category', 'never');
+        });
+        // fake some async work
+        await new Promise((resolve) => setTimeout(resolve, 200));
+        batch.run(() => {
+            item.set('content', 'hello world 3');
+            item.set('category', 'general');
+            item.get('attachments').push({ name: 'other thing' });
+        });
+        await batch.flush();
+        (0, vitest_1.expect)(item.get('content')).toBe('hello world 3');
+        (0, vitest_1.expect)(item.get('category')).toBe('general');
+        (0, vitest_1.expect)(item.get('attachments').length).toBe(2);
+        (0, vitest_1.expect)(storage.undoHistory.canUndo).toBe(true);
+        await storage.undoHistory.undo();
+        (0, vitest_1.expect)(item.get('content')).toBe('hello world');
+        (0, vitest_1.expect)(item.get('category')).toBe('general');
+        (0, vitest_1.expect)(item.get('attachments').length).toBe(1);
+        // the next undo will undo the creation
+        await storage.undoHistory.undo();
+        (0, vitest_1.expect)(storage.undoHistory.canUndo).toBe(false);
+        (0, vitest_1.expect)(item.deleted).toBe(true);
+    });
+});
+//# sourceMappingURL=batching.test.js.map

package/dist/cjs/__tests__/batching.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"batching.test.js","sourceRoot":"","sources":["../../../src/__tests__/batching.test.ts"],"names":[],"mappings":";;AAAA,mCAAkE;AAClE,8DAA8D;AAE9D,IAAA,iBAAQ,EAAC,qBAAqB,EAAE,GAAG,EAAE;IACpC,IAAA,WAAE,EAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,OAAO,GAAG,MAAM,IAAA,kCAAiB,GAAE,CAAC;QAE1C,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC;YACpC,OAAO,EAAE,aAAa;YACtB,QAAQ,EAAE,SAAS;YACnB,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,OAAO;iBACb;aACD;SACD,CAAC,CAAC;QAEH,qCAAqC;QACrC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;QAE/C,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YACd,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;QAEH,uBAAuB;QACvB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QAEzD,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YACd,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YACrC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;YAChC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,aAAa,EAAE,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QAEpB,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAClD,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE/C,IAAA,eAAM,EAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE/C,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAEjC,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAChD,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC7C,IAAA,eAAM,EAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAE/C,uCAAuC;QACvC,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QACjC,IAAA,eAAM,EAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEhD,IAAA,eAAM,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/cjs/__tests__/documents.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/cjs/__tests__/documents.test.js

@@ -0,0 +1,403 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const common_1 = require("@verdant-web/common");
+const vitest_1 = require("vitest");
+const testStorage_js_1 = require("./fixtures/testStorage.js");
+async function waitForStoragePropagation(mock) {
+    await new Promise((resolve, reject) => {
+        // timeout after 3s waiting
+        const timeout = setTimeout(() => reject(new Error('Waiting for storage change timed out')), 3000);
+        const interval = setInterval(() => {
+            if (mock.mock.calls.length > 0) {
+                clearInterval(interval);
+                clearTimeout(timeout);
+                resolve();
+            }
+        }, 0);
+    });
+}
+(0, vitest_1.describe)('storage documents', () => {
+    (0, vitest_1.it)('should fill in default values', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item = await storage.todos.put({
+            content: 'item',
+            category: 'general',
+            attachments: [
+                {
+                    name: 'thing',
+                },
+            ],
+        });
+        (0, vitest_1.expect)(item.get('id')).toBeDefined();
+        (0, vitest_1.expect)(item.get('done')).toBe(false);
+        (0, vitest_1.expect)(item.get('tags').length).toBe(0);
+        (0, vitest_1.expect)(item.get('attachments').get(0).get('test')).toBe(1);
+    });
+    (0, vitest_1.it)('should have a stable identity across different queries when subscribed', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        await storage.todos.put({
+            content: 'item 2',
+            done: true,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        const singleItemQuery = storage.todos.get(item1.get('id'));
+        const singleItemResult = await singleItemQuery.resolved;
+        (0, vitest_1.expect)(singleItemResult).toBeTruthy();
+        (0, common_1.assert)(!!singleItemResult);
+        singleItemResult.subscribe('change', vitest_1.vi.fn());
+        const allItemsQuery = storage.todos.findAll();
+        const allItemsResult = await allItemsQuery.resolved;
+        const allItemsReferenceToItem1 = allItemsResult.find((item) => item.get('id') === item1.get('id'));
+        (0, vitest_1.expect)(singleItemResult).toBe(allItemsReferenceToItem1);
+    });
+    (0, vitest_1.it)('should immediately reflect mutations', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        item1.set('done', true);
+        (0, vitest_1.expect)(item1.get('done')).toBe(true);
+    });
+    (0, vitest_1.it)('should notify about changes', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        const liveItem1 = await storage.todos.get(item1.get('id')).resolved;
+        (0, vitest_1.expect)(liveItem1).toBeTruthy();
+        (0, common_1.assert)(!!liveItem1);
+        const callback = vitest_1.vi.fn();
+        liveItem1.subscribe('change', callback);
+        liveItem1.set('done', true);
+        liveItem1.set('content', 'item 1 updated');
+        await waitForStoragePropagation(callback);
+        // only 1 callback - changes are batched.
+        // expect(callback).toBeCalledTimes(1); // FIXME: called twice, once for immediate in-memory change and once after propagation. can this be 1?
+        (0, vitest_1.expect)(liveItem1.getSnapshot()).toEqual({
+            id: liveItem1.get('id'),
+            content: 'item 1 updated',
+            done: true,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        const callbackDeep = vitest_1.vi.fn();
+        liveItem1.subscribe('changeDeep', callbackDeep);
+        liveItem1.update({
+            tags: ['tag 1', 'tag 2'],
+        });
+        await waitForStoragePropagation(callbackDeep);
+        (0, vitest_1.expect)(liveItem1.getSnapshot().tags).toEqual(['tag 1', 'tag 2']);
+    });
+    (0, vitest_1.it)('should expose array mutators on nested arrays', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        const callback = vitest_1.vi.fn();
+        item1.get('tags').subscribe('change', callback);
+        item1.get('tags').push('tag 1');
+        item1.get('tags').push('tag 2');
+        item1.get('tags').push('tag 3');
+        item1.get('tags').move(1, 2);
+        // fields are immediately updated
+        (0, vitest_1.expect)(item1.get('tags').get(0)).toEqual('tag 1');
+        (0, vitest_1.expect)(item1.get('tags').get(1)).toEqual('tag 3');
+        (0, vitest_1.expect)(item1.get('tags').get(2)).toEqual('tag 2');
+        await waitForStoragePropagation(callback);
+        (0, vitest_1.expect)(callback).toBeCalledTimes(4);
+        (0, vitest_1.expect)(item1.getSnapshot()).toEqual({
+            id: item1.get('id'),
+            content: 'item 1',
+            done: false,
+            tags: ['tag 1', 'tag 3', 'tag 2'],
+            category: 'general',
+            attachments: [],
+        });
+    });
+    (0, vitest_1.it)('should expose array accessors on nested arrays', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: ['tag 1', 'tag 2'],
+            category: 'general',
+            attachments: [
+                {
+                    name: 'attachment 1',
+                },
+            ],
+        });
+        for (const attachment of item1.get('attachments')) {
+            (0, vitest_1.expect)(attachment.get('name')).toBe('attachment 1');
+        }
+        let i = 0;
+        for (const tag of item1.get('tags')) {
+            (0, vitest_1.expect)(tag).toBe('tag ' + ++i);
+        }
+        (0, vitest_1.expect)(item1.get('tags').filter((tag) => tag === 'tag 1')).toEqual([
+            'tag 1',
+        ]);
+        item1.get('attachments').push({
+            name: 'attachment 2',
+        });
+        (0, vitest_1.expect)(item1.get('attachments').getSnapshot()).toEqual([
+            { name: 'attachment 1', test: 1 },
+            { name: 'attachment 2', test: 1 },
+        ]);
+    });
+    (0, vitest_1.it)('should provide a reasonable way to interact with unknown data', async () => {
+        /**
+         * 'any' field types should basically just stop type checking, but still
+         * provide full reactive entity access for nested data.
+         */
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.weirds.put({
+            weird: {
+                foo: 'bar',
+                baz: [
+                    {
+                        corge: 3,
+                    },
+                ],
+            },
+            map: {},
+            objectMap: {},
+        });
+        (0, vitest_1.expect)(item1.get('weird').get('foo')).toBe('bar');
+        (0, vitest_1.expect)(item1.get('weird').get('baz').get(0).get('corge')).toBe(3);
+        (0, vitest_1.expect)(item1.get('weird').getSnapshot()).toEqual({
+            foo: 'bar',
+            baz: [{ corge: 3 }],
+        });
+        item1.get('weird').get('baz').push({ corge: 4 });
+        (0, vitest_1.expect)(item1.get('weird').get('baz').getSnapshot()).toEqual([
+            { corge: 3 },
+            { corge: 4 },
+        ]);
+    });
+    (0, vitest_1.it)('should provide access and updates for map-type fields', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.weirds.put({
+            weird: null,
+            map: {
+                foo: 'bar',
+                baz: 'qux',
+            },
+            objectMap: {
+                foo: {
+                    content: 'bar',
+                },
+            },
+        });
+        (0, vitest_1.expect)(item1.get('map').get('foo')).toBe('bar');
+        (0, vitest_1.expect)(item1.get('map').get('baz')).toBe('qux');
+        (0, vitest_1.expect)(item1.get('map').getSnapshot()).toEqual({
+            foo: 'bar',
+            baz: 'qux',
+        });
+        (0, vitest_1.expect)(item1.get('objectMap').get('foo').get('content')).toBe('bar');
+        (0, vitest_1.expect)(item1.get('objectMap').get('baz')).toBe(undefined);
+        item1.get('objectMap').set('baz', { content: 'qux' });
+        (0, vitest_1.expect)(item1.get('objectMap').get('baz').get('content')).toBe('qux');
+    });
+    (0, vitest_1.it)('should merge .update fields and not discard undefined ones', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.weirds.put({
+            weird: null,
+            map: {
+                foo: 'bar',
+                baz: 'qux',
+            },
+            objectMap: {
+                foo: {
+                    content: 'bar',
+                },
+            },
+        });
+        item1.update({
+            weird: 'foo',
+        });
+        (0, vitest_1.expect)(item1.get('weird')).toBe('foo');
+        (0, vitest_1.expect)(item1.get('map').get('foo')).toBe('bar');
+        item1.update({
+            weird: undefined,
+        });
+        (0, vitest_1.expect)(item1.get('weird')).toBe('foo');
+    });
+    (0, vitest_1.it)('should delete undefined fields in .update if merge is false', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.weirds.put({
+            weird: {
+                bar: 2,
+                qux: 3,
+            },
+            map: {
+                foo: 'bar',
+                baz: 'qux',
+            },
+            objectMap: {
+                foo: {
+                    content: 'bar',
+                },
+            },
+        });
+        item1.get('weird').update({
+            bar: 1,
+        }, {
+            merge: false,
+        });
+        (0, vitest_1.expect)(item1.get('weird').getSnapshot()).toMatchInlineSnapshot(`
+			{
+			  "bar": 1,
+			}
+		`);
+    });
+    (0, vitest_1.it)('should not allow merge: false in strict schema field updates', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        (0, vitest_1.expect)(() => {
+            item1.update({ content: 'bar' }, { merge: false });
+        }).toThrowErrorMatchingInlineSnapshot('"Cannot use .update without merge if the field has a strict schema type. merge: false is only available on \\"any\\" or \\"map\\" types."');
+    });
+    (0, vitest_1.it)('should apply defaults to created sub-objects in .update', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        item1.update({
+            attachments: [
+                {
+                    name: 'attachment 1',
+                },
+            ],
+        });
+        (0, vitest_1.expect)(item1.get('attachments').get(0).get('test')).toBe(1);
+    });
+    (0, vitest_1.it)('should remove items from list when .delete is called', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        item1.get('attachments').push({
+            name: 'attachment 1',
+        });
+        item1.get('attachments').push({
+            name: 'attachment 2',
+        });
+        item1.get('attachments').push({
+            name: 'attachment 3',
+        });
+        item1.get('attachments').delete(1);
+        (0, vitest_1.expect)(item1.get('attachments').length).toBe(2);
+        (0, vitest_1.expect)(item1.get('attachments').get(0).get('name')).toBe('attachment 1');
+        (0, vitest_1.expect)(item1.get('attachments').get(1).get('name')).toBe('attachment 3');
+        // should work on lists which are not field-validated
+        const item2 = await storage.weirds.put({
+            weird: ['foo', 'bar', 'baz'],
+        });
+        item2.get('weird').delete(1);
+        (0, vitest_1.expect)(item2.get('weird').length).toBe(2);
+        (0, vitest_1.expect)(item2.get('weird').get(0)).toBe('foo');
+        (0, vitest_1.expect)(item2.get('weird').get(1)).toBe('baz');
+    });
+    (0, vitest_1.it)('should expose updatedAt', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        let time = new Date();
+        vitest_1.vitest.setSystemTime(time);
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: [],
+            category: 'general',
+            attachments: [],
+        });
+        (0, vitest_1.expect)(item1.updatedAt).toEqual(time.getTime());
+        time = new Date(time.getTime() + 1000);
+        vitest_1.vitest.setSystemTime(time);
+        item1.update({
+            content: 'item 1 updated',
+        });
+        (0, vitest_1.expect)(item1.updatedAt).toEqual(time.getTime());
+        // works on nested fields
+        time = new Date(time.getTime() + 1000);
+        vitest_1.vitest.setSystemTime(time);
+        item1.get('attachments').push({
+            name: 'attachment 1',
+        });
+        (0, vitest_1.expect)(item1.deepUpdatedAt).toEqual(time.getTime());
+        time = new Date(time.getTime() + 1000);
+        vitest_1.vitest.setSystemTime(time);
+        item1.get('attachments').get(0).set('name', 'attachment 1 updated');
+        (0, vitest_1.expect)(item1.deepUpdatedAt).toEqual(time.getTime());
+        // but other items have their own updatedAt
+        (0, vitest_1.expect)(item1.get('tags').deepUpdatedAt).not.toEqual(time.getTime());
+    });
+    (0, vitest_1.it)('should allow creating a new document from another document snapshot', async () => {
+        const storage = await (0, testStorage_js_1.createTestStorage)();
+        const item1 = await storage.todos.put({
+            content: 'item 1',
+            done: false,
+            tags: ['tag 1'],
+            category: 'general',
+            attachments: [
+                {
+                    name: 'attachment 1',
+                },
+            ],
+        });
+        const _a = item1.getSnapshot(), { id } = _a, snapshot = __rest(_a, ["id"]);
+        const item2 = await storage.todos.put(snapshot);
+        (0, vitest_1.expect)(item2.get('tags').length).toBe(1);
+        (0, vitest_1.expect)(item2.get('attachments').length).toBe(1);
+        item2.get('attachments').get(0).set('name', 'attachment 2');
+        (0, vitest_1.expect)(item1.get('attachments').get(0).get('name')).toBe('attachment 1');
+    });
+});
+//# sourceMappingURL=documents.test.js.map