@fiado/type-kit 3.184.0 → 3.186.0

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

@@ -0,0 +1,32 @@
+import { Expose } from 'class-transformer';
+import { IsInt, IsNumber, IsOptional, Max, Min } from 'class-validator';
+
+/**
+ * Body de POST /private/credit-plans/:planId/simulate y query de GET /credit-plans/:planId/simulator.
+ * Entradas del simulador de cuota (flow 06 §6.1.4). `productPriceCents` en cents; `downPaymentPct`
+ * decimal sobre 1. `customerSciScore` opcional: si viene, se valida contra el rango SCI del plan.
+ */
+export class SimulateCreditPlanRequest {
+    @Expose()
+    @IsInt()
+    @Min(1)
+    productPriceCents!: number;
+
+    @Expose()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    downPaymentPct!: number;
+
+    @Expose()
+    @IsInt()
+    @Min(1)
+    termWeeks!: number;
+
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    @Max(100)
+    customerSciScore?: number;
+}

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

@@ -0,0 +1,117 @@
+import { Expose } from 'class-transformer';
+import {
+    ArrayNotEmpty,
+    IsArray,
+    IsBoolean,
+    IsEnum,
+    IsInt,
+    IsNumber,
+    IsOptional,
+    IsString,
+    Max,
+    Min,
+} from 'class-validator';
+import { ProductTierEnum } from '../../enums/ProductTierEnum';
+import { SaleTypeEnum } from '../../enums/SaleTypeEnum';
+
+/**
+ * Body de PUT /credit-plans/:planId — edición parcial de parámetros del plan (todos opcionales).
+ * En F1 el PUT puede editar `min/maxSciScore` por-plan (DEC-004); el guard atómico anti-huecos
+ * entre planes (21-100) es F2/F3. El cambio de `status` va por su endpoint dedicado.
+ * `code` y `level` no se editan aquí (identidad/segmentación del plan).
+ */
+export class UpdateCreditPlanRequest {
+    @Expose()
+    @IsOptional()
+    @IsString()
+    name?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    description?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsEnum(SaleTypeEnum, { each: true })
+    saleTypes?: SaleTypeEnum[];
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsEnum(ProductTierEnum, { each: true })
+    eligibleTiers?: ProductTierEnum[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    minDownPaymentPct?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    maxDownPaymentPct?: number | null;
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsInt({ each: true })
+    @Min(1, { each: true })
+    termWeeksOptions?: number[];
+
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    maxFinancedAmountCents?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsNumber()
+    @Min(2.0)
+    @Max(2.6)
+    tnaAnnual?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    openingCommissionPct?: number;
+
+    @Expose()
+    @IsOptional()
+    @IsBoolean()
+    paymentShift?: boolean;
+
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    @Max(100)
+    minSciScore?: number | null;
+
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    @Max(100)
+    maxSciScore?: number | null;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    validFrom?: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    validUntil?: string | null;
+}

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

@@ -0,0 +1,41 @@
+import { Expose } from 'class-transformer';
+import {
+    IsArray,
+    IsEnum,
+    IsObject,
+    IsOptional,
+    IsString,
+} from 'class-validator';
+import { ProductTierEnum } from '../../enums/ProductTierEnum';
+
+/**
+ * Body de PUT /financiers/:financierId — edición parcial (todos opcionales).
+ * `code`, `type` y `displayOrder` no se editan aquí (identidad / orden por endpoint dedicado).
+ */
+export class UpdateFinancierRequest {
+    @Expose()
+    @IsOptional()
+    @IsString()
+    name?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    label?: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    externalRedirectUrl?: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsEnum(ProductTierEnum, { each: true })
+    eligibleTiers?: ProductTierEnum[] | null;
+
+    @Expose()
+    @IsOptional()
+    @IsObject()
+    config?: Record<string, unknown> | null;
+}

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

@@ -0,0 +1,36 @@
+import { CreditPlanLevelEnum } from '../../enums/CreditPlanLevelEnum';
+import { CreditPlanStatusEnum } from '../../enums/CreditPlanStatusEnum';
+import { ProductTierEnum } from '../../enums/ProductTierEnum';
+import { SaleTypeEnum } from '../../enums/SaleTypeEnum';
+
+/**
+ * Shape de salida de un plan de crédito (GET / POST / PUT de /credit-plans).
+ * Montos en cents; porcentajes y TNA en decimal.
+ */
+export interface CreditPlanResponse {
+    planId: string;
+    code: string;
+    name: string;
+    description: string;
+    level: CreditPlanLevelEnum;
+    saleTypes: SaleTypeEnum[];
+    eligibleTiers: ProductTierEnum[] | null;
+    minDownPaymentPct: number;
+    maxDownPaymentPct: number | null;
+    termWeeksOptions: number[];
+    maxFinancedAmountCents: number;
+    tnaAnnual: number;
+    ivaOnInterest: number;
+    openingCommissionPct: number;
+    paymentShift: boolean;
+    minSciScore: number | null;
+    maxSciScore: number | null;
+    version: number;
+    validFrom: string | null;
+    validUntil: string | null;
+    status: CreditPlanStatusEnum;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}

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

@@ -0,0 +1,24 @@
+import { FinancierStatusEnum } from '../../enums/FinancierStatusEnum';
+import { FinancierTypeEnum } from '../../enums/FinancierTypeEnum';
+import { ProductTierEnum } from '../../enums/ProductTierEnum';
+
+/**
+ * Shape de salida de una financiera (GET / POST / PUT de /financiers).
+ * Los listados devuelven `FinancierResponse[]` ordenados por `displayOrder`.
+ */
+export interface FinancierResponse {
+    financierId: string;
+    code: string;
+    name: string;
+    type: FinancierTypeEnum;
+    displayOrder: number;
+    label: string;
+    externalRedirectUrl: string | null;
+    eligibleTiers: ProductTierEnum[] | null;
+    config: Record<string, unknown> | null;
+    status: FinancierStatusEnum;
+    createdBy: string;
+    updatedBy: string;
+    createdAt: string;
+    updatedAt: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Shape de salida del enlace M:N retailer↔plan.
+ * Devuelto por activate/deactivate, por GET /retailers/:retailerId/credit-plans y por
+ * GET /credit-plans/:planId/active-retailers (lista de `RetailerCreditPlanResponse`).
+ */
+export interface RetailerCreditPlanResponse {
+    retailerId: string;
+    planId: string;
+    active: boolean;
+    activatedAt: string | null;
+    deactivatedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+}

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

@@ -0,0 +1,45 @@
+/**
+ * Un renglón de la tabla de amortización (M2 §3.3). Todos los montos en cents.
+ */
+export interface AmortizationRowResponse {
+    /** Número de cuota semanal (1-based). */
+    week: number;
+    capitalCents: number;
+    interestCents: number;
+    /** IVA 16% sobre el interés de la cuota. */
+    ivaCents: number;
+    /** capital + interés + IVA de la cuota. */
+    totalPaymentCents: number;
+    /** Saldo insoluto de capital tras aplicar la cuota. */
+    remainingBalanceCents: number;
+}
+
+/**
+ * Resultado del simulador de cuota (POST /private/credit-plans/:planId/simulate,
+ * GET /credit-plans/:planId/simulator). Amortización francesa + IVA 16% + comisión de apertura + CAT.
+ *
+ * NOTA (supuesto F1): `catAnnual` se calcula con la metodología estándar CONDUSEF (TIR anualizada)
+ * — pendiente de confirmar fórmula/ejemplos oficiales con Jaime/M2.
+ */
+export interface SimulationResultResponse {
+    planId: string;
+    planCode: string;
+    productPriceCents: number;
+    downPaymentPct: number;
+    downPaymentCents: number;
+    /** Capital financiado = precio − enganche (antes de comisión de apertura). */
+    financedAmountCents: number;
+    openingCommissionCents: number;
+    termWeeks: number;
+    tnaAnnual: number;
+    /** Cuota semanal sin IVA (capital + interés), constante en amortización francesa. */
+    weeklyPaymentSinIvaCents: number;
+    totalCapitalCents: number;
+    totalInterestCents: number;
+    totalIvaCents: number;
+    /** Total a pagar = capital + interés + IVA (+ comisión de apertura). */
+    totalToPayCents: number;
+    /** Costo Anual Total (decimal, ej. 2.87 = 287%). Metodología estándar CONDUSEF (supuesto). */
+    catAnnual: number;
+    schedule: AmortizationRowResponse[];
+}

package/src/loanOfferings/enums/CreditPlanLevelEnum.ts

@@ -0,0 +1,12 @@
+/**
+ * Nivel de cliente al que aplica un plan de crédito SureKeep (M6 §4/§5 · modelo-datos §6.1).
+ * `ALL` = plan que aplica a todos los niveles (Jaime modela EMPLEADO como tipo de venta
+ * con nivel "todos", no como un nivel propio — corrección 2026-07-10).
+ * @enum {string}
+ */
+export enum CreditPlanLevelEnum {
+    BRONZE = 'BRONZE',
+    SILVER = 'SILVER',
+    GOLD = 'GOLD',
+    ALL = 'ALL',
+}

package/src/loanOfferings/enums/CreditPlanStatusEnum.ts

@@ -0,0 +1,8 @@
+/**
+ * Estado de un plan de crédito (modelo-datos §6.1). Soft-delete vía status (nunca DELETE físico).
+ * @enum {string}
+ */
+export enum CreditPlanStatusEnum {
+    ACTIVE = 'ACTIVE',
+    INACTIVE = 'INACTIVE',
+}

package/src/loanOfferings/enums/FinancierStatusEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Estado de una financiera (modelo-datos §6.3). Desactivar la quita del wizard sin afectar
+ * créditos existentes (M6 §6).
+ * @enum {string}
+ */
+export enum FinancierStatusEnum {
+    ACTIVE = 'ACTIVE',
+    INACTIVE = 'INACTIVE',
+}

package/src/loanOfferings/enums/FinancierTypeEnum.ts

@@ -0,0 +1,9 @@
+/**
+ * Tipo de financiera (M6 §6 · modelo-datos §6.3). `INTERNAL` = SureKeep (SOFOM propia);
+ * `EXTERNAL` = financiera de terceros con derivación por URL (PayJoy / KREDIYA / LESPAGO).
+ * @enum {string}
+ */
+export enum FinancierTypeEnum {
+    INTERNAL = 'INTERNAL',
+    EXTERNAL = 'EXTERNAL',
+}

package/src/loanOfferings/enums/ProductTierEnum.ts

@@ -0,0 +1,15 @@
+/**
+ * Gama del equipo (modelo-datos §4.1 `RetailProduct.tier` · §6.1 `eligibleTiers`).
+ *
+ * NOTA (supuesto F1): conceptualmente esta gama pertenece al dominio de catálogo retail
+ * (`retail-catalog-business`), cuyo dominio type-kit aún no existe. Se define aquí para poder
+ * tipar `CreditPlan.eligibleTiers` y `Financier.eligibleTiers` sin bloquear. Al publicarse el
+ * dominio `retailCatalog`, consolidar allí y reexportar (coordinar con la pista Retail).
+ * @enum {string}
+ */
+export enum ProductTierEnum {
+    LOW = 'LOW',
+    MID = 'MID',
+    HIGH = 'HIGH',
+    PREMIUM = 'PREMIUM',
+}

package/src/loanOfferings/enums/SaleTypeEnum.ts

@@ -0,0 +1,13 @@
+/**
+ * Tipo de venta al que aplica un plan de crédito (M6 §4 · modelo-datos §6.1).
+ * Un plan puede configurarse para uno o más tipos (por eso `CreditPlan.saleTypes` es array).
+ * @enum {string}
+ */
+export enum SaleTypeEnum {
+    /** Cliente sin historial previo con SureKeep (primera compra). */
+    NEW = 'NEW',
+    /** Cliente que ya tuvo un crédito con SureKeep (recompra / renovación). */
+    REPURCHASE = 'REPURCHASE',
+    /** Empleado de VentasLuga que compra para uso personal (condiciones preferenciales). */
+    EMPLOYEE = 'EMPLOYEE',
+}

package/src/loanOfferings/index.ts

@@ -0,0 +1,28 @@
+// Enums
+export * from './enums/CreditPlanLevelEnum';
+export * from './enums/SaleTypeEnum';
+export * from './enums/ProductTierEnum';
+export * from './enums/CreditPlanStatusEnum';
+export * from './enums/FinancierTypeEnum';
+export * from './enums/FinancierStatusEnum';
+
+// Entity DTOs
+export * from './dtos/CreditPlan';
+export * from './dtos/Financier';
+export * from './dtos/RetailerCreditPlan';
+
+// Request DTOs
+export * from './dtos/requests/CreateCreditPlanRequest';
+export * from './dtos/requests/UpdateCreditPlanRequest';
+export * from './dtos/requests/ChangeCreditPlanStatusRequest';
+export * from './dtos/requests/SimulateCreditPlanRequest';
+export * from './dtos/requests/CreateFinancierRequest';
+export * from './dtos/requests/UpdateFinancierRequest';
+export * from './dtos/requests/ChangeFinancierStatusRequest';
+export * from './dtos/requests/ReorderFinancierRequest';
+
+// Response DTOs
+export * from './dtos/responses/CreditPlanResponse';
+export * from './dtos/responses/FinancierResponse';
+export * from './dtos/responses/RetailerCreditPlanResponse';
+export * from './dtos/responses/SimulationResultResponse';

package/bin/platformRbac/dtos/ResendOtpRequest.d.ts

@@ -1,22 +0,0 @@
-import { MfaMethodEnum } from '../enums/MfaMethodEnum';
-/**
- * Body del POST /auth/resend-otp (público, anónimo). DEC-RBAC-054.
- * Reenvía el OTP del login re-disparando el challenge real CUSTOM_AUTH (EMAIL_OTP) para la
- * identidad SIN password. `tenantId` obligatorio (DEC-064 — el picker ya lo resolvió, NO "solo email").
- * El email se normaliza lowercase server-side. Postura anti-enumeración: respuesta 200 genérica
- * siempre, sin filtrar existencia (ver AuthLoginManager.resendChallengeOtp).
- */
-export declare class ResendOtpRequest {
-    email: string;
-    tenantId: string;
-}
-/**
- * Respuesta del resend-otp. `session`/`mfaMethod` frescos del nuevo challenge CUSTOM_AUTH.
- * Plain sin validators (no validamos lo que mandamos al cliente — fiado-validation-and-dtos § 7).
- * Ambos opcionales: en los caminos de rechazo silencioso (anti-enumeración) o ramas sin CUSTOM_AUTH
- * el server responde 200 genérico sin session ni método.
- */
-export interface ResendOtpResponse {
-    session?: string;
-    mfaMethod?: MfaMethodEnum;
-}

package/bin/platformRbac/dtos/ResendSelfRegisterOtpRequest.d.ts

@@ -1,11 +0,0 @@
-/**
- * Body del POST /self-register/resend-otp (público, anónimo). DEC-RBAC-054.
- * Re-envía el OTP del autoregistro (mecanismo messages-business, NO Cognito) tras validar un
- * `pending` existente. Misma postura anti-enumeración del start. El email se normaliza lowercase
- * server-side. DTO propio por endpoint (NO reusa SelfRegisterStartRequest, que exige roleId/scope/
- * scopeRef, ni SelfRegisterVerifyOtpRequest, que exige otp).
- */
-export declare class ResendSelfRegisterOtpRequest {
-    tenantId: string;
-    email: string;
-}