yarlo-plugin-board 0.2.0 → 0.2.1

package/dist/index.js

@@ -41,7 +41,7 @@ function openBrowser(url) {
 }
 const plugin = {
     name: "board",
-    version: "0.2.0",
+    version: "0.2.1",
     description: "Kanban board view for yarlo tasks",
     commands: [
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "yarlo-plugin-board",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -15,7 +15,7 @@
     "@hono/node-server": "^1.13.0",
     "hono": "^4.7.0",
     "zod": "^3.24.0",
-    "yarlo-types": "0.1.2"
+    "yarlo-types": "0.1.3"
   },
   "devDependencies": {
     "@types/node": "^22.0.0",

package/source/board-server.test.ts

@@ -0,0 +1,164 @@
+import { describe, expect, it, vi } from "vitest";
+import type {
+  Task,
+  UpdateTaskInput,
+  YarloConfig,
+  YarloPluginContext,
+} from "yarlo-types";
+import { DEFAULT_CONFIG } from "yarlo-types";
+import { createBoardApp } from "./board-server.js";
+
+/**
+ * Minimal task fixture for API serialization tests.
+ */
+function baseTask(overrides: Partial<Task> = {}): Task {
+  return {
+    id: "t1",
+    title: "Task",
+    content: "Body",
+    fields: { status: "backlog", priority: "low" },
+    created_at: "2024-01-01T00:00:00.000Z",
+    updated_at: "2024-01-02T00:00:00.000Z",
+    file_path: "/tmp/t1.md",
+    ...overrides,
+  };
+}
+
+/**
+ * Builds a plugin context with default mocked task operations.
+ */
+function mockContext(
+  overrides: Partial<YarloPluginContext> = {},
+): YarloPluginContext {
+  const config: YarloConfig = {
+    ...DEFAULT_CONFIG,
+    yarlo_version: "0.1.0",
+  };
+  const task = baseTask();
+  const ctx: YarloPluginContext = {
+    config,
+    configDir: "/c",
+    projectDir: "/p",
+    tasks: {
+      list: vi.fn(async () => [task]),
+      get: vi.fn(async (id: string) => {
+        if (id === "t1") return task;
+        throw new Error(`Task "${id}" not found`);
+      }),
+      create: vi.fn(),
+      update: vi.fn(async (_id: string, input: UpdateTaskInput) => ({
+        ...task,
+        title: input.title ?? task.title,
+        content: input.content ?? task.content,
+        fields: { ...task.fields, ...(input.fields ?? {}) },
+        updated_at: "2024-01-03T00:00:00.000Z",
+      })),
+      delete: vi.fn(),
+    },
+    ...overrides,
+  };
+  return ctx;
+}
+
+describe("createBoardApp", () => {
+  it("GET /api/board returns columns, tasks, and fieldDefinitions", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/api/board");
+    expect(res.status).toBe(200);
+    const json = (await res.json()) as {
+      columns: string[];
+      tasks: Array<{ id: string; title: string }>;
+      fieldDefinitions: unknown[];
+    };
+    expect(json.columns).toContain("backlog");
+    expect(json.tasks).toHaveLength(1);
+    expect(json.tasks[0]!.id).toBe("t1");
+    expect(json.fieldDefinitions).toEqual(ctx.config.fields);
+    expect(ctx.tasks.list).toHaveBeenCalledOnce();
+  });
+
+  it("GET /api/tasks/:id returns 200 when task exists", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/api/tasks/t1");
+    expect(res.status).toBe(200);
+    const json = (await res.json()) as { task: { id: string; title: string } };
+    expect(json.task.id).toBe("t1");
+    expect(json.task.title).toBe("Task");
+  });
+
+  it("GET /api/tasks/:id returns 404 when task is missing", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/api/tasks/missing");
+    expect(res.status).toBe(404);
+  });
+
+  it("PATCH /api/tasks/:id returns 400 for invalid JSON", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/api/tasks/t1", {
+      method: "PATCH",
+      headers: { "Content-Type": "application/json" },
+      body: "not-json{",
+    });
+    expect(res.status).toBe(400);
+  });
+
+  it("PATCH /api/tasks/:id returns 400 when body has no updatable fields", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/api/tasks/t1", {
+      method: "PATCH",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({}),
+    });
+    expect(res.status).toBe(400);
+  });
+
+  it("PATCH /api/tasks/:id returns 400 for invalid status value", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/api/tasks/t1", {
+      method: "PATCH",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ status: "__not_a_column__" }),
+    });
+    expect(res.status).toBe(400);
+    const json = (await res.json()) as { error: string };
+    expect(json.error).toMatch(/Invalid status/i);
+  });
+
+  it("PATCH /api/tasks/:id returns updated task when title is sent", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/api/tasks/t1", {
+      method: "PATCH",
+      headers: { "Content-Type": "application/json" },
+      body: JSON.stringify({ title: "Renamed" }),
+    });
+    expect(res.status).toBe(200);
+    const json = (await res.json()) as { task: { title: string } };
+    expect(json.task.title).toBe("Renamed");
+    expect(ctx.tasks.update).toHaveBeenCalledWith("t1", { title: "Renamed" });
+  });
+
+  it("GET / serves board-ui.html", async () => {
+    const ctx = mockContext();
+    const app = createBoardApp(ctx);
+
+    const res = await app.request("http://localhost/");
+    expect(res.status).toBe(200);
+    const text = await res.text();
+    expect(text.length).toBeGreaterThan(100);
+    expect(text).toMatch(/html/i);
+  });
+});

package/source/board-server.ts

