TypeScript types

Type definitions from lib/types.ts and related files.

Chat types

ChatMessage

Represents a message in the chat UI.

export type ChatMessage = UIMessage<
  MessageMetadata,
  CustomUIDataTypes,
  ChatTools
>;

Extends UIMessage from the ai package with:

Metadata: MessageMetadata
Data types: CustomUIDataTypes
Tools: ChatTools

From lib/types.ts:47-51

MessageMetadata

Metadata attached to each message.

export const messageMetadataSchema = z.object({
  createdAt: z.string(),
});

export type MessageMetadata = z.infer<typeof messageMetadataSchema>;

createdAt

string

required

ISO 8601 timestamp string

From lib/types.ts:12-16

CustomUIDataTypes

Custom data events that can be sent during streaming.

export type CustomUIDataTypes = {
  textDelta: string;
  imageDelta: string;
  sheetDelta: string;
  codeDelta: string;
  suggestion: Suggestion;
  appendMessage: string;
  id: string;
  title: string;
  kind: ArtifactKind;
  clear: null;
  finish: null;
  "chat-title": string;
};

textDelta

string

Streaming text content delta

imageDelta

string

Streaming image data delta

sheetDelta

string

Streaming spreadsheet data delta

codeDelta

string

Streaming code content delta

suggestion

Suggestion

A document editing suggestion

appendMessage

string

Message to append to current content

string

Identifier for the current artifact

title

string

Title for the current artifact

kind

ArtifactKind

Type of artifact being created

clear

null

Signal to clear current content

finish

null

Signal that streaming is complete

chat-title

string

Generated chat title

From lib/types.ts:32-46

ChatTools

Available tools for the AI during chat.

type weatherTool = InferUITool<typeof getWeather>;
type createDocumentTool = InferUITool<ReturnType<typeof createDocument>>;
type updateDocumentTool = InferUITool<ReturnType<typeof updateDocument>>;
type requestSuggestionsTool = InferUITool<ReturnType<typeof requestSuggestions>>;

export type ChatTools = {
  getWeather: weatherTool;
  createDocument: createDocumentTool;
  updateDocument: updateDocumentTool;
  requestSuggestions: requestSuggestionsTool;
};

getWeather

weatherTool

Fetch weather information for a location

createDocument

createDocumentTool

Create a new document (text, code, image, or sheet)

updateDocument

updateDocumentTool

Update an existing document’s content

requestSuggestions

requestSuggestionsTool

Request AI-generated editing suggestions for a document

From lib/types.ts:18-30

Attachment

Represents a file attachment.

export type Attachment = {
  name: string;
  url: string;
  contentType: string;
};

name

string

required

File name

url

string

required

File URL

contentType

string

required

MIME type (e.g., "image/jpeg", "image/png")

From lib/types.ts:53-57

Database types

All database types are inferred from schema definitions in lib/db/schema.ts.

User

export type User = InferSelectModel<typeof user>;

Show Properties

string

User UUID

string

Email address (max 64 characters)

password

string | null

Hashed password (nullable for OAuth users)

From lib/db/schema.ts:20

Chat

export type Chat = InferSelectModel<typeof chat>;

Show Properties

string

Chat UUID

createdAt

Date

Creation timestamp

title

string

Chat title

userId

string

Owner user UUID

visibility

'public' | 'private'

Chat visibility (default: "private")

From lib/db/schema.ts:34

DBMessage

export type DBMessage = InferSelectModel<typeof message>;

Show Properties

string

Message UUID

chatId

string

Chat UUID

role

string

Message role: "user", "assistant", or "system"

parts

any[]

Array of message parts (text or file objects)

attachments

any[]

Array of file attachments

createdAt

Date

Creation timestamp

From lib/db/schema.ts:61

Vote

export type Vote = InferSelectModel<typeof vote>;

Show Properties

chatId

string

Chat UUID

messageId

string

Message UUID

isUpvoted

boolean

true for upvote, false for downvote

From lib/db/schema.ts:103

Document

export type Document = InferSelectModel<typeof document>;

Show Properties

string

Document UUID

createdAt

Date

Creation timestamp (part of composite key)

title

string

Document title

content

string | null

Document content

kind

'text' | 'code' | 'image' | 'sheet'

Document type (default: "text")

userId

string

Owner user UUID

From lib/db/schema.ts:126

Suggestion

