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

fix(backend): Fix minor misalignment's with the User FAPI and BAPI classes #2493

Merged
merged 3 commits into from Jan 10, 2024

Conversation

panteliselef
Copy link
Member

Description

User FAPI and User BAPI cannot be fully aligned, but we should aim for keeping their signature as similar as possible.

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/backend
  • @clerk/chrome-extension
  • @clerk/clerk-js
  • @clerk/clerk-expo
  • @clerk/fastify
  • gatsby-plugin-clerk
  • @clerk/localizations
  • @clerk/nextjs
  • @clerk/clerk-react
  • @clerk/remix
  • @clerk/clerk-sdk-node
  • @clerk/shared
  • @clerk/themes
  • @clerk/types
  • build/tooling/chore

Copy link

changeset-bot bot commented Jan 5, 2024

🦋 Changeset detected

Latest commit: ec8179b

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

This PR includes changesets to release 7 packages
Name Type
@clerk/backend Minor
@clerk/fastify Patch
gatsby-plugin-clerk Patch
@clerk/nextjs Patch
@clerk/remix Patch
@clerk/clerk-sdk-node Patch
@clerk/elements 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

@panteliselef panteliselef self-assigned this Jan 5, 2024
Copy link
Member

@dimkl dimkl left a comment

Choose a reason for hiding this comment

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

I would suggest we use getters for primaryEmailAddress / primaryPhoneNumber , .... instead of adding them as params. I would also suggest a getter for fullName.
Why did we export the getFullName function? I don't see any import or usage outside the User.ts.

@dimkl
Copy link
Member

dimkl commented Jan 10, 2024

@panteliselef let's create a ticket to introduce a common interface in @clerk/types and make the BAPI / FAPI User extend it.

@panteliselef panteliselef added this pull request to the merge queue Jan 10, 2024
Merged via the queue into main with commit 448e02e Jan 10, 2024
7 checks passed
@panteliselef panteliselef deleted the elef/fix-user-class branch January 10, 2024 12:14
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.

None yet

3 participants