dexie-cloud-addon 4.1.0-alpha.10 → 4.1.0-alpha.12

package/dist/modern/define-ydoc-trigger.d.ts

@@ -0,0 +1,2 @@
+import { type Table, type YjsDoc } from 'dexie';
+export declare function defineYDocTrigger<T, TKey>(table: Table<T, TKey>, prop: keyof T & string, trigger: (ydoc: YjsDoc, parentId: TKey) => any): void;

package/dist/modern/dexie-cloud-addon.d.ts

@@ -1,3 +1,4 @@
 import dexieCloudAddon from './dexie-cloud-client';
 export * from './dexie-cloud-client';
+export { defineYDocTrigger } from './define-ydoc-trigger';
 export default dexieCloudAddon;

package/dist/modern/dexie-cloud-addon.js

@@ -8,7 +8,7 @@
  *
  * ==========================================================================
  *
- * Version 4.1.0-alpha.10, Wed Oct 16 2024
+ * Version 4.1.0-alpha.12, Wed Oct 16 2024
  *
  * https://dexie.org
  *
@@ -16,7 +16,7 @@
  * 
  */
 
-import Dexie, { PropModification, cmp, DexieYProvider, liveQuery } from 'dexie';
+import Dexie, { PropModification, cmp, DexieYProvider, liveQuery, RangeSet } from 'dexie';
 import { firstValueFrom, from as from$1, filter as filter$1, Observable as Observable$1, BehaviorSubject, Subject, fromEvent, of, merge, switchMap as switchMap$1, tap as tap$1, mergeMap as mergeMap$1, Subscription as Subscription$1, throwError, combineLatest, map as map$1, share, timer as timer$1 } from 'rxjs';
 
 /******************************************************************************
@@ -4944,7 +4944,7 @@ function listUpdatesSince(yTable, sinceIncluding) {
         .toArray();
 }
 
-function $Y(db) {
+function $Y$1(db) {
     const $Y = db.dx._options.Y;
     if (!$Y)
         throw new Error('Y library not supplied to Dexie constructor');
@@ -4974,7 +4974,7 @@ function listYClientMessagesAndStateVector(db, tablesToSync) {
         for (const table of tablesToSync) {
             if (table.schema.yProps) {
                 for (const yProp of table.schema.yProps) {
-                    const Y = $Y(db); // This is how we retrieve the user-provided Y library
+                    const Y = $Y$1(db); // This is how we retrieve the user-provided Y library
                     const yTable = db.table(yProp.updatesTable); // the updates-table for this combo of table+propName
                     const syncState = (yield yTable.get(DEXIE_CLOUD_SYNCER_ID));
                     // unsentFrom = the `i` value of updates that aren't yet sent to server (or at least not acked by the server yet)
@@ -5058,6 +5058,7 @@ function getUpdatesTable(db, table, ydocProp) {
 }
 
 function applyYServerMessages(yMessages, db) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const result = {};
         for (const m of yMessages) {
@@ -5089,7 +5090,24 @@ function applyYServerMessages(yMessages, db) {
                     // See my question in https://discuss.yjs.dev/t/generate-an-inverse-update/2765
                     console.debug(`Y update rejected. Deleting it.`);
                     const utbl = getUpdatesTable(db, m.table, m.prop);
-                    yield utbl.delete(m.i);
+                    // Delete the rejected update and all local updates since (avoid holes in the CRDT)
+                    // and destroy it's open document if there is one.
+                    const primaryKey = (_a = (yield utbl.get(m.i))) === null || _a === void 0 ? void 0 : _a.k;
+                    if (primaryKey != null) {
+                        yield db.transaction('rw', utbl, tx => {
+                            // @ts-ignore
+                            tx.idbtrans._rejecting_y_ypdate = true; // Inform ydoc triggers that we delete because of a rejection and not GC
+                            return utbl
+                                .where('i')
+                                .aboveOrEqual(m.i)
+                                .filter(u => cmp(u.k, primaryKey) === 0 && ((u.f || 0) & 1) === 1)
+                                .delete();
+                        });
+                        // Destroy active doc
+                        const activeDoc = DexieYProvider.getDocCache(db.dx).find(m.table, primaryKey, m.prop);
+                        if (activeDoc)
+                            activeDoc.destroy(); // Destroy the document so that editors don't continue to work on it
+                    }
                     break;
                 }
                 case 'in-sync': {
@@ -7804,125 +7822,137 @@ const getInvitesObservable = associate((db) => {
 function createYHandler(db) {
     return (provider) => {
         var _a;
-        const awap = getAwarenessLibrary(db);
         const doc = provider.doc;
-        const { parentTable, parentId, parentProp, updatesTable } = doc.meta;
+        const { parentTable } = doc.meta || {};
         if (!((_a = db.cloud.schema) === null || _a === void 0 ? void 0 : _a[parentTable].markedForSync)) {
             return; // The table that holds the doc is not marked for sync - leave it to dexie. No syncing, no awareness.
         }
-        let awareness = new awap.Awareness(doc);
-        awarenessWeakMap.set(doc, awareness);
-        provider.awareness = awareness;
-        awareness.on('update', ({ added, updated, removed }, origin) => {
-            // Send the update
-            const changedClients = added.concat(updated).concat(removed);
-            const user = db.cloud.currentUser.value;
-            if (origin !== 'server' && user.isLoggedIn && !isEagerSyncDisabled(db)) {
-                const update = awap.encodeAwarenessUpdate(awareness, changedClients);
+        let awareness;
+        Object.defineProperty(provider, "awareness", {
+            get() {
+                if (awareness)
+                    return awareness;
+                awarenessWeakMap.set(doc, awareness);
+                awareness = createAwareness(db, doc, provider);
+                return awareness;
+            }
+        });
+    };
+}
+function createAwareness(db, doc, provider) {
+    const { parentTable, parentId, parentProp, updatesTable } = doc.meta;
+    const awap = getAwarenessLibrary(db);
+    const awareness = new awap.Awareness(doc);
+    awareness.on('update', ({ added, updated, removed }, origin) => {
+        // Send the update
+        const changedClients = added.concat(updated).concat(removed);
+        const user = db.cloud.currentUser.value;
+        if (origin !== 'server' && user.isLoggedIn && !isEagerSyncDisabled(db)) {
+            const update = awap.encodeAwarenessUpdate(awareness, changedClients);
+            db.messageProducer.next({
+                type: 'aware',
+                table: parentTable,
+                prop: parentProp,
+                k: doc.meta.parentId,
+                u: update,
+            });
+            if (provider.destroyed) {
+                // We're called from awareness.on('destroy') that did
+                // removeAwarenessStates. 
+                // It's time to also send the doc-close message that dexie-cloud understands
+                // and uses to stop subscribing for updates and awareness updates and brings
+                // down the cached information in memory on the WS connection for this.
                 db.messageProducer.next({
-                    type: 'aware',
+                    type: 'doc-close',
                     table: parentTable,
                     prop: parentProp,
-                    k: doc.meta.parentId,
-                    u: update,
+                    k: doc.meta.parentId
                 });
-                if (provider.destroyed) {
-                    // We're called from awareness.on('destroy') that did
-                    // removeAwarenessStates. 
-                    // It's time to also send the doc-close message that dexie-cloud understands
-                    // and uses to stop subscribing for updates and awareness updates and brings
-                    // down the cached information in memory on the WS connection for this.
-                    db.messageProducer.next({
-                        type: 'doc-close',
-                        table: parentTable,
-                        prop: parentProp,
-                        k: doc.meta.parentId
-                    });
-                }
             }
-        });
-        awareness.on('destroy', () => {
-            // Signal to server that this provider is destroyed (the update event will be triggered, which
-            // in turn will trigger db.messageProducer that will send the message to the server if WS is connected)
-            awap.removeAwarenessStates(awareness, [doc.clientID], 'provider destroyed');
-        });
-        // Now wait til document is loaded and then open the document on the server
-        provider.on('load', () => __awaiter(this, void 0, void 0, function* () {
+        }
+    });
+    awareness.on('destroy', () => {
+        // Signal to server that this provider is destroyed (the update event will be triggered, which
+        // in turn will trigger db.messageProducer that will send the message to the server if WS is connected)
+        awap.removeAwarenessStates(awareness, [doc.clientID], 'provider destroyed');
+    });
+    // Open the document on the server
+    (() => __awaiter(this, void 0, void 0, function* () {
+        if (provider.destroyed)
+            return;
+        let connected = false;
+        let currentFlowId = 1;
+        const subscription = db.cloud.webSocketStatus.subscribe((wsStatus) => {
             if (provider.destroyed)
                 return;
-            let connected = false;
-            let currentFlowId = 1;
-            const subscription = db.cloud.webSocketStatus.subscribe((wsStatus) => {
-                if (provider.destroyed)
+            // Keep "connected" state in a variable so we can check it after async operations
+            connected = wsStatus === 'connected';
+            // We are or got connected. Open the document on the server.
+            const user = db.cloud.currentUser.value;
+            if (wsStatus === "connected" && user.isLoggedIn && !isEagerSyncDisabled(db)) {
+                ++currentFlowId;
+                openDocumentOnServer().catch(error => {
+                    console.warn(`Error catched in createYHandler.ts: ${error}`);
+                });
+            }
+        });
+        // Wait until WebSocket is connected
+        provider.addCleanupHandler(subscription);
+        /** Sends an 'doc-open' message to server whenever websocket becomes
+         * connected, or if it is already connected.
+         * The flow is aborted in case websocket is disconnected while querying
+         * information required to compute the state vector. Flow is also
+         * aborted in case document or provider has been destroyed during
+         * the async parts of the task.
+         *
+         * The state vector is only computed from the updates that have occured
+         * after the last full sync - which could very often be zero - in which
+         * case no state vector is sent (then the server already knows us by
+         * revision)
+         *
+         * When server gets the doc-open message, it will authorized us for
+         * whether we are allowed to read / write to this document, and then
+         * keep the cached information in memory on the WS connection for this
+         * particular document, as well as subscribe to updates and awareness updates
+         * from other clients on the document.
+         */
+        function openDocumentOnServer(wsStatus) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const myFlow = currentFlowId; // So we can abort when a new flow is started
+                const yTbl = db.table(updatesTable);
+                const syncState = yield yTbl.get(DEXIE_CLOUD_SYNCER_ID);
+                // After every await, check if we still should be working on this task.
+                if (provider.destroyed || currentFlowId !== myFlow || !connected)
                     return;
