References

Passwordless Types

Type Aliases

AdditionalLoginAttemptInfoProperties

type AdditionalLoginAttemptInfoProperties = object;

Defined in: recipe/passwordless/types.ts:231

When calling getLoginAttemptInfo/setLoginAttemptInfo from web-js we use generics to get access to properties in local storage that web-js does not set by default. This allows us to strongly type the response while keeping it dynamic.

In the context of auth-react this type indicates all the additional properties we need.

Properties

Property	Type	Defined in
contactInfo	string	recipe/passwordless/types.ts:232
contactMethod	"EMAIL" \| "PHONE"	recipe/passwordless/types.ts:233
lastResend	number	recipe/passwordless/types.ts:234
redirectToPath?	string	recipe/passwordless/types.ts:235

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/passwordless/types.ts:445

Properties

Property	Type	Defined in
PasswordlessContinueWithPasswordless_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:459
PasswordlessEmailForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:446
PasswordlessEmailOrPhoneForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:448
PasswordlessEPComboEmailForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:449
PasswordlessEPComboEmailOrPhoneForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:450
PasswordlessLinkClickedScreen_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:458
PasswordlessLinkSent_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:456
PasswordlessMFAFooter_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:462
PasswordlessMFAHeader_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:461
PasswordlessMFAOTPFooter_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:464
PasswordlessMFAOTPHeader_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:463
PasswordlessMFAOTPLoadingScreen_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:465
PasswordlessPhoneForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:447
PasswordlessUserInputCodeForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:454
PasswordlessUserInputCodeFormFooter_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:453
PasswordlessUserInputCodeFormHeader_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/passwordless/types.ts:452

Config

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

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

GetRedirectionURLContext

type GetRedirectionURLContext = never;

Defined in: recipe/passwordless/types.ts:78

LinkClickedScreenProps

type LinkClickedScreenProps = object;

Defined in: recipe/passwordless/types.ts:283

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/passwordless/types.ts:285
consumeCode	() => void	recipe/passwordless/types.ts:287
onSuccess?	() => void	recipe/passwordless/types.ts:288
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:284
requireUserInteraction	boolean	recipe/passwordless/types.ts:286

LinkSentChildProps

type LinkSentChildProps = LinkSentThemeProps;

Defined in: recipe/passwordless/types.ts:389

LinkSentThemeProps

type LinkSentThemeProps = object;

Defined in: recipe/passwordless/types.ts:392

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:393
config	NormalisedConfig	recipe/passwordless/types.ts:398
error	string \| undefined	recipe/passwordless/types.ts:395
loginAttemptInfo	LoginAttemptInfo	recipe/passwordless/types.ts:396
onError	(error) => void	recipe/passwordless/types.ts:394
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:397

LoginAttemptInfo

type LoginAttemptInfo = object;

Defined in: recipe/passwordless/types.ts:214

Properties

Property	Type	Defined in
contactInfo	string	recipe/passwordless/types.ts:217
contactMethod	"EMAIL" \| "PHONE"	recipe/passwordless/types.ts:218
deviceId	string	recipe/passwordless/types.ts:215
flowType	"USER_INPUT_CODE" \| "MAGIC_LINK" \| "USER_INPUT_CODE_AND_MAGIC_LINK"	recipe/passwordless/types.ts:221
lastResend	number	recipe/passwordless/types.ts:219
preAuthSessionId	string	recipe/passwordless/types.ts:216
redirectToPath?	string	recipe/passwordless/types.ts:220

MFAAction

type MFAAction = 
  | {
  callingCreateCode: boolean;
  canChangeEmail: boolean;
  error: string | undefined;
  loginAttemptInfo: LoginAttemptInfo | undefined;
  showAccessDenied: boolean;
  showBackButton: boolean;
  type: "load";
}
  | {
  loginAttemptInfo: LoginAttemptInfo;
  type: "startVerify";
}
  | {
  timestamp: number;
  type: "resendCode";
}
  | {
  error: string | undefined;
  type: "restartFlow";
}
  | {
  error: string | undefined;
  showAccessDenied: boolean;
  type: "setError";
};

