types.ts 2.77 KB
import { RoomData } from "../room/types";
import { UserData } from "../user/types";

export interface Message {
  readonly type: string;
}

/**
 * 서버에 Event를 보냈을 때 요청에 대한 결과를 전송받습니다.
 * @param ok 요청의 성공 여부입니다.
 * @param reason 요청 실패 사유입니다. 필요한 경우에만 포함됩니다.
 */
export interface MessageResponse<T> {
  ok: boolean;
  reason?: string;
  result?: T;
}

/**
 * 클라 -> 서버
 * 로그인 정보를 서버에게 전송합니다.
 */
export class LoginMessage implements Message {
  readonly type = MessageType.LOGIN;
  constructor(public username: string) {}
}

/**
 * 클라 <- 서버
 * 방 리스트를 서버에서 받아옵니다.
 */
export class RoomListMessage implements Message {
  readonly type = MessageType.ROOM_LIST;
  constructor(public rooms: RoomData[]) {}
}

/**
 * 클라 -> 서버
 * 방에 접속합니다.
 */
export class RoomJoinMessage implements Message {
  readonly type = MessageType.ROOM_JOIN;
  constructor(public uuid: string) {}
}

/**
 * 클라 -> 서버
 * 방에서 나갑니다.
 */
export class RoomLeaveMessage implements Message {
  readonly type = MessageType.ROOM_LEAVE;
  constructor() {}
}

/**
 * 클라 <- 서버
 * 방에 접속할 때, 방의 정보를 받아옵니다.
 * @param userdata 현재 방에 접속 중인 유저 목록입니다.
 */
export class RoomInfoMessage implements Message {
  readonly type = MessageType.ROOM_INFO;
  constructor(public userdata: UserData[]) {}
}

/**
 * 클라 <- 서버
 * 접속한 방에 새로운 유저가 들어오거나 나갈 때 전송됩니다.
 * @param state 유저가 입장하면 added, 퇴장하면 removed 값을 가집니다.
 * @param userdata 대상 유저입니다.
 */
export class RoomUserUpdateMessage implements Message {
  readonly type = MessageType.ROOM_USER_UPDATE;
  constructor(
    public state: "added" | "updated" | "removed",
    public userdata: UserData
  ) {}
}

/**
 * 클라 <-> 서버
 * 접속한 방에서 채팅을 보내거나 받을 때 사용됩니다. 자신이 보낸 채팅은 서버에 의해 수신되지 않습니다.
 * @param message 메세지 내용입니다.
 * @param sender 채팅을 보낸 유저의 username입니다. 채팅이 클라이언트로 수신 될 경우에만 값을 가집니다.
 */
export class RoomChatMessage implements Message {
  readonly type = MessageType.ROOM_CHAT;
  constructor(public message: string, public sender?: string) {}
}

export class MessageType {
  static readonly LOGIN = "login";
  static readonly ROOM_LIST = "room_list";
  static readonly ROOM_JOIN = "room_join";
  static readonly ROOM_LEAVE = "room_leave";
  static readonly ROOM_INFO = "room_info";
  static readonly ROOM_USER_UPDATE = "room_user_update";
  static readonly ROOM_CHAT = "room_chat";
}