@serverkgg/bridge 0.0.21 → 0.1.2

package/src/wire/panel.test.ts

@@ -15,7 +15,7 @@ import {
 	BridgeSetupStepKind,
 	BridgeUploadMode,
 } from "@serverkgg/bridge/protocol";
-import { bridgeCellsSchema, bridgeManifestSchema } from "./panel";
+import { bridgeAvailabilitySchema, bridgeCellsSchema, bridgeManifestSchema } from "./panel";
 
 const text = (value: string) => ({
 	ar: value,
@@ -717,3 +717,69 @@ describe("the cell schema", () => {
 		).toBe(false);
 	});
 });
+
+describe("the availability schema", () => {
+	test("accepts reasons for the module and per subject", () => {
+		const availability = {
+			module: {
+				wipe: text("Closed right now"),
+			},
+			subjects: {
+				"world 1": {
+					delete: text("You cannot delete the active world"),
+				},
+			},
+		};
+
+		expect(bridgeAvailabilitySchema.parse(availability)).toEqual(availability);
+	});
+
+	test("accepts an answer with nothing unavailable", () => {
+		expect(
+			bridgeAvailabilitySchema.parse({
+				module: {},
+				subjects: {},
+			}),
+		).toEqual({
+			module: {},
+			subjects: {},
+		});
+	});
+
+	test("rejects a reason that is not localized", () => {
+		expect(
+			bridgeAvailabilitySchema.safeParse({
+				module: {
+					wipe: "closed",
+				},
+				subjects: {},
+			}).success,
+		).toBe(false);
+	});
+
+	test("keeps a manifest module that advertises availability among its actions", () => {
+		const parsed = bridgeManifestSchema.parse({
+			...manifest(),
+			modules: [
+				{
+					id: "worlds",
+					kind: BridgeKind.Collection,
+					requiresRunning: false,
+					refreshSeconds: null,
+					pageSize: null,
+					dependsOn: [],
+					actions: [
+						BridgeAction.List,
+						"delete",
+						BridgeAction.Availability,
+					],
+					protectedActions: [
+						"delete",
+					],
+				},
+			],
+		});
+
+		expect(parsed.modules[0]?.actions).toContain(BridgeAction.Availability);
+	});
+});

package/src/wire/panel.ts

@@ -68,6 +68,17 @@ export const panelTextSchema = z.object({
 	en: z.string().min(1).max(PANEL_TEXT_LENGTH_LIMIT),
 });
 
+export const bridgeUnavailableSchema = z.record(zKey, panelTextSchema);
+
+export type BridgeUnavailableInput = z.infer<typeof bridgeUnavailableSchema>;
+
+export const bridgeAvailabilitySchema = z.object({
+	module: bridgeUnavailableSchema,
+	subjects: z.record(z.string().min(1), bridgeUnavailableSchema),
+});
+
+export type BridgeAvailabilityInput = z.infer<typeof bridgeAvailabilitySchema>;
+
 export const bridgeCellSchema = z.union([
 	bridgeValueSchema,
 	panelTextSchema,