supertokens-auth-react/recipe/webauthn/types

References documentation for the supertokens-auth-react/recipe/webauthn/types package

Enumerations

RecoverAccountScreen

Enumeration Members

Enumeration Member	Value	Defined in
`ContinueWithPasskey`	`0`	recipe/webauthn/types.ts
`Success`	`1`	recipe/webauthn/types.ts

SendRecoveryEmailScreen

Defined in: recipe/webauthn/types.ts

Enumeration Members

Enumeration Member	Value	Defined in
`RecoverAccount`	`0`	recipe/webauthn/types.ts
`RecoverEmailSent`	`1`	recipe/webauthn/types.ts

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`WebauthnContinueWithoutPasskey_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnContinueWithPasskey_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnMFAFooter_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnMFALoadingScreen_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnMFASignIn_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnMFASignUp_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnMFASignUpConfirmation_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnPasskeyConfirmation_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnPasskeyFeatureBlock_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnPasskeyNotSupportedError_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnPasskeyRecoveryEmailSent_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnPasskeySignUpForm_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnPasskeySignUpSomethingWentWrong_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnRecoverAccount_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts
`WebauthnRecoverAccountForm_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/webauthn/types.ts

Config

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

Defined in: recipe/webauthn/types.ts

ContinueOnSuccessParams

type ContinueOnSuccessParams = object;

Defined in: recipe/webauthn/types.ts

Properties

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

ContinueWithPasskeyProps

type ContinueWithPasskeyProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`continueTo`	`"SIGN_UP"` \| `"SIGN_IN"`	recipe/webauthn/types.ts
`continueWithPasskeyClicked`	() => `void`	recipe/webauthn/types.ts
`isLoading`	`boolean`	recipe/webauthn/types.ts
`isPasskeySupported`	`boolean`	recipe/webauthn/types.ts
`recipeImplementation`	`RecipeImplementation`	recipe/webauthn/types.ts

EmailSentProps

type EmailSentProps = object;

Defined in: recipe/webauthn/types.ts

Properties

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

FeatureBlockDetailProps

type FeatureBlockDetailProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`icon`	`JSX.Element`	recipe/webauthn/types.ts
`subText`	`string`	recipe/webauthn/types.ts
`title`	`string`	recipe/webauthn/types.ts

GetRedirectionURLContext

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

Defined in: recipe/webauthn/types.ts

NormalisedConfig

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

Defined in: recipe/webauthn/types.ts

Type Declaration

Name	Type	Defined in
`disableDefaultUI?`	`boolean`	recipe/webauthn/types.ts
`override`	`object`	recipe/webauthn/types.ts
`override.functions()`	(`originalImplementation`) => `SuperTokensWrapper`	recipe/webauthn/types.ts
`recoveryFeature`	`NormalisedRecoveryFeatureConfig`	recipe/webauthn/types.ts
`signInAndUpFeature`	`NormalisedSignInAndUpFormFeatureConfig`	recipe/webauthn/types.ts

NormalisedRecoveryFeatureConfig

type NormalisedRecoveryFeatureConfig = NormalisedBaseConfig & object;

Defined in: recipe/webauthn/types.ts

Type Declaration

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

NormalisedSignInAndUpFormFeatureConfig

type NormalisedSignInAndUpFormFeatureConfig = NormalisedBaseConfig;

Defined in: recipe/webauthn/types.ts

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

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

RecipeImplementation

type RecipeImplementation = WebJSRecipeInterface<typeof SuperTokensWrapper>;

Defined in: recipe/webauthn/types.ts

RecoverAccountWithTokenProps

type RecoverAccountWithTokenProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`children?`	`React.ReactNode`	recipe/webauthn/types.ts
`recipe`	`SuperTokensWrapper`	recipe/webauthn/types.ts
`useComponentOverrides`	() => `ComponentOverrideMap`	recipe/webauthn/types.ts
`userContext?`	`UserContext`	recipe/webauthn/types.ts

RecoverAccountWithTokenThemeProps

type RecoverAccountWithTokenThemeProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`activeScreen`	`RecoverAccountScreen`	recipe/webauthn/types.ts
`clearError`	() => `void`	recipe/webauthn/types.ts
`config`	`NormalisedConfig`	recipe/webauthn/types.ts
`error`	`string` \| `undefined`	recipe/webauthn/types.ts
`errorMessageLabel`	`string` \| `null`	recipe/webauthn/types.ts
`isLoading`	`boolean`	recipe/webauthn/types.ts
`onContinueClick`	() => `void`	recipe/webauthn/types.ts
`onError`	(`error`) => `void`	recipe/webauthn/types.ts
`recipeImplementation`	`RecipeImplementation`	recipe/webauthn/types.ts
`registerOptions`	`RegisterOptions` \| `null`	recipe/webauthn/types.ts
`token`	`string` \| `null`	recipe/webauthn/types.ts
`userContext?`	`UserContext`	recipe/webauthn/types.ts

RecoverFormProps

