ThirdParty Types

Type Aliases

InputType

type InputType = AuthRecipeInputType<PreAndPostAPIHookAction> & UserInput;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:45

NormalisedInputType

type NormalisedInputType = AuthRecipeNormalisedInputType<PreAndPostAPIHookAction> & object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:47

Type Declaration

Name	Type	Defined in
override	object	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:48
override.functions()	(originalImplementation, builder) => RecipeInterface	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:49

PostAPIHookContext

type PostAPIHookContext = RecipePostAPIHookContext<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:31

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = "GET_AUTHORISATION_URL" | "THIRD_PARTY_SIGN_IN_UP";

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:28

PreAPIHookContext

type PreAPIHookContext = RecipePreAPIHookContext<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:30

RecipeInterface

type RecipeInterface = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:66

Properties

Property	Type	Description	Defined in
generateStateToSendToOAuthProvider	(input?) => string	Generate a new state that will be sent to the third party provider	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:193
getAuthErrorFromURL	(input) => string | undefined	Returns the error from the current URL	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:217
getAuthorisationURLFromBackend	(input) => Promise<{ fetchResponse: Response; pkceCodeVerifier?: string; status: "OK"; urlWithQueryParams: string; }>	Get the URL to be used by the third party provider for redirecting after the auth flow. Also returns PKCE Code Verifier if using PKCE. Throws STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:138
getAuthorisationURLWithQueryParamsAndSetState	(input) => Promise<string>	Get the URL that should be opened for third party authentication Throws STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:111
getAuthStateFromURL	(input) => string	Returns the auth state from the current URL	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:226
getStateAndOtherInfoFromStorage	<CustomStateProperties>(input) => StateObject & CustomStateProperties | undefined	Get the current login state from storage, this is also used when calling signInUp	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:74
setStateAndOtherInfoToStorage	<CustomStateProperties>(input) => Promise<void>	Set the login state to storage	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:85
signInAndUp	(input) => Promise< | { createdNewRecipeUser: boolean; fetchResponse: Response; status: "OK"; tenantId?: string; user: User; } | { fetchResponse: Response; status: "NO_EMAIL_GIVEN_BY_PROVIDER"; } | { fetchResponse: Response; reason: string; status: "SIGN_IN_UP_NOT_ALLOWED"; }>	Sign up/Sign in the user, this method uses the login attempt information from storage Throws STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:165
verifyAndGetStateOrThrowError	<CustomStateProperties>(input) => Promise<StateObject & CustomStateProperties>	Verify that the state recieved from the third party provider matches the one in storage	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:204

StateObject

type StateObject = object;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:56

Properties

Property	Type	Defined in
expiresAt	number	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:60
pkceCodeVerifier?	string	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:63
redirectURIOnProviderDashboard	string	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:61
shouldTryLinkingWithSessionUser?	boolean	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:62
stateForAuthProvider	string	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:57
tenantId?	string	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:59
thirdPartyId	string	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:58

UserInput

type UserInput = object & RecipeModuleUserInput<PreAndPostAPIHookAction>;

Defined in: tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:33

Type Declaration

Name	Type	Description	Defined in
override?	object	Refer to the documentation	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:37
override.functions()?	(originalImplementation, builder) => RecipeInterface	-	tmp/supertokens-web-js/lib/ts/recipe/thirdparty/types.ts:38