Skip to content

feat(clerk-js,types): Add support for ticket sign-ins and sign-ups #6806

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

Merged
merged 6 commits into from
Sep 19, 2025
Merged

feat(clerk-js,types): Add support for ticket sign-ins and sign-ups #6806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
33e1be9
feat(clerk-js,types): Add support for ticket sign-ins and sign-ups
dstaley Sep 18, 2025
35d75d1
Merge branch 'main' into ds.feat/signals-tickets
dstaley Sep 18, 2025
268276b
fix(clerk-js): Fix function param type
dstaley Sep 18, 2025
0a099ed
fix(clerk-react): Add ticket methods to stateProxy
dstaley Sep 18, 2025
aa1a4c4
fix(clerk-js): Pass through additional params for signUp.ticket
dstaley Sep 18, 2025
ab0d83c
fix(types): Mark ticket params as optional
dstaley Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changeset/two-mangos-rest.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@clerk/clerk-js': minor
'@clerk/types': minor
---

[Experimental] Add support for ticket sign-ins and sign-ups
6 changes: 6 additions & 0 deletions packages/clerk-js/src/core/resources/SignIn.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand Down Expand Up @@ -914,6 +915,11 @@ class SignInFuture implements SignInFutureResource {
});
}

async ticket(params?: SignInFutureTicketParams): Promise<{ error: unknown }> {
const ticket = params?.ticket ?? getClerkQueryParam('__clerk_ticket');
return this.create({ ticket: ticket ?? undefined });
}
Comment on lines +918 to +921
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

🧩 Analysis chain

SSR safety and empty-ticket guard for signIn.ticket().

Calling this on the server with no param will access window. Guard SSR and provide a clear error when a ticket isn’t available.

-  async ticket(params?: SignInFutureTicketParams): Promise<{ error: unknown }> {
-    const ticket = params?.ticket ?? getClerkQueryParam('__clerk_ticket');
-    return this.create({ ticket: ticket ?? undefined });
-  }
+  async ticket(params?: SignInFutureTicketParams): Promise<{ error: unknown }> {
+    const ticketFromUrl = inBrowser() ? getClerkQueryParam('__clerk_ticket') : null;
+    const ticket = params?.ticket ?? ticketFromUrl ?? undefined;
+    if (!ticket && !inBrowser()) {
+      throw new Error('signIn.ticket() requires a `ticket` param when called outside the browser.');
+    }
+    return this.create({ ticket });
+  }

Add unit tests for:

  • param provided
  • URL param provided (browser)
  • SSR call without param throws

🏁 Script executed:

#!/bin/bash
# Show the ticket method and its surrounding context
sed -n '880,950p' packages/clerk-js/src/core/resources/SignIn.ts

# Verify imports for inBrowser and getClerkQueryParam
rg -nP 'import\s+{\s*inBrowser' -g 'packages/clerk-js/src/core/resources/SignIn.ts'
rg -nP 'import\s+{\s*getClerkQueryParam' -g 'packages/clerk-js/src/core/resources/SignIn.ts'

# Locate implementations to confirm SSR behavior of these helpers
rg -n 'export function inBrowser' -g 'packages/clerk-js/src'
rg -n 'export function getClerkQueryParam' -g 'packages/clerk-js/src'

Length of output: 2998

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts || true

echo
echo "==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam" || true

echo
echo "==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam" | cut -d: -f1 | sort -u | while read -r f; do
  echo "---- $f ----"
  sed -n '1,200p' "$f" || true
done

echo
echo "==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S || true

echo
echo "==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser" | cut -d: -f1 | sort -u | while read -r f; do
  echo "---- $f ----"
  sed -n '1,200p' "$f" || true
done

Length of output: 113138

SSR guard + empty-ticket validation for signIn.ticket() (apply same to signUp.ticket())

getClerkQueryParam reads window.location.href and will throw during SSR — guard with inBrowser() and throw a clear error when no ticket is provided.