type RecoverFormProps = object;

Defined in: recipe/webauthn/types.ts

Properties

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

RegisterOptions

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

Defined in: recipe/webauthn/types.ts

SendRecoveryEmailFormProps

type SendRecoveryEmailFormProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`children?`	`React.ReactNode`	recipe/webauthn/types.ts
`recipe`	`SuperTokensWrapper`	recipe/webauthn/types.ts
`useComponentOverrides`	() => `ComponentOverrideMap`	recipe/webauthn/types.ts
`userContext?`	`UserContext`	recipe/webauthn/types.ts

SendRecoveryEmailFormThemeProps

type SendRecoveryEmailFormThemeProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`activeScreen`	`SendRecoveryEmailScreen`	recipe/webauthn/types.ts
`clearError`	() => `void`	recipe/webauthn/types.ts
`config`	`NormalisedConfig`	recipe/webauthn/types.ts
`error`	`string` \| `undefined`	recipe/webauthn/types.ts
`onEmailChangeClick`	() => `void`	recipe/webauthn/types.ts
`onError`	(`error`) => `void`	recipe/webauthn/types.ts
`onRecoverAccountBackClick`	() => `void`	recipe/webauthn/types.ts
`onRecoverAccountFormSuccess`	(`result`) => `void`	recipe/webauthn/types.ts
`recipeImplementation`	`RecipeImplementation`	recipe/webauthn/types.ts
`recoverAccountEmail`	`string`	recipe/webauthn/types.ts
`setActiveScreen`	`React.Dispatch`<`React.SetStateAction`<`SendRecoveryEmailScreen`>>	recipe/webauthn/types.ts
`userContext?`	`UserContext`	recipe/webauthn/types.ts

SignInThemeProps

type SignInThemeProps = SignUpThemeBaseProps & object;

Defined in: recipe/webauthn/types.ts

Type Declaration

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

SignUpFormProps

type SignUpFormProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`clearError`	() => `void`	recipe/webauthn/types.ts
`config`	`NormalisedConfig`	recipe/webauthn/types.ts
`error`	`string` \| `undefined`	recipe/webauthn/types.ts
`onError`	(`error`) => `void`	recipe/webauthn/types.ts
`onFetchError?`	(`error`) => `void`	recipe/webauthn/types.ts
`onSuccess?`	(`result`) => `void`	recipe/webauthn/types.ts
`recipeImplementation`	`RecipeImplementation`	recipe/webauthn/types.ts
`resetFactorList?`	() => `void`	recipe/webauthn/types.ts
`showBackButton`	`boolean`	recipe/webauthn/types.ts

SignUpThemeBaseProps

type SignUpThemeBaseProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`clearError`	() => `void`	recipe/webauthn/types.ts
`config`	`NormalisedConfig`	recipe/webauthn/types.ts
`error`	`string` \| `undefined`	recipe/webauthn/types.ts
`factorIds`	`string`[]	recipe/webauthn/types.ts
`onError`	(`err`) => `void`	recipe/webauthn/types.ts
`onFetchError`	(`err`) => `void`	recipe/webauthn/types.ts
`onSignInUpSwitcherClick`	() => `void`	recipe/webauthn/types.ts
`onSuccess`	(`result`) => `void`	recipe/webauthn/types.ts
`recipeImplementation`	`RecipeImplementation`	recipe/webauthn/types.ts
`resetFactorList`	() => `void`	recipe/webauthn/types.ts
`showBackButton`	`boolean`	recipe/webauthn/types.ts
`userContext`	`UserContext`	recipe/webauthn/types.ts

SignUpThemeProps

type SignUpThemeProps = SignUpThemeBaseProps & object;

Defined in: recipe/webauthn/types.ts

Type Declaration

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

UserInput

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

Defined in: recipe/webauthn/types.ts

Type Declaration

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

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

WebAuthnMFAProps

type WebAuthnMFAProps = object;

Defined in: recipe/webauthn/types.ts

Properties

Property	Type	Defined in
`config`	`NormalisedConfig`	recipe/webauthn/types.ts
`dispatch`	`Dispatch`<`WebAuthnMFAAction`>	recipe/webauthn/types.ts
`featureState`	`WebAuthnMFAState`	recipe/webauthn/types.ts
`onBackButtonClicked`	() => `void`	recipe/webauthn/types.ts
`onRecoverAccountClick`	() => `void`	recipe/webauthn/types.ts
`onSignIn`	() => `Promise`<`void`>	recipe/webauthn/types.ts
`onSignOutClicked`	() => `void`	recipe/webauthn/types.ts
`onSignUp`	(`email`) => `Promise`<`void`>	recipe/webauthn/types.ts
`recipeImplementation`	`RecipeImplementation`	recipe/webauthn/types.ts
`userContext?`	`UserContext`	recipe/webauthn/types.ts

WebAuthnMFAState

type WebAuthnMFAState = WebAuthnMFAInitialState | WebAuthnMFALoadedState;

Defined in: recipe/webauthn/types.ts