@fiado/type-kit 3.424.0 → 3.425.0

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

@@ -1,8 +1,19 @@
+import { CollectionState } from '../enums/CollectionState';
 import { DeregisterChargeStatus } from '../enums/DeregisterChargeStatus';
 /**
  * Resultado de dar de baja un cargo en el motor de cobro. Un cargo inexistente no viaja en este
  * DTO: el motor responde 404.
+ *
+ * `finalState` y `amountCollected` describen en qué terminó el cobro, y sólo tienen sentido cuando
+ * `status` es `ALREADY_TERMINAL`: ese status por sí solo no distingue el cargo que se cobró del que
+ * ya estaba cancelado, y sin esa distinción quien da de baja no puede reconciliar un cobro cuyo
+ * resultado se perdió en la cola muerta. Son opcionales para no romper al consumidor que ya lee
+ * este DTO.
  */
 export declare class DeregisterChargeResponse {
     status: DeregisterChargeStatus;
+    /** Estado terminal del cobro: `COLLECTED` o `CANCELLED`. */
+    finalState?: CollectionState;
+    /** Lo que el motor alcanzó a cobrar, en PESOS con decimales. */
+    amountCollected?: number;
 }

package/bin/collection/dtos/DeregisterChargeResponse.js

@@ -11,10 +11,17 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeregisterChargeResponse = void 0;
 const class_validator_1 = require("class-validator");
+const CollectionState_1 = require("../enums/CollectionState");
 const DeregisterChargeStatus_1 = require("../enums/DeregisterChargeStatus");
 /**
  * Resultado de dar de baja un cargo en el motor de cobro. Un cargo inexistente no viaja en este
  * DTO: el motor responde 404.
+ *
+ * `finalState` y `amountCollected` describen en qué terminó el cobro, y sólo tienen sentido cuando
+ * `status` es `ALREADY_TERMINAL`: ese status por sí solo no distingue el cargo que se cobró del que
+ * ya estaba cancelado, y sin esa distinción quien da de baja no puede reconciliar un cobro cuyo
+ * resultado se perdió en la cola muerta. Son opcionales para no romper al consumidor que ya lee
+ * este DTO.
  */
 class DeregisterChargeResponse {
 }
@@ -23,3 +30,13 @@ __decorate([
     (0, class_validator_1.IsEnum)(DeregisterChargeStatus_1.DeregisterChargeStatus),
     __metadata("design:type", String)
 ], DeregisterChargeResponse.prototype, "status", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsEnum)(CollectionState_1.CollectionState),
+    __metadata("design:type", String)
+], DeregisterChargeResponse.prototype, "finalState", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsNumber)(),
+    __metadata("design:type", Number)
+], DeregisterChargeResponse.prototype, "amountCollected", void 0);

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

