Initial clean state

packages/common/src/types/game/index.ts

@@ -0,0 +1,38 @@
+export type Player = {
+  id: string
+  clientId: string
+  connected: boolean
+  username: string
+  points: number
+}
+
+export type Answer = {
+  playerId: string
+  answerId: number
+  points: number
+}
+
+export type Quizz = {
+  subject: string
+  questions: {
+    question: string
+    image?: string
+    media?: QuestionMedia
+    answers: string[]
+    solution: number
+    cooldown: number
+    time: number
+  }[]
+}
+
+export type QuestionMedia =
+  | { type: "image"; url: string; fileName?: string }
+  | { type: "audio"; url: string; fileName?: string }
+  | { type: "video"; url: string; fileName?: string }
+
+export type QuizzWithId = Quizz & { id: string }
+
+export type GameUpdateQuestion = {
+  current: number
+  total: number
+}

packages/common/src/types/game/socket.ts

@@ -0,0 +1,99 @@
+import { Server as ServerIO, Socket as SocketIO } from "socket.io"
+import { GameUpdateQuestion, Player, Quizz, QuizzWithId } from "."
+import { Status, StatusDataMap } from "./status"
+
+export type Server = ServerIO<ClientToServerEvents, ServerToClientEvents>
+export type Socket = SocketIO<ClientToServerEvents, ServerToClientEvents>
+
+export type Message<K extends keyof StatusDataMap = keyof StatusDataMap> = {
+  gameId?: string
+  status: K
+  data: StatusDataMap[K]
+}
+
+export type MessageWithoutStatus<T = any> = {
+  gameId?: string
+  data: T
+}
+
+export type MessageGameId = {
+  gameId?: string
+}
+
+export interface ServerToClientEvents {
+  connect: () => void
+
+  // Game events
+  "game:status": (_data: { name: Status; data: StatusDataMap[Status] }) => void
+  "game:successRoom": (_data: string) => void
+  "game:successJoin": (_gameId: string) => void
+  "game:totalPlayers": (_count: number) => void
+  "game:errorMessage": (_message: string) => void
+  "game:startCooldown": () => void
+  "game:cooldown": (_count: number) => void
+  "game:cooldownPause": (_paused: boolean) => void
+  "game:reset": (_message: string) => void
+  "game:updateQuestion": (_data: { current: number; total: number }) => void
+  "game:playerAnswer": (_count: number) => void
+
+  // Player events
+  "player:successReconnect": (_data: {
+    gameId: string
+    status: { name: Status; data: StatusDataMap[Status] }
+    player: { username: string; points: number }
+    currentQuestion: GameUpdateQuestion
+  }) => void
+  "player:updateLeaderboard": (_data: { leaderboard: Player[] }) => void
+
+  // Manager events
+  "manager:successReconnect": (_data: {
+    gameId: string
+    status: { name: Status; data: StatusDataMap[Status] }
+    players: Player[]
+    currentQuestion: GameUpdateQuestion
+  }) => void
+  "manager:quizzList": (_quizzList: QuizzWithId[]) => void
+  "manager:gameCreated": (_data: { gameId: string; inviteCode: string }) => void
+  "manager:statusUpdate": (_data: {
+    status: Status
+    data: StatusDataMap[Status]
+  }) => void
+  "manager:newPlayer": (_player: Player) => void
+  "manager:removePlayer": (_playerId: string) => void
+  "manager:players": (_players: Player[]) => void
+  "manager:errorMessage": (_message: string) => void
+  "manager:playerKicked": (_playerId: string) => void
+  "manager:quizzLoaded": (_quizz: QuizzWithId) => void
+  "manager:quizzSaved": (_quizz: QuizzWithId) => void
+  "manager:quizzDeleted": (_id: string) => void
+}
+
+export interface ClientToServerEvents {
+  // Manager actions
+  "game:create": (_quizzId: string) => void
+  "manager:auth": (_password: string) => void
+  "manager:reconnect": (_message: { gameId: string }) => void
+  "manager:kickPlayer": (_message: { gameId: string; playerId: string }) => void
+  "manager:startGame": (_message: MessageGameId) => void
+  "manager:abortQuiz": (_message: MessageGameId) => void
+  "manager:pauseCooldown": (_message: MessageGameId) => void
+  "manager:resumeCooldown": (_message: MessageGameId) => void
+  "manager:endGame": (_message: MessageGameId) => void
+  "manager:skipQuestionIntro": (_message: MessageGameId) => void
+  "manager:nextQuestion": (_message: MessageGameId) => void
+  "manager:deleteQuizz": (_message: { id: string }) => void
+  "manager:showLeaderboard": (_message: MessageGameId) => void
+  "manager:getQuizz": (_quizzId: string) => void
+  "manager:saveQuizz": (_payload: { id: string | null; quizz: Quizz }) => void
+
+  // Player actions
+  "player:join": (_inviteCode: string) => void
+  "player:login": (_message: MessageWithoutStatus<{ username: string }>) => void
+  "player:reconnect": (_message: { gameId: string }) => void
+  "player:selectedAnswer": (
+    _message: MessageWithoutStatus<{ answerKey: number }>
+  ) => void
+
+  // Common
+  disconnect: () => void
+}

