@fiado/type-kit 3.152.0 → 3.154.0

package/bin/walletFunding/dtos/CancelFundingResponse.d.ts

@@ -0,0 +1,14 @@
+import { BenefitPaymentStatusEnum } from "../../benefitCenter/enums/BenefitPaymentStatusEnum";
+import { WalletFundingErrorCodeEnum } from "../enums/WalletFundingErrorCodeEnum";
+/**
+ * Response del cancel via Centro de Beneficios (spec 13 v2.0).
+ * `status` reusa `BenefitPaymentStatusEnum` (APPROVED = cancel aceptado;
+ * REJECTED = no se pudo) para consistencia con `CancelFundingReferenceResponse`
+ * (marketplace ↔ connector). Idempotente: re-cancelar devuelve APPROVED.
+ */
+export declare class CancelFundingResponse {
+    fundingId: string;
+    status: BenefitPaymentStatusEnum;
+    errorCode?: WalletFundingErrorCodeEnum;
+    message?: string;
+}

package/bin/walletFunding/dtos/CancelFundingResponse.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelFundingResponse = void 0;
+/**
+ * Response del cancel via Centro de Beneficios (spec 13 v2.0).
+ * `status` reusa `BenefitPaymentStatusEnum` (APPROVED = cancel aceptado;
+ * REJECTED = no se pudo) para consistencia con `CancelFundingReferenceResponse`
+ * (marketplace ↔ connector). Idempotente: re-cancelar devuelve APPROVED.
+ */
+class CancelFundingResponse {
+}
+exports.CancelFundingResponse = CancelFundingResponse;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/type-kit",
-  "version": "3.152.0",
+  "version": "3.154.0",
   "description": "",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/src/remittance/dtos/RemittancePricing.ts

