SuperTokens React Types

Type Aliases

AllRecipeComponentOverrides

type AllRecipeComponentOverrides = object;

Defined in: types.ts:509

Properties

Property	Type	Defined in
authRecipe	AuthRecipeComponentOverrideMap	types.ts:519
emailpassword	ComponentOverrideMap	types.ts:510
emailverification	ComponentOverrideMap	types.ts:511
multifactorauth	ComponentOverrideMap	types.ts:512
multitenancy	ComponentOverrideMap	types.ts:513
oauth2provider	ComponentOverrideMap	types.ts:514
passwordless	ComponentOverrideMap	types.ts:515
session	ComponentOverrideMap	types.ts:516
thirdparty	ComponentOverrideMap	types.ts:517
totp	ComponentOverrideMap	types.ts:518
webauthn	ComponentOverrideMap	types.ts:520

AllRecipeConfigs

type AllRecipeConfigs = object;

Defined in: types.ts:496

Properties

Property	Type	Defined in
emailpassword	Config	types.ts:497
emailverification	Config	types.ts:498
multifactorauth	Config	types.ts:499
multitenancy	UserInput	types.ts:500
oauth2provider	UserInput	types.ts:501
passwordless	Config	types.ts:502
session	InputType	types.ts:503
thirdparty	Config	types.ts:504
totp	Config	types.ts:505
webauthn	Config	types.ts:506

APIFormField

type APIFormField = object;

Defined in: types.ts:340

Properties

Property	Type	Defined in
id	string	types.ts:344
value	string	types.ts:349

AppInfoUserInput

type AppInfoUserInput = object;

Defined in: types.ts:202

Properties

Property	Type	Description	Defined in
apiBasePath?	string	-	types.ts:222
apiDomain	string	-	types.ts:211
apiGatewayPath?	string	An API gateway may be used which prepends a path to the API route. That path should be specified here.	types.ts:234
appName	string	-	types.ts:206
websiteBasePath?	string	-	types.ts:228
websiteDomain	string	-	types.ts:216

AuthComponent<T>

type AuthComponent<T> = 
  | PartialAuthComponent
| FullPageAuthComponent<T>;

Defined in: types.ts:491

Type Parameters

Type Parameter	Default type
T	any

AuthComponentProps

type AuthComponentProps = object;

Defined in: types.ts:457

Properties

Property	Type	Defined in
children?	React.ReactNode	types.ts:469
clearError	() => void	types.ts:467
error	string | undefined	types.ts:465
navigate	Navigate | undefined	types.ts:463
onAuthSuccess	(successContext) => Promise<void>	types.ts:462
onError	(err) => void	types.ts:466
onSignInUpSwitcherClick	() => void	types.ts:460
rebuildAuthPage	() => void	types.ts:461
resetFactorList	() => void	types.ts:459
setFactorList	(factorIds) => void	types.ts:458
showBackButton	boolean	types.ts:468
userContext	UserContext	types.ts:464

Awaited<T>

type Awaited<T> = T extends null | undefined ? T : T extends object & object ? F extends (value, ...args) => any ? V : never : T;

Defined in: types.ts:432

Type Parameters

Type Parameter
T

BaseFeatureComponentMap

type BaseFeatureComponentMap = Record<string, ComponentWithRecipeAndMatchingMethod[]>;

Defined in: types.ts:299

ComponentWithRecipeAndMatchingMethod

type ComponentWithRecipeAndMatchingMethod = object;

Defined in: types.ts:280

Properties

Property	Type	Description	Defined in
component	ReactComponentClass	-	types.ts:284
matches	() => boolean	-	types.ts:289
recipeID	string	Recipe ID this component belongs	types.ts:294

CreateRecipeFunction()<T, S, R, N>

type CreateRecipeFunction<T, S, R, N> = (appInfo, enableDebugLogs) => BaseRecipeModule<T, S, R, N>;

Defined in: types.ts:197

Type Parameters

Type Parameter
T
S
R
N extends NormalisedRecipeModuleConfig<T, S, R>

Parameters

Parameter	Type
appInfo	NormalisedAppInfo
enableDebugLogs	boolean

Returns

BaseRecipeModule<T, S, R, N>

FeatureBaseConfig

type FeatureBaseConfig = object;

Defined in: types.ts:407

Properties

Property	Type	Defined in
style?	string	types.ts:411

FeatureBaseProps<T>

type FeatureBaseProps<T> = PropsWithChildren<object & T>;

Defined in: types.ts:425

Type Parameters

Type Parameter	Default type
T	Record<string, unknown>

FormField

type FormField = FormFieldBaseConfig & object;

Defined in: types.ts:328

Type Declaration

Name	Type	Defined in
optional?	boolean	types.ts:337
validate()?	(value) => Promise<string | undefined>	types.ts:332

FormFieldBaseConfig

type FormFieldBaseConfig = object;

Defined in: types.ts:301

Properties

Property	Type	Defined in
getDefaultValue?	() => string	types.ts:320
id	string	types.ts:305
label	string	types.ts:310
nonOptionalErrorMsg?	string	types.ts:325
placeholder?	string	types.ts:315

FullPageAuthComponent<PreloadInfoType>

type FullPageAuthComponent<PreloadInfoType> = object;

Defined in: types.ts:474

Type Parameters

Type Parameter	Default type
PreloadInfoType	any

Properties

Property	Type	Defined in
component	React.FC<FullPageAuthComponentProps<PreloadInfoType>>	types.ts:481
preloadInfoAndRunChecks	(firstFactors, userContext, isSignUp) => Promise< | { preloadInfo: PreloadInfoType; shouldDisplay: true; } | { shouldDisplay: false; }>	types.ts:476
type	"FULL_PAGE"	types.ts:475

FullPageAuthComponentProps<PreloadInfoType>

type FullPageAuthComponentProps<PreloadInfoType> = AuthComponentProps & object;

Defined in: types.ts:472

Type Declaration

Name	Type	Defined in
preloadInfo	PreloadInfoType	types.ts:472

Type Parameters

Type Parameter
PreloadInfoType

GetRedirectionURLContext

type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | {
  action: "TO_AUTH";
  showSignIn?: boolean;
}
| SuccessRedirectContextInApp>;

Defined in: types.ts:72

Navigate

type Navigate = 
  | {
  goBack: () => void;
  push: (path) => void;
}
  | NavigateFunction;

Defined in: types.ts:448

NonPublicConfigPropertiesType

type NonPublicConfigPropertiesType = typeof nonPublicConfigProperties[number];

Defined in: types.ts:566

NormalisedAppInfo

type NormalisedAppInfo = object;

Defined in: types.ts:248

Properties

Property	Type	Defined in
apiBasePath	SuperTokensWrapper	types.ts:268
apiDomain	SuperTokensWrapper	types.ts:257
appName	string	types.ts:252
websiteBasePath	SuperTokensWrapper	types.ts:274
websiteDomain	SuperTokensWrapper	types.ts:262

NormalisedBaseConfig

type NormalisedBaseConfig = object;

Defined in: types.ts:414

Properties

Property	Type	Defined in
style	string	types.ts:418

NormalisedConfigWithAppInfoAndRecipeID<NormalisedConfig>

type NormalisedConfigWithAppInfoAndRecipeID<NormalisedConfig> = NormalisedConfig & object;

Defined in: types.ts:243

Type Declaration

Name	Type	Defined in
appInfo	NormalisedAppInfo	types.ts:244
recipeId	string	types.ts:245

Type Parameters

Type Parameter
NormalisedConfig

NormalisedFormField

type NormalisedFormField = object;

Defined in: types.ts:352

Properties

Property	Type	Defined in
autoComplete?	string	types.ts:386
autofocus?	boolean	types.ts:391
getDefaultValue?	() => string	types.ts:396
hidden?	boolean	types.ts:398
id	string	types.ts:356
label	string	types.ts:361
nonOptionalErrorMsg?	string	types.ts:381
optional	boolean	types.ts:376
placeholder	string	types.ts:366
validate	(value) => Promise<string | undefined> | string | undefined	types.ts:371

NormalisedGetRedirectionURLContext<RecipeContext>

