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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
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
5 changes: 5 additions & 0 deletions .changeset/deep-wombats-retire.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/clerk-js': patch
---

[Experimental] Type method returns using ClerkError
80 changes: 41 additions & 39 deletions packages/clerk-js/src/core/resources/SignIn.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import { inBrowser } from '@clerk/shared/browser';
import { ClerkWebAuthnError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, ClerkWebAuthnError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptFirstFactorParams,
Expand DownExpand Up@@ -686,18 +686,19 @@ class SignInFuture implements SignInFutureResource {
return this.resource.secondFactorVerification;
}

async sendResetPasswordEmailCode(): Promise<{ error: unknown }> {
async sendResetPasswordEmailCode(): Promise<{ error: ClerkError | null }> {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
throw new Error('Cannot reset password without a sign in.');
}

const resetPasswordEmailCodeFactor = this.resource.supportedFirstFactors?.find(
f => f.strategy === 'reset_password_email_code',
);

if (!resetPasswordEmailCodeFactor) {
throw new Error('Reset password email code factor not found');
throw new ClerkRuntimeError('Reset password email code factor not found', {
code: 'factor_not_found',
});
}

const { emailAddressId } = resetPasswordEmailCodeFactor;
Expand All@@ -708,7 +709,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyResetPasswordEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -718,7 +719,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: unknown }> {
async submitResetPassword(params: SignInFutureResetPasswordSubmitParams): Promise<{ error: ClerkError | null }> {
const { password, signOutOfOtherSessions = true } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -736,13 +737,13 @@ class SignInFuture implements SignInFutureResource {
});
}

async create(params: SignInFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignInFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async password(params: SignInFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignInFuturePasswordParams): Promise<{ error: ClerkError | null }> {
if ([params.identifier, params.emailAddress, params.phoneNumber].filter(Boolean).length > 1) {
throw new Error('Only one of identifier, emailAddress, or phoneNumber can be provided');
}
Expand All@@ -763,7 +764,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: unknown }> {
async sendEmailCode(params: SignInFutureEmailCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { emailAddress, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -784,7 +785,7 @@ class SignInFuture implements SignInFutureResource {

const emailCodeFactor = this.selectFirstFactor({ strategy: 'email_code', emailAddressId });
if (!emailCodeFactor) {
throw new Error('Email code factor not found');
throw new ClerkRuntimeError('Email code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -794,7 +795,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignInFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -804,7 +805,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: unknown }> {
async sendEmailLink(params: SignInFutureEmailLinkSendParams): Promise<{ error: ClerkError | null }> {
const { emailAddress, verificationUrl, emailAddressId } = params;
if (!this.resource.id && emailAddressId) {
throw new Error(
Expand All@@ -825,7 +826,7 @@ class SignInFuture implements SignInFutureResource {

const emailLinkFactor = this.selectFirstFactor({ strategy: 'email_link', emailAddressId });
if (!emailLinkFactor) {
throw new Error('Email link factor not found');
throw new ClerkRuntimeError('Email link factor not found', { code: 'factor_not_found' });
}

let absoluteVerificationUrl = verificationUrl;
Expand All@@ -846,7 +847,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async waitForEmailLinkVerification(): Promise<{ error: unknown }> {
async waitForEmailLinkVerification(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { run, stop } = Poller();
await new Promise((resolve, reject) => {
Expand All@@ -867,7 +868,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignInFuturePhoneCodeSendParams = {}): Promise<{ error: ClerkError | null }> {
const { phoneNumber, phoneNumberId, channel = 'sms' } = params;
if (!this.resource.id && phoneNumberId) {
throw new Error(
Expand All@@ -888,7 +889,7 @@ class SignInFuture implements SignInFutureResource {

const phoneCodeFactor = this.selectFirstFactor({ strategy: 'phone_code', phoneNumberId });
if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -898,7 +899,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignInFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -908,7 +909,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async sso(params: SignInFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignInFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl, popup, oidcPrompt, enterpriseConnectionId } = params;
return runAsyncResourceTask(this.resource, async () => {
let actionCompleteRedirectUrl = redirectUrl;
Expand DownExpand Up@@ -959,7 +960,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async web3(params: SignInFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignInFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -993,7 +994,7 @@ class SignInFuture implements SignInFutureResource {
f => f.strategy === strategy,
) as Web3SignatureFactor;
if (!web3FirstFactor) {
throw new Error('Web3 first factor not found');
throw new ClerkRuntimeError('Web3 first factor not found', { code: 'factor_not_found' });
}

await this.resource.__internal_basePost({
Expand All@@ -1003,7 +1004,7 @@ class SignInFuture implements SignInFutureResource {

const { message } = this.firstFactorVerification;
if (!message) {
throw new Error('Web3 nonce not found');
throw new ClerkRuntimeError('Web3 nonce not found', { code: 'web3_nonce_not_found' });
}

let signature: string;
Expand All@@ -1030,7 +1031,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: unknown }> {
async passkey(params?: SignInFuturePasskeyParams): Promise<{ error: ClerkError | null }> {
const { flow } = params || {};

/**
Expand All@@ -1056,7 +1057,7 @@ class SignInFuture implements SignInFutureResource {
const passKeyFactor = this.supportedFirstFactors.find(f => f.strategy === 'passkey') as PasskeyFactor;

if (!passKeyFactor) {
clerkVerifyPasskeyCalledBeforeCreate();
throw new ClerkRuntimeError('Passkey factor not found', { code: 'factor_not_found' });
}
await this.resource.__internal_basePost({
body: { strategy: 'passkey' },
Expand All@@ -1068,7 +1069,7 @@ class SignInFuture implements SignInFutureResource {
const publicKeyOptions = nonce ? convertJSONToPublicKeyRequestOptions(JSON.parse(nonce)) : null;

if (!publicKeyOptions) {
clerkMissingWebAuthnPublicKeyOptions('get');
throw new ClerkRuntimeError('Missing public key options', { code: 'missing_public_key_options' });
}

let canUseConditionalUI = false;
Expand All@@ -1088,7 +1089,7 @@ class SignInFuture implements SignInFutureResource {
});

if (!publicKeyCredential) {
throw error;
throw new ClerkWebAuthnError(error.message, { code: 'passkey_retrieval_failed' });
}

await this.resource.__internal_basePost({
Expand All@@ -1101,12 +1102,12 @@ class SignInFuture implements SignInFutureResource {
});
}

async sendMFAPhoneCode(): Promise<{ error: unknown }> {
async sendMFAPhoneCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const phoneCodeFactor = this.resource.supportedSecondFactors?.find(f => f.strategy === 'phone_code');

if (!phoneCodeFactor) {
throw new Error('Phone code factor not found');
throw new ClerkRuntimeError('Phone code factor not found', { code: 'factor_not_found' });
}

const { phoneNumberId } = phoneCodeFactor;
Expand All@@ -1117,7 +1118,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyMFAPhoneCode(params: SignInFutureMFAPhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1127,7 +1128,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: unknown }> {
async verifyTOTP(params: SignInFutureTOTPVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1137,7 +1138,7 @@ class SignInFuture implements SignInFutureResource {
});
}

async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: unknown }> {
async verifyBackupCode(params: SignInFutureBackupCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -1147,18 +1148,19 @@ class SignInFuture implements SignInFutureResource {
});
}

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

async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignInFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

if (!this.resource.createdSessionId) {
throw new Error('Cannot finalize sign-in without a created session.');
}

return runAsyncResourceTask(this.resource, async () => {
// Reload the client to prevent an issue where the created session is not picked up.
await SignIn.clerk.client?.reload();

Expand Down
24 changes: 12 additions & 12 deletions packages/clerk-js/src/core/resources/SignUp.ts
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { type ClerkError, ClerkRuntimeError, isCaptchaError, isClerkAPIResponseError } from '@clerk/shared/error';
import { Poller } from '@clerk/shared/poller';
import type {
AttemptEmailAddressVerificationParams,
Expand DownExpand Up@@ -707,13 +707,13 @@ class SignUpFuture implements SignUpFutureResource {
await this.resource.__internal_basePost({ path: this.resource.pathRoot, body });
}

async create(params: SignUpFutureCreateParams): Promise<{ error: unknown }> {
async create(params: SignUpFutureCreateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this._create(params);
});
}

async update(params: SignUpFutureUpdateParams): Promise<{ error: unknown }> {
async update(params: SignUpFutureUpdateParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const body: Record<string, unknown> = {
...params,
Expand All@@ -724,7 +724,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async password(params: SignUpFuturePasswordParams): Promise<{ error: unknown }> {
async password(params: SignUpFuturePasswordParams): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();

Expand All@@ -741,7 +741,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendEmailCode(): Promise<{ error: unknown }> {
async sendEmailCode(): Promise<{ error: ClerkError | null }> {
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
body: { strategy: 'email_code' },
Expand All@@ -750,7 +750,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: unknown }> {
async verifyEmailCode(params: SignUpFutureEmailCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -760,7 +760,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: unknown }> {
async sendPhoneCode(params: SignUpFuturePhoneCodeSendParams): Promise<{ error: ClerkError | null }> {
const { phoneNumber, channel = 'sms' } = params;
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.id) {
Expand All@@ -778,7 +778,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: unknown }> {
async verifyPhoneCode(params: SignUpFuturePhoneCodeVerifyParams): Promise<{ error: ClerkError | null }> {
const { code } = params;
return runAsyncResourceTask(this.resource, async () => {
await this.resource.__internal_basePost({
Expand All@@ -788,7 +788,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async sso(params: SignUpFutureSSOParams): Promise<{ error: unknown }> {
async sso(params: SignUpFutureSSOParams): Promise<{ error: ClerkError | null }> {
const { strategy, redirectUrl, redirectCallbackUrl } = params;
return runAsyncResourceTask(this.resource, async () => {
const { captchaToken, captchaWidgetType, captchaError } = await this.getCaptchaToken();
Expand DownExpand Up@@ -822,7 +822,7 @@ class SignUpFuture implements SignUpFutureResource {
});
}

async web3(params: SignUpFutureWeb3Params): Promise<{ error: unknown }> {
async web3(params: SignUpFutureWeb3Params): Promise<{ error: ClerkError | null }> {
const { strategy, unsafeMetadata, legalAccepted } = params;
const provider = strategy.replace('web3_', '').replace('_signature', '') as Web3Provider;

Expand DownExpand Up@@ -888,12 +888,12 @@ class SignUpFuture implements SignUpFutureResource {
});
}

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

async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: unknown }> {
async finalize(params?: SignUpFutureFinalizeParams): Promise<{ error: ClerkError | null }> {
const { navigate } = params || {};
return runAsyncResourceTask(this.resource, async () => {
if (!this.resource.createdSessionId) {
Expand Down
Loading
Loading