@@ -0,0 +1,184 @@
+import { Type } from "class-transformer";
+import {
+    ArrayMaxSize,
+    ArrayMinSize,
+    IsArray,
+    IsEnum,
+    IsInt,
+    IsNumber,
+    IsOptional,
+    IsString,
+    Length,
+    Max,
+    MaxLength,
+    Min,
+    ValidateNested,
+} from "class-validator";
+import { RemittanceCorridor } from "../enums/RemittanceCorridor";
+
+/**
+ * DTOs de Precio Base (Dashboard Ops · Variables Operativas §1).
+ *
+ * Una combinación (corridor × segmento) define el markup FX (bps CON SIGNO:
+ * + Fiado gana spread; − Fiado subsidia, retail > wholesale) y los service fees
+ * escalonados por tramo de monto. Dueño de la tabla: remittance-business
+ * (RemittancePricing_GT). Cambios inmediatos al guardar; lo temporal vive en
+ * Promociones. retail = wholesale × (1 − markupBps/10000), SIN clampear
+ * (el tope ≤ base de UNIR es transitorio).
+ */
+
+/** Tramo de service fee. Matching = MAYOR amountMin ≤ monto (amountMax es SOLO display). */
+export class PricingTier {
+    @IsNumber()
+    @Min(1)
+    amountMin!: number;
+
+    /** Display ("$1–$49"); null/ausente = sin tope (último tramo). El matching NO lo usa. */
+    @IsOptional()
+    @IsNumber()
+    amountMax?: number | null;
+
+    @IsNumber()
+    @Min(0)
+    @Max(100)
+    serviceFee!: number;
+
+    /** ISO date (YYYY-MM-DD) "FEE DESDE" — informativo. */
+    @IsString()
+    @Length(10, 10)
+    effectiveFrom!: string;
+}
+
+/** Body de POST /backoffice/pricing/base. */
+export class CreatePricingRequest {
+    @IsEnum(RemittanceCorridor)
+    corridor!: RemittanceCorridor;
+
+    @IsString()
+    @Length(1, 100)
+    segmentId!: string;
+
+    /** CON SIGNO: + Fiado gana spread; − Fiado subsidia (retail > wholesale). */
+    @IsInt()
+    @Min(-500)
+    @Max(500)
+    markupBps!: number;
+
+    @IsArray()
+    @ArrayMinSize(1)
+    @ArrayMaxSize(20)
+    @ValidateNested({ each: true })
+    @Type(() => PricingTier)
+    tramos!: PricingTier[];
+
+    @IsOptional()
+    @IsString()
+    @MaxLength(100)
+    name?: string;
+
+    @IsOptional()
+    @IsString()
+    @MaxLength(500)
+    notes?: string;
+}
+
+/** Body de PUT /backoffice/pricing/base/{id} (reemplazo completo; corridor/segmentId inmutables). */
+export class UpdatePricingRequest {
+    @IsInt()
+    @Min(-500)
+    @Max(500)
+    markupBps!: number;
+
+    @IsArray()
+    @ArrayMinSize(1)
+    @ArrayMaxSize(20)
+    @ValidateNested({ each: true })
+    @Type(() => PricingTier)
+    tramos!: PricingTier[];
+
+    @IsOptional()
+    @IsString()
+    @MaxLength(100)
+    name?: string;
+
+    @IsOptional()
+    @IsString()
+    @MaxLength(500)
+    notes?: string;
+}
+
+/** Combinación completa (response de list/create/update). */
+export class PricingCombination {
+    id!: string;
+    corridor!: RemittanceCorridor;
+    segmentId!: string;
+    /** Display resuelto contra RemittanceSegments_GT ("Premium"); segmentId si no resoluble. */
+    segmentName!: string;
+    markupBps!: number;
+    tramos!: PricingTier[];
+    /** # promos activas que aplican a la combinación. 0 hasta que exista Promociones. */
+    promosCount!: number;
+    name!: string | null;
+    notes!: string | null;
+    createdAt!: string;
+    updatedAt!: string;
+    createdBy!: string;
+    updatedBy!: string;
+}
+
+/** Response de GET /backoffice/pricing/base. */
+export class PricingListResponse {
+    items!: PricingCombination[];
+}
+
+/** Response de GET /backoffice/pricing/base/{id}/metrics. */
+export class PricingCombinationMetrics {
+    /** Miembros del segmento con ≥1 tx no-cancelada al corredor (histórica). */
+    clientCount!: number;
+    /** Σ amountUSD del mes calendario (UTC) de esas tx al corredor, sin CANCELLED/REFUND. */
+    volMonthUSD!: number;
+}
+
+/** Body de POST /backoffice/pricing/simulate (valores del panel — pueden NO estar guardados). */
+export class SimulatePricingRequest {
+    @IsEnum(RemittanceCorridor)
+    corridor!: RemittanceCorridor;
+
+    @IsNumber()
+    @Min(1)
+    amountUSD!: number;
+
+    @IsInt()
+    @Min(-500)
+    @Max(500)
+    markupBps!: number;
+
+    @IsArray()
+    @ArrayMinSize(1)
+    @ArrayMaxSize(20)
+    @ValidateNested({ each: true })
+    @Type(() => PricingTier)
+    tramos!: PricingTier[];
+}
+
+export class SimulatePricingResponse {
+    /** ExternalQuickQuotes (vivo). */
+    wholesale!: number;
+    /** round4(wholesale × (1 − markupBps/10000)) — SIN clampear (markup negativo ⇒ retail > wholesale). */
+    retail!: number;
+    /** Del tramo matcheado (mayor amountMin ≤ amountUSD). */
+    serviceFee!: number;
+    /** round2(amountUSD × retail), en moneda destino. */
+    receives!: number;
+    /** amountUSD + serviceFee (el stateFee lo calcula UNIR; prod US = 0). */
+    totalToPay!: number;
+    /** ISO del quote. */
+    asOf!: string;
+}
+
+/** Response de GET /backoffice/pricing/wholesale?corridor= (rb passthrough del connector). */
+export class WholesaleRateResponse {
+    corridor!: RemittanceCorridor;
+    wholesale!: number;
+    asOf!: string;
+}

package/src/remittance/dtos/RemittancePromotion.ts

