libfx 0.0.14 → 0.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "libfx",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "Embed fx agents and terminals in JavaScript hosts",
   "type": "module",
   "repository": {

package/types/durable-world.d.ts

@@ -15,9 +15,12 @@ export interface World {
     list(params: unknown): unknown;
   };
   readonly streams: {
-    write(runId: string, name: string, chunk: string): unknown;
+    /** A session's view is written as text; each prompt image as one chunk of bytes. */
+    write(runId: string, name: string, chunk: string | Uint8Array): unknown;
     writeMulti?(runId: string, name: string, chunks: string[]): unknown;
     get(runId: string, name: string, startIndex?: number): unknown;
+    /** Read for a session's images: a page of chunks, `{ data: { data }[] }`. */
+    getChunks(runId: string, name: string, options?: { limit?: number; cursor?: string }): unknown;
     getInfo(runId: string, name: string): unknown;
   };
   queue(queueName: string, message: unknown, options?: unknown): unknown;

package/types/libfx.d.cts

@@ -60,7 +60,7 @@ export type FxModelChoice =
     ultrafast?: never;
   }
   | {
-    /** The model ID. Defaults to fx's built-in model. */
+    /** The model ID. On AI Gateway it defaults to fx's built-in model; Codex, Grok, and custom providers need one. */
     model?: string | undefined;
     /** @deprecated Use `model: { id, effort }`. */
     effort?: FxEffort;
@@ -224,7 +224,7 @@ export type FxKeyedTool =
   | (Omit<FxHostTool, "name"> & { name?: string })
   | (Omit<FxProviderTool, "name"> & { name?: "web_search" });
 
-/** At most 64 tools: an array of descriptors, or an object keyed by tool name. */
+/** Tools: an array of descriptors, or an object keyed by tool name. */
 export type FxTools = readonly FxTool[] | { readonly [name: string]: FxKeyedTool };
 
 /** A tool descriptor for `createFxAgent()`. */
@@ -235,7 +235,7 @@ export type FxAgentKeyedTool =
   | (Omit<FxAgentHostTool, "name"> & { name?: string })
   | (Omit<FxProviderTool, "name"> & { name?: "web_search" });
 
-/** At most 64 `createFxAgent()` tools: an array of descriptors, or an object keyed by tool name. */
+/** `createFxAgent()` tools: an array of descriptors, or an object keyed by tool name. */
 export type FxAgentTools = readonly FxAgentTool[] | { readonly [name: string]: FxAgentKeyedTool };
 
 // ---------------------------------------------------------------------------
@@ -704,6 +704,8 @@ export type FxEngineOptions = FxSharedOptions<FxEngineEvent> & FxModelChoice & F
   | ((FxCodexProvider | FxGrokProvider | FxCustomProvider) & {
     /** The AI Gateway credential, unused by this provider's turns. */
     apiKey?: string | undefined;
+    /** The provider's own model. Required: fx's built-in model is an AI Gateway id. */
+    model: string | FxModelOptions;
   })
 ) & {
   /** The id for AI Gateway session affinity: 1 to 255 letters, digits, `.`, `_`, or `-`. Give a restored session the id it had before. */
@@ -863,7 +865,11 @@ export type FxStreamLine = (
 export interface FxSession {
   /** The session's id; for a new session, null until its first prompt is accepted. */
   readonly id: string | null;
-  /** Queues `input` as the session's next turn and returns a view of that turn. */
+  /**
+   * Queues `input` as the session's next turn and returns a view of that turn. Throws a
+   * TypeError or RangeError for an input libfx refuses, and stores nothing. A prompt whose
+   * `signal` aborts before it is stored is never stored, and ends `cancelled`.
+   */
   prompt(input: FxSessionPromptInput, options?: FxPromptOptions): FxTurn;
   /** Continues a turn a stopped process left open; its result has the stop reason `idle` when there was none. */
   resume(): FxResumeTurn;