@sqlite-sync/devtools 0.4.0 → 0.4.2
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 +46 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @sqlite-sync/devtools
|
|
2
|
+
|
|
3
|
+
Embeddable browser devtools for [sqlite-sync](https://github.com/krolebord-dev/sqlite-sync) — a local-first SQLite sync engine for web apps, with reactive queries, offline persistence, and CRDT-based replication.
|
|
4
|
+
|
|
5
|
+
This package renders a floating **SQLite Sync** button that opens a dialog with a sidebar, database selector, and query tooling for inspecting databases registered through [`@sqlite-sync/core`](https://www.npmjs.com/package/@sqlite-sync/core).
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
pnpm add @sqlite-sync/devtools
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Quick start
|
|
14
|
+
|
|
15
|
+
```tsx
|
|
16
|
+
import { SQLiteSyncDevtools } from "@sqlite-sync/devtools";
|
|
17
|
+
|
|
18
|
+
export function AppShell() {
|
|
19
|
+
return (
|
|
20
|
+
<>
|
|
21
|
+
<App />
|
|
22
|
+
<SQLiteSyncDevtools />
|
|
23
|
+
</>
|
|
24
|
+
);
|
|
25
|
+
}
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Database instances register automatically when `createSyncedDb()` completes and unregister on `dispose()`, so mounting the component once near the app root is enough.
|
|
29
|
+
|
|
30
|
+
Query runner rules:
|
|
31
|
+
|
|
32
|
+
- Worker DB queries are read-only.
|
|
33
|
+
- Memory DB queries may write only to CRDT tables.
|
|
34
|
+
- The UI executes a single SQL statement at a time and shows raw JSON results.
|
|
35
|
+
|
|
36
|
+
## Requirements
|
|
37
|
+
|
|
38
|
+
- Peer dependency: `react` (`^18 || ^19`).
|
|
39
|
+
|
|
40
|
+
## Documentation
|
|
41
|
+
|
|
42
|
+
See the [full documentation](https://github.com/krolebord-dev/sqlite-sync/blob/main/docs.md) and the [project README](https://github.com/krolebord-dev/sqlite-sync).
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sqlite-sync/devtools",
|
|
3
|
-
"version": "0.4.
|
|
3
|
+
"version": "0.4.2",
|
|
4
4
|
"description": "Embeddable devtools for @sqlite-sync",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"dist"
|
|
31
31
|
],
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"@sqlite-sync/core": "0.4.
|
|
33
|
+
"@sqlite-sync/core": "0.4.2"
|
|
34
34
|
},
|
|
35
35
|
"peerDependencies": {
|
|
36
36
|
"react": "^18.0.0 || ^19.0.0"
|