@@ -0,0 +1,162 @@
+import { Type } from "class-transformer";
+import {
+    IsEnum,
+    IsInt,
+    IsNumber,
+    IsOptional,
+    IsString,
+    Length,
+    Matches,
+    Max,
+    MaxLength,
+    Min,
+    ValidateNested,
+} from "class-validator";
+import { FeeEffectMode } from "../enums/FeeEffectMode";
+import { FxEffectMode } from "../enums/FxEffectMode";
+import { PromotionActivation } from "../enums/PromotionActivation";
+import { PromotionKind } from "../enums/PromotionKind";
+import { PromotionStatus } from "../enums/PromotionStatus";
+import { RemittanceCorridor } from "../enums/RemittanceCorridor";
+
+/**
+ * DTOs de Promociones (Dashboard Ops · Variables Operativas §2).
+ *
+ * UniTeller NO participa (no hay motor de promos en API Lite): toda la lógica
+ * vive en Fiado. Una promo es un OVERRIDE de Precio Base (markup y/o fee) para
+ * una audiencia (corridor × segmento × cohort, null = Cualquiera) y vigencia.
+ * Dueño de la tabla: remittance-business (RemittancePromotions_GT). La
+ * resolución en send-time (capas: base → PRICE_CHANGE → mejor-para-el-cliente)
+ * es Fase B — estos DTOs cubren la config.
+ */
+
+const ISO_DATE = /^\d{4}-\d{2}-\d{2}$/;
+
+/** Audiencia: null en una dimensión = "Cualquiera". */
+export class PromotionAudience {
+    @IsOptional()
+    @IsEnum(RemittanceCorridor)
+    corridor?: RemittanceCorridor | null;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 100)
+    segmentId?: string | null;
+
+    @IsOptional()
+    @IsString()
+    @Length(1, 100)
+    cohortId?: string | null;
+}
+
+/** Efecto FX (spread): DELTA suma bps CON SIGNO al markup base; ABSOLUTE lo reemplaza. */
+export class FxEffect {
+    @IsEnum(FxEffectMode)
+    mode!: FxEffectMode;
+
+    /** bps con signo. Ignorado si mode=NONE (mandar 0). */
+    @IsInt()
+    @Min(-500)
+    @Max(500)
+    valueBps!: number;
+}
+
+/** Efecto fee: ABSOLUTE = $; DELTA = ±$; PERCENTAGE = −% del fee (0-100). */
+export class FeeEffect {
+    @IsEnum(FeeEffectMode)
+    mode!: FeeEffectMode;
+
+    @IsNumber()
+    @Min(-100)
+    @Max(100)
+    value!: number;
+}
+
+export class CreatePromotionRequest {
+    @IsString()
+    @Length(3, 100)
+    name!: string;
+
+    @IsEnum(PromotionKind)
+    kind!: PromotionKind;
+
+    @IsEnum(PromotionActivation)
+    activation!: PromotionActivation;
+
+    /** Requerido si activation=CODE (regla en manager); único case-insensitive. */
+    @IsOptional()
+    @IsString()
+    @Length(3, 30)
+    @Matches(/^[A-Z0-9_-]+$/i)
+    code?: string | null;
+
+    @ValidateNested()
+    @Type(() => PromotionAudience)
+    audience!: PromotionAudience;
+
+    /** ISO date (YYYY-MM-DD). */
+    @IsString()
+    @Matches(ISO_DATE)
+    effectiveFrom!: string;
+
+    /** ISO date; null/ausente = permanente (∞). */
+    @IsOptional()
+    @IsString()
+    @Matches(ISO_DATE)
+    effectiveTo?: string | null;
+
+    @ValidateNested()
+    @Type(() => FxEffect)
+    fxEffect!: FxEffect;
+
+    @ValidateNested()
+    @Type(() => FeeEffect)
+    feeEffect!: FeeEffect;
+
+    @IsOptional()
+    @IsString()
+    @MaxLength(500)
+    notes?: string | null;
+}
+
+/** PUT — reemplazo completo (mismos campos que create). */
+export class UpdatePromotionRequest extends CreatePromotionRequest {
+}
+
+/** Promoción completa (response de list/create/update). */
+export class Promotion {
+    id!: string;
+    name!: string;
+    kind!: PromotionKind;
+    activation!: PromotionActivation;
+    code!: string | null;
+    audience!: { corridor: RemittanceCorridor | null; segmentId: string | null; cohortId: string | null };
+    /** Display: nombres resueltos de segmento/cohort (null = "Cualquiera" o no resoluble). */
+    audienceDisplay!: { corridor: string | null; segmentName: string | null; cohortName: string | null };
+    effectiveFrom!: string;
+    effectiveTo!: string | null;
+    fxEffect!: { mode: FxEffectMode; valueBps: number };
+    feeEffect!: { mode: FeeEffectMode; value: number };
+    /** Derivado de la vigencia vs hoy (UTC). */
+    status!: PromotionStatus;
+    /** Legible para la columna EFECTO: "MU −30 bps + Fee = $0". */
+    effectSummary!: string;
+    notes!: string | null;
+    createdAt!: string;
+    updatedAt!: string;
+    createdBy!: string;
+    updatedBy!: string;
+}
+
+/** Response de GET /backoffice/pricing/promotions. */
+export class PromotionListResponse {
+    items!: Promotion[];
+}
+
+/** Response de GET /backoffice/pricing/promotions/reach. */
+export class PromotionReachResponse {
+    /** Clientes en la intersección corridor × segmento × cohort. */
+    reach!: number;
+    /** Universo (todos los RemittanceUsers) — para el % del picker. */
+    total!: number;
+}

package/src/remittance/dtos/index.ts

