feat(backend): add new role 'agent'

Author: pYassine

packages/backend/src/_common/model/users/user-structure/constants/USER_STRUCTURE_ROLES_NOT_FACTEUR.ts

@@ -0,0 +1,8 @@
+import { UserStructureRole } from "@domifa/common";
+
+export const USER_STRUCTURE_ROLES_NOT_FACTEUR: UserStructureRole[] = [
+  "simple",
+  "admin",
+  "agent",
+  "responsable",
+];

packages/backend/src/_common/model/users/user-structure/constants/USER_STRUCTURE_ROLE_ALL.const.ts

@@ -4,5 +4,6 @@ export const USER_STRUCTURE_ROLE_ALL: UserStructureRole[] = [
   "simple",
   "admin",
   "facteur",
+  "agent",
   "responsable",
 ];

packages/backend/src/_common/model/users/user-structure/constants/index.ts

@@ -1,2 +1,3 @@
 // @index('./*', f => `export * from '${f.path}'`)
 export * from "./USER_STRUCTURE_ROLE_ALL.const";
+export * from "./USER_STRUCTURE_ROLES_NOT_FACTEUR";

packages/backend/src/auth/guards/usager-doc-access.guard.ts

@@ -30,7 +30,7 @@ export class UsagerDocAccessGuard implements CanActivate {
       throw new HttpException("USAGER_DOC_NOT_FOUND", HttpStatus.BAD_REQUEST);
     }
 
