@fiado/type-kit 3.26.0 → 3.27.1

package/src/riskProfile/dtos/private/SetCustomAlarmRequest.ts

@@ -0,0 +1,31 @@
+import { Expose } from "class-transformer";
+import { IsEmail, IsEnum, IsNotEmpty, IsNumber, IsString, Min, MinLength, ValidateIf } from "class-validator";
+import { CustomAlarmName } from "../../enums/CustomAlarmName";
+
+/**
+ * Solicitud para cambiar un umbral de alarma custom.
+ *
+ * Solo afecta alarmas custom (customHighAmount, customMonthlyIncrease).
+ * Las 3 alarmas base no se recalculan al modificar custom.
+ *
+ * Si `newValue` es `null`, se interpreta como "quitar override" (limpiar la custom).
+ *
+ * Idempotencia: si previousValue === newValue, devuelve 200 con noop=true.
+ */
+export class SetCustomAlarmRequest {
+    @Expose() @IsEnum(CustomAlarmName) alarmName!: CustomAlarmName;
+
+    @Expose()
+    @ValidateIf(o => o.newValue !== null)
+    @IsNumber({}, { message: 'newValue debe ser un número o null' })
+    @Min(0, { message: 'newValue debe ser ≥ 0' })
+    newValue!: number | null;
+
+    @Expose() @IsEmail({}, { message: 'email debe ser un correo válido' }) email!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MinLength(10, { message: 'notes debe tener al menos 10 caracteres' })
+    notes!: string;
+}

package/src/riskProfile/dtos/private/SetCustomAlarmResponse.ts

@@ -0,0 +1,15 @@
+import { Expose } from "class-transformer";
+import { CustomAlarmName } from "../../enums/CustomAlarmName";
+
+/**
+ * Respuesta de actualización de alarma custom.
+ */
+export class SetCustomAlarmResponse {
+    @Expose() directoryId!: string;
+    @Expose() noop?: boolean;
+    @Expose() alarmName?: CustomAlarmName;
+    @Expose() previousValue?: number | null;
+    @Expose() newValue?: number | null;
+    @Expose() observationId?: string;
+    @Expose() snapshotKey?: string;
+}

package/src/riskProfile/dtos/private/SetDeclaredIncomeRequest.ts

@@ -0,0 +1,26 @@
+import { Expose } from "class-transformer";
+import { IsEmail, IsInt, IsNotEmpty, IsString, Min, MinLength } from "class-validator";
+
+/**
+ * Solicitud para cambiar `declaredMonthlyIncome` del perfil.
+ *
+ * Side effects (atómicos):
+ * - Recalcula las 5 alarmas base (highAmount, monthlyIncrease, monthlyLimit y derivadas).
+ * - Las alarmas custom NO se recalculan.
+ *
+ * Idempotencia: si previousIncome === newValue, devuelve 200 con noop=true.
+ */
+export class SetDeclaredIncomeRequest {
+    @Expose()
+    @IsInt({ message: 'newValue debe ser entero (centavos MXN)' })
+    @Min(0, { message: 'newValue debe ser ≥ 0' })
+    newValue!: number;
+
+    @Expose() @IsEmail({}, { message: 'email debe ser un correo válido' }) email!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MinLength(10, { message: 'notes debe tener al menos 10 caracteres' })
+    notes!: string;
+}

package/src/riskProfile/dtos/private/SetDeclaredIncomeResponse.ts

@@ -0,0 +1,22 @@
+import { Expose } from "class-transformer";
+
+/**
+ * Respuesta de actualización de declaredMonthlyIncome.
+ *
+ * `alarmas` incluye las 5 alarmas recalculadas más los valores custom (que no cambian).
+ */
+export class SetDeclaredIncomeResponse {
+    @Expose() directoryId!: string;
+    @Expose() noop?: boolean;
+    @Expose() previousIncome?: number;
+    @Expose() newIncome?: number;
+    @Expose() alarmas?: {
+        highAmount: number;
+        monthlyIncrease: number;
+        monthlyLimit: number;
+        customHighAmount: number | null;
+        customMonthlyIncrease: number | null;
+    };
+    @Expose() observationId?: string;
+    @Expose() snapshotKey?: string;
+}

package/src/riskProfile/dtos/private/SetManualRiskLevelRequest.ts

