EmailPassword Types

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/emailpassword/types.ts:43

Properties

Property	Type	Defined in
EmailPasswordResetPasswordEmail_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/emailpassword/types.ts:46
EmailPasswordSignInForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/emailpassword/types.ts:44
EmailPasswordSignUpForm_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/emailpassword/types.ts:45
EmailPasswordSubmitNewPassword_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/emailpassword/types.ts:47

Config

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

Defined in: recipe/emailpassword/types.ts:61

EnterEmailProps

type EnterEmailProps = NonSignUpFormThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts:308

Type Declaration

Name	Type	Defined in
clearError()	() => void	recipe/emailpassword/types.ts:311
config	NormalisedConfig	recipe/emailpassword/types.ts:313
error	string | undefined	recipe/emailpassword/types.ts:310
onBackButtonClicked()	() => void	recipe/emailpassword/types.ts:314
onError()	(error) => void	recipe/emailpassword/types.ts:312
recipeImplementation	SuperTokensWrapper	recipe/emailpassword/types.ts:309

EnterEmailStatus

type EnterEmailStatus = "READY" | "SENT";

Defined in: recipe/emailpassword/types.ts:327

FormBaseAPIResponse<T>

type FormBaseAPIResponse<T> = 
  | object & T
  | {
  formFields: FormFieldError[];
  status: "FIELD_ERROR";
};

Defined in: recipe/emailpassword/types.ts:351

Type Parameters

Type Parameter
T

FormBaseProps<T>

type FormBaseProps<T> = object;

Defined in: recipe/emailpassword/types.ts:331

Type Parameters

Type Parameter
T

Properties

Property	Type	Defined in
buttonLabel	string	recipe/emailpassword/types.ts:339
callAPI	(fields, setValue) => Promise<FormBaseAPIResponse<T>>	recipe/emailpassword/types.ts:348
clearError	() => void	recipe/emailpassword/types.ts:343
footer?	JSX.Element	recipe/emailpassword/types.ts:333
formDataSupertokens?	string	recipe/emailpassword/types.ts:332
formFields	FormFieldThemeProps[]	recipe/emailpassword/types.ts:335
onError	(error) => void	recipe/emailpassword/types.ts:344
onFetchError?	(err) => void	recipe/emailpassword/types.ts:345
onSuccess?	(result) => void	recipe/emailpassword/types.ts:346
showLabels	boolean	recipe/emailpassword/types.ts:337
validateOnBlur?	boolean	recipe/emailpassword/types.ts:341

FormFieldError

type FormFieldError = object;

Defined in: recipe/emailpassword/types.ts:232

Properties

Property	Type	Defined in
error	string	recipe/emailpassword/types.ts:241
id	string	recipe/emailpassword/types.ts:236

FormFieldSignInConfig

type FormFieldSignInConfig = FormFieldBaseConfig;

Defined in: recipe/emailpassword/types.ts:133

FormFieldThemeProps

type FormFieldThemeProps = NormalisedFormField & object;

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

Type Declaration

Name	Type	Defined in
clearOnSubmit?	boolean	recipe/emailpassword/types.ts:224
inputComponent()?	(props) => JSX.Element	recipe/emailpassword/types.ts:229
labelComponent?	JSX.Element	recipe/emailpassword/types.ts:214
showIsRequired?	boolean	recipe/emailpassword/types.ts:219

GetRedirectionURLContext

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

Defined in: recipe/emailpassword/types.ts:269

NormalisedConfig

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

Defined in: recipe/emailpassword/types.ts:64

Type Declaration

Name	Type	Defined in
override	object	recipe/emailpassword/types.ts:67
override.functions()	(originalImplementation, builder) => SuperTokensWrapper	recipe/emailpassword/types.ts:68
resetPasswordUsingTokenFeature	NormalisedResetPasswordUsingTokenFeatureConfig	recipe/emailpassword/types.ts:66
signInAndUpFeature	NormalisedSignInAndUpFeatureConfig	recipe/emailpassword/types.ts:65

NormalisedEnterEmailForm

type NormalisedEnterEmailForm = FeatureBaseConfig & object;

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

Type Declaration

Name	Type	Defined in
formFields	NormalisedFormField[]	recipe/emailpassword/types.ts:174

NormalisedResetPasswordUsingTokenFeatureConfig

type NormalisedResetPasswordUsingTokenFeatureConfig = object;

Defined in: recipe/emailpassword/types.ts:152

Properties

Property	Type	Defined in
disableDefaultUI	boolean	recipe/emailpassword/types.ts:156
enterEmailForm	NormalisedEnterEmailForm	recipe/emailpassword/types.ts:166
submitNewPasswordForm	NormalisedSubmitNewPasswordForm	recipe/emailpassword/types.ts:161

NormalisedSignInAndUpFeatureConfig

type NormalisedSignInAndUpFeatureConfig = object;

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

Properties

Property	Type	Defined in
signInForm	NormalisedSignInFormFeatureConfig	recipe/emailpassword/types.ts:98
signUpForm	NormalisedSignUpFormFeatureConfig	recipe/emailpassword/types.ts:93

NormalisedSignInFormFeatureConfig

type NormalisedSignInFormFeatureConfig = NormalisedBaseConfig & object;

Defined in: recipe/emailpassword/types.ts:126

Type Declaration

Name	Type	Defined in
formFields	NormalisedFormField[]	recipe/emailpassword/types.ts:130

NormalisedSignUpFormFeatureConfig

type NormalisedSignUpFormFeatureConfig = NormalisedBaseConfig & object;

Defined in: recipe/emailpassword/types.ts:110

Type Declaration

Name	Type	Defined in
formFields	NormalisedFormField & object[]	recipe/emailpassword/types.ts:114

NormalisedSubmitNewPasswordForm

type NormalisedSubmitNewPasswordForm = FeatureBaseConfig & object;

Defined in: recipe/emailpassword/types.ts:169

Type Declaration

Name	Type	Defined in
formFields	NormalisedFormField[]	recipe/emailpassword/types.ts:170

OnHandleEventContext

type OnHandleEventContext = 
  | AuthRecipeModuleOnHandleEventContext
  | {
  action: "RESET_PASSWORD_EMAIL_SENT";
  email: string;
  userContext: UserContext;
}
  | {
  action: "PASSWORD_RESET_SUCCESSFUL";
  userContext: UserContext;
}
  | {
  action: "SUCCESS";
  createdNewSession: boolean;
  isNewRecipeUser: boolean;
  user: SuperTokensWrapper;
  userContext: UserContext;
};

Defined in: recipe/emailpassword/types.ts:276

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = 
  | "EMAIL_PASSWORD_SIGN_UP"
  | "EMAIL_PASSWORD_SIGN_IN"
  | "SEND_RESET_PASSWORD_EMAIL"
  | "SUBMIT_NEW_PASSWORD"
  | "EMAIL_EXISTS";

Defined in: recipe/emailpassword/types.ts:244

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/emailpassword/types.ts:251

Properties

Property	Type	Defined in
action	PreAndPostAPIHookAction	recipe/emailpassword/types.ts:255
requestInit	RequestInit	recipe/emailpassword/types.ts:260
url	string	recipe/emailpassword/types.ts:265
userContext	UserContext	recipe/emailpassword/types.ts:266

ResetPasswordUsingTokenThemeProps

type ResetPasswordUsingTokenThemeProps = object;

Defined in: recipe/emailpassword/types.ts:301

Properties

Property	Type	Defined in
config	NormalisedConfig	recipe/emailpassword/types.ts:304
enterEmailForm	EnterEmailProps	recipe/emailpassword/types.ts:302
submitNewPasswordForm	SubmitNewPasswordProps | undefined	recipe/emailpassword/types.ts:303
userContext?	UserContext	recipe/emailpassword/types.ts:305

ResetPasswordUsingTokenUserInput

type ResetPasswordUsingTokenUserInput = object;

Defined in: recipe/emailpassword/types.ts:135

Properties

