Refactor lifecycle management: update lifecycle enums, DTOs, and schemas; add custom states and rules configuration

tacxou · tacxou · commit fb50bbe243a7 · 2025-10-01T11:51:15.000+02:00
diff --git a/configs/lifecycle/.gitignore b/configs/lifecycle/.gitignore
@@ -1,2 +1,3 @@
 *
+!rules/
 !.gitignore
diff --git a/configs/lifecycle/rules/.gitignore b/configs/lifecycle/rules/.gitignore
@@ -0,0 +1,2 @@
+*
+!.gitignore
diff --git a/defaults/lifecycle/rules/example.yml.template b/defaults/lifecycle/rules/example.yml.template
@@ -4,5 +4,5 @@ identities:
     #   'inetOrgPerson.employeeType': 'etd',
     #   lastSyncBackup: { $ne : null }
     # }
-    # trigger: null
+    # trigger: 30d
     target: D
diff --git a/defaults/lifecycle/states.yml b/defaults/lifecycle/states.yml
@@ -0,0 +1,20 @@
+states:
+  # En Attente -> supannRessourceEtat : {COMPTE} A SupannAnticipe
+  - key: A
+    label: "En Attente"
+    description: "supannRessourceEtat : {COMPTE} A SupannAnticipe"
+
+  # PROV -> supannResourceEtat : {COMTE} A SupannSursis et supannRessourceEtatDate: Date de passage en PROV
+  - key: P
+    label: "PROV"
+    description: "supannResourceEtat : {COMTE} A SupannSursis et supannRessourceEtatDate: Date de passage en PROV"
+
+  # A Détruire -> supannRessourceEtat : {COMPTE} I SupannSupprCompte
+  - key: D
+    label: "A Détruire"
+    description: "supannRessourceEtat : {COMPTE} I SupannSupprCompte"
+
+  # Verrouillé -> supannRessourceEtat : {COMPTE} S SupannVerrouille
+  - key: V
+    label: "Verrouillé"
+    description: "supannRessourceEtat : {COMPTE} S SupannVerrouille"
diff --git a/src/management/identities/_dto/identities.dto.ts b/src/management/identities/_dto/identities.dto.ts
@@ -2,7 +2,7 @@ import { ApiProperty, IntersectionType, PartialType } from '@nestjs/swagger';
 import { IsOptional, IsObject, IsEnum, IsNumber, ValidateNested, IsString } from 'class-validator';
 import { inetOrgPersonDto } from './_parts/inetOrgPerson.dto';
 import { IdentityState } from '../_enums/states.enum';
-import { IdentityLifecycle } from '../_enums/lifecycle.enum';
+import { IdentityLifecycleDefault } from '../_enums/lifecycle.enum';
 import { Type } from 'class-transformer';
 import { additionalFieldsPartDto } from './_parts/additionalFields.dto';
 import { MetadataDto } from '~/_common/abstracts/dto/metadata.dto';