-  async ticket(params?: SignInFutureTicketParams): Promise<{ error: unknown }> {
-    const ticket = params?.ticket ?? getClerkQueryParam('__clerk_ticket');
-    return this.create({ ticket: ticket ?? undefined });
-  }
+  async ticket(params?: SignInFutureTicketParams): Promise<{ error: unknown }> {
+    const ticketFromUrl = inBrowser() ? getClerkQueryParam('__clerk_ticket') : null;
+    const ticket = params?.ticket ?? ticketFromUrl ?? undefined;
+    if (!ticket && !inBrowser()) {
+      throw new Error('signIn.ticket() requires a `ticket` param when called outside the browser.');
+    }
+    return this.create({ ticket });
+  }

Actions:

  • Apply above change to packages/clerk-js/src/core/resources/SignIn.ts (ticket method).
  • Apply the same SSR guard + error to packages/clerk-js/src/core/resources/SignUp.ts (ticket method) and add the inBrowser import if missing.
  • Add unit tests (Vitest) for each method:
    • param provided (returns/create called)
    • URL param provided (simulate browser window.search with __clerk_ticket)
    • SSR call without param throws


async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
Expand Down
7 changes: 7 additions & 0 deletions packages/clerk-js/src/core/resources/SignUp.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import type {
SignUpFuturePhoneCodeVerifyParams,
SignUpFutureResource,
SignUpFutureSSOParams,
SignUpFutureTicketParams,
SignUpFutureUpdateParams,
SignUpIdentificationField,
SignUpJSON,
Expand All @@ -44,6 +45,7 @@ import {
generateSignatureWithMetamask,
generateSignatureWithOKXWallet,
getBaseIdentifier,
getClerkQueryParam,
getCoinbaseWalletIdentifier,
getMetamaskIdentifier,
getOKXWalletIdentifier,
Expand Down Expand Up @@ -773,6 +775,11 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async ticket(params?: SignUpFutureTicketParams): Promise<{ error: unknown }> {
const ticket = params?.ticket ?? getClerkQueryParam('__clerk_ticket');
return this.create({ ...params, ticket: ticket ?? undefined });
}

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
Expand Down
2 changes: 2 additions & 0 deletions packages/react/src/stateProxy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand Down Expand Up @@ -119,6 +120,7 @@ export class StateProxy implements State {
update: gateMethod(target, 'update'),
sso: gateMethod(target, 'sso'),
password: gateMethod(target, 'password'),
ticket: gateMethod(target, 'ticket'),
finalize: gateMethod(target, 'finalize'),

verifications: wrapMethods(() => target().verifications, [
Expand Down
12 changes: 11 additions & 1 deletion packages/types/src/signInFuture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

export type SignInFuturePasswordParams =
Expand Down Expand Up @@ -110,6 +111,10 @@ export interface SignInFutureBackupCodeVerifyParams {
code: string;
}

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand Down Expand Up @@ -266,7 +271,12 @@ export interface SignInFutureResource {
};

/**
* Used to convert a sign-in with `status === ‘complete’` into an active session. Will cause anything observing the
* Used to perform a ticket-based sign-in.
*/
ticket: (params?: SignInFutureTicketParams) => Promise<{ error: unknown }>;

/**
* Used to convert a sign-in with `status === 'complete'` into an active session. Will cause anything observing the
* session state (such as the `useUser()` hook) to update automatically.
*/
finalize: (params?: SignInFutureFinalizeParams) => Promise<{ error: unknown }>;
Expand Down
12 changes: 11 additions & 1 deletion packages/types/src/signUpFuture.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ interface SignUpFutureAdditionalParams {

export interface SignUpFutureCreateParams extends SignUpFutureAdditionalParams {
transfer?: boolean;
ticket?: string;
}

// This will likely get more properties
Expand Down Expand Up @@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand Down Expand Up @@ -116,7 +121,12 @@ export interface SignUpFutureResource {
sso: (params: SignUpFutureSSOParams) => Promise<{ error: unknown }>;

/**
* Used to convert a sign-up with `status === ‘complete’` into an active session. Will cause anything observing the
* Used to perform a ticket-based sign-up.
*/
ticket: (params?: SignUpFutureTicketParams) => Promise<{ error: unknown }>;

/**
* Used to convert a sign-up with `status === 'complete'` into an active session. Will cause anything observing the
* session state (such as the `useUser()` hook) to update automatically.
*/
finalize: (params?: SignUpFutureFinalizeParams) => Promise<{ error: unknown }>;
Expand Down
Loading