@fiado/type-kit 3.384.0 → 3.385.0

package/_test_/unit/loanOfferings/promotionBonusRequests.test.ts

@@ -0,0 +1,53 @@
+import 'reflect-metadata';
+import { ClassConstructor, plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import {
+  PromotionBonusStatusEnum,
+  ReservePromotionBonusRequest,
+  SettlePromotionBonusRequest,
+} from '../../../src/loanOfferings/index';
+
+const errorProperties = async <T extends object>(
+  dtoClass: ClassConstructor<T>,
+  raw: Record<string, unknown>,
+): Promise<string[]> => {
+  const instance = plainToInstance(dtoClass, raw, { excludeExtraneousValues: true });
+  return (await validate(instance as object)).map((error) => error.property);
+};
+
+describe('ReservePromotionBonusRequest', () => {
+  it('valida con el crédito y nada más', async () => {
+    expect(await errorProperties(ReservePromotionBonusRequest, { creditId: 'CR-1' })).toHaveLength(0);
+  });
+
+  it('exige el crédito: es el candado del pago', async () => {
+    expect(await errorProperties(ReservePromotionBonusRequest, {})).toContain('creditId');
+  });
+});
+
+describe('SettlePromotionBonusRequest', () => {
+  const base = { bonusId: 'BON-1', status: PromotionBonusStatusEnum.SETTLED, transactionId: 'TX-9' };
+
+  it('valida el cierre completo', async () => {
+    expect(await errorProperties(SettlePromotionBonusRequest, base)).toHaveLength(0);
+  });
+
+  it('el folio es opcional: el processor puede aprobar sin darlo', async () => {
+    const { transactionId, ...sinFolio } = base;
+    expect(await errorProperties(SettlePromotionBonusRequest, sinFolio)).toHaveLength(0);
+  });
+
+  it('rechaza un estado fuera del enum', async () => {
+    expect(await errorProperties(SettlePromotionBonusRequest, { ...base, status: 'PAGADO' })).toContain('status');
+  });
+
+  it('acepta los tres desenlaces del processor', async () => {
+    for (const status of [
+      PromotionBonusStatusEnum.SETTLED,
+      PromotionBonusStatusEnum.FAILED,
+      PromotionBonusStatusEnum.UNVERIFIED,
+    ]) {
+      expect(await errorProperties(SettlePromotionBonusRequest, { ...base, status })).toHaveLength(0);
+    }
+  });
+});

package/bin/loanOfferings/dtos/requests/ReservePromotionBonusRequest.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Body de POST /private/promotions/:promotionId/bonus-payment — el crédito recién activado que va a
+ * cobrar el bono. `creditId` es el candado: reenviarlo devuelve `reserved: false`, no un segundo pago.
+ */
+export declare class ReservePromotionBonusRequest {
+    creditId: string;
+}

package/bin/loanOfferings/dtos/requests/ReservePromotionBonusRequest.js

@@ -0,0 +1,26 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReservePromotionBonusRequest = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+/**
+ * Body de POST /private/promotions/:promotionId/bonus-payment — el crédito recién activado que va a
+ * cobrar el bono. `creditId` es el candado: reenviarlo devuelve `reserved: false`, no un segundo pago.
+ */
+class ReservePromotionBonusRequest {
+}
+exports.ReservePromotionBonusRequest = ReservePromotionBonusRequest;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], ReservePromotionBonusRequest.prototype, "creditId", void 0);

package/bin/loanOfferings/dtos/requests/SettlePromotionBonusRequest.d.ts

@@ -0,0 +1,11 @@
+import { PromotionBonusStatusEnum } from '../../enums/PromotionBonusStatusEnum';
+/**
+ * Body de PUT /private/promotions/:promotionId/bonus-payment/result — cierra el asiento con lo que
+ * contestó el processor. `RESERVED` no se acepta: es el estado del que se sale, no al que se llega.
+ */
+export declare class SettlePromotionBonusRequest {
+    bonusId: string;
+    status: PromotionBonusStatusEnum;
+    /** Folio del processor. Ausente cuando aprobó sin darlo, o cuando el pago falló. */
+    transactionId?: string;
+}

package/bin/loanOfferings/dtos/requests/SettlePromotionBonusRequest.js

