Skip to content

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

Merged
panteliselef merged 3 commits into
mainfrom
elef/fix-user-class
Jan 10, 2024
Merged

fix(backend): Fix minor misalignment's with the User FAPI and BAPI classes#2493
panteliselef merged 3 commits into
mainfrom
elef/fix-user-class

Conversation

@panteliselef

Copy link
Copy Markdown
Contributor

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

@changeset-bot

changeset-bot Bot commented Jan 5, 2024

Copy link
Copy Markdown

🦋 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

@dimkl dimkl left a comment

Copy link
Copy Markdown
Contributor

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.

@panteliselef
panteliselef requested a review from dimkl January 8, 2024 09:57
@dimkl

dimkl commented Jan 10, 2024

Copy link
Copy Markdown
Contributor

@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
@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.

3 participants