@fiado/type-kit 3.545.0 → 3.547.0

package/src/loanOfferings/dtos/CreditPlan.ts

@@ -1,4 +1,4 @@
-import { Expose } from 'class-transformer';
+import { Expose, Type } from 'class-transformer';
 import {
     ArrayNotEmpty,
     IsArray,
@@ -11,12 +11,14 @@ import {
     Matches,
     Max,
     Min,
+    ValidateNested,
 } from 'class-validator';
 import { regexIso8601 } from '../../helpers/constans/regex';
 import { CreditPlanLevelEnum } from '../enums/CreditPlanLevelEnum';
 import { CreditPlanStatusEnum } from '../enums/CreditPlanStatusEnum';
 import { ProductTierEnum } from '../enums/ProductTierEnum';
 import { SaleTypeEnum } from '../enums/SaleTypeEnum';
+import { PrepaymentMinimum } from './PrepaymentMinimum';
 
 /**
  * CreditPlan — plan de crédito del catálogo SOFOM SureKeep (modelo-datos §6.1 · M6 §4).
@@ -168,4 +170,11 @@ export class CreditPlan {
     @IsString()
     @Matches(regexIso8601, { message: 'updatedAt debe ser una fecha ISO 8601' })
     updatedAt!: string;
+
+    /** Mínimo del abono a capital; ausente = `ANY` (cualquier monto). */
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => PrepaymentMinimum)
+    prepaymentMinimum?: PrepaymentMinimum;
 }

package/src/loanOfferings/dtos/PrepaymentMinimum.ts

@@ -0,0 +1,28 @@
+import { Expose } from 'class-transformer';
+import { IsEnum, IsInt, IsNumber, IsOptional, Max, Min } from 'class-validator';
+import { PrepaymentMinimumModeEnum } from '../enums/PrepaymentMinimumModeEnum';
+
+/**
+ * Mínimo del abono a capital de un plan. El máximo no depende del plan: es lo que falta para liquidar.
+ * Sin este campo en el plan, el mínimo es `ANY`.
+ */
+export class PrepaymentMinimum {
+    @Expose()
+    @IsEnum(PrepaymentMinimumModeEnum)
+    mode!: PrepaymentMinimumModeEnum;
+
+    /** Sólo `PERCENT_OF_PERIOD_PAYMENT`: decimal sobre 1 del pago del periodo (`0.5` = 50 %). */
+    @Expose()
+    @IsOptional()
+    @IsNumber()
+    @Min(0.0001)
+    @Max(1)
+    periodPaymentPct?: number | null;
+
+    /** Sólo `FIXED`: monto mínimo en cents. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(1)
+    amountCents?: number | null;
+}

package/src/loanOfferings/dtos/requests/CreateCreditPlanRequest.ts

@@ -1,4 +1,4 @@
-import { Expose } from 'class-transformer';
+import { Expose, Type } from 'class-transformer';
 import {
     ArrayNotEmpty,
     IsArray,
@@ -10,10 +10,12 @@ import {
     IsString,
     Max,
     Min,
+    ValidateNested,
 } from 'class-validator';
 import { CreditPlanLevelEnum } from '../../enums/CreditPlanLevelEnum';
 import { ProductTierEnum } from '../../enums/ProductTierEnum';
 import { SaleTypeEnum } from '../../enums/SaleTypeEnum';
+import { PrepaymentMinimum } from '../PrepaymentMinimum';
 
 /**
  * Body de POST /credit-plans — alta de un plan (SureKeep Fase 1 — pista Loan).
@@ -115,4 +117,11 @@ export class CreateCreditPlanRequest {
     @IsOptional()
     @IsString()
     validUntil?: string | null;
+
+    /** Mínimo del abono a capital; ausente = sin cambios (en el alta: `ANY`). */
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => PrepaymentMinimum)
+    prepaymentMinimum?: PrepaymentMinimum;
 }

package/src/loanOfferings/dtos/requests/UpdateCreditPlanRequest.ts