@@ -0,0 +1,38 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SettlePromotionBonusRequest = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+const PromotionBonusStatusEnum_1 = require("../../enums/PromotionBonusStatusEnum");
+/**
+ * Body de PUT /private/promotions/:promotionId/bonus-payment/result — cierra el asiento con lo que
+ * contestó el processor. `RESERVED` no se acepta: es el estado del que se sale, no al que se llega.
+ */
+class SettlePromotionBonusRequest {
+}
+exports.SettlePromotionBonusRequest = SettlePromotionBonusRequest;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SettlePromotionBonusRequest.prototype, "bonusId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsEnum)(PromotionBonusStatusEnum_1.PromotionBonusStatusEnum),
+    __metadata("design:type", String)
+], SettlePromotionBonusRequest.prototype, "status", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], SettlePromotionBonusRequest.prototype, "transactionId", void 0);

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

@@ -0,0 +1,20 @@
+import { PromotionBonusStatusEnum } from '../../enums/PromotionBonusStatusEnum';
+/**
+ * Asiento del bono PCF de una promoción, uno por crédito. Vive junto a la promoción porque ahí está
+ * el monto y ahí está el presupuesto contra el que se compara.
+ */
+export interface PromotionBonusResponse {
+    /** Llave de idempotencia con la que el processor mueve la plata. */
+    bonusId: string;
+    creditId: string;
+    promotionId: string;
+    /** Versión de la promoción al reservar: el monto queda congelado aunque la promo se edite. */
+    promotionVersion: number;
+    amountCents: number;
+    status: PromotionBonusStatusEnum;
+    /** Folio del processor. `null` mientras no haya cerrado, o si cerró sin darlo. */
+    transactionId: string | null;
+    reservedAt: string;
+    /** Instante en que dejó de estar `RESERVED`. `null` si sigue abierto. */
+    settledAt: string | null;
+}

package/bin/loanOfferings/dtos/responses/PromotionBonusResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+import { PromotionBonusResponse } from './PromotionBonusResponse';
+/**
+ * Resultado de reservar el bono de un crédito. `reserved: false` es un reenvío o una segunda venta
+ * del mismo crédito: no es error, y `bonus` trae el asiento que ya existía para poder consultarlo.
+ */
+export interface ReservePromotionBonusResponse {
+    reserved: boolean;
+    /** `null` cuando la promoción no declara bono PCF: no hay nada que pagar ni asiento que abrir. */
+    bonus: PromotionBonusResponse | null;
+}

package/bin/loanOfferings/dtos/responses/ReservePromotionBonusResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/bin/loanOfferings/enums/PromotionBonusStatusEnum.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Estado del asiento del bono PCF de una promoción. `RESERVED` nace con el candado por crédito;
+ * los otros tres lo cierran según lo que haya contestado el processor.
+ * @enum {string}
+ */
+export declare enum PromotionBonusStatusEnum {
+    RESERVED = "RESERVED",
+    SETTLED = "SETTLED",
+    FAILED = "FAILED",
+    UNVERIFIED = "UNVERIFIED"
+}

package/bin/loanOfferings/enums/PromotionBonusStatusEnum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PromotionBonusStatusEnum = void 0;
+/**
+ * Estado del asiento del bono PCF de una promoción. `RESERVED` nace con el candado por crédito;
+ * los otros tres lo cierran según lo que haya contestado el processor.
+ * @enum {string}
+ */
+var PromotionBonusStatusEnum;
+(function (PromotionBonusStatusEnum) {
+    PromotionBonusStatusEnum["RESERVED"] = "RESERVED";
+    PromotionBonusStatusEnum["SETTLED"] = "SETTLED";
+    PromotionBonusStatusEnum["FAILED"] = "FAILED";
+    PromotionBonusStatusEnum["UNVERIFIED"] = "UNVERIFIED";
+})(PromotionBonusStatusEnum || (exports.PromotionBonusStatusEnum = PromotionBonusStatusEnum = {}));

package/bin/loanOfferings/index.d.ts

@@ -6,6 +6,7 @@ export * from './enums/FinancierTypeEnum';
 export * from './enums/FinancierStatusEnum';
 export * from './enums/PromotionStatusEnum';
 export * from './enums/PromotionEffectKindEnum';
+export * from './enums/PromotionBonusStatusEnum';
 export * from './enums/PromotionPhaseEnum';
 export * from './enums/PromotionLogEventEnum';
 export * from './enums/StorePolicyStatusEnum';
