supertokens-auth-react/recipe/emailpassword/types

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

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`EmailPasswordResetPasswordEmail_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/emailpassword/types.ts
`EmailPasswordSignInForm_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/emailpassword/types.ts
`EmailPasswordSignUpForm_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/emailpassword/types.ts
`EmailPasswordSubmitNewPassword_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/emailpassword/types.ts

Config

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

Defined in: recipe/emailpassword/types.ts

EnterEmailProps

type EnterEmailProps = NonSignUpFormThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

Name	Type	Defined in
`clearError()`	() => `void`	recipe/emailpassword/types.ts
`config`	`NormalisedConfig`	recipe/emailpassword/types.ts
`error`	`string` \| `undefined`	recipe/emailpassword/types.ts
`onBackButtonClicked()`	() => `void`	recipe/emailpassword/types.ts
`onError()`	(`error`) => `void`	recipe/emailpassword/types.ts
`recipeImplementation`	`SuperTokensWrapper`	recipe/emailpassword/types.ts

EnterEmailStatus

type EnterEmailStatus = "READY" | "SENT";

Defined in: recipe/emailpassword/types.ts

FormBaseAPIResponse<T>

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

Defined in: recipe/emailpassword/types.ts

Type Parameters

Type Parameter
`T`

FormBaseProps<T>

type FormBaseProps<T> = object;

Defined in: recipe/emailpassword/types.ts

Type Parameters

Type Parameter
`T`

Properties

Property	Type	Defined in
`buttonLabel`	`string`	recipe/emailpassword/types.ts
`callAPI`	(`fields`, `setValue`) => `Promise`<`FormBaseAPIResponse`<`T`>>	recipe/emailpassword/types.ts
`clearError`	() => `void`	recipe/emailpassword/types.ts
`footer?`	`JSX.Element`	recipe/emailpassword/types.ts
`formDataSupertokens?`	`string`	recipe/emailpassword/types.ts
`formFields`	`FormFieldThemeProps`[]	recipe/emailpassword/types.ts
`onError`	(`error`) => `void`	recipe/emailpassword/types.ts
`onFetchError?`	(`err`) => `void`	recipe/emailpassword/types.ts
`onSuccess?`	(`result`) => `void`	recipe/emailpassword/types.ts
`showLabels`	`boolean`	recipe/emailpassword/types.ts
`validateOnBlur?`	`boolean`	recipe/emailpassword/types.ts

FormFieldError

type FormFieldError = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`error`	`string`	recipe/emailpassword/types.ts
`id`	`string`	recipe/emailpassword/types.ts

FormFieldSignInConfig

type FormFieldSignInConfig = FormFieldBaseConfig;

Defined in: recipe/emailpassword/types.ts

FormFieldThemeProps

type FormFieldThemeProps = NormalisedFormField & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

Name	Type	Defined in
`clearOnSubmit?`	`boolean`	recipe/emailpassword/types.ts
`inputComponent()?`	(`props`) => `JSX.Element`	recipe/emailpassword/types.ts
`labelComponent?`	`JSX.Element`	recipe/emailpassword/types.ts
`showIsRequired?`	`boolean`	recipe/emailpassword/types.ts

GetRedirectionURLContext

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

Defined in: recipe/emailpassword/types.ts

NormalisedConfig

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

Defined in: recipe/emailpassword/types.ts

Type Declaration

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

NormalisedEnterEmailForm

type NormalisedEnterEmailForm = FeatureBaseConfig & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

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

NormalisedResetPasswordUsingTokenFeatureConfig

type NormalisedResetPasswordUsingTokenFeatureConfig = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`disableDefaultUI`	`boolean`	recipe/emailpassword/types.ts
`enterEmailForm`	`NormalisedEnterEmailForm`	recipe/emailpassword/types.ts
`submitNewPasswordForm`	`NormalisedSubmitNewPasswordForm`	recipe/emailpassword/types.ts

NormalisedSignInAndUpFeatureConfig

type NormalisedSignInAndUpFeatureConfig = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`signInForm`	`NormalisedSignInFormFeatureConfig`	recipe/emailpassword/types.ts
`signUpForm`	`NormalisedSignUpFormFeatureConfig`	recipe/emailpassword/types.ts

NormalisedSignInFormFeatureConfig

type NormalisedSignInFormFeatureConfig = NormalisedBaseConfig & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

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

NormalisedSignUpFormFeatureConfig

type NormalisedSignUpFormFeatureConfig = NormalisedBaseConfig & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

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