@@ -1,4 +1,4 @@
-import { Expose } from 'class-transformer';
+import { Expose, Type } from 'class-transformer';
 import {
     ArrayNotEmpty,
     IsArray,
@@ -10,9 +10,11 @@ import {
     IsString,
     Max,
     Min,
+    ValidateNested,
 } from 'class-validator';
 import { ProductTierEnum } from '../../enums/ProductTierEnum';
 import { SaleTypeEnum } from '../../enums/SaleTypeEnum';
+import { PrepaymentMinimum } from '../PrepaymentMinimum';
 
 /**
  * Body de PUT /credit-plans/:planId — edición parcial de parámetros del plan (todos opcionales).
@@ -114,4 +116,11 @@ export class UpdateCreditPlanRequest {
     @IsOptional()
     @IsString()
     validUntil?: string | null;
+
+    /** Mínimo del abono a capital; ausente = sin cambios (en el alta: `ANY`). */
+    @Expose()
+    @IsOptional()
+    @ValidateNested()
+    @Type(() => PrepaymentMinimum)
+    prepaymentMinimum?: PrepaymentMinimum;
 }

package/src/loanOfferings/dtos/responses/CreditPlanResponse.ts

@@ -2,6 +2,7 @@ import { CreditPlanLevelEnum } from '../../enums/CreditPlanLevelEnum';
 import { CreditPlanStatusEnum } from '../../enums/CreditPlanStatusEnum';
 import { ProductTierEnum } from '../../enums/ProductTierEnum';
 import { SaleTypeEnum } from '../../enums/SaleTypeEnum';
+import { PrepaymentMinimum } from '../PrepaymentMinimum';
 
 /**
  * Shape de salida de un plan de crédito (GET / POST / PUT de /credit-plans).
@@ -33,4 +34,6 @@ export interface CreditPlanResponse {
     updatedBy: string;
     createdAt: string;
     updatedAt: string;
+    /** Mínimo del abono a capital; ausente = `ANY` (cualquier monto). */
+    prepaymentMinimum?: PrepaymentMinimum;
 }

package/src/loanOfferings/enums/PrepaymentMinimumModeEnum.ts

@@ -0,0 +1,9 @@
+/** Cómo se fija el mínimo del abono a capital de un plan. */
+export enum PrepaymentMinimumModeEnum {
+    /** Sin mínimo: el cliente abona el monto que quiera. */
+    ANY = 'ANY',
+    /** Un porcentaje del pago del periodo (`periodPaymentPct`). */
+    PERCENT_OF_PERIOD_PAYMENT = 'PERCENT_OF_PERIOD_PAYMENT',
+    /** Un monto fijo (`amountCents`). */
+    FIXED = 'FIXED',
+}

package/src/loanOfferings/index.ts

@@ -16,9 +16,11 @@ export * from './enums/StorePolicyPhaseEnum';
 export * from './enums/SegmentStatusEnum';
 export * from './enums/SegmentColorSlotEnum';
 export * from './enums/SegmentFilterIdEnum';
+export * from './enums/PrepaymentMinimumModeEnum';
 
 // Entity DTOs
 export * from './dtos/CreditPlan';
+export * from './dtos/PrepaymentMinimum';
 export * from './dtos/Financier';
 export * from './dtos/RetailerCreditPlan';
 export * from './dtos/PromotionEffect';

package/src/loanRetailAudit/constants/auditTrailEntityTypes.ts

@@ -0,0 +1,12 @@
+import { LoanAuditEntityTypeEnum } from '../enums/LoanAuditEntityTypeEnum';
+import { RetailAuditEntityTypeEnum } from '../enums/RetailAuditEntityTypeEnum';
+
+/** Cualquier `entityType` que acepta el central, de Loan o de Retail. */
+export type AuditTrailEntityType = LoanAuditEntityTypeEnum | RetailAuditEntityTypeEnum;
+
+export const AUDIT_TRAIL_ENTITY_TYPES: readonly AuditTrailEntityType[] = [
+    ...Object.values(LoanAuditEntityTypeEnum),
+    ...Object.values(RetailAuditEntityTypeEnum),
+];
+
+export const AUDIT_TRAIL_MAX_PAGE_SIZE = 100;

package/src/loanRetailAudit/dtos/AuditTrailChange.ts

@@ -0,0 +1,22 @@
+import { Expose } from 'class-transformer';
+import { IsNotEmpty, IsOptional, IsString } from 'class-validator';
+
+/** Un campo que cambió; los valores van serializados a string y nunca llevan PII. */
+export class AuditTrailChange {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    field!: string;
+
+    /** Ausente en un alta. */
+    @Expose()
+    @IsOptional()
+    @IsString()
+    oldValue?: string;
+
+    /** Ausente en una baja. */
+    @Expose()
+    @IsOptional()
+    @IsString()
+    newValue?: string;
+}

package/src/loanRetailAudit/dtos/AuditTrailContextEntry.ts

