Update validation and DTO for employeeNumber field in inetOrgPerson

Author: tacxou

docs/technical/Tests.md

@@ -95,6 +95,7 @@ export const inetOrgPersonDtoStub = (): inetOrgPersonDto => {
     cn: 'cn',
     sn: 'sn',
     uid: 'uid',
+    employeeNumber: 'employeeNumber',
     displayName: 'displayName',
     facsimileTelephoneNumber: 'facsimileTelephoneNumber',
     givenName: 'givenName',

docs/user/IdentitiesCreation.md

@@ -42,12 +42,13 @@ Lors de la création d'une identité, le corps de la requête doit inclure les i
 
 #### Informations de Base (`inetOrgPerson`)
 
-Les informations de base de l'identité sont définies dans l'objet `inetOrgPerson`. Les champs requis sont `cn` (Nom Commun), `sn` (Nom de Famille), et `uid` (Identifiant Unique). Ces champs sont validés en dur.
+Les informations de base de l'identité sont définies dans l'objet `inetOrgPerson`. Les champs requis sont `cn` (Nom Commun), `sn` (Nom de Famille), `uid` (Identifiant Unique), et `employeeNumber` (Identifiant Identité). Ces champs sont validés en dur.
 
 ##### Champs obligatoires :
 - `cn`  
 - `sn`
 - `uid`
+- `employeeNumber`
 
 ##### Champs facultatifs :
 - `displayName`
@@ -92,7 +93,8 @@ Voici un exemple de corps de requête pour la création d'une identité avec les
   "inetOrgPerson": {
     "cn": "Nom Commun",
     "sn": "Nom de Famille",
-    "uid": "Identifiant Unique"
+    "uid": "Identifiant Unique",
+    "employeeNumber": "Identifiant Identité"
   },
   "additionalFields": {
     "objectClasses": ["supann"],
@@ -118,7 +120,8 @@ curl -X POST "http://<adresse-du-serveur>/identities" \
            "inetOrgPerson": {
              "cn": "Nom Commun",
              "sn": "Nom de Famille",
-             "uid": "Identifiant Unique"
+             "uid": "Identifiant Unique",
+             "employeeNumber": "Identifiant Identité"
            },
            "additionalFields": {
              "objectClasses": ["supann"],
@@ -160,15 +163,16 @@ Même procédure pour la validation, mais ici nous avons :
 
 ### Corps de la Requête (Body)
 
-Lors de la création d'une identité, le corps de la requête doit inclure au moins la données (`inetOrgPerson.uid`), ainsi que tout champ additionnel nécessaire selon l'`objectClass` spécifique. Notez que l'objet `inetOrgPerson` est validé en dur et non via un fichier YAML.
+Lors de la création d'une identité, le corps de la requête doit inclure au moins la données (`inetOrgPerson.uid`) et (`inetOrgPerson.employeeNumber`), ainsi que tout champ additionnel nécessaire selon l'`objectClass` spécifique. Notez que l'objet `inetOrgPerson` est validé en dur et non via un fichier YAML.
 
 De plus pour une modification, il specifier le state a `-1`
 
   ```json
   {
     "state": -1,
     "inetOrgPerson": {
-      "uid": "Identifiant Unique"
+      "uid": "Identifiant Unique",
+      "employeeNumber": "Identifiant Identite"
     },
     "additionalFields": {
       "objectClasses": ["supann"],
@@ -190,7 +194,8 @@ De plus pour une modification, il specifier le state a `-1`
        -d '{
              "state": -1,
              "inetOrgPerson": {
-               "uid": "Identifiant Unique"
+               "uid": "Identifiant Unique",
+               "employeeNumber": "Identifiant Identite"
              },
              "additionalFields": {
                "objectClasses": ["supann"],

docs/user/IdentitiesValidation.md

@@ -13,6 +13,7 @@ Les champs de base de l'objet `inetOrgPerson` sont validés par défaut.
 - `cn`  
 - `sn`
 - `uid`
+- `employeeNumber`
 
 ### Champs facultatifs :
 - `displayName`

src/management/identities/_dto/_parts/inetOrgPerson.dto.ts

@@ -8,8 +8,7 @@ export class inetOrgPersonCreateDto {
 
   @IsString()
   @ApiProperty()
-  @IsOptional()
-  cn?: string;
+  employeeNumber: string;
 
   @IsString()
   @ApiProperty()
@@ -78,6 +77,6 @@ export class inetOrgPersonCreateDto {
   userPassword?: string;
 }
 
-export class inetOrgPersonDto extends inetOrgPersonCreateDto {}
+export class inetOrgPersonDto extends inetOrgPersonCreateDto { }
 
-export class inetOrgPersonUpdateDto extends PartialType(inetOrgPersonCreateDto) {}
+export class inetOrgPersonUpdateDto extends PartialType(inetOrgPersonCreateDto) { }

src/management/identities/_schemas/_parts/inetOrgPerson.part.ts

@@ -41,6 +41,9 @@ export class inetOrgPerson {
   @Prop({ required: true, unique: true })
   uid: string;
 
+  @Prop({ required: true, unique: true })
+  employeeNumber: string;
+
   @Prop()
   userCertificate?: string;
 

src/management/identities/_stubs/_parts/inetOrgPerson.dto.stub.ts

@@ -5,6 +5,7 @@ export const inetOrgPersonDtoStub = (): inetOrgPersonDto => {
     cn: 'cn',
     sn: 'sn',
     uid: 'uid',
+    employeeNumber: 'employeeNumber',
     displayName: 'displayName',
     facsimileTelephoneNumber: 'facsimileTelephoneNumber',
     givenName: 'givenName',

src/management/identities/identities.service.ts

@@ -1,4 +1,3 @@
-import { inetOrgPerson } from './_schemas/_parts/inetOrgPerson.part';
 import { HttpException, Injectable, Logger } from '@nestjs/common';
 import { InjectModel } from '@nestjs/mongoose';
 import { Identities } from './_schemas/identities.schema';
@@ -52,7 +51,6 @@ export class IdentitiesService extends AbstractServiceSchema {
     }
 
     //TODO: ameliorer la logique d'upsert
-
     if (identity) {
       this.logger.log(`${logPrefix} Identity already exists. Updating.`);
       data.inetOrgPerson = {
@@ -72,6 +70,7 @@ export class IdentitiesService extends AbstractServiceSchema {
       };
     }
 
+    //TODO: rechercher par uid ou employeeNumber ?
     const upsert = await super.upsert({ 'inetOrgPerson.uid': data.inetOrgPerson.uid }, data, options);
     return upsert;
     //TODO: add backends service logic here

src/management/identities/jsonforms/_config/inetorgperson.ui.yml

@@ -28,6 +28,14 @@
           "options": {
             "required": true
           }
+        },
+        {
+          "type": "Control",
+          "label": "EmployeeNumber",
+          "scope": "#/properties/employeeNumber",
+          "options": {
+            "required": true
+          }
         }
       ]
     },

src/management/identities/validations/_config/inetorgperson.yml

@@ -14,6 +14,10 @@
       "type": "string",
       "description": "UID of the inetOrgPerson."
     },
+    "employeeNumber": {
+      "type": "string",
+      "description": "EmployeeNumber of the inetOrgPerson."
+    },
     "displayName": {
       "type": "string",
       "description": "Display name of the inetOrgPerson."
@@ -64,5 +68,5 @@
       "description": "User password of the inetOrgPerson."
     }
   },
-  "required": ["uid"]
+  "required": ["uid", "employeeNumber"]
 }

src/management/passwd/passwd.controller.ts

@@ -13,7 +13,7 @@ import { ResetPasswordDto } from './dto/reset-password.dto';
 export class PasswdController {
   private readonly logger = new Logger(PasswdController.name);
 
-  public constructor(private passwdService: PasswdService) {}
+  public constructor(private passwdService: PasswdService) { }
 
   @Post('change')
   @ApiOperation({ summary: 'change password' })
@@ -24,6 +24,7 @@ export class PasswdController {
   public async change(@Body() cpwd: ChangePasswordDto, @Res() res: Response): Promise<Response> {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const [_, data] = await this.passwdService.change(cpwd);
+    //TODO: uid ou employeeNumber ?
     data.data.uid = cpwd.id;
     this.logger.log(`call passwd change for : ${cpwd.id}`);