Defined in: recipe/passwordless/types.ts:335

MFAChildProps

type MFAChildProps = Omit<MFAProps, "featureState" | "dispatch">;

Defined in: recipe/passwordless/types.ts:390

MFAFooterProps

type MFAFooterProps = object;

Defined in: recipe/passwordless/types.ts:413

Properties

Property	Type	Defined in
canChangeEmail	boolean	recipe/passwordless/types.ts:414
config	NormalisedConfig	recipe/passwordless/types.ts:417
onSignOutClicked	() => void	recipe/passwordless/types.ts:415
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:416

MFAHeaderProps

type MFAHeaderProps = object;

Defined in: recipe/passwordless/types.ts:428

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/passwordless/types.ts:433
contactMethod	"EMAIL" \| "PHONE"	recipe/passwordless/types.ts:429
onBackButtonClicked	() => void	recipe/passwordless/types.ts:431
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:432
showBackButton	boolean	recipe/passwordless/types.ts:430

MFAOTPFooterProps

type MFAOTPFooterProps = object;

Defined in: recipe/passwordless/types.ts:420

Properties

Property	Type	Defined in
canChangeEmail	boolean	recipe/passwordless/types.ts:421
config	NormalisedConfig	recipe/passwordless/types.ts:425
loginAttemptInfo	LoginAttemptInfo	recipe/passwordless/types.ts:423
onSignOutClicked	() => void	recipe/passwordless/types.ts:422
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:424

MFAOTPHeaderProps

type MFAOTPHeaderProps = object;

Defined in: recipe/passwordless/types.ts:436

Properties

Property	Type	Defined in
canChangeEmail	boolean	recipe/passwordless/types.ts:437
config	NormalisedConfig	recipe/passwordless/types.ts:442
loginAttemptInfo	LoginAttemptInfo	recipe/passwordless/types.ts:440
onBackButtonClicked	() => void	recipe/passwordless/types.ts:439
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:441
showBackButton	boolean	recipe/passwordless/types.ts:438

MFAProps

type MFAProps = object;

Defined in: recipe/passwordless/types.ts:182

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/passwordless/types.ts:184
contactMethod	"EMAIL" \| "PHONE"	recipe/passwordless/types.ts:185
dispatch	Dispatch<MFAAction>	recipe/passwordless/types.ts:190
featureState	object	recipe/passwordless/types.ts:191
featureState.canChangeEmail	boolean	recipe/passwordless/types.ts:192
featureState.error	string \| undefined	recipe/passwordless/types.ts:197
featureState.loaded	boolean	recipe/passwordless/types.ts:194
featureState.loginAttemptInfo?	LoginAttemptInfo	recipe/passwordless/types.ts:193
featureState.showAccessDenied	boolean	recipe/passwordless/types.ts:196
featureState.showBackButton	boolean	recipe/passwordless/types.ts:195
onBackButtonClicked	() => void	recipe/passwordless/types.ts:186
onFetchError	(err) => void	recipe/passwordless/types.ts:189
onSignOutClicked	() => void	recipe/passwordless/types.ts:187
onSuccess?	() => void	recipe/passwordless/types.ts:188
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:183
userContext?	UserContext	recipe/passwordless/types.ts:200
validatePhoneNumber	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:199

MFAState

type MFAState = object;

Defined in: recipe/passwordless/types.ts:363

Properties

Property	Type	Defined in
canChangeEmail	boolean	recipe/passwordless/types.ts:369
error	string \| undefined	recipe/passwordless/types.ts:365
loaded	boolean	recipe/passwordless/types.ts:366
loginAttemptInfo	LoginAttemptInfo \| undefined	recipe/passwordless/types.ts:368
showAccessDenied	boolean	recipe/passwordless/types.ts:364
showBackButton	boolean	recipe/passwordless/types.ts:367

NormalisedConfig

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

Defined in: recipe/passwordless/types.ts:100

Type Declaration

Name	Type	Defined in
contactMethod	"PHONE" \| "EMAIL" \| "EMAIL_OR_PHONE"	recipe/passwordless/types.ts:118
linkClickedScreenFeature	PasswordlessNormalisedBaseConfig	recipe/passwordless/types.ts:115
mfaFeature	PasswordlessNormalisedBaseConfig	recipe/passwordless/types.ts:116
override	object	recipe/passwordless/types.ts:120
override.functions()	(originalImplementation) => SuperTokensWrapper	recipe/passwordless/types.ts:121
signInUpFeature	object	recipe/passwordless/types.ts:106
signInUpFeature.defaultCountry?	string	recipe/passwordless/types.ts:108
signInUpFeature.defaultToEmail	boolean	recipe/passwordless/types.ts:110
signInUpFeature.emailOrPhoneFormStyle	string	recipe/passwordless/types.ts:111
signInUpFeature.linkSentScreenStyle	string	recipe/passwordless/types.ts:113
signInUpFeature.resendEmailOrSMSGapInSeconds	number	recipe/passwordless/types.ts:107
signInUpFeature.userInputCodeFormStyle	string	recipe/passwordless/types.ts:112
validateEmailAddress()	(email) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:101
validatePhoneNumber()?	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:104

OnHandleEventContext

type OnHandleEventContext = 
  | {
  action: "SUCCESS";
  createdNewSession: boolean;
  isNewRecipeUser: boolean;
  user: SuperTokensWrapper;
}
  | {
  action: "PASSWORDLESS_RESTART_FLOW";
}
  | {
  action: "PASSWORDLESS_CODE_SENT";
  isResend: boolean;
}
  | AuthRecipeModuleOnHandleEventContext;

Defined in: recipe/passwordless/types.ts:80

PasswordlessFeatureBaseConfig

type PasswordlessFeatureBaseConfig = object & FeatureBaseConfig;

Defined in: recipe/passwordless/types.ts:128

Type Declaration

Name	Type	Defined in
disableDefaultUI?	boolean	recipe/passwordless/types.ts:129

PasswordlessNormalisedBaseConfig

type PasswordlessNormalisedBaseConfig = object & NormalisedBaseConfig;

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

Type Declaration

Name	Type	Defined in
disableDefaultUI?	boolean	recipe/passwordless/types.ts:97

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = 
  | "PASSWORDLESS_CREATE_CODE"
  | "PASSWORDLESS_CONSUME_CODE"
  | "PASSWORDLESS_RESEND_CODE"
  | "EMAIL_EXISTS"
  | "PHONE_NUMBER_EXISTS";

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

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/passwordless/types.ts:60

Properties

Property	Type	Defined in
action	PreAndPostAPIHookAction	recipe/passwordless/types.ts:64
requestInit	RequestInit	recipe/passwordless/types.ts:69
url	string	recipe/passwordless/types.ts:74

RecipeImplementation

type RecipeImplementation = WebJSRecipeInterface<typeof SuperTokensWrapper>;

Defined in: recipe/passwordless/types.ts:238

SignInUpChildProps

type SignInUpChildProps = SignInUpProps;

Defined in: recipe/passwordless/types.ts:372

SignInUpEmailFormProps

type SignInUpEmailFormProps = object;

Defined in: recipe/passwordless/types.ts:240

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:241
config	NormalisedConfig	recipe/passwordless/types.ts:246
error	string \| undefined	recipe/passwordless/types.ts:244
onError	(error) => void	recipe/passwordless/types.ts:242
onFetchError	(error) => void	recipe/passwordless/types.ts:243
onSuccess?	() => void	recipe/passwordless/types.ts:247
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:245

SignInUpEmailOrPhoneFormProps

type SignInUpEmailOrPhoneFormProps = object;

Defined in: recipe/passwordless/types.ts:261

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:262
config	NormalisedConfig	recipe/passwordless/types.ts:267
error	string \| undefined	recipe/passwordless/types.ts:265
onError	(error) => void	recipe/passwordless/types.ts:263
onFetchError	(error) => void	recipe/passwordless/types.ts:264
onSuccess?	() => void	recipe/passwordless/types.ts:268
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:266
validatePhoneNumber	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:269

SignInUpEPComboChildProps

type SignInUpEPComboChildProps = Omit<SignInUpProps, "onSuccess"> & object;

Defined in: recipe/passwordless/types.ts:373

Type Declaration

Name	Type	Defined in
isPhoneNumber	boolean	recipe/passwordless/types.ts:374
navigate	Navigate \| undefined	recipe/passwordless/types.ts:387
onContactInfoSubmit()	(contactInfo) => Promise<FormBaseAPIResponse<unknown>>	recipe/passwordless/types.ts:378
onContinueWithPasswordlessClick()	(contactInfo) => Promise<void>	recipe/passwordless/types.ts:380
onPasswordSubmit()	(formFields) => Promise<FormBaseAPIResponse<unknown>>	recipe/passwordless/types.ts:379
onSuccess()	(result) => void	recipe/passwordless/types.ts:381
setIsPhoneNumber()	(isPhone) => void	recipe/passwordless/types.ts:375
showContinueWithPasswordlessLink	boolean	recipe/passwordless/types.ts:377
showPasswordField	boolean	recipe/passwordless/types.ts:376
validatePhoneNumber()	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:386

SignInUpEPComboEmailFormProps

type SignInUpEPComboEmailFormProps = object;

Defined in: recipe/passwordless/types.ts:314

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:317
config	NormalisedConfig	recipe/passwordless/types.ts:331
error	string \| undefined	recipe/passwordless/types.ts:328
navigate	Navigate \| undefined	recipe/passwordless/types.ts:332
onContactInfoSubmit	(contactInfo) => Promise<FormBaseAPIResponse<unknown>>	recipe/passwordless/types.ts:318
onContinueWithPasswordlessClick	(contactInfo) => Promise<void>	recipe/passwordless/types.ts:320
onError	(error) => void	recipe/passwordless/types.ts:326
onFetchError	(error) => void	recipe/passwordless/types.ts:327
onPasswordSubmit	(formFields) => Promise<FormBaseAPIResponse<unknown>>	recipe/passwordless/types.ts:319
onSuccess	(result) => void	recipe/passwordless/types.ts:321
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:329
showContinueWithPasswordlessLink	boolean	recipe/passwordless/types.ts:316
showPasswordField	boolean	recipe/passwordless/types.ts:315
validatePhoneNumber	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:330

SignInUpEPComboEmailOrPhoneFormProps

type SignInUpEPComboEmailOrPhoneFormProps = object;

Defined in: recipe/passwordless/types.ts:291

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:294
config	NormalisedConfig	recipe/passwordless/types.ts:309
error	string \| undefined	recipe/passwordless/types.ts:307
isPhoneNumber	boolean	recipe/passwordless/types.ts:295
navigate	Navigate \| undefined	recipe/passwordless/types.ts:311
onContactInfoSubmit	(contactInfo) => Promise<FormBaseAPIResponse<unknown>>	recipe/passwordless/types.ts:297
onContinueWithPasswordlessClick	(contactInfo) => Promise<void>	recipe/passwordless/types.ts:299
onError	(error) => void	recipe/passwordless/types.ts:305
onFetchError	(error) => void	recipe/passwordless/types.ts:306
onPasswordSubmit	(formFields) => Promise<FormBaseAPIResponse<unknown>>	recipe/passwordless/types.ts:298
onSuccess	(result) => void	recipe/passwordless/types.ts:300
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:308
setIsPhoneNumber	(isPhone) => void	recipe/passwordless/types.ts:296
showContinueWithPasswordlessLink	boolean	recipe/passwordless/types.ts:293
showPasswordField	boolean	recipe/passwordless/types.ts:292
validatePhoneNumber	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:310

SignInUpFeatureConfigInput

type SignInUpFeatureConfigInput = object;

Defined in: recipe/passwordless/types.ts:132

Properties