@@ -40,3 +40,5 @@ export * from "./RemittanceCohort";
 export * from "./RemittanceAuditLog";
 export * from "./RemittanceSegment";
 export * from "./RemittanceCommittee";
+export * from "./RemittancePricing";
+export * from "./RemittancePromotion";

package/src/remittance/dtos/internal/RemittancePricingBridge.ts

@@ -0,0 +1,36 @@
+import { IsArray, IsEnum, IsUUID } from "class-validator";
+import { RemittanceCorridor } from "../../enums/RemittanceCorridor";
+
+/**
+ * Contratos internos del puente de Precio Base (Opción A, como
+ * RemittanceSegmentMetrics): remittance-business resuelve la membresía del
+ * segmento y el uniteller-connector (dueño de RemittanceUsers_GT /
+ * RemittanceTransactions_GT y de la integración UNIR) computa.
+ */
+
+/** POST /backoffice/pricing/wholesale (privado connector): wholesale vivo de ExternalQuickQuotes. */
+export class WholesaleRateRequest {
+    @IsEnum(RemittanceCorridor)
+    corridor!: RemittanceCorridor;
+}
+
+/**
+ * POST /backoffice/config/pricing/metrics (privado connector). El filtro de
+ * corredor se hace por countryISO (CORRIDOR_INFO — no ambiguo con USD-SVC).
+ */
+export class PricingMetricsRequest {
+    /** Miembros del segmento ya resueltos por rb. `[]` → { clientCount: 0, volMonthUSD: 0 }. */
+    @IsArray()
+    @IsUUID("4", { each: true })
+    directoryIds!: string[];
+
+    @IsEnum(RemittanceCorridor)
+    corridor!: RemittanceCorridor;
+}
+
+export class PricingMetricsResponse {
+    /** ids del request con ≥1 tx no-cancelada al corredor (histórica). */
+    clientCount!: number;
+    /** Σ amountUSD del mes calendario corriente (UTC) de esas tx al corredor, sin CANCELLED/REFUND. */
+    volMonthUSD!: number;
+}

package/src/remittance/dtos/internal/RemittancePromotionReach.ts

@@ -0,0 +1,31 @@
+import { Type } from "class-transformer";
+import { IsArray, IsEnum, IsOptional, IsUUID, ValidateNested } from "class-validator";
+import { CohortCondition } from "../RemittanceCohort";
+import { RemittanceCorridor } from "../../enums/RemittanceCorridor";
+
+/**
+ * Contrato interno del reach de Promociones (puente Opción A):
+ * POST /backoffice/config/promotions/reach (privado connector). rb resuelve las
+ * dimensiones a datos crudos — segmento → directoryIds; cohort → conditions;
+ * corredor → corridor — y el connector computa la intersección sobre el universo
+ * de RemittanceUsers. Toda dimensión AUSENTE = no filtra ("Cualquiera").
+ */
+export class PromotionReachRequest {
+    /** Miembros del segmento (resueltos por rb). Ausente = todos los usuarios. */
+    @IsOptional()
+    @IsArray()
+    @IsUUID("4", { each: true })
+    directoryIds?: string[];
+
+    /** Condiciones del cohort (AND, evaluadas como en cohortCount). Ausente = sin filtro. */
+    @IsOptional()
+    @IsArray()
+    @ValidateNested({ each: true })
+    @Type(() => CohortCondition)
+    conditions?: CohortCondition[];
+
+    /** Filtro por corredor (countryISO de CORRIDOR_INFO, ≥1 tx no-cancelada histórica). Ausente = sin filtro. */
+    @IsOptional()
+    @IsEnum(RemittanceCorridor)
+    corridor?: RemittanceCorridor;
+}

package/src/remittance/enums/FeeEffectMode.ts

@@ -0,0 +1,7 @@
+/** Efecto de la promo sobre el service fee (relativo a la base efectiva). */
+export enum FeeEffectMode {
+    NONE = "NONE",               // sin cambio
+    ABSOLUTE = "ABSOLUTE",       // fee = value (USD)
+    DELTA = "DELTA",             // baseFee + value (CON SIGNO)
+    PERCENTAGE = "PERCENTAGE",   // baseFee × (1 − value/100), value 0-100
+}

package/src/remittance/enums/FxEffectMode.ts

@@ -0,0 +1,6 @@
+/** Efecto de la promo sobre el spread FX (relativo a la base efectiva). */
+export enum FxEffectMode {
+    NONE = "NONE",           // sin cambio
+    DELTA = "DELTA",         // baseMarkup + valueBps (CON SIGNO)
+    ABSOLUTE = "ABSOLUTE",   // markup = valueBps
+}

