@astralform/js 4.7.0 → 4.9.0

package/dist/index.d.cts

@@ -19,6 +19,16 @@ interface TodoItem {
 interface TodoUpdatePayload {
     todos: TodoItem[];
 }
+/** The conversation's plan, as markdown, after the agent wrote or revised it.
+ *  Full body rather than a diff — `write_plan` replaces the document wholesale. */
+interface PlanUpdatePayload {
+    plan: string;
+}
+/** Names of the conversation's notes, after one was written or deleted.
+ *  Names only; bodies are unbounded and read on demand. */
+interface NoteUpdatePayload {
+    notes: string[];
+}
 interface TitleGeneratedPayload {
     title: string;
 }
@@ -188,6 +198,8 @@ declare const ChatEventType: {
     readonly UserMessage: "user_message";
     readonly TitleGenerated: "title_generated";
     readonly TodoUpdate: "todo_update";
+    readonly PlanUpdate: "plan_update";
+    readonly NoteUpdate: "note_update";
     readonly ContextUpdate: "context_update";
     readonly SubagentStart: "subagent_start";
     readonly SubagentStop: "subagent_stop";
@@ -285,6 +297,7 @@ interface WireMessageStop extends WireEnvelope {
         input_tokens?: number;
         output_tokens?: number;
         cached_tokens?: number;
+        cache_creation_tokens?: number;
     };
     ttfb_ms?: number | null;
     total_ms: number;
@@ -332,6 +345,8 @@ interface TurnUsage {
     inputTokens: number;
     outputTokens: number;
     cachedTokens: number;
+    /** Tokens written to the model's prompt cache (wire: `cache_creation_tokens`). */
+    cacheCreationTokens: number;
 }
 type BlockDeltaPayload = {
     channel: "text";
@@ -432,6 +447,20 @@ type ChatEvent = {
 } | {
     type: "todo_update";
     todos: TodoItem[];
+}
+/** The conversation's plan, as markdown, after the agent wrote or revised it.
+ *  Carries the FULL body rather than a diff: the backend replaces the plan
+ *  wholesale (`write_plan` — "Replaces any existing plan"), so a consumer that
+ *  merged deltas would drift from the stored document. */
+ | {
+    type: "plan_update";
+    plan: string;
+}
+/** Names of the conversation's notes, after one was written or deleted. Names
+ *  only — bodies are unbounded and read on demand. */
+ | {
+    type: "note_update";
+    notes: string[];
 } | {
     type: "context_update";
     context: Record<string, unknown>;
@@ -603,6 +632,8 @@ interface TeamAgentSummary {
     teamId: string;
     createdAt: string;
     updatedAt: string;
+    /** Agent avatar URL, when the team has set one (wire: `avatar_url`). */
+    avatarUrl?: string | null;
 }
 interface SkillInfo {
     name: string;
@@ -674,6 +705,7 @@ interface ChatStreamRequest {
     agent_name?: string;
     plan_mode?: boolean;
     image_mode?: boolean;
+    video_mode?: boolean;
     /**
      * Start a durable long-horizon goal for this run (goal mode). The backend mints
      * an agent_goal from this text and drives the run under a budget until the
@@ -779,6 +811,22 @@ interface SendOptions$1 extends ModelChoiceOptions {
      * The `image_mode` field itself is accepted from Astralform ≥ 0.59.0.
      */
     imageMode?: boolean;
+    /**
+     * Put this turn in video mode, attaching the video-generation tool.
+     *
+     * Off by default and per-message, for a sharper reason than images: a clip
+     * occupies one shared GPU for minutes, during which image generation on the
+     * same host cannot run at all. The tool is not attached unless this is set.
+     *
+     * Mutually exclusive with `imageMode` at the composer level — which is why a
+     * video turn also gets the image tool server-side: the user cannot select
+     * both, so the agent must be able to produce its own first frame.
+     *
+     * `generate_video` animates an EXISTING image; it cannot start from text, and
+     * the clip is silent. Gate the affordance on `AgentStatus.capabilities`
+     * (`video`), the same way image mode does.
+     */
+    videoMode?: boolean;
     /**
      * Start a durable long-horizon goal for this run (goal mode). The text becomes
      * the goal's objective; the backend keeps the agent working under a budget until
@@ -1308,6 +1356,13 @@ interface SendOptions extends ModelChoiceOptions {
      * provider. Gate the affordance on `AgentStatus.capabilities`.
      */
     imageMode?: boolean;
+    /**
+     * Attach the video-generation tool to this turn. Mutually exclusive with
+     * `imageMode` at the composer level. See `SendOptions.videoMode` in types.ts
+     * for the full rule — a clip animates an existing image, is silent, and holds
+     * one shared GPU for minutes, so it is per-message and off by default.
+     */
+    videoMode?: boolean;
     /**
      * Start a durable long-horizon goal for this run (goal mode) — the text is the
      * goal objective the backend drives to completion. Omit for a normal turn.
@@ -1470,4 +1525,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 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 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 };

package/dist/index.d.ts

@@ -19,6 +19,16 @@ interface TodoItem {
 interface TodoUpdatePayload {
     todos: TodoItem[];
 }
+/** The conversation's plan, as markdown, after the agent wrote or revised it.
+ *  Full body rather than a diff — `write_plan` replaces the document wholesale. */
+interface PlanUpdatePayload {
+    plan: string;
+}
+/** Names of the conversation's notes, after one was written or deleted.
+ *  Names only; bodies are unbounded and read on demand. */
+interface NoteUpdatePayload {
+    notes: string[];
+}
 interface TitleGeneratedPayload {
     title: string;
 }
@@ -188,6 +198,8 @@ declare const ChatEventType: {
     readonly UserMessage: "user_message";
     readonly TitleGenerated: "title_generated";
     readonly TodoUpdate: "todo_update";
+    readonly PlanUpdate: "plan_update";
+    readonly NoteUpdate: "note_update";
     readonly ContextUpdate: "context_update";
     readonly SubagentStart: "subagent_start";
     readonly SubagentStop: "subagent_stop";
@@ -285,6 +297,7 @@ interface WireMessageStop extends WireEnvelope {
         input_tokens?: number;
         output_tokens?: number;
         cached_tokens?: number;
+        cache_creation_tokens?: number;
     };
     ttfb_ms?: number | null;
     total_ms: number;
@@ -332,6 +345,8 @@ interface TurnUsage {
     inputTokens: number;
     outputTokens: number;
     cachedTokens: number;
+    /** Tokens written to the model's prompt cache (wire: `cache_creation_tokens`). */
+    cacheCreationTokens: number;
 }
 type BlockDeltaPayload = {
     channel: "text";
@@ -432,6 +447,20 @@ type ChatEvent = {
 } | {
     type: "todo_update";
     todos: TodoItem[];
+}
+/** The conversation's plan, as markdown, after the agent wrote or revised it.
+ *  Carries the FULL body rather than a diff: the backend replaces the plan
+ *  wholesale (`write_plan` — "Replaces any existing plan"), so a consumer that
+ *  merged deltas would drift from the stored document. */
+ | {
+    type: "plan_update";
+    plan: string;
+}
+/** Names of the conversation's notes, after one was written or deleted. Names
+ *  only — bodies are unbounded and read on demand. */
+ | {
+    type: "note_update";
+    notes: string[];
 } | {
     type: "context_update";
     context: Record<string, unknown>;
@@ -603,6 +632,8 @@ interface TeamAgentSummary {
     teamId: string;
     createdAt: string;
     updatedAt: string;
+    /** Agent avatar URL, when the team has set one (wire: `avatar_url`). */
+    avatarUrl?: string | null;
 }
 interface SkillInfo {
     name: string;
@@ -674,6 +705,7 @@ interface ChatStreamRequest {
     agent_name?: string;
     plan_mode?: boolean;
     image_mode?: boolean;
+    video_mode?: boolean;
     /**
      * Start a durable long-horizon goal for this run (goal mode). The backend mints
      * an agent_goal from this text and drives the run under a budget until the
@@ -779,6 +811,22 @@ interface SendOptions$1 extends ModelChoiceOptions {
      * The `image_mode` field itself is accepted from Astralform ≥ 0.59.0.
      */
     imageMode?: boolean;
+    /**
+     * Put this turn in video mode, attaching the video-generation tool.
+     *
+     * Off by default and per-message, for a sharper reason than images: a clip
+     * occupies one shared GPU for minutes, during which image generation on the
+     * same host cannot run at all. The tool is not attached unless this is set.
+     *
+     * Mutually exclusive with `imageMode` at the composer level — which is why a
+     * video turn also gets the image tool server-side: the user cannot select
+     * both, so the agent must be able to produce its own first frame.
+     *
+     * `generate_video` animates an EXISTING image; it cannot start from text, and
+     * the clip is silent. Gate the affordance on `AgentStatus.capabilities`
+     * (`video`), the same way image mode does.
+     */
+    videoMode?: boolean;
     /**
      * Start a durable long-horizon goal for this run (goal mode). The text becomes
      * the goal's objective; the backend keeps the agent working under a budget until
@@ -1308,6 +1356,13 @@ interface SendOptions extends ModelChoiceOptions {
      * provider. Gate the affordance on `AgentStatus.capabilities`.
      */
     imageMode?: boolean;
+    /**
+     * Attach the video-generation tool to this turn. Mutually exclusive with
+     * `imageMode` at the composer level. See `SendOptions.videoMode` in types.ts
+     * for the full rule — a clip animates an existing image, is silent, and holds
+     * one shared GPU for minutes, so it is per-message and off by default.
+     */
+    videoMode?: boolean;
     /**
      * Start a durable long-horizon goal for this run (goal mode) — the text is the
      * goal objective the backend drives to completion. Omit for a normal turn.
@@ -1470,4 +1525,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 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 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 };

package/dist/index.js

@@ -737,7 +737,8 @@ var AstralformClient = class {
       name: a.name,
       teamId: a.team_id,
       createdAt: a.created_at,
-      updatedAt: a.updated_at
+      updatedAt: a.updated_at,
+      avatarUrl: a.avatar_url ?? null
     }));
   }
   // --- Jobs API ---
@@ -1019,6 +1020,19 @@ function translateAgentIdentity(raw) {
     description: raw.description ?? null
   };
 }
+function translateTodoItem(raw) {
+  return {
+    id: raw.id ?? 0,
+    subject: raw.subject ?? "",
+    status: raw.status ?? "pending",
+    description: raw.description ?? null,
+    activeForm: raw.active_form ?? null,
+    owner: raw.owner ?? null,
+    blockedBy: raw.blocked_by ?? null,
+    blocks: raw.blocks ?? null,
+    priority: raw.priority ?? null
+  };
+}
 function translateCustomEvent(name, data) {
   switch (name) {
     case "user_message":
@@ -1035,7 +1049,19 @@ function translateCustomEvent(name, data) {
     case "todo_update":
       return {
         type: "todo_update",
-        todos: data.todos ?? []
+        todos: (data.todos ?? []).map(
+          (t) => translateTodoItem(t)
+        )
+      };
+    case "plan_update":
+      return {
+        type: "plan_update",
+        plan: data.plan ?? ""
+      };
+    case "note_update":
+      return {
+        type: "note_update",
+        notes: data.notes ?? []
       };
     case "context_update":
       return {
@@ -1218,7 +1244,8 @@ function translateWireEvent(wire) {
         usage: {
           inputTokens: wire.usage.input_tokens ?? 0,
           outputTokens: wire.usage.output_tokens ?? 0,
-          cachedTokens: wire.usage.cached_tokens ?? 0
+          cachedTokens: wire.usage.cached_tokens ?? 0,
+          cacheCreationTokens: wire.usage.cache_creation_tokens ?? 0
         },
         ttfbMs: wire.ttfb_ms,
         totalMs: wire.total_ms,
@@ -1426,6 +1453,7 @@ var ChatSession = class {
       agent_name: options?.agentName,
       plan_mode: options?.planMode,
       image_mode: options?.imageMode,
+      video_mode: options?.videoMode,
       goal: options?.goal,
       // Per-request model choice (client-side model selection).
       provider: options?.provider,
@@ -2028,6 +2056,8 @@ var ChatEventType = {
   UserMessage: "user_message",
   TitleGenerated: "title_generated",
   TodoUpdate: "todo_update",
+  PlanUpdate: "plan_update",
+  NoteUpdate: "note_update",
   ContextUpdate: "context_update",
   SubagentStart: "subagent_start",
   SubagentStop: "subagent_stop",
@@ -2131,6 +2161,7 @@ var StreamManager = class {
         uploadIds: options?.uploadIds,
         planMode: options?.planMode,
         imageMode: options?.imageMode,
+        videoMode: options?.videoMode,
         goal: options?.goal,
         provider: options?.provider,
         model: options?.model,