Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(clerk-js,clerk-react,types): Add unsafeMetadata prop to <SignUp /> #1464

Merged
merged 5 commits into from
Jul 18, 2023

Conversation

tmilewski
Copy link
Member

Type of change

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

Packages affected

  • @clerk/clerk-js
  • @clerk/clerk-react
  • @clerk/nextjs
  • @clerk/remix
  • @clerk/types
  • @clerk/themes
  • @clerk/localizations
  • @clerk/clerk-expo
  • @clerk/backend
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/fastify
  • @clerk/chrome-extension
  • gatsby-plugin-clerk
  • build/tooling/chore

Description

  • npm test runs as expected.
  • npm run build runs as expected.

Adds unsafeMetadata prop to the <SignUp /> component to improve flexibility.

Fixes USR-99

@tmilewski tmilewski self-assigned this Jul 7, 2023
@changeset-bot
Copy link

changeset-bot bot commented Jul 7, 2023

🦋 Changeset detected

Latest commit: 2141595

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

This PR includes changesets to release 12 packages
Name Type
@clerk/clerk-js Minor
@clerk/clerk-react Minor
@clerk/types Minor
@clerk/chrome-extension Patch
@clerk/clerk-expo Patch
gatsby-plugin-clerk Patch
@clerk/nextjs Patch
@clerk/remix Patch
@clerk/backend Patch
@clerk/fastify Patch
@clerk/localizations Patch
@clerk/clerk-sdk-node 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

Copy link

@jit-ci jit-ci bot left a comment

Choose a reason for hiding this comment

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

✅ Great news! Jit hasn't found any security issues in your PR. Good Job! 🏆

@@ -77,7 +77,9 @@ type ButtonProps = {
};

export type SignInButtonProps = ButtonProps;
export type SignUpButtonProps = ButtonProps;
export interface SignUpButtonProps extends ButtonProps {
Copy link
Member

Choose a reason for hiding this comment

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

❓Any specific reason we want to switch to an interface and not go with something like this ?

export type SignUpButtonProps = ButtonProps & {unsafeMetadata?: SignUpUnsafeMetadata;}

Copy link
Member Author

Choose a reason for hiding this comment

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

@panteliselef While not exactly this situation, I tend to refer to this: https://github.com/microsoft/TypeScript/wiki/Performance#preferring-interfaces-over-intersections

That said, happy to use an intersection.

Copy link
Member

Choose a reason for hiding this comment

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

that's a great read, thanks tom

Copy link
Member

@gkats gkats left a comment

Choose a reason for hiding this comment

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

@tmilewski Nice one!

Were you able to confirm that the metadata get copied on the newly created user on successful sign up? Does it work with our various sign up methods (password, passwordless and oauth)?

Let me know if you need any help with tests.

playground/nextjs/app/app-dir/sign-up/page.tsx Outdated Show resolved Hide resolved
@tmilewski
Copy link
Member Author

@tmilewski Nice one!

Were you able to confirm that the metadata get copied on the newly created user on successful sign up? Does it work with our various sign up methods (password, passwordless and oauth)?

Let me know if you need any help with tests.

@gkats Thanks! Password and passwordless are good to go. Looking through OAuth now.

@tmilewski
Copy link
Member Author

@gkats Password, Passwordless, OAuth, and Metamask/Web3 all appear to be working as intended.

@tmilewski tmilewski merged commit 0599290 into main Jul 18, 2023
8 checks passed
@tmilewski tmilewski deleted the tom/usr-99 branch July 18, 2023 13:36
@clerk-cookie clerk-cookie mentioned this pull request Jul 18, 2023
@clerk-cookie
Copy link
Collaborator

This PR has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@clerk clerk locked as resolved and limited conversation to collaborators Jul 18, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants