References

TOTP Types

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/totp/types.ts:35

Properties

Property	Type	Defined in
TOTPBlockedScreen_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:36
TOTPCodeForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:38
TOTPCodeVerificationFooter_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:39
TOTPCodeVerificationHeader_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:40
TOTPDeviceInfoSection_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:43
TOTPDeviceSetupFooter_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:41
TOTPDeviceSetupHeader_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:42
TOTPLoadingScreen_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/totp/types.ts:37

Config

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

Defined in: recipe/totp/types.ts:142

GetRedirectionURLContext

type GetRedirectionURLContext = never;

Defined in: recipe/totp/types.ts:157

NormalisedConfig

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

Defined in: recipe/totp/types.ts:145

Type Declaration

Name	Type	Defined in
override	object	recipe/totp/types.ts:148
override.functions()	(originalImplementation, builder?) => SuperTokensWrapper	recipe/totp/types.ts:149
totpMFAScreen	TOTPMFAScreenConfig	recipe/totp/types.ts:146

OnHandleEventContext

type OnHandleEventContext = 
  | {
  action: "TOTP_CODE_VERIFIED";
  userContext: UserContext;
}
  | {
  action: "TOTP_DEVICE_VERIFIED";
  deviceName: string;
  userContext: UserContext;
  wasAlreadyVerified: boolean;
}
  | {
  action: "TOTP_DEVICE_CREATED";
  deviceName: string;
  userContext: UserContext;
};

Defined in: recipe/totp/types.ts:173

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = 
  | "CREATE_DEVICE"
  | "VERIFY_CODE"
  | "VERIFY_DEVICE"
  | "REMOVE_DEVICE"
  | "LIST_DEVICES";

Defined in: recipe/totp/types.ts:159

PreAPIHookContext

type PreAPIHookContext = object;

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

Properties

Property	Type	Defined in
action	PreAndPostAPIHookAction	recipe/totp/types.ts:167
requestInit	RequestInit	recipe/totp/types.ts:168
url	string	recipe/totp/types.ts:169
userContext	UserContext	recipe/totp/types.ts:170

TOTPDeviceInfo

type TOTPDeviceInfo = object;

Defined in: recipe/totp/types.ts:46

Properties

Property	Type	Defined in
deviceName	string	recipe/totp/types.ts:47
qrCodeString	string	recipe/totp/types.ts:49
secret	string	recipe/totp/types.ts:48
userIdentifier?	string	recipe/totp/types.ts:50

TOTPMFAAction

type TOTPMFAAction = 
  | {
  callingCreateDevice: boolean;
  deviceInfo: TOTPDeviceInfo | undefined;
  error: string | undefined;
  showAccessDenied: boolean;
  showBackButton: boolean;
  type: "load";
}
  | {
  deviceInfo: TOTPDeviceInfo;
  type: "createDevice";
}
  | {
  error: string | undefined;
  nextRetryAt: number;
  type: "setBlocked";
}
  | {
  currAttemptCount?: number;
  error: string | undefined;
  maxAttemptCount?: number;
  showAccessDenied: boolean;
  type: "setError";
}
  | {
  error: string | undefined;
  type: "restartFlow";
}
  | {
  type: "success";
}
  | {
  type: "showSecret";
};

Defined in: recipe/totp/types.ts:53

TOTPMFAChildProps

type TOTPMFAChildProps = Omit<TOTPMFAProps, "featureState" | "dispatch">;

Defined in: recipe/totp/types.ts:121

TOTPMFACommonProps

type TOTPMFACommonProps = object;

Defined in: recipe/totp/types.ts:102

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/totp/types.ts:105
featureState	TOTPMFAState	recipe/totp/types.ts:103
recipeImplementation	SuperTokensWrapper	recipe/totp/types.ts:104
userContext?	UserContext	recipe/totp/types.ts:106

TOTPMFAProps

type TOTPMFAProps = object;

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

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/totp/types.ts:111
dispatch	Dispatch<TOTPMFAAction>	recipe/totp/types.ts:117
featureState	TOTPMFAState	recipe/totp/types.ts:118
onBackButtonClicked	() => void	recipe/totp/types.ts:114
onRetryClicked	() => void	recipe/totp/types.ts:115
onShowSecretClicked	() => void	recipe/totp/types.ts:113
onSignOutClicked	() => void	recipe/totp/types.ts:116
onSuccess	() => void	recipe/totp/types.ts:112
recipeImplementation	SuperTokensWrapper	recipe/totp/types.ts:110
userContext?	UserContext	recipe/totp/types.ts:119

TOTPMFAScreenConfig

type TOTPMFAScreenConfig = object;

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

Properties

Property	Type	Defined in
blockedScreenStyle	string	recipe/totp/types.ts:127
disableDefaultUI	boolean	recipe/totp/types.ts:124
loadingScreenStyle	string	recipe/totp/types.ts:128
setupScreenStyle	string	recipe/totp/types.ts:125
verificationScreenStyle	string	recipe/totp/types.ts:126

TOTPMFAState

type TOTPMFAState = object;

Defined in: recipe/totp/types.ts:89

Properties

Property	Type	Defined in
currAttemptCount?	number	recipe/totp/types.ts:98
deviceInfo?	TOTPDeviceInfo	recipe/totp/types.ts:90
error	string \| undefined	recipe/totp/types.ts:96
isBlocked	boolean	recipe/totp/types.ts:93
loaded	boolean	recipe/totp/types.ts:95
maxAttemptCount?	number	recipe/totp/types.ts:97
nextRetryAt?	number	recipe/totp/types.ts:92
showAccessDenied	boolean	recipe/totp/types.ts:99
showBackButton	boolean	recipe/totp/types.ts:94
showSecret	boolean	recipe/totp/types.ts:91

UserInput

type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/totp/types.ts:131

Type Declaration

Name	Type	Defined in
override?	object	recipe/totp/types.ts:134
override.functions()?	(originalImplementation, builder?) => SuperTokensWrapper	recipe/totp/types.ts:135
totpMFAScreen?	Partial<TOTPMFAScreenConfig>	recipe/totp/types.ts:132