65165b5d54
The two hook bridges (dsh-hooks-claude, dsh-hooks-codex) would otherwise duplicate
the bulk of the protocol — Codex deliberately reimplements a SUBSET of the Claude
Code protocol (same hooks.json shape, exit-code/stdout contract, command-hook
model). This library holds the genuinely-identical primitives; each bridge owns
only what differs (per-event stdin payload, env/substitution, decision mapping).
New packages/hooks/ group; hook-protocol is a LIBRARY (no plugin, registers/injects
nothing):
- matcher: matchesMatcher(pattern, query, mode) — the one dialect axis collapsed to
a mode param (claude = literal-or-regex with pipe alternation; codex = always
unanchored regex). Match-all on absent/''/'*'; invalid regex matches nothing.
- codec: parseHookOutput(exit, stdout, stderr) → dialect-neutral HookOutput. Exit 0
→ lenient JSON; exit 2 → blocking error (stderr = reason, surfaced as
decision:'block'); other → non-blocking. Parses the CC superset
(continue/stopReason/decision/hookSpecificOutput.{permissionDecision,
additionalContext,updatedInput}/systemMessage); permissionDecision overrides the
legacy top-level decision.
- runner: runHook(bash, hook, opts, now) — runs a command hook via ctx.bash (stdin
payload + trusted-plugin env), honors timeoutSec, never throws (executor reject →
non-blocking-error HookOutput). Injected clock for testable durations.
- merge: mergeHookOutputs — most-restrictive fold (deny>ask>allow, sticky stop,
block reasons joined, context/system-messages accumulated).
- hook/* session events (declaration-merged into SessionEventMap, log-only like
compact/*) + appendHookInvoked/appendHookResult helpers.
updatedInput is parsed but NOT honored (deferred pre-tool-input-rewrite RFC); a
bridge logs+warns. 47 unit tests at per-file 100% (matcher per-mode, codec per
exit-code/field, runner plumbing w/ stub executor, merge precedence, hook/*
helpers). RFC: implemented/feature/2026-06-30-hook-protocol-lib.md.
39 lines
1.7 KiB
TypeScript
39 lines
1.7 KiB
TypeScript
/**
|
|
* `@deepseek-ai/dsh-hook-protocol` — the shared core of the Claude Code / Codex
|
|
* hook wire protocol. NOT a cordis plugin: it registers nothing and injects
|
|
* nothing. It is a LIBRARY of dialect-neutral primitives the two bridge plugins
|
|
* (`dsh-hooks-claude`, `dsh-hooks-codex`) import to avoid re-implementing the
|
|
* identical halves of the protocol:
|
|
*
|
|
* - {@link matchesMatcher} — the matcher primitive (literal-or-regex by dialect).
|
|
* - {@link runHook} + {@link parseHookOutput} — run a command hook via `ctx.bash`
|
|
* (stdin payload + env) and decode its exit-code/stdout/stderr into a neutral
|
|
* {@link HookOutput}.
|
|
* - {@link mergeHookOutputs} — fold multiple matched hooks into one
|
|
* most-restrictive {@link MergedHookOutcome} (deny > ask > allow).
|
|
* - {@link appendHookInvoked} / {@link appendHookResult} — the log-only `hook/*`
|
|
* session-event helpers (declaration-merged into `SessionEventMap`).
|
|
*
|
|
* Each bridge owns what genuinely DIFFERS: building the per-event stdin payload
|
|
* (CC vs Codex field sets), the dialect's env/substitution, and mapping the
|
|
* neutral outcome onto the harness's seam-specific typed Decisions.
|
|
*
|
|
* @module @deepseek-ai/dsh-hook-protocol
|
|
*/
|
|
|
|
export type {
|
|
CommandHook,
|
|
HookDialect,
|
|
HookOutput,
|
|
MatcherGroup,
|
|
MatcherMode,
|
|
} from './types.ts'
|
|
export { matchesMatcher } from './matcher.ts'
|
|
export { BLOCKING_EXIT_CODE, parseHookOutput } from './codec.ts'
|
|
export { runHook } from './runner.ts'
|
|
export type { RunHookOptions, RunHookResult } from './runner.ts'
|
|
export { mergeHookOutputs } from './merge.ts'
|
|
export type { MergedDecision, MergedHookOutcome } from './merge.ts'
|
|
export { appendHookInvoked, appendHookResult } from './events.ts'
|
|
export type { HookInvocation, HookResultRecord } from './events.ts'
|