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.

Sign up for GitHub

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

Jump to bottom

chore(*): Rename refs of MagicLink to EmailLink - deprecation warnings #1836

Merged
merged 4 commits into from
Oct 9, 2023
Merged

chore(*): Rename refs of MagicLink to EmailLink - deprecation warnings #1836

merged 4 commits into from
Oct 9, 2023

Conversation

dimkl
Copy link
Contributor

@dimkl dimkl commented Oct 6, 2023

Description

Warn about MagicLink deprecations:

  • MagicLinkError
  • isMagicLinkError
  • MagicLinkErrorCode
  • handleMagicLinkVerification
  • createMagicLinkFlow
  • useMagicLink

Checklist

  • npm test runs as expected.
  • npm run 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:

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

@dimkl dimkl self-assigned this Oct 6, 2023
@dimkl dimkl requested a review from a team as a code owner October 6, 2023 13:32
@changeset-bot
Copy link

changeset-bot bot commented Oct 6, 2023 •
edited
Loading

🦋 Changeset detected

Latest commit: 2f66fe8

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

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

@dimkl dimkl force-pushed the js-643-rename-magiclink-js-docs branch 2 times, most recently from a141709 to 335e105 Compare October 6, 2023 21:18
Base automatically changed from js-643-rename-magiclink-js-docs to main October 6, 2023 21:43
@dimkl dimkl force-pushed the js-643-rename-magiclink-deprecated branch from 681e8a5 to d1811bb Compare October 7, 2023 17:26
panteliselef
panteliselef approved these changes Oct 9, 2023
View reviewed changes
packages/shared/src/errors/Error.ts Outdated
@@ -178,6 +182,7 @@ export const MagicLinkErrorCode = {
Expired: 'expired',
Failed: 'failed',
};
// TODO(@dimkl): Add deprecation warning for MagicLinkErrorCode
Copy link
Member

Choose a reason for hiding this comment

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

@dimkl will this be part of a followup PR ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i will update the current PR. I am trying to find if we could avoid adding a deprecation warning for this (eg it may not be exported or there is no real usage outside of our own SDKs)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@panteliselef i've added a deprecation warning for MagicLinkErrorCode since it may be used by our customers

@dimkl dimkl force-pushed the js-643-rename-magiclink-deprecated branch from d1811bb to 479f50b Compare October 9, 2023 10:43
@dimkl dimkl force-pushed the js-643-rename-magiclink-deprecated branch from 479f50b to 2f66fe8 Compare October 9, 2023 13:02
@dimkl dimkl enabled auto-merge October 9, 2023 13:03
@dimkl dimkl added this pull request to the merge queue Oct 9, 2023
Merged via the queue into main with commit 977336f Oct 9, 2023
@dimkl dimkl deleted the js-643-rename-magiclink-deprecated branch October 9, 2023 13:19
@clerk-cookie clerk-cookie mentioned this pull request Oct 9, 2023
Merged
@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 Oct 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@panteliselef panteliselef panteliselef approved these changes

Assignees

@dimkl dimkl

Labels
clerk-js react
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dimkl @clerk-cookie @panteliselef