@fiado/type-kit 3.25.0 → 3.27.0

package/bin/riskProfile/index.js

@@ -36,3 +36,22 @@ __exportStar(require("./enums/AlarmName"), exports);
 __exportStar(require("./enums/UserQuestionnaireStatusEnum"), exports);
 __exportStar(require("./enums/UserQuestionnaireQuestionAnswerEnum"), exports);
 __exportStar(require("./enums/UserQuestionnaireQuestionStatusEnum"), exports);
+// Enums PLD privados
+__exportStar(require("./enums/CustomAlarmName"), exports);
+__exportStar(require("./enums/DictamenStatus"), exports);
+__exportStar(require("./enums/NotesMode"), exports);
+// DTOs PLD privados — endpoints del PrivateController para Dashboard regulatorio
+__exportStar(require("./dtos/private/DictaminateAlertRequest"), exports);
+__exportStar(require("./dtos/private/DictaminateAlertResponse"), exports);
+__exportStar(require("./dtos/private/AppendAlertNoteRequest"), exports);
+__exportStar(require("./dtos/private/AppendAlertNoteResponse"), exports);
+__exportStar(require("./dtos/private/CreateBlockedListAlertRequest"), exports);
+__exportStar(require("./dtos/private/CreateBlockedListAlertResponse"), exports);
+__exportStar(require("./dtos/private/MarkAlertReportedRequest"), exports);
+__exportStar(require("./dtos/private/MarkAlertReportedResponse"), exports);
+__exportStar(require("./dtos/private/SetManualRiskLevelRequest"), exports);
+__exportStar(require("./dtos/private/SetManualRiskLevelResponse"), exports);
+__exportStar(require("./dtos/private/SetCustomAlarmRequest"), exports);
+__exportStar(require("./dtos/private/SetCustomAlarmResponse"), exports);
+__exportStar(require("./dtos/private/SetDeclaredIncomeRequest"), exports);
+__exportStar(require("./dtos/private/SetDeclaredIncomeResponse"), exports);

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@fiado/type-kit",
-  "version": "3.25.0",
+  "version": "3.27.0",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",
   "scripts": {
     "test": "jest",
-    "build": "tsc"
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [],
   "author": "Fiado Inc",

package/src/remittance/dtos/RemittanceQuoteRequest.ts

@@ -0,0 +1,33 @@
+import { IsEnum, IsIn, IsNotEmpty, IsNumber, IsString, Min } from "class-validator";
+import { ReceptionMethod } from "../enums/ReceptionMethod";
+import { RemittanceCountryISO } from "../enums/RemittanceCountryISO";
+
+/**
+ * Quote en tiempo real (debounce mientras el usuario escribe).
+ * Bajo modelo API Lite (D23-D26) NO incluye fundingMethodType — la fuente es
+ * siempre el wallet USD del usuario; el connector mapea a sendingMethodName="Wlp Wallet"
+ * internamente.
+ */
+export class RemittanceQuoteRequest {
+    @IsEnum(RemittanceCountryISO)
+    destCountry!: RemittanceCountryISO;
+
+    @IsString()
+    @IsNotEmpty()
+    destCurrencyISO!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    payerCode!: string;
+
+    @IsEnum(ReceptionMethod)
+    receptionMethod!: ReceptionMethod;
+
+    @IsNumber({ maxDecimalPlaces: 2 })
+    @Min(1)
+    amount!: number;
+
+    /** "USD" si amount está en origen; ISO destino si está en moneda destino. */
+    @IsIn(["USD", "GTQ", "HNL", "MXN", "NIO"])
+    amountCurrency!: string;
+}

package/src/remittance/dtos/RemittanceQuoteResponse.ts

@@ -0,0 +1,11 @@
+export class RemittanceQuoteResponse {
+    exchangeRate!: number;
+    serviceFee!: number;
+    stateFee!: number;
+    receivedAmount!: number;
+    totalAmount!: number;
+    /** UUID interno (no de UNIR). Solo para tracking en logs, no se reusa en Preview. */
+    quoteId!: string;
+    /** Epoch ms. Sugerencia: re-cotizar tras `expiresAt`. */
+    expiresAt!: number;
+}

package/src/remittance/dtos/RemittanceSendPreviewRequest.ts

@@ -0,0 +1,18 @@
+import { IsIn, IsNotEmpty, IsNumber, IsString, Min } from "class-validator";
+
+/**
+ * Preview formal antes del confirm. Bajo API Lite no incluye fundingMethod —
+ * el connector usa unirWlpWalletId de RemittanceUsers_GT (capturado en F2).
+ */
+export class RemittanceSendPreviewRequest {
+    @IsString()
+    @IsNotEmpty()
+    beneficiaryId!: string;
+
+    @IsNumber({ maxDecimalPlaces: 2 })
+    @Min(1)
+    amount!: number;
+
+    @IsIn(["USD", "GTQ", "HNL", "MXN", "NIO"])
+    amountCurrency!: string;
+}

package/src/remittance/dtos/RemittanceSendPreviewResponse.ts

@@ -0,0 +1,19 @@
+export interface RemittanceBeneficiaryDisplay {
+    name: string;
+    bank?: string;
+    lastFour?: string;
+}
+
+export class RemittanceSendPreviewResponse {
+    /** transactionInternalReference de UNIR — requerido para el confirm en F6. */
+    previewRef!: string;
+    exchangeRate!: number;
+    serviceFee!: number;
+    stateFee!: number;
+    totalAmount!: number;
+    receivedAmount!: number;
+    receivedCurrency!: string;
+    beneficiaryDisplay!: RemittanceBeneficiaryDisplay;
+    /** Epoch ms. Cache 10 min en RemittanceCache_GT (D-F5.4). */
+    expiresAt!: number;
+}

package/src/remittance/dtos/index.ts

@@ -6,6 +6,10 @@ export * from "./RemittanceBeneficiary";
 export * from "./RemittanceAddBeneficiaryRequest";
 export * from "./RemittanceUpdateBeneficiaryRequest";
 export * from "./RemittanceListBeneficiariesResponse";
+export * from "./RemittanceQuoteRequest";
+export * from "./RemittanceQuoteResponse";
+export * from "./RemittanceSendPreviewRequest";
+export * from "./RemittanceSendPreviewResponse";
 export * from "./RemittanceTransaction";
 export * from "./RemittanceLimitsInfo";
 export * from "./RemittanceHomeResponse";

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

@@ -0,0 +1,29 @@
+import { Expose } from "class-transformer";
+import { IsEmail, IsEnum, IsNotEmpty, IsString, MinLength } from "class-validator";
+import { NotesMode } from "../../enums/NotesMode";
+
+/**
+ * Solicitud para agregar nota a una alerta sin dictaminar.
+ *
+ * Permite al OC agregar contexto a una alerta en estado NEW o PENDING sin cerrarla.
+ * El modo `APPEND` concatena al final; `REPLACE` sobrescribe.
+ *
+ * Reglas de negocio:
+ * - `notes` mínimo 10 caracteres.
+ * - El append no es atómico ante escritura concurrente — el último gana.
+ */
+export class AppendAlertNoteRequest {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MinLength(10, { message: 'notes debe tener al menos 10 caracteres' })
+    notes!: string;
+
+    @Expose()
+    @IsEnum(NotesMode)
+    mode!: NotesMode;
+
+    @Expose()
+    @IsEmail({}, { message: 'email debe ser un correo válido' })
+    email!: string;
+}

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

@@ -0,0 +1,12 @@
+import { Expose } from "class-transformer";
+
+/**
+ * Respuesta de agregar nota a una alerta.
+ * `notesUpdated` indica si efectivamente hubo cambio (false si el texto resultante fue idéntico).
+ */
+export class AppendAlertNoteResponse {
+    @Expose() alertId!: string;
+    @Expose() notesUpdated!: boolean;
+    @Expose() observationId?: string;
+    @Expose() snapshotKey!: string;
+}

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

@@ -0,0 +1,22 @@
+import { Expose } from "class-transformer";
+import { IsEmail, IsNotEmpty, IsString, MinLength } from "class-validator";
+
+/**
+ * Solicitud para crear una alerta BLOCKED_LIST manualmente.
+ *
+ * Se invoca cuando el caller ha identificado un match contra la lista LPB.
+ * El BO no consulta `blacklist-business` ni la lista negra interna de Fiado;
+ * confía en el caller y solo registra la alerta.
+ *
+ * Reglas de negocio:
+ * - Si ya existe alerta BLOCKED_LIST abierta (NEW/PENDING) para el mismo directoryId, devuelve 409.
+ * - `reason` mínimo 10 caracteres (descripción del match LPB).
+ */
+export class CreateBlockedListAlertRequest {
+    @Expose() @IsString() @IsNotEmpty() directoryId!: string;
+    @Expose() @IsString() @IsNotEmpty() peopleId!: string;
+    @Expose() @IsString() @IsNotEmpty() indexName!: string;
+    @Expose() @IsString() @IsNotEmpty() phoneNumber!: string;
+    @Expose() @IsEmail({}, { message: 'email debe ser un correo válido' }) email!: string;
+    @Expose() @IsString() @IsNotEmpty() @MinLength(10, { message: 'reason debe tener al menos 10 caracteres' }) reason!: string;
+}

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

@@ -0,0 +1,10 @@
+import { Expose } from "class-transformer";
+
+/**
+ * Respuesta de creación de alerta BLOCKED_LIST.
+ */
+export class CreateBlockedListAlertResponse {
+    @Expose() alertId!: string;
+    @Expose() observationId?: string;
+    @Expose() snapshotKey!: string;
+}

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

@@ -0,0 +1,30 @@
+import { Expose } from "class-transformer";
+import { IsEmail, IsEnum, IsNotEmpty, IsString, MinLength } from "class-validator";
+import { DictamenStatus } from "../../enums/DictamenStatus";
+
+/**
+ * Solicitud para dictaminar una alerta de PLD.
+ *
+ * Cierra una alerta en estado NEW o PENDING transicionándola a uno de los estados terminales.
+ * Genera audit trail completo (Observation + snapshot S3) y queda inmutable.
+ *
+ * Reglas de negocio:
+ * - `newStatus` debe ser uno de los estados de cierre permitidos.
+ * - `newNotes` queda como justificación regulatoria del dictamen (mínimo 10 caracteres).
+ * - `email` es el correo del Oficial de Cumplimiento que ejecuta la operación.
+ */
+export class DictaminateAlertRequest {
+    @Expose()
+    @IsEnum(DictamenStatus)
+    newStatus!: DictamenStatus;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MinLength(10, { message: 'newNotes debe tener al menos 10 caracteres' })
+    newNotes!: string;
+
+    @Expose()
+    @IsEmail({}, { message: 'email debe ser un correo válido' })
+    email!: string;
+}

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

@@ -0,0 +1,16 @@
+import { Expose } from "class-transformer";
+
+/**
+ * Respuesta de la operación de dictamen de alerta.
+ *
+ * Incluye el hash SHA-256 del snapshot inmutable guardado en S3.
+ * El `snapshotKey` puede usarse para recuperar el snapshot completo desde el bucket de audit.
+ */
+export class DictaminateAlertResponse {
+    @Expose() alertId!: string;
+    @Expose() previousStatus!: string;
+    @Expose() newStatus!: string;
+    @Expose() snapshotKey!: string;
+    @Expose() snapshotHash!: string;
+    @Expose() observationId?: string;
+}

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

@@ -0,0 +1,21 @@
+import { Expose } from "class-transformer";
+import { IsEmail, IsNotEmpty, IsString } from "class-validator";
+
+/**
+ * Solicitud para marcar una alerta como reportada a SITI (ROI enviado).
+ *
+ * Se invoca después de que el OC envíe el reporte regulatorio; este endpoint
+ * NO envía el reporte a SITI, solo registra el acuse y datos de trazabilidad.
+ *
+ * Precondiciones:
+ * - Alerta debe estar en estado CLOSE_RULED.
+ * - Alerta no debe haber sido reportada previamente (`reported === 0`).
+ *
+ * Si no cumple precondiciones → 409 ALERT_NOT_ELIGIBLE.
+ */
+export class MarkAlertReportedRequest {
+    @Expose() @IsString() @IsNotEmpty() reportSupTechId!: string;
+    @Expose() @IsString() @IsNotEmpty() reportName!: string;
+    @Expose() @IsString() @IsNotEmpty() fileNumber!: string;
+    @Expose() @IsEmail({}, { message: 'email debe ser un correo válido' }) email!: string;
+}

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

@@ -0,0 +1,11 @@
+import { Expose } from "class-transformer";
+
+/**
+ * Respuesta de marcar alerta como reportada.
+ */
+export class MarkAlertReportedResponse {
+    @Expose() alertId!: string;
+    @Expose() reported!: 1 | 0;
+    @Expose() observationId?: string;
+    @Expose() snapshotKey!: string;
+}

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';
+