@serverkgg/bridge 0.0.1 → 0.0.2

package/src/runtime/bridgeRegistry.ts

@@ -1,7 +1,12 @@
 import type { BridgeContext } from "../context";
 import { BridgeAction, BridgeKind, type BridgeRow, type BridgeValues } from "../core";
-import type { BridgeDriver, BridgePanelModule } from "../modules";
-import { BRIDGE_VERSION, type BridgeManifest, type BridgeModuleManifest } from "../protocol";
+import type { BridgeDriver, BridgePanelModule, BridgeTerminalModule } from "../modules";
+import {
+	BRIDGE_VERSION,
+	type BridgeManifest,
+	type BridgeModuleManifest,
+	type BridgeTerminalManifest,
+} from "../protocol";
 import { BridgeDriverError } from "./bridgeDriver";
 import type { BridgeEventRing } from "./bridgeEvents";
 import type { BridgeSupervisor } from "./bridgeSupervisor";
@@ -48,6 +53,11 @@ const actionsOf = (module: BridgePanelModule) => {
 				BridgeAction.Installed,
 				BridgeAction.Remove,
 				BridgeAction.Search,
+				...(module.toggle
+					? [
+							BridgeAction.Toggle,
+						]
+					: []),
 			];
 		}
 	}
@@ -69,6 +79,24 @@ const pageSizeOf = (module: BridgePanelModule) => {
 	return module.kind === BridgeKind.Catalog ? (module.pageSize ?? null) : null;
 };
 
