@astralform/js 3.0.1 → 3.2.0

package/dist/index.d.cts

@@ -615,6 +615,19 @@ interface FeedbackResponse {
     comment: string | null;
     createdAt: string;
 }
+/** Reasoning effort a caller may request for a turn (client-side model selection). */
+type ReasoningEffort = "low" | "medium" | "high";
+/**
+ * The per-request model choice (client-side model selection). `provider` and
+ * `model` are paired — send both or neither; when omitted, the server reuses the
+ * conversation's last model or a connected-provider default.
+ */
+interface ModelChoiceOptions {
+    provider?: string;
+    model?: string;
+    reasoningEffort?: ReasoningEffort;
+    temperature?: number;
+}
 interface ChatStreamRequest {
     message?: string;
     conversation_id?: string;
@@ -626,6 +639,14 @@ interface ChatStreamRequest {
     agent_name?: string;
     enable_search?: boolean;
     plan_mode?: boolean;
+    /**
+     * Per-request model choice (client-side model selection), wire shape.
+     * `provider` and `model` are paired; omit to reuse the thread's last model.
+     */
+    provider?: string;
+    model?: string;
+    reasoning_effort?: ReasoningEffort;
+    temperature?: number;
 }
 interface ToolResultRequest {
     conversation_id: string;
@@ -697,7 +718,7 @@ interface ConversationEvent {
     event: string;
     data: Record<string, unknown>;
 }
-interface SendOptions$1 {
+interface SendOptions$1 extends ModelChoiceOptions {
     conversationId?: string;
     enabledClientTools?: string[];
     uploadIds?: string[];
@@ -705,6 +726,21 @@ interface SendOptions$1 {
     enableSearch?: boolean;
     planMode?: boolean;
 }
+/**
+ * A selectable model for one of the team's connected providers, from
+ * `GET /v1/models`. Backs the client-side model picker.
+ */
+interface ModelOption {
+    provider: string;
+    providerDisplay: string;
+    model: string;
+    thinking: boolean;
+    tools: boolean;
+    vision: boolean;
+    thinkingMode: string;
+    /** whether the model accepts a configurable reasoning effort (low/medium/high); false for always-on-thinking / think-tags models where effort is a no-op */
+    supportsEffort: boolean;
+}
 interface ConversationAsset {
     id: string;
     kind: "upload" | "output";
@@ -787,6 +823,13 @@ declare class AstralformClient {
      * which enumerates the team-level agents a signed-in user can open.
      */
     getAgents(): Promise<AgentInfo[]>;
+    /**
+     * List the models the caller may pick this turn — expanded from the curated
+     * catalog of the providers the team has connected (client-side model
+     * selection). Backs the composer's model picker. Scoped to the active agent
+     * via X-Agent-ID, same as {@link getAgentStatus}.
+     */
+    getModels(): Promise<ModelOption[]>;
     getSkills(): Promise<SkillInfo[]>;
     getConversationEvents(conversationId: string, jobId?: string): Promise<ConversationEvent[]>;
     submitToolResult(request: ToolResultRequest): Promise<void>;
@@ -1066,7 +1109,7 @@ declare function streamJobSSE(options: StreamJobSSEOptions): AsyncGenerator<Chat
  */
 
 type StreamState = "idle" | "streaming" | "restoring" | "detached";
-interface SendOptions {
+interface SendOptions extends ModelChoiceOptions {
     enableSearch?: boolean;
     agentName?: string;
     uploadIds?: string[];
@@ -1202,4 +1245,4 @@ declare function isEmbeddedResource(value: unknown): value is {
  */
 declare function parseEmbeddedResource(value: unknown): EmbeddedResource | null;
 
-export { type ActiveJob, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type DesktopStreamPayload, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, LLMNotConfiguredError, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type MyToolGrantsPage, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type SendOptions, ServerError, type SkillInfo, StreamAbortedError, type StreamJobSSEOptions, StreamManager, type StreamManagerEvent, type StreamState, type SubagentStartPayload, type SubagentStopPayload, type TaskStatus, type TeamAgentSummary, type TeamSummary, type TitleGeneratedPayload, type TodoItem, type TodoUpdatePayload, type ToolApprovalDecision, type ToolApprovalGrantedPayload, type ToolApprovalRequest, type ToolApprovalRequestedPayload, type ToolApprovalScope, type ToolCallRequest, type ToolDefinition, type ToolGrant, type ToolHandler, type ToolHarnessWarningPayload, type ToolPermissionDeniedPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, type WireBlockDelta, type WireBlockDeltaPayload, type WireBlockKind, type WireBlockStart, type WireBlockStatus, type WireBlockStop, type WireCustomEvent, type WireErrorEvent, type WireEvent, type WireInputArgDelta, type WireInputDelta, type WireKeepalive, type WireMessageStart, type WireMessageStop, type WireOutputDelta, type WireRetryEvent, type WireSignatureDelta, type WireStallWarning, type WireStatusDelta, type WireStopReason, type WireTextDelta, type WireThinkingDelta, type WorkspaceReadyPayload, generateId, isEmbeddedResource, mapSseToChat, parseEmbeddedResource, replayEvents, streamJobSSE, translateDelta };
+export { type ActiveJob, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type DesktopStreamPayload, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, LLMNotConfiguredError, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type ModelChoiceOptions, type ModelOption, type MyToolGrantsPage, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type ReasoningEffort, type SendOptions, ServerError, type SkillInfo, StreamAbortedError, type StreamJobSSEOptions, StreamManager, type StreamManagerEvent, type StreamState, type SubagentStartPayload, type SubagentStopPayload, type TaskStatus, type TeamAgentSummary, type TeamSummary, type TitleGeneratedPayload, type TodoItem, type TodoUpdatePayload, type ToolApprovalDecision, type ToolApprovalGrantedPayload, type ToolApprovalRequest, type ToolApprovalRequestedPayload, type ToolApprovalScope, type ToolCallRequest, type ToolDefinition, type ToolGrant, type ToolHandler, type ToolHarnessWarningPayload, type ToolPermissionDeniedPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, type WireBlockDelta, type WireBlockDeltaPayload, type WireBlockKind, type WireBlockStart, type WireBlockStatus, type WireBlockStop, type WireCustomEvent, type WireErrorEvent, type WireEvent, type WireInputArgDelta, type WireInputDelta, type WireKeepalive, type WireMessageStart, type WireMessageStop, type WireOutputDelta, type WireRetryEvent, type WireSignatureDelta, type WireStallWarning, type WireStatusDelta, type WireStopReason, type WireTextDelta, type WireThinkingDelta, type WorkspaceReadyPayload, generateId, isEmbeddedResource, mapSseToChat, parseEmbeddedResource, replayEvents, streamJobSSE, translateDelta };

package/dist/index.d.ts

@@ -615,6 +615,19 @@ interface FeedbackResponse {
     comment: string | null;
     createdAt: string;
 }
+/** Reasoning effort a caller may request for a turn (client-side model selection). */
+type ReasoningEffort = "low" | "medium" | "high";
+/**
+ * The per-request model choice (client-side model selection). `provider` and
+ * `model` are paired — send both or neither; when omitted, the server reuses the
+ * conversation's last model or a connected-provider default.
+ */
+interface ModelChoiceOptions {
+    provider?: string;
+    model?: string;
+    reasoningEffort?: ReasoningEffort;
+    temperature?: number;
+}
 interface ChatStreamRequest {
     message?: string;
     conversation_id?: string;
@@ -626,6 +639,14 @@ interface ChatStreamRequest {
     agent_name?: string;
     enable_search?: boolean;
     plan_mode?: boolean;
+    /**
+     * Per-request model choice (client-side model selection), wire shape.
+     * `provider` and `model` are paired; omit to reuse the thread's last model.
+     */
+    provider?: string;
+    model?: string;
+    reasoning_effort?: ReasoningEffort;
+    temperature?: number;
 }
 interface ToolResultRequest {
     conversation_id: string;
@@ -697,7 +718,7 @@ interface ConversationEvent {
     event: string;
     data: Record<string, unknown>;
 }
-interface SendOptions$1 {
+interface SendOptions$1 extends ModelChoiceOptions {
     conversationId?: string;
     enabledClientTools?: string[];
     uploadIds?: string[];
@@ -705,6 +726,21 @@ interface SendOptions$1 {
     enableSearch?: boolean;
     planMode?: boolean;
 }
+/**
+ * A selectable model for one of the team's connected providers, from
+ * `GET /v1/models`. Backs the client-side model picker.
+ */
+interface ModelOption {
+    provider: string;
+    providerDisplay: string;
+    model: string;
+    thinking: boolean;
+    tools: boolean;
+    vision: boolean;
+    thinkingMode: string;
+    /** whether the model accepts a configurable reasoning effort (low/medium/high); false for always-on-thinking / think-tags models where effort is a no-op */
+    supportsEffort: boolean;
+}
 interface ConversationAsset {
     id: string;
     kind: "upload" | "output";
@@ -787,6 +823,13 @@ declare class AstralformClient {
      * which enumerates the team-level agents a signed-in user can open.
      */
     getAgents(): Promise<AgentInfo[]>;
+    /**
+     * List the models the caller may pick this turn — expanded from the curated
+     * catalog of the providers the team has connected (client-side model
+     * selection). Backs the composer's model picker. Scoped to the active agent
+     * via X-Agent-ID, same as {@link getAgentStatus}.
+     */
+    getModels(): Promise<ModelOption[]>;
     getSkills(): Promise<SkillInfo[]>;
     getConversationEvents(conversationId: string, jobId?: string): Promise<ConversationEvent[]>;
     submitToolResult(request: ToolResultRequest): Promise<void>;
@@ -1066,7 +1109,7 @@ declare function streamJobSSE(options: StreamJobSSEOptions): AsyncGenerator<Chat
  */
 
 type StreamState = "idle" | "streaming" | "restoring" | "detached";
-interface SendOptions {
+interface SendOptions extends ModelChoiceOptions {
     enableSearch?: boolean;
     agentName?: string;
     uploadIds?: string[];
@@ -1202,4 +1245,4 @@ declare function isEmbeddedResource(value: unknown): value is {
  */
 declare function parseEmbeddedResource(value: unknown): EmbeddedResource | null;
 
-export { type ActiveJob, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type DesktopStreamPayload, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, LLMNotConfiguredError, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type MyToolGrantsPage, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type SendOptions, ServerError, type SkillInfo, StreamAbortedError, type StreamJobSSEOptions, StreamManager, type StreamManagerEvent, type StreamState, type SubagentStartPayload, type SubagentStopPayload, type TaskStatus, type TeamAgentSummary, type TeamSummary, type TitleGeneratedPayload, type TodoItem, type TodoUpdatePayload, type ToolApprovalDecision, type ToolApprovalGrantedPayload, type ToolApprovalRequest, type ToolApprovalRequestedPayload, type ToolApprovalScope, type ToolCallRequest, type ToolDefinition, type ToolGrant, type ToolHandler, type ToolHarnessWarningPayload, type ToolPermissionDeniedPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, type WireBlockDelta, type WireBlockDeltaPayload, type WireBlockKind, type WireBlockStart, type WireBlockStatus, type WireBlockStop, type WireCustomEvent, type WireErrorEvent, type WireEvent, type WireInputArgDelta, type WireInputDelta, type WireKeepalive, type WireMessageStart, type WireMessageStop, type WireOutputDelta, type WireRetryEvent, type WireSignatureDelta, type WireStallWarning, type WireStatusDelta, type WireStopReason, type WireTextDelta, type WireThinkingDelta, type WorkspaceReadyPayload, generateId, isEmbeddedResource, mapSseToChat, parseEmbeddedResource, replayEvents, streamJobSSE, translateDelta };
+export { type ActiveJob, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type DesktopStreamPayload, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, LLMNotConfiguredError, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type ModelChoiceOptions, type ModelOption, type MyToolGrantsPage, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type ReasoningEffort, type SendOptions, ServerError, type SkillInfo, StreamAbortedError, type StreamJobSSEOptions, StreamManager, type StreamManagerEvent, type StreamState, type SubagentStartPayload, type SubagentStopPayload, type TaskStatus, type TeamAgentSummary, type TeamSummary, type TitleGeneratedPayload, type TodoItem, type TodoUpdatePayload, type ToolApprovalDecision, type ToolApprovalGrantedPayload, type ToolApprovalRequest, type ToolApprovalRequestedPayload, type ToolApprovalScope, type ToolCallRequest, type ToolDefinition, type ToolGrant, type ToolHandler, type ToolHarnessWarningPayload, type ToolPermissionDeniedPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, type WireBlockDelta, type WireBlockDeltaPayload, type WireBlockKind, type WireBlockStart, type WireBlockStatus, type WireBlockStop, type WireCustomEvent, type WireErrorEvent, type WireEvent, type WireInputArgDelta, type WireInputDelta, type WireKeepalive, type WireMessageStart, type WireMessageStop, type WireOutputDelta, type WireRetryEvent, type WireSignatureDelta, type WireStallWarning, type WireStatusDelta, type WireStopReason, type WireTextDelta, type WireThinkingDelta, type WorkspaceReadyPayload, generateId, isEmbeddedResource, mapSseToChat, parseEmbeddedResource, replayEvents, streamJobSSE, translateDelta };

package/dist/index.js

@@ -495,6 +495,29 @@ var AstralformClient = class {
       avatarUrl: a.avatar_url
     }));
   }
+  /**
+   * List the models the caller may pick this turn — expanded from the curated
+   * catalog of the providers the team has connected (client-side model
+   * selection). Backs the composer's model picker. Scoped to the active agent
+   * via X-Agent-ID, same as {@link getAgentStatus}.
+   */
+  async getModels() {
+    const raw = await this.get("/v1/models");
+    return raw.map((m) => ({
+      provider: m.provider,
+      providerDisplay: m.provider_display,
+      model: m.model,
+      thinking: m.thinking,
+      tools: m.tools,
+      vision: m.vision,
+      thinkingMode: m.thinking_mode,
+      // Coerce so the non-optional `supportsEffort: boolean` stays honest even
+      // against an older backend that omits `supports_effort` (→ false = safe:
+      // the effort control is hidden). Unlike the always-present siblings above,
+      // this field can be absent, so it's the one that needs coercion.
+      supportsEffort: Boolean(m.supports_effort)
+    }));
+  }
   async getSkills() {
     const raw = await this.get("/v1/skills");
     return raw.map((s) => ({
@@ -1246,6 +1269,11 @@ var ChatSession = class {
     this.emit({ type: "connected" });
   }
   async send(content, options) {
+    if (options?.provider == null !== (options?.model == null)) {
+      throw new Error(
+        "`provider` and `model` must be supplied together (client-side model selection)."
+      );
+    }
     if (this.isStreaming) return;
     const conversationId = options?.conversationId ?? this.conversationId ?? void 0;
     const userMessage = {
@@ -1270,7 +1298,12 @@ var ChatSession = class {
       upload_ids: options?.uploadIds,
       agent_name: options?.agentName,
       enable_search: options?.enableSearch,
-      plan_mode: options?.planMode
+      plan_mode: options?.planMode,
+      // Per-request model choice (client-side model selection).
+      provider: options?.provider,
+      model: options?.model,
+      reasoning_effort: options?.reasoningEffort,
+      temperature: options?.temperature
     };
     await this.processStream(request);
   }
@@ -1777,6 +1810,11 @@ var StreamManager = class {
   }
   // ── Send ──────────────────────────────────────────────────────
   async send(content, options) {
+    if (options?.provider == null !== (options?.model == null)) {
+      throw new Error(
+        "`provider` and `model` must be supplied together (client-side model selection)."
+      );
+    }
     if (this._state === "streaming") return;
     if (!this._activeConversationId) {
       const id = await this.session.createNewConversation();
@@ -1788,7 +1826,11 @@ var StreamManager = class {
         enableSearch: options?.enableSearch,
         agentName: options?.agentName,
         uploadIds: options?.uploadIds,
-        planMode: options?.planMode
+        planMode: options?.planMode,
+        provider: options?.provider,
+        model: options?.model,
+        reasoningEffort: options?.reasoningEffort,
+        temperature: options?.temperature
       });
     } catch {
     }