@sinas/sdk 0.7.0 → 0.8.0

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { QueryResult, FunctionResult, StateListResult, ChatMessageFull, ApprovalRequest, MessageContent, SinasConfig, SinasClient, AuthUser, InfoResponse, LoginResponse, OTPVerifyResponse, SinasClientOptions } from './client.cjs';
-export { AgentBatchItem, ApprovalResult, AudioContentPart, AuthMode, BatchExecutionItem, BatchStatus, ChatCreateResult, ChatDetail, ChatMessage, Collection, ComponentContentPart, ContentPart, EnqueueFunctionOptions, EnqueueFunctionResult, FileContentPart, FileInfo, FileUploadRequest, FileUrlResult, ImageContentPart, LoginRequest, OTPVerifyRequest, PermissionCheckRequest, PermissionCheckResponse, PermissionCheckResult, RefreshResponse, SSEChunk, SinasAuthError, SinasClientAuth, SinasError, SinasNotFoundError, SinasPermissionError, SinasTimeoutError, StateGetResult, SubmitAgentBatchOptions, SubmitAgentBatchResult, SubmitFunctionBatchOptions, SubmitFunctionBatchResult, TextContentPart, ToolCallInfo, approveToolCall, cancelBatch, checkPermissions, createChat, enqueueFunction, executeFunction, executeQuery, generateFileUrl, getBatch, getChat, getInfo, getMe, listBatchExecutions, listCollections, listFiles, login, logout, refresh, sendMessage, stateDelete, stateGet, stateList, stateSet, streamFromChannel, streamMessage, submitAgentBatch, submitFunctionBatch, uploadFile, verifyOTP } from './client.cjs';
+import { QueryResult, FunctionResult, StateListResult, ChatMessageFull, ApprovalRequest, PendingInput, MessageContent, SinasConfig, SinasClient, AuthUser, InfoResponse, LoginResponse, OTPVerifyResponse, SinasClientOptions } from './client.cjs';
+export { AgentBatchItem, AnswerPendingInputOptions, ApprovalResult, ApprovalResume, ApproveToolCallOptions, AudioContentPart, AuthMode, BatchExecutionItem, BatchStatus, ChatCreateResult, ChatDetail, ChatMessage, Collection, ComponentContentPart, ContentPart, EnqueueFunctionOptions, EnqueueFunctionResult, FileContentPart, FileInfo, FileUploadRequest, FileUrlResult, ImageContentPart, InputRequiredEvent, InvokeOptions, InvokeResult, LoginRequest, MessageSendResult, OTPVerifyRequest, PendingInputAnswerAccepted, PendingInputAnswerResult, PermissionCheckRequest, PermissionCheckResponse, PermissionCheckResult, RefreshResponse, RoundSuspendedEvent, SSEChunk, SinasAuthError, SinasClientAuth, SinasError, SinasNotFoundError, SinasPermissionError, SinasTimeoutError, StateGetResult, StreamDone, StreamFromChannelOptions, StreamOptions, SubmitAgentBatchOptions, SubmitAgentBatchResult, SubmitFunctionBatchOptions, SubmitFunctionBatchResult, TextContentPart, ToolCallInfo, TurnState, TurnStatus, TurnUsage, answerPendingInput, answerResumeChannel, approvalResumeChannel, approveToolCall, cancelBatch, checkPermissions, createChat, enqueueFunction, executeFunction, executeQuery, generateFileUrl, getBatch, getChat, getInfo, getMe, invokeAgent, listBatchExecutions, listCollections, listFiles, listPendingInputs, login, logout, parsePendingInput, parsePendingInputs, pendingInputFromChunk, refresh, sendMessage, stateDelete, stateGet, stateList, stateSet, streamFromChannel, streamMessage, submitAgentBatch, submitFunctionBatch, uploadFile, verifyOTP } from './client.cjs';
 import React from 'react';
 
 interface UseQueryOptions {
@@ -54,6 +54,28 @@ interface ToolStatus {
     description: string;
     status: 'running' | 'complete';
 }
+/**
+ * The model's thinking during the current turn. Thinking isn't stored with
+ * the messages, so it is only known while (and after) streaming the turn;
+ * it resets when the next turn starts.
+ */
+interface ChatThinking {
+    /** The model is thinking right now (before its answer or next tool call). */
+    active: boolean;
+    /**
+     * The thinking text so far this turn; only sent with `includeThinking`
+     * (otherwise always ''). Thinking rounds are separated by a blank line.
+     */
+    text: string;
+}
+interface ApproveOptions {
+    /** Approve this tool for the rest of the chat: it won't ask again (Sinas 0.5+). */
+    alwaysAllow?: boolean;
+}
+interface FollowOptions {
+    /** Last received stream entry id to resume after (default: from the start). */
+    lastId?: string;
+}
 interface UseChatResult {
     chatId: string | null;
     messages: ChatSessionMessage[];
@@ -61,16 +83,52 @@ interface UseChatResult {
     streaming: boolean;
     error: string | null;
     pendingApprovals: ApprovalRequest[];
+    /**
+     * The ask_user questions the conversation waits on (Sinas 0.5+): from
+     * `input_required` stream events and from the chat as loaded. Answer with
+     * `answer`.
+     */
+    pendingInputs: PendingInput[];
+    /** The model's thinking in the current turn (see `includeThinking`). */
+    thinking: ChatThinking;
     toolStatus: ToolStatus[];
     send: (content: MessageContent) => void;
-    approve: (toolCallId: string) => void;
+    /**
+     * Approve a tool call. When other calls of the same round still wait for a
+     * decision, nothing streams until the last one is decided.
+     */
+    approve: (toolCallId: string, options?: ApproveOptions) => void;
     reject: (toolCallId: string) => void;
+    /**
+     * Answer an ask_user question. Resolves true once the answer is recorded
+     * (the question is then removed from `pendingInputs`), false when it
+     * failed (see `error`). When it was the round's last open question, the
+     * resumed turn streams into `messages`.
+     */
+    answer: (toolCallId: string, answer: string) => Promise<boolean>;
+    /**
+     * Stream a channel into this session: a turn that goes on elsewhere (an
+     * `in_progress` result, a reconnect to a running turn).
+     */
+    follow: (channelId: string, options?: FollowOptions) => void;
     stop: () => void;
     clearError: () => void;
 }
 interface UseChatOptions {
     chatId?: string;
     input?: Record<string, unknown>;
+    /**
+     * Stream the model's thinking text into `thinking.text` (Sinas 0.5+).
+     * Without it, `thinking.active` still says when the model is thinking.
+     */
+    includeThinking?: boolean;
+    /**
+     * While questions wait with no stream open, re-read the chat periodically
+     * and just after the earliest deadline, so an expired question (the round
+     * then resumes server-side) or one answered elsewhere shows up without a
+     * reload. Default true.
+     */
+    pollPendingInputs?: boolean;
 }
 declare function useChat(agentRef: string, options?: UseChatOptions): UseChatResult;
 
@@ -129,4 +187,4 @@ interface SinasProviderProps {
 declare function SinasProvider({ client, options, children }: SinasProviderProps): React.FunctionComponentElement<React.ProviderProps<SinasClient | null>>;
 declare function useClient(): SinasClient;
 
-export { ApprovalRequest, type AuthStatus, AuthUser, ChatMessageFull, type ChatSessionMessage, FunctionResult, InfoResponse, LoginResponse, MessageContent, OTPVerifyResponse, QueryResult, SinasClient, SinasClientOptions, SinasConfig, SinasProvider, type SinasProviderProps, StateListResult, type ToolResult, type ToolStatus, type UseAuthOptions, type UseAuthResult, type UseChatOptions, type UseChatResult, type UseExecuteResult, type UseQueryOptions, type UseQueryResult, type UseSinasResult, type UseStateStoreOptions, type UseStateStoreResult, useAuth, useChat, useClient, useExecute, useQuery, useSinas, useStateStore };
+export { ApprovalRequest, type ApproveOptions, type AuthStatus, AuthUser, ChatMessageFull, type ChatSessionMessage, type ChatThinking, type FollowOptions, FunctionResult, InfoResponse, LoginResponse, MessageContent, OTPVerifyResponse, PendingInput, QueryResult, SinasClient, SinasClientOptions, SinasConfig, SinasProvider, type SinasProviderProps, StateListResult, type ToolResult, type ToolStatus, type UseAuthOptions, type UseAuthResult, type UseChatOptions, type UseChatResult, type UseExecuteResult, type UseQueryOptions, type UseQueryResult, type UseSinasResult, type UseStateStoreOptions, type UseStateStoreResult, useAuth, useChat, useClient, useExecute, useQuery, useSinas, useStateStore };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { QueryResult, FunctionResult, StateListResult, ChatMessageFull, ApprovalRequest, MessageContent, SinasConfig, SinasClient, AuthUser, InfoResponse, LoginResponse, OTPVerifyResponse, SinasClientOptions } from './client.js';
-export { AgentBatchItem, ApprovalResult, AudioContentPart, AuthMode, BatchExecutionItem, BatchStatus, ChatCreateResult, ChatDetail, ChatMessage, Collection, ComponentContentPart, ContentPart, EnqueueFunctionOptions, EnqueueFunctionResult, FileContentPart, FileInfo, FileUploadRequest, FileUrlResult, ImageContentPart, LoginRequest, OTPVerifyRequest, PermissionCheckRequest, PermissionCheckResponse, PermissionCheckResult, RefreshResponse, SSEChunk, SinasAuthError, SinasClientAuth, SinasError, SinasNotFoundError, SinasPermissionError, SinasTimeoutError, StateGetResult, SubmitAgentBatchOptions, SubmitAgentBatchResult, SubmitFunctionBatchOptions, SubmitFunctionBatchResult, TextContentPart, ToolCallInfo, approveToolCall, cancelBatch, checkPermissions, createChat, enqueueFunction, executeFunction, executeQuery, generateFileUrl, getBatch, getChat, getInfo, getMe, listBatchExecutions, listCollections, listFiles, login, logout, refresh, sendMessage, stateDelete, stateGet, stateList, stateSet, streamFromChannel, streamMessage, submitAgentBatch, submitFunctionBatch, uploadFile, verifyOTP } from './client.js';
+import { QueryResult, FunctionResult, StateListResult, ChatMessageFull, ApprovalRequest, PendingInput, MessageContent, SinasConfig, SinasClient, AuthUser, InfoResponse, LoginResponse, OTPVerifyResponse, SinasClientOptions } from './client.js';
+export { AgentBatchItem, AnswerPendingInputOptions, ApprovalResult, ApprovalResume, ApproveToolCallOptions, AudioContentPart, AuthMode, BatchExecutionItem, BatchStatus, ChatCreateResult, ChatDetail, ChatMessage, Collection, ComponentContentPart, ContentPart, EnqueueFunctionOptions, EnqueueFunctionResult, FileContentPart, FileInfo, FileUploadRequest, FileUrlResult, ImageContentPart, InputRequiredEvent, InvokeOptions, InvokeResult, LoginRequest, MessageSendResult, OTPVerifyRequest, PendingInputAnswerAccepted, PendingInputAnswerResult, PermissionCheckRequest, PermissionCheckResponse, PermissionCheckResult, RefreshResponse, RoundSuspendedEvent, SSEChunk, SinasAuthError, SinasClientAuth, SinasError, SinasNotFoundError, SinasPermissionError, SinasTimeoutError, StateGetResult, StreamDone, StreamFromChannelOptions, StreamOptions, SubmitAgentBatchOptions, SubmitAgentBatchResult, SubmitFunctionBatchOptions, SubmitFunctionBatchResult, TextContentPart, ToolCallInfo, TurnState, TurnStatus, TurnUsage, answerPendingInput, answerResumeChannel, approvalResumeChannel, approveToolCall, cancelBatch, checkPermissions, createChat, enqueueFunction, executeFunction, executeQuery, generateFileUrl, getBatch, getChat, getInfo, getMe, invokeAgent, listBatchExecutions, listCollections, listFiles, listPendingInputs, login, logout, parsePendingInput, parsePendingInputs, pendingInputFromChunk, refresh, sendMessage, stateDelete, stateGet, stateList, stateSet, streamFromChannel, streamMessage, submitAgentBatch, submitFunctionBatch, uploadFile, verifyOTP } from './client.js';
 import React from 'react';
 
 interface UseQueryOptions {
@@ -54,6 +54,28 @@ interface ToolStatus {
     description: string;
     status: 'running' | 'complete';
 }
+/**
+ * The model's thinking during the current turn. Thinking isn't stored with
+ * the messages, so it is only known while (and after) streaming the turn;
+ * it resets when the next turn starts.
+ */
+interface ChatThinking {
+    /** The model is thinking right now (before its answer or next tool call). */
+    active: boolean;
+    /**
+     * The thinking text so far this turn; only sent with `includeThinking`
+     * (otherwise always ''). Thinking rounds are separated by a blank line.
+     */
+    text: string;
+}
+interface ApproveOptions {
+    /** Approve this tool for the rest of the chat: it won't ask again (Sinas 0.5+). */
+    alwaysAllow?: boolean;
+}
+interface FollowOptions {
+    /** Last received stream entry id to resume after (default: from the start). */
+    lastId?: string;
+}
 interface UseChatResult {
     chatId: string | null;
     messages: ChatSessionMessage[];
@@ -61,16 +83,52 @@ interface UseChatResult {
     streaming: boolean;
     error: string | null;
     pendingApprovals: ApprovalRequest[];
+    /**
+     * The ask_user questions the conversation waits on (Sinas 0.5+): from
+     * `input_required` stream events and from the chat as loaded. Answer with
+     * `answer`.
+     */
+    pendingInputs: PendingInput[];
+    /** The model's thinking in the current turn (see `includeThinking`). */
+    thinking: ChatThinking;
     toolStatus: ToolStatus[];
     send: (content: MessageContent) => void;
-    approve: (toolCallId: string) => void;
+    /**
+     * Approve a tool call. When other calls of the same round still wait for a
+     * decision, nothing streams until the last one is decided.
+     */
+    approve: (toolCallId: string, options?: ApproveOptions) => void;
     reject: (toolCallId: string) => void;
+    /**
+     * Answer an ask_user question. Resolves true once the answer is recorded
+     * (the question is then removed from `pendingInputs`), false when it
+     * failed (see `error`). When it was the round's last open question, the
+     * resumed turn streams into `messages`.
+     */
+    answer: (toolCallId: string, answer: string) => Promise<boolean>;
+    /**
+     * Stream a channel into this session: a turn that goes on elsewhere (an
+     * `in_progress` result, a reconnect to a running turn).
+     */
+    follow: (channelId: string, options?: FollowOptions) => void;
     stop: () => void;
     clearError: () => void;
 }
 interface UseChatOptions {
     chatId?: string;
     input?: Record<string, unknown>;
+    /**
+     * Stream the model's thinking text into `thinking.text` (Sinas 0.5+).
+     * Without it, `thinking.active` still says when the model is thinking.
+     */
+    includeThinking?: boolean;
+    /**
+     * While questions wait with no stream open, re-read the chat periodically
+     * and just after the earliest deadline, so an expired question (the round
+     * then resumes server-side) or one answered elsewhere shows up without a
+     * reload. Default true.
+     */
+    pollPendingInputs?: boolean;
 }
 declare function useChat(agentRef: string, options?: UseChatOptions): UseChatResult;
 
@@ -129,4 +187,4 @@ interface SinasProviderProps {
 declare function SinasProvider({ client, options, children }: SinasProviderProps): React.FunctionComponentElement<React.ProviderProps<SinasClient | null>>;
 declare function useClient(): SinasClient;
 
-export { ApprovalRequest, type AuthStatus, AuthUser, ChatMessageFull, type ChatSessionMessage, FunctionResult, InfoResponse, LoginResponse, MessageContent, OTPVerifyResponse, QueryResult, SinasClient, SinasClientOptions, SinasConfig, SinasProvider, type SinasProviderProps, StateListResult, type ToolResult, type ToolStatus, type UseAuthOptions, type UseAuthResult, type UseChatOptions, type UseChatResult, type UseExecuteResult, type UseQueryOptions, type UseQueryResult, type UseSinasResult, type UseStateStoreOptions, type UseStateStoreResult, useAuth, useChat, useClient, useExecute, useQuery, useSinas, useStateStore };
+export { ApprovalRequest, type ApproveOptions, type AuthStatus, AuthUser, ChatMessageFull, type ChatSessionMessage, type ChatThinking, type FollowOptions, FunctionResult, InfoResponse, LoginResponse, MessageContent, OTPVerifyResponse, PendingInput, QueryResult, SinasClient, SinasClientOptions, SinasConfig, SinasProvider, type SinasProviderProps, StateListResult, type ToolResult, type ToolStatus, type UseAuthOptions, type UseAuthResult, type UseChatOptions, type UseChatResult, type UseExecuteResult, type UseQueryOptions, type UseQueryResult, type UseSinasResult, type UseStateStoreOptions, type UseStateStoreResult, useAuth, useChat, useClient, useExecute, useQuery, useSinas, useStateStore };