Property	Type	Defined in
disableDefaultUI?	boolean	recipe/emailpassword/types.ts:139
enterEmailForm?	FeatureBaseConfig	recipe/emailpassword/types.ts:149
submitNewPasswordForm?	FeatureBaseConfig	recipe/emailpassword/types.ts:144

SignInAndUpFeatureUserInput

type SignInAndUpFeatureUserInput = object;

Defined in: recipe/emailpassword/types.ts:75

Properties

Property	Type	Defined in
signInForm?	SignInFormFeatureUserInput	recipe/emailpassword/types.ts:86
signUpForm?	SignUpFormFeatureUserInput	recipe/emailpassword/types.ts:80

SignInFormFeatureUserInput

type SignInFormFeatureUserInput = FeatureBaseConfig & object;

Defined in: recipe/emailpassword/types.ts:119

Type Declaration

Name	Type	Defined in
formFields?	FormFieldSignInConfig[]	recipe/emailpassword/types.ts:123

SignInThemeProps

type SignInThemeProps = NonSignUpFormThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts:186

Type Declaration

Name	Type	Defined in
clearError()	() => void	recipe/emailpassword/types.ts:188
config	NormalisedConfig	recipe/emailpassword/types.ts:191
onError()	(error) => void	recipe/emailpassword/types.ts:190
onFetchError()	(error) => void	recipe/emailpassword/types.ts:189
onForgotPasswordClick()	() => void	recipe/emailpassword/types.ts:192
onSuccess()	(result) => void	recipe/emailpassword/types.ts:193
recipeImplementation	SuperTokensWrapper	recipe/emailpassword/types.ts:187
userContext	UserContext	recipe/emailpassword/types.ts:194

SignUpFormFeatureUserInput

type SignUpFormFeatureUserInput = FeatureBaseConfig & object;

Defined in: recipe/emailpassword/types.ts:101

Type Declaration

Name	Type	Defined in
formFields?	FormField & object[]	recipe/emailpassword/types.ts:105

SignUpThemeProps

type SignUpThemeProps = ThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts:197

Type Declaration

Name	Type	Defined in
clearError()	() => void	recipe/emailpassword/types.ts:199
config	NormalisedConfig	recipe/emailpassword/types.ts:202
error	string | undefined	recipe/emailpassword/types.ts:206
formFields	FormFieldThemeProps[]	recipe/emailpassword/types.ts:205
onError()	(error) => void	recipe/emailpassword/types.ts:201
onFetchError()	(error) => void	recipe/emailpassword/types.ts:200
onSuccess()	(result) => void	recipe/emailpassword/types.ts:204
recipeImplementation	SuperTokensWrapper	recipe/emailpassword/types.ts:198
signInClicked()?	() => void	recipe/emailpassword/types.ts:203
userContext	UserContext	recipe/emailpassword/types.ts:207

SubmitNewPasswordProps

type SubmitNewPasswordProps = NonSignUpFormThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts:317

Type Declaration

Name	Type	Defined in
clearError()	() => void	recipe/emailpassword/types.ts:320
config	NormalisedConfig	recipe/emailpassword/types.ts:322
error	string | undefined	recipe/emailpassword/types.ts:319
onError()	(error) => void	recipe/emailpassword/types.ts:321
onSignInClicked()	() => void	recipe/emailpassword/types.ts:323
recipeImplementation	SuperTokensWrapper	recipe/emailpassword/types.ts:318
token	string	recipe/emailpassword/types.ts:324

SubmitNewPasswordStatus

type SubmitNewPasswordStatus = "READY" | "SUCCESS";

Defined in: recipe/emailpassword/types.ts:329

UserInput

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

Defined in: recipe/emailpassword/types.ts:50

Type Declaration

Name	Type	Defined in
override?	object	recipe/emailpassword/types.ts:53
override.functions()?	(originalImplementation, builder) => SuperTokensWrapper	recipe/emailpassword/types.ts:54
resetPasswordUsingTokenFeature?	ResetPasswordUsingTokenUserInput	recipe/emailpassword/types.ts:52
signInAndUpFeature?	SignInAndUpFeatureUserInput	recipe/emailpassword/types.ts:51