recipe/session | supertokens-auth-react

Type Aliases

ClaimValidationError

ClaimValidationError: { reason?: any; validatorId: string }

Type declaration

Optional reason?: any
validatorId: string

ClaimValidationResult

ClaimValidationResult: { isValid: true } | { isValid: false; reason?: any }

InputType

InputType: WebJSInputType & { accessDeniedScreen?: SessionFeatureBaseConfig; style?: string; onHandleEvent?: any }

RecipeInterface

RecipeInterface: { addAxiosInterceptors: any; addFetchInterceptorsAndReturnModifiedFetch: any; addXMLHttpRequestInterceptor: any; doesSessionExist: any; getAccessTokenPayloadSecurely: any; getGlobalClaimValidators: any; getInvalidClaimsFromResponse: any; getUserId: any; shouldDoInterceptionBasedOnUrl: any; signOut: any; validateClaims: any }

Type declaration

addAxiosInterceptors:function
- addAxiosInterceptors(input: { axiosInstance: any; userContext: any }): void
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:95
  Parameters
  - input: { axiosInstance: any; userContext: any }
    - axiosInstance: any
    - userContext: any
  Returns void
addFetchInterceptorsAndReturnModifiedFetch:function
- addFetchInterceptorsAndReturnModifiedFetch(input: { originalFetch: any; userContext: any }): ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:88
  Parameters
  - input: { originalFetch: any; userContext: any }
    - originalFetch: any
    - userContext: any
  Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)
  - - (input: URL | RequestInfo, init?: RequestInit): Promise<Response>
    - Parameters
      - input: URL | RequestInfo
      - Optional init: RequestInit
      Returns Promise<Response>
addXMLHttpRequestInterceptor:function
- addXMLHttpRequestInterceptor(input: { userContext: any }): void
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:92
  Parameters
  - input: { userContext: any }
    - userContext: any
  Returns void
doesSessionExist:function
- doesSessionExist(input: { userContext: any }): Promise<boolean>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:105
  Parameters
  - input: { userContext: any }
    - userContext: any
  Returns Promise<boolean>
getAccessTokenPayloadSecurely:function
- getAccessTokenPayloadSecurely(input: { userContext: any }): Promise<any>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:102
  Parameters
  - input: { userContext: any }
    - userContext: any
  Returns Promise<any>
getGlobalClaimValidators:function
- getGlobalClaimValidators(input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any }): SessionClaimValidator[]
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:121
  Parameters
  - input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any }
    - claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]
    - userContext: any
  Returns SessionClaimValidator[]
getInvalidClaimsFromResponse:function
- getInvalidClaimsFromResponse(input: { response: { data: any } | Response; userContext: any }): Promise<ClaimValidationError[]>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:111
  Parameters
  - input: { response: { data: any } | Response; userContext: any }
    - response: { data: any } | Response
    - userContext: any
  Returns Promise<ClaimValidationError[]>
getUserId:function
- getUserId(input: { userContext: any }): Promise<string>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:99
  Parameters
  - input: { userContext: any }
    - userContext: any
  Returns Promise<string>
shouldDoInterceptionBasedOnUrl:function
- shouldDoInterceptionBasedOnUrl(toCheckUrl: string, apiDomain: string, sessionTokenBackendDomain: undefined | string): boolean
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:125
  Parameters
  - toCheckUrl: string
  - apiDomain: string
  - sessionTokenBackendDomain: undefined | string
  Returns boolean
signOut:function
- signOut(input: { userContext: any }): Promise<void>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:108
  Parameters
  - input: { userContext: any }
    - userContext: any
  Returns Promise<void>
validateClaims:function
- validateClaims(input: { claimValidators: SessionClaimValidator[]; userContext: any }): Promise<ClaimValidationError[]>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:117
  Parameters
  - input: { claimValidators: SessionClaimValidator[]; userContext: any }
    - claimValidators: SessionClaimValidator[]
    - userContext: any
  Returns Promise<ClaimValidationError[]>

SessionClaim

SessionClaim<ValueType>: { getLastFetchedTime: any; getValueFromPayload: any; refresh: any }

Type Parameters

ValueType

Type declaration

