YPE-1146 - Prep React SDK for major bump#253
Merged
Merged
Conversation
Remove previously-deprecated APIs and tighten BibleIndex types ahead of the next major release. Only symbols explicitly marked @deprecated are removed (plus the transitively-dead DEFAULT export). - ui: remove deprecated redirectUrl prop from YouVersionAuthButton - ui: remove BibleWidgetView alias (use BibleCard) - hooks: remove unused useInitData/useChapterNavigation/useVerseSelection hooks and the Reader*/VerseSelection* contexts and providers - core: make passage_id required on BibleIndexChapter and BibleIndexVerse Adds a major changeset documenting each breaking change and its migration. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
🦋 Changeset detectedLatest commit: 951a0f4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com> Signed-off-by: Cameron Pak <cameronandrewpak@gmail.com>
bmanquen
approved these changes
Jun 4, 2026
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
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.
Removes previously-deprecated APIs and tightens
BibleIndextypes across all three packages, ahead of the next major release. 8 files deleted, 4 surfaces changed; guided by one rule — only symbols explicitly marked@deprecatedare removed (plus the transitively-deadDEFAULTexport, removed honestly and documented).Removed/changed:
redirectUrlprop onYouVersionAuthButton(useauthRedirectUrlonYouVersionProvider),BibleWidgetView/BibleWidgetViewPropsalias (useBibleCard/BibleCardProps), unuseduseInitData/useChapterNavigation/useVerseSelectionhooks,Reader*andVerseSelection*contexts and providers, andpassage_idnow required onBibleIndexChapter/BibleIndexVerse(type-only). The per-callsignIn({ redirectUrl })override andBibleIndexBook.introare intentionally untouched.A single major changeset documents every breaking change with its migration path; it coalesces with the auth refactor (#248) into one release as long as the "Version Packages" PR isn't merged between them.
Build, typecheck, test, and lint pass across core, hooks, ui, and the vite-react example app.
Part of YPE-1146
There is additional work YPE-2889 for the necessary follow-up docs-site updates.
Greptile Summary
This PR executes the "next major" cleanup that was explicitly deferred in earlier PRs: it removes eight deprecated symbols (hooks, contexts, a component alias, and a prop) and promotes
passage_idto required in theBibleIndexZod schemas. No new logic is introduced — the change is entirely deletions plus one schema tightening.YouVersionAuthButtonloses itsredirectUrlprop; the component now callssignIn({ scopes })and correctly falls back toredirectUrisourced fromYouVersionProviderviauseYVAuth.BibleIndexChapter/BibleIndexVerseschemas promotepassage_idfrom.optional()to required, fulfilling theTODO(next-major)from PR YPE-2841 - Sync schemas/types with latest OpenAPI spec #251; the changeset accurately notes both the TypeScript and runtime Zod enforcement impact.ReaderContext,ReaderProvider,VerseSelectionContext,VerseSelectionProvider,useInitData,useChapterNavigation,useVerseSelection, andbible-widget-view— all carried explicit@deprecatedJSDoc before this PR.Confidence Score: 5/5
Safe to merge — every removed symbol carried an explicit @deprecated JSDoc, the schema tightening fulfils a documented TODO from a prior PR, and the changeset accurately describes both the TypeScript and runtime impact of each breaking change.
Every removed symbol was already marked deprecated with a clear 'will be removed in the next major version' notice; the passage_id schema promotion is backed by the OpenAPI spec confirmed in the PR thread; signIn() in YouVersionAuthButton correctly falls back through useYVAuth to redirectUri from context; coverage exclusions are cleaned up in lockstep with the deleted files; and all three packages carry a matching major changeset entry.
No files require special attention. All deletions are clean, the schema change is intentional and documented, and the changeset covers every breaking surface.
Important Files Changed
passage_idis correctly called out alongside the type-level change.passage_idfrom optional to required on bothBibleIndexVerseSchemaandBibleIndexChapterSchema; fulfills the explicitTODO(next-major)from PR #251;BibleIndexBook.introcorrectly remains optional.YouVersionContextandYouVersionProviderexports correctly.useVerseSelection,useChapterNavigation,useInitData); remaining public surface is unchanged.redirectUrlprop and its forwarding intosignIn();signIn({ scopes })now correctly falls back toredirectUrifrom the provider context viauseYVAuth.Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD subgraph REMOVED ["❌ Removed in this PR"] RCtx["ReaderContext / ReaderProvider"] VSCtx["VerseSelectionContext / VerseSelectionProvider"] UH["useInitData · useChapterNavigation · useVerseSelection"] BW["BibleWidgetView / BibleWidgetViewProps alias"] RU["YouVersionAuthButton.redirectUrl prop"] end subgraph KEPT ["✅ Retained public API"] YVAuth["YouVersionProvider\nauthRedirectUrl prop"] UC["useYVAuth\nsignIn({ redirectUrl?, scopes? })"] BC["BibleCard / BibleCardProps"] BI["BibleIndex schemas\npassage_id now required"] CTX["YouVersionContext\nYouVersionProvider"] end RU -->|"migration →"| YVAuth BW -->|"migration →"| BC UH -->|"migration →"| UC RCtx -->|"no replacement"| CTX VSCtx -->|"no replacement"| CTXReviews (2): Last reviewed commit: "Merge branch 'main' into chore/remove-de..." | Re-trigger Greptile