Skip to content

Conversation

@alexcarpenter
Copy link
Member

Description

Adding a deprecation warning for virtual routing usage, that is to be removed in the next major release.

Resolves SDKI-858

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@changeset-bot
Copy link

changeset-bot bot commented Feb 3, 2025

🦋 Changeset detected

Latest commit: 9e76956

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@clerk/clerk-js Patch
@clerk/chrome-extension Patch
@clerk/clerk-expo Patch

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

@vercel
Copy link

vercel bot commented Feb 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
clerk-js-sandbox ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 3, 2025 3:29pm

@alexcarpenter
Copy link
Member Author

!snapshot

@clerk-cookie
Copy link
Collaborator

Hey @alexcarpenter - the snapshot version command generated the following package versions:

Package Version
@clerk/chrome-extension 2.2.6-snapshot.v20250203181640
@clerk/clerk-js 5.51.1-snapshot.v20250203181640
@clerk/clerk-expo 2.7.4-snapshot.v20250203181640
@clerk/tanstack-start 0.9.3-snapshot.v20250203181640

Tip: Use the snippet copy button below to quickly install the required packages.
@clerk/chrome-extension

npm i @clerk/chrome-extension@2.2.6-snapshot.v20250203181640 --save-exact

@clerk/clerk-js

npm i @clerk/clerk-js@5.51.1-snapshot.v20250203181640 --save-exact

@clerk/clerk-expo

npm i @clerk/clerk-expo@2.7.4-snapshot.v20250203181640 --save-exact

@clerk/tanstack-start

npm i @clerk/tanstack-start@0.9.3-snapshot.v20250203181640 --save-exact

Comment on lines +60 to +62
if (props.componentProps.routing === 'virtual') {
deprecated('routing="virtual"', 'Use routing="hash" instead.');
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Asking for confirmation here, since this is only logged in LazyComponentRenderer, it means that SignInModal will not display the deprecation, but if someone does <SignIn routing="virtual" /> then it will.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my testing, that is correct.

@LekoArts LekoArts merged commit 5c26eef into main Feb 5, 2025
29 checks passed
@LekoArts LekoArts deleted the alexcarpenter/sdki-803-drop-routing-virtual-from-types-2 branch February 5, 2025 08:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants