References

WebAuthn Types

Enumerations

RecoverAccountScreen

Defined in: recipe/webauthn/types.ts:190

Enumeration Members

Enumeration Member	Value	Defined in
ContinueWithPasskey	0	recipe/webauthn/types.ts:191
Success	1	recipe/webauthn/types.ts:192

SendRecoveryEmailScreen

Defined in: recipe/webauthn/types.ts:217

Enumeration Members

Enumeration Member	Value	Defined in
RecoverAccount	0	recipe/webauthn/types.ts:218
RecoverEmailSent	1	recipe/webauthn/types.ts:219

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/webauthn/types.ts:125

Properties

Property	Type	Defined in
WebauthnContinueWithoutPasskey_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:133
WebauthnContinueWithPasskey_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:126
WebauthnMFAFooter_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:140
WebauthnMFALoadingScreen_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:137
WebauthnMFASignIn_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:136
WebauthnMFASignUp_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:138
WebauthnMFASignUpConfirmation_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:139
WebauthnPasskeyConfirmation_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:131
WebauthnPasskeyFeatureBlock_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:132
WebauthnPasskeyNotSupportedError_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:127
WebauthnPasskeyRecoveryEmailSent_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:128
WebauthnPasskeySignUpForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:134
WebauthnPasskeySignUpSomethingWentWrong_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:135
WebauthnRecoverAccount_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:130
WebauthnRecoverAccountForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/webauthn/types.ts:129

Config

type Config = UserInput & AuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/webauthn/types.ts:104

ContinueOnSuccessParams

type ContinueOnSuccessParams = object;

Defined in: recipe/webauthn/types.ts:237

Properties

Property	Type	Defined in
email	string	recipe/webauthn/types.ts:238

ContinueWithPasskeyProps

type ContinueWithPasskeyProps = object;

Defined in: recipe/webauthn/types.ts:253

Properties

Property	Type	Defined in
continueTo	"SIGN_UP" \| "SIGN_IN"	recipe/webauthn/types.ts:255
continueWithPasskeyClicked	() => void	recipe/webauthn/types.ts:256
isLoading	boolean	recipe/webauthn/types.ts:257
isPasskeySupported	boolean	recipe/webauthn/types.ts:259
recipeImplementation	RecipeImplementation	recipe/webauthn/types.ts:258

EmailSentProps

type EmailSentProps = object;

Defined in: recipe/webauthn/types.ts:262

Properties

Property	Type	Defined in
email	string	recipe/webauthn/types.ts:263
onEmailChangeClick	() => void	recipe/webauthn/types.ts:264

FeatureBlockDetailProps

type FeatureBlockDetailProps = object;

Defined in: recipe/webauthn/types.ts:241

Properties

Property	Type	Defined in
icon	JSX.Element	recipe/webauthn/types.ts:244
subText	string	recipe/webauthn/types.ts:243
title	string	recipe/webauthn/types.ts:242

GetRedirectionURLContext

type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<{
  action: "SEND_RECOVERY_EMAIL";
}>;

Defined in: recipe/webauthn/types.ts:55

NormalisedConfig

type NormalisedConfig = object & NormalisedAuthRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/webauthn/types.ts:113

Type Declaration

Name	Type	Defined in
disableDefaultUI?	boolean	recipe/webauthn/types.ts:116
override	object	recipe/webauthn/types.ts:118
override.functions()	(originalImplementation) => SuperTokensWrapper	recipe/webauthn/types.ts:119
recoveryFeature	NormalisedRecoveryFeatureConfig	recipe/webauthn/types.ts:115
signInAndUpFeature	NormalisedSignInAndUpFormFeatureConfig	recipe/webauthn/types.ts:114

NormalisedRecoveryFeatureConfig

type NormalisedRecoveryFeatureConfig = NormalisedBaseConfig & object;

Defined in: recipe/webauthn/types.ts:109

Type Declaration

Name	Type	Defined in
disableDefaultUI	boolean	recipe/webauthn/types.ts:110

NormalisedSignInAndUpFormFeatureConfig

type NormalisedSignInAndUpFormFeatureConfig = NormalisedBaseConfig;

Defined in: recipe/webauthn/types.ts:107

OnHandleEventContext

type OnHandleEventContext = 
  | {
  action: "SUCCESS";
  createdNewSession: boolean;
  isNewRecipeUser: boolean;
  user: SuperTokensWrapper;
}
  | {
  action: "GET_EMAIL_EXISTS";
  exists: boolean;
}
  | {
  action: "REGISTER_CREDENTIAL_OK";
}
  | {
  action: "AUTHENTICATE_CREDENTIAL_OK";
}
  | {
  action: "FAILED_TO_REGISTER_USER";
}
  | AuthRecipeModuleOnHandleEventContext;

Defined in: recipe/webauthn/types.ts:74

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = 
  | "REGISTER_OPTIONS"
  | "SIGN_IN_OPTIONS"
  | "SIGN_UP"
  | "SIGN_IN"
  | "EMAIL_EXISTS"
  | "GENERATE_RECOVER_ACCOUNT_TOKEN"
  | "RECOVER_ACCOUNT"
  | "REGISTER_CREDENTIAL"
  | "REMOVE_CREDENTIAL"
  | "LIST_CREDENTIALS";

Defined in: recipe/webauthn/types.ts:62

RecipeImplementation

type RecipeImplementation = WebJSRecipeInterface<typeof SuperTokensWrapper>;

Defined in: recipe/webauthn/types.ts:123

RecoverAccountWithTokenProps

type RecoverAccountWithTokenProps = object;

Defined in: recipe/webauthn/types.ts:178

Properties

Property	Type	Defined in
children?	React.ReactNode	recipe/webauthn/types.ts:182
recipe	SuperTokensWrapper	recipe/webauthn/types.ts:180
useComponentOverrides	() => ComponentOverrideMap	recipe/webauthn/types.ts:181
userContext?	UserContext	recipe/webauthn/types.ts:179

RecoverAccountWithTokenThemeProps

type RecoverAccountWithTokenThemeProps = object;

Defined in: recipe/webauthn/types.ts:195

Properties

Property	Type	Defined in
activeScreen	RecoverAccountScreen	recipe/webauthn/types.ts:206
clearError	() => void	recipe/webauthn/types.ts:200
config	NormalisedConfig	recipe/webauthn/types.ts:196
error	string \| undefined	recipe/webauthn/types.ts:199
errorMessageLabel	string \| null	recipe/webauthn/types.ts:204
isLoading	boolean	recipe/webauthn/types.ts:205
onContinueClick	() => void	recipe/webauthn/types.ts:207
onError	(error) => void	recipe/webauthn/types.ts:201
recipeImplementation	RecipeImplementation	recipe/webauthn/types.ts:198
registerOptions	RegisterOptions \| null	recipe/webauthn/types.ts:203
token	string \| null	recipe/webauthn/types.ts:202
userContext?	UserContext	recipe/webauthn/types.ts:197

RecoverFormProps

type RecoverFormProps = object;

Defined in: recipe/webauthn/types.ts:247

Properties

Property	Type	Defined in
onBackClick	() => void	recipe/webauthn/types.ts:249
onSuccess	(result) => void	recipe/webauthn/types.ts:248
recipeImplementation	RecipeImplementation	recipe/webauthn/types.ts:250

RegisterOptions

type RegisterOptions = Extract<Awaited<ReturnType<RecipeImplementation["getRegisterOptions"]>>, {
  status: "OK";
}>;

Defined in: recipe/webauthn/types.ts:185

SendRecoveryEmailFormProps

type SendRecoveryEmailFormProps = object;

Defined in: recipe/webauthn/types.ts:210

Properties

Property	Type	Defined in
children?	React.ReactNode	recipe/webauthn/types.ts:214
recipe	SuperTokensWrapper	recipe/webauthn/types.ts:212
useComponentOverrides	() => ComponentOverrideMap	recipe/webauthn/types.ts:213
userContext?	UserContext	recipe/webauthn/types.ts:211

SendRecoveryEmailFormThemeProps

type SendRecoveryEmailFormThemeProps = object;

Defined in: recipe/webauthn/types.ts:222

Properties

Property	Type	Defined in
activeScreen	SendRecoveryEmailScreen	recipe/webauthn/types.ts:230
clearError	() => void	recipe/webauthn/types.ts:227
config	NormalisedConfig	recipe/webauthn/types.ts:223
error	string \| undefined	recipe/webauthn/types.ts:226
onEmailChangeClick	() => void	recipe/webauthn/types.ts:234
onError	(error) => void	recipe/webauthn/types.ts:228
onRecoverAccountBackClick	() => void	recipe/webauthn/types.ts:233
onRecoverAccountFormSuccess	(result) => void	recipe/webauthn/types.ts:232
recipeImplementation	RecipeImplementation	recipe/webauthn/types.ts:225
recoverAccountEmail	string	recipe/webauthn/types.ts:229
setActiveScreen	React.Dispatch<React.SetStateAction<SendRecoveryEmailScreen>>	recipe/webauthn/types.ts:231
userContext?	UserContext	recipe/webauthn/types.ts:224

