import * as CSS from 'csstype'; /** * Generic Clerk API error structure. */ interface ClerkAPIError { code: string; message: string; longMessage?: string; meta?: { paramName?: string; sessionId?: string; emailAddresses?: string[]; identifiers?: string[]; zxcvbn?: { suggestions: { code: string; message: string; }[]; }; permissions?: string[]; }; } interface ClerkRuntimeError { code: string; message: string; } type AlertId = 'danger' | 'warning'; type FieldId = 'firstName' | 'lastName' | 'name' | 'slug' | 'emailAddress' | 'phoneNumber' | 'currentPassword' | 'newPassword' | 'signOutOfOtherSessions' | 'passkeyName' | 'password' | 'confirmPassword' | 'identifier' | 'username' | 'code' | 'role' | 'deleteConfirmation' | 'deleteOrganizationConfirmation' | 'enrollmentMode' | 'affiliationEmailAddress' | 'deleteExistingInvitationsSuggestions'; type ProfileSectionId = 'profile' | 'username' | 'emailAddresses' | 'phoneNumbers' | 'connectedAccounts' | 'enterpriseAccounts' | 'web3Wallets' | 'password' | 'passkeys' | 'mfa' | 'danger' | 'activeDevices' | 'organizationProfile' | 'organizationDanger' | 'organizationDomains' | 'manageVerifiedDomains'; type ProfilePageId = 'account' | 'security' | 'organizationGeneral' | 'organizationMembers'; type UserPreviewId = 'userButton' | 'personalWorkspace'; type OrganizationPreviewId = 'organizationSwitcherTrigger' | 'organizationList' | 'organizationSwitcherListedOrganization' | 'organizationSwitcherActiveOrganization'; type CardActionId = 'havingTrouble' | 'alternativeMethods' | 'signUp' | 'signIn' | 'usePasskey'; type MenuId = 'invitation' | 'member' | ProfileSectionId; type SelectId = 'countryCode' | 'role'; interface Web3ProviderData { provider: Web3Provider; strategy: Web3Strategy; name: string; } type MetamaskWeb3Provider = 'metamask'; type CoinbaseWeb3Provider = 'coinbase'; type CoinbaseWalletWeb3Provider = 'coinbase_wallet'; type Web3Provider = MetamaskWeb3Provider | CoinbaseWeb3Provider | CoinbaseWalletWeb3Provider; declare const WEB3_PROVIDERS: Web3ProviderData[]; interface getWeb3ProviderDataProps { provider?: Web3Provider; strategy?: Web3Strategy; } declare function getWeb3ProviderData({ provider, strategy, }: getWeb3ProviderDataProps): Web3ProviderData | undefined | null; type GoogleOneTapStrategy = 'google_one_tap'; type PasskeyStrategy = 'passkey'; type PasswordStrategy = 'password'; type PhoneCodeStrategy = 'phone_code'; type EmailCodeStrategy = 'email_code'; type EmailLinkStrategy = 'email_link'; type TicketStrategy = 'ticket'; type TOTPStrategy = 'totp'; type BackupCodeStrategy = 'backup_code'; type ResetPasswordPhoneCodeStrategy = 'reset_password_phone_code'; type ResetPasswordEmailCodeStrategy = 'reset_password_email_code'; type CustomOAuthStrategy = `oauth_custom_${string}`; type OAuthStrategy = `oauth_${OAuthProvider}` | CustomOAuthStrategy; type Web3Strategy = `web3_${Web3Provider}_signature`; type SamlStrategy = 'saml'; type OAuthScope = string; interface OAuthProviderData { provider: OAuthProvider; strategy: OAuthStrategy; name: string; docsUrl: string; } type FacebookOauthProvider = 'facebook'; type GoogleOauthProvider = 'google'; type HubspotOauthProvider = 'hubspot'; type GithubOauthProvider = 'github'; type TiktokOauthProvider = 'tiktok'; type GitlabOauthProvider = 'gitlab'; type DiscordOauthProvider = 'discord'; type TwitterOauthProvider = 'twitter'; type TwitchOauthProvider = 'twitch'; type LinkedinOauthProvider = 'linkedin'; type LinkedinOIDCOauthProvider = 'linkedin_oidc'; type DropboxOauthProvider = 'dropbox'; type AtlassianOauthProvider = 'atlassian'; type BitbucketOauthProvider = 'bitbucket'; type MicrosoftOauthProvider = 'microsoft'; type NotionOauthProvider = 'notion'; type AppleOauthProvider = 'apple'; type LineOauthProvider = 'line'; type InstagramOauthProvider = 'instagram'; type CoinbaseOauthProvider = 'coinbase'; type SpotifyOauthProvider = 'spotify'; type XeroOauthProvider = 'xero'; type BoxOauthProvider = 'box'; type SlackOauthProvider = 'slack'; type LinearOauthProvider = 'linear'; type XOauthProvider = 'x'; type EnstallOauthProvider = 'enstall'; type HuggingfaceOAuthProvider = 'huggingface'; type CustomOauthProvider = `custom_${string}`; type OAuthProvider = FacebookOauthProvider | GoogleOauthProvider | HubspotOauthProvider | GithubOauthProvider | TiktokOauthProvider | GitlabOauthProvider | DiscordOauthProvider | TwitterOauthProvider | TwitchOauthProvider | LinkedinOauthProvider | LinkedinOIDCOauthProvider | DropboxOauthProvider | AtlassianOauthProvider | BitbucketOauthProvider | MicrosoftOauthProvider | NotionOauthProvider | AppleOauthProvider | LineOauthProvider | InstagramOauthProvider | CoinbaseOauthProvider | SpotifyOauthProvider | XeroOauthProvider | BoxOauthProvider | SlackOauthProvider | LinearOauthProvider | XOauthProvider | EnstallOauthProvider | HuggingfaceOAuthProvider | CustomOauthProvider; declare const OAUTH_PROVIDERS: OAuthProviderData[]; interface getOAuthProviderDataProps { provider?: OAuthProvider; strategy?: OAuthStrategy; } declare function getOAuthProviderData({ provider, strategy, }: getOAuthProviderDataProps): OAuthProviderData | undefined | null; declare function sortedOAuthProviders(sortingArray: OAuthStrategy[]): OAuthProviderData[]; type SamlIdpSlug = 'saml_okta' | 'saml_google' | 'saml_microsoft' | 'saml_custom'; type SamlIdp = { name: string; logo: string; }; type SamlIdpMap = Record; declare const SAML_IDPS: SamlIdpMap; type EmUnit = string; type FontWeight = string; type BoxShadow = string; type TransparentColor = 'transparent'; type BuiltInColors = 'black' | 'blue' | 'red' | 'green' | 'grey' | 'white' | 'yellow'; type HexColor = `#${string}`; type HslaColor = { h: number; s: number; l: number; a?: number; }; type RgbaColor = { r: number; g: number; b: number; a?: number; }; type HexColorString = HexColor; type HslaColorString = `hsl(${string})` | `hsla(${string})`; type RgbaColorString = `rgb(${string})` | `rgba(${string})`; type Color = string | HexColor | HslaColor | RgbaColor | TransparentColor; type ColorString = HexColorString | HslaColorString | RgbaColorString; type CSSProperties = CSS.PropertiesFallback; type CSSPropertiesWithMultiValues = { [K in keyof CSSProperties]: CSSProperties[K]; }; type CSSPseudos = { [K in CSS.Pseudos as `&${K}`]?: CSSObject; }; interface CSSObject extends CSSPropertiesWithMultiValues, CSSPseudos { } type UserDefinedStyle = string | CSSObject; type Shade = '25' | '50' | '100' | '150' | '200' | '300' | '400' | '500' | '600' | '700' | '750' | '800' | '850' | '900' | '950'; type ColorScale = Record; type AlphaColorScale = { [K in Shade]: T; }; type ColorScaleWithRequiredBase = Partial> & { '500': T; }; type CssColorOrScale = string | ColorScaleWithRequiredBase; type CssColorOrAlphaScale = string | AlphaColorScale; type CssColor = string | TransparentColor | BuiltInColors; type CssLengthUnit = string; type FontWeightNamedValue = CSS.Properties['fontWeight']; type FontWeightNumericValue = 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900; type FontWeightScale = { normal?: FontWeightNamedValue | FontWeightNumericValue; medium?: FontWeightNamedValue | FontWeightNumericValue; bold?: FontWeightNamedValue | FontWeightNumericValue; }; type WebSafeFont = 'Arial' | 'Brush Script MT' | 'Courier New' | 'Garamond' | 'Georgia' | 'Helvetica' | 'Tahoma' | 'Times New Roman' | 'Trebuchet MS' | 'Verdana'; type FontFamily = string | WebSafeFont; type LoadingState = 'loading'; type ErrorState = 'error'; type OpenState = 'open'; type ActiveState = 'active'; type ElementState = LoadingState | ErrorState | OpenState | ActiveState; type ControlState = ErrorState; /** * A type that describes the states and the ids that we will combine * in order to create all theming combinations * If jsx exists, the element can also receive a typed function that returns a JSX.Element */ type ConfigOptions = { states: ElementState; ids: string; jsx: any; }; type WithOptions = { ids: Ids; states: States; jsx: Jsx; }; /** * Create a type union of all state + id combinations */ type StateSelectors = S extends never ? never : `${E}__${S}`; /** * Create a type union consisting of the base element with all valid ids appended */ type IdSelectors = Id extends never ? never : `${E}__${Id}`; /** * Create a type union consisting of all base, base+state, base+id, base+id+state combinations */ type ElementPartsKeys = StateSelectors | IdSelectors | StateSelectors, Opts['states']>; /** * Create an object type mapping base elements and part combinations (base, base+state, base+id, base+id+state) * to the value they can accept (usually a style rule, a string class or jsx) */ type Selectors = Partial> | Partial, UserDefinedStyle>>; /** * Convert a kebab-cased key from ElementsConfig into a camelCased Elements key */ type ElementObjectKey = K extends `${infer Parent}-${infer Rest}` ? `${Parent}${Capitalize}` : K; /** * A map that describes the possible combinations we need to generate * for each unique base element * Kebab-case is used to differentiate between the container and child elements */ type ElementsConfig = { button: WithOptions; input: WithOptions; checkbox: WithOptions; radio: WithOptions; table: WithOptions; rootBox: WithOptions; cardBox: WithOptions; card: WithOptions; actionCard: WithOptions; popoverBox: WithOptions; logoBox: WithOptions; logoImage: WithOptions; header: WithOptions; headerTitle: WithOptions; headerSubtitle: WithOptions; backRow: WithOptions; backLink: WithOptions; main: WithOptions; footer: WithOptions; footerItem: WithOptions; footerAction: WithOptions; footerActionText: WithOptions; footerActionLink: WithOptions; footerPages: WithOptions; footerPagesLink: WithOptions<'help' | 'terms' | 'privacy'>; socialButtons: WithOptions; socialButtonsIconButton: WithOptions; socialButtonsBlockButton: WithOptions; socialButtonsBlockButtonText: WithOptions; socialButtonsProviderIcon: WithOptions; socialButtonsProviderInitialIcon: WithOptions; enterpriseButtonsProviderIcon: WithOptions; alternativeMethods: WithOptions; alternativeMethodsBlockButton: WithOptions; alternativeMethodsBlockButtonText: WithOptions; alternativeMethodsBlockButtonArrow: WithOptions; otpCodeField: WithOptions; otpCodeFieldInputs: WithOptions; otpCodeFieldInput: WithOptions; otpCodeFieldErrorText: WithOptions; dividerRow: WithOptions; dividerText: WithOptions; dividerLine: WithOptions; formHeader: WithOptions; formHeaderTitle: WithOptions; formHeaderSubtitle: WithOptions; formResendCodeLink: WithOptions; verificationLinkStatusBox: WithOptions; verificationLinkStatusIconBox: WithOptions; verificationLinkStatusIcon: WithOptions; verificationLinkStatusText: WithOptions; form: WithOptions; formContainer: WithOptions; formFieldRow: WithOptions; formField: WithOptions; formFieldLabelRow: WithOptions; formFieldLabel: WithOptions; formFieldRadioGroup: WithOptions; formFieldRadioGroupItem: WithOptions; formFieldRadioInput: WithOptions; formFieldRadioLabel: WithOptions; formFieldRadioLabelTitle: WithOptions; formFieldRadioLabelDescription: WithOptions; formFieldAction: WithOptions; formFieldInput: WithOptions; formFieldErrorText: WithOptions; formFieldWarningText: WithOptions; formFieldSuccessText: WithOptions; formFieldInfoText: WithOptions; formFieldHintText: WithOptions; formButtonPrimary: WithOptions; formButtonReset: WithOptions; formFieldInputGroup: WithOptions; formFieldInputShowPasswordButton: WithOptions; formFieldInputShowPasswordIcon: WithOptions; formFieldInputCopyToClipboardButton: WithOptions; formFieldInputCopyToClipboardIcon: WithOptions; phoneInputBox: WithOptions; formInputGroup: WithOptions; avatarBox: WithOptions; avatarImage: WithOptions; avatarImageActions: WithOptions; avatarImageActionsUpload: WithOptions; avatarImageActionsRemove: WithOptions; userButtonBox: WithOptions; userButtonOuterIdentifier: WithOptions; userButtonTrigger: WithOptions; userButtonAvatarBox: WithOptions; userButtonAvatarImage: WithOptions; userButtonPopoverRootBox: WithOptions; userButtonPopoverCard: WithOptions; userButtonPopoverMain: WithOptions; userButtonPopoverActions: WithOptions<'singleSession' | 'multiSession'>; userButtonPopoverActionButton: WithOptions<'manageAccount' | 'addAccount' | 'signOut' | 'signOutAll'>; userButtonPopoverActionButtonIconBox: WithOptions<'manageAccount' | 'addAccount' | 'signOut' | 'signOutAll'>; userButtonPopoverActionButtonIcon: WithOptions<'manageAccount' | 'addAccount' | 'signOut' | 'signOutAll'>; userButtonPopoverCustomItemButton: WithOptions; userButtonPopoverCustomItemButtonIconBox: WithOptions; userButtonPopoverActionItemButtonIcon: WithOptions; userButtonPopoverFooter: WithOptions; userButtonPopoverFooterPagesLink: WithOptions<'terms' | 'privacy'>; organizationSwitcherTrigger: WithOptions; organizationSwitcherTriggerIcon: WithOptions; organizationSwitcherPopoverRootBox: WithOptions; organizationSwitcherPopoverCard: WithOptions; organizationSwitcherPopoverMain: WithOptions; organizationSwitcherPopoverActions: WithOptions; organizationSwitcherPopoverInvitationActions: WithOptions; organizationSwitcherPopoverInvitationActionsBox: WithOptions; organizationSwitcherPopoverActionButton: WithOptions<'manageOrganization' | 'createOrganization' | 'switchOrganization'>; organizationSwitcherPreviewButton: WithOptions; organizationSwitcherInvitationAcceptButton: WithOptions; organizationSwitcherPopoverActionButtonIconBox: WithOptions<'manageOrganization' | 'createOrganization'>; organizationSwitcherPopoverActionButtonIcon: WithOptions<'manageOrganization' | 'createOrganization'>; organizationSwitcherPopoverFooter: WithOptions; organizationListPreviewItems: WithOptions; organizationListPreviewItem: WithOptions; organizationListPreviewButton: WithOptions; organizationListPreviewItemActionButton: WithOptions; organizationListCreateOrganizationActionButton: WithOptions; userPreview: WithOptions; userPreviewAvatarContainer: WithOptions; userPreviewAvatarBox: WithOptions; userPreviewAvatarImage: WithOptions; userPreviewAvatarIcon: WithOptions; userPreviewTextContainer: WithOptions; userPreviewMainIdentifier: WithOptions; userPreviewSecondaryIdentifier: WithOptions; organizationPreview: WithOptions; organizationPreviewAvatarContainer: WithOptions; organizationPreviewAvatarBox: WithOptions; organizationPreviewAvatarImage: WithOptions; organizationPreviewTextContainer: WithOptions; organizationPreviewMainIdentifier: WithOptions; organizationPreviewSecondaryIdentifier: WithOptions; organizationAvatarUploaderContainer: WithOptions; membersPageInviteButton: WithOptions; identityPreview: WithOptions; identityPreviewText: WithOptions; identityPreviewEditButton: WithOptions; identityPreviewEditButtonIcon: WithOptions; passkeyIcon: WithOptions<'firstFactor'>; accountSwitcherActionButton: WithOptions<'addAccount' | 'signOutAll'>; accountSwitcherActionButtonIconBox: WithOptions<'addAccount' | 'signOutAll'>; accountSwitcherActionButtonIcon: WithOptions<'addAccount' | 'signOutAll'>; alert: WithOptions; alertIcon: WithOptions; alertText: WithOptions; alertTextContainer: WithOptions; tagInputContainer: WithOptions; tagPillIcon: WithOptions; tagPillContainer: WithOptions; tabPanel: WithOptions; tabButton: WithOptions; tabListContainer: WithOptions; tableHead: WithOptions; paginationButton: WithOptions; paginationButtonIcon: WithOptions; paginationRowText: WithOptions<'allRowsCount' | 'rowsCount' | 'displaying'>; selectButton: WithOptions; selectSearchInput: WithOptions; selectButtonIcon: WithOptions; selectOptionsContainer: WithOptions; selectOption: WithOptions; menuButton: WithOptions; menuList: WithOptions; menuItem: WithOptions; modalBackdrop: WithOptions; modalContent: WithOptions; modalCloseButton: WithOptions; profileSection: WithOptions; profileSectionItemList: WithOptions; profileSectionItem: WithOptions; profileSectionHeader: WithOptions; profileSectionTitle: WithOptions; profileSectionTitleText: WithOptions; profileSectionSubtitle: WithOptions; profileSectionSubtitleText: WithOptions; profileSectionContent: WithOptions; profileSectionPrimaryButton: WithOptions; profilePage: WithOptions; formattedPhoneNumber: WithOptions; formattedPhoneNumberFlag: WithOptions; formattedPhoneNumberText: WithOptions; formattedDate: WithOptions<'tableCell'>; scrollBox: WithOptions; navbar: WithOptions; navbarButtons: WithOptions; navbarButton: WithOptions; navbarButtonIcon: WithOptions; navbarMobileMenuRow: WithOptions; navbarMobileMenuButton: WithOptions; navbarMobileMenuButtonIcon: WithOptions; pageScrollBox: WithOptions; page: WithOptions; activeDevice: WithOptions<'current'>; activeDeviceListItem: WithOptions<'current'>; activeDeviceIcon: WithOptions<'mobile' | 'desktop'>; impersonationFab: WithOptions; impersonationFabIcon: WithOptions; impersonationFabIconContainer: WithOptions; impersonationFabTitle: WithOptions; impersonationFabActionLink: WithOptions; invitationsSentIconBox: WithOptions; invitationsSentIcon: WithOptions; qrCodeRow: WithOptions; qrCodeContainer: WithOptions; badge: WithOptions<'primary' | 'actionRequired'>; notificationBadge: WithOptions; buttonArrowIcon: WithOptions; providerIcon: WithOptions; spinner: WithOptions; }; type Elements = { [k in keyof ElementsConfig]: Selectors & string, ElementsConfig[k]>; }[keyof ElementsConfig]; type Variables = { /** * The primary color used throughout the components. Set this to your brand color. * @default '#2F3037' */ colorPrimary?: CssColorOrScale; /** * The color of text appearing on top of an element that with a background color of {@link Variables.colorPrimary}, * eg: solid primary buttons. * @default 'white' */ colorTextOnPrimaryBackground?: CssColor; /** * The color used to indicate errors or destructive actions. Set this to your brand's danger color. * @default '#EF4444' */ colorDanger?: CssColorOrScale; /** * The color used to indicate an action that completed successfully or a positive result. * @default '#22C543' */ colorSuccess?: CssColorOrScale; /** * The color used for potentially destructive actions or when the user's attention is required. * @default '#F36B16' */ colorWarning?: CssColorOrScale; /** * The color that will be used as the neutral color for all the components. To achieve sufficient contrast, * light themes should be using dark shades ('black'), while dark themes should be using light shades ('white'). * This option applies to borders, backgrounds for hovered elements, hovered dropdown options etc. * @default 'black' */ colorNeutral?: CssColorOrAlphaScale; /** * The default text color. * @default '#212126' */ colorText?: CssColor; /** * The text color for elements of lower importance, eg: a subtitle text. * This color is a lighter shade of {@link Variables.colorText}. * @default '#747686' */ colorTextSecondary?: CssColor; /** * The background color for the card container. * @default 'white' */ colorBackground?: CssColor; /** * The default text color inside input elements. To customise the input background color instead, use {@link Variables.colorInputBackground}. * @default 'black' */ colorInputText?: CssColor; /** * The background color for all input elements. * @default 'white' */ colorInputBackground?: CssColor; /** * The color of the avatar shimmer * @default 'rgba(255, 255, 255, 0.36)' */ colorShimmer?: CssColor; /** * The default font that will be used in all components. * This can be the name of a custom font loaded by your code or the name of a web-safe font ((@link WebSafeFont}) * If a specific fontFamily is not provided, the components will inherit the font of the parent element. * @default 'inherit' * @example * { fontFamily: 'Montserrat' } */ fontFamily?: FontFamily; /** * The default font that will be used in all buttons. See {@link Variables.fontFamily} for details. * If not provided, {@link Variables.fontFamily} will be used instead. * @default 'inherit' */ fontFamilyButtons?: FontFamily; /** * The value will be used as the base `md` to calculate all the other scale values (`xs`, `sm`, `lg` and `xl`). * By default, this value is relative to the root fontSize of the html element. * @default '0.8125rem' */ fontSize?: CssLengthUnit; /** * The font weight the components will use. By default, the components will use the 400, 500, 600 and 700 weights * for normal, medium, semibold and bold text respectively. * You can override the default weights by passing a {@FontWeightScale} object * @default { normal: 400, medium: 500, semibold: 600, bold: 700 }; */ fontWeight?: FontWeightScale; /** * The size that will be used as the `md` base borderRadius value. This is used as the base to calculate the `sm`, `lg`, `xl`, * our components use. As a general rule, the bigger an element is, the larger its borderRadius is going to be. * eg: the Card element uses 'xl' * @default '0.375rem' */ borderRadius?: CssLengthUnit; /** * The base spacing unit that all margins, paddings and gaps between the elements are derived from. * @default '1rem' */ spacingUnit?: CssLengthUnit; }; type BaseThemeTaggedType = { __type: 'prebuilt_appearance'; }; type BaseTheme = BaseThemeTaggedType; type Theme = { /** * A theme used as the base theme for the components. * For further customisation, you can use the {@link Theme.layout}, {@link Theme.variables} and {@link Theme.elements} props. * @example * import { dark } from "@clerk/themes"; * appearance={{ baseTheme: dark }} */ baseTheme?: BaseTheme | BaseTheme[]; /** * Configuration options that affect the layout of the components, allowing * customizations that hard to implement with just CSS. * Eg: placing the logo outside the card element */ layout?: Layout; /** * General theme overrides. This styles will be merged with our base theme. * Can override global styles like colors, fonts etc. * Eg: `colorPrimary: 'blue'` */ variables?: Variables; /** * Fine-grained theme overrides. Useful when you want to style * specific elements or elements that under a specific state. * Eg: `formButtonPrimary__loading: { backgroundColor: 'gray' }` */ elements?: Elements; }; type Layout = { /** * Controls whether the logo will be rendered inside or outside the component card. * To customise the logo further, you can use {@link Appearance.elements} * @default inside */ logoPlacement?: 'inside' | 'outside' | 'none'; /** * The URL of your custom logo the components will display. * By default, the components will use the logo you've set in the Clerk Dashboard. * This option is helpful when you need to display different logos for different themes, * eg: white logo on dark themes, black logo on light themes * To customise the logo further, you can use {@link Appearance.elements} * @default undefined */ logoImageUrl?: string; /** * Controls where the browser will redirect to after the user clicks the application logo, * usually found in the SignIn and SignUp components. * If a URL is provided, it will be used as the `href` of the link. * If a value is not passed in, the components will use the Home URL as set in the Clerk dashboard * @default undefined */ logoLinkUrl?: string; /** * Controls the variant that will be used for the social buttons. * By default, the components will use block buttons if you have less than * 3 social providers enabled, otherwise icon buttons will be used. * To customise the social buttons further, you can use {@link Appearance.elements} * @default auto */ socialButtonsVariant?: 'auto' | 'iconButton' | 'blockButton'; /** * Controls whether the social buttons will be rendered above or below the card form. * To customise the social button container further, you can use {@link Appearance.elements} * @default 'top' */ socialButtonsPlacement?: 'top' | 'bottom'; /** * Controls whether the SignIn or SignUp forms will include optional fields. * You can make a field required or optional through the {@link https://dashboard.clerk.com|Clerk dashboard}. * @default true */ showOptionalFields?: boolean; /** * This options enables the "Terms" link which is, by default, displayed on the bottom-right corner of the * prebuilt components. Clicking the link will open the passed URL in a new tab */ termsPageUrl?: string; /** * This options enables the "Help" link which is, by default, displayed on the bottom-right corner of the * prebuilt components. Clicking the link will open the passed URL in a new tab */ helpPageUrl?: string; /** * This options enables the "Privacy" link which is, by default, displayed on the bottom-right corner of the * prebuilt components. Clicking the link will open the passed URL in a new tab */ privacyPageUrl?: string; /** * This option enables the shimmer animation for the avatars of and * @default true */ shimmer?: boolean; /** * This option enables/disables animations for the components. If you want to disable animations, you can set this to false. * Also the prefers-reduced-motion media query is respected and animations are disabled if the user has set it to reduce motion regardless of this option. * @default true */ animations?: boolean; /** * This option disables development mode warning. * We don't recommend disabling this unless you want to see a preview of how the components will look in production. * @default false */ unsafe_disableDevelopmentModeWarnings?: boolean; }; type SignInTheme = Theme; type SignUpTheme = Theme; type UserButtonTheme = Theme; type UserProfileTheme = Theme; type OrganizationSwitcherTheme = Theme; type OrganizationListTheme = Theme; type OrganizationProfileTheme = Theme; type CreateOrganizationTheme = Theme; type UserVerificationTheme = Theme; type Appearance = T & { /** * Theme overrides that only apply to the `` component */ signIn?: T; /** * Theme overrides that only apply to the `` component */ signUp?: T; /** * Theme overrides that only apply to the `` component */ userButton?: T; /** * Theme overrides that only apply to the `` component */ userProfile?: T; /** * Theme overrides that only apply to the `` component */ userVerification?: T; /** * Theme overrides that only apply to the `` component */ organizationSwitcher?: T; /** * Theme overrides that only apply to the `` component */ organizationList?: T; /** * Theme overrides that only apply to the `` component */ organizationProfile?: T; /** * Theme overrides that only apply to the `` component */ createOrganization?: T; /** * Theme overrides that only apply to the `` component */ oneTap?: T; }; type FirstNameAttribute = 'first_name'; type LastNameAttribute = 'last_name'; type PasswordAttribute = 'password'; type ClerkResourceReloadParams = { rotatingTokenNonce?: string; }; interface ClerkResource { readonly id?: string | undefined; pathRoot: string; reload(p?: ClerkResourceReloadParams): Promise; } interface AuthConfigResource extends ClerkResource { /** * Enabled single session configuration at the instance level. */ singleSessionMode: boolean; } interface BackupCodeResource extends ClerkResource { id: string; codes: string[]; createdAt: Date | null; updatedAt: Date | null; } type InstanceType = 'production' | 'development'; /** * @internal */ type TelemetryEvent = { event: string; /** * publishableKey */ pk?: string; /** * secretKey */ sk?: string; /** * instanceType */ it: InstanceType; /** * clerkVersion */ cv: string; /** * SDK */ sdk?: string; /** * SDK Version */ sdkv?: string; payload: Record; }; /** * @internal */ type TelemetryEventRaw = { event: TelemetryEvent['event']; eventSamplingRate?: number; payload: Payload; }; interface TelemetryCollector { isEnabled: boolean; isDebug: boolean; record(event: TelemetryEventRaw): void; } interface DeletedObjectResource { object: string; id?: string; slug?: string; deleted: boolean; } type PreferredSignInStrategy = 'password' | 'otp'; type CaptchaWidgetType = 'smart' | 'invisible' | null; type CaptchaProvider = 'hcaptcha' | 'turnstile'; interface DisplayConfigJSON { object: 'display_config'; id: string; after_sign_in_url: string; after_sign_out_all_url: string; after_sign_out_one_url: string; after_sign_up_url: string; after_switch_session_url: string; application_name: string; branded: boolean; captcha_public_key: string | null; captcha_widget_type: CaptchaWidgetType; captcha_public_key_invisible: string | null; captcha_provider: CaptchaProvider; home_url: string; instance_environment_type: string; logo_image_url: string; favicon_image_url: string; preferred_sign_in_strategy: PreferredSignInStrategy; sign_in_url: string; sign_up_url: string; support_email: string; theme: DisplayThemeJSON; user_profile_url: string; clerk_js_version?: string; organization_profile_url: string; create_organization_url: string; after_leave_organization_url: string; after_create_organization_url: string; google_one_tap_client_id?: string; show_devmode_warning: boolean; } interface DisplayConfigResource extends ClerkResource { id: string; afterSignInUrl: string; afterSignOutAllUrl: string; afterSignOutOneUrl: string; afterSignUpUrl: string; afterSwitchSessionUrl: string; applicationName: string; backendHost: string; branded: boolean; captchaPublicKey: string | null; captchaWidgetType: CaptchaWidgetType; captchaProvider: CaptchaProvider; captchaPublicKeyInvisible: string | null; homeUrl: string; instanceEnvironmentType: string; logoImageUrl: string; faviconImageUrl: string; preferredSignInStrategy: PreferredSignInStrategy; signInUrl: string; signUpUrl: string; supportEmail: string; theme: DisplayThemeJSON; userProfileUrl: string; clerkJSVersion?: string; experimental__forceOauthFirst?: boolean; organizationProfileUrl: string; createOrganizationUrl: string; afterLeaveOrganizationUrl: string; afterCreateOrganizationUrl: string; googleOneTapClientId?: string; showDevModeWarning: boolean; } interface OrganizationDomainVerification { status: OrganizationDomainVerificationStatus; strategy: 'email_code'; attempts: number; expiresAt: Date; } type OrganizationDomainVerificationStatus = 'unverified' | 'verified'; type OrganizationEnrollmentMode = 'manual_invitation' | 'automatic_invitation' | 'automatic_suggestion'; interface OrganizationDomainResource extends ClerkResource { id: string; name: string; organizationId: string; enrollmentMode: OrganizationEnrollmentMode; verification: OrganizationDomainVerification | null; createdAt: Date; updatedAt: Date; affiliationEmailAddress: string | null; totalPendingInvitations: number; totalPendingSuggestions: number; prepareAffiliationVerification: (params: PrepareAffiliationVerificationParams) => Promise; attemptAffiliationVerification: (params: AttemptAffiliationVerificationParams) => Promise; delete: () => Promise; updateEnrollmentMode: (params: UpdateEnrollmentModeParams) => Promise; } type PrepareAffiliationVerificationParams = { affiliationEmailAddress: string; }; type AttemptAffiliationVerificationParams = { code: string; }; type UpdateEnrollmentModeParams = Pick & { deletePending?: boolean; }; declare global { /** * If you want to provide custom types for the organizationInvitation.publicMetadata * object, simply redeclare this rule in the global namespace. * Every organizationInvitation object will use the provided type. */ interface OrganizationInvitationPublicMetadata { [k: string]: unknown; } interface OrganizationInvitationPrivateMetadata { [k: string]: unknown; } } interface OrganizationInvitationResource extends ClerkResource { id: string; emailAddress: string; organizationId: string; publicMetadata: OrganizationInvitationPublicMetadata; role: OrganizationCustomRoleKey; status: OrganizationInvitationStatus; createdAt: Date; updatedAt: Date; revoke: () => Promise; } type OrganizationInvitationStatus = 'pending' | 'accepted' | 'revoked'; interface OrganizationMembershipRequestResource extends ClerkResource { id: string; organizationId: string; status: OrganizationInvitationStatus; publicUserData: PublicUserData; createdAt: Date; updatedAt: Date; accept: () => Promise; reject: () => Promise; } /** * Pagination params in request */ type ClerkPaginationRequest = { /** * Maximum number of items returned per request. */ limit?: number; /** * This is the starting point for your fetched results. */ offset?: number; } & T; /** * Pagination params in response */ interface ClerkPaginatedResponse { data: T[]; total_count: number; } /** * Pagination params passed in FAPI client methods */ type ClerkPaginationParams = { /** * This is the starting point for your fetched results. */ initialPage?: number; /** * Maximum number of items returned per request. */ pageSize?: number; } & T; interface PermissionResource extends ClerkResource { id: string; key: string; name: string; type: 'system' | 'user'; description: string; createdAt: Date; updatedAt: Date; } interface RoleResource extends ClerkResource { id: string; key: string; name: string; description: string; permissions: PermissionResource[]; createdAt: Date; updatedAt: Date; } declare global { /** * If you want to provide custom types for the organization.publicMetadata object, * simply redeclare this rule in the global namespace. * Every organization object will use the provided type. */ interface OrganizationPublicMetadata { [k: string]: unknown; } /** * If you want to provide custom types for the organization.privateMetadata object, * simply redeclare this rule in the global namespace. * Every organization object will use the provided type. */ interface OrganizationPrivateMetadata { [k: string]: unknown; } } interface OrganizationResource extends ClerkResource { id: string; name: string; slug: string | null; imageUrl: string; hasImage: boolean; membersCount: number; pendingInvitationsCount: number; publicMetadata: OrganizationPublicMetadata; adminDeleteEnabled: boolean; maxAllowedMemberships: number; createdAt: Date; updatedAt: Date; update: (params: UpdateOrganizationParams) => Promise; getMemberships: GetMemberships; getInvitations: (params?: GetInvitationsParams) => Promise>; getRoles: (params?: GetRolesParams) => Promise>; getDomains: (params?: GetDomainsParams) => Promise>; getMembershipRequests: (params?: GetMembershipRequestParams) => Promise>; addMember: (params: AddMemberParams) => Promise; inviteMember: (params: InviteMemberParams) => Promise; inviteMembers: (params: InviteMembersParams) => Promise; updateMember: (params: UpdateMembershipParams) => Promise; removeMember: (userId: string) => Promise; createDomain: (domainName: string) => Promise; getDomain: ({ domainId }: { domainId: string; }) => Promise; destroy: () => Promise; setLogo: (params: SetOrganizationLogoParams) => Promise; } type GetRolesParams = ClerkPaginationParams; type GetMembersParams = ClerkPaginationParams<{ role?: OrganizationCustomRoleKey[]; }>; type GetDomainsParams = ClerkPaginationParams<{ enrollmentMode?: OrganizationEnrollmentMode; }>; type GetInvitationsParams = ClerkPaginationParams<{ status?: OrganizationInvitationStatus[]; }>; type GetMembershipRequestParams = ClerkPaginationParams<{ status?: OrganizationInvitationStatus; }>; interface AddMemberParams { userId: string; role: OrganizationCustomRoleKey; } interface InviteMemberParams { emailAddress: string; role: OrganizationCustomRoleKey; } interface InviteMembersParams { emailAddresses: string[]; role: OrganizationCustomRoleKey; } interface UpdateMembershipParams { userId: string; role: OrganizationCustomRoleKey; } interface UpdateOrganizationParams { name: string; slug?: string; } interface SetOrganizationLogoParams { file: Blob | File | string | null; } type GetMemberships = (params?: GetMembersParams) => Promise>; type SnakeToCamel = T extends `${infer A}_${infer B}` ? `${Uncapitalize}${Capitalize>}` : T extends object ? { [K in keyof T as SnakeToCamel]: T[K]; } : T; type DeepSnakeToCamel = T extends `${infer A}_${infer B}` ? `${Uncapitalize}${Capitalize>}` : T extends object ? { [K in keyof T as DeepSnakeToCamel]: DeepSnakeToCamel; } : T; type DeepCamelToSnake = T extends `${infer C0}${infer R}` ? `${C0 extends Uppercase ? '_' : ''}${Lowercase}${DeepCamelToSnake}` : T extends object ? { [K in keyof T as DeepCamelToSnake>]: DeepCamelToSnake; } : T; type CamelToSnake = T extends `${infer C0}${infer R}` ? `${C0 extends Uppercase ? '_' : ''}${Lowercase}${CamelToSnake}` : T extends object ? { [K in keyof T as CamelToSnake>]: T[K]; } : T; type DeepPartial = { [P in keyof T]?: T[P] extends object ? DeepPartial : T[P]; }; type DeepRequired = Required<{ [P in keyof T]: T[P] extends object | undefined ? DeepRequired> : T[P]; }>; /** * Internal type used by RecordToPath */ type PathImpl = Key extends string ? T[Key] extends Record ? `${Key}.${PathImpl> & string}` | `${Key}.${Exclude & string}` : never : never; /** * Internal type used by RecordToPath */ type PathImpl2 = PathImpl | keyof T; /** * Used to construct a type union containing all the keys (even if nested) of an object defined as const * const obj = { a: { b: '' }, c: '' } as const; * type Paths = RecordToPath * Paths contains: 'a' | 'a.b' | 'c' */ type RecordToPath = PathImpl2 extends string | keyof T ? PathImpl2 : keyof T; /** * Used to read the value of a string path inside an object defined as const * const obj = { a: { b: 'hello' }} as const; * type Value = PathValue * Value is now a union set containing a single type: 'hello' */ type PathValue> = P extends `${infer Key}.${infer Rest}` ? Key extends keyof T ? Rest extends RecordToPath ? PathValue : never : never : P extends keyof T ? T[P] : never; type IsSerializable = T extends Function ? false : true; /** * Excludes any non-serializable prop from an object */ type Serializable = { [K in keyof T as IsSerializable extends true ? K : never]: T[K]; }; /** * Enables autocompletion for a union type, while keeping the ability to use any string * or type of `T` */ type Autocomplete = U | (T & Record); /** * Omit without union flattening * */ type Without = { [P in keyof T as Exclude]: T[P]; }; interface Base { permission: string; role: string; } interface Placeholder { permission: unknown; role: unknown; } declare global { interface ClerkAuthorization { } } declare global { /** * If you want to provide custom types for the organizationMembership.publicMetadata * object, simply redeclare this rule in the global namespace. * Every organizationMembership object will use the provided type. */ interface OrganizationMembershipPublicMetadata { [k: string]: unknown; } /** * If you want to provide custom types for the organizationMembership.publicMetadata * object, simply redeclare this rule in the global namespace. * Every organizationMembership object will use the provided type. */ interface OrganizationMembershipPrivateMetadata { [k: string]: unknown; } } interface OrganizationMembershipResource extends ClerkResource { id: string; organization: OrganizationResource; permissions: OrganizationPermissionKey[]; publicMetadata: OrganizationMembershipPublicMetadata; publicUserData: PublicUserData; role: OrganizationCustomRoleKey; createdAt: Date; updatedAt: Date; destroy: () => Promise; update: (updateParams: UpdateOrganizationMembershipParams) => Promise; } type OrganizationCustomPermissionKey = ClerkAuthorization extends Placeholder ? ClerkAuthorization['permission'] extends string ? ClerkAuthorization['permission'] : Base['permission'] : Base['permission']; /** * OrganizationCustomRoleKey will be string unless the developer has provided their own types through `ClerkAuthorization` */ type OrganizationCustomRoleKey = ClerkAuthorization extends Placeholder ? ClerkAuthorization['role'] extends string ? ClerkAuthorization['role'] : Base['role'] : Base['role']; type OrganizationSystemPermissionKey = 'org:sys_domains:manage' | 'org:sys_profile:manage' | 'org:sys_profile:delete' | 'org:sys_memberships:read' | 'org:sys_memberships:manage' | 'org:sys_domains:read'; /** * OrganizationPermissionKey is a combination of system and custom permissions. * System permissions are only accessible from FAPI and client-side operations/utils */ type OrganizationPermissionKey = ClerkAuthorization extends Placeholder ? ClerkAuthorization['permission'] extends string ? ClerkAuthorization['permission'] | OrganizationSystemPermissionKey : Autocomplete : Autocomplete; type UpdateOrganizationMembershipParams = { role: OrganizationCustomRoleKey; }; interface JWT { encoded: { header: string; payload: string; signature: string; }; header: JWTHeader; claims: JWTClaims; } type NonEmptyArray = [T, ...T[]]; interface JWTHeader { alg: string | Algorithm; typ?: string; cty?: string; crit?: NonEmptyArray>; kid?: string; jku?: string; x5u?: string | string[]; 'x5t#S256'?: string; x5t?: string; x5c?: string | string[]; } interface JWTClaims extends ClerkJWTClaims { /** * Encoded token supporting the `getRawString` method. */ __raw: string; } interface ClerkJWTClaims { /** * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1). */ iss: string; /** * JWT Subject - [RFC7519#section-4.1.2](https://tools.ietf.org/html/rfc7519#section-4.1.2). */ sub: string; /** * Session ID */ sid: string; /** * JWT Not Before - [RFC7519#section-4.1.5](https://tools.ietf.org/html/rfc7519#section-4.1.5). */ nbf: number; /** * JWT Expiration Time - [RFC7519#section-4.1.4](https://tools.ietf.org/html/rfc7519#section-4.1.4). */ exp: number; /** * JWT Issued At - [RFC7519#section-4.1.6](https://tools.ietf.org/html/rfc7519#section-4.1.6). */ iat: number; /** * JWT Authorized party - [RFC7800#section-3](https://tools.ietf.org/html/rfc7800#section-3). */ azp?: string; /** * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). */ act?: ActJWTClaim; /** * Active organization id. */ org_id?: string; /** * Active organization slug. */ org_slug?: string; /** * Active organization role */ org_role?: OrganizationCustomRoleKey; /** * Any other JWT Claim Set member. */ [propName: string]: unknown; } /** * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). */ interface ActJWTClaim { sub: string; [x: string]: unknown; } type OrganizationsJWTClaim = Record; interface OrganizationSettingsJSON extends ClerkResourceJSON { id: never; object: never; enabled: boolean; max_allowed_memberships: number; actions: { admin_delete: boolean; }; domains: { enabled: boolean; enrollment_modes: OrganizationEnrollmentMode[]; }; } interface OrganizationSettingsResource extends ClerkResource { enabled: boolean; maxAllowedMemberships: number; actions: { adminDelete: boolean; }; domains: { enabled: boolean; enrollmentModes: OrganizationEnrollmentMode[]; }; } type OrganizationSuggestionStatus = 'pending' | 'accepted'; interface OrganizationSuggestionResource extends ClerkResource { id: string; publicOrganizationData: { hasImage: boolean; imageUrl: string; name: string; id: string; slug: string | null; }; status: OrganizationSuggestionStatus; createdAt: Date; updatedAt: Date; accept: () => Promise; } interface VerificationResource extends ClerkResource { attempts: number | null; error: ClerkAPIError | null; expireAt: Date | null; externalVerificationRedirectURL: URL | null; nonce: string | null; status: VerificationStatus | null; strategy: string | null; verifiedAtClient: string | null; verifiedFromTheSameClient: () => boolean; } interface PasskeyVerificationResource extends VerificationResource { publicKey: PublicKeyCredentialCreationOptionsWithoutExtensions | null; } type VerificationStatus = 'unverified' | 'verified' | 'transferable' | 'failed' | 'expired'; interface CodeVerificationAttemptParam { code: string; signature?: never; } interface SignatureVerificationAttemptParam { code?: never; signature: string; } type VerificationAttemptParams = CodeVerificationAttemptParam | SignatureVerificationAttemptParam; interface StartEmailLinkFlowParams { redirectUrl: string; } type CreateEmailLinkFlowReturn = { startEmailLinkFlow: (params: Params) => Promise; cancelEmailLinkFlow: () => void; }; interface __experimental_SessionVerificationResource extends ClerkResource { status: __experimental_SessionVerificationStatus; level: __experimental_SessionVerificationLevel; session: SessionResource; firstFactorVerification: VerificationResource; secondFactorVerification: VerificationResource; supportedFirstFactors: __experimental_SessionVerificationFirstFactor[] | null; supportedSecondFactors: __experimental_SessionVerificationSecondFactor[] | null; } type __experimental_SessionVerificationStatus = 'needs_first_factor' | 'needs_second_factor' | 'complete'; type __experimental_SessionVerificationLevel = 'L1.firstFactor' | 'L2.secondFactor' | 'L3.multiFactor'; type __experimental_SessionVerificationMaxAge = 'A1.10min' | 'A2.1hr' | 'A3.4hr' | 'A4.1day' | 'A5.1wk'; type __experimental_SessionVerificationFirstFactor = EmailCodeFactor | PhoneCodeFactor | PasswordFactor; type __experimental_SessionVerificationSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor; type UsernameIdentifier = 'username'; type EmailAddressIdentifier = 'email_address'; type PhoneNumberIdentifier = 'phone_number'; type Web3WalletIdentifier = 'web3_wallet'; type EmailAddressOrPhoneNumberIdentifier = 'email_address_or_phone_number'; type Attribute = 'email_address' | 'phone_number' | 'username' | 'first_name' | 'last_name' | 'password' | 'web3_wallet' | 'authenticator_app' | 'backup_code' | 'passkey'; type VerificationStrategy = 'email_link' | 'email_code' | 'phone_code' | 'totp' | 'backup_code'; type OAuthProviderSettings = { enabled: boolean; required: boolean; authenticatable: boolean; strategy: OAuthStrategy; name: string; logo_url: string | null; }; type AttributeDataJSON = { enabled: boolean; required: boolean; verifications: VerificationStrategy[]; used_for_first_factor: boolean; first_factors: VerificationStrategy[]; used_for_second_factor: boolean; second_factors: VerificationStrategy[]; verify_at_sign_up: boolean; }; type AttributeData = AttributeDataJSON & { name: Attribute; }; type SignInData = { second_factor: { required: boolean; enabled: boolean; }; }; type SignUpData = { allowlist_only: boolean; progressive: boolean; captcha_enabled: boolean; }; type PasswordSettingsData = { allowed_special_characters: string; disable_hibp: boolean; min_length: number; max_length: number; require_special_char: boolean; require_numbers: boolean; require_uppercase: boolean; require_lowercase: boolean; show_zxcvbn: boolean; min_zxcvbn_strength: number; }; type PasskeySettingsData = { allow_autofill: boolean; show_sign_in_button: boolean; }; type OAuthProviders = { [provider in OAuthStrategy]: OAuthProviderSettings; }; type SamlSettings = { enabled: boolean; }; type AttributesJSON = { [attribute in Attribute]: AttributeDataJSON; }; type Attributes = { [attribute in Attribute]: AttributeData; }; type Actions = { delete_self: boolean; create_organization: boolean; }; interface UserSettingsJSON extends ClerkResourceJSON { id: never; object: never; attributes: AttributesJSON; actions: Actions; social: OAuthProviders; saml: SamlSettings; sign_in: SignInData; sign_up: SignUpData; password_settings: PasswordSettingsData; passkey_settings: PasskeySettingsData; } interface UserSettingsResource extends ClerkResource { id?: undefined; social: OAuthProviders; saml: SamlSettings; attributes: Attributes; actions: Actions; signIn: SignInData; signUp: SignUpData; passwordSettings: PasswordSettingsData; passkeySettings: PasskeySettingsData; socialProviderStrategies: OAuthStrategy[]; authenticatableSocialStrategies: OAuthStrategy[]; web3FirstFactors: Web3Strategy[]; enabledFirstFactorIdentifiers: Attribute[]; instanceIsPasswordBased: boolean; hasValidAuthFactor: boolean; } interface ZxcvbnResult { feedback: { warning: string | null; suggestions: string[]; }; score: 0 | 1 | 2 | 3 | 4; password: string; guesses: number; guessesLog10: number; calcTime: number; } type ComplexityErrors = { [key in keyof Partial>]?: boolean; }; type PasswordValidation = { complexity?: ComplexityErrors; strength?: PasswordStrength; }; type ValidatePasswordCallbacks = { onValidation?: (res: PasswordValidation) => void; onValidationComplexity?: (b: boolean) => void; }; type PasswordStrength = { state: 'excellent'; result: T; } | { state: 'pass' | 'fail'; keys: string[]; result: T; }; type AfterSignOutUrl = { /** * Full URL or path to navigate after successful sign out. */ afterSignOutUrl?: string | null; }; type AfterMultiSessionSingleSignOutUrl = { /** * Full URL or path to navigate after signing out the current user is complete. * This option applies to multi-session applications. */ afterMultiSessionSingleSignOutUrl?: string | null; }; /** * @deprecated This is deprecated and will be removed in a future release. */ type LegacyRedirectProps = { /** * @deprecated This is deprecated and will be removed in a future release. * Use `fallbackRedirectUrl` or `forceRedirectUrl` instead. */ afterSignInUrl?: string | null; /** * @deprecated This is deprecated and will be removed in a future release. * Use `fallbackRedirectUrl` or `forceRedirectUrl` instead. */ afterSignUpUrl?: string | null; /** * @deprecated This is deprecated and will be removed in a future release. * Use `fallbackRedirectUrl` or `forceRedirectUrl` instead. */ redirectUrl?: string | null; }; /** * Redirect URLs for different actions. * Mainly used to be used to type internal Clerk functions. */ type RedirectOptions = SignInForceRedirectUrl & SignInFallbackRedirectUrl & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps; type AuthenticateWithRedirectParams = { /** * Full URL or path to the route that will complete the OAuth or SAML flow. * Typically, this will be a simple `/sso-callback` route that calls `Clerk.handleRedirectCallback` * or mounts the component. */ redirectUrl: string; /** * Full URL or path to navigate after the OAuth or SAML flow completes. */ redirectUrlComplete: string; /** * Whether to continue (i.e. PATCH) an existing SignUp (if present) or create a new SignUp. */ continueSignUp?: boolean; /** * One of the supported OAuth providers you can use to authenticate with, eg 'oauth_google'. * Or alternatively `saml`, to authenticate with SAML. */ strategy: OAuthStrategy | SamlStrategy; /** * Identifier to use for targeting a SAML connection at sign-in */ identifier?: string; /** * Email address to use for targeting a SAML connection at sign-up */ emailAddress?: string; }; type RedirectUrlProp = { /** * Full URL or path to navigate after a successful action. */ redirectUrl?: string | null; }; type SignUpForceRedirectUrl = { /** * Full URL or path to navigate after successful sign up. * This value has precedence over other redirect props, environment variables or search params. * Use this prop to override the redirect URL when needed. * @default undefined */ signUpForceRedirectUrl?: string | null; }; type SignUpFallbackRedirectUrl = { /** * Full URL or path to navigate after successful sign up. * This value is used when no other redirect props, environment variables or search params are present. * @default undefined */ signUpFallbackRedirectUrl?: string | null; }; type SignInFallbackRedirectUrl = { /** * Full URL or path to navigate after successful sign in. * This value is used when no other redirect props, environment variables or search params are present. * @default undefined */ signInFallbackRedirectUrl?: string | null; }; type SignInForceRedirectUrl = { /** * Full URL or path to navigate after successful sign in. * This value has precedence over other redirect props, environment variables or search params. * Use this prop to override the redirect URL when needed. * @default undefined */ signInForceRedirectUrl?: string | null; }; type PrepareWeb3WalletVerificationParams = { strategy: Web3Strategy; }; type AttemptWeb3WalletVerificationParams = { signature: string; strategy?: Web3Strategy; }; interface Web3WalletResource extends ClerkResource { id: string; web3Wallet: string; verification: VerificationResource; toString: () => string; prepareVerification: (params: PrepareWeb3WalletVerificationParams) => Promise; attemptVerification: (params: AttemptWeb3WalletVerificationParams) => Promise; destroy: () => Promise; create: () => Promise; } type GenerateSignature = (opts: GenerateSignatureParams) => Promise; interface AuthenticateWithWeb3Params { identifier: string; generateSignature: GenerateSignature; strategy?: Web3Strategy; } interface GenerateSignatureParams { identifier: string; nonce: string; provider?: Web3Provider; } interface SignInResource extends ClerkResource { status: SignInStatus | null; /** * @deprecated This attribute will be removed in the next major version */ supportedIdentifiers: SignInIdentifier[]; supportedFirstFactors: SignInFirstFactor[] | null; supportedSecondFactors: SignInSecondFactor[] | null; firstFactorVerification: VerificationResource; secondFactorVerification: VerificationResource; identifier: string | null; createdSessionId: string | null; userData: UserData; create: (params: SignInCreateParams) => Promise; resetPassword: (params: ResetPasswordParams) => Promise; prepareFirstFactor: (params: PrepareFirstFactorParams) => Promise; attemptFirstFactor: (params: AttemptFirstFactorParams) => Promise; prepareSecondFactor: (params: PrepareSecondFactorParams) => Promise; attemptSecondFactor: (params: AttemptSecondFactorParams) => Promise; authenticateWithRedirect: (params: AuthenticateWithRedirectParams) => Promise; authenticateWithWeb3: (params: AuthenticateWithWeb3Params) => Promise; authenticateWithMetamask: () => Promise; authenticateWithCoinbase: () => Promise; authenticateWithCoinbaseWallet: () => Promise; authenticateWithPasskey: (params?: AuthenticateWithPasskeyParams) => Promise; createEmailLinkFlow: () => CreateEmailLinkFlowReturn; validatePassword: (password: string, callbacks?: ValidatePasswordCallbacks) => void; } type SignInStatus = 'needs_identifier' | 'needs_first_factor' | 'needs_second_factor' | 'needs_new_password' | 'complete'; type SignInIdentifier = UsernameIdentifier | EmailAddressIdentifier | PhoneNumberIdentifier | Web3WalletIdentifier; type SignInFirstFactor = EmailCodeFactor | EmailLinkFactor | PhoneCodeFactor | PasswordFactor | PasskeyFactor | ResetPasswordPhoneCodeFactor | ResetPasswordEmailCodeFactor | Web3SignatureFactor | OauthFactor | SamlFactor; type SignInSecondFactor = PhoneCodeFactor | TOTPFactor | BackupCodeFactor; interface UserData { firstName?: string; lastName?: string; imageUrl?: string; hasImage?: boolean; } type SignInFactor = SignInFirstFactor | SignInSecondFactor; type PrepareFirstFactorParams = EmailCodeConfig | EmailLinkConfig | PhoneCodeConfig | Web3SignatureConfig | PassKeyConfig | ResetPasswordPhoneCodeFactorConfig | ResetPasswordEmailCodeFactorConfig | OAuthConfig | SamlConfig; type AttemptFirstFactorParams = PasskeyAttempt | EmailCodeAttempt | PhoneCodeAttempt | PasswordAttempt | Web3Attempt | ResetPasswordPhoneCodeAttempt | ResetPasswordEmailCodeAttempt; type PrepareSecondFactorParams = PhoneCodeSecondFactorConfig; type AttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt; type SignInCreateParams = ({ strategy: OAuthStrategy | SamlStrategy; redirectUrl: string; actionCompleteRedirectUrl?: string; identifier?: string; } | { strategy: TicketStrategy; ticket: string; } | { strategy: GoogleOneTapStrategy; token: string; } | { strategy: PasswordStrategy; password: string; identifier: string; } | { strategy: PasskeyStrategy; } | { strategy: PhoneCodeStrategy | EmailCodeStrategy | Web3Strategy | ResetPasswordEmailCodeStrategy | ResetPasswordPhoneCodeStrategy; identifier: string; } | { strategy: EmailLinkStrategy; identifier: string; redirectUrl?: string; } | { identifier: string; } | { transfer?: boolean; }) & { transfer?: boolean; }; type ResetPasswordParams = { password: string; signOutOfOtherSessions?: boolean; }; type AuthenticateWithPasskeyParams = { flow?: 'autofill' | 'discoverable'; }; interface SignInStartEmailLinkFlowParams extends StartEmailLinkFlowParams { emailAddressId: string; } type SignInStrategy = PasskeyStrategy | PasswordStrategy | ResetPasswordPhoneCodeStrategy | ResetPasswordEmailCodeStrategy | PhoneCodeStrategy | EmailCodeStrategy | EmailLinkStrategy | TicketStrategy | Web3Strategy | TOTPStrategy | BackupCodeStrategy | OAuthStrategy | SamlStrategy; interface SignInJSON extends ClerkResourceJSON { object: 'sign_in'; id: string; status: SignInStatus; /** * @deprecated This attribute will be removed in the next major version */ supported_identifiers: SignInIdentifier[]; identifier: string; user_data: UserDataJSON; supported_first_factors: SignInFirstFactorJSON[]; supported_second_factors: SignInSecondFactorJSON[]; first_factor_verification: VerificationJSON | null; second_factor_verification: VerificationJSON | null; created_session_id: string | null; } interface IdentificationLinkResource extends ClerkResource { id: string; type: string; } type PrepareEmailAddressVerificationParams = { strategy: EmailCodeStrategy; } | { strategy: EmailLinkStrategy; redirectUrl: string; }; type AttemptEmailAddressVerificationParams = { code: string; }; interface EmailAddressResource extends ClerkResource { id: string; emailAddress: string; verification: VerificationResource; linkedTo: IdentificationLinkResource[]; toString: () => string; prepareVerification: (params: PrepareEmailAddressVerificationParams) => Promise; attemptVerification: (params: AttemptEmailAddressVerificationParams) => Promise; createEmailLinkFlow: () => CreateEmailLinkFlowReturn; destroy: () => Promise; create: () => Promise; } type PhoneNumberVerificationStrategy = PhoneCodeStrategy; type PreparePhoneNumberVerificationParams = { strategy: PhoneNumberVerificationStrategy; }; type AttemptPhoneNumberVerificationParams = { code: string; }; type SetReservedForSecondFactorParams = { reserved: boolean; }; interface PhoneNumberResource extends ClerkResource { id: string; phoneNumber: string; verification: VerificationResource; reservedForSecondFactor: boolean; defaultSecondFactor: boolean; linkedTo: IdentificationLinkResource[]; backupCodes?: string[]; toString: () => string; prepareVerification: () => Promise; attemptVerification: (params: AttemptPhoneNumberVerificationParams) => Promise; makeDefaultSecondFactor: () => Promise; setReservedForSecondFactor: (params: SetReservedForSecondFactorParams) => Promise; destroy: () => Promise; create: () => Promise; } declare global { /** * If you want to provide custom types for the signUp.unsafeMetadata object, * simply redeclare this rule in the global namespace. * Every user object will use the provided type. */ interface SignUpUnsafeMetadata { [k: string]: unknown; } } interface SignUpResource extends ClerkResource { status: SignUpStatus | null; requiredFields: SignUpField[]; optionalFields: SignUpField[]; missingFields: SignUpField[]; unverifiedFields: SignUpIdentificationField[]; verifications: SignUpVerificationsResource; username: string | null; firstName: string | null; lastName: string | null; emailAddress: string | null; phoneNumber: string | null; web3wallet: string | null; hasPassword: boolean; unsafeMetadata: SignUpUnsafeMetadata; createdSessionId: string | null; createdUserId: string | null; abandonAt: number | null; create: (params: SignUpCreateParams) => Promise; update: (params: SignUpUpdateParams) => Promise; prepareVerification: (params: PrepareVerificationParams) => Promise; attemptVerification: (params: AttemptVerificationParams) => Promise; prepareEmailAddressVerification: (params?: PrepareEmailAddressVerificationParams) => Promise; attemptEmailAddressVerification: (params: AttemptEmailAddressVerificationParams) => Promise; preparePhoneNumberVerification: (params?: PreparePhoneNumberVerificationParams) => Promise; attemptPhoneNumberVerification: (params: AttemptPhoneNumberVerificationParams) => Promise; prepareWeb3WalletVerification: (params?: PrepareWeb3WalletVerificationParams) => Promise; attemptWeb3WalletVerification: (params: AttemptWeb3WalletVerificationParams) => Promise; createEmailLinkFlow: () => CreateEmailLinkFlowReturn; validatePassword: (password: string, callbacks?: ValidatePasswordCallbacks) => void; authenticateWithRedirect: (params: AuthenticateWithRedirectParams & { unsafeMetadata?: SignUpUnsafeMetadata; }) => Promise; authenticateWithWeb3: (params: AuthenticateWithWeb3Params & { unsafeMetadata?: SignUpUnsafeMetadata; }) => Promise; authenticateWithMetamask: (params?: SignUpAuthenticateWithWeb3Params) => Promise; authenticateWithCoinbase: (params?: SignUpAuthenticateWithWeb3Params) => Promise; authenticateWithCoinbaseWallet: (params?: SignUpAuthenticateWithWeb3Params) => Promise; } type SignUpStatus = 'missing_requirements' | 'complete' | 'abandoned'; type SignUpField = SignUpAttributeField | SignUpIdentificationField; type PrepareVerificationParams = { strategy: EmailCodeStrategy; } | { strategy: EmailLinkStrategy; redirectUrl?: string; } | { strategy: PhoneCodeStrategy; } | { strategy: Web3Strategy; } | { strategy: OAuthStrategy; redirectUrl?: string; actionCompleteRedirectUrl?: string; } | { strategy: SamlStrategy; redirectUrl?: string; actionCompleteRedirectUrl?: string; }; type AttemptVerificationParams = { strategy: EmailCodeStrategy | PhoneCodeStrategy; code: string; } | { strategy: Web3Strategy; signature: string; }; type SignUpAttributeField = FirstNameAttribute | LastNameAttribute | PasswordAttribute; type SignUpVerifiableField = UsernameIdentifier | EmailAddressIdentifier | PhoneNumberIdentifier | EmailAddressOrPhoneNumberIdentifier | Web3WalletIdentifier; type SignUpIdentificationField = SignUpVerifiableField | OAuthStrategy | SamlStrategy; type SignUpCreateParams = Partial<{ externalAccountStrategy: string; externalAccountRedirectUrl: string; externalAccountActionCompleteRedirectUrl: string; strategy: OAuthStrategy | SamlStrategy | TicketStrategy | GoogleOneTapStrategy; redirectUrl: string; actionCompleteRedirectUrl: string; transfer: boolean; unsafeMetadata: SignUpUnsafeMetadata; ticket: string; token: string; } & SnakeToCamel>>; type SignUpUpdateParams = SignUpCreateParams; /** * @deprecated use `SignUpAuthenticateWithWeb3Params` instead */ type SignUpAuthenticateWithMetamaskParams = SignUpAuthenticateWithWeb3Params; type SignUpAuthenticateWithWeb3Params = { unsafeMetadata?: SignUpUnsafeMetadata; }; interface SignUpVerificationsResource { emailAddress: SignUpVerificationResource; phoneNumber: SignUpVerificationResource; externalAccount: VerificationResource; web3Wallet: VerificationResource; } interface SignUpVerificationResource extends VerificationResource { supportedStrategies: string[]; nextAction: string; } /** * Currently representing API DTOs in their JSON form. */ interface ClerkResourceJSON { id: string; object: string; } interface DisplayThemeJSON { general: { color: HexColor; background_color: Color; font_family: string; font_color: HexColor; label_font_weight: FontWeight; padding: EmUnit; border_radius: EmUnit; box_shadow: BoxShadow; }; buttons: { font_color: HexColor; font_family: string; font_weight: FontWeight; }; accounts: { background_color: Color; }; } interface ImageJSON { object: 'image'; id: string; name: string; public_url: string; } interface EnvironmentJSON extends ClerkResourceJSON { auth_config: AuthConfigJSON; display_config: DisplayConfigJSON; user_settings: UserSettingsJSON; organization_settings: OrganizationSettingsJSON; maintenance_mode: boolean; } interface ClientJSON extends ClerkResourceJSON { object: 'client'; id: string; status: any; sessions: SessionJSON[]; sign_up: SignUpJSON | null; sign_in: SignInJSON | null; last_active_session_id: string | null; created_at: number; updated_at: number; } interface SignUpJSON extends ClerkResourceJSON { object: 'sign_up'; status: SignUpStatus; required_fields: SignUpField[]; optional_fields: SignUpField[]; missing_fields: SignUpField[]; unverified_fields: SignUpIdentificationField[]; username: string | null; first_name: string | null; last_name: string | null; email_address: string | null; phone_number: string | null; web3_wallet: string | null; external_account_strategy: string | null; external_account: any; has_password: boolean; unsafe_metadata: SignUpUnsafeMetadata; created_session_id: string | null; created_user_id: string | null; abandon_at: number | null; verifications: SignUpVerificationsJSON | null; } interface SessionJSON extends ClerkResourceJSON { object: 'session'; id: string; status: SessionStatus; expire_at: number; abandon_at: number; last_active_at: number; last_active_token: TokenJSON; last_active_organization_id: string | null; actor: ActJWTClaim | null; user: UserJSON; public_user_data: PublicUserDataJSON; created_at: number; updated_at: number; } interface __experimental_SessionVerificationJSON extends ClerkResourceJSON { object: 'session_verification'; status: __experimental_SessionVerificationStatus; first_factor_verification: VerificationJSON | null; session: SessionJSON; second_factor_verification: VerificationJSON | null; level: __experimental_SessionVerificationLevel; supported_first_factors: SignInFirstFactorJSON[] | null; supported_second_factors: SignInSecondFactorJSON[] | null; } interface EmailAddressJSON extends ClerkResourceJSON { object: 'email_address'; email_address: string; verification: VerificationJSON | null; linked_to: IdentificationLinkJSON[]; } interface IdentificationLinkJSON extends ClerkResourceJSON { id: string; type: string; } interface PhoneNumberJSON extends ClerkResourceJSON { object: 'phone_number'; id: string; phone_number: string; reserved_for_second_factor: boolean; default_second_factor: boolean; linked_to: IdentificationLinkJSON[]; verification: VerificationJSON | null; backup_codes?: string[]; } interface PasskeyJSON extends ClerkResourceJSON { object: 'passkey'; id: string; name: string | null; verification: VerificationJSON | null; last_used_at: number | null; updated_at: number; created_at: number; } interface Web3WalletJSON extends ClerkResourceJSON { object: 'web3_wallet'; id: string; web3_wallet: string; verification: VerificationJSON | null; } interface ExternalAccountJSON extends ClerkResourceJSON { object: 'external_account'; provider: OAuthProvider; identification_id: string; provider_user_id: string; approved_scopes: string; email_address: string; first_name: string; last_name: string; image_url: string; username: string; public_metadata: Record; label: string; verification?: VerificationJSON; } interface SamlAccountJSON extends ClerkResourceJSON { object: 'saml_account'; provider: SamlIdpSlug; provider_user_id: string | null; active: boolean; email_address: string; first_name: string; last_name: string; verification?: VerificationJSON; } interface UserJSON extends ClerkResourceJSON { object: 'user'; id: string; external_id: string; primary_email_address_id: string; primary_phone_number_id: string; primary_web3_wallet_id: string; image_url: string; has_image: boolean; username: string; email_addresses: EmailAddressJSON[]; phone_numbers: PhoneNumberJSON[]; web3_wallets: Web3WalletJSON[]; external_accounts: ExternalAccountJSON[]; passkeys: PasskeyJSON[]; saml_accounts: SamlAccountJSON[]; organization_memberships: OrganizationMembershipJSON[]; password_enabled: boolean; profile_image_id: string; first_name: string; last_name: string; totp_enabled: boolean; backup_code_enabled: boolean; two_factor_enabled: boolean; public_metadata: UserPublicMetadata; unsafe_metadata: UserUnsafeMetadata; last_sign_in_at: number | null; create_organization_enabled: boolean; create_organizations_limit: number | null; delete_self_enabled: boolean; updated_at: number; created_at: number; } interface PublicUserDataJSON extends ClerkResourceJSON { first_name: string | null; last_name: string | null; image_url: string; has_image: boolean; identifier: string; user_id?: string; } interface SessionWithActivitiesJSON extends Omit { user: null; latest_activity: SessionActivityJSON; } interface AuthConfigJSON extends ClerkResourceJSON { single_session_mode: boolean; url_based_session_syncing: boolean; } interface VerificationJSON extends ClerkResourceJSON { status: VerificationStatus; verified_at_client: string; strategy: string; nonce?: string; external_verification_redirect_url?: string; attempts: number; expire_at: number; error: ClerkAPIErrorJSON; } interface SignUpVerificationsJSON { email_address: SignUpVerificationJSON; phone_number: SignUpVerificationJSON; web3_wallet: SignUpVerificationJSON; external_account: VerificationJSON; } interface SignUpVerificationJSON extends VerificationJSON { next_action: string; supported_strategies: string[]; } interface ClerkAPIErrorJSON { code: string; message: string; long_message?: string; meta?: { param_name?: string; session_id?: string; email_addresses?: string[]; identifiers?: string[]; zxcvbn?: { suggestions: { code: string; message: string; }[]; }; }; } interface TokenJSON extends ClerkResourceJSON { object: 'token'; jwt: string; } interface SessionActivityJSON extends ClerkResourceJSON { object: 'session_activity'; browser_name?: string; browser_version?: string; device_type?: string; ip_address?: string; city?: string; country?: string; is_mobile?: boolean; } interface OrganizationJSON extends ClerkResourceJSON { object: 'organization'; id: string; image_url: string; has_image: boolean; name: string; slug: string; public_metadata: OrganizationPublicMetadata; created_at: number; updated_at: number; members_count: number; pending_invitations_count: number; admin_delete_enabled: boolean; max_allowed_memberships: number; } interface OrganizationMembershipJSON extends ClerkResourceJSON { object: 'organization_membership'; id: string; organization: OrganizationJSON; permissions: OrganizationPermissionKey[]; public_metadata: OrganizationMembershipPublicMetadata; public_user_data: PublicUserDataJSON; role: OrganizationCustomRoleKey; created_at: number; updated_at: number; } interface OrganizationInvitationJSON extends ClerkResourceJSON { object: 'organization_invitation'; id: string; email_address: string; organization_id: string; public_metadata: OrganizationInvitationPublicMetadata; status: OrganizationInvitationStatus; role: OrganizationCustomRoleKey; created_at: number; updated_at: number; } interface OrganizationDomainVerificationJSON { status: OrganizationDomainVerificationStatus; strategy: 'email_code'; attempts: number; expires_at: number; } interface OrganizationDomainJSON extends ClerkResourceJSON { object: 'organization_domain'; id: string; name: string; organization_id: string; enrollment_mode: OrganizationEnrollmentMode; verification: OrganizationDomainVerificationJSON | null; affiliation_email_address: string | null; created_at: number; updated_at: number; total_pending_invitations: number; total_pending_suggestions: number; } interface RoleJSON extends ClerkResourceJSON { object: 'role'; id: string; key: string; name: string; description: string; permissions: PermissionJSON[]; created_at: number; updated_at: number; } interface PermissionJSON extends ClerkResourceJSON { object: 'permission'; id: string; key: string; name: string; description: string; type: 'system' | 'user'; created_at: number; updated_at: number; } interface PublicOrganizationDataJSON { id: string; name: string; slug: string | null; has_image: boolean; image_url: string; } interface OrganizationSuggestionJSON extends ClerkResourceJSON { object: 'organization_suggestion'; id: string; public_organization_data: PublicOrganizationDataJSON; status: OrganizationSuggestionStatus; created_at: number; updated_at: number; } interface OrganizationMembershipRequestJSON extends ClerkResourceJSON { object: 'organization_membership_request'; id: string; organization_id: string; status: OrganizationInvitationStatus; public_user_data: PublicUserDataJSON; created_at: number; updated_at: number; } interface UserOrganizationInvitationJSON extends ClerkResourceJSON { object: 'organization_invitation'; id: string; email_address: string; public_organization_data: PublicOrganizationDataJSON; public_metadata: OrganizationInvitationPublicMetadata; status: OrganizationInvitationStatus; role: OrganizationCustomRoleKey; created_at: number; updated_at: number; } interface UserDataJSON { first_name?: string; last_name?: string; image_url: string; has_image: boolean; } interface TOTPJSON extends ClerkResourceJSON { object: 'totp'; id: string; secret?: string; uri?: string; verified: boolean; backup_codes?: string[]; created_at: number; updated_at: number; } interface BackupCodeJSON extends ClerkResourceJSON { object: 'backup_code'; id: string; codes: string[]; created_at: number; updated_at: number; } interface DeletedObjectJSON { object: string; id?: string; slug?: string; deleted: boolean; } type SignInFirstFactorJSON = CamelToSnake; type SignInSecondFactorJSON = CamelToSnake; /** * Types for WebAuthN passkeys */ type Base64UrlString = string; interface PublicKeyCredentialUserEntityJSON { name: string; displayName: string; id: Base64UrlString; } interface PublicKeyCredentialDescriptorJSON { type: 'public-key'; id: Base64UrlString; transports?: ('ble' | 'hybrid' | 'internal' | 'nfc' | 'usb')[]; } interface AuthenticatorSelectionCriteriaJSON { requireResidentKey: boolean; residentKey: 'discouraged' | 'preferred' | 'required'; userVerification: 'discouraged' | 'preferred' | 'required'; } interface PublicKeyCredentialCreationOptionsJSON { rp: PublicKeyCredentialRpEntity; user: PublicKeyCredentialUserEntityJSON; challenge: Base64UrlString; pubKeyCredParams: PublicKeyCredentialParameters[]; timeout: number; excludeCredentials: PublicKeyCredentialDescriptorJSON[]; authenticatorSelection: AuthenticatorSelectionCriteriaJSON; attestation: 'direct' | 'enterprise' | 'indirect' | 'none'; } interface PublicKeyCredentialRequestOptionsJSON { allowCredentials: PublicKeyCredentialDescriptorJSON[]; challenge: Base64UrlString; rpId: string; timeout: number; userVerification: 'discouraged' | 'preferred' | 'required'; } type UpdatePasskeyJSON = Pick; type UpdatePasskeyParams = Partial>; interface PasskeyResource extends ClerkResource { id: string; name: string | null; verification: PasskeyVerificationResource | null; lastUsedAt: Date | null; updatedAt: Date; createdAt: Date; update: (params: UpdatePasskeyParams) => Promise; delete: () => Promise; } type PublicKeyCredentialCreationOptionsWithoutExtensions = Omit, 'extensions'>; type PublicKeyCredentialRequestOptionsWithoutExtensions = Omit, 'extensions'>; type PublicKeyCredentialWithAuthenticatorAttestationResponse = Omit & { response: Omit; }; type PublicKeyCredentialWithAuthenticatorAssertionResponse = Omit & { response: AuthenticatorAssertionResponse; }; type EmailCodeFactor = { strategy: EmailCodeStrategy; emailAddressId: string; safeIdentifier: string; primary?: boolean; }; type EmailLinkFactor = { strategy: EmailLinkStrategy; emailAddressId: string; safeIdentifier: string; primary?: boolean; }; type PhoneCodeFactor = { strategy: PhoneCodeStrategy; phoneNumberId: string; safeIdentifier: string; primary?: boolean; default?: boolean; }; type Web3SignatureFactor = { strategy: Web3Strategy; web3WalletId: string; primary?: boolean; }; type PasswordFactor = { strategy: PasswordStrategy; }; type PasskeyFactor = { strategy: PasskeyStrategy; }; type OauthFactor = { strategy: OAuthStrategy; }; type SamlFactor = { strategy: SamlStrategy; }; type TOTPFactor = { strategy: TOTPStrategy; }; type BackupCodeFactor = { strategy: BackupCodeStrategy; }; type ResetPasswordPhoneCodeFactor = { strategy: ResetPasswordPhoneCodeStrategy; phoneNumberId: string; safeIdentifier: string; primary?: boolean; }; type ResetPasswordEmailCodeFactor = { strategy: ResetPasswordEmailCodeStrategy; emailAddressId: string; safeIdentifier: string; primary?: boolean; }; type ResetPasswordCodeFactor = ResetPasswordEmailCodeFactor | ResetPasswordPhoneCodeFactor; type ResetPasswordPhoneCodeFactorConfig = Omit; type ResetPasswordEmailCodeFactorConfig = Omit; type EmailCodeConfig = Omit; type EmailLinkConfig = Omit & { redirectUrl: string; }; type PhoneCodeConfig = Omit; type Web3SignatureConfig = Web3SignatureFactor; type PassKeyConfig = PasskeyFactor; type OAuthConfig = OauthFactor & { redirectUrl: string; actionCompleteRedirectUrl: string; }; type SamlConfig = SamlFactor & { redirectUrl: string; actionCompleteRedirectUrl: string; }; type PhoneCodeSecondFactorConfig = { strategy: PhoneCodeStrategy; phoneNumberId?: string; }; type EmailCodeAttempt = { strategy: EmailCodeStrategy; code: string; }; type PhoneCodeAttempt = { strategy: PhoneCodeStrategy; code: string; }; type PasswordAttempt = { strategy: PasswordStrategy; password: string; }; type PasskeyAttempt = { strategy: PasskeyStrategy; publicKeyCredential: PublicKeyCredentialWithAuthenticatorAssertionResponse; }; type Web3Attempt = { strategy: Web3Strategy; signature: string; }; type TOTPAttempt = { strategy: TOTPStrategy; code: string; }; type BackupCodeAttempt = { strategy: BackupCodeStrategy; code: string; }; type ResetPasswordPhoneCodeAttempt = { strategy: ResetPasswordPhoneCodeStrategy; code: string; password?: string; }; type ResetPasswordEmailCodeAttempt = { strategy: ResetPasswordEmailCodeStrategy; code: string; password?: string; }; interface TokenResource extends ClerkResource { jwt?: JWT; getRawString: () => string; } type ReauthorizeExternalAccountParams = { additionalScopes?: OAuthScope[]; redirectUrl?: string; }; interface ExternalAccountResource extends ClerkResource { id: string; identificationId: string; provider: OAuthProvider; providerUserId: string; emailAddress: string; approvedScopes: string; firstName: string; lastName: string; imageUrl: string; username?: string; publicMetadata: Record; label?: string; verification: VerificationResource | null; reauthorize: (params: ReauthorizeExternalAccountParams) => Promise; destroy: () => Promise; providerSlug: () => OAuthProvider; providerTitle: () => string; accountIdentifier: () => string; } interface ImageResource extends ClerkResource { id?: string; name: string | null; publicUrl: string | null; } interface SamlAccountResource extends ClerkResource { provider: SamlIdpSlug; providerUserId: string | null; active: boolean; emailAddress: string; firstName: string; lastName: string; verification: VerificationResource | null; } interface TOTPResource extends ClerkResource { id: string; secret?: string; uri?: string; verified: boolean; backupCodes?: string[]; createdAt: Date | null; updatedAt: Date | null; } declare global { /** * If you want to provide custom types for the organizationInvitation.publicMetadata * object, simply redeclare this rule in the global namespace. * Every organizationInvitation object will use the provided type. */ interface UserOrganizationInvitationPublicMetadata { [k: string]: unknown; } interface UserOrganizationInvitationPrivateMetadata { [k: string]: unknown; } } interface UserOrganizationInvitationResource extends ClerkResource { id: string; emailAddress: string; publicOrganizationData: { hasImage: boolean; imageUrl: string; name: string; id: string; slug: string | null; }; publicMetadata: UserOrganizationInvitationPublicMetadata; role: OrganizationCustomRoleKey; status: OrganizationInvitationStatus; createdAt: Date; updatedAt: Date; accept: () => Promise; } declare global { /** * If you want to provide custom types for the user.publicMetadata object, * simply redeclare this rule in the global namespace. * Every user object will use the provided type. */ interface UserPublicMetadata { [k: string]: unknown; } /** * If you want to provide custom types for the user.privateMetadata object, * simply redeclare this rule in the global namespace. * Every user object will use the provided type. */ interface UserPrivateMetadata { [k: string]: unknown; } /** * If you want to provide custom types for the user.unsafeMetadata object, * simply redeclare this rule in the global namespace. * Every user object will use the provided type. */ interface UserUnsafeMetadata { [k: string]: unknown; } } interface UserResource extends ClerkResource { id: string; externalId: string | null; primaryEmailAddressId: string | null; primaryEmailAddress: EmailAddressResource | null; primaryPhoneNumberId: string | null; primaryPhoneNumber: PhoneNumberResource | null; primaryWeb3WalletId: string | null; primaryWeb3Wallet: Web3WalletResource | null; username: string | null; fullName: string | null; firstName: string | null; lastName: string | null; imageUrl: string; hasImage: boolean; emailAddresses: EmailAddressResource[]; phoneNumbers: PhoneNumberResource[]; web3Wallets: Web3WalletResource[]; externalAccounts: ExternalAccountResource[]; passkeys: PasskeyResource[]; samlAccounts: SamlAccountResource[]; organizationMemberships: OrganizationMembershipResource[]; passwordEnabled: boolean; totpEnabled: boolean; backupCodeEnabled: boolean; twoFactorEnabled: boolean; publicMetadata: UserPublicMetadata; unsafeMetadata: UserUnsafeMetadata; lastSignInAt: Date | null; createOrganizationEnabled: boolean; createOrganizationsLimit: number | null; deleteSelfEnabled: boolean; updatedAt: Date | null; createdAt: Date | null; update: (params: UpdateUserParams) => Promise; delete: () => Promise; updatePassword: (params: UpdateUserPasswordParams) => Promise; removePassword: (params: RemoveUserPasswordParams) => Promise; createEmailAddress: (params: CreateEmailAddressParams) => Promise; createPasskey: () => Promise; createPhoneNumber: (params: CreatePhoneNumberParams) => Promise; createWeb3Wallet: (params: CreateWeb3WalletParams) => Promise; isPrimaryIdentification: (ident: EmailAddressResource | PhoneNumberResource | Web3WalletResource) => boolean; getSessions: () => Promise; setProfileImage: (params: SetProfileImageParams) => Promise; createExternalAccount: (params: CreateExternalAccountParams) => Promise; getOrganizationMemberships: GetOrganizationMemberships; getOrganizationInvitations: (params?: GetUserOrganizationInvitationsParams) => Promise>; getOrganizationSuggestions: (params?: GetUserOrganizationSuggestionsParams) => Promise>; leaveOrganization: (organizationId: string) => Promise; createTOTP: () => Promise; verifyTOTP: (params: VerifyTOTPParams) => Promise; disableTOTP: () => Promise; createBackupCode: () => Promise; get verifiedExternalAccounts(): ExternalAccountResource[]; get unverifiedExternalAccounts(): ExternalAccountResource[]; get verifiedWeb3Wallets(): Web3WalletResource[]; get hasVerifiedEmailAddress(): boolean; get hasVerifiedPhoneNumber(): boolean; } type CreateEmailAddressParams = { email: string; }; type CreatePhoneNumberParams = { phoneNumber: string; }; type CreateWeb3WalletParams = { web3Wallet: string; }; type SetProfileImageParams = { file: Blob | File | string | null; }; type CreateExternalAccountParams = { strategy: OAuthStrategy; redirectUrl?: string; additionalScopes?: OAuthScope[]; }; type VerifyTOTPParams = { code: string; }; type UpdateUserJSON = Pick; type UpdateUserParams = Partial>; type UpdateUserPasswordParams = { newPassword: string; currentPassword?: string; signOutOfOtherSessions?: boolean; }; type RemoveUserPasswordParams = Pick; type GetUserOrganizationInvitationsParams = ClerkPaginationParams<{ status?: OrganizationInvitationStatus; }>; type GetUserOrganizationSuggestionsParams = ClerkPaginationParams<{ status?: OrganizationSuggestionStatus | OrganizationSuggestionStatus[]; }>; type GetUserOrganizationMembershipParams = ClerkPaginationParams; type GetOrganizationMemberships = (params?: GetUserOrganizationMembershipParams) => Promise>; type CheckAuthorizationFn = (isAuthorizedParams: Params) => boolean; type CheckAuthorizationWithCustomPermissions = CheckAuthorizationFn; type CheckAuthorizationParamsWithCustomPermissions = { role: OrganizationCustomRoleKey; permission?: never; } | { role?: never; permission: OrganizationCustomPermissionKey; }; type CheckAuthorization = CheckAuthorizationFn; type CheckAuthorizationParams = { role: OrganizationCustomRoleKey; permission?: never; } | { role?: never; permission: OrganizationPermissionKey; }; interface SessionResource extends ClerkResource { id: string; status: SessionStatus; expireAt: Date; abandonAt: Date; lastActiveToken: TokenResource | null; lastActiveOrganizationId: string | null; lastActiveAt: Date; actor: ActJWTClaim | null; user: UserResource | null; publicUserData: PublicUserData; end: () => Promise; remove: () => Promise; touch: () => Promise; getToken: GetToken; checkAuthorization: CheckAuthorization; clearCache: () => void; createdAt: Date; updatedAt: Date; __experimental_startVerification: (params: __experimental_SessionVerifyCreateParams) => Promise<__experimental_SessionVerificationResource>; __experimental_prepareFirstFactorVerification: (factor: __experimental_SessionVerifyPrepareFirstFactorParams) => Promise<__experimental_SessionVerificationResource>; __experimental_attemptFirstFactorVerification: (attemptFactor: __experimental_SessionVerifyAttemptFirstFactorParams) => Promise<__experimental_SessionVerificationResource>; __experimental_prepareSecondFactorVerification: (params: __experimental_SessionVerifyPrepareSecondFactorParams) => Promise<__experimental_SessionVerificationResource>; __experimental_attemptSecondFactorVerification: (params: __experimental_SessionVerifyAttemptSecondFactorParams) => Promise<__experimental_SessionVerificationResource>; } interface ActiveSessionResource extends SessionResource { status: 'active'; user: UserResource; } interface SessionWithActivitiesResource extends ClerkResource { id: string; status: string; expireAt: Date; abandonAt: Date; lastActiveAt: Date; latestActivity: SessionActivity; actor: ActJWTClaim | null; revoke: () => Promise; } interface SessionActivity { id: string; browserName?: string; browserVersion?: string; deviceType?: string; ipAddress?: string; city?: string; country?: string; isMobile?: boolean; } type SessionStatus = 'abandoned' | 'active' | 'ended' | 'expired' | 'removed' | 'replaced' | 'revoked'; interface PublicUserData { firstName: string | null; lastName: string | null; imageUrl: string; hasImage: boolean; identifier: string; userId?: string; } type GetTokenOptions = { template?: string; organizationId?: string; leewayInSeconds?: number; skipCache?: boolean; }; type GetToken = (options?: GetTokenOptions) => Promise; type __experimental_SessionVerifyCreateParams = { level: __experimental_SessionVerificationLevel; maxAge: __experimental_SessionVerificationMaxAge; }; type __experimental_SessionVerifyPrepareFirstFactorParams = EmailCodeConfig | PhoneCodeConfig; type __experimental_SessionVerifyAttemptFirstFactorParams = EmailCodeAttempt | PhoneCodeAttempt | PasswordAttempt; type __experimental_SessionVerifyPrepareSecondFactorParams = PhoneCodeSecondFactorConfig; type __experimental_SessionVerifyAttemptSecondFactorParams = PhoneCodeAttempt | TOTPAttempt | BackupCodeAttempt; interface ClientResource extends ClerkResource { sessions: SessionResource[]; activeSessions: ActiveSessionResource[]; signUp: SignUpResource; signIn: SignInResource; isNew: () => boolean; create: () => Promise; destroy: () => Promise; removeSessions: () => Promise; clearCache: () => void; lastActiveSessionId: string | null; createdAt: Date | null; updatedAt: Date | null; } type CustomMenuItem = { label: string; href?: string; onClick?: () => void; open?: string; mountIcon?: (el: HTMLDivElement) => void; unmountIcon?: (el?: HTMLDivElement) => void; mount?: (el: HTMLDivElement) => void; unmount?: (el?: HTMLDivElement) => void; }; type CustomPage = { label: string; url?: string; mountIcon?: (el: HTMLDivElement) => void; unmountIcon?: (el?: HTMLDivElement) => void; mount?: (el: HTMLDivElement) => void; unmount?: (el?: HTMLDivElement) => void; }; type LocalizationValue = string; /** * A type containing all the possible localization keys the prebuilt Clerk components support. * Users aiming to customise a few strings can also peak at the `data-localization-key` attribute by inspecting * the DOM and updating the corresponding key. * Users aiming to completely localize the components by providing a complete translation can use * the default english resource object from {@link https://github.com/clerk/javascript Clerk's open source repo} * as a starting point. */ type LocalizationResource = DeepPartial<_LocalizationResource>; type _LocalizationResource = { locale: string; maintenanceMode: LocalizationValue; /** * @experimental * Add role keys and their localized value * e.g. roles:{ 'org:teacher': 'Teacher'} */ roles: { [r: string]: LocalizationValue; }; socialButtonsBlockButton: LocalizationValue; socialButtonsBlockButtonManyInView: LocalizationValue; dividerText: LocalizationValue; formFieldLabel__emailAddress: LocalizationValue; formFieldLabel__emailAddresses: LocalizationValue; formFieldLabel__phoneNumber: LocalizationValue; formFieldLabel__username: LocalizationValue; formFieldLabel__emailAddress_username: LocalizationValue; formFieldLabel__password: LocalizationValue; formFieldLabel__currentPassword: LocalizationValue; formFieldLabel__newPassword: LocalizationValue; formFieldLabel__confirmPassword: LocalizationValue; formFieldLabel__signOutOfOtherSessions: LocalizationValue; formFieldLabel__automaticInvitations: LocalizationValue; formFieldLabel__firstName: LocalizationValue; formFieldLabel__lastName: LocalizationValue; formFieldLabel__backupCode: LocalizationValue; formFieldLabel__organizationName: LocalizationValue; formFieldLabel__organizationSlug: LocalizationValue; formFieldLabel__organizationDomain: LocalizationValue; formFieldLabel__organizationDomainEmailAddress: LocalizationValue; formFieldLabel__organizationDomainEmailAddressDescription: LocalizationValue; formFieldLabel__organizationDomainDeletePending: LocalizationValue; formFieldLabel__confirmDeletion: LocalizationValue; formFieldLabel__role: LocalizationValue; formFieldLabel__passkeyName: LocalizationValue; formFieldInputPlaceholder__emailAddress: LocalizationValue; formFieldInputPlaceholder__emailAddresses: LocalizationValue; formFieldInputPlaceholder__phoneNumber: LocalizationValue; formFieldInputPlaceholder__username: LocalizationValue; formFieldInputPlaceholder__emailAddress_username: LocalizationValue; formFieldInputPlaceholder__password: LocalizationValue; formFieldInputPlaceholder__firstName: LocalizationValue; formFieldInputPlaceholder__lastName: LocalizationValue; formFieldInputPlaceholder__backupCode: LocalizationValue; formFieldInputPlaceholder__organizationName: LocalizationValue; formFieldInputPlaceholder__organizationSlug: LocalizationValue; formFieldInputPlaceholder__organizationDomain: LocalizationValue; formFieldInputPlaceholder__organizationDomainEmailAddress: LocalizationValue; formFieldInputPlaceholder__confirmDeletionUserAccount: LocalizationValue; formFieldError__notMatchingPasswords: LocalizationValue; formFieldError__matchingPasswords: LocalizationValue; formFieldError__verificationLinkExpired: LocalizationValue; formFieldAction__forgotPassword: LocalizationValue; formFieldHintText__optional: LocalizationValue; formFieldHintText__slug: LocalizationValue; formButtonPrimary: LocalizationValue; formButtonPrimary__verify: LocalizationValue; signInEnterPasswordTitle: LocalizationValue; backButton: LocalizationValue; footerActionLink__useAnotherMethod: LocalizationValue; badge__primary: LocalizationValue; badge__thisDevice: LocalizationValue; badge__userDevice: LocalizationValue; badge__otherImpersonatorDevice: LocalizationValue; badge__default: LocalizationValue; badge__unverified: LocalizationValue; badge__requiresAction: LocalizationValue; badge__you: LocalizationValue; footerPageLink__help: LocalizationValue; footerPageLink__privacy: LocalizationValue; footerPageLink__terms: LocalizationValue; paginationButton__previous: LocalizationValue; paginationButton__next: LocalizationValue; paginationRowText__displaying: LocalizationValue; paginationRowText__of: LocalizationValue; membershipRole__admin: LocalizationValue; membershipRole__basicMember: LocalizationValue; membershipRole__guestMember: LocalizationValue; signUp: { start: { title: LocalizationValue; subtitle: LocalizationValue; actionText: LocalizationValue; actionLink: LocalizationValue; actionLink__use_phone: LocalizationValue; actionLink__use_email: LocalizationValue; }; emailLink: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; formSubtitle: LocalizationValue; resendButton: LocalizationValue; verified: { title: LocalizationValue; }; loading: { title: LocalizationValue; }; verifiedSwitchTab: { title: LocalizationValue; subtitle: LocalizationValue; subtitleNewTab: LocalizationValue; }; clientMismatch: { title: LocalizationValue; subtitle: LocalizationValue; }; }; emailCode: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; formSubtitle: LocalizationValue; resendButton: LocalizationValue; }; phoneCode: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; formSubtitle: LocalizationValue; resendButton: LocalizationValue; }; continue: { title: LocalizationValue; subtitle: LocalizationValue; actionText: LocalizationValue; actionLink: LocalizationValue; }; }; signIn: { start: { title: LocalizationValue; subtitle: LocalizationValue; actionText: LocalizationValue; actionLink: LocalizationValue; actionLink__use_email: LocalizationValue; actionLink__use_phone: LocalizationValue; actionLink__use_username: LocalizationValue; actionLink__use_email_username: LocalizationValue; actionLink__use_passkey: LocalizationValue; }; password: { title: LocalizationValue; subtitle: LocalizationValue; actionLink: LocalizationValue; }; passwordPwned: { title: LocalizationValue; }; passkey: { title: LocalizationValue; subtitle: LocalizationValue; }; forgotPasswordAlternativeMethods: { title: LocalizationValue; label__alternativeMethods: LocalizationValue; blockButton__resetPassword: LocalizationValue; }; forgotPassword: { title: LocalizationValue; subtitle: LocalizationValue; subtitle_email: LocalizationValue; subtitle_phone: LocalizationValue; formTitle: LocalizationValue; resendButton: LocalizationValue; }; resetPassword: { title: LocalizationValue; formButtonPrimary: LocalizationValue; successMessage: LocalizationValue; requiredMessage: LocalizationValue; }; resetPasswordMfa: { detailsLabel: LocalizationValue; }; emailCode: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; resendButton: LocalizationValue; }; emailLink: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; formSubtitle: LocalizationValue; resendButton: LocalizationValue; unusedTab: { title: LocalizationValue; }; verified: { title: LocalizationValue; subtitle: LocalizationValue; }; verifiedSwitchTab: { subtitle: LocalizationValue; titleNewTab: LocalizationValue; subtitleNewTab: LocalizationValue; }; loading: { title: LocalizationValue; subtitle: LocalizationValue; }; failed: { title: LocalizationValue; subtitle: LocalizationValue; }; expired: { title: LocalizationValue; subtitle: LocalizationValue; }; clientMismatch: { title: LocalizationValue; subtitle: LocalizationValue; }; }; phoneCode: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; resendButton: LocalizationValue; }; phoneCodeMfa: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; resendButton: LocalizationValue; }; totpMfa: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; }; backupCodeMfa: { title: LocalizationValue; subtitle: LocalizationValue; }; alternativeMethods: { title: LocalizationValue; subtitle: LocalizationValue; actionLink: LocalizationValue; actionText: LocalizationValue; blockButton__emailLink: LocalizationValue; blockButton__emailCode: LocalizationValue; blockButton__phoneCode: LocalizationValue; blockButton__password: LocalizationValue; blockButton__passkey: LocalizationValue; blockButton__totp: LocalizationValue; blockButton__backupCode: LocalizationValue; getHelp: { title: LocalizationValue; content: LocalizationValue; blockButton__emailSupport: LocalizationValue; }; }; noAvailableMethods: { title: LocalizationValue; subtitle: LocalizationValue; message: LocalizationValue; }; accountSwitcher: { title: LocalizationValue; subtitle: LocalizationValue; action__addAccount: LocalizationValue; action__signOutAll: LocalizationValue; }; }; __experimental_userVerification: { password: { title: LocalizationValue; subtitle: LocalizationValue; actionLink: LocalizationValue; }; emailCode: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; resendButton: LocalizationValue; }; phoneCode: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; resendButton: LocalizationValue; }; phoneCodeMfa: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; resendButton: LocalizationValue; }; totpMfa: { title: LocalizationValue; subtitle: LocalizationValue; formTitle: LocalizationValue; }; backupCodeMfa: { title: LocalizationValue; subtitle: LocalizationValue; }; alternativeMethods: { title: LocalizationValue; subtitle: LocalizationValue; actionLink: LocalizationValue; actionText: LocalizationValue; blockButton__emailCode: LocalizationValue; blockButton__phoneCode: LocalizationValue; blockButton__password: LocalizationValue; blockButton__totp: LocalizationValue; blockButton__backupCode: LocalizationValue; getHelp: { title: LocalizationValue; content: LocalizationValue; blockButton__emailSupport: LocalizationValue; }; }; noAvailableMethods: { title: LocalizationValue; subtitle: LocalizationValue; message: LocalizationValue; }; }; userProfile: { mobileButton__menu: LocalizationValue; formButtonPrimary__continue: LocalizationValue; formButtonPrimary__save: LocalizationValue; formButtonPrimary__finish: LocalizationValue; formButtonPrimary__remove: LocalizationValue; formButtonPrimary__add: LocalizationValue; formButtonReset: LocalizationValue; navbar: { title: LocalizationValue; description: LocalizationValue; account: LocalizationValue; security: LocalizationValue; }; start: { headerTitle__account: LocalizationValue; headerTitle__security: LocalizationValue; profileSection: { title: LocalizationValue; primaryButton: LocalizationValue; }; usernameSection: { title: LocalizationValue; primaryButton__updateUsername: LocalizationValue; primaryButton__setUsername: LocalizationValue; }; emailAddressesSection: { title: LocalizationValue; primaryButton: LocalizationValue; detailsAction__primary: LocalizationValue; detailsAction__nonPrimary: LocalizationValue; detailsAction__unverified: LocalizationValue; destructiveAction: LocalizationValue; }; phoneNumbersSection: { title: LocalizationValue; primaryButton: LocalizationValue; detailsAction__primary: LocalizationValue; detailsAction__nonPrimary: LocalizationValue; detailsAction__unverified: LocalizationValue; destructiveAction: LocalizationValue; }; connectedAccountsSection: { title: LocalizationValue; primaryButton: LocalizationValue; actionLabel__connectionFailed: LocalizationValue; /** * @deprecated UserProfile now only uses `actionLabel__connectionFailed`. */ actionLabel__reauthorize: LocalizationValue; /** * @deprecated UserProfile now uses `subtitle__disconnected`. */ subtitle__reauthorize: LocalizationValue; subtitle__disconnected: LocalizationValue; destructiveActionTitle: LocalizationValue; }; enterpriseAccountsSection: { title: LocalizationValue; }; passwordSection: { title: LocalizationValue; primaryButton__updatePassword: LocalizationValue; primaryButton__setPassword: LocalizationValue; }; passkeysSection: { title: LocalizationValue; menuAction__rename: LocalizationValue; menuAction__destructive: LocalizationValue; }; mfaSection: { title: LocalizationValue; primaryButton: LocalizationValue; phoneCode: { destructiveActionLabel: LocalizationValue; actionLabel__setDefault: LocalizationValue; }; backupCodes: { headerTitle: LocalizationValue; title__regenerate: LocalizationValue; subtitle__regenerate: LocalizationValue; actionLabel__regenerate: LocalizationValue; }; totp: { headerTitle: LocalizationValue; destructiveActionTitle: LocalizationValue; }; }; activeDevicesSection: { title: LocalizationValue; destructiveAction: LocalizationValue; }; web3WalletsSection: { title: LocalizationValue; primaryButton: LocalizationValue; destructiveAction: LocalizationValue; }; dangerSection: { title: LocalizationValue; deleteAccountButton: LocalizationValue; }; }; profilePage: { title: LocalizationValue; imageFormTitle: LocalizationValue; imageFormSubtitle: LocalizationValue; imageFormDestructiveActionSubtitle: LocalizationValue; fileDropAreaHint: LocalizationValue; readonly: LocalizationValue; successMessage: LocalizationValue; }; usernamePage: { successMessage: LocalizationValue; title__set: LocalizationValue; title__update: LocalizationValue; }; emailAddressPage: { title: LocalizationValue; verifyTitle: LocalizationValue; emailCode: { formHint: LocalizationValue; formTitle: LocalizationValue; formSubtitle: LocalizationValue; resendButton: LocalizationValue; successMessage: LocalizationValue; }; emailLink: { formHint: LocalizationValue; formTitle: LocalizationValue; formSubtitle: LocalizationValue; resendButton: LocalizationValue; successMessage: LocalizationValue; }; removeResource: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; }; }; passkeyScreen: { title__rename: LocalizationValue; subtitle__rename: LocalizationValue; removeResource: { title: LocalizationValue; messageLine1: LocalizationValue; }; }; phoneNumberPage: { title: LocalizationValue; verifyTitle: LocalizationValue; verifySubtitle: LocalizationValue; successMessage: LocalizationValue; infoText: LocalizationValue; removeResource: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; }; }; connectedAccountPage: { title: LocalizationValue; formHint: LocalizationValue; formHint__noAccounts: LocalizationValue; socialButtonsBlockButton: LocalizationValue; successMessage: LocalizationValue; removeResource: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; }; }; web3WalletPage: { title: LocalizationValue; subtitle__availableWallets: LocalizationValue; subtitle__unavailableWallets: LocalizationValue; web3WalletButtonsBlockButton: LocalizationValue; successMessage: LocalizationValue; removeResource: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; }; }; passwordPage: { successMessage__set: LocalizationValue; successMessage__update: LocalizationValue; successMessage__signOutOfOtherSessions: LocalizationValue; checkboxInfoText__signOutOfOtherSessions: LocalizationValue; readonly: LocalizationValue; title__set: LocalizationValue; title__update: LocalizationValue; }; mfaPage: { title: LocalizationValue; formHint: LocalizationValue; }; mfaTOTPPage: { title: LocalizationValue; verifyTitle: LocalizationValue; verifySubtitle: LocalizationValue; successMessage: LocalizationValue; authenticatorApp: { infoText__ableToScan: LocalizationValue; infoText__unableToScan: LocalizationValue; inputLabel__unableToScan1: LocalizationValue; inputLabel__unableToScan2: LocalizationValue; buttonAbleToScan__nonPrimary: LocalizationValue; buttonUnableToScan__nonPrimary: LocalizationValue; }; removeResource: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; }; }; mfaPhoneCodePage: { title: LocalizationValue; primaryButton__addPhoneNumber: LocalizationValue; backButton: LocalizationValue; subtitle__availablePhoneNumbers: LocalizationValue; subtitle__unavailablePhoneNumbers: LocalizationValue; successTitle: LocalizationValue; successMessage1: LocalizationValue; successMessage2: LocalizationValue; removeResource: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; }; }; backupCodePage: { title: LocalizationValue; title__codelist: LocalizationValue; subtitle__codelist: LocalizationValue; infoText1: LocalizationValue; infoText2: LocalizationValue; successSubtitle: LocalizationValue; successMessage: LocalizationValue; actionLabel__copy: LocalizationValue; actionLabel__copied: LocalizationValue; actionLabel__download: LocalizationValue; actionLabel__print: LocalizationValue; }; deletePage: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; actionDescription: LocalizationValue; confirm: LocalizationValue; }; }; userButton: { action__manageAccount: LocalizationValue; action__signOut: LocalizationValue; action__signOutAll: LocalizationValue; action__addAccount: LocalizationValue; }; organizationSwitcher: { personalWorkspace: LocalizationValue; notSelected: LocalizationValue; action__createOrganization: LocalizationValue; action__manageOrganization: LocalizationValue; action__invitationAccept: LocalizationValue; action__suggestionsAccept: LocalizationValue; suggestionsAcceptedLabel: LocalizationValue; }; impersonationFab: { title: LocalizationValue; action__signOut: LocalizationValue; }; organizationProfile: { navbar: { title: LocalizationValue; description: LocalizationValue; general: LocalizationValue; members: LocalizationValue; }; badge__unverified: LocalizationValue; badge__automaticInvitation: LocalizationValue; badge__automaticSuggestion: LocalizationValue; badge__manualInvitation: LocalizationValue; start: { headerTitle__members: LocalizationValue; headerTitle__general: LocalizationValue; profileSection: { title: LocalizationValue; primaryButton: LocalizationValue; uploadAction__title: LocalizationValue; }; }; profilePage: { title: LocalizationValue; successMessage: LocalizationValue; dangerSection: { title: LocalizationValue; leaveOrganization: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; actionDescription: LocalizationValue; }; deleteOrganization: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; actionDescription: LocalizationValue; successMessage: LocalizationValue; }; }; domainSection: { title: LocalizationValue; subtitle: LocalizationValue; primaryButton: LocalizationValue; menuAction__verify: LocalizationValue; menuAction__remove: LocalizationValue; menuAction__manage: LocalizationValue; }; }; createDomainPage: { title: LocalizationValue; subtitle: LocalizationValue; }; verifyDomainPage: { title: LocalizationValue; subtitle: LocalizationValue; subtitleVerificationCodeScreen: LocalizationValue; formTitle: LocalizationValue; formSubtitle: LocalizationValue; resendButton: LocalizationValue; }; verifiedDomainPage: { title: LocalizationValue; subtitle: LocalizationValue; start: { headerTitle__enrollment: LocalizationValue; headerTitle__danger: LocalizationValue; }; enrollmentTab: { subtitle: LocalizationValue; manualInvitationOption__label: LocalizationValue; manualInvitationOption__description: LocalizationValue; automaticInvitationOption__label: LocalizationValue; automaticInvitationOption__description: LocalizationValue; automaticSuggestionOption__label: LocalizationValue; automaticSuggestionOption__description: LocalizationValue; calloutInfoLabel: LocalizationValue; calloutInvitationCountLabel: LocalizationValue; calloutSuggestionCountLabel: LocalizationValue; }; dangerTab: { removeDomainTitle: LocalizationValue; removeDomainSubtitle: LocalizationValue; removeDomainActionLabel__remove: LocalizationValue; calloutInfoLabel: LocalizationValue; }; }; invitePage: { title: LocalizationValue; subtitle: LocalizationValue; successMessage: LocalizationValue; detailsTitle__inviteFailed: LocalizationValue; formButtonPrimary__continue: LocalizationValue; selectDropdown__role: LocalizationValue; }; removeDomainPage: { title: LocalizationValue; messageLine1: LocalizationValue; messageLine2: LocalizationValue; successMessage: LocalizationValue; }; membersPage: { detailsTitle__emptyRow: LocalizationValue; action__invite: LocalizationValue; start: { headerTitle__members: LocalizationValue; headerTitle__invitations: LocalizationValue; headerTitle__requests: LocalizationValue; }; activeMembersTab: { tableHeader__user: LocalizationValue; tableHeader__joined: LocalizationValue; tableHeader__role: LocalizationValue; tableHeader__actions: LocalizationValue; menuAction__remove: LocalizationValue; }; invitedMembersTab: { tableHeader__invited: LocalizationValue; menuAction__revoke: LocalizationValue; }; invitationsTab: { table__emptyRow: LocalizationValue; autoInvitations: { headerTitle: LocalizationValue; headerSubtitle: LocalizationValue; primaryButton: LocalizationValue; }; }; requestsTab: { tableHeader__requested: LocalizationValue; menuAction__approve: LocalizationValue; menuAction__reject: LocalizationValue; table__emptyRow: LocalizationValue; autoSuggestions: { headerTitle: LocalizationValue; headerSubtitle: LocalizationValue; primaryButton: LocalizationValue; }; }; }; }; createOrganization: { title: LocalizationValue; formButtonSubmit: LocalizationValue; invitePage: { formButtonReset: LocalizationValue; }; }; organizationList: { createOrganization: LocalizationValue; title: LocalizationValue; titleWithoutPersonal: LocalizationValue; subtitle: LocalizationValue; action__invitationAccept: LocalizationValue; invitationAcceptedLabel: LocalizationValue; action__suggestionsAccept: LocalizationValue; suggestionsAcceptedLabel: LocalizationValue; action__createOrganization: LocalizationValue; }; unstable__errors: UnstableErrors; dates: { previous6Days: LocalizationValue; lastDay: LocalizationValue; sameDay: LocalizationValue; nextDay: LocalizationValue; next6Days: LocalizationValue; numeric: LocalizationValue; }; }; type WithParamName = T & Partial>}`, LocalizationValue>>; type UnstableErrors = WithParamName<{ external_account_not_found: LocalizationValue; identification_deletion_failed: LocalizationValue; phone_number_exists: LocalizationValue; form_identifier_not_found: LocalizationValue; captcha_unavailable: LocalizationValue; captcha_invalid: LocalizationValue; passkey_not_supported: LocalizationValue; passkey_pa_not_supported: LocalizationValue; passkey_retrieval_cancelled: LocalizationValue; passkey_registration_cancelled: LocalizationValue; passkey_already_exists: LocalizationValue; form_password_pwned: LocalizationValue; form_password_pwned__sign_in: LocalizationValue; form_username_invalid_length: LocalizationValue; form_username_invalid_character: LocalizationValue; form_param_format_invalid: LocalizationValue; form_param_format_invalid__email_address: LocalizationValue; form_password_length_too_short: LocalizationValue; form_param_nil: LocalizationValue; form_code_incorrect: LocalizationValue; form_password_incorrect: LocalizationValue; form_password_validation_failed: LocalizationValue; not_allowed_access: LocalizationValue; form_identifier_exists: LocalizationValue; form_identifier_exists__email_address: LocalizationValue; form_identifier_exists__username: LocalizationValue; form_identifier_exists__phone_number: LocalizationValue; form_password_not_strong_enough: LocalizationValue; form_password_size_in_bytes_exceeded: LocalizationValue; passwordComplexity: { sentencePrefix: LocalizationValue; minimumLength: LocalizationValue; maximumLength: LocalizationValue; requireNumbers: LocalizationValue; requireLowercase: LocalizationValue; requireUppercase: LocalizationValue; requireSpecialCharacter: LocalizationValue; }; zxcvbn: { notEnough: LocalizationValue; couldBeStronger: LocalizationValue; goodPassword: LocalizationValue; warnings: { straightRow: LocalizationValue; keyPattern: LocalizationValue; simpleRepeat: LocalizationValue; extendedRepeat: LocalizationValue; sequences: LocalizationValue; recentYears: LocalizationValue; dates: LocalizationValue; topTen: LocalizationValue; topHundred: LocalizationValue; common: LocalizationValue; similarToCommon: LocalizationValue; wordByItself: LocalizationValue; namesByThemselves: LocalizationValue; commonNames: LocalizationValue; userInputs: LocalizationValue; pwned: LocalizationValue; }; suggestions: { l33t: LocalizationValue; reverseWords: LocalizationValue; allUppercase: LocalizationValue; capitalization: LocalizationValue; dates: LocalizationValue; recentYears: LocalizationValue; associatedYears: LocalizationValue; sequences: LocalizationValue; repeated: LocalizationValue; longerKeyboardPattern: LocalizationValue; anotherWord: LocalizationValue; useWords: LocalizationValue; noNeed: LocalizationValue; pwned: LocalizationValue; }; }; form_param_max_length_exceeded: LocalizationValue; }>; type SDKMetadata = { name: string; version: string; environment?: string; }; type ListenerCallback = (emission: Resources) => void; type UnsubscribeCallback = () => void; type BeforeEmitCallback = (session?: ActiveSessionResource | null) => void | Promise; type SignOutCallback = () => void | Promise; type SignOutOptions = { /** * Specify a specific session to sign out. Useful for * multi-session applications. */ sessionId?: string; /** * Specify a redirect URL to navigate after sign out is complete. */ redirectUrl?: string; }; interface SignOut { (options?: SignOutOptions): Promise; (signOutCallback?: SignOutCallback, options?: SignOutOptions): Promise; } /** * Main Clerk SDK object. */ interface Clerk { /** * Clerk SDK version number. */ version: string | undefined; /** * If present, contains information about the SDK that the host application is using. * For example, if Clerk is loaded through `@clerk/nextjs`, this would be `{ name: '@clerk/nextjs', version: '1.0.0' }` */ sdkMetadata: SDKMetadata | undefined; /** * If true the bootstrapping of Clerk.load() has completed successfully. */ loaded: boolean; frontendApi: string; /** Clerk Publishable Key string. */ publishableKey: string; /** Clerk Proxy url string. */ proxyUrl: string | undefined; /** Clerk Satellite Frontend API string. */ domain: string; /** Clerk Flag for satellite apps. */ isSatellite: boolean; /** Clerk Instance type is defined from the Publishable key */ instanceType: InstanceType | undefined; /** Clerk flag for loading Clerk in a standard browser setup */ isStandardBrowser: boolean | undefined; /** Client handling most Clerk operations. */ client: ClientResource | undefined; /** Active Session. */ session: ActiveSessionResource | null | undefined; /** Active Organization */ organization: OrganizationResource | null | undefined; /** Current User. */ user: UserResource | null | undefined; telemetry: TelemetryCollector | undefined; /** * Signs out the current user on single-session instances, or all users on multi-session instances * @param signOutCallback - Optional A callback that runs after sign out completes. * @param options - Optional Configuration options, see {@link SignOutOptions} * @returns A promise that resolves when the sign out process completes. */ signOut: SignOut; /** * Opens the Clerk SignIn component in a modal. * @param props Optional sign in configuration parameters. */ openSignIn: (props?: SignInProps) => void; /** * Closes the Clerk SignIn modal. */ closeSignIn: () => void; /** * Opens the Clerk UserVerification component in a modal. * @experimantal This API is still under active development and may change at any moment. * @param props Optional user verification configuration parameters. */ __experimental_openUserVerification: (props?: __experimental_UserVerificationModalProps) => void; /** * Closes the Clerk user verification modal. * @experimantal This API is still under active development and may change at any moment. */ __experimental_closeUserVerification: () => void; /** * Opens the Google One Tap component. * @param props Optional props that will be passed to the GoogleOneTap component. */ openGoogleOneTap: (props?: GoogleOneTapProps) => void; /** * Opens the Google One Tap component. * If the component is not already open, results in a noop. */ closeGoogleOneTap: () => void; /** * Opens the Clerk SignUp component in a modal. * @param props Optional props that will be passed to the SignUp component. */ openSignUp: (props?: SignUpProps) => void; /** * Closes the Clerk SignUp modal. */ closeSignUp: () => void; /** * Opens the Clerk UserProfile modal. * @param props Optional props that will be passed to the UserProfile component. */ openUserProfile: (props?: UserProfileProps) => void; /** * Closes the Clerk UserProfile modal. */ closeUserProfile: () => void; /** * Opens the Clerk OrganizationProfile modal. * @param props Optional props that will be passed to the OrganizationProfile component. */ openOrganizationProfile: (props?: OrganizationProfileProps) => void; /** * Closes the Clerk OrganizationProfile modal. */ closeOrganizationProfile: () => void; /** * Opens the Clerk CreateOrganization modal. * @param props Optional props that will be passed to the CreateOrganization component. */ openCreateOrganization: (props?: CreateOrganizationProps) => void; /** * Closes the Clerk CreateOrganization modal. */ closeCreateOrganization: () => void; /** * Mounts a sign in flow component at the target element. * @param targetNode Target node to mount the SignIn component. * @param signInProps sign in configuration parameters. */ mountSignIn: (targetNode: HTMLDivElement, signInProps?: SignInProps) => void; /** * Unmount a sign in flow component from the target element. * If there is no component mounted at the target node, results in a noop. * * @param targetNode Target node to unmount the SignIn component from. */ unmountSignIn: (targetNode: HTMLDivElement) => void; /** * Mounts a user reverification flow component at the target element. * * @experimantal This API is still under active development and may change at any moment. * @param targetNode Target node to mount the UserVerification component from. * @param props user verification configuration parameters. */ __experimental_mountUserVerification: (targetNode: HTMLDivElement, props?: __experimental_UserVerificationProps) => void; /** * Unmount a user reverification flow component from the target element. * If there is no component mounted at the target node, results in a noop. * * @experimantal This API is still under active development and may change at any moment. * @param targetNode Target node to unmount the UserVerification component from. */ __experimental_unmountUserVerification: (targetNode: HTMLDivElement) => void; /** * Mounts a sign up flow component at the target element. * * @param targetNode Target node to mount the SignUp component. * @param signUpProps sign up configuration parameters. */ mountSignUp: (targetNode: HTMLDivElement, signUpProps?: SignUpProps) => void; /** * Unmount a sign up flow component from the target element. * If there is no component mounted at the target node, results in a noop. * * @param targetNode Target node to unmount the SignUp component from. */ unmountSignUp: (targetNode: HTMLDivElement) => void; /** * Mount a user button component at the target element. * * @param targetNode Target node to mount the UserButton component. * @param userButtonProps User button configuration parameters. */ mountUserButton: (targetNode: HTMLDivElement, userButtonProps?: UserButtonProps) => void; /** * Unmount a user button component at the target element. * If there is no component mounted at the target node, results in a noop. * * @param targetNode Target node to unmount the UserButton component from. */ unmountUserButton: (targetNode: HTMLDivElement) => void; /** * Mount a user profile component at the target element. * * @param targetNode Target to mount the UserProfile component. * @param userProfileProps User profile configuration parameters. */ mountUserProfile: (targetNode: HTMLDivElement, userProfileProps?: UserProfileProps) => void; /** * Unmount a user profile component at the target element. * If there is no component mounted at the target node, results in a noop. * * @param targetNode Target node to unmount the UserProfile component from. */ unmountUserProfile: (targetNode: HTMLDivElement) => void; /** * Mount an organization profile component at the target element. * @param targetNode Target to mount the OrganizationProfile component. * @param props Configuration parameters. */ mountOrganizationProfile: (targetNode: HTMLDivElement, props?: OrganizationProfileProps) => void; /** * Unmount the organization profile component from the target node. * @param targetNode Target node to unmount the OrganizationProfile component from. */ unmountOrganizationProfile: (targetNode: HTMLDivElement) => void; /** * Mount a CreateOrganization component at the target element. * @param targetNode Target to mount the CreateOrganization component. * @param props Configuration parameters. */ mountCreateOrganization: (targetNode: HTMLDivElement, props?: CreateOrganizationProps) => void; /** * Unmount the CreateOrganization component from the target node. * @param targetNode Target node to unmount the CreateOrganization component from. */ unmountCreateOrganization: (targetNode: HTMLDivElement) => void; /** * Mount an organization switcher component at the target element. * @param targetNode Target to mount the OrganizationSwitcher component. * @param props Configuration parameters. */ mountOrganizationSwitcher: (targetNode: HTMLDivElement, props?: OrganizationSwitcherProps) => void; /** * Unmount the organization profile component from the target node.* * @param targetNode Target node to unmount the OrganizationSwitcher component from. */ unmountOrganizationSwitcher: (targetNode: HTMLDivElement) => void; /** * Mount an organization list component at the target element. * @param targetNode Target to mount the OrganizationList component. * @param props Configuration parameters. */ mountOrganizationList: (targetNode: HTMLDivElement, props?: OrganizationListProps) => void; /** * Unmount the organization list component from the target node.* * @param targetNode Target node to unmount the OrganizationList component from. */ unmountOrganizationList: (targetNode: HTMLDivElement) => void; /** * Register a listener that triggers a callback each time important Clerk resources are changed. * Allows to hook up at different steps in the sign up, sign in processes. * * Some important checkpoints: * When there is an active session, user === session.user. * When there is no active session, user and session will both be null. * When a session is loading, user and session will be undefined. * * @param callback Callback function receiving the most updated Clerk resources after a change. * @returns - Unsubscribe callback */ addListener: (callback: ListenerCallback) => UnsubscribeCallback; /** * Set the active session and organization explicitly. * * If the session param is `null`, the active session is deleted. * In a similar fashion, if the organization param is `null`, the current organization is removed as active. */ setActive: SetActive; /** * Function used to commit a navigation after certain steps in the Clerk processes. */ navigate: CustomNavigation; /** * Decorates the provided url with the auth token for development instances. * * @param {string} to */ buildUrlWithAuth(to: string): string; /** * Returns the configured url where is mounted or a custom sign-in page is rendered. * * @param opts A {@link RedirectOptions} object */ buildSignInUrl(opts?: RedirectOptions): string; /** * Returns the configured url where is mounted or a custom sign-up page is rendered. * * @param opts A {@link RedirectOptions} object */ buildSignUpUrl(opts?: RedirectOptions): string; /** * Returns the url where is mounted or a custom user-profile page is rendered. */ buildUserProfileUrl(): string; /** * Returns the configured url where is mounted or a custom create-organization page is rendered. */ buildCreateOrganizationUrl(): string; /** * Returns the configured url where is mounted or a custom organization-profile page is rendered. */ buildOrganizationProfileUrl(): string; /** * Returns the configured afterSignInUrl of the instance. */ buildAfterSignInUrl(): string; /** * Returns the configured afterSignInUrl of the instance. */ buildAfterSignUpUrl(): string; /** * Returns the configured afterSignOutUrl of the instance. */ buildAfterSignOutUrl(): string; /** * Returns the configured afterMultiSessionSingleSignOutUrl of the instance. */ buildAfterMultiSessionSingleSignOutUrl(): string; /** * * Redirects to the provided url after decorating it with the auth token for development instances. * * @param {string} to */ redirectWithAuth(to: string): Promise; /** * Redirects to the configured URL where is mounted. * * @param opts A {@link RedirectOptions} object */ redirectToSignIn(opts?: SignInRedirectOptions): Promise; /** * Redirects to the configured URL where is mounted. * * @param opts A {@link RedirectOptions} object */ redirectToSignUp(opts?: SignUpRedirectOptions): Promise; /** * Redirects to the configured URL where is mounted. */ redirectToUserProfile: () => Promise; /** * Redirects to the configured URL where is mounted. */ redirectToOrganizationProfile: () => Promise; /** * Redirects to the configured URL where is mounted. */ redirectToCreateOrganization: () => Promise; /** * Redirects to the configured afterSignIn URL. */ redirectToAfterSignIn: () => void; /** * Redirects to the configured afterSignUp URL. */ redirectToAfterSignUp: () => void; /** * Redirects to the configured afterSignOut URL. */ redirectToAfterSignOut: () => void; /** * Completes a Google One Tap redirection flow started by * {@link Clerk.authenticateWithGoogleOneTap} */ handleGoogleOneTapCallback: (signInOrUp: SignInResource | SignUpResource, params: HandleOAuthCallbackParams, customNavigate?: (to: string) => Promise) => Promise; /** * Completes an OAuth or SAML redirection flow started by * {@link Clerk.client.signIn.authenticateWithRedirect} or {@link Clerk.client.signUp.authenticateWithRedirect} */ handleRedirectCallback: (params: HandleOAuthCallbackParams | HandleSamlCallbackParams, customNavigate?: (to: string) => Promise) => Promise; /** * Completes a Email Link flow started by {@link Clerk.client.signIn.createEmailLinkFlow} or {@link Clerk.client.signUp.createEmailLinkFlow} */ handleEmailLinkVerification: (params: HandleEmailLinkVerificationParams, customNavigate?: (to: string) => Promise) => Promise; /** * Authenticates user using their Metamask browser extension */ authenticateWithMetamask: (params?: AuthenticateWithMetamaskParams) => Promise; /** * Authenticates user using their Coinbase Wallet browser extension */ authenticateWithCoinbase: (params?: AuthenticateWithCoinbaseParams) => Promise; /** * Authenticates user using their Coinbase Smart Wallet and browser extension */ authenticateWithCoinbaseWallet: (params?: AuthenticateWithCoinbaseWalletParams) => Promise; /** * Authenticates user using their Web3 Wallet browser extension */ authenticateWithWeb3: (params: ClerkAuthenticateWithWeb3Params) => Promise; /** * Authenticates user using a Google token generated from Google identity services. */ authenticateWithGoogleOneTap: (params: AuthenticateWithGoogleOneTapParams) => Promise; /** * Creates an organization, adding the current user as admin. */ createOrganization: (params: CreateOrganizationParams) => Promise; /** * Retrieves a single organization by id. */ getOrganization: (organizationId: string) => Promise; /** * Handles a 401 response from Frontend API by refreshing the client and session object accordingly */ handleUnauthenticated: () => Promise; } type HandleOAuthCallbackParams = TransferableOption & SignInForceRedirectUrl & SignInFallbackRedirectUrl & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps & { /** * Full URL or path where the SignIn component is mounted. */ signInUrl?: string; /** * Full URL or path where the SignUp component is mounted. */ signUpUrl?: string; /** * Full URL or path to navigate during sign in, * if identifier verification is required. */ firstFactorUrl?: string; /** * Full URL or path to navigate during sign in, * if 2FA is enabled. */ secondFactorUrl?: string; /** * Full URL or path to navigate during sign in, * if the user is required to reset their password. */ resetPasswordUrl?: string; /** * Full URL or path to navigate after an incomplete sign up. */ continueSignUpUrl?: string | null; /** * Full URL or path to navigate after requesting email verification. */ verifyEmailAddressUrl?: string | null; /** * Full URL or path to navigate after requesting phone verification. */ verifyPhoneNumberUrl?: string | null; }; type HandleSamlCallbackParams = HandleOAuthCallbackParams; type CustomNavigation = (to: string, options?: NavigateOptions) => Promise | void; type ClerkThemeOptions = DeepSnakeToCamel>; /** * Navigation options used to replace or push history changes. * Both `routerPush` & `routerReplace` OR none options should be passed. */ type ClerkOptionsNavigation = { routerPush?: never; routerDebug?: boolean; routerReplace?: never; } | { routerPush: RouterFn; routerReplace: RouterFn; routerDebug?: boolean; }; type ClerkOptions = ClerkOptionsNavigation & SignInForceRedirectUrl & SignInFallbackRedirectUrl & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps & AfterSignOutUrl & AfterMultiSessionSingleSignOutUrl & { appearance?: Appearance; localization?: LocalizationResource; polling?: boolean; selectInitialSession?: (client: ClientResource) => ActiveSessionResource | null; /** Controls if ClerkJS will load with the standard browser setup using Clerk cookies */ standardBrowser?: boolean; /** Optional support email for display in authentication screens */ supportEmail?: string; touchSession?: boolean; signInUrl?: string; signUpUrl?: string; allowedRedirectOrigins?: Array; isSatellite?: boolean | ((url: URL) => boolean); /** * Telemetry options */ telemetry?: false | { disabled?: boolean; debug?: boolean; }; sdkMetadata?: SDKMetadata; /** * Enable experimental flags to gain access to new features. These flags are not guaranteed to be stable and may change drastically in between patch or minor versions. */ experimental?: Autocomplete<{ persistClient: boolean; }, Record>; }; interface NavigateOptions { replace?: boolean; metadata?: RouterMetadata; } interface Resources { client: ClientResource; session?: ActiveSessionResource | null; user?: UserResource | null; organization?: OrganizationResource | null; } type RoutingStrategy = 'path' | 'hash' | 'virtual'; /** * Internal is a navigation type that affects the component * */ type NavigationType = /** * Internal navigations affect the components and alter the * part of the URL that comes after the `path` passed to the component. * eg * going from /sign-in to /sign-in/factor-one is an internal navigation */ 'internal' /** * Internal navigations affect the components and alter the * part of the URL that comes before the `path` passed to the component. * eg * going from /sign-in to / is an external navigation */ | 'external' /** * Window navigations are navigations towards a different origin * and are not handled by the Clerk component or the host app router. */ | 'window'; type RouterMetadata = { routing?: RoutingStrategy; navigationType?: NavigationType; }; type RouterFn = (to: string, metadata?: { __internal_metadata?: RouterMetadata; windowNavigate: (to: URL | string) => void; }) => Promise | unknown; type WithoutRouting = Omit; type SignInInitialValues = { emailAddress?: string; phoneNumber?: string; username?: string; }; type SignUpInitialValues = { emailAddress?: string; phoneNumber?: string; firstName?: string; lastName?: string; username?: string; }; type SignInRedirectOptions = RedirectOptions & RedirectUrlProp & { /** * Initial values that are used to prefill the sign in form. */ initialValues?: SignInInitialValues; }; type SignUpRedirectOptions = RedirectOptions & RedirectUrlProp & { /** * Initial values that are used to prefill the sign up form. */ initialValues?: SignUpInitialValues; }; type SetActiveParams = { /** * The session resource or session id (string version) to be set as active. * If `null`, the current session is deleted. */ session?: ActiveSessionResource | string | null; /** * The organization resource or organization ID/slug (string version) to be set as active in the current session. * If `null`, the currently active organization is removed as active. */ organization?: OrganizationResource | string | null; /** * Callback run just before the active session and/or organization is set to the passed object. * Can be used to hook up for pre-navigation actions. */ beforeEmit?: BeforeEmitCallback; }; type SetActive = (params: SetActiveParams) => Promise; type RoutingOptions = { path: string | undefined; routing?: Extract; } | { path?: never; routing?: Extract; }; type SignInProps = RoutingOptions & { /** * Full URL or path to navigate after successful sign in. * This value has precedence over other redirect props, environment variables or search params. * Use this prop to override the redirect URL when needed. * @default undefined */ forceRedirectUrl?: string | null; /** * Full URL or path to navigate after successful sign in. * This value is used when no other redirect props, environment variables or search params are present. * @default undefined */ fallbackRedirectUrl?: string | null; /** * Full URL or path to for the sign up process. * Used to fill the "Sign up" link in the SignUp component. */ signUpUrl?: string; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: SignInTheme; /** * Initial values that are used to prefill the sign in form. */ initialValues?: SignInInitialValues; } & TransferableOption & SignUpForceRedirectUrl & SignUpFallbackRedirectUrl & LegacyRedirectProps & AfterSignOutUrl; interface TransferableOption { /** * Indicates whether or not sign in attempts are transferable to the sign up flow. * When set to false, prevents opaque sign ups when a user attempts to sign in via OAuth with an email that doesn't exist. * @default true */ transferable?: boolean; } type SignInModalProps = WithoutRouting; /** * @experimantal */ type __experimental_UserVerificationProps = RoutingOptions & { afterVerification?: () => void; afterVerificationUrl?: string; /** * Defines the steps of the verification flow. * When `L3.multiFactor` is used, the user will be prompt for a first factor flow followed by a second factor flow. * @default `'L2.secondFactor'` */ level?: __experimental_SessionVerificationLevel; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: UserVerificationTheme; }; type __experimental_UserVerificationModalProps = WithoutRouting<__experimental_UserVerificationProps>; type GoogleOneTapRedirectUrlProps = SignInForceRedirectUrl & SignUpForceRedirectUrl; type GoogleOneTapProps = GoogleOneTapRedirectUrlProps & { /** * Whether to cancel the Google One Tap request if a user clicks outside the prompt. * @default true */ cancelOnTapOutside?: boolean; /** * Enables upgraded One Tap UX on ITP browsers. * Turning this options off, would hide any One Tap UI in such browsers. * @default true */ itpSupport?: boolean; /** * FedCM enables more private sign-in flows without requiring the use of third-party cookies. * The browser controls user settings, displays user prompts, and only contacts an Identity Provider such as Google after explicit user consent is given. * Backwards compatible with browsers that still support third-party cookies. * @default true */ fedCmSupport?: boolean; appearance?: SignInTheme; }; type SignUpProps = RoutingOptions & { /** * Full URL or path to navigate after successful sign up. * This value has precedence over other redirect props, environment variables or search params. * Use this prop to override the redirect URL when needed. * @default undefined */ forceRedirectUrl?: string | null; /** * Full URL or path to navigate after successful sign up. * This value is used when no other redirect props, environment variables or search params are present. * @default undefined */ fallbackRedirectUrl?: string | null; /** * Full URL or path to for the sign in process. * Used to fill the "Sign in" link in the SignUp component. */ signInUrl?: string; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: SignUpTheme; /** * Additional arbitrary metadata to be stored alongside the User object */ unsafeMetadata?: SignUpUnsafeMetadata; /** * Initial values that are used to prefill the sign up form. */ initialValues?: SignUpInitialValues; } & SignInFallbackRedirectUrl & SignInForceRedirectUrl & LegacyRedirectProps & AfterSignOutUrl; type SignUpModalProps = WithoutRouting; type UserProfileProps = RoutingOptions & { /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: UserProfileTheme; additionalOAuthScopes?: Partial>; customPages?: CustomPage[]; /** * @experimental * Specify on which page the user profile modal will open. **/ __experimental_startPath?: string; }; type UserProfileModalProps = WithoutRouting; type OrganizationProfileProps = RoutingOptions & { /** * Full URL or path to navigate to after the user leaves the currently active organization. * @default undefined */ afterLeaveOrganizationUrl?: string; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: OrganizationProfileTheme; customPages?: CustomPage[]; }; type OrganizationProfileModalProps = WithoutRouting; type CreateOrganizationProps = RoutingOptions & { /** * Full URL or path to navigate after creating a new organization. * @default undefined */ afterCreateOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams>; /** * Hides the screen for sending invitations after an organization is created. * @default undefined When left undefined Clerk will automatically hide the screen if * the number of max allowed members is equal to 1 */ skipInvitationScreen?: boolean; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: CreateOrganizationTheme; /** * Hides the optional "slug" field in the organization creation screen. * @default false */ hideSlug?: boolean; }; type CreateOrganizationModalProps = WithoutRouting; type UserProfileMode = 'modal' | 'navigation'; type UserButtonProfileMode = { userProfileUrl?: never; userProfileMode?: Extract; } | { userProfileUrl: string; userProfileMode?: Extract; }; type UserButtonProps = UserButtonProfileMode & { /** * Controls if the username is displayed next to the trigger button */ showName?: boolean; /** * Controls the default state of the UserButton */ defaultOpen?: boolean; /** * Full URL or path to navigate after sign out is complete * @deprecated Configure `afterSignOutUrl` as a global configuration, either in or in await Clerk.load() */ afterSignOutUrl?: string; /** * Full URL or path to navigate after signing out the current user is complete. * This option applies to multi-session applications. * @deprecated Configure `afterMultiSessionSingleSignOutUrl` as a global configuration, either in or in await Clerk.load() */ afterMultiSessionSingleSignOutUrl?: string; /** * Full URL or path to navigate on "Add another account" action. * Multi-session mode only. */ signInUrl?: string; /** * Full URL or path to navigate after successful account change. * Multi-session mode only. */ afterSwitchSessionUrl?: string; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: UserButtonTheme; userProfileProps?: Pick; customMenuItems?: CustomMenuItem[]; }; type PrimitiveKeys = { [K in keyof T]: T[K] extends string | boolean | number | null ? K : never; }[keyof T]; type LooseExtractedParams = Autocomplete<`:${T}`>; type OrganizationProfileMode = { organizationProfileUrl: string; organizationProfileMode?: 'navigation'; } | { organizationProfileUrl?: never; organizationProfileMode?: 'modal'; }; type CreateOrganizationMode = { createOrganizationUrl: string; createOrganizationMode?: 'navigation'; } | { createOrganizationUrl?: never; createOrganizationMode?: 'modal'; }; type OrganizationSwitcherProps = CreateOrganizationMode & OrganizationProfileMode & { /** * Controls the default state of the OrganizationSwitcher */ defaultOpen?: boolean; /** * By default, users can switch between organization and their personal account. * This option controls whether OrganizationSwitcher will include the user's personal account * in the organization list. Setting this to `false` will hide the personal account entry, * and users will only be able to switch between organizations. * @default true */ hidePersonal?: boolean; /** * Full URL or path to navigate after a successful organization switch. * @default undefined * @deprecated use `afterSelectOrganizationUrl` or `afterSelectPersonalUrl` */ afterSwitchOrganizationUrl?: string; /** * Full URL or path to navigate after creating a new organization. * @default undefined */ afterCreateOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams>; /** * Full URL or path to navigate after a successful organization selection. * Accepts a function that returns URL or path * @default undefined` */ afterSelectOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams>; /** * Full URL or path to navigate after a successful selection of personal workspace. * Accepts a function that returns URL or path * @default undefined */ afterSelectPersonalUrl?: ((user: UserResource) => string) | LooseExtractedParams>; /** * Full URL or path to navigate to after the user leaves the currently active organization. * @default undefined */ afterLeaveOrganizationUrl?: string; /** * Hides the screen for sending invitations after an organization is created. * @default undefined When left undefined Clerk will automatically hide the screen if * the number of max allowed members is equal to 1 */ skipInvitationScreen?: boolean; /** * Hides the optional "slug" field in the organization creation screen. * @default false */ hideSlug?: boolean; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider(if one is provided) */ appearance?: OrganizationSwitcherTheme; organizationProfileProps?: Pick; }; type OrganizationListProps = { /** * Full URL or path to navigate after creating a new organization. * @default undefined */ afterCreateOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams>; /** * Full URL or path to navigate after a successful organization selection. * Accepts a function that returns URL or path * @default undefined` */ afterSelectOrganizationUrl?: ((organization: OrganizationResource) => string) | LooseExtractedParams>; /** * Customisation options to fully match the Clerk components to your own brand. * These options serve as overrides and will be merged with the global `appearance` * prop of ClerkProvider (if one is provided) */ appearance?: OrganizationListTheme; /** * Hides the screen for sending invitations after an organization is created. * @default undefined When left undefined Clerk will automatically hide the screen if * the number of max allowed members is equal to 1 */ skipInvitationScreen?: boolean; /** * By default, users can switch between organization and their personal account. * This option controls whether OrganizationList will include the user's personal account * in the organization list. Setting this to `false` will hide the personal account entry, * and users will only be able to switch between organizations. * @default true */ hidePersonal?: boolean; /** * Full URL or path to navigate after a successful selection of personal workspace. * Accepts a function that returns URL or path * @default undefined` */ afterSelectPersonalUrl?: ((user: UserResource) => string) | LooseExtractedParams>; /** * Hides the optional "slug" field in the organization creation screen. * @default false */ hideSlug?: boolean; }; interface HandleEmailLinkVerificationParams { /** * Full URL or path to navigate after successful magic link verification * on completed sign up or sign in on the same device. */ redirectUrlComplete?: string; /** * Full URL or path to navigate after successful magic link verification * on the same device, but not completed sign in or sign up. */ redirectUrl?: string; /** * Callback function to be executed after successful magic link * verification on another device. */ onVerifiedOnOtherDevice?: () => void; } type CreateOrganizationInvitationParams = { emailAddress: string; role: OrganizationCustomRoleKey; }; type CreateBulkOrganizationInvitationParams = { emailAddresses: string[]; role: OrganizationCustomRoleKey; }; interface CreateOrganizationParams { name: string; slug?: string; } interface ClerkAuthenticateWithWeb3Params { customNavigate?: (to: string) => Promise; redirectUrl?: string; signUpContinueUrl?: string; unsafeMetadata?: SignUpUnsafeMetadata; strategy: Web3Strategy; } interface AuthenticateWithMetamaskParams { customNavigate?: (to: string) => Promise; redirectUrl?: string; signUpContinueUrl?: string; unsafeMetadata?: SignUpUnsafeMetadata; } interface AuthenticateWithCoinbaseParams { customNavigate?: (to: string) => Promise; redirectUrl?: string; signUpContinueUrl?: string; unsafeMetadata?: SignUpUnsafeMetadata; } interface AuthenticateWithCoinbaseWalletParams { customNavigate?: (to: string) => Promise; redirectUrl?: string; signUpContinueUrl?: string; unsafeMetadata?: SignUpUnsafeMetadata; } interface AuthenticateWithGoogleOneTapParams { token: string; } interface LoadedClerk extends Clerk { client: ClientResource; } interface EnvironmentResource extends ClerkResource { userSettings: UserSettingsResource; organizationSettings: OrganizationSettingsResource; authConfig: AuthConfigResource; displayConfig: DisplayConfigResource; isSingleSession: () => boolean; isProduction: () => boolean; isDevelopmentOrStaging: () => boolean; onWindowLocationHost: () => boolean; maintenanceMode: boolean; } type PublishableKey = { frontendApi: string; instanceType: InstanceType; }; interface Jwt { header: JwtHeader; payload: JwtPayload; signature: Uint8Array; raw: { header: string; payload: string; signature: string; text: string; }; } interface JwtHeader { alg: string; typ?: string; cty?: string; crit?: Array>; kid: string; jku?: string; x5u?: string | string[]; 'x5t#S256'?: string; x5t?: string; x5c?: string | string[]; } declare global { /** * If you want to provide custom types for the getAuth().sessionClaims object, * simply redeclare this interface in the global namespace and provide your own custom keys. */ interface CustomJwtSessionClaims { [k: string]: unknown; } } interface JwtPayload extends CustomJwtSessionClaims { /** * Encoded token supporting the `getRawString` method. */ __raw: string; /** * JWT Issuer - [RFC7519#section-4.1.1](https://tools.ietf.org/html/rfc7519#section-4.1.1). */ iss: string; /** * JWT Subject - [RFC7519#section-4.1.2](https://tools.ietf.org/html/rfc7519#section-4.1.2). */ sub: string; /** * Session ID */ sid: string; /** * JWT Not Before - [RFC7519#section-4.1.5](https://tools.ietf.org/html/rfc7519#section-4.1.5). */ nbf: number; /** * JWT Expiration Time - [RFC7519#section-4.1.4](https://tools.ietf.org/html/rfc7519#section-4.1.4). */ exp: number; /** * JWT Issued At - [RFC7519#section-4.1.6](https://tools.ietf.org/html/rfc7519#section-4.1.6). */ iat: number; /** * JWT Authorized party - [RFC7800#section-3](https://tools.ietf.org/html/rfc7800#section-3). */ azp?: string; /** * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). */ act?: ActClaim; /** * Active organization id. */ org_id?: string; /** * Active organization slug. */ org_slug?: string; /** * Active organization role */ org_role?: OrganizationCustomRoleKey; /** * Active organization role */ org_permissions?: OrganizationCustomPermissionKey[]; /** * Any other JWT Claim Set member. */ [propName: string]: unknown; } /** * JWT Actor - [RFC8693](https://www.rfc-editor.org/rfc/rfc8693.html#name-act-actor-claim). */ interface ActClaim { sub: string; [x: string]: unknown; } type StringOrURLFnToString = string | ((url: URL) => string); /** * DomainOrProxyUrl supports the following cases * 1) none of them are set * 2) only proxyUrl is set * 3) isSatellite and proxy is set * 4) isSatellite and domain is set */ type MultiDomainAndOrProxy = { isSatellite?: never; proxyUrl?: never | StringOrURLFnToString; domain?: never; } | { isSatellite: Exclude; proxyUrl?: never; domain: StringOrURLFnToString; } | { isSatellite: Exclude; proxyUrl: StringOrURLFnToString; domain?: never; }; type MultiDomainAndOrProxyPrimitives = { isSatellite?: never; proxyUrl?: never | string; domain?: never; } | { isSatellite: boolean; proxyUrl?: never; domain: string; } | { isSatellite: boolean; proxyUrl: string; domain?: never; }; type DomainOrProxyUrl = { proxyUrl?: never; domain?: StringOrURLFnToString; } | { proxyUrl?: StringOrURLFnToString; domain?: never; }; type ServerGetTokenOptions = { template?: string; }; type ServerGetToken = (options?: ServerGetTokenOptions) => Promise; type InitialState = Serializable<{ sessionClaims: JwtPayload; sessionId: string | undefined; session: SessionResource | undefined; actor: ActClaim | undefined; userId: string | undefined; user: UserResource | undefined; orgId: string | undefined; orgRole: OrganizationCustomRoleKey | undefined; orgSlug: string | undefined; orgPermissions: OrganizationCustomPermissionKey[] | undefined; organization: OrganizationResource | undefined; }>; export { type ActClaim, type ActJWTClaim, type Actions, type ActiveSessionResource, type AddMemberParams, type AfterMultiSessionSingleSignOutUrl, type AfterSignOutUrl, type AlertId, type AlphaColorScale, type Appearance, type AppleOauthProvider, type AtlassianOauthProvider, type AttemptAffiliationVerificationParams, type AttemptEmailAddressVerificationParams, type AttemptFirstFactorParams, type AttemptPhoneNumberVerificationParams, type AttemptSecondFactorParams, type AttemptVerificationParams, type AttemptWeb3WalletVerificationParams, type Attribute, type AttributeData, type AttributeDataJSON, type Attributes, type AttributesJSON, type AuthConfigJSON, type AuthConfigResource, type AuthenticateWithCoinbaseParams, type AuthenticateWithCoinbaseWalletParams, type AuthenticateWithGoogleOneTapParams, type AuthenticateWithMetamaskParams, type AuthenticateWithPasskeyParams, type AuthenticateWithRedirectParams, type AuthenticateWithWeb3Params, type Autocomplete, type BackupCodeAttempt, type BackupCodeFactor, type BackupCodeJSON, type BackupCodeResource, type BackupCodeStrategy, type BaseTheme, type BaseThemeTaggedType, type BeforeEmitCallback, type BitbucketOauthProvider, type BoxOauthProvider, type BoxShadow, type BuiltInColors, type CamelToSnake, type CaptchaProvider, type CaptchaWidgetType, type CardActionId, type CheckAuthorization, type CheckAuthorizationFn, type CheckAuthorizationParamsWithCustomPermissions, type CheckAuthorizationWithCustomPermissions, type Clerk, type ClerkAPIError, type ClerkAPIErrorJSON, type ClerkAuthenticateWithWeb3Params, type ClerkJWTClaims, type ClerkOptions, type ClerkPaginatedResponse, type ClerkPaginationParams, type ClerkPaginationRequest, type ClerkResource, type ClerkResourceJSON, type ClerkResourceReloadParams, type ClerkRuntimeError, type ClerkThemeOptions, type ClientJSON, type ClientResource, type CodeVerificationAttemptParam, type CoinbaseOauthProvider, type CoinbaseWalletWeb3Provider, type CoinbaseWeb3Provider, type Color, type ColorScale, type ColorScaleWithRequiredBase, type ColorString, type ComplexityErrors, type CreateBulkOrganizationInvitationParams, type CreateEmailAddressParams, type CreateEmailLinkFlowReturn, type CreateExternalAccountParams, type CreateOrganizationInvitationParams, type CreateOrganizationModalProps, type CreateOrganizationParams, type CreateOrganizationProps, type CreateOrganizationTheme, type CreatePhoneNumberParams, type CreateWeb3WalletParams, type CssColorOrAlphaScale, type CssColorOrScale, type CustomMenuItem, type CustomNavigation, type CustomOAuthStrategy, type CustomOauthProvider, type CustomPage, type DeepCamelToSnake, type DeepPartial, type DeepRequired, type DeepSnakeToCamel, type DeletedObjectJSON, type DeletedObjectResource, type DiscordOauthProvider, type DisplayConfigJSON, type DisplayConfigResource, type DisplayThemeJSON, type DomainOrProxyUrl, type DropboxOauthProvider, type ElementObjectKey, type ElementState, type Elements, type ElementsConfig, type EmUnit, type EmailAddressIdentifier, type EmailAddressJSON, type EmailAddressOrPhoneNumberIdentifier, type EmailAddressResource, type EmailCodeAttempt, type EmailCodeConfig, type EmailCodeFactor, type EmailCodeStrategy, type EmailLinkConfig, type EmailLinkFactor, type EmailLinkStrategy, type EnstallOauthProvider, type EnvironmentJSON, type EnvironmentResource, type ExternalAccountJSON, type ExternalAccountResource, type FacebookOauthProvider, type FieldId, type FirstNameAttribute, type FontFamily, type FontWeight, type GenerateSignature, type GenerateSignatureParams, type GetDomainsParams, type GetInvitationsParams, type GetMembersParams, type GetMembershipRequestParams, type GetMemberships, type GetOrganizationMemberships, type GetRolesParams, type GetToken, type GetTokenOptions, type GetUserOrganizationInvitationsParams, type GetUserOrganizationMembershipParams, type GetUserOrganizationSuggestionsParams, type GithubOauthProvider, type GitlabOauthProvider, type GoogleOauthProvider, type GoogleOneTapProps, type GoogleOneTapStrategy, type HandleEmailLinkVerificationParams, type HandleOAuthCallbackParams, type HandleSamlCallbackParams, type HexColor, type HexColorString, type HslaColor, type HslaColorString, type HubspotOauthProvider, type HuggingfaceOAuthProvider, type IdSelectors, type IdentificationLinkJSON, type IdentificationLinkResource, type ImageJSON, type ImageResource, type InitialState, type InstagramOauthProvider, type InstanceType, type InviteMemberParams, type InviteMembersParams, type JWT, type JWTClaims, type JWTHeader, type Jwt, type JwtHeader, type JwtPayload, type LastNameAttribute, type Layout, type LegacyRedirectProps, type LineOauthProvider, type LinearOauthProvider, type LinkedinOIDCOauthProvider, type LinkedinOauthProvider, type ListenerCallback, type LoadedClerk, type LocalizationResource, type LocalizationValue, type MenuId, type MetamaskWeb3Provider, type MicrosoftOauthProvider, type MultiDomainAndOrProxy, type MultiDomainAndOrProxyPrimitives, type NavigateOptions, type NotionOauthProvider, OAUTH_PROVIDERS, type OAuthConfig, type OAuthProvider, type OAuthProviderData, type OAuthProviderSettings, type OAuthProviders, type OAuthScope, type OAuthStrategy, type OauthFactor, type OrganizationCustomPermissionKey, type OrganizationCustomRoleKey, type OrganizationDomainJSON, type OrganizationDomainResource, type OrganizationDomainVerification, type OrganizationDomainVerificationStatus, type OrganizationEnrollmentMode, type OrganizationInvitationJSON, type OrganizationInvitationResource, type OrganizationInvitationStatus, type OrganizationJSON, type OrganizationListProps, type OrganizationListTheme, type OrganizationMembershipJSON, type OrganizationMembershipRequestJSON, type OrganizationMembershipRequestResource, type OrganizationMembershipResource, type OrganizationPermissionKey, type OrganizationPreviewId, type OrganizationProfileModalProps, type OrganizationProfileProps, type OrganizationProfileTheme, type OrganizationResource, type OrganizationSettingsJSON, type OrganizationSettingsResource, type OrganizationSuggestionJSON, type OrganizationSuggestionResource, type OrganizationSuggestionStatus, type OrganizationSwitcherProps, type OrganizationSwitcherTheme, type OrganizationSystemPermissionKey, type OrganizationsJWTClaim, type PassKeyConfig, type PasskeyAttempt, type PasskeyFactor, type PasskeyJSON, type PasskeyResource, type PasskeySettingsData, type PasskeyStrategy, type PasskeyVerificationResource, type PasswordAttempt, type PasswordAttribute, type PasswordFactor, type PasswordSettingsData, type PasswordStrategy, type PasswordStrength, type PasswordValidation, type PathValue, type PermissionJSON, type PermissionResource, type PhoneCodeAttempt, type PhoneCodeConfig, type PhoneCodeFactor, type PhoneCodeSecondFactorConfig, type PhoneCodeStrategy, type PhoneNumberIdentifier, type PhoneNumberJSON, type PhoneNumberResource, type PhoneNumberVerificationStrategy, type PreferredSignInStrategy, type PrepareAffiliationVerificationParams, type PrepareEmailAddressVerificationParams, type PrepareFirstFactorParams, type PreparePhoneNumberVerificationParams, type PrepareSecondFactorParams, type PrepareVerificationParams, type PrepareWeb3WalletVerificationParams, type ProfilePageId, type ProfileSectionId, type PublicKeyCredentialCreationOptionsJSON, type PublicKeyCredentialCreationOptionsWithoutExtensions, type PublicKeyCredentialRequestOptionsJSON, type PublicKeyCredentialRequestOptionsWithoutExtensions, type PublicKeyCredentialWithAuthenticatorAssertionResponse, type PublicKeyCredentialWithAuthenticatorAttestationResponse, type PublicOrganizationDataJSON, type PublicUserData, type PublicUserDataJSON, type PublishableKey, type ReauthorizeExternalAccountParams, type RecordToPath, type RedirectOptions, type RedirectUrlProp, type RemoveUserPasswordParams, type ResetPasswordCodeFactor, type ResetPasswordEmailCodeAttempt, type ResetPasswordEmailCodeFactor, type ResetPasswordEmailCodeFactorConfig, type ResetPasswordEmailCodeStrategy, type ResetPasswordParams, type ResetPasswordPhoneCodeAttempt, type ResetPasswordPhoneCodeFactor, type ResetPasswordPhoneCodeFactorConfig, type ResetPasswordPhoneCodeStrategy, type Resources, type RgbaColor, type RgbaColorString, type RoleJSON, type RoleResource, type RoutingOptions, type RoutingStrategy, SAML_IDPS, type SDKMetadata, type SamlAccountJSON, type SamlAccountResource, type SamlConfig, type SamlFactor, type SamlIdp, type SamlIdpMap, type SamlIdpSlug, type SamlSettings, type SamlStrategy, type SelectId, type Serializable, type ServerGetToken, type ServerGetTokenOptions, type SessionActivity, type SessionActivityJSON, type SessionJSON, type SessionResource, type SessionStatus, type SessionWithActivitiesJSON, type SessionWithActivitiesResource, type SetActive, type SetActiveParams, type SetOrganizationLogoParams, type SetProfileImageParams, type SetReservedForSecondFactorParams, type SignInCreateParams, type SignInData, type SignInFactor, type SignInFallbackRedirectUrl, type SignInFirstFactor, type SignInFirstFactorJSON, type SignInForceRedirectUrl, type SignInIdentifier, type SignInInitialValues, type SignInJSON, type SignInModalProps, type SignInProps, type SignInRedirectOptions, type SignInResource, type SignInSecondFactor, type SignInSecondFactorJSON, type SignInStartEmailLinkFlowParams, type SignInStatus, type SignInStrategy, type SignInTheme, type SignOut, type SignOutCallback, type SignOutOptions, type SignUpAttributeField, type SignUpAuthenticateWithMetamaskParams, type SignUpAuthenticateWithWeb3Params, type SignUpCreateParams, type SignUpData, type SignUpFallbackRedirectUrl, type SignUpField, type SignUpForceRedirectUrl, type SignUpIdentificationField, type SignUpInitialValues, type SignUpJSON, type SignUpModalProps, type SignUpProps, type SignUpRedirectOptions, type SignUpResource, type SignUpStatus, type SignUpTheme, type SignUpUpdateParams, type SignUpVerifiableField, type SignUpVerificationJSON, type SignUpVerificationResource, type SignUpVerificationsJSON, type SignUpVerificationsResource, type SignatureVerificationAttemptParam, type SlackOauthProvider, type SnakeToCamel, type SpotifyOauthProvider, type StartEmailLinkFlowParams, type StateSelectors, type TOTPAttempt, type TOTPFactor, type TOTPJSON, type TOTPResource, type TOTPStrategy, type TelemetryCollector, type TelemetryEvent, type TelemetryEventRaw, type Theme, type TicketStrategy, type TiktokOauthProvider, type TokenJSON, type TokenResource, type TransparentColor, type TwitchOauthProvider, type TwitterOauthProvider, type UnsubscribeCallback, type UpdateEnrollmentModeParams, type UpdateMembershipParams, type UpdateOrganizationMembershipParams, type UpdateOrganizationParams, type UpdatePasskeyParams, type UpdateUserParams, type UpdateUserPasswordParams, type UserButtonProps, type UserButtonTheme, type UserData, type UserDataJSON, type UserJSON, type UserOrganizationInvitationJSON, type UserOrganizationInvitationResource, type UserPreviewId, type UserProfileModalProps, type UserProfileProps, type UserProfileTheme, type UserResource, type UserSettingsJSON, type UserSettingsResource, type UserVerificationTheme, type UsernameIdentifier, type ValidatePasswordCallbacks, type Variables, type VerificationAttemptParams, type VerificationJSON, type VerificationResource, type VerificationStatus, type VerificationStrategy, type VerifyTOTPParams, WEB3_PROVIDERS, type Web3Attempt, type Web3Provider, type Web3ProviderData, type Web3SignatureConfig, type Web3SignatureFactor, type Web3Strategy, type Web3WalletIdentifier, type Web3WalletJSON, type Web3WalletResource, type Without, type WithoutRouting, type XOauthProvider, type XeroOauthProvider, type ZxcvbnResult, type __experimental_SessionVerificationFirstFactor, type __experimental_SessionVerificationJSON, type __experimental_SessionVerificationLevel, type __experimental_SessionVerificationMaxAge, type __experimental_SessionVerificationResource, type __experimental_SessionVerificationSecondFactor, type __experimental_SessionVerificationStatus, type __experimental_SessionVerifyAttemptFirstFactorParams, type __experimental_SessionVerifyAttemptSecondFactorParams, type __experimental_SessionVerifyCreateParams, type __experimental_SessionVerifyPrepareFirstFactorParams, type __experimental_SessionVerifyPrepareSecondFactorParams, type __experimental_UserVerificationModalProps, type __experimental_UserVerificationProps, getOAuthProviderData, getWeb3ProviderData, sortedOAuthProviders };