@octavus/react 2.19.0 → 2.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.cjs ADDED
@@ -0,0 +1,208 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __export = (target, all) => {
7
+ for (var name in all)
8
+ __defProp(target, name, { get: all[name], enumerable: true });
9
+ };
10
+ var __copyProps = (to, from, except, desc) => {
11
+ if (from && typeof from === "object" || typeof from === "function") {
12
+ for (let key of __getOwnPropNames(from))
13
+ if (!__hasOwnProp.call(to, key) && key !== except)
14
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
15
+ }
16
+ return to;
17
+ };
18
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
19
+
20
+ // src/index.ts
21
+ var index_exports = {};
22
+ __export(index_exports, {
23
+ AppError: () => import_client_sdk2.AppError,
24
+ ConflictError: () => import_client_sdk2.ConflictError,
25
+ ForbiddenError: () => import_client_sdk2.ForbiddenError,
26
+ MAIN_THREAD: () => import_client_sdk2.MAIN_THREAD,
27
+ NotFoundError: () => import_client_sdk2.NotFoundError,
28
+ OCTAVUS_SKILL_TOOLS: () => import_client_sdk2.OCTAVUS_SKILL_TOOLS,
29
+ OctavusChat: () => import_client_sdk2.OctavusChat,
30
+ OctavusError: () => import_client_sdk2.OctavusError,
31
+ ValidationError: () => import_client_sdk2.ValidationError,
32
+ createApiErrorEvent: () => import_client_sdk2.createApiErrorEvent,
33
+ createErrorEvent: () => import_client_sdk2.createErrorEvent,
34
+ createHttpTransport: () => import_client_sdk2.createHttpTransport,
35
+ createInternalErrorEvent: () => import_client_sdk2.createInternalErrorEvent,
36
+ createPollingTransport: () => import_client_sdk2.createPollingTransport,
37
+ createSocketTransport: () => import_client_sdk2.createSocketTransport,
38
+ errorToStreamEvent: () => import_client_sdk2.errorToStreamEvent,
39
+ generateId: () => import_client_sdk2.generateId,
40
+ getSkillSlugFromToolCall: () => import_client_sdk2.getSkillSlugFromToolCall,
41
+ isAbortError: () => import_client_sdk2.isAbortError,
42
+ isAuthenticationError: () => import_client_sdk2.isAuthenticationError,
43
+ isFileReference: () => import_client_sdk2.isFileReference,
44
+ isFileReferenceArray: () => import_client_sdk2.isFileReferenceArray,
45
+ isMainThread: () => import_client_sdk2.isMainThread,
46
+ isOctavusSkillTool: () => import_client_sdk2.isOctavusSkillTool,
47
+ isOtherThread: () => import_client_sdk2.isOtherThread,
48
+ isProviderError: () => import_client_sdk2.isProviderError,
49
+ isRateLimitError: () => import_client_sdk2.isRateLimitError,
50
+ isRetryableError: () => import_client_sdk2.isRetryableError,
51
+ isSocketTransport: () => import_client_sdk2.isSocketTransport,
52
+ isToolError: () => import_client_sdk2.isToolError,
53
+ isValidationError: () => import_client_sdk2.isValidationError,
54
+ parseSSEStream: () => import_client_sdk2.parseSSEStream,
55
+ resolveThread: () => import_client_sdk2.resolveThread,
56
+ safeParseStreamEvent: () => import_client_sdk2.safeParseStreamEvent,
57
+ safeParseUIMessage: () => import_client_sdk2.safeParseUIMessage,
58
+ safeParseUIMessages: () => import_client_sdk2.safeParseUIMessages,
59
+ threadForPart: () => import_client_sdk2.threadForPart,
60
+ uploadFiles: () => import_client_sdk2.uploadFiles,
61
+ useOctavusChat: () => useOctavusChat
62
+ });
63
+ module.exports = __toCommonJS(index_exports);
64
+
65
+ // src/hooks/use-octavus-chat.ts
66
+ var import_react = require("react");
67
+ var import_client_sdk = require("@octavus/client-sdk");
68
+ function useOctavusChat(options) {
69
+ const chatRef = (0, import_react.useRef)(null);
70
+ const transportRef = (0, import_react.useRef)(null);
71
+ const [sessionId, setSessionId] = (0, import_react.useState)(null);
72
+ const sessionIdSetterRef = (0, import_react.useRef)(setSessionId);
73
+ sessionIdSetterRef.current = setSessionId;
74
+ if (transportRef.current !== options.transport) {
75
+ chatRef.current?.stop();
76
+ setSessionId(null);
77
+ chatRef.current = new import_client_sdk.OctavusChat(options);
78
+ transportRef.current = options.transport;
79
+ }
80
+ const chat = chatRef.current;
81
+ chat.updateOptions({
82
+ clientTools: options.clientTools,
83
+ onError: options.onError,
84
+ onFinish: options.onFinish,
85
+ onStop: options.onStop,
86
+ onResourceUpdate: options.onResourceUpdate,
87
+ onStart: (id) => {
88
+ sessionIdSetterRef.current(id);
89
+ options.onStart?.(id);
90
+ },
91
+ requestUploadUrls: options.requestUploadUrls,
92
+ uploadOptions: options.uploadOptions
93
+ });
94
+ const transport = options.transport;
95
+ const subscribe = (0, import_react.useCallback)((callback) => chat.subscribe(callback), [chat]);
96
+ const getMessagesSnapshot = (0, import_react.useCallback)(() => chat.messages, [chat]);
97
+ const getStatusSnapshot = (0, import_react.useCallback)(() => chat.status, [chat]);
98
+ const getErrorSnapshot = (0, import_react.useCallback)(() => chat.error, [chat]);
99
+ const getPendingClientToolsSnapshot = (0, import_react.useCallback)(() => chat.pendingClientTools, [chat]);
100
+ const getCanRetrySnapshot = (0, import_react.useCallback)(() => chat.canRetry, [chat]);
101
+ const messages = (0, import_react.useSyncExternalStore)(subscribe, getMessagesSnapshot, getMessagesSnapshot);
102
+ const status = (0, import_react.useSyncExternalStore)(subscribe, getStatusSnapshot, getStatusSnapshot);
103
+ const error = (0, import_react.useSyncExternalStore)(subscribe, getErrorSnapshot, getErrorSnapshot);
104
+ const pendingClientTools = (0, import_react.useSyncExternalStore)(
105
+ subscribe,
106
+ getPendingClientToolsSnapshot,
107
+ getPendingClientToolsSnapshot
108
+ );
109
+ const canRetry = (0, import_react.useSyncExternalStore)(subscribe, getCanRetrySnapshot, getCanRetrySnapshot);
110
+ const socketTransport = (0, import_client_sdk.isSocketTransport)(transport) ? transport : null;
111
+ const [connectionState, setConnectionState] = (0, import_react.useState)(
112
+ socketTransport?.connectionState
113
+ );
114
+ const [connectionError, setConnectionError] = (0, import_react.useState)(void 0);
115
+ (0, import_react.useEffect)(() => {
116
+ if (!socketTransport) {
117
+ setConnectionState(void 0);
118
+ setConnectionError(void 0);
119
+ return;
120
+ }
121
+ const unsubscribe = socketTransport.onConnectionStateChange((state, err) => {
122
+ setConnectionState(state);
123
+ setConnectionError(err);
124
+ });
125
+ return unsubscribe;
126
+ }, [socketTransport]);
127
+ const send = (0, import_react.useCallback)(
128
+ (triggerName, input, sendOptions) => chat.send(triggerName, input, sendOptions),
129
+ [chat]
130
+ );
131
+ const stop = (0, import_react.useCallback)(() => chat.stop(), [chat]);
132
+ const retry = (0, import_react.useCallback)(() => chat.retry(), [chat]);
133
+ const observe = (0, import_react.useCallback)(() => chat.observe(), [chat]);
134
+ const replaceMessages = (0, import_react.useCallback)((msgs) => chat.replaceMessages(msgs), [chat]);
135
+ const uploadFiles2 = (0, import_react.useCallback)(
136
+ (files, onProgress) => chat.uploadFiles(files, onProgress),
137
+ [chat]
138
+ );
139
+ const connect = (0, import_react.useCallback)(
140
+ () => socketTransport?.connect() ?? Promise.resolve(),
141
+ [socketTransport]
142
+ );
143
+ const disconnect = (0, import_react.useCallback)(() => socketTransport?.disconnect(), [socketTransport]);
144
+ return {
145
+ messages,
146
+ status,
147
+ error,
148
+ sessionId,
149
+ connectionState,
150
+ connectionError,
151
+ pendingClientTools,
152
+ send,
153
+ stop,
154
+ retry,
155
+ observe,
156
+ replaceMessages,
157
+ canRetry,
158
+ connect: socketTransport ? connect : void 0,
159
+ disconnect: socketTransport ? disconnect : void 0,
160
+ uploadFiles: uploadFiles2
161
+ };
162
+ }
163
+
164
+ // src/index.ts
165
+ var import_client_sdk2 = require("@octavus/client-sdk");
166
+ // Annotate the CommonJS export names for ESM import in node:
167
+ 0 && (module.exports = {
168
+ AppError,
169
+ ConflictError,
170
+ ForbiddenError,
171
+ MAIN_THREAD,
172
+ NotFoundError,
173
+ OCTAVUS_SKILL_TOOLS,
174
+ OctavusChat,
175
+ OctavusError,
176
+ ValidationError,
177
+ createApiErrorEvent,
178
+ createErrorEvent,
179
+ createHttpTransport,
180
+ createInternalErrorEvent,
181
+ createPollingTransport,
182
+ createSocketTransport,
183
+ errorToStreamEvent,
184
+ generateId,
185
+ getSkillSlugFromToolCall,
186
+ isAbortError,
187
+ isAuthenticationError,
188
+ isFileReference,
189
+ isFileReferenceArray,
190
+ isMainThread,
191
+ isOctavusSkillTool,
192
+ isOtherThread,
193
+ isProviderError,
194
+ isRateLimitError,
195
+ isRetryableError,
196
+ isSocketTransport,
197
+ isToolError,
198
+ isValidationError,
199
+ parseSSEStream,
200
+ resolveThread,
201
+ safeParseStreamEvent,
202
+ safeParseUIMessage,
203
+ safeParseUIMessages,
204
+ threadForPart,
205
+ uploadFiles,
206
+ useOctavusChat
207
+ });
208
+ //# sourceMappingURL=index.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/hooks/use-octavus-chat.ts"],"sourcesContent":["export {\n useOctavusChat,\n type UseOctavusChatReturn,\n type OctavusChatOptions,\n type ChatStatus,\n type UserMessageInput,\n type ClientToolContext,\n type ClientToolHandler,\n type InteractiveTool,\n} from './hooks/use-octavus-chat';\n\nexport type * from '@octavus/client-sdk';\nexport {\n // Chat\n OctavusChat,\n // Files\n uploadFiles,\n // Stream\n parseSSEStream,\n // Transports\n createHttpTransport,\n createSocketTransport,\n isSocketTransport,\n createPollingTransport,\n // Error classes\n AppError,\n NotFoundError,\n ValidationError,\n ConflictError,\n ForbiddenError,\n OctavusError,\n // Error type guards\n isRateLimitError,\n isAuthenticationError,\n isProviderError,\n isToolError,\n isRetryableError,\n isValidationError,\n // Error event helpers\n createErrorEvent,\n errorToStreamEvent,\n createInternalErrorEvent,\n createApiErrorEvent,\n // Utilities\n generateId,\n isAbortError,\n // Thread helpers\n MAIN_THREAD,\n resolveThread,\n isMainThread,\n threadForPart,\n isOtherThread,\n // Type guards\n isFileReference,\n isFileReferenceArray,\n // Safe parse helpers\n safeParseStreamEvent,\n safeParseUIMessage,\n safeParseUIMessages,\n // Skills\n OCTAVUS_SKILL_TOOLS,\n isOctavusSkillTool,\n getSkillSlugFromToolCall,\n} from '@octavus/client-sdk';\n","'use client';\n\nimport { useRef, useCallback, useSyncExternalStore, useState, useEffect } from 'react';\nimport {\n OctavusChat,\n type OctavusError,\n isSocketTransport,\n type OctavusChatOptions,\n type ChatStatus,\n type UserMessageInput,\n type UIMessage,\n type Transport,\n type ConnectionState,\n type FileReference,\n type UploadFilesOptions,\n type UploadUrlsResponse,\n type ClientToolContext,\n type ClientToolHandler,\n type InteractiveTool,\n} from '@octavus/client-sdk';\n\nexport type {\n OctavusChatOptions,\n ChatStatus,\n UserMessageInput,\n FileReference,\n UploadFilesOptions,\n UploadUrlsResponse,\n ClientToolContext,\n ClientToolHandler,\n InteractiveTool,\n};\n\nexport interface UseOctavusChatReturn {\n /** All messages including the currently streaming one */\n messages: UIMessage[];\n /** Current status of the chat */\n status: ChatStatus;\n /**\n * Error if status is 'error'.\n * Contains structured error information including type, source, and retryability.\n * Use type guards like `isRateLimitError()` or `isProviderError()` to check specific error types.\n */\n error: OctavusError | null;\n /**\n * The current session/execution ID from the most recent `send()` call.\n * Updated when the server responds with a `start` event containing an execution ID.\n * Useful for tracking activity logs or debugging.\n *\n * For workers, this is the execution ID. For interactive sessions, this is the session ID.\n */\n sessionId: string | null;\n /**\n * Socket connection state (socket transport only).\n * For HTTP transport, this is always `undefined`.\n *\n * - `disconnected`: Not connected (initial state before first send)\n * - `connecting`: Connection attempt in progress\n * - `connected`: Successfully connected\n * - `error`: Connection failed (check `connectionError`)\n */\n connectionState: ConnectionState | undefined;\n /**\n * Connection error if `connectionState` is 'error'.\n */\n connectionError: Error | undefined;\n /**\n * Pending interactive tool calls keyed by tool name.\n * Each tool has bound `submit()` and `cancel()` methods.\n *\n * @example\n * ```tsx\n * const feedbackTools = pendingClientTools['request-feedback'] ?? [];\n *\n * {feedbackTools.map(tool => (\n * <FeedbackModal\n * key={tool.toolCallId}\n * {...tool.args}\n * onSubmit={(result) => tool.submit(result)}\n * onCancel={() => tool.cancel()}\n * />\n * ))}\n * ```\n */\n pendingClientTools: Record<string, InteractiveTool[]>;\n /**\n * Trigger the agent and optionally add a user message to the chat.\n *\n * @param triggerName - The trigger name defined in the agent's protocol.yaml\n * @param input - Input parameters for the trigger (variable substitutions)\n * @param options.userMessage - If provided, adds a user message to the chat before triggering\n */\n send: (\n triggerName: string,\n input?: Record<string, unknown>,\n options?: { userMessage?: UserMessageInput },\n ) => Promise<void>;\n /** Stop the current streaming and finalize any partial message */\n stop: () => void;\n /**\n * Retry the last trigger from the same starting point.\n * Rolls back messages, re-adds the user message (if any), and re-executes.\n * No-op if no trigger has been sent yet.\n */\n retry: () => Promise<void>;\n /**\n * Observe an already-active execution without triggering a new one.\n * Only works with transports that support `observe()` (e.g., polling transport).\n * Use when the page loads and the session is already streaming.\n */\n observe: () => Promise<void>;\n /**\n * Replace the message list with externally-provided messages.\n * Use to sync with server-authoritative state (e.g., multi-observer scenarios).\n * Must NOT be called while streaming.\n */\n replaceMessages: (messages: UIMessage[]) => void;\n /**\n * Whether `retry()` can be called.\n * True when a trigger has been sent and the chat is not currently streaming or awaiting input.\n */\n canRetry: boolean;\n /**\n * Eagerly connect to the socket (socket transport only).\n * Returns a promise that resolves when connected or rejects on error.\n * Safe to call multiple times - subsequent calls resolve immediately if already connected.\n *\n * For HTTP transport, this is `undefined`.\n */\n connect: (() => Promise<void>) | undefined;\n /**\n * Disconnect the socket (socket transport only).\n * The transport will reconnect automatically on next send().\n *\n * For HTTP transport, this is `undefined`.\n */\n disconnect: (() => void) | undefined;\n /**\n * Upload files directly without sending a message.\n * Useful for showing upload progress before sending.\n *\n * @param files - Files to upload\n * @param onProgress - Optional progress callback\n * @returns Array of file references\n *\n * @example\n * ```typescript\n * const fileRefs = await uploadFiles(fileInput.files, (i, progress) => {\n * console.log(`File ${i}: ${progress}%`);\n * });\n * // Later...\n * await send('user-message', { FILES: fileRefs }, { userMessage: { files: fileRefs } });\n * ```\n */\n uploadFiles: (\n files: FileList | File[],\n onProgress?: (fileIndex: number, progress: number) => void,\n ) => Promise<FileReference[]>;\n}\n\n/**\n * React hook for interacting with Octavus agents.\n * Provides chat state management and streaming support.\n *\n * When the transport changes (e.g., sessionId changes), the hook automatically\n * reinitializes with a fresh chat instance. Use `initialMessages` if you need\n * to preserve messages across transport changes.\n *\n * @example Basic usage with HTTP transport\n * ```tsx\n * import { useOctavusChat, createHttpTransport } from '@octavus/react';\n *\n * function Chat({ sessionId }) {\n * const transport = useMemo(\n * () => createHttpTransport({\n * request: (payload, options) =>\n * fetch('/api/trigger', {\n * method: 'POST',\n * headers: { 'Content-Type': 'application/json' },\n * body: JSON.stringify({ sessionId, ...payload }),\n * signal: options?.signal,\n * }),\n * }),\n * [sessionId],\n * );\n *\n * const { messages, status, send } = useOctavusChat({ transport });\n *\n * return (\n * <div>\n * {messages.map((msg) => (\n * <Message key={msg.id} message={msg} />\n * ))}\n * <button onClick={() => send('user-message', { USER_MESSAGE: 'Hello' })}>\n * Send\n * </button>\n * </div>\n * );\n * }\n * ```\n *\n * @example Socket transport with eager connection\n * ```tsx\n * import { useOctavusChat, createSocketTransport } from '@octavus/react';\n *\n * function Chat() {\n * const transport = useMemo(\n * () => createSocketTransport({\n * connect: () => new Promise((resolve, reject) => {\n * const sock = new SockJS('/octavus');\n * sock.onopen = () => resolve(sock);\n * sock.onerror = () => reject(new Error('Connection failed'));\n * }),\n * }),\n * [],\n * );\n *\n * const { messages, status, send, connectionState, connect, disconnect } =\n * useOctavusChat({ transport });\n *\n * // Eager connection on mount\n * useEffect(() => {\n * connect?.();\n * return () => disconnect?.();\n * }, [connect, disconnect]);\n *\n * return (\n * <div>\n * <StatusIndicator state={connectionState} />\n * {messages.map((msg) => <Message key={msg.id} message={msg} />)}\n * </div>\n * );\n * }\n * ```\n */\nexport function useOctavusChat(options: OctavusChatOptions): UseOctavusChatReturn {\n const chatRef = useRef<OctavusChat | null>(null);\n const transportRef = useRef<Transport | null>(null);\n const [sessionId, setSessionId] = useState<string | null>(null);\n\n const sessionIdSetterRef = useRef(setSessionId);\n sessionIdSetterRef.current = setSessionId;\n\n if (transportRef.current !== options.transport) {\n chatRef.current?.stop();\n setSessionId(null);\n chatRef.current = new OctavusChat(options);\n transportRef.current = options.transport;\n }\n\n const chat = chatRef.current!;\n\n // Keep all mutable options (callbacks, tool handlers) fresh on every render.\n // This ensures handlers always reference the latest closures instead of going stale.\n chat.updateOptions({\n clientTools: options.clientTools,\n onError: options.onError,\n onFinish: options.onFinish,\n onStop: options.onStop,\n onResourceUpdate: options.onResourceUpdate,\n onStart: (id) => {\n sessionIdSetterRef.current(id);\n options.onStart?.(id);\n },\n requestUploadUrls: options.requestUploadUrls,\n uploadOptions: options.uploadOptions,\n });\n const transport = options.transport;\n\n const subscribe = useCallback((callback: () => void) => chat.subscribe(callback), [chat]);\n const getMessagesSnapshot = useCallback(() => chat.messages, [chat]);\n const getStatusSnapshot = useCallback(() => chat.status, [chat]);\n const getErrorSnapshot = useCallback(() => chat.error, [chat]);\n const getPendingClientToolsSnapshot = useCallback(() => chat.pendingClientTools, [chat]);\n const getCanRetrySnapshot = useCallback(() => chat.canRetry, [chat]);\n\n const messages = useSyncExternalStore(subscribe, getMessagesSnapshot, getMessagesSnapshot);\n const status = useSyncExternalStore(subscribe, getStatusSnapshot, getStatusSnapshot);\n const error = useSyncExternalStore(subscribe, getErrorSnapshot, getErrorSnapshot);\n const pendingClientTools = useSyncExternalStore(\n subscribe,\n getPendingClientToolsSnapshot,\n getPendingClientToolsSnapshot,\n );\n const canRetry = useSyncExternalStore(subscribe, getCanRetrySnapshot, getCanRetrySnapshot);\n\n const socketTransport = isSocketTransport(transport) ? transport : null;\n const [connectionState, setConnectionState] = useState<ConnectionState | undefined>(\n socketTransport?.connectionState,\n );\n const [connectionError, setConnectionError] = useState<Error | undefined>(undefined);\n\n useEffect(() => {\n if (!socketTransport) {\n setConnectionState(undefined);\n setConnectionError(undefined);\n return;\n }\n\n const unsubscribe = socketTransport.onConnectionStateChange((state, err) => {\n setConnectionState(state);\n setConnectionError(err);\n });\n\n return unsubscribe;\n }, [socketTransport]);\n\n const send = useCallback(\n (\n triggerName: string,\n input?: Record<string, unknown>,\n sendOptions?: { userMessage?: UserMessageInput },\n ) => chat.send(triggerName, input, sendOptions),\n [chat],\n );\n\n const stop = useCallback(() => chat.stop(), [chat]);\n const retry = useCallback(() => chat.retry(), [chat]);\n const observe = useCallback(() => chat.observe(), [chat]);\n const replaceMessages = useCallback((msgs: UIMessage[]) => chat.replaceMessages(msgs), [chat]);\n\n const uploadFiles = useCallback(\n (files: FileList | File[], onProgress?: (fileIndex: number, progress: number) => void) =>\n chat.uploadFiles(files, onProgress),\n [chat],\n );\n\n // Stable references for connect/disconnect (socket transport only)\n const connect = useCallback(\n () => socketTransport?.connect() ?? Promise.resolve(),\n [socketTransport],\n );\n const disconnect = useCallback(() => socketTransport?.disconnect(), [socketTransport]);\n\n return {\n messages,\n status,\n error,\n sessionId,\n connectionState,\n connectionError,\n pendingClientTools,\n send,\n stop,\n retry,\n observe,\n replaceMessages,\n canRetry,\n connect: socketTransport ? connect : undefined,\n disconnect: socketTransport ? disconnect : undefined,\n uploadFiles,\n };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEA,mBAA+E;AAC/E,wBAgBO;AAwNA,SAAS,eAAe,SAAmD;AAChF,QAAM,cAAU,qBAA2B,IAAI;AAC/C,QAAM,mBAAe,qBAAyB,IAAI;AAClD,QAAM,CAAC,WAAW,YAAY,QAAI,uBAAwB,IAAI;AAE9D,QAAM,yBAAqB,qBAAO,YAAY;AAC9C,qBAAmB,UAAU;AAE7B,MAAI,aAAa,YAAY,QAAQ,WAAW;AAC9C,YAAQ,SAAS,KAAK;AACtB,iBAAa,IAAI;AACjB,YAAQ,UAAU,IAAI,8BAAY,OAAO;AACzC,iBAAa,UAAU,QAAQ;AAAA,EACjC;AAEA,QAAM,OAAO,QAAQ;AAIrB,OAAK,cAAc;AAAA,IACjB,aAAa,QAAQ;AAAA,IACrB,SAAS,QAAQ;AAAA,IACjB,UAAU,QAAQ;AAAA,IAClB,QAAQ,QAAQ;AAAA,IAChB,kBAAkB,QAAQ;AAAA,IAC1B,SAAS,CAAC,OAAO;AACf,yBAAmB,QAAQ,EAAE;AAC7B,cAAQ,UAAU,EAAE;AAAA,IACtB;AAAA,IACA,mBAAmB,QAAQ;AAAA,IAC3B,eAAe,QAAQ;AAAA,EACzB,CAAC;AACD,QAAM,YAAY,QAAQ;AAE1B,QAAM,gBAAY,0BAAY,CAAC,aAAyB,KAAK,UAAU,QAAQ,GAAG,CAAC,IAAI,CAAC;AACxF,QAAM,0BAAsB,0BAAY,MAAM,KAAK,UAAU,CAAC,IAAI,CAAC;AACnE,QAAM,wBAAoB,0BAAY,MAAM,KAAK,QAAQ,CAAC,IAAI,CAAC;AAC/D,QAAM,uBAAmB,0BAAY,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC;AAC7D,QAAM,oCAAgC,0BAAY,MAAM,KAAK,oBAAoB,CAAC,IAAI,CAAC;AACvF,QAAM,0BAAsB,0BAAY,MAAM,KAAK,UAAU,CAAC,IAAI,CAAC;AAEnE,QAAM,eAAW,mCAAqB,WAAW,qBAAqB,mBAAmB;AACzF,QAAM,aAAS,mCAAqB,WAAW,mBAAmB,iBAAiB;AACnF,QAAM,YAAQ,mCAAqB,WAAW,kBAAkB,gBAAgB;AAChF,QAAM,yBAAqB;AAAA,IACzB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACA,QAAM,eAAW,mCAAqB,WAAW,qBAAqB,mBAAmB;AAEzF,QAAM,sBAAkB,qCAAkB,SAAS,IAAI,YAAY;AACnE,QAAM,CAAC,iBAAiB,kBAAkB,QAAI;AAAA,IAC5C,iBAAiB;AAAA,EACnB;AACA,QAAM,CAAC,iBAAiB,kBAAkB,QAAI,uBAA4B,MAAS;AAEnF,8BAAU,MAAM;AACd,QAAI,CAAC,iBAAiB;AACpB,yBAAmB,MAAS;AAC5B,yBAAmB,MAAS;AAC5B;AAAA,IACF;AAEA,UAAM,cAAc,gBAAgB,wBAAwB,CAAC,OAAO,QAAQ;AAC1E,yBAAmB,KAAK;AACxB,yBAAmB,GAAG;AAAA,IACxB,CAAC;AAED,WAAO;AAAA,EACT,GAAG,CAAC,eAAe,CAAC;AAEpB,QAAM,WAAO;AAAA,IACX,CACE,aACA,OACA,gBACG,KAAK,KAAK,aAAa,OAAO,WAAW;AAAA,IAC9C,CAAC,IAAI;AAAA,EACP;AAEA,QAAM,WAAO,0BAAY,MAAM,KAAK,KAAK,GAAG,CAAC,IAAI,CAAC;AAClD,QAAM,YAAQ,0BAAY,MAAM,KAAK,MAAM,GAAG,CAAC,IAAI,CAAC;AACpD,QAAM,cAAU,0BAAY,MAAM,KAAK,QAAQ,GAAG,CAAC,IAAI,CAAC;AACxD,QAAM,sBAAkB,0BAAY,CAAC,SAAsB,KAAK,gBAAgB,IAAI,GAAG,CAAC,IAAI,CAAC;AAE7F,QAAMA,mBAAc;AAAA,IAClB,CAAC,OAA0B,eACzB,KAAK,YAAY,OAAO,UAAU;AAAA,IACpC,CAAC,IAAI;AAAA,EACP;AAGA,QAAM,cAAU;AAAA,IACd,MAAM,iBAAiB,QAAQ,KAAK,QAAQ,QAAQ;AAAA,IACpD,CAAC,eAAe;AAAA,EAClB;AACA,QAAM,iBAAa,0BAAY,MAAM,iBAAiB,WAAW,GAAG,CAAC,eAAe,CAAC;AAErF,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,SAAS,kBAAkB,UAAU;AAAA,IACrC,YAAY,kBAAkB,aAAa;AAAA,IAC3C,aAAAA;AAAA,EACF;AACF;;;ADpVA,IAAAC,qBAmDO;","names":["uploadFiles","import_client_sdk"]}
@@ -0,0 +1,203 @@
1
+ import { OctavusChatOptions, UIMessage, ChatStatus, OctavusError, ConnectionState, InteractiveTool, UserMessageInput, FileReference } from '@octavus/client-sdk';
2
+ export * from '@octavus/client-sdk';
3
+ export { AppError, ChatStatus, ClientToolContext, ClientToolHandler, ConflictError, ForbiddenError, InteractiveTool, MAIN_THREAD, NotFoundError, OCTAVUS_SKILL_TOOLS, OctavusChat, OctavusChatOptions, OctavusError, UserMessageInput, ValidationError, createApiErrorEvent, createErrorEvent, createHttpTransport, createInternalErrorEvent, createPollingTransport, createSocketTransport, errorToStreamEvent, generateId, getSkillSlugFromToolCall, isAbortError, isAuthenticationError, isFileReference, isFileReferenceArray, isMainThread, isOctavusSkillTool, isOtherThread, isProviderError, isRateLimitError, isRetryableError, isSocketTransport, isToolError, isValidationError, parseSSEStream, resolveThread, safeParseStreamEvent, safeParseUIMessage, safeParseUIMessages, threadForPart, uploadFiles } from '@octavus/client-sdk';
4
+
5
+ interface UseOctavusChatReturn {
6
+ /** All messages including the currently streaming one */
7
+ messages: UIMessage[];
8
+ /** Current status of the chat */
9
+ status: ChatStatus;
10
+ /**
11
+ * Error if status is 'error'.
12
+ * Contains structured error information including type, source, and retryability.
13
+ * Use type guards like `isRateLimitError()` or `isProviderError()` to check specific error types.
14
+ */
15
+ error: OctavusError | null;
16
+ /**
17
+ * The current session/execution ID from the most recent `send()` call.
18
+ * Updated when the server responds with a `start` event containing an execution ID.
19
+ * Useful for tracking activity logs or debugging.
20
+ *
21
+ * For workers, this is the execution ID. For interactive sessions, this is the session ID.
22
+ */
23
+ sessionId: string | null;
24
+ /**
25
+ * Socket connection state (socket transport only).
26
+ * For HTTP transport, this is always `undefined`.
27
+ *
28
+ * - `disconnected`: Not connected (initial state before first send)
29
+ * - `connecting`: Connection attempt in progress
30
+ * - `connected`: Successfully connected
31
+ * - `error`: Connection failed (check `connectionError`)
32
+ */
33
+ connectionState: ConnectionState | undefined;
34
+ /**
35
+ * Connection error if `connectionState` is 'error'.
36
+ */
37
+ connectionError: Error | undefined;
38
+ /**
39
+ * Pending interactive tool calls keyed by tool name.
40
+ * Each tool has bound `submit()` and `cancel()` methods.
41
+ *
42
+ * @example
43
+ * ```tsx
44
+ * const feedbackTools = pendingClientTools['request-feedback'] ?? [];
45
+ *
46
+ * {feedbackTools.map(tool => (
47
+ * <FeedbackModal
48
+ * key={tool.toolCallId}
49
+ * {...tool.args}
50
+ * onSubmit={(result) => tool.submit(result)}
51
+ * onCancel={() => tool.cancel()}
52
+ * />
53
+ * ))}
54
+ * ```
55
+ */
56
+ pendingClientTools: Record<string, InteractiveTool[]>;
57
+ /**
58
+ * Trigger the agent and optionally add a user message to the chat.
59
+ *
60
+ * @param triggerName - The trigger name defined in the agent's protocol.yaml
61
+ * @param input - Input parameters for the trigger (variable substitutions)
62
+ * @param options.userMessage - If provided, adds a user message to the chat before triggering
63
+ */
64
+ send: (triggerName: string, input?: Record<string, unknown>, options?: {
65
+ userMessage?: UserMessageInput;
66
+ }) => Promise<void>;
67
+ /** Stop the current streaming and finalize any partial message */
68
+ stop: () => void;
69
+ /**
70
+ * Retry the last trigger from the same starting point.
71
+ * Rolls back messages, re-adds the user message (if any), and re-executes.
72
+ * No-op if no trigger has been sent yet.
73
+ */
74
+ retry: () => Promise<void>;
75
+ /**
76
+ * Observe an already-active execution without triggering a new one.
77
+ * Only works with transports that support `observe()` (e.g., polling transport).
78
+ * Use when the page loads and the session is already streaming.
79
+ */
80
+ observe: () => Promise<void>;
81
+ /**
82
+ * Replace the message list with externally-provided messages.
83
+ * Use to sync with server-authoritative state (e.g., multi-observer scenarios).
84
+ * Must NOT be called while streaming.
85
+ */
86
+ replaceMessages: (messages: UIMessage[]) => void;
87
+ /**
88
+ * Whether `retry()` can be called.
89
+ * True when a trigger has been sent and the chat is not currently streaming or awaiting input.
90
+ */
91
+ canRetry: boolean;
92
+ /**
93
+ * Eagerly connect to the socket (socket transport only).
94
+ * Returns a promise that resolves when connected or rejects on error.
95
+ * Safe to call multiple times - subsequent calls resolve immediately if already connected.
96
+ *
97
+ * For HTTP transport, this is `undefined`.
98
+ */
99
+ connect: (() => Promise<void>) | undefined;
100
+ /**
101
+ * Disconnect the socket (socket transport only).
102
+ * The transport will reconnect automatically on next send().
103
+ *
104
+ * For HTTP transport, this is `undefined`.
105
+ */
106
+ disconnect: (() => void) | undefined;
107
+ /**
108
+ * Upload files directly without sending a message.
109
+ * Useful for showing upload progress before sending.
110
+ *
111
+ * @param files - Files to upload
112
+ * @param onProgress - Optional progress callback
113
+ * @returns Array of file references
114
+ *
115
+ * @example
116
+ * ```typescript
117
+ * const fileRefs = await uploadFiles(fileInput.files, (i, progress) => {
118
+ * console.log(`File ${i}: ${progress}%`);
119
+ * });
120
+ * // Later...
121
+ * await send('user-message', { FILES: fileRefs }, { userMessage: { files: fileRefs } });
122
+ * ```
123
+ */
124
+ uploadFiles: (files: FileList | File[], onProgress?: (fileIndex: number, progress: number) => void) => Promise<FileReference[]>;
125
+ }
126
+ /**
127
+ * React hook for interacting with Octavus agents.
128
+ * Provides chat state management and streaming support.
129
+ *
130
+ * When the transport changes (e.g., sessionId changes), the hook automatically
131
+ * reinitializes with a fresh chat instance. Use `initialMessages` if you need
132
+ * to preserve messages across transport changes.
133
+ *
134
+ * @example Basic usage with HTTP transport
135
+ * ```tsx
136
+ * import { useOctavusChat, createHttpTransport } from '@octavus/react';
137
+ *
138
+ * function Chat({ sessionId }) {
139
+ * const transport = useMemo(
140
+ * () => createHttpTransport({
141
+ * request: (payload, options) =>
142
+ * fetch('/api/trigger', {
143
+ * method: 'POST',
144
+ * headers: { 'Content-Type': 'application/json' },
145
+ * body: JSON.stringify({ sessionId, ...payload }),
146
+ * signal: options?.signal,
147
+ * }),
148
+ * }),
149
+ * [sessionId],
150
+ * );
151
+ *
152
+ * const { messages, status, send } = useOctavusChat({ transport });
153
+ *
154
+ * return (
155
+ * <div>
156
+ * {messages.map((msg) => (
157
+ * <Message key={msg.id} message={msg} />
158
+ * ))}
159
+ * <button onClick={() => send('user-message', { USER_MESSAGE: 'Hello' })}>
160
+ * Send
161
+ * </button>
162
+ * </div>
163
+ * );
164
+ * }
165
+ * ```
166
+ *
167
+ * @example Socket transport with eager connection
168
+ * ```tsx
169
+ * import { useOctavusChat, createSocketTransport } from '@octavus/react';
170
+ *
171
+ * function Chat() {
172
+ * const transport = useMemo(
173
+ * () => createSocketTransport({
174
+ * connect: () => new Promise((resolve, reject) => {
175
+ * const sock = new SockJS('/octavus');
176
+ * sock.onopen = () => resolve(sock);
177
+ * sock.onerror = () => reject(new Error('Connection failed'));
178
+ * }),
179
+ * }),
180
+ * [],
181
+ * );
182
+ *
183
+ * const { messages, status, send, connectionState, connect, disconnect } =
184
+ * useOctavusChat({ transport });
185
+ *
186
+ * // Eager connection on mount
187
+ * useEffect(() => {
188
+ * connect?.();
189
+ * return () => disconnect?.();
190
+ * }, [connect, disconnect]);
191
+ *
192
+ * return (
193
+ * <div>
194
+ * <StatusIndicator state={connectionState} />
195
+ * {messages.map((msg) => <Message key={msg.id} message={msg} />)}
196
+ * </div>
197
+ * );
198
+ * }
199
+ * ```
200
+ */
201
+ declare function useOctavusChat(options: OctavusChatOptions): UseOctavusChatReturn;
202
+
203
+ export { type UseOctavusChatReturn, useOctavusChat };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@octavus/react",
3
- "version": "2.19.0",
3
+ "version": "2.20.0",
4
4
  "description": "React bindings for Octavus agents",
5
5
  "license": "MIT",
6
6
  "author": "Octavus AI <dev@octavus.ai>",
@@ -25,12 +25,19 @@
25
25
  ],
26
26
  "type": "module",
27
27
  "sideEffects": false,
28
- "main": "./dist/index.js",
28
+ "main": "./dist/index.cjs",
29
+ "module": "./dist/index.js",
29
30
  "types": "./dist/index.d.ts",
30
31
  "exports": {
31
32
  ".": {
32
- "types": "./dist/index.d.ts",
33
- "import": "./dist/index.js"
33
+ "import": {
34
+ "types": "./dist/index.d.ts",
35
+ "default": "./dist/index.js"
36
+ },
37
+ "require": {
38
+ "types": "./dist/index.d.cts",
39
+ "default": "./dist/index.cjs"
40
+ }
34
41
  }
35
42
  },
36
43
  "files": [
@@ -40,7 +47,7 @@
40
47
  "access": "public"
41
48
  },
42
49
  "dependencies": {
43
- "@octavus/client-sdk": "^2.19.0"
50
+ "@octavus/client-sdk": "^2.20.0"
44
51
  },
45
52
  "peerDependencies": {
46
53
  "react": ">=18.0.0"