@serverkgg/bridge 0.1.2 → 0.1.3

package/src/guides/markdown.test.ts

@@ -1,11 +1,11 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import { GuideOpenTab } from "./blocks";
 import { parseGuideMarkdown } from "./markdown";
 
 const parse = (text: string) => parseGuideMarkdown("guides/test/en.md", text);
 
 describe("static blocks", () => {
-	test("parses the existing block vocabulary", () => {
+	it("parses the existing block vocabulary", () => {
 		const { blocks } = parse(
 			[
 				"## Join the game",
@@ -32,7 +32,7 @@ describe("static blocks", () => {
 		]);
 	});
 
-	test("still rejects what it always rejected", () => {
+	it("still rejects what it always rejected", () => {
 		expect(() => parse("# Title")).toThrow(/h1 is not supported/);
 		expect(() => parse("| a | b |")).toThrow(/tables are not supported/);
 		expect(() => parse("<div>hi</div>")).toThrow(/raw HTML/);
@@ -41,7 +41,7 @@ describe("static blocks", () => {
 });
 
 describe("variables", () => {
-	test("parses an inline variable", () => {
+	it("parses an inline variable", () => {
 		const { blocks } = parse("Your address is {{server.address}} — paste it in.");
 
 		expect(blocks[0]).toEqual({
@@ -63,7 +63,7 @@ describe("variables", () => {
 		});
 	});
 
-	test("accepts a panel variable", () => {
+	it("accepts a panel variable", () => {
 		const { blocks } = parse("The motd is {{panel.MOTD}}.");
 
 		expect(blocks[0]).toMatchObject({
@@ -76,19 +76,19 @@ describe("variables", () => {
 		});
 	});
 
-	test("rejects an unknown key", () => {
+	it("rejects an unknown key", () => {
 		expect(() => parse("Your address is {{server.adress}}.")).toThrow(/unknown variable "server.adress"/);
 	});
 
-	test("rejects a lowercase panel key", () => {
+	it("rejects a lowercase panel key", () => {
 		expect(() => parse("{{panel.motd}} is set.")).toThrow(/unknown variable/);
 	});
 
-	test("rejects an unterminated marker", () => {
+	it("rejects an unterminated marker", () => {
 		expect(() => parse("Your address is {{server.address.")).toThrow(/unterminated \{\{ marker/);
 	});
 
-	test("rejects a variable inside a link target", () => {
+	it("rejects a variable inside a link target", () => {
 		expect(() => parse("See [your server](/server/{{server.code}}).")).toThrow(
 			/variables cannot be used inside a link target/,
 		);
@@ -96,7 +96,7 @@ describe("variables", () => {
 });
 
 describe("directives", () => {
-	test("parses a field", () => {
+	it("parses a field", () => {
 		const { blocks } = parse("@[field](server.address)");
 
 		expect(blocks[0]).toEqual({
@@ -105,11 +105,11 @@ describe("directives", () => {
 		});
 	});
 
-	test("rejects a field with an unknown key", () => {
+	it("rejects a field with an unknown key", () => {
 		expect(() => parse("@[field](server.nope)")).toThrow(/unknown variable "server.nope"/);
 	});
 
-	test("parses a command and collects it", () => {
+	it("parses a command and collects it", () => {
 		const result = parse("@[command](whitelist on)");
 
 		expect(result.blocks[0]).toEqual({
@@ -121,11 +121,11 @@ describe("directives", () => {
 		]);
 	});
 
-	test("rejects an empty command", () => {
+	it("rejects an empty command", () => {
 		expect(() => parse("@[command]()")).toThrow(/a command must be a single line/);
 	});
 
-	test("parses every open target", () => {
+	it("parses every open target", () => {
 		const { blocks } = parse(
 			[
 				"@[open](console)",
@@ -187,27 +187,27 @@ describe("directives", () => {
 		]);
 	});
 
-	test("rejects a panel target without a tab id", () => {
+	it("rejects a panel target without a tab id", () => {
 		expect(() => parse("@[open](panel)")).toThrow(/panel target needs a tab id/);
 	});
 
-	test("rejects an unknown open target", () => {
+	it("rejects an unknown open target", () => {
 		expect(() => parse("@[open](nowhere)")).toThrow(/unknown open target "nowhere"/);
 	});
 
-	test("rejects an argument on a target that takes none", () => {
+	it("rejects an argument on a target that takes none", () => {
 		expect(() => parse("@[open](setup:sign-in)")).toThrow(/"setup" target does not take an argument/);
 	});
 
-	test("rejects a traversing file path", () => {
+	it("rejects a traversing file path", () => {
 		expect(() => parse("@[open](files:../../etc/passwd)")).toThrow();
 	});
 
-	test("rejects an unknown directive", () => {
+	it("rejects an unknown directive", () => {
 		expect(() => parse("@[embed](something)")).toThrow(/unknown directive @\[embed\]/);
 	});
 
-	test("keeps the youtube directive working", () => {
+	it("keeps the youtube directive working", () => {
 		const { blocks } = parse("@[youtube](dQw4w9WgXcQ)");
 
 		expect(blocks[0]).toEqual({
@@ -216,7 +216,7 @@ describe("directives", () => {
 		});
 	});
 
-	test("does not swallow a directive into the paragraph above it", () => {
+	it("does not swallow a directive into the paragraph above it", () => {
 		const { blocks } = parse(
 			[
 				"Copy your address:",
@@ -232,7 +232,7 @@ describe("directives", () => {
 });
 
 describe("conditionals", () => {
-	test("parses both branches", () => {
+	it("parses both branches", () => {
 		const { blocks } = parse(
 			[
 				":::when server.address",
@@ -279,7 +279,7 @@ describe("conditionals", () => {
 		]);
 	});
 
-	test("allows a missing else branch", () => {
+	it("allows a missing else branch", () => {
 		const { blocks } = parse(
 			[
 				":::when server.address",
@@ -294,7 +294,7 @@ describe("conditionals", () => {
 		});
 	});
 
-	test("keeps blocks around a conditional", () => {
+	it("keeps blocks around a conditional", () => {
 		const { blocks } = parse(
 			[
 				"## Join the game",
@@ -314,7 +314,7 @@ describe("conditionals", () => {
 		]);
 	});
 
-	test("parses two conditionals in a row", () => {
+	it("parses two conditionals in a row", () => {
 		const { blocks } = parse(
 			[
 				":::when server.address",
@@ -332,7 +332,7 @@ describe("conditionals", () => {
 		]);
 	});
 
-	test("rejects nesting", () => {
+	it("rejects nesting", () => {
 		expect(() =>
 			parse(
 				[
@@ -346,7 +346,7 @@ describe("conditionals", () => {
 		).toThrow(/conditionals cannot be nested/);
 	});
 
-	test("rejects an unterminated block", () => {
+	it("rejects an unterminated block", () => {
 		expect(() =>
 			parse(
 				[
@@ -357,7 +357,7 @@ describe("conditionals", () => {
 		).toThrow(/unterminated :::when block/);
 	});
 
-	test("rejects an empty when branch", () => {
+	it("rejects an empty when branch", () => {
 		expect(() =>
 			parse(
 				[
@@ -370,11 +370,11 @@ describe("conditionals", () => {
 		).toThrow(/empty :::when branch/);
 	});
 
-	test("rejects a stray close", () => {
+	it("rejects a stray close", () => {
 		expect(() => parse(":::")).toThrow(/unexpected ::: without a matching :::when/);
 	});
 
-	test("rejects an unknown key", () => {
+	it("rejects an unknown key", () => {
 		expect(() =>
 			parse(
 				[
@@ -386,7 +386,7 @@ describe("conditionals", () => {
 		).toThrow(/unknown variable "server.nope"/);
 	});
 
-	test("rejects a malformed opener", () => {
+	it("rejects a malformed opener", () => {
 		expect(() => parse(":::if server.address")).toThrow(/conditionals open with :::when/);
 	});
 });

package/src/install/installStamp.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, test } from "bun:test";
+import { describe, expect, it } from "bun:test";
 import type { BridgeContext } from "../context";
 import { INSTALL_STAMP_FILE, parseStamp, readStamp, writeStamp } from "./installStamp";
 
@@ -31,7 +31,7 @@ const testContext = (seed: Record<string, string> = {}) => {
 };
 
 describe("parseStamp", () => {
-	test("reads a json object", () => {
+	it("reads a json object", () => {
 		expect(
 			parseStamp<TestStamp>(
 				JSON.stringify({
@@ -43,7 +43,7 @@ describe("parseStamp", () => {
 		});
 	});
 
-	test("returns null for anything that is not a json object", () => {
+	it("returns null for anything that is not a json object", () => {
 		expect(parseStamp("")).toBeNull();
 		expect(parseStamp("{")).toBeNull();
 		expect(parseStamp("null")).toBeNull();
@@ -53,13 +53,13 @@ describe("parseStamp", () => {
 });
 
 describe("readStamp", () => {
-	test("returns null when the stamp file is absent", async () => {
+	it("returns null when the stamp file is absent", async () => {
 		const { context } = testContext();
 
 		expect(await readStamp(context)).toBeNull();
 	});
 
-	test("reads the stamp the writer left behind", async () => {
+	it("reads the stamp the writer left behind", async () => {
 		const { context } = testContext();
 
 		await writeStamp<TestStamp>(context, {
@@ -73,7 +73,7 @@ describe("readStamp", () => {
 		});
 	});
 
-	test("writes pretty json ending in a newline", async () => {
+	it("writes pretty json ending in a newline", async () => {
 		const { context, stored } = testContext();
 
 		await writeStamp(context, {
@@ -83,7 +83,7 @@ describe("readStamp", () => {
 		expect(stored.get(INSTALL_STAMP_FILE)).toBe('{\n  "buildId": "1"\n}\n');
 	});
 
-	test("honours a custom stamp path", async () => {
+	it("honours a custom stamp path", async () => {
 		const { context, stored } = testContext();
 
 		await writeStamp(
@@ -100,7 +100,7 @@ describe("readStamp", () => {
 		});
 	});
 
-	test("returns null when the read fails after the file was seen", async () => {
+	it("returns null when the read fails after the file was seen", async () => {
 		const context = {
 			files: {
 				async exists() {
@@ -115,7 +115,7 @@ describe("readStamp", () => {
 		expect(await readStamp(context)).toBeNull();
 	});
 
-	test("returns null when the stamp file is corrupt", async () => {
+	it("returns null when the stamp file is corrupt", async () => {
 		const { context } = testContext({
 			[INSTALL_STAMP_FILE]: "not json",
 		});

package/src/manifest/extension.ts

@@ -0,0 +1,36 @@
+import { z } from "zod";
+
+export enum ManifestExtensionKind {
+	Mods = "mods",
+	Plugins = "plugins",
+	Addons = "addons",
+	Modpacks = "modpacks",
+}
+
+export enum ManifestExtensionSource {
+	Modrinth = "modrinth",
+	CurseForge = "curseforge",
+	Hangar = "hangar",
+	Thunderstore = "thunderstore",
+}
+
+export const EXTENSIONS_LIMIT = Object.values(ManifestExtensionKind).length;
+
+export const EXTENSION_SOURCES_LIMIT = Object.values(ManifestExtensionSource).length;
+
+export const manifestExtensionSchema = z.object({
+	kind: z.enum(ManifestExtensionKind).meta({
+		description: "What the customer adds to the game: mods, plugins, add-ons or modpacks.",
+	}),
+	sources: z.array(z.enum(ManifestExtensionSource)).max(EXTENSION_SOURCES_LIMIT).default([]).meta({
+		description:
+			"The catalogs the panel installs this kind from. Leave it empty when the customer adds them by hand through the files.",
+	}),
+});
+
+export type ManifestExtension = z.infer<typeof manifestExtensionSchema>;
+
+export const manifestExtensionsSchema = z.array(manifestExtensionSchema).max(EXTENSIONS_LIMIT).default([]).meta({
+	description:
+		"What a customer can add to this game, and from which catalogs. The public pages claim only what is declared here; declare nothing when the game takes no additions.",
+});

package/src/manifest/index.ts

@@ -1,6 +1,7 @@
 export * from "../utils";
 export * from "./assets";
 export * from "./category";
+export * from "./extension";
 export * from "./guide";
 export * from "./image";
 export * from "./jsonSchema";