Skip to Content
API referenceSIWX ServerSrcInterfacesSiwxSessionStore

API Reference — @tuwaio/siwx (CAIP-122 Authentication Layer)


SiwxSessionStore

Defined in: packages/siwx-server/src/types.ts:86 

Durable session store interface for production environments.

Methods

bindSubject()

bindSubject(id, subjectId): Promise<boolean>

Defined in: packages/siwx-server/src/types.ts:108 

Atomically binds a user/subject identifier to the session.

Parameters

id

string

The session ID.

subjectId

string

The user or subject ID.

Returns

Promise<boolean>

True if binding succeeded, false if session not found.


create()

create(input): Promise<SiwxSessionRecord>

Defined in: packages/siwx-server/src/types.ts:93 

Creates and stores a new session record.

Parameters

input
session

SiwxSession

The verified session data.

ttlSeconds

number

Time-to-live in seconds.

Returns

Promise<SiwxSessionRecord>

The created session record with unique ID.


get()

get(id): Promise<SiwxSessionRecord | null>

Defined in: packages/siwx-server/src/types.ts:100 

Retrieves a session record by its opaque ID.

Parameters

id

string

The session ID.

Returns

Promise<SiwxSessionRecord | null>

The session record, or null if not found or expired.


revoke()

revoke(id): Promise<void>

Defined in: packages/siwx-server/src/types.ts:114 

Revokes and removes a session record.

Parameters

id

string

The session ID.

Returns

Promise<void>

Last updated on