tiaoom 0.0.1

package/src/index.d.cts

@@ -0,0 +1,350 @@
+/// <reference types="node" />
+import EventEmitter$1, { EventEmitter } from "events";
+
+//#region lib/events/base.d.ts
+interface BaseEvents {
+  ready: () => void;
+  close: () => void;
+  error: (error: Error) => void;
+}
+//#endregion
+//#region lib/events/player.d.ts
+interface PlayerEvents extends BaseEvents {
+  /**
+   * 加入房间
+   **/
+  join: (room: Room, player: Player) => void;
+  /**
+   * 离开房间
+   **/
+  leave: (room: Room, player: Player) => void;
+  /**
+   * 玩家状态变化
+   **/
+  status: (status: PlayerStatus) => void;
+  /**
+   * 玩家命令
+   */
+  command: (message: MessagePackage) => void;
+  /**
+   * 玩家私信
+   **/
+  message: (data: string, sender?: Player) => void;
+}
+//#endregion
+//#region lib/models/player.d.ts
+interface PlayerOptions {
+  id: string;
+  name: string;
+  attributes?: any;
+  sender?: (type: string, ...message: any) => void;
+}
+declare enum PlayerStatus {
+  ready = "ready",
+  unready = "unready",
+  online = "online",
+  playing = "playing",
+}
+interface IPlayer extends PlayerOptions {
+  status: PlayerStatus;
+}
+declare class Player extends EventEmitter$1 implements IPlayer {
+  on<K extends keyof PlayerEvents>(event: K, listener: PlayerEvents[K]): this;
+  emit<K extends keyof PlayerEvents>(event: K, ...args: Parameters<PlayerEvents[K]>): boolean;
+  id: string;
+  name: string;
+  attributes?: any;
+  status: PlayerStatus;
+  sender?: (type: string, ...message: any) => void;
+  constructor({
+    id,
+    name,
+    attributes,
+    sender
+  }: PlayerOptions);
+  toJSON(): {
+    id: string;
+    name: string;
+    attributes: any;
+    status: PlayerStatus;
+  };
+  toString(): string;
+  setSender(sender: (type: string, ...message: any) => void): this;
+}
+//#endregion
+//#region lib/models/message.d.ts
+declare enum MessageTypes {
+  RoomList = "room.list",
+  RoomCreate = "room.create",
+  RoomReady = "room.ready",
+  RoomStart = "room.start",
+  RoomEnd = "room.end",
+  RoomClose = "room.close",
+  RoomAllReady = "room.allready",
+  RoomCommand = "room.command",
+  RoomMessage = "room.message",
+  PlayerOffline = "player.offline",
+  PlayerList = "player.list",
+  PlayerLogin = "player.login",
+  PlayerLogout = "player.logout",
+  PlayerJoin = "player.join",
+  PlayerLeave = "player.leave",
+  PlayerReady = "player.ready",
+  PlayerUnready = "player.unready",
+  PlayerCommand = "player.command",
+}
+interface MessagePackage {
+  type: MessageTypes | string;
+  data?: PlayerOptions | IRoomOptions | IPlayer | IRoom | IRoomPlayer | any;
+  sender?: IPlayer | IRoom | IRoomPlayer;
+}
+interface Message extends EventEmitter$1 {
+  on<K extends keyof MessageEvents>(event: K, listener: MessageEvents[K]): this;
+  emit<K extends keyof MessageEvents>(event: K, ...args: Parameters<MessageEvents[K]>): boolean;
+  close(): void;
+  send(message: MessagePackage): void;
+}
+//#endregion
+//#region lib/events/message.d.ts
+interface MessageEvents extends BaseEvents {
+  /**
+   * 服务接收数据
+   */
+  message: (data: MessagePackage, cb?: (...params: any) => any) => void;
+}
+//#endregion
+//#region lib/events/room.d.ts
+interface RoomEvents extends BaseEvents {
+  /**
+   * 加入房间
+   **/
+  join: (player: IRoomPlayer) => void;
+  /**
+   * 离开房间
+   **/
+  leave: (player: IRoomPlayer) => void;
+  /**
+   * 房间状态变化
+   **/
+  status: (status: RoomStatus) => void;
+  /**
+   * 房间聊天
+   **/
+  message: (data: string) => void;
+  /**
+   * 玩家发送的房间命令
+   */
+  'player-command': (message: MessagePackage) => void;
+  /**
+   * 房间命令
+   */
+  command: (message: MessagePackage) => void;
+  /**
+   * 房间更新
+   */
+  update: (room: IRoom) => void;
+  /**
+   * 玩家准备
+   */
+  'player-ready': (player: IRoomPlayer) => void;
+  /**
+   * 全部玩家已准备
+   */
+  'all-ready': (players: IRoomPlayer[]) => void;
+  /**
+   * 玩家取消准备
+   */
+  'player-unready': (player: IRoomPlayer) => void;
+  /**
+   * 房间开始游戏
+   */
+  start: (room: IRoom) => void;
+  /**
+   * 房间结束游戏
+   */
+  end: (room: IRoom) => void;
+}
+//#endregion
+//#region lib/events/index.d.ts
+/**
+ * Tiaoom 广播事件
+ */
+interface TiaoomEvents extends BaseEvents {
+  /**
+   * 房间创建事件
+   * @param room 房间信息
+   */
+  room: (room: Room) => void;
+  /**
+   * 返回房间列表
+   * @param rooms 房间列表
+   */
+  rooms: (rooms: Room[]) => void;
+  /**
+   * 房间玩家变更事件
+   * @param room 房间信息
+   */
+  'room-player': (room: Room) => void;
+  /**
+   * 玩家变更事件
+   * @param player 玩家信息
+   * @param online 是否在线
+   */
+  player: (player: Player, online: boolean) => void;
+  /**
+   * 返回玩家列表
+   * @param players 玩家列表
+   */
+  players: (players: Player[]) => void;
+  /**
+   * 全局命令事件
+   * @param command 命令内容
+   */
+  command: (data: any & {
+    sender: Player;
+  }) => void;
+}
+//#endregion
+//#region lib/models/room.d.ts
+interface IRoomOptions {
+  /**
+   * 房间号
+   */
+  id?: string;
+  /**
+   * 房间名称
+   */
+  name?: string;
+  /**
+   * 房间容量
+   */
+  size?: number;
+  /**
+   * 最小容量
+   */
+  minSize?: number;
+  /**
+   * 其他属性
+   */
+  attrs?: Record<string, any>;
+}
+declare enum PlayerRole {
+  player = "player",
+  watcher = "watcher",
+}
+declare enum RoomStatus {
+  waiting = "waiting",
+  ready = "ready",
+  playing = "playing",
+}
+interface IRoom extends IRoomOptions {
+  players: RoomPlayer[];
+}
+interface IRoomPlayerOptions extends PlayerOptions {
+  roomId?: string;
+}
+interface IRoomPlayer extends IRoomPlayerOptions, IPlayer {
+  isReady: boolean;
+  role: PlayerRole;
+  isCreator: boolean;
+}
+declare class RoomPlayer extends Player implements IRoomPlayer {
+  isReady: boolean;
+  role: PlayerRole;
+  isCreator: boolean;
+  roomId?: string;
+  constructor(player: IPlayer | Player, role?: PlayerRole);
+  toJSON(): {
+    role: PlayerRole;
+    isReady: boolean;
+    isCreator: boolean;
+    id: string;
+    name: string;
+    attributes: any;
+    status: PlayerStatus;
+  };
+}
+declare class Room extends EventEmitter$1 implements IRoom {
+  on<K extends keyof RoomEvents>(event: K, listener: RoomEvents[K]): this;
+  emit<K extends keyof RoomEvents>(event: K, ...args: Parameters<RoomEvents[K]>): boolean;
+  id: string;
+  size: number;
+  name: string;
+  minSize: number;
+  attrs?: Record<string, any>;
+  players: RoomPlayer[];
+  get validPlayers(): RoomPlayer[];
+  get watchers(): RoomPlayer[];
+  private sender?;
+  get isReady(): boolean;
+  get status(): RoomStatus;
+  get isPlaying(): boolean;
+  get isFull(): boolean;
+  toJSON(): {
+    id: string;
+    name: string;
+    size: number;
+    minSize: number;
+    status: RoomStatus;
+    players: {
+      role: PlayerRole;
+      isReady: boolean;
+      isCreator: boolean;
+      id: string;
+      name: string;
+      attributes: any;
+      status: PlayerStatus;
+    }[];
+    attrs: Record<string, any> | undefined;
+  };
+  toString(): string;
+  constructor({
+    id,
+    name,
+    size,
+    minSize,
+    attrs
+  }: IRoomOptions);
+  addPlayer(player: Player, isCreator?: boolean): RoomPlayer | undefined;
+  kickPlayer(playerId: string): RoomPlayer;
+  kickPlayer(player: IPlayer): RoomPlayer;
+  searchPlayer(playerId: string): RoomPlayer | undefined;
+  searchPlayer(playerId: IPlayer): RoomPlayer | undefined;
+  start(): boolean;
+  end(): boolean;
+  setSender(sender: (type: string, ...message: any) => void): this;
+}
+//#endregion
+//#region lib/index.d.ts
+interface ITiaoomOptions {
+  socket: Message;
+}
+declare class Tiaoom extends EventEmitter {
+  rooms: Room[];
+  players: Player[];
+  messageInstance?: Message;
+  constructor({
+    socket
+  }: ITiaoomOptions);
+  on<K extends keyof TiaoomEvents>(event: K, listener: TiaoomEvents[K]): this;
+  emit<K extends keyof TiaoomEvents>(event: K, ...args: Parameters<TiaoomEvents[K]>): boolean;
+  run(): this;
+  searchPlayer(player: string): Player | undefined;
+  searchPlayer(player: PlayerOptions | IRoomPlayerOptions): Player | undefined;
+  searchRoom(room: string): Room | undefined;
+  searchRoom(room: Partial<IRoomOptions>): Room | undefined;
+  createRoom(sender: IPlayer, options: IRoomOptions): Room;
+  startRoom(sender: IPlayer, room: IRoom): boolean;
+  closeRoom(sender: IPlayer, room: IRoom): IRoom;
+  loginPlayer(player: PlayerOptions, cb?: (data: {
+    player: Player;
+  }) => void): Player;
+  joinPlayer(sender: IPlayer, player: IRoomPlayerOptions, isCreator?: boolean): RoomPlayer;
+  leavePlayer(sender: IPlayer, player: IRoomPlayerOptions): RoomPlayer;
+  readyPlayer(sender: IPlayer, player: IRoomPlayer): this;
+  unReadyPlayer(sender: IPlayer, player: IRoomPlayer): this;
+  removePlayer(sender: IPlayer): Player;
+}
+//#endregion
+export { IPlayer, IRoom, IRoomOptions, IRoomPlayer, IRoomPlayerOptions, ITiaoomOptions, Message, MessageEvents, MessagePackage, MessageTypes, Player, PlayerEvents, PlayerOptions, PlayerRole, PlayerStatus, Room, RoomEvents, RoomPlayer, RoomStatus, Tiaoom, TiaoomEvents };
+//# sourceMappingURL=index.d.cts.map

