@serverkgg/bridge 0.0.8 → 0.0.10

package/src/protocol/bridgeLimits.ts

@@ -18,6 +18,14 @@ export const BRIDGE_VISIBLE_VALUES_LIMIT = 16;
 
 export const BRIDGE_PREVIEW_LINES_LIMIT = 8;
 
+export const BRIDGE_DETAIL_STATS_LIMIT = 12;
+
+export const BRIDGE_DETAIL_BADGES_LIMIT = 4;
+
+export const BRIDGE_DETAIL_LINKS_LIMIT = 4;
+
+export const BRIDGE_FORM_CLEARS_LIMIT = 8;
+
 export const BRIDGE_UPLOAD_EXTENSIONS_LIMIT = 8;
 
 export const BRIDGE_MODULES_LIMIT = 32;
@@ -28,6 +36,10 @@ export const BRIDGE_DEPENDS_ON_LIMIT = 8;
 
 export const BRIDGE_EVENTS_LIMIT = 32;
 
+export const BRIDGE_PENDING_FILES_LIMIT = 64;
+
+export const BRIDGE_SETUP_STEPS_LIMIT = 8;
+
 export const BRIDGE_ID_LENGTH_LIMIT = 32;
 
 export const BRIDGE_KEY_LENGTH_LIMIT = 64;

package/src/protocol/bridgeManifest.ts

@@ -1,6 +1,7 @@
 import type { BridgeKind, BridgeStream } from "../core";
 import type { BridgePanel } from "../panel";
 import type { BridgeTerminalCommand, BridgeTerminalLevel } from "../terminal";
+import type { BridgeSetupManifest } from "./bridgeSetup";
 
 export interface BridgeTerminalRuleManifest {
 	match: string;
@@ -28,6 +29,7 @@ export interface BridgeManifest {
 	version: string;
 	panel: BridgePanel | null;
 	terminal: BridgeTerminalManifest | null;
+	setup: BridgeSetupManifest | null;
 	modules: BridgeModuleManifest[];
 	events: string[];
 }

package/src/protocol/bridgeSetup.ts

@@ -0,0 +1,97 @@
+import type { BridgeSetupPromptKind, BridgeSetupStepKind, BridgeSetupStepState, LocalizedText } from "../core";
+import type { GuideOpenTarget } from "../guides";
+
+interface BridgeSetupStepBase {
+	id: string;
+	title: LocalizedText;
+	help?: LocalizedText;
+	required?: boolean;
+}
+
+export interface BridgeSetupDriverStep extends BridgeSetupStepBase {
+	kind: BridgeSetupStepKind.Driver;
+	requiresRunning?: boolean;
+}
+
+export interface BridgeSetupFormStep extends BridgeSetupStepBase {
+	kind: BridgeSetupStepKind.Form;
+	tab: string;
+	section: string;
+	fields?: string[];
+}
+
+export interface BridgeSetupOpenStep extends BridgeSetupStepBase {
+	kind: BridgeSetupStepKind.Open;
+	target: GuideOpenTarget;
+}
+
+export type BridgeSetupStep = BridgeSetupDriverStep | BridgeSetupFormStep | BridgeSetupOpenStep;
+
+export interface BridgeSetupManifest {
+	steps: BridgeSetupStep[];
+}
+
+export interface BridgeSetupAction {
+	id: string;
+	label: LocalizedText;
+}
+
+export interface BridgeSetupWaitPrompt {
+	kind: BridgeSetupPromptKind.Wait;
+	message: LocalizedText;
+}
+
+export interface BridgeSetupProgressPrompt {
+	kind: BridgeSetupPromptKind.Progress;
+	message: LocalizedText;
+	percent: number | null;
+	detail: string | null;
+}
+
+export interface BridgeSetupLinkPrompt {
+	kind: BridgeSetupPromptKind.Link;
+	message: LocalizedText;
+	url: string;
+	code: string | null;
+	expiresAt: string | null;
+	actions: BridgeSetupAction[];
+}
+
+export interface BridgeSetupActionPrompt {
+	kind: BridgeSetupPromptKind.Action;
+	message: LocalizedText;
+	actions: BridgeSetupAction[];
+}
+
+export interface BridgeSetupFailedPrompt {
+	kind: BridgeSetupPromptKind.Failed;
+	message: LocalizedText;
+	actions: BridgeSetupAction[];
+}
+
+export type BridgeSetupPrompt =
+	| BridgeSetupActionPrompt
+	| BridgeSetupFailedPrompt
+	| BridgeSetupLinkPrompt
+	| BridgeSetupProgressPrompt
+	| BridgeSetupWaitPrompt;
+
+export interface BridgeSetupStepStatus {
+	id: string;
+	state: BridgeSetupStepState;
+}
+
+export interface BridgeSetupRuntime {
+	steps: BridgeSetupStepStatus[];
+	prompt: BridgeSetupPrompt | null;
+}
+
+export interface BridgeSetupSummary {
+	step: string | null;
+	attention: boolean;
+}
+
+export interface BridgeSetupResult {
+	supported: boolean;
+	runtime: BridgeSetupRuntime | null;
+}

package/src/protocol/index.ts

@@ -10,4 +10,5 @@ export * from "./bridgeLimits";
 export * from "./bridgeLine";
 export * from "./bridgeManifest";
 export * from "./bridgePreview";
+export * from "./bridgeSetup";
 export * from "./bridgeVersion";

package/src/runtime/bridgeActions.ts

@@ -42,6 +42,13 @@ export const actionsOf = (module: BridgePanelModule): string[] => {
 			];
 		}
 
+		case BridgeKind.Detail: {
+			return [
+				BridgeAction.Read,
+				...Object.keys(module.actions ?? {}),
+			];
+		}
+
 		case BridgeKind.Catalog: {
 			return [
 				BridgeAction.Install,

package/src/runtime/bridgeConfigReader.ts

@@ -82,14 +82,8 @@ export const statePath = (config: BridgeConfig) => {
 	return `${config.run}/${BRIDGE_STATE_NAME}`;
 };
 
-export const readConfig = async (path: string): Promise<BridgeConfig> => {
-	const file = Bun.file(path);
-
-	if (!(await file.exists())) {
-		throw new BridgeConfigError(`no bridge config at "${path}"`);
-	}
-
-	const parsed: unknown = JSON.parse(await file.text());
+export const parseConfig = (text: string): BridgeConfig => {
+	const parsed: unknown = JSON.parse(text);
 
 	if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed)) {
 		throw new BridgeConfigError("bridge config must be an object");
@@ -117,3 +111,13 @@ export const readConfig = async (path: string): Promise<BridgeConfig> => {
 
 	return config;
 };
+
+export const readConfig = async (path: string): Promise<BridgeConfig> => {
+	const file = Bun.file(path);
+
+	if (!(await file.exists())) {
+		throw new BridgeConfigError(`no bridge config at "${path}"`);
+	}
+
+	return parseConfig(await file.text());
+};

package/src/runtime/bridgeContext.ts

@@ -1,18 +1,22 @@
 import type { BridgeContext } from "../context";
 import type { BridgeValues } from "../core";
-import type { BridgeConfig } from "../protocol";
+import type { BridgeConfig, BridgeSetupRuntime } from "../protocol";
+import { stripAnsi } from "../utils";
 import { createBridgeCodecs } from "./bridgeCodec";
+import { configPath } from "./bridgeConfigReader";
 import { createBridgeEgress } from "./bridgeEgress";
 import { createBridgeExec } from "./bridgeExec";
 import { createBridgeFiles } from "./bridgeFiles";
 import type { BridgeLeveledLogger } from "./bridgeLog";
 import { createBridgeNet } from "./bridgeNet";
 import { createBridgeProbes } from "./bridgeProbe";
+import { createBridgeSecrets } from "./bridgeSecrets";
 import type { BridgeSupervisor } from "./bridgeSupervisor";
 
 export interface ContextHooks {
 	onLog: BridgeLeveledLogger;
 	onEmit: (event: string, payload?: BridgeValues) => void;
+	onSetup: (runtime: BridgeSetupRuntime | null) => void;
 }
 
 export const createContext = (
@@ -22,6 +26,8 @@ export const createContext = (
 ): BridgeContext => {
 	const egress = createBridgeEgress(config);
 
+	const secrets = createBridgeSecrets(configPath(), config);
+
 	const files = createBridgeFiles({
 		root: config.cwd,
 		uid: config.gameUid,
@@ -45,7 +51,7 @@ export const createContext = (
 		},
 
 		secret(key) {
-			return config.secrets[key] ?? null;
+			return secrets.read(key);
 		},
 
 		port(key) {
@@ -84,6 +90,26 @@ export const createContext = (
 			async watch(pattern, timeoutMs) {
 				return await supervisor.watch(pattern, timeoutMs);
 			},
+
+			follow(pattern, onMatch) {
+				return supervisor.subscribe((entry) => {
+					const match = stripAnsi(entry.line).match(pattern);
+
+					if (match) {
+						onMatch(match);
+					}
+				});
+			},
+		},
+
+		setup: {
+			report(runtime) {
+				hooks.onSetup(runtime);
+			},
+
+			clear() {
+				hooks.onSetup(null);
+			},
 		},
 
 		emit(event, payload) {