@goodfoot/claude-code-hooks 1.0.9 → 1.0.11

package/types/scaffold.d.ts

@@ -18,12 +18,12 @@
  * Options for scaffolding a new hook project.
  */
 export interface ScaffoldOptions {
-  /** Directory path where the project will be created. */
-  directory: string;
-  /** Array of hook event names to generate (e.g., ['Stop', 'SubagentStop']). */
-  hooks: string[];
-  /** Relative path for hooks.json output in the build script. */
-  outputPath: string;
+    /** Directory path where the project will be created. */
+    directory: string;
+    /** Array of hook event names to generate (e.g., ['Stop', 'SubagentStop']). */
+    hooks: string[];
+    /** Relative path for hooks.json output in the build script. */
+    outputPath: string;
 }
 /**
  * Scaffolds a new Claude Code hook project.

package/types/tool-helpers.d.ts

@@ -18,7 +18,7 @@
  *   const filePath = getFilePath(input);
  *   if (!filePath || !isTsFile(filePath)) return preToolUseOutput({});
  *
- *   const result = checkContentForPattern(input, /@ts-ignore/g);
+ *   const result = checkContentForPattern(input, /@ts-expect-error/g);
  *   if (result?.isAddition) {
  *     return preToolUseOutput({
  *       hookSpecificOutput: {
@@ -34,18 +34,7 @@
  * @see https://code.claude.com/docs/en/hooks
  * @module
  */
-import type { PreToolUseInput, PostToolUseInput, PostToolUseFailureInput, PermissionRequestInput } from './inputs.js';
-import type {
-  WriteToolInput,
-  EditToolInput,
-  MultiEditToolInput,
-  ReadToolInput,
-  BashToolInput,
-  GlobToolInput,
-  GrepToolInput,
-  FileModifyingToolInput,
-  FileModifyingToolName
-} from './tool-inputs.js';
+import type { AgentInput, AskUserQuestionInput, BashInput, ExitPlanModeInput, FileEditInput, FileModifyingToolInput, FileModifyingToolName, FileReadInput, FileWriteInput, GlobInput, GrepInput, KillShellInput, MultiEditToolInput, NotebookEditInput, PermissionRequestInput, PostToolUseFailureInput, PostToolUseInput, PreToolUseInput, TaskOutputInput, TodoWriteInput, WebFetchInput, WebSearchInput } from "./types.js";
 /**
  * Union of all hook input types that include tool_input.
  */
@@ -65,11 +54,9 @@ export type ToolUseInput = PreToolUseInput | PostToolUseInput | PostToolUseFailu
  * }
  * ```
  */
-export declare function isWriteTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: 'Write';
-  tool_input: WriteToolInput;
+export declare function isWriteTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "Write";
+    tool_input: FileWriteInput;
 };
 /**
  * Type guard for Edit tool inputs.
@@ -85,11 +72,9 @@ export declare function isWriteTool<T extends ToolUseInput>(
  * }
  * ```
  */
-export declare function isEditTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: 'Edit';
-  tool_input: EditToolInput;
+export declare function isEditTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "Edit";
+    tool_input: FileEditInput;
 };
 /**
  * Type guard for MultiEdit tool inputs.
@@ -106,11 +91,9 @@ export declare function isEditTool<T extends ToolUseInput>(
  * }
  * ```
  */
-export declare function isMultiEditTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: 'MultiEdit';
-  tool_input: MultiEditToolInput;
+export declare function isMultiEditTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "MultiEdit";
+    tool_input: MultiEditToolInput;
 };
 /**
  * Type guard for any file-modifying tool (Write, Edit, or MultiEdit).
@@ -125,11 +108,9 @@ export declare function isMultiEditTool<T extends ToolUseInput>(
  * }
  * ```
  */
-export declare function isFileModifyingTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: FileModifyingToolName;
-  tool_input: FileModifyingToolInput;
+export declare function isFileModifyingTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: FileModifyingToolName;
+    tool_input: FileModifyingToolInput;
 };
 /**
  * Type guard for Read tool inputs.
@@ -145,11 +126,9 @@ export declare function isFileModifyingTool<T extends ToolUseInput>(
  * }
  * ```
  */
