@dexto/tools-plan 1.5.8 → 1.6.1

package/dist/tools/plan-read-tool.test.js

@@ -1,83 +1,86 @@
-/**
- * Plan Read Tool Tests
- *
- * Tests for the plan_read tool.
- */
-import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
-import * as path from 'node:path';
-import * as fs from 'node:fs/promises';
-import * as os from 'node:os';
-import { createPlanReadTool } from './plan-read-tool.js';
-import { PlanService } from '../plan-service.js';
-import { PlanErrorCode } from '../errors.js';
-import { DextoRuntimeError } from '@dexto/core';
-// Create mock logger
-const createMockLogger = () => ({
+import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
+import * as path from "node:path";
+import * as fs from "node:fs/promises";
+import * as os from "node:os";
+import { createPlanReadTool } from "./plan-read-tool.js";
+import { PlanService } from "../plan-service.js";
+import { PlanErrorCode } from "../errors.js";
+import { DextoRuntimeError } from "@dexto/core";
+const createMockLogger = () => {
+  const logger = {
     debug: vi.fn(),
+    silly: vi.fn(),
     info: vi.fn(),
     warn: vi.fn(),
     error: vi.fn(),
-    createChild: vi.fn().mockReturnThis(),
-});
-describe('plan_read tool', () => {
-    let mockLogger;
-    let tempDir;
-    let planService;
-    beforeEach(async () => {
-        mockLogger = createMockLogger();
-        const rawTempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'dexto-plan-read-test-'));
-        tempDir = await fs.realpath(rawTempDir);
-        planService = new PlanService({ basePath: tempDir }, mockLogger);
-        vi.clearAllMocks();
+    trackException: vi.fn(),
+    createChild: vi.fn(() => logger),
+    createFileOnlyChild: vi.fn(() => logger),
+    setLevel: vi.fn(),
+    getLevel: vi.fn(() => "debug"),
+    getLogFilePath: vi.fn(() => null),
+    destroy: vi.fn(async () => void 0)
+  };
+  return logger;
+};
+function createToolContext(logger, overrides = {}) {
+  return { logger, ...overrides };
+}
+describe("plan_read tool", () => {
+  let logger;
+  let tempDir;
+  let planService;
+  beforeEach(async () => {
+    logger = createMockLogger();
+    const rawTempDir = await fs.mkdtemp(path.join(os.tmpdir(), "dexto-plan-read-test-"));
+    tempDir = await fs.realpath(rawTempDir);
+    planService = new PlanService({ basePath: tempDir }, logger);
+    vi.clearAllMocks();
+  });
+  afterEach(async () => {
+    try {
+      await fs.rm(tempDir, { recursive: true, force: true });
+    } catch {
+    }
+  });
+  describe("execute", () => {
+    it("should return exists: false when no plan exists", async () => {
+      const tool = createPlanReadTool(async () => planService);
+      const sessionId = "test-session";
+      const result = await tool.execute({}, createToolContext(logger, { sessionId }));
+      expect(result.exists).toBe(false);
+      expect(result.message).toContain("No plan found");
+    });
+    it("should return plan content and metadata when plan exists", async () => {
+      const tool = createPlanReadTool(async () => planService);
+      const sessionId = "test-session";
+      const content = "# My Plan\n\nSome content";
+      const title = "My Plan Title";
+      await planService.create(sessionId, content, { title });
+      const result = await tool.execute({}, createToolContext(logger, { sessionId }));
+      expect(result.exists).toBe(true);
+      expect(result.content).toBe(content);
+      expect(result.status).toBe("draft");
+      expect(result.title).toBe(title);
+      expect(result.path).toBe(path.join(tempDir, sessionId, "plan.md"));
     });
-    afterEach(async () => {
-        try {
-            await fs.rm(tempDir, { recursive: true, force: true });
-        }
-        catch {
-            // Ignore cleanup errors
-        }
+    it("should return ISO timestamps", async () => {
+      const tool = createPlanReadTool(async () => planService);
+      const sessionId = "test-session";
+      await planService.create(sessionId, "# Plan");
+      const result = await tool.execute({}, createToolContext(logger, { sessionId }));
+      expect(result.createdAt).toMatch(/^\d{4}-\d{2}-\d{2}T/);
+      expect(result.updatedAt).toMatch(/^\d{4}-\d{2}-\d{2}T/);
     });
-    describe('execute', () => {
-        it('should return exists: false when no plan exists', async () => {
-            const tool = createPlanReadTool(planService);
-            const sessionId = 'test-session';
-            const result = (await tool.execute({}, { sessionId }));
-            expect(result.exists).toBe(false);
-            expect(result.message).toContain('No plan found');
-        });
-        it('should return plan content and metadata when plan exists', async () => {
-            const tool = createPlanReadTool(planService);
-            const sessionId = 'test-session';
-            const content = '# My Plan\n\nSome content';
-            const title = 'My Plan Title';
-            await planService.create(sessionId, content, { title });
-            const result = (await tool.execute({}, { sessionId }));
-            expect(result.exists).toBe(true);
-            expect(result.content).toBe(content);
-            expect(result.status).toBe('draft');
-            expect(result.title).toBe(title);
-            expect(result.path).toBe(`.dexto/plans/${sessionId}/plan.md`);
-        });
-        it('should return ISO timestamps', async () => {
-            const tool = createPlanReadTool(planService);
-            const sessionId = 'test-session';
-            await planService.create(sessionId, '# Plan');
-            const result = (await tool.execute({}, { sessionId }));
-            // Should be ISO format
-            expect(result.createdAt).toMatch(/^\d{4}-\d{2}-\d{2}T/);
-            expect(result.updatedAt).toMatch(/^\d{4}-\d{2}-\d{2}T/);
-        });
-        it('should throw error when sessionId is missing', async () => {
-            const tool = createPlanReadTool(planService);
-            try {
-                await tool.execute({}, {});
-                expect.fail('Should have thrown an error');
-            }
-            catch (error) {
-                expect(error).toBeInstanceOf(DextoRuntimeError);
-                expect(error.code).toBe(PlanErrorCode.SESSION_ID_REQUIRED);
-            }
-        });
+    it("should throw error when sessionId is missing", async () => {
+      const tool = createPlanReadTool(async () => planService);
+      try {
+        await tool.execute({}, createToolContext(logger));
+        expect.fail("Should have thrown an error");
+      } catch (error) {
+        expect(error).toBeInstanceOf(DextoRuntimeError);
+        expect(error.code).toBe(PlanErrorCode.SESSION_ID_REQUIRED);
+      }
     });
+  });
 });

package/dist/tools/plan-review-tool.cjs

@@ -0,0 +1,98 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plan_review_tool_exports = {};
+__export(plan_review_tool_exports, {
+  createPlanReviewTool: () => createPlanReviewTool
+});
+module.exports = __toCommonJS(plan_review_tool_exports);
+var import_zod = require("zod");
+var import_core = require("@dexto/core");
+var import_errors = require("../errors.js");
+const PlanReviewInputSchema = import_zod.z.object({
+  summary: import_zod.z.string().optional().describe("Brief summary of the plan for context (shown above the plan content)")
+}).strict();
+function createPlanReviewTool(getPlanService) {
+  return (0, import_core.defineTool)({
+    id: "plan_review",
+    description: "Request user review of the current plan. Shows the full plan content for review with options to approve, request changes, or reject. Use after creating or updating a plan to get user approval before implementation.",
+    inputSchema: PlanReviewInputSchema,
+    presentation: {
+      describeHeader: (input) => (0, import_core.createLocalToolCallHeader)({
+        title: "Review Plan",
+        ...input.summary ? { argsText: (0, import_core.truncateForHeader)(input.summary, 140) } : {}
+      }),
+      /**
+       * Generate preview showing the plan content for review.
+       * The ApprovalPrompt component detects plan_review and shows custom options.
+       */
+      preview: async (input, context) => {
+        const resolvedPlanService = await getPlanService(context);
+        const { summary } = input;
+        if (!context.sessionId) {
+          throw import_errors.PlanError.sessionIdRequired();
+        }
+        const plan = await resolvedPlanService.read(context.sessionId);
+        if (!plan) {
+          throw import_errors.PlanError.planNotFound(context.sessionId);
+        }
+        let displayContent = plan.content;
+        if (summary) {
+          displayContent = `## Summary
+${summary}
+
+---
+
+${plan.content}`;
+        }
+        const lineCount = displayContent.split("\n").length;
+        const planPath = resolvedPlanService.getPlanPath(context.sessionId);
+        return {
+          type: "file",
+          title: "Review Plan",
+          path: planPath,
+          operation: "read",
+          // 'read' indicates this is for viewing, not creating/modifying
+          content: displayContent,
+          size: Buffer.byteLength(displayContent, "utf8"),
+          lineCount
+        };
+      }
+    },
+    async execute(_input, context) {
+      const resolvedPlanService = await getPlanService(context);
+      if (!context.sessionId) {
+        throw import_errors.PlanError.sessionIdRequired();
+      }
+      const plan = await resolvedPlanService.read(context.sessionId);
+      if (!plan) {
+        throw import_errors.PlanError.planNotFound(context.sessionId);
+      }
+      await resolvedPlanService.updateMeta(context.sessionId, { status: "approved" });
+      return {
+        approved: true,
+        message: "Plan approved. You may now proceed with implementation.",
+        planStatus: "approved"
+      };
+    }
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPlanReviewTool
+});

package/dist/tools/plan-review-tool.d.ts

@@ -8,15 +8,24 @@
  * - Request Changes: Provide feedback for iteration
  * - Reject: Reject the plan entirely
  *
- * Uses the tool confirmation pattern (not elicitation) so the user
+ * Uses the tool approval pattern (not elicitation) so the user
  * can see the full plan content before deciding.
  */
-import type { InternalTool } from '@dexto/core';
-import type { PlanService } from '../plan-service.js';
+import { z } from 'zod';
+import type { Tool } from '@dexto/core';
+import type { PlanServiceGetter } from '../plan-service-getter.js';
+declare const PlanReviewInputSchema: z.ZodObject<{
+    summary: z.ZodOptional<z.ZodString>;
+}, "strict", z.ZodTypeAny, {
+    summary?: string | undefined;
+}, {
+    summary?: string | undefined;
+}>;
 /**
  * Creates the plan_review tool
  *
- * @param planService - Service for plan operations
+ * @param getPlanService - Getter for the plan service
  */
-export declare function createPlanReviewTool(planService: PlanService): InternalTool;
+export declare function createPlanReviewTool(getPlanService: PlanServiceGetter): Tool<typeof PlanReviewInputSchema>;
+export {};
 //# sourceMappingURL=plan-review-tool.d.ts.map

package/dist/tools/plan-review-tool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plan-review-tool.d.ts","sourceRoot":"","sources":["../../src/tools/plan-review-tool.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAyC,MAAM,aAAa,CAAC;AACvF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AActD;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,CAoE3E"}
+{"version":3,"file":"plan-review-tool.d.ts","sourceRoot":"","sources":["../../src/tools/plan-review-tool.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,IAAI,EAAyC,MAAM,aAAa,CAAC;AAC/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,QAAA,MAAM,qBAAqB;;;;;;EAOd,CAAC;AAEd;;;;GAIG;AACH,wBAAgB,oBAAoB,CAChC,cAAc,EAAE,iBAAiB,GAClC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CA2EpC"}

package/dist/tools/plan-review-tool.js

@@ -1,84 +1,74 @@
-/**
- * Plan Review Tool
- *
- * Requests user review of the current plan.
- * Shows the plan content for review with approval options:
- * - Approve: Proceed with implementation
- * - Approve + Accept Edits: Proceed and auto-approve file edits
- * - Request Changes: Provide feedback for iteration
- * - Reject: Reject the plan entirely
- *
- * Uses the tool confirmation pattern (not elicitation) so the user
- * can see the full plan content before deciding.
- */
-import { z } from 'zod';
-import { PlanError } from '../errors.js';
-const PlanReviewInputSchema = z
-    .object({
-    summary: z
-        .string()
-        .optional()
-        .describe('Brief summary of the plan for context (shown above the plan content)'),
-})
-    .strict();
-/**
- * Creates the plan_review tool
- *
- * @param planService - Service for plan operations
- */
-export function createPlanReviewTool(planService) {
-    return {
-        id: 'plan_review',
-        description: 'Request user review of the current plan. Shows the full plan content for review with options to approve, request changes, or reject. Use after creating or updating a plan to get user approval before implementation.',
-        inputSchema: PlanReviewInputSchema,
-        /**
-         * Generate preview showing the plan content for review.
-         * The ApprovalPrompt component detects plan_review and shows custom options.
-         */
-        generatePreview: async (input, context) => {
-            const { summary } = input;
-            if (!context?.sessionId) {
-                throw PlanError.sessionIdRequired();
-            }
-            // Read the current plan
-            const plan = await planService.read(context.sessionId);
-            if (!plan) {
-                throw PlanError.planNotFound(context.sessionId);
-            }
-            // Build content with optional summary header
-            let displayContent = plan.content;
-            if (summary) {
-                displayContent = `## Summary\n${summary}\n\n---\n\n${plan.content}`;
-            }
-            const lineCount = displayContent.split('\n').length;
-            const planPath = planService.getPlanPath(context.sessionId);
-            return {
-                type: 'file',
-                path: planPath,
-                operation: 'read', // 'read' indicates this is for viewing, not creating/modifying
-                content: displayContent,
-                size: Buffer.byteLength(displayContent, 'utf8'),
-                lineCount,
-            };
-        },
-        execute: async (_input, context) => {
-            // Tool execution means user approved the plan (selected Approve or Approve + Accept Edits)
-            // Request Changes and Reject are handled as denials in the approval flow
-            if (!context?.sessionId) {
-                throw PlanError.sessionIdRequired();
-            }
-            // Read plan to verify it still exists
-            const plan = await planService.read(context.sessionId);
-            if (!plan) {
-                throw PlanError.planNotFound(context.sessionId);
-            }
-            // Update plan status to approved
-            await planService.updateMeta(context.sessionId, { status: 'approved' });
-            return {
-                approved: true,
-                message: 'Plan approved. You may now proceed with implementation.',
-                planStatus: 'approved',
-            };
-        },
-    };
+import { z } from "zod";
+import { createLocalToolCallHeader, defineTool, truncateForHeader } from "@dexto/core";
+import { PlanError } from "../errors.js";
+const PlanReviewInputSchema = z.object({
+  summary: z.string().optional().describe("Brief summary of the plan for context (shown above the plan content)")
+}).strict();
+function createPlanReviewTool(getPlanService) {
+  return defineTool({
+    id: "plan_review",
+    description: "Request user review of the current plan. Shows the full plan content for review with options to approve, request changes, or reject. Use after creating or updating a plan to get user approval before implementation.",
+    inputSchema: PlanReviewInputSchema,
+    presentation: {
+      describeHeader: (input) => createLocalToolCallHeader({
+        title: "Review Plan",
+        ...input.summary ? { argsText: truncateForHeader(input.summary, 140) } : {}
+      }),
+      /**
+       * Generate preview showing the plan content for review.
+       * The ApprovalPrompt component detects plan_review and shows custom options.
+       */
+      preview: async (input, context) => {
+        const resolvedPlanService = await getPlanService(context);
+        const { summary } = input;
+        if (!context.sessionId) {
+          throw PlanError.sessionIdRequired();
+        }
+        const plan = await resolvedPlanService.read(context.sessionId);
+        if (!plan) {
+          throw PlanError.planNotFound(context.sessionId);
+        }
+        let displayContent = plan.content;
+        if (summary) {
+          displayContent = `## Summary
+${summary}
+
+---
+
+${plan.content}`;
+        }
+        const lineCount = displayContent.split("\n").length;
+        const planPath = resolvedPlanService.getPlanPath(context.sessionId);
+        return {
+          type: "file",
+          title: "Review Plan",
+          path: planPath,
+          operation: "read",
+          // 'read' indicates this is for viewing, not creating/modifying
+          content: displayContent,
+          size: Buffer.byteLength(displayContent, "utf8"),
+          lineCount
+        };
+      }
+    },
+    async execute(_input, context) {
+      const resolvedPlanService = await getPlanService(context);
+      if (!context.sessionId) {
+        throw PlanError.sessionIdRequired();
+      }
+      const plan = await resolvedPlanService.read(context.sessionId);
+      if (!plan) {
+        throw PlanError.planNotFound(context.sessionId);
+      }
+      await resolvedPlanService.updateMeta(context.sessionId, { status: "approved" });
+      return {
+        approved: true,
+        message: "Plan approved. You may now proceed with implementation.",
+        planStatus: "approved"
+      };
+    }
+  });
 }
+export {
+  createPlanReviewTool
+};

package/dist/tools/plan-update-tool.cjs

@@ -0,0 +1,92 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var plan_update_tool_exports = {};
+__export(plan_update_tool_exports, {
+  createPlanUpdateTool: () => createPlanUpdateTool
+});
+module.exports = __toCommonJS(plan_update_tool_exports);
+var import_zod = require("zod");
+var import_diff = require("diff");
+var import_core = require("@dexto/core");
+var import_errors = require("../errors.js");
+const PlanUpdateInputSchema = import_zod.z.object({
+  content: import_zod.z.string().describe("Updated plan content in markdown format")
+}).strict();
+function generateDiffPreview(filePath, originalContent, newContent) {
+  const unified = (0, import_diff.createPatch)(filePath, originalContent, newContent, "before", "after", {
+    context: 3
+  });
+  const additions = (unified.match(/^\+[^+]/gm) || []).length;
+  const deletions = (unified.match(/^-[^-]/gm) || []).length;
+  return {
+    type: "diff",
+    title: "Update Plan",
+    unified,
+    filename: filePath,
+    additions,
+    deletions
+  };
+}
+function createPlanUpdateTool(getPlanService) {
+  return (0, import_core.defineTool)({
+    id: "plan_update",
+    description: "Update the existing implementation plan for this session. Shows a diff preview for approval before saving. The plan must already exist (use plan_create first).",
+    inputSchema: PlanUpdateInputSchema,
+    presentation: {
+      describeHeader: () => (0, import_core.createLocalToolCallHeader)({
+        title: "Update Plan"
+      }),
+      /**
+       * Generate diff preview for approval UI
+       */
+      preview: async (input, context) => {
+        const resolvedPlanService = await getPlanService(context);
+        const { content: newContent } = input;
+        if (!context.sessionId) {
+          throw import_errors.PlanError.sessionIdRequired();
+        }
+        const existing = await resolvedPlanService.read(context.sessionId);
+        if (!existing) {
+          throw import_errors.PlanError.planNotFound(context.sessionId);
+        }
+        const planPath = resolvedPlanService.getPlanPath(context.sessionId);
+        return generateDiffPreview(planPath, existing.content, newContent);
+      }
+    },
+    async execute(input, context) {
+      const resolvedPlanService = await getPlanService(context);
+      const { content } = input;
+      if (!context.sessionId) {
+        throw import_errors.PlanError.sessionIdRequired();
+      }
+      const result = await resolvedPlanService.update(context.sessionId, content);
+      const planPath = resolvedPlanService.getPlanPath(context.sessionId);
+      return {
+        success: true,
+        path: planPath,
+        status: result.meta.status,
+        _display: generateDiffPreview(planPath, result.oldContent, result.newContent)
+      };
+    }
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPlanUpdateTool
+});

package/dist/tools/plan-update-tool.d.ts

@@ -4,10 +4,19 @@
  * Updates the implementation plan for the current session.
  * Shows a diff preview for approval before saving.
  */
-import type { InternalTool } from '@dexto/core';
-import type { PlanService } from '../plan-service.js';
+import { z } from 'zod';
+import type { Tool } from '@dexto/core';
+import type { PlanServiceGetter } from '../plan-service-getter.js';
+declare const PlanUpdateInputSchema: z.ZodObject<{
+    content: z.ZodString;
+}, "strict", z.ZodTypeAny, {
+    content: string;
+}, {
+    content: string;
+}>;
 /**
  * Creates the plan_update tool
  */
-export declare function createPlanUpdateTool(planService: PlanService): InternalTool;
+export declare function createPlanUpdateTool(getPlanService: PlanServiceGetter): Tool<typeof PlanUpdateInputSchema>;
+export {};
 //# sourceMappingURL=plan-update-tool.d.ts.map

package/dist/tools/plan-update-tool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plan-update-tool.d.ts","sourceRoot":"","sources":["../../src/tools/plan-update-tool.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAIH,OAAO,KAAK,EAAE,YAAY,EAAyC,MAAM,aAAa,CAAC;AACvF,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAkCtD;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,CAiD3E"}
+{"version":3,"file":"plan-update-tool.d.ts","sourceRoot":"","sources":["../../src/tools/plan-update-tool.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,OAAO,KAAK,EAAE,IAAI,EAAyC,MAAM,aAAa,CAAC;AAC/E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,QAAA,MAAM,qBAAqB;;;;;;EAId,CAAC;AA0Bd;;GAEG;AACH,wBAAgB,oBAAoB,CAChC,cAAc,EAAE,iBAAiB,GAClC,IAAI,CAAC,OAAO,qBAAqB,CAAC,CAsDpC"}