@visulima/storage 1.0.9 → 1.0.10

package/dist/ai/openai/index.d.ts

@@ -1,28 +1,28 @@
-import { T as TOOL_SCHEMAS, F as FileToolName, A as ApprovalConfig, c as FileReadToolName } from "../../packem_shared/approval.d-CMAYH9GF.js";
-export type { d as FileWriteToolName } from "../../packem_shared/approval.d-CMAYH9GF.js";
+import { T as TOOL_SCHEMAS, F as FileToolName, A as ApprovalConfig, c as FileReadToolName } from "../../packem_shared/approval.d-C-d-t94D.js";
+export type { d as FileWriteToolName } from "../../packem_shared/approval.d-C-d-t94D.js";
 import { UnknownContext, FunctionTool } from '@openai/agents';
-import { F as Files } from "../../packem_shared/files.d-CH0iLBNC.js";
+import { F as Files } from "../../packem_shared/files.d-D8H_ge9Y.js";
 import 'node:stream';
 import 'node:crypto';
 import 'node:http';
 import 'lru-cache';
-import { e as executors } from "../../packem_shared/executors.d-BZP2rWo3.js";
+import { e as executors } from "../../packem_shared/executors.d-DeDH3Ilt.js";
 import 'zod';
-import "../../packem_shared/storage.d-CEM1upWM.js";
+import "../../packem_shared/storage.d-DIav_lF1.js";
 /**
-* Per-tool overrides for `createResponsesFileTools`. `name`, `parameters`, and
-* `type` are intentionally not overridable — the contract that drives tool
-* behavior should not be patched at this layer.
-*/
+ * Per-tool overrides for `createResponsesFileTools`. `name`, `parameters`, and
+ * `type` are intentionally not overridable — the contract that drives tool
+ * behavior should not be patched at this layer.
+ */
 interface ResponsesToolOverrides {
   description?: string;
   strict?: boolean;
 }
 /**
-* Per-tool overrides for `createAgentsFileTools`. `name`, `parameters`,
-* `execute`, and `strict` are intentionally not overridable — the contract
-* that drives tool behavior should not be patched at this layer.
-*/
+ * Per-tool overrides for `createAgentsFileTools`. `name`, `parameters`,
+ * `execute`, and `strict` are intentionally not overridable — the contract
+ * that drives tool behavior should not be patched at this layer.
+ */
 interface AgentsToolOverrides {
   description?: string;
   needsApproval?: boolean;
@@ -47,24 +47,16 @@ declare const agentsListFiles: (files: Files) => FunctionTool<UnknownContext, Li
 declare const agentsGetFileMetadata: (files: Files) => FunctionTool<UnknownContext, GetFileMetadataParameters, GetFileMetadataOutput>;
 declare const agentsDownloadFile: (files: Files) => FunctionTool<UnknownContext, DownloadFileParameters, DownloadFileOutput>;
 declare const agentsGetFileUrl: (files: Files) => FunctionTool<UnknownContext, GetFileUrlParameters, GetFileUrlOutput>;
-declare const agentsUploadFile: (files: Files, {
-  needsApproval
-}?: {
+declare const agentsUploadFile: (files: Files, { needsApproval }?: {
   needsApproval?: boolean;
 }) => FunctionTool<UnknownContext, UploadFileParameters, UploadFileOutput>;
-declare const agentsDeleteFile: (files: Files, {
-  needsApproval
-}?: {
+declare const agentsDeleteFile: (files: Files, { needsApproval }?: {
   needsApproval?: boolean;
 }) => FunctionTool<UnknownContext, DeleteFileParameters, DeleteFileOutput>;
-declare const agentsCopyFile: (files: Files, {
-  needsApproval
-}?: {
+declare const agentsCopyFile: (files: Files, { needsApproval }?: {
   needsApproval?: boolean;
 }) => FunctionTool<UnknownContext, CopyFileParameters, CopyFileOutput>;
-declare const agentsSignUploadUrl: (files: Files, {
-  needsApproval
-}?: {
+declare const agentsSignUploadUrl: (files: Files, { needsApproval }?: {
   needsApproval?: boolean;
 }) => FunctionTool<UnknownContext, SignUploadUrlParameters, SignUploadUrlOutput>;
 interface AgentsFileTools {
@@ -85,29 +77,29 @@ interface AgentsFileToolsOptions {
   requireApproval?: ApprovalConfig;
 }
 /**
-* Create a set of storage tools shaped for the OpenAI Agents SDK (`@openai/agents`).
-*
-* Returns a record keyed by tool name — spread `Object.values()` into
-* `new Agent({ tools })`. Write tools require approval by default.
-* @example
-* ```ts
-* import { Agent, run } from "@openai/agents";
-* import { Files } from "@visulima/storage";
-* import { S3Storage } from "@visulima/storage/provider/aws";
-* import { createAgentsFileTools } from "@visulima/storage/ai/openai";
-*
-* const files = new Files({ adapter: new S3Storage({ bucket: "uploads" }) });
-* const tools = createAgentsFileTools({ files });
-*
-* const agent = new Agent({
-*   instructions: "Help the user manage their files.",
-*   name: "Files agent",
-*   tools: Object.values(tools),
-* });
-*
-* const result = await run(agent, "List my files.");
-* ```
-*/
+ * Create a set of storage tools shaped for the OpenAI Agents SDK (`@openai/agents`).
+ *
+ * Returns a record keyed by tool name — spread `Object.values()` into
+ * `new Agent({ tools })`. Write tools require approval by default.
+ * @example
+ * ```ts
+ * import { Agent, run } from "@openai/agents";
+ * import { Files } from "@visulima/storage";
+ * import { S3Storage } from "@visulima/storage/provider/aws";
+ * import { createAgentsFileTools } from "@visulima/storage/ai/openai";
+ *
+ * const files = new Files({ adapter: new S3Storage({ bucket: "uploads" }) });
+ * const tools = createAgentsFileTools({ files });
+ *
+ * const agent = new Agent({
+ *   instructions: "Help the user manage their files.",
+ *   name: "Files agent",
+ *   tools: Object.values(tools),
+ * });
+ *
+ * const result = await run(agent, "List my files.");
+ * ```
+ */
 declare function createAgentsFileTools(options: AgentsFileToolsOptions & {
   readOnly: true;
 }): ReadOnlyAgentsFileTools;
@@ -116,9 +108,9 @@ declare function createAgentsFileTools(options: AgentsFileToolsOptions & {
 }): AgentsFileTools;
 declare function createAgentsFileTools(options: AgentsFileToolsOptions): AgentsFileTools | ReadOnlyAgentsFileTools;
 /**
-* A function-tool definition shaped for OpenAI's Responses API. Pass an
-* array of these to `openai.responses.create({ tools })`.
-*/
+ * A function-tool definition shaped for OpenAI's Responses API. Pass an
+ * array of these to `openai.responses.create({ tools })`.
+ */
 interface ResponsesFunctionTool {
   description: string;
   name: string;
@@ -127,8 +119,8 @@ interface ResponsesFunctionTool {
   type: "function";
 }
 /**
-* A function call emitted by the Responses API in `response.output[]`.
-*/
+ * A function call emitted by the Responses API in `response.output[]`.
+ */
 interface FunctionCallItem {
   arguments: string;
   call_id: string;
@@ -136,9 +128,9 @@ interface FunctionCallItem {
   type: "function_call";
 }
 /**
-* A function-call output item to append to the next `responses.create`
-* input alongside the original `function_call` item.
-*/
+ * A function-call output item to append to the next `responses.create`
+ * input alongside the original `function_call` item.
+ */
 interface FunctionCallOutputItem {
   call_id: string;
   output: string;
@@ -146,21 +138,21 @@ interface FunctionCallOutputItem {
 }
 interface ResponsesFileTools {
   /**
-  * Function tool definitions. Pass directly to `openai.responses.create({ tools })`.
-  */
+   * Function tool definitions. Pass directly to `openai.responses.create({ tools })`.
+   */
   definitions: ResponsesFunctionTool[];
   /**
-  * Execute a `function_call` item from the model's `response.output[]`.
-  * Returns a `function_call_output` item ready to push into the next turn's input.
-  *
-  * Approval is **not** enforced. Check {@link ResponsesFileTools.needsApproval}
-  * first if you want a human-in-the-loop gate.
-  */
+   * Execute a `function_call` item from the model's `response.output[]`.
+   * Returns a `function_call_output` item ready to push into the next turn's input.
+   *
+   * Approval is **not** enforced. Check {@link ResponsesFileTools.needsApproval}
+   * first if you want a human-in-the-loop gate.
+   */
   execute: (call: FunctionCallItem) => Promise<FunctionCallOutputItem>;
   /**
-  * Returns whether the named tool is approval-gated under this config.
-  * Read tools always return `false`. Unknown names return `false`.
-  */
+   * Returns whether the named tool is approval-gated under this config.
+   * Read tools always return `false`. Unknown names return `false`.
+   */
   needsApproval: (name: string) => boolean;
 }
 interface ResponsesFileToolsOptions {
@@ -170,36 +162,31 @@ interface ResponsesFileToolsOptions {
   requireApproval?: ApprovalConfig;
 }
 /**
-* Create a set of storage tools shaped for OpenAI's Responses API (`openai.responses.create`).
-* @example
-* ```ts
-* import OpenAI from "openai";
-* import { Files } from "@visulima/storage";
-* import { S3Storage } from "@visulima/storage/provider/aws";
-* import { createResponsesFileTools } from "@visulima/storage/ai/openai";
-*
-* const client = new OpenAI();
-* const files = new Files({ adapter: new S3Storage({ bucket: "uploads" }) });
-* const ft = createResponsesFileTools({ files });
-*
-* const input: any[] = [{ role: "user", content: "List my files." }];
-* while (true) {
-*   const res = await client.responses.create({ model: "gpt-4.1", input, tools: ft.definitions });
-*   const calls = res.output.filter((o) => o.type === "function_call");
-*   if (calls.length === 0) break;
-*   for (const call of calls) {
-*     if (ft.needsApproval(call.name)) {
-*       // surface approval UX, then continue or break
-*     }
-*     input.push(call, await ft.execute(call));
-*   }
-* }
-* ```
-*/
-declare const createResponsesFileTools: ({
-  files,
-  overrides,
-  readOnly,
-  requireApproval
-}: ResponsesFileToolsOptions) => ResponsesFileTools;
+ * Create a set of storage tools shaped for OpenAI's Responses API (`openai.responses.create`).
+ * @example
+ * ```ts
+ * import OpenAI from "openai";
+ * import { Files } from "@visulima/storage";
+ * import { S3Storage } from "@visulima/storage/provider/aws";
+ * import { createResponsesFileTools } from "@visulima/storage/ai/openai";
+ *
+ * const client = new OpenAI();
+ * const files = new Files({ adapter: new S3Storage({ bucket: "uploads" }) });
+ * const ft = createResponsesFileTools({ files });
+ *
+ * const input: any[] = [{ role: "user", content: "List my files." }];
+ * while (true) {
+ *   const res = await client.responses.create({ model: "gpt-4.1", input, tools: ft.definitions });
+ *   const calls = res.output.filter((o) => o.type === "function_call");
+ *   if (calls.length === 0) break;
+ *   for (const call of calls) {
+ *     if (ft.needsApproval(call.name)) {
+ *       // surface approval UX, then continue or break
+ *     }
+ *     input.push(call, await ft.execute(call));
+ *   }
+ * }
+ * ```
+ */
+declare const createResponsesFileTools: ({ files, overrides, readOnly, requireApproval }: ResponsesFileToolsOptions) => ResponsesFileTools;
 export { type AgentsFileTools, type AgentsFileToolsOptions, type AgentsToolOverrides, type ApprovalConfig, type FileReadToolName, type FileToolName, type FunctionCallItem, type FunctionCallOutputItem, type ReadOnlyAgentsFileTools, type ResponsesFileTools, type ResponsesFileToolsOptions, type ResponsesFunctionTool, type ResponsesToolOverrides, agentsCopyFile, agentsDeleteFile, agentsDownloadFile, agentsGetFileMetadata, agentsGetFileUrl, agentsListFiles, agentsSignUploadUrl, agentsUploadFile, createAgentsFileTools, createResponsesFileTools };

package/dist/ai/tanstack/index.d.ts

@@ -1,25 +1,25 @@
-import { F as Files } from "../../packem_shared/files.d-CH0iLBNC.js";
+import { F as Files } from "../../packem_shared/files.d-D8H_ge9Y.js";
 import 'node:stream';
 import 'node:crypto';
 import 'node:http';
 import 'lru-cache';
-import { T as TOOL_SCHEMAS, c as FileReadToolName, F as FileToolName, A as ApprovalConfig } from "../../packem_shared/approval.d-CMAYH9GF.js";
-export type { d as FileWriteToolName } from "../../packem_shared/approval.d-CMAYH9GF.js";
+import { T as TOOL_SCHEMAS, c as FileReadToolName, F as FileToolName, A as ApprovalConfig } from "../../packem_shared/approval.d-C-d-t94D.js";
+export type { d as FileWriteToolName } from "../../packem_shared/approval.d-C-d-t94D.js";
 import { ServerTool } from '@tanstack/ai';
-import "../../packem_shared/storage.d-CEM1upWM.js";
+import "../../packem_shared/storage.d-DIav_lF1.js";
 import 'zod';
 /**
-* Common options accepted by every write-tool factory.
-*/
+ * Common options accepted by every write-tool factory.
+ */
 interface ToolOptions {
   needsApproval?: boolean;
 }
 /**
-* Per-tool overrides for customizing TanStack AI `ServerTool` properties
-* without changing the underlying implementation. Core properties
-* (`execute`, `inputSchema`, `outputSchema`, `__toolSide`) are intentionally
-* excluded — those drive the tool's behavior and contract.
-*/
+ * Per-tool overrides for customizing TanStack AI `ServerTool` properties
+ * without changing the underlying implementation. Core properties
+ * (`execute`, `inputSchema`, `outputSchema`, `__toolSide`) are intentionally
+ * excluded — those drive the tool's behavior and contract.
+ */
 type ToolOverrides = Partial<Pick<ServerTool, "description" | "lazy" | "metadata" | "needsApproval">>;
 type ListFilesParameters = typeof TOOL_SCHEMAS.listFiles.input;
 type GetFileMetadataParameters = typeof TOOL_SCHEMAS.getFileMetadata.input;
@@ -33,40 +33,32 @@ declare const listFiles: (files: Files) => ServerTool<ListFilesParameters, never
 declare const getFileMetadata: (files: Files) => ServerTool<GetFileMetadataParameters, never, "getFileMetadata">;
 declare const downloadFile: (files: Files) => ServerTool<DownloadFileParameters, never, "downloadFile">;
 declare const getFileUrl: (files: Files) => ServerTool<GetFileUrlParameters, never, "getFileUrl">;
-declare const uploadFile: (files: Files, {
-  needsApproval
-}?: ToolOptions) => ServerTool<UploadFileParameters, never, "uploadFile">;
-declare const deleteFile: (files: Files, {
-  needsApproval
-}?: ToolOptions) => ServerTool<DeleteFileParameters, never, "deleteFile">;
-declare const copyFile: (files: Files, {
-  needsApproval
-}?: ToolOptions) => ServerTool<CopyFileParameters, never, "copyFile">;
-declare const signUploadUrl: (files: Files, {
-  needsApproval
-}?: ToolOptions) => ServerTool<SignUploadUrlParameters, never, "signUploadUrl">;
+declare const uploadFile: (files: Files, { needsApproval }?: ToolOptions) => ServerTool<UploadFileParameters, never, "uploadFile">;
+declare const deleteFile: (files: Files, { needsApproval }?: ToolOptions) => ServerTool<DeleteFileParameters, never, "deleteFile">;
+declare const copyFile: (files: Files, { needsApproval }?: ToolOptions) => ServerTool<CopyFileParameters, never, "copyFile">;
+declare const signUploadUrl: (files: Files, { needsApproval }?: ToolOptions) => ServerTool<SignUploadUrlParameters, never, "signUploadUrl">;
 interface TanstackFileToolsOptions {
   /**
-  * The configured `Files` instance the tools will operate against.
-  * Each tool delegates to the methods on this instance.
-  */
+   * The configured `Files` instance the tools will operate against.
+   * Each tool delegates to the methods on this instance.
+   */
   files: Files;
   /**
-  * Per-tool overrides for customizing tool behavior (description,
-  * needsApproval, metadata) without changing the underlying implementation.
-  * `execute` and `inputSchema` cannot be overridden.
-  */
+   * Per-tool overrides for customizing tool behavior (description,
+   * needsApproval, metadata) without changing the underlying implementation.
+   * `execute` and `inputSchema` cannot be overridden.
+   */
   overrides?: Partial<Record<FileToolName, ToolOverrides>>;
   /**
-  * When `true`, write tools (`uploadFile`, `deleteFile`, `copyFile`,
-  * `signUploadUrl`) are omitted entirely. The model cannot mutate the
-  * bucket regardless of approval configuration.
-  */
+   * When `true`, write tools (`uploadFile`, `deleteFile`, `copyFile`,
+   * `signUploadUrl`) are omitted entirely. The model cannot mutate the
+   * bucket regardless of approval configuration.
+   */
   readOnly?: boolean;
   /**
-  * Approval gating for write tools. Defaults to `true` (all writes
-  * require approval). See {@link ApprovalConfig}.
-  */
+   * Approval gating for write tools. Defaults to `true` (all writes
+   * require approval). See {@link ApprovalConfig}.
+   */
   requireApproval?: ApprovalConfig;
 }
 interface TanstackFileTools {
@@ -81,30 +73,30 @@ interface TanstackFileTools {
 }
 type ReadOnlyTanstackFileTools = Pick<TanstackFileTools, FileReadToolName>;
 /**
-* Create a set of visulima/storage tools for TanStack AI.
-*
-* Each entry is a `ServerTool` built via `toolDefinition(...).server(...)`,
-* ready to be passed to `chat({ tools: [...] })` or registered with a
-* `ToolRegistry`. Write operations require user approval by default;
-* control globally or per-tool via `requireApproval`, or strip writes
-* entirely with `readOnly: true`.
-* @example
-* ```ts
-* import { Files } from "@visulima/storage";
-* import { S3Storage } from "@visulima/storage/provider/aws";
-* import { createTanstackFileTools } from "@visulima/storage/ai/tanstack";
-* import { chat } from "@tanstack/ai";
-*
-* const files = new Files({ adapter: new S3Storage({ bucket: "uploads" }) });
-* const tools = createTanstackFileTools({ files });
-*
-* const stream = chat({
-*   adapter,
-*   messages,
-*   tools: Object.values(tools),
-* });
-* ```
-*/
+ * Create a set of visulima/storage tools for TanStack AI.
+ *
+ * Each entry is a `ServerTool` built via `toolDefinition(...).server(...)`,
+ * ready to be passed to `chat({ tools: [...] })` or registered with a
+ * `ToolRegistry`. Write operations require user approval by default;
+ * control globally or per-tool via `requireApproval`, or strip writes
+ * entirely with `readOnly: true`.
+ * @example
+ * ```ts
+ * import { Files } from "@visulima/storage";
+ * import { S3Storage } from "@visulima/storage/provider/aws";
+ * import { createTanstackFileTools } from "@visulima/storage/ai/tanstack";
+ * import { chat } from "@tanstack/ai";
+ *
+ * const files = new Files({ adapter: new S3Storage({ bucket: "uploads" }) });
+ * const tools = createTanstackFileTools({ files });
+ *
+ * const stream = chat({
+ *   adapter,
+ *   messages,
+ *   tools: Object.values(tools),
+ * });
+ * ```
+ */
 declare function createTanstackFileTools(options: TanstackFileToolsOptions & {
   readOnly: true;
 }): ReadOnlyTanstackFileTools;