@fiado/type-kit 3.286.0 → 3.289.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/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/phoneSales/DeviceCatalogModelDto.d.ts

@@ -0,0 +1,19 @@
+import { CurrencyId } from '../currency';
+import { DeviceVariantResponseDto } from './DeviceVariantResponseDto';
+/**
+ * Catálogo público agrupado por modelo (GET /device-variants, PublicController). Cada item agrupa
+ * las variantes visibles de un mismo `model` (ya filtradas por ListPublicDeviceVariantsManager:
+ * stock > 0, status distinto de HIDDEN, con precio cargado en la moneda del comprador) para que el
+ * front no tenga que agrupar/derivar esto del array plano de variantes.
+ */
+export declare class DeviceCatalogModelDto {
+    model: string;
+    /** Imagen representativa del modelo: la de la variante con `minPrice` dentro del grupo. */
+    imageUrl: string;
+    /** Precio mínimo (`price`) entre las variantes visibles del modelo, en `currencyId`. */
+    minPrice: number;
+    /** Misma moneda resuelta server-side que ya trae cada item de `variants` (DEC-011). */
+    currencyId: CurrencyId;
+    /** Variantes visibles del modelo, cada una con `price`/`currencyId` ya resueltos. */
+    variants: DeviceVariantResponseDto[];
+}

package/bin/phoneSales/DeviceCatalogModelDto.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceCatalogModelDto = void 0;
+/**
+ * Catálogo público agrupado por modelo (GET /device-variants, PublicController). Cada item agrupa
+ * las variantes visibles de un mismo `model` (ya filtradas por ListPublicDeviceVariantsManager:
+ * stock > 0, status distinto de HIDDEN, con precio cargado en la moneda del comprador) para que el
+ * front no tenga que agrupar/derivar esto del array plano de variantes.
+ */
+class DeviceCatalogModelDto {
+}
+exports.DeviceCatalogModelDto = DeviceCatalogModelDto;

package/bin/phoneSales/index.d.ts

@@ -1,4 +1,5 @@
 export * from './DeviceVariantResponseDto';
+export * from './DeviceCatalogModelDto';
 export * from './CreateDeviceVariantRequestDto';
 export * from './UpdateDeviceVariantRequestDto';
 export * from './CreateSaleRequestDto';

package/bin/phoneSales/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./DeviceVariantResponseDto"), exports);
+__exportStar(require("./DeviceCatalogModelDto"), exports);
 __exportStar(require("./CreateDeviceVariantRequestDto"), exports);
 __exportStar(require("./UpdateDeviceVariantRequestDto"), exports);
 __exportStar(require("./CreateSaleRequestDto"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/type-kit",
-  "version": "3.286.0",
+  "version": "3.289.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/src/phoneSales/DeviceCatalogModelDto.ts

@@ -0,0 +1,24 @@
+import { CurrencyId } from '../currency';
+import { DeviceVariantResponseDto } from './DeviceVariantResponseDto';
+
+/**
+ * Catálogo público agrupado por modelo (GET /device-variants, PublicController). Cada item agrupa
+ * las variantes visibles de un mismo `model` (ya filtradas por ListPublicDeviceVariantsManager:
+ * stock > 0, status distinto de HIDDEN, con precio cargado en la moneda del comprador) para que el
+ * front no tenga que agrupar/derivar esto del array plano de variantes.
+ */
+export class DeviceCatalogModelDto {
+  model!: string;
+
+  /** Imagen representativa del modelo: la de la variante con `minPrice` dentro del grupo. */
+  imageUrl!: string;
+
+  /** Precio mínimo (`price`) entre las variantes visibles del modelo, en `currencyId`. */
+  minPrice!: number;
+
+  /** Misma moneda resuelta server-side que ya trae cada item de `variants` (DEC-011). */
+  currencyId!: CurrencyId;
+
+  /** Variantes visibles del modelo, cada una con `price`/`currencyId` ya resueltos. */
+  variants!: DeviceVariantResponseDto[];
+}

package/src/phoneSales/index.ts

@@ -1,4 +1,5 @@
 export * from './DeviceVariantResponseDto';
+export * from './DeviceCatalogModelDto';
 export * from './CreateDeviceVariantRequestDto';
 export * from './UpdateDeviceVariantRequestDto';
 export * from './CreateSaleRequestDto';