initial commit

packages/protocol/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@lxc/protocol",
+  "version": "0.1.0",
+  "type": "module",
+  "exports": { ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" } },
+  "scripts": { "build": "tsc -p tsconfig.json", "check": "tsc -p tsconfig.json --noEmit", "test": "node --test test/*.test.mjs" },
+  "dependencies": { "zod": "^3.24.2" },
+  "devDependencies": { "typescript": "^5.8.3", "vitest": "^3.1.1" }
+}

packages/protocol/src/index.test.ts

@@ -0,0 +1,6 @@
+import { describe, expect, it } from "vitest";
+import { liveEventSchema, makeEvent } from "./index.js";
+describe("protocol", () => it("parses a typed event", () => {
+  const event = makeEvent("1", "live.enter", { viewer: { uid: "42", name: "观众" } });
+  expect(liveEventSchema.parse(event).type).toBe("live.enter");
+}));

packages/protocol/src/index.ts

@@ -0,0 +1,34 @@
+import { z } from "zod";
+
+export const PROTOCOL_VERSION = 1 as const;
+export const viewerSchema = z.object({ uid: z.string().min(1), name: z.string().min(1).max(128), avatar: z.string().url().optional() });
+export type Viewer = z.infer<typeof viewerSchema>;
+
+const liveEvents = {
+  "live.danmaku": z.object({ viewer: viewerSchema, text: z.string().max(500) }),
+  "live.gift": z.object({ viewer: viewerSchema, giftName: z.string(), battery: z.number().int().nonnegative(), quantity: z.number().int().positive(), sourceEventId: z.string() }),
+  "live.gift.combo": z.object({ viewer: viewerSchema, giftName: z.string(), battery: z.number().int().nonnegative(), quantity: z.number().int().positive(), comboId: z.string() }),
+  "live.enter": z.object({ viewer: viewerSchema }),
+  "live.guard.buy": z.object({ viewer: viewerSchema, guardName: z.string(), quantity: z.number().int().positive(), price: z.number().int().nonnegative() }),
+  "live.superchat": z.object({ viewer: viewerSchema, message: z.string(), price: z.number().int().nonnegative(), sourceEventId: z.string() }),
+  "live.like": z.object({ viewer: viewerSchema }),
+  "live.share": z.object({ viewer: viewerSchema }),
+  "live.unknown": z.object({ cmd: z.string(), raw: z.unknown() }),
+  "system.status": z.object({ connected: z.boolean(), cookieCloud: z.boolean(), replyEnabled: z.boolean(), detail: z.string().optional() }),
+  "system.error": z.object({ code: z.string(), message: z.string() }),
+  "viewer.points.updated": z.object({ viewer: viewerSchema, delta: z.number().int(), balance: z.number().int(), reason: z.enum(["gift", "wheel"]) }),
+  "wheel.result": z.object({ viewer: viewerSchema, category: z.string(), fallback: z.boolean(), song: z.object({ id: z.number().int(), title: z.string(), tags: z.array(z.string()) }), cost: z.literal(150), balance: z.number().int() }),
+  "wheel.insufficient-balance": z.object({ viewer: viewerSchema, balance: z.number().int(), cost: z.literal(150) }),
+  "wheel.invalid-command": z.object({ viewer: viewerSchema, message: z.string() })
+} as const;
+
+export type EventType = keyof typeof liveEvents;
+export type EventPayload<T extends EventType> = z.infer<(typeof liveEvents)[T]>;
+export type LiveEvent = { [T in EventType]: { version: 1; id: string; occurredAt: string; roomId: string; type: T; payload: EventPayload<T> } }[EventType];
+
+const variants = Object.entries(liveEvents).map(([type, payload]) => z.object({ version: z.literal(1), id: z.string().uuid(), occurredAt: z.string().datetime(), roomId: z.string(), type: z.literal(type), payload }));
+export const liveEventSchema = z.discriminatedUnion("type", variants as unknown as [z.ZodDiscriminatedUnionOption<"type">, ...z.ZodDiscriminatedUnionOption<"type">[]]) as unknown as z.ZodType<LiveEvent>;
+
+export function makeEvent<T extends EventType>(roomId: string, type: T, payload: EventPayload<T>): Extract<LiveEvent, { type: T }> {
+  return { version: PROTOCOL_VERSION, id: crypto.randomUUID(), occurredAt: new Date().toISOString(), roomId, type, payload } as Extract<LiveEvent, { type: T }>;
+}

packages/protocol/test/protocol.test.mjs

@@ -0,0 +1,7 @@
+import assert from "node:assert/strict";
+import test from "node:test";
+import { liveEventSchema, makeEvent } from "../dist/index.js";
+test("protocol parses typed event", () => {
+  const event = makeEvent("1", "live.enter", { viewer: { uid: "42", name: "观众" } });
+  assert.equal(liveEventSchema.parse(event).type, "live.enter");
+});

packages/protocol/tsconfig.json

@@ -0,0 +1 @@
+{ "compilerOptions": { "target": "ES2022", "module": "NodeNext", "moduleResolution": "NodeNext", "declaration": true, "outDir": "dist", "strict": true, "skipLibCheck": true }, "include": ["src"] }