Class SessionKit<TPayload, TPrincipal>

Framework-agnostic session runtime responsible for auth context hydration, session creation/revocation, and optional token refresh behavior.

Type Parameters

TPayload
TPrincipal

Index

Constructors

Methods

middleware optionalAuth requireAuth signIn signOut getAuth buildAuthContext maybeRefreshTokenSession handleRefreshFailure maybeTouch

Properties

cookieName lockProvider opts

Constructors

constructor

new SessionKit<TPayload, TPrincipal>(
opts: SessionKitOptions<TPayload, TPrincipal>,
): SessionKit<TPayload, TPrincipal>
Type Parameters
- TPayload
- TPrincipal
Parameters
- opts: SessionKitOptions<TPayload, TPrincipal>
Returns SessionKit<TPayload, TPrincipal>
- Defined in packages/core/src/SessionKit.ts:35

Methods

middleware

middleware(): HttpMiddleware
Creates middleware that resolves session state and stores auth context.

Returns HttpMiddleware
- Defined in packages/core/src/SessionKit.ts:43

optionalAuth

optionalAuth(): HttpMiddleware
Alias of middleware. Useful for readability in route composition.

Returns HttpMiddleware
- Defined in packages/core/src/SessionKit.ts:58

requireAuth

requireAuth(options?: RequireAuthOptions): HttpMiddleware
Creates middleware that requires an authenticated session.
Parameters
- Optionaloptions: RequireAuthOptions
Returns HttpMiddleware
- Defined in packages/core/src/SessionKit.ts:65

signIn

signIn(
    ctx: HttpContext,
    payload: TPayload,
    options?: SignInOptions,
): Promise<SignInResult<TPrincipal>>
Creates a new session, sets cookie, and optionally hydrates request auth context.
Parameters
- ctx: HttpContext
- payload: TPayload
- Optionaloptions: SignInOptions
Returns Promise<SignInResult<TPrincipal>>
- Defined in packages/core/src/SessionKit.ts:86

signOut

signOut(ctx: HttpContext, options?: SignOutOptions): Promise<void>
Deletes session data and clears the session cookie.
Parameters
- ctx: HttpContext
- Optionaloptions: SignOutOptions
Returns Promise<void>
- Defined in packages/core/src/SessionKit.ts:126

getAuth

getAuth(ctx: HttpContext): AuthContext<TPayload, TPrincipal>
Returns auth context attached to the request, or an unauthenticated default value.
Parameters
- ctx: HttpContext
Returns AuthContext<TPayload, TPrincipal>
- Defined in packages/core/src/SessionKit.ts:153

`Private`buildAuthContext

buildAuthContext(ctx: HttpContext): Promise<InternalAuth<TPayload, TPrincipal>>
Parameters
- ctx: HttpContext
Returns Promise<InternalAuth<TPayload, TPrincipal>>
- Defined in packages/core/src/SessionKit.ts:165

`Private`maybeRefreshTokenSession

maybeRefreshTokenSession(
    ctx: HttpContext,
    sessionId: string,
    stored: StoredSession<TPayload>,
): Promise<null | StoredSession<TPayload>>
Parameters
- ctx: HttpContext
- sessionId: string
- stored: StoredSession<TPayload>
Returns Promise<null | StoredSession<TPayload>>
- Defined in packages/core/src/SessionKit.ts:231

`Private`handleRefreshFailure

handleRefreshFailure(
    ctx: HttpContext,
    sessionId: string,
    error: unknown,
): Promise<void>
Parameters
- ctx: HttpContext
- sessionId: string
- error: unknown
Returns Promise<void>
- Defined in packages/core/src/SessionKit.ts:300

`Private`maybeTouch

maybeTouch(
    sessionId: string,
    renewBeforeSeconds: number,
    ttlSeconds: number,
    auth: InternalAuth<TPayload, TPrincipal>,
): Promise<void>
Parameters
- sessionId: string
- renewBeforeSeconds: number
- ttlSeconds: number
- auth: InternalAuth<TPayload, TPrincipal>
Returns Promise<void>
- Defined in packages/core/src/SessionKit.ts:321

Properties

`Private` `Readonly`cookieName

cookieName: string

`Private` `Readonly`lockProvider

lockProvider: LockProvider | NoopLockProvider

`Private` `Readonly`opts

opts: SessionKitOptions<TPayload, TPrincipal>