supabase / supabase-swift / 31687944663

86%

push

github

fix(auth)!: return VerifyOTPResponse from verifyOTP instead of AuthResponse (#1088)

* fix(auth)!: return AuthResponse.none when GoTrue returns no session or user

verifyOTP(type: .emailChange) previously threw a DecodingError when
GoTrue's /verify endpoint returned the `{ msg, code }` body sent for the
first of the two confirmations required by a secure email change,
since AuthResponse could only decode a Session or a User.

AuthResponse gains a `.none` case for this shape, and `user` is now
`User?` instead of `User` so `(session: nil, user: nil)` is
representable.

BREAKING CHANGE: `AuthResponse.user` is now `User?` instead of `User`.
Update call sites that access `response.user` directly to handle the
optional (e.g. `response.user?.email`).

Linear: SDK-1022

* fix(auth): restore canonical import order and clarify AuthResponse.none doc

Addresses code review feedback on #1088 (SDK-1022): the import ordering
in AuthClientTests.swift had regressed to a non-swift-format-canonical
layout, and the `.none` doc didn't make clear it's a catch-all for any
unrecognized response shape, not just the email-change confirmation case.

* fix(auth): convert rebased AuthResponse tests to Swift Testing style

The tests re-created while resolving the rebase conflict onto main still
used XCTest assertions and a duplicated import, left over from before
main's migration to Swift Testing.

* docs(auth): add AuthResponse migration guide and require guides for breaking changes

AuthResponse.user changed from User to User? in this release; document
the migration and encode the requirement in AGENTS.md so future
breaking changes ship with a guide.

* docs(auth): consolidate migration guides to one file per module

Rename AuthResponse Migration Guide.md to Auth Migration Guide.md and
restructure it as a per-module doc with a section per breaking change,
so future Auth breaking changes get a new section instead of a new
file. Update the AGENTS.md convention to match.

* docs(au... (continued)

17 of 17 new or added lines in 2 files covered. (100.0%)

8865 of 10474 relevant lines covered (84.64%)

39.96 hits per line