recipe/session | supertokens-node

Type Aliases

APIInterface

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

Type declaration

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

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; 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:302
  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; getAccessTokenLifeTimeMS: any; getAllSessionHandlesForUser: any; getRefreshTokenLifeTimeMS: any; getSession: any; getSessionInformation: any; refreshSession: any; regenerateAccessToken: any; revokeAllSessionsForUser: any; revokeMultipleSessions: any; revokeSession: any; updateAccessTokenPayload: any; updateSessionData: any }

Type declaration

createNewSession:function
- createNewSession(input: { accessTokenPayload?: any; res: BaseResponse; sessionData?: any; userContext: any; userId: string }): Promise<SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:185
  Parameters
  - input: { accessTokenPayload?: any; res: BaseResponse; sessionData?: any; userContext: any; userId: string }
    - Optional accessTokenPayload?: any
    - res: BaseResponse
    - Optional sessionData?: any
    - userContext: any
    - userId: string
  Returns Promise<SessionContainer>
getAccessTokenLifeTimeMS:function
- getAccessTokenLifeTimeMS(input: { userContext: any }): Promise<number>
- - Defined in lib/ts/recipe/session/types.ts:246
  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:214
  Parameters
  - input: { userContext: any; userId: string }
    - userContext: any
    - userId: string
  Returns Promise<string[]>
getRefreshTokenLifeTimeMS:function
- getRefreshTokenLifeTimeMS(input: { userContext: any }): Promise<number>
- - Defined in lib/ts/recipe/session/types.ts:248
  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:193
  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<SessionInformation>
- - Defined in lib/ts/recipe/session/types.ts:210
  Used to retrieve all session information for a given session handle. Can be used in place of:
  - getSessionData
  - getAccessTokenPayload
  Parameters
  - input: { sessionHandle: string; userContext: any }
    - sessionHandle: string
    - userContext: any
  Returns Promise<SessionInformation>
refreshSession:function
- refreshSession(input: { req: BaseRequest; res: BaseResponse; userContext: any }): Promise<SessionContainer>
- - Defined in lib/ts/recipe/session/types.ts:200
  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<{ accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; userDataInJWT: any; userId: string }; status: "OK" }>
- - Defined in lib/ts/recipe/session/types.ts:228
  Parameters
  - input: { accessToken: string; newAccessTokenPayload?: any; userContext: any }
    - accessToken: string
    - Optional newAccessTokenPayload?: any
    - userContext: any
  Returns Promise<{ accessToken?: { createdTime: number; expiry: number; token: string }; session: { handle: string; userDataInJWT: any; userId: string }; status: "OK" }>
revokeAllSessionsForUser:function
- revokeAllSessionsForUser(input: { userContext: any; userId: string }): Promise<string[]>
- - Defined in lib/ts/recipe/session/types.ts:212
  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:218
  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:216
  Parameters
  - input: { sessionHandle: string; userContext: any }
    - sessionHandle: string
    - userContext: any
  Returns Promise<boolean>
updateAccessTokenPayload:function
- updateAccessTokenPayload(input: { newAccessTokenPayload: any; sessionHandle: string; userContext: any }): Promise<void>
- - Defined in lib/ts/recipe/session/types.ts:222
  Parameters
  - input: { newAccessTokenPayload: any; sessionHandle: string; userContext: any }
    - newAccessTokenPayload: any
    - sessionHandle: string
    - userContext: any
  Returns Promise<void>
updateSessionData:function
- updateSessionData(input: { newSessionData: any; sessionHandle: string; userContext: any }): Promise<void>
- - Defined in lib/ts/recipe/session/types.ts:220
  Parameters
  - input: { newSessionData: any; sessionHandle: string; userContext: any }
    - newSessionData: any
    - sessionHandle: string
    - userContext: any
  Returns Promise<void>

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:190
Parameters
- Optional payload: any
- Optional validitySeconds: number
- userContext: any = {}
Returns Promise<{ jwt: string; status: "OK" } | { status: "UNSUPPORTED_ALGORITHM_ERROR" }>

createNewSession

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

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

getAllSessionHandlesForUser

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

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

getJWKS

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

- Defined in lib/ts/recipe/session/index.ts:192
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:196
Parameters
- userContext: any = {}
Returns Promise<{ issuer: string; jwks_uri: string; status: "OK" }>

getSession

getSession(req: any, res: any, options?: VerifySessionOptions, userContext?: any): Promise<undefined | SessionContainer>

- Defined in lib/ts/recipe/session/index.ts:169
Parameters
- req: any
- res: any
- Optional options: VerifySessionOptions
- userContext: any = {}
Returns Promise<undefined | SessionContainer>

getSessionInformation

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

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

init

init(config?: TypeInput): RecipeListFunction

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

refreshSession

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

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

revokeAllSessionsForUser

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

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

revokeMultipleSessions

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

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

revokeSession

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

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

updateAccessTokenPayload

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

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

updateSessionData

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

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

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

APIInterface

Type declaration

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

signOutPOST: undefined | ((input: { options: APIOptions; 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; res: BaseResponse; sessionData?: any; userContext: any; userId: string }

Optional accessTokenPayload?: any

res: BaseResponse

Optional sessionData?: any

userContext: any

userId: string

Returns Promise<SessionContainer>

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[]>

getRefreshTokenLifeTimeMS:function

Parameters

input: { userContext: any }

userContext: any

Returns Promise<number>

getSession:function

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

Parameters

input: { sessionHandle: string; userContext: any }

sessionHandle: string

userContext: any

Returns Promise<SessionInformation>

refreshSession:function

Parameters

input: { req: BaseRequest; res: BaseResponse; userContext: any }

req: BaseRequest

res: BaseResponse

userContext: any

Returns Promise<SessionContainer>

regenerateAccessToken:function

Parameters

input: { accessToken: string; newAccessTokenPayload?: any; userContext: any }

accessToken: string

Optional newAccessTokenPayload?: any

userContext: any