chapterhouse 0.8.1 → 0.9.0

package/dist/shared/api-schemas.js

@@ -0,0 +1,618 @@
+/**
+ * Shared API contract schemas — single source of truth for every server↔client
+ * response type in Chapterhouse.
+ *
+ * Both the backend (`src/api/server.ts`) and the frontend (`web/src/api-schemas.ts`)
+ * import from here.  When a server response shape changes, the TypeScript compiler
+ * immediately surfaces any mismatch on the import side — schema drift becomes a
+ * compile error rather than a runtime bug.
+ *
+ * Excluded from this file:
+ *  - Parts model (TextPart, ToolCallPart, etc.) — client-only; synthesised from SSE
+ *    frames in the frontend store.  Lives in `web/src/api-schemas.ts`.
+ *  - TurnEventSchema — depends on the client-side PartSchema (which includes the
+ *    client-only ActivityHeartbeatPart).  Lives in `web/src/api-schemas.ts`.
+ *    See `src/copilot/turn-events.ts` for the daemon-side TypeScript mirror.
+ *
+ * Migration status: initial extraction from web/src/api-schemas.ts (issue #369).
+ */
+import { z } from "zod";
+// ---------------------------------------------------------------------------
+// /api/config/public
+// ---------------------------------------------------------------------------
+const StandaloneConfigSchema = z.object({
+    appName: z.literal("Chapterhouse"),
+    entraAuthEnabled: z.literal(false),
+    standalone: z.literal(true),
+    chatSseEnabled: z.boolean().optional(),
+});
+const NonStandaloneConfigSchema = z.object({
+    appName: z.literal("Chapterhouse"),
+    entraAuthEnabled: z.literal(false),
+    standalone: z.literal(false),
+    chatSseEnabled: z.boolean().optional(),
+});
+const EntraRuntimeConfigSchema = z.object({
+    appName: z.literal("Chapterhouse"),
+    entraAuthEnabled: z.literal(true),
+    entraClientId: z.string(),
+    entraTenantId: z.string(),
+    chatSseEnabled: z.boolean().optional(),
+});
+export const PublicConfigResponseSchema = z.union([
+    StandaloneConfigSchema,
+    NonStandaloneConfigSchema,
+    EntraRuntimeConfigSchema,
+]);
+// ---------------------------------------------------------------------------
+// /api/bootstrap
+// ---------------------------------------------------------------------------
+export const BootstrapResponseSchema = z.union([
+    z.object({ authMode: z.literal("legacy"), token: z.string().nullable() }),
+    z.object({ authMode: z.literal("entra") }),
+    z.object({ authMode: z.literal("standalone") }),
+]);
+// ---------------------------------------------------------------------------
+// /api/message  /api/restart
+// ---------------------------------------------------------------------------
+export const StatusResponseSchema = z.object({ status: z.string() });
+// ---------------------------------------------------------------------------
+// /api/cancel
+// ---------------------------------------------------------------------------
+export const CancelResponseSchema = z.object({
+    status: z.string(),
+    cancelled: z.boolean(),
+});
+// ---------------------------------------------------------------------------
+// /api/agents
+// ---------------------------------------------------------------------------
+export const AgentSummarySchema = z.object({
+    name: z.string(),
+    slug: z.string(),
+    description: z.string(),
+    model: z.string(),
+    scope: z.string().nullable(),
+    type: z.enum(["builtin", "custom"]),
+    lastEdited: z.string().nullable(),
+});
+export const AgentListSchema = z.array(AgentSummarySchema);
+export const AgentDetailSchema = z.object({
+    name: z.string(),
+    slug: z.string(),
+    description: z.string(),
+    model: z.string(),
+    scope: z.string().nullable(),
+    persistent: z.boolean(),
+    skills: z.array(z.string()),
+    type: z.enum(["builtin", "custom"]),
+    editable: z.boolean(),
+    systemPrompt: z.string(),
+});
+export const AgentPatchRequestSchema = z.object({
+    name: z.string().optional(),
+    description: z.string().optional(),
+    model: z.string().optional(),
+    systemPrompt: z.string().optional(),
+}).strict();
+// ---------------------------------------------------------------------------
+// /api/projects
+// ---------------------------------------------------------------------------
+export const ProjectSummarySchema = z.object({
+    slug: z.string(),
+    cwd: z.string(),
+    hardRuleCount: z.number().int().nullable(),
+    softRuleCount: z.number().int().nullable(),
+});
+export const ProjectListSchema = z.array(ProjectSummarySchema);
+export const ProjectHardRulesSchema = z.object({
+    auto_pr: z.boolean(),
+    require_worktree: z.boolean(),
+    pr_draft_default: z.boolean(),
+    default_branch: z.string(),
+    commit_co_author: z.string(),
+    test_command: z.string(),
+    build_command: z.string(),
+    lint_command: z.string(),
+    require_clean_worktree: z.boolean(),
+});
+export const ProjectHardRulesUpdateRequestSchema = z.object({
+    hardRules: ProjectHardRulesSchema,
+});
+export const ProjectSoftRulesUpdateRequestSchema = z.object({
+    softRules: z.array(z.string()),
+});
+export const ProjectDetailSchema = z.discriminatedUnion("rulesFound", [
+    z.object({
+        slug: z.string(),
+        cwd: z.string(),
+        rulesFound: z.literal(true),
+        hardRules: ProjectHardRulesSchema,
+        softRules: z.array(z.string()),
+    }),
+    z.object({
+        slug: z.string(),
+        cwd: z.string(),
+        rulesFound: z.literal(false),
+        hardRules: z.null(),
+        softRules: z.array(z.string()),
+    }),
+]);
+export const ProjectDeleteResponseSchema = z.object({
+    ok: z.literal(true),
+    slug: z.string(),
+});
+export const AgentSaveResponseSchema = z.object({
+    ok: z.literal(true),
+    slug: z.string(),
+});
+// ---------------------------------------------------------------------------
+// /api/workers  (list)
+// ---------------------------------------------------------------------------
+export const WorkerRowSchema = z.object({
+    slug: z.string(),
+    name: z.string(),
+    model: z.string(),
+    taskId: z.string(),
+    description: z.string(),
+    status: z.string(),
+    startedAt: z.string(),
+    completedAt: z.string().nullable(),
+});
+export const WorkerListSchema = z.array(WorkerRowSchema);
+// ---------------------------------------------------------------------------
+// /api/workers/:taskId  (detail)
+// ---------------------------------------------------------------------------
+export const WorkerDetailSchema = z.object({
+    taskId: z.string(),
+    agentSlug: z.string(),
+    name: z.string(),
+    description: z.string(),
+    prompt: z.string().nullable(),
+    status: z.string(),
+    result: z.string().nullable(),
+    startedAt: z.string(),
+    completedAt: z.string().nullable(),
+});
+// ---------------------------------------------------------------------------
+// /api/workers/:taskId/events  (historical event log)
+// ---------------------------------------------------------------------------
+export const TaskEventSchema = z.object({
+    id: z.number(),
+    taskId: z.string(),
+    seq: z.number(),
+    ts: z.number(),
+    kind: z.enum(["tool_start", "tool_complete"]),
+    toolName: z.string().nullable(),
+    summary: z.string().nullable(),
+});
+export const TaskEventsResponseSchema = z.object({
+    taskId: z.string(),
+    events: z.array(TaskEventSchema),
+});
+// ---------------------------------------------------------------------------
+// /api/model  (get / set)
+// ---------------------------------------------------------------------------
+export const ModelResponseSchema = z.object({ model: z.string() });
+export const SetModelResponseSchema = z.object({ previous: z.string(), current: z.string() });
+export const ListModelsResponseSchema = z.object({
+    models: z.array(z.string()),
+    current: z.string(),
+});
+// ---------------------------------------------------------------------------
+// /api/auto
+// ---------------------------------------------------------------------------
+export const AutoConfigSchema = z.object({
+    enabled: z.boolean(),
+    tierModels: z.record(z.string(), z.string()),
+    cooldownMessages: z.number(),
+    currentModel: z.string(),
+    lastRoute: z.unknown(),
+});
+// ---------------------------------------------------------------------------
+// /api/wiki/pages
+// ---------------------------------------------------------------------------
+export const WikiPageMetaSchema = z.object({
+    path: z.string(),
+    title: z.string(),
+    summary: z.string(),
+    section: z.string(),
+    tags: z.array(z.string()),
+    updated: z.string(),
+    scope: z.enum(["personal", "team"]),
+});
+export const WikiPageListSchema = z.array(WikiPageMetaSchema);
+// ---------------------------------------------------------------------------
+// /api/wiki/page  (read / write / delete)
+// ---------------------------------------------------------------------------
+const WikiFrontmatterValueSchema = z.union([z.string(), z.array(z.string()), z.boolean()]);
+export const WikiPageFrontmatterSchema = z.object({
+    title: z.string().optional(),
+    summary: z.string().optional(),
+    updated: z.string().optional(),
+    tags: z.array(z.string()).optional(),
+    autostub: z.boolean().optional(),
+    confidence: z.enum(["high", "medium", "low"]).optional(),
+    contested: z.boolean().optional(),
+    contradictions: z.array(z.string()).optional(),
+    related: z.array(z.string()).optional(),
+    auto_pr: z.boolean().optional(),
+    require_worktree: z.boolean().optional(),
+    pr_draft_default: z.boolean().optional(),
+    default_branch: z.string().optional(),
+    commit_co_author: z.string().optional(),
+    test_command: z.string().optional(),
+    build_command: z.string().optional(),
+    lint_command: z.string().optional(),
+    require_clean_worktree: z.boolean().optional(),
+    metadata: z.record(z.string(), WikiFrontmatterValueSchema),
+});
+export const WikiPageContentSchema = z.object({
+    path: z.string(),
+    content: z.string(),
+    renderedContent: z.string(),
+    frontmatter: WikiPageFrontmatterSchema,
+});
+export const WikiWriteResponseSchema = z.object({
+    ok: z.boolean(),
+    created: z.boolean(),
+    path: z.string(),
+});
+export const WikiDeleteResponseSchema = z.object({
+    ok: z.boolean(),
+    path: z.string(),
+});
+export const WikiBrowserPageSchema = z.object({
+    slug: z.string(),
+    title: z.string().default(""),
+    summary: z.string().default(""),
+    type: z.string().default("topics"),
+    last_updated: z.string().default(""),
+    pinned: z.boolean().optional(),
+}).passthrough();
+export const WikiBrowserPageListSchema = z.object({
+    pages: z.array(WikiBrowserPageSchema),
+});
+export const WikiLinkSchema = z.object({
+    source_slug: z.string(),
+    target_slug: z.string(),
+    link_type: z.string(),
+}).passthrough();
+export const WikiLinksResponseSchema = z.object({
+    links: z.array(WikiLinkSchema),
+});
+export const WikiSourceSchema = z.object({
+    source_url: z.string().optional(),
+    path: z.string().optional(),
+    kind: z.string(),
+    status: z.string(),
+    session_id: z.string().nullable().optional(),
+    ingested_at: z.string().nullable().optional(),
+}).passthrough();
+export const WikiSourcesResponseSchema = z.object({
+    sources: z.array(WikiSourceSchema),
+});
+export const WikiResearchSessionSchema = z.object({
+    id: z.string().optional(),
+    name: z.string(),
+    source_count: z.number().int().default(0),
+    open_questions_count: z.number().int().default(0),
+    last_activity_at: z.string().default(""),
+}).passthrough();
+export const WikiResearchSessionsResponseSchema = z.object({
+    sessions: z.array(WikiResearchSessionSchema),
+});
+export const WikiPageDetailSchema = z.object({
+    page: WikiBrowserPageSchema.extend({
+        compiled_truth: z.string().default(""),
+        pinned: z.boolean().default(false),
+        frontmatter: z.record(z.string(), z.unknown()).optional(),
+        links: z.array(WikiLinkSchema).optional(),
+    }).passthrough(),
+});
+export const WikiPageUpdateResponseSchema = z.object({
+    ok: z.boolean(),
+    page: WikiPageDetailSchema.shape.page.optional(),
+    pinned: z.boolean().optional(),
+}).passthrough();
+export const WikiKorgResponseSchema = z.object({
+    reply: z.string(),
+}).passthrough();
+export const WikiReingestResponseSchema = z.object({
+    ok: z.boolean(),
+}).passthrough();
+// ---------------------------------------------------------------------------
+// /api/skills
+// ---------------------------------------------------------------------------
+export const SkillSchema = z.object({
+    slug: z.string(),
+    name: z.string(),
+    description: z.string(),
+    directory: z.string(),
+    source: z.enum(["bundled", "local", "global"]),
+});
+export const SkillListSchema = z.array(SkillSchema);
+export const RemoveSkillResponseSchema = z.object({
+    ok: z.boolean(),
+    message: z.string(),
+});
+// ---------------------------------------------------------------------------
+// /api/channels
+// ---------------------------------------------------------------------------
+export const ChannelSchema = z.object({
+    key: z.string().min(1),
+    label: z.string().min(1),
+    slug: z.string().optional(),
+    name: z.string().optional(),
+    description: z.string().optional(),
+    scope: z.string().optional(),
+});
+export const ChannelListSchema = z.array(ChannelSchema);
+// ---------------------------------------------------------------------------
+// /api/session/:key/messages
+// ---------------------------------------------------------------------------
+export const SessionMessageSchema = z.object({
+    id: z.number().int(),
+    role: z.enum(["user", "assistant"]),
+    content: z.string(),
+    ts: z.string(),
+    turn_id: z.string().nullable(),
+    turnId: z.string().optional(),
+    agentSlug: z.string().optional(),
+    agentDisplayName: z.string().optional(),
+});
+export const SessionMessagesResponseSchema = z.object({
+    sessionKey: z.string(),
+    messages: z.array(SessionMessageSchema),
+});
+// ---------------------------------------------------------------------------
+// SSE stream events  (/stream)
+// ---------------------------------------------------------------------------
+const RouteInfoSchema = z.object({
+    model: z.string(),
+    routerMode: z.string().optional(),
+    tier: z.string().nullable().optional(),
+    overrideName: z.string().optional(),
+});
+const ThinkingDeltaFrameSchema = z.object({
+    kind: z.literal("thinking_delta"),
+    reasoningId: z.string(),
+    deltaContent: z.string(),
+    agentSlug: z.string().optional(),
+});
+const ToolStartFrameSchema = z.object({
+    kind: z.literal("tool_start"),
+    toolCallId: z.string(),
+    toolName: z.string(),
+    mcpServerName: z.string().optional(),
+    arguments: z.record(z.string(), z.unknown()).optional(),
+    agentSlug: z.string().optional(),
+});
+const ToolCompleteFrameSchema = z.object({
+    kind: z.literal("tool_complete"),
+    toolCallId: z.string(),
+    success: z.boolean(),
+    resultPreview: z.string().optional(),
+    detailedContent: z.string().optional(),
+    agentSlug: z.string().optional(),
+});
+const SubagentStartedFrameSchema = z.object({
+    kind: z.literal("subagent_started"),
+    toolCallId: z.string(),
+    agentName: z.string(),
+    agentDisplayName: z.string(),
+    agentDescription: z.string(),
+    agentSlug: z.string().optional(),
+});
+const SubagentCompletedFrameSchema = z.object({
+    kind: z.literal("subagent_completed"),
+    toolCallId: z.string(),
+    agentName: z.string(),
+    agentDisplayName: z.string(),
+    durationMs: z.number().optional(),
+    agentSlug: z.string().optional(),
+});
+const SubagentFailedFrameSchema = z.object({
+    kind: z.literal("subagent_failed"),
+    toolCallId: z.string(),
+    agentName: z.string(),
+    agentDisplayName: z.string(),
+    error: z.string().optional(),
+    agentSlug: z.string().optional(),
+});
+export const ActivityFrameSchema = z.discriminatedUnion("kind", [
+    ThinkingDeltaFrameSchema,
+    ToolStartFrameSchema,
+    ToolCompleteFrameSchema,
+    SubagentStartedFrameSchema,
+    SubagentCompletedFrameSchema,
+    SubagentFailedFrameSchema,
+]);
+export const StreamEventSchema = z.union([
+    z.object({ type: z.literal("connected"), connectionId: z.string() }),
+    z.object({ type: z.literal("delta"), content: z.string(), sessionKey: z.string().optional(), turnId: z.string().optional() }),
+    z.object({
+        type: z.literal("message"),
+        content: z.string(),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        route: RouteInfoSchema.optional(),
+    }),
+    z.object({ type: z.literal("cancelled"), sessionKey: z.string().optional() }),
+    z.object({
+        type: z.literal("status"),
+        status: z.enum(["idle", "dreaming"]),
+        message: z.string(),
+    }),
+    z.object({
+        type: z.literal("agent_reload_pending"),
+        slug: z.string(),
+        reason: z.literal("in_flight"),
+    }),
+    z.object({
+        type: z.literal("agent_reloaded"),
+        slug: z.string(),
+        reason: z.enum(["session_restart", "confirmed_restart"]),
+    }),
+    z.object({
+        type: z.literal("queued"),
+        position: z.number(),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        msgId: z.string().optional(),
+    }),
+    // Activity events — each ActivityFrame kind merged inline with the activity wrapper.
+    // turnId is included for future use (e.g., the activity sidecar in #85) but is NOT
+    // used by App.tsx for bubble-boundary detection — activity events don't drive bubble
+    // boundaries; only delta/message events (which carry the authoritative turnId) do.
+    z.object({
+        type: z.literal("activity"),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        kind: z.literal("thinking_delta"),
+        reasoningId: z.string(),
+        deltaContent: z.string(),
+        agentSlug: z.string().optional(),
+    }),
+    z.object({
+        type: z.literal("activity"),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        kind: z.literal("tool_start"),
+        toolCallId: z.string(),
+        toolName: z.string(),
+        mcpServerName: z.string().optional(),
+        arguments: z.record(z.string(), z.unknown()).optional(),
+        agentSlug: z.string().optional(),
+    }),
+    z.object({
+        type: z.literal("activity"),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        kind: z.literal("tool_complete"),
+        toolCallId: z.string(),
+        success: z.boolean(),
+        resultPreview: z.string().optional(),
+        detailedContent: z.string().optional(),
+        agentSlug: z.string().optional(),
+    }),
+    z.object({
+        type: z.literal("activity"),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        kind: z.literal("subagent_started"),
+        toolCallId: z.string(),
+        agentName: z.string(),
+        agentDisplayName: z.string(),
+        agentDescription: z.string(),
+        agentSlug: z.string().optional(),
+    }),
+    z.object({
+        type: z.literal("activity"),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        kind: z.literal("subagent_completed"),
+        toolCallId: z.string(),
+        agentName: z.string(),
+        agentDisplayName: z.string(),
+        durationMs: z.number().optional(),
+        agentSlug: z.string().optional(),
+    }),
+    z.object({
+        type: z.literal("activity"),
+        sessionKey: z.string().optional(),
+        turnId: z.string().optional(),
+        kind: z.literal("subagent_failed"),
+        toolCallId: z.string(),
+        agentName: z.string(),
+        agentDisplayName: z.string(),
+        error: z.string().optional(),
+        agentSlug: z.string().optional(),
+    }),
+    // Emitted by the backend when a queued turn starts processing, with the number
+    // of messages still waiting behind it. Frontend renumbers "N ahead" indicators.
+    z.object({
+        type: z.literal("queue-advance"),
+        length: z.number(),
+        sessionKey: z.string().optional(),
+    }),
+    // Emitted by the backend when an active turn is aborted by the user via the
+    // interrupt endpoint. The frontend should drop the partial in-flight bubble
+    // (identified by abortedTurnId) so the replacement turn renders fresh.
+    z.object({
+        type: z.literal("turn-interrupted"),
+        abortedTurnId: z.string(),
+        sessionKey: z.string().optional(),
+    }),
+]);
+// ---------------------------------------------------------------------------
+// /api/sessions/:key/turn  (POST — fire-and-forget submit, #131)
+// ---------------------------------------------------------------------------
+export const SubmitTurnResponseSchema = z.object({
+    turnId: z.string(),
+});
+// ---------------------------------------------------------------------------
+// /api/memory/active-scope (GET + POST)
+// ---------------------------------------------------------------------------
+export const ActiveMemoryScopeSchema = z.object({
+    slug: z.string(),
+    title: z.string(),
+}).nullable();
+export const SetActiveScopeResponseSchema = z.object({
+    ok: z.literal(true),
+    scope: z.string().nullable(),
+});
+// ---------------------------------------------------------------------------
+// /api/memory/scopes
+// ---------------------------------------------------------------------------
+const MemoryScopeCountsSchema = z.object({
+    observations: z.number(),
+    decisions: z.number(),
+    entities: z.number(),
+    action_items: z.number(),
+});
+const MemoryScopeItemSchema = z.object({
+    slug: z.string(),
+    title: z.string(),
+    description: z.string(),
+    active: z.boolean(),
+    counts: MemoryScopeCountsSchema,
+});
+export const MemoryScopeListSchema = z.object({
+    scopes: z.array(MemoryScopeItemSchema),
+});
+// ---------------------------------------------------------------------------
+// /api/memory/:scope  (entries)
+// ---------------------------------------------------------------------------
+export const MemoryEntriesSchema = z.object({
+    entries: z.array(z.record(z.string(), z.unknown())),
+    total: z.number(),
+});
+// ---------------------------------------------------------------------------
+// /api/memory/:scope/remember
+// ---------------------------------------------------------------------------
+export const MemoryRememberResponseSchema = z.object({
+    ok: z.literal(true),
+    id: z.string(),
+});
+// ---------------------------------------------------------------------------
+// /api/memory/inbox
+// ---------------------------------------------------------------------------
+const InboxItemSchema = z.object({
+    id: z.number(),
+    scope_slug: z.string().nullable(),
+    kind: z.string(),
+    payload: z.string(),
+    source_agent: z.string(),
+    created_at: z.string(),
+});
+export const MemoryInboxSchema = z.object({
+    items: z.array(InboxItemSchema),
+    total: z.number(),
+});
+// ---------------------------------------------------------------------------
+// /api/memory/inbox/:id/route
+// ---------------------------------------------------------------------------
+export const InboxRouteResponseSchema = z.object({
+    ok: z.literal(true),
+});
+//# sourceMappingURL=api-schemas.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chapterhouse",
-  "version": "0.8.1",
+  "version": "0.9.0",
   "description": "Chapterhouse — a team-level AI assistant for engineering teams, built on the GitHub Copilot SDK. Web UI only.",
   "bin": {
     "chapterhouse": "dist/cli.js"