[#7] feat: add new models and dto for user

backend/user-service/src/models/user.model.ts

@@ -0,0 +1,47 @@
+import { Schema, model } from 'mongoose'
+import { IUser } from '../types/IUser'
+import { Proficiency } from '../types/Proficiency'
+import { Role } from '../types/Role'
+
+const UserSchema = new Schema<IUser>({
+    username: {
+        type: String,
+        required: true,
+        unique: true,
+    },
+    email: {
+        type: String,
+        required: true,
+        unique: true,
+    },
+    password: {
+        type: String,
+        required: true,
+    },
+    role: {
+        type: String,
+        enum: Object.values(Role),
+        required: true,
+    },
+    proficiency: {
+        type: String,
+        enum: Object.values(Proficiency),
+        required: false,
+    },
+    createdAt: {
+        type: Date,
+        required: false,
+    },
+    updatedAt: {
+        type: Date,
+        required: false,
+        default: null,
+    },
+    deletedAt: {
+        type: Date,
+        required: false,
+        default: null,
+    },
+})
+
+export default model<IUser>('User', UserSchema)

backend/user-service/src/types/CreateUserDto.ts

@@ -0,0 +1,56 @@
+import {
+    IsEmail,
+    IsEnum,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    IsStrongPassword,
+    validate,
+    ValidationError,
+} from 'class-validator'
+import { Proficiency } from './Proficiency'
+import { Role } from './Role'
+import { TypedRequest } from './TypedRequest'
+
+export class CreateUserDto {
+    @IsString()
+    @IsNotEmpty()
+    username: string
+
+    @IsStrongPassword({ minLength: 8, minLowercase: 1, minUppercase: 1, minNumbers: 1, minSymbols: 1 })
+    password: string
+
+    @IsEmail()
+    email: string
+
+    @IsEnum(Role)
+    role: Role
+
+    @IsOptional()
+    @IsEnum(Proficiency)
+    proficiency?: Proficiency
+
+    constructor(username: string, email: string, password: string, role: Role, proficiency?: Proficiency) {
+        this.username = username
+        this.email = email
+        this.password = password
+        this.role = role
+        this.proficiency = proficiency
+    }
+
+    static fromRequest({
+        body: { username, email, password, role, proficiency },
+    }: TypedRequest<{
+        username: string
+        password: string
+        email: string
+        role: Role
+        proficiency: Proficiency | undefined
+    }>): CreateUserDto {
+        return new CreateUserDto(username, email, password, role, proficiency)
+    }
+
+    async validate(): Promise<ValidationError[]> {
+        return validate(this)
+    }
+}

backend/user-service/src/types/IUser.ts

@@ -0,0 +1,14 @@
+import { Proficiency } from './Proficiency'
+import { Role } from './Role'
+
+export interface IUser {
+    id: string
+    username: string
+    email: string
+    password: string
+    role: Role
+    proficiency?: Proficiency
+    createdAt?: Date
+    updatedAt?: Date
+    deletedAt?: Date
+}

backend/user-service/src/types/Proficiency.ts

@@ -0,0 +1,6 @@
+export enum Proficiency {
+    BEGINNER = 'BEGINNER',
+    INTERMEDIATE = 'INTERMEDIATE',
+    ADVANCED = 'ADVANCED',
+    EXPERT = 'EXPERT',
+}

backend/user-service/src/types/Role.ts

@@ -0,0 +1,4 @@
+export enum Role {
+    USER = 'USER',
+    ADMIN = 'ADMIN',
+}

backend/user-service/src/types/TypedRequest.ts

@@ -0,0 +1,5 @@
+import { Request } from 'express'
+
+export interface TypedRequest<T> extends Request {
+    body: T
+}

backend/user-service/src/types/UserDto.ts

@@ -0,0 +1,53 @@
+import { IsEmail, IsEnum, IsNotEmpty, IsOptional, IsString, validate, ValidationError } from 'class-validator'
+import { IUser } from './IUser'
+import { Proficiency } from './Proficiency'
+import { Role } from './Role'
+import { TypedRequest } from './TypedRequest'
+
+export class UserDto {
+    @IsString()
+    @IsNotEmpty()
+    id: string
+
+    @IsString()
+    @IsNotEmpty()
+    username: string
+
+    @IsEmail()
+    email: string
+
+    @IsEnum(Role)
+    role: Role
+
+    @IsOptional()
+    @IsEnum(Proficiency)
+    proficiency?: Proficiency
+
+    constructor(id: string, username: string, email: string, role: Role, proficiency?: Proficiency) {
+        this.id = id
+        this.username = username
+        this.email = email
+        this.role = role
+        this.proficiency = proficiency
+    }
+
+    static fromModel({ id, username, email, role, proficiency }: IUser): UserDto {
+        return new UserDto(id, username, email, role, proficiency)
+    }
+
+    static fromRequest({
+        body: { id, username, email, role, proficiency },
+    }: TypedRequest<{
+        id: string
+        username: string
+        email: string
+        role: Role
+        proficiency: Proficiency | undefined
+    }>): UserDto {
+        return new UserDto(id, username, email, role, proficiency)
+    }
+
+    async validate(): Promise<ValidationError[]> {
+        return validate(this)
+    }
+}

backend/user-service/tsconfig.json

@@ -14,7 +14,7 @@
         "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
         // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
         // "jsx": "preserve",                                /* Specify what JSX code is generated. */
-        // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+        "experimentalDecorators": true /* Enable experimental support for legacy experimental decorators. */,
         // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
         // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
         // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */