@fiado/type-kit 3.184.0 → 3.186.0

package/src/loanConfig/dtos/requests/BulkUpdateParametersRequest.ts

@@ -0,0 +1,33 @@
+import { Expose, Type } from 'class-transformer';
+import { ArrayNotEmpty, IsArray, IsEnum, IsOptional, IsString, ValidateNested } from 'class-validator';
+import { ParameterTypeEnum } from '../../enums/ParameterTypeEnum';
+
+export class BulkUpdateParameterItem {
+    @Expose()
+    @IsEnum(ParameterTypeEnum)
+    paramType!: ParameterTypeEnum;
+
+    @Expose()
+    @IsString()
+    key!: string;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    value!: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    reason?: string;
+}
+
+/** Body de POST /parameters/bulk-update — carga inicial / ajuste masivo. */
+export class BulkUpdateParametersRequest {
+    @Expose()
+    @IsArray()
+    @ArrayNotEmpty()
+    @ValidateNested({ each: true })
+    @Type(() => BulkUpdateParameterItem)
+    parameters!: BulkUpdateParameterItem[];
+}

package/src/loanConfig/dtos/requests/UpdateParameterRequest.ts

@@ -0,0 +1,18 @@
+import { Expose } from 'class-transformer';
+import { IsOptional, IsString } from 'class-validator';
+
+/**
+ * Body de PUT /parameters/:paramType/:key. `value` puede ser null (parámetro pendiente).
+ * `reason` opcional en F1; el manager lo exigirá para cambios críticos (modelo-datos §10).
+ */
+export class UpdateParameterRequest {
+    @Expose()
+    @IsOptional()
+    @IsString()
+    value!: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    reason?: string;
+}

package/src/loanConfig/dtos/responses/ParameterResponse.ts

@@ -0,0 +1,28 @@
+import { ModifiableByRoleEnum } from '../../enums/ModifiableByRoleEnum';
+import { ParameterTypeEnum } from '../../enums/ParameterTypeEnum';
+import { ParameterValueTypeEnum } from '../../enums/ParameterValueTypeEnum';
+
+/** Shape de salida de un parámetro. `effectiveValue` = value ?? defaultValue. */
+export interface ParameterResponse {
+    parameterId: string;
+    paramType: ParameterTypeEnum;
+    key: string;
+    value: string | null;
+    effectiveValue: string;
+    valueType: ParameterValueTypeEnum;
+    defaultValue: string;
+    description: string;
+    modifiableBy: ModifiableByRoleEnum;
+    lastModifiedByUserId: string;
+    createdAt: string;
+    updatedAt: string;
+}
+
+/** Respuesta de GET /parameters — agrupado por paramType (flow 08.1). */
+export type ParametersByTypeResponse = Partial<Record<ParameterTypeEnum, ParameterResponse[]>>;
+
+/** Respuesta de POST /private/parameters/bulk-get. */
+export interface BulkGetParametersResponse {
+    parameters: ParameterResponse[];
+    notFound: { paramType: ParameterTypeEnum; key: string }[];
+}

package/src/loanConfig/enums/ModifiableByRoleEnum.ts

@@ -0,0 +1,11 @@
+/**
+ * Rol RBAC mínimo que puede modificar un parámetro (RBAC a nivel de parámetro, modelo-datos §8).
+ * `retailer_admin` = "Admin VentasLuga" de M6 §8. Valores = identificadores de rol de RBAC F0.
+ * TD-004: confirmar mapeo super_admin ↔ platform_super_admin con el naming real de F0.
+ * @enum {string}
+ */
+export enum ModifiableByRoleEnum {
+    SUPER_ADMIN = 'super_admin',
+    SOFOM_ADMIN = 'sofom_admin',
+    RETAILER_ADMIN = 'retailer_admin',
+}

package/src/loanConfig/enums/ParameterTypeEnum.ts

@@ -0,0 +1,20 @@
+/**
+ * Sub-tipos de parámetro operativo del SOFOM (M6 §8 = 13 + SCORING de §5 = 14).
+ * @enum {string}
+ */
+export enum ParameterTypeEnum {
+    CREDIT = 'CREDIT',
+    WARRANTY = 'WARRANTY',
+    WELCOME_BONUS = 'WELCOME_BONUS',
+    MORA_BLOCK = 'MORA_BLOCK',
+    UNBLOCK = 'UNBLOCK',
+    PAY_INVESTIGATION = 'PAY_INVESTIGATION',
+    COLLECTIONS = 'COLLECTIONS',
+    ANTI_FRAUD = 'ANTI_FRAUD',
+    REMITTANCE = 'REMITTANCE',
+    NOTIFICATIONS = 'NOTIFICATIONS',
+    CROSS_BORDER = 'CROSS_BORDER',
+    WIZARD = 'WIZARD',
+    INTEGRATIONS = 'INTEGRATIONS',
+    SCORING = 'SCORING',
+}

package/src/loanConfig/enums/ParameterValueTypeEnum.ts

@@ -0,0 +1,11 @@
+/**
+ * Tipo lógico del `value` (siempre persistido como string; el consumer parsea según esto).
+ * Valores en minúscula por contrato del modelo (modelo-datos §8).
+ * @enum {string}
+ */
+export enum ParameterValueTypeEnum {
+    STRING = 'string',
+    NUMBER = 'number',
+    BOOLEAN = 'boolean',
+    JSON = 'json',
+}

package/src/loanConfig/index.ts

@@ -0,0 +1,14 @@
+export * from './enums/ParameterTypeEnum';
+export * from './enums/ParameterValueTypeEnum';
+export * from './enums/ModifiableByRoleEnum';
+
+// Entity DTOs
+export * from './dtos/Parameter';
+
+// Request DTOs
+export * from './dtos/requests/UpdateParameterRequest';
+export * from './dtos/requests/BulkUpdateParametersRequest';
+export * from './dtos/requests/BulkGetParametersRequest';
+
+// Response DTOs
+export * from './dtos/responses/ParameterResponse';

package/src/loanOfferings/dtos/CreditPlan.ts

@@ -0,0 +1,171 @@
+import { Expose } from 'class-transformer';
+import {
+    ArrayNotEmpty,
+    IsArray,
+    IsBoolean,
+    IsEnum,
+    IsInt,
+    IsNumber,
+    IsOptional,
+    IsString,
+    Matches,
+    Max,
+    Min,
+} 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';
+
+/**
+ * CreditPlan — plan de crédito del catálogo SOFOM SureKeep (modelo-datos §6.1 · M6 §4).
+ * Entidad completa del dominio `loan-offerings-business` (SureKeep Fase 1 — pista Loan).
+ *
+ * Convenciones: montos en **cents** (entero); porcentajes **decimal sobre 1** (`0.40` = 40%);
+ * TNA decimal (`2.60` = 260%). El PLAN es dueño de los umbrales SCI por nivel
+ * (`minSciScore`/`maxSciScore`, resolución 2026-07-15) y del techo de enganche `maxDownPaymentPct`.
+ */
+export class CreditPlan {
+    @Expose()
+    @IsString()
+    planId!: string;
+
+    /** Código único por tenant: `BRONZE_NEW` | `SILVER_NEW` | `GOLD_NEW` | `EMPLOYEE`. */
+    @Expose()
+    @IsString()
+    code!: string;
+
+    @Expose()
+    @IsString()
+    name!: string;
+
+    @Expose()
+    @IsString()
+    description!: string;
+
+    @Expose()
+    @IsEnum(CreditPlanLevelEnum)
+    level!: CreditPlanLevelEnum;
+
+    /** Array: un plan puede aplicar a varios tipos de venta (M6 §4). */
+    @Expose()
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsEnum(SaleTypeEnum, { each: true })
+    saleTypes!: SaleTypeEnum[];
+
+    /** Gamas elegibles del plan; `null` = todas. */
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsEnum(ProductTierEnum, { each: true })
+    eligibleTiers!: ProductTierEnum[] | null;
+
+    /** Enganche MÍNIMO como decimal sobre 1 (`0.40` = 40%). */
+    @Expose()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    minDownPaymentPct!: number;
+
+    /** Techo de enganche (decimal sobre 1); `null` = sin techo definido (F1: TBD). */
+    @Expose()
+    @IsOptional()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    maxDownPaymentPct!: number | null;
+
+    /** Plazos válidos en semanas (subconjunto del catálogo maestro). */
+    @Expose()
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsInt({ each: true })
+    @Min(1, { each: true })
+    termWeeksOptions!: number[];
+
+    @Expose()
+    @IsInt()
+    @Min(0)
+    maxFinancedAmountCents!: number;
+
+    /** Tasa Nominal Anual como decimal (`2.60` = 260%); rango de negocio [2.00, 2.60]. */
+    @Expose()
+    @IsNumber()
+    @Min(0)
+    tnaAnnual!: number;
+
+    /** IVA sobre intereses (decimal); fijo `0.16` en México. */
+    @Expose()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    ivaOnInterest!: number;
+
+    /** Comisión de apertura (decimal sobre 1); default `0`. */
+    @Expose()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    openingCommissionPct!: number;
+
+    /** Corrimiento de cuotas al pagar fuera de fecha (M6 §4 "Corrimiento"). */
+    @Expose()
+    @IsBoolean()
+    paymentShift!: boolean;
+
+    /** Cota inferior del rango SCI del nivel (0-100); `null` mientras TBD. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    @Max(100)
+    minSciScore!: number | null;
+
+    /** Cota superior del rango SCI del nivel (0-100); `null` mientras TBD. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    @Max(100)
+    maxSciScore!: number | null;
+
+    /** Versión del plan; incrementa en cada publicación de cambios. */
+    @Expose()
+    @IsInt()
+    @Min(1)
+    version!: number;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    validFrom!: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    validUntil!: string | null;
+
+    @Expose()
+    @IsEnum(CreditPlanStatusEnum)
+    status!: CreditPlanStatusEnum;
+
+    @Expose()
+    @IsString()
+    createdBy!: string;
+
+    @Expose()
+    @IsString()
+    updatedBy!: string;
+
+    @Expose()
+    @IsString()
+    @Matches(regexIso8601, { message: 'createdAt debe ser una fecha ISO 8601' })
+    createdAt!: string;
+
+    @Expose()
+    @IsString()
+    @Matches(regexIso8601, { message: 'updatedAt debe ser una fecha ISO 8601' })
+    updatedAt!: string;
+}

package/src/loanOfferings/dtos/Financier.ts

@@ -0,0 +1,91 @@
+import { Expose } from 'class-transformer';
+import {
+    IsArray,
+    IsEnum,
+    IsInt,
+    IsObject,
+    IsOptional,
+    IsString,
+    Matches,
+    Min,
+} from 'class-validator';
+import { regexIso8601 } from '../../helpers/constans/regex';
+import { FinancierStatusEnum } from '../enums/FinancierStatusEnum';
+import { FinancierTypeEnum } from '../enums/FinancierTypeEnum';
+import { ProductTierEnum } from '../enums/ProductTierEnum';
+
+/**
+ * Financier — financiera del catálogo mostrado al cliente (modelo-datos §6.3 · M6 §6).
+ * Entidad completa del dominio `loan-offerings-business` (SureKeep Fase 1 — pista Loan).
+ * SureKeep (INTERNAL) va primero (`displayOrder=1`); las externas después.
+ */
+export class Financier {
+    @Expose()
+    @IsString()
+    financierId!: string;
+
+    /** Grafía canónica: `SUREKEEP` | `PAYJOY` | `KREDIYA` | `LESPAGO`. */
+    @Expose()
+    @IsString()
+    code!: string;
+
+    @Expose()
+    @IsString()
+    name!: string;
+
+    @Expose()
+    @IsEnum(FinancierTypeEnum)
+    type!: FinancierTypeEnum;
+
+    /** Orden de presentación en el wizard (M1 paso 4). Reorder renumera. */
+    @Expose()
+    @IsInt()
+    @Min(1)
+    displayOrder!: number;
+
+    /** Texto mostrado en el wizard (ej. "RECOMENDADO"). */
+    @Expose()
+    @IsString()
+    label!: string;
+
+    /** Solo EXTERNAL: URL de derivación; `null` para INTERNAL. */
+    @Expose()
+    @IsOptional()
+    @IsString()
+    externalRedirectUrl!: string | null;
+
+    /** Gamas que la financiera acepta por defecto; `null` = todas. */
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsEnum(ProductTierEnum, { each: true })
+    eligibleTiers!: ProductTierEnum[] | null;
+
+    /** Configuración específica por financiera; `null` si no aplica. */
+    @Expose()
+    @IsOptional()
+    @IsObject()
+    config!: Record<string, unknown> | null;
+
+    @Expose()
+    @IsEnum(FinancierStatusEnum)
+    status!: FinancierStatusEnum;
+
+    @Expose()
+    @IsString()
+    createdBy!: string;
+
+    @Expose()
+    @IsString()
+    updatedBy!: string;
+
+    @Expose()
+    @IsString()
+    @Matches(regexIso8601, { message: 'createdAt debe ser una fecha ISO 8601' })
+    createdAt!: string;
+
+    @Expose()
+    @IsString()
+    @Matches(regexIso8601, { message: 'updatedAt debe ser una fecha ISO 8601' })
+    updatedAt!: string;
+}

package/src/loanOfferings/dtos/RetailerCreditPlan.ts

@@ -0,0 +1,49 @@
+import { Expose } from 'class-transformer';
+import { IsBoolean, IsOptional, IsString, Matches } from 'class-validator';
+import { regexIso8601 } from '../../helpers/constans/regex';
+
+/**
+ * RetailerCreditPlan — enlace M:N "qué planes ofrece cada retailer" (modelo-datos §6.2).
+ * Activación explícita e idempotente por retailer. Entidad del dominio `loan-offerings-business`.
+ */
+export class RetailerCreditPlan {
+    @Expose()
+    @IsString()
+    retailerId!: string;
+
+    @Expose()
+    @IsString()
+    planId!: string;
+
+    @Expose()
+    @IsBoolean()
+    active!: boolean;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    activatedAt!: string | null;
+
+    @Expose()
+    @IsOptional()
+    @IsString()
+    deactivatedAt!: string | null;
+
+    @Expose()
+    @IsString()
+    createdBy!: string;
+
+    @Expose()
+    @IsString()
+    updatedBy!: string;
+
+    @Expose()
+    @IsString()
+    @Matches(regexIso8601, { message: 'createdAt debe ser una fecha ISO 8601' })
+    createdAt!: string;
+
+    @Expose()
+    @IsString()
+    @Matches(regexIso8601, { message: 'updatedAt debe ser una fecha ISO 8601' })
+    updatedAt!: string;
+}

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

@@ -0,0 +1,13 @@
+import { Expose } from 'class-transformer';
+import { IsEnum } from 'class-validator';
+import { CreditPlanStatusEnum } from '../../enums/CreditPlanStatusEnum';
+
+/**
+ * Body de PUT /credit-plans/:planId/status — activar / inactivar un plan.
+ * Desactivar no afecta créditos existentes; solo deja de estar disponible para nuevas ventas.
+ */
+export class ChangeCreditPlanStatusRequest {
+    @Expose()
+    @IsEnum(CreditPlanStatusEnum)
+    status!: CreditPlanStatusEnum;
+}

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

@@ -0,0 +1,13 @@
+import { Expose } from 'class-transformer';
+import { IsEnum } from 'class-validator';
+import { FinancierStatusEnum } from '../../enums/FinancierStatusEnum';
+
+/**
+ * Body de PUT /financiers/:financierId/status — activar / inactivar una financiera.
+ * Desactivar la quita del wizard sin afectar créditos existentes (M6 §6).
+ */
+export class ChangeFinancierStatusRequest {
+    @Expose()
+    @IsEnum(FinancierStatusEnum)
+    status!: FinancierStatusEnum;
+}

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