package/src/remittance/enums/PromotionActivation.ts

@@ -0,0 +1,7 @@
+/** Cómo se activa la promo para el cliente. */
+export enum PromotionActivation {
+    /** Auto-aplica a toda la audiencia. */
+    AUTOMATIC = "AUTOMATIC",
+    /** El cliente teclea el código en la app (habilita SOLO esa promo). */
+    CODE = "CODE",
+}

package/src/remittance/enums/PromotionKind.ts

@@ -0,0 +1,9 @@
+/** Tipo de promoción (Variables Operativas › Promociones — mockup). */
+export enum PromotionKind {
+    /** Descuento promocional temporal (puede tener código). */
+    PROMO = "PROMO",
+    /** Cambio de BASE programado (overlay absoluto; NO muta RemittancePricing_GT). */
+    PRICE_CHANGE = "PRICE_CHANGE",
+    /** Override permanente por audiencia (VIP, Onboarding sin fee, …). */
+    PREFERENTIAL = "PREFERENTIAL",
+}

package/src/remittance/enums/PromotionStatus.ts

@@ -0,0 +1,7 @@
+/** Estado DERIVADO de effectiveFrom/To vs hoy (UTC). NO se persiste. */
+export enum PromotionStatus {
+    ACTIVE = "ACTIVE",         // vigente con fecha de fin
+    SCHEDULED = "SCHEDULED",   // programada (hoy < from)
+    PERMANENT = "PERMANENT",   // vigente sin fin (effectiveTo null)
+    EXPIRED = "EXPIRED",       // vencida (hoy > to)
+}

package/src/remittance/enums/RemittanceCorridor.ts

@@ -0,0 +1,22 @@
+/**
+ * Corredores de remesa soportados (Dashboard Ops · Variables Operativas).
+ *
+ * D-PB-3: nomenclatura por MONEDA ISO-4217 (`USD-<destino>`). `USD_SVC` es un
+ * símbolo para El Salvador (su payout real es USD; usar la moneda colisionaría
+ * como "USD-USD"). Por eso el destino real vive en CORRIDOR_INFO y el filtro de
+ * transacciones usa countryISO (no ambiguo).
+ */
+export enum RemittanceCorridor {
+    USD_GTQ = "USD-GTQ",
+    USD_MXN = "USD-MXN",
+    USD_HNL = "USD-HNL",
+    USD_SVC = "USD-SVC",
+}
+
+/** Destino real del corredor. El filtro de tx usa countryISO; currencyISO es el payout. */
+export const CORRIDOR_INFO: Record<RemittanceCorridor, { countryISO: string; currencyISO: string }> = {
+    [RemittanceCorridor.USD_GTQ]: { countryISO: "GT", currencyISO: "GTQ" },
+    [RemittanceCorridor.USD_MXN]: { countryISO: "MX", currencyISO: "MXN" },
+    [RemittanceCorridor.USD_HNL]: { countryISO: "HN", currencyISO: "HNL" },
+    [RemittanceCorridor.USD_SVC]: { countryISO: "SV", currencyISO: "USD" },
+};

package/src/remittance/enums/index.ts

@@ -11,3 +11,9 @@ export * from "./CohortRefresh";
 export * from "./AuditAction";
 export * from "./AuditEntityType";
 export * from "./SegmentMemberType";
+export * from "./RemittanceCorridor";
+export * from "./PromotionKind";
+export * from "./PromotionActivation";
+export * from "./PromotionStatus";
+export * from "./FxEffectMode";
+export * from "./FeeEffectMode";

package/src/remittance/index.ts

@@ -6,3 +6,5 @@ export * from "./dtos/internal/RemittanceCreditBackRequest";
 export * from "./dtos/internal/RemittanceCreditBackResponse";
 export * from "./dtos/internal/RemittanceCohortCount";
 export * from "./dtos/internal/RemittanceSegmentMetrics";
+export * from "./dtos/internal/RemittancePricingBridge";
+export * from "./dtos/internal/RemittancePromotionReach";

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

@@ -1,9 +0,0 @@
-/**
- * Body del PUT /me/profile/complete (autenticado, gate post-MFA del autoregistro). DEC-RBAC-034.
- * Opera sobre el propio usuario (cognitoSub del token). Valida nombre + los `userFieldDefs` requeridos
- * del tenant (422 MISSING_REQUIRED_FIELDS si faltan) y flipea `profileComplete=true`.
- */
-export declare class CompleteMyProfileRequest {
-    displayName: string;
-    customFields?: Record<string, string>;
-}