Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line numberDiff line numberDiff 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ import type {
SignInFutureResetPasswordSubmitParams,
SignInFutureResource,
SignInFutureSSOParams,
SignInFutureTicketParams,
SignInFutureTOTPVerifyParams,
SignInIdentifier,
SignInJSON,
Expand DownExpand 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
Copy Markdown
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/bashset -euo pipefail
echo"==== SignIn.ts top imports (lines 1-120) ===="
sed -n '1,120p' packages/clerk-js/src/core/resources/SignIn.ts ||trueechoecho"==== Search for occurrences of getClerkQueryParam ===="
rg -n --hidden --no-ignore "getClerkQueryParam"||trueechoecho"==== Files containing getClerkQueryParam (show up to 200 lines) ===="
rg -n --hidden --no-ignore "getClerkQueryParam"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedoneechoecho"==== Search for inBrowser implementation/exports ===="
rg -n --hidden --no-ignore "export .*inBrowser|function inBrowser" -S ||trueechoecho"==== Files referencing inBrowser (show up to 200 lines) ===="
rg -n --hidden --no-ignore "inBrowser"| cut -d: -f1 | sort -u |whileread -r f;doecho"---- $f ----"
sed -n '1,200p'"$f"||truedone

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
Original file line numberDiff line numberDiff 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 DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -91,6 +91,7 @@ export class StateProxy implements State {
'verifyTOTP',
'verifyBackupCode',
] as const),
ticket: this.gateMethod(target, 'ticket'),
},
};
}
Expand DownExpand 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
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ export interface SignInFutureCreateParams {
redirectUrl?: string;
actionCompleteRedirectUrl?: string;
transfer?: boolean;
ticket?: string;
}

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

export interface SignInFutureTicketParams {
ticket: string;
}

export interface SignInFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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
Original file line numberDiff line numberDiff 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 DownExpand Up@@ -50,6 +51,10 @@ export interface SignUpFutureSSOParams {
redirectCallbackUrl: string;
}

export interface SignUpFutureTicketParams extends SignUpFutureAdditionalParams {
ticket: string;
}

export interface SignUpFutureFinalizeParams {
navigate?: SetActiveNavigate;
}
Expand DownExpand 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