supabase / supabase-flutter / 33490731163

89%

push

github

feat: add typed table access with PostgrestTable and TableColumn (#1634)

## What kind of change does this PR introduce?

Feature (draft for design discussion). This is layer 1 of a plan to make
query results type-safe so users never have to handle `Map<String,
dynamic>`. It adds the runtime primitives to `postgrest` and `supabase`;
a schema code generator that emits row extension types, table
definitions and column tokens is a possible follow-up (layer 2), but
everything here is also usable hand-written.

## What is the current behavior?

Every query resolves to `PostgrestList`/`PostgrestMap` (raw `Map<String,
dynamic>` shapes). The only typing affordance is `withConverter`, which
can only be applied at the end of a chain, and filters, `stream()`, and
mutations are stringly typed throughout.

## What is the new behavior?

A typed, opt-in parallel surface next to the existing string-based API
(which is unchanged):

```dart
extension type Book(Map<String, dynamic> json) {
  int get id => json['id'] as int;
  String get title => json['title'] as String;
}

class Books {
  static const table = PostgrestTable('books', Book.new);
  static const id = TableColumn<int>('id');
  static const title = TableColumn<String>('title');
}

final List<Book> books = await supabase
    .table(Books.table)
    .select()
    .where(Books.id.gt(10))
    .where(Books.title.like('%Dart%'))
    .order(Books.title, ascending: true);

final Book book =
    await supabase.table(Books.table).insert({'title': 'foo'}).select().single();

supabase
    .table(Books.table)
    .stream(primaryKey: [Books.id])
    .filter(Books.status.eq(true))
    .listen((List<Book> books) { /* ... */ });
```

- `PostgrestTable<Row>` describes a table plus its row converter;
`client.table(...)` (on `PostgrestClient`, `SupabaseClient` and
`SupabaseQuerySchema`) is the typed counterpart of `from(...)`.
- `TableColumn<Value>` carries the column name and value type. Filter
methods live on the column (`Book... (continued)

323 of 379 new or added lines in 10 files covered. (85.22%)

6423 of 7258 relevant lines covered (88.5%)

4.47 hits per line