supabase / supabase-swift / 42083052640

96%

push

github

refactor!: move optional request settings into per-method options structs (#1736)

Writes down when a public method takes its optional settings inline and when it takes an
`<Action>Options` struct (new "Method Parameters: Inline or Options" section in CODE_STYLE.md),
and changes the methods that broke the rule. v3 is unreleased, so the breaks are free now.

- Auth: `resend(email:type:options:)`, `resend(phone:type:options:)`, and
  `resetPassword(email:options:)` take `ResendEmailOptions`, `ResendPhoneOptions`, and
  `ResetPasswordOptions`.
- Storage: `createSignedURL`, `createSignedURLs`, and `publicURL` take `SignedURLOptions`,
  `SignedURLsOptions`, and `PublicURLOptions`. `download` moves `transform` into `DownloadOptions`.
- Vectors (experimental): `vectors(keys:)`, `listVectors`, and `queryVectors` take
  `GetVectorsOptions`, `ListVectorsOptions`, and `QueryVectorsOptions`.

The rule records three deliberate exceptions: PostgREST builder modifiers, Realtime
`postgresChanges`, and type initializers. Methods with a lone `captchaToken` or `redirectTo`
(`signIn(email:password:captchaToken:)`, `updateUser(_:redirectTo:)`, …) follow the rule unchanged.

Migration guides: docs/migrations/v3/Auth.md and docs/migrations/v3/Storage.md.
`sdk-compliance.yaml` is updated.

Test evidence: all unit tests pass; full local integration suite passes (323 tests + the secure
email change suite); `swiftlint lint --strict` clean; `./scripts/check-compliance.sh` reports no
stale entries.

BREAKING CHANGE: the methods above take an `options:` value instead of inline parameters.

Fixes SDK-2793

74 of 74 new or added lines in 6 files covered. (100.0%)

15102 of 15795 relevant lines covered (95.61%)

477223.88 hits per line