@fiado/type-kit 3.490.0 → 3.492.0

package/bin/retailLoan/enums/MyPaymentTypeEnum.js

@@ -1,10 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MyPaymentTypeEnum = void 0;
-/** Pago que el cliente pide desde la app. `ADVANCE` = varias cuotas. */
+/** Pago que el cliente pide desde la app. `ADVANCE` = varias cuotas; `PREPAYMENT` = abono a capital. */
 var MyPaymentTypeEnum;
 (function (MyPaymentTypeEnum) {
     MyPaymentTypeEnum["NEXT_INSTALLMENT"] = "NEXT_INSTALLMENT";
     MyPaymentTypeEnum["ADVANCE"] = "ADVANCE";
     MyPaymentTypeEnum["SETTLEMENT"] = "SETTLEMENT";
+    MyPaymentTypeEnum["PREPAYMENT"] = "PREPAYMENT";
 })(MyPaymentTypeEnum || (exports.MyPaymentTypeEnum = MyPaymentTypeEnum = {}));

package/bin/retailWizard/enums/RetailCommissionInboundMessageTypeEnum.d.ts

@@ -0,0 +1,5 @@
+/** Tipo de mensaje que el wizard publica en la cola de Comisiones. */
+export declare enum RetailCommissionInboundMessageTypeEnum {
+    SALE_COMPLETED = "SALE_COMPLETED",
+    SALE_CANCELLED = "SALE_CANCELLED"
+}

package/bin/retailWizard/enums/RetailCommissionInboundMessageTypeEnum.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetailCommissionInboundMessageTypeEnum = void 0;
+/** Tipo de mensaje que el wizard publica en la cola de Comisiones. */
+var RetailCommissionInboundMessageTypeEnum;
+(function (RetailCommissionInboundMessageTypeEnum) {
+    RetailCommissionInboundMessageTypeEnum["SALE_COMPLETED"] = "SALE_COMPLETED";
+    RetailCommissionInboundMessageTypeEnum["SALE_CANCELLED"] = "SALE_CANCELLED";
+})(RetailCommissionInboundMessageTypeEnum || (exports.RetailCommissionInboundMessageTypeEnum = RetailCommissionInboundMessageTypeEnum = {}));

package/bin/retailWizard/events/RetailCommissionInboundMessage.d.ts

@@ -1,19 +1,45 @@
 import { ItemTypeEnum } from '../../retailCatalog/enums/ItemTypeEnum';
+import { ProductCategoryEnum } from '../../retailCatalog/enums/ProductCategoryEnum';
+import { ProductTierEnum } from '../../retailCatalog/enums/ProductTierEnum';
+import { ExternalProviderEnum } from '../enums/ExternalProviderEnum';
+import { LinePaymentTypeEnum } from '../enums/LinePaymentTypeEnum';
+import { RetailCommissionInboundMessageTypeEnum } from '../enums/RetailCommissionInboundMessageTypeEnum';
+import { SaleTypeEnum } from '../enums/SaleTypeEnum';
+import { WizardLineRoleEnum } from '../enums/WizardLineRoleEnum';
 /** Línea vendida en el mensaje de comisiones. */
 export declare class RetailCommissionInboundLine {
+    lineId: string;
     sku: string;
     qty: number;
     /** Precio neto de la línea (precio − descuento). */
     netCents: number;
     itemType: ItemTypeEnum;
+    /** `null` si la línea no trae la ficha del producto. */
+    category: ProductCategoryEnum | null;
+    /** `null` = sin gama. */
+    tier: ProductTierEnum | null;
+    brand: string | null;
+    paymentType: LinePaymentTypeEnum;
+    role?: WizardLineRoleEnum;
 }
-/** Venta de la saga que el wizard publica en la cola de comisiones, con sus líneas. */
+/** Venta cerrada o cancelada que el wizard publica en RetailCommissionInboundQueue. */
 export declare class RetailCommissionInboundMessage {
+    type: RetailCommissionInboundMessageTypeEnum;
     tenantId: string;
     retailerId: string;
     storeId: string;
     saleId: string;
     sessionId: string;
+    /** Quién vendió. */
+    sellerRetailUserId: string;
+    saleType: SaleTypeEnum;
+    /** Solo en EXTERNAL_REFERRAL. */
+    externalProvider: ExternalProviderEnum | null;
+    creditId: string | null;
     soldAt: string;
+    /** soldAt en la venta; cancelledAt en la cancelación. */
+    occurredAt: string;
+    /** Motivo de la cancelación; puede venir vacío. */
+    cancelReason?: string;
     lines: RetailCommissionInboundLine[];
 }

package/bin/retailWizard/events/RetailCommissionInboundMessage.js

@@ -13,10 +13,22 @@ exports.RetailCommissionInboundMessage = exports.RetailCommissionInboundLine = v
 const class_transformer_1 = require("class-transformer");
 const class_validator_1 = require("class-validator");
 const ItemTypeEnum_1 = require("../../retailCatalog/enums/ItemTypeEnum");
+const ProductCategoryEnum_1 = require("../../retailCatalog/enums/ProductCategoryEnum");
+const ProductTierEnum_1 = require("../../retailCatalog/enums/ProductTierEnum");
+const ExternalProviderEnum_1 = require("../enums/ExternalProviderEnum");
+const LinePaymentTypeEnum_1 = require("../enums/LinePaymentTypeEnum");
+const RetailCommissionInboundMessageTypeEnum_1 = require("../enums/RetailCommissionInboundMessageTypeEnum");
+const SaleTypeEnum_1 = require("../enums/SaleTypeEnum");
+const WizardLineRoleEnum_1 = require("../enums/WizardLineRoleEnum");
 /** Línea vendida en el mensaje de comisiones. */
 class RetailCommissionInboundLine {
 }
 exports.RetailCommissionInboundLine = RetailCommissionInboundLine;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], RetailCommissionInboundLine.prototype, "lineId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
@@ -36,10 +48,38 @@ __decorate([
     (0, class_validator_1.IsEnum)(ItemTypeEnum_1.ItemTypeEnum),
     __metadata("design:type", String)
 ], RetailCommissionInboundLine.prototype, "itemType", void 0);
-/** Venta de la saga que el wizard publica en la cola de comisiones, con sus líneas. */
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(ProductCategoryEnum_1.ProductCategoryEnum),
+    __metadata("design:type", String)
+], RetailCommissionInboundLine.prototype, "category", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(ProductTierEnum_1.ProductTierEnum),
+    __metadata("design:type", String)
+], RetailCommissionInboundLine.prototype, "tier", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], RetailCommissionInboundLine.prototype, "brand", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(LinePaymentTypeEnum_1.LinePaymentTypeEnum),
+    __metadata("design:type", String)
+], RetailCommissionInboundLine.prototype, "paymentType", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(WizardLineRoleEnum_1.WizardLineRoleEnum),
+    __metadata("design:type", String)
+], RetailCommissionInboundLine.prototype, "role", void 0);
+/** Venta cerrada o cancelada que el wizard publica en RetailCommissionInboundQueue. */
 class RetailCommissionInboundMessage {
 }
 exports.RetailCommissionInboundMessage = RetailCommissionInboundMessage;
