@fiado/type-kit 3.286.0 → 3.288.0

package/_test_/unit/identity/SsnItinSentinel.test.ts

@@ -0,0 +1,54 @@
+import { SSN_ITIN_DOESNT_HAVE, hasRealSsn } from '../../../src/identity/index';
+
+/**
+ * Centinela del SSN/ITIN.
+ *
+ * El campo `SSN_ITIN` guarda tres cosas distintas y cada una significa algo:
+ *   - un número real            => el cliente entregó su SSN o ITIN
+ *   - `DOESNT_HAVE` (centinela) => se le preguntó y respondió que NO tiene
+ *   - vacío / null / ausente    => todavía no se le preguntó
+ *
+ * `hasRealSsn` es el criterio único para distinguir el primero de los otros dos. Sin él, todo
+ * lector que pregunte "¿el campo trae contenido?" da verdadero para quien declaró lo contrario, y
+ * el centinela termina viajando a proveedores externos como si fuera una identificación.
+ *
+ * Vive acá además de en `@fiado/fiado-abstractions` porque los repos que envían el dato a terceros
+ * (card-business, el connector de Central Payments, lista negra, account-fiadoinc) consumen
+ * type-kit y no aquella. Las dos definiciones deben mantenerse idénticas.
+ */
+describe('SSN_ITIN_DOESNT_HAVE / hasRealSsn', () => {
+
+    test('el centinela es exactamente "DOESNT_HAVE"', () => {
+        // La grafía importa: es el valor que queda persistido y con el que comparan los lectores.
+        expect(SSN_ITIN_DOESNT_HAVE).toBe('DOESNT_HAVE');
+    });
+
+    test('un SSN real es un SSN real', () => {
+        expect(hasRealSsn('123456789')).toBe(true);
+    });
+
+    test('un valor con prefijo también (así lo guarda la app)', () => {
+        expect(hasRealSsn('SSN_123456789')).toBe(true);
+        expect(hasRealSsn('ITIN_912345678')).toBe(true);
+    });
+
+    test('el centinela NO es un SSN real', () => {
+        expect(hasRealSsn(SSN_ITIN_DOESNT_HAVE)).toBe(false);
+    });
+
+    test('vacío, null y undefined tampoco', () => {
+        expect(hasRealSsn('')).toBe(false);
+        expect(hasRealSsn(null)).toBe(false);
+        expect(hasRealSsn(undefined)).toBe(false);
+    });
+
+    test('tolera espacios alrededor del centinela', () => {
+        expect(hasRealSsn('  DOESNT_HAVE  ')).toBe(false);
+    });
+
+    test('es sensible a mayúsculas: otra grafía no es el centinela', () => {
+        // Deliberado: si aparece "doesnt_have" en la base, es un dato mal escrito y queremos verlo,
+        // no absorberlo en silencio.
+        expect(hasRealSsn('doesnt_have')).toBe(true);
+    });
+});

package/bin/benefitCenter/enums/BenefitFlowEnum.d.ts

@@ -0,0 +1,11 @@
+export declare enum BenefitFlowEnum {
+    TOPUPS = "TOPUPS",
+    BILL_PAYMENT = "BILL_PAYMENT",
+    CREDIT = "CREDIT",
+    INSURANCE = "INSURANCE",
+    DONATION = "DONATION",
+    PHARMACY = "PHARMACY",
+    REMITTANCE = "REMITTANCE",
+    /** Fondeo de wallet PCF con efectivo via provider externo (Equality/Passport, OpenPay, …) — spec 13. */
+    WALLET_FUNDING = "WALLET_FUNDING"
+}

package/bin/benefitCenter/enums/BenefitFlowEnum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BenefitFlowEnum = void 0;
+var BenefitFlowEnum;
+(function (BenefitFlowEnum) {
+    BenefitFlowEnum["TOPUPS"] = "TOPUPS";
+    BenefitFlowEnum["BILL_PAYMENT"] = "BILL_PAYMENT";
+    BenefitFlowEnum["CREDIT"] = "CREDIT";
+    BenefitFlowEnum["INSURANCE"] = "INSURANCE";
+    BenefitFlowEnum["DONATION"] = "DONATION";
+    BenefitFlowEnum["PHARMACY"] = "PHARMACY";
+    BenefitFlowEnum["REMITTANCE"] = "REMITTANCE";
+    /** Fondeo de wallet PCF con efectivo via provider externo (Equality/Passport, OpenPay, …) — spec 13. */
+    BenefitFlowEnum["WALLET_FUNDING"] = "WALLET_FUNDING";
+})(BenefitFlowEnum || (exports.BenefitFlowEnum = BenefitFlowEnum = {}));

