@fiado/type-kit 3.547.0 → 3.548.0

package/_test_/unit/loanCredit/cancelLoanCreditRequest.test.ts

@@ -0,0 +1,40 @@
+import 'reflect-metadata';
+import { plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import { CancelLoanCreditRequest } from '../../../src/loanCredit/index';
+import type { LoanCreditResponse } from '../../../src/loanCredit/index';
+
+const errorsOf = async (body: Record<string, unknown>): Promise<string[]> => {
+    const errors = await validate(plainToInstance(CancelLoanCreditRequest, body));
+    return errors.map((error) => error.property);
+};
+
+const VALID = { saleId: '01M5B1V5R2KZ90G8CNEA8TTC46', reason: 'El cliente se arrepintió' };
+
+describe('CancelLoanCreditRequest', () => {
+    it('acepta la venta y el motivo', async () => {
+        expect(await errorsOf(VALID)).toEqual([]);
+    });
+
+    it('exige saleId y reason', async () => {
+        expect((await errorsOf({})).sort()).toEqual(['reason', 'saleId']);
+    });
+
+    it('rechaza saleId o reason vacíos', async () => {
+        expect(await errorsOf({ ...VALID, saleId: '' })).toEqual(['saleId']);
+        expect(await errorsOf({ ...VALID, reason: '' })).toEqual(['reason']);
+    });
+
+    it('rechaza un saleId con caracteres fuera de la referencia del hecho', async () => {
+        expect(await errorsOf({ ...VALID, saleId: 'SALE#123' })).toEqual(['saleId']);
+    });
+});
+
+describe('LoanCreditResponse.hasPayments', () => {
+    it('es opcional y booleano', () => {
+        const partial: Pick<LoanCreditResponse, 'hasPayments'> = {};
+        const withFlag: Pick<LoanCreditResponse, 'hasPayments'> = { hasPayments: true };
+        expect(partial.hasPayments).toBeUndefined();
+        expect(withFlag.hasPayments).toBe(true);
+    });
+});

package/_test_/unit/loanRetailAudit/loanRetailAuditContracts.test.ts

@@ -123,6 +123,15 @@ describe('ListAuditTrailQuery', () => {
 });
 
 describe('catálogos', () => {
+    it('incluye PROSPECT y RETAIL_CUSTOMER del wizard y los acepta en el evento', () => {
+        for (const entityType of ['PROSPECT', 'RETAIL_CUSTOMER']) {
+            expect(AUDIT_TRAIL_ENTITY_TYPES).toContain(entityType);
+            expect(errorsOf(AuditTrailRecordedV1, { ...validEvent, entityType })).toEqual([]);
+        }
+        expect(RetailAuditEntityTypeEnum.PROSPECT).toBe('PROSPECT');
+        expect(RetailAuditEntityTypeEnum.RETAIL_CUSTOMER).toBe('RETAIL_CUSTOMER');
+    });
+
     it('AUDIT_TRAIL_ENTITY_TYPES une Loan y Retail sin repetidos', () => {
         const all = [...Object.values(LoanAuditEntityTypeEnum), ...Object.values(RetailAuditEntityTypeEnum)];
         expect([...AUDIT_TRAIL_ENTITY_TYPES].sort()).toEqual([...all].sort());

package/_test_/unit/retailWizard/saleCancellation.test.ts

@@ -0,0 +1,25 @@
+import 'reflect-metadata';
+import { SaleCancellationReasonEnum } from '../../../src/retailWizard/index';
+import type { Sale, SaleCancellation } from '../../../src/retailWizard/index';
+
+describe('SaleCancellation', () => {
+    it('cataloga los cinco motivos por los que no se puede cancelar', () => {
+        expect(Object.values(SaleCancellationReasonEnum).sort()).toEqual([
+            'CANCEL_WINDOW_EXPIRED',
+            'CREDIT_HAS_PAYMENTS',
+            'CREDIT_NOT_CANCELLABLE',
+            'IMEI_NOT_RETURNABLE',
+            'SALE_ALREADY_CANCELLED',
+        ]);
+    });
+
+    it('viaja opcional en la venta', () => {
+        const cancellation: SaleCancellation = {
+            allowed: false,
+            reason: SaleCancellationReasonEnum.CREDIT_HAS_PAYMENTS,
+            windowEndsAt: '2026-10-26T00:00:00.000Z',
+        };
+        const sale: Pick<Sale, 'cancellation'> = { cancellation };
+        expect(sale.cancellation?.allowed).toBe(false);
+    });
+});

package/bin/loanCredit/dtos/requests/CancelLoanCreditRequest.d.ts

@@ -0,0 +1,7 @@
+/** Body de `POST /private/credits/:creditId/cancel` (loan-credit-business): la venta que se cancela. */
+export declare class CancelLoanCreditRequest {
+    /** Venta que origina la cancelación; es la referencia del aviso al cliente. */
+    saleId: string;
+    /** Motivo de la cancelación; va a la auditoría del crédito y no se loguea. */
+    reason: string;
+}

package/bin/loanCredit/dtos/requests/CancelLoanCreditRequest.js

@@ -0,0 +1,33 @@
+"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.CancelLoanCreditRequest = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+/** Body de `POST /private/credits/:creditId/cancel` (loan-credit-business): la venta que se cancela. */
+class CancelLoanCreditRequest {
+}
+exports.CancelLoanCreditRequest = CancelLoanCreditRequest;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.MaxLength)(120),
+    (0, class_validator_1.Matches)(/^[A-Za-z0-9._:-]+$/),
+    __metadata("design:type", String)
+], CancelLoanCreditRequest.prototype, "saleId", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.MaxLength)(500),
+    __metadata("design:type", String)
+], CancelLoanCreditRequest.prototype, "reason", void 0);

