[FEATURE]: Swagger Documentation

backend/package.json

@@ -23,52 +23,55 @@
 		"pre-commit": "lint-staged"
 	},
 	"dependencies": {
-		"@faker-js/faker": "^6.1.2",
-		"@nestjs-modules/mailer": "^1.6.1",
-		"@nestjs/common": "^8.4.4",
+		"@faker-js/faker": "^7.3.0",
+		"@nestjs-modules/mailer": "^1.8.1",
+		"@nestjs/common": "^9.0.0",
 		"@nestjs/config": "^2.0.0",
-		"@nestjs/core": "^8.4.4",
-		"@nestjs/jwt": "^8.0.0",
+		"@nestjs/core": "^9.0.0",
+		"@nestjs/jwt": "^9.0.0",
 		"@nestjs/mapped-types": "^1.0.1",
 		"@nestjs/mongoose": "^9.0.3",
-		"@nestjs/passport": "^8.2.1",
-		"@nestjs/platform-express": "^8.4.4",
-		"@nestjs/platform-socket.io": "^8.4.4",
-		"@nestjs/schedule": "^1.1.0",
-		"@nestjs/websockets": "^8.4.4",
-    "@slack/web-api": "^6.7.1",
-		"axios": "^0.26.1",
+		"@nestjs/passport": "^9.0.0",
+		"@nestjs/platform-express": "^9.0.0",
+		"@nestjs/platform-socket.io": "^9.0.0",
+		"@nestjs/schedule": "^2.1.0",
+		"@nestjs/swagger": "^6.0.4",
+		"@nestjs/websockets": "^9.0.0",
+		"@slack/web-api": "^6.7.1",
+		"axios": "^0.27.2",
 		"bcrypt": "^5.0.1",
 		"class-transformer": "^0.5.1",
 		"class-validator": "^0.13.2",
-		"cron": "1.8.2",
+		"cron": "2.1.0",
 		"dotenv": "^16.0.0",
 		"eslint-config-airbnb": "^19.0.4",
 		"eslint-config-airbnb-typescript": "^17.0.0",
 		"express": "^4.17.3",
 		"joi": "^17.6.0",
 		"jwt-decode": "^3.1.2",
-		"lint-staged": "^12.3.7",
+		"lint-staged": "^13.0.3",
+		"moment": "^2.29.4",
 		"moment-business-days": "^1.2.0",
 		"mongodb": "4.5.0",
 		"mongoose": "6.2.10",
 		"mongoose-lean-virtuals": "0.9.0",
 		"nodemailer": "^6.7.5",
-		"passport": "^0.5.2",
+		"passport": "^0.6.0",
 		"passport-jwt": "^4.0.0",
 		"passport-local": "^1.0.0",
 		"reflect-metadata": "^0.1.13",
 		"rimraf": "^3.0.2",
 		"rxjs": "^7.5.6",
-		"socket.io": "^4.4.1"
+		"socket.io": "^4.4.1",
+		"swagger-ui-express": "^4.5.0"
 	},
 	"devDependencies": {
-		"@nestjs/cli": "^8.2.5",
-		"@nestjs/schematics": "^8.0.10",
-		"@nestjs/testing": "^8.4.4",
+		"@nestjs/cli": "^9.0.0",
+		"@nestjs/schematics": "^9.0.1",
+		"@nestjs/testing": "^9.0.0",
 		"@types/bcrypt": "^5.0.0",
 		"@types/express": "^4.17.13",
-		"@types/jest": "^27.4.1",
+		"@types/jest": "^28.1.6",
 		"@types/node": "^17.0.23",
 		"@types/passport-jwt": "^3.0.6",
 		"@types/passport-local": "^1.0.34",
@@ -84,14 +87,14 @@
 		"eslint-plugin-prettier": "^4.2.1",
 		"eslint-plugin-simple-import-sort": "^7.0.0",
 		"eslint-plugin-unused-imports": "^2.0.0",
-		"jest": "^27.5.1",
+		"jest": "^28.1.3",
 		"prettier": "^2.6.2",
 		"source-map-support": "^0.5.21",
 		"supertest": "^6.2.2",
-		"ts-jest": "^27.1.4",
+		"ts-jest": "^28.0.7",
 		"ts-loader": "^9.2.8",
 		"ts-node": "^10.7.0",
-		"tsconfig-paths": "^3.14.1",
+		"tsconfig-paths": "^4.0.0",
 		"typescript": "^4.6.3"
 	},
 	"lint-staged": {

backend/src/app.module.ts

@@ -1,22 +1,21 @@
 import { Module } from '@nestjs/common';
 import { ScheduleModule } from '@nestjs/schedule';
 
+import AppConfigModule from 'infrastructure/config/config.module';
+import { configuration } from 'infrastructure/config/configuration';
+import DatabaseModule from 'infrastructure/database/database.module';
+import { mongooseResetModule, mongooseUserModule } from 'infrastructure/database/mongoose.module';
+import AuthModule from 'modules/auth/auth.module';
+import AzureModule from 'modules/azure/azure.module';
+import BoardsModule from 'modules/boards/boards.module';
+import { CardsModule } from 'modules/cards/cards.module';
+import { CommentsModule } from 'modules/comments/comments.module';
 import { CommunicationModule } from 'modules/communication/communication.module';
-
-import AppConfigModule from './infrastructure/config/config.module';
-import { configuration } from './infrastructure/config/configuration';
-import DatabaseModule from './infrastructure/database/database.module';
-import { mongooseResetModule, mongooseUserModule } from './infrastructure/database/mongoose.module';
-import AuthModule from './modules/auth/auth.module';
-import AzureModule from './modules/azure/azure.module';
-import BoardsModule from './modules/boards/boards.module';
-import { CardsModule } from './modules/cards/cards.module';
-import { CommentsModule } from './modules/comments/comments.module';
-import EmailModule from './modules/mailer/mailer.module';
-import SocketModule from './modules/socket/socket.module';
-import TeamsModule from './modules/teams/teams.module';
-import UsersModule from './modules/users/users.module';
-import { VotesModule } from './modules/votes/votes.module';
+import EmailModule from 'modules/mailer/mailer.module';
+import SocketModule from 'modules/socket/socket.module';
+import TeamsModule from 'modules/teams/teams.module';
+import UsersModule from 'modules/users/users.module';
+import { VotesModule } from 'modules/votes/votes.module';
 
 const imports = [
 	AppConfigModule,

backend/src/libs/dto/base.dto.ts

@@ -1,6 +1,8 @@
+import { ApiProperty } from '@nestjs/swagger';
 import { IsNotEmpty, IsString } from 'class-validator';
 
 export class BaseDto {
+	@ApiProperty()
 	@IsNotEmpty()
 	@IsString()
 	socketId!: string;

backend/src/libs/dto/param/email.param.ts

@@ -1,6 +1,8 @@
+import { ApiProperty } from '@nestjs/swagger';
 import { IsEmail, IsString } from 'class-validator';
 
 export class EmailParam {
+	@ApiProperty({ type: String, format: 'email' })
 	@IsEmail()
 	@IsString()
 	email!: string;

backend/src/libs/dto/text.dto.ts

@@ -1,9 +1,11 @@
+import { ApiProperty } from '@nestjs/swagger';
 import { Transform, TransformFnParams } from 'class-transformer';
 import { IsNotEmpty, IsString } from 'class-validator';
 
 import { BaseDto } from './base.dto';
 
 export class TextDto extends BaseDto {
+	@ApiProperty()
 	@IsNotEmpty()
 	@IsString()
 	@Transform(({ value }: TransformFnParams) => value.trim())

backend/src/libs/exceptions/messages.ts

@@ -1,20 +1,43 @@
-export const USER_NOT_FOUND = 'USER_NOT_FOUND';
-export const INVALID_CREDENTIALS = 'INVALID_CREDENTIALS';
+const USER_NOT_FOUND = 'USER_NOT_FOUND';
+const INVALID_CREDENTIALS = 'INVALID_CREDENTIALS';
 
-export const EMAIL_EXISTS = 'EMAIL_EXISTS';
-export const EMAIL_NOT_EXISTS = 'EMAIL_NOT_EXISTS';
-export const EMAIL_DONT_MATCH = 'EMAIL_DONT_MATCH';
+const EMAIL_EXISTS = 'EMAIL_EXISTS';
+const EMAIL_NOT_EXISTS = 'EMAIL_NOT_EXISTS';
+const EMAIL_DONT_MATCH = 'EMAIL_DONT_MATCH';
 
-export const BOARD_NOT_FOUND = 'BOARD_NOT_FOUND';
-export const BOARDS_NOT_FOUND = 'BOARDS_NOT_FOUND';
+const BOARD_NOT_FOUND = 'BOARD_NOT_FOUND';
+const BOARDS_NOT_FOUND = 'BOARDS_NOT_FOUND';
 
-export const TOKENS_NOT_MATCHING = 'TOKENS_NOT_MATCHING';
+const TOKENS_NOT_MATCHING = 'TOKENS_NOT_MATCHING';
 
-export const UNAUTHORIZED = 'UNAUTHORIZED';
-export const UPDATE_FAILED = 'UPDATE_FAILED';
-export const DELETE_FAILED = 'DELETE_FAILED';
-export const INSERT_FAILED = 'INSERT_FAILED';
+const UNAUTHORIZED = 'UNAUTHORIZED';
+const UPDATE_FAILED = 'UPDATE_FAILED';
+const DELETE_FAILED = 'DELETE_FAILED';
+const INSERT_FAILED = 'INSERT_FAILED';
 
-export const CARD_NOT_REMOVED = "Card wasn't removed";
-export const CARD_NOT_INSERTED = "Card wasn't inserted";
-export const CARD_NOT_FOUND = "Card wasn't found";
+const CARD_NOT_REMOVED = "Card wasn't removed";
+const CARD_NOT_INSERTED = "Card wasn't inserted";
+const CARD_NOT_FOUND = "Card wasn't found";
+
+const FORBIDDEN = 'FORBIDDEN';
+const NOT_FOUND = 'NOT_FOUND';
+
+export {
+	BOARD_NOT_FOUND,
+	BOARDS_NOT_FOUND,
+	CARD_NOT_FOUND,
+	CARD_NOT_INSERTED,
+	CARD_NOT_REMOVED,
+	DELETE_FAILED,
+	EMAIL_DONT_MATCH,
+	EMAIL_EXISTS,
+	EMAIL_NOT_EXISTS,
+	FORBIDDEN,
+	INSERT_FAILED,
+	INVALID_CREDENTIALS,
+	NOT_FOUND,
+	TOKENS_NOT_MATCHING,
+	UNAUTHORIZED,
+	UPDATE_FAILED,
+	USER_NOT_FOUND
+};

backend/src/libs/swagger/dto/socket-id.swagger.ts

@@ -0,0 +1,6 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class SocketIdDto {
+	@ApiProperty()
+	socketId!: string;
+}

backend/src/libs/swagger/errors/bad-request.swagger.ts

@@ -0,0 +1,27 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+import {
+	DELETE_FAILED,
+	EMAIL_DONT_MATCH,
+	EMAIL_EXISTS,
+	INSERT_FAILED,
+	UPDATE_FAILED
+} from 'libs/exceptions/messages';
+
+export class BadRequestResponse {
+	@ApiProperty({
+		type: Number,
+		default: 400
+	})
+	statusCode!: number;
+
+	@ApiProperty({
+		type: String,
+		isArray: true,
+		examples: [INSERT_FAILED, DELETE_FAILED, UPDATE_FAILED, EMAIL_EXISTS, EMAIL_DONT_MATCH]
+	})
+	message!: string[];
+
+	@ApiProperty({ type: String, default: 'Bad Request' })
+	error!: string;
+}

backend/src/libs/swagger/errors/forbidden.swagger.ts

@@ -0,0 +1,21 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+import { FORBIDDEN } from 'libs/exceptions/messages';
+
+export class ForbiddenResponse {
+	@ApiProperty({
+		type: Number,
+		default: 403
+	})
+	statusCode!: number;
+
+	@ApiProperty({
+		type: String,
+		isArray: true,
+		default: [FORBIDDEN]
+	})
+	message!: string[];
+
+	@ApiProperty({ type: String, default: 'Forbidden' })
+	error!: string;
+}

backend/src/libs/swagger/errors/internal-server-error.swagger.ts

@@ -0,0 +1,15 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+export class InternalServerErrorResponse {
+	@ApiProperty({
+		type: Number,
+		default: 500
+	})
+	statusCode!: number;
+
+	@ApiProperty({
+		type: String,
+		default: 'Internal server error'
+	})
+	message!: string;
+}

backend/src/libs/swagger/errors/not-found.swagger.ts

@@ -0,0 +1,26 @@
+import { ApiProperty } from '@nestjs/swagger';
+
+import {
+	BOARD_NOT_FOUND,
+	BOARDS_NOT_FOUND,
+	NOT_FOUND,
+	USER_NOT_FOUND
+} from 'libs/exceptions/messages';
+
+export class NotFoundResponse {
+	@ApiProperty({
+		type: Number,
+		default: 404
+	})
+	statusCode!: number;
+
+	@ApiProperty({
+		type: String,
+		isArray: true,
+		examples: [NOT_FOUND, BOARDS_NOT_FOUND, BOARD_NOT_FOUND, USER_NOT_FOUND]
+	})
+	message!: string[];
+
+	@ApiProperty({ type: String, default: 'Not Found' })
+	error!: string;
+}

backend/src/libs/swagger/errors/unauthorized.swagger.ts

@@ -0,0 +1,20 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+
+export class UnauthorizedResponse {
+	@ApiProperty({
+		type: Number,
+		default: 401
+	})
+	statusCode!: number;
+
+	@ApiProperty({
+		type: String,
+		default: 'Unauthorized'
+	})
+	message!: string;
+
+	@ApiPropertyOptional({
+		type: String
+	})
+	error!: string;
+}