-                // Keep "connected" state in a variable so we can check it after async operations
-                connected = wsStatus === 'connected';
-                // We are or got connected. Open the document on the server.
-                const user = db.cloud.currentUser.value;
-                if (wsStatus === "connected" && user.isLoggedIn && !isEagerSyncDisabled(db)) {
-                    ++currentFlowId;
-                    openDocumentOnServer().catch(error => {
-                        console.warn(`Error catched in createYHandler.ts: ${error}`);
-                    });
+                const receivedUntil = (syncState === null || syncState === void 0 ? void 0 : syncState.receivedUntil) || 0;
+                const docOpenMsg = {
+                    type: 'doc-open',
+                    table: parentTable,
+                    prop: parentProp,
+                    k: parentId,
+                    serverRev: syncState === null || syncState === void 0 ? void 0 : syncState.serverRev,
+                };
+                const serverUpdatesSinceLastSync = yield yTbl
+                    .where('i')
+                    .between(receivedUntil, Infinity, false)
+                    .filter((update) => cmp(update.k, parentId) === 0 && // Only updates for this document
+                    ((update.f || 0) & 1) === 0 // Don't include local changes
+                )
+                    .toArray();
+                // After every await, check if we still should be working on this task.
+                if (provider.destroyed || currentFlowId !== myFlow || !connected)
+                    return;
+                if (serverUpdatesSinceLastSync.length > 0) {
+                    const Y = $Y$1(db); // Get the Yjs library from Dexie constructor options
+                    const mergedUpdate = Y.mergeUpdatesV2(serverUpdatesSinceLastSync.map((update) => update.u));
+                    const stateVector = Y.encodeStateVectorFromUpdateV2(mergedUpdate);
+                    docOpenMsg.sv = stateVector;
                 }
+                db.messageProducer.next(docOpenMsg);
             });
