supabase / supabase-flutter / 31083019160

89%

Build Type

push

github

Committed by web-flow

Commit Message

refactor!: singularize plural enum names and fold enum extensions in (#1654)

Closes #1652

## What

A Dart enum type names one value rather than the set, so its name should
be singular. Five enums were ports of `realtime-js` / `gotrue-js` names
instead:

| Before | After | Was reachable by consumers? |
| --- | --- | --- |
| `ChannelStates` | `ChannelState` | No (omitted from the `show` list) |
| `ChannelEvents` | `ChannelEvent` | No (omitted from the `show` list) |
| `RealtimeListenTypes` | `RealtimeListenType` | No (named in the `hide`
clause) |
| `PostgresTypes` | `PostgresType` | Yes |
| `AuthenticatorAssuranceLevels` | `AuthenticatorAssuranceLevel` | Yes |

The three unreachable ones are now annotated `@internal`, which is both
the accurate annotation and enough to keep them out of the capability
matrix scan.

Sweeping the rest of the monorepo's 51 enums turned up one more name
that did not read as a noun naming a single value: `LoadTableSnapshots`
(storage, Iceberg) is now `TableSnapshotScope`.

## Enum extensions folded in

Enums can declare methods and static methods directly, so every
extension that only existed to hang helpers off an enum is now part of
the enum:

- `ChannelEventsExtended` → `ChannelEvent.fromType` /
`ChannelEvent.eventName`
- `ToType` → `RealtimeListenType.toType`
- `PostgresChangeEventMethods` → `PostgresChangeEvent.fromString` /
`PostgresChangeEvent.toRealtimeEvent`
- `PresenceEventExtended` → `PresenceEvent.fromString`
- `AuthChangeEventExtended` → `AuthChangeEvent.fromString`
- `GenerateLinkTypeExtended` → `GenerateLinkType.fromString`

Those helpers decode wire values, so the folded members carry
`@internal`, matching the visibility the extensions already had through
the `hide` clauses. The now-unnecessary `hide` entries are dropped from
the gotrue and realtime_client exports.

`SupabaseEventTypesName` is deliberately left alone: its member is
`name()`, which would shadow `Enum.name` if declared on the enum, and
both i... (continued)

Coverage Stats

73 of 75 new or added lines in 10 files covered. (97.33%)

32 existing lines in 4 files now uncovered.

5588 of 6411 relevant lines covered (87.16%)

4.04 hits per line