NormalisedSubmitNewPasswordForm

type NormalisedSubmitNewPasswordForm = FeatureBaseConfig & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

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

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

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

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`action`	`PreAndPostAPIHookAction`	recipe/emailpassword/types.ts
`requestInit`	`RequestInit`	recipe/emailpassword/types.ts
`url`	`string`	recipe/emailpassword/types.ts
`userContext`	`UserContext`	recipe/emailpassword/types.ts

ResetPasswordUsingTokenThemeProps

type ResetPasswordUsingTokenThemeProps = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`config`	`NormalisedConfig`	recipe/emailpassword/types.ts
`enterEmailForm`	`EnterEmailProps`	recipe/emailpassword/types.ts
`submitNewPasswordForm`	`SubmitNewPasswordProps` \| `undefined`	recipe/emailpassword/types.ts
`userContext?`	`UserContext`	recipe/emailpassword/types.ts

ResetPasswordUsingTokenUserInput

type ResetPasswordUsingTokenUserInput = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`disableDefaultUI?`	`boolean`	recipe/emailpassword/types.ts
`enterEmailForm?`	`FeatureBaseConfig`	recipe/emailpassword/types.ts
`submitNewPasswordForm?`	`FeatureBaseConfig`	recipe/emailpassword/types.ts

SignInAndUpFeatureUserInput

type SignInAndUpFeatureUserInput = object;

Defined in: recipe/emailpassword/types.ts

Properties

Property	Type	Defined in
`signInForm?`	`SignInFormFeatureUserInput`	recipe/emailpassword/types.ts
`signUpForm?`	`SignUpFormFeatureUserInput`	recipe/emailpassword/types.ts

SignInFormFeatureUserInput

type SignInFormFeatureUserInput = FeatureBaseConfig & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

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

SignInThemeProps

type SignInThemeProps = NonSignUpFormThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

Name	Type	Defined in
`clearError()`	() => `void`	recipe/emailpassword/types.ts
`config`	`NormalisedConfig`	recipe/emailpassword/types.ts
`onError()`	(`error`) => `void`	recipe/emailpassword/types.ts
`onFetchError()`	(`error`) => `void`	recipe/emailpassword/types.ts
`onForgotPasswordClick()`	() => `void`	recipe/emailpassword/types.ts
`onSuccess()`	(`result`) => `void`	recipe/emailpassword/types.ts
`recipeImplementation`	`SuperTokensWrapper`	recipe/emailpassword/types.ts
`userContext`	`UserContext`	recipe/emailpassword/types.ts

SignUpFormFeatureUserInput

type SignUpFormFeatureUserInput = FeatureBaseConfig & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

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

SignUpThemeProps

type SignUpThemeProps = ThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

Name	Type	Defined in
`clearError()`	() => `void`	recipe/emailpassword/types.ts
`config`	`NormalisedConfig`	recipe/emailpassword/types.ts
`error`	`string` \| `undefined`	recipe/emailpassword/types.ts
`formFields`	`FormFieldThemeProps`[]	recipe/emailpassword/types.ts
`onError()`	(`error`) => `void`	recipe/emailpassword/types.ts
`onFetchError()`	(`error`) => `void`	recipe/emailpassword/types.ts
`onSuccess()`	(`result`) => `void`	recipe/emailpassword/types.ts
`recipeImplementation`	`SuperTokensWrapper`	recipe/emailpassword/types.ts
`signInClicked()?`	() => `void`	recipe/emailpassword/types.ts
`userContext`	`UserContext`	recipe/emailpassword/types.ts

SubmitNewPasswordProps

type SubmitNewPasswordProps = NonSignUpFormThemeBaseProps & object;

Defined in: recipe/emailpassword/types.ts

Type Declaration

Name	Type	Defined in
`clearError()`	() => `void`	recipe/emailpassword/types.ts
`config`	`NormalisedConfig`	recipe/emailpassword/types.ts
`error`	`string` \| `undefined`	recipe/emailpassword/types.ts
`onError()`	(`error`) => `void`	recipe/emailpassword/types.ts
`onSignInClicked()`	() => `void`	recipe/emailpassword/types.ts
`recipeImplementation`	`SuperTokensWrapper`	recipe/emailpassword/types.ts
`token`	`string`	recipe/emailpassword/types.ts

SubmitNewPasswordStatus

type SubmitNewPasswordStatus = "READY" | "SUCCESS";

Defined in: recipe/emailpassword/types.ts

UserInput

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

Defined in: recipe/emailpassword/types.ts

Type Declaration

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