+__decorate([
+    (0, class_validator_1.IsEnum)(RetailCommissionInboundMessageTypeEnum_1.RetailCommissionInboundMessageTypeEnum),
+    __metadata("design:type", String)
+], RetailCommissionInboundMessage.prototype, "type", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     (0, class_validator_1.IsNotEmpty)(),
@@ -65,10 +105,39 @@ __decorate([
     (0, class_validator_1.IsNotEmpty)(),
     __metadata("design:type", String)
 ], RetailCommissionInboundMessage.prototype, "sessionId", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], RetailCommissionInboundMessage.prototype, "sellerRetailUserId", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(SaleTypeEnum_1.SaleTypeEnum),
+    __metadata("design:type", String)
+], RetailCommissionInboundMessage.prototype, "saleType", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(ExternalProviderEnum_1.ExternalProviderEnum),
+    __metadata("design:type", String)
+], RetailCommissionInboundMessage.prototype, "externalProvider", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], RetailCommissionInboundMessage.prototype, "creditId", void 0);
 __decorate([
     (0, class_validator_1.IsISO8601)(),
     __metadata("design:type", String)
 ], RetailCommissionInboundMessage.prototype, "soldAt", void 0);
+__decorate([
+    (0, class_validator_1.IsISO8601)(),
+    __metadata("design:type", String)
+], RetailCommissionInboundMessage.prototype, "occurredAt", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], RetailCommissionInboundMessage.prototype, "cancelReason", void 0);
 __decorate([
     (0, class_validator_1.IsArray)(),
     (0, class_validator_1.ArrayMinSize)(1),

package/bin/retailWizard/index.d.ts

@@ -139,6 +139,7 @@ export * from './events/SaleCompletedV2';
 export * from './events/SaleCancelledV2';
 export * from './events/SessionExpiredV1';
 export * from './enums/RetailPromotionInboundMessageTypeEnum';
+export * from './enums/RetailCommissionInboundMessageTypeEnum';
 export * from './events/RetailPromotionInboundMessage';
 export * from './events/RetailCommissionInboundMessage';
 export * from './enums/WizardSessionLookupStatusEnum';

package/bin/retailWizard/index.js

@@ -170,6 +170,7 @@ __exportStar(require("./events/SaleCompletedV2"), exports);
 __exportStar(require("./events/SaleCancelledV2"), exports);
 __exportStar(require("./events/SessionExpiredV1"), exports);
 __exportStar(require("./enums/RetailPromotionInboundMessageTypeEnum"), exports);
+__exportStar(require("./enums/RetailCommissionInboundMessageTypeEnum"), exports);
 __exportStar(require("./events/RetailPromotionInboundMessage"), exports);
 __exportStar(require("./events/RetailCommissionInboundMessage"), exports);
 // Lookup privado por lote (GET /private/wizard-sessions/batch)

package/package.json

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

package/src/loanCredit/dtos/InstallmentPaidEvent.ts

@@ -0,0 +1,20 @@
+import type { LoanInstallmentStatusEnum } from '../enums/LoanInstallmentStatusEnum';
+
+/** `eventType` del outbox cuando una cuota queda pagada. */
+export const INSTALLMENT_PAID_EVENT_TYPE = 'InstallmentPaidV1';
+
+/**
+ * Payload de `InstallmentPaidV1`: una cuota que pasó a `PAID` o `PAID_IN_ADVANCE` por cualquier
+ * camino (cargo de la cuota, revisión, adelanto, liquidación o recuperación). Se escribe al outbox en
+ * la misma transacción que la cuota. Sin PII.
+ */
+export interface InstallmentPaidV1Payload {
+    creditId: string;
+    installmentNumber: number;
+    /** Lo pagado de la cuota en total (capital + interés + IVA), en centavos. */
+    paidCents: number;
+    /** Instante del pago (ISO): decide el corte de la renta. */
+    paidAt: string;
+    installmentStatus: LoanInstallmentStatusEnum;
+    paymentId: string;
+}

package/src/loanCredit/dtos/requests/CreateCustomerPaymentRequest.ts

@@ -1,5 +1,5 @@
 import { Expose } from 'class-transformer';
-import { IsEnum, IsInt, IsUUID, Min } from 'class-validator';
+import { IsEnum, IsInt, IsOptional, IsUUID, Min } from 'class-validator';
 import { LoanCustomerPaymentTypeEnum } from '../../enums/LoanCustomerPaymentTypeEnum';
 
 /** Body de `POST /private/customers/:directoryId/credits/:creditId/payments` (loan-credit-business). */
@@ -8,7 +8,7 @@ export class CreateCustomerPaymentRequest {
     @IsEnum(LoanCustomerPaymentTypeEnum)
     type!: LoanCustomerPaymentTypeEnum;
 
-    /** Monto que vio el cliente; si ya no coincide, responde 409 CUSTOMER_PAYMENT_AMOUNT_CHANGED. */
+    /** Monto que vio el cliente (en PREPAYMENT, el que eligió); si ya no coincide, responde 409 CUSTOMER_PAYMENT_AMOUNT_CHANGED. */
     @Expose()
     @IsInt()
     @Min(1)
@@ -18,4 +18,11 @@ export class CreateCustomerPaymentRequest {
     @Expose()
     @IsUUID()
     idempotencyKey!: string;
+
+    /** Solo ADVANCE: cuántas cuotas adelanta. */
+    @Expose()
+    @IsOptional()
+    @IsInt()
+    @Min(2)
+    installmentCount?: number;
 }

package/src/loanCredit/dtos/responses/LoanCustomerPaymentOptions.ts

@@ -10,19 +10,42 @@ export interface LoanCustomerPaymentOption {
     amountCents?: number;
 }
 
+/** Una cuota que se puede adelantar. */
+export interface LoanCustomerAdvanceInstallment {
+    installmentNumber: number;
+    /** `YYYY-MM-DD`. */
+    dueDate: string;
+    amountCents: number;
+}
+
 /** Response de `GET /private/customers/:directoryId/credits/:creditId/payment-options`. Montos en cents. */
 export interface LoanCustomerPaymentOptions {
     creditId: string;
     /** Cargo ad hoc en curso; mientras exista, ninguna opción está disponible. */
-    pendingCharge?: { kind: LoanAdHocChargeKindEnum; amountCents: number };
+    pendingCharge?: {
+        kind: LoanAdHocChargeKindEnum;
+        amountCents: number;
+        /** Solo en un adelanto: las cuotas que cubre. */
+        installmentNumbers?: number[];
+    };
     nextInstallment: LoanCustomerPaymentOption & {
         mode?: LoanNextInstallmentModeEnum;
         installmentNumber?: number;
         /** `YYYY-MM-DD`. */
         dueDate?: string;
     };
-    /** Varias cuotas: hoy siempre `available: false` con `NOT_AVAILABLE_YET`. */
-    advance: LoanCustomerPaymentOption;
+    /** Varias cuotas. `installments` trae las `maxInstallments` que se pueden adelantar, en orden. */
+    advance: LoanCustomerPaymentOption & {
+        minInstallments?: number;
+        maxInstallments?: number;
+        installments?: LoanCustomerAdvanceInstallment[];
+    };
+    /** Abono a capital: monto libre entre `minAmountCents` y `maxAmountCents`. */
+    prepayment: LoanCustomerPaymentOption & {
+        minAmountCents?: number;
+        maxAmountCents?: number;
+        outstandingCapitalCents?: number;
+    };
     settlement: LoanCustomerPaymentOption & {
         /** La cotización de hoy; su `settlementAmountCents` es el `amountCents`. */
         quote?: LoanSettlementQuote;

package/src/loanCredit/dtos/responses/LoanCustomerPaymentResult.ts

@@ -9,4 +9,6 @@ export interface LoanCustomerPaymentResult {
     amountCents: number;
     /** Respuesta síncrona del motor; ausente si no contestó a tiempo. */
     collection?: { status: CollectionResultStatus; amountCollectedCents: number };
+    /** Solo ADVANCE: cuántas cuotas cubre. */
+    installmentCount?: number;
 }

package/src/loanCredit/enums/LoanCustomerPaymentTypeEnum.ts

@@ -2,4 +2,8 @@
 export enum LoanCustomerPaymentTypeEnum {
     NEXT_INSTALLMENT = 'NEXT_INSTALLMENT',
     SETTLEMENT = 'SETTLEMENT',
+    /** Varias cuotas: las siguientes N tal como están, sin cambiar la tabla. */
+    ADVANCE = 'ADVANCE',
+    /** Abono a capital: va completo a capital y baja las cuotas siguientes. */
+    PREPAYMENT = 'PREPAYMENT',
 }

package/src/loanCredit/index.ts

@@ -10,6 +10,7 @@ export * from './dtos/LoanBorrower';
 export * from './dtos/LoanBeneficiary';
 export * from './dtos/LoanCredit';
 export * from './dtos/LoanInstallment';
+export * from './dtos/InstallmentPaidEvent';
 export * from './dtos/LoanContract';
 export * from './dtos/ActivationChecklist';
 export * from './dtos/AppliedPromotionSnapshot';

package/src/retailCommission/dtos/CommissionAccrual.ts

@@ -2,6 +2,11 @@ import type { CommissionAccrualStatusEnum } from '../enums/CommissionAccrualStat
 import type { CommissionPayeeTypeEnum } from '../enums/CommissionPayeeTypeEnum';
 import type { SaleFinancierEnum } from '../../retailWizard/enums/SaleFinancierEnum';
 import type { CommissionCalcTrace } from './CommissionCalcTrace';
+import type { CommissionBonusModeEnum } from '../enums/CommissionBonusModeEnum';
+import type { ProductCategoryEnum } from '../../retailCatalog/enums/ProductCategoryEnum';
+import type { ProductTierEnum } from '../../retailCatalog/enums/ProductTierEnum';
+import type { LinePaymentTypeEnum } from '../../retailWizard/enums/LinePaymentTypeEnum';
+import type { WizardLineRoleEnum } from '../../retailWizard/enums/WizardLineRoleEnum';
 
 /**
  * El devengo: lo que se le debe a un vendedor por UNA venta.
@@ -52,6 +57,10 @@ export interface CommissionAccrual {
     payoutId: string | null;
     reversalReason: string | null;
     calcTrace: CommissionCalcTrace;
+    /** Los bonos por venta que sumaron, uno por regla y por pieza. Solo en devengos calculados con reglas. */
+    appliedBonuses?: CommissionAppliedBonus[];
+    /** Suma de `appliedBonuses`. Solo en devengos calculados con reglas. */
+    subtotalBonusCents?: number;
 }
 
 /**
@@ -78,4 +87,33 @@ export interface CommissionSaleInput {
     /** `CASH` | `CREDIT`, para `PERCENT_BY_PAYMENT`. */
     paymentType: string;
     soldAt: string;
+    /** Las líneas de la venta. Las ventas que se calculan con reglas siempre las traen. */
+    lines?: CommissionSaleLine[];
+}
+
+/** Una línea de la venta, congelada en el devengo. */
+export interface CommissionSaleLine {
+    lineId: string;
+    sku: string;
+    qty: number;
+    /** Precio neto de la línea completa (todas sus piezas). */
+    netCents: number;
+    category: ProductCategoryEnum | null;
+    tier: ProductTierEnum | null;
+    brand: string | null;
+    paymentType: LinePaymentTypeEnum;
+    /** `GIFT` = regalo: no comisiona ni cuenta en la posición. */
+    role?: WizardLineRoleEnum;
+}
+
+/** Un bono por venta que sumó en el devengo. */
+export interface CommissionAppliedBonus {
+    ruleId: string;
+    name: string;
+    lineId: string;
+    sku: string;
+    /** Posición de la pieza en el contador de la regla dentro del periodo. */
+    position: number;
+    mode: CommissionBonusModeEnum;
+    amountCents: number;
 }