@serverkgg/bridge 0.0.7 → 0.0.9

package/src/wire/panel.test.ts

@@ -0,0 +1,451 @@
+import { describe, expect, test } from "bun:test";
+import {
+	BridgeAccess,
+	BridgeAction,
+	BridgeConfirm,
+	BridgeControl,
+	BridgeFormTarget,
+	BridgeKind,
+	BridgeLayout,
+	type BridgeManifest,
+	BridgeUploadMode,
+} from "@serverkgg/bridge/protocol";
+import { bridgeManifestSchema } from "./panel";
+
+const text = (value: string) => ({
+	ar: value,
+	en: value,
+});
+
+const manifest = (): BridgeManifest => ({
+	version: "1.0.0",
+	panel: {
+		tabs: [
+			{
+				id: "gameplay",
+				title: text("Gameplay"),
+				access: BridgeAccess.Invoke,
+				sections: [
+					{
+						layout: BridgeLayout.Actions,
+						id: "broadcast",
+						title: text("Broadcast"),
+						help: text("Send a message to everyone playing"),
+						module: "broadcast",
+						actions: [
+							{
+								id: "say",
+								label: text("Say"),
+								fields: [
+									{
+										key: "message",
+										control: BridgeControl.Text,
+										label: text("Message"),
+										maxLength: 200,
+									},
+								],
+							},
+							{
+								id: "saveAll",
+								label: text("Save"),
+								confirm: BridgeConfirm.Normal,
+							},
+						],
+					},
+					{
+						layout: BridgeLayout.Table,
+						id: "players",
+						module: "players",
+						columns: [
+							{
+								key: "name",
+								label: text("Name"),
+							},
+						],
+						actions: [
+							{
+								id: "xp",
+								label: text("Give XP"),
+								fields: [
+									{
+										key: "amount",
+										control: BridgeControl.Number,
+										label: text("Amount"),
+										min: 1,
+										max: 1000,
+									},
+									{
+										key: "kind",
+										control: BridgeControl.Select,
+										label: text("Kind"),
+										options: [
+											{
+												value: "levels",
+												label: text("Levels"),
+											},
+											{
+												value: "points",
+												label: text("Points"),
+											},
+										],
+									},
+								],
+							},
+						],
+					},
+				],
+			},
+		],
+	},
+	terminal: null,
+	modules: [
+		{
+			id: "broadcast",
+			kind: BridgeKind.Actions,
+			requiresRunning: true,
+			refreshSeconds: null,
+			pageSize: null,
+			dependsOn: [],
+			actions: [
+				"say",
+				"saveAll",
+			],
+		},
+		{
+			id: "players",
+			kind: BridgeKind.Collection,
+			requiresRunning: true,
+			refreshSeconds: 10,
+			pageSize: null,
+			dependsOn: [],
+			actions: [
+				"list",
+				"xp",
+			],
+		},
+	],
+	events: [
+		"PlayerJoined",
+	],
+});
+
+const previewManifest = (): BridgeManifest => ({
+	version: "1.0.0",
+	panel: {
+		tabs: [
+			{
+				id: "version",
+				title: text("Version"),
+				sections: [
+					{
+						layout: BridgeLayout.Form,
+						id: "version",
+						target: BridgeFormTarget.Variables,
+						preview: {
+							module: "transition",
+						},
+						reinstall: true,
+						confirm: BridgeConfirm.Strong,
+						fields: [
+							{
+								key: "MC_VERSION",
+								control: BridgeControl.Text,
+								label: text("Version"),
+							},
+						],
+					},
+				],
+			},
+		],
+	},
+	terminal: null,
+	modules: [
+		{
+			id: "transition",
+			kind: BridgeKind.Preview,
+			requiresRunning: false,
+			refreshSeconds: null,
+			pageSize: null,
+			dependsOn: [],
+			actions: [
+				BridgeAction.Preview,
+			],
+		},
+	],
+	events: [],
+});
+
+const tabsOf = (count: number) => {
+	return Array.from({
+		length: count,
+	}).map((_entry, index) => ({
+		id: `tab-${index}`,
+		title: text(`Tab ${index}`),
+		sections: [
+			{
+				layout: BridgeLayout.Actions,
+				id: "broadcast",
+				module: "broadcast",
+				actions: [
+					{
+						id: "say",
+						label: text("Say"),
+					},
+				],
+			},
+		],
+	}));
+};
+
+describe("the panel mirror", () => {
+	test("carries an actions section and its fields through unchanged", () => {
+		const source = manifest();
+		const parsed = bridgeManifestSchema.parse(source);
+
+		expect(parsed).toEqual(source);
+	});
+
+	test("refuses an action carrying more fields than a prompt fits", () => {
+		const source = manifest();
+		const [tab] = source.panel?.tabs ?? [];
+		const [section] = tab?.sections ?? [];
+
+		if (section?.layout !== BridgeLayout.Actions) {
+			throw new Error("fixture is missing its actions section");
+		}
+
+		const [action] = section.actions;
+
+		if (!action) {
+			throw new Error("fixture is missing its action");
+		}
+
+		action.fields = Array.from({
+			length: 6,
+		}).map((_entry, index) => ({
+			key: `field${index}`,
+			control: BridgeControl.Text,
+			label: text("Field"),
+		}));
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+
+	test("keeps a variables form's preview ref instead of stripping it", () => {
+		const source = previewManifest();
+		const parsed = bridgeManifestSchema.parse(source);
+		const [section] = parsed.panel?.tabs[0]?.sections ?? [];
+
+		if (section?.layout !== BridgeLayout.Form) {
+			throw new Error("fixture is missing its form section");
+		}
+
+		expect(section.preview).toEqual({
+			module: "transition",
+		});
+		expect(parsed).toEqual(source);
+	});
+
+	test("takes a preview module and the preview action it answers", () => {
+		const parsed = bridgeManifestSchema.parse(previewManifest());
+
+		expect(parsed.modules[0]).toEqual({
+			id: "transition",
+			kind: BridgeKind.Preview,
+			requiresRunning: false,
+			refreshSeconds: null,
+			pageSize: null,
+			dependsOn: [],
+			actions: [
+				BridgeAction.Preview,
+			],
+		});
+	});
+
+	test("takes eight tabs and refuses nine", () => {
+		const source = manifest();
+
+		expect(
+			bridgeManifestSchema.safeParse({
+				...source,
+				panel: {
+					tabs: tabsOf(8),
+				},
+			}).success,
+		).toBe(true);
+
+		expect(
+			bridgeManifestSchema.safeParse({
+				...source,
+				panel: {
+					tabs: tabsOf(9),
+				},
+			}).success,
+		).toBe(false);
+	});
+});
+
+const detailManifest = (): BridgeManifest => ({
+	version: "1.0.0",
+	panel: {
+		tabs: [
+			{
+				id: "version",
+				title: text("Version"),
+				sections: [
+					{
+						layout: BridgeLayout.Form,
+						id: "version",
+						target: BridgeFormTarget.Variables,
+						reinstall: true,
+						fields: [
+							{
+								key: "MC_VERSION",
+								control: BridgeControl.Text,
+								label: text("Version"),
+							},
+						],
+						clears: [
+							{
+								variable: "MODPACK",
+								warning: text("Applying this removes the modpack"),
+							},
+						],
+					},
+					{
+						layout: BridgeLayout.Detail,
+						id: "modpack-status",
+						title: text("Running a modpack"),
+						module: "modpackStatus",
+						reinstall: true,
+						variable: "MODPACK",
+						confirm: BridgeConfirm.Strong,
+						related: {
+							tab: "modpacks",
+							label: text("Browse modpacks"),
+						},
+						actions: [
+							{
+								id: "update",
+								label: text("Update"),
+								confirm: BridgeConfirm.Strong,
+							},
+						],
+					},
+				],
+			},
+		],
+	},
+	terminal: null,
+	modules: [
+		{
+			id: "modpackStatus",
+			kind: BridgeKind.Detail,
+			requiresRunning: false,
+			refreshSeconds: null,
+			pageSize: null,
+			dependsOn: [],
+			actions: [
+				BridgeAction.Read,
+				"update",
+			],
+		},
+	],
+	events: [],
+});
+
+describe("detail sections", () => {
+	test("round-trips a detail section and a clearing form", () => {
+		const source = detailManifest();
+
+		expect(bridgeManifestSchema.parse(source)).toEqual(source);
+	});
+
+	test("refuses a clear whose variable is not an env key", () => {
+		const source = detailManifest();
+		const [form] = source.panel?.tabs[0]?.sections ?? [];
+
+		if (form?.layout !== BridgeLayout.Form) {
+			throw new Error("fixture is missing its form section");
+		}
+
+		form.clears = [
+			{
+				variable: "mod pack",
+				warning: text("Broken"),
+			},
+		];
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+});
+
+const uploadManifest = (mode?: BridgeUploadMode): BridgeManifest => ({
+	version: "1.0.0",
+	panel: {
+		tabs: [
+			{
+				id: "modpacks",
+				title: text("Modpacks"),
+				sections: [
+					{
+						layout: BridgeLayout.Table,
+						id: "pending",
+						module: "pending",
+						columns: [
+							{
+								key: "name",
+								label: text("Name"),
+							},
+						],
+						upload: {
+							label: text("Upload"),
+							extensions: [
+								"jar",
+							],
+							staging: ".serverk-staging/pending-upload",
+							mode,
+						},
+					},
+				],
+			},
+		],
+	},
+	terminal: null,
+	modules: [
+		{
+			id: "pending",
+			kind: BridgeKind.Collection,
+			requiresRunning: false,
+			refreshSeconds: null,
+			pageSize: null,
+			dependsOn: [],
+			actions: [],
+		},
+	],
+	events: [],
+});
+
+describe("the upload mirror", () => {
+	test("carries the file upload mode through unchanged", () => {
+		const source = uploadManifest(BridgeUploadMode.File);
+		const parsed = bridgeManifestSchema.parse(source);
+		const [section] = parsed.panel?.tabs[0]?.sections ?? [];
+
+		if (section?.layout !== BridgeLayout.Table) {
+			throw new Error("fixture is missing its table section");
+		}
+
+		expect(section.upload?.mode).toBe(BridgeUploadMode.File);
+	});
+
+	test("takes an upload that declares no mode", () => {
+		expect(bridgeManifestSchema.safeParse(uploadManifest()).success).toBe(true);
+	});
+
+	test("refuses an upload mode the platform does not know", () => {
+		const source = uploadManifest("stream" as BridgeUploadMode);
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+});