Skip to content

sessions / Exports

sessions

Table of contents

References

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

References

ConversationHistory

Renames and re-exports SimpleConversationHistory


Context

Renames and re-exports AIProvider


ModelResponse

Renames and re-exports AIProvider


StreamingResponseChunk

Renames and re-exports AIProvider

Type Aliases

MessageContent

Ƭ MessageContent: string | { [key: string]: any; text?: string ; image?: string ; file?: string }

Defined in

packages/sessions/src/types/chat.ts:16

Variables

AIProvider

AIProvider: any


ValidationConstraints

Const ValidationConstraints: Object

Common validation constraints

Type declaration

NameType
required(field: string) => string
minLength(field: string, min: number) => string
maxLength(field: string, max: number) => string
positive(field: string) => string
range(field: string, min: number, max: number) => string

Defined in

packages/sessions/src/constants/error-messages.ts:133


DEFAULT_SESSION_CONFIG

Const DEFAULT_SESSION_CONFIG: DefaultSessionConfig

Default session configuration

Defined in

packages/sessions/src/utils/session-utils.ts:30

Functions

getErrorMessage

getErrorMessage(key, params?): string

Get formatted error message

Parameters

NameTypeDescription
keySessionErrorKeyError message key
paramsRecord<string, any>Message parameters for substitution

Returns

string

Formatted error message

Defined in

packages/sessions/src/constants/error-messages.ts:47


createSessionError

createSessionError(key, params?): Error

Create session error with formatted message

Parameters

NameTypeDescription
keySessionErrorKeyError message key
paramsRecord<string, any>Message parameters

Returns

Error

Error instance

Defined in

packages/sessions/src/constants/error-messages.ts:65


isValidTransition

isValidTransition(currentState, targetState, action, context?): boolean

Check if a state transition is valid

Parameters

NameTypeDescription
currentStateSessionStateCurrent session state
targetStateSessionStateTarget session state
actionstringAction being performed
context?anyOptional context for condition checking

Returns

boolean

True if transition is valid

Defined in

packages/sessions/src/state/session-state-machine.ts:61


attemptTransition

attemptTransition(currentState, targetState, action, context?): TransitionResult

Attempt to transition to a new state

Parameters

NameTypeDescription
currentStateSessionStateCurrent session state
targetStateSessionStateTarget session state
actionstringAction being performed
context?anyOptional context for condition checking

Returns

TransitionResult

Transition result

Defined in

packages/sessions/src/state/session-state-machine.ts:99


getPossibleTransitions

getPossibleTransitions(currentState): { state: SessionState ; action: string }[]

Get all possible next states from current state

Parameters

NameTypeDescription
currentStateSessionStateCurrent session state

Returns

{ state: SessionState ; action: string }[]

Array of possible next states with their actions

Defined in

packages/sessions/src/state/session-state-machine.ts:124


isFinalState

isFinalState(state): boolean

Check if a state is a final state (no transitions possible)

Parameters

NameTypeDescription
stateSessionStateState to check

Returns

boolean

True if state is final

Defined in

packages/sessions/src/state/session-state-machine.ts:136


isActiveState

isActiveState(state): boolean

Check if a state allows active operations

Parameters

NameTypeDescription
stateSessionStateState to check

Returns

boolean

True if state allows active operations

Defined in

packages/sessions/src/state/session-state-machine.ts:146


allowsModifications

allowsModifications(state): boolean

Check if a state allows modifications

Parameters

NameTypeDescription
stateSessionStateState to check

Returns

boolean

True if state allows modifications

Defined in

packages/sessions/src/state/session-state-machine.ts:156


getStateDescription

getStateDescription(state): string

Get human-readable state description

Parameters

NameTypeDescription
stateSessionStateSession state

Returns

string

Human-readable description

Defined in

packages/sessions/src/state/session-state-machine.ts:166


validateTransitionChain

validateTransitionChain(transitions): Object

Validate state transition chain

Parameters

