@fiado/type-kit 3.376.0 → 3.378.0

package/bin/collection/dtos/CollectRequest.d.ts

@@ -1,5 +1,5 @@
 export declare class CollectRequest {
-    ownerRef: string;
+    directoryId: string;
     tenantId: string;
     domain: string;
     productId: string;

package/bin/collection/dtos/CollectRequest.js

@@ -17,7 +17,7 @@ exports.CollectRequest = CollectRequest;
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
-], CollectRequest.prototype, "ownerRef", void 0);
+], CollectRequest.prototype, "directoryId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)

package/bin/collection/dtos/CollectionIntentSummaryDto.d.ts

@@ -3,7 +3,7 @@ import { SagaStep } from '../enums/SagaStep';
 /** Fila de listado de intents para el backoffice de monitoreo del motor de cobro. */
 export declare class CollectionIntentSummaryDto {
     intentId: string;
-    ownerRef: string;
+    directoryId: string;
     tenantId: string;
     domain: string;
     chargeId: string;

package/bin/collection/dtos/CollectionIntentSummaryDto.js

@@ -24,7 +24,7 @@ __decorate([
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
-], CollectionIntentSummaryDto.prototype, "ownerRef", void 0);
+], CollectionIntentSummaryDto.prototype, "directoryId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)

package/bin/collection/dtos/MoneyInEvent.d.ts

@@ -10,7 +10,7 @@
  */
 export declare class MoneyInEvent {
     /** Titular que recibió el dinero. */
-    ownerRef: string;
+    directoryId: string;
     /**
      * Tenant a quien le interesa el ingreso, cuando quien publica lo sabe. Casi nunca lo sabe: la
      * wallet es de la persona, no de un tenant, y varios pueden estar esperando el mismo saldo. El

package/bin/collection/dtos/MoneyInEvent.js

@@ -27,7 +27,7 @@ exports.MoneyInEvent = MoneyInEvent;
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
-], MoneyInEvent.prototype, "ownerRef", void 0);
+], MoneyInEvent.prototype, "directoryId", void 0);
 __decorate([
     (0, class_validator_1.IsOptional)(),
     (0, class_validator_1.IsString)(),

package/bin/collection/dtos/PendingChargeDto.d.ts

@@ -1,7 +1,7 @@
 import { CurrencyId } from '../../currency/enums/CurrencyId';
 export declare class PendingChargeDto {
     chargeId: string;
-    ownerRef: string;
+    directoryId: string;
     tenantId: string;
     domain: string;
     parentDebtId: string;

package/bin/collection/dtos/PendingChargeDto.js

@@ -22,7 +22,7 @@ __decorate([
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
-], PendingChargeDto.prototype, "ownerRef", void 0);
+], PendingChargeDto.prototype, "directoryId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)

package/bin/collection/dtos/RegisterCollectibleRequest.d.ts

@@ -1,7 +1,26 @@
+/**
+ * Alta de un cargo cobrable: el dominio avisa de que hay algo que cobrar y el motor se encarga de
+ * perseguirlo — lo intenta, espera fondos si no hay saldo, y reintenta en cuanto entra dinero.
+ *
+ * No lleva importe a propósito. Cuánto se debe se le pregunta al dominio al ir a cobrar, porque
+ * entre el alta y el cobro puede correr mora o el cliente puede haber pagado por otra vía.
+ */
 export declare class RegisterCollectibleRequest {
-    ownerRef: string;
+    /** Titular de la deuda. */
+    directoryId: string;
+    /** La SOFOM dueña de la cartera. Junto con `productId` resuelve la configuración de cobro. */
     tenantId: string;
+    /** Quién es el dueño de la deuda (`surekeep-retail`). Rutea las consultas de vuelta al dominio. */
     domain: string;
+    /** Configuración de cobro a aplicar: de qué cuentas se cobra, en qué orden y con qué mecanismo. */
     productId: string;
+    /**
+     * La llave del cargo, la que use el dominio. El motor no la interpreta: la trata como opaca y la
+     * concatena con `domain` para identificar el cobro.
+     *
+     * Tiene que ser ÚNICA por cargo cobrable y ESTABLE — el mismo valor al darlo de alta, al responder
+     * qué se debe y al darlo de baja. Dos cargos que compartan esta llave son, para el motor, el mismo
+     * cobro. Si un cargo se puede cobrar más de una vez, el ciclo va codificado aquí dentro.
+     */
     chargeId: string;
 }

package/bin/collection/dtos/RegisterCollectibleRequest.js

@@ -11,13 +11,20 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RegisterCollectibleRequest = void 0;
 const class_validator_1 = require("class-validator");
+/**
+ * Alta de un cargo cobrable: el dominio avisa de que hay algo que cobrar y el motor se encarga de
+ * perseguirlo — lo intenta, espera fondos si no hay saldo, y reintenta en cuanto entra dinero.
+ *
+ * No lleva importe a propósito. Cuánto se debe se le pregunta al dominio al ir a cobrar, porque
+ * entre el alta y el cobro puede correr mora o el cliente puede haber pagado por otra vía.
+ */
 class RegisterCollectibleRequest {
 }
 exports.RegisterCollectibleRequest = RegisterCollectibleRequest;
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
-], RegisterCollectibleRequest.prototype, "ownerRef", void 0);
+], RegisterCollectibleRequest.prototype, "directoryId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)

