message

Module: vibex/message

Message types for VibeX - Using AI SDK v5 types directly

Classes

MessageQueue

View source

Enhanced Message Queue with management capabilities

Methods:

add

View source

Add message to queue


function add(content: string, metadata?: any): string

Parameters:

Name	Type	Description
`content`	`string`
`metadata`	`any` (optional)

View source

Get next message from queue


function next(): QueuedMessage | undefined

complete

View source

Mark current message as complete


function complete(messageId: string): void

Parameters:

Name	Type	Description
`messageId`	`string`

error

View source

Mark current message as error


function error(messageId: string, error: string): void

Parameters:

Name	Type	Description
`messageId`	`string`
`error`	`string`

remove

View source

Remove message from queue


function remove(messageId: string): boolean

Parameters:

Name	Type	Description
`messageId`	`string`

reorder

View source

Reorder queue


function reorder(messageId: string, newIndex: number): void

Parameters:

Name	Type	Description
`messageId`	`string`
`newIndex`	`number`

edit

View source

Edit queued message


function edit(messageId: string, content: string): void

Parameters:

Name	Type	Description
`messageId`	`string`
`content`	`string`

clear

View source

Clear all queued messages


function clear(): void

getState

View source

Get queue state


function getState(): QueueState

View source

Subscribe to queue changes


function subscribe(listener: QueueListener): () => void

Parameters:

Name	Type	Description
`listener`	`QueueListener`

isEmpty

View source

Check if queue is empty


function isEmpty(): boolean

isProcessing

View source

Check if processing


function isProcessing(): boolean

ConversationHistory

View source

Conversation History management

Properties:

Name	Type	Description
`messages`	`Message[]`

Methods:

add

View source


function add(message: Message): void

Parameters:

Name	Type	Description
`message`	`Message`

getMessages

View source


function getMessages(): Message[]

getLastN

View source


function getLastN(n: number): Message[]

Parameters:

Name	Type	Description
`n`	`number`

clear

View source


function clear(): void

toModelMessages

View source


function toModelMessages(): ModelMessage[]

Interfaces

XMessage

View source

Properties:

Name	Type	Description
`role`	`"system" \| "user" \| "assistant" \| "function" \| "data" \| "tool"`
`content`	`any`
`id`	`string`	(optional)
`metadata`	`\{ agentName?: string; timestamp?: number; [key: string]: any; \}`	(optional)

QueuedMessage

View source

Queued message with metadata

Properties:

Name	Type	Description
`id`	`string`
`content`	`string`
`status`	`"queued" \| "processing" \| "completed" \| "error"`
`timestamp`	`number`
`edited`	`boolean`	(optional)
`error`	`string`	(optional)
`metadata`	`any`	(optional)

QueueState

View source

Queue state for UI

Properties:

Name	Type	Description
`current`	`QueuedMessage`	(optional)
`queue`	`QueuedMessage[]`
`processing`	`boolean`

Types

ModelMessage

View source

Message types for VibeX - Using AI SDK v5 types directly


type ModelMessage = {
  role: "system" | "user" | "assistant" | "function" | "data" | "tool";
  content: string | any[];
}

Message

View source


type Message = XMessage

QueueListener

View source

Queue listener type


type QueueListener = (state: QueueState) => void

Functions

getTextContent

View source

Get text content from a message


function getTextContent(message: Message): string

Parameters:

Name	Type	Description
`message`	`Message`