supabase / supabase-flutter / 32982098636

89%

Build Type

push

github

Committed by web-flow

Commit Message

docs(realtime_client): enable public_member_api_docs (#1771)

## Summary
- Enables `public_member_api_docs` for `supabase_realtime` (149
violations per the ticket's original measurement, 140 after the two
ignores were narrowed).
- Documents the full public surface: `RealtimeClient`,
`RealtimeChannel`, the enums and constants in
`constants.dart`/`realtime_constants.dart`, the Postgres type conversion
helpers in `transformers.dart`, and the data classes in `types.dart`
(payloads, filters, config).
- Deletes the two file-level `ignore_for_file: public_member_api_docs`
comments in `realtime_presence.dart` and `types.dart` (the
`sort_constructors_first` half was already removed by #1767), which is
the concrete trigger for
[SDK-1449](https://linear.app/supabase/issue/SDK-1449/enable-public-member-api-docs-and-document-the-public-api).

## Context
Note on `@internal`: the `public_member_api_docs` lint exempts a whole
class/enum annotated `@internal`, but not an individual member annotated
`@internal` inside an otherwise-public class — those still needed real
docs, which is most of what this PR adds.

## Test plan
- [x] `dart analyze` reports no issues
- [x] `dart format .` produces no diff
- [x] `dart test` passes (252 tests)
- [x] Dependent package `supabase` still analyzes cleanly (no signature
changes, doc-only diff)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Documentation**
- Expanded and clarified API documentation across realtime channels,
clients, constants, presence, data types, and PostgreSQL
transformations.
- Improved guidance for connection states, subscriptions, heartbeat
handling, events, serialization, and timeout settings.
  - Removed outdated documentation exceptions and improved consistency.

- **Refactor**
- Improved protection for channel and presence state through controlled,
read-only access.
- Channel parameters and presence snapshots are now safely unmodifiable,
preventing... (continued)

Coverage Stats

2 of 2 new or added lines in 1 file covered. (100.0%)

1 existing line in 1 file now uncovered.

6050 of 6832 relevant lines covered (88.55%)

4.57 hits per line