@sqlite-sync/devtools 0.3.0 → 0.4.1

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/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 sqlite-sync contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
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/dist/index.d.ts CHANGED
@@ -1,8 +1,8 @@
1
- import * as react_jsx_runtime from 'react/jsx-runtime';
1
+ import * as react from 'react';
2
2
 
3
3
  type SQLiteSyncDevtoolsProps = {
4
4
  className?: string;
5
5
  };
6
- declare function SQLiteSyncDevtools({ className }: SQLiteSyncDevtoolsProps): react_jsx_runtime.JSX.Element;
6
+ declare function SQLiteSyncDevtools({ className }: SQLiteSyncDevtoolsProps): react.JSX.Element;
7
7
 
8
8
  export { SQLiteSyncDevtools };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sqlite-sync/devtools",
3
- "version": "0.3.0",
3
+ "version": "0.4.1",
4
4
  "description": "Embeddable devtools for @sqlite-sync",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -30,16 +30,16 @@
30
30
  "dist"
31
31
  ],
32
32
  "dependencies": {
33
- "@sqlite-sync/core": "0.3.0"
33
+ "@sqlite-sync/core": "0.4.1"
34
34
  },
35
35
  "peerDependencies": {
36
36
  "react": "^18.0.0 || ^19.0.0"
37
37
  },
38
38
  "devDependencies": {
39
- "@types/react": "^19.2.9",
40
- "react": "^19.2.3",
39
+ "@types/react": "^19.2.17",
40
+ "react": "^19.2.7",
41
41
  "tsup": "^8.3.5",
42
- "typescript": "~5.9.3"
42
+ "typescript": "~6.0.3"
43
43
  },
44
44
  "scripts": {
45
45
  "build": "tsup",