Add missing hook output fields to match TypeScript SDK #226
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ashwin-ant
force-pushed
the
ashwin/hooktypes
branch
2 times, most recently
from
bd31bc0 to
3cf6b56
Compare
bcherny
reviewed
Oct 9, 2025
szwang
previously approved these changes
Oct 9, 2025
Collaborator
szwang
left a comment
szwang
left a comment
There was a problem hiding this comment.
lgtm! left a few minor questions and nonblocking ideas
src/claude_agent_sdk/types.py
Outdated
| stopReason: NotRequired[str] | ||
|
|
||
| # Decision fields | ||
| decision: NotRequired[Literal["approve", "block"]] |
Collaborator
There was a problem hiding this comment.
Can this used for every hook specific output? It feels more intuitive to me as something pre-tool use but not sure of how it gets used beyond that.
Collaborator
Author
There was a problem hiding this comment.
Will stick with this since it's mirroring TS types, but we should revisit
| $job = Start-Job { python examples/hooks.py DecisionFields } | ||
| Wait-Job $job -Timeout 120 | Out-Null | ||
| Stop-Job $job | ||
| Receive-Job $job |
Collaborator
There was a problem hiding this comment.
Are we actually running on Windows for test-examples? Since runs-on: ubuntu-latest
| "systemMessage": "⚠️ Command blocked by hook", | ||
| "hookSpecificOutput": { | ||
| "hookEventName": "PreToolUse", | ||
| "permissionDecision": "deny", |
Collaborator
There was a problem hiding this comment.
Would love to better understand the difference between decision and permissionDecision
Collaborator
Author
There was a problem hiding this comment.
decision and reason are actually deprecated, so it's a little confusing right now
Closes the gap between Python and TypeScript SDK hook output types by adding: - `reason` field for explaining decisions - `continue_` field for controlling execution flow - `suppressOutput` field for hiding stdout - `stopReason` field for stop explanations - `decision` now supports both "approve" and "block" (not just "block") - `AsyncHookJSONOutput` type for deferred hook execution - Proper typing for `hookSpecificOutput` with discriminated unions Also adds comprehensive examples and tests: - New examples in hooks.py demonstrating all new fields - Unit tests in test_tool_callbacks.py for new output types - E2E tests in e2e-tests/test_hooks.py with real API calls - CI integration in .github/workflows/test.yml 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
- Remove deprecated `decision: "approve"` in favor of `permissionDecision: "allow"` - Update `decision` type to only allow "block" (approve is deprecated) - Replace string assertions with JSON parsing in unit tests for robustness - Add HookJSONOutput type annotations to test hook functions - Rename test to match actual behavior (permission decision vs generic decision) - Update examples and documentation to use new permissionDecision API 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
ashwin-ant
force-pushed
the
ashwin/hooktypes
branch
from
d360a2b to
6d1c0d9
Compare
szwang
approved these changes
Oct 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes the gap between Python and TypeScript SDK hook output types by adding:
reasonfield for explaining decisionscontinue_field for controlling execution flowsuppressOutputfield for hiding stdoutstopReasonfield for stop explanationsdecisionnow supports both "approve" and "block" (not just "block")AsyncHookJSONOutputtype for deferred hook executionhookSpecificOutputwith discriminated unionsAlso adds comprehensive examples and tests:
🤖 Generated with Claude Code