bashkit 0.3.1 → 0.4.0

package/AGENTS.md

@@ -98,12 +98,14 @@ This is useful for:
 
 | Tool | Purpose | Key Inputs |
 |------|---------|------------|
-| `Bash` | Execute shell commands | `command`, `timeout?`, `description?` |
-| `Read` | Read files or list directories | `file_path`, `offset?`, `limit?` |
+| `Bash` | Execute shell commands | `command`, `timeout`, `description` |
+| `Read` | Read files or list directories | `file_path`, `offset`, `limit` |
 | `Write` | Create/overwrite files | `file_path`, `content` |
-| `Edit` | Replace strings in files | `file_path`, `old_string`, `new_string`, `replace_all?` |
-| `Glob` | Find files by pattern | `pattern`, `path?` |
-| `Grep` | Search file contents | `pattern`, `path?`, `output_mode?`, `-i?`, `-C?` |
+| `Edit` | Replace strings in files | `file_path`, `old_string`, `new_string`, `replace_all` |
+| `Glob` | Find files by pattern | `pattern`, `path` |
+| `Grep` | Search file contents | `pattern`, `path`, `output_mode`, `-i`, `-C` |
+
+> **Note on nullable types:** Optional parameters use `T | null` (not `T | undefined`) for OpenAI structured outputs compatibility. AI models should send explicit `null` for parameters they don't want to set. This works with both OpenAI and Anthropic models.
 
 ### Optional Tools (via config)
 

package/README.md

@@ -19,6 +19,32 @@ Agentic coding tools for Vercel AI SDK. Give AI agents the ability to execute co
 - Search the web and fetch URLs
 - Load skills on-demand via the [Agent Skills](https://agentskills.io) standard
 
+## Breaking Changes in v0.4.0
+
+### Nullable Types for OpenAI Compatibility
+
+All optional tool parameters now use `.nullable()` instead of `.optional()` in Zod schemas. This change enables compatibility with OpenAI's structured outputs, which require all properties to be in the `required` array.
+
+**What changed:**
+- Tool input types changed from `T | undefined` to `T | null`
+- Exported interfaces (`QuestionOption`, `StructuredQuestion`) use `T | null`
+- AI models will send explicit `null` values instead of omitting properties
+
+**Migration:**
+```typescript
+// Before v0.4.0
+const option: QuestionOption = { label: "test", description: undefined };
+
+// v0.4.0+
+const option: QuestionOption = { label: "test", description: null };
+```
+
+**Why this matters:**
+- Works with both OpenAI and Anthropic models
+- OpenAI structured outputs require nullable (not optional) fields
+- Anthropic/Claude handles nullable fields correctly
+- The `??` operator handles both `null` and `undefined`, so runtime behavior is unchanged
+
 ## Installation
 
 ```bash

package/dist/cloudflare/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * bashkit/cloudflare - Cloudflare Workers compatible exports
+ *
+ * This module exports only the parts of bashkit that work in Cloudflare Workers.
+ * It excludes local sandbox (uses Bun/Node APIs) and bundled ripgrep.
+ *
+ * @example
+ * ```typescript
+ * import { createE2BSandbox, createBashTool } from 'bashkit/cloudflare';
+ * ```
+ */
+export { createE2BSandbox, type E2BSandboxConfig } from "../sandbox/e2b";
+export type { ExecOptions, ExecResult, Sandbox } from "../sandbox/interface";
+export { createBashTool } from "../tools/bash";
+export { createReadTool } from "../tools/read";
+export { createWriteTool } from "../tools/write";
+export { createEditTool } from "../tools/edit";
+export { createGlobTool } from "../tools/glob";
+export { createGrepTool } from "../tools/grep";
+export type { BashOutput, BashError, ReadOutput, ReadError, WriteOutput, WriteError, EditOutput, EditError, GlobOutput, GlobError, GrepOutput, GrepError, } from "../tools";