package/bin/identity/SsnItinSentinel.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Centinela del campo `SSN_ITIN`.
+ *
+ * El campo guarda tres estados distintos y cada uno significa algo:
+ *  - un número real (con o sin prefijo `SSN_` / `ITIN_`) => el cliente entregó su SSN o ITIN.
+ *  - `SSN_ITIN_DOESNT_HAVE`                              => se le preguntó y respondió que NO tiene.
+ *  - vacío / null / ausente                              => todavía no se le preguntó.
+ *
+ * La distinción entre el segundo y el tercero es la que gobierna el paso del onboarding, y la que
+ * el valor vacío no permitía hacer.
+ *
+ * ⚠️ Esta misma definición vive en `@fiado/fiado-abstractions`. Está duplicada a propósito: los
+ * repos que envían el dato hacia afuera (card-business, el connector de Central Payments, lista
+ * negra, account-fiadoinc) consumen type-kit y no aquella librería. Si una cambia, la otra también.
+ */
+export declare const SSN_ITIN_DOESNT_HAVE = "DOESNT_HAVE";
+/**
+ * Criterio único para "este cliente tiene un SSN/ITIN de verdad".
+ *
+ * Usalo en lugar de preguntar si el campo trae contenido. Un chequeo por contenido (`if (ssn)`,
+ * `!= null`, `.length > 4`) da verdadero para el centinela, y ahí es donde el valor termina
+ * viajando a un proveedor externo como identificación de una persona real.
+ *
+ * Tolera espacios alrededor y es sensible a mayúsculas: una grafía distinta a la del centinela es
+ * un dato mal escrito y conviene que se note, no que se absorba en silencio.
+ */
+export declare function hasRealSsn(ssnItin: string | null | undefined): boolean;

package/bin/identity/SsnItinSentinel.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SSN_ITIN_DOESNT_HAVE = void 0;
+exports.hasRealSsn = hasRealSsn;
+/**
+ * Centinela del campo `SSN_ITIN`.
+ *
+ * El campo guarda tres estados distintos y cada uno significa algo:
+ *  - un número real (con o sin prefijo `SSN_` / `ITIN_`) => el cliente entregó su SSN o ITIN.
+ *  - `SSN_ITIN_DOESNT_HAVE`                              => se le preguntó y respondió que NO tiene.
+ *  - vacío / null / ausente                              => todavía no se le preguntó.
+ *
+ * La distinción entre el segundo y el tercero es la que gobierna el paso del onboarding, y la que
+ * el valor vacío no permitía hacer.
+ *
+ * ⚠️ Esta misma definición vive en `@fiado/fiado-abstractions`. Está duplicada a propósito: los
+ * repos que envían el dato hacia afuera (card-business, el connector de Central Payments, lista
+ * negra, account-fiadoinc) consumen type-kit y no aquella librería. Si una cambia, la otra también.
+ */
+exports.SSN_ITIN_DOESNT_HAVE = "DOESNT_HAVE";
+/**
+ * Criterio único para "este cliente tiene un SSN/ITIN de verdad".
+ *
+ * Usalo en lugar de preguntar si el campo trae contenido. Un chequeo por contenido (`if (ssn)`,
+ * `!= null`, `.length > 4`) da verdadero para el centinela, y ahí es donde el valor termina
+ * viajando a un proveedor externo como identificación de una persona real.
+ *
+ * Tolera espacios alrededor y es sensible a mayúsculas: una grafía distinta a la del centinela es
+ * un dato mal escrito y conviene que se note, no que se absorba en silencio.
+ */
+function hasRealSsn(ssnItin) {
+    const value = (ssnItin ?? "").trim();
+    return !!value && value !== exports.SSN_ITIN_DOESNT_HAVE;
+}

