pi-roundtable-web 0.25.0 → 0.26.1

package/src/app/protocol.ts

@@ -1,6 +1,7 @@
 import { QUESTIONNAIRE_LIMITS } from "pi-roundtable";
 import {
 	type ClientFrame,
+	type FormInput,
 	MAX_MESSAGE_FILES,
 	type PromptAnswer,
 } from "../api-types.ts";
@@ -40,6 +41,31 @@ function parseAnswer(value: unknown): PromptAnswer | undefined {
 	};
 }
 
+/** The most fields and the longest value a form's input may carry. */
+const FORM_FIELDS = 40;
+const FORM_VALUE_CHARS = 32_000;
+
+/** A form's input: text, or a list of text, by field name. */
+function parseInput(value: unknown): FormInput | undefined {
+	if (!isRecord(value)) return undefined;
+	const entries = Object.entries(value);
+	if (entries.length > FORM_FIELDS) return undefined;
+	const input: Record<string, string | string[]> = {};
+	for (const [name, field] of entries) {
+		if (name.length === 0 || name.length > ID_CHARS) return undefined;
+		if (typeof field === "string" && field.length <= FORM_VALUE_CHARS)
+			input[name] = field;
+		else if (
+			Array.isArray(field) &&
+			field.length <= FORM_FIELDS &&
+			field.every((one) => isText(one) && one.length <= FORM_VALUE_CHARS)
+		)
+			input[name] = field as string[];
+		else return undefined;
+	}
+	return input;
+}
+
 function parseAnswers(value: Record<string, unknown>): ClientFrame | undefined {
 	const { prompt, answers, note } = value;
 	if (!isId(prompt) || !Array.isArray(answers)) return undefined;
@@ -99,8 +125,10 @@ export function parseClientFrame(
 				...(value.room === undefined ? {} : { room: value.room as string }),
 			};
 		case "send": {
-			const { id, room, text, uploads } = value;
+			const { id, room, text, uploads, mode } = value;
 			if (!isId(id) || !isId(room) || !isText(text)) return undefined;
+			if (mode !== undefined && mode !== "note" && mode !== "turn")
+				return undefined;
 			if (
 				uploads !== undefined &&
 				!(
@@ -118,8 +146,42 @@ export function parseClientFrame(
 				...(uploads === undefined || uploads.length === 0
 					? {}
 					: { uploads: uploads as string[] }),
+				...(mode === undefined ? {} : { mode }),
 			};
 		}
+		case "subscribe":
+		case "unsubscribe":
+			return isId(value.room)
+				? { type: value.type, room: value.room }
+				: undefined;
+		case "act": {
+			const { id, room, page, action, card, input } = value;
+			if (!isId(id) || !isId(action)) return undefined;
+			// One target: a room or a page, never both and never neither.
+			if ((room === undefined) === (page === undefined)) return undefined;
+			if (!optional(room, isId) || !optional(page, isId)) return undefined;
+			if (!optional(card, isId)) return undefined;
+			const parsed = input === undefined ? undefined : parseInput(input);
+			if (input !== undefined && !parsed) return undefined;
+			return {
+				type: "act",
+				id,
+				action,
+				...(room === undefined ? {} : { room: room as string }),
+				...(page === undefined ? {} : { page: page as string }),
+				...(card === undefined ? {} : { card: card as string }),
+				...(parsed ? { input: parsed } : {}),
+			};
+		}
+		case "ack":
+			return isId(value.tag) ? { type: "ack", tag: value.tag } : undefined;
+		case "read":
+			return isId(value.room) &&
+				typeof value.upTo === "number" &&
+				Number.isSafeInteger(value.upTo) &&
+				value.upTo >= 0
+				? { type: "read", room: value.room, upTo: value.upTo }
+				: undefined;
 		case "stop":
 			return isId(value.room) ? { type: "stop", room: value.room } : undefined;
 		case "approval":

package/src/app/room-log.ts

@@ -1,6 +1,12 @@
 import type { SQL } from "bun";
 import type { Migration } from "pi-roundtable";
-import type { RoomFile, RoomMessage } from "../api-types.ts";
+import type {
+	HostAuthorKind,
+	PictureRef,
+	RoomFile,
+	RoomMessage,
+} from "../api-types.ts";
+import { storedJson } from "../host/stored-json.ts";
 
 /** A message to store; the log numbers it and stamps its time. */
 export interface NewRoomMessage {
@@ -11,6 +17,16 @@ export interface NewRoomMessage {
 	author: string;
 	text: string;
 	files?: RoomFile[];
+	/** Host rooms: who wrote it, as the host's kinds of author name them. */
+	authorKind?: HostAuthorKind;
+	authorLabel?: string;
+	picture?: PictureRef;
+	/** Host rooms: the host's own id for the message, unique within the room. */
+	reference?: string;
+	/** When it was written, for an import; the log's clock otherwise. Retention counts from it. */
+	at?: Date;
+	/** An internal note: shown to the room's readers, never handed to the agent. */
+	note?: true;
 }
 
 interface Row {
@@ -23,16 +39,18 @@ interface Row {
 	text: string;
 	files: RoomFile[] | string;
 	created_at: Date;
+	author_kind: HostAuthorKind | null;
+	author_label: string | null;
+	picture: PictureRef | string | null;
+	edited_at: Date | null;
+	note: boolean | null;
 }
 
 /** The most messages one page of history holds. */
 export const PAGE_LIMIT = 100;
 
 function messageOf(row: Row): RoomMessage {
-	const files =
-		typeof row.files === "string"
-			? (JSON.parse(row.files) as RoomFile[])
-			: row.files;
+	const files = storedJson(row.files, "message files");
 	return {
 		id: Number(row.id),
 		room: row.room,
@@ -43,6 +61,15 @@ function messageOf(row: Row): RoomMessage {
 		text: row.text,
 		files,
 		at: row.created_at.toISOString(),
+		...(row.author_kind === null ? {} : { authorKind: row.author_kind }),
+		...(row.author_label === null ? {} : { authorLabel: row.author_label }),
+		...(row.picture === null
+			? {}
+			: {
+					picture: storedJson(row.picture, "picture"),
+				}),
+		...(row.edited_at === null ? {} : { edited: true as const }),
+		...(row.note ? { note: true as const } : {}),
 	};
 }
 
@@ -79,29 +106,141 @@ export class RoomLog {
 		},
 	};
 
+	/** The columns a host room's messages add: who wrote it, the host's reference, and when it was changed. */
+	static readonly hostMigration: Migration = {
+		name: "web-room-messages-host",
+		up: async (sql) => {
+			await sql`ALTER TABLE web_room_messages ADD COLUMN IF NOT EXISTS author_kind text`;
+			await sql`ALTER TABLE web_room_messages ADD COLUMN IF NOT EXISTS author_label text`;
+			await sql`ALTER TABLE web_room_messages ADD COLUMN IF NOT EXISTS picture jsonb`;
+			await sql`ALTER TABLE web_room_messages ADD COLUMN IF NOT EXISTS reference text`;
+			await sql`ALTER TABLE web_room_messages ADD COLUMN IF NOT EXISTS edited_at timestamptz`;
+			await sql`CREATE UNIQUE INDEX IF NOT EXISTS web_room_messages_reference ON web_room_messages (room, reference) WHERE reference IS NOT NULL`;
+			await sql`CREATE INDEX IF NOT EXISTS web_room_messages_created ON web_room_messages (created_at)`;
+		},
+	};
+
+	/** The column that marks a message as an internal note, for the rooms more than one person reads. */
+	static readonly noteMigration: Migration = {
+		name: "web-room-messages-note",
+		up: async (sql) => {
+			await sql`ALTER TABLE web_room_messages ADD COLUMN IF NOT EXISTS note boolean NOT NULL DEFAULT false`;
+		},
+	};
+
 	async append(message: NewRoomMessage): Promise<RoomMessage> {
-		const files = JSON.stringify(message.files ?? []);
-		const [row]: Row[] = await this.#sql`
-			INSERT INTO web_room_messages (room, kind, principal_id, agent, author_name, text, files)
-			VALUES (${message.room}, ${message.kind}, ${message.principalId ?? null},
-				${message.agent ?? null}, ${message.author}, ${message.text}, ${files}::jsonb)
-			RETURNING *`;
+		const [row] = await this.#insert(message, false);
 		if (!row) throw new Error("the room log stored nothing");
 		return messageOf(row);
 	}
 
-	/** Changes the text of a message stored in the room; undefined when the room holds no such message. */
+	/**
+	 * Stores a host room's message once per `reference`: a second post with the same reference in
+	 * the room stores nothing and answers the message already there, with `created` false.
+	 */
+	async appendOnce(
+		message: NewRoomMessage,
+	): Promise<{ message: RoomMessage; created: boolean }> {
+		const [row] = await this.#insert(message, message.reference !== undefined);
+		if (row) return { message: messageOf(row), created: true };
+		const [existing]: Row[] = await this.#sql`
+			SELECT * FROM web_room_messages
+			WHERE room = ${message.room} AND reference = ${message.reference ?? null}`;
+		if (!existing) throw new Error("the room log stored nothing");
+		return { message: messageOf(existing), created: false };
+	}
+
+	async #insert(message: NewRoomMessage, once: boolean): Promise<Row[]> {
+		const files = JSON.stringify(message.files ?? []);
+		const picture = message.picture ? JSON.stringify(message.picture) : null;
+		const at = message.at ?? new Date();
+		return once
+			? await this.#sql`
+				INSERT INTO web_room_messages (room, kind, principal_id, agent, author_name, text, files,
+					author_kind, author_label, picture, reference, created_at, note)
+				VALUES (${message.room}, ${message.kind}, ${message.principalId ?? null},
+					${message.agent ?? null}, ${message.author}, ${message.text}, ${files}::jsonb,
+					${message.authorKind ?? null}, ${message.authorLabel ?? null}, ${picture}::jsonb,
+					${message.reference ?? null}, ${at}, ${message.note === true})
+				ON CONFLICT (room, reference) WHERE reference IS NOT NULL DO NOTHING
+				RETURNING *`
+			: await this.#sql`
+				INSERT INTO web_room_messages (room, kind, principal_id, agent, author_name, text, files,
+					author_kind, author_label, picture, reference, created_at, note)
+				VALUES (${message.room}, ${message.kind}, ${message.principalId ?? null},
+					${message.agent ?? null}, ${message.author}, ${message.text}, ${files}::jsonb,
+					${message.authorKind ?? null}, ${message.authorLabel ?? null}, ${picture}::jsonb,
+					${message.reference ?? null}, ${at}, ${message.note === true})
+				RETURNING *`;
+	}
+
+	/**
+	 * Changes the text of a message stored in the room; undefined when the room holds no such
+	 * message. `mark` shows it as edited, as a host's edit of someone's words does.
+	 */
 	async edit(
 		room: string,
 		id: number,
 		text: string,
+		mark = false,
 	): Promise<RoomMessage | undefined> {
+		const [row]: Row[] = mark
+			? await this.#sql`
+				UPDATE web_room_messages SET text = ${text}, edited_at = now()
+				WHERE id = ${id} AND room = ${room} RETURNING *`
+			: await this.#sql`
+				UPDATE web_room_messages SET text = ${text}
+				WHERE id = ${id} AND room = ${room} RETURNING *`;
+		return row && messageOf(row);
+	}
+
+	/** The message the host's reference names, if the room holds one. */
+	async byReference(
+		room: string,
+		reference: string,
+	): Promise<number | undefined> {
+		const [row]: { id: string | number | bigint }[] = await this.#sql`
+			SELECT id FROM web_room_messages WHERE room = ${room} AND reference = ${reference}`;
+		return row === undefined ? undefined : Number(row.id);
+	}
+
+	/** One stored message of the room, or undefined. */
+	async get(room: string, id: number): Promise<RoomMessage | undefined> {
+		const [row]: Row[] = await this.#sql`
+			SELECT * FROM web_room_messages WHERE room = ${room} AND id = ${id}`;
+		return row && messageOf(row);
+	}
+
+	/** Deletes one message of the room; the message as it was, or undefined when the room held none. */
+	async remove(room: string, id: number): Promise<RoomMessage | undefined> {
 		const [row]: Row[] = await this.#sql`
-			UPDATE web_room_messages SET text = ${text}
-			WHERE id = ${id} AND room = ${room} RETURNING *`;
+			DELETE FROM web_room_messages WHERE room = ${room} AND id = ${id} RETURNING *`;
 		return row && messageOf(row);
 	}
 
+	/**
+	 * Deletes the messages older than `before` of the rooms whose key starts with `prefix`, the
+	 * kind's rooms; the deleted messages, so their files can go too. Age is the message's own time.
+	 */
+	async sweepKind(prefix: string, before: Date): Promise<RoomMessage[]> {
+		const rows: Row[] = await this.#sql`
+			DELETE FROM web_room_messages
+			WHERE starts_with(room, ${prefix}) AND created_at < ${before} RETURNING *`;
+		return rows.map(messageOf);
+	}
+
+	/** The newest message id of each room that has one, for the read cursors. */
+	async newestIds(rooms: readonly string[]): Promise<Map<string, number>> {
+		const found = new Map<string, number>();
+		if (rooms.length === 0) return found;
+		const rows: { room: string; id: string | number | bigint }[] = await this
+			.#sql`
+			SELECT room, max(id) AS id FROM web_room_messages
+			WHERE room IN ${this.#sql(rooms)} GROUP BY room`;
+		for (const row of rows) found.set(row.room, Number(row.id));
+		return found;
+	}
+
 	/** The newest `limit` messages older than `before` (all of them when absent), oldest first. */
 	async page(
 		room: string,

package/src/app/rooms.ts

@@ -45,6 +45,11 @@ export interface RoomsOptions {
 	activity(
 		room: ChannelKey,
 	): Pick<RoomView, "typing" | "stoppable" | "phase" | "agent">;
+	/**
+	 * Whether more than one person reads the agent and group rooms, so a message may be an
+	 * internal note. Absent: one person does, and a room takes only turns.
+	 */
+	readers?(): Promise<boolean>;
 }
 
 const THREAD_ID = /^thread\.[0-9a-f-]{36}$/;
@@ -111,6 +116,11 @@ export class Rooms {
 			: undefined;
 	}
 
+	/** Whether the agent and group rooms take internal notes: more than one person reads them. */
+	async notesOn(): Promise<boolean> {
+		return (await this.#options.readers?.()) === true;
+	}
+
 	/** The home room: the coordinator's, else the first active agent's. */
 	homeKey(): ChannelKey | undefined {
 		const { directory, team, surface } = this.#options;
@@ -153,6 +163,33 @@ export class Rooms {
 		return `${this.#options.mount}${path ?? "/avatars/missing.png"}`;
 	}
 
+	/**
+	 * The view of one thread, listed or not: a thread the owners dismissed is off the list and still
+	 * opens by its address, and the page asks for its view here.
+	 */
+	async threadView(key: ChannelKey): Promise<RoomView | undefined> {
+		const room = await this.resolve(key);
+		if (room?.kind !== "thread") return undefined;
+		const thread = await this.#options.threads.get(room.name);
+		if (!thread) return undefined;
+		const { modes, activity, log } = this.#options;
+		const { yolo, longRunning } = modes.peek(key);
+		const last = (await log.lastOf([key])).get(key);
+		return {
+			home: false,
+			readOnly: true,
+			mode: { yolo, longRunning },
+			...activity(key),
+			kind: "thread",
+			name: thread.id,
+			displayName: thread.title,
+			parent: thread.parent,
+			...(thread.open ? {} : { closed: true as const }),
+			...(last ? { last } : {}),
+			key,
+		};
+	}
+
 	async list(): Promise<RoomView[]> {
 		const { surface, directory, modes, mutes, activity, log, threads } =
 			this.#options;
@@ -162,6 +199,7 @@ export class Rooms {
 		const groups = directory.groups().filter((g) => g.status === "active");
 		const shown = await threads.list();
 		const muted = await mutes.all();
+		const notes = await this.notesOn();
 		const view = (
 			key: ChannelKey,
 			rest: Pick<RoomView, "kind" | "name" | "displayName"> & Partial<RoomView>,
@@ -172,6 +210,7 @@ export class Rooms {
 				readOnly: false,
 				mode: { yolo, longRunning },
 				...(muted.has(key) ? { muted: true as const } : {}),
+				...(notes && rest.kind !== "thread" ? { notes: true as const } : {}),
 				...activity(key),
 				...rest,
 				key,