Prepare drift_sqlite for publishing

Author: simolus3

future/drift_sqlite/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0-alpha.0
+
+- Initial version.

future/drift_sqlite/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Simon Binder
+
+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.

future/drift_sqlite/README.md

@@ -0,0 +1,77 @@
+This package adds SQLite support for [drift](https://pub.dev/packages/drift), a
+reactive persistence library for Flutter and Dart.
+
+## Getting started
+
+> [!TIP]
+> For Flutter apps, consider using the [drift_flutter](https://pub.dev/packages/drift_flutter) package.
+> It is based on `drift_sqlite` and adds defaults to make the cross-platform setup easier.
+
+Begin by [setting up a drift database](https://drift.simonbinder.eu/setup/). Add
+a dependency on `drift_sqlite` to use it to open database connections:
+
+```dart
+import 'package:drift/drift.dart';
+import 'package:drift_sqlite/drift_sqlite.dart';
+
+void main() {
+  final db = ExampleDatabase(
+    // TODO: Platform-specific connection setup.
+  );
+}
+
+@DriftDatabase(tables: [Notes])
+final class ExampleDatabase extends _$ExampleDatabase {
+  ExampleDatabase(super.implementation);
+  // ...
+}
+```
+
+On native platforms, use `sqliteConnectionPool` to open a high-performance pool of SQLite
+connections:
+
+```dart
+// For native platforms
+final db = ExampleDatabase(sqliteConnectionPool(
+  file: File('test.db')
+));
+```
+
+On the web, download `sqlite3.wasm` and `drift_worker.js` from a [drift release](https://github.com/simolus3/drift/releases)
+into the `web/` directory of your app. Then, use this snippet to open databases:
+
+```dart
+// For the web
+final db = ExampleDatabase(DriftConnection(
+  dialect: SqliteDialect.new,
+  openConnection: () async {
+    final web = WebSqlite.open(
+      wasmModule: '/sqlite3.wasm',
+      workers: .defaultWorkers('/drift_worker.js'),
+      controller: WasmDatabase.driftDatabaseController(),
+    );
+    final db = await web.connectToRecommended('my_database_name');
+    return WasmDatabase.wrapDatabase(rawDb);
+  }
+));
+```
+
+## Sponsors
+
+Drift is proudly Sponsored by [Stream 💙](https://getstream.io/chat/sdk/flutter/?utm_source=Moor&utm_medium=Github_Repo_Content_Ad&utm_content=Developer&utm_campaign=Moor_July2022_FlutterChatSDK_klmh22) and [PowerSync](https://powersync.com/?utm_source=drift&utm_campaign=drift_sponsorship).
+
+<p align="center">
+<table>
+    <tbody>
+        <tr>
+            <td align="center">
+                <a href="https://getstream.io/chat/sdk/flutter/?utm_source=Moor&utm_medium=Github_Repo_Content_Ad&utm_content=Developer&utm_campaign=Moor_July2022_FlutterChatSDK_klmh22" target="_blank"><img width="250px" src="https://stream-blog.s3.amazonaws.com/blog/wp-content/uploads/fc148f0fc75d02841d017bb36e14e388/Stream-logo-with-background-.png"/></a><br/><span><a href="https://getstream.io/chat/sdk/flutter/?utm_source=Moor&utm_medium=Github_Repo_Content_Ad&utm_content=Developer&utm_campaign=Moor_July2022_FlutterChatSDK_klmh22" target="_blank">Try the Flutter Chat Tutorial &nbsp💬</a></span>
+            </td>
+            <td align="center">
+                <a href="https://powersync.com/?utm_source=drift&utm_campaign=drift_sponsorship" target="_blank"><img width="250px" src="https://powersync.com/images/brand/powersync-logo-light-bg.png"/></a><br/>
+                <span><a href="https://docs.powersync.com/integrations/supabase/guide?&utm_campaign=drift_sponsorship">Try PowerSync with Supabase</a></span>
+            </td>
+        </tr>
+    </tbody>
+</table>
+</p>

future/drift_sqlite/example/connection_native.dart

@@ -0,0 +1,7 @@
+import 'package:drift3_preview/drift.dart';
+import 'package:drift_sqlite/drift_sqlite.dart';
+import 'package:sqlite3/sqlite3.dart';
+
+Future<DriftSession> openConnection() async {
+  return SqliteConnection(sqlite3.openInMemory());
+}

future/drift_sqlite/example/connection_unsupported.dart

@@ -0,0 +1,5 @@
+import 'package:drift3_preview/drift.dart';
+
+Future<DriftSession> openConnection() async {
+  throw UnsupportedError('Example not supported on this platform');
+}

future/drift_sqlite/example/connection_web.dart

@@ -0,0 +1,16 @@
+import 'package:drift3_preview/drift.dart';
+import 'package:drift_sqlite/web.dart';
+import 'package:sqlite3_web/sqlite3_web.dart';
+
+Future<DriftSession> openConnection() async {
+  final web = WebSqlite.open(
+    wasmModule: 'https://cdn.jsdelivr.net/npm/sqlite3-web/assets/sqlite3.wasm',
+    // For a real setup, consider using a database with web workers for better
+    // performance and multi-tab support: https://drift.simonbinder.eu/platforms/web/
+    workers: .defaultWorkers(''),
+    controller: WasmDatabase.driftDatabaseController(),
+  );
+
+  final rawDb = await web.connect('memory', .inMemoryLocal);
+  return WasmDatabase.wrapDatabase(rawDb);
+}

future/drift_sqlite/example/main.dart

@@ -0,0 +1,41 @@
+import 'package:drift3_preview/drift.dart';
+import 'package:drift_sqlite/drift_sqlite.dart';
+
+import 'connection_unsupported.dart'
+    if (dart.library.js_interop) 'connection_web.dart'
+    if (dart.library.ffi) 'connection_native.dart';
+
+part 'main.g.dart';
+
+void main() async {
+  final db = ExampleDatabase(
+    DriftConnection(dialect: SqliteDialect.new, openConnection: openConnection),
+  );
+
+  final note = await db.createNote('Drift example!');
+  print('Created note: $note');
+
+  final query = db.notesQueries.all();
+  await for (final snapshot in query.watch()) {
+    print('Notes in database: $snapshot');
+  }
+}
+
+class Notes extends Table {
+  IntColumn get id => integer().autoIncrement();
+  TextColumn get contents => text();
+}
+
+@DriftDatabase(tables: [Notes])
+final class ExampleDatabase extends _$ExampleDatabase {
+  ExampleDatabase(super.implementation);
+
+  @override
+  int get schemaVersion => 1;
+
+  Future<Note> createNote(String contents) async {
+    return await into(
+      notes,
+    ).insertReturning(NotesCompanion.insert(contents: contents));
+  }
+}

future/drift_sqlite/example/main.g.dart

@@ -1,6 +1,6 @@
 name: drift_sqlite
 description: SQLite dialect for drift.
-version: 1.0.0-alpha.0
+version: 0.1.0-alpha.0
 repository: https://github.com/simolus3/drift
 homepage: https://drift.simonbinder.eu/
 issue_tracker: https://github.com/simolus3/drift/issues
@@ -10,8 +10,8 @@ environment:
   sdk: ^3.10.0
 
 dependencies:
-  drift:
-  drift3_preview:
+  drift: ^2.35.0
+  drift3_preview: ^3.0.0-alpha.0
   meta: ^1.16.0
   collection: ^1.18.0
   sqlite3: ^3.1.6