@revealui/sync 0.3.1 → 0.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -0
- package/package.json +3 -4
package/README.md
CHANGED
|
@@ -182,6 +182,20 @@ pnpm --filter @revealui/sync test # Run tests
|
|
|
182
182
|
pnpm --filter @revealui/sync typecheck # Type check
|
|
183
183
|
```
|
|
184
184
|
|
|
185
|
+
## When to Use This
|
|
186
|
+
|
|
187
|
+
- You need real-time data sync between your database and React UI via ElectricSQL
|
|
188
|
+
- You want CRDT-based collaborative editing (Yjs) for multi-user document workflows
|
|
189
|
+
- You need React hooks that subscribe to live database changes with automatic mutation support
|
|
190
|
+
- **Not** for batch data loading or static pages — use server components with `@revealui/db` directly
|
|
191
|
+
- **Not** for offline-first mobile apps — ElectricSQL targets web clients with persistent connections
|
|
192
|
+
|
|
193
|
+
## JOSHUA Alignment
|
|
194
|
+
|
|
195
|
+
- **Adaptive**: Shape subscriptions dynamically sync only the data your component needs — scales from one user to many
|
|
196
|
+
- **Sovereign**: Sync runs through your own CMS proxy and PostgreSQL — no third-party real-time service required
|
|
197
|
+
- **Hermetic**: All mutations go through authenticated REST endpoints; ElectricSQL replication is read-only on the client
|
|
198
|
+
|
|
185
199
|
## License
|
|
186
200
|
|
|
187
201
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@revealui/sync",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.4",
|
|
4
4
|
"description": "ElectricSQL sync utilities for RevealUI",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"dependencies": {
|
|
@@ -9,13 +9,12 @@
|
|
|
9
9
|
"ws": "^8.18.0",
|
|
10
10
|
"y-protocols": "^1.0.7",
|
|
11
11
|
"yjs": "^13.6.29",
|
|
12
|
-
"@revealui/
|
|
13
|
-
"@revealui/
|
|
12
|
+
"@revealui/contracts": "1.3.4",
|
|
13
|
+
"@revealui/db": "0.3.4"
|
|
14
14
|
},
|
|
15
15
|
"devDependencies": {
|
|
16
16
|
"@testing-library/jest-dom": "^6.6.4",
|
|
17
17
|
"@testing-library/react": "^16.3.0",
|
|
18
|
-
"@testing-library/react-hooks": "^8.0.1",
|
|
19
18
|
"@types/ws": "^8.5.14",
|
|
20
19
|
"@vitest/coverage-v8": "^4.1.0",
|
|
21
20
|
"jsdom": "^29.0.1",
|