package/bin/identity/index.d.ts

@@ -18,3 +18,4 @@ export * from './enums/AuthorizationNeededMXNStatus';
 export * from './enums/DocumentSideEnum';
 export * from './enums/CPStatusEnum';
 export * from './enums/AccountRequirementStatusEnum';
+export * from './SsnItinSentinel';

package/bin/identity/index.js

@@ -36,3 +36,5 @@ __exportStar(require("./enums/AuthorizationNeededMXNStatus"), exports);
 __exportStar(require("./enums/DocumentSideEnum"), exports);
 __exportStar(require("./enums/CPStatusEnum"), exports);
 __exportStar(require("./enums/AccountRequirementStatusEnum"), exports);
+//helpers
+__exportStar(require("./SsnItinSentinel"), exports);

package/bin/places/dtos/CashInFeeDto.d.ts

@@ -0,0 +1,17 @@
+import { CurrencyId } from '../../currency/enums/CurrencyId';
+/**
+ * Comisión que cobra un punto de cash-in (lo que el lambda MUESTRA, no cobra).
+ * - GreenDot (US): representativo por cadena → `fixed` + `cap` (cada tienda cobra hasta el tope).
+ * - Passport (MX): por red → `fixed` + `percentage`.
+ * Response DTO — sin decoradores de validación.
+ */
+export declare class CashInFeeDto {
+    /** Comisión fija, en la moneda del país. */
+    fixed?: number;
+    /** Porcentaje del monto depositado (0–100). */
+    percentage?: number;
+    /** Tope máximo de comisión (GreenDot: el asociado cobra hasta este cap). */
+    cap?: number;
+    /** Moneda del fee: USD (GreenDot) | MXN (Passport). */
+    currency: CurrencyId;
+}

package/bin/places/dtos/CashInFeeDto.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CashInFeeDto = void 0;
+/**
+ * Comisión que cobra un punto de cash-in (lo que el lambda MUESTRA, no cobra).
+ * - GreenDot (US): representativo por cadena → `fixed` + `cap` (cada tienda cobra hasta el tope).
+ * - Passport (MX): por red → `fixed` + `percentage`.
+ * Response DTO — sin decoradores de validación.
+ */
+class CashInFeeDto {
+}
+exports.CashInFeeDto = CashInFeeDto;

package/bin/platformRbac/dtos/CompleteMyProfileRequest.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Body del PUT /me/profile/complete (autenticado, gate post-MFA del autoregistro). DEC-RBAC-034.
+ * Opera sobre el propio usuario (cognitoSub del token). Valida nombre + los `userFieldDefs` requeridos
+ * del tenant (422 MISSING_REQUIRED_FIELDS si faltan) y flipea `profileComplete=true`.
+ */
+export declare class CompleteMyProfileRequest {
+    displayName: string;
+    customFields?: Record<string, string>;
+}

package/bin/platformRbac/dtos/CompleteMyProfileRequest.js

@@ -0,0 +1,34 @@
+"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.CompleteMyProfileRequest = void 0;
+const class_transformer_1 = require("class-transformer");
+const class_validator_1 = require("class-validator");
+/**
+ * Body del PUT /me/profile/complete (autenticado, gate post-MFA del autoregistro). DEC-RBAC-034.
+ * Opera sobre el propio usuario (cognitoSub del token). Valida nombre + los `userFieldDefs` requeridos
+ * del tenant (422 MISSING_REQUIRED_FIELDS si faltan) y flipea `profileComplete=true`.
+ */
+class CompleteMyProfileRequest {
+}
+exports.CompleteMyProfileRequest = CompleteMyProfileRequest;
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.IsNotEmpty)(),
+    __metadata("design:type", String)
+], CompleteMyProfileRequest.prototype, "displayName", void 0);
+__decorate([
+    (0, class_transformer_1.Expose)(),
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsObject)(),
+    __metadata("design:type", Object)
+], CompleteMyProfileRequest.prototype, "customFields", void 0);