NameTypeDescription
transitions{ from: SessionState ; to: SessionState ; action: string }[]Array of state transitions to validate

Returns

Object

Validation result with any errors

NameType
validboolean
errorsstring[]

Defined in

packages/sessions/src/state/session-state-machine.ts:183


generateId

generateId(): string

Returns

string

Defined in

packages/sessions/src/utils/id.ts:3


generateDefaultSessionName

generateDefaultSessionName(timestamp?): string

Generate default session name based on timestamp

Parameters

NameTypeDescription
timestamp?DateOptional timestamp (defaults to current time)

Returns

string

Generated session name

Defined in

packages/sessions/src/utils/session-utils.ts:45


validateSessionConfig

validateSessionConfig(config): Object

Validate session configuration

Parameters

NameTypeDescription
configSessionConfigConfiguration to validate

Returns

Object

Validation result

NameType
validboolean
errorsValidationError[]

Defined in

packages/sessions/src/utils/session-utils.ts:56


mergeWithDefaults

mergeWithDefaults(config): DefaultSessionConfig

Merge session configuration with defaults

Parameters

NameTypeDescription
configSessionConfigUser provided configuration

Returns

DefaultSessionConfig

Merged configuration with all required fields

Defined in

packages/sessions/src/utils/session-utils.ts:116


createInitialMetadata

createInitialMetadata(sessionId, userId, config): SessionMetadata

Create initial session metadata

Parameters

NameTypeDescription
sessionIdstringUnique session ID
userIdstringUser ID
configDefaultSessionConfigSession configuration

Returns

SessionMetadata

Initial metadata

Defined in

packages/sessions/src/utils/session-utils.ts:135


updateTimestamps

updateTimestamps(metadata): SessionMetadata

Update metadata timestamps

Parameters

NameTypeDescription
metadataSessionMetadataCurrent metadata

Returns

SessionMetadata

Updated metadata with new timestamps

Defined in

packages/sessions/src/utils/session-utils.ts:162


calculateSessionStats

calculateSessionStats(metadata, chats, startTime): SessionStats

Calculate session statistics

Parameters

NameTypeDescription
metadataSessionMetadataSession metadata
chatsChatInstance[]All chat instances
startTimeDateSession start time

Returns

SessionStats

Calculated statistics

Defined in

packages/sessions/src/utils/session-utils.ts:179


findNextActiveChat

findNextActiveChat(chats, removedChatId, currentActiveChatId?): string | undefined

Find next active chat when current one is removed

Parameters

NameTypeDescription
chatsMap<string, ChatInstance>Map of chat instances
removedChatIdstringID of chat being removed
currentActiveChatId?stringCurrent active chat ID

Returns

string | undefined

ID of next chat to activate, or undefined if none

Defined in

packages/sessions/src/utils/session-utils.ts:209


wouldExceedChatLimit

wouldExceedChatLimit(currentCount, maxChats): boolean

Check if chat limit would be exceeded

Parameters

NameTypeDescription
currentCountnumberCurrent number of chats
maxChatsnumberMaximum allowed chats

Returns

boolean

True if limit would be exceeded

Defined in

packages/sessions/src/utils/session-utils.ts:233


formatUptime

formatUptime(uptimeMs): string

Format uptime duration in human-readable format

Parameters

NameTypeDescription
uptimeMsnumberUptime in milliseconds

Returns

string

Formatted duration string

Defined in

packages/sessions/src/utils/session-utils.ts:243


isSessionModifiable

isSessionModifiable(state): boolean

Check if session is in a modifiable state

Parameters

NameTypeDescription
stateSessionStateCurrent session state

Returns

boolean

True if session allows modifications

Defined in

packages/sessions/src/utils/session-utils.ts:266


isSessionActive

isSessionActive(state): boolean

Check if session is active and ready for operations

Parameters

NameTypeDescription
stateSessionStateCurrent session state

Returns

boolean

True if session is active

Defined in

packages/sessions/src/utils/session-utils.ts:276

Released under the MIT License.