@fiado/type-kit 3.485.0 → 3.487.0

package/_test_/unit/collection/disburseRequest.test.ts

@@ -0,0 +1,92 @@
+import 'reflect-metadata';
+import { plainToInstance } from 'class-transformer';
+import { validate } from 'class-validator';
+import { Collection } from '../../../src/index';
+import { DisburseRequest, DisburseResponse } from '../../../src/collection/index';
+
+const VALID = {
+    tenantId: 'surekeep',
+    domain: 'retail-wizard-business',
+    directoryId: 'dir-1',
+    disbursementType: 'MEX_BONUS',
+    amount: 25.5,
+    currencyId: 'MXN',
+    idempotencyKey: '01M0JT2KQCN9QGA7PE3C34Q37E',
+    concept: 'Bono de bienvenida SureKeep',
+    reference: '01M0JT2KQCN9QGA7PE3C34Q37E',
+};
+
+async function invalidProperties(body: Record<string, unknown>): Promise<string[]> {
+    const dto = plainToInstance(DisburseRequest, body);
+    return (await validate(dto as object)).map((e) => e.property);
+}
+
+describe('DisburseRequest', () => {
+    it('acepta una dispersión válida', async () => {
+        expect(await invalidProperties(VALID)).toEqual([]);
+    });
+
+    it('reference es opcional', async () => {
+        const { reference: _omit, ...withoutReference } = VALID;
+        expect(await invalidProperties(withoutReference)).toEqual([]);
+    });
+
+    it.each(['tenantId', 'domain', 'directoryId', 'idempotencyKey', 'concept'])(
+        'rechaza %s vacío',
+        async (field) => {
+            expect(await invalidProperties({ ...VALID, [field]: '' })).toContain(field);
+        },
+    );
+
+    it.each(['tenantId', 'domain', 'directoryId', 'disbursementType', 'amount', 'currencyId', 'idempotencyKey', 'concept'])(
+        'rechaza si falta %s',
+        async (field) => {
+            const body: Record<string, unknown> = { ...VALID };
+            delete body[field];
+            expect(await invalidProperties(body)).toContain(field);
+        },
+    );
+
+    it('rechaza un tipo de dispersión desconocido', async () => {
+        expect(await invalidProperties({ ...VALID, disbursementType: 'USD_BONUS' })).toContain('disbursementType');
+    });
+
+    it('rechaza cualquier moneda distinta de MXN', async () => {
+        expect(await invalidProperties({ ...VALID, currencyId: 'USD' })).toContain('currencyId');
+    });
+
+    it.each([0, -1, 10.005, '25'])('rechaza el monto %p', async (amount) => {
+        expect(await invalidProperties({ ...VALID, amount })).toContain('amount');
+    });
+
+    it('acepta pesos con dos decimales', async () => {
+        expect(await invalidProperties({ ...VALID, amount: 19.99 })).toEqual([]);
+    });
+
+    it('rechaza una llave con #, que chocaría con los executionId del motor', async () => {
+        expect(await invalidProperties({ ...VALID, idempotencyKey: 'SALE#42' })).toContain('idempotencyKey');
+    });
+
+    it('rechaza un concepto de más de 120 caracteres, el tope del processor', async () => {
+        expect(await invalidProperties({ ...VALID, concept: 'x'.repeat(121) })).toContain('concept');
+        expect(await invalidProperties({ ...VALID, concept: 'x'.repeat(120) })).toEqual([]);
+    });
+
+    it('rechaza strings que no son string', async () => {
+        expect(await invalidProperties({ ...VALID, directoryId: 42, reference: 7 })).toEqual(
+            expect.arrayContaining(['directoryId', 'reference']),
+        );
+    });
+
+    it('sale por el index raíz', () => {
+        expect(new Collection.DisburseRequest()).toBeInstanceOf(DisburseRequest);
+        expect(new Collection.DisburseResponse()).toBeInstanceOf(DisburseResponse);
+    });
+});
+
+describe('DisburseResponse', () => {
+    it('acepta un folio o null', async () => {
+        expect(await validate(plainToInstance(DisburseResponse, { transactionId: 'TX-1' }) as object)).toHaveLength(0);
+        expect(await validate(plainToInstance(DisburseResponse, { transactionId: null }) as object)).toHaveLength(0);
+    });
+});

package/_test_/unit/collection/disbursementType.test.ts

