Repository navigation
Expand file tree
/
Copy pathhooks.ts
More file actions
290 lines (272 loc) · 8.92 KB
/
Copy pathhooks.ts
File metadata and controls
290 lines (272 loc) · 8.92 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
// biome-ignore-all assist/source/organizeImports: ANT-ONLY import markers must not be reordered
import { z } from 'zod/v4'
import { lazySchema } from '../utils/lazySchema.js'
import {
type HookEvent,
HOOK_EVENTS,
type HookInput,
type PermissionUpdate,
} from 'src/entrypoints/agentSdkTypes.js'
import type {
HookJSONOutput,
AsyncHookJSONOutput,
SyncHookJSONOutput,
} from 'src/entrypoints/agentSdkTypes.js'
import type { Message } from 'src/types/message.js'
import type { PermissionResult } from 'src/utils/permissions/PermissionResult.js'
import { permissionBehaviorSchema } from 'src/utils/permissions/PermissionRule.js'
import { permissionUpdateSchema } from 'src/utils/permissions/PermissionUpdateSchema.js'
import type { AppState } from '../state/AppState.js'
import type { AttributionState } from '../utils/commitAttribution.js'
export function isHookEvent(value: string): value is HookEvent {
return HOOK_EVENTS.includes(value as HookEvent)
}
// Prompt elicitation protocol types. The `prompt` key acts as discriminator
// (mirroring the {async:true} pattern), with the id as its value.
export const promptRequestSchema = lazySchema(() =>
z.object({
prompt: z.string(), // request id
message: z.string(),
options: z.array(
z.object({
key: z.string(),
label: z.string(),
description: z.string().optional(),
}),
),
}),
)
export type PromptRequest = z.infer<ReturnType<typeof promptRequestSchema>>
export type PromptResponse = {
prompt_response: string // request id
selected: string
}
// Sync hook response schema
export const syncHookResponseSchema = lazySchema(() =>
z.object({
continue: z
.boolean()
.describe('Whether Claude should continue after hook (default: true)')
.optional(),
suppressOutput: z
.boolean()
.describe('Hide stdout from transcript (default: false)')
.optional(),
stopReason: z
.string()
.describe('Message shown when continue is false')
.optional(),
decision: z.enum(['approve', 'block']).optional(),
reason: z.string().describe('Explanation for the decision').optional(),
systemMessage: z
.string()
.describe('Warning message shown to the user')
.optional(),
hookSpecificOutput: z
.union([
z.object({
hookEventName: z.literal('PreToolUse'),
permissionDecision: permissionBehaviorSchema().optional(),
permissionDecisionReason: z.string().optional(),
updatedInput: z.record(z.string(), z.unknown()).optional(),
additionalContext: z.string().optional(),
}),
z.object({
hookEventName: z.literal('UserPromptSubmit'),
additionalContext: z.string().optional(),
}),
z.object({
hookEventName: z.literal('SessionStart'),
additionalContext: z.string().optional(),
initialUserMessage: z.string().optional(),
watchPaths: z
.array(z.string())
.describe('Absolute paths to watch for FileChanged hooks')
.optional(),
}),
z.object({
hookEventName: z.literal('Setup'),
additionalContext: z.string().optional(),
}),
z.object({
hookEventName: z.literal('SubagentStart'),
additionalContext: z.string().optional(),
}),
z.object({
hookEventName: z.literal('PostToolUse'),
additionalContext: z.string().optional(),
updatedMCPToolOutput: z
.unknown()
.describe('Updates the output for MCP tools')
.optional(),
}),
z.object({
hookEventName: z.literal('PostToolUseFailure'),
additionalContext: z.string().optional(),
}),
z.object({
hookEventName: z.literal('PermissionDenied'),
retry: z.boolean().optional(),
}),
z.object({
hookEventName: z.literal('Notification'),
additionalContext: z.string().optional(),
}),
z.object({
hookEventName: z.literal('PermissionRequest'),
decision: z.union([
z.object({
behavior: z.literal('allow'),
updatedInput: z.record(z.string(), z.unknown()).optional(),
updatedPermissions: z.array(permissionUpdateSchema()).optional(),
}),
z.object({
behavior: z.literal('deny'),
message: z.string().optional(),
interrupt: z.boolean().optional(),
}),
]),
}),
z.object({
hookEventName: z.literal('Elicitation'),
action: z.enum(['accept', 'decline', 'cancel']).optional(),
content: z.record(z.string(), z.unknown()).optional(),
}),
z.object({
hookEventName: z.literal('ElicitationResult'),
action: z.enum(['accept', 'decline', 'cancel']).optional(),
content: z.record(z.string(), z.unknown()).optional(),
}),
z.object({
hookEventName: z.literal('CwdChanged'),
watchPaths: z
.array(z.string())
.describe('Absolute paths to watch for FileChanged hooks')
.optional(),
}),
z.object({
hookEventName: z.literal('FileChanged'),
watchPaths: z
.array(z.string())
.describe('Absolute paths to watch for FileChanged hooks')
.optional(),
}),
z.object({
hookEventName: z.literal('WorktreeCreate'),
worktreePath: z.string(),
}),
])
.optional(),
}),
)
// Zod schema for hook JSON output validation
export const hookJSONOutputSchema = lazySchema(() => {
// Async hook response schema
const asyncHookResponseSchema = z.object({
async: z.literal(true),
asyncTimeout: z.number().optional(),
})
return z.union([asyncHookResponseSchema, syncHookResponseSchema()])
})
// Infer the TypeScript type from the schema
type SchemaHookJSONOutput = z.infer<ReturnType<typeof hookJSONOutputSchema>>
// Type guard function to check if response is sync
export function isSyncHookJSONOutput(
json: HookJSONOutput,
): json is SyncHookJSONOutput {
return !('async' in json && json.async === true)
}
// Type guard function to check if response is async
export function isAsyncHookJSONOutput(
json: HookJSONOutput,
): json is AsyncHookJSONOutput {
return 'async' in json && json.async === true
}
// Compile-time assertion that SDK and Zod types match
import type { IsEqual } from 'type-fest'
type Assert<T extends true> = T
type _assertSDKTypesMatch = Assert<
IsEqual<SchemaHookJSONOutput, HookJSONOutput>
>
/** Context passed to callback hooks for state access */
export type HookCallbackContext = {
getAppState: () => AppState
updateAttributionState: (
updater: (prev: AttributionState) => AttributionState,
) => void
}
/** Hook that is a callback. */
export type HookCallback = {
type: 'callback'
callback: (
input: HookInput,
toolUseID: string | null,
abort: AbortSignal | undefined,
/** Hook index for SessionStart hooks to compute CLAUDE_ENV_FILE path */
hookIndex?: number,
/** Optional context for accessing app state */
context?: HookCallbackContext,
) => Promise<HookJSONOutput>
/** Timeout in seconds for this hook */
timeout?: number
/** Internal hooks (e.g. session file access analytics) are excluded from tengu_run_hook metrics */
internal?: boolean
}
export type HookCallbackMatcher = {
matcher?: string
hooks: HookCallback[]
pluginName?: string
}
export type HookProgress = {
type: 'hook_progress'
hookEvent: HookEvent
hookName: string
command: string
promptText?: string
statusMessage?: string
}
export type HookBlockingError = {
blockingError: string
command: string
}
export type PermissionRequestResult =
| {
behavior: 'allow'
updatedInput?: Record<string, unknown>
updatedPermissions?: PermissionUpdate[]
}
| {
behavior: 'deny'
message?: string
interrupt?: boolean
}
export type HookResult = {
message?: Message
systemMessage?: Message
blockingError?: HookBlockingError
outcome: 'success' | 'blocking' | 'non_blocking_error' | 'cancelled'
preventContinuation?: boolean
stopReason?: string
permissionBehavior?: 'ask' | 'deny' | 'allow' | 'passthrough'
hookPermissionDecisionReason?: string
additionalContext?: string
initialUserMessage?: string
updatedInput?: Record<string, unknown>
updatedMCPToolOutput?: unknown
permissionRequestResult?: PermissionRequestResult
retry?: boolean
}
export type AggregatedHookResult = {
message?: Message
blockingErrors?: HookBlockingError[]
preventContinuation?: boolean
stopReason?: string
hookPermissionDecisionReason?: string
permissionBehavior?: PermissionResult['behavior']
additionalContexts?: string[]
initialUserMessage?: string
updatedInput?: Record<string, unknown>
updatedMCPToolOutput?: unknown
permissionRequestResult?: PermissionRequestResult
retry?: boolean
}