recipe/session | supertokens-node

Type aliases

APIInterface

APIInterface: { refreshPOST: undefined | ((input: { options: APIOptions; userContext: any }) => Promise<SessionContainer>); signOutPOST: undefined | ((input: { options: APIOptions; session: SessionContainer | undefined; userContext: any }) => Promise<{ status: "OK" } | GeneralErrorResponse>); verifySession: any }

Type declaration

refreshPOST: undefined | ((input: { options: APIOptions; userContext: any }) => Promise<SessionContainer>)

We do not add a GeneralErrorResponse response to this API since it's not something that is directly called by the user on the frontend anyway
signOutPOST: undefined | ((input: { options: APIOptions; session: SessionContainer | undefined; userContext: any }) => Promise<{ status: "OK" } | GeneralErrorResponse>)
verifySession:function
- verifySession(input: { options: APIOptions; userContext: any; verifySessionOptions: VerifySessionOptions | undefined }): Promise<undefined | SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:416
  Parameters
  - input: { options: APIOptions; userContext: any; verifySessionOptions: VerifySessionOptions | undefined }
    - options: APIOptions
    - userContext: any
    - verifySessionOptions: VerifySessionOptions | undefined
  Returns Promise<undefined | SessionContainer>

APIOptions

APIOptions: { config: TypeNormalisedInput; isInServerlessEnv: boolean; recipeId: string; recipeImplementation: RecipeInterface; req: BaseRequest; res: BaseResponse }

Type declaration

config: TypeNormalisedInput
isInServerlessEnv: boolean
recipeId: string
recipeImplementation: RecipeInterface
req: BaseRequest
res: BaseResponse

RecipeInterface

RecipeInterface: { createNewSession: any; fetchAndSetClaim: any; getAccessTokenLifeTimeMS: any; getAllSessionHandlesForUser: any; getClaimValue: any; getGlobalClaimValidators: any; getRefreshTokenLifeTimeMS: any; getSession: any; getSessionInformation: any; mergeIntoAccessTokenPayload: any; refreshSession: any; regenerateAccessToken: any; removeClaim: any; revokeAllSessionsForUser: any; revokeMultipleSessions: any; revokeSession: any; setClaimValue: any; updateAccessTokenPayload: any; updateSessionData: any; validateClaims: any; validateClaimsInJWTPayload: any }

Type declaration

createNewSession:function
- createNewSession(input: { accessTokenPayload?: any; req: BaseRequest; res: BaseResponse; sessionData?: any; userContext: any; userId: string }): Promise<SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:214
  Parameters
  - input: { accessTokenPayload?: any; req: BaseRequest; res: BaseResponse; sessionData?: any; userContext: any; userId: string }
    - Optional accessTokenPayload?: any
    - req: BaseRequest
    - res: BaseResponse
    - Optional sessionData?: any
    - userContext: any
    - userId: string
  Returns Promise<SessionContainer>
fetchAndSetClaim:function
- fetchAndSetClaim(input: { claim: SessionClaim<any>; sessionHandle: string; userContext: any }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:325
  Parameters
  - input: { claim: SessionClaim<any>; sessionHandle: string; userContext: any }
    - claim: SessionClaim<any>
    - sessionHandle: string
    - userContext: any
  Returns Promise<boolean>
getAccessTokenLifeTimeMS:function
- getAccessTokenLifeTimeMS(input: { userContext: any }): Promise<number>
- - Defined in lib/ts/recipe/session/types.ts:301
  Parameters
  - input: { userContext: any }
    - userContext: any
  Returns Promise<number>
getAllSessionHandlesForUser:function
- getAllSessionHandlesForUser(input: { userContext: any; userId: string }): Promise<string[]>
- - Defined in lib/ts/recipe/session/types.ts:252
  Parameters
  - input: { userContext: any; userId: string }
    - userContext: any
    - userId: string
  Returns Promise<string[]>
getClaimValue:function
- getClaimValue<T>(input: { claim: SessionClaim<T>; sessionHandle: string; userContext: any }): Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: T | undefined }>
- - Defined in lib/ts/recipe/session/types.ts:333
  Type parameters
  - T
  Parameters
  - input: { claim: SessionClaim<T>; sessionHandle: string; userContext: any }
    - claim: SessionClaim<T>
    - sessionHandle: string
    - userContext: any
  Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: T | undefined }>