type NormalisedGetRedirectionURLContext<RecipeContext> = RecipeContext & object;

Defined in: types.ts:492

Type Declaration

Name	Type	Defined in
tenantIdFromQueryParams	string | undefined	types.ts:493

Type Parameters

Type Parameter
RecipeContext

PartialAuthComponent

type PartialAuthComponent = object;

Defined in: types.ts:484

Properties

Property	Type	Defined in
component	React.FC<PartialAuthComponentProps>	types.ts:488
displayOrder	number	types.ts:487
factorIds	string[]	types.ts:486
type	"SIGN_IN_UP" | "SIGN_IN" | "SIGN_UP"	types.ts:485

PartialAuthComponentProps

type PartialAuthComponentProps = AuthComponentProps;

Defined in: types.ts:471

PluginRouteHandler

type PluginRouteHandler = object;

Defined in: types.ts:529

Properties

Property	Type	Defined in
handler	() => JSX.Element	types.ts:531
path	string	types.ts:530

ReactComponentClass<P>

type ReactComponentClass<P> = ComponentClass<P, any> | (props) => JSX.Element;

Defined in: types.ts:401

Type Parameters

Type Parameter	Default type
P	any

RecipeFeatureComponentMap

type RecipeFeatureComponentMap = Record<string, ComponentWithRecipeAndMatchingMethod>;

Defined in: types.ts:297

RecipeInitResult<T, Action, R, P>

type RecipeInitResult<T, Action, R, P> = object;

Defined in: types.ts:237

Type Parameters

Type Parameter
T
Action
R
P extends NormalisedRecipeModuleConfig<T, Action, R>

Properties

Property	Type	Defined in
authReact	CreateRecipeFunction<T, Action, R, P>	types.ts:239
recipeID	string	types.ts:238
webJS	SuperTokensWrapper<Action>	types.ts:240

RecipePluginOverride<T>

type RecipePluginOverride<T> = object;

Defined in: types.ts:523

Type Parameters

Type Parameter
T extends keyof AllRecipeConfigs

Properties

Property	Type	Defined in
components?	AllRecipeComponentOverrides[T]	types.ts:525
config?	(config) => AllRecipeConfigs[T]	types.ts:526
functions?	NonNullable<AllRecipeConfigs[T]["override"]>["functions"]	types.ts:524

SessionClaimValidator

type SessionClaimValidator = SuperTokensWrapper & object;

Defined in: types.ts:90

Type Declaration

Name	Type	Defined in
onFailureRedirection?	ValidationFailureCallback	types.ts:92
showAccessDeniedOnFailure?	boolean	types.ts:91

SuccessRedirectContext

type SuccessRedirectContext = 
  | SuccessRedirectContextInApp
  | SuccessRedirectContextOAuth2;

Defined in: types.ts:70

SuccessRedirectContextInApp

type SuccessRedirectContextInApp = SuccessRedirectContextCommon & object;

Defined in: types.ts:64

Type Declaration

Name	Type	Defined in
action	"SUCCESS"	types.ts:64
redirectToPath?	string	types.ts:64

SuccessRedirectContextOAuth2

type SuccessRedirectContextOAuth2 = SuccessRedirectContextCommon & object;

Defined in: types.ts:65

Type Declaration

Name	Type	Defined in
action	"SUCCESS_OAUTH2"	types.ts:66
frontendRedirectTo	string	types.ts:67

SuperTokensConfig

type SuperTokensConfig = object;

Defined in: types.ts:99

Properties

