@flue/sdk 0.2.0 → 0.3.0

package/dist/types-C0nqbu6Z.d.mts

@@ -1,358 +0,0 @@
-import { Model, TSchema } from "@mariozechner/pi-ai";
-import { AgentMessage } from "@mariozechner/pi-agent-core";
-import * as v from "valibot";
-
-//#region src/types.d.ts
-interface Skill {
-  name: string;
-  description: string;
-  /** Markdown body of SKILL.md (below the frontmatter). */
-  instructions: string;
-}
-interface Role {
-  name: string;
-  description: string;
-  /** Markdown body of the role file (below the frontmatter). */
-  instructions: string;
-  model?: string;
-}
-/**
- * An executable command that can be passed to prompt(), skill(), or shell().
- * Registered into just-bash for the duration of the call.
- */
-interface Command {
-  name: string;
-  execute(args: string[]): Promise<{
-    stdout: string;
-    stderr: string;
-    exitCode: number;
-  }>;
-}
-/** @deprecated Use `Command` with `defineCommand()` instead. */
-interface CommandDef {
-  name: string;
-  env?: Record<string, string>;
-}
-/**
- * Custom tool passed to prompt() or skill(). Scoped to the duration of the call.
- * Parameters use TypeBox schemas — import `Type` from `@flue/sdk/client`.
- */
-interface ToolDef<TParams extends TSchema = TSchema> {
-  /** Must be unique across built-in and custom tools. */
-  name: string;
-  /** Tells the LLM when and how to use this tool. */
-  description: string;
-  /** TypeBox parameter schema. */
-  parameters: TParams;
-  /** Returns a string result sent back to the LLM. Thrown errors become tool errors. */
-  execute: (args: Record<string, any>) => Promise<string>;
-}
-interface FileStat {
-  isFile: boolean;
-  isDirectory: boolean;
-  isSymbolicLink: boolean;
-  size: number;
-  mtime: Date;
-}
-/** Registers commands into the isolate's bash. Only present when the sandbox supports it. */
-interface CommandSupport {
-  register(cmd: Command): void;
-  unregister(name: string): void;
-}
-/**
- * Universal session environment interface. All sandbox modes (isolate, local, remote)
- * implement this — no mode-specific branching needed in core logic.
- *
- * File methods accept both absolute and relative paths (resolved against `cwd`).
- */
-interface SessionEnv {
-  exec(command: string, options?: {
-    cwd?: string;
-    env?: Record<string, string>;
-  }): Promise<ShellResult>;
-  readFile(path: string): Promise<string>;
-  readFileBuffer(path: string): Promise<Uint8Array>;
-  writeFile(path: string, content: string | Uint8Array): Promise<void>;
-  stat(path: string): Promise<FileStat>;
-  readdir(path: string): Promise<string[]>;
-  exists(path: string): Promise<boolean>;
-  mkdir(path: string, options?: {
-    recursive?: boolean;
-  }): Promise<void>;
-  rm(path: string, options?: {
-    recursive?: boolean;
-    force?: boolean;
-  }): Promise<void>;
-  cwd: string;
-  /**
-   * Resolve a relative path against cwd. Absolute paths pass through.
-   * File methods resolve internally — only needed when you need the absolute path
-   * for your own logic (e.g., extracting the parent directory).
-   */
-  resolvePath(p: string): string;
-  /** Only present with isolate/local sandboxes. Undefined for remote sandboxes. */
-  commandSupport?: CommandSupport;
-  cleanup(): Promise<void>;
-}
-interface CompactionConfig {
-  enabled?: boolean;
-  /** Token buffer to keep free in the context window. Default: 16384 */
-  reserveTokens?: number;
-  /** Recent tokens to preserve (not summarized). Default: 20000 */
-  keepRecentTokens?: number;
-}
-interface AgentConfig {
-  /** Discovered at runtime from AGENTS.md + .agents/skills/ in the session's cwd. */
-  systemPrompt: string;
-  /** Discovered at runtime from .agents/skills/ in the session's cwd. */
-  skills: Record<string, Skill>;
-  roles: Record<string, Role>;
-  /**
-   * Session-wide default model. Undefined by default — the user must set it via
-   * `init({ model: "provider/model-id" })` or pass `{ model }` at each prompt/
-   * skill/task call site. Calls with no model resolved throw clearly at runtime.
-   */
-  model: Model<any> | undefined;
-  /** Resolve a "provider/modelId" string to a Model instance. Throws on invalid input. */
-  resolveModel?: (modelString: string) => Model<any>;
-  compaction?: CompactionConfig;
-}
-/** Request context passed to agent handler functions. */
-interface FlueContext {
-  readonly sessionId: string;
-  readonly payload: any;
-  /** Platform env bindings (process.env on Node, Worker env on Cloudflare). */
-  readonly env: Record<string, any>;
-  /** Create a session with sandbox + persistence. Can only be called once per request. */
-  init(options?: SessionInit): Promise<FlueSession>;
-}
-/** All fields are optional — omitting gives platform defaults (empty sandbox, platform store, build-time model). */
-interface SessionInit {
-  /**
-   * - `'empty'` (default): In-memory sandbox, no files, no host access.
-   * - `'local'`: Mounts process.cwd() at /workspace. Node only.
-   * - `BashLike`: User-configured just-bash instance.
-   * - `SandboxFactory`: Connector-wrapped external sandbox (Daytona, CF Containers, etc.).
-   */
-  sandbox?: 'empty' | 'local' | SandboxFactory | BashLike;
-  /** Defaults to platform store (in-memory on Node, DO SQLite on Cloudflare). */
-  persist?: SessionStore;
-  /**
-   * Override the default model for this session. Applies to all prompt(), skill(),
-   * and task() calls unless overridden at the call site.
-   *
-   * Format: `'provider/modelId'` (e.g. `'anthropic/claude-opus-4-20250514'`).
-   *
-   * Precedence (highest wins): per-call `model` > role `model` > session `model` > build-time default.
-   */
-  model?: string;
-  /**
-   * Session-wide commands. Every prompt(), skill(), and shell() call inherits
-   * this list. Per-call `commands` are merged on top — if a per-call command
-   * shares a name with a session command, the per-call version wins for that
-   * call.
-   */
-  commands?: Command[];
-}
-interface FlueSession {
-  prompt<S extends v.GenericSchema>(text: string, options: PromptOptions<S> & {
-    result: S;
-  }): Promise<v.InferOutput<S>>;
-  prompt(text: string, options?: PromptOptions): Promise<PromptResponse>;
-  shell(command: string, options?: ShellOptions): Promise<ShellResult>;
-  skill<S extends v.GenericSchema>(name: string, options: SkillOptions<S> & {
-    result: S;
-  }): Promise<v.InferOutput<S>>;
-  skill(name: string, options?: SkillOptions): Promise<PromptResponse>;
-  /** Sub-agent task with its own conversation history, context discovery, and compaction. */
-  task<S extends v.GenericSchema>(prompt: string, options: TaskOptions<S> & {
-    result: S;
-  }): Promise<v.InferOutput<S>>;
-  task(prompt: string, options?: TaskOptions): Promise<PromptResponse>;
-  destroy(): Promise<void>;
-}
-interface PromptResponse {
-  text: string;
-}
-interface SessionData {
-  messages: AgentMessage[];
-  metadata: Record<string, any>;
-  createdAt: string;
-  updatedAt: string;
-  lastCompaction?: {
-    summary: string;
-    firstKeptIndex: number;
-    details?: {
-      readFiles: string[];
-      modifiedFiles: string[];
-    };
-  };
-}
-interface SessionStore {
-  save(id: string, data: SessionData): Promise<void>;
-  load(id: string): Promise<SessionData | null>;
-  delete(id: string): Promise<void>;
-}
-/** All option fields are scoped to the duration of the call. */
-interface PromptOptions<S extends v.GenericSchema | undefined = undefined> {
-  result?: S;
-  timeout?: number;
-  commands?: Command[];
-  tools?: ToolDef[];
-  role?: string;
-  /** e.g., 'anthropic/claude-sonnet-4-20250514' */
-  model?: string;
-}
-interface SkillOptions<S extends v.GenericSchema | undefined = undefined> {
-  args?: Record<string, unknown>;
-  result?: S;
-  timeout?: number;
-  commands?: Command[];
-  tools?: ToolDef[];
-  role?: string;
-  model?: string;
-}
-interface TaskOptions<S extends v.GenericSchema | undefined = undefined> {
-  /** Workspace directory — AGENTS.md and skills are discovered from here. */
-  workspace?: string;
-  result?: S;
-  role?: string;
-  model?: string;
-}
-interface ShellOptions {
-  env?: Record<string, string>;
-  cwd?: string;
-  timeout?: number;
-  commands?: Command[];
-}
-interface ShellResult {
-  stdout: string;
-  stderr: string;
-  exitCode: number;
-}
-/** Wraps external sandboxes (Daytona, CF Containers, etc.) into Flue's SessionEnv. */
-interface SandboxFactory {
-  createSessionEnv(options: {
-    sessionId: string;
-    workspace?: string;
-  }): Promise<SessionEnv>;
-}
-/**
- * Structural type for duck-type detection of just-bash `Bash` instances in init().
- * Purely structural — no just-bash import, so client.ts stays platform-agnostic.
- */
-interface BashLike {
-  exec(command: string, options?: {
-    cwd?: string;
-    env?: Record<string, string>;
-  }): Promise<ShellResult>;
-  getCwd(): string;
-  fs: {
-    readFile(path: string, options?: any): Promise<string>;
-    readFileBuffer(path: string): Promise<Uint8Array>;
-    writeFile(path: string, content: string | Uint8Array, options?: any): Promise<void>;
-    stat(path: string): Promise<any>;
-    readdir(path: string): Promise<string[]>;
-    exists(path: string): Promise<boolean>;
-    mkdir(path: string, options?: {
-      recursive?: boolean;
-    }): Promise<void>;
-    rm(path: string, options?: {
-      recursive?: boolean;
-      force?: boolean;
-    }): Promise<void>;
-    resolvePath(base: string, path: string): string;
-  };
-  registerCommand?(cmd: any): void;
-}
-type FlueEvent = {
-  type: 'agent_start';
-} | {
-  type: 'text_delta';
-  text: string;
-} | {
-  type: 'tool_start';
-  toolName: string;
-  toolCallId: string;
-  args?: any;
-} | {
-  type: 'tool_end';
-  toolName: string;
-  toolCallId: string;
-  isError: boolean;
-  result?: any;
-} | {
-  type: 'turn_end';
-} | {
-  type: 'command_start';
-  command: string;
-  args: string[];
-} | {
-  type: 'command_end';
-  command: string;
-  exitCode: number;
-} | {
-  type: 'compaction_start';
-  reason: 'threshold' | 'overflow';
-  estimatedTokens: number;
-} | {
-  type: 'compaction_end';
-  messagesBefore: number;
-  messagesAfter: number;
-} | {
-  type: 'task_start';
-  workspace: string;
-} | {
-  type: 'task_end';
-} | {
-  type: 'done';
-} | {
-  type: 'error';
-  error: string;
-};
-type FlueEventCallback = (event: FlueEvent) => void;
-interface AgentInfo {
-  name: string;
-  filePath: string;
-  triggers: {
-    webhook?: boolean;
-    cron?: string;
-  };
-}
-interface BuildContext {
-  agents: AgentInfo[];
-  roles: Record<string, Role>;
-  /** The workspace root: the directory directly containing agents/ and roles/. */
-  workspaceDir: string;
-  /** Where dist/ is written. Typically the project root, independent of workspaceDir. */
-  outputDir: string;
-  options: BuildOptions;
-}
-/** Controls the build output format for a target platform. */
-interface BuildPlugin {
-  name: string;
-  generateEntryPoint(ctx: BuildContext): string;
-  esbuildOptions(ctx: BuildContext): Record<string, any>;
-  /** Additional files to write to dist/ (e.g., wrangler.jsonc, Dockerfile). */
-  additionalOutputs?(ctx: BuildContext): Record<string, string>;
-}
-interface BuildOptions {
-  /**
-   * The workspace directory: the directory directly containing agents/ and
-   * roles/. Pass an explicit path — no .flue/ waterfall is performed here.
-   * Callers that want the waterfall behavior (e.g. the CLI when --workspace
-   * is omitted) should resolve it themselves with `resolveWorkspaceFromCwd`.
-   */
-  workspaceDir: string;
-  /**
-   * Where to write the dist/ directory. Independent of workspaceDir — typically
-   * the project root, so platform config like wrangler.jsonc ends up where the
-   * deploy tool expects it.
-   */
-  outputDir: string;
-  target?: 'node' | 'cloudflare';
-  /** Overrides `target` when provided. */
-  plugin?: BuildPlugin;
-}
-//#endregion
-export { ShellOptions as C, TaskOptions as D, SkillOptions as E, ToolDef as O, SessionStore as S, Skill as T, Role as _, BuildOptions as a, SessionEnv as b, CommandDef as c, FlueContext as d, FlueEvent as f, PromptResponse as g, PromptOptions as h, BuildContext as i, CommandSupport as l, FlueSession as m, AgentInfo as n, BuildPlugin as o, FlueEventCallback as p, BashLike as r, Command as s, AgentConfig as t, FileStat as u, SandboxFactory as v, ShellResult as w, SessionInit as x, SessionData as y };