@tstax/coding-tab 0.1.1 → 0.2.0

package/dist/server.d.ts

@@ -21,38 +21,108 @@ interface ModelOption {
     cursorModelId: string;
     displayName: string;
 }
+interface PrInfo {
+    url: string;
+    number: number;
+    owner: string;
+    repo: string;
+    branch?: string;
+    state?: "open" | "closed" | "merged";
+    title?: string;
+    body?: string;
+}
+/**
+ * A chronological event inside an assistant turn. Either a paragraph of text
+ * (one per `block.text` from the SDK assistant message) or a tool invocation
+ * (one per `tool_use`/`tool_call` from the SDK).
+ */
+type TimelineEvent = {
+    kind: "text";
+    id: string;
+    text: string;
+} | {
+    kind: "tool";
+    id: string;
+    callId: string;
+    name: string;
+    status: "running" | "completed" | "error";
+    args?: unknown;
+    result?: unknown;
+};
+type TurnRole = "user" | "assistant";
+type TurnStatus = "running" | "finished" | "error" | "cancelled";
+/** A persisted turn (user prompt or assistant response) inside a chat. */
+interface StoredTurn {
+    id: string;
+    chatId: string;
+    seq: number;
+    role: TurnRole;
+    isPlan: boolean;
+    status?: TurnStatus;
+    events: TimelineEvent[];
+    pr?: PrInfo;
+    createdAt: number;
+    /** For user turns: the raw prompt typed into the composer. */
+    prompt?: string;
+    /** For assistant turns: surfaced if the plan ended with `PLAN READY`. */
+    showExecute?: boolean;
+}
+/** The persisted metadata for a chat thread. */
+interface StoredChat {
+    id: string;
+    githubLogin: string;
+    title: string;
+    mode: ChatMode;
+    model: ModelChoice;
+    repoUrl: string;
+    startingRef?: string;
+    /** Last cloud agentId used by this chat — re-attached via `Agent.resume`. */
+    agentId?: string;
+    createdAt: number;
+    updatedAt: number;
+}
+/** Lightweight chat row used to populate the sidebar. */
+interface ChatListItem {
+    id: string;
+    title: string;
+    mode: ChatMode;
+    model: ModelChoice;
+    updatedAt: number;
+    createdAt: number;
+}
+interface FullChat extends StoredChat {
+    turns: StoredTurn[];
+}
+interface CreateChatRequest {
+    title?: string;
+    mode?: ChatMode;
+    model?: ModelChoice;
+    repoUrl?: string;
+    startingRef?: string;
+}
+interface CreateChatResponse {
+    chat: StoredChat;
+}
+interface PatchChatRequest {
+    title?: string;
+    mode?: ChatMode;
+    model?: ModelChoice;
+}
 interface StartAgentRequest {
+    chatId: string;
     prompt: string;
     mode: ChatMode;
     model: ModelChoice;
     repoUrl?: string;
     startingRef?: string;
 }
-interface StartAgentResponse {
-    sessionId: string;
-    agentId: string;
-    runId: string;
-}
 interface SendMessageRequest {
-    sessionId: string;
+    chatId: string;
     prompt: string;
     mode: ChatMode;
 }