getLastFetchedTime:function
- getLastFetchedTime(payload: any, _userContext?: any): undefined | number
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:156
  Parameters
  - payload: any
  - Optional _userContext: any
  Returns undefined | number
getValueFromPayload:function
- getValueFromPayload(payload: any, _userContext?: any): undefined | ValueType
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:155
  Parameters
  - payload: any
  - Optional _userContext: any
  Returns undefined | ValueType
refresh:function
- refresh(userContext: any): Promise<void>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:154
  Parameters
  - userContext: any
  Returns Promise<void>

SessionClaimValidator

SessionClaimValidator: { id: string; refresh: any; shouldRefresh: any; validate: any }

Type declaration

Readonly id: string
refresh:function
- refresh(userContext: any): Promise<void>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:142
  Makes an API call that will refresh the claim in the token.
  
  Parameters
  - userContext: any
  Returns Promise<void>
shouldRefresh:function
- shouldRefresh(accessTokenPayload: any, userContext: any): boolean | Promise<boolean>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:147
  Decides if we need to refresh the claim value before checking the payload with validate. E.g.: if the information in the payload is expired, or is not sufficient for this validator.
  
  Parameters
  - accessTokenPayload: any
  - userContext: any
  Returns boolean | Promise<boolean>
validate:function
- validate(accessTokenPayload: any, userContext: any): ClaimValidationResult | Promise<ClaimValidationResult>
- - Defined in node_modules/supertokens-website/lib/build/types.d.ts:151
  Decides if the claim is valid based on the accessTokenPayload object (and not checking DB or anything else)
  
  Parameters
  - accessTokenPayload: any
  - userContext: any
  Returns ClaimValidationResult | Promise<ClaimValidationResult>

SessionContextType

SessionContextType: LoadedSessionContext | { loading: true }

Variables

Const SessionAuth

SessionAuth: FC<PropsWithChildren<SessionAuthProps & { userContext?: any }>> = SessionAPIWrapper.SessionAuth

Const SessionComponentsOverrideProvider

SessionComponentsOverrideProvider: FC<PropsWithChildren<{ components: ComponentOverrideMap }>> = SessionAPIWrapper.ComponentsOverrideProvider

Const SessionContext

SessionContext: Context<{ accessDeniedValidatorError?: ClaimValidationError; invalidClaims: ClaimValidationError[]; loading: false } & SessionContextUpdate & { isDefault?: boolean } & { loading: true } & { isDefault?: boolean }> = ...

Functions

addAxiosInterceptors

addAxiosInterceptors(axiosInstance: any, userContext?: any): void

- Defined in lib/ts/recipe/session/index.ts:125
deprecated
Parameters
- axiosInstance: any
- Optional userContext: any
Returns void

attemptRefreshingSession

attemptRefreshingSession(): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:120
Returns Promise<boolean>

doesSessionExist

doesSessionExist(input?: { userContext?: any }): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:121
Parameters
- Optional input: { userContext?: any }
  - Optional userContext?: any
Returns Promise<boolean>

getAccessToken

getAccessToken(input?: { userContext?: any }): Promise<undefined | string>

- Defined in lib/ts/recipe/session/index.ts:118
Parameters
- Optional input: { userContext?: any }
  - Optional userContext?: any
Returns Promise<undefined | string>

getAccessTokenPayloadSecurely

getAccessTokenPayloadSecurely(input?: { userContext?: any }): Promise<any>

- Defined in lib/ts/recipe/session/index.ts:119
Parameters
- Optional input: { userContext?: any }
  - Optional userContext?: any
Returns Promise<any>

getClaimValue

getClaimValue<T>(input: { claim: SessionClaim<T>; userContext?: any }): Promise<undefined | T>

- Defined in lib/ts/recipe/session/index.ts:129
Type Parameters
- T
Parameters
- input: { claim: SessionClaim<T>; userContext?: any }
  - claim: SessionClaim<T>
  - Optional userContext?: any
Returns Promise<undefined | T>

getInvalidClaimsFromResponse

getInvalidClaimsFromResponse(input: { response: Response | { data: any }; userContext: any }): Promise<ClaimValidationError[]>

