FEAT: export users in csv

docsfera.json

@@ -969,6 +969,41 @@
           ]
         }
       },
+      "/users/download": {
+        "get": {
+          "operationId": "UsersController_downloadUsersInCsv",
+          "parameters": [
+            {
+              "name": "dadosfera-lang",
+              "in": "header",
+              "required": false,
+              "schema": {
+                "enum": [
+                  "pt-br",
+                  "en-us"
+                ],
+                "type": "string"
+              }
+            }
+          ],
+          "responses": {
+            "200": {
+              "description": ""
+            }
+          },
+          "tags": [
+            "Users"
+          ],
+          "security": [
+            {
+              "access-token": []
+            },
+            {
+              "access-token": []
+            }
+          ]
+        }
+      },
       "/users/hierarchies": {
         "get": {
           "operationId": "UsersController_getAllHierarchies",

src/modules/users/dtos/entities.ts

@@ -174,3 +174,14 @@ export class GetAllDepartmentsRes {
   @ApiProperty()
   departments: string[];
 }
+
+
+export interface UserReporter {
+  name: string;
+  email: string;
+  mfaStatus: string;
+  status: string;
+  lastLogin: string;
+  createdAt: string;
+  updatedAt: string;
+}

src/modules/users/users.controller.ts

@@ -12,6 +12,7 @@ import {
   Post,
   Put,
   Query,
+  Res,
   UseFilters,
 } from '@nestjs/common';
 import {
@@ -24,6 +25,7 @@ import { PERMISSIONS_GROUPS } from 'src/authentication/permissions.enum';
 import {
   Authenticated,
   RequireAllPermissions,
+  RequireSomePermission,
 } from 'src/decorators/authentication.decorator';
 import { Language } from 'src/decorators/language.decorator';
 import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator';
@@ -52,6 +54,7 @@ import {
   UpdateUserRes,
 } from './dtos/entities';
 import { UsersService } from './users.service';
+import { Response } from 'express';
 
 @ApiInternalOnlyController()
 @ApiTags('Users')
@@ -80,6 +83,26 @@ export class UsersController {
     return await this.userService.findAllUsersByCustomerId(user.customer_id);
   }
 
+  @Get('/download')
+  @RequireSomePermission(PERMISSIONS_GROUPS.USERS.permissions.ADMIN)
+  async downloadUsersInCsv(
+    @User() user: RequestUser,
+    @Language() language: LanguageEnum,
+    @Res() res: Response
+  ) {
+    this.logger.info('downloadUsersInCsv');
+    this.userService.setLanguage(language);
+    const {
+      file,
+      filename
+    } = await this.userService.downloadUsersInCsv(user.customer_id);
+
+    res.setHeader('Content-Disposition', `attachment; filename="${filename}"`);
+    res.setHeader('Content-Type', 'text/csv');
+
+    res.end(file);
+  }
+
   @Get('hierarchies')
   @RequireAllPermissions(PERMISSIONS_GROUPS.USERS.permissions.ADMIN)
   @ApiOkResponse({ type: GetAllHierarchiesRes })

src/modules/users/users.service.ts

@@ -21,6 +21,7 @@ import {
   IUserByCustomer,
   SetUserRolesReq,
   UpdateUserReq,
+  UserReporter,
 } from './dtos/entities';
 import { RolesService } from '../roles/roles.service';
 import { HIERARCHIES } from './hierarchies';
@@ -29,6 +30,7 @@ import { UserByCustomer } from '@dadosfera/protospack-v2/dist/lib/Duc/interfaces
 import { EnrichErrorCode } from 'src/utils/ErrorBuilder';
 import { DucClient } from '../duc/client.config';
 import { Metadata } from '@grpc/grpc-js';
+import { ParserBuilder } from 'src/utils/FileParser/parser.builder';
 
 @Injectable()
 export class UsersService implements OnModuleInit {
@@ -78,6 +80,34 @@ export class UsersService implements OnModuleInit {
     };
   }
 
+  async downloadUsersInCsv(customerId: string) {
+    const { users } = await lastValueFrom(
+      this.usersClientService.UserFindAllByCustomerId({ customerId }),
+    );
+
+    const formatUsers: UserReporter[] = users.map(user => ({
+      createdAt: user.createdAt,
+      email: user.email,
+      lastLogin: user.lastLogin,
+      mfaStatus: user.mfaStatus,
+      name: user.name,
+      status: user.status,
+      updatedAt: user.updatedAt
+    }))
+
+    const parser = ParserBuilder.build<UserReporter>('csv');
+
+    const file = await parser.parse(formatUsers);
+
+    const timestamp = new Date().toISOString().replace(/[:.]/g, '-');
+    const filename = `dadosfera-users-${timestamp}.csv`;
+
+    return {
+      file,
+      filename
+    }
+  }
+
   async findOneById(id: string): Promise<{ user: IUserByCustomer }> {
     const { user } = await lastValueFrom(
       this.usersClientService.UserFindOneById({ id }),