@plotday/twister 0.57.0 → 0.58.0

package/dist/llm-docs/tool.js

@@ -4,5 +4,5 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-export default "import {\n  type Actor,\n} from \"./plot\";\nimport type { Callback } from \"./tools/callbacks\";\nimport type {\n  InferOptions,\n  InferTools,\n  Serializable,\n  ToolBuilder,\n  ToolShed,\n} from \"./utils/types\";\n\nexport type { ToolBuilder };\n\n/**\n * Abstrtact parent for both built-in tools and regular Tools.\n * Regular tools extend Tool.\n */\nexport abstract class ITool {}\n\n/**\n * Base class for regular tools.\n *\n * Regular tools run in isolation and can only access other tools declared\n * in their build method. They are ideal for external API integrations\n * and reusable functionality that doesn't require Plot's internal infrastructure.\n *\n * @example\n * ```typescript\n * class GoogleCalendarTool extends Tool<GoogleCalendarTool> {\n *   constructor(id: string, options: { clientId: string }) {\n *     super(id, options);\n *   }\n *\n *   build(tools: ToolBuilder) {\n *     return {\n *       auth: tools.build(Integrations),\n *       network: tools.build(Network),\n *     };\n *   }\n *\n *   async getCalendars() {\n *     const token = await this.tools.auth.get(...);\n *     // Implementation\n *   }\n * }\n * ```\n */\nexport abstract class Tool<TSelf> implements ITool {\n  constructor(\n    protected id: string,\n    protected options: InferOptions<TSelf>,\n    private toolShed: ToolShed\n  ) {}\n\n  /**\n   * Gets the initialized tools for this tool.\n   * @throws Error if called before initialization is complete\n   */\n  protected get tools() {\n    return this.toolShed.getTools<InferTools<TSelf>>();\n  }\n\n  /**\n   * Declares tool dependencies for this tool.\n   * Return an object mapping tool names to build() promises.\n   * Default implementation returns empty object (no custom tools).\n   *\n   * @param build - The build function to use for declaring dependencies\n   * @returns Object mapping tool names to tool promises\n   *\n   * @example\n   * ```typescript\n   * build(build: ToolBuilder) {\n   *   return {\n   *     network: build(Network, { urls: [\"https://api.example.com/*\"] }),\n   *   };\n   * }\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  build(build: ToolBuilder): Record<string, Promise<ITool>> {\n    return {};\n  }\n\n  /**\n   * Creates a persistent callback to a method on this tool.\n   *\n   * ExtraArgs are strongly typed to match the method's signature.\n   *\n   * @param fn - The method to callback\n   * @param extraArgs - Additional arguments to pass (type-checked, must be serializable)\n   * @returns Promise resolving to a persistent callback token\n   *\n   * @example\n   * ```typescript\n   * const callback = await this.callback(this.onWebhook, \"calendar\", 123);\n   * ```\n   */\n  protected async callback<\n    TArgs extends Serializable[],\n    Fn extends (...args: TArgs) => any\n  >(fn: Fn, ...extraArgs: TArgs): Promise<Callback> {\n    return this.tools.callbacks.create(fn, ...extraArgs);\n  }\n\n  /**\n   * Deletes a specific callback by its token.\n   *\n   * @param token - The callback token to delete\n   * @returns Promise that resolves when the callback is deleted\n   */\n  protected async deleteCallback(token: Callback): Promise<void> {\n    return this.tools.callbacks.delete(token);\n  }\n\n  /**\n   * Deletes all callbacks for this tool.\n   *\n   * @returns Promise that resolves when all callbacks are deleted\n   */\n  protected async deleteAllCallbacks(): Promise<void> {\n    return this.tools.callbacks.deleteAll();\n  }\n\n  /**\n   * Executes a callback by its token inline in the current execution.\n   *\n   * **Use `this.runTask()` instead for batch continuations and long-running work.**\n   * `this.run()` executes inline, sharing the current request count (~1000 limit)\n   * and blocking the HTTP response. This causes timeouts when used in lifecycle\n   * methods like `onChannelEnabled` or `syncBatch` continuations.\n   *\n   * `this.run()` is appropriate when you need the callback's **return value** —\n   * e.g., running a parent callback token that returns data. For fire-and-forget\n   * work, always prefer `this.runTask()`.\n   *\n   * @param token - The callback token to execute\n   * @param args - Optional arguments to pass to the callback\n   * @returns Promise resolving to the callback result\n   */\n  protected async run(token: Callback, ...args: any[]): Promise<any> {\n    return this.tools.callbacks.run(token, ...args);\n  }\n\n  /**\n   * Retrieves a value from persistent storage by key.\n   *\n   * Values are automatically deserialized using SuperJSON, which\n   * properly restores Date objects, Maps, Sets, and other complex types.\n   *\n   * @template T - The expected type of the stored value (must be Serializable)\n   * @param key - The storage key to retrieve\n   * @returns Promise resolving to the stored value or null\n   */\n  protected async get<T extends Serializable>(key: string): Promise<T | null> {\n    return this.tools.store.get(key);\n  }\n\n  /**\n   * Stores a value in persistent storage.\n   *\n   * The value will be serialized using SuperJSON and stored persistently.\n   * SuperJSON automatically handles Date objects, Maps, Sets, undefined values,\n   * and other complex types that standard JSON doesn't support.\n   *\n   * **Important**: Functions and Symbols cannot be stored.\n   * **For function references**: Use callbacks instead of storing functions directly.\n   *\n   * @example\n   * ```typescript\n   * // ✅ Date objects are preserved\n   * await this.set(\"sync_state\", {\n   *   lastSync: new Date(),\n   *   minDate: new Date(2024, 0, 1)\n   * });\n   *\n   * // ✅ undefined is now supported\n   * await this.set(\"data\", { name: \"test\", optional: undefined });\n   *\n   * // ✅ Arrays with undefined are supported\n   * await this.set(\"items\", [1, undefined, 3]);\n   * await this.set(\"items\", [1, null, 3]); // Also works\n   *\n   * // ✅ Maps and Sets are supported\n   * await this.set(\"mapping\", new Map([[\"key\", \"value\"]]));\n   * await this.set(\"tags\", new Set([\"tag1\", \"tag2\"]));\n   *\n   * // ❌ WRONG: Cannot store functions directly\n   * await this.set(\"handler\", this.myHandler);\n   *\n   * // ✅ CORRECT: Create a callback token first\n   * const token = await this.callback(this.myHandler, \"arg1\", \"arg2\");\n   * await this.set(\"handler_token\", token);\n   *\n   * // Later, execute the callback\n   * const token = await this.get<string>(\"handler_token\");\n   * await this.run(token, args);\n   * ```\n   *\n   * @template T - The type of value being stored (must be Serializable)\n   * @param key - The storage key to use\n   * @param value - The value to store (must be SuperJSON-serializable)\n   * @returns Promise that resolves when the value is stored\n   */\n  protected async set<T extends Serializable>(\n    key: string,\n    value: T\n  ): Promise<void> {\n    return this.tools.store.set(key, value);\n  }\n\n  /**\n   * Lists all storage keys matching a prefix.\n   *\n   * @param prefix - The prefix to match keys against\n   * @returns Promise resolving to an array of matching key strings\n   */\n  protected async list(prefix: string): Promise<string[]> {\n    return this.tools.store.list(prefix);\n  }\n\n  /**\n   * Removes a specific key from persistent storage.\n   *\n   * @param key - The storage key to remove\n   * @returns Promise that resolves when the key is removed\n   */\n  protected async clear(key: string): Promise<void> {\n    return this.tools.store.clear(key);\n  }\n\n  /**\n   * Removes all keys from this tool's storage.\n   *\n   * @returns Promise that resolves when all keys are removed\n   */\n  protected async clearAll(): Promise<void> {\n    return this.tools.store.clearAll();\n  }\n\n  /**\n   * Queues a callback to execute in a separate worker context with a fresh request limit.\n   *\n   * **Creates a NEW execution** with its own request limit of ~1000 requests (HTTP requests,\n   * tool calls, database operations). This is the primary way to stay under request limits\n   * when processing large datasets or making many API calls.\n   *\n   * Use this to break long loops into chunks that each stay under the ~1000 request limit.\n   * Each task runs in an isolated execution environment with ~1000 requests and ~60 seconds CPU time.\n   *\n   * @param callback - The callback token created with `this.callback()`\n   * @param options - Optional configuration for the execution\n   * @param options.runAt - If provided, schedules execution at this time; otherwise runs immediately\n   * @returns Promise resolving to a cancellation token (only for scheduled executions)\n   *\n   * @example\n   * ```typescript\n   * // Break large loop into batches\n   * const callback = await this.callback(\"processBatch\", { page: 1 });\n   * await this.runTask(callback); // New execution with fresh request limit\n   * ```\n   */\n  protected async runTask(\n    callback: Callback,\n    options?: { runAt?: Date }\n  ): Promise<string | void> {\n    return this.tools.tasks.runTask(callback, options);\n  }\n\n  /**\n   * Cancels a previously scheduled execution.\n   *\n   * @param token - The cancellation token returned by runTask() with runAt option\n   * @returns Promise that resolves when the cancellation is processed\n   */\n  protected async cancelTask(token: string): Promise<void> {\n    return this.tools.tasks.cancelTask(token);\n  }\n\n  /**\n   * Cancels all scheduled executions for this tool.\n   *\n   * @returns Promise that resolves when all cancellations are processed\n   */\n  protected async cancelAllTasks(): Promise<void> {\n    return this.tools.tasks.cancelAllTasks();\n  }\n\n  /**\n   * Called before the twist's activate method, starting from the deepest tool dependencies.\n   *\n   * This method is called in a depth-first manner, with the deepest dependencies\n   * being called first, bubbling up to the top-level tools before the twist's\n   * activate method is called.\n   *\n   * @param context - Optional context containing the actor who triggered activation\n   * @returns Promise that resolves when pre-activation is complete\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  preActivate(context?: { actor: Actor }): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called after the twist's activate method, starting from the top-level tools.\n   *\n   * This method is called in reverse order, with top-level tools being called\n   * first, then cascading down to the deepest dependencies.\n   *\n   * @param context - Optional context containing the actor who triggered activation\n   * @returns Promise that resolves when post-activation is complete\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  postActivate(context?: { actor: Actor }): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called before the twist's upgrade method, starting from the deepest tool dependencies.\n   *\n   * This method is called in a depth-first manner, with the deepest dependencies\n   * being called first, bubbling up to the top-level tools before the twist's\n   * upgrade method is called.\n   *\n   * @returns Promise that resolves when pre-upgrade is complete\n   */\n  preUpgrade(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called after the twist's upgrade method, starting from the top-level tools.\n   *\n   * This method is called in reverse order, with top-level tools being called\n   * first, then cascading down to the deepest dependencies.\n   *\n   * @returns Promise that resolves when post-upgrade is complete\n   */\n  postUpgrade(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called before the twist's deactivate method, starting from the deepest tool dependencies.\n   *\n   * This method is called in a depth-first manner, with the deepest dependencies\n   * being called first, bubbling up to the top-level tools before the twist's\n   * deactivate method is called.\n   *\n   * @returns Promise that resolves when pre-deactivation is complete\n   */\n  preDeactivate(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called after the twist's deactivate method, starting from the top-level tools.\n   *\n   * This method is called in reverse order, with top-level tools being called\n   * first, then cascading down to the deepest dependencies.\n   *\n   * @returns Promise that resolves when post-deactivation is complete\n   */\n  postDeactivate(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Waits for tool initialization to complete.\n   * Called automatically by the entrypoint before lifecycle methods.\n   * @internal\n   */\n  async waitForReady(): Promise<void> {\n    await this.toolShed.waitForReady();\n  }\n}\n";
+export default "import {\n  type Actor,\n} from \"./plot\";\nimport type { Callback } from \"./tools/callbacks\";\nimport type {\n  InferOptions,\n  InferTools,\n  Serializable,\n  ToolBuilder,\n  ToolShed,\n} from \"./utils/types\";\n\nexport type { ToolBuilder };\n\n/**\n * Abstract parent for both built-in tools and regular Tools.\n * Regular tools extend Tool.\n */\nexport abstract class ITool {}\n\n/**\n * Base class for regular tools.\n *\n * Regular tools run in isolation and can only access other tools declared\n * in their build method. They are ideal for external API integrations\n * and reusable functionality that doesn't require Plot's internal infrastructure.\n *\n * @example\n * ```typescript\n * class GoogleCalendarTool extends Tool<GoogleCalendarTool> {\n *   constructor(id: string, options: { clientId: string }) {\n *     super(id, options);\n *   }\n *\n *   build(tools: ToolBuilder) {\n *     return {\n *       auth: tools.build(Integrations),\n *       network: tools.build(Network),\n *     };\n *   }\n *\n *   async getCalendars() {\n *     const token = await this.tools.auth.get(...);\n *     // Implementation\n *   }\n * }\n * ```\n */\nexport abstract class Tool<TSelf> implements ITool {\n  constructor(\n    protected id: string,\n    protected options: InferOptions<TSelf>,\n    private toolShed: ToolShed\n  ) {}\n\n  /**\n   * Gets the initialized tools for this tool.\n   * @throws Error if called before initialization is complete\n   */\n  protected get tools() {\n    return this.toolShed.getTools<InferTools<TSelf>>();\n  }\n\n  /**\n   * Declares tool dependencies for this tool.\n   * Return an object mapping tool names to build() promises.\n   * Default implementation returns empty object (no custom tools).\n   *\n   * @param build - The build function to use for declaring dependencies\n   * @returns Object mapping tool names to tool promises\n   *\n   * @example\n   * ```typescript\n   * build(build: ToolBuilder) {\n   *   return {\n   *     network: build(Network, { urls: [\"https://api.example.com/*\"] }),\n   *   };\n   * }\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  build(build: ToolBuilder): Record<string, Promise<ITool>> {\n    return {};\n  }\n\n  /**\n   * Creates a persistent callback to a method on this tool.\n   *\n   * ExtraArgs are strongly typed to match the method's signature.\n   *\n   * @param fn - The method to callback\n   * @param extraArgs - Additional arguments to pass (type-checked, must be serializable)\n   * @returns Promise resolving to a persistent callback token\n   *\n   * @example\n   * ```typescript\n   * const callback = await this.callback(this.onWebhook, \"calendar\", 123);\n   * ```\n   */\n  protected async callback<\n    TArgs extends Serializable[],\n    Fn extends (...args: TArgs) => any\n  >(fn: Fn, ...extraArgs: TArgs): Promise<Callback> {\n    return this.tools.callbacks.create(fn, ...extraArgs);\n  }\n\n  /**\n   * Deletes a specific callback by its token.\n   *\n   * @param token - The callback token to delete\n   * @returns Promise that resolves when the callback is deleted\n   */\n  protected async deleteCallback(token: Callback): Promise<void> {\n    return this.tools.callbacks.delete(token);\n  }\n\n  /**\n   * Deletes all callbacks for this tool.\n   *\n   * @returns Promise that resolves when all callbacks are deleted\n   */\n  protected async deleteAllCallbacks(): Promise<void> {\n    return this.tools.callbacks.deleteAll();\n  }\n\n  /**\n   * Executes a callback by its token inline in the current execution.\n   *\n   * **Use `this.runTask()` instead for batch continuations and long-running work.**\n   * `this.run()` executes inline, sharing the current request count (~1000 limit)\n   * and blocking the HTTP response. This causes timeouts when used in lifecycle\n   * methods like `onChannelEnabled` or `syncBatch` continuations.\n   *\n   * `this.run()` is appropriate when you need the callback's **return value** —\n   * e.g., running a parent callback token that returns data. For fire-and-forget\n   * work, always prefer `this.runTask()`.\n   *\n   * @param token - The callback token to execute\n   * @param args - Optional arguments to pass to the callback\n   * @returns Promise resolving to the callback result\n   */\n  protected async run(token: Callback, ...args: any[]): Promise<any> {\n    return this.tools.callbacks.run(token, ...args);\n  }\n\n  /**\n   * Retrieves a value from persistent storage by key.\n   *\n   * Values are automatically deserialized using SuperJSON, which\n   * properly restores Date objects, Maps, Sets, and other complex types.\n   *\n   * @template T - The expected type of the stored value (must be Serializable)\n   * @param key - The storage key to retrieve\n   * @returns Promise resolving to the stored value or null\n   */\n  protected async get<T extends Serializable>(key: string): Promise<T | null> {\n    return this.tools.store.get(key);\n  }\n\n  /**\n   * Stores a value in persistent storage.\n   *\n   * The value will be serialized using SuperJSON and stored persistently.\n   * SuperJSON automatically handles Date objects, Maps, Sets, undefined values,\n   * and other complex types that standard JSON doesn't support.\n   *\n   * **Important**: Functions and Symbols cannot be stored.\n   * **For function references**: Use callbacks instead of storing functions directly.\n   *\n   * @example\n   * ```typescript\n   * // ✅ Date objects are preserved\n   * await this.set(\"sync_state\", {\n   *   lastSync: new Date(),\n   *   minDate: new Date(2024, 0, 1)\n   * });\n   *\n   * // ✅ undefined is now supported\n   * await this.set(\"data\", { name: \"test\", optional: undefined });\n   *\n   * // ✅ Arrays with undefined are supported\n   * await this.set(\"items\", [1, undefined, 3]);\n   * await this.set(\"items\", [1, null, 3]); // Also works\n   *\n   * // ✅ Maps and Sets are supported\n   * await this.set(\"mapping\", new Map([[\"key\", \"value\"]]));\n   * await this.set(\"tags\", new Set([\"tag1\", \"tag2\"]));\n   *\n   * // ❌ WRONG: Cannot store functions directly\n   * await this.set(\"handler\", this.myHandler);\n   *\n   * // ✅ CORRECT: Create a callback token first\n   * const token = await this.callback(this.myHandler, \"arg1\", \"arg2\");\n   * await this.set(\"handler_token\", token);\n   *\n   * // Later, execute the callback\n   * const token = await this.get<Callback>(\"handler_token\");\n   * await this.run(token);\n   * ```\n   *\n   * @template T - The type of value being stored (must be Serializable)\n   * @param key - The storage key to use\n   * @param value - The value to store (must be SuperJSON-serializable)\n   * @returns Promise that resolves when the value is stored\n   */\n  protected async set<T extends Serializable>(\n    key: string,\n    value: T\n  ): Promise<void> {\n    return this.tools.store.set(key, value);\n  }\n\n  /**\n   * Lists all storage keys matching a prefix.\n   *\n   * @param prefix - The prefix to match keys against\n   * @returns Promise resolving to an array of matching key strings\n   */\n  protected async list(prefix: string): Promise<string[]> {\n    return this.tools.store.list(prefix);\n  }\n\n  /**\n   * Removes a specific key from persistent storage.\n   *\n   * @param key - The storage key to remove\n   * @returns Promise that resolves when the key is removed\n   */\n  protected async clear(key: string): Promise<void> {\n    return this.tools.store.clear(key);\n  }\n\n  /**\n   * Removes all keys from this tool's storage.\n   *\n   * @returns Promise that resolves when all keys are removed\n   */\n  protected async clearAll(): Promise<void> {\n    return this.tools.store.clearAll();\n  }\n\n  /**\n   * Queues a callback to execute in a separate worker context with a fresh request limit.\n   *\n   * **Creates a NEW execution** with its own request limit of ~1000 requests (HTTP requests,\n   * tool calls, database operations). This is the primary way to stay under request limits\n   * when processing large datasets or making many API calls.\n   *\n   * Use this to break long loops into chunks that each stay under the ~1000 request limit.\n   * Each task runs in an isolated execution environment with ~1000 requests and ~60 seconds CPU time.\n   *\n   * @param callback - The callback token created with `this.callback()`\n   * @param options - Optional configuration for the execution\n   * @param options.runAt - If provided, schedules execution at this time; otherwise runs immediately\n   * @returns Promise resolving to a cancellation token (only for scheduled executions)\n   *\n   * @example\n   * ```typescript\n   * // Break large loop into batches\n   * const callback = await this.callback(this.processBatch, 1);\n   * await this.runTask(callback); // New execution with fresh request limit\n   * ```\n   */\n  protected async runTask(\n    callback: Callback,\n    options?: { runAt?: Date }\n  ): Promise<string | void> {\n    return this.tools.tasks.runTask(callback, options);\n  }\n\n  /**\n   * Cancels a previously scheduled execution.\n   *\n   * @param token - The cancellation token returned by runTask() with runAt option\n   * @returns Promise that resolves when the cancellation is processed\n   */\n  protected async cancelTask(token: string): Promise<void> {\n    return this.tools.tasks.cancelTask(token);\n  }\n\n  /**\n   * Cancels all scheduled executions for this tool.\n   *\n   * @returns Promise that resolves when all cancellations are processed\n   */\n  protected async cancelAllTasks(): Promise<void> {\n    return this.tools.tasks.cancelAllTasks();\n  }\n\n  /**\n   * Called before the twist's activate method, starting from the deepest tool dependencies.\n   *\n   * This method is called in a depth-first manner, with the deepest dependencies\n   * being called first, bubbling up to the top-level tools before the twist's\n   * activate method is called.\n   *\n   * @param context - Optional context containing the actor who triggered activation\n   * @returns Promise that resolves when pre-activation is complete\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  preActivate(context?: { actor: Actor }): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called after the twist's activate method, starting from the top-level tools.\n   *\n   * This method is called in reverse order, with top-level tools being called\n   * first, then cascading down to the deepest dependencies.\n   *\n   * @param context - Optional context containing the actor who triggered activation\n   * @returns Promise that resolves when post-activation is complete\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  postActivate(context?: { actor: Actor }): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called before the twist's upgrade method, starting from the deepest tool dependencies.\n   *\n   * This method is called in a depth-first manner, with the deepest dependencies\n   * being called first, bubbling up to the top-level tools before the twist's\n   * upgrade method is called.\n   *\n   * @returns Promise that resolves when pre-upgrade is complete\n   */\n  preUpgrade(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called after the twist's upgrade method, starting from the top-level tools.\n   *\n   * This method is called in reverse order, with top-level tools being called\n   * first, then cascading down to the deepest dependencies.\n   *\n   * @returns Promise that resolves when post-upgrade is complete\n   */\n  postUpgrade(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called before the twist's deactivate method, starting from the deepest tool dependencies.\n   *\n   * This method is called in a depth-first manner, with the deepest dependencies\n   * being called first, bubbling up to the top-level tools before the twist's\n   * deactivate method is called.\n   *\n   * @returns Promise that resolves when pre-deactivation is complete\n   */\n  preDeactivate(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Called after the twist's deactivate method, starting from the top-level tools.\n   *\n   * This method is called in reverse order, with top-level tools being called\n   * first, then cascading down to the deepest dependencies.\n   *\n   * @returns Promise that resolves when post-deactivation is complete\n   */\n  postDeactivate(): Promise<void> {\n    return Promise.resolve();\n  }\n\n  /**\n   * Waits for tool initialization to complete.\n   * Called automatically by the entrypoint before lifecycle methods.\n   * @internal\n   */\n  async waitForReady(): Promise<void> {\n    await this.toolShed.waitForReady();\n  }\n}\n";
 //# sourceMappingURL=tool.js.map