packages/common/src/types/game/status.ts

@@ -0,0 +1,62 @@
+import { Player, QuestionMedia } from "."
+
+export const STATUS = {
+  SHOW_ROOM: "SHOW_ROOM",
+  SHOW_START: "SHOW_START",
+  SHOW_PREPARED: "SHOW_PREPARED",
+  SHOW_QUESTION: "SHOW_QUESTION",
+  SELECT_ANSWER: "SELECT_ANSWER",
+  SHOW_RESULT: "SHOW_RESULT",
+  SHOW_RESPONSES: "SHOW_RESPONSES",
+  SHOW_LEADERBOARD: "SHOW_LEADERBOARD",
+  FINISHED: "FINISHED",
+  WAIT: "WAIT",
+} as const
+
+export type Status = (typeof STATUS)[keyof typeof STATUS]
+
+export type CommonStatusDataMap = {
+  SHOW_START: { time: number; subject: string }
+  SHOW_PREPARED: { totalAnswers: number; questionNumber: number }
+  SHOW_QUESTION: {
+    question: string
+    image?: string
+    media?: QuestionMedia
+    cooldown: number
+  }
+  SELECT_ANSWER: {
+    question: string
+    answers: string[]
+    image?: string
+    media?: QuestionMedia
+    time: number
+    totalPlayer: number
+  }
+  SHOW_RESULT: {
+    correct: boolean
+    message: string
+    points: number
+    myPoints: number
+    rank: number
+    aheadOfMe: string | null
+  }
+  WAIT: { text: string }
+  FINISHED: { subject: string; top: Player[] }
+}
+
+type ManagerExtraStatus = {
+  SHOW_ROOM: { text: string; inviteCode?: string }
+  SHOW_RESPONSES: {
+    question: string
+    responses: Record<number, number>
+    correct: number
+    answers: string[]
+    image?: string
+    media?: QuestionMedia
+  }
+  SHOW_LEADERBOARD: { oldLeaderboard: Player[]; leaderboard: Player[] }
+}
+
+export type PlayerStatusDataMap = CommonStatusDataMap
+export type ManagerStatusDataMap = CommonStatusDataMap & ManagerExtraStatus
+export type StatusDataMap = PlayerStatusDataMap & ManagerStatusDataMap

packages/common/src/validators/auth.ts

@@ -0,0 +1,8 @@
+import z from "zod"
+
+export const usernameValidator = z
+  .string()
+  .min(4, "Username cannot be less than 4 characters")
+  .max(20, "Username cannot exceed 20 characters")
+
+export const inviteCodeValidator = z.string().length(6, "Invalid invite code")