@@ -0,0 +1,14 @@
+import { Expose } from 'class-transformer';
+import { IsNotEmpty, IsString } from 'class-validator';
+
+/** Dato que la acción no cambió y se guarda para leer la entrada sin abrir otra pantalla. */
+export class AuditTrailContextEntry {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    key!: string;
+
+    @Expose()
+    @IsString()
+    value!: string;
+}

package/src/loanRetailAudit/dtos/requests/CreatePiiAccessLogRequest.ts

@@ -0,0 +1,64 @@
+import { Expose } from 'class-transformer';
+import { ArrayNotEmpty, IsArray, IsEnum, IsISO8601, IsNotEmpty, IsOptional, IsString } from 'class-validator';
+import { PiiAccessActionEnum } from '../../enums/PiiAccessActionEnum';
+import { PiiResourceTypeEnum } from '../../enums/PiiResourceTypeEnum';
+
+/** Body de `POST /private/pii-access-logs` (privateCreatePiiAccessLog); el tenant va en `?tenantId=`. */
+export class CreatePiiAccessLogRequest {
+    /** ULID generado por quien llama; con `occurredAt` forma el sk, así un reintento no duplica. */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    accessId!: string;
+
+    @Expose()
+    @IsISO8601()
+    occurredAt!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    correlationId!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    actorId!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    sourceLambda!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    operationName!: string;
+
+    @Expose()
+    @IsEnum(PiiAccessActionEnum)
+    action!: PiiAccessActionEnum;
+
+    @Expose()
+    @IsEnum(PiiResourceTypeEnum)
+    resourceType!: PiiResourceTypeEnum;
+
+    /** Id del recurso, o `(list)` en un listado con los ids en `resourceIds`. */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    resourceId!: string;
+
+    /** Nombres de los campos PII que viajaron; nunca sus valores. */
+    @Expose()
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsString({ each: true })
+    fields!: string[];
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsString({ each: true })
+    resourceIds?: string[];
+}

package/src/loanRetailAudit/dtos/requests/ListAuditTrailQuery.ts

@@ -0,0 +1,35 @@
+import { Expose, Type } from 'class-transformer';
+import { IsEnum, IsIn, IsInt, IsNotEmpty, IsOptional, IsString, Max, Min } from 'class-validator';
+import { SortDirEnum } from '../../../passport/enums/SortDirEnum';
+import { AUDIT_TRAIL_ENTITY_TYPES, AUDIT_TRAIL_MAX_PAGE_SIZE, AuditTrailEntityType } from '../../constants/auditTrailEntityTypes';
+
+/** Query de `GET /private/audit-trail` (privateListAuditTrail): bitácora de una entidad, paginada por sk. */
+export class ListAuditTrailQuery {
+    @Expose()
+    @IsIn(AUDIT_TRAIL_ENTITY_TYPES)
+    entityType!: AuditTrailEntityType;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    entityId!: string;
+
+    /** Por default `desc`, lo más reciente primero. */
+    @Expose()
+    @IsOptional()
+    @IsEnum(SortDirEnum)
+    order?: SortDirEnum;
+
+    @Expose()
+    @IsOptional()
+    @Type(() => Number)
+    @IsInt()
+    @Min(1)
+    @Max(AUDIT_TRAIL_MAX_PAGE_SIZE)
+    limit?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    nextToken?: string;
+}

package/src/loanRetailAudit/dtos/responses/CreatePiiAccessLogResponse.ts

@@ -0,0 +1,4 @@
+/** Respuesta 201 de privateCreatePiiAccessLog; el mismo `accessId` en un reintento no duplica la fila. */
+export interface CreatePiiAccessLogResponse {
+    accessId: string;
+}

package/src/loanRetailAudit/dtos/responses/ListAuditTrailResponse.ts

@@ -0,0 +1,31 @@
+import { AuditTrailEntityType } from '../../constants/auditTrailEntityTypes';
+import { AuditTrailActionEnum } from '../../enums/AuditTrailActionEnum';
+
+/** Un campo que cambió, como lo devuelve la lectura. */
+export interface AuditTrailChangeView {
+    field: string;
+    oldValue: string | null;
+    newValue: string | null;
+}
+
+/** Una entrada de la bitácora; `eventId` y `sourceLambda` son `null` en filas Loan de forma vieja. */
+export interface AuditTrailEntry {
+    eventId: string | null;
+    sourceLambda: string | null;
+    entityType: AuditTrailEntityType;
+    entityId: string;
+    tenantId: string | null;
+    action: AuditTrailActionEnum;
+    performedBy: string;
+    reason: string | null;
+    ip: string | null;
+    changes: AuditTrailChangeView[];
+    context: { key: string; value: string }[];
+    occurredAt: string;
+}
+
+/** Página de privateListAuditTrail; `nextToken` es `null` en la última. */
+export interface ListAuditTrailResponse {
+    items: AuditTrailEntry[];
+    nextToken: string | null;
+}

