@serverkgg/bridge 0.0.1 → 0.0.3

package/src/modules/bridgeModule.ts

@@ -1,9 +1,15 @@
 import type { BridgeContext } from "../context";
 import type { BridgeKind, BridgeOption, BridgeRow, BridgeStream, BridgeValues } from "../core";
+import type { BridgeCatalogEntry, BridgeCatalogPage, BridgeCatalogQuery } from "../protocol/bridgeCatalog";
+import type { BridgeDescribeResult } from "../protocol/bridgeFrame";
+import type { BridgeTerminalCommand, BridgeTerminalRule } from "../terminal";
+
+export type BridgeDescription = Omit<BridgeDescribeResult, "supported">;
 
 export interface BridgeInstallModule {
 	kind: BridgeKind.Install;
 	run(context: BridgeContext): Promise<void>;
+	describe?(context: BridgeContext): Promise<BridgeDescription>;
 }
 
 export interface BridgeLifecycleModule {
@@ -15,6 +21,11 @@ export interface BridgeLifecycleModule {
 	onReady?(context: BridgeContext): Promise<void>;
 }
 
+export interface BridgeAnnounceModule {
+	kind: BridgeKind.Announce;
+	announce(context: BridgeContext, message: string): Promise<void>;
+}
+
 export interface BridgeBackupModule {
 	kind: BridgeKind.Backup;
 	settleSeconds?: number;
@@ -42,6 +53,13 @@ export interface BridgeEventPattern {
 export interface BridgeEventsModule {
 	kind: BridgeKind.Events;
 	patterns: BridgeEventPattern[];
+	emits?: string[];
+}
+
+export interface BridgeTerminalModule {
+	kind: BridgeKind.Terminal;
+	commands: BridgeTerminalCommand[];
+	rules?: BridgeTerminalRule[];
 }
 
 export interface BridgeOptionsModule {
@@ -57,7 +75,19 @@ export interface BridgeSettingsModule {
 	write?(context: BridgeContext, values: BridgeValues): Promise<void>;
 }
 
-export type BridgeRowAction<Row extends BridgeRow = BridgeRow> = (context: BridgeContext, row: Row) => Promise<void>;
+export type BridgeRowAction<Row extends BridgeRow = BridgeRow> = (
+	context: BridgeContext,
+	row: Row,
+	args: BridgeValues,
+) => Promise<void>;
+
+export type BridgeServerAction = (context: BridgeContext, args: BridgeValues) => Promise<void>;
+
+export interface BridgeActionsModule {
+	kind: BridgeKind.Actions;
+	requiresRunning?: boolean;
+	actions: Record<string, BridgeServerAction>;
+}
 
 export interface BridgeCollectionModule<Row extends BridgeRow = BridgeRow> {
 	kind: BridgeKind.Collection;
@@ -68,45 +98,27 @@ export interface BridgeCollectionModule<Row extends BridgeRow = BridgeRow> {
 	actions?: Record<string, BridgeRowAction<Row>>;
 }
 
-export interface BridgeCatalogHit {
-	id: string;
-	title: string;
-	description: string;
-	icon: string | null;
-	downloads: number;
-	pageUrl?: string | null;
-}
-
-export interface BridgeCatalogPage {
-	hits: BridgeCatalogHit[];
-	total: number;
-}
-
-export interface BridgeCatalogEntry {
-	id: string;
-	path: string;
-	title: string;
-	version: string | null;
-	sizeBytes: number;
-}
-
 export interface BridgeCatalogModule {
 	kind: BridgeKind.Catalog;
 	pageSize?: number;
-	search(context: BridgeContext, query: string, page: number): Promise<BridgeCatalogPage>;
+	search(context: BridgeContext, query: BridgeCatalogQuery): Promise<BridgeCatalogPage>;
 	installed(context: BridgeContext): Promise<BridgeCatalogEntry[]>;
 	install(context: BridgeContext, id: string): Promise<BridgeCatalogEntry>;
 	remove(context: BridgeContext, id: string): Promise<void>;
+	toggle?(context: BridgeContext, id: string, enabled: boolean): Promise<void>;
 }
 
 export type BridgePanelModule =
+	| BridgeActionsModule
 	| BridgeCatalogModule
 	| BridgeCollectionModule
 	| BridgeOptionsModule
 	| BridgeSettingsModule;
 
 export type BridgeModule =
+	| BridgeAnnounceModule
 	| BridgeBackupModule
+	| BridgeTerminalModule
 	| BridgeEventsModule
 	| BridgeInstallModule
 	| BridgeLifecycleModule

package/src/panel/bridgeAccess.ts

@@ -0,0 +1,3 @@
+export enum BridgeAccess {
+	Invoke = "invoke",
+}

package/src/panel/bridgeLayout.ts

@@ -1,4 +1,5 @@
 export enum BridgeLayout {
+	Actions = "actions",
 	Cards = "cards",
 	Catalog = "catalog",
 	Form = "form",

package/src/panel/bridgePanel.ts

@@ -1,4 +1,5 @@
 import type { BridgeOption, LocalizedText } from "../core";
+import type { BridgeAccess } from "./bridgeAccess";
 import type { BridgeConfirm } from "./bridgeConfirm";
 import type { BridgeControl } from "./bridgeControl";
 import type { BridgeFormTarget } from "./bridgeFormTarget";
@@ -7,7 +8,8 @@ import type { BridgeLayout } from "./bridgeLayout";
 
 export interface BridgeVisibleWhen {
 	variable: string;
-	values: string[];
+	values?: string[];
+	empty?: boolean;
 }
 
 export interface BridgeOptionsRef {
@@ -33,6 +35,9 @@ export interface BridgeSectionAction {
 	id: string;
 	label: LocalizedText;
 	confirm?: BridgeConfirm;
+	confirmText?: LocalizedText;
+	download?: boolean;
+	fields?: BridgeField[];
 }
 
 export interface BridgeSectionAdd {
@@ -40,6 +45,23 @@ export interface BridgeSectionAdd {
 	placeholder?: string;
 }
 
+export interface BridgeSectionUpload {
+	label: LocalizedText;
+	extensions: string[];
+	staging: string;
+}
+
+export interface BridgeActionsSection {
+	layout: BridgeLayout.Actions;
+	id: string;
+	title?: LocalizedText;
+	help?: LocalizedText;
+	module: string;
+	actions: BridgeSectionAction[];
+	visibleWhen?: BridgeVisibleWhen;
+	access?: BridgeAccess;
+}
+
 export interface BridgeFormSection {
 	layout: BridgeLayout.Form;
 	id: string;
@@ -52,6 +74,7 @@ export interface BridgeFormSection {
 	confirmText?: LocalizedText;
 	fields: BridgeField[];
 	visibleWhen?: BridgeVisibleWhen;
+	access?: BridgeAccess;
 }
 
 export interface BridgeColumn {
@@ -64,11 +87,14 @@ export interface BridgeTableSection {
 	id: string;
 	title?: LocalizedText;
 	module: string;
+	restartHint?: boolean;
 	columns: BridgeColumn[];
 	add?: BridgeSectionAdd;
+	upload?: BridgeSectionUpload;
 	actions?: BridgeSectionAction[];
 	empty?: LocalizedText;
 	visibleWhen?: BridgeVisibleWhen;
+	access?: BridgeAccess;
 }
 
 export interface BridgeCardsSection {
@@ -81,6 +107,7 @@ export interface BridgeCardsSection {
 	actions?: BridgeSectionAction[];
 	empty?: LocalizedText;
 	visibleWhen?: BridgeVisibleWhen;
+	access?: BridgeAccess;
 }
 
 export interface BridgeCatalogSection {
@@ -89,17 +116,28 @@ export interface BridgeCatalogSection {
 	title?: LocalizedText;
 	module: string;
 	restartHint?: boolean;
+	reinstall?: boolean;
+	variable?: string;
+	confirm?: BridgeConfirm;
+	confirmText?: LocalizedText;
 	empty?: LocalizedText;
 	visibleWhen?: BridgeVisibleWhen;
+	access?: BridgeAccess;
 }
 
-export type BridgeSection = BridgeCardsSection | BridgeCatalogSection | BridgeFormSection | BridgeTableSection;
+export type BridgeSection =
+	| BridgeActionsSection
+	| BridgeCardsSection
+	| BridgeCatalogSection
+	| BridgeFormSection
+	| BridgeTableSection;
 
 export interface BridgeTab {
 	id: string;
 	title: LocalizedText;
 	icon?: BridgeIcon;
 	sections: BridgeSection[];
+	access?: BridgeAccess;
 }
 
 export interface BridgePanel {

package/src/panel/index.ts

@@ -1,3 +1,4 @@
+export * from "./bridgeAccess";
 export * from "./bridgeConfirm";
 export * from "./bridgeControl";
 export * from "./bridgeFormTarget";

package/src/protocol/bridgeCatalog.ts

@@ -0,0 +1,57 @@
+import type { LocalizedText } from "../core";
+
+export interface BridgeCatalogProvider {
+	id: string;
+	label: LocalizedText;
+	ready: boolean;
+	note?: LocalizedText;
+}
+
+export interface BridgeCatalogFacet {
+	value: string;
+	label: LocalizedText;
+}
+
+export interface BridgeCatalogHit {
+	id: string;
+	provider: string;
+	title: string;
+	description: string;
+	icon: string | null;
+	downloads: number;
+	author: string | null;
+	categories: string[];
+	updatedAt: string | null;
+	pageUrl: string | null;
+}
+
+export interface BridgeCatalogPage {
+	hits: BridgeCatalogHit[];
+	total: number;
+	providers: BridgeCatalogProvider[];
+	categories: BridgeCatalogFacet[];
+	sorts: BridgeCatalogFacet[];
+}
+
+export interface BridgeCatalogEntry {
+	id: string;
+	provider: string | null;
+	path: string;
+	title: string;
+	version: string | null;
+	sizeBytes: number;
+	enabled: boolean;
+	gameVersion: string | null;
+	stale: boolean;
+	pageUrl: string | null;
+	icon: string | null;
+	variables?: Record<string, string> | null;
+}
+
+export interface BridgeCatalogQuery {
+	query: string;
+	page: number;
+	provider: string | null;
+	category: string | null;
+	sort: string | null;
+}

package/src/protocol/bridgeEgress.ts

@@ -0,0 +1,53 @@
+export const BRIDGE_EGRESS_SOCKET_NAME = "egress.sock";
+
+export const BRIDGE_EGRESS_FRAME_LIMIT = 16 * 1024 * 1024;
+
+export const BRIDGE_EGRESS_BODY_LIMIT = 8 * 1024 * 1024;
+
+export const BRIDGE_EGRESS_DOWNLOAD_LIMIT = 512 * 1024 * 1024;
+
+export enum BridgeEgressMethod {
+	Fetch = "fetch",
+	Download = "download",
+}
+
+export interface BridgeEgressRequest {
+	id: number;
+	token: string;
+	method: BridgeEgressMethod;
+	url: string;
+	headers?: Record<string, string>;
+	timeoutMs?: number;
+	cache?: boolean;
+	cacheSeconds?: number;
+	refresh?: boolean;
+	digest?: string;
+	sizeBytes?: number;
+}
+
+export interface BridgeEgressFetchResult {
+	status: number;
+	body: string;
+	fromCache: boolean;
+}
+
+export interface BridgeEgressDownloadResult {
+	status: number;
+	sizeBytes: number;
+	fromCache: boolean;
+}
+
+export interface BridgeEgressSuccess<Result> {
+	id: number | null;
+	ok: true;
+	result: Result;
+}
+
+export interface BridgeEgressFailure {
+	id: number | null;
+	ok: false;
+	error: string;
+	status: number | null;
+}
+
+export type BridgeEgressResponse<Result> = BridgeEgressFailure | BridgeEgressSuccess<Result>;

package/src/protocol/bridgeEvents.ts

@@ -0,0 +1,20 @@
+export enum BridgeEventName {
+	GameModeChanged = "GameModeChanged",
+	MissingDependency = "MissingDependency",
+	PlayerJoined = "PlayerJoined",
+	PlayerLeft = "PlayerLeft",
+	PortBindFailed = "PortBindFailed",
+	ServerCrashed = "ServerCrashed",
+	ServerStarted = "ServerStarted",
+	ServerStopping = "ServerStopping",
+	TickLagging = "TickLagging",
+	WorldCorrupt = "WorldCorrupt",
+	WorldSaved = "WorldSaved",
+	WrongJavaVersion = "WrongJavaVersion",
+}
+
+export const BRIDGE_EVENT_NAMES: readonly string[] = Object.values(BridgeEventName);
+
+export const isBridgeEventName = (name: string): boolean => {
+	return BRIDGE_EVENT_NAMES.includes(name);
+};

package/src/protocol/bridgeFrame.ts

@@ -13,7 +13,9 @@ export const BRIDGE_FRAME_LIMIT = 1024 * 1024;
 export const BRIDGE_INSTALL_ERROR_LIMIT = 2048;
 
 export enum BridgeMethod {
+	Announce = "announce",
 	Command = "command",
+	Describe = "describe",
 	Events = "events",
 	Invoke = "invoke",
 	Manifest = "manifest",
@@ -36,6 +38,7 @@ export interface BridgeRequest {
 	action?: string;
 	args?: BridgeValues;
 	cursor?: number;
+	message?: string;
 }
 
 export interface BridgeCommandResult {
@@ -55,6 +58,7 @@ export interface BridgeFailure {
 	ok: false;
 	error: string;
 	secret?: string;
+	failure?: string;
 }
 
 export type BridgeResponse = BridgeFailure | BridgeSuccess;
@@ -73,12 +77,24 @@ export interface BridgeSampleResult {
 	max: number | null;
 }
 
+export interface BridgeAnnounceResult {
+	supported: boolean;
+	delivered: boolean;
+}
+
 export interface BridgeQuiesceResult {
 	supported: boolean;
 	quiesced: boolean;
 	settleSeconds: number;
 }
 
+export interface BridgeDescribeResult {
+	supported: boolean;
+	version: string | null;
+	variant: string | null;
+	build: string | null;
+}
+
 export interface BridgeEvent {
 	seq: number;
 	event: string;

package/src/protocol/bridgeLimits.ts

@@ -0,0 +1,41 @@
+export const BRIDGE_PANEL_TABS_LIMIT = 8;
+
+export const BRIDGE_TAB_SECTIONS_LIMIT = 8;
+
+export const BRIDGE_FORM_FIELDS_LIMIT = 32;
+
+export const BRIDGE_TABLE_COLUMNS_LIMIT = 8;
+
+export const BRIDGE_ROW_ACTIONS_LIMIT = 8;
+
+export const BRIDGE_SECTION_ACTIONS_LIMIT = 10;
+
+export const BRIDGE_ACTION_FIELDS_LIMIT = 5;
+
+export const BRIDGE_FIELD_OPTIONS_LIMIT = 64;
+
+export const BRIDGE_VISIBLE_VALUES_LIMIT = 16;
+
+export const BRIDGE_UPLOAD_EXTENSIONS_LIMIT = 8;
+
+export const BRIDGE_MODULES_LIMIT = 32;
+
+export const BRIDGE_MODULE_ACTIONS_LIMIT = 16;
+
+export const BRIDGE_DEPENDS_ON_LIMIT = 8;
+
+export const BRIDGE_EVENTS_LIMIT = 32;
+
+export const BRIDGE_ID_LENGTH_LIMIT = 32;
+
+export const BRIDGE_KEY_LENGTH_LIMIT = 64;
+
+export const BRIDGE_TEXT_LENGTH_LIMIT = 512;
+
+export const BRIDGE_OPTION_VALUE_LENGTH_LIMIT = 128;
+
+export const BRIDGE_PLACEHOLDER_LENGTH_LIMIT = 256;
+
+export const BRIDGE_STAGING_LENGTH_LIMIT = 128;
+
+export const BRIDGE_EXTENSION_LENGTH_LIMIT = 16;

package/src/protocol/bridgeLine.ts

@@ -1,10 +1,31 @@
+import { BridgeTerminalLevel } from "../terminal";
+
 export const BRIDGE_LOG_SOURCE = "bridge";
 
+const FIELD_LIMIT = 16;
+
+const FIELD_KEY_LIMIT = 64;
+
+const FIELD_VALUE_LIMIT = 512;
+
 export interface BridgeLogLine {
+	level: BridgeTerminalLevel;
 	message: string;
-	text: string;
+	fields: Record<string, string>;
 }
 
+const LEVELS = new Set<string>(Object.values(BridgeTerminalLevel));
+
+const levelOf = (value: unknown): BridgeTerminalLevel => {
+	return typeof value === "string" && LEVELS.has(value) ? (value as BridgeTerminalLevel) : BridgeTerminalLevel.Info;
+};
+
+const textOf = (value: unknown) => {
+	const text = typeof value === "object" && value !== null ? JSON.stringify(value) : String(value);
+
+	return text.slice(0, FIELD_VALUE_LIMIT);
+};
+
 export const parseBridgeLine = (line: string): BridgeLogLine | null => {
 	if (!line.startsWith("{") || !line.endsWith("}")) {
 		return null;
@@ -28,13 +49,27 @@ export const parseBridgeLine = (line: string): BridgeLogLine | null => {
 		return null;
 	}
 
-	const fields = Object.entries(entry)
-		.filter(([key]) => key !== "source" && key !== "message")
-		.map(([key, value]) => `${key}=${typeof value === "object" ? JSON.stringify(value) : String(value)}`)
-		.join(" ");
+	const fields: Record<string, string> = {};
+
+	for (const [key, value] of Object.entries(entry)) {
+		if (key === "source" || key === "message" || key === "level" || key === "driver") {
+			continue;
+		}
+
+		if (key.length > FIELD_KEY_LIMIT) {
+			continue;
+		}
+
+		if (Object.keys(fields).length >= FIELD_LIMIT) {
+			break;
+		}
+
+		fields[key] = textOf(value);
+	}
 
 	return {
+		level: levelOf(entry.level),
 		message: entry.message,
-		text: fields.length > 0 ? `${entry.message} ${fields}` : entry.message,
+		fields,
 	};
 };

package/src/protocol/bridgeManifest.ts

@@ -1,5 +1,18 @@
-import type { BridgeKind } from "../core";
+import type { BridgeKind, BridgeStream } from "../core";
 import type { BridgePanel } from "../panel";
+import type { BridgeTerminalCommand, BridgeTerminalLevel } from "../terminal";
+
+export interface BridgeTerminalRuleManifest {
+	match: string;
+	flags: string;
+	level: BridgeTerminalLevel;
+	stream?: BridgeStream;
+}
+
+export interface BridgeTerminalManifest {
+	commands: BridgeTerminalCommand[];
+	rules: BridgeTerminalRuleManifest[];
+}
 
 export interface BridgeModuleManifest {
 	id: string;
@@ -14,6 +27,7 @@ export interface BridgeModuleManifest {
 export interface BridgeManifest {
 	version: string;
 	panel: BridgePanel | null;
+	terminal: BridgeTerminalManifest | null;
 	modules: BridgeModuleManifest[];
 	events: string[];
 }

package/src/protocol/bridgeVersion.ts

@@ -1,4 +1,4 @@
-import pkg from "../../package.json";
+import pkg from "../../package.json" with { type: "json" };
 
 export const BRIDGE_VERSION: string = pkg.version;
 

package/src/protocol/index.ts

@@ -1,7 +1,12 @@
 export * from "../core";
 export * from "../panel";
+export * from "../terminal";
+export * from "./bridgeCatalog";
 export * from "./bridgeConfig";
+export * from "./bridgeEgress";
+export * from "./bridgeEvents";
 export * from "./bridgeFrame";
+export * from "./bridgeLimits";
 export * from "./bridgeLine";
 export * from "./bridgeManifest";
 export * from "./bridgeVersion";

package/src/runtime/bridgeActions.ts

@@ -0,0 +1,53 @@
+import { BridgeAction, BridgeKind } from "../core";
+import type { BridgePanelModule } from "../modules";
+
+export const actionsOf = (module: BridgePanelModule): string[] => {
+	switch (module.kind) {
+		case BridgeKind.Actions: {
+			return Object.keys(module.actions);
+		}
+
+		case BridgeKind.Options: {
+			return [
+				BridgeAction.List,
+			];
+		}
+
+		case BridgeKind.Settings: {
+			return [
+				BridgeAction.Read,
+				...(module.write
+					? [
+							BridgeAction.Write,
+						]
+					: []),
+			];
+		}
+
+		case BridgeKind.Collection: {
+			return [
+				BridgeAction.List,
+				...(module.add
+					? [
+							BridgeAction.Add,
+						]
+					: []),
+				...Object.keys(module.actions ?? {}),
+			];
+		}
+
+		case BridgeKind.Catalog: {
+			return [
+				BridgeAction.Install,
+				BridgeAction.Installed,
+				BridgeAction.Remove,
+				BridgeAction.Search,
+				...(module.toggle
+					? [
+							BridgeAction.Toggle,
+						]
+					: []),
+			];
+		}
+	}
+};