@@ -0,0 +1,37 @@
+import { Expose } from "class-transformer";
+import { IsEmail, IsInt, IsNotEmpty, IsString, Max, Min, MinLength } from "class-validator";
+
+/**
+ * Solicitud para cambiar el manualRiskLevel del perfil de riesgo.
+ *
+ * Aplica override manual del nivel de riesgo calculado automáticamente.
+ *
+ * Side effects (atómicos respecto al cambio principal):
+ * - Recalcula las 3 alarmas base (highAmount, monthlyIncrease, monthlyLimit) usando
+ *   `effectiveLevel = newLevel > 0 ? newLevel : profile.riskLevel`.
+ * - Si `newLevel > previousLevel AND newLevel > 0`: crea alerta MANUAL_RISK_INCREASE
+ *   con AlarmType.UNUSUAL.
+ *
+ * Mapeo de `newLevel`:
+ * - 0 = sin override (usa el riskLevel calculado)
+ * - 1 = Bajo
+ * - 2 = Medio
+ * - 3 = Alto
+ *
+ * Idempotencia: si `previousLevel === newLevel`, devuelve 200 con noop=true.
+ */
+export class SetManualRiskLevelRequest {
+    @Expose()
+    @IsInt()
+    @Min(0, { message: 'newLevel debe ser 0, 1, 2 o 3' })
+    @Max(3, { message: 'newLevel debe ser 0, 1, 2 o 3' })
+    newLevel!: number;
+
+    @Expose() @IsEmail({}, { message: 'email debe ser un correo válido' }) email!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MinLength(10, { message: 'notes debe tener al menos 10 caracteres' })
+    notes!: string;
+}

package/src/riskProfile/dtos/private/SetManualRiskLevelResponse.ts

@@ -0,0 +1,22 @@
+import { Expose } from "class-transformer";
+
+/**
+ * Respuesta del cambio de manualRiskLevel.
+ *
+ * Si fue noop (mismo valor previo), `noop: true` y el resto de campos no aplican.
+ * En caso de éxito real, incluye las alarmas recalculadas y el id de alerta auto-creada si subió el nivel.
+ */
+export class SetManualRiskLevelResponse {
+    @Expose() directoryId!: string;
+    @Expose() noop?: boolean;
+    @Expose() previousLevel?: number;
+    @Expose() newLevel?: number;
+    @Expose() alarmasRecalculadas?: {
+        highAmount: number;
+        monthlyIncrease: number;
+        monthlyLimit: number;
+    };
+    @Expose() alertaCreada?: string;
+    @Expose() observationId?: string;
+    @Expose() snapshotKey?: string;
+}

package/src/riskProfile/enums/CustomAlarmName.ts

@@ -0,0 +1,9 @@
+/**
+ * Nombres válidos de alarmas custom configurables manualmente por el OC.
+ * Solo estas dos alarmas aceptan override de umbral; las 3 alarmas base
+ * (highAmount, monthlyIncrease, monthlyLimit) se recalculan automáticamente.
+ */
+export enum CustomAlarmName {
+    CUSTOM_HIGH_AMOUNT = 'customHighAmount',
+    CUSTOM_MONTHLY_INCREASE = 'customMonthlyIncrease',
+}

package/src/riskProfile/enums/DictamenStatus.ts

@@ -0,0 +1,9 @@
+/**
+ * Estados terminales válidos al dictaminar una alerta.
+ * Una alerta solo puede transicionar a estos estados desde NEW o PENDING.
+ */
+export enum DictamenStatus {
+    CLOSE_JUSTIFIED = 'CLOSE_JUSTIFIED',
+    CLOSE_RULED = 'CLOSE_RULED',
+    CLOSED = 'CLOSED',
+}

package/src/riskProfile/enums/NotesMode.ts

@@ -0,0 +1,9 @@
+/**
+ * Modo de modificación de notas al agregar texto a una alerta sin dictaminar.
+ * - REPLACE: sobrescribe el contenido de notes.
+ * - APPEND: concatena al final con un salto de línea.
+ */
+export enum NotesMode {
+    REPLACE = 'replace',
+    APPEND = 'append',
+}

package/src/riskProfile/index.ts

@@ -22,3 +22,24 @@ export * from './enums/UserQuestionnaireStatusEnum';
 export * from './enums/UserQuestionnaireQuestionAnswerEnum';
 export * from './enums/UserQuestionnaireQuestionStatusEnum';
 
+// Enums PLD privados
+export * from './enums/CustomAlarmName';
+export * from './enums/DictamenStatus';
+export * from './enums/NotesMode';
+
+// DTOs PLD privados — endpoints del PrivateController para Dashboard regulatorio
+export * from './dtos/private/DictaminateAlertRequest';
+export * from './dtos/private/DictaminateAlertResponse';
+export * from './dtos/private/AppendAlertNoteRequest';
+export * from './dtos/private/AppendAlertNoteResponse';
+export * from './dtos/private/CreateBlockedListAlertRequest';
+export * from './dtos/private/CreateBlockedListAlertResponse';
+export * from './dtos/private/MarkAlertReportedRequest';
+export * from './dtos/private/MarkAlertReportedResponse';
+export * from './dtos/private/SetManualRiskLevelRequest';
+export * from './dtos/private/SetManualRiskLevelResponse';
+export * from './dtos/private/SetCustomAlarmRequest';
+export * from './dtos/private/SetCustomAlarmResponse';
+export * from './dtos/private/SetDeclaredIncomeRequest';
+export * from './dtos/private/SetDeclaredIncomeResponse';
+