package/bin/collection/dtos/ResolvePendingChargesRequest.d.ts

@@ -7,6 +7,6 @@
  */
 export declare class ResolvePendingChargesRequest {
     domain: string;
-    ownerRef: string;
+    directoryId: string;
     tenantId: string;
 }

package/bin/collection/dtos/ResolvePendingChargesRequest.js

@@ -28,7 +28,7 @@ __decorate([
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)
-], ResolvePendingChargesRequest.prototype, "ownerRef", void 0);
+], ResolvePendingChargesRequest.prototype, "directoryId", void 0);
 __decorate([
     (0, class_validator_1.IsString)(),
     __metadata("design:type", String)

package/bin/loanOfferings/dtos/responses/SimulationResultResponse.d.ts

@@ -27,6 +27,21 @@ export interface AppliedPromotionResponse {
     /** Palancas del plan que la promoción pisó. */
     appliedEffects: PromotionEffectKindEnum[];
 }
+/**
+ * Cotas con las que se cotizó de verdad, ya pisadas por la promoción y las políticas. NO son las
+ * del plan: una promoción puede bajar el enganche mínimo o subir el techo de monto.
+ *
+ * El wizard dibuja el control del enganche con estas, no con las del plan. Sin ellas el vendedor
+ * ve un mínimo que el motor ya no exige, y la palanca de enganche queda inalcanzable.
+ */
+export interface EffectiveTermsResponse {
+    /** Enganche mínimo exigible, en decimal sobre 1 (`0.10` = 10%). */
+    minDownPaymentPct: number;
+    /** Tope de enganche, o `null` si el plan no lo acota. */
+    maxDownPaymentPct: number | null;
+    /** Techo de capital financiable. */
+    maxFinancedAmountCents: 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.
@@ -65,4 +80,8 @@ export interface SimulationResultResponse {
      * alcanzó la venta, y ausente si el lambda todavía no lo emite.
      */
     provenance?: PlanTermProvenance;
+    /**
+     * Las cotas efectivas de ESTA cotización. Ausente si el lambda todavía no las emite.
+     */
+    effectiveTerms?: EffectiveTermsResponse;
 }

package/bin/loanOfferings/dtos/responses/StorePolicyResponse.d.ts

@@ -6,6 +6,9 @@ export type PlanTermLayer = 'PLAN' | 'EASING' | 'PROMOTION' | 'HARDENING';
 /**
  * Cadena de capas que tocaron cada término, no una capa única: una palanca puede registrarse como
  * aplicada y quedar pisada después. Va vacío (`{}`) si ninguna política alcanzó la venta.
+ *
+ * NO es la auditoría completa del cálculo: con una promoción aplicada y cero políticas va vacío
+ * igual. Una promoción se audita por `appliedPromotion`, que es su canal propio.
  */
 export type PlanTermProvenance = Record<string, PlanTermLayer[]>;
 /** Palancas que ENDURECEN. Se pliegan con `max` sobre pisos y `min` sobre techos. */

package/package.json

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

package/src/collection/dtos/CollectRequest.ts

@@ -1,7 +1,7 @@
 import { IsString, IsInt } from 'class-validator';
 
 export class CollectRequest {
-  @IsString() ownerRef!: string;
+  @IsString() directoryId!: string;
   @IsString() tenantId!: string;
   @IsString() domain!: string;
   @IsString() productId!: string;

package/src/collection/dtos/CollectionIntentSummaryDto.ts

@@ -5,7 +5,7 @@ import { SagaStep } from '../enums/SagaStep';
 /** Fila de listado de intents para el backoffice de monitoreo del motor de cobro. */
 export class CollectionIntentSummaryDto {
   @IsString() intentId!: string;
-  @IsString() ownerRef!: string;
+  @IsString() directoryId!: string;
   @IsString() tenantId!: string;
   @IsString() domain!: string;
   @IsString() chargeId!: string;

package/src/collection/dtos/MoneyInEvent.ts

@@ -12,7 +12,7 @@ import { IsNumber, IsOptional, IsString } from 'class-validator';
  */
 export class MoneyInEvent {
   /** Titular que recibió el dinero. */
-  @IsString() ownerRef!: string;
+  @IsString() directoryId!: string;
 
   /**
    * Tenant a quien le interesa el ingreso, cuando quien publica lo sabe. Casi nunca lo sabe: la

package/src/collection/dtos/PendingChargeDto.ts

@@ -3,7 +3,7 @@ import { CurrencyId } from '../../currency/enums/CurrencyId';
 
 export class PendingChargeDto {
   @IsString() chargeId!: string;          // record_id / INSTALLMENT#n
-  @IsString() ownerRef!: string;          // directoryId
+  @IsString() directoryId!: string;
   @IsString() tenantId!: string;          // FIADO | surekeep
   @IsString() domain!: string;            // une-credit | surekeep-retail
   @IsString() parentDebtId!: string;      // credit_id / CREDIT#id

package/src/collection/dtos/RegisterCollectibleRequest.ts

@@ -1,9 +1,32 @@
 import { IsString } from 'class-validator';
 
+/**
+ * Alta de un cargo cobrable: el dominio avisa de que hay algo que cobrar y el motor se encarga de
+ * perseguirlo — lo intenta, espera fondos si no hay saldo, y reintenta en cuanto entra dinero.
+ *
+ * No lleva importe a propósito. Cuánto se debe se le pregunta al dominio al ir a cobrar, porque
+ * entre el alta y el cobro puede correr mora o el cliente puede haber pagado por otra vía.
+ */
 export class RegisterCollectibleRequest {
-  @IsString() ownerRef!: string;
+  /** Titular de la deuda. */
+  @IsString() directoryId!: string;
+
+  /** La SOFOM dueña de la cartera. Junto con `productId` resuelve la configuración de cobro. */
   @IsString() tenantId!: string;
+
+  /** Quién es el dueño de la deuda (`surekeep-retail`). Rutea las consultas de vuelta al dominio. */
   @IsString() domain!: string;
+
+  /** Configuración de cobro a aplicar: de qué cuentas se cobra, en qué orden y con qué mecanismo. */
   @IsString() productId!: string;
+
+  /**
+   * La llave del cargo, la que use el dominio. El motor no la interpreta: la trata como opaca y la
+   * concatena con `domain` para identificar el cobro.
+   *
+   * Tiene que ser ÚNICA por cargo cobrable y ESTABLE — el mismo valor al darlo de alta, al responder
+   * qué se debe y al darlo de baja. Dos cargos que compartan esta llave son, para el motor, el mismo
+   * cobro. Si un cargo se puede cobrar más de una vez, el ciclo va codificado aquí dentro.
+   */
   @IsString() chargeId!: string;
 }

package/src/collection/dtos/ResolvePendingChargesRequest.ts

@@ -9,6 +9,6 @@ import { IsString } from 'class-validator';
  */
 export class ResolvePendingChargesRequest {
   @IsString() domain!: string;
-  @IsString() ownerRef!: string;
+  @IsString() directoryId!: string;
   @IsString() tenantId!: string;
 }

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

@@ -30,6 +30,22 @@ export interface AppliedPromotionResponse {
     appliedEffects: PromotionEffectKindEnum[];
 }
 
+/**
+ * Cotas con las que se cotizó de verdad, ya pisadas por la promoción y las políticas. NO son las
+ * del plan: una promoción puede bajar el enganche mínimo o subir el techo de monto.
+ *
+ * El wizard dibuja el control del enganche con estas, no con las del plan. Sin ellas el vendedor
+ * ve un mínimo que el motor ya no exige, y la palanca de enganche queda inalcanzable.
+ */
+export interface EffectiveTermsResponse {
+    /** Enganche mínimo exigible, en decimal sobre 1 (`0.10` = 10%). */
+    minDownPaymentPct: number;
+    /** Tope de enganche, o `null` si el plan no lo acota. */
+    maxDownPaymentPct: number | null;
+    /** Techo de capital financiable. */
+    maxFinancedAmountCents: 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.
@@ -68,4 +84,8 @@ export interface SimulationResultResponse {
      * alcanzó la venta, y ausente si el lambda todavía no lo emite.
      */
     provenance?: PlanTermProvenance;
+    /**
+     * Las cotas efectivas de ESTA cotización. Ausente si el lambda todavía no las emite.
+     */
+    effectiveTerms?: EffectiveTermsResponse;
 }

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

@@ -8,6 +8,9 @@ export type PlanTermLayer = 'PLAN' | 'EASING' | 'PROMOTION' | 'HARDENING';
 /**
  * Cadena de capas que tocaron cada término, no una capa única: una palanca puede registrarse como
  * aplicada y quedar pisada después. Va vacío (`{}`) si ninguna política alcanzó la venta.
+ *
+ * NO es la auditoría completa del cálculo: con una promoción aplicada y cero políticas va vacío
+ * igual. Una promoción se audita por `appliedPromotion`, que es su canal propio.
  */
 export type PlanTermProvenance = Record<string, PlanTermLayer[]>;