package/bin/loanCredit/dtos/responses/LoanCreditResponse.d.ts

@@ -51,6 +51,8 @@ export interface LoanCreditResponse {
     effectiveTerms?: EffectiveTermsSnapshot | null;
     activatedAt?: string;
     voluntaryCancelDeadline?: string;
+    /** Si ya se abonó alguna cuota (el enganche no cuenta); solo lo traen la lectura y la cancelación privadas. */
+    hasPayments?: boolean;
     firstDueDate?: string;
     lastDueDate?: string;
     createdBy: string;

package/bin/loanCredit/index.d.ts

@@ -117,6 +117,7 @@ export * from './dtos/WriteOffConfirmations';
 export * from './dtos/requests/BackofficeSettleCreditRequest';
 export * from './dtos/requests/BackofficeListWriteOffCandidatesRequest';
 export * from './dtos/requests/BackofficeWriteOffCreditRequest';
+export * from './dtos/requests/CancelLoanCreditRequest';
 export * from './dtos/requests/BackofficeCollectWrittenOffCreditRequest';
 export * from './dtos/requests/BackofficeProposeRestructureRequest';
 export * from './dtos/requests/BackofficeApproveRestructureRequest';

package/bin/loanCredit/index.js

@@ -159,6 +159,7 @@ __exportStar(require("./dtos/WriteOffConfirmations"), exports);
 __exportStar(require("./dtos/requests/BackofficeSettleCreditRequest"), exports);
 __exportStar(require("./dtos/requests/BackofficeListWriteOffCandidatesRequest"), exports);
 __exportStar(require("./dtos/requests/BackofficeWriteOffCreditRequest"), exports);
+__exportStar(require("./dtos/requests/CancelLoanCreditRequest"), exports);
 __exportStar(require("./dtos/requests/BackofficeCollectWrittenOffCreditRequest"), exports);
 __exportStar(require("./dtos/requests/BackofficeProposeRestructureRequest"), exports);
 __exportStar(require("./dtos/requests/BackofficeApproveRestructureRequest"), exports);

package/bin/loanRetailAudit/enums/RetailAuditEntityTypeEnum.d.ts

@@ -13,5 +13,7 @@ export declare enum RetailAuditEntityTypeEnum {
     COMMISSION_PAYOUT = "COMMISSION_PAYOUT",
     COMMISSION_ADJUSTMENT = "COMMISSION_ADJUSTMENT",
     COMMISSION_RULE = "COMMISSION_RULE",
-    COMMISSION_POLICY = "COMMISSION_POLICY"
+    COMMISSION_POLICY = "COMMISSION_POLICY",
+    PROSPECT = "PROSPECT",
+    RETAIL_CUSTOMER = "RETAIL_CUSTOMER"
 }

package/bin/loanRetailAudit/enums/RetailAuditEntityTypeEnum.js

@@ -18,4 +18,6 @@ var RetailAuditEntityTypeEnum;
     RetailAuditEntityTypeEnum["COMMISSION_ADJUSTMENT"] = "COMMISSION_ADJUSTMENT";
     RetailAuditEntityTypeEnum["COMMISSION_RULE"] = "COMMISSION_RULE";
     RetailAuditEntityTypeEnum["COMMISSION_POLICY"] = "COMMISSION_POLICY";
+    RetailAuditEntityTypeEnum["PROSPECT"] = "PROSPECT";
+    RetailAuditEntityTypeEnum["RETAIL_CUSTOMER"] = "RETAIL_CUSTOMER";
 })(RetailAuditEntityTypeEnum || (exports.RetailAuditEntityTypeEnum = RetailAuditEntityTypeEnum = {}));