-interface SendMessageResponse {
-    runId: string;
-}
 interface ExecuteRequest {
-    sessionId: string;
-}
-interface PrInfo {
-    url: string;
-    number: number;
-    owner: string;
-    repo: string;
-    branch?: string;
-    state?: "open" | "closed" | "merged";
-    title?: string;
-    body?: string;
+    chatId: string;
 }
 interface MergeRequest {
     prUrl: string;
@@ -90,11 +160,61 @@ type StreamEvent = {
     retryable?: boolean;
 } | {
     kind: "ready";
-    sessionId: string;
+    chatId: string;
+    turnId: string;
     agentId: string;
     runId: string;
 };
 
+/**
+ * Pluggable persistence layer for chats + turns. The default
+ * `FileChatStorage` writes JSON files under a data directory; host apps can
+ * swap in their own implementation (e.g. Postgres / Supabase) by passing
+ * `storage` to `mountCodingTab`.
+ */
+interface ChatStorage {
+    listChats(login: string): Promise<ChatListItem[]>;
+    loadChat(id: string, login: string): Promise<FullChat | null>;
+    createChat(chat: StoredChat): Promise<void>;
+    patchChat(id: string, login: string, patch: Partial<Omit<StoredChat, "id" | "githubLogin" | "createdAt">>): Promise<StoredChat | null>;
+    appendTurn(turn: StoredTurn): Promise<void>;
+    patchTurn(chatId: string, turnId: string, patch: Partial<Omit<StoredTurn, "id" | "chatId" | "createdAt">>): Promise<void>;
+    deleteChat(id: string, login: string): Promise<boolean>;
+}
+interface FileChatStorageOptions {
+    dataDir: string;
+}
+declare class FileChatStorage implements ChatStorage {
+    private readonly dataDir;
+    /** Per-chat write mutex chain to keep concurrent appends consistent. */
+    private readonly chains;
+    constructor(opts: FileChatStorageOptions);
+    private chatPath;
+    private indexPath;
+    /** Serialize all reads/writes for a single chat through a chained promise. */
+    private withChat;
+    private readChat;
+    private writeChat;
+    private readIndex;
+    private writeIndex;
+    /**
+     * Rebuild the index for a user by scanning every chat file. Used as a
+     * self-heal path when the index gets out of sync (e.g. crash mid-write).
+     */
+    private rebuildIndex;
+    private toListItem;
+    private upsertIndex;
+    private removeFromIndex;
+    listChats(login: string): Promise<ChatListItem[]>;
+    loadChat(id: string, login: string): Promise<FullChat | null>;
+    createChat(chat: StoredChat): Promise<void>;
+    patchChat(id: string, login: string, patch: Partial<Omit<StoredChat, "id" | "githubLogin" | "createdAt">>): Promise<StoredChat | null>;
+    appendTurn(turn: StoredTurn): Promise<void>;
+    patchTurn(chatId: string, turnId: string, patch: Partial<Omit<StoredTurn, "id" | "chatId" | "createdAt">>): Promise<void>;
+    deleteChat(id: string, login: string): Promise<boolean>;
+}
+declare function createDefaultStorage(dataDir?: string): ChatStorage;
+
 interface MountCodingTabOptions {
     cursorApiKey: string;
     githubOAuth: GitHubOAuthOptions;
@@ -107,7 +227,15 @@ interface MountCodingTabOptions {
     secure?: boolean;
     envName?: string;
     skipReviewerRequest?: boolean;
+    /**
+     * Optional pluggable persistence layer. Defaults to a JSON file store
+     * rooted at `dataDir` (or `<cwd>/.coding-tab-data`). Override to plug in
+     * Postgres, Supabase, Redis, etc. on hosts with ephemeral filesystems.
+     */
+    storage?: ChatStorage;
+    /** Directory used by the default file storage. Ignored when `storage` is set. */
+    dataDir?: string;
 }
 declare function mountCodingTab(app: Express, options: MountCodingTabOptions): Router;
 
-export { type ChatMode, type ExecuteRequest, type GitHubOAuthOptions, type MeResponse, type MergeRequest, type MergeResponse, type ModelChoice, type ModelOption, type MountCodingTabOptions, type PrInfo, type SendMessageRequest, type SendMessageResponse, type StartAgentRequest, type StartAgentResponse, type StreamEvent, mountCodingTab };
+export { type ChatListItem, type ChatMode, type ChatStorage, type CreateChatRequest, type CreateChatResponse, type ExecuteRequest, FileChatStorage, type FullChat, type GitHubOAuthOptions, type MeResponse, type MergeRequest, type MergeResponse, type ModelChoice, type ModelOption, type MountCodingTabOptions, type PatchChatRequest, type PrInfo, type SendMessageRequest, type StartAgentRequest, type StoredChat, type StoredTurn, type StreamEvent, type TimelineEvent, type TurnRole, type TurnStatus, createDefaultStorage, mountCodingTab };