@dexto/tools-plan 1.5.8 → 1.6.1

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

@@ -1,118 +1,151 @@
-/**
- * Plan Create Tool Tests
- *
- * Tests for the plan_create tool including preview generation.
- */
-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 { createPlanCreateTool } from './plan-create-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 { createPlanCreateTool } from "./plan-create-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_create tool', () => {
-    let mockLogger;
-    let tempDir;
-    let planService;
-    beforeEach(async () => {
-        mockLogger = createMockLogger();
-        // Create temp directory for testing
-        const rawTempDir = await fs.mkdtemp(path.join(os.tmpdir(), 'dexto-plan-create-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_create tool", () => {
+  let logger;
+  let tempDir;
+  let planService;
+  beforeEach(async () => {
+    logger = createMockLogger();
+    const rawTempDir = await fs.mkdtemp(path.join(os.tmpdir(), "dexto-plan-create-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("generatePreview", () => {
+    it("should return FileDisplayData for new plan", async () => {
+      const tool = createPlanCreateTool(async () => planService);
+      const sessionId = "test-session";
+      const content = "# Implementation Plan\n\n## Steps\n1. First step";
+      const previewFn = tool.presentation?.preview;
+      expect(previewFn).toBeDefined();
+      const preview = await previewFn(
+        { title: "Test Plan", content },
+        createToolContext(logger, { sessionId })
+      );
+      expect(preview.type).toBe("file");
+      expect(preview.title).toBe("Create Plan");
+      expect(preview.operation).toBe("create");
+      expect(preview.path).toContain(sessionId);
+      expect(preview.path).toMatch(/plan\.md$/);
+      expect(preview.content).toBe(content);
+      expect(preview.lineCount).toBe(4);
+    });
+    it("should throw error when sessionId is missing", async () => {
+      const tool = createPlanCreateTool(async () => planService);
+      const previewFn = tool.presentation?.preview;
+      expect(previewFn).toBeDefined();
+      try {
+        await previewFn({ title: "Test", content: "# Plan" }, createToolContext(logger));
+        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 plan already exists", async () => {
+      const tool = createPlanCreateTool(async () => planService);
+      const sessionId = "test-session";
+      const previewFn = tool.presentation?.preview;
+      expect(previewFn).toBeDefined();
+      await planService.create(sessionId, "# Existing Plan");
+      try {
+        await previewFn(
+          { title: "New Plan", content: "# New Content" },
+          createToolContext(logger, { sessionId })
+        );
+        expect.fail("Should have thrown an error");
+      } catch (error) {
+        expect(error).toBeInstanceOf(DextoRuntimeError);
+        expect(error.code).toBe(PlanErrorCode.PLAN_ALREADY_EXISTS);
+      }
+    });
+  });
+  describe("execute", () => {
+    it("should create plan and return success", async () => {
+      const tool = createPlanCreateTool(async () => planService);
+      const sessionId = "test-session";
+      const content = "# Implementation Plan";
+      const title = "My Plan";
+      const result = await tool.execute(
+        { title, content },
+        createToolContext(logger, { sessionId })
+      );
+      expect(result.success).toBe(true);
+      expect(result.path).toContain(sessionId);
+      expect(result.path).toMatch(/plan\.md$/);
+      expect(result.status).toBe("draft");
+      expect(result.title).toBe(title);
     });
-    afterEach(async () => {
-        try {
-            await fs.rm(tempDir, { recursive: true, force: true });
-        }
-        catch {
-            // Ignore cleanup errors
-        }
+    it("should throw error when plan already exists", async () => {
+      const tool = createPlanCreateTool(async () => planService);
+      const sessionId = "test-session";
+      await planService.create(sessionId, "# Existing Plan");
+      try {
+        await tool.execute(
+          { title: "New Plan", content: "# New content" },
+          createToolContext(logger, { sessionId })
+        );
+        expect.fail("Should have thrown an error");
+      } catch (error) {
+        expect(error).toBeInstanceOf(DextoRuntimeError);
+        expect(error.code).toBe(PlanErrorCode.PLAN_ALREADY_EXISTS);
+      }
     });
-    describe('generatePreview', () => {
-        it('should return FileDisplayData for new plan', async () => {
-            const tool = createPlanCreateTool(planService);
-            const sessionId = 'test-session';
-            const content = '# Implementation Plan\n\n## Steps\n1. First step';
-            const preview = (await tool.generatePreview({ title: 'Test Plan', content }, { sessionId }));
-            expect(preview.type).toBe('file');
-            expect(preview.operation).toBe('create');
-            // Path is now absolute, check it ends with the expected suffix
-            expect(preview.path).toContain(sessionId);
-            expect(preview.path).toMatch(/plan\.md$/);
-            expect(preview.content).toBe(content);
-            expect(preview.lineCount).toBe(4);
-        });
-        it('should throw error when sessionId is missing', async () => {
-            const tool = createPlanCreateTool(planService);
-            try {
-                await tool.generatePreview({ title: 'Test', content: '# Plan' }, {});
-                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 plan already exists', async () => {
-            const tool = createPlanCreateTool(planService);
-            const sessionId = 'test-session';
-            // Create existing plan
-            await planService.create(sessionId, '# Existing Plan');
-            try {
-                await tool.generatePreview({ title: 'New Plan', content: '# New Content' }, { sessionId });
-                expect.fail('Should have thrown an error');
-            }
-            catch (error) {
-                expect(error).toBeInstanceOf(DextoRuntimeError);
-                expect(error.code).toBe(PlanErrorCode.PLAN_ALREADY_EXISTS);
-            }
-        });
+    it("should throw error when sessionId is missing", async () => {
+      const tool = createPlanCreateTool(async () => planService);
+      try {
+        await tool.execute({ title: "Test", content: "# Plan" }, createToolContext(logger));
+        expect.fail("Should have thrown an error");
+      } catch (error) {
+        expect(error).toBeInstanceOf(DextoRuntimeError);
+        expect(error.code).toBe(PlanErrorCode.SESSION_ID_REQUIRED);
+      }
     });
-    describe('execute', () => {
-        it('should create plan and return success', async () => {
-            const tool = createPlanCreateTool(planService);
-            const sessionId = 'test-session';
-            const content = '# Implementation Plan';
-            const title = 'My Plan';
-            const result = (await tool.execute({ title, content }, { sessionId }));
-            expect(result.success).toBe(true);
-            // Path is now absolute, check it ends with the expected suffix
-            expect(result.path).toContain(sessionId);
-            expect(result.path).toMatch(/plan\.md$/);
-            expect(result.status).toBe('draft');
-            expect(result.title).toBe(title);
-        });
-        it('should throw error when sessionId is missing', async () => {
-            const tool = createPlanCreateTool(planService);
-            try {
-                await tool.execute({ title: 'Test', content: '# Plan' }, {});
-                expect.fail('Should have thrown an error');
-            }
-            catch (error) {
-                expect(error).toBeInstanceOf(DextoRuntimeError);
-                expect(error.code).toBe(PlanErrorCode.SESSION_ID_REQUIRED);
-            }
-        });
-        it('should include _display data in result', async () => {
-            const tool = createPlanCreateTool(planService);
-            const sessionId = 'test-session';
-            const content = '# Plan\n## Steps';
-            const result = (await tool.execute({ title: 'Plan', content }, { sessionId }));
-            expect(result._display).toBeDefined();
-            expect(result._display.type).toBe('file');
-            expect(result._display.operation).toBe('create');
-            expect(result._display.lineCount).toBe(2);
-        });
+    it("should include _display data in result", async () => {
+      const tool = createPlanCreateTool(async () => planService);
+      const sessionId = "test-session";
+      const content = "# Plan\n## Steps";
+      const result = await tool.execute(
+        { title: "Plan", content },
+        createToolContext(logger, { sessionId })
+      );
+      expect(result._display).toBeDefined();
+      expect(result._display.type).toBe("file");
+      expect(result._display.title).toBe("Create Plan");
+      expect(result._display.operation).toBe("create");
+      expect(result._display.lineCount).toBe(2);
     });
+  });
 });

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

@@ -0,0 +1,65 @@
+"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_read_tool_exports = {};
+__export(plan_read_tool_exports, {
+  createPlanReadTool: () => createPlanReadTool
+});
+module.exports = __toCommonJS(plan_read_tool_exports);
+var import_zod = require("zod");
+var import_core = require("@dexto/core");
+var import_errors = require("../errors.js");
+const PlanReadInputSchema = import_zod.z.object({}).strict();
+function createPlanReadTool(getPlanService) {
+  return (0, import_core.defineTool)({
+    id: "plan_read",
+    description: "Read the current implementation plan for this session. Returns the plan content and metadata including status. Use markdown checkboxes (- [ ] and - [x]) in the content to track progress.",
+    inputSchema: PlanReadInputSchema,
+    presentation: {
+      describeHeader: () => (0, import_core.createLocalToolCallHeader)({
+        title: "Read Plan"
+      })
+    },
+    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) {
+        return {
+          exists: false,
+          message: `No plan found for this session. Use plan_create to create one.`
+        };
+      }
+      return {
+        exists: true,
+        path: resolvedPlanService.getPlanPath(context.sessionId),
+        content: plan.content,
+        status: plan.meta.status,
+        title: plan.meta.title,
+        createdAt: new Date(plan.meta.createdAt).toISOString(),
+        updatedAt: new Date(plan.meta.updatedAt).toISOString()
+      };
+    }
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createPlanReadTool
+});

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

@@ -4,10 +4,13 @@
  * Reads the current implementation plan for the session.
  * No approval needed - read-only operation.
  */
-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 PlanReadInputSchema: z.ZodObject<{}, "strict", z.ZodTypeAny, {}, {}>;
 /**
  * Creates the plan_read tool
  */
-export declare function createPlanReadTool(planService: PlanService): InternalTool;
+export declare function createPlanReadTool(getPlanService: PlanServiceGetter): Tool<typeof PlanReadInputSchema>;
+export {};
 //# sourceMappingURL=plan-read-tool.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"plan-read-tool.d.ts","sourceRoot":"","sources":["../../src/tools/plan-read-tool.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,KAAK,EAAE,YAAY,EAAwB,MAAM,aAAa,CAAC;AACtE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAKtD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,WAAW,GAAG,YAAY,CAgCzE"}
+{"version":3,"file":"plan-read-tool.d.ts","sourceRoot":"","sources":["../../src/tools/plan-read-tool.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,KAAK,EAAE,IAAI,EAAwB,MAAM,aAAa,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAGnE,QAAA,MAAM,mBAAmB,iDAAwB,CAAC;AAElD;;GAEG;AACH,wBAAgB,kBAAkB,CAC9B,cAAc,EAAE,iBAAiB,GAClC,IAAI,CAAC,OAAO,mBAAmB,CAAC,CAuClC"}

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

@@ -1,40 +1,41 @@
-/**
- * Plan Read Tool
- *
- * Reads the current implementation plan for the session.
- * No approval needed - read-only operation.
- */
-import { z } from 'zod';
-import { PlanError } from '../errors.js';
+import { z } from "zod";
+import { createLocalToolCallHeader, defineTool } from "@dexto/core";
+import { PlanError } from "../errors.js";
 const PlanReadInputSchema = z.object({}).strict();
-/**
- * Creates the plan_read tool
- */
-export function createPlanReadTool(planService) {
-    return {
-        id: 'plan_read',
-        description: 'Read the current implementation plan for this session. Returns the plan content and metadata including status. Use markdown checkboxes (- [ ] and - [x]) in the content to track progress.',
-        inputSchema: PlanReadInputSchema,
-        execute: async (_input, context) => {
-            if (!context?.sessionId) {
-                throw PlanError.sessionIdRequired();
-            }
-            const plan = await planService.read(context.sessionId);
-            if (!plan) {
-                return {
-                    exists: false,
-                    message: `No plan found for this session. Use plan_create to create one.`,
-                };
-            }
-            return {
-                exists: true,
-                path: `.dexto/plans/${context.sessionId}/plan.md`,
-                content: plan.content,
-                status: plan.meta.status,
-                title: plan.meta.title,
-                createdAt: new Date(plan.meta.createdAt).toISOString(),
-                updatedAt: new Date(plan.meta.updatedAt).toISOString(),
-            };
-        },
-    };
+function createPlanReadTool(getPlanService) {
+  return defineTool({
+    id: "plan_read",
+    description: "Read the current implementation plan for this session. Returns the plan content and metadata including status. Use markdown checkboxes (- [ ] and - [x]) in the content to track progress.",
+    inputSchema: PlanReadInputSchema,
+    presentation: {
+      describeHeader: () => createLocalToolCallHeader({
+        title: "Read Plan"
+      })
+    },
+    async execute(_input, context) {
+      const resolvedPlanService = await getPlanService(context);
+      if (!context.sessionId) {
+        throw PlanError.sessionIdRequired();
+      }
+      const plan = await resolvedPlanService.read(context.sessionId);
+      if (!plan) {
+        return {
+          exists: false,
+          message: `No plan found for this session. Use plan_create to create one.`
+        };
+      }
+      return {
+        exists: true,
+        path: resolvedPlanService.getPlanPath(context.sessionId),
+        content: plan.content,
+        status: plan.meta.status,
+        title: plan.meta.title,
+        createdAt: new Date(plan.meta.createdAt).toISOString(),
+        updatedAt: new Date(plan.meta.updatedAt).toISOString()
+      };
+    }
+  });
 }
+export {
+  createPlanReadTool
+};

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

@@ -0,0 +1,109 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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 __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var import_vitest = require("vitest");
+var path = __toESM(require("node:path"), 1);
+var fs = __toESM(require("node:fs/promises"), 1);
+var os = __toESM(require("node:os"), 1);
+var import_plan_read_tool = require("./plan-read-tool.js");
+var import_plan_service = require("../plan-service.js");
+var import_errors = require("../errors.js");
+var import_core = require("@dexto/core");
+const createMockLogger = () => {
+  const logger = {
+    debug: import_vitest.vi.fn(),
+    silly: import_vitest.vi.fn(),
+    info: import_vitest.vi.fn(),
+    warn: import_vitest.vi.fn(),
+    error: import_vitest.vi.fn(),
+    trackException: import_vitest.vi.fn(),
+    createChild: import_vitest.vi.fn(() => logger),
+    createFileOnlyChild: import_vitest.vi.fn(() => logger),
+    setLevel: import_vitest.vi.fn(),
+    getLevel: import_vitest.vi.fn(() => "debug"),
+    getLogFilePath: import_vitest.vi.fn(() => null),
+    destroy: import_vitest.vi.fn(async () => void 0)
+  };
+  return logger;
+};
+function createToolContext(logger, overrides = {}) {
+  return { logger, ...overrides };
+}
+(0, import_vitest.describe)("plan_read tool", () => {
+  let logger;
+  let tempDir;
+  let planService;
+  (0, import_vitest.beforeEach)(async () => {
+    logger = createMockLogger();
+    const rawTempDir = await fs.mkdtemp(path.join(os.tmpdir(), "dexto-plan-read-test-"));
+    tempDir = await fs.realpath(rawTempDir);
+    planService = new import_plan_service.PlanService({ basePath: tempDir }, logger);
+    import_vitest.vi.clearAllMocks();
+  });
+  (0, import_vitest.afterEach)(async () => {
+    try {
+      await fs.rm(tempDir, { recursive: true, force: true });
+    } catch {
+    }
+  });
+  (0, import_vitest.describe)("execute", () => {
+    (0, import_vitest.it)("should return exists: false when no plan exists", async () => {
+      const tool = (0, import_plan_read_tool.createPlanReadTool)(async () => planService);
+      const sessionId = "test-session";
+      const result = await tool.execute({}, createToolContext(logger, { sessionId }));
+      (0, import_vitest.expect)(result.exists).toBe(false);
+      (0, import_vitest.expect)(result.message).toContain("No plan found");
+    });
+    (0, import_vitest.it)("should return plan content and metadata when plan exists", async () => {
+      const tool = (0, import_plan_read_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 }));
+      (0, import_vitest.expect)(result.exists).toBe(true);
+      (0, import_vitest.expect)(result.content).toBe(content);
+      (0, import_vitest.expect)(result.status).toBe("draft");
+      (0, import_vitest.expect)(result.title).toBe(title);
+      (0, import_vitest.expect)(result.path).toBe(path.join(tempDir, sessionId, "plan.md"));
+    });
+    (0, import_vitest.it)("should return ISO timestamps", async () => {
+      const tool = (0, import_plan_read_tool.createPlanReadTool)(async () => planService);
+      const sessionId = "test-session";
+      await planService.create(sessionId, "# Plan");
+      const result = await tool.execute({}, createToolContext(logger, { sessionId }));
+      (0, import_vitest.expect)(result.createdAt).toMatch(/^\d{4}-\d{2}-\d{2}T/);
+      (0, import_vitest.expect)(result.updatedAt).toMatch(/^\d{4}-\d{2}-\d{2}T/);
+    });
+    (0, import_vitest.it)("should throw error when sessionId is missing", async () => {
+      const tool = (0, import_plan_read_tool.createPlanReadTool)(async () => planService);
+      try {
+        await tool.execute({}, createToolContext(logger));
+        import_vitest.expect.fail("Should have thrown an error");
+      } catch (error) {
+        (0, import_vitest.expect)(error).toBeInstanceOf(import_core.DextoRuntimeError);
+        (0, import_vitest.expect)(error.code).toBe(import_errors.PlanErrorCode.SESSION_ID_REQUIRED);
+      }
+    });
+  });
+});