export type Suggestion = InferSelectModel<typeof suggestion>;

Show Properties

string

Suggestion UUID

documentId

string

Document UUID

documentCreatedAt

Date

Document version timestamp

originalText

string

Text to be replaced

suggestedText

string

Suggested replacement

description

string | null

Optional description

isResolved

boolean

Resolution status (default: false)

userId

string

Owner user UUID

createdAt

Date

Creation timestamp

From lib/db/schema.ts:152

Stream

export type Stream = InferSelectModel<typeof stream>;

Show Properties

string

Stream UUID

chatId

string

Associated chat UUID

createdAt

Date

Creation timestamp

From lib/db/schema.ts:170

Request/Response schemas

PostRequestBody

Request body schema for POST /api/chat.

export const postRequestBodySchema = z.object({
  id: z.string().uuid(),
  message: userMessageSchema.optional(),
  messages: z.array(messageSchema).optional(),
  selectedChatModel: z.string(),
  selectedVisibilityType: z.enum(["public", "private"]),
});

export type PostRequestBody = z.infer<typeof postRequestBodySchema>;

string

required

Chat UUID

message

object

Single new user message (for new messages)

messages

array

All messages (for tool approval flows)

selectedChatModel

string

required

AI model identifier

selectedVisibilityType

'public' | 'private'

required

Chat visibility

From app/(chat)/api/chat/schema.ts:30-39

Message parts

TextPart

const textPartSchema = z.object({
  type: z.enum(["text"]),
  text: z.string().min(1).max(2000),
});

type

'text'

required

Part type identifier

text

string

required

Text content (1-2000 characters)

From app/(chat)/api/chat/schema.ts:3-6

FilePart

const filePartSchema = z.object({
  type: z.enum(["file"]),
  mediaType: z.enum(["image/jpeg", "image/png"]),
  name: z.string().min(1).max(100),
  url: z.string().url(),
});

type

'file'

required

Part type identifier

mediaType

'image/jpeg' | 'image/png'

required

MIME type (currently only images supported)

name

string

required

File name (1-100 characters)

url

string

required

Valid URL to the file

From app/(chat)/api/chat/schema.ts:8-13

UserMessage

const userMessageSchema = z.object({
  id: z.string().uuid(),
  role: z.enum(["user"]),
  parts: z.array(partSchema),
});

string

required

Message UUID

role

'user'

required

Must be "user"

parts

array

required

Array of text or file parts

From app/(chat)/api/chat/schema.ts:17-21

Artifact types

ArtifactKind

Type of document/artifact that can be created.

type ArtifactKind = "text" | "code" | "image" | "sheet";

text
code
image
sheet

Plain text documents, notes, articles

From components/artifact.tsx

Visibility types

VisibilityType

Chat visibility setting.

type VisibilityType = "public" | "private";

private
public

Only visible to the chat owner (default)

From components/visibility-selector.tsx

Utility types

DataPart

Custom data part for streaming.

export type DataPart = { type: "append-message"; message: string };

From lib/types.ts:10

Used for appending messages during streaming responses.

API Routes

Database

Types

Chat types

ChatMessage

MessageMetadata

CustomUIDataTypes

ChatTools

Attachment

Database types

User

Chat

DBMessage

Vote

Document

Suggestion

Stream

Request/Response schemas

PostRequestBody

Message parts

TextPart

FilePart

UserMessage

Artifact types

ArtifactKind

Visibility types

VisibilityType

Utility types

DataPart

Build docs developers (and LLMs) love

API Routes

Database

Types

​Chat types

​ChatMessage

​MessageMetadata

​CustomUIDataTypes

​ChatTools

​Attachment

​Database types

​User

​Chat

​DBMessage

​Vote

​Document

​Suggestion

​Stream

​Request/Response schemas

​PostRequestBody

​Message parts

​TextPart

​FilePart

​UserMessage

​Artifact types

​ArtifactKind

​Visibility types

​VisibilityType

​Utility types

​DataPart

Build docs developers (and LLMs) love

Chat types

ChatMessage

MessageMetadata

CustomUIDataTypes

ChatTools

Attachment

Database types

User

Chat

DBMessage

Vote

Document

Suggestion

Stream

Request/Response schemas

PostRequestBody

Message parts

TextPart

FilePart

UserMessage

Artifact types

ArtifactKind

Visibility types

VisibilityType

Utility types

DataPart