@blackbox_ai/blackbox-cli-core 0.0.4

package/dist/src/tools/exitPlanMode.js

@@ -0,0 +1,137 @@
+/**
+ * @license
+ * Copyright 2025 Blackbox
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { BaseDeclarativeTool, BaseToolInvocation, Kind, ToolConfirmationOutcome, } from './tools.js';
+import { ApprovalMode } from '../config/config.js';
+const exitPlanModeToolDescription = `Use this tool when you are in plan mode and have finished presenting your plan and are ready to code. This will prompt the user to exit plan mode.
+IMPORTANT: Only use this tool when the task requires planning the implementation steps of a task that requires writing code. For research tasks where you're gathering information, searching files, reading files or in general trying to understand the codebase - do NOT use this tool.
+
+Eg.
+1. Initial task: "Search for and understand the implementation of vim mode in the codebase" - Do not use the exit plan mode tool because you are not planning the implementation steps of a task.
+2. Initial task: "Help me implement yank mode for vim" - Use the exit plan mode tool after you have finished planning the implementation steps of the task.
+`;
+const exitPlanModeToolSchemaData = {
+    name: 'exit_plan_mode',
+    description: exitPlanModeToolDescription,
+    parametersJsonSchema: {
+        type: 'object',
+        properties: {
+            plan: {
+                type: 'string',
+                description: 'The plan you came up with, that you want to run by the user for approval. Supports markdown. The plan should be pretty concise.',
+            },
+        },
+        required: ['plan'],
+        additionalProperties: false,
+        $schema: 'http://json-schema.org/draft-07/schema#',
+    },
+};
+class ExitPlanModeToolInvocation extends BaseToolInvocation {
+    config;
+    wasApproved = false;
+    constructor(config, params) {
+        super(params);
+        this.config = config;
+    }
+    getDescription() {
+        return 'Present implementation plan for user approval';
+    }
+    async shouldConfirmExecute(_abortSignal) {
+        const details = {
+            type: 'plan',
+            title: 'Would you like to proceed?',
+            plan: this.params.plan,
+            onConfirm: async (outcome) => {
+                switch (outcome) {
+                    case ToolConfirmationOutcome.ProceedAlways:
+                        this.wasApproved = true;
+                        this.setApprovalModeSafely(ApprovalMode.AUTO_EDIT);
+                        break;
+                    case ToolConfirmationOutcome.ProceedOnce:
+                        this.wasApproved = true;
+                        this.setApprovalModeSafely(ApprovalMode.DEFAULT);
+                        break;
+                    case ToolConfirmationOutcome.Cancel:
+                        this.wasApproved = false;
+                        this.setApprovalModeSafely(ApprovalMode.PLAN);
+                        break;
+                    default:
+                        // Treat any other outcome as manual approval to preserve conservative behaviour.
+                        this.wasApproved = true;
+                        this.setApprovalModeSafely(ApprovalMode.DEFAULT);
+                        break;
+                }
+            },
+        };
+        return details;
+    }
+    setApprovalModeSafely(mode) {
+        try {
+            this.config.setApprovalMode(mode);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            console.error(`[ExitPlanModeTool] Failed to set approval mode to "${mode}": ${errorMessage}`);
+        }
+    }
+    async execute(_signal) {
+        const { plan } = this.params;
+        try {
+            if (!this.wasApproved) {
+                const rejectionMessage = 'Plan execution was not approved. Remaining in plan mode.';
+                return {
+                    llmContent: JSON.stringify({
+                        success: false,
+                        plan,
+                        error: rejectionMessage,
+                    }),
+                    returnDisplay: rejectionMessage,
+                };
+            }
+            const llmMessage = 'User has approved your plan. You can now start coding. Start with updating your todo list if applicable.';
+            const displayMessage = 'User approved the plan.';
+            return {
+                llmContent: llmMessage,
+                returnDisplay: {
+                    type: 'plan_summary',
+                    message: displayMessage,
+                    plan,
+                },
+            };
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            console.error(`[ExitPlanModeTool] Error executing exit_plan_mode: ${errorMessage}`);
+            return {
+                llmContent: JSON.stringify({
+                    success: false,
+                    error: `Failed to present plan. Detail: ${errorMessage}`,
+                }),
+                returnDisplay: `Error presenting plan: ${errorMessage}`,
+            };
+        }
+    }
+}
+export class ExitPlanModeTool extends BaseDeclarativeTool {
+    config;
+    static Name = exitPlanModeToolSchemaData.name;
+    constructor(config) {
+        super(ExitPlanModeTool.Name, 'ExitPlanMode', exitPlanModeToolDescription, Kind.Think, exitPlanModeToolSchemaData.parametersJsonSchema);
+        this.config = config;
+    }
+    validateToolParams(params) {
+        // Validate plan parameter
+        if (!params.plan ||
+            typeof params.plan !== 'string' ||
+            params.plan.trim() === '') {
+            return 'Parameter "plan" must be a non-empty string.';
+        }
+        return null;
+    }
+    createInvocation(params) {
+        return new ExitPlanModeToolInvocation(this.config, params);
+    }
+}
+//# sourceMappingURL=exitPlanMode.js.map

package/dist/src/tools/exitPlanMode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exitPlanMode.js","sourceRoot":"","sources":["../../../src/tools/exitPlanMode.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,IAAI,EACJ,uBAAuB,GACxB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAMnD,MAAM,2BAA2B,GAAG;;;;;;CAMnC,CAAC;AAEF,MAAM,0BAA0B,GAAwB;IACtD,IAAI,EAAE,gBAAgB;IACtB,WAAW,EAAE,2BAA2B;IACxC,oBAAoB,EAAE;QACpB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,WAAW,EACT,iIAAiI;aACpI;SACF;QACD,QAAQ,EAAE,CAAC,MAAM,CAAC;QAClB,oBAAoB,EAAE,KAAK;QAC3B,OAAO,EAAE,yCAAyC;KACnD;CACF,CAAC;AAEF,MAAM,0BAA2B,SAAQ,kBAGxC;IAIoB;IAHX,WAAW,GAAG,KAAK,CAAC;IAE5B,YACmB,MAAc,EAC/B,MAA0B;QAE1B,KAAK,CAAC,MAAM,CAAC,CAAC;QAHG,WAAM,GAAN,MAAM,CAAQ;IAIjC,CAAC;IAED,cAAc;QACZ,OAAO,+CAA+C,CAAC;IACzD,CAAC;IAEQ,KAAK,CAAC,oBAAoB,CACjC,YAAyB;QAEzB,MAAM,OAAO,GAAgC;YAC3C,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,4BAA4B;YACnC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;YACtB,SAAS,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;gBACpD,QAAQ,OAAO,EAAE,CAAC;oBAChB,KAAK,uBAAuB,CAAC,aAAa;wBACxC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;wBACxB,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;wBACnD,MAAM;oBACR,KAAK,uBAAuB,CAAC,WAAW;wBACtC,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;wBACxB,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;wBACjD,MAAM;oBACR,KAAK,uBAAuB,CAAC,MAAM;wBACjC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;wBACzB,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;wBAC9C,MAAM;oBACR;wBACE,iFAAiF;wBACjF,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;wBACxB,IAAI,CAAC,qBAAqB,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;wBACjD,MAAM;gBACV,CAAC;YACH,CAAC;SACF,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;IAEO,qBAAqB,CAAC,IAAkB;QAC9C,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,OAAO,CAAC,KAAK,CACX,sDAAsD,IAAI,MAAM,YAAY,EAAE,CAC/E,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,OAAoB;QAChC,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QAE7B,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACtB,MAAM,gBAAgB,GACpB,0DAA0D,CAAC;gBAC7D,OAAO;oBACL,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC;wBACzB,OAAO,EAAE,KAAK;wBACd,IAAI;wBACJ,KAAK,EAAE,gBAAgB;qBACxB,CAAC;oBACF,aAAa,EAAE,gBAAgB;iBAChC,CAAC;YACJ,CAAC;YAED,MAAM,UAAU,GACd,0GAA0G,CAAC;YAC7G,MAAM,cAAc,GAAG,yBAAyB,CAAC;YAEjD,OAAO;gBACL,UAAU,EAAE,UAAU;gBACtB,aAAa,EAAE;oBACb,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,cAAc;oBACvB,IAAI;iBACL;aACF,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,OAAO,CAAC,KAAK,CACX,sDAAsD,YAAY,EAAE,CACrE,CAAC;YACF,OAAO;gBACL,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,mCAAmC,YAAY,EAAE;iBACzD,CAAC;gBACF,aAAa,EAAE,0BAA0B,YAAY,EAAE;aACxD,CAAC;QACJ,CAAC;IACH,CAAC;CACF;AAED,MAAM,OAAO,gBAAiB,SAAQ,mBAGrC;IAG8B;IAF7B,MAAM,CAAU,IAAI,GAAW,0BAA0B,CAAC,IAAK,CAAC;IAEhE,YAA6B,MAAc;QACzC,KAAK,CACH,gBAAgB,CAAC,IAAI,EACrB,cAAc,EACd,2BAA2B,EAC3B,IAAI,CAAC,KAAK,EACV,0BAA0B,CAAC,oBAG1B,CACF,CAAC;QAVyB,WAAM,GAAN,MAAM,CAAQ;IAW3C,CAAC;IAEQ,kBAAkB,CAAC,MAA0B;QACpD,0BAA0B;QAC1B,IACE,CAAC,MAAM,CAAC,IAAI;YACZ,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ;YAC/B,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EACzB,CAAC;YACD,OAAO,8CAA8C,CAAC;QACxD,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAES,gBAAgB,CAAC,MAA0B;QACnD,OAAO,IAAI,0BAA0B,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7D,CAAC"}

package/dist/src/tools/exitPlanMode.test.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @license
+ * Copyright 2025 Blackbox
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export {};

package/dist/src/tools/exitPlanMode.test.js

@@ -0,0 +1,219 @@
+/**
+ * @license
+ * Copyright 2025 Blackbox
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+import { ExitPlanModeTool } from './exitPlanMode.js';
+import { ApprovalMode } from '../config/config.js';
+import { ToolConfirmationOutcome } from './tools.js';
+describe('ExitPlanModeTool', () => {
+    let tool;
+    let mockConfig;
+    let approvalMode;
+    beforeEach(() => {
+        approvalMode = ApprovalMode.PLAN;
+        mockConfig = {
+            getApprovalMode: vi.fn(() => approvalMode),
+            setApprovalMode: vi.fn((mode) => {
+                approvalMode = mode;
+            }),
+        };
+        tool = new ExitPlanModeTool(mockConfig);
+    });
+    describe('constructor and metadata', () => {
+        it('should have correct tool name', () => {
+            expect(tool.name).toBe('exit_plan_mode');
+            expect(ExitPlanModeTool.Name).toBe('exit_plan_mode');
+        });
+        it('should have correct display name', () => {
+            expect(tool.displayName).toBe('ExitPlanMode');
+        });
+        it('should have correct kind', () => {
+            expect(tool.kind).toBe('think');
+        });
+        it('should have correct schema', () => {
+            expect(tool.schema).toEqual({
+                name: 'exit_plan_mode',
+                description: expect.stringContaining('Use this tool when you are in plan mode'),
+                parametersJsonSchema: {
+                    type: 'object',
+                    properties: {
+                        plan: {
+                            type: 'string',
+                            description: expect.stringContaining('The plan you came up with'),
+                        },
+                    },
+                    required: ['plan'],
+                    additionalProperties: false,
+                    $schema: 'http://json-schema.org/draft-07/schema#',
+                },
+            });
+        });
+    });
+    describe('validateToolParams', () => {
+        it('should accept valid parameters', () => {
+            const params = {
+                plan: 'This is a comprehensive plan for the implementation.',
+            };
+            const result = tool.validateToolParams(params);
+            expect(result).toBeNull();
+        });
+        it('should reject missing plan parameter', () => {
+            const params = {};
+            const result = tool.validateToolParams(params);
+            expect(result).toBe('Parameter "plan" must be a non-empty string.');
+        });
+        it('should reject empty plan parameter', () => {
+            const params = {
+                plan: '',
+            };
+            const result = tool.validateToolParams(params);
+            expect(result).toBe('Parameter "plan" must be a non-empty string.');
+        });
+        it('should reject whitespace-only plan parameter', () => {
+            const params = {
+                plan: '   \n\t  ',
+            };
+            const result = tool.validateToolParams(params);
+            expect(result).toBe('Parameter "plan" must be a non-empty string.');
+        });
+        it('should reject non-string plan parameter', () => {
+            const params = {
+                plan: 123,
+            };
+            const result = tool.validateToolParams(params);
+            expect(result).toBe('Parameter "plan" must be a non-empty string.');
+        });
+    });
+    describe('tool execution', () => {
+        it('should execute successfully through tool interface after approval', async () => {
+            const params = {
+                plan: 'This is my implementation plan:\n1. Step 1\n2. Step 2\n3. Step 3',
+            };
+            const signal = new AbortController().signal;
+            // Use the tool's public build method
+            const invocation = tool.build(params);
+            expect(invocation).toBeDefined();
+            expect(invocation.params).toEqual(params);
+            const confirmation = await invocation.shouldConfirmExecute(signal);
+            expect(confirmation).toMatchObject({
+                type: 'plan',
+                title: 'Would you like to proceed?',
+                plan: params.plan,
+            });
+            if (confirmation) {
+                await confirmation.onConfirm(ToolConfirmationOutcome.ProceedOnce);
+            }
+            const result = await invocation.execute(signal);
+            const expectedLlmMessage = 'User has approved your plan. You can now start coding. Start with updating your todo list if applicable.';
+            expect(result).toEqual({
+                llmContent: expectedLlmMessage,
+                returnDisplay: {
+                    type: 'plan_summary',
+                    message: 'User approved the plan.',
+                    plan: params.plan,
+                },
+            });
+            expect(mockConfig.setApprovalMode).toHaveBeenCalledWith(ApprovalMode.DEFAULT);
+            expect(approvalMode).toBe(ApprovalMode.DEFAULT);
+        });
+        it('should request confirmation with plan details', async () => {
+            const params = {
+                plan: 'Simple plan',
+            };
+            const signal = new AbortController().signal;
+            const invocation = tool.build(params);
+            const confirmation = await invocation.shouldConfirmExecute(signal);
+            if (confirmation) {
+                expect(confirmation.type).toBe('plan');
+                if (confirmation.type === 'plan') {
+                    expect(confirmation.plan).toBe(params.plan);
+                }
+                await confirmation.onConfirm(ToolConfirmationOutcome.ProceedAlways);
+            }
+            expect(mockConfig.setApprovalMode).toHaveBeenCalledWith(ApprovalMode.AUTO_EDIT);
+            expect(approvalMode).toBe(ApprovalMode.AUTO_EDIT);
+        });
+        it('should remain in plan mode when confirmation is rejected', async () => {
+            const params = {
+                plan: 'Remain in planning',
+            };
+            const signal = new AbortController().signal;
+            const invocation = tool.build(params);
+            const confirmation = await invocation.shouldConfirmExecute(signal);
+            if (confirmation) {
+                await confirmation.onConfirm(ToolConfirmationOutcome.Cancel);
+            }
+            const result = await invocation.execute(signal);
+            expect(result).toEqual({
+                llmContent: JSON.stringify({
+                    success: false,
+                    plan: params.plan,
+                    error: 'Plan execution was not approved. Remaining in plan mode.',
+                }),
+                returnDisplay: 'Plan execution was not approved. Remaining in plan mode.',
+            });
+            expect(mockConfig.setApprovalMode).toHaveBeenCalledWith(ApprovalMode.PLAN);
+            expect(approvalMode).toBe(ApprovalMode.PLAN);
+        });
+        it('should have correct description', () => {
+            const params = {
+                plan: 'Test plan',
+            };
+            const invocation = tool.build(params);
+            expect(invocation.getDescription()).toBe('Present implementation plan for user approval');
+        });
+        it('should handle execution errors gracefully', async () => {
+            const params = {
+                plan: 'Test plan',
+            };
+            const invocation = tool.build(params);
+            const confirmation = await invocation.shouldConfirmExecute(new AbortController().signal);
+            if (confirmation) {
+                // Don't approve the plan so we go through the rejection path
+                await confirmation.onConfirm(ToolConfirmationOutcome.Cancel);
+            }
+            // Create a spy to simulate an error during the execution
+            const consoleSpy = vi
+                .spyOn(console, 'error')
+                .mockImplementation(() => { });
+            // Mock JSON.stringify to throw an error in the rejection path
+            const originalStringify = JSON.stringify;
+            vi.spyOn(JSON, 'stringify').mockImplementationOnce(() => {
+                throw new Error('JSON stringify error');
+            });
+            const result = await invocation.execute(new AbortController().signal);
+            expect(result).toEqual({
+                llmContent: JSON.stringify({
+                    success: false,
+                    error: 'Failed to present plan. Detail: JSON stringify error',
+                }),
+                returnDisplay: 'Error presenting plan: JSON stringify error',
+            });
+            expect(consoleSpy).toHaveBeenCalledWith('[ExitPlanModeTool] Error executing exit_plan_mode: JSON stringify error');
+            // Restore original JSON.stringify
+            JSON.stringify = originalStringify;
+            consoleSpy.mockRestore();
+        });
+        it('should return empty tool locations', () => {
+            const params = {
+                plan: 'Test plan',
+            };
+            const invocation = tool.build(params);
+            expect(invocation.toolLocations()).toEqual([]);
+        });
+    });
+    describe('tool description', () => {
+        it('should contain usage guidelines', () => {
+            expect(tool.description).toContain('Only use this tool when the task requires planning');
+            expect(tool.description).toContain('Do not use the exit plan mode tool because you are not planning');
+            expect(tool.description).toContain('Use the exit plan mode tool after you have finished planning');
+        });
+        it('should contain examples', () => {
+            expect(tool.description).toContain('Search for and understand the implementation of vim mode');
+            expect(tool.description).toContain('Help me implement yank mode for vim');
+        });
+    });
+});
+//# sourceMappingURL=exitPlanMode.test.js.map

package/dist/src/tools/exitPlanMode.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exitPlanMode.test.js","sourceRoot":"","sources":["../../../src/tools/exitPlanMode.test.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAC9D,OAAO,EAAE,gBAAgB,EAA2B,MAAM,mBAAmB,CAAC;AAC9E,OAAO,EAAE,YAAY,EAAe,MAAM,qBAAqB,CAAC;AAChE,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AAErD,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,IAAI,IAAsB,CAAC;IAC3B,IAAI,UAAkB,CAAC;IACvB,IAAI,YAA0B,CAAC;IAE/B,UAAU,CAAC,GAAG,EAAE;QACd,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC;QACjC,UAAU,GAAG;YACX,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC;YAC1C,eAAe,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,IAAkB,EAAE,EAAE;gBAC5C,YAAY,GAAG,IAAI,CAAC;YACtB,CAAC,CAAC;SACkB,CAAC;QAEvB,IAAI,GAAG,IAAI,gBAAgB,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACxC,EAAE,CAAC,+BAA+B,EAAE,GAAG,EAAE;YACvC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;YACzC,MAAM,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;YAClC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;YACpC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBAC1B,IAAI,EAAE,gBAAgB;gBACtB,WAAW,EAAE,MAAM,CAAC,gBAAgB,CAClC,yCAAyC,CAC1C;gBACD,oBAAoB,EAAE;oBACpB,IAAI,EAAE,QAAQ;oBACd,UAAU,EAAE;wBACV,IAAI,EAAE;4BACJ,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,MAAM,CAAC,gBAAgB,CAAC,2BAA2B,CAAC;yBAClE;qBACF;oBACD,QAAQ,EAAE,CAAC,MAAM,CAAC;oBAClB,oBAAoB,EAAE,KAAK;oBAC3B,OAAO,EAAE,yCAAyC;iBACnD;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,sDAAsD;aAC7D,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,MAAM,MAAM,GAAG,EAAwB,CAAC;YAExC,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,EAAE;aACT,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,WAAW;aAClB,CAAC;YAEF,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;YACjD,MAAM,MAAM,GAAG;gBACb,IAAI,EAAE,GAAG;aACuB,CAAC;YAEnC,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;YAC/C,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAC9B,EAAE,CAAC,mEAAmE,EAAE,KAAK,IAAI,EAAE;YACjF,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,kEAAkE;aACzE,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;YAE5C,qCAAqC;YACrC,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;YACjC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAE1C,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YACnE,MAAM,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC;gBACjC,IAAI,EAAE,MAAM;gBACZ,KAAK,EAAE,4BAA4B;gBACnC,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAC;YAEH,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,SAAS,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC;YACpE,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAChD,MAAM,kBAAkB,GACtB,0GAA0G,CAAC;YAE7G,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,UAAU,EAAE,kBAAkB;gBAC9B,aAAa,EAAE;oBACb,IAAI,EAAE,cAAc;oBACpB,OAAO,EAAE,yBAAyB;oBAClC,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB;aACF,CAAC,CAAC;YAEH,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,oBAAoB,CACrD,YAAY,CAAC,OAAO,CACrB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;QAClD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC7D,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,aAAa;aACpB,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;YAE5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAEnE,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACvC,IAAI,YAAY,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBACjC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;gBAC9C,CAAC;gBAED,MAAM,YAAY,CAAC,SAAS,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC;YACtE,CAAC;YAED,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,oBAAoB,CACrD,YAAY,CAAC,SAAS,CACvB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QACpD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;YACxE,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,oBAAoB;aAC3B,CAAC;YACF,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC;YAE5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;YAEnE,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,YAAY,CAAC,SAAS,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YAC/D,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;YAEhD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,OAAO,EAAE,KAAK;oBACd,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,KAAK,EAAE,0DAA0D;iBAClE,CAAC;gBACF,aAAa,EACX,0DAA0D;aAC7D,CAAC,CAAC;YAEH,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,oBAAoB,CACrD,YAAY,CAAC,IAAI,CAClB,CAAC;YACF,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,WAAW;aAClB,CAAC;YAEF,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,UAAU,CAAC,cAAc,EAAE,CAAC,CAAC,IAAI,CACtC,+CAA+C,CAChD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,KAAK,IAAI,EAAE;YACzD,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,WAAW;aAClB,CAAC;YAEF,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,YAAY,GAAG,MAAM,UAAU,CAAC,oBAAoB,CACxD,IAAI,eAAe,EAAE,CAAC,MAAM,CAC7B,CAAC;YACF,IAAI,YAAY,EAAE,CAAC;gBACjB,6DAA6D;gBAC7D,MAAM,YAAY,CAAC,SAAS,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC;YAC/D,CAAC;YAED,yDAAyD;YACzD,MAAM,UAAU,GAAG,EAAE;iBAClB,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC;iBACvB,kBAAkB,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAEhC,8DAA8D;YAC9D,MAAM,iBAAiB,GAAG,IAAI,CAAC,SAAS,CAAC;YACzC,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,sBAAsB,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;YAC1C,CAAC,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,OAAO,CAAC,IAAI,eAAe,EAAE,CAAC,MAAM,CAAC,CAAC;YAEtE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;gBACrB,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,sDAAsD;iBAC9D,CAAC;gBACF,aAAa,EAAE,6CAA6C;aAC7D,CAAC,CAAC;YAEH,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CACrC,yEAAyE,CAC1E,CAAC;YAEF,kCAAkC;YAClC,IAAI,CAAC,SAAS,GAAG,iBAAiB,CAAC;YACnC,UAAU,CAAC,WAAW,EAAE,CAAC;QAC3B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,MAAM,MAAM,GAAuB;gBACjC,IAAI,EAAE,WAAW;aAClB,CAAC;YAEF,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACtC,MAAM,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;QAChC,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,CAChC,oDAAoD,CACrD,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,CAChC,iEAAiE,CAClE,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,CAChC,8DAA8D,CAC/D,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;YACjC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,CAChC,0DAA0D,CAC3D,CAAC;YACF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC;QAC5E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/src/tools/glob.d.ts

@@ -0,0 +1,52 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import type { ToolInvocation, ToolResult } from './tools.js';
+import { BaseDeclarativeTool } from './tools.js';
+import type { Config } from '../config/config.js';
+export interface GlobPath {
+    fullpath(): string;
+    mtimeMs?: number;
+}
+/**
+ * Sorts file entries based on recency and then alphabetically.
+ * Recent files (modified within recencyThresholdMs) are listed first, newest to oldest.
+ * Older files are listed after recent ones, sorted alphabetically by path.
+ */
+export declare function sortFileEntries(entries: GlobPath[], nowTimestamp: number, recencyThresholdMs: number): GlobPath[];
+/**
+ * Parameters for the GlobTool
+ */
+export interface GlobToolParams {
+    /**
+     * The glob pattern to match files against
+     */
+    pattern: string;
+    /**
+     * The directory to search in (optional, defaults to current directory)
+     */
+    path?: string;
+    /**
+     * Whether the search should be case-sensitive (optional, defaults to false)
+     */
+    case_sensitive?: boolean;
+    /**
+     * Whether to respect .gitignore patterns (optional, defaults to true)
+     */
+    respect_git_ignore?: boolean;
+}
+/**
+ * Implementation of the Glob tool logic
+ */
+export declare class GlobTool extends BaseDeclarativeTool<GlobToolParams, ToolResult> {
+    private config;
+    static readonly Name: "glob";
+    constructor(config: Config);
+    /**
+     * Validates the parameters for the tool.
+     */
+    protected validateToolParamValues(params: GlobToolParams): string | null;
+    protected createInvocation(params: GlobToolParams): ToolInvocation<GlobToolParams, ToolResult>;
+}