@librechat/agents 3.1.66 → 3.1.67-dev.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/dist/cjs/agents/AgentContext.cjs +23 -3
  2. package/dist/cjs/agents/AgentContext.cjs.map +1 -1
  3. package/dist/cjs/common/enum.cjs +14 -0
  4. package/dist/cjs/common/enum.cjs.map +1 -1
  5. package/dist/cjs/graphs/Graph.cjs +72 -0
  6. package/dist/cjs/graphs/Graph.cjs.map +1 -1
  7. package/dist/cjs/hooks/HookRegistry.cjs +162 -0
  8. package/dist/cjs/hooks/HookRegistry.cjs.map +1 -0
  9. package/dist/cjs/hooks/executeHooks.cjs +276 -0
  10. package/dist/cjs/hooks/executeHooks.cjs.map +1 -0
  11. package/dist/cjs/hooks/matchers.cjs +256 -0
  12. package/dist/cjs/hooks/matchers.cjs.map +1 -0
  13. package/dist/cjs/hooks/types.cjs +27 -0
  14. package/dist/cjs/hooks/types.cjs.map +1 -0
  15. package/dist/cjs/main.cjs +52 -0
  16. package/dist/cjs/main.cjs.map +1 -1
  17. package/dist/cjs/messages/format.cjs +74 -12
  18. package/dist/cjs/messages/format.cjs.map +1 -1
  19. package/dist/cjs/run.cjs +111 -0
  20. package/dist/cjs/run.cjs.map +1 -1
  21. package/dist/cjs/summarization/node.cjs +44 -0
  22. package/dist/cjs/summarization/node.cjs.map +1 -1
  23. package/dist/cjs/tools/BashExecutor.cjs +175 -0
  24. package/dist/cjs/tools/BashExecutor.cjs.map +1 -0
  25. package/dist/cjs/tools/BashProgrammaticToolCalling.cjs +296 -0
  26. package/dist/cjs/tools/BashProgrammaticToolCalling.cjs.map +1 -0
  27. package/dist/cjs/tools/ReadFile.cjs +43 -0
  28. package/dist/cjs/tools/ReadFile.cjs.map +1 -0
  29. package/dist/cjs/tools/SkillTool.cjs +50 -0
  30. package/dist/cjs/tools/SkillTool.cjs.map +1 -0
  31. package/dist/cjs/tools/SubagentTool.cjs +92 -0
  32. package/dist/cjs/tools/SubagentTool.cjs.map +1 -0
  33. package/dist/cjs/tools/ToolNode.cjs +304 -140
  34. package/dist/cjs/tools/ToolNode.cjs.map +1 -1
  35. package/dist/cjs/tools/skillCatalog.cjs +84 -0
  36. package/dist/cjs/tools/skillCatalog.cjs.map +1 -0
  37. package/dist/cjs/tools/subagent/SubagentExecutor.cjs +261 -0
  38. package/dist/cjs/tools/subagent/SubagentExecutor.cjs.map +1 -0
  39. package/dist/esm/agents/AgentContext.mjs +23 -3
  40. package/dist/esm/agents/AgentContext.mjs.map +1 -1
  41. package/dist/esm/common/enum.mjs +13 -1
  42. package/dist/esm/common/enum.mjs.map +1 -1
  43. package/dist/esm/graphs/Graph.mjs +72 -0
  44. package/dist/esm/graphs/Graph.mjs.map +1 -1
  45. package/dist/esm/hooks/HookRegistry.mjs +160 -0
  46. package/dist/esm/hooks/HookRegistry.mjs.map +1 -0
  47. package/dist/esm/hooks/executeHooks.mjs +273 -0
  48. package/dist/esm/hooks/executeHooks.mjs.map +1 -0
  49. package/dist/esm/hooks/matchers.mjs +251 -0
  50. package/dist/esm/hooks/matchers.mjs.map +1 -0
  51. package/dist/esm/hooks/types.mjs +25 -0
  52. package/dist/esm/hooks/types.mjs.map +1 -0
  53. package/dist/esm/main.mjs +12 -1
  54. package/dist/esm/main.mjs.map +1 -1
  55. package/dist/esm/messages/format.mjs +66 -4
  56. package/dist/esm/messages/format.mjs.map +1 -1
  57. package/dist/esm/run.mjs +111 -0
  58. package/dist/esm/run.mjs.map +1 -1
  59. package/dist/esm/summarization/node.mjs +44 -0
  60. package/dist/esm/summarization/node.mjs.map +1 -1
  61. package/dist/esm/tools/BashExecutor.mjs +169 -0
  62. package/dist/esm/tools/BashExecutor.mjs.map +1 -0
  63. package/dist/esm/tools/BashProgrammaticToolCalling.mjs +287 -0
  64. package/dist/esm/tools/BashProgrammaticToolCalling.mjs.map +1 -0
  65. package/dist/esm/tools/ReadFile.mjs +38 -0
  66. package/dist/esm/tools/ReadFile.mjs.map +1 -0
  67. package/dist/esm/tools/SkillTool.mjs +45 -0
  68. package/dist/esm/tools/SkillTool.mjs.map +1 -0
  69. package/dist/esm/tools/SubagentTool.mjs +85 -0
  70. package/dist/esm/tools/SubagentTool.mjs.map +1 -0
  71. package/dist/esm/tools/ToolNode.mjs +306 -142
  72. package/dist/esm/tools/ToolNode.mjs.map +1 -1
  73. package/dist/esm/tools/skillCatalog.mjs +82 -0
  74. package/dist/esm/tools/skillCatalog.mjs.map +1 -0
  75. package/dist/esm/tools/subagent/SubagentExecutor.mjs +256 -0
  76. package/dist/esm/tools/subagent/SubagentExecutor.mjs.map +1 -0
  77. package/dist/types/agents/AgentContext.d.ts +6 -0
  78. package/dist/types/common/enum.d.ts +8 -1
  79. package/dist/types/graphs/Graph.d.ts +2 -0
  80. package/dist/types/hooks/HookRegistry.d.ts +56 -0
  81. package/dist/types/hooks/executeHooks.d.ts +79 -0
  82. package/dist/types/hooks/index.d.ts +6 -0
  83. package/dist/types/hooks/matchers.d.ts +95 -0
  84. package/dist/types/hooks/types.d.ts +320 -0
  85. package/dist/types/index.d.ts +8 -0
  86. package/dist/types/messages/format.d.ts +2 -1
  87. package/dist/types/run.d.ts +1 -0
  88. package/dist/types/summarization/node.d.ts +2 -0
  89. package/dist/types/tools/BashExecutor.d.ts +45 -0
  90. package/dist/types/tools/BashProgrammaticToolCalling.d.ts +72 -0
  91. package/dist/types/tools/ReadFile.d.ts +28 -0
  92. package/dist/types/tools/SkillTool.d.ts +40 -0
  93. package/dist/types/tools/SubagentTool.d.ts +36 -0
  94. package/dist/types/tools/ToolNode.d.ts +24 -2
  95. package/dist/types/tools/skillCatalog.d.ts +19 -0
  96. package/dist/types/tools/subagent/SubagentExecutor.d.ts +83 -0
  97. package/dist/types/tools/subagent/index.d.ts +2 -0
  98. package/dist/types/types/graph.d.ts +25 -0
  99. package/dist/types/types/index.d.ts +1 -0
  100. package/dist/types/types/llm.d.ts +14 -2
  101. package/dist/types/types/run.d.ts +20 -0
  102. package/dist/types/types/skill.d.ts +9 -0
  103. package/dist/types/types/tools.d.ts +38 -1
  104. package/package.json +2 -1
  105. package/src/agents/AgentContext.ts +26 -2
  106. package/src/common/enum.ts +13 -0
  107. package/src/graphs/Graph.ts +92 -0
  108. package/src/hooks/HookRegistry.ts +208 -0
  109. package/src/hooks/__tests__/HookRegistry.test.ts +190 -0
  110. package/src/hooks/__tests__/compactHooks.test.ts +214 -0
  111. package/src/hooks/__tests__/executeHooks.test.ts +1013 -0
  112. package/src/hooks/__tests__/integration.test.ts +337 -0
  113. package/src/hooks/__tests__/matchers.test.ts +238 -0
  114. package/src/hooks/__tests__/toolHooks.test.ts +669 -0
  115. package/src/hooks/executeHooks.ts +375 -0
  116. package/src/hooks/index.ts +57 -0
  117. package/src/hooks/matchers.ts +280 -0
  118. package/src/hooks/types.ts +404 -0
  119. package/src/index.ts +10 -0
  120. package/src/messages/format.ts +74 -4
  121. package/src/messages/formatAgentMessages.skills.test.ts +334 -0
  122. package/src/run.ts +126 -0
  123. package/src/scripts/multi-agent-subagent.ts +246 -0
  124. package/src/specs/subagent.test.ts +305 -0
  125. package/src/summarization/node.ts +53 -0
  126. package/src/tools/BashExecutor.ts +205 -0
  127. package/src/tools/BashProgrammaticToolCalling.ts +397 -0
  128. package/src/tools/ReadFile.ts +39 -0
  129. package/src/tools/SkillTool.ts +46 -0
  130. package/src/tools/SubagentTool.ts +100 -0
  131. package/src/tools/ToolNode.ts +391 -169
  132. package/src/tools/__tests__/ReadFile.test.ts +44 -0
  133. package/src/tools/__tests__/SkillTool.test.ts +442 -0
  134. package/src/tools/__tests__/SubagentExecutor.test.ts +615 -0
  135. package/src/tools/__tests__/SubagentTool.test.ts +149 -0
  136. package/src/tools/__tests__/ToolNode.session.test.ts +12 -12
  137. package/src/tools/__tests__/skillCatalog.test.ts +161 -0
  138. package/src/tools/__tests__/subagentHooks.test.ts +215 -0
  139. package/src/tools/skillCatalog.ts +126 -0
  140. package/src/tools/subagent/SubagentExecutor.ts +344 -0
  141. package/src/tools/subagent/index.ts +12 -0
  142. package/src/types/graph.ts +27 -0
  143. package/src/types/index.ts +1 -0
  144. package/src/types/llm.ts +16 -2
  145. package/src/types/run.ts +20 -0
  146. package/src/types/skill.ts +11 -0
  147. package/src/types/tools.ts +41 -1
