supabase / supabase-flutter / 32032620092

89%

push

github

chore!: give each package's Constants class a package-specific name (#1677)

Stacked on #1673, addressing
https://github.com/supabase/supabase-flutter/pull/1673#discussion_r3747503513.

## Why

Six packages declared a class named `Constants`: `functions_client`,
`gotrue`, `realtime_client`, `storage_client`, `supabase` and
`supabase_flutter`. The capability matrix keys symbols by bare name, so
an entry like `Constants.defaultHeaders` could not say which package it
meant. The same ambiguity applies to anyone reading the code across
packages.

## What changed

Each class is named after its package, and the file declaring it is
named to match:

| Package | Class | File |
|---|---|---|
| `functions_client` | `FunctionsConstants` |
`src/functions_constants.dart` |
| `gotrue` | `GoTrueConstants` | `src/gotrue_constants.dart` |
| `realtime_client` | `RealtimeConstants` |
`src/realtime_constants.dart` |
| `storage_client` | `StorageConstants` | `src/storage_constants.dart` |
| `supabase` | `SupabaseConstants` | `src/supabase_constants.dart` |
| `supabase_flutter` | `SupabaseFlutterConstants` |
`src/supabase_flutter_constants.dart` |

`gotrue` and `realtime_client` keep a `constants.dart`, since both also
declare enums there. Only the class moved out into its own file, so
`constants.dart` now holds exactly the enums and, for `gotrue`,
`ApiVersions`. `gotrue.dart` no longer needs `hide Constants` on its
export as a result.

`realtime_client` holds the only public class of the six, so it changed
the most:

- The `typedef RealtimeConstants = Constants` is gone and the class
carries that name directly. `realtime_client.dart` only ever exported
the alias, so the name consumers write is unchanged.
- `defaultHeaders`, `defaultHeartbeatIntervalMs` and `wsCloseNormal` are
now `@internal`. Nothing outside the package reads them, and the other
five packages' default header maps were already internal. This is the
breaking part: code outside the package that reached for th... (continued)

19 of 20 new or added lines in 10 files covered. (95.0%)

5747 of 6510 relevant lines covered (88.28%)

4.14 hits per line