@astralform/js 9.2.0 → 9.3.0

package/dist/index.d.cts

@@ -1207,6 +1207,50 @@ interface ToolOutputStub {
 declare function isToolOutputStub(value: unknown): value is ToolOutputStub;
 /** How a restore asks for tool outputs. */
 type ToolOutputMode = "inline" | "stub";
+/**
+ * A tool's image preview the server declined to inline, with a handle to fetch it.
+ *
+ * Restore can ask for these with `toolImages: "stub"`. It replaces an entry of a
+ * `tool_use` final's `images` — and only that entry's `url`: `mime_type`,
+ * `width`, `height` and `bytes` survive, so a consumer can reserve the image's
+ * box before the bytes arrive and the transcript does not jump when they do.
+ * Resolve it with `client.getToolImage`.
+ *
+ * Previews are exempt from `toolOutputs: "stub"`, which is why this is its own
+ * opt-in: they are hoisted out of `output` precisely so a stubbed pill keeps its
+ * thumbnail, and on a picture-heavy conversation they were three quarters of
+ * the bytes a restore shipped before first render.
+ */
+interface ToolImageStub {
+    __stub: "tool_image";
+    call_id: string;
+    /** The entry's position in its call's `images` — what the fetch reads. */
+    index: number;
+    /**
+     * The job this call belongs to. The same rule as `ToolOutputStub.job_id`:
+     * a version-switched read returns superseded jobs the unscoped fetch cannot
+     * see. `getToolImage` takes the whole stub so it cannot be dropped.
+     */
+    job_id?: string;
+    mime_type?: string;
+    /** Pixel size of the preview, for reserving its box. */
+    width?: number;
+    height?: number;
+    /** Encoded size of the preview. */
+    bytes?: number;
+}
+/**
+ * Is this `images` entry a stub to fetch rather than a preview with a `url`?
+ *
+ * Checks every field the fetch is built from — `call_id` AND `index` — for the
+ * reason `isToolOutputStub` gives: narrowing on the marker alone hands a caller
+ * fields the type promises but the value lacks, and the next line puts them in
+ * a URL. The display fields are hints and are not required, so a stub missing
+ * its dimensions still resolves; it just cannot reserve its box.
+ */
+declare function isToolImageStub(value: unknown): value is ToolImageStub;
+/** How a restore asks for tool image previews. */
+type ToolImageMode = "inline" | "stub";
 interface ConversationEvent {
     seq: number;
     event: string;
@@ -1521,6 +1565,8 @@ declare class AstralformClient {
      */
     private getWithHeaders;
     get<T>(path: string): Promise<T>;
+    /** A GET whose body is binary. Read inside the race, for the reason above. */
+    private getBlob;
     post<T>(path: string, body: unknown): Promise<T>;
     patch<T>(path: string, body: unknown): Promise<T>;
     private del;
@@ -1619,6 +1665,7 @@ declare class AstralformClient {
     listSkillCommands(surface?: SlashCommandSurface): Promise<SlashCommand[]>;
     getConversationEvents(conversationId: string, jobId?: string, options?: {
         toolOutputs?: ToolOutputMode;
+        toolImages?: ToolImageMode;
     }): Promise<ConversationEvent[]>;
     /**
      * The full output behind a {@link ToolOutputStub}.
@@ -1640,6 +1687,20 @@ declare class AstralformClient {
      * Prefer the overload above, which takes the stub and cannot be got wrong.
      */
     getToolOutput(conversationId: string, callId: string, jobId?: string): Promise<unknown>;
+    /**
+     * The image behind a {@link ToolImageStub}, as a `Blob` of the preview's bytes.
+     *
+     * Takes the stub itself and nothing else — the `job_id` scoping that
+     * `getToolOutput`'s id form warns about cannot be dropped from a value that
+     * carries it. There is deliberately no by-ids form.
+     *
+     * A `Blob` rather than a URL because the route is authenticated: an `<img
+     * src>` cannot send the bearer token, so a browser consumer turns this into
+     * an object URL (`URL.createObjectURL`) and revokes it when the image
+     * unmounts. The response is `private, immutable`, so a repeat fetch of the
+     * same preview is served by the HTTP cache.
+     */
+    getToolImage(conversationId: string, stub: ToolImageStub): Promise<Blob>;
     submitToolResult(request: ToolResultRequest): Promise<void>;
     submitToolApproval(request: ToolApprovalRequest): Promise<void>;
     /**
@@ -2368,6 +2429,12 @@ declare class StreamManager {
      * Defaults to inline, so this is inert until a consumer opts in.
      */
     private toolOutputs;
+    /**
+     * Whether restore asks for tool image previews inline or as fetch handles.
+     * Separate from `toolOutputs` because the server keeps them separate — see
+     * `ToolImageStub` — and on the same one-setting-both-waves rule.
+     */
+    private toolImages;
     private _state;
     private _activeConversationId;
     private _backgroundJobs;
@@ -2407,6 +2474,21 @@ declare class StreamManager {
      * belongs, because that is what arrives in `final.output`.
      */
     setToolOutputMode(mode: ToolOutputMode): void;
+    /**
+     * Ask restore for stubbed image previews, fetched on demand.
+     *
+     * The same caution as `setToolOutputMode`, sharper: a consumer that cannot
+     * resolve one (`isToolImageStub`, `client.getToolImage`) finds an `images`
+     * entry with no `url` and draws a broken image where the preview was.
+     */
+    setToolImageMode(mode: ToolImageMode): void;
+    /**
+     * The ONE options object both event waves fetch with — the newest page and
+     * every `loadEarlierTurns` page. Built in one place so an opt-in added here
+     * reaches both by construction: two literals at two call sites is how one
+     * wave would silently keep asking for inline payloads.
+     */
+    private get eventFetchOptions();
     private emit;
     private setState;
     private attach;
@@ -2684,4 +2766,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 AvailableRepositories, type AvailableRepository, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, type CodeProject, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type ConversationJob, type ConversationJobAttachment, type DesktopStreamPayload, type EffortRung, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, type JobsPage, LLMNotConfiguredError, type MemoryProviderErrorPayload, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type MessagesPage, type ModelChoiceOptions, type ModelOption, type MyToolGrantsPage, type NestedLlmUsagePayload, type NoteUpdatePayload, type PlanUpdatePayload, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type ReasoningEffort, type SendOptions, ServerError, type SendOptions$1 as SessionSendOptions, type SkillInfo, type SlashCommand, type SlashCommandSurface, 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 ToolOutputMode, type ToolOutputStub, type ToolProgressPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type ToolSource, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, VOICE_POLISH_MODES, type VoiceConfig, type VoiceLLMMode, type VoicePolishEvent, type VoicePolishMode, type VoicePolishRequest, type VoiceTranscribeOptions, type VoiceTranscript, 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, isToolOutputStub, isVoiceLLMMode, isVoicePolishMode, mapSseToChat, parseEmbeddedResource, parseVoicePolishFrame, 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 AvailableRepositories, type AvailableRepository, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, type CodeProject, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type ConversationJob, type ConversationJobAttachment, type DesktopStreamPayload, type EffortRung, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, type JobsPage, LLMNotConfiguredError, type MemoryProviderErrorPayload, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type MessagesPage, type ModelChoiceOptions, type ModelOption, type MyToolGrantsPage, type NestedLlmUsagePayload, type NoteUpdatePayload, type PlanUpdatePayload, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type ReasoningEffort, type SendOptions, ServerError, type SendOptions$1 as SessionSendOptions, type SkillInfo, type SlashCommand, type SlashCommandSurface, 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 ToolImageMode, type ToolImageStub, type ToolOutputMode, type ToolOutputStub, type ToolProgressPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type ToolSource, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, VOICE_POLISH_MODES, type VoiceConfig, type VoiceLLMMode, type VoicePolishEvent, type VoicePolishMode, type VoicePolishRequest, type VoiceTranscribeOptions, type VoiceTranscript, 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, isToolImageStub, isToolOutputStub, isVoiceLLMMode, isVoicePolishMode, mapSseToChat, parseEmbeddedResource, parseVoicePolishFrame, replayEvents, streamJobSSE, translateDelta };

package/dist/index.d.ts

@@ -1207,6 +1207,50 @@ interface ToolOutputStub {
 declare function isToolOutputStub(value: unknown): value is ToolOutputStub;
 /** How a restore asks for tool outputs. */
 type ToolOutputMode = "inline" | "stub";
+/**
+ * A tool's image preview the server declined to inline, with a handle to fetch it.
+ *
+ * Restore can ask for these with `toolImages: "stub"`. It replaces an entry of a
+ * `tool_use` final's `images` — and only that entry's `url`: `mime_type`,
+ * `width`, `height` and `bytes` survive, so a consumer can reserve the image's
+ * box before the bytes arrive and the transcript does not jump when they do.
+ * Resolve it with `client.getToolImage`.
+ *
+ * Previews are exempt from `toolOutputs: "stub"`, which is why this is its own
+ * opt-in: they are hoisted out of `output` precisely so a stubbed pill keeps its
+ * thumbnail, and on a picture-heavy conversation they were three quarters of
+ * the bytes a restore shipped before first render.
+ */
+interface ToolImageStub {
+    __stub: "tool_image";
+    call_id: string;
+    /** The entry's position in its call's `images` — what the fetch reads. */
+    index: number;
+    /**
+     * The job this call belongs to. The same rule as `ToolOutputStub.job_id`:
+     * a version-switched read returns superseded jobs the unscoped fetch cannot
+     * see. `getToolImage` takes the whole stub so it cannot be dropped.
+     */
+    job_id?: string;
+    mime_type?: string;
+    /** Pixel size of the preview, for reserving its box. */
+    width?: number;
+    height?: number;
+    /** Encoded size of the preview. */
+    bytes?: number;
+}
+/**
+ * Is this `images` entry a stub to fetch rather than a preview with a `url`?
+ *
+ * Checks every field the fetch is built from — `call_id` AND `index` — for the
+ * reason `isToolOutputStub` gives: narrowing on the marker alone hands a caller
+ * fields the type promises but the value lacks, and the next line puts them in
+ * a URL. The display fields are hints and are not required, so a stub missing
+ * its dimensions still resolves; it just cannot reserve its box.
+ */
+declare function isToolImageStub(value: unknown): value is ToolImageStub;
+/** How a restore asks for tool image previews. */
+type ToolImageMode = "inline" | "stub";
 interface ConversationEvent {
     seq: number;
     event: string;
@@ -1521,6 +1565,8 @@ declare class AstralformClient {
      */
     private getWithHeaders;
     get<T>(path: string): Promise<T>;
+    /** A GET whose body is binary. Read inside the race, for the reason above. */
+    private getBlob;
     post<T>(path: string, body: unknown): Promise<T>;
     patch<T>(path: string, body: unknown): Promise<T>;
     private del;
@@ -1619,6 +1665,7 @@ declare class AstralformClient {
     listSkillCommands(surface?: SlashCommandSurface): Promise<SlashCommand[]>;
     getConversationEvents(conversationId: string, jobId?: string, options?: {
         toolOutputs?: ToolOutputMode;
+        toolImages?: ToolImageMode;
     }): Promise<ConversationEvent[]>;
     /**
      * The full output behind a {@link ToolOutputStub}.
@@ -1640,6 +1687,20 @@ declare class AstralformClient {
      * Prefer the overload above, which takes the stub and cannot be got wrong.
      */
     getToolOutput(conversationId: string, callId: string, jobId?: string): Promise<unknown>;
+    /**
+     * The image behind a {@link ToolImageStub}, as a `Blob` of the preview's bytes.
+     *
+     * Takes the stub itself and nothing else — the `job_id` scoping that
+     * `getToolOutput`'s id form warns about cannot be dropped from a value that
+     * carries it. There is deliberately no by-ids form.
+     *
+     * A `Blob` rather than a URL because the route is authenticated: an `<img
+     * src>` cannot send the bearer token, so a browser consumer turns this into
+     * an object URL (`URL.createObjectURL`) and revokes it when the image
+     * unmounts. The response is `private, immutable`, so a repeat fetch of the
+     * same preview is served by the HTTP cache.
+     */
+    getToolImage(conversationId: string, stub: ToolImageStub): Promise<Blob>;
     submitToolResult(request: ToolResultRequest): Promise<void>;
     submitToolApproval(request: ToolApprovalRequest): Promise<void>;
     /**
@@ -2368,6 +2429,12 @@ declare class StreamManager {
      * Defaults to inline, so this is inert until a consumer opts in.
      */
     private toolOutputs;
+    /**
+     * Whether restore asks for tool image previews inline or as fetch handles.
+     * Separate from `toolOutputs` because the server keeps them separate — see
+     * `ToolImageStub` — and on the same one-setting-both-waves rule.
+     */
+    private toolImages;
     private _state;
     private _activeConversationId;
     private _backgroundJobs;
@@ -2407,6 +2474,21 @@ declare class StreamManager {
      * belongs, because that is what arrives in `final.output`.
      */
     setToolOutputMode(mode: ToolOutputMode): void;
+    /**
+     * Ask restore for stubbed image previews, fetched on demand.
+     *
+     * The same caution as `setToolOutputMode`, sharper: a consumer that cannot
+     * resolve one (`isToolImageStub`, `client.getToolImage`) finds an `images`
+     * entry with no `url` and draws a broken image where the preview was.
+     */
+    setToolImageMode(mode: ToolImageMode): void;
+    /**
+     * The ONE options object both event waves fetch with — the newest page and
+     * every `loadEarlierTurns` page. Built in one place so an opt-in added here
+     * reaches both by construction: two literals at two call sites is how one
+     * wave would silently keep asking for inline payloads.
+     */
+    private get eventFetchOptions();
     private emit;
     private setState;
     private attach;
@@ -2684,4 +2766,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 AvailableRepositories, type AvailableRepository, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, type CodeProject, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type ConversationJob, type ConversationJobAttachment, type DesktopStreamPayload, type EffortRung, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, type JobsPage, LLMNotConfiguredError, type MemoryProviderErrorPayload, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type MessagesPage, type ModelChoiceOptions, type ModelOption, type MyToolGrantsPage, type NestedLlmUsagePayload, type NoteUpdatePayload, type PlanUpdatePayload, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type ReasoningEffort, type SendOptions, ServerError, type SendOptions$1 as SessionSendOptions, type SkillInfo, type SlashCommand, type SlashCommandSurface, 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 ToolOutputMode, type ToolOutputStub, type ToolProgressPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type ToolSource, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, VOICE_POLISH_MODES, type VoiceConfig, type VoiceLLMMode, type VoicePolishEvent, type VoicePolishMode, type VoicePolishRequest, type VoiceTranscribeOptions, type VoiceTranscript, 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, isToolOutputStub, isVoiceLLMMode, isVoicePolishMode, mapSseToChat, parseEmbeddedResource, parseVoicePolishFrame, 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 AvailableRepositories, type AvailableRepository, type BlockDeltaPayload, CONVERSATION_PAGE_SIZE, type ChatEvent, ChatEventType, type ChatEventTypeValue, ChatSession, type ChatStorage, type ChatStreamEvent, type ChatStreamRequest, type CodeProject, ConnectionError, type ContextUpdatePayload, type ContextWarningPayload, type Conversation, type ConversationAsset, type ConversationEvent, type ConversationJob, type ConversationJobAttachment, type DesktopStreamPayload, type EffortRung, type EmbeddedResource, type FeedbackRequest, type FeedbackResponse, InMemoryStorage, type JobCreateResponse, type JobStatus, type JobSummary, type JobsPage, LLMNotConfiguredError, type MemoryProviderErrorPayload, type MemoryRecallPayload, type MemoryRecord, type MemoryUpdatePayload, type Message, type MessagesPage, type ModelChoiceOptions, type ModelOption, type MyToolGrantsPage, type NestedLlmUsagePayload, type NoteUpdatePayload, type PlanUpdatePayload, type PromptSuggestionPayload, type ProtocolAdapter, ProtocolRegistry, RateLimitError, type RateLimitErrorDetails, type RawSseEvent, type ReasoningEffort, type SendOptions, ServerError, type SendOptions$1 as SessionSendOptions, type SkillInfo, type SlashCommand, type SlashCommandSurface, 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 ToolImageMode, type ToolImageStub, type ToolOutputMode, type ToolOutputStub, type ToolProgressPayload, ToolRegistry, type ToolResult, type ToolResultRequest, type ToolSource, type TurnUsage, type UIComponentsConfig, type UserUnavailablePayload, VOICE_POLISH_MODES, type VoiceConfig, type VoiceLLMMode, type VoicePolishEvent, type VoicePolishMode, type VoicePolishRequest, type VoiceTranscribeOptions, type VoiceTranscript, 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, isToolImageStub, isToolOutputStub, isVoiceLLMMode, isVoicePolishMode, mapSseToChat, parseEmbeddedResource, parseVoicePolishFrame, replayEvents, streamJobSSE, translateDelta };

package/dist/index.js

@@ -319,6 +319,11 @@ function isToolOutputStub(value) {
   const v = value;
   return v.__stub === "tool_output" && typeof v.call_id === "string" && v.call_id.length > 0;
 }
+function isToolImageStub(value) {
+  if (typeof value !== "object" || value === null) return false;
+  const v = value;
+  return v.__stub === "tool_image" && typeof v.call_id === "string" && v.call_id.length > 0 && typeof v.index === "number" && Number.isInteger(v.index) && v.index >= 0;
+}
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.astralform.ai";
@@ -642,6 +647,13 @@ var AstralformClient = class {
       return await response.json();
     });
   }
+  /** A GET whose body is binary. Read inside the race, for the reason above. */
+  async getBlob(path) {
+    return this.withDeadline(async (signal) => {
+      const response = await this.send("GET", path, void 0, signal);
+      return response.blob();
+    });
+  }
   async post(path, body) {
     return this.withDeadline(async (signal) => {
       const response = await this.send("POST", path, body, signal);
@@ -861,6 +873,7 @@ var AstralformClient = class {
     const params = new URLSearchParams();
     if (jobId) params.set("job_id", jobId);
     if (options?.toolOutputs === "stub") params.set("tool_outputs", "stub");
+    if (options?.toolImages === "stub") params.set("tool_images", "stub");
     const query = params.toString();
     return this.get(
       `/v1/conversations/${encodeURIComponent(conversationId)}/events${query ? `?${query}` : ""}`
@@ -875,6 +888,25 @@ var AstralformClient = class {
     );
     return res.output;
   }
+  /**
+   * The image behind a {@link ToolImageStub}, as a `Blob` of the preview's bytes.
+   *
+   * Takes the stub itself and nothing else — the `job_id` scoping that
+   * `getToolOutput`'s id form warns about cannot be dropped from a value that
+   * carries it. There is deliberately no by-ids form.
+   *
+   * A `Blob` rather than a URL because the route is authenticated: an `<img
+   * src>` cannot send the bearer token, so a browser consumer turns this into
+   * an object URL (`URL.createObjectURL`) and revokes it when the image
+   * unmounts. The response is `private, immutable`, so a repeat fetch of the
+   * same preview is served by the HTTP cache.
+   */
+  async getToolImage(conversationId, stub) {
+    const query = stub.job_id ? `?job_id=${encodeURIComponent(stub.job_id)}` : "";
+    return this.getBlob(
+      `/v1/conversations/${encodeURIComponent(conversationId)}/tool-output/${encodeURIComponent(stub.call_id)}/images/${stub.index}${query}`
+    );
+  }
   async submitToolResult(request) {
     await this.post("/v1/tool-result", request);
   }
@@ -2749,6 +2781,12 @@ var StreamManager = class _StreamManager {
      * Defaults to inline, so this is inert until a consumer opts in.
      */
     this.toolOutputs = "inline";
+    /**
+     * Whether restore asks for tool image previews inline or as fetch handles.
+     * Separate from `toolOutputs` because the server keeps them separate — see
+     * `ToolImageStub` — and on the same one-setting-both-waves rule.
+     */
+    this.toolImages = "inline";
     this._state = "idle";
     this._activeConversationId = null;
     this._backgroundJobs = /* @__PURE__ */ new Map();
@@ -2805,6 +2843,25 @@ var StreamManager = class _StreamManager {
   setToolOutputMode(mode) {
     this.toolOutputs = mode;
   }
+  /**
+   * Ask restore for stubbed image previews, fetched on demand.
+   *
+   * The same caution as `setToolOutputMode`, sharper: a consumer that cannot
+   * resolve one (`isToolImageStub`, `client.getToolImage`) finds an `images`
+   * entry with no `url` and draws a broken image where the preview was.
+   */
+  setToolImageMode(mode) {
+    this.toolImages = mode;
+  }
+  /**
+   * The ONE options object both event waves fetch with — the newest page and
+   * every `loadEarlierTurns` page. Built in one place so an opt-in added here
+   * reaches both by construction: two literals at two call sites is how one
+   * wave would silently keep asking for inline payloads.
+   */
+  get eventFetchOptions() {
+    return { toolOutputs: this.toolOutputs, toolImages: this.toolImages };
+  }
   emit(event) {
     for (const handler of this.handlers) {
       try {
@@ -3305,9 +3362,7 @@ var StreamManager = class _StreamManager {
       const boundary = this.oldestDrawnMessageId;
       const eventLists = await Promise.all(
         page.jobs.map(
-          (job) => session.client.getConversationEvents(conversationId, job.job_id, {
-            toolOutputs: this.toolOutputs
-          }).catch(() => [])
+          (job) => session.client.getConversationEvents(conversationId, job.job_id, this.eventFetchOptions).catch(() => [])
         )
       );
       if (stop()) return 0;
@@ -3428,9 +3483,7 @@ var StreamManager = class _StreamManager {
       });
       const eventLists = await Promise.all(
         replayableJobs.map(
-          (job) => this.session.client.getConversationEvents(conversationId, job.job_id, {
-            toolOutputs: this.toolOutputs
-          }).catch(() => [])
+          (job) => this.session.client.getConversationEvents(conversationId, job.job_id, this.eventFetchOptions).catch(() => [])
         )
       );
       if (stopReplay()) return false;
@@ -3578,6 +3631,7 @@ export {
   VOICE_POLISH_MODES,
   generateId,
   isEmbeddedResource,
+  isToolImageStub,
   isToolOutputStub,
   isVoiceLLMMode,
   isVoicePolishMode,