@lizardon386/game-sdk 0.2.0 → 0.3.0

package/README.md

@@ -4,7 +4,7 @@
 
 导出路径：
 
-- `@lizardon386/game-sdk`：游戏 ABI、版本常量、`reject` / `isReject` / `stableDigest`
+- `@lizardon386/game-sdk`：游戏 ABI、版本常量、`reject` / `isReject` / `stableDigest`、规则表单与静态资料的校验（`parseRuleConfig` / `parseGameReference`）
 - `@lizardon386/game-sdk/client`：客户端契约类型
 - `@lizardon386/game-sdk/node`：`.bpmap` 读写（re-export `@lizardon386/pack-format`）
 - `@lizardon386/game-sdk/kit`：ChatPanel / FeedPanel / ScoreboardPanel / seatColor

package/dist/index.d.ts

@@ -1,3 +1,3 @@
-export type { Effect, GameAction, GameAsset, GameContext, GameInstance, GameManifest, GameMode, GameModule, GameSeatInfo, GameUiOptions, NoticeCode, Outcome, PlatformCode, Reject, RoomPhase, SeatRole, SeatView, ViewerId, } from '@lizardon386/core-abi';
-export { API_VERSION, DEFAULT_MODE, GAME_MODES, SUPPORTED_API_VERSIONS, SUPPORTED_MODES, isReject, reject, stableDigest, } from '@lizardon386/core-abi';
+export type { Effect, GameAction, GameAsset, GameContext, GameInstance, GameManifest, GameMode, GameModule, GameReferenceDocument, GameReferenceGroup, GameReferenceImage, GameReferenceItem, GameReferenceParseResult, GameReferenceSpec, GameSeatInfo, GameUiOptions, NoticeCode, Outcome, PlatformCode, Reject, RoomPhase, RuleConfigField, RuleConfigParseResult, RuleConfigSpec, SeatRole, SeatView, ViewerId, } from '@lizardon386/core-abi';
+export { API_VERSION, DEFAULT_MODE, GAME_MODES, GAME_REFERENCE_LIMITS, RULE_CONFIG_LIMITS, SUPPORTED_API_VERSIONS, SUPPORTED_MODES, isReject, isValidGameReferenceEntry, isValidPackRelativePath, parseGameReference, parseRuleConfig, reject, stableDigest, } from '@lizardon386/core-abi';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,MAAM,EACN,UAAU,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,YAAY,EACZ,aAAa,EACb,UAAU,EACV,OAAO,EACP,YAAY,EACZ,MAAM,EACN,SAAS,EACT,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,WAAW,EACX,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,eAAe,EACf,QAAQ,EACR,MAAM,EACN,YAAY,GACb,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,MAAM,EACN,UAAU,EACV,SAAS,EACT,WAAW,EACX,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,qBAAqB,EACrB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,wBAAwB,EACxB,iBAAiB,EACjB,YAAY,EACZ,aAAa,EACb,UAAU,EACV,OAAO,EACP,YAAY,EACZ,MAAM,EACN,SAAS,EACT,eAAe,EACf,qBAAqB,EACrB,cAAc,EACd,QAAQ,EACR,QAAQ,EACR,QAAQ,GACT,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,WAAW,EACX,YAAY,EACZ,UAAU,EACV,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,QAAQ,EACR,yBAAyB,EACzB,uBAAuB,EACvB,kBAAkB,EAClB,eAAe,EACf,MAAM,EACN,YAAY,GACb,MAAM,uBAAuB,CAAC"}

package/dist/index.js

@@ -1,2 +1,2 @@
-export { API_VERSION, DEFAULT_MODE, GAME_MODES, SUPPORTED_API_VERSIONS, SUPPORTED_MODES, isReject, reject, stableDigest, } from '@lizardon386/core-abi';
+export { API_VERSION, DEFAULT_MODE, GAME_MODES, GAME_REFERENCE_LIMITS, RULE_CONFIG_LIMITS, SUPPORTED_API_VERSIONS, SUPPORTED_MODES, isReject, isValidGameReferenceEntry, isValidPackRelativePath, parseGameReference, parseRuleConfig, reject, stableDigest, } from '@lizardon386/core-abi';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoBA,OAAO,EACL,WAAW,EACX,YAAY,EACZ,UAAU,EACV,sBAAsB,EACtB,eAAe,EACf,QAAQ,EACR,MAAM,EACN,YAAY,GACb,MAAM,uBAAuB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA6BA,OAAO,EACL,WAAW,EACX,YAAY,EACZ,UAAU,EACV,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,QAAQ,EACR,yBAAyB,EACzB,uBAAuB,EACvB,kBAAkB,EAClB,eAAe,EACf,MAAM,EACN,YAAY,GACb,MAAM,uBAAuB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lizardon386/game-sdk",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "3178 游戏接入 SDK：游戏 ABI、客户端契约、单文件包和 game-kit",
   "license": "MIT",
   "author": "3178-battle-platform contributors",
@@ -49,8 +49,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@lizardon386/core-abi": "^0.2.0",
-    "@lizardon386/pack-format": "^0.2.0"
+    "@lizardon386/core-abi": "^0.3.0",
+    "@lizardon386/pack-format": "^0.3.0"
   },
   "files": [
     "dist",

package/src/index.ts

@@ -7,6 +7,12 @@ export type {
   GameManifest,
   GameMode,
   GameModule,
+  GameReferenceDocument,
+  GameReferenceGroup,
+  GameReferenceImage,
+  GameReferenceItem,
+  GameReferenceParseResult,
+  GameReferenceSpec,
   GameSeatInfo,
   GameUiOptions,
   NoticeCode,
@@ -14,6 +20,9 @@ export type {
   PlatformCode,
   Reject,
   RoomPhase,
+  RuleConfigField,
+  RuleConfigParseResult,
+  RuleConfigSpec,
   SeatRole,
   SeatView,
   ViewerId,
@@ -22,9 +31,15 @@ export {
   API_VERSION,
   DEFAULT_MODE,
   GAME_MODES,
+  GAME_REFERENCE_LIMITS,
+  RULE_CONFIG_LIMITS,
   SUPPORTED_API_VERSIONS,
   SUPPORTED_MODES,
   isReject,
+  isValidGameReferenceEntry,
+  isValidPackRelativePath,
+  parseGameReference,
+  parseRuleConfig,
   reject,
   stableDigest,
 } from '@lizardon386/core-abi';

package/dist/contract/module-api.d.ts

@@ -1,104 +0,0 @@
-import type { GameManifest, GameUiOptions, NoticeCode, PlatformCode, RoomPhase, SeatRole } from '@bp/protocol';
-/**
- * 平台与游戏模块之间的唯一契约。
- * 三条硬规矩：
- *  1. 游戏状态不进平台对象——平台只搬 opaque blob。
- *  2. 游戏不许直接碰 socket——一切对外投递都通过返回 Effect[]。
- *  3. 游戏不许改房间相位、座位表或房主权限——那要经过平台（Ready 闸、TTL、审计都在平台）。
- */
-export type ViewerId = string | null;
-export type Effect = {
-    kind: 'broadcast';
-    name: string;
-    payload?: unknown;
-} | {
-    kind: 'toSeat';
-    seatId: string;
-    name: string;
-    payload?: unknown;
-} | {
-    kind: 'notice';
-    code: NoticeCode;
-    text?: string;
-} | {
-    kind: 'system';
-    text: string;
-} | {
-    kind: 'end';
-    reason?: string;
-} | {
-    kind: 'kick';
-    seatId: string;
-    reason?: string;
-};
-export interface Reject {
-    reject: string;
-    code?: PlatformCode;
-}
-export type Outcome = Effect[] | Reject;
-export declare function isReject(value: Outcome): value is Reject;
-export declare function reject(message: string, code?: PlatformCode): Reject;
-export interface GameAction {
-    name: string;
-    payload?: unknown;
-}
-/** 传给游戏模块的座位信息：不含 socket、不含票据，游戏拿不到传输细节。 */
-export interface GameSeatInfo {
-    seatId: string;
-    slot: number;
-    name: string;
-    role: SeatRole;
-    team: string | number | null;
-    ready: boolean;
-    connected: boolean;
-}
-export interface GameContext {
-    readonly roomCode: string;
-    readonly config: Record<string, unknown>;
-    /** 注入时钟与随机源，让规则测试可确定性推进。 */
-    now(): number;
-    random(): number;
-    seats(): GameSeatInfo[];
-    seat(seatId: string): GameSeatInfo | undefined;
-}
-export interface GameInstance {
-    /** 按视角裁剪后的状态；`null` 表示观战视角。 */
-    serialize(viewer: ViewerId): unknown;
-    handle(action: GameAction, by: string): Outcome;
-    /** 开局。平台已确认发话人是房主且所有人类玩家都 Ready。 */
-    begin(): Outcome;
-    snapshot(): unknown;
-    /** 心跳：规则计时窗口在这里推进（旧项目心跳里的玩法部分）。 */
-    tick?(now: number): Effect[];
-    onSeatJoin?(seat: GameSeatInfo): Effect[];
-    onSeatLeave?(seat: GameSeatInfo, phase: RoomPhase): Effect[];
-    /** 座位超时。托管与罚则属于游戏，不属于平台。 */
-    onTimeout?(seat: GameSeatInfo): Effect[];
-    dispose?(): void;
-}
-export interface GameModule {
-    id: string;
-    name: string;
-    version: string;
-    entry: string;
-    seats: {
-        min: number;
-        max: number;
-    };
-    allowSpectate: boolean;
-    soloFill: boolean;
-    roles: SeatRole[];
-    /** 把房主原始设置规范化；返回的形状决定 rulesHash 与 create 的输入。 */
-    normalizeConfig(raw: Record<string, unknown> | undefined): Record<string, unknown>;
-    /** 只摘要真正影响对局的字段，避免"改了房间名也算房规不同"。 */
-    rulesHashOf(config: Record<string, unknown>): string;
-    create(config: Record<string, unknown>, ctx: GameContext): GameInstance;
-    resume(snapshot: unknown, ctx: GameContext): GameInstance;
-    /** 落盘快照的兼容性闸；返回 false 则平台丢弃快照并报错给房主。 */
-    acceptsSnapshot?(snapshot: unknown): boolean;
-    /** 可选 UI 声明；例如让游戏自己的聊天面板替代平台聊天卡。 */
-    ui?: GameUiOptions;
-}
-/** 平台侧组装 manifest。rulesHash 由模块从规范化 config 算出，平台不参与玩法判断。 */
-export declare function manifestOf(module: GameModule, config: Record<string, unknown>): GameManifest;
-//# sourceMappingURL=module-api.d.ts.map

package/dist/contract/module-api.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"module-api.d.ts","sourceRoot":"","sources":["../../src/contract/module-api.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAE/G;;;;;;GAMG;AAEH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;AAErC,MAAM,MAAM,MAAM,GACd;IAAE,IAAI,EAAE,WAAW,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACtD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GACnE;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,UAAU,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACnD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAChC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtD,MAAM,WAAW,MAAM;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,YAAY,CAAC;CACrB;AAED,MAAM,MAAM,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC;AAExC,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAExD;AAED,wBAAgB,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,YAAY,GAAG,MAAM,CAEnE;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,4CAA4C;AAC5C,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzC,4BAA4B;IAC5B,GAAG,IAAI,MAAM,CAAC;IACd,MAAM,IAAI,MAAM,CAAC;IACjB,KAAK,IAAI,YAAY,EAAE,CAAC;IACxB,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;CAChD;AAED,MAAM,WAAW,YAAY;IAC3B,+BAA+B;IAC/B,SAAS,CAAC,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAC;IACrC,MAAM,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;IAChD,oCAAoC;IACpC,KAAK,IAAI,OAAO,CAAC;IACjB,QAAQ,IAAI,OAAO,CAAC;IACpB,mCAAmC;IACnC,IAAI,CAAC,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,UAAU,CAAC,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,EAAE,CAAC;IAC1C,WAAW,CAAC,CAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS,GAAG,MAAM,EAAE,CAAC;IAC7D,4BAA4B;IAC5B,SAAS,CAAC,CAAC,IAAI,EAAE,YAAY,GAAG,MAAM,EAAE,CAAC;IACzC,OAAO,CAAC,IAAI,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,aAAa,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,EAAE,QAAQ,EAAE,CAAC;IAClB,iDAAiD;IACjD,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnF,oCAAoC;IACpC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC;IACrD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,EAAE,WAAW,GAAG,YAAY,CAAC;IACxE,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,WAAW,GAAG,YAAY,CAAC;IAC1D,wCAAwC;IACxC,eAAe,CAAC,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7C,oCAAoC;IACpC,EAAE,CAAC,EAAE,aAAa,CAAC;CACpB;AAED,4DAA4D;AAC5D,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAa5F"}

package/dist/contract/module-api.js

@@ -1,22 +0,0 @@
-export function isReject(value) {
-    return !Array.isArray(value) && typeof value?.reject === 'string';
-}
-export function reject(message, code) {
-    return code ? { reject: message, code } : { reject: message };
-}
-/** 平台侧组装 manifest。rulesHash 由模块从规范化 config 算出，平台不参与玩法判断。 */
-export function manifestOf(module, config) {
-    return {
-        id: module.id,
-        name: module.name,
-        version: module.version,
-        rulesHash: module.rulesHashOf(config),
-        seats: module.seats,
-        allowSpectate: module.allowSpectate,
-        soloFill: module.soloFill,
-        roles: module.roles,
-        entry: module.entry,
-        ...(module.ui ? { ui: { ...module.ui } } : {}),
-    };
-}
-//# sourceMappingURL=module-api.js.map

package/dist/contract/module-api.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"module-api.js","sourceRoot":"","sources":["../../src/contract/module-api.ts"],"names":[],"mappings":"AA2BA,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,OAAQ,KAAgB,EAAE,MAAM,KAAK,QAAQ,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,OAAe,EAAE,IAAmB;IACzD,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AAChE,CAAC;AAiED,4DAA4D;AAC5D,MAAM,UAAU,UAAU,CAAC,MAAkB,EAAE,MAA+B;IAC5E,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,OAAO,EAAE,MAAM,CAAC,OAAO;QACvB,SAAS,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC;QACrC,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,GAAG,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC/C,CAAC;AACJ,CAAC"}