SignInThemeProps

type SignInThemeProps = SignUpThemeBaseProps & object;

Defined in: recipe/webauthn/types.ts:162

Type Declaration

Name	Type	Defined in
isPasskeySupported	boolean	recipe/webauthn/types.ts:163

SignUpFormProps

type SignUpFormProps = object;

Defined in: recipe/webauthn/types.ts:166

Properties

Property	Type	Defined in
clearError	() => void	recipe/webauthn/types.ts:167
config	NormalisedConfig	recipe/webauthn/types.ts:172
error	string \| undefined	recipe/webauthn/types.ts:170
onError	(error) => void	recipe/webauthn/types.ts:168
onFetchError?	(error) => void	recipe/webauthn/types.ts:169
onSuccess?	(result) => void	recipe/webauthn/types.ts:173
recipeImplementation	RecipeImplementation	recipe/webauthn/types.ts:171
resetFactorList?	() => void	recipe/webauthn/types.ts:174
showBackButton	boolean	recipe/webauthn/types.ts:175

SignUpThemeBaseProps

type SignUpThemeBaseProps = object;

Defined in: recipe/webauthn/types.ts:143

Properties

Property	Type	Defined in
clearError	() => void	recipe/webauthn/types.ts:144
config	NormalisedConfig	recipe/webauthn/types.ts:147
error	string \| undefined	recipe/webauthn/types.ts:151
factorIds	string[]	recipe/webauthn/types.ts:146
onError	(err) => void	recipe/webauthn/types.ts:150
onFetchError	(err) => void	recipe/webauthn/types.ts:149
onSignInUpSwitcherClick	() => void	recipe/webauthn/types.ts:154
onSuccess	(result) => void	recipe/webauthn/types.ts:148
recipeImplementation	RecipeImplementation	recipe/webauthn/types.ts:145
resetFactorList	() => void	recipe/webauthn/types.ts:153
showBackButton	boolean	recipe/webauthn/types.ts:155
userContext	UserContext	recipe/webauthn/types.ts:152

SignUpThemeProps

type SignUpThemeProps = SignUpThemeBaseProps & object;

Defined in: recipe/webauthn/types.ts:158

Type Declaration

Name	Type	Defined in
onRecoverAccountClick()	() => void	recipe/webauthn/types.ts:159

UserInput

type UserInput = Record<string, unknown> & object & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/webauthn/types.ts:96

Type Declaration

Name	Type	Defined in
override?	object	recipe/webauthn/types.ts:97
override.functions()?	(originalImplementation) => SuperTokensWrapper	recipe/webauthn/types.ts:98
recoveryFeature?	NormalisedRecoveryFeatureConfig	recipe/webauthn/types.ts:101
signInAndUpFeature?	NormalisedSignInAndUpFormFeatureConfig	recipe/webauthn/types.ts:100

WebAuthnMFAAction

type WebAuthnMFAAction = 
  | {
  accessDenied?: boolean;
  error: string | undefined;
  type: "setError";
}
  | {
  canRegisterPasskey: boolean;
  deviceSupported: boolean;
  email: string | undefined;
  error: string | undefined;
  hasRegisteredPassKey: boolean;
  showBackButton: boolean;
  type: "load";
};

Defined in: recipe/webauthn/types.ts:267

WebAuthnMFAProps

type WebAuthnMFAProps = object;

Defined in: recipe/webauthn/types.ts:307

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/webauthn/types.ts:309
dispatch	Dispatch<WebAuthnMFAAction>	recipe/webauthn/types.ts:317
featureState	WebAuthnMFAState	recipe/webauthn/types.ts:316
onBackButtonClicked	() => void	recipe/webauthn/types.ts:310
onRecoverAccountClick	() => void	recipe/webauthn/types.ts:314
onSignIn	() => Promise<void>	recipe/webauthn/types.ts:312
onSignOutClicked	() => void	recipe/webauthn/types.ts:311
onSignUp	(email) => Promise<void>	recipe/webauthn/types.ts:313
recipeImplementation	RecipeImplementation	recipe/webauthn/types.ts:308
userContext?	UserContext	recipe/webauthn/types.ts:315

WebAuthnMFAState

type WebAuthnMFAState = WebAuthnMFAInitialState | WebAuthnMFALoadedState;

Defined in: recipe/webauthn/types.ts:305