@serverkgg/bridge 0.0.8 → 0.0.10

package/src/wire/panel.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, test } from "bun:test";
+import { GuideOpenTab } from "@serverkgg/bridge/guides";
 import {
 	BridgeAccess,
 	BridgeAction,
@@ -8,6 +9,9 @@ import {
 	BridgeKind,
 	BridgeLayout,
 	type BridgeManifest,
+	type BridgeSetupManifest,
+	BridgeSetupStepKind,
+	BridgeUploadMode,
 } from "@serverkgg/bridge/protocol";
 import { bridgeManifestSchema } from "./panel";
 
@@ -97,6 +101,7 @@ const manifest = (): BridgeManifest => ({
 		],
 	},
 	terminal: null,
+	setup: null,
 	modules: [
 		{
 			id: "broadcast",
@@ -158,6 +163,7 @@ const previewManifest = (): BridgeManifest => ({
 		],
 	},
 	terminal: null,
+	setup: null,
 	modules: [
 		{
 			id: "transition",
@@ -283,3 +289,256 @@ describe("the panel mirror", () => {
 		).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,
+	setup: 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,
+	setup: 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);
+	});
+});
+
+const setupManifest = (setup: BridgeSetupManifest | null): BridgeManifest => ({
+	version: "1.0.0",
+	panel: null,
+	terminal: null,
+	setup,
+	modules: [],
+	events: [],
+});
+
+describe("the setup mirror", () => {
+	test("carries every step kind through unchanged", () => {
+		const source = setupManifest({
+			steps: [
+				{
+					kind: BridgeSetupStepKind.Driver,
+					id: "sign-in",
+					title: text("Sign in"),
+					help: text("Sign in with your account"),
+					requiresRunning: true,
+				},
+				{
+					kind: BridgeSetupStepKind.Form,
+					id: "name",
+					title: text("Name your server"),
+					required: false,
+					tab: "settings",
+					section: "server",
+					fields: [
+						"SERVER_NAME",
+					],
+				},
+				{
+					kind: BridgeSetupStepKind.Open,
+					id: "invite",
+					title: text("Invite your friends"),
+					target: {
+						tab: GuideOpenTab.Access,
+					},
+				},
+			],
+		});
+
+		expect(bridgeManifestSchema.parse(source).setup).toEqual(source.setup);
+	});
+
+	test("takes a manifest that declares no setup", () => {
+		expect(bridgeManifestSchema.parse(setupManifest(null)).setup).toBeNull();
+	});
+
+	test("defaults a manifest from an older bridge that carries no setup block to null", () => {
+		const older = setupManifest(null);
+
+		delete (older as Partial<BridgeManifest>).setup;
+
+		expect(bridgeManifestSchema.parse(older).setup).toBeNull();
+	});
+
+	test("refuses a step kind the platform does not know", () => {
+		const source = setupManifest({
+			steps: [
+				{
+					kind: "wizard" as BridgeSetupStepKind.Driver,
+					id: "sign-in",
+					title: text("Sign in"),
+				},
+			],
+		});
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+
+	test("refuses more steps than the platform takes", () => {
+		const source = setupManifest({
+			steps: Array.from({
+				length: 9,
+			}).map((_entry, index) => ({
+				kind: BridgeSetupStepKind.Driver as const,
+				id: `step-${index}`,
+				title: text(`Step ${index}`),
+			})),
+		});
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+});

package/src/wire/panel.ts

@@ -1,3 +1,4 @@
+import { guideOpenTargetSchema } from "@serverkgg/bridge/guides";
 import {
 	BRIDGE_ID_PATTERN,
 	BRIDGE_MODULE_ID_PATTERN,
@@ -11,12 +12,16 @@ import {
 	type BridgeManifest,
 	type BridgePanel,
 	type BridgeSection,
+	type BridgeSetupManifest,
+	type BridgeSetupStep,
+	BridgeSetupStepKind,
 	BridgeStream,
 	type BridgeTerminalArg,
 	type BridgeTerminalCommand,
 	BridgeTerminalLevel,
 	type BridgeTerminalManifest,
 	type BridgeTerminalRuleManifest,
+	BridgeUploadMode,
 } from "@serverkgg/bridge/protocol";
 import { z } from "zod";
 import { zEnvKey } from "./zEnvKey";
@@ -27,6 +32,12 @@ const ACTION_FIELDS_LIMIT = 5;
 
 const SECTION_ACTIONS_LIMIT = 10;
 
+const FORM_CLEARS_LIMIT = 8;
+
+const SETUP_STEPS_LIMIT = 8;
+
+const SETUP_STEP_FIELDS_LIMIT = 32;
+
 const zKey = z
 	.string()
 	.min(1)
@@ -107,6 +118,16 @@ export const bridgeSectionActionSchema = z.object({
 	fields: z.array(bridgeFieldSchema).max(ACTION_FIELDS_LIMIT).optional(),
 });
 
+export const bridgeTabRefSchema = z.object({
+	tab: zBridgeId,
+	label: panelTextSchema,
+});
+
+export const bridgeFormClearSchema = z.object({
+	variable: zEnvKey,
+	warning: panelTextSchema,
+});
+
 export const bridgeSectionAddSchema = z.object({
 	label: panelTextSchema,
 	placeholder: z.string().max(256).optional(),
@@ -116,6 +137,7 @@ export const bridgeSectionUploadSchema = z.object({
 	label: panelTextSchema,
 	extensions: z.array(z.string().min(1).max(16)).min(1).max(8),
 	staging: z.string().min(1).max(128),
+	mode: z.enum(BridgeUploadMode).optional(),
 });
 
 export const bridgeActionsSectionSchema = z.object({
@@ -141,6 +163,23 @@ export const bridgeFormSectionSchema = z.object({
 	confirm: z.enum(BridgeConfirm).optional(),
 	confirmText: panelTextSchema.optional(),
 	fields: z.array(bridgeFieldSchema).min(1).max(32),
+	clears: z.array(bridgeFormClearSchema).max(FORM_CLEARS_LIMIT).optional(),
+	visibleWhen: bridgeVisibleWhenSchema.optional(),
+	access: z.enum(BridgeAccess).optional(),
+});
+
+export const bridgeDetailSectionSchema = z.object({
+	layout: z.literal(BridgeLayout.Detail),
+	id: zBridgeId,
+	title: panelTextSchema.optional(),
+	module: zBridgeModuleId,
+	actions: z.array(bridgeSectionActionSchema).max(SECTION_ACTIONS_LIMIT).optional(),
+	reinstall: z.boolean().optional(),
+	variable: zEnvKey.optional(),
+	confirm: z.enum(BridgeConfirm).optional(),
+	confirmText: panelTextSchema.optional(),
+	related: bridgeTabRefSchema.optional(),
+	empty: panelTextSchema.optional(),
 	visibleWhen: bridgeVisibleWhenSchema.optional(),
 	access: z.enum(BridgeAccess).optional(),
 });
@@ -197,6 +236,7 @@ export const bridgeSectionSchema: z.ZodType<BridgeSection> = z.discriminatedUnio
 	bridgeActionsSectionSchema,
 	bridgeCardsSectionSchema,
 	bridgeCatalogSectionSchema,
+	bridgeDetailSectionSchema,
 	bridgeFormSectionSchema,
 	bridgeTableSectionSchema,
 ]);
@@ -244,6 +284,37 @@ export const bridgeTerminalManifestSchema: z.ZodType<BridgeTerminalManifest> = z
 	rules: z.array(bridgeTerminalRuleSchema).max(64),
 });
 
+const setupStepBase = {
+	id: zBridgeId,
+	title: panelTextSchema,
+	help: panelTextSchema.optional(),
+	required: z.boolean().optional(),
+};
+
+export const bridgeSetupStepSchema: z.ZodType<BridgeSetupStep> = z.discriminatedUnion("kind", [
+	z.object({
+		...setupStepBase,
+		kind: z.literal(BridgeSetupStepKind.Driver),
+		requiresRunning: z.boolean().optional(),
+	}),
+	z.object({
+		...setupStepBase,
+		kind: z.literal(BridgeSetupStepKind.Form),
+		tab: zBridgeId,
+		section: zBridgeId,
+		fields: z.array(zKey).max(SETUP_STEP_FIELDS_LIMIT).optional(),
+	}),
+	z.object({
+		...setupStepBase,
+		kind: z.literal(BridgeSetupStepKind.Open),
+		target: guideOpenTargetSchema,
+	}),
+]);
+
+export const bridgeSetupManifestSchema: z.ZodType<BridgeSetupManifest> = z.object({
+	steps: z.array(bridgeSetupStepSchema).min(1).max(SETUP_STEPS_LIMIT),
+});
+
 export const bridgeModuleManifestSchema = z.object({
 	id: zBridgeModuleId,
 	kind: z.enum(BridgeKind),
@@ -258,6 +329,7 @@ export const bridgeManifestSchema: z.ZodType<BridgeManifest> = z.object({
 	version: z.string(),
 	panel: bridgePanelSchema.nullable(),
 	terminal: bridgeTerminalManifestSchema.nullable().default(null),
+	setup: bridgeSetupManifestSchema.nullable().default(null),
 	modules: z.array(bridgeModuleManifestSchema).max(32),
 	events: z.array(z.string().min(1).max(64)).max(32),
 });