Merge pull request #2180 from dexie/breakout-yjs-to-addon

Breakout yjs to addon to its own module "y-dexie".

Author: dfahlander

.github/workflows/main.yml

@@ -23,9 +23,10 @@ jobs:
           - addons/Dexie.Observable/test
           - addons/Dexie.Syncable/test
           - addons/dexie-export-import/test
+          - addons/y-dexie/test
           - libs/dexie-react-hooks/test
       fail-fast: true # If one test fails, abort the rest of the tests
-      max-parallel: 5 # At least for browserstack, this seems to be needed to avoid timeouts
+      max-parallel: 6 # At least for browserstack, this seems to be needed to avoid timeouts
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

addons/dexie-cloud/package.json

@@ -1,48 +1,50 @@
 {
   "name": "dexie-cloud-addon",
-  "version": "4.1.0-beta.49",
+  "version": "4.2.0-alpha.7",
   "description": "Dexie addon that syncs with to Dexie Cloud",
-  "main": "dist/umd/dexie-cloud-addon.js",
   "type": "module",
-  "module": "dist/modern/dexie-cloud-addon.js",
+  "module": "dist/modern/dexie-cloud-addon.min.js",
   "homepage": "https://dexie.org/cloud/docs/dexie-cloud-addon",
   "exports": {
     ".": {
       "development": {
         "import": "./dist/modern/dexie-cloud-addon.js",
-        "require": "./dist/umd/dexie-cloud-addon.js",
-        "default": "./dist/umd/dexie-cloud-addon.js"
+        "require": false,
+        "types": "./dist/modern/dexie-cloud-addon.d.ts"
       },
       "production": {
         "import": "./dist/modern/dexie-cloud-addon.min.js",
-        "require": "./dist/umd/dexie-cloud-addon.min.js",
-        "default": "./dist/umd/dexie-cloud-addon.min.js"
+        "require": false,
+        "types": "./dist/modern/dexie-cloud-addon.d.ts"
       },
       "default": {
-        "import": "./dist/modern/dexie-cloud-addon.js",
-        "require": "./dist/umd/dexie-cloud-addon.js",
-        "default": "./dist/umd/dexie-cloud-addon.js"
+        "import": "./dist/modern/dexie-cloud-addon.min.js",
+        "require": false,
+        "types": "./dist/modern/dexie-cloud-addon.d.ts"
       }
     },
     "./service-worker": {
       "development": {
         "import": "./dist/modern/service-worker.js",
         "require": "./dist/umd/service-worker.js",
-        "default": "./dist/umd/service-worker.js"
+        "default": "./dist/umd/service-worker.js",
+         "types": "./dist/modern/service-worker.d.ts"
       },
       "production": {
         "import": "./dist/modern/service-worker.min.js",
         "require": "./dist/umd/service-worker.min.js",
-        "default": "./dist/umd/service-worker.min.js"
+        "default": "./dist/umd/service-worker.min.js",
+        "types": "./dist/modern/service-worker.d.ts"
       },
       "default": {
-        "import": "./dist/modern/service-worker.js",
-        "require": "./dist/umd/service-worker.js",
-        "default": "./dist/umd/service-worker.js"
+        "import": "./dist/modern/service-worker.min.js",
+        "require": "./dist/umd/service-worker.min.js",
+        "default": "./dist/umd/service-worker.min.js",
+        "types": "./dist/modern/service-worker.d.ts"
       }
     }
   },
-  "types": "dist/modern/dexie-cloud-client.d.ts",
+  "types": "dist/modern/dexie-cloud-addon.d.ts",
   "engines": {
     "node": ">=14"
   },
@@ -89,11 +91,15 @@
     "rollup": "^4.1.4",
     "terser": "^5.20.0",
     "tslib": "*",
-    "typescript": "^5.6.3"
+    "typescript": "^5.6.3",
+    "y-dexie": "workspace:>=4.2.0-alpha.1 <5.0.0"
   },
   "dependencies": {
     "dexie-cloud-common": "workspace:^",
-    "rxjs": "^7.x"
+    "y-dexie": "workspace:^",
+    "rxjs": "^7.x",
+    "yjs": "^13.6.27",
+    "y-protocols": "^1.0.6"
   },
   "peerDependencies": {
     "dexie": "workspace:^"

addons/dexie-cloud/src/WSObservable.ts

@@ -7,14 +7,16 @@ import type { YClientMessage, YServerMessage } from 'dexie-cloud-common';
 import { DexieCloudDB } from './db/DexieCloudDB';
 import { createYClientUpdateObservable } from './yjs/createYClientUpdateObservable';
 import { applyYServerMessages } from './yjs/applyYMessages';
-import { DexieYProvider, Table, YSyncState } from 'dexie';
-import { getAwarenessLibrary, getDocAwareness } from './yjs/awareness';
+import { Table } from 'dexie';
+import { getDocAwareness } from './yjs/awareness';
+import * as awap from 'y-protocols/awareness';
 import { encodeYMessage, decodeYMessage } from 'dexie-cloud-common';
 import { UserLogin } from './dexie-cloud-client';
 import { isEagerSyncDisabled } from './isEagerSyncDisabled';
 import { getOpenDocSignal } from './yjs/reopenDocSignal';
 import { getUpdatesTable } from './yjs/getUpdatesTable';
 import { DEXIE_CLOUD_SYNCER_ID } from './sync/DEXIE_CLOUD_SYNCER_ID';
+import { DexieYProvider, YSyncState } from 'y-dexie';
 
 const SERVER_PING_TIMEOUT = 20000;
 const CLIENT_PING_INTERVAL = 30000;
@@ -324,7 +326,6 @@ export class WSConnection extends Subscription {
           if (doc) {
             const awareness = getDocAwareness(doc);
             if (awareness) {
-              const awap = getAwarenessLibrary(this.db);
               awap.applyAwarenessUpdate(
                 awareness,
                 msg.u,

addons/dexie-cloud/src/define-ydoc-trigger.ts

@@ -1,13 +1,11 @@
 import Dexie, {
-  DexieYProvider,
   RangeSet,
-  type YjsLib,
-  type YUpdateRow,
   type DBCore,
   type Middleware,
   type Table,
-  type YjsDoc,
 } from 'dexie';
+import { DexieYProvider, YUpdateRow } from 'y-dexie';
+import type { Doc as YjsDoc } from 'yjs';
 
 const ydocTriggers: {
   [ydocTable: string]: {

addons/dexie-cloud/src/dexie-cloud-client.ts

@@ -49,6 +49,7 @@ import { logout, _logout } from './authentication/logout';
 import { loadAccessToken } from './authentication/authenticate';
 import { isEagerSyncDisabled } from './isEagerSyncDisabled';
 import { createYHandler } from "./yjs/createYHandler";
+import { DexieYProvider } from 'y-dexie';
 export { DexieCloudTable } from './DexieCloudTable';
 export * from './getTiedRealmId';
 export {
@@ -393,9 +394,9 @@ export function dexieCloud(dexie: Dexie) {
       ]));
 
       const yHandler = createYHandler(db);
-      db.dx.on('y', yHandler);
+      DexieYProvider.on.new.subscribe(yHandler);
       db.dx.once('close', () => {
-        db.dx.on.y?.unsubscribe(yHandler);
+        DexieYProvider.on.new.unsubscribe(yHandler);
       });
     }
 
@@ -504,6 +505,4 @@ dexieCloud.version = __VERSION__;
 
 Dexie.Cloud = dexieCloud;
 
-//Dexie.addons.push(dexieCloud);
-
 export default dexieCloud;

addons/dexie-cloud/src/yjs/Y.ts

@@ -1,5 +1,4 @@
-import { YSyncState } from "dexie";
-
+import type { YSyncState } from 'y-dexie';
 export interface YDexieCloudSyncState extends YSyncState {
   //serverRev: string;
 }

addons/dexie-cloud/src/yjs/YDexieCloudSyncState.ts

@@ -1,3 +1,4 @@
-import { EntityTable, YUpdateRow } from "dexie";
+import { EntityTable } from "dexie";
+import type { YUpdateRow } from "y-dexie";
 
-export type YTable = EntityTable<YUpdateRow, "i">;
+export type YTable = EntityTable<YUpdateRow, "i">;

addons/dexie-cloud/src/yjs/YTable.ts

@@ -1,8 +1,9 @@
-import { cmp, DexieYProvider, InsertType, YSyncState, YUpdateRow } from 'dexie';
+import { cmp, InsertType } from 'dexie';
 import { DexieCloudDB } from '../db/DexieCloudDB';
 import { YServerMessage } from 'dexie-cloud-common';
 import { DEXIE_CLOUD_SYNCER_ID } from '../sync/DEXIE_CLOUD_SYNCER_ID';
 import { getUpdatesTable } from './getUpdatesTable';
+import { DexieYProvider, YSyncState, YUpdateRow } from 'y-dexie';
 
 export async function applyYServerMessages(
   yMessages: YServerMessage[],
@@ -91,7 +92,7 @@ export async function applyYServerMessages(
             m.prop
           );
           if (doc && !doc.isSynced) {
-            doc.emit('sync', [true]);
+            doc.emit('sync', [true, doc]);
           }
           break;
         }

addons/dexie-cloud/src/yjs/applyYMessages.ts

@@ -1,15 +1,5 @@
-import Dexie from "dexie";
-import { type DexieCloudDB } from "../db/DexieCloudDB";
+import type { Awareness } from 'y-protocols/awareness';
 
-export function getAwarenessLibrary(db: DexieCloudDB): typeof import ('y-protocols/awareness') {
-  if (!db.cloud.options?.awarenessProtocol) {
-    throw new Dexie.MissingAPIError('awarenessProtocol was not provided to db.cloud.configure(). Please import * as awarenessProtocol from "y-protocols/awareness".');
-  }
-  return db.cloud.options?.awarenessProtocol;
-}
-
-export const awarenessWeakMap = new WeakMap<any, import('y-protocols/awareness').Awareness>();
+export const awarenessWeakMap = new WeakMap<any, Awareness>();
 
 export const getDocAwareness = (doc: any) => awarenessWeakMap.get(doc);
-
-