@@ -0,0 +1 @@
1
+ {"version":3,"file":"SubagentExecutor.mjs","sources":["../../../../src/tools/subagent/SubagentExecutor.ts"],"sourcesContent":["import { nanoid } from 'nanoid';\nimport { HumanMessage } from '@langchain/core/messages';\nimport type { BaseMessage } from '@langchain/core/messages';\nimport type {\n AgentInputs,\n StandardGraphInput,\n ResolvedSubagentConfig,\n SubagentConfig,\n TokenCounter,\n} from '@/types';\nimport type { AggregatedHookResult, HookRegistry } from '@/hooks';\nimport type { AgentContext } from '@/agents/AgentContext';\nimport type { StandardGraph } from '@/graphs/Graph';\nimport { executeHooks } from '@/hooks';\n\nconst DEFAULT_MAX_TURNS = 25;\nconst RECURSION_MULTIPLIER = 3;\nconst ERROR_MESSAGE_MAX_CHARS = 200;\n\nconst HOOK_FALLBACK: AggregatedHookResult = Object.freeze({\n additionalContexts: [] as string[],\n errors: [] as string[],\n});\n\nexport type SubagentExecuteParams = {\n description: string;\n subagentType: string;\n threadId?: string;\n};\n\nexport type SubagentExecuteResult = {\n content: string;\n messages: BaseMessage[];\n};\n\n/**\n * Factory that constructs a child graph for subagent execution. Injected\n * rather than imported so that `SubagentExecutor` does not have a runtime\n * dependency on `StandardGraph` — this avoids a circular dependency between\n * `src/graphs/Graph.ts` and `src/tools/subagent/` that would otherwise break\n * Rollup's chunking under `preserveModules`.\n */\nexport type ChildGraphFactory = (input: StandardGraphInput) => StandardGraph;\n\nexport type SubagentExecutorOptions = {\n configs: Map<string, ResolvedSubagentConfig>;\n parentSignal?: AbortSignal;\n hookRegistry?: HookRegistry;\n parentRunId: string;\n parentAgentId?: string;\n tokenCounter?: TokenCounter;\n /** Remaining nesting budget. 0 or negative blocks execution. */\n maxDepth?: number;\n /**\n * Factory for constructing the isolated child graph. Callers pass\n * `(input) => new StandardGraph(input)` — injected to break a circular\n * module dependency.\n */\n createChildGraph: ChildGraphFactory;\n};\n\nexport class SubagentExecutor {\n private readonly configs: Map<string, ResolvedSubagentConfig>;\n private readonly parentSignal?: AbortSignal;\n private readonly hookRegistry?: HookRegistry;\n private readonly parentRunId: string;\n private readonly parentAgentId?: string;\n private readonly tokenCounter?: TokenCounter;\n private readonly maxDepth: number;\n private readonly createChildGraph: ChildGraphFactory;\n\n constructor(options: SubagentExecutorOptions) {\n this.configs = options.configs;\n this.parentSignal = options.parentSignal;\n this.hookRegistry = options.hookRegistry;\n this.parentRunId = options.parentRunId;\n this.parentAgentId = options.parentAgentId;\n this.tokenCounter = options.tokenCounter;\n this.maxDepth = options.maxDepth ?? 1;\n this.createChildGraph = options.createChildGraph;\n }\n\n async execute(params: SubagentExecuteParams): Promise<SubagentExecuteResult> {\n const { description, subagentType, threadId } = params;\n const config = this.configs.get(subagentType);\n\n if (!config) {\n const available = [...this.configs.keys()].join(', ');\n return {\n content: `Error: Unknown subagent type \"${subagentType}\". Available types: ${available}`,\n messages: [],\n };\n }\n\n if (this.maxDepth <= 0) {\n return {\n content: 'Error: Maximum subagent nesting depth exceeded.',\n messages: [],\n };\n }\n\n const childAgentId =\n config.agentInputs.agentId ||\n `${this.parentAgentId ?? 'agent'}_sub_${nanoid(8)}`;\n\n if (\n this.hookRegistry?.hasHookFor('SubagentStart', this.parentRunId) === true\n ) {\n const hookResult = await executeHooks({\n registry: this.hookRegistry,\n input: {\n hook_event_name: 'SubagentStart',\n runId: this.parentRunId,\n threadId,\n parentAgentId: this.parentAgentId,\n agentId: childAgentId,\n agentType: subagentType,\n inputs: [new HumanMessage(description)],\n },\n sessionId: this.parentRunId,\n matchQuery: subagentType,\n }).catch((): AggregatedHookResult => HOOK_FALLBACK);\n\n /**\n * `ask` is treated identically to `deny` in the subagent context:\n * subagents are non-interactive, so there is no prompt path for `ask`.\n * Both decisions block execution and return a \"Blocked\" tool result.\n */\n if (hookResult.decision === 'deny' || hookResult.decision === 'ask') {\n return {\n content: `Blocked: ${hookResult.reason ?? 'Blocked by hook'}`,\n messages: [],\n };\n }\n }\n\n const childInputs = buildChildInputs(config, childAgentId, this.maxDepth);\n const childRunId = `${this.parentRunId}_sub_${nanoid(8)}`;\n const maxTurns = config.maxTurns ?? DEFAULT_MAX_TURNS;\n\n const childGraph = this.createChildGraph({\n runId: childRunId,\n signal: this.parentSignal,\n agents: [childInputs],\n tokenCounter: this.tokenCounter,\n });\n\n let result: { messages: BaseMessage[] };\n try {\n const workflow = childGraph.createWorkflow();\n /**\n * Detach the child invocation from the parent's callback chain.\n * Without this, `streamEvents` in the parent's `Run.processStream`\n * captures events from the child graph's LLM calls (e.g.\n * `on_chat_model_stream` for the \"researcher\" agent) and delivers\n * them to the parent's handlers. The parent then tries to resolve\n * the child's agent ID in its own `agentContexts` map and throws\n * \"No agent context found for agent ID …\". Setting `callbacks: []`\n * overrides the inherited callbacks for this invoke; combined with\n * the child's own empty `handlerRegistry`/`hookRegistry`, the child\n * runs fully isolated.\n *\n * `runName` gives the child a distinct LangSmith trace root (avoids\n * nested trace pollution).\n */\n result = await workflow.invoke(\n { messages: [new HumanMessage(description)] },\n {\n recursionLimit: maxTurns * RECURSION_MULTIPLIER,\n signal: this.parentSignal,\n callbacks: [],\n runName: `subagent:${subagentType}`,\n configurable: {\n thread_id: childRunId,\n },\n }\n );\n } catch (error) {\n childGraph.clearHeavyState();\n return {\n content: `Subagent error: ${truncateErrorMessage(error)}`,\n messages: [],\n };\n }\n\n const filteredContent = filterSubagentResult(result.messages);\n\n if (\n this.hookRegistry?.hasHookFor('SubagentStop', this.parentRunId) === true\n ) {\n /**\n * Awaited (not fire-and-forget) for deterministic test synchronization\n * and consistency with PostCompact. The parent is already waiting on the\n * tool result, so the small extra latency is acceptable. Errors are\n * swallowed — SubagentStop is observational.\n */\n await executeHooks({\n registry: this.hookRegistry,\n input: {\n hook_event_name: 'SubagentStop',\n runId: this.parentRunId,\n threadId,\n agentId: childAgentId,\n agentType: subagentType,\n messages: result.messages,\n },\n sessionId: this.parentRunId,\n matchQuery: subagentType,\n }).catch(() => {\n /* SubagentStop is observational — swallow errors */\n });\n }\n\n childGraph.clearHeavyState();\n\n return { content: filteredContent, messages: result.messages };\n }\n}\n\n/**\n * Walk messages from last to first, returning the text content of the most\n * recent AIMessage that has any. Non-text blocks (tool_use, thinking,\n * redacted_thinking, tool_result) are stripped. If the last AIMessage is\n * pure tool_use (e.g. the subagent hit `maxTurns` mid-tool-call), the walk\n * continues to earlier AIMessages so partial progress is salvaged — this\n * matches Claude Code's behavior in `agentToolUtils.finalizeAgentTool`.\n * Returns \"Task completed\" only when no AIMessage in the history contains\n * any text.\n */\nexport function filterSubagentResult(messages: BaseMessage[]): string {\n for (let i = messages.length - 1; i >= 0; i--) {\n if (messages[i]._getType() !== 'ai') {\n continue;\n }\n\n const content = messages[i].content;\n\n if (typeof content === 'string') {\n if (content) return content;\n continue;\n }\n\n if (!Array.isArray(content)) {\n continue;\n }\n\n const textParts: string[] = [];\n for (const block of content) {\n if (typeof block === 'string') {\n textParts.push(block);\n } else if ('type' in block && block.type === 'text' && 'text' in block) {\n textParts.push(block.text as string);\n }\n }\n\n if (textParts.length > 0) {\n return textParts.join('\\n');\n }\n }\n\n return 'Task completed';\n}\n\n/**\n * Resolve self-spawn configs by filling in agentInputs from the parent context.\n * Returns configs with agentInputs guaranteed present. Throws on duplicate\n * `type` values to prevent silent config shadowing.\n */\nexport function resolveSubagentConfigs(\n configs: SubagentConfig[],\n parentContext: AgentContext\n): ResolvedSubagentConfig[] {\n const resolved = configs\n .map((config) => {\n if (config.agentInputs != null) {\n return config as ResolvedSubagentConfig;\n }\n if (config.self !== true || parentContext._sourceInputs == null) {\n return null;\n }\n return {\n ...config,\n agentInputs: { ...parentContext._sourceInputs },\n } as ResolvedSubagentConfig;\n })\n .filter((c): c is ResolvedSubagentConfig => c != null);\n\n const seenTypes = new Set<string>();\n for (const config of resolved) {\n if (seenTypes.has(config.type)) {\n throw new Error(\n `Duplicate subagent type \"${config.type}\". Each SubagentConfig must have a unique \"type\" field.`\n );\n }\n seenTypes.add(config.type);\n }\n\n return resolved;\n}\n\n/**\n * Build child AgentInputs from a resolved config, stripping nesting and\n * event-driven fields. When `allowNested: true`, the child's\n * `maxSubagentDepth` is decremented so that depth is consumed as the call\n * chain deepens across graph boundaries — the parent's executor-level check\n * alone cannot see into the child graph's separate executor.\n *\n * @remarks Advanced utility: exported primarily for testing and by\n * {@link SubagentExecutor}. Host applications configuring subagents should\n * not need to call this directly — it is invoked internally when a subagent\n * tool is dispatched. The depth-countdown contract (parent's `maxDepth` in,\n * child's decremented `maxSubagentDepth` on the returned inputs) is the\n * mechanism that bounds nesting across graph boundaries; callers must\n * respect it.\n */\nexport function buildChildInputs(\n config: ResolvedSubagentConfig,\n childAgentId: string,\n parentMaxDepth: number\n): AgentInputs {\n const { agentInputs } = config;\n const childInputs: AgentInputs = {\n ...agentInputs,\n agentId: childAgentId,\n toolDefinitions: undefined,\n };\n\n if (config.allowNested === true) {\n childInputs.maxSubagentDepth = Math.max(0, parentMaxDepth - 1);\n } else {\n childInputs.subagentConfigs = undefined;\n childInputs.maxSubagentDepth = undefined;\n }\n\n return childInputs;\n}\n\nfunction truncateErrorMessage(error: unknown): string {\n const message = error instanceof Error ? error.message : String(error);\n if (message.length <= ERROR_MESSAGE_MAX_CHARS) {\n return message;\n }\n return `${message.slice(0, ERROR_MESSAGE_MAX_CHARS)}...`;\n}\n"],"names":[],"mappings":";;;;AAeA,MAAM,iBAAiB,GAAG,EAAE;AAC5B,MAAM,oBAAoB,GAAG,CAAC;AAC9B,MAAM,uBAAuB,GAAG,GAAG;AAEnC,MAAM,aAAa,GAAyB,MAAM,CAAC,MAAM,CAAC;AACxD,IAAA,kBAAkB,EAAE,EAAc;AAClC,IAAA,MAAM,EAAE,EAAc;AACvB,CAAA,CAAC;MAuCW,gBAAgB,CAAA;AACV,IAAA,OAAO;AACP,IAAA,YAAY;AACZ,IAAA,YAAY;AACZ,IAAA,WAAW;AACX,IAAA,aAAa;AACb,IAAA,YAAY;AACZ,IAAA,QAAQ;AACR,IAAA,gBAAgB;AAEjC,IAAA,WAAA,CAAY,OAAgC,EAAA;AAC1C,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO;AAC9B,QAAA,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY;AACxC,QAAA,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY;AACxC,QAAA,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW;AACtC,QAAA,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa;AAC1C,QAAA,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY;QACxC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,CAAC;AACrC,QAAA,IAAI,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB;IAClD;IAEA,MAAM,OAAO,CAAC,MAA6B,EAAA;QACzC,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,QAAQ,EAAE,GAAG,MAAM;QACtD,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC;QAE7C,IAAI,CAAC,MAAM,EAAE;AACX,YAAA,MAAM,SAAS,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;YACrD,OAAO;AACL,gBAAA,OAAO,EAAE,CAAA,8BAAA,EAAiC,YAAY,CAAA,oBAAA,EAAuB,SAAS,CAAA,CAAE;AACxF,gBAAA,QAAQ,EAAE,EAAE;aACb;QACH;AAEA,QAAA,IAAI,IAAI,CAAC,QAAQ,IAAI,CAAC,EAAE;YACtB,OAAO;AACL,gBAAA,OAAO,EAAE,iDAAiD;AAC1D,gBAAA,QAAQ,EAAE,EAAE;aACb;QACH;AAEA,QAAA,MAAM,YAAY,GAChB,MAAM,CAAC,WAAW,CAAC,OAAO;YAC1B,CAAA,EAAG,IAAI,CAAC,aAAa,IAAI,OAAO,CAAA,KAAA,EAAQ,MAAM,CAAC,CAAC,CAAC,CAAA,CAAE;AAErD,QAAA,IACE,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,eAAe,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,EACzE;AACA,YAAA,MAAM,UAAU,GAAG,MAAM,YAAY,CAAC;gBACpC,QAAQ,EAAE,IAAI,CAAC,YAAY;AAC3B,gBAAA,KAAK,EAAE;AACL,oBAAA,eAAe,EAAE,eAAe;oBAChC,KAAK,EAAE,IAAI,CAAC,WAAW;oBACvB,QAAQ;oBACR,aAAa,EAAE,IAAI,CAAC,aAAa;AACjC,oBAAA,OAAO,EAAE,YAAY;AACrB,oBAAA,SAAS,EAAE,YAAY;AACvB,oBAAA,MAAM,EAAE,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;AACxC,iBAAA;gBACD,SAAS,EAAE,IAAI,CAAC,WAAW;AAC3B,gBAAA,UAAU,EAAE,YAAY;aACzB,CAAC,CAAC,KAAK,CAAC,MAA4B,aAAa,CAAC;AAEnD;;;;AAIG;AACH,YAAA,IAAI,UAAU,CAAC,QAAQ,KAAK,MAAM,IAAI,UAAU,CAAC,QAAQ,KAAK,KAAK,EAAE;gBACnE,OAAO;AACL,oBAAA,OAAO,EAAE,CAAA,SAAA,EAAY,UAAU,CAAC,MAAM,IAAI,iBAAiB,CAAA,CAAE;AAC7D,oBAAA,QAAQ,EAAE,EAAE;iBACb;YACH;QACF;AAEA,QAAA,MAAM,WAAW,GAAG,gBAAgB,CAAC,MAAM,EAAE,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC;AACzE,QAAA,MAAM,UAAU,GAAG,CAAA,EAAG,IAAI,CAAC,WAAW,CAAA,KAAA,EAAQ,MAAM,CAAC,CAAC,CAAC,CAAA,CAAE;AACzD,QAAA,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,IAAI,iBAAiB;AAErD,QAAA,MAAM,UAAU,GAAG,IAAI,CAAC,gBAAgB,CAAC;AACvC,YAAA,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,IAAI,CAAC,YAAY;YACzB,MAAM,EAAE,CAAC,WAAW,CAAC;YACrB,YAAY,EAAE,IAAI,CAAC,YAAY;AAChC,SAAA,CAAC;AAEF,QAAA,IAAI,MAAmC;AACvC,QAAA,IAAI;AACF,YAAA,MAAM,QAAQ,GAAG,UAAU,CAAC,cAAc,EAAE;AAC5C;;;;;;;;;;;;;;AAcG;AACH,YAAA,MAAM,GAAG,MAAM,QAAQ,CAAC,MAAM,CAC5B,EAAE,QAAQ,EAAE,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC,EAAE,EAC7C;gBACE,cAAc,EAAE,QAAQ,GAAG,oBAAoB;gBAC/C,MAAM,EAAE,IAAI,CAAC,YAAY;AACzB,gBAAA,SAAS,EAAE,EAAE;gBACb,OAAO,EAAE,CAAA,SAAA,EAAY,YAAY,CAAA,CAAE;AACnC,gBAAA,YAAY,EAAE;AACZ,oBAAA,SAAS,EAAE,UAAU;AACtB,iBAAA;AACF,aAAA,CACF;QACH;QAAE,OAAO,KAAK,EAAE;YACd,UAAU,CAAC,eAAe,EAAE;YAC5B,OAAO;AACL,gBAAA,OAAO,EAAE,CAAA,gBAAA,EAAmB,oBAAoB,CAAC,KAAK,CAAC,CAAA,CAAE;AACzD,gBAAA,QAAQ,EAAE,EAAE;aACb;QACH;QAEA,MAAM,eAAe,GAAG,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC;AAE7D,QAAA,IACE,IAAI,CAAC,YAAY,EAAE,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK,IAAI,EACxE;AACA;;;;;AAKG;AACH,YAAA,MAAM,YAAY,CAAC;gBACjB,QAAQ,EAAE,IAAI,CAAC,YAAY;AAC3B,gBAAA,KAAK,EAAE;AACL,oBAAA,eAAe,EAAE,cAAc;oBAC/B,KAAK,EAAE,IAAI,CAAC,WAAW;oBACvB,QAAQ;AACR,oBAAA,OAAO,EAAE,YAAY;AACrB,oBAAA,SAAS,EAAE,YAAY;oBACvB,QAAQ,EAAE,MAAM,CAAC,QAAQ;AAC1B,iBAAA;gBACD,SAAS,EAAE,IAAI,CAAC,WAAW;AAC3B,gBAAA,UAAU,EAAE,YAAY;AACzB,aAAA,CAAC,CAAC,KAAK,CAAC,MAAK;;AAEd,YAAA,CAAC,CAAC;QACJ;QAEA,UAAU,CAAC,eAAe,EAAE;QAE5B,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE;IAChE;AACD;AAED;;;;;;;;;AASG;AACG,SAAU,oBAAoB,CAAC,QAAuB,EAAA;AAC1D,IAAA,KAAK,IAAI,CAAC,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE;QAC7C,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,KAAK,IAAI,EAAE;YACnC;QACF;QAEA,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,OAAO;AAEnC,QAAA,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE;AAC/B,YAAA,IAAI,OAAO;AAAE,gBAAA,OAAO,OAAO;YAC3B;QACF;QAEA,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAC3B;QACF;QAEA,MAAM,SAAS,GAAa,EAAE;AAC9B,QAAA,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;AAC3B,YAAA,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;AAC7B,gBAAA,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC;YACvB;AAAO,iBAAA,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,IAAI,KAAK,EAAE;AACtE,gBAAA,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,IAAc,CAAC;YACtC;QACF;AAEA,QAAA,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;AACxB,YAAA,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;QAC7B;IACF;AAEA,IAAA,OAAO,gBAAgB;AACzB;AAEA;;;;AAIG;AACG,SAAU,sBAAsB,CACpC,OAAyB,EACzB,aAA2B,EAAA;IAE3B,MAAM,QAAQ,GAAG;AACd,SAAA,GAAG,CAAC,CAAC,MAAM,KAAI;AACd,QAAA,IAAI,MAAM,CAAC,WAAW,IAAI,IAAI,EAAE;AAC9B,YAAA,OAAO,MAAgC;QACzC;AACA,QAAA,IAAI,MAAM,CAAC,IAAI,KAAK,IAAI,IAAI,aAAa,CAAC,aAAa,IAAI,IAAI,EAAE;AAC/D,YAAA,OAAO,IAAI;QACb;QACA,OAAO;AACL,YAAA,GAAG,MAAM;AACT,YAAA,WAAW,EAAE,EAAE,GAAG,aAAa,CAAC,aAAa,EAAE;SACtB;AAC7B,IAAA,CAAC;SACA,MAAM,CAAC,CAAC,CAAC,KAAkC,CAAC,IAAI,IAAI,CAAC;AAExD,IAAA,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU;AACnC,IAAA,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE;QAC7B,IAAI,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC9B,MAAM,IAAI,KAAK,CACb,CAAA,yBAAA,EAA4B,MAAM,CAAC,IAAI,CAAA,uDAAA,CAAyD,CACjG;QACH;AACA,QAAA,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;IAC5B;AAEA,IAAA,OAAO,QAAQ;AACjB;AAEA;;;;;;;;;;;;;;AAcG;SACa,gBAAgB,CAC9B,MAA8B,EAC9B,YAAoB,EACpB,cAAsB,EAAA;AAEtB,IAAA,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM;AAC9B,IAAA,MAAM,WAAW,GAAgB;AAC/B,QAAA,GAAG,WAAW;AACd,QAAA,OAAO,EAAE,YAAY;AACrB,QAAA,eAAe,EAAE,SAAS;KAC3B;AAED,IAAA,IAAI,MAAM,CAAC,WAAW,KAAK,IAAI,EAAE;AAC/B,QAAA,WAAW,CAAC,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,cAAc,GAAG,CAAC,CAAC;IAChE;SAAO;AACL,QAAA,WAAW,CAAC,eAAe,GAAG,SAAS;AACvC,QAAA,WAAW,CAAC,gBAAgB,GAAG,SAAS;IAC1C;AAEA,IAAA,OAAO,WAAW;AACpB;AAEA,SAAS,oBAAoB,CAAC,KAAc,EAAA;AAC1C,IAAA,MAAM,OAAO,GAAG,KAAK,YAAY,KAAK,GAAG,KAAK,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;AACtE,IAAA,IAAI,OAAO,CAAC,MAAM,IAAI,uBAAuB,EAAE;AAC7C,QAAA,OAAO,OAAO;IAChB;IACA,OAAO,CAAA,EAAG,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,uBAAuB,CAAC,CAAA,GAAA,CAAK;AAC1D;;;;"}
@@ -86,6 +86,12 @@ export declare class AgentContext {
86
86
  toolDefinitions?: t.LCTool[];
87
87
  /** Set of tool names discovered via tool search (to be loaded) */
88
88
  discoveredToolNames: Set<string>;
89
+ /** Original AgentInputs used to create this context — used for self-spawn subagent resolution. */
90
+ _sourceInputs?: t.AgentInputs;
91
+ /** Subagent configurations for hierarchical delegation. */
92
+ subagentConfigs?: t.SubagentConfig[];
93
+ /** Maximum subagent nesting depth. */
94
+ maxSubagentDepth?: number;
89
95
  /** Instructions for this agent */
90
96
  instructions?: string;
91
97
  /** Additional instructions for this agent */
@@ -136,8 +136,15 @@ export declare enum Constants {
136
136
  /** Delimiter for MCP tools: toolName_mcp_serverName */
137
137
  MCP_DELIMITER = "_mcp_",
138
138
  /** Anthropic server tool ID prefix (web_search, code_execution, etc.) */
139
- ANTHROPIC_SERVER_TOOL_PREFIX = "srvtoolu_"
139
+ ANTHROPIC_SERVER_TOOL_PREFIX = "srvtoolu_",
140
+ SKILL_TOOL = "skill",
141
+ READ_FILE = "read_file",
142
+ BASH_TOOL = "bash_tool",
143
+ BASH_PROGRAMMATIC_TOOL_CALLING = "run_tools_with_bash",
144
+ SUBAGENT = "subagent"
140
145
  }
146
+ /** Tool names that use the code execution environment (shared session, file tracking). */
147
+ export declare const CODE_EXECUTION_TOOLS: ReadonlySet<string>;
141
148
  export declare enum TitleMethod {
142
149
  STRUCTURED = "structured",
143
150
  FUNCTIONS = "functions",
@@ -6,6 +6,7 @@ import type * as t from '@/types';
6
6
  import { ToolNode as CustomToolNode } from '@/tools/ToolNode';
7
7
  import { AgentContext } from '@/agents/AgentContext';
8
8
  import { HandlerRegistry } from '@/events';
9
+ import type { HookRegistry } from '@/hooks';
9
10
  export declare abstract class Graph<T extends t.BaseGraphState = t.BaseGraphState, _TNodeName extends string = string> {
10
11
  abstract resetValues(): void;
11
12
  abstract initializeTools({ currentTools, currentToolMap, }: {
@@ -43,6 +44,7 @@ export declare abstract class Graph<T extends t.BaseGraphState = t.BaseGraphStat
43
44
  /** Set of invoked tool call IDs from non-message run steps completed mid-run, if any */
44
45
  invokedToolIds?: Set<string>;
45
46
  handlerRegistry: HandlerRegistry | undefined;
47
+ hookRegistry: HookRegistry | undefined;
46
48
  /**
47
49
  * Tool session contexts for automatic state persistence across tool invocations.
48
50
  * Keyed by tool name (e.g., Constants.EXECUTE_CODE).
@@ -0,0 +1,56 @@
1
+ import type { HookEvent, HookMatcher } from './types';
2
+ /**
3
+ * Run-scoped storage for hook matchers with an additional layer for
4
+ * session-scoped matchers that should be cleaned up between sessions.
5
+ *
6
+ * Hosts construct one registry per `Run` (mirroring how `HandlerRegistry` is
7
+ * scoped) and register global matchers + per-session matchers against it.
8
+ * Registration is strictly additive — nothing in this class mutates a
9
+ * matcher's callbacks or flags after insertion.
10
+ *
11
+ * ## Why `Map<sessionId, MatcherBucket>` and not `Record`
12
+ *
13
+ * LibreChat runs thousands of parallel sessions in one Node process, and
14
+ * hook registration happens inside hot paths (tool loading, agent spawning).
15
+ * A `Record<sessionId, ...>` has to be spread on every insertion, which is
16
+ * O(n) per call and O(n²) total for a batch of parallel registrations. A
17
+ * Map mutates in place, keeping insertions O(1). This mirrors the reasoning
18
+ * Claude Code documents at `utils/hooks/sessionHooks.ts:62`.
19
+ */
20
+ export declare class HookRegistry {
21
+ private readonly global;
22
+ private readonly sessions;
23
+ /**
24
+ * Register a matcher for the lifetime of this registry (= one Run).
25
+ * Returns an unregister function that removes the matcher by reference.
26
+ */
27
+ register<E extends HookEvent>(event: E, matcher: HookMatcher<E>): () => void;
28
+ /**
29
+ * Register a matcher for a specific session. Cleared automatically when
30
+ * `clearSession(sessionId)` is called, or can be removed directly via the
31
+ * returned unregister function.
32
+ */
33
+ registerSession<E extends HookEvent>(sessionId: string, event: E, matcher: HookMatcher<E>): () => void;
34
+ /**
35
+ * Returns all matchers registered for `event`, concatenating global first
36
+ * and then session-specific (when `sessionId` is supplied). The caller
37
+ * receives a fresh array, so iterating it is safe even if a matcher is
38
+ * removed mid-iteration (e.g. via `once: true`).
39
+ */
40
+ getMatchers<E extends HookEvent>(event: E, sessionId?: string): HookMatcher<E>[];
41
+ /**
42
+ * Removes `matcher` by reference from global storage first, falling back
43
+ * to the session bucket when `sessionId` is supplied. Used by
44
+ * `executeHooks` to drop `once: true` matchers after they fire.
45
+ */
46
+ removeMatcher<E extends HookEvent>(event: E, matcher: HookMatcher<E>, sessionId?: string): boolean;
47
+ /**
48
+ * Drops every session-scoped matcher for `sessionId`. Call this in the
49
+ * `finally` block around a Run so a `once: true` hook that never fired
50
+ * cannot leak into the next session on the same registry.
51
+ */
52
+ clearSession(sessionId: string): void;
53
+ /** True if at least one matcher exists for `event` (global + session). */
54
+ hasHookFor(event: HookEvent, sessionId?: string): boolean;
55
+ private ensureSessionBucket;
56
+ }
@@ -0,0 +1,79 @@
1
+ import type { Logger } from 'winston';
2
+ import type { HookRegistry } from './HookRegistry';
3
+ import type { HookInput, AggregatedHookResult } from './types';
4
+ /** Default per-hook timeout when a matcher doesn't set its own. */
5
+ export declare const DEFAULT_HOOK_TIMEOUT_MS = 30000;
6
+ /**
7
+ * Options for a single `executeHooks` call. The `input` drives everything —
8
+ * the event name is read from `input.hook_event_name`, matchers are looked
9
+ * up against that event, and each hook receives `input` directly.
10
+ */
11
+ export interface ExecuteHooksOptions {
12
+ registry: HookRegistry;
13
+ input: HookInput;
14
+ /** Scope lookup to this session (in addition to global matchers). */
15
+ sessionId?: string;
16
+ /** Query string matched against each matcher's pattern (tool name, etc.). */
17
+ matchQuery?: string;
18
+ /** Parent AbortSignal — combined with per-hook timeout into the hook signal. */
19
+ signal?: AbortSignal;
20
+ /** Default per-hook timeout; overridden by `matcher.timeout` when present. */
21
+ timeoutMs?: number;
22
+ /** Optional winston logger for non-internal hook errors. */
23
+ logger?: Logger;
24
+ }
25
+ /**
26
+ * Fires every matcher registered against `input.hook_event_name`, folding
27
+ * their results per `deny > ask > allow` precedence and accumulating
28
+ * context/errors.
29
+ *
30
+ * ## Parallelism and determinism
31
+ *
32
+ * All matching hooks fire simultaneously and are awaited via `Promise.all`,
33
+ * which preserves input-array order in its returned results. The fold
34
+ * therefore iterates outcomes in **registration order** — outer loop over
35
+ * matchers as they sit in the registry (global first, then session), inner
36
+ * loop over each matcher's `hooks` array. Last-writer-wins fields
37
+ * (`updatedInput`, `updatedOutput`) are deterministic in that order, even
38
+ * though hooks may complete in arbitrary wall-clock order.
39
+ *
40
+ * Consumers that need a single authoritative rewrite should still scope
41
+ * `updatedInput`/`updatedOutput` to one hook per matcher to avoid subtle
42
+ * precedence bugs when matchers are added in a different order than
43
+ * expected.
44
+ *
45
+ * ## Timeouts and cancellation
46
+ *
47
+ * Each matcher receives **one shared `AbortSignal`** derived from the
48
+ * caller's parent signal combined with `matcher.timeout` (falling back to
49
+ * `opts.timeoutMs`, default {@link DEFAULT_HOOK_TIMEOUT_MS}). Sharing the
50
+ * signal across hooks in a matcher collapses N timer allocations into
51
+ * one, which matters on the PreToolUse hot path where a matcher with
52
+ * several hooks fires on every tool call. Each hook call is raced
53
+ * against the shared signal, so even a hook that ignores the signal is
54
+ * force-unblocked when the timeout fires. Timeout/abort errors are
55
+ * swallowed into the aggregated result's `errors` array (non-fatal by
56
+ * default).
57
+ *
58
+ * ## Internal matchers
59
+ *
60
+ * A matcher with `internal: true` is excluded from both the `errors` array
61
+ * and the logger output. Use it for infrastructure hooks whose failures
62
+ * should not pollute user-visible diagnostics.
63
+ *
64
+ * ## Once semantics — atomic at-most-once
65
+ *
66
+ * A matcher with `once: true` is removed from the registry **before any
67
+ * hook runs**, inside the synchronous prefix of `executeHooks` (between
68
+ * `getMatchers` and the first `await`). Because Node's event loop serialises
69
+ * sync work, two concurrent `executeHooks` calls can never both observe
70
+ * and dispatch the same `once` matcher — whichever call runs its sync
71
+ * prefix first consumes it, and the loser sees an empty bucket.
72
+ *
73
+ * Trade-off: if every hook in a `once` matcher throws, the matcher is
74
+ * still gone. "Once" here means "at most one dispatch, ever", not "at
75
+ * most one successful execution with retry on failure". Hosts that need
76
+ * retry semantics should register a normal matcher and self-unregister
77
+ * via the `unregister` callback returned from `registry.register`.
78
+ */
79
+ export declare function executeHooks(opts: ExecuteHooksOptions): Promise<AggregatedHookResult>;
@@ -0,0 +1,6 @@
1
+ export { HookRegistry } from './HookRegistry';
2
+ export { executeHooks, DEFAULT_HOOK_TIMEOUT_MS } from './executeHooks';
3
+ export { matchesQuery, hasNestedQuantifier, MAX_PATTERN_LENGTH, MAX_CACHE_SIZE, } from './matchers';
4
+ export { HOOK_EVENTS } from './types';
5
+ export type { HookEvent, HookInput, HookOutput, HookCallback, HookMatcher, HooksByEvent, HookInputByEvent, HookOutputByEvent, BaseHookInput, BaseHookOutput, ToolDecision, StopDecision, AggregatedHookResult, RunStartHookInput, UserPromptSubmitHookInput, PreToolUseHookInput, PostToolUseHookInput, PostToolUseFailureHookInput, PermissionDeniedHookInput, SubagentStartHookInput, SubagentStopHookInput, StopHookInput, StopFailureHookInput, PreCompactHookInput, PostCompactHookInput, RunStartHookOutput, UserPromptSubmitHookOutput, PreToolUseHookOutput, PostToolUseHookOutput, PostToolUseFailureHookOutput, PermissionDeniedHookOutput, SubagentStartHookOutput, SubagentStopHookOutput, StopHookOutput, StopFailureHookOutput, PreCompactHookOutput, PostCompactHookOutput, } from './types';
6
+ export type { ExecuteHooksOptions } from './executeHooks';
@@ -0,0 +1,95 @@
1
+ /**
2
+ * Upper bound on hook-matcher pattern length. Patterns longer than this
3
+ * are rejected outright — the goal is a cheap cap on pathological inputs
4
+ * (repeated quantifiers, huge alternation groups) without pulling in a
5
+ * safe-regex dependency.
6
+ *
7
+ * Legitimate matchers are almost always under 50 characters (tool names,
8
+ * short alternations, simple prefix anchors); 512 leaves generous
9
+ * headroom while preventing 10KB regexes.
10
+ */
11
+ export declare const MAX_PATTERN_LENGTH = 512;
12
+ /**
13
+ * Upper bound on the compilation cache. Chosen to comfortably hold every
14
+ * distinct pattern a single multi-tenant run is likely to see (tools,
15
+ * agent types, basename filters) without growing without bound.
16
+ *
17
+ * Under hosts that register unique patterns per tenant, LRU eviction
18
+ * keeps the working set bounded — cold patterns are re-compiled on next
19
+ * use, which is the correct cost trade-off for long-running processes
20
+ * that must not leak memory.
21
+ */
22
+ export declare const MAX_CACHE_SIZE = 256;
23
+ /**
24
+ * Cheap syntactic detector for the most common catastrophic-backtracking
25
+ * shape: a quantified group that contains another quantifier (e.g.
26
+ * `(a+)+`, `(.*)*`, `(\w+)+$`, `(?:(a+))+`). This is the "nested
27
+ * quantifier" class of ReDoS — runs in polynomial-or-worse time on
28
+ * adversarial inputs.
29
+ *
30
+ * The scan walks the pattern linearly using an explicit stack of group
31
+ * frames. For each group it tracks whether the group's contents include
32
+ * "backtrack risk" — meaning a direct quantifier OR a nested group that
33
+ * carries risk up. When a group closes with a trailing quantifier AND its
34
+ * frame carries backtrack risk, the pattern is flagged. Risk propagates
35
+ * to the enclosing frame when a child group closes (whether the child
36
+ * itself was quantified or not), so `(?:(a+))+` — equivalent to `(a+)+`
37
+ * — is flagged correctly even though the outer non-capturing wrapper is
38
+ * one level removed from the inner quantifier.
39
+ *
40
+ * ## Group-syntax prefixes
41
+ *
42
+ * Non-capturing groups (`(?:`), lookaheads (`(?=`, `(?!`), lookbehinds
43
+ * (`(?<=`, `(?<!`), and named groups (`(?<name>`) are skipped over at
44
+ * the `(` so their `?` is not misread as a quantifier. Without this,
45
+ * `(?:pre_)?tool_name` would be incorrectly rejected because the scanner
46
+ * would see the group-syntax `?` as a quantifier at depth 1.
47
+ *
48
+ * ## Heuristic, not a proof
49
+ *
50
+ * This catches the common forms but not all. Ambiguous-alternation ReDoS
51
+ * like `(a|a)+` is not detected. Pathologically long patterns are also
52
+ * caught by {@link MAX_PATTERN_LENGTH}. Hosts that accept user-supplied
53
+ * patterns must still validate upstream.
54
+ */
55
+ export declare function hasNestedQuantifier(pattern: string): boolean;
56
+ /**
57
+ * Tests whether a hook matcher pattern matches the given query string.
58
+ *
59
+ * ## Semantics
60
+ *
61
+ * - `undefined` or empty `pattern` matches any query (wildcard). This is
62
+ * the intended shape for events that do not supply a query string at
63
+ * all (`RunStart`, `Stop`, etc.) — register such matchers without a
64
+ * pattern.
65
+ * - `undefined` or empty `query` with a non-empty `pattern` never matches.
66
+ * Setting a pattern on a query-less event is therefore inert: the
67
+ * matcher will simply never fire. This is intentional — it keeps
68
+ * query-based filtering out of event types where "query" has no meaning,
69
+ * and is documented on `HookMatcher.pattern`.
70
+ * - Otherwise, the pattern is compiled once (via a bounded LRU cache) and
71
+ * tested against the query.
72
+ * - Invalid regex patterns never throw — a failed compile is cached as
73
+ * "never matches" so a single malformed pattern cannot take out a whole
74
+ * `executeHooks` batch.
75
+ *
76
+ * ## ReDoS mitigations
77
+ *
78
+ * Patterns compile through three cheap gates before reaching `new RegExp`:
79
+ *
80
+ * 1. {@link MAX_PATTERN_LENGTH} length cap rejects oversized inputs.
81
+ * 2. {@link hasNestedQuantifier} rejects the most common catastrophic-
82
+ * backtracking shape (quantified group containing a quantifier).
83
+ * 3. Successful compiles are cached in a bounded LRU so repeated calls
84
+ * never re-enter the regex compiler.
85
+ *
86
+ * These are a floor, not a ceiling. Hosts that accept user-supplied
87
+ * patterns should still validate upstream. The design report §3.8 routes
88
+ * persistable hooks through a host-side compiler before they reach this
89
+ * module.
90
+ */
91
+ export declare function matchesQuery(pattern: string | undefined, query: string | undefined): boolean;
92
+ /** Clears the regex compilation cache. Intended for test isolation. */
93
+ export declare function clearMatcherCache(): void;
94
+ /** Returns the current size of the compilation cache. Intended for tests. */
95
+ export declare function getMatcherCacheSize(): number;
@@ -0,0 +1,320 @@
1
+ import type { BaseMessage } from '@langchain/core/messages';
2
+ /**
3
+ * Closed set of hook lifecycle events supported by the hooks system.
4
+ *
5
+ * These mirror the subset of Claude Code's event surface that makes sense
6
+ * for a library context (no filesystem/CLI-specific events). See
7
+ * `docs/hooks-design-report.md` §3.2 for the mapping to existing
8
+ * `@librechat/agents` emission points.
9
+ */
10
+ export declare const HOOK_EVENTS: readonly ["RunStart", "UserPromptSubmit", "PreToolUse", "PostToolUse", "PostToolUseFailure", "PermissionDenied", "SubagentStart", "SubagentStop", "Stop", "StopFailure", "PreCompact", "PostCompact"];
11
+ export type HookEvent = (typeof HOOK_EVENTS)[number];
12
+ /** Tool-gating decision; executeHooks folds with `deny > ask > allow` precedence. */
13
+ export type ToolDecision = 'allow' | 'deny' | 'ask';
14
+ /** Stop-loop decision; `block` means "do not stop, run another turn". Any `block` wins. */
15
+ export type StopDecision = 'continue' | 'block';
16
+ /**
17
+ * Fields shared by every `HookInput`. Discriminated by `hook_event_name`.
18
+ *
19
+ * - `runId` identifies the current agent run and is always present.
20
+ * - `threadId` identifies the conversation thread when the host has one.
21
+ * - `agentId` is only set when the hook fires inside a subagent scope.
22
+ */
23
+ export interface BaseHookInput {
24
+ runId: string;
25
+ threadId?: string;
26
+ agentId?: string;
27
+ }
28
+ export interface RunStartHookInput extends BaseHookInput {
29
+ hook_event_name: 'RunStart';
30
+ messages: BaseMessage[];
31
+ }
32
+ export interface UserPromptSubmitHookInput extends BaseHookInput {
33
+ hook_event_name: 'UserPromptSubmit';
34
+ prompt: string;
35
+ attachments?: BaseMessage[];
36
+ }
37
+ /**
38
+ * Fires before a tool is invoked. Hook may return `deny`/`ask`/`allow` and/or
39
+ * an `updatedInput` that replaces the tool arguments before invocation.
40
+ *
41
+ * `toolInput` is intentionally typed as `Record<string, unknown>` because the
42
+ * SDK is tool-agnostic — concrete tool argument shapes are only known at the
43
+ * call site and are narrowed by the host. This is the one escape hatch in
44
+ * the hook type system.
45
+ */
46
+ export interface PreToolUseHookInput extends BaseHookInput {
47
+ hook_event_name: 'PreToolUse';
48
+ toolName: string;
49
+ toolInput: Record<string, unknown>;
50
+ toolUseId: string;
51
+ stepId?: string;
52
+ /**
53
+ * Number of times this tool has been invoked in prior batches within the
54
+ * current run. Within a single batch of parallel calls, all calls to the
55
+ * same tool share the same turn value — per-call discrimination within a
56
+ * batch is not supported in v1.
57
+ */
58
+ turn?: number;
59
+ }
60
+ export interface PostToolUseHookInput extends BaseHookInput {
61
+ hook_event_name: 'PostToolUse';
62
+ toolName: string;
63
+ toolInput: Record<string, unknown>;
64
+ toolOutput: unknown;
65
+ toolUseId: string;
66
+ stepId?: string;
67
+ turn?: number;
68
+ }
69
+ export interface PostToolUseFailureHookInput extends BaseHookInput {
70
+ hook_event_name: 'PostToolUseFailure';
71
+ toolName: string;
72
+ toolInput: Record<string, unknown>;
73
+ toolUseId: string;
74
+ error: string;
75
+ stepId?: string;
76
+ turn?: number;
77
+ }
78
+ export interface PermissionDeniedHookInput extends BaseHookInput {
79
+ hook_event_name: 'PermissionDenied';
80
+ toolName: string;
81
+ toolInput: Record<string, unknown>;
82
+ toolUseId: string;
83
+ reason: string;
84
+ }
85
+ export interface SubagentStartHookInput extends BaseHookInput {
86
+ hook_event_name: 'SubagentStart';
87
+ parentAgentId?: string;
88
+ agentId: string;
89
+ agentType: string;
90
+ inputs: BaseMessage[];
91
+ }
92
+ export interface SubagentStopHookInput extends BaseHookInput {
93
+ hook_event_name: 'SubagentStop';
94
+ agentId: string;
95
+ agentType: string;
96
+ messages: BaseMessage[];
97
+ }
98
+ export interface StopHookInput extends BaseHookInput {
99
+ hook_event_name: 'Stop';
100
+ messages: BaseMessage[];
101
+ stopReason?: string;
102
+ stopHookActive: boolean;
103
+ }
104
+ export interface StopFailureHookInput extends BaseHookInput {
105
+ hook_event_name: 'StopFailure';
106
+ error: string;
107
+ lastAssistantMessage?: BaseMessage;
108
+ }
109
+ export interface PreCompactHookInput extends BaseHookInput {
110
+ hook_event_name: 'PreCompact';
111
+ messagesBeforeCount: number;
112
+ /**
113
+ * What triggered compaction. Matches `SummarizationTrigger.type` from the
114
+ * agent's summarization config. `'default'` means no trigger was
115
+ * configured and compaction fired because messages were pruned.
116
+ */
117
+ trigger: 'token_ratio' | 'remaining_tokens' | 'messages_to_refine' | 'default' | (string & {});
118
+ }
119
+ export interface PostCompactHookInput extends BaseHookInput {
120
+ hook_event_name: 'PostCompact';
121
+ summary: string;
122
+ /**
123
+ * Number of messages remaining after compaction. The summarize node
124
+ * returns a `removeAll` signal that clears all messages from state;
125
+ * the summary itself is injected into the system prompt, not as a
126
+ * message. This is `0` at the point of hook dispatch.
127
+ */
128
+ messagesAfterCount: number;
129
+ }
130
+ /** Discriminated union of every hook input shape. */
131
+ export type HookInput = RunStartHookInput | UserPromptSubmitHookInput | PreToolUseHookInput | PostToolUseHookInput | PostToolUseFailureHookInput | PermissionDeniedHookInput | SubagentStartHookInput | SubagentStopHookInput | StopHookInput | StopFailureHookInput | PreCompactHookInput | PostCompactHookInput;
132
+ /** Compile-time map from event name to its input shape. */
133
+ export type HookInputByEvent = {
134
+ RunStart: RunStartHookInput;
135
+ UserPromptSubmit: UserPromptSubmitHookInput;
136
+ PreToolUse: PreToolUseHookInput;
137
+ PostToolUse: PostToolUseHookInput;
138
+ PostToolUseFailure: PostToolUseFailureHookInput;
139
+ PermissionDenied: PermissionDeniedHookInput;
140
+ SubagentStart: SubagentStartHookInput;
141
+ SubagentStop: SubagentStopHookInput;
142
+ Stop: StopHookInput;
143
+ StopFailure: StopFailureHookInput;
144
+ PreCompact: PreCompactHookInput;
145
+ PostCompact: PostCompactHookInput;
146
+ };
147
+ /**
148
+ * Fields common to every hook output. Hooks that have nothing to say simply
149
+ * return `{}` (or omit the fields below).
150
+ */
151
+ export interface BaseHookOutput {
152
+ /** Context string to inject into the conversation. Accumulated across hooks. */
153
+ additionalContext?: string;
154
+ /** True to prevent the next model turn. Any hook can set this. */
155
+ preventContinuation?: boolean;
156
+ /** Reason reported alongside `preventContinuation`. */
157
+ stopReason?: string;
158
+ }
159
+ export type RunStartHookOutput = BaseHookOutput;
160
+ export interface UserPromptSubmitHookOutput extends BaseHookOutput {
161
+ decision?: ToolDecision;
162
+ reason?: string;
163
+ }
164
+ export interface PreToolUseHookOutput extends BaseHookOutput {
165
+ decision?: ToolDecision;
166
+ reason?: string;
167
+ /**
168
+ * Replacement tool input. Merged into the pending tool call by the host.
169
+ *
170
+ * When multiple hooks set `updatedInput` within a single `executeHooks`
171
+ * call, the last writer in registration order wins (outer loop: matcher
172
+ * registration order; inner loop: hook position within the matcher). The
173
+ * winner is deterministic — `Promise.all` preserves input-array order.
174
+ * Consumers that need a single authoritative rewrite should still scope
175
+ * `updatedInput` to one hook per matcher to avoid confusing precedence.
176
+ */
177
+ updatedInput?: Record<string, unknown>;
178
+ }
179
+ export interface PostToolUseHookOutput extends BaseHookOutput {
180
+ /**
181
+ * Replacement tool output. Flows through the aggregated result so the
182
+ * host can substitute it before appending the tool result message.
183
+ * Ordering semantics match `PreToolUseHookOutput.updatedInput`:
184
+ * last-writer-wins in registration order.
185
+ */
186
+ updatedOutput?: unknown;
187
+ }
188
+ export type PostToolUseFailureHookOutput = BaseHookOutput;
189
+ export type PermissionDeniedHookOutput = BaseHookOutput;
190
+ export interface SubagentStartHookOutput extends BaseHookOutput {
191
+ decision?: ToolDecision;
192
+ reason?: string;
193
+ }
194
+ export type SubagentStopHookOutput = BaseHookOutput;
195
+ export interface StopHookOutput extends BaseHookOutput {
196
+ decision?: StopDecision;
197
+ reason?: string;
198
+ }
199
+ export type StopFailureHookOutput = BaseHookOutput;
200
+ export type PreCompactHookOutput = BaseHookOutput;
201
+ export type PostCompactHookOutput = BaseHookOutput;
202
+ /** Compile-time map from event name to its output shape. */
203
+ export type HookOutputByEvent = {
204
+ RunStart: RunStartHookOutput;
205
+ UserPromptSubmit: UserPromptSubmitHookOutput;
206
+ PreToolUse: PreToolUseHookOutput;
207
+ PostToolUse: PostToolUseHookOutput;
208
+ PostToolUseFailure: PostToolUseFailureHookOutput;
209
+ PermissionDenied: PermissionDeniedHookOutput;
210
+ SubagentStart: SubagentStartHookOutput;
211
+ SubagentStop: SubagentStopHookOutput;
212
+ Stop: StopHookOutput;
213
+ StopFailure: StopFailureHookOutput;
214
+ PreCompact: PreCompactHookOutput;
215
+ PostCompact: PostCompactHookOutput;
216
+ };
217
+ /** Superset output shape used by the executor's fold loop. */
218
+ export type HookOutput = RunStartHookOutput | UserPromptSubmitHookOutput | PreToolUseHookOutput | PostToolUseHookOutput | PostToolUseFailureHookOutput | PermissionDeniedHookOutput | SubagentStartHookOutput | SubagentStopHookOutput | StopHookOutput | StopFailureHookOutput | PreCompactHookOutput | PostCompactHookOutput;
219
+ /**
220
+ * A hook callback is a plain async function registered against a specific
221
+ * event. The `signal` is always supplied by `executeHooks` and combines the
222
+ * batch's parent signal with the per-hook timeout — callbacks that perform
223
+ * long-running work should observe it.
224
+ */
225
+ export type HookCallback<E extends HookEvent = HookEvent> = (input: HookInputByEvent[E], signal: AbortSignal) => HookOutputByEvent[E] | Promise<HookOutputByEvent[E]>;
226
+ /**
227
+ * A matcher groups one or more callbacks under a shared regex filter and
228
+ * shared timeout/once/internal flags. The generic `E` ties the callback
229
+ * types to the event the matcher is registered against.
230
+ */
231
+ export interface HookMatcher<E extends HookEvent = HookEvent> {
232
+ /**
233
+ * Regex pattern matched against the event's primary query string (e.g.
234
+ * the tool name for `PreToolUse`, the agent type for `SubagentStart`).
235
+ *
236
+ * Omitted or empty means "always match". For events that do not supply a
237
+ * query string (`RunStart`, `Stop`, etc.), only wildcard matchers fire —
238
+ * a non-empty pattern on such events will never match.
239
+ *
240
+ * Patterns are treated as trusted input: `executeHooks` compiles them
241
+ * with `new RegExp(pattern)` without any sandbox, and a pathological
242
+ * pattern can block the event loop. Host registration code is expected
243
+ * to validate or length-bound patterns that originate from user input.
244
+ */
245
+ pattern?: string;
246
+ /** Callbacks that fire when the matcher hits. Executed in parallel. */
247
+ hooks: HookCallback<E>[];
248
+ /** Per-matcher timeout in ms. Defaults to the executor's batch timeout. */
249
+ timeout?: number;
250
+ /**
251
+ * Atomically remove the matcher before its first dispatch.
252
+ *
253
+ * `executeHooks` claims `once: true` matchers synchronously — between
254
+ * `getMatchers` and its first `await` — so two concurrent calls cannot
255
+ * both dispatch the same matcher. Whichever call runs its sync prefix
256
+ * first wins the matcher; the other sees an empty bucket.
257
+ *
258
+ * Semantics are "at most one dispatch, ever" — if every hook in the
259
+ * matcher throws, the matcher is still gone. Use `once` for
260
+ * fire-and-forget bootstrapping (registration, telemetry, setup). Hosts
261
+ * that need retry semantics should register a normal matcher and
262
+ * self-unregister via the callback returned from `registry.register`.
263
+ */
264
+ once?: boolean;
265
+ /** Internal hooks are excluded from telemetry and non-fatal error logging. */
266
+ internal?: boolean;
267
+ }
268
+ /**
269
+ * Storage shape for matchers keyed by event. Each event's matcher list is
270
+ * a generic array parameterized by that event type, so lookup via
271
+ * `HooksByEvent[E]` preserves type-safe callback signatures.
272
+ */
273
+ export type HooksByEvent = {
274
+ [E in HookEvent]?: HookMatcher<E>[];
275
+ };
276
+ /**
277
+ * Aggregated result of a single `executeHooks` call. Fields are populated
278
+ * according to the fold rules in `executeHooks.ts`.
279
+ */
280
+ export interface AggregatedHookResult {
281
+ /** Folded tool-gating decision; `deny > ask > allow`. */
282
+ decision?: ToolDecision;
283
+ /** Folded stop decision; any `block` wins. */
284
+ stopDecision?: StopDecision;
285
+ /** Reason from the hook that set the winning decision. */
286
+ reason?: string;
287
+ /**
288
+ * Replacement tool input from a `PreToolUse` hook.
289
+ *
290
+ * Last-writer-wins in **registration order**: `executeHooks` uses
291
+ * `Promise.all`, which preserves input-array order, so the fold iterates
292
+ * outcomes in the same order they were pushed — outer loop over matchers
293
+ * as they sit in the registry, inner loop over each matcher's `hooks`
294
+ * array. The winner is therefore deterministic but may not match the
295
+ * order in which hooks actually completed. Consumers that want a single
296
+ * authoritative rewrite should still register one `updatedInput`-setting
297
+ * hook per matcher to avoid subtle precedence bugs.
298
+ */
299
+ updatedInput?: Record<string, unknown>;
300
+ /**
301
+ * Replacement tool output from a `PostToolUse` hook.
302
+ *
303
+ * Same last-writer-wins-in-registration-order semantics as
304
+ * `updatedInput`. Present only when at least one hook set it; `undefined`
305
+ * means "use the original tool output".
306
+ */
307
+ updatedOutput?: unknown;
308
+ /** Accumulated `additionalContext` strings from every hook, in order. */
309
+ additionalContexts: string[];
310
+ /** True if any hook returned `preventContinuation`. */
311
+ preventContinuation?: boolean;
312
+ /**
313
+ * Reason recorded alongside `preventContinuation`. First winner wins:
314
+ * once a hook sets both flags, later hooks that also set
315
+ * `preventContinuation` do not overwrite the reason.
316
+ */
317
+ stopReason?: string;
318
+ /** Error messages from hooks that threw; always present (possibly empty). */
319
+ errors: string[];
320
+ }