@@ -0,0 +1,19 @@
+import 'reflect-metadata';
+import { Collection } from '../../../src/index';
+import { DisbursementType } from '../../../src/collection/index';
+
+describe('DisbursementType', () => {
+    it('v1 solo trae el riel MEX_BONUS', () => {
+        expect(Object.values(DisbursementType)).toEqual(['MEX_BONUS']);
+    });
+
+    it('cada clave es igual a su valor', () => {
+        for (const [key, value] of Object.entries(DisbursementType)) {
+            expect(key).toBe(value);
+        }
+    });
+
+    it('sale por el index raíz', () => {
+        expect(Collection.DisbursementType.MEX_BONUS).toBe('MEX_BONUS');
+    });
+});

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

@@ -0,0 +1,20 @@
+import { CurrencyId } from '../../currency/enums/CurrencyId';
+import { DisbursementType } from '../enums/DisbursementType';
+/** Dispersión síncrona: el motor deposita `amount` pesos al titular por el riel de `disbursementType`. */
+export declare class DisburseRequest {
+    tenantId: string;
+    /** Quién llama. Solo viaja a los logs; no es control de acceso. */
+    domain: string;
+    /** Titular que recibe el depósito. */
+    directoryId: string;
+    disbursementType: DisbursementType;
+    /** Pesos con hasta dos decimales, no centavos. */
+    amount: number;
+    currencyId: CurrencyId;
+    /** Única entre todas las operaciones del processor; el motor la reenvía intacta. Sin `#`. */
+    idempotencyKey: string;
+    /** Texto que ve el titular en su movimiento. 120 es el tope del processor. */
+    concept: string;
+    /** Id del llamador para rastreo: asiento, crédito. */
+    reference?: string;
+}

package/bin/collection/dtos/DisburseRequest.js

