Skip to content

chore(*): Improve @clerk/backend DX [Part 6 - token and jwt utils return values] - #2377

Merged
SokratisVidros merged 3 commits into
mainfrom
sdk-974-improve-dx-backend-p6-verify-token
Dec 15, 2023
Merged

chore(*): Improve @clerk/backend DX [Part 6 - token and jwt utils return values]#2377
SokratisVidros merged 3 commits into
mainfrom
sdk-974-improve-dx-backend-p6-verify-token

Conversation

@dimkl

@dimkldimkl commented Dec 15, 2023

Copy link
Copy Markdown
Contributor

Description

Change return values of signJwt, hasValidSignature, decodeJwt, verifyJwt, verifyToken
to return { data, error }. Example of keeping the same behaviour using those utilies:

import{signJwt,hasValidSignature,decodeJwt,verifyJwt}from'@clerk/backend/jwt';import{verifyToken}from'@clerk/backend/jwt';const{ data, error }=awaitsignJwt(...)if(error)throwerror;const{ data, error }=awaithasValidSignature(...)if(error)throwerror;const{ data, error }=decodeJwt(...)if(error)throwerror;const{ data, error }=awaitverifyJwt(...)if(error)throwerror;const{ data, error }=awaitverifyToken(...)if(error)throwerror;

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-botBot commented Dec 15, 2023

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 23127d5

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

This PR includes changesets to release 11 packages
NameType
@clerk/backendMajor
@clerk/typesMajor
@clerk/nextjsMajor
@clerk/fastifyPatch
gatsby-plugin-clerkPatch
@clerk/remixPatch
@clerk/clerk-sdk-nodePatch
@clerk/clerk-jsPatch
@clerk/clerk-expoPatch
@clerk/clerk-reactPatch
@clerk/chrome-extensionPatch

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

Comment threadpackages/backend/src/jwt/signJwt.ts Outdated
Comment threadpackages/backend/src/jwt/verifyJwt.ts Outdated
Comment threadpackages/types/src/utils.ts Outdated
@dimkl
dimklforce-pushed the sdk-974-improve-dx-backend-p6-verify-token branch 2 times, most recently from 156f4d4 to 9e9e0d1CompareDecember 15, 2023 19:01
@dimkl
dimklforce-pushed the sdk-974-improve-dx-backend-p6-verify-token branch from 9e9e0d1 to 88532d1CompareDecember 15, 2023 19:18
@dimkl
dimklforce-pushed the sdk-974-improve-dx-backend-p6-verify-token branch from 88532d1 to 23127d5CompareDecember 15, 2023 19:27
@SokratisVidros
SokratisVidros merged commit a9fe242 into mainDec 15, 2023
@SokratisVidros
SokratisVidros deleted the sdk-974-improve-dx-backend-p6-verify-token branch December 15, 2023 21:02
octoper pushed a commit that referenced this pull request Dec 16, 2023
…urn values] (#2377)
* chore(backend,types): Introduce ReturnWithError and use it as `verifyToken` return value
* chore(backend,types): Make /jwt subpath utilies to return `ReturnWithError` type
* chore(backend,types): Rename and move `ReturnWithError` move types to backend `JwtReturnType`
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@dimkl@SokratisVidros@clerk-cookie