-            // Wait until WebSocket is connected
-            provider.addCleanupHandler(subscription);
-            /** Sends an 'doc-open' message to server whenever websocket becomes
-             * connected, or if it is already connected.
-             * The flow is aborted in case websocket is disconnected while querying
-             * information required to compute the state vector. Flow is also
-             * aborted in case document or provider has been destroyed during
-             * the async parts of the task.
-             *
-             * The state vector is only computed from the updates that have occured
-             * after the last full sync - which could very often be zero - in which
-             * case no state vector is sent (then the server already knows us by
-             * revision)
-             *
-             * When server gets the doc-open message, it will authorized us for
-             * whether we are allowed to read / write to this document, and then
-             * keep the cached information in memory on the WS connection for this
-             * particular document, as well as subscribe to updates and awareness updates
-             * from other clients on the document.
-             */
-            function openDocumentOnServer(wsStatus) {
-                return __awaiter(this, void 0, void 0, function* () {
-                    const myFlow = currentFlowId; // So we can abort when a new flow is started
-                    const yTbl = db.table(updatesTable);
-                    const syncState = yield yTbl.get(DEXIE_CLOUD_SYNCER_ID);
-                    // After every await, check if we still should be working on this task.
-                    if (provider.destroyed || currentFlowId !== myFlow || !connected)
-                        return;
-                    const receivedUntil = (syncState === null || syncState === void 0 ? void 0 : syncState.receivedUntil) || 0;
-                    const docOpenMsg = {
-                        type: 'doc-open',
-                        table: parentTable,
-                        prop: parentProp,
-                        k: parentId,
-                        serverRev: syncState === null || syncState === void 0 ? void 0 : syncState.serverRev,
-                    };
-                    const serverUpdatesSinceLastSync = yield yTbl
-                        .where('i')
-                        .between(receivedUntil, Infinity, false)
-                        .filter((update) => cmp(update.k, parentId) === 0 && // Only updates for this document
-                        ((update.f || 0) & 1) === 0 // Don't include local changes
-                    )
-                        .toArray();
-                    // After every await, check if we still should be working on this task.
-                    if (provider.destroyed || currentFlowId !== myFlow || !connected)
-                        return;
-                    if (serverUpdatesSinceLastSync.length > 0) {
-                        const Y = $Y(db); // Get the Yjs library from Dexie constructor options
-                        const mergedUpdate = Y.mergeUpdatesV2(serverUpdatesSinceLastSync.map((update) => update.u));
-                        const stateVector = Y.encodeStateVectorFromUpdateV2(mergedUpdate);
-                        docOpenMsg.sv = stateVector;
-                    }
-                    db.messageProducer.next(docOpenMsg);
-                });
-            }
-        }));
-    };
+        }
+    }))();
+    return awareness;
 }
 
 function getTiedRealmId(objectId) {
@@ -7972,7 +8002,7 @@ function dexieCloud(dexie) {
     const syncComplete = new Subject();
     dexie.cloud = {
         // @ts-ignore
-        version: "4.1.0-alpha.10",
+        version: "4.1.0-alpha.12",
         options: Object.assign({}, DEFAULT_OPTIONS),
         schema: null,
         get currentUserId() {
@@ -8274,8 +8304,160 @@ function dexieCloud(dexie) {
     }
 }
 // @ts-ignore
-dexieCloud.version = "4.1.0-alpha.10";
+dexieCloud.version = "4.1.0-alpha.12";
 Dexie.Cloud = dexieCloud;
 
-export { dexieCloud as default, dexieCloud, getTiedObjectId, getTiedRealmId, resolveText };
+const ydocTriggers = {};
+const docIsAlreadyHooked = new WeakSet();
+const middlewares = new WeakMap();
+const createMiddleware = (db) => ({
+    stack: 'dbcore',
+    level: 10,
+    name: 'yTriggerMiddleware',
+    create: (down) => {
+        return Object.assign(Object.assign({}, down), { transaction: (stores, mode, options) => {
+                const idbtrans = down.transaction(stores, mode, options);
+                idbtrans.addEventListener('complete', onTransactionCommitted);
+                return idbtrans;
+            }, table: (tblName) => {
+                const coreTable = down.table(tblName);
+                const triggerSpec = ydocTriggers[tblName];
+                if (!triggerSpec)
+                    return coreTable;
+                const { trigger, parentTable, prop } = triggerSpec;
+                return Object.assign(Object.assign({}, coreTable), { mutate(req) {
+                        switch (req.type) {
+                            case 'add': {
+                                for (const obj of req.values) {
+                                    const primaryKey = coreTable.schema.primaryKey.extractKey(obj);
+                                    const doc = DexieYProvider.getDocCache(db).find(parentTable, primaryKey, prop);
+                                    if (doc) {
+                                        if (!docIsAlreadyHooked.has(doc)) {
+                                            hookToDoc(doc, primaryKey, trigger);
+                                            docIsAlreadyHooked.add(doc);
+                                        }
+                                    }
+                                    else {
+                                        enqueueTrigger(tblName, primaryKey, trigger);
+                                    }
+                                }
+                                break;
+                            }
+                            case 'delete':
+                                // @ts-ignore
+                                if (req.trans._rejecting_y_ypdate) {
+                                    // The deletion came from a rejection, not garbage collection.
+                                    // When that happens, let the triggers run to compute new values
+                                    // based on the deleted updates.
+                                    coreTable
+                                        .getMany({
+                                        keys: req.keys,
+                                        trans: req.trans,
+                                        cache: 'immutable',
+                                    })
+                                        .then((updates) => {
+                                        const keySet = new RangeSet();
+                                        for (const { k } of updates) {
+                                            keySet.addKey(k);
+                                        }
+                                        for (const key of keySet) {
+                                            enqueueTrigger(tblName, key, trigger);
+                                        }
+                                    });
+                                }
+                                break;
+                        }
+                        return coreTable.mutate(req);
+                    } });
+            } });
+    },
+});
+let triggerExecPromise = null;
+let triggerScheduled = false;
+let scheduledTriggers = [];
+function $Y(db) {
+    const $Y = db._options.Y;
+    if (!$Y)
+        throw new Error('Y library not supplied to Dexie constructor');
+    return $Y;
+}
+function executeTriggers(triggersToRun) {
+    return __awaiter(this, void 0, void 0, function* () {
+        for (const { db, parentId, trigger, updatesTable } of triggersToRun) {
+            // Load entire document into an Y.Doc instance:
+            const updates = yield db
+                .table(updatesTable)
+                .where({ k: parentId })
+                .toArray();
+            const Y = $Y(db);
+            const yDoc = new Y.Doc();
+            for (const update of updates) {
+                Y.applyUpdateV2(yDoc, update);
+            }
+            try {
+                yield trigger(yDoc, parentId);
+            }
+            catch (error) {
+                console.error(`Error in YDocTrigger ${error}`);
+            }
+        }
+    });
+}
+function enqueueTrigger(updatesTable, parentId, trigger) {
+    var _a;
+    ((_a = scheduledTriggers[updatesTable]) !== null && _a !== void 0 ? _a : (scheduledTriggers[updatesTable] = [])).push({
+        parentId,
+        trigger,
+    });
+}
+function onTransactionCommitted() {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!triggerScheduled && scheduledTriggers.length > 0) {
+            triggerScheduled = true;
+            if (triggerExecPromise)
+                yield triggerExecPromise.catch(() => { });
+            setTimeout(() => {
+                // setTimeout() is to escape from Promise.PSD zones and never run within liveQueries or transaction scopes
+                triggerScheduled = false;
+                const triggersToRun = scheduledTriggers;
+                scheduledTriggers = [];
+                triggerExecPromise = executeTriggers(triggersToRun).finally(() => (triggerExecPromise = null));
+            }, 0);
+        }
+    });
+}
+function hookToDoc(doc, parentId, trigger) {
+    // From now on, keep listening to doc updates and execute the trigger when it happens there instead
+    doc.on('updateV2', (update, origin) => {
+        //Dexie.ignoreTransaction(()=>{
+        trigger(doc, parentId);
+        //});
+    });
+    /*
+      NOT NEEDED because DexieYProvider's docCache will also listen to destroy and remove it from its cache:
+      doc.on('destroy', ()=>{
+      docIsAlreadyHooked.delete(doc);
+    })
+    */
+}
+function defineYDocTrigger(table, prop, trigger) {
+    var _a, _b;
+    const updatesTable = (_b = (_a = table.schema.yProps) === null || _a === void 0 ? void 0 : _a.find((p) => p.prop === prop)) === null || _b === void 0 ? void 0 : _b.updatesTable;
+    if (!updatesTable)
+        throw new Error(`Table ${table.name} does not have a Yjs property named ${prop}`);
+    ydocTriggers[updatesTable] = {
+        trigger,
+        parentTable: table.name,
+        prop,
+    };
+    const db = table.db._novip;
+    let mw = middlewares.get(db);
+    if (!mw) {
+        mw = createMiddleware(db);
+        middlewares.set(db, mw);
+    }
+    db.use(mw);
+}
+
+export { dexieCloud as default, defineYDocTrigger, dexieCloud, getTiedObjectId, getTiedRealmId, resolveText };
 //# sourceMappingURL=dexie-cloud-addon.js.map