@@ -30,6 +31,8 @@ export * from './dtos/requests/CreatePromotionRequest';
 export * from './dtos/requests/UpdatePromotionRequest';
 export * from './dtos/requests/ChangePromotionStatusRequest';
 export * from './dtos/requests/ConsumePromotionRequest';
+export * from './dtos/requests/ReservePromotionBonusRequest';
+export * from './dtos/requests/SettlePromotionBonusRequest';
 export * from './dtos/requests/CreateStorePolicyRequest';
 export * from './dtos/requests/UpdateStorePolicyRequest';
 export * from './dtos/requests/ChangeStorePolicyStatusRequest';
@@ -44,6 +47,8 @@ export * from './dtos/responses/SimulationResultResponse';
 export * from './dtos/responses/PromotionResponse';
 export * from './dtos/responses/PromotionLogEntryResponse';
 export * from './dtos/responses/ConsumePromotionResponse';
+export * from './dtos/responses/PromotionBonusResponse';
+export * from './dtos/responses/ReservePromotionBonusResponse';
 export * from './dtos/responses/PromotedSkusResponse';
 export * from './dtos/responses/StorePolicyResponse';
 export * from './dtos/responses/SegmentResponse';

package/bin/loanOfferings/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./enums/FinancierTypeEnum"), exports);
 __exportStar(require("./enums/FinancierStatusEnum"), exports);
 __exportStar(require("./enums/PromotionStatusEnum"), exports);
 __exportStar(require("./enums/PromotionEffectKindEnum"), exports);
+__exportStar(require("./enums/PromotionBonusStatusEnum"), exports);
 __exportStar(require("./enums/PromotionPhaseEnum"), exports);
 __exportStar(require("./enums/PromotionLogEventEnum"), exports);
 __exportStar(require("./enums/StorePolicyStatusEnum"), exports);
@@ -49,6 +50,8 @@ __exportStar(require("./dtos/requests/CreatePromotionRequest"), exports);
 __exportStar(require("./dtos/requests/UpdatePromotionRequest"), exports);
 __exportStar(require("./dtos/requests/ChangePromotionStatusRequest"), exports);
 __exportStar(require("./dtos/requests/ConsumePromotionRequest"), exports);
+__exportStar(require("./dtos/requests/ReservePromotionBonusRequest"), exports);
+__exportStar(require("./dtos/requests/SettlePromotionBonusRequest"), exports);
 __exportStar(require("./dtos/requests/CreateStorePolicyRequest"), exports);
 __exportStar(require("./dtos/requests/UpdateStorePolicyRequest"), exports);
 __exportStar(require("./dtos/requests/ChangeStorePolicyStatusRequest"), exports);
@@ -64,6 +67,8 @@ __exportStar(require("./dtos/responses/SimulationResultResponse"), exports);
 __exportStar(require("./dtos/responses/PromotionResponse"), exports);
 __exportStar(require("./dtos/responses/PromotionLogEntryResponse"), exports);
 __exportStar(require("./dtos/responses/ConsumePromotionResponse"), exports);
+__exportStar(require("./dtos/responses/PromotionBonusResponse"), exports);
+__exportStar(require("./dtos/responses/ReservePromotionBonusResponse"), exports);
 __exportStar(require("./dtos/responses/PromotedSkusResponse"), exports);
 __exportStar(require("./dtos/responses/StorePolicyResponse"), exports);
 __exportStar(require("./dtos/responses/SegmentResponse"), exports);

package/package.json

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

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

@@ -0,0 +1,12 @@
+import { Expose } from 'class-transformer';
+import { IsString } from 'class-validator';
+
+/**
+ * Body de POST /private/promotions/:promotionId/bonus-payment — el crédito recién activado que va a
+ * cobrar el bono. `creditId` es el candado: reenviarlo devuelve `reserved: false`, no un segundo pago.
+ */
+export class ReservePromotionBonusRequest {
+    @Expose()
+    @IsString()
+    creditId!: string;
+}

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