getGlobalClaimValidators:function
- getGlobalClaimValidators(input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any; userId: string }): SessionClaimValidator[] | Promise<SessionClaimValidator[]>
- - Defined in lib/ts/recipe/session/types.ts:223
  Parameters
  - input: { claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]; userContext: any; userId: string }
    - claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]
    - userContext: any
    - userId: string
  Returns SessionClaimValidator[] | Promise<SessionClaimValidator[]>
getRefreshTokenLifeTimeMS:function
- getRefreshTokenLifeTimeMS(input: { userContext: any }): Promise<number>
- - Defined in lib/ts/recipe/session/types.ts:303
  Parameters
  - input: { userContext: any }
    - userContext: any
  Returns Promise<number>
getSession:function
- getSession(input: { options?: VerifySessionOptions; req: BaseRequest; res: BaseResponse; userContext: any }): Promise<undefined | SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:229
  Parameters
  - input: { options?: VerifySessionOptions; req: BaseRequest; res: BaseResponse; userContext: any }
    - Optional options?: VerifySessionOptions
    - req: BaseRequest
    - res: BaseResponse
    - userContext: any
  Returns Promise<undefined | SessionContainer>
getSessionInformation:function
- getSessionInformation(input: { sessionHandle: string; userContext: any }): Promise<undefined | SessionInformation>
- - Defined in lib/ts/recipe/session/types.ts:248
  Used to retrieve all session information for a given session handle. Can be used in place of:
  - getSessionData
  - getAccessTokenPayload
  Returns undefined if the sessionHandle does not exist
  Parameters
  - input: { sessionHandle: string; userContext: any }
    - sessionHandle: string
    - userContext: any
  Returns Promise<undefined | SessionInformation>
mergeIntoAccessTokenPayload:function
- mergeIntoAccessTokenPayload(input: { accessTokenPayloadUpdate: JSONObject; sessionHandle: string; userContext: any }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:271
  Parameters
  - input: { accessTokenPayloadUpdate: JSONObject; sessionHandle: string; userContext: any }
    - accessTokenPayloadUpdate: JSONObject
    - sessionHandle: string
    - userContext: any
  Returns Promise<boolean>
refreshSession:function
- refreshSession(input: { req: BaseRequest; res: BaseResponse; userContext: any }): Promise<SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:236
  Parameters
  - input: { req: BaseRequest; res: BaseResponse; userContext: any }
    - req: BaseRequest
    - res: BaseResponse
    - userContext: any
  Returns Promise<SessionContainer>
regenerateAccessToken:function
- regenerateAccessToken(input: { accessToken: string; newAccessTokenPayload?: any; userContext: any }): Promise<undefined | { accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; userDataInJWT: any; userId: string }; status: "OK" }>
- - Defined in lib/ts/recipe/session/types.ts:280
  Parameters
  - input: { accessToken: string; newAccessTokenPayload?: any; userContext: any }
    - accessToken: string
    - Optional newAccessTokenPayload?: any
    - userContext: any
  Returns Promise<undefined | { accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; userDataInJWT: any; userId: string }; status: "OK" }>
  Returns false if the sessionHandle does not exist
removeClaim:function
- removeClaim(input: { claim: SessionClaim<any>; sessionHandle: string; userContext: any }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:347
  Parameters
  - input: { claim: SessionClaim<any>; sessionHandle: string; userContext: any }
    - claim: SessionClaim<any>
    - sessionHandle: string
    - userContext: any
  Returns Promise<boolean>
revokeAllSessionsForUser:function
- revokeAllSessionsForUser(input: { userContext: any; userId: string }): Promise<string[]>
- - Defined in lib/ts/recipe/session/types.ts:250
  Parameters
  - input: { userContext: any; userId: string }
    - userContext: any
    - userId: string
  Returns Promise<string[]>
revokeMultipleSessions:function
- revokeMultipleSessions(input: { sessionHandles: string[]; userContext: any }): Promise<string[]>
- - Defined in lib/ts/recipe/session/types.ts:256
  Parameters
  - input: { sessionHandles: string[]; userContext: any }
    - sessionHandles: string[]
    - userContext: any
  Returns Promise<string[]>
revokeSession:function
- revokeSession(input: { sessionHandle: string; userContext: any }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:254
  Parameters
  - input: { sessionHandle: string; userContext: any }
    - sessionHandle: string
    - userContext: any
  Returns Promise<boolean>
setClaimValue:function
- setClaimValue<T>(input: { claim: SessionClaim<T>; sessionHandle: string; userContext: any; value: T }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:326
  Type parameters
  - T
  Parameters
  - input: { claim: SessionClaim<T>; sessionHandle: string; userContext: any; value: T }
    - claim: SessionClaim<T>
    - sessionHandle: string
    - userContext: any
    - value: T
  Returns Promise<boolean>
updateAccessTokenPayload:function
- updateAccessTokenPayload(input: { newAccessTokenPayload: any; sessionHandle: string; userContext: any }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:265
  deprecated
  Use mergeIntoAccessTokenPayload instead
  
  Parameters
  - input: { newAccessTokenPayload: any; sessionHandle: string; userContext: any }
    - newAccessTokenPayload: any
    - sessionHandle: string
    - userContext: any
  Returns Promise<boolean>
  Returns false if the sessionHandle does not exist
updateSessionData:function
- updateSessionData(input: { newSessionData: any; sessionHandle: string; userContext: any }): Promise<boolean>
- - Defined in lib/ts/recipe/session/types.ts:259
  Parameters
  - input: { newSessionData: any; sessionHandle: string; userContext: any }
    - newSessionData: any
    - sessionHandle: string
    - userContext: any
  Returns Promise<boolean>
validateClaims:function
- validateClaims(input: { accessTokenPayload: any; claimValidators: SessionClaimValidator[]; userContext: any; userId: string }): Promise<{ accessTokenPayloadUpdate?: any; invalidClaims: ClaimValidationError[] }>
- - Defined in lib/ts/recipe/session/types.ts:305
  Parameters
  - input: { accessTokenPayload: any; claimValidators: SessionClaimValidator[]; userContext: any; userId: string }
    - accessTokenPayload: any
    - claimValidators: SessionClaimValidator[]
    - userContext: any
    - userId: string
  Returns Promise<{ accessTokenPayloadUpdate?: any; invalidClaims: ClaimValidationError[] }>
validateClaimsInJWTPayload:function
- validateClaimsInJWTPayload(input: { claimValidators: SessionClaimValidator[]; jwtPayload: JSONObject; userContext: any; userId: string }): Promise<{ invalidClaims: ClaimValidationError[]; status: "OK" }>
- - Defined in lib/ts/recipe/session/types.ts:315
  Parameters
  - input: { claimValidators: SessionClaimValidator[]; jwtPayload: JSONObject; userContext: any; userId: string }
    - claimValidators: SessionClaimValidator[]
    - jwtPayload: JSONObject
    - userContext: any
    - userId: string
  Returns Promise<{ invalidClaims: ClaimValidationError[]; status: "OK" }>

SessionClaimValidator

SessionClaimValidator: ({ claim: SessionClaim<any>; shouldRefetch: any } | {}) & { id: string; validate: any }

SessionInformation

SessionInformation: { accessTokenPayload: any; expiry: number; sessionData: any; sessionHandle: string; timeCreated: number; userId: string }

Type declaration

accessTokenPayload: any
expiry: number
sessionData: any
sessionHandle: string
timeCreated: number
userId: string

Variables

Error

Error: typeof default = SessionWrapper.Error

Functions

createJWT

createJWT(payload?: any, validitySeconds?: number, userContext?: any): Promise<{ jwt: string; status: "OK" } | { status: "UNSUPPORTED_ALGORITHM_ERROR" }>

- Defined in lib/ts/recipe/session/index.ts:408
Parameters
- Optional payload: any
- Optional validitySeconds: number
- userContext: any = {}
Returns Promise<{ jwt: string; status: "OK" } | { status: "UNSUPPORTED_ALGORITHM_ERROR" }>

createNewSession

createNewSession(req: any, res: any, userId: string, accessTokenPayload?: any, sessionData?: any, userContext?: any): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:377
Parameters
- req: any
- res: any
- userId: string
- accessTokenPayload: any = {}
- sessionData: any = {}
- userContext: any = {}
Returns Promise<SessionContainer>

fetchAndSetClaim

fetchAndSetClaim(sessionHandle: string, claim: SessionClaim<any>, userContext?: any): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:398
Parameters
- sessionHandle: string
- claim: SessionClaim<any>
- userContext: any = {}
Returns Promise<boolean>

getAllSessionHandlesForUser

getAllSessionHandlesForUser(userId: string, userContext?: any): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:387
Parameters
- userId: string
- userContext: any = {}
Returns Promise<string[]>

getClaimValue

getClaimValue<T>(sessionHandle: string, claim: SessionClaim<T>, userContext?: any): Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: undefined | T }>

- Defined in lib/ts/recipe/session/index.ts:400
Type parameters
- T
Parameters
- sessionHandle: string
- claim: SessionClaim<T>
- userContext: any = {}
Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: undefined | T }>

getJWKS

getJWKS(userContext?: any): Promise<{ keys: JsonWebKey[]; status: "OK" }>

- Defined in lib/ts/recipe/session/index.ts:410
Parameters
- userContext: any = {}
Returns Promise<{ keys: JsonWebKey[]; status: "OK" }>

getOpenIdDiscoveryConfiguration

getOpenIdDiscoveryConfiguration(userContext?: any): Promise<{ issuer: string; jwks_uri: string; status: "OK" }>

- Defined in lib/ts/recipe/session/index.ts:414
Parameters
- userContext: any = {}
Returns Promise<{ issuer: string; jwks_uri: string; status: "OK" }>

getSession

getSession(req: any, res: any): Promise<SessionContainer>
getSession(req: any, res: any, options?: VerifySessionOptions & { sessionRequired?: true }, userContext?: any): Promise<SessionContainer>
getSession(req: any, res: any, options?: VerifySessionOptions & { sessionRequired: false }, userContext?: any): Promise<undefined | SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:379
Parameters
- req: any
- res: any
Returns Promise<SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:379
Parameters
- req: any
- res: any
- Optional options: VerifySessionOptions & { sessionRequired?: true }
- Optional userContext: any
Returns Promise<SessionContainer>
- Defined in lib/ts/recipe/session/index.ts:379
Parameters
- req: any
- res: any
- Optional options: VerifySessionOptions & { sessionRequired: false }
- Optional userContext: any
Returns Promise<undefined | SessionContainer>

getSessionInformation

getSessionInformation(sessionHandle: string, userContext?: any): Promise<undefined | SessionInformation>

- Defined in lib/ts/recipe/session/index.ts:381
Parameters
- sessionHandle: string
- userContext: any = {}
Returns Promise<undefined | SessionInformation>

init

init(config?: TypeInput): RecipeListFunction

- Defined in lib/ts/recipe/session/index.ts:375
Parameters
- Optional config: TypeInput
Returns RecipeListFunction

mergeIntoAccessTokenPayload

mergeIntoAccessTokenPayload(sessionHandle: string, accessTokenPayloadUpdate: JSONObject, userContext?: any): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:396
Parameters
- sessionHandle: string
- accessTokenPayloadUpdate: JSONObject
- userContext: any = {}
Returns Promise<boolean>

refreshSession

refreshSession(req: any, res: any, userContext?: any): Promise<SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:383
Parameters
- req: any
- res: any
- userContext: any = {}
Returns Promise<SessionContainer>

removeClaim

removeClaim(sessionHandle: string, claim: SessionClaim<any>, userContext?: any): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:401
Parameters
- sessionHandle: string
- claim: SessionClaim<any>
- userContext: any = {}
Returns Promise<boolean>

revokeAllSessionsForUser

revokeAllSessionsForUser(userId: string, userContext?: any): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:385
Parameters
- userId: string
- userContext: any = {}
Returns Promise<string[]>

revokeMultipleSessions

revokeMultipleSessions(sessionHandles: string[], userContext?: any): Promise<string[]>

- Defined in lib/ts/recipe/session/index.ts:391
Parameters
- sessionHandles: string[]
- userContext: any = {}
Returns Promise<string[]>

revokeSession

revokeSession(sessionHandle: string, userContext?: any): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:389
Parameters
- sessionHandle: string
- userContext: any = {}
Returns Promise<boolean>

setClaimValue

setClaimValue<T>(sessionHandle: string, claim: SessionClaim<T>, value: T, userContext?: any): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:399
Type parameters
- T
Parameters
- sessionHandle: string
- claim: SessionClaim<T>
- value: T
- userContext: any = {}
Returns Promise<boolean>

updateAccessTokenPayload

updateAccessTokenPayload(sessionHandle: string, newAccessTokenPayload: any, userContext?: any): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:395
Parameters
- sessionHandle: string
- newAccessTokenPayload: any
- userContext: any = {}
Returns Promise<boolean>

updateSessionData

updateSessionData(sessionHandle: string, newSessionData: any, userContext?: any): Promise<boolean>

- Defined in lib/ts/recipe/session/index.ts:393
Parameters
- sessionHandle: string
- newSessionData: any
- userContext: any = {}
Returns Promise<boolean>

validateClaimsForSessionHandle

validateClaimsForSessionHandle(sessionHandle: string, overrideGlobalClaimValidators?: (globalClaimValidators: SessionClaimValidator[], sessionInfo: SessionInformation, userContext: any) => SessionClaimValidator[] | Promise<SessionClaimValidator[]>, userContext?: any): Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { invalidClaims: ClaimValidationError[]; status: "OK" }>

- Defined in lib/ts/recipe/session/index.ts:403
Parameters
- sessionHandle: string
- Optional overrideGlobalClaimValidators: (globalClaimValidators: SessionClaimValidator[], sessionInfo: SessionInformation, userContext: any) => SessionClaimValidator[] | Promise<SessionClaimValidator[]>
  - - (globalClaimValidators: SessionClaimValidator[], sessionInfo: SessionInformation, userContext: any): SessionClaimValidator[] | Promise<SessionClaimValidator[]>
    - Parameters
      - globalClaimValidators: SessionClaimValidator[]
      - sessionInfo: SessionInformation
      - userContext: any
      Returns SessionClaimValidator[] | Promise<SessionClaimValidator[]>
- userContext: any = {}
Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { invalidClaims: ClaimValidationError[]; status: "OK" }>

validateClaimsInJWTPayload

validateClaimsInJWTPayload(userId: string, jwtPayload: JSONObject, overrideGlobalClaimValidators?: (globalClaimValidators: SessionClaimValidator[], userId: string, userContext: any) => SessionClaimValidator[] | Promise<SessionClaimValidator[]>, userContext?: any): Promise<{ invalidClaims: ClaimValidationError[]; status: "OK" }>

- Defined in lib/ts/recipe/session/index.ts:402
Parameters
- userId: string
- jwtPayload: JSONObject
- Optional overrideGlobalClaimValidators: (globalClaimValidators: SessionClaimValidator[], userId: string, userContext: any) => SessionClaimValidator[] | Promise<SessionClaimValidator[]>
  - - (globalClaimValidators: SessionClaimValidator[], userId: string, userContext: any): SessionClaimValidator[] | Promise<SessionClaimValidator[]>
    - Parameters
      - globalClaimValidators: SessionClaimValidator[]
      - userId: string
      - userContext: any
      Returns SessionClaimValidator[] | Promise<SessionClaimValidator[]>
- userContext: any = {}
Returns Promise<{ invalidClaims: ClaimValidationError[]; status: "OK" }>

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

APIInterface

Type declaration

refreshPOST: undefined | ((input: { options: APIOptions; userContext: any }) => Promise<SessionContainer>)

signOutPOST: undefined | ((input: { options: APIOptions; session: SessionContainer | undefined; userContext: any }) => Promise<{ status: "OK" } | GeneralErrorResponse>)

verifySession:function

Parameters

input: { options: APIOptions; userContext: any; verifySessionOptions: VerifySessionOptions | undefined }

options: APIOptions

userContext: any

verifySessionOptions: VerifySessionOptions | undefined

Returns Promise<undefined | SessionContainer>

APIOptions

Type declaration

config: TypeNormalisedInput

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

RecipeInterface

Type declaration

createNewSession:function

Parameters

input: { accessTokenPayload?: any; req: BaseRequest; res: BaseResponse; sessionData?: any; userContext: any; userId: string }

Optional accessTokenPayload?: any

req: BaseRequest

res: BaseResponse

Optional sessionData?: any

userContext: any

userId: string

Returns Promise<SessionContainer>

fetchAndSetClaim:function

Parameters

input: { claim: SessionClaim<any>; sessionHandle: string; userContext: any }

claim: SessionClaim<any>

sessionHandle: string

userContext: any

Returns Promise<boolean>

getAccessTokenLifeTimeMS:function

Parameters

input: { userContext: any }

userContext: any

Returns Promise<number>

getAllSessionHandlesForUser:function

Parameters

input: { userContext: any; userId: string }

userContext: any

userId: string

Returns Promise<string[]>

getClaimValue:function

Type parameters

T

Parameters

input: { claim: SessionClaim<T>; sessionHandle: string; userContext: any }

claim: SessionClaim<T>

sessionHandle: string

userContext: any

Returns Promise<{ status: "SESSION_DOES_NOT_EXIST_ERROR" } | { status: "OK"; value: T | undefined }>

getGlobalClaimValidators:function

Parameters

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

claimValidatorsAddedByOtherRecipes: SessionClaimValidator[]

userContext: any

userId: string

Returns SessionClaimValidator[] | Promise<SessionClaimValidator[]>

getRefreshTokenLifeTimeMS:function

Parameters

input: { userContext: any }

userContext: any

Returns Promise<number>

getSession:function

Parameters

input: { options?: VerifySessionOptions; req: BaseRequest; res: BaseResponse; userContext: any }