@serverkgg/bridge 0.1.13 → 0.1.15

package/src/steam/workshop.ts

@@ -6,6 +6,10 @@ export const STEAM_REMOTE_STORAGE = "https://api.steampowered.com/ISteamRemoteSt
 
 export const WORKSHOP_CONTENT_DIRECTORY = "steamapps/workshop/content";
 
+const WORKSHOP_ARCHIVE_DIRECTORY = ".serverk/snapshots";
+
+const WORKSHOP_ITEM_PAGE = "https://steamcommunity.com/sharedfiles/filedetails/?id=";
+
 const FORM_CONTENT_TYPE = "application/x-www-form-urlencoded";
 
 const DETAILS_CACHE_SECONDS = 600;
@@ -63,6 +67,14 @@ export const workshopContentPath = (
 	return `${directory}/${workshopAppId}/${id}`;
 };
 
+export const workshopArchivePath = (appId: number, itemId: string) => {
+	return `${WORKSHOP_ARCHIVE_DIRECTORY}/workshop-${appId}-${itemId}.zip`;
+};
+
+export const workshopItemPageUrl = (itemId: string) => {
+	return `${WORKSHOP_ITEM_PAGE}${itemId}`;
+};
+
 export const workshopFormBody = (countKey: string, ids: string[]) => {
 	const form = new URLSearchParams();
 

package/src/wire/panel.test.ts

@@ -3,6 +3,8 @@ import { GuideOpenTab } from "@serverkgg/bridge/guides";
 import {
 	BridgeAccess,
 	BridgeAction,
+	type BridgeCatalogSource,
+	BridgeCatalogSourceKind,
 	BridgeConfirm,
 	BridgeControl,
 	type BridgeField,
@@ -11,6 +13,7 @@ import {
 	BridgeLayout,
 	type BridgeManifest,
 	BridgePlace,
+	type BridgeSectionUpload,
 	type BridgeSetupManifest,
 	BridgeSetupStepKind,
 	type BridgeTerminalManifest,
@@ -460,6 +463,143 @@ describe("the upload mirror", () => {
 	});
 });
 
+const MODS_UPLOAD: BridgeSectionUpload = {
+	label: text("Upload a mod"),
+	extensions: [
+		"zip",
+	],
+	staging: ".serverk-staging/mods-upload",
+	mode: BridgeUploadMode.Archive,
+};
+
+const catalogManifest = (source?: BridgeCatalogSource, upload?: BridgeSectionUpload): BridgeManifest => ({
+	version: "1.0.0",
+	panel: {
+		tabs: [
+			{
+				id: "mods",
+				title: text("Mods"),
+				sections: [
+					{
+						layout: BridgeLayout.Catalog,
+						id: "mods",
+						module: "mods",
+						...(upload
+							? {
+									upload,
+								}
+							: {}),
+					},
+				],
+			},
+		],
+	},
+	terminal: null,
+	setup: null,
+	modules: [
+		{
+			id: "mods",
+			kind: BridgeKind.Catalog,
+			requiresRunning: false,
+			refreshSeconds: null,
+			pageSize: null,
+			dependsOn: [],
+			actions: [
+				BridgeAction.Preview,
+				BridgeAction.Install,
+				BridgeAction.Installed,
+				BridgeAction.Remove,
+				BridgeAction.Search,
+				BridgeAction.Add,
+			],
+			...(source
+				? {
+						source,
+					}
+				: {}),
+		},
+	],
+	events: [],
+});
+
+const workshopSource = (overrides: Partial<BridgeCatalogSource> = {}): BridgeCatalogSource => ({
+	kind: BridgeCatalogSourceKind.Workshop,
+	appId: 1_623_730,
+	provided: [
+		"UE4SS",
+		"PalSchema",
+	],
+	...overrides,
+});
+
+describe("the catalog mirror", () => {
+	it("carries a sourced catalog and its section's upload through unchanged", () => {
+		const source = catalogManifest(workshopSource(), MODS_UPLOAD);
+
+		expect(bridgeManifestSchema.parse(source)).toEqual(source);
+	});
+
+	it("takes a source that names nothing the image provides", () => {
+		expect(
+			bridgeManifestSchema.safeParse(
+				catalogManifest({
+					kind: BridgeCatalogSourceKind.Workshop,
+					appId: 1_623_730,
+				}),
+			).success,
+		).toBe(true);
+	});
+
+	it("reads a catalog from an older bridge that carries no source and no upload", () => {
+		const parsed = bridgeManifestSchema.parse(catalogManifest());
+
+		expect(parsed.modules[0]?.source).toBeUndefined();
+		expect(parsed.panel?.tabs[0]?.sections[0]).toEqual({
+			layout: BridgeLayout.Catalog,
+			id: "mods",
+			module: "mods",
+		});
+	});
+
+	it("refuses a source the platform does not serve", () => {
+		const source = catalogManifest(
+			workshopSource({
+				kind: "nexus" as BridgeCatalogSourceKind,
+			}),
+		);
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+
+	it("refuses an app id that is not a positive whole number", () => {
+		for (const appId of [
+			0,
+			-1,
+			1.5,
+		]) {
+			const source = catalogManifest(
+				workshopSource({
+					appId,
+				}),
+			);
+
+			expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+		}
+	});
+
+	it("refuses an empty provided name", () => {
+		const source = catalogManifest(
+			workshopSource({
+				provided: [
+					"",
+				],
+			}),
+		);
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+});
+
 const fieldManifest = (field: BridgeField): BridgeManifest => ({
 	version: "1.0.0",
 	panel: {
@@ -521,6 +661,43 @@ describe("secret fields", () => {
 	});
 });
 
+describe("field defaults", () => {
+	it("carries a field's default through unchanged", () => {
+		const source = fieldManifest({
+			key: "WINDOWS_STEAM",
+			control: BridgeControl.Boolean,
+			label: text("Use Steam"),
+			default: "true",
+		});
+
+		expect(bridgeManifestSchema.parse(source)).toEqual(source);
+	});
+
+	it("reads a field from an older bridge that declares no default", () => {
+		const parsed = bridgeManifestSchema.parse(
+			fieldManifest({
+				key: "WINDOWS_STEAM",
+				control: BridgeControl.Boolean,
+				label: text("Use Steam"),
+			}),
+		);
+		const [section] = parsed.panel?.tabs[0]?.sections ?? [];
+
+		expect(section?.layout === BridgeLayout.Form ? section.fields[0]?.default : null).toBeUndefined();
+	});
+
+	it("refuses a default longer than the platform takes", () => {
+		const source = fieldManifest({
+			key: "MOTD",
+			control: BridgeControl.Text,
+			label: text("Message"),
+			default: "a".repeat(257),
+		});
+
+		expect(bridgeManifestSchema.safeParse(source).success).toBe(false);
+	});
+});
+
 const setupManifest = (setup: BridgeSetupManifest | null): BridgeManifest => ({
 	version: "1.0.0",
 	panel: null,

package/src/wire/panel.ts

@@ -1,9 +1,13 @@
 import { guideOpenTargetSchema } from "@serverkgg/bridge/guides";
 import {
+	BRIDGE_CATALOG_PROVIDED_LIMIT,
+	BRIDGE_DEFAULT_LENGTH_LIMIT,
 	BRIDGE_ID_PATTERN,
 	BRIDGE_MODULE_ID_PATTERN,
 	BRIDGE_PATTERN_LENGTH_LIMIT,
+	BRIDGE_PROVIDED_NAME_LENGTH_LIMIT,
 	BridgeAccess,
+	BridgeCatalogSourceKind,
 	BridgeConfirm,
 	BridgeControl,
 	BridgeFormTarget,
@@ -120,6 +124,7 @@ export const bridgeFieldSchema = z.object({
 	help: panelTextSchema.optional(),
 	warning: panelTextSchema.optional(),
 	placeholder: z.string().max(256).optional(),
+	default: z.string().max(BRIDGE_DEFAULT_LENGTH_LIMIT).optional(),
 	min: z.number().optional(),
 	max: z.number().optional(),
 	step: z.number().optional(),
@@ -263,6 +268,7 @@ export const bridgeCatalogSectionSchema = z.object({
 	variable: zEnvKey.optional(),
 	confirm: z.enum(BridgeConfirm).optional(),
 	confirmText: panelTextSchema.optional(),
+	upload: bridgeSectionUploadSchema.optional(),
 	empty: panelTextSchema.optional(),
 	visibleWhen: bridgeVisibleWhenSchema.optional(),
 	access: z.enum(BridgeAccess).optional(),
@@ -352,6 +358,15 @@ export const bridgeSetupManifestSchema: z.ZodType<BridgeSetupManifest> = z.objec
 	steps: z.array(bridgeSetupStepSchema).min(1).max(SETUP_STEPS_LIMIT),
 });
 
+export const bridgeCatalogSourceSchema = z.object({
+	kind: z.enum(BridgeCatalogSourceKind),
+	appId: z.int().positive(),
+	provided: z
+		.array(z.string().min(1).max(BRIDGE_PROVIDED_NAME_LENGTH_LIMIT))
+		.max(BRIDGE_CATALOG_PROVIDED_LIMIT)
+		.optional(),
+});
+
 export const bridgeModuleManifestSchema = z.object({
 	id: zBridgeModuleId,
 	kind: z.enum(BridgeKind),
@@ -361,6 +376,7 @@ export const bridgeModuleManifestSchema = z.object({
 	dependsOn: z.array(zKey).max(8),
 	actions: z.array(z.string().min(1).max(64)).max(16),
 	protectedActions: z.array(z.string().min(1).max(64)).max(16).optional(),
+	source: bridgeCatalogSourceSchema.optional(),
 });
 
 export const bridgeManifestSchema: z.ZodType<BridgeManifest> = z.object({