user serialization add username, role access for endpoint

Author: andrechristikan

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ack-nestjs-boilerplate",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "Ack NestJs Boilerplate",
   "repository": {
     "type": "git",

src/modules/role/controllers/role.admin.controller.ts

@@ -54,6 +54,7 @@ import {
 } from 'src/modules/role/decorators/role.admin.decorator';
 import { GetRole } from 'src/modules/role/decorators/role.decorator';
 import {
+    RoleAccessForDoc,
     RoleActiveDoc,
     RoleCreateDoc,
     RoleDeleteDoc,
@@ -68,8 +69,10 @@ import { RoleUpdateNameDto } from 'src/modules/role/dtos/role.update-name.dto';
 import { RoleUpdatePermissionDto } from 'src/modules/role/dtos/role.update-permission.dto';
 import { IRoleEntity } from 'src/modules/role/interfaces/role.interface';
 import { RoleEntity } from 'src/modules/role/repository/entities/role.entity';
+import { RoleAccessForSerialization } from 'src/modules/role/serializations/role.access-for.serialization';
 import { RoleGetSerialization } from 'src/modules/role/serializations/role.get.serialization';
 import { RoleListSerialization } from 'src/modules/role/serializations/role.list.serialization';
+import { RoleEnumService } from 'src/modules/role/services/role.enum.service';
 import { RoleService } from 'src/modules/role/services/role.service';
 
 @ApiTags('modules.admin.role')
@@ -81,7 +84,8 @@ export class RoleAdminController {
     constructor(
         private readonly paginationService: PaginationService,
         private readonly permissionService: PermissionService,
-        private readonly roleService: RoleService
+        private readonly roleService: RoleService,
+        private readonly roleEnumService: RoleEnumService
     ) {}
 
     @RoleListDoc()
@@ -382,4 +386,16 @@ export class RoleAdminController {
 
         return;
     }
+
+    @RoleAccessForDoc()
+    @Response('role.accessFor', { serialization: RoleAccessForSerialization })
+    @RequestParamGuard(RoleRequestDto)
+    @AuthPermissionProtected(ENUM_AUTH_PERMISSIONS.ROLE_READ)
+    @AuthJwtAdminAccessProtected()
+    @Get('/access-for')
+    async accessFor(): Promise<IResponse> {
+        const accessFor: string[] = await this.roleEnumService.getAccessFor();
+
+        return { accessFor };
+    }
 }

src/modules/role/docs/role.admin.doc.ts

@@ -10,6 +10,7 @@ import {
     ROLE_DEFAULT_AVAILABLE_SEARCH,
     ROLE_DEFAULT_AVAILABLE_SORT,
 } from 'src/modules/role/constants/role.list.constant';
+import { RoleAccessForSerialization } from 'src/modules/role/serializations/role.access-for.serialization';
 import { RoleGetSerialization } from 'src/modules/role/serializations/role.get.serialization';
 import { RoleListSerialization } from 'src/modules/role/serializations/role.list.serialization';
 
@@ -118,3 +119,15 @@ export function RoleInactiveDoc(): MethodDecorator {
         })
     );
 }
+
+export function RoleAccessForDoc(): MethodDecorator {
+    return applyDecorators(
+        Doc<RoleAccessForSerialization>('role.accessFor', {
+            auth: {
+                jwtAccessToken: true,
+                permissionToken: true,
+            },
+            response: { serialization: RoleAccessForSerialization },
+        })
+    );
+}

src/modules/role/serializations/role.access-for.serialization.ts

@@ -0,0 +1,11 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { ENUM_AUTH_ACCESS_FOR } from 'src/common/auth/constants/auth.enum.constant';
+
+export class RoleAccessForSerialization {
+    @ApiProperty({
+        description: 'Access for role',
+        example: [ENUM_AUTH_ACCESS_FOR.USER, ENUM_AUTH_ACCESS_FOR.ADMIN],
+        required: true,
+    })
+    groups: string[];
+}

src/modules/user/serializations/user.get.serialization.ts

@@ -20,6 +20,11 @@ export class UserGetSerialization {
     })
     readonly email: string;
 
+    @ApiProperty({
+        example: faker.internet.userName(),
+    })
+    readonly username: string;
+
     @ApiProperty({
         example: faker.internet.email(),
     })