@@ -3,12 +3,24 @@ import path from "node:path";
 import { fileURLToPath } from "node:url";
 import { Hono } from "hono";
 import { z } from "zod";
-import type { Task, YarloPluginContext } from "yarlo-types";
+import type { FieldDefinition, Task, UpdateTaskInput, YarloPluginContext } from "yarlo-types";
 import { getStatusColumnOptions } from "./status-field.js";
 
-const patchBodySchema = z.object({
-  status: z.string().min(1),
-});
+const patchBodySchema = z
+  .object({
+    status: z.string().min(1).optional(),
+    title: z.string().optional(),
+    content: z.string().optional(),
+    fields: z.record(z.unknown()).optional(),
+  })
+  .refine(
+    (d) =>
+      d.status !== undefined ||
+      d.title !== undefined ||
+      d.content !== undefined ||
+      d.fields !== undefined,
+    { message: "At least one of status, title, content, or fields is required" },
+  );
 
 export type BoardTaskJson = {
   id: string;
@@ -22,6 +34,15 @@ export type BoardTaskJson = {
   updated_at: string;
 };
 
+export type BoardTaskDetailJson = {
+  id: string;
+  title: string;
+  content: string;
+  fields: Record<string, unknown>;
+  created_at: string;
+  updated_at: string;
+};
+
 /**
  * Maps a task to a JSON-safe shape for the board UI (no file paths).
  *
@@ -43,6 +64,31 @@ function serializeBoardTask(task: Task): BoardTaskJson {
   };
 }
 
+/**
+ * Full task payload for detail view and PATCH responses (no file_path).
+ *
+ * @param task - Task from yarlo storage
+ * @returns Serializable task detail
+ */
+function serializeBoardTaskDetail(task: Task): BoardTaskDetailJson {
+  return {
+    id: task.id,
+    title: task.title,
+    content: task.content,
+    fields: { ...task.fields },
+    created_at: task.created_at,
+    updated_at: task.updated_at,
+  };
+}
+
+function isNotFoundMessage(msg: string): boolean {
+  return (
+    msg.includes("not found") ||
+    msg.includes("Ambiguous ID") ||
+    msg.includes("Ambiguous")
+  );
+}
+
 /**
  * Builds the Hono app for the local board (HTML UI + JSON API).
  *
@@ -62,12 +108,28 @@ export function createBoardApp(ctx: YarloPluginContext): Hono {
   app.get("/api/board", async (c) => {
     const columns = getStatusColumnOptions(ctx.config);
     const tasks = await ctx.tasks.list();
+    const fieldDefinitions: FieldDefinition[] = ctx.config.fields;
     return c.json({
       columns,
       tasks: tasks.map(serializeBoardTask),
+      fieldDefinitions,
     });
   });
 
+  app.get("/api/tasks/:id", async (c) => {
+    const id = c.req.param("id");
+    try {
+      const task = await ctx.tasks.get(id);
+      return c.json({ task: serializeBoardTaskDetail(task) });
+    } catch (e) {
+      const msg = e instanceof Error ? e.message : String(e);
+      if (isNotFoundMessage(msg)) {
+        return c.json({ error: msg }, 404);
+      }
+      return c.json({ error: msg }, 500);
+    }
+  });
+
   app.patch("/api/tasks/:id", async (c) => {
     const id = c.req.param("id");
     let body: unknown;
@@ -79,14 +141,29 @@ export function createBoardApp(ctx: YarloPluginContext): Hono {
 
     const parsed = patchBodySchema.safeParse(body);
     if (!parsed.success) {
+      const flat = parsed.error.flatten();
+      const refineMsg = parsed.error.errors.find((e) => e.code === "custom");
       return c.json(
-        { error: "Validation failed", details: parsed.error.flatten() },
+        {
+          error: refineMsg?.message ?? "Validation failed",
+          details: flat,
+        },
         400,
       );
     }
 
     const columns = getStatusColumnOptions(ctx.config);
-    if (!columns.includes(parsed.data.status)) {
+    const fieldPatch: Record<string, unknown> = {};
+    if (parsed.data.fields) {
+      Object.assign(fieldPatch, parsed.data.fields);
+    }
+    if (parsed.data.status !== undefined) {
+      fieldPatch.status = parsed.data.status;
+    }
+
+    const statusValue =
+      typeof fieldPatch.status === "string" ? fieldPatch.status : undefined;
+    if (statusValue !== undefined && !columns.includes(statusValue)) {
       return c.json(
         {
           error: `Invalid status: must be one of: ${columns.join(", ")}`,
@@ -95,18 +172,23 @@ export function createBoardApp(ctx: YarloPluginContext): Hono {
       );
     }
 
+    const updateInput: UpdateTaskInput = {};
+    if (parsed.data.title !== undefined) {
+      updateInput.title = parsed.data.title;
+    }
+    if (parsed.data.content !== undefined) {
+      updateInput.content = parsed.data.content;
+    }
+    if (Object.keys(fieldPatch).length > 0) {
+      updateInput.fields = fieldPatch;
+    }
+
     try {
-      const task = await ctx.tasks.update(id, {
-        fields: { status: parsed.data.status },
-      });
-      return c.json({ task: serializeBoardTask(task) });
+      const task = await ctx.tasks.update(id, updateInput);
+      return c.json({ task: serializeBoardTaskDetail(task) });
     } catch (e) {
       const msg = e instanceof Error ? e.message : String(e);
-      if (
-        msg.includes("not found") ||
-        msg.includes("Ambiguous ID") ||
-        msg.includes("Ambiguous")
-      ) {
+      if (isNotFoundMessage(msg)) {
         return c.json({ error: msg }, 404);
       }
       return c.json({ error: msg }, 500);