Class UserFlowStateManager

Manages the lifecycle of coordinated user flow state on top of a storage adapter.

Index

Constructors

Methods

advanceStep completeFlow createStateKey failFlow getState resumeFlow startFlow

Constructors

constructor

new UserFlowStateManager(storage: StorageAdapter): UserFlowStateManager
Parameters
- storage: StorageAdapter
Returns UserFlowStateManager

Methods

advanceStep

advanceStep(
    key: string,
    newStep: string,
    payloadUpdate?: Record<string, unknown>,
): Promise<UserFlowState>
Parameters
- key: string
- newStep: string
- payloadUpdate: Record<string, unknown> = {}
Returns Promise<UserFlowState>

completeFlow

completeFlow(key: string): Promise<void>
Parameters
- key: string
Returns Promise<void>

createStateKey

createStateKey(userId: string, flowId: string): string
Parameters
- userId: string
- flowId: string
Returns string

failFlow

failFlow(key: string, error: Error): Promise<void>
Parameters
- key: string
- error: Error
Returns Promise<void>

getState

getState(key: string): Promise<UserFlowState | null>
Parameters
- key: string
Returns Promise<UserFlowState | null>

resumeFlow

resumeFlow(userId: string, flowId: string): Promise<UserFlowState | null>
Parameters
- userId: string
- flowId: string
Returns Promise<UserFlowState | null>

startFlow

startFlow(
    userId: string,
    flowId: string,
    initialStep: string,
    payload?: Record<string, unknown>,
    chatId?: string,
): Promise<string>
Parameters
- userId: string
- flowId: string
- initialStep: string
- payload: Record<string, unknown> = {}
- OptionalchatId: string
Returns Promise<string>