@funfair-works/ggs-protocol 0.0.1

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+import * as ggsProtocol from './protocol.js';
+export { ggsProtocol as default };
+//# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -0,0 +1,3 @@
+import * as ggsProtocol from './protocol.js';
+export { ggsProtocol as default };
+//# sourceMappingURL=index.js.map

package/lib/protocol.d.ts

@@ -0,0 +1,171 @@
+export declare enum MessageId {
+    /**
+     * 列出所有游戏房间。
+     * @sender client
+     */
+    listRooms = "listRooms",
+    /**
+     * 创建游戏房间。
+     * @sender client
+     */
+    createRoom = "createRoom",
+    /**
+     * 请求加入游戏。
+     * @sender client
+     */
+    requestJoinRoom = "requestJoinRoom",
+    /**
+     * 请求加入游戏响应。
+     * @sender server
+     */
+    requestJoinRoomResponse = "requestJoinResponse",
+    /**
+     * 玩家加入。
+     * @sender server
+     */
+    playerJoinRoom = "playerJoin",
+    /**
+     * 请求离开游戏。
+     * @sender client
+     */
+    requestLeaveRoom = "requestLeave",
+    /**
+     * 玩家离开。
+     * @sender server
+     */
+    playerLeaveRoom = "playerLeave",
+    /**
+     * 单播。
+     * @sender client
+     */
+    unicast = "unicast",
+    /**
+     * 广播。
+     * @sender client
+     */
+    broadcast = "broadcast",
+    /**
+     * 消息响应。
+     * @sender server
+     */
+    messageReceived = "messageReceived",
+    /**
+     * 服务器错误。
+     */
+    serverError = "serverError"
+}
+export type CustomData = Uint8Array | string;
+export interface MessageMap {
+    [MessageId.listRooms]: {};
+    [MessageId.createRoom]: {
+        secret?: string;
+        payload: CustomData;
+    };
+    [MessageId.requestJoinRoom]: {
+        roomId: number;
+        payload: CustomData;
+    };
+    [MessageId.requestJoinRoomResponse]: {
+        playerIdInRoom: number;
+        payload: CustomData;
+        room: GameRoom;
+    };
+    [MessageId.playerJoinRoom]: {
+        playerIdInRoom: number;
+        name: string;
+        debug?: {
+            clientId: number;
+        };
+        payload: CustomData;
+    };
+    [MessageId.requestLeaveRoom]: {};
+    [MessageId.playerLeaveRoom]: {
+        playerIdInRoom: number;
+    };
+    /**
+     * 单播。
+     * @sender client
+     */
+    [MessageId.unicast]: {
+        receiver: number;
+        data: CustomData;
+    };
+    /**
+     * 单播响应。
+     * @sender server
+     */
+    [MessageId.messageReceived]: {
+        sender: number;
+        data: CustomData;
+    };
+    /**
+     * 广播。
+     * @sender client
+     */
+    [MessageId.broadcast]: {
+        excepts?: number[];
+        data: CustomData;
+    };
+    /**
+     * 消息。
+     * @sender client
+     */
+    [MessageId.serverError]: {
+        code: number;
+        message: string;
+    };
+}
+export interface RPCMap {
+    [MessageId.listRooms]: {
+        rooms: GameRoom[];
+    };
+}
+export type Message<T extends MessageId> = MessageMap[T];
+export type ResponseMessage<T extends keyof RPCMap> = RPCMap[T];
+export type RequestingMessageId = keyof RPCMap;
+export interface GameRoom {
+    id: number;
+    players: Array<{
+        id: number;
+        name: string;
+    }>;
+    secret?: string;
+    payload?: CustomData;
+    maxPlayers: number;
+    owner: number;
+}
+export declare enum ServerErrorCode {
+    unknown = 0
+}
+export declare enum MessageEnvelopType {
+    notification = 0,
+    request = 1,
+    response = 2,
+    requestException = 3
+}
+export interface EnvelopBase {
+    __stack__?: string;
+}
+export type RequestEnvelop<T extends RequestingMessageId> = {
+    type: MessageEnvelopType.request;
+    requestId: number;
+    messageId: T;
+    message: Message<T>;
+} & EnvelopBase;
+export type ResponseEnvelop<T extends RequestingMessageId> = {
+    type: MessageEnvelopType.response;
+    requestId: number;
+    message: ResponseMessage<T>;
+} & EnvelopBase;
+export type RequestExceptionEnvelop = {
+    type: MessageEnvelopType.requestException;
+    requestId: number;
+    errorMessage: string;
+} & EnvelopBase;
+export type NotificationEnvelop<TMessageId extends MessageId> = {
+    type: MessageEnvelopType.notification;
+    messageId: TMessageId;
+    message: Message<TMessageId>;
+} & EnvelopBase;
+export type MessageEnvelop = RequestEnvelop<RequestingMessageId> | ResponseEnvelop<RequestingMessageId> | RequestExceptionEnvelop | NotificationEnvelop<MessageId>;
+//# sourceMappingURL=protocol.d.ts.map

