supabase / supabase-flutter / 32955863333

89%

Build Type

push

github

Committed by web-flow

Commit Message

docs(gotrue): enable public_member_api_docs (#1775)

## Summary
This is the largest package in the ticket (414 violations originally
measured). Enables `public_member_api_docs` for `supabase_auth` and
documents its full public API:

- `ErrorCode`: all 86 server error codes, matching upstream
https://github.com/supabase/auth/blob/master/internal/api/apierrors/errorcode.go
(the file moved since the ticket was filed; fetched the current source
to keep names/values in sync)
- MFA: `Factor`, `FactorType`, `FactorStatus`,
`AuthenticatorAssuranceLevel`, `AuthenticationMethodReference`, and all
`AuthMFA*Response` types
- `User`, `UserIdentity`
- OAuth 2.1 server types (`OAuthClient`, `OAuthProvider` constants,
grant/response/registration types) and the
`AuthOAuthApi`/`AuthAdminOAuthApi` namespaces
- Custom OAuth/OIDC provider admin types (`CustomOAuthProvider`,
`OIDCDiscoveryDocument`, create/update options)
- JWT decoding types (`JwtHeader`, `JwtPayload`, `DecodedJwt`, `JWK`,
`JWKSet`)
- `Session`, `AuthState`, exceptions (`AuthWeakPasswordException`,
`AuthInvalidJwtException`, etc.), and the remaining API namespace
constructors (`AuthAdminApi`, `AuthMFAApi`, `AuthPasskeyApi`, etc.)

## Context
Continues the package-by-package rollout for
[SDK-1449](https://linear.app/supabase/issue/SDK-1449/enable-public-member-api-docs-and-document-the-public-api).
Doc-only diff, no signature changes.

## Test plan
- [x] `dart analyze` reports no issues
- [x] `dart format .` produces no diff
- [x] `dart test` passes aside from pre-existing failures that need a
live GoTrue instance (confirmed identical failures reproduce on `main`)
- [x] Dependent packages `supabase` and `supabase_flutter` still analyze
cleanly

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

* **Documentation**
* Expanded API documentation across authentication, MFA, sessions,
users, JWTs, error codes, OAuth, and response types.
* Clarified admin API req... (continued)

Coverage Stats

85 of 99 new or added lines in 14 files covered. (85.86%)

68 existing lines in 10 files now uncovered.

6049 of 6831 relevant lines covered (88.55%)

4.57 hits per line