@@ -0,0 +1,118 @@
+import { Expose } from 'class-transformer';
+import {
+    ArrayNotEmpty,
+    IsArray,
+    IsBoolean,
+    IsEnum,
+    IsInt,
+    IsNumber,
+    IsOptional,
+    IsString,
+    Max,
+    Min,
+} from 'class-validator';
+import { CreditPlanLevelEnum } from '../../enums/CreditPlanLevelEnum';
+import { ProductTierEnum } from '../../enums/ProductTierEnum';
+import { SaleTypeEnum } from '../../enums/SaleTypeEnum';
+
+/**
+ * Body de POST /credit-plans — alta de un plan (SureKeep Fase 1 — pista Loan).
+ * Campos server-assigned (`planId`, `version`, `ivaOnInterest`=0.16, `status`, auditoría) NO viajan
+ * en el request: los asigna el lambda. `tnaAnnual` en decimal; rango de negocio [2.00, 2.60].
+ */
+export class CreateCreditPlanRequest {
+    @Expose()
+    @IsString()
+    code!: string;
+
+    @Expose()
+    @IsString()
+    name!: string;
+
+    @Expose()
+    @IsString()
+    description!: string;
+
+    @Expose()
+    @IsEnum(CreditPlanLevelEnum)
+    level!: CreditPlanLevelEnum;
+
+    @Expose()
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsEnum(SaleTypeEnum, { each: true })
+    saleTypes!: SaleTypeEnum[];
+
+    @Expose()
+    @IsOptional()
+    @IsArray()
+    @IsEnum(ProductTierEnum, { each: true })
+    eligibleTiers?: ProductTierEnum[] | null;
+
+    @Expose()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    minDownPaymentPct!: number;
+
+    @Expose()
+    @IsOptional()
+    @IsNumber()
+    @Min(0)
+    @Max(1)
+    maxDownPaymentPct?: number | null;
+
+    @Expose()
+    @IsArray()
+    @ArrayNotEmpty()
+    @IsInt({ each: true })
+    @Min(1, { each: true })
+    termWeeksOptions!: number[];
+
+    @Expose()
+    @IsInt()
+    @Min(0)
+    maxFinancedAmountCents!: number;
+
+    @Expose()
+    @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/CreateFinancierRequest.ts

@@ -0,0 +1,57 @@
+import { Expose } from 'class-transformer';
+import {
+    IsArray,
+    IsEnum,
+    IsInt,
+    IsObject,
+    IsOptional,
+    IsString,
+    Min,
+} from 'class-validator';
+import { FinancierTypeEnum } from '../../enums/FinancierTypeEnum';
+import { ProductTierEnum } from '../../enums/ProductTierEnum';
+
+/**
+ * Body de POST /financiers — alta de una financiera (SureKeep Fase 1 — pista Loan).
+ * `financierId` y auditoría los asigna el lambda; `status` default ACTIVE. `displayOrder` opcional
+ * (si no viene, se coloca al final del catálogo).
+ */
+export class CreateFinancierRequest {
+    @Expose()
+    @IsString()
+    code!: string;
+
+    @Expose()
+    @IsString()
+    name!: string;
+
+    @Expose()
+    @IsEnum(FinancierTypeEnum)
+    type!: FinancierTypeEnum;
+
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(1)
+    displayOrder?: number;
+
+    @Expose()
+    @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/requests/ReorderFinancierRequest.ts

@@ -0,0 +1,13 @@
+import { Expose } from 'class-transformer';
+import { IsInt, Min } from 'class-validator';
+
+/**
+ * Body de PUT /financiers/:financierId/reorder — nueva posición en el catálogo.
+ * El lambda renumera el resto de forma contigua (M6 §6 · flow 06 §6.2.1).
+ */
+export class ReorderFinancierRequest {
+    @Expose()
+    @IsInt()
+    @Min(1)
+    displayOrder!: number;
+}