@@ -0,0 +1,64 @@
+"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.DisburseRequest = void 0;
+const class_validator_1 = require("class-validator");
+const CurrencyId_1 = require("../../currency/enums/CurrencyId");
+const DisbursementType_1 = require("../enums/DisbursementType");
+/** Dispersión síncrona: el motor deposita `amount` pesos al titular por el riel de `disbursementType`. */
+class DisburseRequest {
+}
+exports.DisburseRequest = DisburseRequest;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "tenantId", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "domain", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "directoryId", void 0);
+__decorate([
+    (0, class_validator_1.IsEnum)(DisbursementType_1.DisbursementType),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "disbursementType", void 0);
+__decorate([
+    (0, class_validator_1.IsNumber)({ maxDecimalPlaces: 2 }),
+    (0, class_validator_1.IsPositive)(),
+    __metadata("design:type", Number)
+], DisburseRequest.prototype, "amount", void 0);
+__decorate([
+    (0, class_validator_1.IsIn)([CurrencyId_1.CurrencyId.MXN]),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "currencyId", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.Matches)(/^[^#]+$/),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "idempotencyKey", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    (0, class_validator_1.MaxLength)(120),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "concept", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], DisburseRequest.prototype, "reference", void 0);

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

@@ -0,0 +1,4 @@
+/** Folio del processor; `null` cuando aprobó sin devolverlo y el llamador decide cómo cerrar. */
+export declare class DisburseResponse {
+    transactionId: string | null;
+}

package/bin/collection/dtos/DisburseResponse.js

@@ -0,0 +1,22 @@
+"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.DisburseResponse = void 0;
+const class_validator_1 = require("class-validator");
+/** Folio del processor; `null` cuando aprobó sin devolverlo y el llamador decide cómo cerrar. */
+class DisburseResponse {
+}
+exports.DisburseResponse = DisburseResponse;
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    __metadata("design:type", String)
+], DisburseResponse.prototype, "transactionId", void 0);

package/bin/collection/enums/DisbursementType.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Riel por el que el motor de cobro deposita una dispersión. Nombra el movimiento, no el propósito:
+ * el propósito lo manda el llamador en `concept`.
+ */
+export declare enum DisbursementType {
+    MEX_BONUS = "MEX_BONUS"
+}

package/bin/collection/enums/DisbursementType.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DisbursementType = void 0;
+/**
+ * Riel por el que el motor de cobro deposita una dispersión. Nombra el movimiento, no el propósito:
+ * el propósito lo manda el llamador en `concept`.
+ */
+var DisbursementType;
+(function (DisbursementType) {
+    DisbursementType["MEX_BONUS"] = "MEX_BONUS";
+})(DisbursementType || (exports.DisbursementType = DisbursementType = {}));

package/bin/collection/index.d.ts

@@ -10,6 +10,7 @@ export * from './enums/CollectionFeeMode';
 export * from './enums/RetryIntentStatus';
 export * from './enums/AckIntentStatus';
 export * from './enums/RedriveOutboxStatus';
+export * from './enums/DisbursementType';
 export * from './dtos/PendingChargeDto';
 export * from './dtos/CollectRequest';
 export * from './dtos/CollectResponse';
@@ -27,6 +28,8 @@ export * from './dtos/RegisterCollectibleResponse';
 export * from './dtos/CollectionPricingDto';
 export * from './dtos/ResolvePendingChargesRequest';
 export * from './dtos/MoneyInEvent';
+export * from './dtos/DisburseRequest';
+export * from './dtos/DisburseResponse';
 export * from './dtos/CollectionIntentSummaryDto';
 export * from './dtos/CollectionAttemptDto';
 export * from './dtos/CollectionOutboxEventDto';

package/bin/collection/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./enums/CollectionFeeMode"), exports);
 __exportStar(require("./enums/RetryIntentStatus"), exports);
 __exportStar(require("./enums/AckIntentStatus"), exports);
 __exportStar(require("./enums/RedriveOutboxStatus"), exports);
+__exportStar(require("./enums/DisbursementType"), exports);
 // DTOs
 __exportStar(require("./dtos/PendingChargeDto"), exports);
 __exportStar(require("./dtos/CollectRequest"), exports);
@@ -45,6 +46,8 @@ __exportStar(require("./dtos/RegisterCollectibleResponse"), exports);
 __exportStar(require("./dtos/CollectionPricingDto"), exports);
 __exportStar(require("./dtos/ResolvePendingChargesRequest"), exports);
 __exportStar(require("./dtos/MoneyInEvent"), exports);
+__exportStar(require("./dtos/DisburseRequest"), exports);
+__exportStar(require("./dtos/DisburseResponse"), exports);
 // DTOs — backoffice de monitoreo
 __exportStar(require("./dtos/CollectionIntentSummaryDto"), exports);
 __exportStar(require("./dtos/CollectionAttemptDto"), exports);

package/bin/retailCards/dtos/responses/CardBalanceResponse.d.ts

@@ -0,0 +1,5 @@
+/** Saldo de tarjetas físicas de una tienda para el wizard del vendedor. Sin saldo registrado, `available` es 0. */
+export interface CardBalanceResponse {
+    storeId: string;
+    available: number;
+}

package/bin/retailCards/dtos/responses/CardBalanceResponse.js

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

package/bin/retailCards/index.d.ts

@@ -5,6 +5,7 @@ export * from './dtos/requests/RegisterCardDeliveryRequest';
 export * from './dtos/requests/WriteOffCardStockRequest';
 export * from './dtos/requests/ReverseCardMovementRequest';
 export * from './dtos/responses/CardBatchResponse';
+export * from './dtos/responses/CardBalanceResponse';
 export * from './dtos/responses/CardDeliveryResponse';
 export * from './dtos/responses/CardStockBalanceResponse';
 export * from './dtos/responses/CardStockMovementResponse';

package/bin/retailCards/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./dtos/requests/WriteOffCardStockRequest"), exports);
 __exportStar(require("./dtos/requests/ReverseCardMovementRequest"), exports);
 // Response DTOs
 __exportStar(require("./dtos/responses/CardBatchResponse"), exports);
+__exportStar(require("./dtos/responses/CardBalanceResponse"), exports);
 __exportStar(require("./dtos/responses/CardDeliveryResponse"), exports);
 __exportStar(require("./dtos/responses/CardStockBalanceResponse"), exports);
 __exportStar(require("./dtos/responses/CardStockMovementResponse"), exports);

package/bin/retailWizard/dtos/responses/AppOnboardingResponse.d.ts

@@ -11,4 +11,6 @@ export interface AppOnboardingResponse {
     steps: AppOnboardingStep[];
     /** Ninguna quedó en `PENDING`. Una `UNVERIFIABLE` NO bloquea: cuenta como saldada. */
     allSettled: boolean;
+    /** Hay tarjetas en la tienda. Ausente: no se pudo consultar retail-cards. Con `false` la tarjeta física no bloquea. */
+    cardStockAvailable?: boolean;
 }

package/package.json

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

package/src/collection/dtos/DisburseRequest.ts

@@ -0,0 +1,30 @@
+import { IsEnum, IsIn, IsNotEmpty, IsNumber, IsOptional, IsPositive, IsString, Matches, MaxLength } from 'class-validator';
+import { CurrencyId } from '../../currency/enums/CurrencyId';
+import { DisbursementType } from '../enums/DisbursementType';
+
+/** Dispersión síncrona: el motor deposita `amount` pesos al titular por el riel de `disbursementType`. */
+export class DisburseRequest {
+    @IsString() @IsNotEmpty() tenantId!: string;
+
+    /** Quién llama. Solo viaja a los logs; no es control de acceso. */
+    @IsString() @IsNotEmpty() domain!: string;
+
+    /** Titular que recibe el depósito. */
+    @IsString() @IsNotEmpty() directoryId!: string;
+
+    @IsEnum(DisbursementType) disbursementType!: DisbursementType;
+
+    /** Pesos con hasta dos decimales, no centavos. */
+    @IsNumber({ maxDecimalPlaces: 2 }) @IsPositive() amount!: number;
+
+    @IsIn([CurrencyId.MXN]) currencyId!: CurrencyId;
+
+    /** Única entre todas las operaciones del processor; el motor la reenvía intacta. Sin `#`. */
+    @IsString() @IsNotEmpty() @Matches(/^[^#]+$/) idempotencyKey!: string;
+
+    /** Texto que ve el titular en su movimiento. 120 es el tope del processor. */
+    @IsString() @IsNotEmpty() @MaxLength(120) concept!: string;
+
+    /** Id del llamador para rastreo: asiento, crédito. */
+    @IsOptional() @IsString() reference?: string;
+}

package/src/collection/dtos/DisburseResponse.ts

@@ -0,0 +1,6 @@
+import { IsOptional, IsString } from 'class-validator';
+
+/** Folio del processor; `null` cuando aprobó sin devolverlo y el llamador decide cómo cerrar. */
+export class DisburseResponse {
+    @IsOptional() @IsString() transactionId!: string | null;
+}

package/src/collection/enums/DisbursementType.ts

@@ -0,0 +1,7 @@
+/**
+ * Riel por el que el motor de cobro deposita una dispersión. Nombra el movimiento, no el propósito:
+ * el propósito lo manda el llamador en `concept`.
+ */
+export enum DisbursementType {
+    MEX_BONUS = 'MEX_BONUS',
+}

package/src/collection/index.ts

@@ -11,6 +11,7 @@ export * from './enums/CollectionFeeMode';
 export * from './enums/RetryIntentStatus';
 export * from './enums/AckIntentStatus';
 export * from './enums/RedriveOutboxStatus';
+export * from './enums/DisbursementType';
 
 // DTOs
 export * from './dtos/PendingChargeDto';
@@ -30,6 +31,8 @@ export * from './dtos/RegisterCollectibleResponse';
 export * from './dtos/CollectionPricingDto';
 export * from './dtos/ResolvePendingChargesRequest';
 export * from './dtos/MoneyInEvent';
+export * from './dtos/DisburseRequest';
+export * from './dtos/DisburseResponse';
 
 // DTOs — backoffice de monitoreo
 export * from './dtos/CollectionIntentSummaryDto';

package/src/retailCards/dtos/responses/CardBalanceResponse.ts

@@ -0,0 +1,5 @@
+/** Saldo de tarjetas físicas de una tienda para el wizard del vendedor. Sin saldo registrado, `available` es 0. */
+export interface CardBalanceResponse {
+    storeId: string;
+    available: number;
+}

package/src/retailCards/index.ts

@@ -9,6 +9,7 @@ export * from './dtos/requests/ReverseCardMovementRequest';
 
 // Response DTOs
 export * from './dtos/responses/CardBatchResponse';
+export * from './dtos/responses/CardBalanceResponse';
 export * from './dtos/responses/CardDeliveryResponse';
 export * from './dtos/responses/CardStockBalanceResponse';
 export * from './dtos/responses/CardStockMovementResponse';

package/src/retailWizard/dtos/responses/AppOnboardingResponse.ts

@@ -12,4 +12,6 @@ export interface AppOnboardingResponse {
     steps: AppOnboardingStep[];
     /** Ninguna quedó en `PENDING`. Una `UNVERIFIABLE` NO bloquea: cuenta como saldada. */
     allSettled: boolean;
+    /** Hay tarjetas en la tienda. Ausente: no se pudo consultar retail-cards. Con `false` la tarjeta física no bloquea. */
+    cardStockAvailable?: boolean;
 }