@rozenite/sqlite-plugin 1.7.0-rc.0

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# @rozenite/sqlite-plugin
+
+## 1.6.0
+
+- Initial release.
+- Added adapter-driven SQLite inspection for Rozenite.
+- Added an `expo-sqlite` adapter and query-first runtime bridge.
+- Added Browse, Schema, and Query views for registered databases.

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 Szymon Chmal
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,102 @@
+![rozenite-banner](https://www.rozenite.dev/rozenite-banner.jpg)
+
+### A Rozenite plugin for inspecting SQLite databases in React Native DevTools.
+
+The SQLite Plugin provides a query-first inspector for registered SQLite databases. It ships with an `expo-sqlite` adapter and supports custom adapters for any SQLite-like library that can execute ordered SQL statements and return normalized metadata for each statement.
+
+![SQLite Plugin](https://rozenite.dev/sqlite-plugin.png)
+
+## Installation
+
+```bash
+npm install @rozenite/sqlite-plugin
+```
+
+Optional peer for the built-in Expo adapter:
+
+```bash
+npm install expo-sqlite
+```
+
+## Usage
+
+```ts
+import * as SQLite from 'expo-sqlite';
+import {
+  createExpoSqliteAdapter,
+  useRozeniteSqlitePlugin,
+} from '@rozenite/sqlite-plugin';
+
+const adapters = __DEV__
+  ? [
+      createExpoSqliteAdapter({
+        adapterName: 'Expo SQLite',
+        databases: {
+          app: {
+            name: 'app.db',
+            database: SQLite.openDatabaseSync('app.db'),
+          },
+          analytics: {
+            name: 'analytics.db',
+            database: SQLite.openDatabaseSync('analytics.db'),
+          },
+        },
+      }),
+    ]
+  : [];
+
+function App() {
+  useRozeniteSqlitePlugin({ adapters });
+
+  return <YourApp />;
+}
+```
+
+## Custom adapters
+
+You can support any SQLite-like library by normalizing its statement execution API:
+
+```ts
+import { createSqliteAdapter } from '@rozenite/sqlite-plugin';
+
+const adapters = [
+  createSqliteAdapter({
+    adapterName: 'My SQLite Driver',
+    databases: {
+      main: {
+        name: 'main.db',
+        executeStatements: async (statements) => {
+          const results = [];
+
+          for (const statement of statements) {
+            const result = await driver.query(statement.sql, statement.params);
+
+            results.push({
+              rows: result.rows,
+              columns: result.columns,
+              metadata: {
+                statementType: result.statementType,
+                rowCount: result.rows.length,
+                changes: result.changes,
+                lastInsertRowId: result.lastInsertRowId,
+                durationMs: result.durationMs,
+              },
+            });
+          }
+
+          return results;
+        },
+      },
+    },
+  }),
+];
+```
+
+## Notes
+
+- Register adapters in development only. The hook no-ops in production, but your app-level database setup should still stay behind `__DEV__`.
+- The SQL editor executes multi-statement scripts in order and stops on the first error.
+- Custom adapters receive the full ordered statement array for scripts. To preserve per-statement failure details, throw an error enriched with `completedResults` and `failedStatementIndex`.
+- Explicit `BEGIN`, `COMMIT`, and `ROLLBACK` statements are preserved as written. The plugin does not wrap scripts in an implicit transaction.
+- The UI derives tables, schema, and browse views from SQL and `PRAGMA` queries.
+- Database display names are shown in the panel; opaque IDs are generated internally.