@@ -3,9 +3,9 @@ import { CollectionPricingDto } from './CollectionPricingDto';
 /**
  * Un cargo vivo, según el dominio que lleva la deuda.
  *
- * `amount` es lo que queda por cobrar AHORA, con las reglas del dominio ya aplicadas —mora corrida,
- * pagos recibidos por otra vía—. El motor no lo recalcula ni lo valida contra nada: cobra lo que aquí
- * se declare.
+ * `amount` es lo que queda por cobrar AHORA, en PESOS con decimales —no en centavos—, con las reglas
+ * del dominio ya aplicadas —mora corrida, pagos recibidos por otra vía—. El motor no lo recalcula ni
+ * lo valida contra nada: cobra lo que aquí se declare, en la escala en que aquí se declare.
  *
  * El desglose (capital, interés, impuesto) es opcional y no participa del cobro: viaja para que el
  * asiento y los reportes puedan reconstruirlo.

package/bin/collection/dtos/PendingChargeDto.js

@@ -17,9 +17,9 @@ const CollectionPricingDto_1 = require("./CollectionPricingDto");
 /**
  * Un cargo vivo, según el dominio que lleva la deuda.
  *
- * `amount` es lo que queda por cobrar AHORA, con las reglas del dominio ya aplicadas —mora corrida,
- * pagos recibidos por otra vía—. El motor no lo recalcula ni lo valida contra nada: cobra lo que aquí
- * se declare.
+ * `amount` es lo que queda por cobrar AHORA, en PESOS con decimales —no en centavos—, con las reglas
+ * del dominio ya aplicadas —mora corrida, pagos recibidos por otra vía—. El motor no lo recalcula ni
+ * lo valida contra nada: cobra lo que aquí se declare, en la escala en que aquí se declare.
  *
  * El desglose (capital, interés, impuesto) es opcional y no participa del cobro: viaja para que el
  * asiento y los reportes puedan reconstruirlo.

package/package.json

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

package/src/collection/dtos/DeregisterChargeResponse.ts

@@ -1,10 +1,21 @@
-import { IsEnum } from 'class-validator';
+import { IsEnum, IsNumber, IsOptional } from 'class-validator';
+import { CollectionState } from '../enums/CollectionState';
 import { DeregisterChargeStatus } from '../enums/DeregisterChargeStatus';
 
 /**
  * Resultado de dar de baja un cargo en el motor de cobro. Un cargo inexistente no viaja en este
  * DTO: el motor responde 404.
+ *
+ * `finalState` y `amountCollected` describen en qué terminó el cobro, y sólo tienen sentido cuando
+ * `status` es `ALREADY_TERMINAL`: ese status por sí solo no distingue el cargo que se cobró del que
+ * ya estaba cancelado, y sin esa distinción quien da de baja no puede reconciliar un cobro cuyo
+ * resultado se perdió en la cola muerta. Son opcionales para no romper al consumidor que ya lee
+ * este DTO.
  */
 export class DeregisterChargeResponse {
   @IsEnum(DeregisterChargeStatus) status!: DeregisterChargeStatus;
+  /** Estado terminal del cobro: `COLLECTED` o `CANCELLED`. */
+  @IsOptional() @IsEnum(CollectionState) finalState?: CollectionState;
+  /** Lo que el motor alcanzó a cobrar, en PESOS con decimales. */
+  @IsOptional() @IsNumber() amountCollected?: number;
 }

package/src/collection/dtos/PendingChargeDto.ts

@@ -6,9 +6,9 @@ import { CollectionPricingDto } from './CollectionPricingDto';
 /**
  * Un cargo vivo, según el dominio que lleva la deuda.
  *
- * `amount` es lo que queda por cobrar AHORA, con las reglas del dominio ya aplicadas —mora corrida,
- * pagos recibidos por otra vía—. El motor no lo recalcula ni lo valida contra nada: cobra lo que aquí
- * se declare.
+ * `amount` es lo que queda por cobrar AHORA, en PESOS con decimales —no en centavos—, con las reglas
+ * del dominio ya aplicadas —mora corrida, pagos recibidos por otra vía—. El motor no lo recalcula ni
+ * lo valida contra nada: cobra lo que aquí se declare, en la escala en que aquí se declare.
  *
  * El desglose (capital, interés, impuesto) es opcional y no participa del cobro: viaja para que el
  * asiento y los reportes puedan reconstruirlo.
@@ -25,7 +25,7 @@ export class PendingChargeDto {
   @IsString() domain!: string;            // une-credit | surekeep-retail
   @IsString() parentDebtId!: string;      // credit_id / CREDIT#id
   @IsInt() installmentNumber!: number;    // coupon_number / installment_number
-  @IsNumber() amount!: number;               // centavos
+  @IsNumber() amount!: number;            // PESOS con decimales (1026.66), NO centavos
   @IsEnum(CurrencyId) currency!: CurrencyId;
   @IsString() dueDate!: string;           // ISO date
   @IsString() status!: string;            // estado del cargo en el dominio (normalizado por el motor)