Property	Type	Description	Defined in
appInfo	AppInfoUserInput	-	types.ts:103
clientType?	string	Identifier for the client, such as web, ios, etc. to be used with thirdparty, multitenancy recipes.	types.ts:108
cookieHandler?	SuperTokensWrapper	-	types.ts:119
dateProvider?	SuperTokensWrapper	-	types.ts:123
defaultToSignUp?	boolean	-	types.ts:169
disableAuthRoute?	boolean	-	types.ts:164
enableDebugLogs?	boolean	-	types.ts:156
experimental?	object	Our experimental features are not yet stable and are subject to change. In practical terms, this means that their interface is subject to change without a major version update. They are also not tested as much as our "normal" features. If you want to use these features, or if you have any feedback please let us know at: https://supertokens.com/discord	types.ts:190
experimental.plugins?	SuperTokensPlugin[]	-	types.ts:191
getRedirectionURL?	(context, userContext) => Promise<string | undefined | null>	-	types.ts:157
languageTranslations?	object	-	types.ts:127
languageTranslations.currentLanguageCookieScope?	string	-	types.ts:137
languageTranslations.defaultLanguage?	string	-	types.ts:131
languageTranslations.translationFunc?	TranslationFunc	-	types.ts:154
languageTranslations.translations?	TranslationStore	-	types.ts:149
privacyPolicyLink?	string	-	types.ts:174
recipeList	object[]	-	types.ts:113
style?	string	-	types.ts:162
termsOfServiceLink?	string	-	types.ts:179
usesDynamicLoginMethods?	boolean	-	types.ts:125
useShadowDom?	boolean	-	types.ts:163
windowHandler?	SuperTokensWrapper	-	types.ts:121

SuperTokensConfigWithNormalisedAppInfo

type SuperTokensConfigWithNormalisedAppInfo = Omit<SuperTokensConfig, "appInfo"> & object;

Defined in: types.ts:568

Type Declaration

Name	Type	Defined in
appInfo	NormalisedAppInfo	types.ts:569

SuperTokensPlugin

type SuperTokensPlugin = object;

Defined in: types.ts:535

Properties

Property	Type	Defined in
compatibleAuthReactSDKVersions?	string | string[]	types.ts:538
compatibleWebJSSDKVersions?	string | string[]	types.ts:539
config?	(config) => | Omit<SuperTokensPublicConfig, "appInfo"> | undefined	types.ts:560
dependencies?	(config, pluginsAbove, sdkVersion) => | { pluginsToAdd?: SuperTokensPlugin[]; status: "OK"; } | { message: string; status: "ERROR"; }	types.ts:541
exports?	Record<string, any>	types.ts:561
generalAuthRecipeComponentOverrides?	AuthRecipeComponentOverrideMap	types.ts:551
id	string	types.ts:536
init?	(config, allPlugins, sdkVersion) => void	types.ts:540
overrideMap?	{ [recipeId in keyof AllRecipeConfigs]?: RecipePluginOverride<recipeId> & { recipeInitRequired?: boolean | ((sdkVersion: string) => boolean) } }	types.ts:546
routeHandlers?	| (config, allPlugins, sdkVersion) => | { routeHandlers: PluginRouteHandler[]; status: "OK"; } | { message: string; status: "ERROR"; } | PluginRouteHandler[]	types.ts:552
version?	string	types.ts:537

SuperTokensPublicConfig

type SuperTokensPublicConfig = Omit<Omit<SuperTokensConfig, NonPublicConfigPropertiesType>, "appInfo"> & object;

Defined in: types.ts:576

Type Declaration

Name	Type	Defined in
appInfo	NormalisedAppInfo	types.ts:577

SuperTokensPublicPlugin

type SuperTokensPublicPlugin = Pick<SuperTokensPlugin, 
  | "id"
  | "version"
  | "exports"
  | "compatibleAuthReactSDKVersions"
  | "compatibleWebJSSDKVersions"> & object;

Defined in: types.ts:571

Type Declaration

Name	Type	Defined in
initialized	boolean	types.ts:574

ThemeBaseProps

type ThemeBaseProps = object;

Defined in: types.ts:421

Properties

Property	Type	Defined in
styleFromInit?	string	types.ts:422

UserContext

type UserContext = Record<string, any>;

Defined in: types.ts:455

ValidationFailureCallback

type ValidationFailureCallback = 
  | ({
          userContext,
          reason,
      }) => Promise<string | undefined> | string | undefined
  | undefined;

Defined in: types.ts:80

WebJSRecipeInterface<T>

type WebJSRecipeInterface<T> = Omit<T, "default" | "init" | "signOut">;

Defined in: types.ts:195

Type Parameters

Type Parameter
T

Variables

nonPublicConfigProperties

const nonPublicConfigProperties: readonly ["experimental"];

Defined in: types.ts:564