refactor: update user model to contain new fields, and omitting username for unnecessary use

Author: Zaiidmo

README.md

@@ -188,14 +188,22 @@ Content-Type: application/json
     "fname": "Test",
     "lname": "User"
   },
-  "username": "Userrr",
+  "username": "custom-username",
   "email": "user@example.com",
   "password": "Pa$$word!",
   "phoneNumber": "+1234567890",
-  "avatar": "https://example.com/avatar.jpg"
+  "avatar": "https://example.com/avatar.jpg",
+  "jobTitle": "Software Engineer",
+  "company": "Ciscode"
 }
 ```
 
+**Notes:**
+
+- `username` is now **optional**. If not provided, it will be auto-generated as `fname-lname` (e.g., `test-user`)
+- `jobTitle` and `company` are **optional** profile fields
+- All other fields work as before
+
 **Response:**
 
 ```json
@@ -387,10 +395,12 @@ All permissions are assigned to the `admin` role.
     fname: string,
     lname: string
   },
-  username: string (unique, 3-30 chars),
+  username: string (unique, 3-30 chars, auto-generated as fname-lname if not provided),
   email: string (unique, validated),
   phoneNumber?: string (unique, 10-14 digits),
   avatar?: string (default: 'default.jpg'),
+  jobTitle?: string,
+  company?: string,
   password: string (hashed, min 6 chars),
   roles: ObjectId[] (references Role),
   isVerified: boolean (default: false),

src/dtos/auth/register.dto.ts

@@ -11,9 +11,10 @@ export class RegisterDto {
     @Type(() => FullNameDto)
     fullname!: FullNameDto;
 
+    @IsOptional()
     @IsString()
     @MinLength(3)
-    username!: string;
+    username?: string;
 
     @IsEmail()
     email!: string;
@@ -29,4 +30,12 @@ export class RegisterDto {
     @IsOptional()
     @IsString()
     avatar?: string;
+
+    @IsOptional()
+    @IsString()
+    jobTitle?: string;
+
+    @IsOptional()
+    @IsString()
+    company?: string;
 }

src/models/user.model.ts

@@ -47,7 +47,7 @@ export class User {
 
   @Prop({ default: Date.now })
   passwordChangedAt!: Date;
-  
+
   @Prop({ type: [{ type: Types.ObjectId, ref: 'Role' }], required: true })
   roles!: Types.ObjectId[];
 
@@ -57,6 +57,12 @@ export class User {
   @Prop({ default: false })
   isBanned!: boolean;
 
+  @Prop({ trim: true, sparse: true })
+  jobTitle?: string;
+
+  @Prop({ trim: true, sparse: true })
+  company?: string;
+
 }
 
 export const UserSchema = SchemaFactory.createForClass(User);

src/services/auth.service.ts

@@ -7,6 +7,7 @@ import { RegisterDto } from '@dtos/auth/register.dto';
 import { LoginDto } from '@dtos/auth/login.dto';
 import { MailService } from '@services/mail.service';
 import { RoleRepository } from '@repos/role.repository';
+import { generateUsernameFromName } from '@utils/helper';
 
 type JwtExpiry = SignOptions['expiresIn'];
 
@@ -70,6 +71,11 @@ export class AuthService {
 
 
     async register(dto: RegisterDto) {
+        // Generate username from fname-lname if not provided
+        if (!dto.username || dto.username.trim() === '') {
+            dto.username = generateUsernameFromName(dto.fullname.fname, dto.fullname.lname);
+        }
+
         if (await this.users.findByEmail(dto.email)) throw new Error('Email already in use.');
         if (await this.users.findByUsername(dto.username)) throw new Error('Username already in use.');
         if (dto.phoneNumber && (await this.users.findByPhone(dto.phoneNumber))) {
@@ -89,6 +95,8 @@ export class AuthService {
             email: dto.email,
             phoneNumber: dto.phoneNumber,
             avatar: dto.avatar,
+            jobTitle: dto.jobTitle,
+            company: dto.company,
             password: hashed,
             roles: [userRole._id],
             isVerified: false,

src/services/users.service.ts

@@ -4,6 +4,7 @@ import { UserRepository } from '@repos/user.repository';
 import { RoleRepository } from '@repos/role.repository';
 import { RegisterDto } from '@dtos/auth/register.dto';
 import { Types } from 'mongoose';
+import { generateUsernameFromName } from '@utils/helper';
 
 @Injectable()
 export class UsersService {
@@ -13,6 +14,11 @@ export class UsersService {
     ) { }
 
     async create(dto: RegisterDto) {
+        // Generate username from fname-lname if not provided
+        if (!dto.username || dto.username.trim() === '') {
+            dto.username = generateUsernameFromName(dto.fullname.fname, dto.fullname.lname);
+        }
+
         if (await this.users.findByEmail(dto.email)) throw new Error('Email already in use.');
         if (await this.users.findByUsername(dto.username)) throw new Error('Username already in use.');
         if (dto.phoneNumber && (await this.users.findByPhone(dto.phoneNumber))) {
@@ -28,6 +34,8 @@ export class UsersService {
             email: dto.email,
             phoneNumber: dto.phoneNumber,
             avatar: dto.avatar,
+            jobTitle: dto.jobTitle,
+            company: dto.company,
             password: hashed,
             roles: [],
             isVerified: true,

src/utils/helper.ts

@@ -19,3 +19,7 @@ export function getMillisecondsFromExpiry(expiry: string | number): number {
       return 0;
   }
 }
+
+export function generateUsernameFromName(fname: string, lname: string): string {
+  return `${fname.toLowerCase()}-${lname.toLowerCase()}`;
+}