package/lib/protocol.js

@@ -0,0 +1,69 @@
+export var MessageId;
+(function (MessageId) {
+    /**
+     * 列出所有游戏房间。
+     * @sender client
+     */
+    MessageId["listRooms"] = "listRooms";
+    /**
+     * 创建游戏房间。
+     * @sender client
+     */
+    MessageId["createRoom"] = "createRoom";
+    /**
+     * 请求加入游戏。
+     * @sender client
+     */
+    MessageId["requestJoinRoom"] = "requestJoinRoom";
+    /**
+     * 请求加入游戏响应。
+     * @sender server
+     */
+    MessageId["requestJoinRoomResponse"] = "requestJoinResponse";
+    /**
+     * 玩家加入。
+     * @sender server
+     */
+    MessageId["playerJoinRoom"] = "playerJoin";
+    /**
+     * 请求离开游戏。
+     * @sender client
+     */
+    MessageId["requestLeaveRoom"] = "requestLeave";
+    /**
+     * 玩家离开。
+     * @sender server
+     */
+    MessageId["playerLeaveRoom"] = "playerLeave";
+    /**
+     * 单播。
+     * @sender client
+     */
+    MessageId["unicast"] = "unicast";
+    /**
+     * 广播。
+     * @sender client
+     */
+    MessageId["broadcast"] = "broadcast";
+    /**
+     * 消息响应。
+     * @sender server
+     */
+    MessageId["messageReceived"] = "messageReceived";
+    /**
+     * 服务器错误。
+     */
+    MessageId["serverError"] = "serverError";
+})(MessageId || (MessageId = {}));
+export var ServerErrorCode;
+(function (ServerErrorCode) {
+    ServerErrorCode[ServerErrorCode["unknown"] = 0] = "unknown";
+})(ServerErrorCode || (ServerErrorCode = {}));
+export var MessageEnvelopType;
+(function (MessageEnvelopType) {
+    MessageEnvelopType[MessageEnvelopType["notification"] = 0] = "notification";
+    MessageEnvelopType[MessageEnvelopType["request"] = 1] = "request";
+    MessageEnvelopType[MessageEnvelopType["response"] = 2] = "response";
+    MessageEnvelopType[MessageEnvelopType["requestException"] = 3] = "requestException";
+})(MessageEnvelopType || (MessageEnvelopType = {}));
+//# sourceMappingURL=protocol.js.map

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@funfair-works/ggs-protocol",
+  "version": "0.0.1",
+  "type": "module",
+  "files": [
+    "lib",
+    "!lib/**/*.map"
+  ],
+  "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "scripts": {
+    "prepublishOnly": "pnpm exec tsc --build --clean && npm run build",
+    "build": "pnpm exec tsc -b",
+    "dev": "pnpm exec tsc -b -w"
+  }
+}