package/bin/walletFunding/dtos/CancelFundingReferenceRequest.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Body para cancelar una referencia de funding ya creada. La referencia/fundingId
+ * viaja en la URL (`/funding/{moduleName}/{fundingId}/cancel`); este body aporta
+ * el contexto del solicitante + idempotencia.
+ *
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker`
+ * (benefits-marketplace / equality-connector) — confirmar con el dueño del
+ * módulo walletFunding / el lambda equality-connector que implementa el cancel.
+ */
+export declare class CancelFundingReferenceRequest {
+    directoryId: string;
+    reason?: string;
+    idempotencyKey: string;
+}

package/bin/walletFunding/dtos/CancelFundingReferenceRequest.js

@@ -0,0 +1,41 @@
+"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.CancelFundingReferenceRequest = void 0;
+const class_validator_1 = require("class-validator");
+/**
+ * Body para cancelar una referencia de funding ya creada. La referencia/fundingId
+ * viaja en la URL (`/funding/{moduleName}/{fundingId}/cancel`); este body aporta
+ * el contexto del solicitante + idempotencia.
+ *
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker`
+ * (benefits-marketplace / equality-connector) — confirmar con el dueño del
+ * módulo walletFunding / el lambda equality-connector que implementa el cancel.
+ */
+class CancelFundingReferenceRequest {
+}
+exports.CancelFundingReferenceRequest = CancelFundingReferenceRequest;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(64),
+    __metadata("design:type", String)
+], CancelFundingReferenceRequest.prototype, "directoryId", void 0);
+__decorate([
+    (0, class_validator_1.IsOptional)(),
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(256),
+    __metadata("design:type", String)
+], CancelFundingReferenceRequest.prototype, "reason", void 0);
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(64),
+    __metadata("design:type", String)
+], CancelFundingReferenceRequest.prototype, "idempotencyKey", void 0);

package/bin/walletFunding/dtos/CancelFundingReferenceResponse.d.ts

@@ -0,0 +1,15 @@
+import { BenefitPaymentStatusEnum } from "../../benefitCenter/enums/BenefitPaymentStatusEnum";
+import { WalletFundingErrorCodeEnum } from "../enums/WalletFundingErrorCodeEnum";
+/**
+ * Respuesta de la cancelación de una referencia de funding. Mismo estilo que
+ * CreateFundingReferenceResponse.
+ *
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker` — confirmar con el
+ * dueño del módulo walletFunding / el lambda equality-connector.
+ */
+export declare class CancelFundingReferenceResponse {
+    /** Referencia cancelada (misma PK que se creó). */
+    reference: string;
+    status: BenefitPaymentStatusEnum;
+    errorCode?: WalletFundingErrorCodeEnum;
+}

package/bin/walletFunding/dtos/CancelFundingReferenceResponse.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelFundingReferenceResponse = void 0;
+/**
+ * Respuesta de la cancelación de una referencia de funding. Mismo estilo que
+ * CreateFundingReferenceResponse.
+ *
+ * NOTA: shape inferido desde el uso en `@fiado/api-invoker` — confirmar con el
+ * dueño del módulo walletFunding / el lambda equality-connector.
+ */
+class CancelFundingReferenceResponse {
+}
+exports.CancelFundingReferenceResponse = CancelFundingReferenceResponse;

package/bin/walletFunding/dtos/CancelWalletFundingRequest.d.ts

@@ -0,0 +1,3 @@
+export declare class CancelWalletFundingRequest {
+    idempotencyKey: string;
+}

package/bin/walletFunding/dtos/CancelWalletFundingRequest.js

@@ -0,0 +1,21 @@
+"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.CancelWalletFundingRequest = void 0;
+const class_validator_1 = require("class-validator");
+class CancelWalletFundingRequest {
+}
+exports.CancelWalletFundingRequest = CancelWalletFundingRequest;
+__decorate([
+    (0, class_validator_1.IsString)(),
+    (0, class_validator_1.MaxLength)(64),
+    __metadata("design:type", String)
+], CancelWalletFundingRequest.prototype, "idempotencyKey", void 0);

package/bin/walletFunding/dtos/CancelWalletFundingResponse.d.ts