- Defined in lib/ts/recipe/session/index.ts:128
Parameters
- input: { response: Response | { data: any }; userContext: any }
  - response: Response | { data: any }
  - userContext: any
Returns Promise<ClaimValidationError[]>

getUserId

getUserId(input?: { userContext?: any }): Promise<string>

- Defined in lib/ts/recipe/session/index.ts:117
Parameters
- Optional input: { userContext?: any }
  - Optional userContext?: any
Returns Promise<string>

init

init(config?: InputType): RecipeInitResult<unknown, unknown, unknown, any>

- Defined in lib/ts/recipe/session/index.ts:116
Parameters
- Optional config: InputType
Returns RecipeInitResult<unknown, unknown, unknown, any>

signOut

signOut(input?: { userContext?: any }): Promise<void>

- Defined in lib/ts/recipe/session/index.ts:126
Parameters
- Optional input: { userContext?: any }
  - Optional userContext?: any
Returns Promise<void>

useClaimValue

useClaimValue<T>(claim: SessionClaim<T>): { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }

- Defined in lib/ts/recipe/session/index.ts:114
Type Parameters
- T
Parameters
- claim: SessionClaim<T>
Returns { loading: true } | { doesSessionExist: boolean; loading: false; value: undefined | T }

useSessionContext

useSessionContext(): SessionContextType

- Defined in lib/ts/recipe/session/index.ts:113
Returns SessionContextType

validateClaims

validateClaims(input?: { userContext?: any; overrideGlobalClaimValidators?: any }): ClaimValidationError[] | Promise<ClaimValidationError[]>

- Defined in lib/ts/recipe/session/index.ts:127
Parameters
- Optional input: { userContext?: any; overrideGlobalClaimValidators?: any }
  - Optional userContext?: any
  - overrideGlobalClaimValidators?:function
    - overrideGlobalClaimValidators(globalClaimValidators: SessionClaimValidator[], userContext: any): SessionClaimValidator[]
    - Defined in lib/ts/recipe/session/index.ts:84
      Parameters
      - globalClaimValidators: SessionClaimValidator[]
      - userContext: any
      Returns SessionClaimValidator[]
Returns ClaimValidationError[] | Promise<ClaimValidationError[]>

Index

Classes

Type Aliases

Variables

Functions

Type Aliases

ClaimValidationError

Type declaration

Optional reason?: any

validatorId: string

ClaimValidationResult

InputType

RecipeInterface

Type declaration

addAxiosInterceptors:function

Parameters

input: { axiosInstance: any; userContext: any }

axiosInstance: any

userContext: any

Returns void

addFetchInterceptorsAndReturnModifiedFetch:function

Parameters

input: { originalFetch: any; userContext: any }

originalFetch: any

userContext: any

Returns ((input: URL | RequestInfo, init?: RequestInit) => Promise<Response>)

Parameters

input: URL | RequestInfo

Optional init: RequestInit

Returns Promise<Response>

addXMLHttpRequestInterceptor:function

Parameters

input: { userContext: any }

userContext: any

Returns void

doesSessionExist:function

Parameters

input: { userContext: any }

userContext: any

Returns Promise<boolean>

getAccessTokenPayloadSecurely:function

Parameters

input: { userContext: any }

userContext: any

Returns Promise<any>

getGlobalClaimValidators:function

Parameters

input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any }

claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]

userContext: any

Returns SessionClaimValidator[]

getInvalidClaimsFromResponse:function

Parameters

input: { response: { data: any } | Response; userContext: any }

response: { data: any } | Response

userContext: any

Returns Promise<ClaimValidationError[]>

getUserId:function

Parameters

input: { userContext: any }

userContext: any

Returns Promise<string>

shouldDoInterceptionBasedOnUrl:function

Parameters

toCheckUrl: string

apiDomain: string

sessionTokenBackendDomain: undefined | string

Returns boolean

signOut:function

Parameters

input: { userContext: any }

userContext: any

Returns Promise<void>

validateClaims:function

Parameters

input: { claimValidators: SessionClaimValidator[]; userContext: any }

claimValidators: SessionClaimValidator[]

userContext: any

Returns Promise<ClaimValidationError[]>

SessionClaim