@@ -0,0 +1,23 @@
+import { Expose } from 'class-transformer';
+import { IsEnum, IsOptional, IsString } from 'class-validator';
+import { PromotionBonusStatusEnum } from '../../enums/PromotionBonusStatusEnum';
+
+/**
+ * Body de PUT /private/promotions/:promotionId/bonus-payment/result — cierra el asiento con lo que
+ * contestó el processor. `RESERVED` no se acepta: es el estado del que se sale, no al que se llega.
+ */
+export class SettlePromotionBonusRequest {
+    @Expose()
+    @IsString()
+    bonusId!: string;
+
+    @Expose()
+    @IsEnum(PromotionBonusStatusEnum)
+    status!: PromotionBonusStatusEnum;
+
+    /** Folio del processor. Ausente cuando aprobó sin darlo, o cuando el pago falló. */
+    @Expose()
+    @IsOptional()
+    @IsString()
+    transactionId?: string;
+}

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

@@ -0,0 +1,21 @@
+import { PromotionBonusStatusEnum } from '../../enums/PromotionBonusStatusEnum';
+
+/**
+ * Asiento del bono PCF de una promoción, uno por crédito. Vive junto a la promoción porque ahí está
+ * el monto y ahí está el presupuesto contra el que se compara.
+ */
+export interface PromotionBonusResponse {
+    /** Llave de idempotencia con la que el processor mueve la plata. */
+    bonusId: string;
+    creditId: string;
+    promotionId: string;
+    /** Versión de la promoción al reservar: el monto queda congelado aunque la promo se edite. */
+    promotionVersion: number;
+    amountCents: number;
+    status: PromotionBonusStatusEnum;
+    /** Folio del processor. `null` mientras no haya cerrado, o si cerró sin darlo. */
+    transactionId: string | null;
+    reservedAt: string;
+    /** Instante en que dejó de estar `RESERVED`. `null` si sigue abierto. */
+    settledAt: string | null;
+}

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

@@ -0,0 +1,11 @@
+import { PromotionBonusResponse } from './PromotionBonusResponse';
+
+/**
+ * Resultado de reservar el bono de un crédito. `reserved: false` es un reenvío o una segunda venta
+ * del mismo crédito: no es error, y `bonus` trae el asiento que ya existía para poder consultarlo.
+ */
+export interface ReservePromotionBonusResponse {
+    reserved: boolean;
+    /** `null` cuando la promoción no declara bono PCF: no hay nada que pagar ni asiento que abrir. */
+    bonus: PromotionBonusResponse | null;
+}

package/src/loanOfferings/enums/PromotionBonusStatusEnum.ts

@@ -0,0 +1,11 @@
+/**
+ * Estado del asiento del bono PCF de una promoción. `RESERVED` nace con el candado por crédito;
+ * los otros tres lo cierran según lo que haya contestado el processor.
+ * @enum {string}
+ */
+export enum PromotionBonusStatusEnum {
+    RESERVED = 'RESERVED',
+    SETTLED = 'SETTLED',
+    FAILED = 'FAILED',
+    UNVERIFIED = 'UNVERIFIED',
+}

package/src/loanOfferings/index.ts

@@ -7,6 +7,7 @@ export * from './enums/FinancierTypeEnum';
 export * from './enums/FinancierStatusEnum';
 export * from './enums/PromotionStatusEnum';
 export * from './enums/PromotionEffectKindEnum';
+export * from './enums/PromotionBonusStatusEnum';
 export * from './enums/PromotionPhaseEnum';
 export * from './enums/PromotionLogEventEnum';
 export * from './enums/StorePolicyStatusEnum';
@@ -35,6 +36,8 @@ export * from './dtos/requests/CreatePromotionRequest';
 export * from './dtos/requests/UpdatePromotionRequest';
 export * from './dtos/requests/ChangePromotionStatusRequest';
 export * from './dtos/requests/ConsumePromotionRequest';
+export * from './dtos/requests/ReservePromotionBonusRequest';
+export * from './dtos/requests/SettlePromotionBonusRequest';
 export * from './dtos/requests/CreateStorePolicyRequest';
 export * from './dtos/requests/UpdateStorePolicyRequest';
 export * from './dtos/requests/ChangeStorePolicyStatusRequest';
@@ -51,6 +54,8 @@ export * from './dtos/responses/SimulationResultResponse';
 export * from './dtos/responses/PromotionResponse';
 export * from './dtos/responses/PromotionLogEntryResponse';
 export * from './dtos/responses/ConsumePromotionResponse';
+export * from './dtos/responses/PromotionBonusResponse';
+export * from './dtos/responses/ReservePromotionBonusResponse';
 export * from './dtos/responses/PromotedSkusResponse';
 export * from './dtos/responses/StorePolicyResponse';
 export * from './dtos/responses/SegmentResponse';