package/dist/llm-docs/tool.js.map

@@ -1 +1 @@
-{"version":3,"file":"tool.js","sourceRoot":"","sources":["../../src/llm-docs/tool.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,4gZAA4gZ,CAAC"}
+{"version":3,"file":"tool.js","sourceRoot":"","sources":["../../src/llm-docs/tool.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,8/YAA8/Y,CAAC"}

package/dist/llm-docs/tools/ai.d.ts

@@ -4,6 +4,6 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-declare const _default: "import type { Static, TSchema } from \"typebox\";\n\nimport { ITool } from \"..\";\n\n/**\n * Built-in tool for prompting Large Language Models (LLMs).\n *\n * The AI tool provides twists and tools with access to LLM capabilities\n * for natural language processing, text generation, data extraction,\n * and intelligent decision making within their workflows.\n *\n * **Features:**\n * - Access to multiple AI providers (OpenAI, Anthropic, Google, Workers AI)\n * - Multi-turn conversation support with `messages`\n * - Tool calling with automatic execution\n * - Structured output with Typebox schemas via `outputSchema`\n * - Unified API across all models via Vercel AI SDK\n * - Automatic response parsing and validation with full type inference\n *\n * @example\n * ```typescript\n * import { Type } from \"typebox\";\n *\n * class SmartEmailTool extends Tool {\n *   private ai: AI;\n *\n *   constructor(id: string, tools: ToolBuilder) {\n *     super();\n *     this.ai = tools.get(AI);\n *   }\n *\n *   async categorizeEmail(emailContent: string) {\n *     // Define the output schema using Typebox\n *     const schema = Type.Object({\n *       category: Type.Union([\n *         Type.Literal(\"work\"),\n *         Type.Literal(\"personal\"),\n *         Type.Literal(\"spam\"),\n *         Type.Literal(\"promotional\")\n *       ]),\n *       confidence: Type.Number({ minimum: 0, maximum: 1 }),\n *       reasoning: Type.Optional(Type.String())\n *     });\n *\n *     const response = await this.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Classify emails into categories: work, personal, spam, or promotional.\",\n *       prompt: `Categorize this email: ${emailContent}`,\n *       outputSchema: schema\n *     });\n *\n *     return response.output;\n *   }\n *\n *   async generateResponse(emailContent: string) {\n *     const response = await this.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Generate professional email responses that are helpful and concise.\",\n *       prompt: `Write a response to: ${emailContent}`\n *     });\n *\n *     return response.text;\n *   }\n * }\n * ```\n */\nexport abstract class AI extends ITool {\n  /**\n   * Returns which AI capabilities are currently available.\n   * Check this before calling prompt() or embed() to gracefully\n   * handle cases where AI is disabled by the user.\n   *\n   * Built-in tools are accessed as RPC stubs, so from a twist this call\n   * resolves asynchronously \u2014 always `await` it.\n   */\n  abstract available(): AICapabilities | Promise<AICapabilities>;\n\n  /**\n   * Sends a request to an AI model and returns the response using the Vercel AI SDK.\n   *\n   * Supports text generation, multi-turn conversations, structured outputs,\n   * and tool calling across multiple AI providers via Cloudflare AI Gateway.\n   *\n   * @param request - AI request with model, prompt/messages, and optional configuration\n   * @returns Promise resolving to the AI response with generated text and metadata\n   *\n   * @example\n   * ```typescript\n   * // Simple text generation\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Explain quantum computing in simple terms\"\n   * });\n   * console.log(response.text);\n   *\n   * // Fast and cheap for simple tasks\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"low\" },\n   *   prompt: \"Summarize this text...\"\n   * });\n   * console.log(response.text);\n   *\n   * // With system instructions for complex reasoning\n   * const response = await ai.prompt({\n   *   model: { speed: \"capable\", cost: \"high\" },\n   *   system: \"You are a helpful physics tutor.\",\n   *   prompt: \"Explain quantum entanglement\"\n   * });\n   * console.log(response.text);\n   *\n   * // Multi-turn conversation\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   messages: [\n   *     { role: \"user\", content: \"What is 2+2?\" },\n   *     { role: \"assistant\", content: \"2+2 equals 4.\" },\n   *     { role: \"user\", content: \"What about 3+3?\" }\n   *   ]\n   * });\n   * console.log(response.text);\n   *\n   * // Structured output with Typebox schema\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Extract information: John is 30 years old\",\n   *   outputSchema: Type.Object({\n   *     name: Type.String(),\n   *     age: Type.Number()\n   *   })\n   * });\n   * console.log(response.output); // { name: \"John\", age: 30 }\n   *\n   * // Tool calling\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   prompt: \"What's the weather in San Francisco?\",\n   *   tools: {\n   *     getWeather: {\n   *       description: \"Get weather for a city\",\n   *       inputSchema: Type.Object({\n   *         city: Type.String()\n   *       }),\n   *       execute: async ({ city }) => {\n   *         return { temp: 72, condition: \"sunny\" };\n   *       }\n   *     }\n   *   }\n   * });\n   * console.log(response.text); // Model's response using tool results\n   * console.log(response.toolCalls); // Array of tool calls made\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract prompt<TOOLS extends AIToolSet, SCHEMA extends TSchema = never>(\n    request: AIRequest<TOOLS, SCHEMA>\n  ): Promise<AIResponse<TOOLS, SCHEMA>>;\n}\n\n/** Options for configuring AI tool usage in a twist. */\nexport type AIOptions = {\n  /** Whether AI is required for this twist to function. Default: true */\n  required?: boolean;\n};\n\n/** Describes which AI capabilities are currently available to this twist. */\nexport type AICapabilities = {\n  /** Whether AI prompting (text generation) is available. */\n  prompt: boolean;\n  /** Whether AI embedding generation is available. */\n  embed: boolean;\n  /**\n   * Whether provider-native web search is available. True for Plot AI and\n   * Anthropic/Google BYOK providers; false for OpenAI/custom BYOK providers\n   * that don't expose a server-side web search tool through this runtime.\n   */\n  webSearch: boolean;\n};\n\n/**\n * Model preferences for selecting an AI model based on performance and cost requirements.\n * This allows Plot to match those preferences with user preferences (such as preferred or\n * disallowed providers), as well as availability of newer and better models.\n *\n * @example\n * ```typescript\n * // Fast and cheap - uses Workers AI models like Llama 3.2 1B\n * const response = await ai.prompt({\n *   model: { speed: \"fast\", cost: \"low\" },\n *   prompt: \"Summarize this in one sentence: ...\"\n * });\n *\n * // Balanced performance - uses GPT-5 Mini or Gemini 2.5 Flash\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\" },\n *   prompt: \"Analyze this data...\"\n * });\n *\n * // Most capable - uses Claude Sonnet 4.5 or Opus 4.1\n * const response = await ai.prompt({\n *   model: { speed: \"capable\", cost: \"high\" },\n *   prompt: \"Solve this complex reasoning problem...\"\n * });\n *\n * // Request a specific model with a hint\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\", hint: AIModel.CLAUDE_SONNET_45 },\n *   prompt: \"...\"\n * });\n * ```\n */\nexport type ModelPreferences = {\n  /**\n   * Desired speed tier:\n   * - \"fast\": Optimized for low latency and quick responses\n   * - \"balanced\": Good balance of speed and capability\n   * - \"capable\": Maximum reasoning and problem-solving ability\n   */\n  speed: \"fast\" | \"balanced\" | \"capable\";\n\n  /**\n   * Desired cost tier:\n   * - \"low\": Minimal cost, often using Workers AI models (free/very cheap)\n   * - \"medium\": Moderate pricing for good performance\n   * - \"high\": Premium pricing for best-in-class models\n   */\n  cost: \"low\" | \"medium\" | \"high\";\n\n  /**\n   * Optional hint to suggest a specific model. The system will use this\n   * model if possible, but may override it based on user preferences.\n   */\n  hint?: AIModel;\n};\n\n/**\n * Supported AI models available through Cloudflare AI Gateway and Workers AI.\n *\n * Models are organized by provider:\n * - **OpenAI**: Latest GPT models via AI Gateway\n * - **Anthropic**: Claude models via AI Gateway (prefix with \"anthropic/\")\n * - **Google**: Gemini models via AI Gateway (prefix with \"google-ai-studio/\")\n * - **Workers AI**: Models running on Cloudflare's network (free/low cost)\n */\nexport enum AIModel {\n  // OpenAI models - Latest GPT and reasoning models\n  GPT_5 = \"openai/gpt-5\",\n  GPT_5_PRO = \"openai/gpt-5-pro\",\n  GPT_5_MINI = \"openai/gpt-5-mini\",\n  GPT_5_NANO = \"openai/gpt-5-nano\",\n  GPT_4O = \"openai/gpt-4o\",\n  GPT_4O_MINI = \"openai/gpt-4o-mini\",\n  O3 = \"openai/o3\",\n  O3_MINI = \"openai/o3-mini\",\n\n  // Anthropic models - Claude 4.x series\n  CLAUDE_OPUS_46 = \"anthropic/claude-opus-4-6\",\n  CLAUDE_SONNET_46 = \"anthropic/claude-sonnet-4-6\",\n  CLAUDE_HAIKU_45 = \"anthropic/claude-haiku-4-5\",\n\n  // Google models - Gemini 2.x series\n  GEMINI_25_PRO = \"google/gemini-2.5-pro\",\n  GEMINI_25_FLASH = \"google/gemini-2.5-flash\",\n  GEMINI_25_FLASH_LITE = \"google/gemini-2.5-flash-lite\",\n  GEMINI_20_FLASH = \"google/gemini-2.0-flash\",\n  GEMINI_20_FLASH_LITE = \"google/gemini-2.0-flash-lite\",\n\n  // Cloudflare Workers AI models - Free/low-cost models running on Cloudflare's network\n  LLAMA_4_SCOUT_17B = \"meta/llama-4-scout-17b-16e-instruct\",\n  LLAMA_33_70B = \"meta/llama-3.3-70b-instruct-fp8-fast\",\n  LLAMA_31_8B = \"meta/llama-3.1-8b-instruct-fp8\",\n  LLAMA_32_1B = \"meta/llama-3.2-1b-instruct\",\n  DEEPSEEK_R1_32B = \"deepseek-ai/deepseek-r1-distill-qwen-32b\",\n}\n\n/**\n * Request parameters for AI text generation, matching Vercel AI SDK's generateText() function.\n */\nexport interface AIRequest<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * Model selection preferences based on desired speed and cost characteristics.\n   * Plot will automatically select the best available model matching these preferences.\n   *\n   * @example\n   * // Fast and cheap - good for simple tasks\n   * model: { speed: \"fast\", cost: \"low\" }\n   *\n   * @example\n   * // Balanced performance - general purpose\n   * model: { speed: \"balanced\", cost: \"medium\" }\n   *\n   * @example\n   * // Maximum capability - complex reasoning\n   * model: { speed: \"capable\", cost: \"high\" }\n   *\n   * @example\n   * // With a specific model hint\n   * model: { speed: \"balanced\", cost: \"medium\", hint: \"anthropic/claude-sonnet-4-6\" }\n   */\n  model: ModelPreferences;\n\n  /**\n   * System instructions to guide the model's behavior.\n   */\n  system?: string;\n\n  /**\n   * The user's input prompt. Can be a simple string or an array of messages for multi-turn conversations.\n   */\n  prompt?: string;\n\n  /**\n   * Conversation messages for multi-turn interactions.\n   * Replaces 'prompt' for more complex conversations.\n   */\n  messages?: AIMessage[];\n\n  /**\n   * Tools that the model can call during generation.\n   * Each tool definition includes a description, input schema, and optional execute function.\n   */\n  tools?: TOOLS;\n\n  /**\n   * Controls which tools the model can use.\n   * - \"auto\": Model decides whether to use tools\n   * - \"none\": Model cannot use tools\n   * - \"required\": Model must use at least one tool\n   * - { type: \"tool\", toolName: string }: Model must use specific tool\n   */\n  toolChoice?: ToolChoice<TOOLS>;\n\n  /**\n   * Structured output schema using Typebox.\n   * Typebox schemas are JSON Schema objects that provide full TypeScript type inference.\n   */\n  outputSchema?: SCHEMA;\n\n  /**\n   * Maximum number of tokens to generate.\n   */\n  maxOutputTokens?: number;\n\n  /**\n   * Temperature for controlling randomness (0-2).\n   * Higher values make output more random, lower values more deterministic.\n   */\n  temperature?: number;\n\n  /**\n   * Top P sampling parameter (0-1).\n   * Controls diversity by limiting to top probability tokens.\n   */\n  topP?: number;\n\n  /**\n   * Enable provider-native web search so the model can retrieve\n   * up-to-date information from the web. The search is executed\n   * server-side by the provider and any pages used are returned in\n   * {@link AIResponse.sources}.\n   *\n   * Only available on web-search-capable providers (Anthropic and\n   * Google). Check {@link AICapabilities.webSearch} via `available()`\n   * before relying on it; on unsupported providers the flag is ignored.\n   *\n   * Pass `true` for defaults, or an object to cap the number of searches.\n   */\n  webSearch?: boolean | { maxUses?: number };\n\n  /**\n   * Maximum number of sequential generation steps for agentic tool use.\n   * When the model calls a tool, its result is fed back and the model is\n   * called again, up to `maxSteps` times, until it produces a final answer.\n   *\n   * Defaults to 1 (single step \u2014 tool calls are returned but not looped),\n   * preserving prior behavior. Set higher (e.g. 6) to let the model chain\n   * tool calls into a final answer.\n   */\n  maxSteps?: number;\n}\n\n/**\n * Response from AI text generation, matching Vercel AI SDK's GenerateTextResult.\n */\nexport interface AIResponse<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * The generated text.\n   */\n  text: string;\n\n  /**\n   * Tool calls made by the model during generation.\n   */\n  toolCalls?: ToolCallArray<TOOLS>;\n\n  /**\n   * Results from tool executions.\n   */\n  toolResults?: ToolResultArray<TOOLS>;\n\n  /**\n   * Reason why the model stopped generating.\n   */\n  finishReason:\n    | \"stop\"\n    | \"length\"\n    | \"content-filter\"\n    | \"tool-calls\"\n    | \"error\"\n    | \"other\"\n    | \"unknown\";\n\n  /**\n   * Token usage information for this generation.\n   */\n  usage: AIUsage;\n\n  /**\n   * Sources used by the model (if supported).\n   */\n  sources?: Array<AISource>;\n\n  /**\n   * Structured output when using outputSchema.\n   * Type is automatically inferred from the Typebox schema.\n   */\n  output?: Static<SCHEMA>;\n\n  /**\n   * Response metadata including messages.\n   */\n  response?: {\n    id?: string;\n    timestamp?: Date;\n    modelId?: string;\n    messages?: AIMessage[];\n  };\n}\n\n// ============================================================================\n// Message Types\n// ============================================================================\n\n/**\n * A system message. It can contain system information.\n *\n * Note: using the \"system\" part of the prompt is strongly preferred\n * to increase the resilience against prompt injection attacks,\n * and because not all providers support several system messages.\n */\nexport type AISystemMessage = {\n  role: \"system\";\n  content: string;\n};\n\n/**\n * A user message. It can contain text or a combination of text and images.\n */\nexport type AIUserMessage = {\n  role: \"user\";\n  content: string | Array<TextPart | ImagePart | FilePart>;\n};\n\n/**\n * An assistant message. It can contain text, tool calls, or a combination of text and tool calls.\n */\nexport type AIAssistantMessage = {\n  role: \"assistant\";\n  content:\n    | string\n    | Array<\n        TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart\n      >;\n};\n\n/**\n * A tool message. It contains the result of one or more tool calls.\n */\nexport type AIToolMessage = {\n  role: \"tool\";\n  content: Array<ToolResultPart>;\n};\n\n/**\n * A message that can be used in the `messages` field of a prompt.\n * It can be a user message, an assistant message, or a tool message.\n */\nexport type AIMessage =\n  | AISystemMessage\n  | AIUserMessage\n  | AIAssistantMessage\n  | AIToolMessage;\n\n// ============================================================================\n// Usage & Sources\n// ============================================================================\n\n/**\n * Represents the number of tokens used in a prompt and completion.\n */\nexport type AIUsage = {\n  /**\n   * The number of tokens used in the prompt.\n   */\n  inputTokens?: number;\n  /**\n   * The number of tokens used in the completion.\n   */\n  outputTokens?: number;\n  /**\n   * The total number of tokens used (promptTokens + completionTokens).\n   */\n  totalTokens?: number;\n  /**\n   * The number of reasoning tokens used in the completion.\n   */\n  reasoningTokens?: number;\n};\n\n/**\n * A source that has been used as input to generate the response.\n */\nexport type AISource =\n  | {\n      type: \"source\";\n      /**\n       * A URL source. This is returned by web search RAG models.\n       */\n      sourceType: \"url\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * The URL of the source.\n       */\n      url: string;\n      /**\n       * The title of the source.\n       */\n      title?: string;\n    }\n  | {\n      type: \"source\";\n      /**\n       * The type of source - document sources reference files/documents.\n       */\n      sourceType: \"document\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * IANA media type of the document (e.g., 'application/pdf').\n       */\n      mediaType: string;\n      /**\n       * The title of the document.\n       */\n      title: string;\n      /**\n       * Optional filename of the document.\n       */\n      filename?: string;\n    };\n\n// ============================================================================\n// Content Parts\n// ============================================================================\n\n/**\n * Text content part of a prompt. It contains a string of text.\n */\nexport interface TextPart {\n  type: \"text\";\n  /**\n   * The text content.\n   */\n  text: string;\n}\n\n/**\n * Data content. Can either be a base64-encoded string, a Uint8Array, or an ArrayBuffer.\n */\nexport type DataContent = string | Uint8Array | ArrayBuffer;\n\n/**\n * Image content part of a prompt. It contains an image.\n */\nexport interface ImagePart {\n  type: \"image\";\n  /**\n   * Image data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the image\n   */\n  image: DataContent | URL;\n  /**\n   * Optional mime type of the image.\n   */\n  mimeType?: string;\n}\n\n/**\n * File content part of a prompt. It contains a file.\n */\nexport interface FilePart {\n  type: \"file\";\n  /**\n   * File data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the file\n   */\n  data: DataContent | URL;\n  /**\n   * Optional filename of the file.\n   */\n  filename?: string;\n  /**\n   * IANA media type of the file.\n   *\n   * @see https://www.iana.org/assignments/media-types/media-types.xhtml\n   */\n  mediaType: string;\n}\n\n/**\n * Reasoning content part of a prompt. It contains a reasoning.\n */\nexport interface ReasoningPart {\n  type: \"reasoning\";\n  /**\n   * The reasoning text.\n   */\n  text: string;\n  /**\n   * An optional signature for verifying that the reasoning originated from the model.\n   */\n  signature?: string;\n}\n\n/**\n * Redacted reasoning content part of a prompt.\n */\nexport interface RedactedReasoningPart {\n  type: \"redacted-reasoning\";\n  /**\n   * Redacted reasoning data.\n   */\n  data: string;\n}\n\n/**\n * Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).\n */\nexport interface ToolCallPart {\n  type: \"tool-call\";\n  /**\n   * ID of the tool call. This ID is used to match the tool call with the tool result.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that is being called.\n   */\n  toolName: string;\n  /**\n   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.\n   */\n  input: unknown;\n}\n\ntype JSONValue = null | string | number | boolean | JSONObject | JSONArray;\ntype JSONObject = {\n  [key: string]: JSONValue;\n};\ntype JSONArray = JSONValue[];\n\n/**\n * Tool result content part of a prompt. It contains the result of the tool call with the matching ID.\n */\nexport interface ToolResultPart {\n  type: \"tool-result\";\n  /**\n   * ID of the tool call that this result is associated with.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that generated this result.\n   */\n  toolName: string;\n  /**\n   * Result of the tool call. This is a JSON-serializable object.\n   */\n  output:\n    | {\n        type: \"text\";\n        value: string;\n      }\n    | {\n        type: \"json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"error-text\";\n        value: string;\n      }\n    | {\n        type: \"error-json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"content\";\n        value: Array<\n          | {\n              type: \"text\";\n              /**\nText content.\n*/\n              text: string;\n            }\n          | {\n              type: \"media\";\n              /**\nBase-64 encoded media data.\n*/\n              data: string;\n              /**\nIANA media type.\n@see https://www.iana.org/assignments/media-types/media-types.xhtml\n*/\n              mediaType: string;\n            }\n        >;\n      };\n}\n\n// ============================================================================\n// Tool Types\n// ============================================================================\n\ntype ToolParameters = TSchema;\n\ntype inferParameters<PARAMETERS extends ToolParameters> = Static<PARAMETERS>;\n\n/**\n * Options passed to tool execution functions.\n */\nexport interface ToolExecutionOptions {\n  /**\n   * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.\n   */\n  toolCallId: string;\n  /**\n   * Messages that were sent to the language model to initiate the response that contained the tool call.\n   * The messages **do not** include the system prompt nor the assistant response that contained the tool call.\n   */\n  messages: AIMessage[];\n  /**\n   * An optional abort signal that indicates that the overall operation should be aborted.\n   */\n  abortSignal?: AbortSignal;\n}\n\n/**\n * A tool contains the description and the schema of the input that the tool expects.\n * This enables the language model to generate the input.\n *\n * The tool can also contain an optional execute function for the actual execution function of the tool.\n */\nexport type AITool<PARAMETERS extends ToolParameters = any, RESULT = any> = {\n  /**\n   * The schema of the input that the tool expects, expressed as a Typebox\n   * schema. The language model uses this to generate (and the runtime to\n   * validate) the tool input. Use field descriptions to make the input\n   * understandable for the model.\n   *\n   * This is the canonical field read by the runtime. `parameters` is an\n   * accepted alias for backwards compatibility.\n   */\n  inputSchema: TSchema;\n  /**\n   * @deprecated Alias for {@link inputSchema}. Prefer `inputSchema`.\n   */\n  parameters?: PARAMETERS;\n  /**\n   * An optional description of what the tool does.\n   * Will be used by the language model to decide whether to use the tool.\n   * Not used for provider-defined tools.\n   */\n  description?: string;\n  /**\n   * An async function that is called with the arguments from the tool call and produces a result.\n   * If not provided, the tool will not be executed automatically.\n   *\n   * @param args - The input of the tool call\n   * @param options - Execution options including abort signal and messages\n   */\n  execute?: (\n    args: inferParameters<PARAMETERS>,\n    options: ToolExecutionOptions\n  ) => PromiseLike<RESULT>;\n} & (\n  | {\n      /**\n       * Function tool.\n       */\n      type?: undefined | \"function\";\n    }\n  | {\n      /**\n       * Provider-defined tool.\n       */\n      type: \"provider-defined\";\n      /**\n       * The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.\n       */\n      id: `${string}.${string}`;\n      /**\n       * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.\n       */\n      args: Record<string, unknown>;\n    }\n);\n\n/**\n * Tool choice for the generation. It supports the following settings:\n *\n * - `auto` (default): the model can choose whether and which tools to call.\n * - `required`: the model must call a tool. It can choose which tool to call.\n * - `none`: the model must not call tools\n * - `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool\n */\ntype ToolChoice<TOOLS extends Record<string, unknown>> =\n  | \"auto\"\n  | \"none\"\n  | \"required\"\n  | {\n      type: \"tool\";\n      toolName: Extract<keyof TOOLS, string>;\n    };\n\nexport type AIToolSet = Record<\n  string,\n  (\n    | AITool<never, never>\n    | AITool<any, any>\n    | AITool<any, never>\n    | AITool<never, any>\n  ) &\n    Pick<AITool<any, any>, \"execute\">\n>;\n\n// ============================================================================\n// Internal Helper Types\n// ============================================================================\n\ntype ToolCallUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-call\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n};\n\ntype ToolCallArray<TOOLS extends AIToolSet> = Array<ToolCallUnion<TOOLS>>;\n\ntype ToolResultUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-result\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n  result?: unknown;\n};\n\ntype ToolResultArray<TOOLS extends AIToolSet> = Array<ToolResultUnion<TOOLS>>;\n";
+declare const _default: "import type { Static, TSchema } from \"typebox\";\n\nimport { ITool } from \"..\";\n\n/**\n * Built-in tool for prompting Large Language Models (LLMs).\n *\n * The AI tool provides twists and tools with access to LLM capabilities\n * for natural language processing, text generation, data extraction,\n * and intelligent decision making within their workflows.\n *\n * **Features:**\n * - Access to multiple AI providers (OpenAI, Anthropic, Google, Workers AI)\n * - Multi-turn conversation support with `messages`\n * - Tool calling with automatic execution\n * - Structured output with Typebox schemas via `outputSchema`\n * - Unified API across all models via Vercel AI SDK\n * - Automatic response parsing and validation with full type inference\n *\n * @example\n * ```typescript\n * import { Type } from \"typebox\";\n *\n * class SmartEmailTool extends Tool<SmartEmailTool> {\n *   build(build: ToolBuilder) {\n *     return {\n *       ai: build(AI),\n *     };\n *   }\n *\n *   async categorizeEmail(emailContent: string) {\n *     // Define the output schema using Typebox\n *     const schema = Type.Object({\n *       category: Type.Union([\n *         Type.Literal(\"work\"),\n *         Type.Literal(\"personal\"),\n *         Type.Literal(\"spam\"),\n *         Type.Literal(\"promotional\")\n *       ]),\n *       confidence: Type.Number({ minimum: 0, maximum: 1 }),\n *       reasoning: Type.Optional(Type.String())\n *     });\n *\n *     const response = await this.tools.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Classify emails into categories: work, personal, spam, or promotional.\",\n *       prompt: `Categorize this email: ${emailContent}`,\n *       outputSchema: schema\n *     });\n *\n *     return response.output;\n *   }\n *\n *   async generateResponse(emailContent: string) {\n *     const response = await this.tools.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Generate professional email responses that are helpful and concise.\",\n *       prompt: `Write a response to: ${emailContent}`\n *     });\n *\n *     return response.text;\n *   }\n * }\n * ```\n */\nexport abstract class AI extends ITool {\n  /**\n   * Returns which AI capabilities are currently available.\n   * Check this before calling prompt() to gracefully\n   * handle cases where AI is disabled by the user.\n   *\n   * Built-in tools are accessed as RPC stubs, so from a twist this call\n   * resolves asynchronously \u2014 always `await` it.\n   */\n  abstract available(): AICapabilities | Promise<AICapabilities>;\n\n  /**\n   * Sends a request to an AI model and returns the response using the Vercel AI SDK.\n   *\n   * Supports text generation, multi-turn conversations, structured outputs,\n   * and tool calling across multiple AI providers via Cloudflare AI Gateway.\n   *\n   * @param request - AI request with model, prompt/messages, and optional configuration\n   * @returns Promise resolving to the AI response with generated text and metadata\n   *\n   * @example\n   * ```typescript\n   * // Simple text generation\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Explain quantum computing in simple terms\"\n   * });\n   * console.log(response.text);\n   *\n   * // Fast and cheap for simple tasks\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"low\" },\n   *   prompt: \"Summarize this text...\"\n   * });\n   * console.log(response.text);\n   *\n   * // With system instructions for complex reasoning\n   * const response = await ai.prompt({\n   *   model: { speed: \"capable\", cost: \"high\" },\n   *   system: \"You are a helpful physics tutor.\",\n   *   prompt: \"Explain quantum entanglement\"\n   * });\n   * console.log(response.text);\n   *\n   * // Multi-turn conversation\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   messages: [\n   *     { role: \"user\", content: \"What is 2+2?\" },\n   *     { role: \"assistant\", content: \"2+2 equals 4.\" },\n   *     { role: \"user\", content: \"What about 3+3?\" }\n   *   ]\n   * });\n   * console.log(response.text);\n   *\n   * // Structured output with Typebox schema\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Extract information: John is 30 years old\",\n   *   outputSchema: Type.Object({\n   *     name: Type.String(),\n   *     age: Type.Number()\n   *   })\n   * });\n   * console.log(response.output); // { name: \"John\", age: 30 }\n   *\n   * // Tool calling\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   prompt: \"What's the weather in San Francisco?\",\n   *   tools: {\n   *     getWeather: {\n   *       description: \"Get weather for a city\",\n   *       inputSchema: Type.Object({\n   *         city: Type.String()\n   *       }),\n   *       execute: async ({ city }) => {\n   *         return { temp: 72, condition: \"sunny\" };\n   *       }\n   *     }\n   *   }\n   * });\n   * console.log(response.text); // Model's response using tool results\n   * console.log(response.toolCalls); // Array of tool calls made\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract prompt<TOOLS extends AIToolSet, SCHEMA extends TSchema = never>(\n    request: AIRequest<TOOLS, SCHEMA>\n  ): Promise<AIResponse<TOOLS, SCHEMA>>;\n}\n\n/** Options for configuring AI tool usage in a twist. */\nexport type AIOptions = {\n  /** Whether AI is required for this twist to function. Default: true */\n  required?: boolean;\n};\n\n/** Describes which AI capabilities are currently available to this twist. */\nexport type AICapabilities = {\n  /** Whether AI prompting (text generation) is available. */\n  prompt: boolean;\n  /** Whether AI embedding generation is available. */\n  embed: boolean;\n  /**\n   * Whether provider-native web search is available. True for Plot AI and\n   * Anthropic/Google BYOK providers; false for OpenAI/custom BYOK providers\n   * that don't expose a server-side web search tool through this runtime.\n   */\n  webSearch: boolean;\n};\n\n/**\n * Model preferences for selecting an AI model based on performance and cost requirements.\n * This allows Plot to match those preferences with user preferences (such as preferred or\n * disallowed providers), as well as availability of newer and better models.\n *\n * @example\n * ```typescript\n * // Fast and cheap - uses Workers AI models like Llama 3.2 1B\n * const response = await ai.prompt({\n *   model: { speed: \"fast\", cost: \"low\" },\n *   prompt: \"Summarize this in one sentence: ...\"\n * });\n *\n * // Balanced performance - uses GPT-5 Mini or Gemini 2.5 Flash\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\" },\n *   prompt: \"Analyze this data...\"\n * });\n *\n * // Most capable - uses models like GPT-5, Claude Sonnet 4.6, or Gemini 2.5 Pro\n * const response = await ai.prompt({\n *   model: { speed: \"capable\", cost: \"high\" },\n *   prompt: \"Solve this complex reasoning problem...\"\n * });\n *\n * // Request a specific model with a hint\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\", hint: AIModel.CLAUDE_SONNET_46 },\n *   prompt: \"...\"\n * });\n * ```\n */\nexport type ModelPreferences = {\n  /**\n   * Desired speed tier:\n   * - \"fast\": Optimized for low latency and quick responses\n   * - \"balanced\": Good balance of speed and capability\n   * - \"capable\": Maximum reasoning and problem-solving ability\n   */\n  speed: \"fast\" | \"balanced\" | \"capable\";\n\n  /**\n   * Desired cost tier:\n   * - \"low\": Minimal cost, often using Workers AI models (free/very cheap)\n   * - \"medium\": Moderate pricing for good performance\n   * - \"high\": Premium pricing for best-in-class models\n   */\n  cost: \"low\" | \"medium\" | \"high\";\n\n  /**\n   * Optional hint to suggest a specific model. The system will use this\n   * model if possible, but may override it based on user preferences.\n   */\n  hint?: AIModel;\n};\n\n/**\n * Supported AI models available through Cloudflare AI Gateway and Workers AI.\n *\n * Models are organized by provider:\n * - **OpenAI**: Latest GPT models via AI Gateway\n * - **Anthropic**: Claude models via AI Gateway (prefix with \"anthropic/\")\n * - **Google**: Gemini models via AI Gateway (prefix with \"google/\")\n * - **Workers AI**: Models running on Cloudflare's network (free/low cost)\n */\nexport enum AIModel {\n  // OpenAI models - Latest GPT and reasoning models\n  GPT_5 = \"openai/gpt-5\",\n  GPT_5_PRO = \"openai/gpt-5-pro\",\n  GPT_5_MINI = \"openai/gpt-5-mini\",\n  GPT_5_NANO = \"openai/gpt-5-nano\",\n  GPT_4O = \"openai/gpt-4o\",\n  GPT_4O_MINI = \"openai/gpt-4o-mini\",\n  O3 = \"openai/o3\",\n  O3_MINI = \"openai/o3-mini\",\n\n  // Anthropic models - Claude 4.x series\n  CLAUDE_OPUS_46 = \"anthropic/claude-opus-4-6\",\n  CLAUDE_SONNET_46 = \"anthropic/claude-sonnet-4-6\",\n  CLAUDE_HAIKU_45 = \"anthropic/claude-haiku-4-5\",\n\n  // Google models - Gemini 2.x series\n  GEMINI_25_PRO = \"google/gemini-2.5-pro\",\n  GEMINI_25_FLASH = \"google/gemini-2.5-flash\",\n  GEMINI_25_FLASH_LITE = \"google/gemini-2.5-flash-lite\",\n  GEMINI_20_FLASH = \"google/gemini-2.0-flash\",\n  GEMINI_20_FLASH_LITE = \"google/gemini-2.0-flash-lite\",\n\n  // Cloudflare Workers AI models - Free/low-cost models running on Cloudflare's network\n  LLAMA_4_SCOUT_17B = \"meta/llama-4-scout-17b-16e-instruct\",\n  LLAMA_33_70B = \"meta/llama-3.3-70b-instruct-fp8-fast\",\n  LLAMA_31_8B = \"meta/llama-3.1-8b-instruct-fp8\",\n  LLAMA_32_1B = \"meta/llama-3.2-1b-instruct\",\n  DEEPSEEK_R1_32B = \"deepseek-ai/deepseek-r1-distill-qwen-32b\",\n}\n\n/**\n * Request parameters for AI text generation, matching Vercel AI SDK's generateText() function.\n */\nexport interface AIRequest<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * Model selection preferences based on desired speed and cost characteristics.\n   * Plot will automatically select the best available model matching these preferences.\n   *\n   * @example\n   * // Fast and cheap - good for simple tasks\n   * model: { speed: \"fast\", cost: \"low\" }\n   *\n   * @example\n   * // Balanced performance - general purpose\n   * model: { speed: \"balanced\", cost: \"medium\" }\n   *\n   * @example\n   * // Maximum capability - complex reasoning\n   * model: { speed: \"capable\", cost: \"high\" }\n   *\n   * @example\n   * // With a specific model hint\n   * model: { speed: \"balanced\", cost: \"medium\", hint: \"anthropic/claude-sonnet-4-6\" }\n   */\n  model: ModelPreferences;\n\n  /**\n   * System instructions to guide the model's behavior.\n   */\n  system?: string;\n\n  /**\n   * The user's input prompt. Can be a simple string or an array of messages for multi-turn conversations.\n   */\n  prompt?: string;\n\n  /**\n   * Conversation messages for multi-turn interactions.\n   * Replaces 'prompt' for more complex conversations.\n   */\n  messages?: AIMessage[];\n\n  /**\n   * Tools that the model can call during generation.\n   * Each tool definition includes a description, input schema, and optional execute function.\n   */\n  tools?: TOOLS;\n\n  /**\n   * Controls which tools the model can use.\n   * - \"auto\": Model decides whether to use tools\n   * - \"none\": Model cannot use tools\n   * - \"required\": Model must use at least one tool\n   * - { type: \"tool\", toolName: string }: Model must use specific tool\n   */\n  toolChoice?: ToolChoice<TOOLS>;\n\n  /**\n   * Structured output schema using Typebox.\n   * Typebox schemas are JSON Schema objects that provide full TypeScript type inference.\n   */\n  outputSchema?: SCHEMA;\n\n  /**\n   * Maximum number of tokens to generate.\n   */\n  maxOutputTokens?: number;\n\n  /**\n   * Temperature for controlling randomness (0-2).\n   * Higher values make output more random, lower values more deterministic.\n   */\n  temperature?: number;\n\n  /**\n   * Top P sampling parameter (0-1).\n   * Controls diversity by limiting to top probability tokens.\n   */\n  topP?: number;\n\n  /**\n   * Enable provider-native web search so the model can retrieve\n   * up-to-date information from the web. The search is executed\n   * server-side by the provider and any pages used are returned in\n   * {@link AIResponse.sources}.\n   *\n   * Only available on web-search-capable providers (Anthropic and\n   * Google). Check {@link AICapabilities.webSearch} via `available()`\n   * before relying on it; on unsupported providers the flag is ignored.\n   *\n   * Pass `true` for defaults, or an object to cap the number of searches.\n   */\n  webSearch?: boolean | { maxUses?: number };\n\n  /**\n   * Maximum number of sequential generation steps for agentic tool use.\n   * When the model calls a tool, its result is fed back and the model is\n   * called again, up to `maxSteps` times, until it produces a final answer.\n   *\n   * Defaults to 1 (single step \u2014 tool calls are returned but not looped),\n   * preserving prior behavior. Set higher (e.g. 6) to let the model chain\n   * tool calls into a final answer.\n   */\n  maxSteps?: number;\n}\n\n/**\n * Response from AI text generation, matching Vercel AI SDK's GenerateTextResult.\n */\nexport interface AIResponse<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * The generated text.\n   */\n  text: string;\n\n  /**\n   * Tool calls made by the model during generation.\n   */\n  toolCalls?: ToolCallArray<TOOLS>;\n\n  /**\n   * Results from tool executions.\n   */\n  toolResults?: ToolResultArray<TOOLS>;\n\n  /**\n   * Reason why the model stopped generating.\n   */\n  finishReason:\n    | \"stop\"\n    | \"length\"\n    | \"content-filter\"\n    | \"tool-calls\"\n    | \"error\"\n    | \"other\"\n    | \"unknown\";\n\n  /**\n   * Token usage information for this generation.\n   */\n  usage: AIUsage;\n\n  /**\n   * Sources used by the model (if supported).\n   */\n  sources?: Array<AISource>;\n\n  /**\n   * Structured output when using outputSchema.\n   * Type is automatically inferred from the Typebox schema.\n   */\n  output?: Static<SCHEMA>;\n\n  /**\n   * Response metadata including messages.\n   */\n  response?: {\n    id?: string;\n    timestamp?: Date;\n    modelId?: string;\n    messages?: AIMessage[];\n  };\n}\n\n// ============================================================================\n// Message Types\n// ============================================================================\n\n/**\n * A system message. It can contain system information.\n *\n * Note: using the \"system\" part of the prompt is strongly preferred\n * to increase the resilience against prompt injection attacks,\n * and because not all providers support several system messages.\n */\nexport type AISystemMessage = {\n  role: \"system\";\n  content: string;\n};\n\n/**\n * A user message. It can contain text or a combination of text and images.\n */\nexport type AIUserMessage = {\n  role: \"user\";\n  content: string | Array<TextPart | ImagePart | FilePart>;\n};\n\n/**\n * An assistant message. It can contain text, tool calls, or a combination of text and tool calls.\n */\nexport type AIAssistantMessage = {\n  role: \"assistant\";\n  content:\n    | string\n    | Array<\n        TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart\n      >;\n};\n\n/**\n * A tool message. It contains the result of one or more tool calls.\n */\nexport type AIToolMessage = {\n  role: \"tool\";\n  content: Array<ToolResultPart>;\n};\n\n/**\n * A message that can be used in the `messages` field of a prompt.\n * It can be a user message, an assistant message, or a tool message.\n */\nexport type AIMessage =\n  | AISystemMessage\n  | AIUserMessage\n  | AIAssistantMessage\n  | AIToolMessage;\n\n// ============================================================================\n// Usage & Sources\n// ============================================================================\n\n/**\n * Represents the number of tokens used in a prompt and completion.\n */\nexport type AIUsage = {\n  /**\n   * The number of tokens used in the prompt.\n   */\n  inputTokens?: number;\n  /**\n   * The number of tokens used in the completion.\n   */\n  outputTokens?: number;\n  /**\n   * The total number of tokens used (inputTokens + outputTokens).\n   */\n  totalTokens?: number;\n  /**\n   * The number of reasoning tokens used in the completion.\n   */\n  reasoningTokens?: number;\n};\n\n/**\n * A source that has been used as input to generate the response.\n */\nexport type AISource =\n  | {\n      type: \"source\";\n      /**\n       * A URL source. This is returned by web search RAG models.\n       */\n      sourceType: \"url\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * The URL of the source.\n       */\n      url: string;\n      /**\n       * The title of the source.\n       */\n      title?: string;\n    }\n  | {\n      type: \"source\";\n      /**\n       * The type of source - document sources reference files/documents.\n       */\n      sourceType: \"document\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * IANA media type of the document (e.g., 'application/pdf').\n       */\n      mediaType: string;\n      /**\n       * The title of the document.\n       */\n      title: string;\n      /**\n       * Optional filename of the document.\n       */\n      filename?: string;\n    };\n\n// ============================================================================\n// Content Parts\n// ============================================================================\n\n/**\n * Text content part of a prompt. It contains a string of text.\n */\nexport interface TextPart {\n  type: \"text\";\n  /**\n   * The text content.\n   */\n  text: string;\n}\n\n/**\n * Data content. Can either be a base64-encoded string, a Uint8Array, or an ArrayBuffer.\n */\nexport type DataContent = string | Uint8Array | ArrayBuffer;\n\n/**\n * Image content part of a prompt. It contains an image.\n */\nexport interface ImagePart {\n  type: \"image\";\n  /**\n   * Image data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the image\n   */\n  image: DataContent | URL;\n  /**\n   * Optional mime type of the image.\n   */\n  mimeType?: string;\n}\n\n/**\n * File content part of a prompt. It contains a file.\n */\nexport interface FilePart {\n  type: \"file\";\n  /**\n   * File data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the file\n   */\n  data: DataContent | URL;\n  /**\n   * Optional filename of the file.\n   */\n  filename?: string;\n  /**\n   * IANA media type of the file.\n   *\n   * @see https://www.iana.org/assignments/media-types/media-types.xhtml\n   */\n  mediaType: string;\n}\n\n/**\n * Reasoning content part of a prompt. It contains a reasoning.\n */\nexport interface ReasoningPart {\n  type: \"reasoning\";\n  /**\n   * The reasoning text.\n   */\n  text: string;\n  /**\n   * An optional signature for verifying that the reasoning originated from the model.\n   */\n  signature?: string;\n}\n\n/**\n * Redacted reasoning content part of a prompt.\n */\nexport interface RedactedReasoningPart {\n  type: \"redacted-reasoning\";\n  /**\n   * Redacted reasoning data.\n   */\n  data: string;\n}\n\n/**\n * Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).\n */\nexport interface ToolCallPart {\n  type: \"tool-call\";\n  /**\n   * ID of the tool call. This ID is used to match the tool call with the tool result.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that is being called.\n   */\n  toolName: string;\n  /**\n   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.\n   */\n  input: unknown;\n}\n\ntype JSONValue = null | string | number | boolean | JSONObject | JSONArray;\ntype JSONObject = {\n  [key: string]: JSONValue;\n};\ntype JSONArray = JSONValue[];\n\n/**\n * Tool result content part of a prompt. It contains the result of the tool call with the matching ID.\n */\nexport interface ToolResultPart {\n  type: \"tool-result\";\n  /**\n   * ID of the tool call that this result is associated with.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that generated this result.\n   */\n  toolName: string;\n  /**\n   * Result of the tool call. This is a JSON-serializable object.\n   */\n  output:\n    | {\n        type: \"text\";\n        value: string;\n      }\n    | {\n        type: \"json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"error-text\";\n        value: string;\n      }\n    | {\n        type: \"error-json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"content\";\n        value: Array<\n          | {\n              type: \"text\";\n              /**\nText content.\n*/\n              text: string;\n            }\n          | {\n              type: \"media\";\n              /**\nBase-64 encoded media data.\n*/\n              data: string;\n              /**\nIANA media type.\n@see https://www.iana.org/assignments/media-types/media-types.xhtml\n*/\n              mediaType: string;\n            }\n        >;\n      };\n}\n\n// ============================================================================\n// Tool Types\n// ============================================================================\n\ntype ToolParameters = TSchema;\n\ntype inferParameters<PARAMETERS extends ToolParameters> = Static<PARAMETERS>;\n\n/**\n * Options passed to tool execution functions.\n */\nexport interface ToolExecutionOptions {\n  /**\n   * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.\n   */\n  toolCallId: string;\n  /**\n   * Messages that were sent to the language model to initiate the response that contained the tool call.\n   * The messages **do not** include the system prompt nor the assistant response that contained the tool call.\n   */\n  messages: AIMessage[];\n  /**\n   * An optional abort signal that indicates that the overall operation should be aborted.\n   */\n  abortSignal?: AbortSignal;\n}\n\n/**\n * A tool contains the description and the schema of the input that the tool expects.\n * This enables the language model to generate the input.\n *\n * The tool can also contain an optional execute function for the actual execution function of the tool.\n */\nexport type AITool<PARAMETERS extends ToolParameters = any, RESULT = any> = {\n  /**\n   * The schema of the input that the tool expects, expressed as a Typebox\n   * schema. The language model uses this to generate (and the runtime to\n   * validate) the tool input. Use field descriptions to make the input\n   * understandable for the model.\n   *\n   * This is the canonical field read by the runtime. `parameters` is an\n   * accepted alias for backwards compatibility.\n   */\n  inputSchema: TSchema;\n  /**\n   * @deprecated Alias for {@link inputSchema}. Prefer `inputSchema`.\n   */\n  parameters?: PARAMETERS;\n  /**\n   * An optional description of what the tool does.\n   * Will be used by the language model to decide whether to use the tool.\n   * Not used for provider-defined tools.\n   */\n  description?: string;\n  /**\n   * An async function that is called with the arguments from the tool call and produces a result.\n   * If not provided, the tool will not be executed automatically.\n   *\n   * @param args - The input of the tool call\n   * @param options - Execution options including abort signal and messages\n   */\n  execute?: (\n    args: inferParameters<PARAMETERS>,\n    options: ToolExecutionOptions\n  ) => PromiseLike<RESULT>;\n} & (\n  | {\n      /**\n       * Function tool.\n       */\n      type?: undefined | \"function\";\n    }\n  | {\n      /**\n       * Provider-defined tool.\n       */\n      type: \"provider-defined\";\n      /**\n       * The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.\n       */\n      id: `${string}.${string}`;\n      /**\n       * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.\n       */\n      args: Record<string, unknown>;\n    }\n);\n\n/**\n * Tool choice for the generation. It supports the following settings:\n *\n * - `auto` (default): the model can choose whether and which tools to call.\n * - `required`: the model must call a tool. It can choose which tool to call.\n * - `none`: the model must not call tools\n * - `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool\n */\ntype ToolChoice<TOOLS extends Record<string, unknown>> =\n  | \"auto\"\n  | \"none\"\n  | \"required\"\n  | {\n      type: \"tool\";\n      toolName: Extract<keyof TOOLS, string>;\n    };\n\nexport type AIToolSet = Record<\n  string,\n  (\n    | AITool<never, never>\n    | AITool<any, any>\n    | AITool<any, never>\n    | AITool<never, any>\n  ) &\n    Pick<AITool<any, any>, \"execute\">\n>;\n\n// ============================================================================\n// Internal Helper Types\n// ============================================================================\n\ntype ToolCallUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-call\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n};\n\ntype ToolCallArray<TOOLS extends AIToolSet> = Array<ToolCallUnion<TOOLS>>;\n\ntype ToolResultUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-result\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n  result?: unknown;\n};\n\ntype ToolResultArray<TOOLS extends AIToolSet> = Array<ToolResultUnion<TOOLS>>;\n";
 export default _default;
 //# sourceMappingURL=ai.d.ts.map

package/dist/llm-docs/tools/ai.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/ai.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,yhzBAA+gzB;AAA9hzB,wBAA+hzB"}
+{"version":3,"file":"ai.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/ai.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,4gzBAAkgzB;AAAjhzB,wBAAkhzB"}

package/dist/llm-docs/tools/ai.js

@@ -4,5 +4,5 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-export default "import type { Static, TSchema } from \"typebox\";\n\nimport { ITool } from \"..\";\n\n/**\n * Built-in tool for prompting Large Language Models (LLMs).\n *\n * The AI tool provides twists and tools with access to LLM capabilities\n * for natural language processing, text generation, data extraction,\n * and intelligent decision making within their workflows.\n *\n * **Features:**\n * - Access to multiple AI providers (OpenAI, Anthropic, Google, Workers AI)\n * - Multi-turn conversation support with `messages`\n * - Tool calling with automatic execution\n * - Structured output with Typebox schemas via `outputSchema`\n * - Unified API across all models via Vercel AI SDK\n * - Automatic response parsing and validation with full type inference\n *\n * @example\n * ```typescript\n * import { Type } from \"typebox\";\n *\n * class SmartEmailTool extends Tool {\n *   private ai: AI;\n *\n *   constructor(id: string, tools: ToolBuilder) {\n *     super();\n *     this.ai = tools.get(AI);\n *   }\n *\n *   async categorizeEmail(emailContent: string) {\n *     // Define the output schema using Typebox\n *     const schema = Type.Object({\n *       category: Type.Union([\n *         Type.Literal(\"work\"),\n *         Type.Literal(\"personal\"),\n *         Type.Literal(\"spam\"),\n *         Type.Literal(\"promotional\")\n *       ]),\n *       confidence: Type.Number({ minimum: 0, maximum: 1 }),\n *       reasoning: Type.Optional(Type.String())\n *     });\n *\n *     const response = await this.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Classify emails into categories: work, personal, spam, or promotional.\",\n *       prompt: `Categorize this email: ${emailContent}`,\n *       outputSchema: schema\n *     });\n *\n *     return response.output;\n *   }\n *\n *   async generateResponse(emailContent: string) {\n *     const response = await this.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Generate professional email responses that are helpful and concise.\",\n *       prompt: `Write a response to: ${emailContent}`\n *     });\n *\n *     return response.text;\n *   }\n * }\n * ```\n */\nexport abstract class AI extends ITool {\n  /**\n   * Returns which AI capabilities are currently available.\n   * Check this before calling prompt() or embed() to gracefully\n   * handle cases where AI is disabled by the user.\n   *\n   * Built-in tools are accessed as RPC stubs, so from a twist this call\n   * resolves asynchronously — always `await` it.\n   */\n  abstract available(): AICapabilities | Promise<AICapabilities>;\n\n  /**\n   * Sends a request to an AI model and returns the response using the Vercel AI SDK.\n   *\n   * Supports text generation, multi-turn conversations, structured outputs,\n   * and tool calling across multiple AI providers via Cloudflare AI Gateway.\n   *\n   * @param request - AI request with model, prompt/messages, and optional configuration\n   * @returns Promise resolving to the AI response with generated text and metadata\n   *\n   * @example\n   * ```typescript\n   * // Simple text generation\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Explain quantum computing in simple terms\"\n   * });\n   * console.log(response.text);\n   *\n   * // Fast and cheap for simple tasks\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"low\" },\n   *   prompt: \"Summarize this text...\"\n   * });\n   * console.log(response.text);\n   *\n   * // With system instructions for complex reasoning\n   * const response = await ai.prompt({\n   *   model: { speed: \"capable\", cost: \"high\" },\n   *   system: \"You are a helpful physics tutor.\",\n   *   prompt: \"Explain quantum entanglement\"\n   * });\n   * console.log(response.text);\n   *\n   * // Multi-turn conversation\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   messages: [\n   *     { role: \"user\", content: \"What is 2+2?\" },\n   *     { role: \"assistant\", content: \"2+2 equals 4.\" },\n   *     { role: \"user\", content: \"What about 3+3?\" }\n   *   ]\n   * });\n   * console.log(response.text);\n   *\n   * // Structured output with Typebox schema\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Extract information: John is 30 years old\",\n   *   outputSchema: Type.Object({\n   *     name: Type.String(),\n   *     age: Type.Number()\n   *   })\n   * });\n   * console.log(response.output); // { name: \"John\", age: 30 }\n   *\n   * // Tool calling\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   prompt: \"What's the weather in San Francisco?\",\n   *   tools: {\n   *     getWeather: {\n   *       description: \"Get weather for a city\",\n   *       inputSchema: Type.Object({\n   *         city: Type.String()\n   *       }),\n   *       execute: async ({ city }) => {\n   *         return { temp: 72, condition: \"sunny\" };\n   *       }\n   *     }\n   *   }\n   * });\n   * console.log(response.text); // Model's response using tool results\n   * console.log(response.toolCalls); // Array of tool calls made\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract prompt<TOOLS extends AIToolSet, SCHEMA extends TSchema = never>(\n    request: AIRequest<TOOLS, SCHEMA>\n  ): Promise<AIResponse<TOOLS, SCHEMA>>;\n}\n\n/** Options for configuring AI tool usage in a twist. */\nexport type AIOptions = {\n  /** Whether AI is required for this twist to function. Default: true */\n  required?: boolean;\n};\n\n/** Describes which AI capabilities are currently available to this twist. */\nexport type AICapabilities = {\n  /** Whether AI prompting (text generation) is available. */\n  prompt: boolean;\n  /** Whether AI embedding generation is available. */\n  embed: boolean;\n  /**\n   * Whether provider-native web search is available. True for Plot AI and\n   * Anthropic/Google BYOK providers; false for OpenAI/custom BYOK providers\n   * that don't expose a server-side web search tool through this runtime.\n   */\n  webSearch: boolean;\n};\n\n/**\n * Model preferences for selecting an AI model based on performance and cost requirements.\n * This allows Plot to match those preferences with user preferences (such as preferred or\n * disallowed providers), as well as availability of newer and better models.\n *\n * @example\n * ```typescript\n * // Fast and cheap - uses Workers AI models like Llama 3.2 1B\n * const response = await ai.prompt({\n *   model: { speed: \"fast\", cost: \"low\" },\n *   prompt: \"Summarize this in one sentence: ...\"\n * });\n *\n * // Balanced performance - uses GPT-5 Mini or Gemini 2.5 Flash\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\" },\n *   prompt: \"Analyze this data...\"\n * });\n *\n * // Most capable - uses Claude Sonnet 4.5 or Opus 4.1\n * const response = await ai.prompt({\n *   model: { speed: \"capable\", cost: \"high\" },\n *   prompt: \"Solve this complex reasoning problem...\"\n * });\n *\n * // Request a specific model with a hint\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\", hint: AIModel.CLAUDE_SONNET_45 },\n *   prompt: \"...\"\n * });\n * ```\n */\nexport type ModelPreferences = {\n  /**\n   * Desired speed tier:\n   * - \"fast\": Optimized for low latency and quick responses\n   * - \"balanced\": Good balance of speed and capability\n   * - \"capable\": Maximum reasoning and problem-solving ability\n   */\n  speed: \"fast\" | \"balanced\" | \"capable\";\n\n  /**\n   * Desired cost tier:\n   * - \"low\": Minimal cost, often using Workers AI models (free/very cheap)\n   * - \"medium\": Moderate pricing for good performance\n   * - \"high\": Premium pricing for best-in-class models\n   */\n  cost: \"low\" | \"medium\" | \"high\";\n\n  /**\n   * Optional hint to suggest a specific model. The system will use this\n   * model if possible, but may override it based on user preferences.\n   */\n  hint?: AIModel;\n};\n\n/**\n * Supported AI models available through Cloudflare AI Gateway and Workers AI.\n *\n * Models are organized by provider:\n * - **OpenAI**: Latest GPT models via AI Gateway\n * - **Anthropic**: Claude models via AI Gateway (prefix with \"anthropic/\")\n * - **Google**: Gemini models via AI Gateway (prefix with \"google-ai-studio/\")\n * - **Workers AI**: Models running on Cloudflare's network (free/low cost)\n */\nexport enum AIModel {\n  // OpenAI models - Latest GPT and reasoning models\n  GPT_5 = \"openai/gpt-5\",\n  GPT_5_PRO = \"openai/gpt-5-pro\",\n  GPT_5_MINI = \"openai/gpt-5-mini\",\n  GPT_5_NANO = \"openai/gpt-5-nano\",\n  GPT_4O = \"openai/gpt-4o\",\n  GPT_4O_MINI = \"openai/gpt-4o-mini\",\n  O3 = \"openai/o3\",\n  O3_MINI = \"openai/o3-mini\",\n\n  // Anthropic models - Claude 4.x series\n  CLAUDE_OPUS_46 = \"anthropic/claude-opus-4-6\",\n  CLAUDE_SONNET_46 = \"anthropic/claude-sonnet-4-6\",\n  CLAUDE_HAIKU_45 = \"anthropic/claude-haiku-4-5\",\n\n  // Google models - Gemini 2.x series\n  GEMINI_25_PRO = \"google/gemini-2.5-pro\",\n  GEMINI_25_FLASH = \"google/gemini-2.5-flash\",\n  GEMINI_25_FLASH_LITE = \"google/gemini-2.5-flash-lite\",\n  GEMINI_20_FLASH = \"google/gemini-2.0-flash\",\n  GEMINI_20_FLASH_LITE = \"google/gemini-2.0-flash-lite\",\n\n  // Cloudflare Workers AI models - Free/low-cost models running on Cloudflare's network\n  LLAMA_4_SCOUT_17B = \"meta/llama-4-scout-17b-16e-instruct\",\n  LLAMA_33_70B = \"meta/llama-3.3-70b-instruct-fp8-fast\",\n  LLAMA_31_8B = \"meta/llama-3.1-8b-instruct-fp8\",\n  LLAMA_32_1B = \"meta/llama-3.2-1b-instruct\",\n  DEEPSEEK_R1_32B = \"deepseek-ai/deepseek-r1-distill-qwen-32b\",\n}\n\n/**\n * Request parameters for AI text generation, matching Vercel AI SDK's generateText() function.\n */\nexport interface AIRequest<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * Model selection preferences based on desired speed and cost characteristics.\n   * Plot will automatically select the best available model matching these preferences.\n   *\n   * @example\n   * // Fast and cheap - good for simple tasks\n   * model: { speed: \"fast\", cost: \"low\" }\n   *\n   * @example\n   * // Balanced performance - general purpose\n   * model: { speed: \"balanced\", cost: \"medium\" }\n   *\n   * @example\n   * // Maximum capability - complex reasoning\n   * model: { speed: \"capable\", cost: \"high\" }\n   *\n   * @example\n   * // With a specific model hint\n   * model: { speed: \"balanced\", cost: \"medium\", hint: \"anthropic/claude-sonnet-4-6\" }\n   */\n  model: ModelPreferences;\n\n  /**\n   * System instructions to guide the model's behavior.\n   */\n  system?: string;\n\n  /**\n   * The user's input prompt. Can be a simple string or an array of messages for multi-turn conversations.\n   */\n  prompt?: string;\n\n  /**\n   * Conversation messages for multi-turn interactions.\n   * Replaces 'prompt' for more complex conversations.\n   */\n  messages?: AIMessage[];\n\n  /**\n   * Tools that the model can call during generation.\n   * Each tool definition includes a description, input schema, and optional execute function.\n   */\n  tools?: TOOLS;\n\n  /**\n   * Controls which tools the model can use.\n   * - \"auto\": Model decides whether to use tools\n   * - \"none\": Model cannot use tools\n   * - \"required\": Model must use at least one tool\n   * - { type: \"tool\", toolName: string }: Model must use specific tool\n   */\n  toolChoice?: ToolChoice<TOOLS>;\n\n  /**\n   * Structured output schema using Typebox.\n   * Typebox schemas are JSON Schema objects that provide full TypeScript type inference.\n   */\n  outputSchema?: SCHEMA;\n\n  /**\n   * Maximum number of tokens to generate.\n   */\n  maxOutputTokens?: number;\n\n  /**\n   * Temperature for controlling randomness (0-2).\n   * Higher values make output more random, lower values more deterministic.\n   */\n  temperature?: number;\n\n  /**\n   * Top P sampling parameter (0-1).\n   * Controls diversity by limiting to top probability tokens.\n   */\n  topP?: number;\n\n  /**\n   * Enable provider-native web search so the model can retrieve\n   * up-to-date information from the web. The search is executed\n   * server-side by the provider and any pages used are returned in\n   * {@link AIResponse.sources}.\n   *\n   * Only available on web-search-capable providers (Anthropic and\n   * Google). Check {@link AICapabilities.webSearch} via `available()`\n   * before relying on it; on unsupported providers the flag is ignored.\n   *\n   * Pass `true` for defaults, or an object to cap the number of searches.\n   */\n  webSearch?: boolean | { maxUses?: number };\n\n  /**\n   * Maximum number of sequential generation steps for agentic tool use.\n   * When the model calls a tool, its result is fed back and the model is\n   * called again, up to `maxSteps` times, until it produces a final answer.\n   *\n   * Defaults to 1 (single step — tool calls are returned but not looped),\n   * preserving prior behavior. Set higher (e.g. 6) to let the model chain\n   * tool calls into a final answer.\n   */\n  maxSteps?: number;\n}\n\n/**\n * Response from AI text generation, matching Vercel AI SDK's GenerateTextResult.\n */\nexport interface AIResponse<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * The generated text.\n   */\n  text: string;\n\n  /**\n   * Tool calls made by the model during generation.\n   */\n  toolCalls?: ToolCallArray<TOOLS>;\n\n  /**\n   * Results from tool executions.\n   */\n  toolResults?: ToolResultArray<TOOLS>;\n\n  /**\n   * Reason why the model stopped generating.\n   */\n  finishReason:\n    | \"stop\"\n    | \"length\"\n    | \"content-filter\"\n    | \"tool-calls\"\n    | \"error\"\n    | \"other\"\n    | \"unknown\";\n\n  /**\n   * Token usage information for this generation.\n   */\n  usage: AIUsage;\n\n  /**\n   * Sources used by the model (if supported).\n   */\n  sources?: Array<AISource>;\n\n  /**\n   * Structured output when using outputSchema.\n   * Type is automatically inferred from the Typebox schema.\n   */\n  output?: Static<SCHEMA>;\n\n  /**\n   * Response metadata including messages.\n   */\n  response?: {\n    id?: string;\n    timestamp?: Date;\n    modelId?: string;\n    messages?: AIMessage[];\n  };\n}\n\n// ============================================================================\n// Message Types\n// ============================================================================\n\n/**\n * A system message. It can contain system information.\n *\n * Note: using the \"system\" part of the prompt is strongly preferred\n * to increase the resilience against prompt injection attacks,\n * and because not all providers support several system messages.\n */\nexport type AISystemMessage = {\n  role: \"system\";\n  content: string;\n};\n\n/**\n * A user message. It can contain text or a combination of text and images.\n */\nexport type AIUserMessage = {\n  role: \"user\";\n  content: string | Array<TextPart | ImagePart | FilePart>;\n};\n\n/**\n * An assistant message. It can contain text, tool calls, or a combination of text and tool calls.\n */\nexport type AIAssistantMessage = {\n  role: \"assistant\";\n  content:\n    | string\n    | Array<\n        TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart\n      >;\n};\n\n/**\n * A tool message. It contains the result of one or more tool calls.\n */\nexport type AIToolMessage = {\n  role: \"tool\";\n  content: Array<ToolResultPart>;\n};\n\n/**\n * A message that can be used in the `messages` field of a prompt.\n * It can be a user message, an assistant message, or a tool message.\n */\nexport type AIMessage =\n  | AISystemMessage\n  | AIUserMessage\n  | AIAssistantMessage\n  | AIToolMessage;\n\n// ============================================================================\n// Usage & Sources\n// ============================================================================\n\n/**\n * Represents the number of tokens used in a prompt and completion.\n */\nexport type AIUsage = {\n  /**\n   * The number of tokens used in the prompt.\n   */\n  inputTokens?: number;\n  /**\n   * The number of tokens used in the completion.\n   */\n  outputTokens?: number;\n  /**\n   * The total number of tokens used (promptTokens + completionTokens).\n   */\n  totalTokens?: number;\n  /**\n   * The number of reasoning tokens used in the completion.\n   */\n  reasoningTokens?: number;\n};\n\n/**\n * A source that has been used as input to generate the response.\n */\nexport type AISource =\n  | {\n      type: \"source\";\n      /**\n       * A URL source. This is returned by web search RAG models.\n       */\n      sourceType: \"url\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * The URL of the source.\n       */\n      url: string;\n      /**\n       * The title of the source.\n       */\n      title?: string;\n    }\n  | {\n      type: \"source\";\n      /**\n       * The type of source - document sources reference files/documents.\n       */\n      sourceType: \"document\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * IANA media type of the document (e.g., 'application/pdf').\n       */\n      mediaType: string;\n      /**\n       * The title of the document.\n       */\n      title: string;\n      /**\n       * Optional filename of the document.\n       */\n      filename?: string;\n    };\n\n// ============================================================================\n// Content Parts\n// ============================================================================\n\n/**\n * Text content part of a prompt. It contains a string of text.\n */\nexport interface TextPart {\n  type: \"text\";\n  /**\n   * The text content.\n   */\n  text: string;\n}\n\n/**\n * Data content. Can either be a base64-encoded string, a Uint8Array, or an ArrayBuffer.\n */\nexport type DataContent = string | Uint8Array | ArrayBuffer;\n\n/**\n * Image content part of a prompt. It contains an image.\n */\nexport interface ImagePart {\n  type: \"image\";\n  /**\n   * Image data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the image\n   */\n  image: DataContent | URL;\n  /**\n   * Optional mime type of the image.\n   */\n  mimeType?: string;\n}\n\n/**\n * File content part of a prompt. It contains a file.\n */\nexport interface FilePart {\n  type: \"file\";\n  /**\n   * File data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the file\n   */\n  data: DataContent | URL;\n  /**\n   * Optional filename of the file.\n   */\n  filename?: string;\n  /**\n   * IANA media type of the file.\n   *\n   * @see https://www.iana.org/assignments/media-types/media-types.xhtml\n   */\n  mediaType: string;\n}\n\n/**\n * Reasoning content part of a prompt. It contains a reasoning.\n */\nexport interface ReasoningPart {\n  type: \"reasoning\";\n  /**\n   * The reasoning text.\n   */\n  text: string;\n  /**\n   * An optional signature for verifying that the reasoning originated from the model.\n   */\n  signature?: string;\n}\n\n/**\n * Redacted reasoning content part of a prompt.\n */\nexport interface RedactedReasoningPart {\n  type: \"redacted-reasoning\";\n  /**\n   * Redacted reasoning data.\n   */\n  data: string;\n}\n\n/**\n * Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).\n */\nexport interface ToolCallPart {\n  type: \"tool-call\";\n  /**\n   * ID of the tool call. This ID is used to match the tool call with the tool result.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that is being called.\n   */\n  toolName: string;\n  /**\n   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.\n   */\n  input: unknown;\n}\n\ntype JSONValue = null | string | number | boolean | JSONObject | JSONArray;\ntype JSONObject = {\n  [key: string]: JSONValue;\n};\ntype JSONArray = JSONValue[];\n\n/**\n * Tool result content part of a prompt. It contains the result of the tool call with the matching ID.\n */\nexport interface ToolResultPart {\n  type: \"tool-result\";\n  /**\n   * ID of the tool call that this result is associated with.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that generated this result.\n   */\n  toolName: string;\n  /**\n   * Result of the tool call. This is a JSON-serializable object.\n   */\n  output:\n    | {\n        type: \"text\";\n        value: string;\n      }\n    | {\n        type: \"json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"error-text\";\n        value: string;\n      }\n    | {\n        type: \"error-json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"content\";\n        value: Array<\n          | {\n              type: \"text\";\n              /**\nText content.\n*/\n              text: string;\n            }\n          | {\n              type: \"media\";\n              /**\nBase-64 encoded media data.\n*/\n              data: string;\n              /**\nIANA media type.\n@see https://www.iana.org/assignments/media-types/media-types.xhtml\n*/\n              mediaType: string;\n            }\n        >;\n      };\n}\n\n// ============================================================================\n// Tool Types\n// ============================================================================\n\ntype ToolParameters = TSchema;\n\ntype inferParameters<PARAMETERS extends ToolParameters> = Static<PARAMETERS>;\n\n/**\n * Options passed to tool execution functions.\n */\nexport interface ToolExecutionOptions {\n  /**\n   * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.\n   */\n  toolCallId: string;\n  /**\n   * Messages that were sent to the language model to initiate the response that contained the tool call.\n   * The messages **do not** include the system prompt nor the assistant response that contained the tool call.\n   */\n  messages: AIMessage[];\n  /**\n   * An optional abort signal that indicates that the overall operation should be aborted.\n   */\n  abortSignal?: AbortSignal;\n}\n\n/**\n * A tool contains the description and the schema of the input that the tool expects.\n * This enables the language model to generate the input.\n *\n * The tool can also contain an optional execute function for the actual execution function of the tool.\n */\nexport type AITool<PARAMETERS extends ToolParameters = any, RESULT = any> = {\n  /**\n   * The schema of the input that the tool expects, expressed as a Typebox\n   * schema. The language model uses this to generate (and the runtime to\n   * validate) the tool input. Use field descriptions to make the input\n   * understandable for the model.\n   *\n   * This is the canonical field read by the runtime. `parameters` is an\n   * accepted alias for backwards compatibility.\n   */\n  inputSchema: TSchema;\n  /**\n   * @deprecated Alias for {@link inputSchema}. Prefer `inputSchema`.\n   */\n  parameters?: PARAMETERS;\n  /**\n   * An optional description of what the tool does.\n   * Will be used by the language model to decide whether to use the tool.\n   * Not used for provider-defined tools.\n   */\n  description?: string;\n  /**\n   * An async function that is called with the arguments from the tool call and produces a result.\n   * If not provided, the tool will not be executed automatically.\n   *\n   * @param args - The input of the tool call\n   * @param options - Execution options including abort signal and messages\n   */\n  execute?: (\n    args: inferParameters<PARAMETERS>,\n    options: ToolExecutionOptions\n  ) => PromiseLike<RESULT>;\n} & (\n  | {\n      /**\n       * Function tool.\n       */\n      type?: undefined | \"function\";\n    }\n  | {\n      /**\n       * Provider-defined tool.\n       */\n      type: \"provider-defined\";\n      /**\n       * The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.\n       */\n      id: `${string}.${string}`;\n      /**\n       * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.\n       */\n      args: Record<string, unknown>;\n    }\n);\n\n/**\n * Tool choice for the generation. It supports the following settings:\n *\n * - `auto` (default): the model can choose whether and which tools to call.\n * - `required`: the model must call a tool. It can choose which tool to call.\n * - `none`: the model must not call tools\n * - `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool\n */\ntype ToolChoice<TOOLS extends Record<string, unknown>> =\n  | \"auto\"\n  | \"none\"\n  | \"required\"\n  | {\n      type: \"tool\";\n      toolName: Extract<keyof TOOLS, string>;\n    };\n\nexport type AIToolSet = Record<\n  string,\n  (\n    | AITool<never, never>\n    | AITool<any, any>\n    | AITool<any, never>\n    | AITool<never, any>\n  ) &\n    Pick<AITool<any, any>, \"execute\">\n>;\n\n// ============================================================================\n// Internal Helper Types\n// ============================================================================\n\ntype ToolCallUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-call\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n};\n\ntype ToolCallArray<TOOLS extends AIToolSet> = Array<ToolCallUnion<TOOLS>>;\n\ntype ToolResultUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-result\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n  result?: unknown;\n};\n\ntype ToolResultArray<TOOLS extends AIToolSet> = Array<ToolResultUnion<TOOLS>>;\n";
+export default "import type { Static, TSchema } from \"typebox\";\n\nimport { ITool } from \"..\";\n\n/**\n * Built-in tool for prompting Large Language Models (LLMs).\n *\n * The AI tool provides twists and tools with access to LLM capabilities\n * for natural language processing, text generation, data extraction,\n * and intelligent decision making within their workflows.\n *\n * **Features:**\n * - Access to multiple AI providers (OpenAI, Anthropic, Google, Workers AI)\n * - Multi-turn conversation support with `messages`\n * - Tool calling with automatic execution\n * - Structured output with Typebox schemas via `outputSchema`\n * - Unified API across all models via Vercel AI SDK\n * - Automatic response parsing and validation with full type inference\n *\n * @example\n * ```typescript\n * import { Type } from \"typebox\";\n *\n * class SmartEmailTool extends Tool<SmartEmailTool> {\n *   build(build: ToolBuilder) {\n *     return {\n *       ai: build(AI),\n *     };\n *   }\n *\n *   async categorizeEmail(emailContent: string) {\n *     // Define the output schema using Typebox\n *     const schema = Type.Object({\n *       category: Type.Union([\n *         Type.Literal(\"work\"),\n *         Type.Literal(\"personal\"),\n *         Type.Literal(\"spam\"),\n *         Type.Literal(\"promotional\")\n *       ]),\n *       confidence: Type.Number({ minimum: 0, maximum: 1 }),\n *       reasoning: Type.Optional(Type.String())\n *     });\n *\n *     const response = await this.tools.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Classify emails into categories: work, personal, spam, or promotional.\",\n *       prompt: `Categorize this email: ${emailContent}`,\n *       outputSchema: schema\n *     });\n *\n *     return response.output;\n *   }\n *\n *   async generateResponse(emailContent: string) {\n *     const response = await this.tools.ai.prompt({\n *       model: { speed: \"fast\", cost: \"medium\" },\n *       system: \"Generate professional email responses that are helpful and concise.\",\n *       prompt: `Write a response to: ${emailContent}`\n *     });\n *\n *     return response.text;\n *   }\n * }\n * ```\n */\nexport abstract class AI extends ITool {\n  /**\n   * Returns which AI capabilities are currently available.\n   * Check this before calling prompt() to gracefully\n   * handle cases where AI is disabled by the user.\n   *\n   * Built-in tools are accessed as RPC stubs, so from a twist this call\n   * resolves asynchronously — always `await` it.\n   */\n  abstract available(): AICapabilities | Promise<AICapabilities>;\n\n  /**\n   * Sends a request to an AI model and returns the response using the Vercel AI SDK.\n   *\n   * Supports text generation, multi-turn conversations, structured outputs,\n   * and tool calling across multiple AI providers via Cloudflare AI Gateway.\n   *\n   * @param request - AI request with model, prompt/messages, and optional configuration\n   * @returns Promise resolving to the AI response with generated text and metadata\n   *\n   * @example\n   * ```typescript\n   * // Simple text generation\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Explain quantum computing in simple terms\"\n   * });\n   * console.log(response.text);\n   *\n   * // Fast and cheap for simple tasks\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"low\" },\n   *   prompt: \"Summarize this text...\"\n   * });\n   * console.log(response.text);\n   *\n   * // With system instructions for complex reasoning\n   * const response = await ai.prompt({\n   *   model: { speed: \"capable\", cost: \"high\" },\n   *   system: \"You are a helpful physics tutor.\",\n   *   prompt: \"Explain quantum entanglement\"\n   * });\n   * console.log(response.text);\n   *\n   * // Multi-turn conversation\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   messages: [\n   *     { role: \"user\", content: \"What is 2+2?\" },\n   *     { role: \"assistant\", content: \"2+2 equals 4.\" },\n   *     { role: \"user\", content: \"What about 3+3?\" }\n   *   ]\n   * });\n   * console.log(response.text);\n   *\n   * // Structured output with Typebox schema\n   * const response = await ai.prompt({\n   *   model: { speed: \"fast\", cost: \"medium\" },\n   *   prompt: \"Extract information: John is 30 years old\",\n   *   outputSchema: Type.Object({\n   *     name: Type.String(),\n   *     age: Type.Number()\n   *   })\n   * });\n   * console.log(response.output); // { name: \"John\", age: 30 }\n   *\n   * // Tool calling\n   * const response = await ai.prompt({\n   *   model: { speed: \"balanced\", cost: \"medium\" },\n   *   prompt: \"What's the weather in San Francisco?\",\n   *   tools: {\n   *     getWeather: {\n   *       description: \"Get weather for a city\",\n   *       inputSchema: Type.Object({\n   *         city: Type.String()\n   *       }),\n   *       execute: async ({ city }) => {\n   *         return { temp: 72, condition: \"sunny\" };\n   *       }\n   *     }\n   *   }\n   * });\n   * console.log(response.text); // Model's response using tool results\n   * console.log(response.toolCalls); // Array of tool calls made\n   * ```\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract prompt<TOOLS extends AIToolSet, SCHEMA extends TSchema = never>(\n    request: AIRequest<TOOLS, SCHEMA>\n  ): Promise<AIResponse<TOOLS, SCHEMA>>;\n}\n\n/** Options for configuring AI tool usage in a twist. */\nexport type AIOptions = {\n  /** Whether AI is required for this twist to function. Default: true */\n  required?: boolean;\n};\n\n/** Describes which AI capabilities are currently available to this twist. */\nexport type AICapabilities = {\n  /** Whether AI prompting (text generation) is available. */\n  prompt: boolean;\n  /** Whether AI embedding generation is available. */\n  embed: boolean;\n  /**\n   * Whether provider-native web search is available. True for Plot AI and\n   * Anthropic/Google BYOK providers; false for OpenAI/custom BYOK providers\n   * that don't expose a server-side web search tool through this runtime.\n   */\n  webSearch: boolean;\n};\n\n/**\n * Model preferences for selecting an AI model based on performance and cost requirements.\n * This allows Plot to match those preferences with user preferences (such as preferred or\n * disallowed providers), as well as availability of newer and better models.\n *\n * @example\n * ```typescript\n * // Fast and cheap - uses Workers AI models like Llama 3.2 1B\n * const response = await ai.prompt({\n *   model: { speed: \"fast\", cost: \"low\" },\n *   prompt: \"Summarize this in one sentence: ...\"\n * });\n *\n * // Balanced performance - uses GPT-5 Mini or Gemini 2.5 Flash\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\" },\n *   prompt: \"Analyze this data...\"\n * });\n *\n * // Most capable - uses models like GPT-5, Claude Sonnet 4.6, or Gemini 2.5 Pro\n * const response = await ai.prompt({\n *   model: { speed: \"capable\", cost: \"high\" },\n *   prompt: \"Solve this complex reasoning problem...\"\n * });\n *\n * // Request a specific model with a hint\n * const response = await ai.prompt({\n *   model: { speed: \"balanced\", cost: \"medium\", hint: AIModel.CLAUDE_SONNET_46 },\n *   prompt: \"...\"\n * });\n * ```\n */\nexport type ModelPreferences = {\n  /**\n   * Desired speed tier:\n   * - \"fast\": Optimized for low latency and quick responses\n   * - \"balanced\": Good balance of speed and capability\n   * - \"capable\": Maximum reasoning and problem-solving ability\n   */\n  speed: \"fast\" | \"balanced\" | \"capable\";\n\n  /**\n   * Desired cost tier:\n   * - \"low\": Minimal cost, often using Workers AI models (free/very cheap)\n   * - \"medium\": Moderate pricing for good performance\n   * - \"high\": Premium pricing for best-in-class models\n   */\n  cost: \"low\" | \"medium\" | \"high\";\n\n  /**\n   * Optional hint to suggest a specific model. The system will use this\n   * model if possible, but may override it based on user preferences.\n   */\n  hint?: AIModel;\n};\n\n/**\n * Supported AI models available through Cloudflare AI Gateway and Workers AI.\n *\n * Models are organized by provider:\n * - **OpenAI**: Latest GPT models via AI Gateway\n * - **Anthropic**: Claude models via AI Gateway (prefix with \"anthropic/\")\n * - **Google**: Gemini models via AI Gateway (prefix with \"google/\")\n * - **Workers AI**: Models running on Cloudflare's network (free/low cost)\n */\nexport enum AIModel {\n  // OpenAI models - Latest GPT and reasoning models\n  GPT_5 = \"openai/gpt-5\",\n  GPT_5_PRO = \"openai/gpt-5-pro\",\n  GPT_5_MINI = \"openai/gpt-5-mini\",\n  GPT_5_NANO = \"openai/gpt-5-nano\",\n  GPT_4O = \"openai/gpt-4o\",\n  GPT_4O_MINI = \"openai/gpt-4o-mini\",\n  O3 = \"openai/o3\",\n  O3_MINI = \"openai/o3-mini\",\n\n  // Anthropic models - Claude 4.x series\n  CLAUDE_OPUS_46 = \"anthropic/claude-opus-4-6\",\n  CLAUDE_SONNET_46 = \"anthropic/claude-sonnet-4-6\",\n  CLAUDE_HAIKU_45 = \"anthropic/claude-haiku-4-5\",\n\n  // Google models - Gemini 2.x series\n  GEMINI_25_PRO = \"google/gemini-2.5-pro\",\n  GEMINI_25_FLASH = \"google/gemini-2.5-flash\",\n  GEMINI_25_FLASH_LITE = \"google/gemini-2.5-flash-lite\",\n  GEMINI_20_FLASH = \"google/gemini-2.0-flash\",\n  GEMINI_20_FLASH_LITE = \"google/gemini-2.0-flash-lite\",\n\n  // Cloudflare Workers AI models - Free/low-cost models running on Cloudflare's network\n  LLAMA_4_SCOUT_17B = \"meta/llama-4-scout-17b-16e-instruct\",\n  LLAMA_33_70B = \"meta/llama-3.3-70b-instruct-fp8-fast\",\n  LLAMA_31_8B = \"meta/llama-3.1-8b-instruct-fp8\",\n  LLAMA_32_1B = \"meta/llama-3.2-1b-instruct\",\n  DEEPSEEK_R1_32B = \"deepseek-ai/deepseek-r1-distill-qwen-32b\",\n}\n\n/**\n * Request parameters for AI text generation, matching Vercel AI SDK's generateText() function.\n */\nexport interface AIRequest<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * Model selection preferences based on desired speed and cost characteristics.\n   * Plot will automatically select the best available model matching these preferences.\n   *\n   * @example\n   * // Fast and cheap - good for simple tasks\n   * model: { speed: \"fast\", cost: \"low\" }\n   *\n   * @example\n   * // Balanced performance - general purpose\n   * model: { speed: \"balanced\", cost: \"medium\" }\n   *\n   * @example\n   * // Maximum capability - complex reasoning\n   * model: { speed: \"capable\", cost: \"high\" }\n   *\n   * @example\n   * // With a specific model hint\n   * model: { speed: \"balanced\", cost: \"medium\", hint: \"anthropic/claude-sonnet-4-6\" }\n   */\n  model: ModelPreferences;\n\n  /**\n   * System instructions to guide the model's behavior.\n   */\n  system?: string;\n\n  /**\n   * The user's input prompt. Can be a simple string or an array of messages for multi-turn conversations.\n   */\n  prompt?: string;\n\n  /**\n   * Conversation messages for multi-turn interactions.\n   * Replaces 'prompt' for more complex conversations.\n   */\n  messages?: AIMessage[];\n\n  /**\n   * Tools that the model can call during generation.\n   * Each tool definition includes a description, input schema, and optional execute function.\n   */\n  tools?: TOOLS;\n\n  /**\n   * Controls which tools the model can use.\n   * - \"auto\": Model decides whether to use tools\n   * - \"none\": Model cannot use tools\n   * - \"required\": Model must use at least one tool\n   * - { type: \"tool\", toolName: string }: Model must use specific tool\n   */\n  toolChoice?: ToolChoice<TOOLS>;\n\n  /**\n   * Structured output schema using Typebox.\n   * Typebox schemas are JSON Schema objects that provide full TypeScript type inference.\n   */\n  outputSchema?: SCHEMA;\n\n  /**\n   * Maximum number of tokens to generate.\n   */\n  maxOutputTokens?: number;\n\n  /**\n   * Temperature for controlling randomness (0-2).\n   * Higher values make output more random, lower values more deterministic.\n   */\n  temperature?: number;\n\n  /**\n   * Top P sampling parameter (0-1).\n   * Controls diversity by limiting to top probability tokens.\n   */\n  topP?: number;\n\n  /**\n   * Enable provider-native web search so the model can retrieve\n   * up-to-date information from the web. The search is executed\n   * server-side by the provider and any pages used are returned in\n   * {@link AIResponse.sources}.\n   *\n   * Only available on web-search-capable providers (Anthropic and\n   * Google). Check {@link AICapabilities.webSearch} via `available()`\n   * before relying on it; on unsupported providers the flag is ignored.\n   *\n   * Pass `true` for defaults, or an object to cap the number of searches.\n   */\n  webSearch?: boolean | { maxUses?: number };\n\n  /**\n   * Maximum number of sequential generation steps for agentic tool use.\n   * When the model calls a tool, its result is fed back and the model is\n   * called again, up to `maxSteps` times, until it produces a final answer.\n   *\n   * Defaults to 1 (single step — tool calls are returned but not looped),\n   * preserving prior behavior. Set higher (e.g. 6) to let the model chain\n   * tool calls into a final answer.\n   */\n  maxSteps?: number;\n}\n\n/**\n * Response from AI text generation, matching Vercel AI SDK's GenerateTextResult.\n */\nexport interface AIResponse<\n  TOOLS extends AIToolSet,\n  SCHEMA extends TSchema = never\n> {\n  /**\n   * The generated text.\n   */\n  text: string;\n\n  /**\n   * Tool calls made by the model during generation.\n   */\n  toolCalls?: ToolCallArray<TOOLS>;\n\n  /**\n   * Results from tool executions.\n   */\n  toolResults?: ToolResultArray<TOOLS>;\n\n  /**\n   * Reason why the model stopped generating.\n   */\n  finishReason:\n    | \"stop\"\n    | \"length\"\n    | \"content-filter\"\n    | \"tool-calls\"\n    | \"error\"\n    | \"other\"\n    | \"unknown\";\n\n  /**\n   * Token usage information for this generation.\n   */\n  usage: AIUsage;\n\n  /**\n   * Sources used by the model (if supported).\n   */\n  sources?: Array<AISource>;\n\n  /**\n   * Structured output when using outputSchema.\n   * Type is automatically inferred from the Typebox schema.\n   */\n  output?: Static<SCHEMA>;\n\n  /**\n   * Response metadata including messages.\n   */\n  response?: {\n    id?: string;\n    timestamp?: Date;\n    modelId?: string;\n    messages?: AIMessage[];\n  };\n}\n\n// ============================================================================\n// Message Types\n// ============================================================================\n\n/**\n * A system message. It can contain system information.\n *\n * Note: using the \"system\" part of the prompt is strongly preferred\n * to increase the resilience against prompt injection attacks,\n * and because not all providers support several system messages.\n */\nexport type AISystemMessage = {\n  role: \"system\";\n  content: string;\n};\n\n/**\n * A user message. It can contain text or a combination of text and images.\n */\nexport type AIUserMessage = {\n  role: \"user\";\n  content: string | Array<TextPart | ImagePart | FilePart>;\n};\n\n/**\n * An assistant message. It can contain text, tool calls, or a combination of text and tool calls.\n */\nexport type AIAssistantMessage = {\n  role: \"assistant\";\n  content:\n    | string\n    | Array<\n        TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart\n      >;\n};\n\n/**\n * A tool message. It contains the result of one or more tool calls.\n */\nexport type AIToolMessage = {\n  role: \"tool\";\n  content: Array<ToolResultPart>;\n};\n\n/**\n * A message that can be used in the `messages` field of a prompt.\n * It can be a user message, an assistant message, or a tool message.\n */\nexport type AIMessage =\n  | AISystemMessage\n  | AIUserMessage\n  | AIAssistantMessage\n  | AIToolMessage;\n\n// ============================================================================\n// Usage & Sources\n// ============================================================================\n\n/**\n * Represents the number of tokens used in a prompt and completion.\n */\nexport type AIUsage = {\n  /**\n   * The number of tokens used in the prompt.\n   */\n  inputTokens?: number;\n  /**\n   * The number of tokens used in the completion.\n   */\n  outputTokens?: number;\n  /**\n   * The total number of tokens used (inputTokens + outputTokens).\n   */\n  totalTokens?: number;\n  /**\n   * The number of reasoning tokens used in the completion.\n   */\n  reasoningTokens?: number;\n};\n\n/**\n * A source that has been used as input to generate the response.\n */\nexport type AISource =\n  | {\n      type: \"source\";\n      /**\n       * A URL source. This is returned by web search RAG models.\n       */\n      sourceType: \"url\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * The URL of the source.\n       */\n      url: string;\n      /**\n       * The title of the source.\n       */\n      title?: string;\n    }\n  | {\n      type: \"source\";\n      /**\n       * The type of source - document sources reference files/documents.\n       */\n      sourceType: \"document\";\n      /**\n       * The ID of the source.\n       */\n      id: string;\n      /**\n       * IANA media type of the document (e.g., 'application/pdf').\n       */\n      mediaType: string;\n      /**\n       * The title of the document.\n       */\n      title: string;\n      /**\n       * Optional filename of the document.\n       */\n      filename?: string;\n    };\n\n// ============================================================================\n// Content Parts\n// ============================================================================\n\n/**\n * Text content part of a prompt. It contains a string of text.\n */\nexport interface TextPart {\n  type: \"text\";\n  /**\n   * The text content.\n   */\n  text: string;\n}\n\n/**\n * Data content. Can either be a base64-encoded string, a Uint8Array, or an ArrayBuffer.\n */\nexport type DataContent = string | Uint8Array | ArrayBuffer;\n\n/**\n * Image content part of a prompt. It contains an image.\n */\nexport interface ImagePart {\n  type: \"image\";\n  /**\n   * Image data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the image\n   */\n  image: DataContent | URL;\n  /**\n   * Optional mime type of the image.\n   */\n  mimeType?: string;\n}\n\n/**\n * File content part of a prompt. It contains a file.\n */\nexport interface FilePart {\n  type: \"file\";\n  /**\n   * File data. Can either be:\n   *\n   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer\n   * - URL: a URL that points to the file\n   */\n  data: DataContent | URL;\n  /**\n   * Optional filename of the file.\n   */\n  filename?: string;\n  /**\n   * IANA media type of the file.\n   *\n   * @see https://www.iana.org/assignments/media-types/media-types.xhtml\n   */\n  mediaType: string;\n}\n\n/**\n * Reasoning content part of a prompt. It contains a reasoning.\n */\nexport interface ReasoningPart {\n  type: \"reasoning\";\n  /**\n   * The reasoning text.\n   */\n  text: string;\n  /**\n   * An optional signature for verifying that the reasoning originated from the model.\n   */\n  signature?: string;\n}\n\n/**\n * Redacted reasoning content part of a prompt.\n */\nexport interface RedactedReasoningPart {\n  type: \"redacted-reasoning\";\n  /**\n   * Redacted reasoning data.\n   */\n  data: string;\n}\n\n/**\n * Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).\n */\nexport interface ToolCallPart {\n  type: \"tool-call\";\n  /**\n   * ID of the tool call. This ID is used to match the tool call with the tool result.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that is being called.\n   */\n  toolName: string;\n  /**\n   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.\n   */\n  input: unknown;\n}\n\ntype JSONValue = null | string | number | boolean | JSONObject | JSONArray;\ntype JSONObject = {\n  [key: string]: JSONValue;\n};\ntype JSONArray = JSONValue[];\n\n/**\n * Tool result content part of a prompt. It contains the result of the tool call with the matching ID.\n */\nexport interface ToolResultPart {\n  type: \"tool-result\";\n  /**\n   * ID of the tool call that this result is associated with.\n   */\n  toolCallId: string;\n  /**\n   * Name of the tool that generated this result.\n   */\n  toolName: string;\n  /**\n   * Result of the tool call. This is a JSON-serializable object.\n   */\n  output:\n    | {\n        type: \"text\";\n        value: string;\n      }\n    | {\n        type: \"json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"error-text\";\n        value: string;\n      }\n    | {\n        type: \"error-json\";\n        value: JSONValue;\n      }\n    | {\n        type: \"content\";\n        value: Array<\n          | {\n              type: \"text\";\n              /**\nText content.\n*/\n              text: string;\n            }\n          | {\n              type: \"media\";\n              /**\nBase-64 encoded media data.\n*/\n              data: string;\n              /**\nIANA media type.\n@see https://www.iana.org/assignments/media-types/media-types.xhtml\n*/\n              mediaType: string;\n            }\n        >;\n      };\n}\n\n// ============================================================================\n// Tool Types\n// ============================================================================\n\ntype ToolParameters = TSchema;\n\ntype inferParameters<PARAMETERS extends ToolParameters> = Static<PARAMETERS>;\n\n/**\n * Options passed to tool execution functions.\n */\nexport interface ToolExecutionOptions {\n  /**\n   * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.\n   */\n  toolCallId: string;\n  /**\n   * Messages that were sent to the language model to initiate the response that contained the tool call.\n   * The messages **do not** include the system prompt nor the assistant response that contained the tool call.\n   */\n  messages: AIMessage[];\n  /**\n   * An optional abort signal that indicates that the overall operation should be aborted.\n   */\n  abortSignal?: AbortSignal;\n}\n\n/**\n * A tool contains the description and the schema of the input that the tool expects.\n * This enables the language model to generate the input.\n *\n * The tool can also contain an optional execute function for the actual execution function of the tool.\n */\nexport type AITool<PARAMETERS extends ToolParameters = any, RESULT = any> = {\n  /**\n   * The schema of the input that the tool expects, expressed as a Typebox\n   * schema. The language model uses this to generate (and the runtime to\n   * validate) the tool input. Use field descriptions to make the input\n   * understandable for the model.\n   *\n   * This is the canonical field read by the runtime. `parameters` is an\n   * accepted alias for backwards compatibility.\n   */\n  inputSchema: TSchema;\n  /**\n   * @deprecated Alias for {@link inputSchema}. Prefer `inputSchema`.\n   */\n  parameters?: PARAMETERS;\n  /**\n   * An optional description of what the tool does.\n   * Will be used by the language model to decide whether to use the tool.\n   * Not used for provider-defined tools.\n   */\n  description?: string;\n  /**\n   * An async function that is called with the arguments from the tool call and produces a result.\n   * If not provided, the tool will not be executed automatically.\n   *\n   * @param args - The input of the tool call\n   * @param options - Execution options including abort signal and messages\n   */\n  execute?: (\n    args: inferParameters<PARAMETERS>,\n    options: ToolExecutionOptions\n  ) => PromiseLike<RESULT>;\n} & (\n  | {\n      /**\n       * Function tool.\n       */\n      type?: undefined | \"function\";\n    }\n  | {\n      /**\n       * Provider-defined tool.\n       */\n      type: \"provider-defined\";\n      /**\n       * The ID of the tool. Should follow the format `<provider-name>.<tool-name>`.\n       */\n      id: `${string}.${string}`;\n      /**\n       * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.\n       */\n      args: Record<string, unknown>;\n    }\n);\n\n/**\n * Tool choice for the generation. It supports the following settings:\n *\n * - `auto` (default): the model can choose whether and which tools to call.\n * - `required`: the model must call a tool. It can choose which tool to call.\n * - `none`: the model must not call tools\n * - `{ type: 'tool', toolName: string (typed) }`: the model must call the specified tool\n */\ntype ToolChoice<TOOLS extends Record<string, unknown>> =\n  | \"auto\"\n  | \"none\"\n  | \"required\"\n  | {\n      type: \"tool\";\n      toolName: Extract<keyof TOOLS, string>;\n    };\n\nexport type AIToolSet = Record<\n  string,\n  (\n    | AITool<never, never>\n    | AITool<any, any>\n    | AITool<any, never>\n    | AITool<never, any>\n  ) &\n    Pick<AITool<any, any>, \"execute\">\n>;\n\n// ============================================================================\n// Internal Helper Types\n// ============================================================================\n\ntype ToolCallUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-call\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n};\n\ntype ToolCallArray<TOOLS extends AIToolSet> = Array<ToolCallUnion<TOOLS>>;\n\ntype ToolResultUnion<_TOOLS extends AIToolSet> = {\n  type: \"tool-result\";\n  toolCallId: string;\n  toolName: string;\n  args?: unknown;\n  result?: unknown;\n};\n\ntype ToolResultArray<TOOLS extends AIToolSet> = Array<ToolResultUnion<TOOLS>>;\n";
 //# sourceMappingURL=ai.js.map

package/dist/llm-docs/tools/ai.js.map

@@ -1 +1 @@
-{"version":3,"file":"ai.js","sourceRoot":"","sources":["../../../src/llm-docs/tools/ai.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,+gzBAA+gzB,CAAC"}
+{"version":3,"file":"ai.js","sourceRoot":"","sources":["../../../src/llm-docs/tools/ai.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,kgzBAAkgzB,CAAC"}

package/dist/llm-docs/tools/callbacks.d.ts

@@ -4,6 +4,6 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-declare const _default: "import { ITool } from \"..\";\nimport { Serializable } from \"../utils/types\";\n\n/**\n * Represents a callback token for persistent function references.\n *\n * Callbacks enable tools and twists to create persistent references to functions\n * that can survive worker restarts and be invoked across different execution contexts.\n *\n * This is a branded strin\n * type to prevent mixing callback tokens with regular strings.\n *\n * @example\n * ```typescript\n * const callback = await this.callback(this.onCalendarSelected, \"primary\", \"google\");\n * ```\n */\nexport type Callback = string & { readonly __brand: \"Callback\" };\n\n/**\n * Built-in tool for creating and managing persistent callback references.\n *\n * The Callbacks tool enables twists and tools to create callback links that persist\n * across worker invocations and restarts. This is essential for webhook handlers,\n * scheduled operations, and user interaction flows that need to survive runtime\n * boundaries.\n *\n * **Note:** Callback methods are also available directly on Twist and Tool classes\n * via `this.callback()`, `this.deleteCallback()`, `this.deleteAllCallbacks()`, and\n * `this.run()`. This is the recommended approach for most use cases.\n *\n * **When to use callbacks:**\n * - Webhook handlers that need persistent function references\n * - Scheduled operations that run after worker timeouts\n * - User interaction actions (ActionType.callback)\n * - Cross-tool communication that survives restarts\n *\n * **Type Safety:**\n * Callbacks are fully type-safe - extraArgs are type-checked against the function signature.\n *\n * @example\n * ```typescript\n * class MyTool extends Tool {\n *   async setupWebhook() {\n *     // Using built-in callback method (recommended)\n *     const callback = await this.callback(this.handleWebhook, \"calendar\");\n *     return `https://api.plot.day/webhook/${callback}`;\n *   }\n *\n *   async handleWebhook(data: any, webhookType: string) {\n *     console.log(\"Webhook received:\", data, webhookType);\n *   }\n * }\n * ```\n */\nexport abstract class Callbacks extends ITool {\n  /**\n   * Creates a persistent callback to a method on the current class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a persistent callback token\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  /**\n   * Creates a persistent callback to a function from the parent twist/tool.\n   * Use this when the callback function is passed in from outside this class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a callback token\n   */\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  // <\n  //   DeferredArgs extends any[],\n  //   Fn extends (...args: any[]) => any,\n  //   CurriedArgs extends Serializable[],\n  //   AllArgs extends any[] = Parameters<Fn>,\n  //   R = ReturnType<Fn>,\n  //   DeferredArgs extends any[] = AllArgs extends [...infer D, ...CurriedArgs]\n  //     ? D extends any[]\n  //       ? D\n  //       : never\n  //     : never\n  // >(\n  //   fn: (...args: [...DeferredArgs, ...CurriedArgs]) => R,\n  //   ...curriedArgs: CurriedArgs\n  // ): Promise<Callback>;\n\n  /**\n   * Deletes a specific callback by its token.\n   *\n   * @param callback - The callback token to delete\n   * @returns Promise that resolves when the callback is deleted\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract delete(callback: Callback): Promise<void>;\n\n  /**\n   * Deletes all callbacks for the tool's parent.\n   *\n   * @returns Promise that resolves when all callbacks are deleted\n   */\n  abstract deleteAll(): Promise<void>;\n\n  /**\n   * Executes a callback by its token.\n   *\n   * @param callback - The callback token returned by create()\n   * @param args - Optional arguments to pass to the callback function\n   * @returns Promise resolving to the callback result\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract run<T = unknown>(callback: Callback, ...args: any[]): Promise<T>;\n}\n";
+declare const _default: "import { ITool } from \"..\";\nimport { Serializable } from \"../utils/types\";\n\n/**\n * Represents a callback token for persistent function references.\n *\n * Callbacks enable tools and twists to create persistent references to functions\n * that can survive worker restarts and be invoked across different execution contexts.\n *\n * This is a branded string\n * type to prevent mixing callback tokens with regular strings.\n *\n * @example\n * ```typescript\n * const callback = await this.callback(this.onCalendarSelected, \"primary\", \"google\");\n * ```\n */\nexport type Callback = string & { readonly __brand: \"Callback\" };\n\n/**\n * Built-in tool for creating and managing persistent callback references.\n *\n * The Callbacks tool enables twists and tools to create callback links that persist\n * across worker invocations and restarts. This is essential for webhook handlers,\n * scheduled operations, and user interaction flows that need to survive runtime\n * boundaries.\n *\n * **Note:** Callback methods are also available directly on Twist and Tool classes\n * via `this.callback()`, `this.deleteCallback()`, `this.deleteAllCallbacks()`, and\n * `this.run()`. This is the recommended approach for most use cases.\n *\n * **When to use callbacks:**\n * - Webhook handlers that need persistent function references\n * - Scheduled operations that run after worker timeouts\n * - User interaction actions (ActionType.callback)\n * - Cross-tool communication that survives restarts\n *\n * **Type Safety:**\n * Callbacks are fully type-safe - extraArgs are type-checked against the function signature.\n *\n * @example\n * ```typescript\n * class MyTool extends Tool {\n *   async setupWebhook() {\n *     // Using built-in callback method (recommended)\n *     const callback = await this.callback(this.handleWebhook, \"calendar\");\n *     return `https://api.plot.day/webhook/${callback}`;\n *   }\n *\n *   async handleWebhook(data: any, webhookType: string) {\n *     console.log(\"Webhook received:\", data, webhookType);\n *   }\n * }\n * ```\n */\nexport abstract class Callbacks extends ITool {\n  /**\n   * Creates a persistent callback to a method on the current class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a persistent callback token\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  /**\n   * Creates a persistent callback to a function from the parent twist/tool.\n   * Use this when the callback function is passed in from outside this class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a callback token\n   */\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  // <\n  //   DeferredArgs extends any[],\n  //   Fn extends (...args: any[]) => any,\n  //   CurriedArgs extends Serializable[],\n  //   AllArgs extends any[] = Parameters<Fn>,\n  //   R = ReturnType<Fn>,\n  //   DeferredArgs extends any[] = AllArgs extends [...infer D, ...CurriedArgs]\n  //     ? D extends any[]\n  //       ? D\n  //       : never\n  //     : never\n  // >(\n  //   fn: (...args: [...DeferredArgs, ...CurriedArgs]) => R,\n  //   ...curriedArgs: CurriedArgs\n  // ): Promise<Callback>;\n\n  /**\n   * Deletes a specific callback by its token.\n   *\n   * @param callback - The callback token to delete\n   * @returns Promise that resolves when the callback is deleted\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract delete(callback: Callback): Promise<void>;\n\n  /**\n   * Deletes all callbacks for the tool's parent.\n   *\n   * @returns Promise that resolves when all callbacks are deleted\n   */\n  abstract deleteAll(): Promise<void>;\n\n  /**\n   * Executes a callback by its token.\n   *\n   * @param callback - The callback token returned by create()\n   * @param args - Optional arguments to pass to the callback function\n   * @returns Promise resolving to the callback result\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract run<T = unknown>(callback: Callback, ...args: any[]): Promise<T>;\n}\n";
 export default _default;
 //# sourceMappingURL=callbacks.d.ts.map

package/dist/llm-docs/tools/callbacks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"callbacks.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/callbacks.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,o6JAAo6J;AAAn7J,wBAAo7J"}
+{"version":3,"file":"callbacks.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/callbacks.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,q6JAAq6J;AAAp7J,wBAAq7J"}

package/dist/llm-docs/tools/callbacks.js

@@ -4,5 +4,5 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-export default "import { ITool } from \"..\";\nimport { Serializable } from \"../utils/types\";\n\n/**\n * Represents a callback token for persistent function references.\n *\n * Callbacks enable tools and twists to create persistent references to functions\n * that can survive worker restarts and be invoked across different execution contexts.\n *\n * This is a branded strin\n * type to prevent mixing callback tokens with regular strings.\n *\n * @example\n * ```typescript\n * const callback = await this.callback(this.onCalendarSelected, \"primary\", \"google\");\n * ```\n */\nexport type Callback = string & { readonly __brand: \"Callback\" };\n\n/**\n * Built-in tool for creating and managing persistent callback references.\n *\n * The Callbacks tool enables twists and tools to create callback links that persist\n * across worker invocations and restarts. This is essential for webhook handlers,\n * scheduled operations, and user interaction flows that need to survive runtime\n * boundaries.\n *\n * **Note:** Callback methods are also available directly on Twist and Tool classes\n * via `this.callback()`, `this.deleteCallback()`, `this.deleteAllCallbacks()`, and\n * `this.run()`. This is the recommended approach for most use cases.\n *\n * **When to use callbacks:**\n * - Webhook handlers that need persistent function references\n * - Scheduled operations that run after worker timeouts\n * - User interaction actions (ActionType.callback)\n * - Cross-tool communication that survives restarts\n *\n * **Type Safety:**\n * Callbacks are fully type-safe - extraArgs are type-checked against the function signature.\n *\n * @example\n * ```typescript\n * class MyTool extends Tool {\n *   async setupWebhook() {\n *     // Using built-in callback method (recommended)\n *     const callback = await this.callback(this.handleWebhook, \"calendar\");\n *     return `https://api.plot.day/webhook/${callback}`;\n *   }\n *\n *   async handleWebhook(data: any, webhookType: string) {\n *     console.log(\"Webhook received:\", data, webhookType);\n *   }\n * }\n * ```\n */\nexport abstract class Callbacks extends ITool {\n  /**\n   * Creates a persistent callback to a method on the current class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a persistent callback token\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  /**\n   * Creates a persistent callback to a function from the parent twist/tool.\n   * Use this when the callback function is passed in from outside this class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a callback token\n   */\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  // <\n  //   DeferredArgs extends any[],\n  //   Fn extends (...args: any[]) => any,\n  //   CurriedArgs extends Serializable[],\n  //   AllArgs extends any[] = Parameters<Fn>,\n  //   R = ReturnType<Fn>,\n  //   DeferredArgs extends any[] = AllArgs extends [...infer D, ...CurriedArgs]\n  //     ? D extends any[]\n  //       ? D\n  //       : never\n  //     : never\n  // >(\n  //   fn: (...args: [...DeferredArgs, ...CurriedArgs]) => R,\n  //   ...curriedArgs: CurriedArgs\n  // ): Promise<Callback>;\n\n  /**\n   * Deletes a specific callback by its token.\n   *\n   * @param callback - The callback token to delete\n   * @returns Promise that resolves when the callback is deleted\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract delete(callback: Callback): Promise<void>;\n\n  /**\n   * Deletes all callbacks for the tool's parent.\n   *\n   * @returns Promise that resolves when all callbacks are deleted\n   */\n  abstract deleteAll(): Promise<void>;\n\n  /**\n   * Executes a callback by its token.\n   *\n   * @param callback - The callback token returned by create()\n   * @param args - Optional arguments to pass to the callback function\n   * @returns Promise resolving to the callback result\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract run<T = unknown>(callback: Callback, ...args: any[]): Promise<T>;\n}\n";
+export default "import { ITool } from \"..\";\nimport { Serializable } from \"../utils/types\";\n\n/**\n * Represents a callback token for persistent function references.\n *\n * Callbacks enable tools and twists to create persistent references to functions\n * that can survive worker restarts and be invoked across different execution contexts.\n *\n * This is a branded string\n * type to prevent mixing callback tokens with regular strings.\n *\n * @example\n * ```typescript\n * const callback = await this.callback(this.onCalendarSelected, \"primary\", \"google\");\n * ```\n */\nexport type Callback = string & { readonly __brand: \"Callback\" };\n\n/**\n * Built-in tool for creating and managing persistent callback references.\n *\n * The Callbacks tool enables twists and tools to create callback links that persist\n * across worker invocations and restarts. This is essential for webhook handlers,\n * scheduled operations, and user interaction flows that need to survive runtime\n * boundaries.\n *\n * **Note:** Callback methods are also available directly on Twist and Tool classes\n * via `this.callback()`, `this.deleteCallback()`, `this.deleteAllCallbacks()`, and\n * `this.run()`. This is the recommended approach for most use cases.\n *\n * **When to use callbacks:**\n * - Webhook handlers that need persistent function references\n * - Scheduled operations that run after worker timeouts\n * - User interaction actions (ActionType.callback)\n * - Cross-tool communication that survives restarts\n *\n * **Type Safety:**\n * Callbacks are fully type-safe - extraArgs are type-checked against the function signature.\n *\n * @example\n * ```typescript\n * class MyTool extends Tool {\n *   async setupWebhook() {\n *     // Using built-in callback method (recommended)\n *     const callback = await this.callback(this.handleWebhook, \"calendar\");\n *     return `https://api.plot.day/webhook/${callback}`;\n *   }\n *\n *   async handleWebhook(data: any, webhookType: string) {\n *     console.log(\"Webhook received:\", data, webhookType);\n *   }\n * }\n * ```\n */\nexport abstract class Callbacks extends ITool {\n  /**\n   * Creates a persistent callback to a method on the current class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a persistent callback token\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract create<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  /**\n   * Creates a persistent callback to a function from the parent twist/tool.\n   * Use this when the callback function is passed in from outside this class.\n   *\n   * @param fn - The function to callback\n   * @param extraArgs - Additional arguments to pass to the function after any passed by the caller\n   * @returns Promise resolving to a callback token\n   */\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n  // Variation when called provides the first argument\n  abstract createFromParent<\n    TArgs extends Serializable[],\n    F extends (arg1: any, ...extraArgs: TArgs) => any\n  >(fn: F, ...extraArgs: TArgs): Promise<Callback>;\n\n  // <\n  //   DeferredArgs extends any[],\n  //   Fn extends (...args: any[]) => any,\n  //   CurriedArgs extends Serializable[],\n  //   AllArgs extends any[] = Parameters<Fn>,\n  //   R = ReturnType<Fn>,\n  //   DeferredArgs extends any[] = AllArgs extends [...infer D, ...CurriedArgs]\n  //     ? D extends any[]\n  //       ? D\n  //       : never\n  //     : never\n  // >(\n  //   fn: (...args: [...DeferredArgs, ...CurriedArgs]) => R,\n  //   ...curriedArgs: CurriedArgs\n  // ): Promise<Callback>;\n\n  /**\n   * Deletes a specific callback by its token.\n   *\n   * @param callback - The callback token to delete\n   * @returns Promise that resolves when the callback is deleted\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract delete(callback: Callback): Promise<void>;\n\n  /**\n   * Deletes all callbacks for the tool's parent.\n   *\n   * @returns Promise that resolves when all callbacks are deleted\n   */\n  abstract deleteAll(): Promise<void>;\n\n  /**\n   * Executes a callback by its token.\n   *\n   * @param callback - The callback token returned by create()\n   * @param args - Optional arguments to pass to the callback function\n   * @returns Promise resolving to the callback result\n   */\n  // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  abstract run<T = unknown>(callback: Callback, ...args: any[]): Promise<T>;\n}\n";
 //# sourceMappingURL=callbacks.js.map

package/dist/llm-docs/tools/callbacks.js.map

@@ -1 +1 @@
-{"version":3,"file":"callbacks.js","sourceRoot":"","sources":["../../../src/llm-docs/tools/callbacks.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,o6JAAo6J,CAAC"}
+{"version":3,"file":"callbacks.js","sourceRoot":"","sources":["../../../src/llm-docs/tools/callbacks.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,q6JAAq6J,CAAC"}

package/dist/llm-docs/tools/files.d.ts

@@ -4,6 +4,6 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-declare const _default: "import { ITool } from \"..\";\n\n/**\n * Built-in tool for reading files attached to notes in Plot.\n *\n * Files are uploaded by clients via POST /files which creates an\n * ActionType.file entry on a note. Connectors call read() during outbound\n * (e.g. onNoteCreated) to retrieve those bytes and send them to the source\n * system.\n *\n * For inbound attachments, connectors emit ActionType.fileRef actions and\n * implement Connector.downloadAttachment \u2014 no upload tool is needed because\n * inbound bytes never enter Plot's R2 storage.\n */\nexport abstract class Files extends ITool {\n  /**\n   * Read a file uploaded by a client and attached to a note in a focus\n   * where this twist is installed.\n   *\n   * @param fileId The id from an ActionType.file action.\n   * @returns Bytes plus original metadata.\n   * @throws FileNotFoundError if the file is missing or out of scope.\n   */\n  abstract read(fileId: string): Promise<{\n    data: Uint8Array;\n    fileName: string;\n    mimeType: string;\n    fileSize: number;\n  }>;\n}\n\nexport class FileNotFoundError extends Error {\n  constructor(fileId: string) {\n    super(`File not found or out of scope: ${fileId}`);\n    this.name = \"FileNotFoundError\";\n  }\n}\n";
+declare const _default: "import { ITool } from \"..\";\n\n/**\n * Built-in tool for reading files attached to notes in Plot.\n *\n * Files are uploaded by clients via POST /files which creates an\n * ActionType.file entry on a note. Connectors call read() during outbound\n * (e.g. onNoteCreated) to retrieve those bytes and send them to the source\n * system.\n *\n * For inbound attachments, connectors emit ActionType.fileRef actions and\n * implement Connector.downloadAttachment \u2014 no upload tool is needed because\n * inbound bytes never enter Plot's R2 storage.\n */\nexport abstract class Files extends ITool {\n  /**\n   * Read a file uploaded by a client and attached to a note on a thread\n   * in one of the twist owner's focuses.\n   *\n   * @param fileId The id from an ActionType.file action.\n   * @returns Bytes plus original metadata.\n   * @throws FileNotFoundError if the file is missing or out of scope.\n   */\n  abstract read(fileId: string): Promise<{\n    data: Uint8Array;\n    fileName: string;\n    mimeType: string;\n    fileSize: number;\n  }>;\n}\n\nexport class FileNotFoundError extends Error {\n  constructor(fileId: string) {\n    super(`File not found or out of scope: ${fileId}`);\n    this.name = \"FileNotFoundError\";\n  }\n}\n";
 export default _default;
 //# sourceMappingURL=files.d.ts.map

package/dist/llm-docs/tools/files.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/files.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,ytCAAotC;AAAnuC,wBAAouC"}
+{"version":3,"file":"files.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/files.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,guCAA2tC;AAA1uC,wBAA2uC"}

package/dist/llm-docs/tools/files.js

@@ -4,5 +4,5 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-export default "import { ITool } from \"..\";\n\n/**\n * Built-in tool for reading files attached to notes in Plot.\n *\n * Files are uploaded by clients via POST /files which creates an\n * ActionType.file entry on a note. Connectors call read() during outbound\n * (e.g. onNoteCreated) to retrieve those bytes and send them to the source\n * system.\n *\n * For inbound attachments, connectors emit ActionType.fileRef actions and\n * implement Connector.downloadAttachment — no upload tool is needed because\n * inbound bytes never enter Plot's R2 storage.\n */\nexport abstract class Files extends ITool {\n  /**\n   * Read a file uploaded by a client and attached to a note in a focus\n   * where this twist is installed.\n   *\n   * @param fileId The id from an ActionType.file action.\n   * @returns Bytes plus original metadata.\n   * @throws FileNotFoundError if the file is missing or out of scope.\n   */\n  abstract read(fileId: string): Promise<{\n    data: Uint8Array;\n    fileName: string;\n    mimeType: string;\n    fileSize: number;\n  }>;\n}\n\nexport class FileNotFoundError extends Error {\n  constructor(fileId: string) {\n    super(`File not found or out of scope: ${fileId}`);\n    this.name = \"FileNotFoundError\";\n  }\n}\n";
+export default "import { ITool } from \"..\";\n\n/**\n * Built-in tool for reading files attached to notes in Plot.\n *\n * Files are uploaded by clients via POST /files which creates an\n * ActionType.file entry on a note. Connectors call read() during outbound\n * (e.g. onNoteCreated) to retrieve those bytes and send them to the source\n * system.\n *\n * For inbound attachments, connectors emit ActionType.fileRef actions and\n * implement Connector.downloadAttachment — no upload tool is needed because\n * inbound bytes never enter Plot's R2 storage.\n */\nexport abstract class Files extends ITool {\n  /**\n   * Read a file uploaded by a client and attached to a note on a thread\n   * in one of the twist owner's focuses.\n   *\n   * @param fileId The id from an ActionType.file action.\n   * @returns Bytes plus original metadata.\n   * @throws FileNotFoundError if the file is missing or out of scope.\n   */\n  abstract read(fileId: string): Promise<{\n    data: Uint8Array;\n    fileName: string;\n    mimeType: string;\n    fileSize: number;\n  }>;\n}\n\nexport class FileNotFoundError extends Error {\n  constructor(fileId: string) {\n    super(`File not found or out of scope: ${fileId}`);\n    this.name = \"FileNotFoundError\";\n  }\n}\n";
 //# sourceMappingURL=files.js.map

package/dist/llm-docs/tools/files.js.map

@@ -1 +1 @@
-{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/llm-docs/tools/files.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,otCAAotC,CAAC"}
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../../src/llm-docs/tools/files.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAe,2tCAA2tC,CAAC"}

package/dist/llm-docs/tools/imap.d.ts

@@ -4,6 +4,6 @@
  * This file is auto-generated during build. Do not edit manually.
  * Generated from: prebuild.ts
  */
-declare const _default: "import { ITool } from \"..\";\n\n/** Opaque session handle returned by connect(). */\nexport type ImapSession = string;\n\n/** Credentials and server info for connecting to an IMAP server. */\nexport type ImapConnectOptions = {\n  /** IMAP server hostname (e.g. \"imap.mail.me.com\") */\n  host: string;\n  /** IMAP server port (e.g. 993 for TLS) */\n  port: number;\n  /** Whether to use TLS (true for port 993) */\n  tls: boolean;\n  /** IMAP username (typically the email address) */\n  username: string;\n  /** IMAP password (app-specific password for Apple) */\n  password: string;\n};\n\n/** A mailbox returned by listMailboxes(). */\nexport type ImapMailbox = {\n  /** Mailbox name (e.g. \"INBOX\", \"Sent Messages\") */\n  name: string;\n  /** Hierarchy delimiter (e.g. \"/\") */\n  delimiter: string;\n  /** Mailbox flags (e.g. [\"\\\\HasNoChildren\"]) */\n  flags: string[];\n  /** Special-use attribute if present (e.g. \"\\\\Sent\", \"\\\\Drafts\", \"\\\\Trash\") */\n  specialUse?: string;\n};\n\n/** Status of a selected mailbox. */\nexport type ImapMailboxStatus = {\n  /** Mailbox name */\n  name: string;\n  /** Total number of messages */\n  exists: number;\n  /** Number of recent messages */\n  recent: number;\n  /** UID validity value (changes if UIDs are reassigned) */\n  uidValidity: number;\n  /** Next UID to be assigned */\n  uidNext: number;\n  /** Number of unseen messages (may be absent) */\n  unseen?: number;\n};\n\n/** Criteria for searching messages. All fields are optional; they are ANDed together. */\nexport type ImapSearchCriteria = {\n  /** Messages with internal date on or after this date */\n  since?: Date | string;\n  /** Messages with internal date before this date */\n  before?: Date | string;\n  /** Messages with From header containing this string */\n  from?: string;\n  /** Messages with To header containing this string */\n  to?: string;\n  /** Messages with Subject containing this string */\n  subject?: string;\n  /** If true, only unseen messages; if false, only seen messages */\n  unseen?: boolean;\n  /** If true, only flagged messages; if false, only unflagged messages */\n  flagged?: boolean;\n  /** Specific UIDs to match */\n  uid?: number[];\n};\n\n/** An email address with optional display name. */\nexport type ImapAddress = {\n  /** Display name (e.g. \"John Doe\") */\n  name?: string;\n  /** Email address (e.g. \"john@example.com\") */\n  address: string;\n};\n\n/** A fetched message. Fields are populated based on ImapFetchOptions. */\nexport type ImapMessage = {\n  /** Message UID (stable across sessions if uidValidity hasn't changed) */\n  uid: number;\n  /** Message flags (e.g. [\"\\\\Seen\", \"\\\\Flagged\"]) */\n  flags: string[];\n  /** Internal date of the message */\n  date?: Date;\n  /** Subject header */\n  subject?: string;\n  /** From addresses */\n  from?: ImapAddress[];\n  /** To addresses */\n  to?: ImapAddress[];\n  /** CC addresses */\n  cc?: ImapAddress[];\n  /** Message-ID header */\n  messageId?: string;\n  /** In-Reply-To header (for threading) */\n  inReplyTo?: string;\n  /** References header (for threading) */\n  references?: string[];\n  /** Plain text body (when requested) */\n  bodyText?: string;\n  /** HTML body (when requested) */\n  bodyHtml?: string;\n  /** Message size in bytes */\n  size?: number;\n};\n\n/** Options for fetchMessages(). */\nexport type ImapFetchOptions = {\n  /** Fetch envelope/headers. Default: true. */\n  headers?: boolean;\n  /** Fetch body content. Default: false. */\n  body?: boolean;\n  /** Which body parts to fetch when body is true. Default: \"both\". */\n  bodyType?: \"text\" | \"html\" | \"both\";\n};\n\n/** How to modify flags. */\nexport type ImapFlagOperation = \"add\" | \"remove\" | \"set\";\n\n/**\n * Built-in tool for IMAP email access.\n *\n * Provides high-level IMAP operations for reading email and managing flags.\n * Handles TCP/TLS connections, IMAP protocol details, and MIME decoding\n * internally.\n *\n * **Permission model:** Connectors declare which IMAP hosts they need access\n * to. Connections to undeclared hosts are rejected.\n *\n * @example\n * ```typescript\n * class AppleMailConnector extends Connector<AppleMailConnector> {\n *   build(build: ConnectorBuilder) {\n *     return {\n *       options: build(Options, {\n *         email: { type: \"text\", label: \"Apple ID Email\", default: \"\" },\n *         password: { type: \"text\", label: \"App-Specific Password\", secure: true, default: \"\" },\n *       }),\n *\n *       imap: build(Imap, { hosts: [\"imap.mail.me.com\"] }),\n *       integrations: build(Integrations),\n *     };\n *   }\n *\n *   async syncInbox() {\n *     const session = await this.tools.imap.connect({\n *       host: \"imap.mail.me.com\",\n *       port: 993,\n *       tls: true,\n *       username: this.tools.options.email,\n *       password: this.tools.options.password,\n *     });\n *\n *     try {\n *       await this.tools.imap.selectMailbox(session, \"INBOX\");\n *       const uids = await this.tools.imap.search(session, { unseen: true });\n *       const messages = await this.tools.imap.fetchMessages(session, uids, {\n *         body: true,\n *         bodyType: \"html\",\n *       });\n *\n *       for (const msg of messages) {\n *         await this.tools.integrations.saveLink({\n *           source: `apple-mail:${msg.messageId}`,\n *           title: msg.subject ?? \"(no subject)\",\n *           // ...\n *         });\n *       }\n *     } finally {\n *       await this.tools.imap.disconnect(session);\n *     }\n *   }\n * }\n * ```\n */\nexport abstract class Imap extends ITool {\n  static readonly Options: {\n    /** IMAP server hostnames this tool is allowed to connect to. */\n    hosts: string[];\n  };\n\n  /**\n   * Opens a connection to an IMAP server and authenticates.\n   *\n   * @param options - Server address, port, TLS setting, and credentials\n   * @returns An opaque session handle for subsequent operations\n   * @throws If the host is not in the declared hosts list, connection fails, or auth fails\n   */\n  abstract connect(options: ImapConnectOptions): Promise<ImapSession>;\n\n  /**\n   * Lists all mailboxes (folders) on the server.\n   *\n   * @param session - Session handle from connect()\n   * @returns Array of mailbox descriptors\n   */\n  abstract listMailboxes(session: ImapSession): Promise<ImapMailbox[]>;\n\n  /**\n   * Selects a mailbox for subsequent search/fetch/flag operations.\n   *\n   * @param session - Session handle from connect()\n   * @param mailbox - Mailbox name (e.g. \"INBOX\")\n   * @returns Mailbox status including message count and UID validity\n   */\n  abstract selectMailbox(\n    session: ImapSession,\n    mailbox: string\n  ): Promise<ImapMailboxStatus>;\n\n  /**\n   * Searches for messages matching the given criteria in the selected mailbox.\n   *\n   * All criteria fields are ANDed together. Returns UIDs (not sequence numbers).\n   *\n   * @param session - Session handle from connect()\n   * @param criteria - Search criteria (all optional, ANDed)\n   * @returns Array of matching message UIDs\n   */\n  abstract search(\n    session: ImapSession,\n    criteria: ImapSearchCriteria\n  ): Promise<number[]>;\n\n  /**\n   * Fetches message data for the given UIDs.\n   *\n   * By default fetches headers only. Set `body: true` in options to include\n   * message body content. The implementation handles MIME decoding internally.\n   *\n   * @param session - Session handle from connect()\n   * @param uids - Array of message UIDs to fetch\n   * @param options - What to fetch (headers, body, body type)\n   * @returns Array of message objects with requested fields populated\n   */\n  abstract fetchMessages(\n    session: ImapSession,\n    uids: number[],\n    options?: ImapFetchOptions\n  ): Promise<ImapMessage[]>;\n\n  /**\n   * Modifies flags on messages.\n   *\n   * Common flags: \"\\\\Seen\" (read), \"\\\\Flagged\" (starred), \"\\\\Deleted\" (marked for deletion).\n   *\n   * @param session - Session handle from connect()\n   * @param uids - Array of message UIDs to modify\n   * @param flags - Flags to add/remove/set (e.g. [\"\\\\Seen\"])\n   * @param operation - \"add\", \"remove\", or \"set\" (replace all flags)\n   */\n  abstract setFlags(\n    session: ImapSession,\n    uids: number[],\n    flags: string[],\n    operation: ImapFlagOperation\n  ): Promise<void>;\n\n  /**\n   * Closes the IMAP connection.\n   *\n   * Always call this when done, preferably in a finally block.\n   *\n   * @param session - Session handle from connect()\n   */\n  abstract disconnect(session: ImapSession): Promise<void>;\n}\n";
+declare const _default: "import { ITool } from \"..\";\n\n/** Opaque session handle returned by connect(). */\nexport type ImapSession = string;\n\n/** Credentials and server info for connecting to an IMAP server. */\nexport type ImapConnectOptions = {\n  /** IMAP server hostname (e.g. \"imap.mail.me.com\") */\n  host: string;\n  /** IMAP server port (e.g. 993 for TLS) */\n  port: number;\n  /** Whether to use TLS (true for port 993) */\n  tls: boolean;\n  /** IMAP username (typically the email address) */\n  username: string;\n  /** IMAP password (app-specific password for Apple) */\n  password: string;\n};\n\n/** A mailbox returned by listMailboxes(). */\nexport type ImapMailbox = {\n  /** Mailbox name (e.g. \"INBOX\", \"Sent Messages\") */\n  name: string;\n  /** Hierarchy delimiter (e.g. \"/\") */\n  delimiter: string;\n  /** Mailbox flags (e.g. [\"\\\\HasNoChildren\"]) */\n  flags: string[];\n  /** Special-use attribute if present (e.g. \"\\\\Sent\", \"\\\\Drafts\", \"\\\\Trash\") */\n  specialUse?: string;\n};\n\n/** Status of a selected mailbox. */\nexport type ImapMailboxStatus = {\n  /** Mailbox name */\n  name: string;\n  /** Total number of messages */\n  exists: number;\n  /** Number of recent messages */\n  recent: number;\n  /** UID validity value (changes if UIDs are reassigned) */\n  uidValidity: number;\n  /** Next UID to be assigned */\n  uidNext: number;\n  /** Number of unseen messages (may be absent) */\n  unseen?: number;\n};\n\n/** Criteria for searching messages. All fields are optional; they are ANDed together. */\nexport type ImapSearchCriteria = {\n  /** Messages with internal date on or after this date */\n  since?: Date | string;\n  /** Messages with internal date before this date */\n  before?: Date | string;\n  /** Messages with From header containing this string */\n  from?: string;\n  /** Messages with To header containing this string */\n  to?: string;\n  /** Messages with Subject containing this string */\n  subject?: string;\n  /** If true, only unseen messages; if false, only seen messages */\n  unseen?: boolean;\n  /** If true, only flagged messages; if false, only unflagged messages */\n  flagged?: boolean;\n  /** Specific UIDs to match */\n  uid?: number[];\n};\n\n/** An email address with optional display name. */\nexport type ImapAddress = {\n  /** Display name (e.g. \"John Doe\") */\n  name?: string;\n  /** Email address (e.g. \"john@example.com\") */\n  address: string;\n};\n\n/** A fetched message. Fields are populated based on ImapFetchOptions. */\nexport type ImapMessage = {\n  /** Message UID (stable across sessions if uidValidity hasn't changed) */\n  uid: number;\n  /** Message flags (e.g. [\"\\\\Seen\", \"\\\\Flagged\"]) */\n  flags: string[];\n  /** Internal date of the message */\n  date?: Date;\n  /** Subject header */\n  subject?: string;\n  /** From addresses */\n  from?: ImapAddress[];\n  /** To addresses */\n  to?: ImapAddress[];\n  /** CC addresses */\n  cc?: ImapAddress[];\n  /** Message-ID header */\n  messageId?: string;\n  /** In-Reply-To header (for threading) */\n  inReplyTo?: string;\n  /** References header (for threading) */\n  references?: string[];\n  /** Plain text body (when requested) */\n  bodyText?: string;\n  /** HTML body (when requested) */\n  bodyHtml?: string;\n  /** Message size in bytes */\n  size?: number;\n};\n\n/** Options for fetchMessages(). */\nexport type ImapFetchOptions = {\n  /** Fetch envelope/headers. Default: true. */\n  headers?: boolean;\n  /** Fetch body content. Default: false. */\n  body?: boolean;\n  /** Which body parts to fetch when body is true. Default: \"both\". */\n  bodyType?: \"text\" | \"html\" | \"both\";\n};\n\n/** How to modify flags. */\nexport type ImapFlagOperation = \"add\" | \"remove\" | \"set\";\n\n/**\n * Built-in tool for IMAP email access.\n *\n * Provides high-level IMAP operations for reading email and managing flags.\n * Handles TCP/TLS connections, IMAP protocol details, and MIME decoding\n * internally.\n *\n * **Permission model:** Connectors declare which IMAP hosts they need access\n * to. Connections to undeclared hosts are rejected.\n *\n * @example\n * ```typescript\n * class AppleMailConnector extends Connector<AppleMailConnector> {\n *   build(build: ToolBuilder) {\n *     return {\n *       options: build(Options, {\n *         email: { type: \"text\", label: \"Apple ID Email\", default: \"\" },\n *         password: { type: \"text\", label: \"App-Specific Password\", secure: true, default: \"\" },\n *       }),\n *\n *       imap: build(Imap, { hosts: [\"imap.mail.me.com\"] }),\n *       integrations: build(Integrations),\n *     };\n *   }\n *\n *   async syncInbox() {\n *     const session = await this.tools.imap.connect({\n *       host: \"imap.mail.me.com\",\n *       port: 993,\n *       tls: true,\n *       username: this.tools.options.email,\n *       password: this.tools.options.password,\n *     });\n *\n *     try {\n *       await this.tools.imap.selectMailbox(session, \"INBOX\");\n *       const uids = await this.tools.imap.search(session, { unseen: true });\n *       const messages = await this.tools.imap.fetchMessages(session, uids, {\n *         body: true,\n *         bodyType: \"html\",\n *       });\n *\n *       for (const msg of messages) {\n *         await this.tools.integrations.saveLink({\n *           source: `apple-mail:${msg.messageId}`,\n *           title: msg.subject ?? \"(no subject)\",\n *           // ...\n *         });\n *       }\n *     } finally {\n *       await this.tools.imap.disconnect(session);\n *     }\n *   }\n * }\n * ```\n */\nexport abstract class Imap extends ITool {\n  static readonly Options: {\n    /** IMAP server hostnames this tool is allowed to connect to. */\n    hosts: string[];\n  };\n\n  /**\n   * Opens a connection to an IMAP server and authenticates.\n   *\n   * @param options - Server address, port, TLS setting, and credentials\n   * @returns An opaque session handle for subsequent operations\n   * @throws If the host is not in the declared hosts list, connection fails, or auth fails\n   */\n  abstract connect(options: ImapConnectOptions): Promise<ImapSession>;\n\n  /**\n   * Lists all mailboxes (folders) on the server.\n   *\n   * @param session - Session handle from connect()\n   * @returns Array of mailbox descriptors\n   */\n  abstract listMailboxes(session: ImapSession): Promise<ImapMailbox[]>;\n\n  /**\n   * Selects a mailbox for subsequent search/fetch/flag operations.\n   *\n   * @param session - Session handle from connect()\n   * @param mailbox - Mailbox name (e.g. \"INBOX\")\n   * @returns Mailbox status including message count and UID validity\n   */\n  abstract selectMailbox(\n    session: ImapSession,\n    mailbox: string\n  ): Promise<ImapMailboxStatus>;\n\n  /**\n   * Searches for messages matching the given criteria in the selected mailbox.\n   *\n   * All criteria fields are ANDed together. Returns UIDs (not sequence numbers).\n   *\n   * @param session - Session handle from connect()\n   * @param criteria - Search criteria (all optional, ANDed)\n   * @returns Array of matching message UIDs\n   */\n  abstract search(\n    session: ImapSession,\n    criteria: ImapSearchCriteria\n  ): Promise<number[]>;\n\n  /**\n   * Fetches message data for the given UIDs.\n   *\n   * By default fetches headers only. Set `body: true` in options to include\n   * message body content. The implementation handles MIME decoding internally.\n   *\n   * @param session - Session handle from connect()\n   * @param uids - Array of message UIDs to fetch\n   * @param options - What to fetch (headers, body, body type)\n   * @returns Array of message objects with requested fields populated\n   */\n  abstract fetchMessages(\n    session: ImapSession,\n    uids: number[],\n    options?: ImapFetchOptions\n  ): Promise<ImapMessage[]>;\n\n  /**\n   * Modifies flags on messages.\n   *\n   * Common flags: \"\\\\Seen\" (read), \"\\\\Flagged\" (starred), \"\\\\Deleted\" (marked for deletion).\n   *\n   * @param session - Session handle from connect()\n   * @param uids - Array of message UIDs to modify\n   * @param flags - Flags to add/remove/set (e.g. [\"\\\\Seen\"])\n   * @param operation - \"add\", \"remove\", or \"set\" (replace all flags)\n   */\n  abstract setFlags(\n    session: ImapSession,\n    uids: number[],\n    flags: string[],\n    operation: ImapFlagOperation\n  ): Promise<void>;\n\n  /**\n   * Closes the IMAP connection.\n   *\n   * Always call this when done, preferably in a finally block.\n   *\n   * @param session - Session handle from connect()\n   */\n  abstract disconnect(session: ImapSession): Promise<void>;\n}\n";
 export default _default;
 //# sourceMappingURL=imap.d.ts.map

package/dist/llm-docs/tools/imap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"imap.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/imap.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,g9QAAg9Q;AAA/9Q,wBAAg+Q"}
+{"version":3,"file":"imap.d.ts","sourceRoot":"","sources":["../../../src/llm-docs/tools/imap.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;wBAEY,28QAA28Q;AAA19Q,wBAA29Q"}