-    if (user?.role === "facteur") {
+    if (user?.role === "facteur" || user?.role === "agent") {
       throw new HttpException("CANNOT_GET_DOC", HttpStatus.UNAUTHORIZED);
     }
 

packages/backend/src/auth/structures-auth.controller.ts

@@ -29,6 +29,7 @@ import { domifaConfig } from "../config";
 import { userSecurityPasswordChecker } from "../modules/users/services";
 import { AllowUserStructureRoles } from "./decorators";
 import { UserStructure } from "@domifa/common";
+import { appLogger } from "../util";
 
 const userProfile: UserProfile = "structure";
 
@@ -55,6 +56,7 @@ export class StructuresAuthController {
 
       return res.status(HttpStatus.OK).json(accessToken);
     } catch (err) {
+      appLogger.error(err);
       return res
         .status(HttpStatus.UNAUTHORIZED)
         .json({ message: "LOGIN_FAILED" });

packages/backend/src/modules/portail-admin/dto/register-user-structure-admin.dto.ts

@@ -12,6 +12,7 @@ import {
 import { Transform, TransformFnParams } from "class-transformer";
 import { LowerCaseTransform } from "../../../_common/decorators";
 import { UserStructureRole, UserFonction } from "@domifa/common";
+import { USER_STRUCTURE_ROLE_ALL } from "../../../_common/model";
 
 export class RegisterUserStructureAdminDto {
   @ApiProperty({
@@ -78,10 +79,10 @@ export class RegisterUserStructureAdminDto {
   @ApiProperty({
     type: String,
     required: true,
-    enum: ["admin", "simple", "facteur", "responsable"],
+    enum: USER_STRUCTURE_ROLE_ALL,
   })
   @IsNotEmpty()
-  @IsIn(["admin", "simple", "facteur", "responsable"])
+  @IsIn(USER_STRUCTURE_ROLE_ALL)
   public readonly role!: UserStructureRole;
 
   @IsNotEmpty()

packages/backend/src/modules/portail-usagers/controllers/portail-usagers-manager/portail-usagers-manager.controller.ts

@@ -53,7 +53,7 @@ import * as XLSX from "xlsx";
 @ApiTags("portail-usagers-manager")
 @UseGuards(AuthGuard("jwt"), AppUserGuard)
 @AllowUserProfiles("structure")
-@AllowUserStructureRoles(...USER_STRUCTURE_ROLE_ALL)
+@AllowUserStructureRoles("responsable", "admin")
 @ApiBearerAuth()
 export class PortailUsagersManagerController {
   constructor(private readonly appLogsService: AppLogsService) {}
@@ -114,15 +114,13 @@ export class PortailUsagersManagerController {
     }
   }
 
-  @AllowUserStructureRoles(...USER_STRUCTURE_ROLE_ALL)
   @Get("stats")
   public async getUserUsagerStats(
     @CurrentUser() currentUser: UserStructureAuthenticated
   ): Promise<UsagersCountByStatus> {
     return usagerRepository.countUsagersByStatus(currentUser.structureId, true);
   }
 
-  @AllowUserStructureRoles(...USER_STRUCTURE_ROLE_ALL)
   @Get("export/all-accounts")
   public async exportAccountsToExcel(
     @Res() res: Response,
@@ -197,7 +195,6 @@ export class PortailUsagersManagerController {
     res.send(excelBuffer);
   }
 
-  @AllowUserStructureRoles("admin", "responsable")
   @Get("generate-all-accounts")
   public async generateAllAccounts(
     @Res() res: Response,
@@ -272,9 +269,9 @@ export class PortailUsagersManagerController {
   }
 
   @UseGuards(UsagerAccessGuard)
-  @AllowUserStructureRoles("simple", "responsable", "admin")
+  @AllowUserStructureRoles("simple", "responsable", "admin", "agent")
   @Post("enable-access/:usagerRef")
-  public async editPreupdatePortailUsagerOptionsference(
+  public async enablePortailForUsager(
     @Res() res: Response,
     @Body() dto: UpdatePortailUsagerOptionsDto,
     @CurrentUsager() usager: Usager,
@@ -333,7 +330,6 @@ export class PortailUsagersManagerController {
     }
   }
 
-  @AllowUserStructureRoles(...USER_STRUCTURE_ROLE_ALL)
   @Post("all-accounts")
   public async getAllAccounts(
     @Body() pageOptionsDto: PageOptionsDto,

packages/backend/src/modules/structures/controllers/structure-doc.controller.ts

@@ -37,6 +37,7 @@ import { join } from "path";
 import { FileManagerService } from "../../../util/file-manager/file-manager.service";
 import { validateDocTemplate } from "../../../usagers/utils/custom-docs";
 import { StructureDocTypesAvailable } from "@domifa/common";
+import { appLogger } from "../../../util";
 
 @ApiTags("structure-docs")
 @ApiBearerAuth()
@@ -171,7 +172,8 @@ export class StructureDocController {
       });
 
       return res.status(HttpStatus.OK).json(docs);
-    } catch (e) {
+    } catch (err) {
+      appLogger.error(err);
       return res
         .status(HttpStatus.BAD_REQUEST)
         .json({ message: "UPLOAD_FAIL" });
@@ -211,7 +213,8 @@ export class StructureDocController {
         structureId: user.structureId,
       });
       return res.status(HttpStatus.OK).json(docs);
-    } catch (e) {
+    } catch (err) {
+      appLogger.error(err);
       return res
         .status(HttpStatus.BAD_REQUEST)
         .json({ message: "DOC_NOT_FOUND" });

packages/backend/src/modules/users/controllers/users.controller.ts

@@ -52,6 +52,7 @@ import {
   UserStructureCreateLogContext,
   UserStructureRoleChangeLogContext,
 } from "../../app-logs/app-log-context.types";
+import { appLogger } from "../../../util";
 
 const userProfile: UserProfile = "structure";
 
@@ -62,16 +63,19 @@ const userProfile: UserProfile = "structure";
 @UseGuards(AuthGuard("jwt"), AppUserGuard)
 export class UsersController {
   constructor(private readonly appLogService: AppLogsService) {}
-  @ApiBearerAuth()
-  @ApiOperation({ summary: "Liste des utilisateurs" })
+
   @Get("")
   public async getUsers(
     @CurrentUser() user: UserStructureAuthenticated
   ): Promise<UserStructureProfile[]> {
     const users = await userStructureRepository.getVerifiedUsersByStructureId(
       user.structureId
     );
-    if (user.role === "facteur" || user.role === "simple") {
+    if (
+      user.role === "facteur" ||
+      user.role === "agent" ||
+      user.role === "simple"
+    ) {
       return users.map((user) => {
         return {
           id: user.id,
@@ -83,7 +87,6 @@ export class UsersController {
     return users;
   }
 
-  @ApiOperation({ summary: "Accepter les CGU" })
   @Get("accept-terms")
   public async acceptTerms(@CurrentUser() user: UserStructureAuthenticated) {
     await userStructureRepository.update(
@@ -100,7 +103,6 @@ export class UsersController {
     return true;
   }
 
-  @ApiOperation({ summary: "Edition du mot de passe depuis le compte user" })
   @Get("last-password-update")
   public async getLastPasswordUpdate(
     @CurrentUser() user: UserStructureAuthenticated,
@@ -115,8 +117,6 @@ export class UsersController {
   }
 
   @AllowUserStructureRoles("admin")
-  @ApiBearerAuth("Administrateurs")
-  @ApiOperation({ summary: "Editer le rôle d'un utilisateur" })
   @UseGuards(CanGetUserStructureGuard)
   @Patch("update-role/:userUuid")
   public async updateRole(
@@ -234,6 +234,7 @@ export class UsersController {
   }
 
   @Patch()
+  @ApiOperation({ summary: "Modifier mes informations" })
   public async patch(
     @CurrentUser() user: UserStructureAuthenticated,
     @Body() userDto: UserEditDto,
@@ -338,6 +339,7 @@ export class UsersController {
       });
       return res.status(HttpStatus.OK).json({ message: "OK" });
     } catch (err) {
+      appLogger.error(err);
       return res
         .status(HttpStatus.BAD_REQUEST)
         .json({ message: "EDIT_PASSWORD_FAIL" });

packages/backend/src/modules/users/controllers/users.public.controller.ts

@@ -25,6 +25,7 @@ const userProfile: UserProfile = "structure";
 @Controller("users")
 @ApiTags("users")
 export class UsersPublicController {
+  // TODO: add a limit for this endpoint by ip
   @Post("validate-email")
   public async validateEmail(
     @Body() emailDto: EmailDto,
@@ -57,6 +58,7 @@ export class UsersPublicController {
       });
       return res.status(HttpStatus.OK).json({ message: "OK" });
     } catch (err) {
+      appLogger.error(err);
       return res
         .status(HttpStatus.BAD_REQUEST)
         .json({ message: "TOKEN_INVALID" });
@@ -77,6 +79,7 @@ export class UsersPublicController {
       });
       return res.status(HttpStatus.OK).json({ message: "OK" });
     } catch (err) {
+      appLogger.error(err);
       return res
         .status(HttpStatus.BAD_REQUEST)
         .json({ message: "TOKEN_INVALID" });
@@ -101,7 +104,7 @@ export class UsersPublicController {
         userProfile,
       });
     } catch (err) {
-      appLogger.error("Cannot reset password");
+      appLogger.error(err);
     }
     return res.status(HttpStatus.OK).json({ message: "OK" });
   }