@nogataka/smart-edit 0.0.14

package/dist/serena/tools/file_tools.d.ts

@@ -0,0 +1,231 @@
+import { z } from 'zod';
+import { Tool } from './tools_base.js';
+export { SUCCESS_RESULT } from './tools_base.js';
+interface ReadFileInput {
+    relative_path: string;
+    start_line?: number;
+    end_line?: number | null;
+    max_answer_chars?: number;
+}
+interface CreateTextFileInput {
+    relative_path: string;
+    content: string;
+}
+interface ListDirInput {
+    relative_path: string;
+    recursive: boolean;
+    skip_ignored_files?: boolean;
+    max_answer_chars?: number;
+}
+interface FindFileInput {
+    file_mask: string;
+    relative_path: string;
+}
+interface ReplaceRegexInput {
+    relative_path: string;
+    regex: string;
+    repl: string;
+    allow_multiple_occurrences?: boolean;
+}
+interface DeleteLinesInput {
+    relative_path: string;
+    start_line: number;
+    end_line: number;
+}
+interface ReplaceLinesInput extends DeleteLinesInput {
+    content: string;
+}
+interface InsertAtLineInput {
+    relative_path: string;
+    line: number;
+    content: string;
+}
+interface SearchForPatternInput {
+    substring_pattern: string;
+    context_lines_before?: number;
+    context_lines_after?: number;
+    paths_include_glob?: string;
+    paths_exclude_glob?: string;
+    relative_path?: string;
+    restrict_search_to_code_files?: boolean;
+    max_answer_chars?: number;
+}
+export declare class ReadFileTool extends Tool {
+    static readonly description = "Reads a file within the project directory.";
+    static readonly inputSchema: z.ZodObject<{
+        relative_path: z.ZodString;
+        start_line: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        end_line: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        max_answer_chars: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        start_line: number;
+        relative_path: string;
+        end_line?: number | null | undefined;
+        max_answer_chars?: number | undefined;
+    }, {
+        relative_path: string;
+        start_line?: number | undefined;
+        end_line?: number | null | undefined;
+        max_answer_chars?: number | undefined;
+    }>;
+    apply(args: ReadFileInput): Promise<string>;
+}
+export declare class CreateTextFileTool extends Tool {
+    static readonly markers: Set<"can-edit">;
+    static readonly description = "Creates or overwrites a text file in the project directory.";
+    static readonly inputSchema: z.ZodObject<{
+        relative_path: z.ZodString;
+        content: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        relative_path: string;
+        content: string;
+    }, {
+        relative_path: string;
+        content: string;
+    }>;
+    apply(args: CreateTextFileInput): Promise<string>;
+}
+export declare class ListDirTool extends Tool {
+    static readonly description = "Lists files and directories for a given relative path. Honors gitignore rules when requested.";
+    static readonly inputSchema: z.ZodObject<{
+        relative_path: z.ZodString;
+        recursive: z.ZodBoolean;
+        skip_ignored_files: z.ZodOptional<z.ZodBoolean>;
+        max_answer_chars: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        recursive: boolean;
+        relative_path: string;
+        max_answer_chars?: number | undefined;
+        skip_ignored_files?: boolean | undefined;
+    }, {
+        recursive: boolean;
+        relative_path: string;
+        max_answer_chars?: number | undefined;
+        skip_ignored_files?: boolean | undefined;
+    }>;
+    apply(args: ListDirInput): Promise<string>;
+}
+export declare class FindFileTool extends Tool {
+    static readonly description = "Finds files within a directory tree that match a filename mask while respecting ignored paths.";
+    static readonly inputSchema: z.ZodObject<{
+        file_mask: z.ZodString;
+        relative_path: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        relative_path: string;
+        file_mask: string;
+    }, {
+        relative_path: string;
+        file_mask: string;
+    }>;
+    apply(args: FindFileInput): Promise<string>;
+}
+export declare class ReplaceRegexTool extends Tool {
+    static readonly markers: Set<"can-edit">;
+    static readonly description = "Replaces one or more regex matches within a file. Falls back to Python-style DOTALL matching.";
+    static readonly inputSchema: z.ZodObject<{
+        relative_path: z.ZodString;
+        regex: z.ZodString;
+        repl: z.ZodString;
+        allow_multiple_occurrences: z.ZodOptional<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        relative_path: string;
+        regex: string;
+        repl: string;
+        allow_multiple_occurrences?: boolean | undefined;
+    }, {
+        relative_path: string;
+        regex: string;
+        repl: string;
+        allow_multiple_occurrences?: boolean | undefined;
+    }>;
+    apply(args: ReplaceRegexInput): Promise<string>;
+}
+export declare class DeleteLinesTool extends Tool {
+    static readonly markers: Set<"can-edit" | "optional">;
+    static readonly description = "Deletes a range of lines within a file. Requires the same lines to be read beforehand.";
+    static readonly inputSchema: z.ZodObject<{
+        relative_path: z.ZodString;
+        start_line: z.ZodNumber;
+        end_line: z.ZodNumber;
+    }, "strip", z.ZodTypeAny, {
+        start_line: number;
+        end_line: number;
+        relative_path: string;
+    }, {
+        start_line: number;
+        end_line: number;
+        relative_path: string;
+    }>;
+    apply(args: DeleteLinesInput): Promise<string>;
+}
+export declare class ReplaceLinesTool extends Tool {
+    static readonly markers: Set<"can-edit" | "optional">;
+    static readonly description = "Replaces a range of lines within a file. Requires the range to be read beforehand.";
+    static readonly inputSchema: z.ZodObject<{
+        relative_path: z.ZodString;
+        start_line: z.ZodNumber;
+        end_line: z.ZodNumber;
+        content: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        start_line: number;
+        end_line: number;
+        relative_path: string;
+        content: string;
+    }, {
+        start_line: number;
+        end_line: number;
+        relative_path: string;
+        content: string;
+    }>;
+    apply(args: ReplaceLinesInput): Promise<string>;
+}
+export declare class InsertAtLineTool extends Tool {
+    static readonly markers: Set<"can-edit" | "optional">;
+    static readonly description = "Inserts content at a specific line. The insertion will push existing content down.";
+    static readonly inputSchema: z.ZodObject<{
+        relative_path: z.ZodString;
+        line: z.ZodNumber;
+        content: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        line: number;
+        relative_path: string;
+        content: string;
+    }, {
+        line: number;
+        relative_path: string;
+        content: string;
+    }>;
+    apply(args: InsertAtLineInput): Promise<string>;
+}
+export declare class SearchForPatternTool extends Tool {
+    static readonly description = "Searches files for a substring/regex pattern, returning grouped matches with optional context.";
+    static readonly inputSchema: z.ZodObject<{
+        substring_pattern: z.ZodString;
+        context_lines_before: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        context_lines_after: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+        paths_include_glob: z.ZodOptional<z.ZodString>;
+        paths_exclude_glob: z.ZodOptional<z.ZodString>;
+        relative_path: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+        restrict_search_to_code_files: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
+        max_answer_chars: z.ZodOptional<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        relative_path: string;
+        context_lines_before: number;
+        context_lines_after: number;
+        substring_pattern: string;
+        restrict_search_to_code_files: boolean;
+        paths_include_glob?: string | undefined;
+        paths_exclude_glob?: string | undefined;
+        max_answer_chars?: number | undefined;
+    }, {
+        substring_pattern: string;
+        relative_path?: string | undefined;
+        context_lines_before?: number | undefined;
+        context_lines_after?: number | undefined;
+        paths_include_glob?: string | undefined;
+        paths_exclude_glob?: string | undefined;
+        max_answer_chars?: number | undefined;
+        restrict_search_to_code_files?: boolean | undefined;
+    }>;
+    apply(args: SearchForPatternInput): Promise<string>;
+}