feat: ✨ (api/user) role プロパティを追加

Author: dino3616

apps/api/src/module/user/controller/dto/enum/user-role.enum.ts

@@ -0,0 +1,9 @@
+import { registerEnumType } from '@nestjs/graphql';
+
+// eslint-disable-next-line no-shadow
+export enum UserRoleEnum {
+  USER = 'USER',
+  OCCUPIER = 'OCCUPIER',
+}
+
+registerEnumType(UserRoleEnum, { name: 'UserRole' });

apps/api/src/module/user/controller/dto/input/user-create.input.ts

@@ -4,7 +4,7 @@ import type { User } from '#api/module/user/domain/user.model';
 
 @InputType()
 export class UserCreateInput
-  implements Omit<User, 'id' | 'hashedFingerprintId' | 'lostAndFoundState' | 'isDiscloseAsOwner' | 'createdAt' | 'isOnTheWay'>
+  implements Omit<User, 'id' | 'hashedFingerprintId' | 'role' | 'lostAndFoundState' | 'isDiscloseAsOwner' | 'createdAt' | 'isOnTheWay'>
 {
   @Field(() => String, { nullable: false })
   @IsUUID()

apps/api/src/module/user/controller/dto/object/user.object.ts

@@ -1,6 +1,7 @@
 import { Field, ID, ObjectType } from '@nestjs/graphql';
 import { IsEmail, IsUUID, IsUrl, MaxLength } from 'class-validator';
 import { UserLostAndFoundStateEnum } from '#api/module/user/controller/dto/enum/user-lost-and-found-state.enum';
+import { UserRoleEnum } from '#api/module/user/controller/dto/enum/user-role.enum';
 import { User } from '#api/module/user/domain/user.model';
 
 @ObjectType(User.name)
@@ -22,6 +23,9 @@ export class UserObject implements Omit<User, 'hashedFingerprintId' | 'isOnTheWa
   @MaxLength(320)
   email!: string;
 
+  @Field(() => UserRoleEnum, { nullable: false })
+  role!: UserRoleEnum;
+
   @Field(() => UserLostAndFoundStateEnum, { nullable: false })
   lostAndFoundState!: UserLostAndFoundStateEnum;
 

apps/api/src/module/user/domain/user.model.ts

@@ -1,3 +1,5 @@
+type UserRole = 'USER' | 'OCCUPIER';
+
 type UserLostAndFoundState = 'NONE' | 'DELIVERING' | 'RETRIEVING';
 
 export class User {
@@ -11,6 +13,8 @@ export class User {
 
   readonly email: string;
 
+  readonly role: UserRole;
+
   readonly lostAndFoundState: UserLostAndFoundState;
 
   readonly avatarUrl: string;
@@ -25,6 +29,7 @@ export class User {
     hashedFingerprintId,
     name,
     email,
+    role,
     lostAndFoundState,
     avatarUrl,
     isDiscloseAsOwner,
@@ -35,6 +40,7 @@ export class User {
     this.hashedFingerprintId = hashedFingerprintId;
     this.name = name;
     this.email = email;
+    this.role = role;
     this.lostAndFoundState = lostAndFoundState;
     this.avatarUrl = avatarUrl;
     this.isDiscloseAsOwner = isDiscloseAsOwner;

apps/api/src/module/user/repository/user.repository.ts

@@ -8,7 +8,9 @@ export interface UserRepositoryInterface {
   findByReportedLostItemId(reportedLostItemId: LostItem['id']): Promise<User | null>;
   findByOwnedLostItemId(ownedLostItemId: LostItem['id']): Promise<User | null>;
   findMany(userIds: User['id'][]): Promise<User[]>;
-  create(user: Omit<User, 'id' | 'hashedFingerprintId' | 'lostAndFoundState' | 'isDiscloseAsOwner' | 'createdAt' | 'isOnTheWay'>): Promise<User>;
+  create(
+    user: Omit<User, 'id' | 'hashedFingerprintId' | 'role' | 'lostAndFoundState' | 'isDiscloseAsOwner' | 'createdAt' | 'isOnTheWay'>,
+  ): Promise<User>;
   update(userId: User['id'], user: Partial<Omit<User, 'id' | 'authId' | 'createdAt' | 'isOnTheWay'>>): Promise<User>;
   updateByAuthId(authId: User['authId'], user: Partial<Omit<User, 'id' | 'authId' | 'createdAt' | 'isOnTheWay'>>): Promise<User>;
   updateByHashedFingerprintId(

apps/api/src/module/user/use-case/user.use-case.ts

@@ -4,7 +4,9 @@ export interface UserUseCaseInterface {
   findUser(authId: User['authId']): Promise<User | null>;
   findUserById(id: User['id']): Promise<User | null>;
   findUserByHashedFingerprintId(hashedFingerprintId: NonNullable<User['hashedFingerprintId']>): Promise<User | null>;
-  createUser(user: Omit<User, 'id' | 'hashedFingerprintId' | 'lostAndFoundState' | 'isDiscloseAsOwner' | 'createdAt' | 'isOnTheWay'>): Promise<User>;
+  createUser(
+    user: Omit<User, 'id' | 'hashedFingerprintId' | 'role' | 'lostAndFoundState' | 'isDiscloseAsOwner' | 'createdAt' | 'isOnTheWay'>,
+  ): Promise<User>;
   updateUserDisclosure(authId: User['authId'], isDiscloseAsOwner: User['isDiscloseAsOwner']): Promise<User>;
   relateFingerprintWithUser(authId: User['authId'], hashedFingerprintId: NonNullable<User['hashedFingerprintId']>): Promise<User>;
 }