message

Module: @vibex/core/message

Message Types - AI SDK v6 Compatible

VibeX adopts a parts-based message format aligned with AI SDK v6. This provides structured content types for text, tools, reasoning, and artifacts.

Interfaces

TextPart

View source

Message Types - AI SDK v6 Compatible

VibeX adopts a parts-based message format aligned with AI SDK v6. This provides structured content types for text, tools, reasoning, and artifacts.

Properties:

Name	Type	Description
`type`	`"text"`
`text`	`string`

ToolCallPart

View source

Tool call part - when an agent invokes a tool

Properties:

Name	Type	Description
`type`	`"tool-call"`
`toolCallId`	`string`
`toolName`	`string`
`args`	`Record<string, unknown>`
`status`	`"pending" \| "running" \| "completed" \| "failed" \| "pending-approval"`	(optional)

ToolResultPart

View source

Tool result part - the output from a tool

Properties:

Name	Type	Description
`type`	`"tool-result"`
`toolCallId`	`string`
`toolName`	`string`
`result`	`unknown`
`isError`	`boolean`	(optional)

ReasoningPart

View source

Reasoning part - for chain-of-thought or thinking

Properties:

Name	Type	Description
`type`	`"reasoning"`
`text`	`string`

ArtifactPart

View source

Artifact reference part - VibeX-specific for document/file references

Properties:

Name	Type	Description
`type`	`"artifact"`
`artifactId`	`string`
`title`	`string`	(optional)
`version`	`number`	(optional)
`artifactType`	`"document" \| "code" \| "data" \| "image" \| "file"`	(optional)
`preview`	`string`	(optional)
`action`	`"created" \| "updated" \| "referenced"`	(optional)

PlanUpdatePart

View source

Plan update part - VibeX-specific for plan/task changes

Properties:

Name	Type	Description
`type`	`"plan-update"`
`planId`	`string`
`action`	`"created" \| "updated" \| "completed" \| "failed"`
`summary`	`string`	(optional)
`tasksAffected`	`string[]`	(optional)

FilePart

View source

File part - for file attachments

Properties:

Name	Type	Description
`type`	`"file"`
`fileId`	`string`
`filename`	`string`
`mimeType`	`string`
`url`	`string`	(optional)
`size`	`number`	(optional)

StepStartPart

View source

Step start part - marks the beginning of a multi-step process

Properties:

Name	Type	Description
`type`	`"step-start"`
`stepId`	`string`
`stepName`	`string`
`agentName`	`string`	(optional)

ModelMessage

View source

Model message - minimal format for LLM APIs (AI SDK CoreMessage compatible)

Properties:

Name	Type	Description
`role`	`MessageRole`
`content`	`string \| XMessagePart[]`

XMessage

View source

VibeX message - full server-side message with metadata and parts

This is the canonical message format used throughout VibeX. It supports both legacy content and new parts format.

Properties:

Name	Type	Description
`id`	`string`	Unique message identifier (optional)
`role`	`MessageRole`	Role of the message sender
`parts`	`XMessagePart[]`	Message parts - structured content (v6 format)
Preferred over `content` for new code. (optional)
`content`	`string \| unknown[]`	Legacy content field (optional)
`metadata`	`object`	Message metadata (optional)

Types

XMessagePart

View source

Union of all message part types


type XMessagePart = | TextPart
  | ToolCallPart
  | ToolResultPart
  | ReasoningPart
  | ArtifactPart
  | PlanUpdatePart
  | FilePart
  | StepStartPart

MessageRole

View source

Message role types


type MessageRole = "system" | "user" | "assistant" | "tool"

Message

View source

Alias for XMessage


type Message = XMessage

ChatStatus

View source

Granular message/chat status


type ChatStatus = | "idle" // No activity
  | "submitted" // Request sent, waiting for response
  | "streaming" // Actively receiving response
  | "awaiting-approval" // Tool call needs human approval
  | "error"

Functions

getTextFromParts

View source

Extract text content from message parts


function getTextFromParts(parts: XMessagePart[]): string

Parameters:

Name	Type	Description
`parts`	`XMessagePart[]`

createTextMessage

View source

Create a simple text message


function createTextMessage(role: MessageRole, text: string, metadata?: XMessage["metadata"]): XMessage

Parameters:

Name	Type	Description
`role`	`MessageRole`
`text`	`string`
`metadata`	`XMessage["metadata"]` (optional)

hasPendingApproval

View source

Check if message has pending tool approvals


function hasPendingApproval(message: XMessage): boolean

Parameters:

Name	Type	Description
`message`	`XMessage`

getToolCalls

View source

Get all tool calls from a message


function getToolCalls(message: XMessage): ToolCallPart[]

Parameters:

Name	Type	Description
`message`	`XMessage`

getArtifacts

View source

Get all artifacts from a message


function getArtifacts(message: XMessage): ArtifactPart[]

Parameters:

Name	Type	Description
`message`	`XMessage`

contentToParts

View source

Convert legacy content to parts format


function contentToParts(content: string | unknown[] | undefined): XMessagePart[]

Parameters:

Name	Type	Description
`content`	`string \| unknown[] \| undefined`

normalizeMessage

View source

Normalize a message to always have parts


function normalizeMessage(message: XMessage): XMessage

Parameters:

Name	Type	Description
`message`	`XMessage`