supabase / supabase-swift / 28599450566

81%

push

github

feat(postgrest): add ExplainFormat enum for explain(format:) (#1050)

* feat(postgrest): add ExplainFormat enum for explain(format:)

Introduce a type-safe ExplainFormat enum (.text / .json) for the
explain() plan format, giving compile-time safety instead of an
untyped String. The existing String-based overload is kept and marked
deprecated so current callers keep compiling, making this a
non-breaking change. Both overloads forward to a single private
implementation.

* refactor(postgrest): make ExplainFormat an open-ended struct in Types.swift

Address review: use a RawRepresentable struct instead of a closed enum so
callers can pass future PostgREST plan formats (e.g. ExplainFormat(rawValue:
"yaml")) without waiting for an SDK release, and move it to module top-level
alongside CountOption/TextSearchType. Also resolves the ambiguous DocC
cross-reference between the two explain() overloads.

* chore(postgrest): register ExplainFormat in sdk-compliance.yaml

The capability-matrix check flags ExplainFormat as new public API. Attribute
it under database.using_modifiers.explain.

* refactor(postgrest): move deprecated explain(format:String) to Deprecated.swift

Keep all deprecated declarations under Deprecated.swift so they are easy to
drop at the next major release. The deprecated string overload now forwards to
the ExplainFormat overload via ExplainFormat(rawValue:); the main explain
method no longer needs a shared private helper.

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

7502 of 9262 relevant lines covered (81.0%)

36.97 hits per line