+const terminalManifestOf = (module: BridgeTerminalModule | undefined): BridgeTerminalManifest | null => {
+	if (!module) {
+		return null;
+	}
+
+	return {
+		commands: module.commands,
+		rules: (module.rules ?? []).map((rule) => {
+			return {
+				match: rule.match.source,
+				flags: rule.match.flags,
+				level: rule.level,
+				stream: rule.stream,
+			};
+		}),
+	};
+};
+
 const withVariables = (context: BridgeContext, overlay: Record<string, string>): BridgeContext => {
 	return {
 		get server() {
@@ -97,9 +125,7 @@ const withVariables = (context: BridgeContext, overlay: Record<string, string>):
 		emit(event, payload) {
 			context.emit(event, payload);
 		},
-		log(message, fields) {
-			context.log(message, fields);
-		},
+		log: context.log,
 	};
 };
 
@@ -119,6 +145,12 @@ const asText = (args: BridgeValues, key: string) => {
 	return typeof value === "string" ? value : "";
 };
 
+const asOptional = (args: BridgeValues, key: string) => {
+	const value = args[key];
+
+	return typeof value === "string" && value.length > 0 ? value : null;
+};
+
 const asPage = (args: BridgeValues) => {
 	const value = args.page;
 
@@ -246,7 +278,13 @@ export const createRegistry = (
 
 			case BridgeKind.Catalog: {
 				if (action === BridgeAction.Search) {
-					return await module.search(context, asText(args, "query"), asPage(args));
+					return await module.search(context, {
+						query: asText(args, "query"),
+						page: asPage(args),
+						provider: asOptional(args, "provider"),
+						category: asOptional(args, "category"),
+						sort: asOptional(args, "sort"),
+					});
 				}
 
 				if (action === BridgeAction.Installed) {
@@ -263,6 +301,12 @@ export const createRegistry = (
 					return null;
 				}
 
+				if (action === BridgeAction.Toggle && module.toggle) {
+					await module.toggle(context, asString(args, "id"), args.enabled !== false);
+
+					return null;
+				}
+
 				break;
 			}
 		}
@@ -287,6 +331,7 @@ export const createRegistry = (
 			return {
 				version: BRIDGE_VERSION,
 				panel: driver.panel ?? null,
+				terminal: terminalManifestOf(driver.terminal),
 				modules: entries,
 				events: ring.names(),
 			};

package/src/runtime/bridgeServer.ts

@@ -1,8 +1,10 @@
 import { timingSafeEqual } from "node:crypto";
-import { BridgeSecretError, type BridgeValues } from "../core";
+import { BridgeFailureError, BridgeSecretError, type BridgeValues, type LocalizedText } from "../core";
 import {
 	BRIDGE_FRAME_LIMIT,
+	type BridgeAnnounceResult,
 	type BridgeCommandResult,
+	type BridgeDescribeResult,
 	type BridgeEventsResult,
 	type BridgeManifest,
 	BridgeMethod,
@@ -26,6 +28,8 @@ export interface ServerOptions {
 	onSample: () => Promise<BridgeSampleResult>;
 	onQuiesce: () => Promise<BridgeQuiesceResult>;
 	onRelease: () => Promise<void>;
+	onDescribe: () => Promise<BridgeDescribeResult>;
+	onAnnounce: (message: LocalizedText) => Promise<BridgeAnnounceResult>;
 	onLog: BridgeLogger;
 }
 
@@ -40,8 +44,26 @@ interface IncomingFrame {
 	action?: unknown;
 	args?: unknown;
 	cursor?: unknown;
+	message?: unknown;
 }
 
+const asMessage = (value: unknown): LocalizedText | null => {
+	if (value === null || typeof value !== "object") {
+		return null;
+	}
+
+	const { ar, en } = value as Record<string, unknown>;
+
+	if (typeof ar !== "string" || typeof en !== "string") {
+		return null;
+	}
+
+	return {
+		ar,
+		en,
+	};
+};
+
 const matches = (left: string, right: string) => {
 	const a = Buffer.from(left);
 	const b = Buffer.from(right);
@@ -122,6 +144,20 @@ export const createServer = (options: ServerOptions) => {
 				return null;
 			}
 
+			case BridgeMethod.Describe: {
+				return await options.onDescribe();
+			}
+
+			case BridgeMethod.Announce: {
+				const message = asMessage(request.message);
+
+				if (!message) {
+					throw new Error("announce needs a message with ar and en text");
+				}
+
+				return await options.onAnnounce(message);
+			}
+
 			default: {
 				throw new Error(`unknown method "${method}"`);
 			}
@@ -205,6 +241,12 @@ export const createServer = (options: ServerOptions) => {
 							);
 						})
 						.catch((error: unknown) => {
+							options.onLog("bridge call failed", {
+								method: String(request.method ?? ""),
+								error: errorText(error),
+								stack: error instanceof Error ? (error.stack ?? null) : null,
+							});
+
 							socket.write(
 								encode({
 									id,
@@ -215,6 +257,11 @@ export const createServer = (options: ServerOptions) => {
 												secret: error.key,
 											}
 										: {}),
+									...(error instanceof BridgeFailureError
+										? {
+												failure: error.code,
+											}
+										: {}),
 								}),
 							);
 						});

package/src/runtime/bridgeSupervisor.ts

@@ -1,6 +1,6 @@
 import type { BridgeCommandOptions, BridgeReply } from "../context";
 import { BridgeRuntime, BridgeStream } from "../core";
-import type { BridgeLogger } from "./bridgeLog";
+import type { BridgeLeveledLogger } from "./bridgeLog";
 import { errorText } from "./bridgeLog";
 import { settleUid, unprivilegedArgv } from "./bridgePrivilege";
 
@@ -32,7 +32,7 @@ export interface SupervisorOptions {
 	resolveCommand: () => Promise<string[]>;
 	gracefulStop?: () => Promise<void>;
 	onReady?: () => void;
-	onLog: BridgeLogger;
+	onLog: BridgeLeveledLogger;
 }
 
 type LineWatcher = (entry: SupervisorLine) => void;
@@ -295,7 +295,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 		} catch (error) {
 			runtime = BridgeRuntime.Crashed;
 
-			options.onLog("game failed to restart", {
+			options.onLog.error("game failed to restart", {
 				error: errorText(error),
 			});
 		}
@@ -322,7 +322,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 			breaker = true;
 			runtime = BridgeRuntime.Crashed;
 
-			options.onLog("game crash loop detected, not restarting", {
+			options.onLog.error("game crash loop detected, not restarting", {
 				code,
 				restarts,
 			});
@@ -332,7 +332,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 
 		runtime = BridgeRuntime.Starting;
 
-		options.onLog("game exited, restarting", {
+		options.onLog.warn("game exited, restarting", {
 			code,
 			restarts,
 		});
@@ -405,7 +405,7 @@ export const createSupervisor = (options: SupervisorOptions) => {
 
 			if (options.gracefulStop) {
 				const graceful = options.gracefulStop().catch((error: unknown) => {
-					options.onLog("graceful stop failed", {
+					options.onLog.warn("graceful stop failed", {
 						error: errorText(error),
 					});
 				});

package/src/runtime/index.ts

@@ -1,18 +1 @@
-export * from "./bridgeCodec";
-export * from "./bridgeConfigReader";
-export * from "./bridgeContext";
-export * from "./bridgeDriver";
-export * from "./bridgeEvents";
-export * from "./bridgeExec";
-export * from "./bridgeFiles";
-export * from "./bridgeLog";
-export * from "./bridgeNet";
-export * from "./bridgePath";
-export * from "./bridgePrivilege";
-export * from "./bridgeProbe";
-export * from "./bridgeRegistry";
-export * from "./bridgeServer";
-export * from "./bridgeState";
-export * from "./bridgeSupervisor";
-export * from "./bridgeZip";
 export * from "./serve";

package/src/runtime/serve.ts

@@ -79,7 +79,7 @@ export const serve = async (driver: BridgeDriver) => {
 		},
 		onReady() {
 			void Promise.resolve(driver.lifecycle.onReady?.(context)).catch((error: unknown) => {
-				log("lifecycle ready hook failed", {
+				log.warn("lifecycle ready hook failed", {
 					error: errorText(error),
 				});
 			});
@@ -219,6 +219,47 @@ export const serve = async (driver: BridgeDriver) => {
 				await driver.backup?.release?.(context);
 			}
 		},
+		async onDescribe() {
+			const describe = driver.install.describe;
+
+			if (!describe) {
+				return {
+					supported: false,
+					version: null,
+					variant: null,
+					build: null,
+				};
+			}
+
+			return {
+				supported: true,
+				...(await describe(context)),
+			};
+		},
+		async onAnnounce(message) {
+			const announce = driver.announce;
+
+			if (!announce) {
+				return {
+					supported: false,
+					delivered: false,
+				};
+			}
+
+			if (!supervisor.running) {
+				return {
+					supported: true,
+					delivered: false,
+				};
+			}
+
+			await announce.announce(context, message);
+
+			return {
+				supported: true,
+				delivered: true,
+			};
+		},
 	});
 
 	await chmod(socketPath(config), SOCKET_MODE);
@@ -271,7 +312,7 @@ export const serve = async (driver: BridgeDriver) => {
 
 		supervisor.setRuntime(BridgeRuntime.Crashed);
 
-		log("install failed", {
+		log.error("install failed", {
 			error: installError,
 		});
 
@@ -286,7 +327,7 @@ export const serve = async (driver: BridgeDriver) => {
 		} catch (error) {
 			supervisor.setRuntime(BridgeRuntime.Crashed);
 
-			log("start failed", {
+			log.error("start failed", {
 				error: errorText(error),
 			});
 		}

package/src/terminal/bridgeTerminalArg.ts

@@ -0,0 +1,11 @@
+import type { LocalizedText } from "../core";
+
+export interface BridgeTerminalArg {
+	key: string;
+	label?: LocalizedText;
+	required?: boolean;
+	variadic?: boolean;
+	values?: string[];
+	module?: string;
+	column?: string;
+}

package/src/terminal/bridgeTerminalCommand.ts

@@ -0,0 +1,11 @@
+import type { LocalizedText } from "../core";
+import type { BridgeTerminalArg } from "./bridgeTerminalArg";
+
+export interface BridgeTerminalCommand {
+	name: string;
+	summary: LocalizedText;
+	syntax?: string;
+	args?: BridgeTerminalArg[];
+	danger?: boolean;
+	requiresRunning?: boolean;
+}

package/src/terminal/bridgeTerminalLevel.ts

@@ -0,0 +1,6 @@
+export enum BridgeTerminalLevel {
+	Debug = "debug",
+	Info = "info",
+	Warn = "warn",
+	Error = "error",
+}

package/src/terminal/bridgeTerminalRule.ts

@@ -0,0 +1,8 @@
+import type { BridgeStream } from "../core";
+import type { BridgeTerminalLevel } from "./bridgeTerminalLevel";
+
+export interface BridgeTerminalRule {
+	match: RegExp;
+	level: BridgeTerminalLevel;
+	stream?: BridgeStream;
+}

package/src/terminal/index.ts

@@ -0,0 +1,4 @@
+export * from "./bridgeTerminalArg";
+export * from "./bridgeTerminalCommand";
+export * from "./bridgeTerminalLevel";
+export * from "./bridgeTerminalRule";

package/src/manifest/checks.ts

@@ -1,50 +0,0 @@
-import type { Manifest, ManifestPort } from "./manifest";
-
-const overlaps = (a: ManifestPort, b: ManifestPort) => {
-	return a.host.min <= b.host.max && b.host.min <= a.host.max;
-};
-
-export const checkManifest = (manifest: Manifest) => {
-	const portKeys = manifest.runtime.ports.map((port) => port.key);
-
-	if (new Set(portKeys).size !== portKeys.length) {
-		throw new Error("runtime declares duplicate port keys");
-	}
-
-	const ports = manifest.runtime.ports;
-
-	for (let index = 0; index < ports.length; index += 1) {
-		for (let other = index + 1; other < ports.length; other += 1) {
-			const a = ports[index];
-			const b = ports[other];
-
-			if (!a || !b || a.protocol !== b.protocol) {
-				continue;
-			}
-
-			if (overlaps(a, b)) {
-				throw new Error(`ports "${a.key}" and "${b.key}" declare overlapping ${a.protocol} host ranges`);
-			}
-		}
-	}
-
-	const guideIds = manifest.guides.map((guide) => guide.id);
-
-	if (new Set(guideIds).size !== guideIds.length) {
-		throw new Error("guides declare duplicate ids");
-	}
-
-	const bodies: string[] = [];
-
-	for (const guide of manifest.guides) {
-		if (guide.body.ar === guide.body.en) {
-			throw new Error(`guide "${guide.id}" reuses one body file for both locales`);
-		}
-
-		bodies.push(guide.body.ar, guide.body.en);
-	}
-
-	if (new Set(bodies).size !== bodies.length) {
-		throw new Error("guides declare duplicate body paths");
-	}
-};