@@ -31,8 +31,7 @@ export class IdentitiesCreateDto extends IntersectionType(CustomFieldsDto, Metad
 
   @IsString()
   @IsOptional()
-  @IsEnum(IdentityLifecycle)
-  @ApiProperty({ enum: IdentityLifecycle })
+  @ApiProperty({ enum: IdentityLifecycleDefault })
   public lifecycle: string;
 
   @IsObject()
diff --git a/src/management/identities/_enums/lifecycle.enum.ts b/src/management/identities/_enums/lifecycle.enum.ts
@@ -1,4 +1,4 @@
-export enum IdentityLifecycle {
+export enum IdentityLifecycleDefault {
   OFFICIAL = "O",
   INACTIVE = "I",
   MANUAL = "M",
diff --git a/src/management/identities/_schemas/identities.schema.ts b/src/management/identities/_schemas/identities.schema.ts
@@ -1,4 +1,4 @@
-import { IdentityLifecycle } from './../_enums/lifecycle.enum';
+import { IdentityLifecycleDefault } from './../_enums/lifecycle.enum';
 import { inetOrgPerson, inetOrgPersonSchema } from './_parts/inetOrgPerson.part';
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
 import { Document, Types } from 'mongoose';
@@ -20,8 +20,8 @@ export class Identities extends AbstractSchema {
   @Prop({ type: Number, enum: IdentityState, default: IdentityState.TO_CREATE })
   public state: IdentityState;
 
-  @Prop({ type: String, enum: IdentityLifecycle, default: IdentityLifecycle.OFFICIAL })
-  public lifecycle: IdentityLifecycle;
+  @Prop({ type: String, default: IdentityLifecycleDefault.OFFICIAL })
+  public lifecycle: IdentityLifecycleDefault | string;
 
   @Prop({ type: Number, enum: DataStatusEnum, default: DataStatusEnum.NOTINITIALIZED })
   public dataStatus: DataStatusEnum;
diff --git a/src/management/identities/_stubs/identities.dto.stub.ts b/src/management/identities/_stubs/identities.dto.stub.ts
@@ -1,6 +1,6 @@
 import { IdentitiesUpdateDto } from './../_dto/identities.dto';
 import { IdentitiesDto } from '~/management/identities/_dto/identities.dto';
-import { IdentityLifecycle } from '~/management/identities/_enums/lifecycle.enum';
+import { IdentityLifecycleDefault } from '~/management/identities/_enums/lifecycle.enum';
 import { IdentityState } from '~/management/identities/_enums/states.enum';
 import { additionalFieldsPartDtoStub } from './_parts/addtionalFields.dto.stub';
 import { inetOrgPersonDtoStub } from './_parts/inetOrgPerson.dto.stub';
@@ -10,7 +10,7 @@ import { DataStatusEnum } from '~/management/identities/_enums/data-status';
 export const IdentitiesDtoStub = (): IdentitiesDto => {
   return {
     state: IdentityState.TO_CREATE,
-    lifecycle: IdentityLifecycle.INACTIVE,
+    lifecycle: IdentityLifecycleDefault.INACTIVE,
     inetOrgPerson: inetOrgPersonDtoStub(),
     additionalFields: additionalFieldsPartDtoStub(),
     initState: InitStatesEnum.NOSENT,
@@ -23,7 +23,7 @@ export const IdentitiesUpdateDtoStub = (): IdentitiesUpdateDto => {
   inetOrgPerson.cn = 'updated-cn';
   return {
     state: IdentityState.TO_COMPLETE,
-    lifecycle: IdentityLifecycle.INACTIVE,
+    lifecycle: IdentityLifecycleDefault.INACTIVE,
     initState: InitStatesEnum.NOSENT,
     dataStatus: DataStatusEnum.ACTIVE,
     inetOrgPerson,
diff --git a/src/management/lifecycle/_dto/config-rules.dto.ts b/src/management/lifecycle/_dto/config-rules.dto.ts
@@ -1,7 +1,7 @@
 import { ApiProperty } from '@nestjs/swagger';
 import { Type, Transform } from 'class-transformer';
-import { IsArray, IsEnum, IsNegative, IsNotEmpty, IsNumber, IsObject, IsOptional, ValidateNested, registerDecorator, ValidationOptions, ValidationArguments, isString, isNumber, IsString } from 'class-validator';
-import { IdentityLifecycle } from '~/management/identities/_enums/lifecycle.enum';
+import { IsArray, IsNotEmpty, IsNumber, IsObject, IsOptional, ValidateNested, registerDecorator, ValidationOptions, ValidationArguments, isString, isNumber, IsString } from 'class-validator';
+import { IdentityLifecycleDefault } from '~/management/identities/_enums/lifecycle.enum';
 
 /**
  * Transform trigger values to seconds.
@@ -102,7 +102,7 @@ function ValidateRulesOrTrigger(validationOptions?: ValidationOptions) {
       options: validationOptions,
       validator: {
         validate(_: any, args: ValidationArguments) {
-          const obj = args.object as ConfigObjectIdentitiesDTO;
+          const obj = args.object as ConfigRulesObjectIdentitiesDTO;
 
           /**
            * Check if either 'rules' or 'trigger' is defined and not empty.
@@ -122,16 +122,15 @@ function ValidateRulesOrTrigger(validationOptions?: ValidationOptions) {
 }
 
 @ValidateRulesOrTrigger({ message: 'Either rules or trigger must be provided' })
-export class ConfigObjectIdentitiesDTO {
-  @IsEnum(IdentityLifecycle, { each: true })
+export class ConfigRulesObjectIdentitiesDTO {
   @ApiProperty({
     type: String,
-    enum: IdentityLifecycle,
+    enum: IdentityLifecycleDefault,
     description: 'Lifecycle state of the identity',
-    example: IdentityLifecycle.OFFICIAL,
+    example: IdentityLifecycleDefault.OFFICIAL,
     required: true,
   })
-  public sources: IdentityLifecycle[];
+  public sources: IdentityLifecycleDefault[];
 
   @IsOptional()
   @IsString()
@@ -160,25 +159,24 @@ export class ConfigObjectIdentitiesDTO {
   public trigger: number;
 
   @IsNotEmpty()
-  @IsEnum(IdentityLifecycle)
   @ApiProperty({
     type: String,
-    enum: IdentityLifecycle,
+    enum: IdentityLifecycleDefault,
     description: 'Target lifecycle state for the identity',
-    example: IdentityLifecycle.MANUAL,
+    example: IdentityLifecycleDefault.MANUAL,
     required: true,
   })
-  public target: IdentityLifecycle;
+  public target: IdentityLifecycleDefault;
 }
 
-export class ConfigObjectSchemaDTO {
+export class ConfigRulesObjectSchemaDTO {
   @IsOptional()
   @IsArray()
   @ApiProperty({
-    type: ConfigObjectIdentitiesDTO,
+    type: ConfigRulesObjectIdentitiesDTO,
     required: false,
   })
   @ValidateNested({ each: true })
-  @Type(() => ConfigObjectIdentitiesDTO)
-  public identities: ConfigObjectIdentitiesDTO[]
+  @Type(() => ConfigRulesObjectIdentitiesDTO)
+  public identities: ConfigRulesObjectIdentitiesDTO[]
 }
diff --git a/src/management/lifecycle/_dto/config-states.dto.ts b/src/management/lifecycle/_dto/config-states.dto.ts
@@ -0,0 +1,56 @@
+import { ApiProperty } from '@nestjs/swagger';
+import { IsArray, IsNotEmpty, IsString, ValidateNested } from 'class-validator';
+import { Type } from 'class-transformer';
+
+/**
+ * DTO pour un état de cycle de vie individuel
+ * Basé sur la structure du fichier states.yml
+ */
+export class LifecycleStateDTO {
+  @IsNotEmpty()
+  @IsString()
+  @ApiProperty({
+    type: String,
+    description: 'Clé unique de l\'état (une seule lettre)',
+    example: 'A',
+    maxLength: 1,
+    required: true,
+  })
+  public key: string;
+
+  @IsNotEmpty()
+  @IsString()
+  @ApiProperty({
+    type: String,
+    description: 'Label/nom de l\'état',
+    example: 'En Attente',
+    required: true,
+  })
+  public label: string;
+
+  @IsNotEmpty()
+  @IsString()
+  @ApiProperty({
+    type: String,
+    description: 'Description détaillée de l\'état avec correspondances supann',
+    example: 'supannRessourceEtat : {COMPTE} A SupannAnticipe',
+    required: true,
+  })
+  public description: string;
+}
+
+/**
+ * DTO pour la configuration des états de cycle de vie
+ * Correspond à la structure du fichier configs/lifecycle/states.yml
+ */
+export class ConfigStatesDTO {
+  @IsArray()
+  @ValidateNested({ each: true })
+  @Type(() => LifecycleStateDTO)
+  @ApiProperty({
+    type: [LifecycleStateDTO],
+    description: 'Liste des états de cycle de vie disponibles',
+    required: true,
+  })
+  public states: LifecycleStateDTO[];
+}
diff --git a/src/management/lifecycle/_dto/lifecycle.dto.ts b/src/management/lifecycle/_dto/lifecycle.dto.ts
@@ -1,7 +1,7 @@
 import { ApiProperty, PartialType } from '@nestjs/swagger';
-import { IsDateString, IsEnum, IsMongoId, IsNotEmpty } from 'class-validator';
+import { IsDateString, IsMongoId, IsNotEmpty } from 'class-validator';
 import { Types } from 'mongoose';
-import { IdentityLifecycle } from '~/management/identities/_enums/lifecycle.enum';
+import { IdentityLifecycleDefault } from '~/management/identities/_enums/lifecycle.enum';
 
 export class LifecycleCreateDto {
   @ApiProperty({
@@ -13,11 +13,10 @@ export class LifecycleCreateDto {
 
   @ApiProperty({
     description: 'Lifecycle state',
-    enum: IdentityLifecycle,
+    enum: IdentityLifecycleDefault,
   })
-  @IsEnum(IdentityLifecycle)
   @IsNotEmpty()
-  public lifecycle: IdentityLifecycle;
+  public lifecycle: IdentityLifecycleDefault | string;
 
   @ApiProperty({
     description: 'Date of the lifecycle event',
diff --git a/src/management/lifecycle/_schemas/lifecycle.schema.ts b/src/management/lifecycle/_schemas/lifecycle.schema.ts
@@ -1,7 +1,7 @@
 import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
 import { Document, Types } from 'mongoose';
 import { AbstractSchema } from '~/_common/abstracts/schemas/abstract.schema';
-import { IdentityLifecycle } from '~/management/identities/_enums/lifecycle.enum';
+import { IdentityLifecycleDefault } from '~/management/identities/_enums/lifecycle.enum';
 
 export type LifecycleDocument = Lifecycle & Document;
 
@@ -18,10 +18,9 @@ export class Lifecycle extends AbstractSchema {
 
   @Prop({
     type: String,
-    enum: IdentityLifecycle,
     required: true,
   })
-  public lifecycle: IdentityLifecycle;
+  public lifecycle: IdentityLifecycleDefault | string;
 
   @Prop({
     type: Date,
diff --git a/src/management/lifecycle/lifecycle.controller.ts b/src/management/lifecycle/lifecycle.controller.ts
@@ -47,10 +47,9 @@ export class LifecycleController extends AbstractController {
   }
 
   /**
-   * Get lifecycle history for an agent
+   * Get lifecycle statistics
    *
-   * @param agentId - The ID of the agent to retrieve lifecycle history for
-   * @returns A response containing the lifecycle history of the specified agent
+   * @returns A response containing lifecycle statistics
    */
   @ApiOperation({ summary: 'Get lifecycle statistics' })
   @Get('stats')
@@ -63,6 +62,44 @@ export class LifecycleController extends AbstractController {
     });
   }
 
+  /**
+   * Get all available lifecycle states
+   *
+   * @returns A response containing all available lifecycle states (default + custom)
+   */
+  @ApiOperation({ 
+    summary: 'Get all available lifecycle states',
+    description: 'Returns all lifecycle states including default states from enum and custom states from configuration'
+  })
+  @Get('states')
+  public async getAllStates(
+    @Res() res: Response,
+  ): Promise<Response<Array<{ key: string; label: string; description: string }>>> {
+    return res.status(HttpStatus.OK).json({
+      statusCode: HttpStatus.OK,
+      data: this._service.getAllAvailableStates(),
+    });
+  }
+
+  /**
+   * Get only custom lifecycle states
+   *
+   * @returns A response containing only custom lifecycle states from configuration
+   */
+  @ApiOperation({ 
+    summary: 'Get custom lifecycle states',
+    description: 'Returns only custom lifecycle states loaded from states.yml configuration file'
+  })
+  @Get('states/custom')
+  public async getCustomStates(
+    @Res() res: Response,
+  ): Promise<Response<Array<{ key: string; label: string; description: string }>>> {
+    return res.status(HttpStatus.OK).json({
+      statusCode: HttpStatus.OK,
+      data: this._service.getCustomStates(),
+    });
+  }
+
   /**
    * Get recent lifecycle changes
    *
diff --git a/src/management/lifecycle/lifecycle.service.ts b/src/management/lifecycle/lifecycle.service.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-export enum IdentityLifecycle {`
	`1`	`+export enum IdentityLifecycleDefault {`
`2`	`2`	`OFFICIAL = "O",`
`3`	`3`	`INACTIVE = "I",`
`4`	`4`	`MANUAL = "M",`