PasswordGame

Backend for Password game.

Frontend Repo: https://github.com/roerohan/Password

API

Note: ?param implies param is optional.

Note: Format: <REQUEST-TYPE> <ROUTE> - <PARAMS>

• All routes return a JSON with the following format:

{
    success: boolean,
    message: string | object,
}

• success indicates if a request passed or failed.
• message indicates why a request failed, or stores the response if the operation was successful.

/room

• POST /room/create - username, ?access, ?rounds
  • Create a room with creator as username.
  • access determines the type of room, may be private or public.
  • rounds implies the number of rounds in the game.
  • Returns the roomId and creator in the response JSON.

{
    success: boolean,
    message: {
        roomId: string,
        creator: string,
        players: [
            {
                username: string,
                points: number,
            },
        ],
    },
}

• GET /room/join/:roomId - username
  • Add user username to the room.
  • Returns a JSON of the following format:

{
    success: boolean,
    message: {
        roomId: string,
        creator: string,
        hasStarted: boolean,
        player: {
            username: string,
            points: 0,
        }
        players: [
            {
                username: string,
                points: number,
            },
            {
                username: string,
                points: number,
            },
        ],
    },
}

/game

• POST /game/start - username, roomId, ?access, ?rounds
  • username must be the creator of the room.
  • Modifies access and rounds according to access and rounds.
  • Starts the game for room roomId.
  • Returns a JSON of the following format:

{
    success: boolean,
    message: {
        hasStarted: boolean,
        rounds: number,
        currentRound: number,
        players: [
            {
                username: string,
                points: number,
            },
            {
                username: string,
                points: number,
            },
        ],
    },
}

• POST /game/next - roomId, username
  • Generates a new password in the backend for the room, returns the new passwordHolder and the length of the new password.
  • currentPassword is sent only when the username is the same as the passwordHolder.
  • Returns a JSON of the following format:

{
    success: boolean,
    message: {
        currentRound: number,
        rounds: number,
        passwordHolder: string,
        passwordLength: number,
        previousPassword: string,
        currentPassword: string,
        roundEnd: number,
        players: [
            {
                username: string,
                points: number,
            },
            {
                username: string,
                points: number,
            },
        ],
    },
}

• POST /game/hint - roomId, username, hint
  • Adds the hint to the hints array for the current round.
  • Returns a JSON of the format:

{
    success: boolean,
    message: {
        hints: array,
        passwordHolder: string,
    },
}
``

- `POST /game/end - roomId`
    * Ends the game for `roomId`.
    * Deletes data pertaining to `roomId`.
    * Returns a JSON of the form:

```typescript
{
    success: true,
    message: {
        players: [
            {
                username: string,
                points: number,
            },
            {
                username: string,
                points: number,
            },
        ],
    },
}

Socket Events

• join
• message
• start
• hint
• disconnect