feat(backend): signal support for handshake nonce

[jacekradko]

Description

Send query string param to signal support for handshake nonce flow from current version of @clerk/backend

Related: SDKI-979

Checklist

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

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
clerk-js-sandbox	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 15, 2025 6:01pm

[changeset-bot]

🦋 Changeset detected

Latest commit: ffb8c6f

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

This PR includes changesets to release 11 packages

Name	Type
@clerk/backend	Minor
@clerk/agent-toolkit	Patch
@clerk/astro	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/remix	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	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

[Copilot]

Pull Request Overview

This PR adds support for signaling the handshake nonce flow by including a query parameter.

• In handshake.ts, the query parameter SupportsHandshakeNonce is appended to the URL.
• In handshake.test.ts, corresponding tests ensure the parameter is correctly set in both regular and development modes.
• In constants.ts, a new constant for SupportsHandshakeNonce is added to support the new query parameter.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
packages/backend/src/tokens/handshake.ts	Appends a new query parameter for handshake nonce support.
packages/backend/src/tokens/tests/handshake.test.ts	Adds tests to validate the presence of the new query parameter.
packages/backend/src/constants.ts	Introduces the SupportsHandshakeNonce constant to hold the parameter key.

[jfoshee]

LGTM. So to be doubly clear: this indicates "nonce support", but FAPI still has the option to return 'optimized' payload in initial response, right?
I'll work on API definition update and FAPI implementation.

[jacekradko]

@jfoshee Yeah, this is just to signal to the API that it COULD send a handshake nonce

[pkg-pr-new]

Open in StackBlitz

@clerk/agent-toolkit

npm i https://pkg.pr.new/@clerk/agent-toolkit@5905

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@5905

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@5905

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@5905

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@5905

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@5905

@clerk/elements

npm i https://pkg.pr.new/@clerk/elements@5905

@clerk/clerk-expo

npm i https://pkg.pr.new/@clerk/clerk-expo@5905

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@5905

@clerk/express

npm i https://pkg.pr.new/@clerk/express@5905

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@5905

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@5905

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@5905

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@5905

@clerk/clerk-react

npm i https://pkg.pr.new/@clerk/clerk-react@5905

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@5905

@clerk/remix

npm i https://pkg.pr.new/@clerk/remix@5905

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@5905

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@5905

@clerk/themes

npm i https://pkg.pr.new/@clerk/themes@5905

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@5905

@clerk/types

npm i https://pkg.pr.new/@clerk/types@5905

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@5905

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@5905

commit: ffb8c6f