-export declare function isReadTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: 'Read';
-  tool_input: ReadToolInput;
+export declare function isReadTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "Read";
+    tool_input: FileReadInput;
 };
 /**
  * Type guard for Bash tool inputs.
@@ -165,11 +144,9 @@ export declare function isReadTool<T extends ToolUseInput>(
  * }
  * ```
  */
-export declare function isBashTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: 'Bash';
-  tool_input: BashToolInput;
+export declare function isBashTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "Bash";
+    tool_input: BashInput;
 };
 /**
  * Type guard for Glob tool inputs.
@@ -185,11 +162,9 @@ export declare function isBashTool<T extends ToolUseInput>(
  * }
  * ```
  */
-export declare function isGlobTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: 'Glob';
-  tool_input: GlobToolInput;
+export declare function isGlobTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "Glob";
+    tool_input: GlobInput;
 };
 /**
  * Type guard for Grep tool inputs.
@@ -205,11 +180,165 @@ export declare function isGlobTool<T extends ToolUseInput>(
  * }
  * ```
  */
-export declare function isGrepTool<T extends ToolUseInput>(
-  input: T
-): input is T & {
-  tool_name: 'Grep';
-  tool_input: GrepToolInput;
+export declare function isGrepTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "Grep";
+    tool_input: GrepInput;
+};
+/**
+ * Type guard for Task tool inputs.
+ *
+ * Narrows the input type to include a typed AgentInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for a Task tool
+ * @example
+ * ```typescript
+ * if (isTaskTool(input)) {
+ *   console.log(input.tool_input.prompt);
+ *   console.log(input.tool_input.subagent_type);
+ * }
+ * ```
+ */
+export declare function isTaskTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "Task";
+    tool_input: AgentInput;
+};
+/**
+ * Type guard for TaskOutput tool inputs.
+ *
+ * Narrows the input type to include a typed TaskOutputInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for a TaskOutput tool
+ * @example
+ * ```typescript
+ * if (isTaskOutputTool(input)) {
+ *   console.log(input.tool_input.task_id);
+ * }
+ * ```
+ */
+export declare function isTaskOutputTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "TaskOutput";
+    tool_input: TaskOutputInput;
+};
+/**
+ * Type guard for ExitPlanMode tool inputs.
+ *
+ * Narrows the input type to include a typed ExitPlanModeInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for an ExitPlanMode tool
+ * @example
+ * ```typescript
+ * if (isExitPlanModeTool(input)) {
+ *   console.log(input.tool_input.allowedPrompts);
+ * }
+ * ```
+ */
+export declare function isExitPlanModeTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "ExitPlanMode";
+    tool_input: ExitPlanModeInput;
+};
+/**
+ * Type guard for KillShell tool inputs.
+ *
+ * Narrows the input type to include a typed KillShellInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for a KillShell tool
+ * @example
+ * ```typescript
+ * if (isKillShellTool(input)) {
+ *   console.log(input.tool_input.shell_id);
+ * }
+ * ```
+ */
+export declare function isKillShellTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "KillShell";
+    tool_input: KillShellInput;
+};
+/**
+ * Type guard for NotebookEdit tool inputs.
+ *
+ * Narrows the input type to include a typed NotebookEditInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for a NotebookEdit tool
+ * @example
+ * ```typescript
+ * if (isNotebookEditTool(input)) {
+ *   console.log(input.tool_input.notebook_path);
+ *   console.log(input.tool_input.new_source);
+ * }
+ * ```
+ */
+export declare function isNotebookEditTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "NotebookEdit";
+    tool_input: NotebookEditInput;
+};
+/**
+ * Type guard for TodoWrite tool inputs.
+ *
+ * Narrows the input type to include a typed TodoWriteInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for a TodoWrite tool
+ * @example
+ * ```typescript
+ * if (isTodoWriteTool(input)) {
+ *   console.log(input.tool_input.todos);
+ * }
+ * ```
+ */
+export declare function isTodoWriteTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "TodoWrite";
+    tool_input: TodoWriteInput;
+};
+/**
+ * Type guard for WebFetch tool inputs.
+ *
+ * Narrows the input type to include a typed WebFetchInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for a WebFetch tool
+ * @example
+ * ```typescript
+ * if (isWebFetchTool(input)) {
+ *   console.log(input.tool_input.url);
+ *   console.log(input.tool_input.prompt);
+ * }
+ * ```
+ */
+export declare function isWebFetchTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "WebFetch";
+    tool_input: WebFetchInput;
+};
+/**
+ * Type guard for WebSearch tool inputs.
+ *
+ * Narrows the input type to include a typed WebSearchInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for a WebSearch tool
+ * @example
+ * ```typescript
+ * if (isWebSearchTool(input)) {
+ *   console.log(input.tool_input.query);
+ * }
+ * ```
+ */
+export declare function isWebSearchTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "WebSearch";
+    tool_input: WebSearchInput;
+};
+/**
+ * Type guard for AskUserQuestion tool inputs.
+ *
+ * Narrows the input type to include a typed AskUserQuestionInput.
+ * @param input - The hook input to check
+ * @returns True if the input is for an AskUserQuestion tool
+ * @example
+ * ```typescript
+ * if (isAskUserQuestionTool(input)) {
+ *   console.log(input.tool_input.questions);
+ * }
+ * ```
+ */
+export declare function isAskUserQuestionTool<T extends ToolUseInput>(input: T): input is T & {
+    tool_name: "AskUserQuestion";
+    tool_input: AskUserQuestionInput;
 };
 /**
  * Extracts the file path from a tool input.
@@ -259,23 +388,23 @@ export declare function isTsFile(filePath: string): boolean;
  * Result of checking content for a pattern.
  */
 export interface PatternCheckResult {
-  /** True if the pattern was found in any content. */
-  found: boolean;
-  /** True if the pattern is being added (not present in old content, present in new). */
-  isAddition: boolean;
-  /** All matches found across all content (deduplicated). */
-  matches: string[];
-  /** Per-edit details for MultiEdit operations. */
-  details?: Array<{
-    /** Index of the edit (for MultiEdit) or 0 for Write/Edit. */
-    index: number;
-    /** True if found in this edit. */
+    /** True if the pattern was found in any content. */
     found: boolean;
-    /** True if this edit adds the pattern. */
+    /** True if the pattern is being added (not present in old content, present in new). */
     isAddition: boolean;
-    /** Matches in this edit. */
+    /** All matches found across all content (deduplicated). */
     matches: string[];
-  }>;
+    /** Per-edit details for MultiEdit operations. */
+    details?: Array<{
+        /** Index of the edit (for MultiEdit) or 0 for Write/Edit. */
+        index: number;
+        /** True if found in this edit. */
+        found: boolean;
+        /** True if this edit adds the pattern. */
+        isAddition: boolean;
+        /** Matches in this edit. */
+        matches: string[];
+    }>;
 }
 /**
  * Checks if a pattern exists in the content being written or edited.
@@ -288,8 +417,8 @@ export interface PatternCheckResult {
  * @returns Result object, or null if not a file-modifying tool
  * @example
  * ```typescript
- * // Block @ts-ignore being added
- * const result = checkContentForPattern(input, /@ts-ignore/g);
+ * // Block @ts-expect-error being added
+ * const result = checkContentForPattern(input, /@ts-expect-error/g);
  * if (result?.isAddition) {
  *   return preToolUseOutput({
  *     hookSpecificOutput: {
@@ -305,14 +434,14 @@ export declare function checkContentForPattern(input: PreToolUseInput, pattern:
  * Context passed to the forEachContent callback.
  */
 export interface ContentContext {
-  /** The new content being written or replacing old content. */
-  newContent: string;
-  /** The old content being replaced (null for Write). */
-  oldContent: string | null;
-  /** Index of the edit (0 for Write/Edit, index for MultiEdit). */
-  index: number;
-  /** True if this is a Write operation (not Edit/MultiEdit). */
-  isWrite: boolean;
+    /** The new content being written or replacing old content. */
+    newContent: string;
+    /** The old content being replaced (null for Write). */
+    oldContent: string | null;
+    /** Index of the edit (0 for Write/Edit, index for MultiEdit). */
+    index: number;
+    /** True if this is a Write operation (not Edit/MultiEdit). */
+    isWrite: boolean;
 }
 /**
  * Iterates over content in Write/Edit/MultiEdit operations.