package/src/loanRetailAudit/enums/AuditTrailActionEnum.ts

@@ -0,0 +1,39 @@
+/** Acción auditada en `SharedAuditTrail`; une las de Loan y Retail. */
+export enum AuditTrailActionEnum {
+    CREATE = 'CREATE',
+    UPDATE = 'UPDATE',
+    DELETE = 'DELETE',
+    UPSERT = 'UPSERT',
+    STATUS_CHANGE = 'STATUS_CHANGE',
+    TRANSFER = 'TRANSFER',
+    KYC_VERIFIED = 'KYC_VERIFIED',
+    KYC_REVIEW = 'KYC_REVIEW',
+    ACCOUNT_RESULT = 'ACCOUNT_RESULT',
+    WELCOME_ACCREDITED = 'WELCOME_ACCREDITED',
+    WELCOME_ACCREDITATION_RESULT = 'WELCOME_ACCREDITATION_RESULT',
+    WELCOME_ACCREDITATION_RECONCILED = 'WELCOME_ACCREDITATION_RECONCILED',
+    SESSION_CREATE = 'SESSION_CREATE',
+    STEP_ADVANCE = 'STEP_ADVANCE',
+    OTP_SKIP = 'OTP_SKIP',
+    SESSION_RESUME = 'SESSION_RESUME',
+    SESSION_CANCEL = 'SESSION_CANCEL',
+    SESSION_CREDIT_ENABLED = 'SESSION_CREDIT_ENABLED',
+    PAYMENT_REGISTERED = 'PAYMENT_REGISTERED',
+    SALE_COMPLETE = 'SALE_COMPLETE',
+    SALE_CANCEL = 'SALE_CANCEL',
+    SALE_CARD_DELIVERED = 'SALE_CARD_DELIVERED',
+    KYC_CONFIRM = 'KYC_CONFIRM',
+    COMPLIANCE_VERDICT = 'COMPLIANCE_VERDICT',
+    EXCEPTION_CREATE = 'EXCEPTION_CREATE',
+    EXCEPTION_REVIEW = 'EXCEPTION_REVIEW',
+    EXCEPTION_RESOLVE = 'EXCEPTION_RESOLVE',
+    EXCEPTION_APPLY = 'EXCEPTION_APPLY',
+    EXCEPTION_NOTE = 'EXCEPTION_NOTE',
+    REPORT_RUN_REQUEST = 'REPORT_RUN_REQUEST',
+    PUBLISH = 'PUBLISH',
+    CLOSE = 'CLOSE',
+    ADJUST = 'ADJUST',
+    PAUSE = 'PAUSE',
+    RESUME = 'RESUME',
+    EXPIRE = 'EXPIRE',
+}

package/src/loanRetailAudit/enums/LoanAuditEntityTypeEnum.ts

@@ -0,0 +1,12 @@
+/** `entityType` de bitácora que escriben los lambdas Loan; los valores son los que ya están en la pk. */
+export enum LoanAuditEntityTypeEnum {
+    CREDIT = 'CREDIT',
+    INSTALLMENT = 'INSTALLMENT',
+    RESTRUCTURE = 'RESTRUCTURE',
+    CREDIT_PLAN = 'CREDIT_PLAN',
+    STORE_POLICY = 'STORE_POLICY',
+    SEGMENT = 'SEGMENT',
+    LOAN_PARAMETER = 'LoanParameter',
+    LOAN_ASSIGNMENT_RULE = 'LoanAssignmentRule',
+    LOAN_COLLECTOR_ASSIGNMENT = 'LoanCollectorAssignment',
+}

package/src/loanRetailAudit/enums/PiiAccessActionEnum.ts

@@ -0,0 +1,5 @@
+/** Qué se hizo con la PII: verla o cambiarla. */
+export enum PiiAccessActionEnum {
+    READ = 'READ',
+    WRITE = 'WRITE',
+}

package/src/loanRetailAudit/enums/PiiResourceTypeEnum.ts

