diff --git a/backend/README.md b/backend/README.md
index 0a7be481fc14c8d8854e4b662fe053653f137dd0..3ec9552367bcd61a6c51276719cce4b86eddc0b7 100644
--- a/backend/README.md
+++ b/backend/README.md
@@ -1,36 +1,38 @@
# Backend
-This backend handles connection with the database and ongoing gameStates.
+The backend handles ongoing lobbies and games. Also communicates with the firebase database for persistance.
+The backend uses Node and is written in TypeScript with Express for routing.
-The backend uses the express framework to handle requests.
+## Documentation
-Implemation in Typescript.
+The API documentation is available at the root of the backend (http://localhost:4999/). The documentation is generated with Swagger.
-Package handler is Yarn.
+<img src="./assets/apidoc.png" width="400" alt="API-docs">
## Setup
-You must add a file in the following directory: `backend/keys/fb-key.json`
+To access database you must add firebase-key to the following directory: `backend/keys/fb-key.json`
-The key is login details to a Firebase service account, needed to access the database.
-
-## How to run
+## How to run the backend
Run the following commands in your terminal:
-- `yarn` last ned avhengigheter
-- `yarn start:local` start serveren i lokal modus
-- `yarn start:prod` start serveren i produksjonsmodus
-
-## Nyttige kommandoer
+- `yarn` download dependencies
+- `yarn start:local` start server in development mode on localhost:4999
+- `yarn start:prod` start server in production mode on {machine_ip}:80
-Formatere koden: `yarn prettier`
-Kjøre tester: `yarn test`
+## CD: Deployment to virtual machine
-## VM Deployment
+The backend is automatically deployed to a virtual machine when a commit is pushed to the main branch. The deployment is done by a Gitlab CI server that connects to the VM with SSH and runs the `vm.sh` script.
-The backend runs on NTNU VM.
+The VM is hosted on NTNU (requires VPN) and can be accessed on the following address:
IP: 10.212.26.72
Port: 80
-`vm.sh` defines the code that is needed to boot the vm (after CI connectes to the VM with SSH)
+The VM utilizes Nodemon to automatically restart the server if a crash occurs.
+
+## CI: Testing
+
+The backend is automatically tested by a Gitlab CI server for each commit.
+Formatter: `yarn prettier`
+e2e tests: `yarn test`
diff --git a/backend/assets/apidoc.png b/backend/assets/apidoc.png
new file mode 100644
index 0000000000000000000000000000000000000000..92f457d45445d43524568577220667bd8c5df0dc
Binary files /dev/null and b/backend/assets/apidoc.png differ
diff --git a/backend/documentation.md b/backend/documentation.md
deleted file mode 100644
index a5f4039d6237a14cc80548813fb7ae6da3139ec7..0000000000000000000000000000000000000000
--- a/backend/documentation.md
+++ /dev/null
@@ -1,183 +0,0 @@
-# API Documentation
-
-This is an API documentation for an Express server that handles users, lobbies, and game state. The server uses Firebase Firestore for database storage.
-
-### Base URL
-
-> http://localhost:3000
-
-### GET /user/
-
-Description: Returns a list of all user IDs
-Response:
-Status: 200 OK
-Body: Array of user IDs
-
-> - 204 No users found (DB is empty)
-> - 200 List of user-id's
-
-### GET /user/{id: string}
-
-> - 404 User not found
-> - 200 User
-
-### GET /user/{idOrUsername: string}
-
-Returns data for the user with the specified ID or username. If the parameter provided matches an ID, the response will contain data for that user. If the parameter matches a username, the response will contain data for the first user with that username found in the database.
-
-```json
-Status: 200 OK
-{
- "username": "user1",
- "highscore": 50,
- "games": 10,
- "wins": 5,
- "losses": 5
-}
-```
-
-> - 404 User not found
-> - 200 User
-
-### POST /user/create/{username: string}
-
-Creates a new user with the specified username. The username must be unique. If the username is already taken, the response will contain an error message.
-
-> - 409 User already exists
-> - 201 User created
-
-### GET /highscores
-
-Returns an array of the top 10 users with the highest scores, sorted in descending order.
-
-> - 204 No highscores found
-> - 200 List of users with highest score
-
-```json
-Status: 200 OK
-{
- [
- {
- "username": "user1",
- "highscore": 50,
- "games": 10,
- "wins": 5,
- "losses": 5
- },
- {
- "username": "user2",
- "highscore": 40,
- "games": 8,
- "wins": 4,
- "losses": 4
- },
- ...
- ]
-}
-```
-
-### POST /lobby/:id
-
-Joins a lobby with the specified ID. If the lobby does not exist, a new lobby is created.
-
-```json
-POST /lobby/lobby1
-Body: { "userId": "user1" }
-```
-
-> - 201 Created
-
-### POST /lobby/:id/leave
-
-Leaves a lobby with the specified ID.
-
-Example request:
-
-```json
-POST /lobby/lobby1/leave
-Body: { "userId": "user1" }
-```
-
-### GET /game/:gameid/currentTurn
-
-Checks if it is the specified user's turn in the specified game. Returns the current game state if it is the user's turn.
-
-Example request:
-
-```json
-GET /game/game1/currentTurn
-Body: { "userName": "user1" }
-```
-
-Example response:
-
-```json
-Status: 200 OK
-{
- "gameId": "12345678",
- "gameStatus": false,
- "currentTurn": 0,
- "users": {
- [
- "User": {
- "id": string;
- "username": string;
- "wins": number;
- "losses": number;
- "highscore": number;
- },
- "IStat": {
- "position": [0,0];
- "turretAngle": 0.5;
- "isMirrored": true;
- "health": 100;
- "ammunition": 100;
- "tankDirection": "left";
- "tankType": "M107";
- "score": 100;
- },
- ...
- ]
- },
-}
-```
-
-### POST /game/:gameid/move
-
-Updates the game state for the specified game with the new game state provided in the request body.
-
-Example request:
-
-```json
-POST /game/123456/move
-Body:
-{ "newGameState":
- {
- "gameId": "12345678",
- "gameStatus": false,
- "currentTurn": 0,
- "users": {
- [
- "User": {
- "id": string;
- "username": string;
- "wins": number;
- "losses": number;
- "highscore": number;
- },
- "IStat": {
- "position": [0,0];
- "turretAngle": 0.5;
- "isMirrored": true;
- "health": 100;
- "ammunition": 100;
- "tankDirection": "left";
- "tankType": "M107";
- "score": 100;
- },
- ...
- ]
- },
- }
-}
-```
diff --git a/backend/package.json b/backend/package.json
index 5abc2784c8ad7677dbfab06e4f46bcd730ea26c8..d39e78f1700e8b0b1aef12af761db84fcb718bd5 100644
--- a/backend/package.json
+++ b/backend/package.json
@@ -16,6 +16,7 @@
"@types/cypress": "^1.1.3",
"@types/express": "^4.17.17",
"@types/jest": "^29.5.0",
+ "@types/swagger-jsdoc": "^6.0.1",
"concurrently": "^8.0.1",
"cross-env": "^7.0.3",
"cypress": "^12.9.0",
@@ -26,7 +27,10 @@
},
"dependencies": {
"firebase-admin": "^11.5.0",
+ "node-cache": "^5.1.2",
"prettier": "^2.8.4",
- "simplex-noise": "^4.0.1"
+ "simplex-noise": "^4.0.1",
+ "swagger-jsdoc": "^6.2.8",
+ "swagger-ui-express": "^4.6.2"
}
}
diff --git a/backend/src/controllers/gameController.ts b/backend/src/controllers/gameController.ts
index 15499ec6e6db975a1eadff7d944e8b4fa4904520..85aa6d1a5de72c3dd709ec199dbf460b419a2a97 100644
--- a/backend/src/controllers/gameController.ts
+++ b/backend/src/controllers/gameController.ts
@@ -37,7 +37,7 @@ export const move = async (req: Request, res: Response): Promise<void> => {
export const currentTurn = async (req: Request, res: Response): Promise<void> => {
const game = gameHandler.getGameById(req.params.gameid);
- const user = req.body.userName;
+ const user = req.body.username || req.body.userName;
if (game) {
if (user === game.getCurrentTurnUser().username) {
// send the gamestate to the client
diff --git a/backend/src/controllers/highscoreController.ts b/backend/src/controllers/highscoreController.ts
index 31099358fcde2951b84e7bd5f9d5bdfe0906b010..dd508aaea2fb0dc33724db236967c1b150c436ef 100644
--- a/backend/src/controllers/highscoreController.ts
+++ b/backend/src/controllers/highscoreController.ts
@@ -5,17 +5,17 @@ import { getUserById } from '../functions/getUserById';
import { User } from '../../types/User';
import admin from '../functions/firebaseAdmin';
import { IGame } from '../interfaces/IGame';
+import { getTopUsers } from '../functions/firebaseCache';
const gameHandler = GameHandler.getInstance();
export const top10 = async (req: Request, res: Response): Promise<void> => {
- const usersRef = admin.firestore().collection('users');
- const querySnapshot = await usersRef.orderBy('highscore', 'desc').limit(10).get();
+ const topUsers = await getTopUsers();
- if (querySnapshot.empty) {
+ if (topUsers === null) {
res.status(204).send('No highscores found');
} else {
- const users = querySnapshot.docs.map(
+ const users = topUsers.docs.map(
(doc: any) =>
({
id: doc.id,
diff --git a/backend/src/controllers/userController.ts b/backend/src/controllers/userController.ts
index d919b7b6c6c59ccf1cb4177b6a4afc0740a6edf0..13b7676f675f1fbd7105fe117ee4e5db7589620d 100644
--- a/backend/src/controllers/userController.ts
+++ b/backend/src/controllers/userController.ts
@@ -3,18 +3,18 @@ import { GameHandler } from '../gameHandler';
import { getUserById } from '../functions/getUserById';
import { User } from '../../types/User';
import admin from '../functions/firebaseAdmin';
+import { getUsers } from '../functions/firebaseCache';
+import { log } from '../functions/console';
const gameHandler = GameHandler.getInstance();
export const users = async (req: Request, res: Response): Promise<void> => {
- // returns all the user-id's
- const usersRef = admin.firestore().collection('users');
- const querySnapshot = await usersRef.get();
+ const users = await getUsers();
- if (querySnapshot.empty) {
+ if (users == null) {
res.status(204).send('No users found');
} else {
- const userids = querySnapshot.docs.map((doc: { id: any }) => doc.id);
+ const userids = users.docs.map((doc: { id: any }) => doc.id);
res.status(200).send(userids);
}
};
@@ -34,31 +34,22 @@ export const getUser = async (req: Request, res: Response): Promise<void> => {
export const createUser = async (req: Request, res: Response): Promise<void> => {
const usersRef = admin.firestore().collection('users');
const username = req.params.username;
- const querySnapshot = await usersRef.where('username', '==', username).get();
+ log('firestore: quering for user with username: ' + username);
+ const user = await getUserById(username);
- if (!querySnapshot.empty) {
- const user: User[] = querySnapshot.docs.map((doc: any) => {
- if (doc.data().username === username) {
- return { id: doc.id, ...doc.data() };
- }
- });
- res.status(409).send(user[0]);
+ if (user) {
+ res.status(409).send(user);
} else {
- const newUserRef = await usersRef.add({
- username: req.params.username,
- highscore: 0,
- games: 0,
- wins: 0,
- losses: 0,
- });
- res.status(201).send({
+ const initialUserData = {
username: req.params.username,
highscore: 0,
games: 0,
wins: 0,
losses: 0,
- id: newUserRef.id,
- } as User);
+ };
+ log('firestore: creating new user with username: ' + username);
+ const newUserRef = await usersRef.add(initialUserData);
+ res.status(201).send({ id: newUserRef.id, ...initialUserData } as User);
}
};
@@ -66,15 +57,16 @@ export const createUser = async (req: Request, res: Response): Promise<void> =>
export const deleteUser = async (req: Request, res: Response): Promise<void> => {
const usersRef = admin.firestore().collection('users');
const username = req.params.username;
+ log('firestore: quering for user with username: ' + username);
const querySnapshot = await usersRef.where('username', '==', username).get();
if (!querySnapshot.empty) {
// delete user
- const user: User[] = querySnapshot.docs.map((doc: any) => {
- if (doc.data().username === username) {
- return { id: doc.id, ...doc.data() };
- }
- });
- await usersRef.doc(user[0].id).delete();
+ const userDoc = querySnapshot.docs[0];
+ const user: User = { id: userDoc.id, ...userDoc.data() };
+ log(
+ 'firestore: deleting user with id: ' + user.id + ' and username: ' + user.username
+ );
+ await usersRef.doc(user.id).delete();
res.status(204).send('User deleted');
} else {
res.status(404).send('User not found');
diff --git a/backend/src/functions/console.ts b/backend/src/functions/console.ts
index d1b44c809153dd33789e346350b3a78b1796846e..d6c294e9c0e37c21dcd1fca09f3efc51b1ae219f 100644
--- a/backend/src/functions/console.ts
+++ b/backend/src/functions/console.ts
@@ -4,12 +4,18 @@
* @param message The message to log
* @returns void
*/
-export function log(message: string): void {
+export function log(message: string, status: string = 'info'): void {
const time = new Date().toLocaleTimeString();
- const file = new Error().stack?.split('at ')[2].split(' ')[0];
- const maxLength = 20; // Set the desired maximum length for the file section
- const paddedFile = file?.padEnd(maxLength, ' ');
- console.log(time + ' | ' + paddedFile + '| ' + message);
+ const file = new Error().stack?.split('at ')[2].split('\n')[0].trim();
+ const maxLength = 25; // Set the desired maximum length for the file section
+ const paddedFile =
+ file?.split('/').pop()?.padEnd(maxLength, ' ') ?? ''.padEnd(maxLength, ' ');
+ // if status is info, log in default/black color. If warning use yellow, if danger use red
+ const statusColor =
+ status === 'info' ? '\x1b[0m' : status === 'warning' ? '\x1b[33m' : '\x1b[31m';
+ process.stdout.write(
+ statusColor + time + ' | ' + paddedFile + ' | ' + message + '\x1b[0m\n'
+ );
}
/**
diff --git a/backend/src/functions/expressLogger.ts b/backend/src/functions/expressLogger.ts
deleted file mode 100644
index 28852de1c393e3ad26da6a586a94c28dfbd3fe93..0000000000000000000000000000000000000000
--- a/backend/src/functions/expressLogger.ts
+++ /dev/null
@@ -1,25 +0,0 @@
-import { log } from './console';
-
-/**
- * Custom middleware to log express requests
- * @param req
- * @param res
- * @param next
- */
-
-export function expressLogger(req: any, res: any, next: any) {
- // Store the original `.send()` method
- const originalSend = res.send;
-
- // Override the `.send()` method
- res.send = function (body: any) {
- // Log the response
- log(`${req.method} ${req.url} - Response: ${body}`);
-
- // Call the original `.send()` method with the provided body
- originalSend.call(res, body);
- };
-
- // Call the next middleware or route handler in the stack
- next();
-}
diff --git a/backend/src/functions/firebaseCache.ts b/backend/src/functions/firebaseCache.ts
new file mode 100644
index 0000000000000000000000000000000000000000..2104507f953beefc6f9fa709ad8e1b4c9e587c3c
--- /dev/null
+++ b/backend/src/functions/firebaseCache.ts
@@ -0,0 +1,75 @@
+import NodeCache from 'node-cache';
+import admin from './firebaseAdmin';
+import { log } from './console';
+
+/**
+ * This is a cache and firebaseHandler for the firestore database
+ */
+
+const queryCache = new NodeCache({ stdTTL: 60 }); // 60 seconds TTL
+
+export async function getUsers(): Promise<any> {
+ const usersRef = admin.firestore().collection('users');
+ const cacheKey = 'userRef';
+ return retrieveFromCache(usersRef, queryCache, cacheKey);
+}
+
+export async function getTopUsers(): Promise<any> {
+ const usersRef = admin.firestore().collection('users');
+ const querySnapshot = await usersRef.orderBy('highscore', 'desc').limit(10);
+ const cacheKey = 'topUsers';
+ return retrieveFromCache(querySnapshot, queryCache, cacheKey);
+}
+
+/**
+ * A function that retrieves data from the cache if it exists, otherwise it retrieves it from firestore
+ *
+ * @param ref Firestore reference
+ * @param cache The cache to retrieve data from
+ * @param cacheKey The key to use for the cache
+ * @returns cached or firestore result (null if error)
+ */
+async function retrieveFromCache(
+ ref: any,
+ cache: NodeCache,
+ cacheKey: string
+): Promise<any | null> {
+ const cachedValue = cache.get(cacheKey);
+
+ if (cachedValue) {
+ log('Cache-hit: retrieved from cache');
+ return cachedValue;
+ } else {
+ log('Cache-miss: retrieving from firestore...');
+ return await sendFirestoreRequest(ref, cache, cacheKey);
+ }
+}
+
+/**
+ * Sends a request to firestore and returns the result
+ *
+ * @param ref
+ * @param cache
+ * @param cacheKey
+ * @returns firestore result
+ */
+async function sendFirestoreRequest(
+ ref: any,
+ cache: NodeCache,
+ cacheKey: string
+): Promise<any | null> {
+ try {
+ log('firebase: sending request to firestore...');
+ const snapshot = await ref.get();
+ cache.set(cacheKey, snapshot);
+ log("Cache-set: set cache for key '" + cacheKey + "'");
+ return snapshot;
+ } catch (err: any) {
+ if (err?.code === 8) {
+ log('error: firestore max-limit reached', 'danger');
+ } else {
+ log('error: firestore error code ' + err?.code, 'danger');
+ }
+ return null;
+ }
+}
diff --git a/backend/src/functions/getUserById.ts b/backend/src/functions/getUserById.ts
index dfe6901a04e2c99b19ea6682b7dff35b6ef31798..5810764e22d416516ec2fd034ef2ba319d182aeb 100644
--- a/backend/src/functions/getUserById.ts
+++ b/backend/src/functions/getUserById.ts
@@ -4,22 +4,26 @@ import admin from './firebaseAdmin';
export async function getUserById(id: string): Promise<User | null> {
const usersRef = admin.firestore().collection('users');
- const snapshot = await usersRef.get();
const searchParam = id;
- const user =
- snapshot.docs.find((doc: { id: string }) => doc.id === searchParam) ||
- (
- await Promise.all(
- snapshot.docs.map(async (doc: { id: string }) => {
- const userSnapshot = await usersRef.doc(doc.id).get();
- return userSnapshot.data().username === searchParam ? userSnapshot : null;
- })
- )
- ).find(Boolean);
+ // Search for user by id
+ log('firebase: searching for user by id: ' + searchParam);
+ let userSnapshot = await usersRef.doc(searchParam).get();
- if (user) {
- return user.data() as User;
+ // If the user is not found by id, search for user by username
+ if (!userSnapshot.exists) {
+ log('firebase: searching for user by username: ' + searchParam);
+ const userByUsernameSnapshot = await usersRef
+ .where('username', '==', searchParam)
+ .get();
+ if (!userByUsernameSnapshot.empty) {
+ userSnapshot = userByUsernameSnapshot.docs[0];
+ }
+ }
+
+ if (userSnapshot) {
+ log('found user: ' + userSnapshot.id);
+ return userSnapshot.data() as User;
} else {
log('User not found');
return null;
diff --git a/backend/src/index.ts b/backend/src/index.ts
index 85eda66a602052c4520eae4b848b8687277ab991..8ba97fb84085792e528589257f3014f19a60d9e6 100644
--- a/backend/src/index.ts
+++ b/backend/src/index.ts
@@ -1,6 +1,6 @@
import express from 'express';
import { GameHandler } from './gameHandler';
-import { expressLogger } from './functions/expressLogger';
+import { expressLogger } from './middleware/expressLogger';
import lobbyRoutes from './routes/lobbyRoutes';
import userRoutes from './routes/userRoutes';
import gameRoutes from './routes/gameRoutes';
@@ -9,6 +9,9 @@ import serverRoutes from './routes/serverRoutes';
import { log } from './functions/console';
import { welcome } from './functions/welcomeScreen';
import { disposeInactiveGames } from './functions/disposeInactiveGames';
+import swaggerJsdoc from 'swagger-jsdoc';
+import path from 'path';
+import { firebaseLogger } from './middleware/firebaseLogger';
new GameHandler(); // singleton ;)
@@ -18,7 +21,7 @@ const port = process.env.NODE_ENV === 'production' ? 80 : 4999;
// middleware
app.use(express.json()); // for parsing application/json
-app.use(expressLogger); // for logging
+app.use(expressLogger); // for request logging
// routes
app.use('/lobby', lobbyRoutes);
@@ -27,13 +30,40 @@ app.use('/game', gameRoutes);
app.use('/highscore', highscoreRoutes);
app.use('/server', serverRoutes);
-// in testing, we don't want to cache the results
+// Cache-Control
app.set('etag', false);
app.use((req, res, next) => {
res.setHeader('Cache-Control', 'no-store');
next();
});
+// API Documentation
+const swaggerUi = require('swagger-ui-express');
+const swaggerJSDoc = require('swagger-jsdoc');
+const swaggerOptions: swaggerJsdoc.Options = {
+ definition: {
+ openapi: '3.0.0',
+ info: {
+ title: 'TankWars API Documentation',
+ version: '1.0.1',
+ description:
+ 'The API lets clients create lobbies and send gamestates between users',
+ },
+ servers: [
+ {
+ url: 'http://localhost:4999',
+ },
+ {
+ url: 'http://10.212.26.72:80',
+ },
+ ],
+ },
+ apis: ['./src/routes/*.ts', './src/controllers/*.ts'],
+};
+
+const swaggerDocs = swaggerJsdoc(swaggerOptions);
+app.use('/', swaggerUi.serve, swaggerUi.setup(swaggerDocs));
+
setInterval(() => {
disposeInactiveGames();
}, 60 * 1000);
@@ -43,7 +73,7 @@ app.listen(port, () => {
if (process.env.NODE_ENV === 'production') {
log('PRODUCTION MODE');
} else {
- log('DEVELOPMENT MODE');
+ log('DEVELOPMENT MODE', 'warning');
}
- log(`Server started on port ${port}`);
+ log(`Server started on port ${port}`, 'warning');
});
diff --git a/backend/src/middleware/expressLogger.ts b/backend/src/middleware/expressLogger.ts
new file mode 100644
index 0000000000000000000000000000000000000000..559bbdb3b56b4172ce44c116a0952057867b08db
--- /dev/null
+++ b/backend/src/middleware/expressLogger.ts
@@ -0,0 +1,31 @@
+import { log } from '../functions/console';
+import { Request, Response, NextFunction } from 'express';
+
+/**
+ * Custom middleware to log express requests
+ * @param req
+ * @param res
+ * @param next
+ */
+
+export function expressLogger(req: Request, res: Response, next: NextFunction) {
+ // Store the original `.send()` method
+ const originalSend = res.send;
+
+ // Override the `.send()` method
+ res.send = function (body: any): Response {
+ const bodyString: string = body.toString();
+ if (bodyString.includes('<!DOCTYPE html>') || bodyString.includes('window.onload')) {
+ // dont print html/js files
+ log(`${req.method} ${req.url} - Response: HTML / JS file`);
+ } else {
+ log(`${req.method} ${req.url} - Response: ${body}`);
+ }
+
+ // Call the original `.send()` method with the provided body
+ return originalSend.call(res, body);
+ };
+
+ // Call the next middleware or route handler in the stack
+ next();
+}
diff --git a/backend/src/middleware/firebaseLogger.ts b/backend/src/middleware/firebaseLogger.ts
new file mode 100644
index 0000000000000000000000000000000000000000..8f942121e2d2e7ea2b1ca0aa6394098407a8b092
--- /dev/null
+++ b/backend/src/middleware/firebaseLogger.ts
@@ -0,0 +1,15 @@
+import { Request, Response, NextFunction } from 'express';
+import { log } from '../functions/console';
+
+export function firebaseLogger(req: Request, res: Response, next: NextFunction) {
+ const startTime = Date.now();
+ const path = req.path;
+
+ res.on('finish', () => {
+ const endTime = Date.now();
+ const duration = endTime - startTime;
+ log('Firebase read/request: ' + path + ', duration: ' + duration + 'ms');
+ });
+
+ next();
+}
diff --git a/backend/src/routes/gameRoutes.ts b/backend/src/routes/gameRoutes.ts
index 73f105d33649856fabbf50c0e9d114e2badac10f..865cb52f62ed239f1dfa19b9f99c241acbd09b97 100644
--- a/backend/src/routes/gameRoutes.ts
+++ b/backend/src/routes/gameRoutes.ts
@@ -3,9 +3,194 @@ import * as gameController from '../controllers/gameController';
const router = express.Router();
+/**
+ * @swagger
+ * /game/{lobbyId}:
+ * get:
+ * tags: [Game]
+ * summary: Retrive the gameID of a lobby.
+ * description: Retrive the gameID of a lobby.
+ * responses:
+ * 200:
+ * description: A gameId.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "0.0d8441fqd"
+ * 404:
+ * description: Lobby does not have ongoing game.
+ */
router.get('/:lobbyId', gameController.gameId);
+
+/**
+ * @swagger
+ * /game/move:
+ * post:
+ * tags: [Game]
+ * summary: Send a move.
+ * description: Client uses this to send a gameState as JSON to the server.
+ * parameters:
+ * - name: gameId
+ * in: path
+ * required: true
+ * description: gameId.
+ * schema:
+ * type: string
+ * requestBody:
+ * required: true
+ * content:
+ * application/json:
+ * schema:
+ * type: object
+ * properties:
+ * gameId:
+ * type: string
+ * gameStatus:
+ * type: boolean
+ * description: True if game is ongoing, false if game is over.
+ * currentTurn:
+ * type: integer
+ * users:
+ * type: array
+ * items:
+ * type: array
+ * items:
+ * oneOf:
+ * - type: object
+ * properties:
+ * wins:
+ * type: integer
+ * highscore:
+ * type: integer
+ * games:
+ * type: integer
+ * losses:
+ * type: integer
+ * username:
+ * type: string
+ * - type: object
+ * properties:
+ * position:
+ * type: integer
+ * turretAngle:
+ * type: integer
+ * health:
+ * type: integer
+ * ammunition:
+ * type: integer
+ * score:
+ * type: integer
+ * isMirrored:
+ * type: boolean
+ * tankDirection:
+ * type: string
+ * tankType:
+ * type: string
+ * responses:
+ * 200:
+ * description: A move was made.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: Move made
+ * 404:
+ * description: A move was made.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: Game not found
+ */
router.post('/:gameid/move', gameController.move);
+
+/**
+ * @swagger
+ * /game/{id}/currentTurn:
+ * post:
+ * tags: [Game]
+ * summary: Check current turn.
+ * description: If it is clients turn, a gamestate JSON will be sent.
+ * parameters:
+ * - name: username
+ * in: query
+ * required: true
+ * description: Username of the user polling the game.
+ * schema:
+ * type: string
+ * responses:
+ * 200:
+ * description: A move was made.
+ * content:
+ * application/json:
+ * schema:
+ * type: object
+ * properties:
+ * gameId:
+ * type: string
+ * gameStatus:
+ * type: boolean
+ * description: True if game is ongoing, false if game is over.
+ * currentTurn:
+ * type: integer
+ * users:
+ * type: array
+ * items:
+ * type: array
+ * items:
+ * oneOf:
+ * - type: object
+ * properties:
+ * wins:
+ * type: integer
+ * highscore:
+ * type: integer
+ * games:
+ * type: integer
+ * losses:
+ * type: integer
+ * username:
+ * type: string
+ * - type: object
+ * properties:
+ * position:
+ * type: integer
+ * turretAngle:
+ * type: integer
+ * health:
+ * type: integer
+ * ammunition:
+ * type: integer
+ * score:
+ * type: integer
+ * isMirrored:
+ * type: boolean
+ * tankDirection:
+ * type: string
+ * tankType:
+ * type: string
+ */
router.get('/:gameid/currentTurn', gameController.currentTurn);
+
+/**
+ * @swagger
+ * /game/{gameId}/terrain:
+ * get:
+ * tags: [Game]
+ * summary: Retrive the terrain of a game.
+ * description: Retrive the terrain of a game.
+ * responses:
+ * 200:
+ * description: An array of numbers representing the terrain.
+ * content:
+ * text/plain:
+ * schema:
+ * type: array
+ * example: [1,2,2,1,1,2,3]
+ * 404:
+ * description: Game not found.
+ */
router.get('/:gameid/terrain', gameController.getTerrain);
export default router;
diff --git a/backend/src/routes/highscoreRoutes.ts b/backend/src/routes/highscoreRoutes.ts
index fcf34ec0d6edae1e525dc9dd6a6c91b3956d94c4..205df0fd75f020d87e2725b3cec6f629e2da1ba1 100644
--- a/backend/src/routes/highscoreRoutes.ts
+++ b/backend/src/routes/highscoreRoutes.ts
@@ -3,6 +3,43 @@ import * as highscoreController from '../controllers/highscoreController';
const router = express.Router();
-router.get('/', highscoreController.top10);
+/**
+ * @swagger
+ * /highscore/top10:
+ * get:
+ * tags: [Highscore]
+ * summary: Get the top 10 highest ranking users.
+ * responses:
+ * 200:
+ * description: Top 10 highest ranking users found.
+ * content:
+ * application/json:
+ * schema:
+ * type: array
+ * items:
+ * type: object
+ * properties:
+ * username:
+ * type: string
+ * description: The username of the user.
+ * highscore:
+ * type: number
+ * description: The highscore of the user.
+ * games:
+ * type: number
+ * description: The number of games the user has played.
+ * wins:
+ * type: number
+ * description: The number of games the user has won.
+ * losses:
+ * type: number
+ * description: The number of games the user has lost.
+ * id:
+ * type: string
+ * description: The ID of the user.
+ * 204:
+ * description: No highscores found.
+ */
+router.get('/top10', highscoreController.top10);
export default router;
diff --git a/backend/src/routes/lobbyRoutes.ts b/backend/src/routes/lobbyRoutes.ts
index 2e006b95ea924354ff18741dfbad241eeefa8d0a..5318f5ee1b5c00da1a47f8b9c50ee11a07d44474 100644
--- a/backend/src/routes/lobbyRoutes.ts
+++ b/backend/src/routes/lobbyRoutes.ts
@@ -3,7 +3,82 @@ import * as lobbyController from '../controllers/lobbyController';
const router = express.Router();
+/**
+ * @swagger
+ * /lobby/{id}/leave:
+ * post:
+ * tags: [Lobby]
+ * summary: Leaves a lobby.
+ * description: The user leaves the lobby with the given id. If the lobby is empty it will be disposed automatically.
+ * parameters:
+ * - name: username
+ * in: path
+ * required: true
+ * description: Username of the user leaving the lobby.
+ * schema:
+ * type: string
+ * responses:
+ * 200:
+ * description: User left lobby.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "Lobby left"
+ */
router.post('/:id/leave', lobbyController.leaveLobby);
+
+/**
+ * @swagger
+ * /lobby/{id}/join:
+ * post:
+ * tags: [Lobby]
+ * summary: Joins a lobby.
+ * description: The user joins the lobby with the given id. If the lobby is full, a game will be started automatically.
+ * parameters:
+ * - name: username
+ * in: path
+ * required: true
+ * description: Username of the user joining the lobby.
+ * schema:
+ * type: string
+ * responses:
+ * 200:
+ * description: Successfully joined lobby. (opponent already joined, game will be started automatically)
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "Joined lobby"
+ * 201:
+ * description: Successfully created lobby. (needs to wait for opponent to join)
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "Created lobby"
+ * 404:
+ * description: Lobby not found.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "Lobby not found"
+ * 409:
+ * description: User already joined lobby.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "User already in lobby"
+ * 429:
+ * description: Lobby is full.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "Lobby is full"
+ */
router.post('/:id/join', lobbyController.joinLobby);
export default router;
diff --git a/backend/src/routes/serverRoutes.ts b/backend/src/routes/serverRoutes.ts
index 29eebfd075cd02c03509958163a46529ce6a5549..89a5b6c2bd3e23ac889a5631024e74df2c71d257 100644
--- a/backend/src/routes/serverRoutes.ts
+++ b/backend/src/routes/serverRoutes.ts
@@ -3,6 +3,38 @@ import * as serverController from '../controllers/serverController';
const router = express.Router();
+/**
+ * @swagger
+ * tags:
+ * - name: User
+ * description: Endpoints for managing users.
+ * - name: Game
+ * description: Endpoints for interacting with games.
+ * - name: Server
+ * description: Endpoints for interacting with the server.
+ * - name: Lobby
+ * description: Endpoints for interacting with lobbies.
+ * - name: Highscore
+ * description: Endpoints for interacting with highscores.
+ *
+ */
+
+/**
+ * @swagger
+ * /server/heartbeat:
+ * get:
+ * tags: [Server]
+ * summary: Retrieve a response from the server (heartbeat)
+ * description: If the server is alive, it will respond with a 200 status code and the message "Server is alive"
+ * responses:
+ * 200:
+ * description: A heartbeat response.
+ * content:
+ * text/plain:
+ * schema:
+ * type: string
+ * example: "Server is alive"
+ */
router.get('/heartbeat', serverController.heartbeat);
export default router;
diff --git a/backend/src/routes/userRoutes.ts b/backend/src/routes/userRoutes.ts
index a781f711b464a98c28448bb5d010c67d6c1545da..72e6a91b8fb7557559f389695cd7810b77bd7b8d 100644
--- a/backend/src/routes/userRoutes.ts
+++ b/backend/src/routes/userRoutes.ts
@@ -3,9 +3,114 @@ import * as userController from '../controllers/userController';
const router = express.Router();
+/**
+ * @swagger
+ * /user:
+ * get:
+ * summary: Returns all user IDs.
+ * tags: [User]
+ * responses:
+ * 200:
+ * description: List of user IDs.
+ * content:
+ * application/json:
+ * schema:
+ * type: array
+ * items:
+ * type: string
+ * example: ["0t73mMGkAADD7zjJVWXU","1mGO1z9484Y8OoCvjsF4","1yBYv7JzZupLCfmdmqLh","32E9WGluUTYu4DXl6lxh"]
+ *
+ * 204:
+ * description: No users found.
+ */
router.get('/', userController.users);
-router.get('/:idOrUsername', userController.getUser);
-router.post('/create/:username', userController.createUser);
-router.post('/delete/:username', userController.deleteUser); // should be router.delete
+
+/**
+ * @swagger
+ * /user/{username}:
+ * get:
+ * tags: [User]
+ * summary: Returns data for a specific user.
+ * parameters:
+ * - name: username
+ * in: path
+ * required: true
+ * description: Username of the user (can also be the unique user-id).
+ * schema:
+ * type: string
+ * responses:
+ * 200:
+ * description: User data.
+ * 404:
+ * description: User not found.
+ */
+router.get('/:username', userController.getUser);
+
+/**
+ * @swagger
+ * /user/{username}:
+ * post:
+ * tags: [User]
+ * summary: Creates a new user 1.
+ * parameters:
+ * - name: username
+ * in: path
+ * required: true
+ * description: Username of the user.
+ * schema:
+ * type: string
+ * responses:
+ * 201:
+ * description: User created.
+ * content:
+ * application/json:
+ * schema:
+ * type: array
+ * items:
+ * type: object
+ * properties:
+ * username:
+ * type: string
+ * description: The username of the user.
+ * highscore:
+ * type: number
+ * description: The highscore of the user.
+ * games:
+ * type: number
+ * description: The number of games the user has played.
+ * wins:
+ * type: number
+ * description: The number of games the user has won.
+ * losses:
+ * type: number
+ * description: The number of games the user has lost.
+ * id:
+ * type: string
+ * description: The ID of the user.
+ * 409:
+ * description: User already exists.
+ */
+router.post('/:username', userController.createUser);
+
+/**
+ * @swagger
+ * /user/{username}:
+ * delete:
+ * tags: [User]
+ * summary: Deletes a user.
+ * parameters:
+ * - name: username
+ * in: path
+ * required: true
+ * description: Username of the user.
+ * schema:
+ * type: string
+ * responses:
+ * 204:
+ * description: User deleted.
+ * 404:
+ * description: User not found.
+ */
+router.delete('/:username', userController.deleteUser);
export default router;
diff --git a/backend/tsconfig.json b/backend/tsconfig.json
index 38825eee024a61655bd045554b860de08ccc05d3..8fe805977e791cb9a87e3ee23bfb61680e92a012 100644
--- a/backend/tsconfig.json
+++ b/backend/tsconfig.json
@@ -5,7 +5,12 @@
"esModuleInterop": true,
"outDir": "dist",
"strict": true,
- "sourceMap": true
+ "sourceMap": true,
+ "removeComments": false,
+ "emitDecoratorMetadata": true,
+ "experimentalDecorators": true,
+ "allowJs": true,
+ "declaration": true
},
- "include": ["src/**/*", "types/**/*", "keys/**/*", "src/models/Lobby.ts"]
+ "include": ["src/**/*", "types/**/*", "keys/**/*"]
}
diff --git a/backend/yarn.lock b/backend/yarn.lock
index fc4c1664ee61e1da2ed877e7789f67fb567f31ec..97a88bf9473c82314a04b52279d479c843f8f524 100644
--- a/backend/yarn.lock
+++ b/backend/yarn.lock
@@ -2,6 +2,38 @@
# yarn lockfile v1
+"@apidevtools/json-schema-ref-parser@^9.0.6":
+ version "9.1.2"
+ resolved "https://registry.yarnpkg.com/@apidevtools/json-schema-ref-parser/-/json-schema-ref-parser-9.1.2.tgz#8ff5386b365d4c9faa7c8b566ff16a46a577d9b8"
+ integrity sha512-r1w81DpR+KyRWd3f+rk6TNqMgedmAxZP5v5KWlXQWlgMUUtyEJch0DKEci1SorPMiSeM8XPl7MZ3miJ60JIpQg==
+ dependencies:
+ "@jsdevtools/ono" "^7.1.3"
+ "@types/json-schema" "^7.0.6"
+ call-me-maybe "^1.0.1"
+ js-yaml "^4.1.0"
+
+"@apidevtools/openapi-schemas@^2.0.4":
+ version "2.1.0"
+ resolved "https://registry.yarnpkg.com/@apidevtools/openapi-schemas/-/openapi-schemas-2.1.0.tgz#9fa08017fb59d80538812f03fc7cac5992caaa17"
+ integrity sha512-Zc1AlqrJlX3SlpupFGpiLi2EbteyP7fXmUOGup6/DnkRgjP9bgMM/ag+n91rsv0U1Gpz0H3VILA/o3bW7Ua6BQ==
+
+"@apidevtools/swagger-methods@^3.0.2":
+ version "3.0.2"
+ resolved "https://registry.yarnpkg.com/@apidevtools/swagger-methods/-/swagger-methods-3.0.2.tgz#b789a362e055b0340d04712eafe7027ddc1ac267"
+ integrity sha512-QAkD5kK2b1WfjDS/UQn/qQkbwF31uqRjPTrsCs5ZG9BQGAkjwvqGFjjPqAuzac/IYzpPtRzjCP1WrTuAIjMrXg==
+
+"@apidevtools/swagger-parser@10.0.3":
+ version "10.0.3"
+ resolved "https://registry.yarnpkg.com/@apidevtools/swagger-parser/-/swagger-parser-10.0.3.tgz#32057ae99487872c4dd96b314a1ab4b95d89eaf5"
+ integrity sha512-sNiLY51vZOmSPFZA5TF35KZ2HbgYklQnTSDnkghamzLb3EkNtcQnrBQEj5AOCxHpTtXpqMCRM1CrmV2rG6nw4g==
+ dependencies:
+ "@apidevtools/json-schema-ref-parser" "^9.0.6"
+ "@apidevtools/openapi-schemas" "^2.0.4"
+ "@apidevtools/swagger-methods" "^3.0.2"
+ "@jsdevtools/ono" "^7.1.3"
+ call-me-maybe "^1.0.1"
+ z-schema "^5.0.1"
+
"@babel/code-frame@^7.12.13":
version "7.21.4"
resolved "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.21.4.tgz"
@@ -257,6 +289,11 @@
"@jridgewell/resolve-uri" "^3.0.3"
"@jridgewell/sourcemap-codec" "^1.4.10"
+"@jsdevtools/ono@^7.1.3":
+ version "7.1.3"
+ resolved "https://registry.yarnpkg.com/@jsdevtools/ono/-/ono-7.1.3.tgz#9df03bbd7c696a5c58885c34aa06da41c8543796"
+ integrity sha512-4JQNk+3mVzK3xh2rqd6RB4J46qUR19azEHBneZyTZM+c456qOrbbM/5xcR8huNCCcbVt7+UmizG6GuUvPvKUYg==
+
"@jsdoc/salty@^0.2.1":
version "0.2.4"
resolved "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.4.tgz"
@@ -423,6 +460,11 @@
expect "^29.0.0"
pretty-format "^29.0.0"
+"@types/json-schema@^7.0.6":
+ version "7.0.11"
+ resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.11.tgz#d421b6c527a3037f7c84433fd2c4229e016863d3"
+ integrity sha512-wOuvG1SN4Us4rez+tylwwwCV1psiNVOkJeM3AUWUNWg/jDQY2+HE/444y5gc+jBmRqASOm2Oeh5c1axHobwRKQ==
+
"@types/jsonwebtoken@^9.0.0":
version "9.0.1"
resolved "https://registry.npmjs.org/@types/jsonwebtoken/-/jsonwebtoken-9.0.1.tgz"
@@ -514,6 +556,11 @@
resolved "https://registry.npmjs.org/@types/stack-utils/-/stack-utils-2.0.1.tgz"
integrity sha512-Hl219/BT5fLAaz6NDkSuhzasy49dwQS/DSdu4MdggFB8zcXv7vflBI3xp7FEmkmdDkBUI2bPUNeMttp2knYdxw==
+"@types/swagger-jsdoc@^6.0.1":
+ version "6.0.1"
+ resolved "https://registry.yarnpkg.com/@types/swagger-jsdoc/-/swagger-jsdoc-6.0.1.tgz#94a99aca0356cb64ad2a6eb903ed034703453801"
+ integrity sha512-+MUpcbyxD528dECUBCEVm6abNuORdbuGjbrUdHDeAQ+rkPuo2a+L4N02WJHF3bonSSE6SJ3dUJwF2V6+cHnf0w==
+
"@types/yargs-parser@*":
version "21.0.0"
resolved "https://registry.npmjs.org/@types/yargs-parser/-/yargs-parser-21.0.0.tgz"
@@ -814,6 +861,11 @@ call-bind@^1.0.0:
function-bind "^1.1.1"
get-intrinsic "^1.0.2"
+call-me-maybe@^1.0.1:
+ version "1.0.2"
+ resolved "https://registry.yarnpkg.com/call-me-maybe/-/call-me-maybe-1.0.2.tgz#03f964f19522ba643b1b0693acb9152fe2074baa"
+ integrity sha512-HpX65o1Hnr9HH25ojC1YGs7HCQLq0GCOibSaWER0eNpgJ/Z1MZv2mTc7+xh6WOPxbRVcmgbv4hGU+uSQ/2xFZQ==
+
caseless@~0.12.0:
version "0.12.0"
resolved "https://registry.npmjs.org/caseless/-/caseless-0.12.0.tgz"
@@ -915,6 +967,11 @@ cliui@^8.0.1:
strip-ansi "^6.0.1"
wrap-ansi "^7.0.0"
+clone@2.x:
+ version "2.1.2"
+ resolved "https://registry.yarnpkg.com/clone/-/clone-2.1.2.tgz#1b7f4b9f591f1e8f83670401600345a02887435f"
+ integrity sha512-3Pe/CF1Nn94hyhIYpjtiLhdCoEoz0DqQ+988E9gmeEdQZlojxnOb74wctFyuwWQHzqyf9X7C7MG8juUpqBJT8w==
+
color-convert@^1.9.0:
version "1.9.3"
resolved "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz"
@@ -951,6 +1008,16 @@ combined-stream@^1.0.6, combined-stream@~1.0.6:
dependencies:
delayed-stream "~1.0.0"
+commander@6.2.0:
+ version "6.2.0"
+ resolved "https://registry.yarnpkg.com/commander/-/commander-6.2.0.tgz#b990bfb8ac030aedc6d11bc04d1488ffef56db75"
+ integrity sha512-zP4jEKbe8SHzKJYQmq8Y9gYjtO/POJLgIdKgV7B9qNmABVFVc+ctqSX6iXh4mCpJfRBOabiZ2YKPg8ciDw6C+Q==
+
+commander@^10.0.0:
+ version "10.0.0"
+ resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.0.tgz#71797971162cd3cf65f0b9d24eb28f8d303acdf1"
+ integrity sha512-zS5PnTI22FIRM6ylNW8G4Ap0IEOyk62fhLSD0+uHRT9McRCLGpkVNvao4bjimpK/GShynyQkFFxHhwMcETmduA==
+
commander@^5.1.0:
version "5.1.0"
resolved "https://registry.npmjs.org/commander/-/commander-5.1.0.tgz"
@@ -1152,6 +1219,13 @@ diff@^4.0.1:
resolved "https://registry.yarnpkg.com/diff/-/diff-4.0.2.tgz#60f3aecb89d5fae520c11aa19efc2bb982aade7d"
integrity sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==
+doctrine@3.0.0:
+ version "3.0.0"
+ resolved "https://registry.yarnpkg.com/doctrine/-/doctrine-3.0.0.tgz#addebead72a6574db783639dc87a121773973961"
+ integrity sha512-yS+Q5i3hBf7GBkd4KG8a7eBNNWNGLTaEwwYWUijIYM7zrlYDM0BFXHjjPWlWZ1Rg7UaddZeIDmi9jF3HmqiQ2w==
+ dependencies:
+ esutils "^2.0.2"
+
duplexify@^4.0.0:
version "4.1.2"
resolved "https://registry.npmjs.org/duplexify/-/duplexify-4.1.2.tgz"
@@ -1580,6 +1654,18 @@ glob-parent@~5.1.2:
dependencies:
is-glob "^4.0.1"
+glob@7.1.6:
+ version "7.1.6"
+ resolved "https://registry.yarnpkg.com/glob/-/glob-7.1.6.tgz#141f33b81a7c2492e125594307480c46679278a6"
+ integrity sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==
+ dependencies:
+ fs.realpath "^1.0.0"
+ inflight "^1.0.4"
+ inherits "2"
+ minimatch "^3.0.4"
+ once "^1.3.0"
+ path-is-absolute "^1.0.0"
+
glob@^7.1.3:
version "7.2.3"
resolved "https://registry.npmjs.org/glob/-/glob-7.2.3.tgz"
@@ -1927,6 +2013,13 @@ js-tokens@^4.0.0:
resolved "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz"
integrity sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==
+js-yaml@^4.1.0:
+ version "4.1.0"
+ resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.1.0.tgz#c1fb65f8f5017901cdd2c951864ba18458a10602"
+ integrity sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==
+ dependencies:
+ argparse "^2.0.1"
+
js2xmlparser@^4.0.2:
version "4.0.2"
resolved "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz"
@@ -2108,6 +2201,21 @@ lodash.clonedeep@^4.5.0:
resolved "https://registry.npmjs.org/lodash.clonedeep/-/lodash.clonedeep-4.5.0.tgz"
integrity sha512-H5ZhCF25riFd9uB5UCkVKo61m3S/xZk1x4wA6yp/L3RFP6Z/eHH1ymQcGLo7J3GMPfm0V/7m1tryHuGVxpqEBQ==
+lodash.get@^4.4.2:
+ version "4.4.2"
+ resolved "https://registry.yarnpkg.com/lodash.get/-/lodash.get-4.4.2.tgz#2d177f652fa31e939b4438d5341499dfa3825e99"
+ integrity sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==
+
+lodash.isequal@^4.5.0:
+ version "4.5.0"
+ resolved "https://registry.yarnpkg.com/lodash.isequal/-/lodash.isequal-4.5.0.tgz#415c4478f2bcc30120c22ce10ed3226f7d3e18e0"
+ integrity sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==
+
+lodash.mergewith@^4.6.2:
+ version "4.6.2"
+ resolved "https://registry.yarnpkg.com/lodash.mergewith/-/lodash.mergewith-4.6.2.tgz#617121f89ac55f59047c7aec1ccd6654c6590f55"
+ integrity sha512-GK3g5RPZWTRSeLSpgP8Xhra+pnjBC56q9FZYe1d5RN3TJ35dbkGy3YqBSMbyCrlbi+CM9Z3Jk5yTL7RCsqboyQ==
+
lodash.once@^4.1.1:
version "4.1.1"
resolved "https://registry.npmjs.org/lodash.once/-/lodash.once-4.1.1.tgz"
@@ -2255,7 +2363,7 @@ mimic-fn@^2.1.0:
resolved "https://registry.npmjs.org/mimic-fn/-/mimic-fn-2.1.0.tgz"
integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==
-minimatch@^3.1.1, minimatch@^3.1.2:
+minimatch@^3.0.4, minimatch@^3.1.1, minimatch@^3.1.2:
version "3.1.2"
resolved "https://registry.npmjs.org/minimatch/-/minimatch-3.1.2.tgz"
integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==
@@ -2299,6 +2407,13 @@ negotiator@0.6.3:
resolved "https://registry.npmjs.org/negotiator/-/negotiator-0.6.3.tgz"
integrity sha512-+EUsqGPLsM+j/zdChZjsnX51g4XrHFOIXwfnCVPGlQk/k5giakcKsuxCObBRu6DSm9opw/O6slWbJdghQM4bBg==
+node-cache@^5.1.2:
+ version "5.1.2"
+ resolved "https://registry.yarnpkg.com/node-cache/-/node-cache-5.1.2.tgz#f264dc2ccad0a780e76253a694e9fd0ed19c398d"
+ integrity sha512-t1QzWwnk4sjLWaQAS8CHgOJ+RAfmHpxFWmc36IWTiWHQfs0w5JDMBS1b1ZxQteo0vVVuWJvIUKHDkkeK7vIGCg==
+ dependencies:
+ clone "2.x"
+
node-fetch@^2.6.1, node-fetch@^2.6.7:
version "2.6.9"
resolved "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.9.tgz"
@@ -2898,6 +3013,37 @@ supports-color@^8.1.1:
dependencies:
has-flag "^4.0.0"
+swagger-jsdoc@^6.2.8:
+ version "6.2.8"
+ resolved "https://registry.yarnpkg.com/swagger-jsdoc/-/swagger-jsdoc-6.2.8.tgz#6d33d9fb07ff4a7c1564379c52c08989ec7d0256"
+ integrity sha512-VPvil1+JRpmJ55CgAtn8DIcpBs0bL5L3q5bVQvF4tAW/k/9JYSj7dCpaYCAv5rufe0vcCbBRQXGvzpkWjvLklQ==
+ dependencies:
+ commander "6.2.0"
+ doctrine "3.0.0"
+ glob "7.1.6"
+ lodash.mergewith "^4.6.2"
+ swagger-parser "^10.0.3"
+ yaml "2.0.0-1"
+
+swagger-parser@^10.0.3:
+ version "10.0.3"
+ resolved "https://registry.yarnpkg.com/swagger-parser/-/swagger-parser-10.0.3.tgz#04cb01c18c3ac192b41161c77f81e79309135d03"
+ integrity sha512-nF7oMeL4KypldrQhac8RyHerJeGPD1p2xDh900GPvc+Nk7nWP6jX2FcC7WmkinMoAmoO774+AFXcWsW8gMWEIg==
+ dependencies:
+ "@apidevtools/swagger-parser" "10.0.3"
+
+swagger-ui-dist@>=4.11.0:
+ version "4.18.2"
+ resolved "https://registry.yarnpkg.com/swagger-ui-dist/-/swagger-ui-dist-4.18.2.tgz#323308f1c1d87a7c22ce3e273c31835eb680a71b"
+ integrity sha512-oVBoBl9Dg+VJw8uRWDxlyUyHoNEDC0c1ysT6+Boy6CTgr2rUcLcfPon4RvxgS2/taNW6O0+US+Z/dlAsWFjOAQ==
+
+swagger-ui-express@^4.6.2:
+ version "4.6.2"
+ resolved "https://registry.yarnpkg.com/swagger-ui-express/-/swagger-ui-express-4.6.2.tgz#61b2cb9fd7932cdccff99e0efdf700a5459e493c"
+ integrity sha512-MHIOaq9JrTTB3ygUJD+08PbjM5Tt/q7x80yz9VTFIatw8j5uIWKcr90S0h5NLMzFEDC6+eVprtoeA5MDZXCUKQ==
+ dependencies:
+ swagger-ui-dist ">=4.11.0"
+
teeny-request@^8.0.0:
version "8.0.3"
resolved "https://registry.npmjs.org/teeny-request/-/teeny-request-8.0.3.tgz"
@@ -3089,6 +3235,11 @@ v8-compile-cache-lib@^3.0.1:
resolved "https://registry.yarnpkg.com/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz#6336e8d71965cb3d35a1bbb7868445a7c05264bf"
integrity sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==
+validator@^13.7.0:
+ version "13.9.0"
+ resolved "https://registry.yarnpkg.com/validator/-/validator-13.9.0.tgz#33e7b85b604f3bbce9bb1a05d5c3e22e1c2ff855"
+ integrity sha512-B+dGG8U3fdtM0/aNK4/X8CXq/EcxU2WPrPEkJGslb47qyHsxmbggTWK0yEA4qnYVNF+nxNlN88o14hIcPmSIEA==
+
vary@~1.1.2:
version "1.1.2"
resolved "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz"
@@ -3185,6 +3336,11 @@ yallist@^4.0.0:
resolved "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz"
integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==
+yaml@2.0.0-1:
+ version "2.0.0-1"
+ resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.0.0-1.tgz#8c3029b3ee2028306d5bcf396980623115ff8d18"
+ integrity sha512-W7h5dEhywMKenDJh2iX/LABkbFnBxasD27oyXWDS/feDsxiw0dD5ncXdYXgkvAsXIY2MpW/ZKkr9IU30DBdMNQ==
+
yargs-parser@^20.2.2:
version "20.2.9"
resolved "https://registry.npmjs.org/yargs-parser/-/yargs-parser-20.2.9.tgz"
@@ -3238,3 +3394,14 @@ yocto-queue@^0.1.0:
version "0.1.0"
resolved "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz"
integrity sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==
+
+z-schema@^5.0.1:
+ version "5.0.6"
+ resolved "https://registry.yarnpkg.com/z-schema/-/z-schema-5.0.6.tgz#46d6a687b15e4a4369e18d6cb1c7b8618fc256c5"
+ integrity sha512-+XR1GhnWklYdfr8YaZv/iu+vY+ux7V5DS5zH1DQf6bO5ufrt/5cgNhVO5qyhsjFXvsqQb/f08DWE9b6uPscyAg==
+ dependencies:
+ lodash.get "^4.4.2"
+ lodash.isequal "^4.5.0"
+ validator "^13.7.0"
+ optionalDependencies:
+ commander "^10.0.0"