supertokens-auth-react/recipe/oauth2provider/types

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

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/oauth2provider/types.ts

Properties

Property	Type	Defined in
`OAuth2LogoutScreenInner_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/oauth2provider/types.ts

ContinueOAuth2AfterRefreshRedirectContext

type ContinueOAuth2AfterRefreshRedirectContext = object;

Defined in: recipe/oauth2provider/types.ts

Properties

Property	Type	Defined in
`action`	`"CONTINUE_OAUTH2_AFTER_REFRESH"`	recipe/oauth2provider/types.ts
`frontendRedirectTo`	`string`	recipe/oauth2provider/types.ts
`recipeId`	`"oauth2provider"`	recipe/oauth2provider/types.ts

GetRedirectionURLContext

type GetRedirectionURLContext = NormalisedGetRedirectionURLContext<
  | SuccessRedirectContextOAuth2
  | ContinueOAuth2AfterRefreshRedirectContext
| PostOAuth2LogoutRedirectContext>;

Defined in: recipe/oauth2provider/types.ts

NormalisedConfig

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

Defined in: recipe/oauth2provider/types.ts

Type Declaration

Name	Type	Defined in
`disableDefaultUI`	`boolean`	recipe/oauth2provider/types.ts
`oauth2LogoutScreen`	`OAuth2LogoutScreenConfig`	recipe/oauth2provider/types.ts
`override`	`object`	recipe/oauth2provider/types.ts
`override.functions()`	(`originalImplementation`, `builder`) => `SuperTokensWrapper`	recipe/oauth2provider/types.ts
`tryRefreshPage`	`OAuth2TryRefreshPageConfig`	recipe/oauth2provider/types.ts

OAuth2LogoutScreenConfig

type OAuth2LogoutScreenConfig = NormalisedBaseConfig & object;

Defined in: recipe/oauth2provider/types.ts

Type Declaration

Name	Type	Defined in
`disableDefaultUI`	`boolean`	recipe/oauth2provider/types.ts

OAuth2LogoutScreenThemeProps

type OAuth2LogoutScreenThemeProps = object;

Defined in: recipe/oauth2provider/types.ts

Properties

Property	Type	Defined in
`config`	`NormalisedConfig`	recipe/oauth2provider/types.ts
`isLoggingOut`	`boolean`	recipe/oauth2provider/types.ts
`onLogoutClicked`	() => `void`	recipe/oauth2provider/types.ts
`showSpinner`	`boolean`	recipe/oauth2provider/types.ts

OAuth2TryRefreshPageConfig

type OAuth2TryRefreshPageConfig = object;

Defined in: recipe/oauth2provider/types.ts

Properties

Property	Type	Defined in
`disableDefaultUI`	`boolean`	recipe/oauth2provider/types.ts

OnHandleEventContext

type OnHandleEventContext = 
  | {
  action: "LOADED_LOGIN_CHALLENGE";
  loginChallenge: string;
  loginInfo: SuperTokensWrapper;
  userContext: UserContext;
}
  | {
  action: "OAUTH2_LOGOUT_SUCCESS";
  frontendRedirectTo: string;
  userContext: UserContext;
};

Defined in: recipe/oauth2provider/types.ts

PostOAuth2LogoutRedirectContext

type PostOAuth2LogoutRedirectContext = object;

Defined in: recipe/oauth2provider/types.ts

Properties

Property	Type	Defined in
`action`	`"POST_OAUTH2_LOGOUT_REDIRECT"`	recipe/oauth2provider/types.ts
`frontendRedirectTo`	`string`	recipe/oauth2provider/types.ts
`recipeId`	`"oauth2provider"`	recipe/oauth2provider/types.ts

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = 
  | "GET_LOGIN_CHALLENGE_INFO"
  | "GET_REDIRECT_URL_TO_CONTINUE_OAUTH_FLOW"
  | "LOG_OUT";

Defined in: recipe/oauth2provider/types.ts

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/oauth2provider/types.ts

Properties

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

UserInput

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

Defined in: recipe/oauth2provider/types.ts

Type Declaration

Name	Type	Defined in
`disableDefaultUI?`	`boolean`	recipe/oauth2provider/types.ts
`oauth2LogoutScreen?`	`Partial`<`OAuth2LogoutScreenConfig`>	recipe/oauth2provider/types.ts
`override?`	`object`	recipe/oauth2provider/types.ts
`override.functions()?`	(`originalImplementation`, `builder`) => `SuperTokensWrapper`	recipe/oauth2provider/types.ts
`tryRefreshPage?`	`Partial`<`OAuth2TryRefreshPageConfig`>	recipe/oauth2provider/types.ts