@office-ai/aioncli-core 0.1.1-8.1

package/dist/src/tools/read-file.test.js

@@ -0,0 +1,300 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { ReadFileTool } from './read-file.js';
+import { ToolErrorType } from './tool-error.js';
+import path from 'path';
+import os from 'os';
+import fs from 'fs';
+import fsp from 'fs/promises';
+import { FileDiscoveryService } from '../services/fileDiscoveryService.js';
+import { createMockWorkspaceContext } from '../test-utils/mockWorkspaceContext.js';
+describe('ReadFileTool', () => {
+    let tempRootDir;
+    let tool;
+    const abortSignal = new AbortController().signal;
+    beforeEach(async () => {
+        // Create a unique temporary root directory for each test run
+        tempRootDir = await fsp.mkdtemp(path.join(os.tmpdir(), 'read-file-tool-root-'));
+        const mockConfigInstance = {
+            getFileService: () => new FileDiscoveryService(tempRootDir),
+            getTargetDir: () => tempRootDir,
+            getWorkspaceContext: () => createMockWorkspaceContext(tempRootDir),
+        };
+        tool = new ReadFileTool(mockConfigInstance);
+    });
+    afterEach(async () => {
+        // Clean up the temporary root directory
+        if (fs.existsSync(tempRootDir)) {
+            await fsp.rm(tempRootDir, { recursive: true, force: true });
+        }
+    });
+    describe('build', () => {
+        it('should return an invocation for valid params (absolute path within root)', () => {
+            const params = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+            };
+            const result = tool.build(params);
+            expect(typeof result).not.toBe('string');
+        });
+        it('should throw error if file path is relative', () => {
+            const params = {
+                absolute_path: 'relative/path.txt',
+            };
+            expect(() => tool.build(params)).toThrow('File path must be absolute, but was relative: relative/path.txt. You must provide an absolute path.');
+        });
+        it('should throw error if path is outside root', () => {
+            const params = {
+                absolute_path: '/outside/root.txt',
+            };
+            expect(() => tool.build(params)).toThrow(/File path must be within one of the workspace directories/);
+        });
+        it('should throw error if offset is negative', () => {
+            const params = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+                offset: -1,
+            };
+            expect(() => tool.build(params)).toThrow('Offset must be a non-negative number');
+        });
+        it('should throw error if limit is zero or negative', () => {
+            const params = {
+                absolute_path: path.join(tempRootDir, 'test.txt'),
+                limit: 0,
+            };
+            expect(() => tool.build(params)).toThrow('Limit must be a positive number');
+        });
+    });
+    describe('getDescription', () => {
+        it('should return relative path without limit/offset', () => {
+            const subDir = path.join(tempRootDir, 'sub', 'dir');
+            const params = {
+                absolute_path: path.join(subDir, 'file.txt'),
+            };
+            const invocation = tool.build(params);
+            expect(typeof invocation).not.toBe('string');
+            expect(invocation.getDescription()).toBe(path.join('sub', 'dir', 'file.txt'));
+        });
+        it('should return shortened path when file path is deep', () => {
+            const deepPath = path.join(tempRootDir, 'very', 'deep', 'directory', 'structure', 'that', 'exceeds', 'the', 'normal', 'limit', 'file.txt');
+            const params = { absolute_path: deepPath };
+            const invocation = tool.build(params);
+            expect(typeof invocation).not.toBe('string');
+            const desc = invocation.getDescription();
+            expect(desc).toContain('...');
+            expect(desc).toContain('file.txt');
+        });
+        it('should handle non-normalized file paths correctly', () => {
+            const subDir = path.join(tempRootDir, 'sub', 'dir');
+            const params = {
+                absolute_path: path.join(subDir, '..', 'dir', 'file.txt'),
+            };
+            const invocation = tool.build(params);
+            expect(typeof invocation).not.toBe('string');
+            expect(invocation.getDescription()).toBe(path.join('sub', 'dir', 'file.txt'));
+        });
+        it('should return . if path is the root directory', () => {
+            const params = { absolute_path: tempRootDir };
+            const invocation = tool.build(params);
+            expect(typeof invocation).not.toBe('string');
+            expect(invocation.getDescription()).toBe('.');
+        });
+    });
+    describe('execute', () => {
+        it('should return error if file does not exist', async () => {
+            const filePath = path.join(tempRootDir, 'nonexistent.txt');
+            const params = { absolute_path: filePath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result).toEqual({
+                llmContent: 'Could not read file because no file was found at the specified path.',
+                returnDisplay: 'File not found.',
+                error: {
+                    message: `File not found: ${filePath}`,
+                    type: ToolErrorType.FILE_NOT_FOUND,
+                },
+            });
+        });
+        it('should return success result for a text file', async () => {
+            const filePath = path.join(tempRootDir, 'textfile.txt');
+            const fileContent = 'This is a test file.';
+            await fsp.writeFile(filePath, fileContent, 'utf-8');
+            const params = { absolute_path: filePath };
+            const invocation = tool.build(params);
+            expect(await invocation.execute(abortSignal)).toEqual({
+                llmContent: fileContent,
+                returnDisplay: '',
+            });
+        });
+        it('should return error if path is a directory', async () => {
+            const dirPath = path.join(tempRootDir, 'directory');
+            await fsp.mkdir(dirPath);
+            const params = { absolute_path: dirPath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result).toEqual({
+                llmContent: 'Could not read file because the provided path is a directory, not a file.',
+                returnDisplay: 'Path is a directory.',
+                error: {
+                    message: `Path is a directory, not a file: ${dirPath}`,
+                    type: ToolErrorType.INVALID_TOOL_PARAMS,
+                },
+            });
+        });
+        it('should return error for a file that is too large', async () => {
+            const filePath = path.join(tempRootDir, 'largefile.txt');
+            // 21MB of content exceeds 20MB limit
+            const largeContent = 'x'.repeat(21 * 1024 * 1024);
+            await fsp.writeFile(filePath, largeContent, 'utf-8');
+            const params = { absolute_path: filePath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result).toHaveProperty('error');
+            expect(result.error?.type).toBe(ToolErrorType.FILE_TOO_LARGE);
+            expect(result.error?.message).toContain('File size exceeds the 20MB limit');
+        });
+        it('should handle text file with lines exceeding maximum length', async () => {
+            const filePath = path.join(tempRootDir, 'longlines.txt');
+            const longLine = 'a'.repeat(2500); // Exceeds MAX_LINE_LENGTH_TEXT_FILE (2000)
+            const fileContent = `Short line\n${longLine}\nAnother short line`;
+            await fsp.writeFile(filePath, fileContent, 'utf-8');
+            const params = { absolute_path: filePath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toContain('IMPORTANT: The file content has been truncated');
+            expect(result.llmContent).toContain('--- FILE CONTENT (truncated) ---');
+            expect(result.returnDisplay).toContain('some lines were shortened');
+        });
+        it('should handle image file and return appropriate content', async () => {
+            const imagePath = path.join(tempRootDir, 'image.png');
+            // Minimal PNG header
+            const pngHeader = Buffer.from([
+                0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a,
+            ]);
+            await fsp.writeFile(imagePath, pngHeader);
+            const params = { absolute_path: imagePath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toEqual({
+                inlineData: {
+                    data: pngHeader.toString('base64'),
+                    mimeType: 'image/png',
+                },
+            });
+            expect(result.returnDisplay).toBe('Read image file: image.png');
+        });
+        it('should handle PDF file and return appropriate content', async () => {
+            const pdfPath = path.join(tempRootDir, 'document.pdf');
+            // Minimal PDF header
+            const pdfHeader = Buffer.from('%PDF-1.4');
+            await fsp.writeFile(pdfPath, pdfHeader);
+            const params = { absolute_path: pdfPath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toEqual({
+                inlineData: {
+                    data: pdfHeader.toString('base64'),
+                    mimeType: 'application/pdf',
+                },
+            });
+            expect(result.returnDisplay).toBe('Read pdf file: document.pdf');
+        });
+        it('should handle binary file and skip content', async () => {
+            const binPath = path.join(tempRootDir, 'binary.bin');
+            // Binary data with null bytes
+            const binaryData = Buffer.from([0x00, 0xff, 0x00, 0xff]);
+            await fsp.writeFile(binPath, binaryData);
+            const params = { absolute_path: binPath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toBe('Cannot display content of binary file: binary.bin');
+            expect(result.returnDisplay).toBe('Skipped binary file: binary.bin');
+        });
+        it('should handle SVG file as text', async () => {
+            const svgPath = path.join(tempRootDir, 'image.svg');
+            const svgContent = '<svg><circle cx="50" cy="50" r="40"/></svg>';
+            await fsp.writeFile(svgPath, svgContent, 'utf-8');
+            const params = { absolute_path: svgPath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toBe(svgContent);
+            expect(result.returnDisplay).toBe('Read SVG as text: image.svg');
+        });
+        it('should handle large SVG file', async () => {
+            const svgPath = path.join(tempRootDir, 'large.svg');
+            // Create SVG content larger than 1MB
+            const largeContent = '<svg>' + 'x'.repeat(1024 * 1024 + 1) + '</svg>';
+            await fsp.writeFile(svgPath, largeContent, 'utf-8');
+            const params = { absolute_path: svgPath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toBe('Cannot display content of SVG file larger than 1MB: large.svg');
+            expect(result.returnDisplay).toBe('Skipped large SVG file (>1MB): large.svg');
+        });
+        it('should handle empty file', async () => {
+            const emptyPath = path.join(tempRootDir, 'empty.txt');
+            await fsp.writeFile(emptyPath, '', 'utf-8');
+            const params = { absolute_path: emptyPath };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toBe('');
+            expect(result.returnDisplay).toBe('');
+        });
+        it('should support offset and limit for text files', async () => {
+            const filePath = path.join(tempRootDir, 'paginated.txt');
+            const lines = Array.from({ length: 20 }, (_, i) => `Line ${i + 1}`);
+            const fileContent = lines.join('\n');
+            await fsp.writeFile(filePath, fileContent, 'utf-8');
+            const params = {
+                absolute_path: filePath,
+                offset: 5, // Start from line 6
+                limit: 3,
+            };
+            const invocation = tool.build(params);
+            const result = await invocation.execute(abortSignal);
+            expect(result.llmContent).toContain('IMPORTANT: The file content has been truncated');
+            expect(result.llmContent).toContain('Status: Showing lines 6-8 of 20 total lines');
+            expect(result.llmContent).toContain('Line 6');
+            expect(result.llmContent).toContain('Line 7');
+            expect(result.llmContent).toContain('Line 8');
+            expect(result.returnDisplay).toBe('Read lines 6-8 of 20 from paginated.txt');
+        });
+        describe('with .geminiignore', () => {
+            beforeEach(async () => {
+                await fsp.writeFile(path.join(tempRootDir, '.geminiignore'), ['foo.*', 'ignored/'].join('\n'));
+            });
+            it('should throw error if path is ignored by a .geminiignore pattern', async () => {
+                const ignoredFilePath = path.join(tempRootDir, 'foo.bar');
+                await fsp.writeFile(ignoredFilePath, 'content', 'utf-8');
+                const params = {
+                    absolute_path: ignoredFilePath,
+                };
+                const expectedError = `File path '${ignoredFilePath}' is ignored by .geminiignore pattern(s).`;
+                expect(() => tool.build(params)).toThrow(expectedError);
+            });
+            it('should throw error if file is in an ignored directory', async () => {
+                const ignoredDirPath = path.join(tempRootDir, 'ignored');
+                await fsp.mkdir(ignoredDirPath, { recursive: true });
+                const ignoredFilePath = path.join(ignoredDirPath, 'file.txt');
+                await fsp.writeFile(ignoredFilePath, 'content', 'utf-8');
+                const params = {
+                    absolute_path: ignoredFilePath,
+                };
+                const expectedError = `File path '${ignoredFilePath}' is ignored by .geminiignore pattern(s).`;
+                expect(() => tool.build(params)).toThrow(expectedError);
+            });
+            it('should allow reading non-ignored files', async () => {
+                const allowedFilePath = path.join(tempRootDir, 'allowed.txt');
+                await fsp.writeFile(allowedFilePath, 'content', 'utf-8');
+                const params = {
+                    absolute_path: allowedFilePath,
+                };
+                const invocation = tool.build(params);
+                expect(typeof invocation).not.toBe('string');
+            });
+        });
+    });
+});
+//# sourceMappingURL=read-file.test.js.map

package/dist/src/tools/read-file.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"read-file.test.js","sourceRoot":"","sources":["../../../src/tools/read-file.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACrE,OAAO,EAAE,YAAY,EAAsB,MAAM,gBAAgB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,qCAAqC,CAAC;AAC3E,OAAO,EAAE,0BAA0B,EAAE,MAAM,uCAAuC,CAAC;AAGnF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,IAAI,WAAmB,CAAC;IACxB,IAAI,IAAkB,CAAC;IACvB,MAAM,WAAW,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;IAEjD,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,6DAA6D;QAC7D,WAAW,GAAG,MAAM,GAAG,CAAC,OAAO,CAC7B,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,sBAAsB,CAAC,CAC/C,CAAC;QAEF,MAAM,kBAAkB,GAAG;YACzB,cAAc,EAAE,GAAG,EAAE,CAAC,IAAI,oBAAoB,CAAC,WAAW,CAAC;YAC3D,YAAY,EAAE,GAAG,EAAE,CAAC,WAAW;YAC/B,mBAAmB,EAAE,GAAG,EAAE,CAAC,0BAA0B,CAAC,WAAW,CAAC;SAC9C,CAAC;QACvB,IAAI,GAAG,IAAI,YAAY,CAAC,kBAAkB,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,KAAK,IAAI,EAAE;QACnB,wCAAwC;QACxC,IAAI,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,CAAC;YAC/B,MAAM,GAAG,CAAC,EAAE,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;QACrB,EAAE,CAAC,0EAA0E,EAAE,GAAG,EAAE;YAClF,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;aAClD,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAClC,MAAM,CAAC,OAAO,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;YACrD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,mBAAmB;aACnC,CAAC;YACF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CACtC,qGAAqG,CACtG,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;YACpD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,mBAAmB;aACnC,CAAC;YACF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CACtC,2DAA2D,CAC5D,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;YAClD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;gBACjD,MAAM,EAAE,CAAC,CAAC;aACX,CAAC;YACF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CACtC,sCAAsC,CACvC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;gBACjD,KAAK,EAAE,CAAC;aACT,CAAC;YACF,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CACtC,iCAAiC,CAClC,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,kDAAkD,EAAE,GAAG,EAAE;YAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACpD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC;aAC7C,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,CAEF,UACD,CAAC,cAAc,EAAE,CACnB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CACxB,WAAW,EACX,MAAM,EACN,MAAM,EACN,WAAW,EACX,WAAW,EACX,MAAM,EACN,SAAS,EACT,KAAK,EACL,QAAQ,EACR,OAAO,EACP,UAAU,CACX,CAAC;YACF,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,IAAI,GACR,UACD,CAAC,cAAc,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACrC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAC3D,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACpD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC;aAC1D,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,CAEF,UACD,CAAC,cAAc,EAAE,CACnB,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,WAAW,EAAE,CAAC;YAClE,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7C,MAAM,CAEF,UACD,CAAC,cAAc,EAAE,CACnB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACd,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QACvB,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,UAAU,EACR,sEAAsE;gBACxE,aAAa,EAAE,iBAAiB;gBAChC,KAAK,EAAE;oBACL,OAAO,EAAE,mBAAmB,QAAQ,EAAE;oBACtC,IAAI,EAAE,aAAa,CAAC,cAAc;iBACnC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;YACxD,MAAM,WAAW,GAAG,sBAAsB,CAAC;YAC3C,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;YACpD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,CAAC,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC;gBACpD,UAAU,EAAE,WAAW;gBACvB,aAAa,EAAE,EAAE;aAClB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACpD,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzB,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;YAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,UAAU,EACR,2EAA2E;gBAC7E,aAAa,EAAE,sBAAsB;gBACrC,KAAK,EAAE;oBACL,OAAO,EAAE,oCAAoC,OAAO,EAAE;oBACtD,IAAI,EAAE,aAAa,CAAC,mBAAmB;iBACxC;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kDAAkD,EAAE,KAAK,IAAI,EAAE;YAChE,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;YACzD,qCAAqC;YACrC,MAAM,YAAY,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;YAClD,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;YACrD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;YACvC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,CAAC;YAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS,CACrC,kCAAkC,CACnC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;YAC3E,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;YACzD,MAAM,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,2CAA2C;YAC9E,MAAM,WAAW,GAAG,eAAe,QAAQ,sBAAsB,CAAC;YAClE,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;YACpD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,QAAQ,EAAE,CAAC;YAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CACjC,gDAAgD,CACjD,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,kCAAkC,CAAC,CAAC;YACxE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;YACvE,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACtD,qBAAqB;YACrB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC;gBAC5B,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;aAC/C,CAAC,CAAC;YACH,MAAM,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;YAC1C,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;YAChE,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;gBAChC,UAAU,EAAE;oBACV,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBAClC,QAAQ,EAAE,WAAW;iBACtB;aACF,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAC;QAClE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;YACrE,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;YACvD,qBAAqB;YACrB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YACxC,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;YAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC;gBAChC,UAAU,EAAE;oBACV,IAAI,EAAE,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;oBAClC,QAAQ,EAAE,iBAAiB;iBAC5B;aACF,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;YAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;YACrD,8BAA8B;YAC9B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;YACzD,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;YACzC,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;YAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAC5B,mDAAmD,CACpD,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACpD,MAAM,UAAU,GAAG,6CAA6C,CAAC;YACjE,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;YAClD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;YAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;YAC3C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACpD,qCAAqC;YACrC,MAAM,YAAY,GAAG,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC;YACtE,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;YACpD,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC;YAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAC5B,+DAA+D,CAChE,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAC/B,0CAA0C,CAC3C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;YACxC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;YACtD,MAAM,GAAG,CAAC,SAAS,CAAC,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;YAC5C,MAAM,MAAM,GAAuB,EAAE,aAAa,EAAE,SAAS,EAAE,CAAC;YAChE,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACnC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAC9D,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;YACzD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACpE,MAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACrC,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;YAEpD,MAAM,MAAM,GAAuB;gBACjC,aAAa,EAAE,QAAQ;gBACvB,MAAM,EAAE,CAAC,EAAE,oBAAoB;gBAC/B,KAAK,EAAE,CAAC;aACT,CAAC;YACF,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAGnC,CAAC;YAEF,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACrD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CACjC,gDAAgD,CACjD,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CACjC,6CAA6C,CAC9C,CAAC;YACF,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YAC9C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAC/B,yCAAyC,CAC1C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAClC,UAAU,CAAC,KAAK,IAAI,EAAE;gBACpB,MAAM,GAAG,CAAC,SAAS,CACjB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,eAAe,CAAC,EACvC,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACjC,CAAC;YACJ,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,kEAAkE,EAAE,KAAK,IAAI,EAAE;gBAChF,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBAC1D,MAAM,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM,MAAM,GAAuB;oBACjC,aAAa,EAAE,eAAe;iBAC/B,CAAC;gBACF,MAAM,aAAa,GAAG,cAAc,eAAe,2CAA2C,CAAC;gBAC/F,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;gBACrE,MAAM,cAAc,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;gBACzD,MAAM,GAAG,CAAC,KAAK,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;gBACrD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;gBAC9D,MAAM,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM,MAAM,GAAuB;oBACjC,aAAa,EAAE,eAAe;iBAC/B,CAAC;gBACF,MAAM,aAAa,GAAG,cAAc,eAAe,2CAA2C,CAAC;gBAC/F,MAAM,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;YAC1D,CAAC,CAAC,CAAC;YAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;gBACtD,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;gBAC9D,MAAM,GAAG,CAAC,SAAS,CAAC,eAAe,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;gBACzD,MAAM,MAAM,GAAuB;oBACjC,aAAa,EAAE,eAAe;iBAC/B,CAAC;gBACF,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;gBACtC,MAAM,CAAC,OAAO,UAAU,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC/C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/tools/read-many-files.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BaseTool, ToolResult } from './tools.js';
+import { Config } from '../config/config.js';
+/**
+ * Parameters for the ReadManyFilesTool.
+ */
+export interface ReadManyFilesParams {
+    /**
+     * An array of file paths or directory paths to search within.
+     * Paths are relative to the tool's configured target directory.
+     * Glob patterns can be used directly in these paths.
+     */
+    paths: string[];
+    /**
+     * Optional. Glob patterns for files to include.
+     * These are effectively combined with the `paths`.
+     * Example: ["*.ts", "src/** /*.md"]
+     */
+    include?: string[];
+    /**
+     * Optional. Glob patterns for files/directories to exclude.
+     * Applied as ignore patterns.
+     * Example: ["*.log", "dist/**"]
+     */
+    exclude?: string[];
+    /**
+     * Optional. Search directories recursively.
+     * This is generally controlled by glob patterns (e.g., `**`).
+     * The glob implementation is recursive by default for `**`.
+     * For simplicity, we'll rely on `**` for recursion.
+     */
+    recursive?: boolean;
+    /**
+     * Optional. Apply default exclusion patterns. Defaults to true.
+     */
+    useDefaultExcludes?: boolean;
+    /**
+     * Whether to respect .gitignore and .geminiignore patterns (optional, defaults to true)
+     */
+    file_filtering_options?: {
+        respect_git_ignore?: boolean;
+        respect_gemini_ignore?: boolean;
+    };
+}
+/**
+ * Tool implementation for finding and reading multiple text files from the local filesystem
+ * within a specified target directory. The content is concatenated.
+ * It is intended to run in an environment with access to the local file system (e.g., a Node.js backend).
+ */
+export declare class ReadManyFilesTool extends BaseTool<ReadManyFilesParams, ToolResult> {
+    private config;
+    static readonly Name: string;
+    constructor(config: Config);
+    validateParams(params: ReadManyFilesParams): string | null;
+    getDescription(params: ReadManyFilesParams): string;
+    execute(params: ReadManyFilesParams, signal: AbortSignal): Promise<ToolResult>;
+}