pi-roundtable-web 0.25.0 → 0.26.1

package/src/i18n/zh-tw.ts

@@ -266,6 +266,9 @@ export const ZH_TW: Readonly<Record<string, string>> = {
 	// 進度
 	"{name} is working…": "{name}正在處理…",
 	"Show the whole stream": "顯示完整串流",
+	"{count} earlier tool": "前面還有 {count} 個工具",
+	"{count} earlier tools": "前面還有 {count} 個工具",
+	"Show fewer tools": "收合工具",
 
 	// 聊天室選單
 	"A thread has no settings.": "討論串沒有設定。",
@@ -285,6 +288,7 @@ export const ZH_TW: Readonly<Record<string, string>> = {
 	"Leave the table": "離席",
 	"{name} left the table": "{name}已離席",
 	"The table is empty": "圓桌空了",
+	"There are no rooms to seat yet.": "還沒有可以入座的聊天室。",
 	"Every agent has left the table. Choose who sits down.":
 		"所有夥伴都離席了。選擇誰要上桌。",
 	"An agent who leaves the table is muted: its room stops pushing to you. A card that waits for you is always pushed.":
@@ -577,6 +581,8 @@ export const ZH_TW: Readonly<Record<string, string>> = {
 	"{count} cards waiting": "{count} 張卡片等待中",
 	"{count} finished thread": "{count} 個已結束的討論串",
 	"{count} finished threads": "{count} 個已結束的討論串",
+	"Clear all": "清除全部",
+	"The thread is still open.": "這個討論串還在進行中。",
 
 	// 排程
 	"{days} at {time}": "每{days} {time}",
@@ -1021,4 +1027,137 @@ export const ZH_TW: Readonly<Record<string, string>> = {
 		"baseHash 必須是讀取技能時的雜湊值。",
 	"This skill changed while you were editing it.":
 		"這個技能在你編輯時被更動了。",
+	// 成員、登入與設定關卡
+	Profile: "個人資料",
+	Owner: "擁有者",
+	Admin: "管理員",
+	Member: "成員",
+	"Finish setting up": "完成設定",
+	"Finish setting up first.": "請先完成設定。",
+	"These steps come first. The rest of the app opens when they are done.":
+		"請先完成這些步驟，完成後才能使用其餘功能。",
+	"Push is not available to you.": "你不能使用推播通知。",
+	"You are signed out.": "你已登出。",
+	"This account is not allowed to use this app.":
+		"這個帳號不能使用此應用程式。",
+	"Sign-in did not complete.": "登入沒有完成。",
+	// 主機的聊天室、頁面、卡片與已讀
+	"Host room": "主機聊天室",
+	"No rooms yet.": "還沒有聊天室。",
+	"No messages yet.": "還沒有訊息。",
+	"Nothing here.": "這裡沒有內容。",
+	"Show more": "顯示更多",
+	"Search {name}": "搜尋{name}",
+	"Search…": "搜尋…",
+	"Needs attention": "需要處理",
+	"This page is not available.": "這個頁面無法使用。",
+	"You can read this room but not write in it.":
+		"你可以閱讀這個聊天室，但不能在其中發言。",
+	"@AI": "@AI",
+	"The message starts with @AI, so the agent answers.":
+		"訊息開頭是 @AI，所以 AI 會回覆。",
+	"Write an internal note…": "寫一則內部備註…",
+	"Ask AI…": "問 AI…",
+	"Internal note": "內部備註",
+	"Earlier cards ({count})": "先前的卡片（{count}）",
+	Replaced: "已被取代",
+	Image: "圖片",
+	edited: "已編輯",
+	"{count} file was removed": "已移除 {count} 個檔案",
+	"{count} files were removed": "已移除 {count} 個檔案",
+	"{count} unread message": "{count} 則未讀訊息",
+	"{count} unread messages": "{count} 則未讀訊息",
+	"New messages": "新訊息",
+	"Seen by {count}": "已讀 {count}",
+	"More settings": "更多設定",
+	// 主機聊天室與頁面：伺服器的拒絕訊息
+	"There is no such room.": "沒有這個聊天室。",
+	"There is no such page.": "沒有這個頁面。",
+	"input must be an object.": "input 必須是物件。",
+	"input holds text or lists of text.": "input 只能放文字或文字清單。",
+	"action must be text.": "action 必須是文字。",
+	"card must be text.": "card 必須是文字。",
+	"This is not yours to do.": "這個操作不是你可以做的。",
+	"The page's query is too long.": "頁面的查詢參數太長。",
+	"This action takes no form.": "這個操作沒有表單。",
+	"The form has no such field.": "表單沒有這個欄位。",
+	"This field is required.": "這個欄位必填。",
+	"Choose from the list.": "請從清單中選擇。",
+	"This field takes one value.": "這個欄位只能填一個值。",
+	"This field is too long.": "這個欄位的內容太長。",
+	"Give a web address.": "請填入網址。",
+	"The action could not be done.": "無法執行這個操作。",
+	// 通知、設定步驟與帳號連結
+	Notices: "通知",
+	"Notices, {count} waiting": "通知，{count} 則待處理",
+	"Turn on notifications": "開啟通知",
+	"Link your {name} account": "連結你的 {name} 帳號",
+	"Prove which account is yours, so the app knows who you are there.":
+		"證明哪個帳號是你的，讓應用程式知道你在那裡是誰。",
+	"So that you hear when something needs you, even when the app is closed.":
+		"這樣即使應用程式關著，有事找你時你也聽得到。",
+	Urgent: "緊急",
+	Handled: "已處理",
+	"Nothing needs you.": "目前沒有需要你處理的事。",
+	Linked: "已連結",
+	Required: "必填",
+	Recommended: "建議",
+	"The server's configuration links this account.":
+		"這個帳號由伺服器設定連結，無法在這裡移除。",
+	Unlink: "解除連結",
+	"Unlink {name}?": "要解除連結 {name} 嗎？",
+	"The app will no longer know this account is yours. You can link it again later.":
+		"應用程式將不再知道這個帳號是你的。之後可以再連結。",
+	"Your code": "你的驗證碼",
+	"The code works until {time}.": "驗證碼的有效時間到 {time}。",
+	"A code is waiting to be used.": "有一組驗證碼等著被使用。",
+	"{name} used the code. Confirm that this is you.":
+		"{name} 使用了驗證碼。請確認那是你。",
+	"I did it": "我完成了",
+	"Link {name} first.": "請先連結 {name}。",
+	Link: "連結",
+	"In your quiet hours a normal notice waits in the bell instead of ringing your phone. An urgent one still rings.":
+		"勿擾時段內，一般通知只會留在通知鈴裡，不會響手機；緊急通知照常響。",
+	From: "從",
+	To: "到",
+	"Turn off quiet hours": "關閉勿擾時段",
+	"A test notification is on its way.": "測試通知已送出。",
+	"Send a test notification": "傳送測試通知",
+	"Shown as": "顯示為",
+	"The name and picture of this account are what others see in the app.":
+		"別人在應用程式裡看到的，是這個帳號的名稱與頭像。",
+	Automatic: "自動",
+	"Your accounts": "你的帳號",
+	"Put the app on your phone": "把應用程式放到手機上",
+	"On iPhone and iPad, open this page in Safari, tap Share, then Add to Home Screen, and open the app from there.":
+		"在 iPhone 與 iPad 上，用 Safari 開啟此頁，點「分享」，再點「加入主畫面」，之後從主畫面開啟。",
+	"On a phone, add it to the home screen from the browser's menu so notifications reach you when it is closed.":
+		"在手機上，請從瀏覽器選單加入主畫面，這樣應用程式關著時也收得到通知。",
+	"Allow notifications": "允許通知",
+	"This browser cannot get push notifications.": "這個瀏覽器無法接收推播通知。",
+	"Allowed on this device.": "這台裝置已允許。",
+	"Send a test": "傳送測試",
+	"It arrived. Notifications work on this device.":
+		"收到了。這台裝置的通知可以正常運作。",
+	"Waiting for it…": "等待通知中…",
+	"It has not arrived. Check that notifications are allowed for this app, then send another.":
+		"還沒收到。請確認這個應用程式已允許通知，再傳送一次。",
+	Skip: "略過",
+	"{count} device(s) will get notifications.": "{count} 台裝置會收到通知。",
+	Skipped: "已略過",
+	"There is nothing left to set up.": "沒有需要再設定的項目。",
+	"There is no such notice to handle.": "沒有這則可處理的通知。",
+	"This account has no device that gets push yet. Turn it on first.":
+		"這個帳號還沒有接收推播的裝置，請先開啟推播。",
+	"A receipt needs a tag and received or opened.":
+		"回報需要標籤，以及「已收到」或「已開啟」。",
+	"There is no such notification.": "沒有這則通知。",
+	"Send quiet: {start, end, timeZone} or null.":
+		"請傳入 quiet：{start, end, timeZone}，或 null。",
+	"Send provider: the account's provider, or null for the default.":
+		"請傳入 provider（帳號的提供者），或 null 使用預設。",
+	"There is no picture.": "沒有頭像。",
+	"Send request: the id the code came with.":
+		"請傳入 request：驗證碼附帶的代號。",
+	"That step cannot be waived.": "這個步驟不能略過。",
 };

package/src/index.ts

@@ -12,6 +12,7 @@ export type {
 	ConversationView,
 	DashboardView,
 	GroupView,
+	HostIconName,
 	NoteInput,
 	NoteKind,
 	NoteView,
@@ -26,7 +27,7 @@ export type {
 	TranscriptRole,
 	TranscriptView,
 } from "./api-types.ts";
-export { PANES } from "./api-types.ts";
+export { HOST_ICONS, PANES } from "./api-types.ts";
 export type { CloudflareAccessOptions } from "./cloudflare-access.ts";
 export {
 	cloudflareAccess,
@@ -39,4 +40,17 @@ export type { WebAuthOptions, WebConsoleOptions } from "./options.ts";
 export { DEFAULT_RELAY_NOTE } from "./options.ts";
 export type { RequestVerifier, Verdict } from "./verifier.ts";
 export { admit, admitAs, refuse } from "./verifier.ts";
+export type {
+	ActionResult,
+	HostCard,
+	HostPage,
+	HostRoomKind,
+	LinkProver,
+	Notices,
+	OnboardingStep,
+	OpenTarget,
+	Viewer,
+	WebApp,
+} from "./web-app.ts";
+export { WEB_APP } from "./web-app.ts";
 export { webConsole } from "./web-plugin.ts";

package/src/notices/api.ts

@@ -0,0 +1,43 @@
+import { ConsoleHttpError as HttpError, json } from "../http.ts";
+import type { FrameHandler, PluggedFrames, RouteArea } from "../web-app.ts";
+import type { NoticeService } from "./service.ts";
+
+/**
+ * `GET api/notices` and `POST api/notices/<tag>/ack`. Both are the signed-in person's own: the
+ * principal is the session's, and a notice not addressed to them answers 404 as if there were none.
+ */
+export function noticesArea(notices: NoticeService): RouteArea {
+	return {
+		area: "notices",
+		async handle(request, parts, { visitor }) {
+			try {
+				const principalId = visitor.principal.id;
+				const [tag, action] = parts;
+				if (tag === undefined && request.method === "GET")
+					return json(await notices.listFor(principalId));
+				if (tag !== undefined && action === "ack" && parts.length === 2) {
+					if (request.method !== "POST")
+						throw new HttpError(405, "Method not allowed.");
+					if (!(await notices.ack(tag, principalId)))
+						throw new HttpError(404, "There is no such notice to handle.");
+					return json({ ok: true });
+				}
+				throw new HttpError(404, "There is no such API.");
+			} catch (error) {
+				if (error instanceof HttpError)
+					return json({ error: error.message }, error.status);
+				throw error;
+			}
+		},
+	};
+}
+
+/** The `ack` frame: the person handled a notice. A notice that is not theirs, or needs no answer, is refused. */
+export function ackFrame(
+	notices: NoticeService,
+): FrameHandler<PluggedFrames["ack"]> {
+	return async ({ frame, viewer, refuse }) => {
+		if (!(await notices.ack(frame.tag, viewer.principalId)))
+			refuse("not_accepted");
+	};
+}

package/src/notices/mount.ts

@@ -0,0 +1,292 @@
+import { randomUUID } from "node:crypto";
+import type { SQL } from "bun";
+import type {
+	IdentityService,
+	Logger,
+	Migration,
+	PersonProfiles,
+} from "pi-roundtable";
+import type { AppSocket, Sockets } from "../app/sockets.ts";
+import type { Gate } from "../gate.ts";
+import { onboardingArea } from "../onboarding/api.ts";
+import { OnboardingService, PUSH_STEP } from "../onboarding/service.ts";
+import { builtInSteps } from "../onboarding/steps.ts";
+import { OnboardingWaivers } from "../onboarding/waivers.ts";
+import type { ResolvedOptions } from "../options.ts";
+import { linksArea, peopleArea, profileArea } from "../profile/api.ts";
+import { LinkService } from "../profile/links.ts";
+import { DeviceRoutes, PushApi } from "../push/api.ts";
+import { PushDispatch } from "../push/dispatch.ts";
+import { OutboxSender, type PushTransport } from "../push/drain.ts";
+import type { EndpointPolicy } from "../push/endpoint.ts";
+import {
+	type OutboxKind,
+	PushOutbox,
+	type ReceiptEvent,
+} from "../push/outbox.ts";
+import { PushPrefsStore } from "../push/prefs.ts";
+import type { PushSubscriptions } from "../push/subscriptions.ts";
+import type { OutboxRoute } from "../push/triggers.ts";
+import type { Vapid } from "../push/vapid.ts";
+import { webPushTransport } from "../push/web-push-transport.ts";
+import type { WebAppRegistry } from "../web-app.ts";
+import { ackFrame, noticesArea } from "./api.ts";
+import { NoticeService } from "./service.ts";
+import { NoticeStore } from "./store.ts";
+
+/** The tables of notices, push delivery, preferences and waivers. */
+export const NOTICE_MIGRATIONS: readonly Migration[] = [
+	NoticeStore.migration,
+	PushOutbox.migration,
+	PushPrefsStore.migration,
+	OnboardingWaivers.migration,
+];
+
+/** The words of a push the app sends itself when its row carries none (`push.content: "none"`). */
+const WORDS: Record<OutboxKind, string> = {
+	card: "Card waiting",
+	reply: "New reply",
+	notice: "Notice",
+	test: "Test notification",
+	clear: "",
+};
+
+export interface NoticesMountOptions {
+	database: SQL;
+	logger: Logger;
+	registry: WebAppRegistry;
+	gate: Gate;
+	sockets: Pick<Sockets, "anyVisible" | "deliver">;
+	identity: IdentityService;
+	/** Present on every host that has the identity plugin; the profile page needs it. */
+	profiles?: PersonProfiles;
+	subscriptions: PushSubscriptions;
+	policy: EndpointPolicy;
+	mount: string;
+	routing: "hash" | "path";
+	/** The tiers, content, sender and transports the options resolved to. */
+	push: Pick<
+		ResolvedOptions["push"],
+		| "tiers"
+		| "content"
+		| "preview"
+		| "sender"
+		| "transports"
+		| "subject"
+		| "endpointHosts"
+		| "fetch"
+	>;
+	/** The operator's quiet window for a normal notice; absent = none. */
+	quiet?: (at: number) => boolean;
+	/** The app's own key, present with the internal sender. */
+	vapid?: Vapid;
+	onboarding: ResolvedOptions["onboarding"];
+}
+
+export interface NoticesMount {
+	notices: NoticeService;
+	pushApi: PushApi;
+	/** Present when the app does not sign: the built-in pushes are queued for the external sender. */
+	route?: OutboxRoute;
+	outbox: PushOutbox;
+	/** Sends a socket its notices and the badge once it is ready. */
+	opened(connection: AppSocket): Promise<void>;
+	start(): void;
+	stop(): Promise<void>;
+}
+
+/**
+ * Builds the notices, the push outbox and its in-process sender (internal mode), the onboarding
+ * service and the profile and link routes, and registers them with the web app. A host plugin
+ * reaches the first three through `WEB_APP` once the web service has started.
+ */
+export function mountNotices(options: NoticesMountOptions): NoticesMount {
+	const { database, registry, sockets, identity, logger, push } = options;
+	const outbox = new PushOutbox(database);
+	const prefs = new PushPrefsStore(database);
+	const external = push.sender !== "internal";
+	const enabled = external || push.subject !== undefined;
+	const transports: PushTransport[] = [];
+	if (!external && options.vapid && push.subject)
+		transports.push(
+			webPushTransport({
+				vapid: options.vapid,
+				subject: push.subject,
+				endpointHosts: push.endpointHosts,
+				database,
+				...(push.fetch ? { fetch: push.fetch } : {}),
+				logger,
+			}),
+		);
+	const sender = external
+		? undefined
+		: new OutboxSender({
+				outbox,
+				transports,
+				render: (row) => ({
+					title: row.title ?? WORDS[row.kind],
+					...(row.body ? { body: row.body } : {}),
+				}),
+				logger,
+			});
+	const dispatch = new PushDispatch({
+		outbox,
+		prefs,
+		identity,
+		tiers: push.tiers,
+		content: push.content,
+		preview: push.preview,
+		visible: (principalId) => sockets.anyVisible(principalId),
+		...(options.quiet ? { quiet: options.quiet } : {}),
+		...(sender
+			? { kick: () => void sender.drain().catch(() => undefined) }
+			: {}),
+		enabled,
+		transports: push.transports,
+		logger,
+	});
+	const routing = { mount: options.mount, routing: options.routing };
+	const store = new NoticeStore(database);
+	const notices = new NoticeService({
+		store,
+		dispatch,
+		deliver: (frame, principal) => sockets.deliver(frame, { principal }),
+		routing,
+		logger,
+	});
+	const pushStatus = {
+		status: async (principalId: string) => {
+			const lastReceiptAt = await outbox.lastReceiptAt(principalId);
+			return {
+				devices: (await options.subscriptions.of(principalId)).length,
+				...(lastReceiptAt ? { lastReceiptAt } : {}),
+				waived: await registry.waived(principalId, PUSH_STEP),
+			};
+		},
+	};
+	const waivers = new OnboardingWaivers(database);
+	registry.setWaivers(waivers);
+	const onboarding = new OnboardingService({
+		registry,
+		waivers,
+		gate: options.gate,
+		identity,
+		...(options.profiles ? { profiles: options.profiles } : {}),
+		push: pushStatus,
+		logger,
+	});
+	const links = new LinkService({
+		registry,
+		steps: options.onboarding.links,
+		identity,
+		gate: options.gate,
+		logger,
+	});
+	registry.provide({ notices, onboarding, push: pushStatus });
+	for (const step of builtInSteps({
+		links: options.onboarding.links,
+		push: {
+			mode: options.onboarding.push,
+			waiver: options.onboarding.pushWaiver,
+		},
+		pushTiers: push.tiers,
+		prover: (provider) => registry.prover(provider),
+		identity,
+		outbox,
+	}))
+		registry.registerStep(step);
+	registry.onArea(noticesArea(notices));
+	registry.onArea(onboardingArea(onboarding));
+	registry.onArea(linksArea(links));
+	registry.onArea(
+		peopleArea({
+			profiles: options.profiles ?? { picture: async () => undefined },
+			gate: options.gate,
+		}),
+	);
+	if (options.profiles)
+		registry.onArea(
+			profileArea({
+				profiles: options.profiles,
+				identity,
+				sessionLabel: "Sign-in account",
+			}),
+		);
+	registry.onFrame("ack", ackFrame(notices));
+
+	const receipt = async (
+		principalId: string,
+		tag: string,
+		event: ReceiptEvent,
+	): Promise<boolean> => {
+		const mine = tag.startsWith("test:")
+			? await outbox.has(principalId, "test", tag)
+			: await notices.receipt(tag, principalId, event);
+		if (!mine) return false;
+		await outbox.receipt(principalId, tag, event);
+		// A receipt may finish the push step: the gate asks again.
+		onboarding.changed(principalId);
+		return true;
+	};
+	const pushApi = new PushApi({
+		vapid: {
+			publicKey:
+				push.sender === "internal"
+					? (options.vapid?.publicKey ?? "")
+					: push.sender.external.publicKey,
+		},
+		devices: new DeviceRoutes({
+			policy: options.policy,
+			subscriptions: options.subscriptions,
+			enabled,
+		}),
+		tiers: push.tiers,
+		subscriptions:
+			push.sender === "internal" || !push.sender.external.subscribePath,
+		...(enabled
+			? {
+					test: async (principalId: string) => {
+						if ((await options.subscriptions.of(principalId)).length === 0)
+							return "no-device" as const;
+						const tag = `test:${randomUUID()}`;
+						await dispatch.test(
+							principalId,
+							tag,
+							`${options.mount}/`,
+							await notices.badge(principalId),
+						);
+						return { tag };
+					},
+				}
+			: {}),
+		receipt,
+		prefs,
+	});
+	const route: OutboxRoute | undefined = external
+		? { outbox, content: push.content, badge: (id) => notices.badge(id) }
+		: undefined;
+	let sweeper: ReturnType<typeof setInterval> | undefined;
+	return {
+		notices,
+		pushApi,
+		...(route ? { route } : {}),
+		outbox,
+		opened: async (connection) => {
+			for (const frame of await notices.frames(connection.principal.id))
+				sockets.deliver(frame, { connection });
+		},
+		start: () => {
+			sender?.start();
+			const sweep = () =>
+				Promise.all([store.sweep(), outbox.sweep()]).catch((error: unknown) =>
+					logger.warn({ err: error }, "old notices were not deleted"),
+				);
+			void sweep();
+			sweeper = setInterval(sweep, 3_600_000);
+		},
+		stop: async () => {
+			clearInterval(sweeper);
+			await sender?.stop();
+		},
+	};
+}