fix(types): Ensure `unsafeMetadata` prop is only allowed in valid circumstances #6340

tmilewski · 2025-07-16T22:23:41Z

Description

unsafeMetadata isn't passed along with page redirects and it's causing confusion as the types are incorrect for <SignUpButton />:

If mode == "modal: unsafeMetadata is allowed.
If mode != "modal: unsafeMetadata isn't allowed.

This PR accounts for those scenarios.

USER-2376

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

Summary by CodeRabbit

New Features
- Improved handling of custom metadata during the sign-up process, allowing metadata to be included specifically when using the modal sign-up flow.
Refactor
- Updated type definitions to enforce that custom metadata is only accepted when using the modal sign-up mode, enhancing type safety without altering the component interface.

vercel · 2025-07-16T22:23:45Z

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	Jul 17, 2025 2:00pm

changeset-bot · 2025-07-16T22:23:46Z

🦋 Changeset detected

Latest commit: 184c169

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

This PR includes changesets to release 22 packages

Name	Type
@clerk/astro	Patch
@clerk/clerk-react	Patch
@clerk/types	Patch
@clerk/chrome-extension	Patch
@clerk/elements	Patch
@clerk/clerk-expo	Patch
@clerk/nextjs	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/agent-toolkit	Patch
@clerk/backend	Patch
@clerk/clerk-js	Patch
@clerk/expo-passkeys	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/localizations	Patch
@clerk/nuxt	Patch
@clerk/shared	Patch
@clerk/testing	Patch
@clerk/themes	Patch
@clerk/vue	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

coderabbitai · 2025-07-16T22:26:59Z

📝 Walkthrough

"""

Walkthrough

The changes update the handling of the unsafeMetadata property in the SignUpButton component and its associated type definitions. In the component, unsafeMetadata is no longer destructured from props or always forwarded to sign-up methods. Instead, it is now conditionally added only when opening the sign-up modal via clerk.openSignUp. The call to clerk.redirectToSignUp does not include unsafeMetadata. The type definitions in clerk.ts are updated to include an optional unsafeMetadata property specifically for modal button props, and the SignUpButtonProps type is simplified to rely on these updated definitions.

Assessment against linked issues

Objective	Addressed	Explanation
Ensure `unsafeMetadata` is correctly passed to the sign-up process (USER-2376)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found.
"""

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6623f86 and 184c169.

📒 Files selected for processing (1)

packages/types/src/clerk.ts (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/types/src/clerk.ts

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

GitHub Check: semgrep-cloud-platform/scan
GitHub Check: Build Packages
GitHub Check: Formatting | Dedupe | Changeset
GitHub Check: semgrep/ci
GitHub Check: Analyze (javascript-typescript)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

pkg-pr-new · 2025-07-16T23:06:38Z

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@6340

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@6340

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@6340

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@6340

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@6340

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@6340

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@6340

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@6340

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@6340

@clerk/express

npm i https://pkg.pr.new/@clerk/express@6340

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@6340

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@6340

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@6340

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@6340

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@6340

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@6340

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@6340

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@6340

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@6340

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@6340

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@6340

@clerk/types

npm i https://pkg.pr.new/@clerk/types@6340

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@6340

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@6340

commit: 184c169

panteliselef

I don't think this works as intended

tmilewski · 2025-07-17T14:01:26Z

I don't think this works as intended

@panteliselef Interesting as I tested the other day and sent out some screenshots of it working:

Regardless, I refactored the types, if you don't mind testing again.

fix: Ensure unsafeMetadata prop is only allowed in valid circumstances

c84d316

tmilewski self-assigned this Jul 16, 2025

tmilewski changed the title ~~fix: Ensure unsafeMetadata prop is only allowed in valid circumstances~~ fix: Ensure unsafeMetadata prop is only allowed in valid circumstances Jul 16, 2025

clerk-cookie added types react labels Jul 16, 2025

wobsoriano approved these changes Jul 16, 2025

View reviewed changes

fix: Apply changes to Astro components

6623f86

clerk-cookie added the astro label Jul 16, 2025

vercel bot deployed to Preview July 16, 2025 23:02 View deployment

tmilewski changed the title ~~fix: Ensure unsafeMetadata prop is only allowed in valid circumstances~~ fix(types): Ensure unsafeMetadata prop is only allowed in valid circumstances Jul 16, 2025

This comment was marked as outdated.

Sign in to view

panteliselef requested changes Jul 17, 2025

View reviewed changes

chore: clean up typing

184c169

vercel bot deployed to Preview July 17, 2025 14:00 View deployment

tmilewski requested a review from panteliselef July 17, 2025 14:01

panteliselef approved these changes Jul 17, 2025

View reviewed changes

tmilewski enabled auto-merge (squash) July 17, 2025 14:10

tmilewski merged commit d2f6f9e into main Jul 17, 2025
38 checks passed

tmilewski deleted the tm/user-2376-unsafemetadata-props branch July 17, 2025 14:11

clerk-cookie mentioned this pull request Jul 17, 2025

ci(repo): Version packages #6337

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(types): Ensure `unsafeMetadata` prop is only allowed in valid circumstances #6340

fix(types): Ensure `unsafeMetadata` prop is only allowed in valid circumstances #6340

Uh oh!

tmilewski commented Jul 16, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

changeset-bot bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 16, 2025 •

edited

Loading

Walkthrough

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 16, 2025 •

edited

Loading

Uh oh!

This comment was marked as outdated.

Uh oh!

panteliselef left a comment

Uh oh!

tmilewski commented Jul 17, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

fix(types): Ensure unsafeMetadata prop is only allowed in valid circumstances #6340

fix(types): Ensure unsafeMetadata prop is only allowed in valid circumstances #6340

Uh oh!

Conversation

tmilewski commented Jul 16, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Type of change

Summary by CodeRabbit

Summary by CodeRabbit

Uh oh!

vercel bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

changeset-bot bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

coderabbitai bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

pkg-pr-new bot commented Jul 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

panteliselef left a comment

Choose a reason for hiding this comment

Uh oh!

tmilewski commented Jul 17, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

fix(types): Ensure `unsafeMetadata` prop is only allowed in valid circumstances #6340

fix(types): Ensure `unsafeMetadata` prop is only allowed in valid circumstances #6340

tmilewski commented Jul 16, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 16, 2025 •

edited

Loading

changeset-bot bot commented Jul 16, 2025 •

edited

Loading

coderabbitai bot commented Jul 16, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

pkg-pr-new bot commented Jul 16, 2025 •

edited

Loading