Initial JSONB support for typed_sql.

Author: isoos

typed_sql/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.1.4
+ * Initial support for `JSONB` columns with `JsonValue` wrapper.
+
 ## 0.1.3
  * Added `TransactionAbortedException.toString()` to render the `reason` when
    printing an exception.

typed_sql/lib/src/adapter/adapter.dart

@@ -320,6 +320,17 @@ abstract base class RowReader {
   /// Throws [AssertionError], if the type is not [Uint8List].
   Uint8List? readUint8List();
 
+  /// Read [JsonValue] or `null`.
+  ///
+  /// Throws [AssertionError], if the type is not [JsonValue].
+  JsonValue? readJsonValue();
+
   /// Return `true` and consume next column, if next column is `null`.
   bool tryReadNull();
 }
+
+class JsonValue {
+  final Object? value;
+
+  JsonValue(this.value);
+}

typed_sql/lib/src/adapter/postgres_adapter.dart

@@ -439,6 +439,19 @@ final class _PostgresRowReader extends RowReader {
     return value;
   }
 
+  @override
+  JsonValue? readJsonValue() {
+    final value = _row[_i++];
+    if (value == null ||
+        value is bool ||
+        value is num ||
+        value is List ||
+        value is Map) {
+      return JsonValue(value);
+    }
+    throw AssertionError('readJsonValue() expected a JSON type, got "$value"');
+  }
+
   @override
   bool tryReadNull() {
     if (_row[_i] == null) {
@@ -462,6 +475,7 @@ List<Object?> _paramsForPostgres(List<Object?> params) => params
           int i => i,
           double d => d,
           Uint8List u => TypedValue(Type.byteArray, u, isSqlNull: false),
+          JsonValue v => TypedValue(Type.jsonb, v.value, isSqlNull: false),
           _ => throw UnsupportedError('Unsupported type: ${p.runtimeType}'),
         })
     .toList();

typed_sql/lib/src/adapter/sqlite_adapter.dart

@@ -417,6 +417,19 @@ final class _SqliteRowReader extends RowReader {
     return value;
   }
 
+  @override
+  JsonValue? readJsonValue() {
+    final value = jsonb.decode(_row.values[_i++] as Uint8List);
+    if (value == null ||
+        value is bool ||
+        value is num ||
+        value is List ||
+        value is Map) {
+      return JsonValue(value);
+    }
+    throw AssertionError('readJsonValue() expected a JSON type, got "$value"');
+  }
+
   @override
   bool tryReadNull() {
     if (_row.values[_i] == null) {
@@ -436,6 +449,7 @@ List<Object?> _paramsForSqlite(List<Object?> params) => params
           int i => i,
           double d => d,
           Uint8List u => u,
+          JsonValue v => jsonb.encode(v.value),
           _ => throw UnsupportedError('Unsupported type: ${p.runtimeType}'),
         })
     .toList();

typed_sql/lib/src/codegen/build_code.dart

@@ -290,6 +290,7 @@ Iterable<Spec> buildTable(ParsedTable table, ParsedSchema schema) sync* {
       'bool' => '$rowReader.readBool()',
       'DateTime' => '$rowReader.readDateTime()',
       'Uint8List' => '$rowReader.readUint8List()',
+      'JsonValue' => '$rowReader.readJsonValue()',
       _ => throw UnsupportedError(
           'Unsupported type "${field.typeName}"',
         ),
@@ -1155,6 +1156,7 @@ String backingExprType(String backingType) {
     'bool' => 'ExposedForCodeGen.boolean',
     'DateTime' => 'ExposedForCodeGen.dateTime',
     'Uint8List' => 'ExposedForCodeGen.blob',
+    'JsonValue' => 'ExposedForCodeGen.jsonValue',
     _ => throw UnsupportedError(
         'Unsupported backingType: "$backingType"',
       ),

typed_sql/lib/src/codegen/parse_library.dart

@@ -509,6 +509,12 @@ String? _tryGetColumnType(DartType t) {
     return 'DateTime';
   } else if (uint8ListTypeChecker.isExactlyType(t)) {
     return 'Uint8List';
+  } else if (t.toString().contains('JsonValue') &&
+      (t.element3
+              ?.getExtendedDisplayName2()
+              .contains('/typed_sql/lib/src/adapter/adapter.dart') ??
+          false)) {
+    return 'JsonValue';
   }
   return null;
 }

typed_sql/lib/src/dialect/postgres_dialect.dart

@@ -16,6 +16,7 @@ import 'dart:typed_data';
 
 import 'package:collection/collection.dart';
 
+import '../adapter/adapter.dart' show JsonValue;
 import 'dialect.dart';
 
 SqlDialect postgresDialect() => _PostgresDialect();
@@ -580,6 +581,7 @@ extension on ColumnType {
         ColumnType<int> _ => 'BIGINT',
         ColumnType<double> _ => 'DOUBLE PRECISION',
         ColumnType<String> _ => 'TEXT',
+        ColumnType<JsonValue> _ => 'JSONB',
         ColumnType<Null> _ => throw UnsupportedError(
             'Null type cannot be used as column type',
           ),

typed_sql/lib/src/dialect/sqlite_dialect.dart

@@ -16,6 +16,7 @@ import 'dart:typed_data' show Uint8List;
 
 import 'package:collection/collection.dart';
 
+import '../adapter/adapter.dart' show JsonValue;
 import 'dialect.dart';
 
 SqlDialect sqliteDialect() => _Sqlite();
@@ -550,6 +551,7 @@ extension on ColumnType {
         ColumnType<int> _ => 'INTEGER',
         ColumnType<double> _ => 'REAL',
         ColumnType<String> _ => 'TEXT',
+        ColumnType<JsonValue> _ => 'JSONB',
         ColumnType<Null> _ => throw UnsupportedError(
             'Null type cannot be used as column type',
           ),

typed_sql/lib/src/typed_sql.dart

@@ -232,4 +232,5 @@ final class ExposedForCodeGen {
   static const ColumnType<double> real = ColumnType.real;
   static const ColumnType<String> text = ColumnType.text;
   static const ColumnType<Null> nullType = ColumnType.nullType;
+  static const ColumnType<JsonValue> jsonValue = ColumnType.jsonValue;
 }

typed_sql/lib/src/typed_sql.expr.dart

@@ -37,6 +37,7 @@ sealed class ColumnType<T extends Object?> extends FieldType<T> {
   static const ColumnType<double> real = _RealExprType._();
   static const ColumnType<String> text = _TextExprType._();
   static const ColumnType<Null> nullType = _NullExprType._();
+  static const ColumnType<JsonValue> jsonValue = _JsonValueExprType._();
 }
 
 final class _BlobExprType extends ColumnType<Uint8List> {
@@ -81,6 +82,13 @@ final class _TextExprType extends ColumnType<String> {
   String? _read(RowReader r) => r.readString();
 }
 
+final class _JsonValueExprType extends ColumnType<JsonValue> {
+  const _JsonValueExprType._() : super._();
+
+  @override
+  JsonValue? _read(RowReader r) => r.readJsonValue();
+}
+
 final class _NullExprType extends ColumnType<Null> {
   const _NullExprType._() : super._();
 
@@ -485,6 +493,8 @@ final class Literal<T> extends SingleValueExpr<T> {
         return Literal._(value, ColumnType.blob as _ExprType<T>);
       case DateTime _:
         return Literal._(value, ColumnType.dateTime as _ExprType<T>);
+      case JsonValue _:
+        return Literal._(value, ColumnType.jsonValue as _ExprType<T>);
 
       case CustomDataType _:
         throw ArgumentError.value(

typed_sql/lib/typed_sql.dart

@@ -22,7 +22,7 @@
 /// See topic on _schema defintion_ for how to get started.
 library;
 
-export 'src/adapter/adapter.dart' show DatabaseAdapter, RowReader;
+export 'src/adapter/adapter.dart' show DatabaseAdapter, JsonValue, RowReader;
 export 'src/dialect/dialect.dart' show SqlDialect;
 export 'src/exceptions.dart' hide throwTransactionAbortedException;
 export 'src/typed_sql.dart'

typed_sql/pubspec.yaml

@@ -1,5 +1,5 @@
 name: typed_sql
-version: 0.1.3
+version: 0.1.4
 description: Package for doing SQL with some type safety.
 homepage: https://github.com/google/dart-neats/tree/master/typed_sql
 repository: https://github.com/google/dart-neats.git