@@ -0,0 +1,7 @@
+import { BenefitPaymentStatusEnum } from "../../benefitCenter/enums/BenefitPaymentStatusEnum";
+import { WalletFundingErrorCodeEnum } from "../enums/WalletFundingErrorCodeEnum";
+export declare class CancelWalletFundingResponse {
+    status: BenefitPaymentStatusEnum;
+    errorCode?: WalletFundingErrorCodeEnum;
+    fundingId?: string;
+}

package/bin/walletFunding/dtos/CancelWalletFundingResponse.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CancelWalletFundingResponse = void 0;
+class CancelWalletFundingResponse {
+}
+exports.CancelWalletFundingResponse = CancelWalletFundingResponse;

package/package.json

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

package/src/identity/SsnItinSentinel.ts

@@ -0,0 +1,31 @@
+/**
+ * Centinela del campo `SSN_ITIN`.
+ *
+ * El campo guarda tres estados distintos y cada uno significa algo:
+ *  - un número real (con o sin prefijo `SSN_` / `ITIN_`) => el cliente entregó su SSN o ITIN.
+ *  - `SSN_ITIN_DOESNT_HAVE`                              => se le preguntó y respondió que NO tiene.
+ *  - vacío / null / ausente                              => todavía no se le preguntó.
+ *
+ * La distinción entre el segundo y el tercero es la que gobierna el paso del onboarding, y la que
+ * el valor vacío no permitía hacer.
+ *
+ * ⚠️ Esta misma definición vive en `@fiado/fiado-abstractions`. Está duplicada a propósito: los
+ * repos que envían el dato hacia afuera (card-business, el connector de Central Payments, lista
+ * negra, account-fiadoinc) consumen type-kit y no aquella librería. Si una cambia, la otra también.
+ */
+export const SSN_ITIN_DOESNT_HAVE = "DOESNT_HAVE";
+
+/**
+ * Criterio único para "este cliente tiene un SSN/ITIN de verdad".
+ *
+ * Usalo en lugar de preguntar si el campo trae contenido. Un chequeo por contenido (`if (ssn)`,
+ * `!= null`, `.length > 4`) da verdadero para el centinela, y ahí es donde el valor termina
+ * viajando a un proveedor externo como identificación de una persona real.
+ *
+ * Tolera espacios alrededor y es sensible a mayúsculas: una grafía distinta a la del centinela es
+ * un dato mal escrito y conviene que se note, no que se absorba en silencio.
+ */
+export function hasRealSsn(ssnItin: string | null | undefined): boolean {
+    const value = (ssnItin ?? "").trim();
+    return !!value && value !== SSN_ITIN_DOESNT_HAVE;
+}

package/src/identity/index.ts

@@ -23,3 +23,6 @@ export * from './enums/AuthorizationNeededMXNStatus';
 export * from './enums/DocumentSideEnum';
 export * from './enums/CPStatusEnum';
 export * from './enums/AccountRequirementStatusEnum';
+
+//helpers
+export * from './SsnItinSentinel';

package/bin/identity/enums/SelfieSourceEnum.d.ts

@@ -1,10 +0,0 @@
-/**
- * Con qué criterio se resolvió cuál archivo de S3 es la selfie del usuario.
- * Le dice al consumidor qué tan confiable es el match antes de mandarla a un facematch.
- */
-export declare enum SelfieSourceEnum {
-    /** Matcheó el verificationId de la verificación vigente en People. */
-    VERIFICATION = "VERIFICATION",
-    /** No hubo match por verificación: se tomó el archivo de selfie más reciente del bucket. */
-    LATEST = "LATEST"
-}

package/bin/identity/enums/SelfieSourceEnum.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SelfieSourceEnum = void 0;
-/**
- * Con qué criterio se resolvió cuál archivo de S3 es la selfie del usuario.
- * Le dice al consumidor qué tan confiable es el match antes de mandarla a un facematch.
- */
-var SelfieSourceEnum;
-(function (SelfieSourceEnum) {
-    /** Matcheó el verificationId de la verificación vigente en People. */
-    SelfieSourceEnum["VERIFICATION"] = "VERIFICATION";
-    /** No hubo match por verificación: se tomó el archivo de selfie más reciente del bucket. */
-    SelfieSourceEnum["LATEST"] = "LATEST";
-})(SelfieSourceEnum || (exports.SelfieSourceEnum = SelfieSourceEnum = {}));