@astralform/js 6.0.4 → 7.1.0

package/dist/index.d.cts

@@ -683,8 +683,47 @@ 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";
+/**
+ * One rung on a model's thinking ladder.
+ *
+ * These strings are not ours to choose: they are verbatim what OpenAI,
+ * DeepSeek and Z.AI each enumerate when rejecting an invalid
+ * `reasoning_effort`, so renaming one means sending a value the provider 400s
+ * on. A given model accepts a SUBSET — read it from
+ * {@link ModelOption.thinkingControl}, never assume all seven.
+ *
+ * `"none"` is a real off on the providers that list it, and is distinct from
+ * omitting the effort entirely: omitting means "use the model's own default",
+ * which on some models still reasons.
+ */
+type EffortRung = "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max";
+/**
+ * A reasoning effort a caller may request. Widened from `low | medium | high`
+ * once the providers were probed and shown to expose seven values.
+ */
+type ReasoningEffort = EffortRung;
+/** One selectable rung, with the label every client should display for it. */
+interface ThinkingRungOption {
+    id: EffortRung;
+    /** Server-owned, so two clients cannot word the same rung differently. */
+    label: string;
+}
+/**
+ * A model's thinking control, from `GET /v1/models`.
+ *
+ * `ladder` runs least-effort-first. That order is the menu order and the basis
+ * of any proportional indicator — a rung's INDEX is its strength. It contains a
+ * `none` rung if and only if the model can genuinely stop reasoning, so an Off
+ * is an ordinary rung rather than something a client synthesizes.
+ *
+ * `default` is the rung a run uses when the caller picks nothing, and is
+ * nullable: for the OpenAI-style family the server sends no effort at all, so
+ * the choice belongs to the provider and naming a rung would be a guess.
+ */
+interface ThinkingDescriptor {
+    ladder: ThinkingRungOption[];
+    default: EffortRung | null;
+}
 /**
  * The per-request model choice (client-side model selection). `provider` and
  * `model` are paired — send both or neither; when omitted, the server reuses the
@@ -865,9 +904,29 @@ interface ModelOption {
     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;
+    /**
+     * The model's thinking control, or absent when it has none.
+     *
+     * Its ABSENCE is the signal to render no control — that replaces a separate
+     * `supportsEffort` flag which had to be kept consistent with the level list
+     * beside it. Distinct from `thinking` above, which says only whether the
+     * model reasons at all: a model can reason with no control a client can
+     * drive.
+     */
+    thinkingControl?: ThinkingDescriptor;
+    /** the provider's brand mark (picker tiles); null until the backend rollout / for icon-less providers */
+    iconUrl?: string | null;
+    /** when the CALLER last ran this model (picker "Recent" ordering); null for a never-used model */
+    lastUsedAt?: string | null;
+    /** how many times the caller has run this model; null alongside lastUsedAt */
+    useCount?: number | null;
+    /**
+     * The model's context window in tokens, as the serving provider reports it
+     * — which is not always the model's headline number (a provider may serve
+     * a smaller window than the model supports). Null when the backend does not
+     * state one.
+     */
+    contextWindow?: number | null;
 }
 interface ConversationAsset {
     id: string;
@@ -1757,4 +1816,4 @@ declare function isEmbeddedResource(value: unknown): value is {
  */
 declare function parseEmbeddedResource(value: unknown): EmbeddedResource | null;
 
-export { type ActiveJob, type AgentCapability, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, 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 NoteUpdatePayload, type PlanUpdatePayload, 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 };
+export { type ActiveJob, type AgentCapability, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, 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 EffortRung, 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 NoteUpdatePayload, type PlanUpdatePayload, 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 ThinkingDescriptor, type ThinkingRungOption, 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

@@ -683,8 +683,47 @@ 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";
+/**
+ * One rung on a model's thinking ladder.
+ *
+ * These strings are not ours to choose: they are verbatim what OpenAI,
+ * DeepSeek and Z.AI each enumerate when rejecting an invalid
+ * `reasoning_effort`, so renaming one means sending a value the provider 400s
+ * on. A given model accepts a SUBSET — read it from
+ * {@link ModelOption.thinkingControl}, never assume all seven.
+ *
+ * `"none"` is a real off on the providers that list it, and is distinct from
+ * omitting the effort entirely: omitting means "use the model's own default",
+ * which on some models still reasons.
+ */
+type EffortRung = "none" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max";
+/**
+ * A reasoning effort a caller may request. Widened from `low | medium | high`
+ * once the providers were probed and shown to expose seven values.
+ */
+type ReasoningEffort = EffortRung;
+/** One selectable rung, with the label every client should display for it. */
+interface ThinkingRungOption {
+    id: EffortRung;
+    /** Server-owned, so two clients cannot word the same rung differently. */
+    label: string;
+}
+/**
+ * A model's thinking control, from `GET /v1/models`.
+ *
+ * `ladder` runs least-effort-first. That order is the menu order and the basis
+ * of any proportional indicator — a rung's INDEX is its strength. It contains a
+ * `none` rung if and only if the model can genuinely stop reasoning, so an Off
+ * is an ordinary rung rather than something a client synthesizes.
+ *
+ * `default` is the rung a run uses when the caller picks nothing, and is
+ * nullable: for the OpenAI-style family the server sends no effort at all, so
+ * the choice belongs to the provider and naming a rung would be a guess.
+ */
+interface ThinkingDescriptor {
+    ladder: ThinkingRungOption[];
+    default: EffortRung | null;
+}
 /**
  * The per-request model choice (client-side model selection). `provider` and
  * `model` are paired — send both or neither; when omitted, the server reuses the
@@ -865,9 +904,29 @@ interface ModelOption {
     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;
+    /**
+     * The model's thinking control, or absent when it has none.
+     *
+     * Its ABSENCE is the signal to render no control — that replaces a separate
+     * `supportsEffort` flag which had to be kept consistent with the level list
+     * beside it. Distinct from `thinking` above, which says only whether the
+     * model reasons at all: a model can reason with no control a client can
+     * drive.
+     */
+    thinkingControl?: ThinkingDescriptor;
+    /** the provider's brand mark (picker tiles); null until the backend rollout / for icon-less providers */
+    iconUrl?: string | null;
+    /** when the CALLER last ran this model (picker "Recent" ordering); null for a never-used model */
+    lastUsedAt?: string | null;
+    /** how many times the caller has run this model; null alongside lastUsedAt */
+    useCount?: number | null;
+    /**
+     * The model's context window in tokens, as the serving provider reports it
+     * — which is not always the model's headline number (a provider may serve
+     * a smaller window than the model supports). Null when the backend does not
+     * state one.
+     */
+    contextWindow?: number | null;
 }
 interface ConversationAsset {
     id: string;
@@ -1757,4 +1816,4 @@ declare function isEmbeddedResource(value: unknown): value is {
  */
 declare function parseEmbeddedResource(value: unknown): EmbeddedResource | null;
 
-export { type ActiveJob, type AgentCapability, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, 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 NoteUpdatePayload, type PlanUpdatePayload, 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 };
+export { type ActiveJob, type AgentCapability, type AgentIdentity, type AgentInfo, type AgentStatus, type AssetCreatedPayload, type AstralformApiKeyConfig, AstralformClient, type AstralformConfig, AstralformError, type AstralformUserTokenConfig, type AttachmentStagedPayload, AuthenticationError, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, 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 EffortRung, 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 NoteUpdatePayload, type PlanUpdatePayload, 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 ThinkingDescriptor, type ThinkingRungOption, 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

@@ -578,20 +578,16 @@ var AstralformClient = class {
    */
   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)
-    }));
+    return raw.map((m) => {
+      const option = camelizeKeys(m);
+      return {
+        ...option,
+        iconUrl: option.iconUrl ?? null,
+        lastUsedAt: option.lastUsedAt ?? null,
+        useCount: option.useCount ?? null,
+        contextWindow: option.contextWindow ?? null
+      };
+    });
   }
   async getSkills() {
     const raw = await this.get("/v1/skills");