Merge pull request #2045 from dexie/support-yjs-dexie-cloud

Support yjs in dexie-cloud-addon

Author: dfahlander

.github/workflows/main.yml

@@ -47,5 +47,5 @@ jobs:
       - name: Run headless test
         uses: coactions/setup-xvfb@v1
         with:
-          run: bash ./gh-actions.sh
+          run: bash -e ./gh-actions.sh
           working-directory: ${{ matrix.TF }}

addons/Dexie.Observable/package.json

@@ -81,11 +81,11 @@
   },
   "homepage": "https://dexie.org",
   "peerDependencies": {
-    "dexie": "workspace:^3.0.2 || ^4.0.1"
+    "dexie": "workspace:^"
   },
   "devDependencies": {
     "@types/node": "^18.11.18",
-    "dexie": "workspace:^3.0.2 || ^4.0.1",
+    "dexie": "workspace:^",
     "eslint": "^7.27.0",
     "just-build": "^0.9.24",
     "qunit": "^2.9.2",

addons/Dexie.Syncable/package.json

@@ -74,11 +74,11 @@
   },
   "homepage": "https://dexie.org",
   "peerDependencies": {
-    "dexie": "workspace:^3.0.2 || ^4.0.1",
+    "dexie": "workspace:^",
     "dexie-observable": "workspace:^"
   },
   "devDependencies": {
-    "dexie": "workspace:^3.0.2 || ^4.0.1",
+    "dexie": "workspace:^",
     "dexie-observable": "workspace:^",
     "eslint": "^5.16.0",
     "just-build": "^0.9.24",

addons/dexie-cloud/README.md

@@ -0,0 +1,57 @@
+The web client for [Dexie Cloud](https://dexie.org/cloud/).
+
+## Getting started
+
+```
+npm install dexie@latest
+npm install dexie-cloud-addon@latest
+```
+
+```ts
+import Dexie from 'dexie';
+import dexieCloud from 'dexie-cloud-addon';
+
+const db = new Dexie('dbname', { addons: [dexieCloud]});
+
+db.version(1).stores({
+    yourTable: '@primKeyProp, indexedProp1, indexedProp2, ...'
+});
+
+db.cloud.configure({
+  databaseUrl: 'https://<yourdb>.dexie.cloud'
+})
+```
+
+## See also
+
+https://dexie.org/cloud/docs/dexie-cloud-addon#api
+
+## Obtaining a database URL
+
+Run the following command in a console / terminal:
+
+```
+npx dexie-cloud create
+```
+
+See also https://dexie.org/cloud/#getting-started
+
+*Having problems getting started, please [file an issue](https://github.com/dexie/Dexie.js/issues/new)*
+
+# The Cloud Service
+
+[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v2/monitor/jist.svg)](https://www.dexie-cloud-status.com)
+
+The official production service for Dexie Cloud Server is forever free of charge so you do not need to install any server to get started. The free service has some limits, see https://dexie.org/cloud/pricing
+
+# On-Prem version
+
+Dexie Cloud Server is a closed source software that can be purchased and installed on own hardware, see [On-Prem Silver / On-Prem Gold](https://dexie.org/cloud/pricing)
+
+# CLI
+
+See https://dexie.org/cloud/docs/cli
+
+# APIs
+
+See https://dexie.org/cloud/docs/dexie-cloud-api

addons/dexie-cloud/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dexie-cloud-addon",
-  "version": "4.0.11",
+  "version": "4.1.0-beta.45",
   "description": "Dexie addon that syncs with to Dexie Cloud",
   "main": "dist/umd/dexie-cloud-addon.js",
   "type": "module",
@@ -52,7 +52,7 @@
   },
   "scripts": {
     "test": "just-build test && pnpm run test-unit",
-    "test-unit": "karma start test/unit/karma.conf.js --single-run",
+    "test-unit": "karma start test/unit/karma.conf.cjs --single-run",
     "build": "rollup -c tools/build-configs/rollup.config.mjs",
     "watch": "rollup -c tools/build-configs/rollup.config.mjs --watch",
     "clean": "rm -rf tools/tmp dist test/unit/bundle.*"
@@ -78,20 +78,21 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.5",
     "@types/node": "^18.11.18",
-    "dreambase-library": "^1.0.21",
+    "dreambase-library": "^1.0.23",
     "just-build": "*",
     "karma": "*",
     "karma-chrome-launcher": "*",
     "karma-firefox-launcher": "*",
     "karma-qunit": "*",
+    "lib0": "^0.2.97",
     "preact": "*",
     "rollup": "^4.1.4",
     "terser": "^5.20.0",
     "tslib": "*",
-    "typescript": "^5.3.3"
+    "typescript": "^5.6.3"
   },
   "dependencies": {
-    "dexie-cloud-common": "^1.0.31",
+    "dexie-cloud-common": "workspace:^",
     "rxjs": "^7.x"
   },
   "peerDependencies": {

addons/dexie-cloud/src/DexieCloudOptions.ts

@@ -29,6 +29,10 @@ export interface DexieCloudOptions {
   // not be synced with Dexie Cloud
   unsyncedTables?: string[];
 
+  unsyncedProperties?: {
+    [tableName: string]: string[];
+  }
+
   // By default Dexie Cloud will suffix the cloud DB ID to your IndexedDB database name
   // in order to ensure that the local database is uniquely tied to the remote one and
   // will use another local database if databaseURL is changed or if dexieCloud addon
@@ -52,4 +56,6 @@ export interface DexieCloudOptions {
     public_key: string;
     hints?: { userId?: string; email?: string };
   }) => Promise<TokenFinalResponse>;
+
+  awarenessProtocol?: typeof import('y-protocols/awareness');
 }

addons/dexie-cloud/src/PermissionChecker.ts

@@ -42,6 +42,7 @@ export class PermissionChecker<T, TableNames extends string = TableName<T>> {
     // If user can update any prop in any table in this realm, return true unless
     // it regards to ownership change:
     if (this.permissions.update === '*') {
+      // @ts-ignore
       return props.every((prop) => prop !== 'owner');
     }
     const tablePermissions = this.permissions.update?.[this.tableName];

addons/dexie-cloud/src/TSON.ts

@@ -4,6 +4,7 @@ import undefinedDef from 'dreambase-library/dist/typeson-simplified/types/undefi
 import tsonBuiltinDefs from 'dreambase-library/dist/typeson-simplified/presets/builtin.js';
 import { TypeDefSet } from 'dreambase-library/dist/typeson-simplified/TypeDefSet';
 import { PropModSpec, PropModification } from 'dexie';
+import FileDef from "dreambase-library/dist/typeson-simplified/types/File.js";
 
 // Since server revisions are stored in bigints, we need to handle clients without
 // bigint support to not fail when serverRevision is passed over to client.
@@ -71,6 +72,7 @@ const bigIntDef = hasBigIntSupport
 const defs: TypeDefSet = {
   ...undefinedDef,
   ...bigIntDef,
+  ...FileDef,
   PropModification: {
     test: (val: any) => val instanceof PropModification,
     replace: (propModification: any) => {