Final naming consistency pass before 1.0 freeze#89
Merged
Conversation
A naming-only audit of every module's public API against the SDK's own conventions. Fixes the handful of genuine, contained inconsistencies; the debatable and parity-driven cases are recorded as deliberate decisions in API_DESIGN.md. Renames (the SDK's own convention was violated): - invokeSSE -> invokeSse (acronyms are word-cased everywhere else) - Paginator.endReached -> isEndReached (boolean reads as an assertion) - database selectWithCount -> selectWithCountTyped (joins the *Typed family) - realtime setPrivate -> configurePrivate (matches configure* builder group) - storage createUploadSignedUrl(WithPath) -> createSignedUploadUrl(WithPath) - storage VectorDistanceMetric.DOTPRODUCT -> DOT_PRODUCT (wire value kept) - auth-admin OIDC jwksUri -> jwksUrl (siblings are all *Url; wire value kept) Removed two exact duplicates: - core SupabaseResult.toResultFlow() (identical to asFlow()) - realtime RealtimeSubscription.statusFlow() (identical to the status property) apiDump regenerated; apiCheck + detekt + spotlessCheck + jvmTest all green; docs site builds clean. CHANGELOG + API_DESIGN.md updated.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A naming-only audit of every module's public API (7 parallel read-only auditors + a cross-module acronym/factory-verb/enum-casing analysis), judged against Kotlin/JetBrains API conventions. Verdict: the surface was already in good shape — every auditor reported no blockers. This PR fixes the handful of genuine, contained violations of the SDK's own conventions and records the debatable/parity-driven cases as deliberate decisions in
API_DESIGN.md.Renames (the SDK's own convention was violated)
invokeSSEinvokeSseUrl,Otp,Jwt)Paginator.endReachedisEndReachedisLoading)selectWithCountselectWithCountTypedT→ joins the*TypedfamilysetPrivateconfigurePrivateconfigure*groupcreateUploadSignedUrl(WithPath)createSignedUploadUrl(WithPath)Signed+direction orderVectorDistanceMetric.DOTPRODUCTDOT_PRODUCT@SerialNamejwksUrijwksUrl*Url; wire value kept via@SerialNameRemoved (exact duplicates)
SupabaseResult.toResultFlow()— identical single-emit toasFlow()RealtimeSubscription.statusFlow()— identical to thestatuspropertyDeliberately kept (documented in API_DESIGN.md)
Enum-casing split (UPPER_SNAKE for wire/option enums, PascalCase for the two domain-category sets), filter-operator vocabulary, factory-verb variety,
rpcTyped=single vsselectTyped=list, pseudo-namespaced auth methods, the*OrThrow/*WithResultescape-hatch suffixes. Deferred (not worth pre-freeze churn; sync isn't published in 1.0):sync.Record/Cursor→SyncRecord/SyncCursor,RealtimeSubscription.channel→channelName.apiDump regenerated; apiCheck + detekt + spotlessCheck + jvmTest all green; docs site builds clean. CHANGELOG + API_DESIGN.md updated.