@@ -0,0 +1,9 @@
+/** Tipo de recurso con PII; arma la pk `RESOURCE#<tipo>#<id>` de `SharedPiiAccessLog`. */
+export enum PiiResourceTypeEnum {
+    RETAIL_CUSTOMER = 'RETAIL_CUSTOMER',
+    RETAIL_USER = 'RETAIL_USER',
+    RETAILER = 'RETAILER',
+    SALE = 'SALE',
+    PROSPECT = 'PROSPECT',
+    LOAN_PAYMENT = 'LOAN_PAYMENT',
+}

package/src/loanRetailAudit/enums/RetailAuditEntityTypeEnum.ts

@@ -0,0 +1,17 @@
+/** `entityType` de bitácora que escriben los lambdas Retail (customer, org, wizard, commission). */
+export enum RetailAuditEntityTypeEnum {
+    CUSTOMER = 'CUSTOMER',
+    RETAILER = 'RETAILER',
+    STORE = 'STORE',
+    RETAIL_USER = 'RETAIL_USER',
+    GOAL = 'GOAL',
+    WIZARD_SESSION = 'WIZARD_SESSION',
+    SALE = 'SALE',
+    SALE_EXCEPTION = 'SALE_EXCEPTION',
+    REPORT_RUN = 'REPORT_RUN',
+    COMMISSION_PLAN = 'COMMISSION_PLAN',
+    COMMISSION_PAYOUT = 'COMMISSION_PAYOUT',
+    COMMISSION_ADJUSTMENT = 'COMMISSION_ADJUSTMENT',
+    COMMISSION_RULE = 'COMMISSION_RULE',
+    COMMISSION_POLICY = 'COMMISSION_POLICY',
+}

package/src/loanRetailAudit/events/AuditTrailRecordedV1.ts

@@ -0,0 +1,70 @@
+import { Expose, Type } from 'class-transformer';
+import { IsArray, IsIn, IsEnum, IsISO8601, IsNotEmpty, IsOptional, IsString, ValidateNested } from 'class-validator';
+import { AUDIT_TRAIL_ENTITY_TYPES, AuditTrailEntityType } from '../constants/auditTrailEntityTypes';
+import { AuditTrailChange } from '../dtos/AuditTrailChange';
+import { AuditTrailContextEntry } from '../dtos/AuditTrailContextEntry';
+import { AuditTrailActionEnum } from '../enums/AuditTrailActionEnum';
+
+/** Mensaje de la cola `LoanRetailAuditQueue`; el central lo guarda una sola vez por `eventId`. */
+export class AuditTrailRecordedV1 {
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    eventId!: string;
+
+    @Expose()
+    @IsIn(AUDIT_TRAIL_ENTITY_TYPES)
+    entityType!: AuditTrailEntityType;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    entityId!: string;
+
+    @Expose()
+    @IsEnum(AuditTrailActionEnum)
+    action!: AuditTrailActionEnum;
+
+    @Expose()
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => AuditTrailChange)
+    changes!: AuditTrailChange[];
+
+    @Expose()
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => AuditTrailContextEntry)
+    context!: AuditTrailContextEntry[];
+
+    /** userId del actor, o `system` si lo disparó un proceso interno. */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    performedBy!: string;
+
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    sourceLambda!: string;
+
+    @Expose()
+    @IsISO8601()
+    occurredAt!: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    @IsNotEmpty()
+    tenantId?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    reason?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    ip?: string;
+}

package/src/loanRetailAudit/index.ts

@@ -0,0 +1,20 @@
+// Enums
+export * from './enums/LoanAuditEntityTypeEnum';
+export * from './enums/RetailAuditEntityTypeEnum';
+export * from './enums/AuditTrailActionEnum';
+export * from './enums/PiiResourceTypeEnum';
+export * from './enums/PiiAccessActionEnum';
+
+// Constantes
+export * from './constants/auditTrailEntityTypes';
+
+// DTOs
+export * from './dtos/AuditTrailChange';
+export * from './dtos/AuditTrailContextEntry';
+export * from './dtos/requests/CreatePiiAccessLogRequest';
+export * from './dtos/requests/ListAuditTrailQuery';
+export * from './dtos/responses/CreatePiiAccessLogResponse';
+export * from './dtos/responses/ListAuditTrailResponse';
+
+// Contratos de eventos
+export * from './events/AuditTrailRecordedV1';

package/src/retailLoan/dtos/MyCreditSummary.ts

@@ -28,5 +28,7 @@ export interface MyCreditSummary {
     totalInstallments: number;
     paidInstallments: number;
     remainingBalance: number | null;
+    /** Deuda total en pesos: capital, interés e IVA que faltan de las cuotas abiertas. `null` = no aplica. */
+    totalDebt?: number | null;
     overdue?: MyOverdue;
 }