package/bin/loanRetailAudit/events/AuditTrailRecordedV1.d.ts

@@ -10,7 +10,7 @@ export declare class AuditTrailRecordedV1 {
     action: AuditTrailActionEnum;
     changes: AuditTrailChange[];
     context: AuditTrailContextEntry[];
-    /** userId del actor, o `system` si lo disparó un proceso interno. */
+    /** userId del actor; nunca `system`: sin usuario va el nombre del lambda que lo disparó. */
     performedBy: string;
     sourceLambda: string;
     occurredAt: string;

package/bin/retailWizard/dtos/Sale.d.ts

@@ -7,6 +7,7 @@ import type { CentralSyncStatusEnum } from '../enums/CentralSyncStatusEnum';
 import type { SalePaymentDetail } from './SalePaymentDetail';
 import type { SaleLine } from './SaleLine';
 import type { SalePromotionRef } from '../../retailPromotions/dtos/SalePromotionRef';
+import type { SaleCancellation } from './SaleCancellation';
 /**
  * Venta (modelo-datos §3). pk `SALE#<saleId>` · sk `META` · 4 GSIs (`retailerId-soldAt-index`,
  * `storeId-soldAt-index`, `seller-soldAt-index`, `customerId-soldAt-index`). Unicidad de folio vía
@@ -65,6 +66,8 @@ export interface Sale {
     cancelledAt: string | null;
     /** Reason OBLIGATORIO en cancelación (AuditTrail) — flujo C. */
     cancelReason: string | null;
+    /** Si la venta se puede cancelar hoy y, si no, por qué; solo lo trae el detalle del backoffice. */
+    cancellation?: SaleCancellation;
     /**
      * SNAPSHOT de identidad y contexto, congelado al cerrar la venta. NO se refresca: una venta es la
      * fotografía de un hecho, no la caché de un perfil. Si el cliente corrige su nombre, la venta

package/bin/retailWizard/dtos/SaleCancellation.d.ts

@@ -0,0 +1,9 @@
+import type { SaleCancellationReasonEnum } from '../enums/SaleCancellationReasonEnum';
+/** Si la venta se puede cancelar hoy; el backend valida igual al cancelar. */
+export interface SaleCancellation {
+    allowed: boolean;
+    /** Ausente cuando `allowed` es true. */
+    reason?: SaleCancellationReasonEnum;
+    /** Fin de la ventana de cancelación voluntaria, ISO-8601. */
+    windowEndsAt?: string;
+}

package/bin/retailWizard/dtos/SaleCancellation.js

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

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

@@ -0,0 +1,8 @@
+/** Por qué una venta no se puede cancelar; coincide con el `code` que respondería la cancelación. */
+export declare enum SaleCancellationReasonEnum {
+    SALE_ALREADY_CANCELLED = "SALE_ALREADY_CANCELLED",
+    IMEI_NOT_RETURNABLE = "IMEI_NOT_RETURNABLE",
+    CANCEL_WINDOW_EXPIRED = "CANCEL_WINDOW_EXPIRED",
+    CREDIT_HAS_PAYMENTS = "CREDIT_HAS_PAYMENTS",
+    CREDIT_NOT_CANCELLABLE = "CREDIT_NOT_CANCELLABLE"
+}

package/bin/retailWizard/enums/SaleCancellationReasonEnum.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SaleCancellationReasonEnum = void 0;
+/** Por qué una venta no se puede cancelar; coincide con el `code` que respondería la cancelación. */
+var SaleCancellationReasonEnum;
+(function (SaleCancellationReasonEnum) {
+    SaleCancellationReasonEnum["SALE_ALREADY_CANCELLED"] = "SALE_ALREADY_CANCELLED";
+    SaleCancellationReasonEnum["IMEI_NOT_RETURNABLE"] = "IMEI_NOT_RETURNABLE";
+    SaleCancellationReasonEnum["CANCEL_WINDOW_EXPIRED"] = "CANCEL_WINDOW_EXPIRED";
+    SaleCancellationReasonEnum["CREDIT_HAS_PAYMENTS"] = "CREDIT_HAS_PAYMENTS";
+    SaleCancellationReasonEnum["CREDIT_NOT_CANCELLABLE"] = "CREDIT_NOT_CANCELLABLE";
+})(SaleCancellationReasonEnum || (exports.SaleCancellationReasonEnum = SaleCancellationReasonEnum = {}));

package/bin/retailWizard/index.d.ts

@@ -57,6 +57,8 @@ export * from './dtos/AccessorySaleLine';
 export * from './dtos/WizardSession';
 export * from './dtos/OtpVerification';
 export * from './dtos/Sale';
+export * from './dtos/SaleCancellation';
+export * from './enums/SaleCancellationReasonEnum';
 export * from './dtos/Prospect';
 export * from './dtos/PaginatedResult';
 export * from './dtos/requests/StartSessionRequest';

package/bin/retailWizard/index.js

@@ -80,6 +80,8 @@ __exportStar(require("./dtos/AccessorySaleLine"), exports);
 __exportStar(require("./dtos/WizardSession"), exports);
 __exportStar(require("./dtos/OtpVerification"), exports);
 __exportStar(require("./dtos/Sale"), exports);
+__exportStar(require("./dtos/SaleCancellation"), exports);
+__exportStar(require("./enums/SaleCancellationReasonEnum"), exports);
 __exportStar(require("./dtos/Prospect"), exports);
 // Paginación genérica
 __exportStar(require("./dtos/PaginatedResult"), exports);

package/package.json

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

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

@@ -0,0 +1,20 @@
+import { Expose } from 'class-transformer';
+import { IsNotEmpty, IsString, Matches, MaxLength } from 'class-validator';
+
+/** Body de `POST /private/credits/:creditId/cancel` (loan-credit-business): la venta que se cancela. */
+export class CancelLoanCreditRequest {
+    /** Venta que origina la cancelación; es la referencia del aviso al cliente. */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(120)
+    @Matches(/^[A-Za-z0-9._:-]+$/)
+    saleId!: string;
+
+    /** Motivo de la cancelación; va a la auditoría del crédito y no se loguea. */
+    @Expose()
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(500)
+    reason!: string;
+}

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

@@ -52,6 +52,8 @@ export interface LoanCreditResponse {
     effectiveTerms?: EffectiveTermsSnapshot | null;
     activatedAt?: string;
     voluntaryCancelDeadline?: string;
+    /** Si ya se abonó alguna cuota (el enganche no cuenta); solo lo traen la lectura y la cancelación privadas. */
+    hasPayments?: boolean;
     firstDueDate?: string;
     lastDueDate?: string;
     createdBy: string;

package/src/loanCredit/index.ts

@@ -141,6 +141,7 @@ export * from './dtos/WriteOffConfirmations';
 export * from './dtos/requests/BackofficeSettleCreditRequest';
 export * from './dtos/requests/BackofficeListWriteOffCandidatesRequest';
 export * from './dtos/requests/BackofficeWriteOffCreditRequest';
+export * from './dtos/requests/CancelLoanCreditRequest';
 export * from './dtos/requests/BackofficeCollectWrittenOffCreditRequest';
 export * from './dtos/requests/BackofficeProposeRestructureRequest';
 export * from './dtos/requests/BackofficeApproveRestructureRequest';

package/src/loanRetailAudit/enums/RetailAuditEntityTypeEnum.ts

@@ -14,4 +14,6 @@ export enum RetailAuditEntityTypeEnum {
     COMMISSION_ADJUSTMENT = 'COMMISSION_ADJUSTMENT',
     COMMISSION_RULE = 'COMMISSION_RULE',
     COMMISSION_POLICY = 'COMMISSION_POLICY',
+    PROSPECT = 'PROSPECT',
+    RETAIL_CUSTOMER = 'RETAIL_CUSTOMER',
 }

package/src/loanRetailAudit/events/AuditTrailRecordedV1.ts

@@ -37,7 +37,7 @@ export class AuditTrailRecordedV1 {
     @Type(() => AuditTrailContextEntry)
     context!: AuditTrailContextEntry[];
 
-    /** userId del actor, o `system` si lo disparó un proceso interno. */
+    /** userId del actor; nunca `system`: sin usuario va el nombre del lambda que lo disparó. */
     @Expose()
     @IsString()
     @IsNotEmpty()

package/src/retailWizard/dtos/Sale.ts

@@ -7,6 +7,7 @@ import type { CentralSyncStatusEnum } from '../enums/CentralSyncStatusEnum';
 import type { SalePaymentDetail } from './SalePaymentDetail';
 import type { SaleLine } from './SaleLine';
 import type { SalePromotionRef } from '../../retailPromotions/dtos/SalePromotionRef';
+import type { SaleCancellation } from './SaleCancellation';
 
 /**
  * Venta (modelo-datos §3). pk `SALE#<saleId>` · sk `META` · 4 GSIs (`retailerId-soldAt-index`,
@@ -66,6 +67,8 @@ export interface Sale {
   cancelledAt: string | null;
   /** Reason OBLIGATORIO en cancelación (AuditTrail) — flujo C. */
   cancelReason: string | null;
+  /** Si la venta se puede cancelar hoy y, si no, por qué; solo lo trae el detalle del backoffice. */
+  cancellation?: SaleCancellation;
   /**
    * SNAPSHOT de identidad y contexto, congelado al cerrar la venta. NO se refresca: una venta es la
    * fotografía de un hecho, no la caché de un perfil. Si el cliente corrige su nombre, la venta

package/src/retailWizard/dtos/SaleCancellation.ts

@@ -0,0 +1,10 @@
+import type { SaleCancellationReasonEnum } from '../enums/SaleCancellationReasonEnum';
+
+/** Si la venta se puede cancelar hoy; el backend valida igual al cancelar. */
+export interface SaleCancellation {
+  allowed: boolean;
+  /** Ausente cuando `allowed` es true. */
+  reason?: SaleCancellationReasonEnum;
+  /** Fin de la ventana de cancelación voluntaria, ISO-8601. */
+  windowEndsAt?: string;
+}

package/src/retailWizard/enums/SaleCancellationReasonEnum.ts

@@ -0,0 +1,8 @@
+/** Por qué una venta no se puede cancelar; coincide con el `code` que respondería la cancelación. */
+export enum SaleCancellationReasonEnum {
+  SALE_ALREADY_CANCELLED = 'SALE_ALREADY_CANCELLED',
+  IMEI_NOT_RETURNABLE = 'IMEI_NOT_RETURNABLE',
+  CANCEL_WINDOW_EXPIRED = 'CANCEL_WINDOW_EXPIRED',
+  CREDIT_HAS_PAYMENTS = 'CREDIT_HAS_PAYMENTS',
+  CREDIT_NOT_CANCELLABLE = 'CREDIT_NOT_CANCELLABLE',
+}

package/src/retailWizard/index.ts

@@ -64,6 +64,8 @@ export * from './dtos/AccessorySaleLine';
 export * from './dtos/WizardSession';
 export * from './dtos/OtpVerification';
 export * from './dtos/Sale';
+export * from './dtos/SaleCancellation';
+export * from './enums/SaleCancellationReasonEnum';
 export * from './dtos/Prospect';
 
 // Paginación genérica