package/src/index.d.mts

@@ -0,0 +1,350 @@
+/// <reference types="node" />
+import EventEmitter$1, { EventEmitter } from "events";
+
+//#region lib/events/base.d.ts
+interface BaseEvents {
+  ready: () => void;
+  close: () => void;
+  error: (error: Error) => void;
+}
+//#endregion
+//#region lib/events/player.d.ts
+interface PlayerEvents extends BaseEvents {
+  /**
+   * 加入房间
+   **/
+  join: (room: Room, player: Player) => void;
+  /**
+   * 离开房间
+   **/
+  leave: (room: Room, player: Player) => void;
+  /**
+   * 玩家状态变化
+   **/
+  status: (status: PlayerStatus) => void;
+  /**
+   * 玩家命令
+   */
+  command: (message: MessagePackage) => void;
+  /**
+   * 玩家私信
+   **/
+  message: (data: string, sender?: Player) => void;
+}
+//#endregion
+//#region lib/models/player.d.ts
+interface PlayerOptions {
+  id: string;
+  name: string;
+  attributes?: any;
+  sender?: (type: string, ...message: any) => void;
+}
+declare enum PlayerStatus {
+  ready = "ready",
+  unready = "unready",
+  online = "online",
+  playing = "playing",
+}
+interface IPlayer extends PlayerOptions {
+  status: PlayerStatus;
+}
+declare class Player extends EventEmitter$1 implements IPlayer {
+  on<K extends keyof PlayerEvents>(event: K, listener: PlayerEvents[K]): this;
+  emit<K extends keyof PlayerEvents>(event: K, ...args: Parameters<PlayerEvents[K]>): boolean;
+  id: string;
+  name: string;
+  attributes?: any;
+  status: PlayerStatus;
+  sender?: (type: string, ...message: any) => void;
+  constructor({
+    id,
+    name,
+    attributes,
+    sender
+  }: PlayerOptions);
+  toJSON(): {
+    id: string;
+    name: string;
+    attributes: any;
+    status: PlayerStatus;
+  };
+  toString(): string;
+  setSender(sender: (type: string, ...message: any) => void): this;
+}
+//#endregion
+//#region lib/models/message.d.ts
+declare enum MessageTypes {
+  RoomList = "room.list",
+  RoomCreate = "room.create",
+  RoomReady = "room.ready",
+  RoomStart = "room.start",
+  RoomEnd = "room.end",
+  RoomClose = "room.close",
+  RoomAllReady = "room.allready",
+  RoomCommand = "room.command",
+  RoomMessage = "room.message",
+  PlayerOffline = "player.offline",
+  PlayerList = "player.list",
+  PlayerLogin = "player.login",
+  PlayerLogout = "player.logout",
+  PlayerJoin = "player.join",
+  PlayerLeave = "player.leave",
+  PlayerReady = "player.ready",
+  PlayerUnready = "player.unready",
+  PlayerCommand = "player.command",
+}
+interface MessagePackage {
+  type: MessageTypes | string;
+  data?: PlayerOptions | IRoomOptions | IPlayer | IRoom | IRoomPlayer | any;
+  sender?: IPlayer | IRoom | IRoomPlayer;
+}
+interface Message extends EventEmitter$1 {
+  on<K extends keyof MessageEvents>(event: K, listener: MessageEvents[K]): this;
+  emit<K extends keyof MessageEvents>(event: K, ...args: Parameters<MessageEvents[K]>): boolean;
+  close(): void;
+  send(message: MessagePackage): void;
+}
+//#endregion
+//#region lib/events/message.d.ts
+interface MessageEvents extends BaseEvents {
+  /**
+   * 服务接收数据
+   */
+  message: (data: MessagePackage, cb?: (...params: any) => any) => void;
+}
+//#endregion
+//#region lib/events/room.d.ts
+interface RoomEvents extends BaseEvents {
+  /**
+   * 加入房间
+   **/
+  join: (player: IRoomPlayer) => void;
+  /**
+   * 离开房间
+   **/
+  leave: (player: IRoomPlayer) => void;
+  /**
+   * 房间状态变化
+   **/
+  status: (status: RoomStatus) => void;
+  /**
+   * 房间聊天
+   **/
+  message: (data: string) => void;
+  /**
+   * 玩家发送的房间命令
+   */
+  'player-command': (message: MessagePackage) => void;
+  /**
+   * 房间命令
+   */
+  command: (message: MessagePackage) => void;
+  /**
+   * 房间更新
+   */
+  update: (room: IRoom) => void;
+  /**
+   * 玩家准备
+   */
+  'player-ready': (player: IRoomPlayer) => void;
+  /**
+   * 全部玩家已准备
+   */
+  'all-ready': (players: IRoomPlayer[]) => void;
+  /**
+   * 玩家取消准备
+   */
+  'player-unready': (player: IRoomPlayer) => void;
+  /**
+   * 房间开始游戏
+   */
+  start: (room: IRoom) => void;
+  /**
+   * 房间结束游戏
+   */
+  end: (room: IRoom) => void;
+}
+//#endregion
+//#region lib/events/index.d.ts
+/**
+ * Tiaoom 广播事件
+ */
+interface TiaoomEvents extends BaseEvents {
+  /**
+   * 房间创建事件
+   * @param room 房间信息
+   */
+  room: (room: Room) => void;
+  /**
+   * 返回房间列表
+   * @param rooms 房间列表
+   */
+  rooms: (rooms: Room[]) => void;
+  /**
+   * 房间玩家变更事件
+   * @param room 房间信息
+   */
+  'room-player': (room: Room) => void;
+  /**
+   * 玩家变更事件
+   * @param player 玩家信息
+   * @param online 是否在线
+   */
+  player: (player: Player, online: boolean) => void;
+  /**
+   * 返回玩家列表
+   * @param players 玩家列表
+   */
+  players: (players: Player[]) => void;
+  /**
+   * 全局命令事件
+   * @param command 命令内容
+   */
+  command: (data: any & {
+    sender: Player;
+  }) => void;
+}
+//#endregion
+//#region lib/models/room.d.ts
+interface IRoomOptions {
+  /**
+   * 房间号
+   */
+  id?: string;
+  /**
+   * 房间名称
+   */
+  name?: string;
+  /**
+   * 房间容量
+   */
+  size?: number;
+  /**
+   * 最小容量
+   */
+  minSize?: number;
+  /**
+   * 其他属性
+   */
+  attrs?: Record<string, any>;
+}
+declare enum PlayerRole {
+  player = "player",
+  watcher = "watcher",
+}
+declare enum RoomStatus {
+  waiting = "waiting",
+  ready = "ready",
+  playing = "playing",
+}
+interface IRoom extends IRoomOptions {
+  players: RoomPlayer[];
+}
+interface IRoomPlayerOptions extends PlayerOptions {
+  roomId?: string;
+}
+interface IRoomPlayer extends IRoomPlayerOptions, IPlayer {
+  isReady: boolean;
+  role: PlayerRole;
+  isCreator: boolean;
+}
+declare class RoomPlayer extends Player implements IRoomPlayer {
+  isReady: boolean;
+  role: PlayerRole;
+  isCreator: boolean;
+  roomId?: string;
+  constructor(player: IPlayer | Player, role?: PlayerRole);
+  toJSON(): {
+    role: PlayerRole;
+    isReady: boolean;
+    isCreator: boolean;
+    id: string;
+    name: string;
+    attributes: any;
+    status: PlayerStatus;
+  };
+}
+declare class Room extends EventEmitter$1 implements IRoom {
+  on<K extends keyof RoomEvents>(event: K, listener: RoomEvents[K]): this;
+  emit<K extends keyof RoomEvents>(event: K, ...args: Parameters<RoomEvents[K]>): boolean;
+  id: string;
+  size: number;
+  name: string;
+  minSize: number;
+  attrs?: Record<string, any>;
+  players: RoomPlayer[];
+  get validPlayers(): RoomPlayer[];
+  get watchers(): RoomPlayer[];
+  private sender?;
+  get isReady(): boolean;
+  get status(): RoomStatus;
+  get isPlaying(): boolean;
+  get isFull(): boolean;
+  toJSON(): {
+    id: string;
+    name: string;
+    size: number;
+    minSize: number;
+    status: RoomStatus;
+    players: {
+      role: PlayerRole;
+      isReady: boolean;
+      isCreator: boolean;
+      id: string;
+      name: string;
+      attributes: any;
+      status: PlayerStatus;
+    }[];
+    attrs: Record<string, any> | undefined;
+  };
+  toString(): string;
+  constructor({
+    id,
+    name,
+    size,
+    minSize,
+    attrs
+  }: IRoomOptions);
+  addPlayer(player: Player, isCreator?: boolean): RoomPlayer | undefined;
+  kickPlayer(playerId: string): RoomPlayer;
+  kickPlayer(player: IPlayer): RoomPlayer;
+  searchPlayer(playerId: string): RoomPlayer | undefined;
+  searchPlayer(playerId: IPlayer): RoomPlayer | undefined;
+  start(): boolean;
+  end(): boolean;
+  setSender(sender: (type: string, ...message: any) => void): this;
+}
+//#endregion
+//#region lib/index.d.ts
+interface ITiaoomOptions {
+  socket: Message;
+}
+declare class Tiaoom extends EventEmitter {
+  rooms: Room[];
+  players: Player[];
+  messageInstance?: Message;
+  constructor({
+    socket
+  }: ITiaoomOptions);
+  on<K extends keyof TiaoomEvents>(event: K, listener: TiaoomEvents[K]): this;
+  emit<K extends keyof TiaoomEvents>(event: K, ...args: Parameters<TiaoomEvents[K]>): boolean;
+  run(): this;
+  searchPlayer(player: string): Player | undefined;
+  searchPlayer(player: PlayerOptions | IRoomPlayerOptions): Player | undefined;
+  searchRoom(room: string): Room | undefined;
+  searchRoom(room: Partial<IRoomOptions>): Room | undefined;
+  createRoom(sender: IPlayer, options: IRoomOptions): Room;
+  startRoom(sender: IPlayer, room: IRoom): boolean;
+  closeRoom(sender: IPlayer, room: IRoom): IRoom;
+  loginPlayer(player: PlayerOptions, cb?: (data: {
+    player: Player;
+  }) => void): Player;
+  joinPlayer(sender: IPlayer, player: IRoomPlayerOptions, isCreator?: boolean): RoomPlayer;
+  leavePlayer(sender: IPlayer, player: IRoomPlayerOptions): RoomPlayer;
+  readyPlayer(sender: IPlayer, player: IRoomPlayer): this;
+  unReadyPlayer(sender: IPlayer, player: IRoomPlayer): this;
+  removePlayer(sender: IPlayer): Player;
+}
+//#endregion
+export { IPlayer, IRoom, IRoomOptions, IRoomPlayer, IRoomPlayerOptions, ITiaoomOptions, Message, MessageEvents, MessagePackage, MessageTypes, Player, PlayerEvents, PlayerOptions, PlayerRole, PlayerStatus, Room, RoomEvents, RoomPlayer, RoomStatus, Tiaoom, TiaoomEvents };
+//# sourceMappingURL=index.d.mts.map