Merge pull request #1 from solid-software/dart-package

init dart package

Author: illia-romanenko

.gitignore

@@ -0,0 +1,2 @@
+.dart_tool
+pubspec.lock

CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+- Initial version.

README.md

@@ -0,0 +1,44 @@
+# deno_postgres_interop
+[![style: solid](https://img.shields.io/badge/style-solid-orange)](https://pub.dev/packages/solid_lints)
+[![$solid_lints](https://nokycucwgzweensacwfy.supabase.co/functions/v1/get_project_badge?projectName=deno_postgres_interop)](https://www.worklog.ai)
+
+The package allows the use
+of [Deno Postgres](https://deno.land/x/postgres)
+in [Deno Deploy](https://deno.com/deploy)
+on [dart_edge](https://docs.dartedge.dev/)
+by creating interop bindings for the js library
+since other drivers rely on dart:io and don't work there.
+
+The main scenario is Supabase Edge Functions, but it should also work for other cases with dart2js.
+
+## Usage with Supabase edge functions
+1. Add dependency in your pubspec.yaml:
+   ```yaml
+   dependencies:
+     deno_postgres_interop: <INSERT LATEST VERSION>
+   ```
+
+   or run
+
+   ```bash
+   dart pub add deno_postgres_interop
+   ```
+
+2. Import the package:
+   ```dart
+   import 'package:deno_postgres_interop/deno_postgres_interop.dart';
+   ```
+
+3. Compile the code that uses this package with:
+   ```bash
+   dart run edge build supabase_functions
+   ```
+
+4. Add imports to generated file by calling the script:
+   ```bash
+   dart run tools/add_imports/bin/add_imports.dart
+     --filename=example/functions/dart_edge/main.dart.js
+   ```
+   Note: your filename may differ from the example
+
+5. You can use the function now.

add_imports.yaml

@@ -0,0 +1,9 @@
+file_url_prefix: 'https://deno.land/x/[email protected]/'
+
+classes_map:
+  'query/query.ts':
+    - QueryObjectResult
+  'mod.ts':
+    - QueryClient
+    - Client
+    - Transaction

analysis_options.yaml

@@ -0,0 +1,7 @@
+include: package:solid_lints/analysis_options.yaml
+
+linter:
+  rules:
+    package_api_docs: true
+    prefer_foreach: true
+    prefer_single_quotes: true

example/.gitignore

@@ -0,0 +1,4 @@
+.dart_tool
+.packages
+build
+functions/dart_edge

example/analysis_options.yaml

@@ -0,0 +1,7 @@
+include: package:solid_lints/analysis_options.yaml
+
+linter:
+  rules:
+    public_member_api_docs: false
+    prefer_foreach: true
+    prefer_single_quotes: true

example/lib/main.dart

@@ -0,0 +1,32 @@
+import 'package:deno_postgres_interop/deno_postgres_interop.dart';
+import 'package:supabase_functions/supabase_functions.dart';
+
+void main() => SupabaseFunctions(fetch: fetch);
+
+Future<Response> fetch(Request _) async {
+  final dbUrl = Deno.env.get('SUPABASE_DB_URL');
+  if (dbUrl == null) return Response.error();
+
+  final client = Client(dbUrl);
+  await client.connect();
+  final result = await client.transaction('transaction', transaction);
+  await client.end();
+
+  return Response(result.rows.map(rowToPrettyString).join('\n\n'));
+}
+
+Future<QueryObjectResult<dynamic>> transaction(Transaction transaction) async {
+  await transaction.queryObject(
+    'UPDATE public."User" '
+    "SET username='user${transaction.hashCode}' "
+    "WHERE last_name='user'",
+  );
+  await Future.delayed(const Duration(seconds: 10));
+
+  return transaction.queryObject('SELECT * FROM public."User"');
+}
+
+String rowToPrettyString(Map<String, dynamic> row) => row
+    .toString()
+    .replaceAll(', ', '\n')
+    .replaceAllMapped(RegExp(r'\{|\}'), (_) => '');

example/pubspec.yaml

@@ -0,0 +1,16 @@
+name: deno_postgres_interop_example
+description: An example for deno_postgres_interop package.
+version: 1.0.0
+publish_to: none
+
+environment:
+  sdk: ^3.0.0
+
+dependencies:
+  deno_postgres_interop:
+    path: ..
+  edge: ^0.0.5
+  supabase_functions: ^0.0.1
+
+dev_dependencies:
+  solid_lints: 0.0.19

lib/deno_postgres_interop.dart

@@ -0,0 +1,7 @@
+/// An interop for [[email protected]](https://deno.land/x/[email protected]).
+library;
+
+export 'src/client.dart';
+export 'src/query_client.dart';
+export 'src/query_object_result.dart';
+export 'src/transaction.dart';