types.ts 3.03 KB
import { RoomDescription } from "../room/types";
import { UserData } from "../user/types";

export interface Message {
  readonly type: string;
}

/**
 * 클라 -> 서버      : 클라이언트에서 서버로 요청할 때 사용하는 메세지입니다. 요청 결과는 MessageResponse<undefined>입니다.
 * 클라 -> 서버 -> T : 위와 동일하지만 요청 결과가 MessageResponse<T>입니다.
 * 서버 -> 클라      : 서버에서 클라이언트로 전송되는 메세지입니다.
 * 클라 <-> 서버     : 양방향으로 사용되는 메세지입니다.
 */

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

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

/**
 * 클라 -> 서버 -> RoomDescription[]
 * 방 목록을 요청합니다.
 */
export class RoomListRequestMessage implements Message {
  readonly type = MessageType.ROOM_LIST_REQUEST;
  constructor() {}
}

/**
 * 클라 -> 서버 -> RoomInfo
 * 방에 접속합니다.
 */
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 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_REQUEST = "room_list_request";
  static readonly ROOM_JOIN = "room_join";
  static readonly ROOM_LEAVE = "room_leave";
  static readonly ROOM_USER_UPDATE = "room_user_update";
  static readonly ROOM_CHAT = "room_chat";
}