Property	Type	Defined in
emailOrPhoneFormStyle?	string	recipe/passwordless/types.ts:135
linkSentScreenStyle?	string	recipe/passwordless/types.ts:137
resendEmailOrSMSGapInSeconds?	number	recipe/passwordless/types.ts:133
userInputCodeFormStyle?	string	recipe/passwordless/types.ts:136

SignInUpPhoneFormProps

type SignInUpPhoneFormProps = object;

Defined in: recipe/passwordless/types.ts:250

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:251
config	NormalisedConfig	recipe/passwordless/types.ts:256
error	string \| undefined	recipe/passwordless/types.ts:254
onError	(error) => void	recipe/passwordless/types.ts:252
onFetchError	(error) => void	recipe/passwordless/types.ts:253
onSuccess?	() => void	recipe/passwordless/types.ts:257
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:255
validatePhoneNumber	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:258

SignInUpProps

type SignInUpProps = object;

Defined in: recipe/passwordless/types.ts:202

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:210
config	NormalisedConfig	recipe/passwordless/types.ts:205
error	string \| undefined	recipe/passwordless/types.ts:209
factorIds	string[]	recipe/passwordless/types.ts:204
onError	(err) => void	recipe/passwordless/types.ts:208
onFetchError	(err) => void	recipe/passwordless/types.ts:207
onSuccess?	(result) => void	recipe/passwordless/types.ts:206
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:203
userContext	UserContext	recipe/passwordless/types.ts:211
validatePhoneNumber	(phoneNumber) => Promise<string \| undefined> \| string \| undefined	recipe/passwordless/types.ts:212

SignInUpUserInputCodeFormProps

type SignInUpUserInputCodeFormProps = object;

Defined in: recipe/passwordless/types.ts:272

Properties

Property	Type	Defined in
clearError	() => void	recipe/passwordless/types.ts:273
config	NormalisedConfig	recipe/passwordless/types.ts:278
error	string \| undefined	recipe/passwordless/types.ts:276
loginAttemptInfo	LoginAttemptInfo	recipe/passwordless/types.ts:279
onError	(error) => void	recipe/passwordless/types.ts:274
onFetchError	(error) => void	recipe/passwordless/types.ts:275
onSuccess?	(result) => void	recipe/passwordless/types.ts:280
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:277

UserInput

type UserInput = 
  | {
  contactMethod: "EMAIL";
  signInUpFeature?: SignInUpFeatureConfigInput;
  validateEmailAddress?: (email) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "PHONE";
  signInUpFeature?: SignInUpFeatureConfigInput & object;
  validatePhoneNumber?: (phoneNumber) => Promise<string | undefined> | string | undefined;
}
  | {
  contactMethod: "EMAIL_OR_PHONE";
  signInUpFeature?: SignInUpFeatureConfigInput & object;
  validateEmailAddress?: (email) => Promise<string | undefined> | string | undefined;
  validatePhoneNumber?: (phoneNumber) => Promise<string | undefined> | string | undefined;
} & object & AuthRecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/passwordless/types.ts:140

Type Declaration

Name	Type	Defined in
linkClickedScreenFeature?	PasswordlessFeatureBaseConfig	recipe/passwordless/types.ts:178
mfaFeature?	PasswordlessFeatureBaseConfig	recipe/passwordless/types.ts:179
override?	object	recipe/passwordless/types.ts:175
override.functions()?	(originalImplementation) => SuperTokensWrapper	recipe/passwordless/types.ts:176

UserInputCodeFormFooterProps

type UserInputCodeFormFooterProps = object;

Defined in: recipe/passwordless/types.ts:401

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/passwordless/types.ts:404
loginAttemptInfo	LoginAttemptInfo	recipe/passwordless/types.ts:402
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:403

UserInputCodeFormHeaderProps

type UserInputCodeFormHeaderProps = object;

Defined in: recipe/passwordless/types.ts:407

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/passwordless/types.ts:410
loginAttemptInfo	LoginAttemptInfo	recipe/passwordless/types.ts:408
recipeImplementation	RecipeImplementation	recipe/passwordless/types.ts:409