@fiado/type-kit 3.47.0 → 3.49.0

package/src/benefitCenter/dtos/AuthorizeBenefitsMarketplaceTransactionRequest.ts

@@ -1,138 +1,138 @@
-import {
-    IsLatitude,
-    IsLongitude,
-    IsNotEmpty,
-    IsNumber,
-    IsObject,
-    IsOptional,
-    IsPositive,
-    IsString,
-    Matches,
-    Max,
-    MaxLength,
-} from "class-validator";
-
-/**
- * Request del endpoint nuevo `POST /authorizeBenefitsMarketplaceTransaction`
- * en `transaction-processor-business` (PublicController). Lo invoca la app
- * para todos los flujos del Centro de Beneficios.
- *
- * NO se reusa `AuthorizePaymentTransactionRequest` ni similares: este DTO
- * es dedicado, sin sub-objetos opcionales, con los campos del Centro como
- * ciudadanos de primera clase.
- *
- * Los endpoints `authorize*Transaction` actuales del procesador no se tocan
- * y siguen recibiendo su tráfico legacy. Ver doc Fase 2 §5.1.
- */
-export class AuthorizeBenefitsMarketplaceTransactionRequest {
-    /**
-     * Reusa entradas existentes en `ProductCatalog_GT` del procesador
-     * (`MEX_TOPUP`, `MEX_SERVICE_PAYMENT`, …). No se agregan entradas nuevas
-     * en Fase 2 (ver doc §10).
-     *
-     * El factory dinámico `TransactionProcessorFactory.getMarketplaceInstance`
-     * deriva el token del binding desde aquí (`MEX_<X>` →
-     * `BenefitsMarketplace<X>TransactionService`). La regex impone el contrato
-     * y permite que el factory falle con 400 en lugar de 500 si llega algo
-     * fuera de la convención.
-     */
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(64)
-    @Matches(/^MEX_[A-Z][A-Z_]*$/, {
-        message: "productCatalogId debe seguir el formato MEX_<UPPER_SNAKE>",
-    })
-    productCatalogId!: string;
-
-    /**
-     * Idempotency key generada por la **app** (UUID por intento).
-     * Lo consume el decorador `@IdempotencyController` del procesador para
-     * deduplicar reintentos del cliente.
-     *
-     * Distinto de `BenefitPaymentRequest.transactionNumber` que el procesador
-     * genera internamente al crear la transacción y envía al marketplace y
-     * al conector como idempotency key del lado del proveedor. La app NO
-     * debe generar `transactionNumber` — por eso este DTO no lo expone.
-     */
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(64)
-    idempotencyKey!: string;
-
-    /**
-     * Monto en unidad mayor de la moneda (no centavos). Como mucho 2 decimales.
-     * El `Max` cap es defensivo — atrapa errores obvios (montos absurdos por
-     * bugs de UI) sin restringir casos legítimos. Ajustar si la operatoria
-     * requiere techos mayores.
-     */
-    @IsNumber({maxDecimalPlaces: 2})
-    @IsPositive()
-    @Max(1_000_000)
-    amount!: number;
-
-    /** ISO numeric (3 chars). Ej: "484" (MXN), "840" (USD). */
-    @IsString()
-    @Matches(/^\d{3}$/, {
-        message: "currencyId debe ser ISO numérico de 3 dígitos",
-    })
-    currencyId!: string;
-
-    // Campos del Centro de Beneficios — first-class, no opcionales
-
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(64)
-    benefitId!: string;
-
-    /**
-     * `leafId = base64url("<moduleName>::<idServicio>")`. Convención
-     * cross-componente del Centro (ver
-     * `docs/favorites/05b-favoritos-ligados-a-producto.md`). La regex
-     * enforce el charset base64url sin tener que decodificar acá.
-     */
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(256)
-    @Matches(/^[A-Za-z0-9_-]+$/, {
-        message: "leafId debe estar codificado en base64url (charset A-Za-z0-9_-)",
-    })
-    leafId!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(64)
-    productId!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(128)
-    reference!: string;
-
-    /**
-     * Decide a qué conector apuntar dentro del marketplace. Va concatenado
-     * a la URL `POST /pay/{moduleName}` del marketplace privado. La regex
-     * restringe a charset seguro (kebab-case minúsculas), previene
-     * inyecciones de path y matchea la convención de naming de los
-     * lambdas Fiado.
-     */
-    @IsString()
-    @IsNotEmpty()
-    @MaxLength(128)
-    @Matches(/^[a-z][a-z0-9-]*$/, {
-        message: "moduleName debe ser kebab-case minúsculas",
-    })
-    moduleName!: string;
-
-    /** Inputs dinámicos del leaf — opcionales según el servicio. */
-    @IsOptional()
-    @IsObject()
-    inputs?: Record<string, string | number | boolean>;
-
-    @IsOptional()
-    @IsLatitude()
-    latitude?: number;
-
-    @IsOptional()
-    @IsLongitude()
-    longitude?: number;
-}
+import {
+    IsLatitude,
+    IsLongitude,
+    IsNotEmpty,
+    IsNumber,
+    IsObject,
+    IsOptional,
+    IsPositive,
+    IsString,
+    Matches,
+    Max,
+    MaxLength,
+} from "class-validator";
+
+/**
+ * Request del endpoint nuevo `POST /authorizeBenefitsMarketplaceTransaction`
+ * en `transaction-processor-business` (PublicController). Lo invoca la app
+ * para todos los flujos del Centro de Beneficios.
+ *
+ * NO se reusa `AuthorizePaymentTransactionRequest` ni similares: este DTO
+ * es dedicado, sin sub-objetos opcionales, con los campos del Centro como
+ * ciudadanos de primera clase.
+ *
+ * Los endpoints `authorize*Transaction` actuales del procesador no se tocan
+ * y siguen recibiendo su tráfico legacy. Ver doc Fase 2 §5.1.
+ */
+export class AuthorizeBenefitsMarketplaceTransactionRequest {
+    /**
+     * Reusa entradas existentes en `ProductCatalog_GT` del procesador
+     * (`MEX_TOPUP`, `MEX_SERVICE_PAYMENT`, …). No se agregan entradas nuevas
+     * en Fase 2 (ver doc §10).
+     *
+     * El factory dinámico `TransactionProcessorFactory.getMarketplaceInstance`
+     * deriva el token del binding desde aquí (`MEX_<X>` →
+     * `BenefitsMarketplace<X>TransactionService`). La regex impone el contrato
+     * y permite que el factory falle con 400 en lugar de 500 si llega algo
+     * fuera de la convención.
+     */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    @Matches(/^MEX_[A-Z][A-Z_]*$/, {
+        message: "productCatalogId debe seguir el formato MEX_<UPPER_SNAKE>",
+    })
+    productCatalogId!: string;
+
+    /**
+     * Idempotency key generada por la **app** (UUID por intento).
+     * Lo consume el decorador `@IdempotencyController` del procesador para
+     * deduplicar reintentos del cliente.
+     *
+     * Distinto de `BenefitPaymentRequest.transactionNumber` que el procesador
+     * genera internamente al crear la transacción y envía al marketplace y
+     * al conector como idempotency key del lado del proveedor. La app NO
+     * debe generar `transactionNumber` — por eso este DTO no lo expone.
+     */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    idempotencyKey!: string;
+
+    /**
+     * Monto en unidad mayor de la moneda (no centavos). Como mucho 2 decimales.
+     * El `Max` cap es defensivo — atrapa errores obvios (montos absurdos por
+     * bugs de UI) sin restringir casos legítimos. Ajustar si la operatoria
+     * requiere techos mayores.
+     */
+    @IsNumber({maxDecimalPlaces: 2})
+    @IsPositive()
+    @Max(1_000_000)
+    amount!: number;
+
+    /** ISO numeric (3 chars). Ej: "484" (MXN), "840" (USD). */
+    @IsString()
+    @Matches(/^\d{3}$/, {
+        message: "currencyId debe ser ISO numérico de 3 dígitos",
+    })
+    currencyId!: string;
+
+    // Campos del Centro de Beneficios — first-class, no opcionales
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    benefitId!: string;
+
+    /**
+     * `leafId = base64url("<moduleName>::<idServicio>")`. Convención
+     * cross-componente del Centro (ver
+     * `docs/favorites/05b-favoritos-ligados-a-producto.md`). La regex
+     * enforce el charset base64url sin tener que decodificar acá.
+     */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(256)
+    @Matches(/^[A-Za-z0-9_-]+$/, {
+        message: "leafId debe estar codificado en base64url (charset A-Za-z0-9_-)",
+    })
+    leafId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(64)
+    productId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(128)
+    reference!: string;
+
+    /**
+     * Decide a qué conector apuntar dentro del marketplace. Va concatenado
+     * a la URL `POST /pay/{moduleName}` del marketplace privado. La regex
+     * restringe a charset seguro (kebab-case minúsculas), previene
+     * inyecciones de path y matchea la convención de naming de los
+     * lambdas Fiado.
+     */
+    @IsString()
+    @IsNotEmpty()
+    @MaxLength(128)
+    @Matches(/^[a-z][a-z0-9-]*$/, {
+        message: "moduleName debe ser kebab-case minúsculas",
+    })
+    moduleName!: string;
+
+    /** Inputs dinámicos del leaf — opcionales según el servicio. */
+    @IsOptional()
+    @IsObject()
+    inputs?: Record<string, string | number | boolean>;
+
+    @IsOptional()
+    @IsLatitude()
+    latitude?: number;
+
+    @IsOptional()
+    @IsLongitude()
+    longitude?: number;
+}

package/src/benefitCenter/dtos/BackofficeInputLabelsUpdateRequest.ts

@@ -1,16 +1,16 @@
-import { IsNotEmpty, IsObject } from "class-validator";
-
-/**
- * Body de PUT /backoffice/leaves/{leafId}/input-labels.
- *
- * Override de los `label` del inputSchema, keyed por `key` de campo
- * (ej. `{ "phoneNumber": "Tu número Telcel" }`). El conector guarda el map y
- * lo aplica al construir el schema; los campos sin override mantienen el label
- * generado.
- */
-export class BackofficeInputLabelsUpdateRequest {
-    /** Map fieldKey → label. Los valores deben ser strings. */
-    @IsObject()
-    @IsNotEmpty()
-    labels!: Record<string, string>;
-}
+import { IsNotEmpty, IsObject } from "class-validator";
+
+/**
+ * Body de PUT /backoffice/leaves/{leafId}/input-labels.
+ *
+ * Override de los `label` del inputSchema, keyed por `key` de campo
+ * (ej. `{ "phoneNumber": "Tu número Telcel" }`). El conector guarda el map y
+ * lo aplica al construir el schema; los campos sin override mantienen el label
+ * generado.
+ */
+export class BackofficeInputLabelsUpdateRequest {
+    /** Map fieldKey → label. Los valores deben ser strings. */
+    @IsObject()
+    @IsNotEmpty()
+    labels!: Record<string, string>;
+}

package/src/benefitCenter/dtos/BackofficeLeafCreateRequest.ts

@@ -1,90 +1,90 @@
-import {
-    ArrayNotEmpty,
-    IsArray,
-    IsBoolean,
-    IsEnum,
-    IsInt,
-    IsNotEmpty,
-    IsOptional,
-    IsString,
-    Min,
-    ValidateNested,
-} from "class-validator";
-import { Type } from "class-transformer";
-import { Provider } from "../../provider/enums/Provider";
-import { BackofficeProductCreateItem } from "./BackofficeProductCreateItem";
-
-/**
- * Body de POST /backoffice/leaves — alta manual de un servicio nuevo en el
- * catálogo, en forma estándar. bmb rutea por `provider` al conector destino,
- * que traduce a su forma nativa y persiste.
- *
- * `serviceId` (idServicio) y los `productId` vienen del Excel del proveedor
- * (ids reales). Si el `serviceId` ya existe → 409 (no sobrescribe).
- */
-export class BackofficeLeafCreateRequest {
-    /** Determina el conector destino (STP vs multicomm). */
-    @IsEnum(Provider)
-    provider!: Provider;
-
-    /** "ben-3" (recargas) | "ben-6" (pagos). */
-    @IsString()
-    @IsNotEmpty()
-    benefitId!: string;
-
-    /** idServicio real del proveedor (del Excel). */
-    @IsString()
-    @IsNotEmpty()
-    serviceId!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    serviceName!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    category!: string;
-
-    @IsString()
-    @IsNotEmpty()
-    subcategory!: string;
-
-    /** Código de moneda ISO (ej. "MXN", "USD"). */
-    @IsString()
-    @IsNotEmpty()
-    currency!: string;
-
-    /** Código ISO numérico del país destino (ej. "484"). */
-    @IsString()
-    @IsNotEmpty()
-    countryId!: string;
-
-    /** Logo del servicio (→ logoSrc). */
-    @IsOptional()
-    @IsString()
-    logo?: string;
-
-    /** Orden del servicio dentro de su subcategoría. Default 1. */
-    @IsOptional()
-    @IsInt()
-    @Min(0)
-    serviceOrder?: number;
-
-    /** Orden de la subcategoría. Default 1. */
-    @IsOptional()
-    @IsInt()
-    @Min(0)
-    subcategoryOrder?: number;
-
-    /** Habilitado en el catálogo público. Default true. */
-    @IsOptional()
-    @IsBoolean()
-    enabled?: boolean;
-
-    /** Productos del servicio (≥1). */
-    @IsArray()
-    @ArrayNotEmpty()
-    @ValidateNested({ each: true })
-    @Type(() => BackofficeProductCreateItem)
-    products!: BackofficeProductCreateItem[];
-}
+import {
+    ArrayNotEmpty,
+    IsArray,
+    IsBoolean,
+    IsEnum,
+    IsInt,
+    IsNotEmpty,
+    IsOptional,
+    IsString,
+    Min,
+    ValidateNested,
+} from "class-validator";
+import { Type } from "class-transformer";
+import { Provider } from "../../provider/enums/Provider";
+import { BackofficeProductCreateItem } from "./BackofficeProductCreateItem";
+
+/**
+ * Body de POST /backoffice/leaves — alta manual de un servicio nuevo en el
+ * catálogo, en forma estándar. bmb rutea por `provider` al conector destino,
+ * que traduce a su forma nativa y persiste.
+ *
+ * `serviceId` (idServicio) y los `productId` vienen del Excel del proveedor
+ * (ids reales). Si el `serviceId` ya existe → 409 (no sobrescribe).
+ */
+export class BackofficeLeafCreateRequest {
+    /** Determina el conector destino (STP vs multicomm). */
+    @IsEnum(Provider)
+    provider!: Provider;
+
+    /** "ben-3" (recargas) | "ben-6" (pagos). */
+    @IsString()
+    @IsNotEmpty()
+    benefitId!: string;
+
+    /** idServicio real del proveedor (del Excel). */
+    @IsString()
+    @IsNotEmpty()
+    serviceId!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    serviceName!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    category!: string;
+
+    @IsString()
+    @IsNotEmpty()
+    subcategory!: string;
+
+    /** Código de moneda ISO (ej. "MXN", "USD"). */
+    @IsString()
+    @IsNotEmpty()
+    currency!: string;
+
+    /** Código ISO numérico del país destino (ej. "484"). */
+    @IsString()
+    @IsNotEmpty()
+    countryId!: string;
+
+    /** Logo del servicio (→ logoSrc). */
+    @IsOptional()
+    @IsString()
+    logo?: string;
+
+    /** Orden del servicio dentro de su subcategoría. Default 1. */
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    serviceOrder?: number;
+
+    /** Orden de la subcategoría. Default 1. */
+    @IsOptional()
+    @IsInt()
+    @Min(0)
+    subcategoryOrder?: number;
+
+    /** Habilitado en el catálogo público. Default true. */
+    @IsOptional()
+    @IsBoolean()
+    enabled?: boolean;
+
+    /** Productos del servicio (≥1). */
+    @IsArray()
+    @ArrayNotEmpty()
+    @ValidateNested({ each: true })
+    @Type(() => BackofficeProductCreateItem)
+    products!: BackofficeProductCreateItem[];
+}

package/src/benefitCenter/dtos/BackofficeLeafDetailResponse.ts

@@ -1,14 +1,14 @@
-import { ConnectorCatalogItem } from "./ConnectorCatalogItem";
-
-/**
- * Respuesta del detalle de un leaf en el backoffice (v2 in-place).
- * Devuelve el item del catálogo del conector tal cual — sin paso de merge
- * (la edición editorial vive in-place en la tabla del conector).
- */
-export interface BackofficeLeafDetailResponse {
-    leafId: string;
-    benefitId: string;
-    moduleName: string;
-    serviceId: string;
-    item: ConnectorCatalogItem;
-}
+import { ConnectorCatalogItem } from "./ConnectorCatalogItem";
+
+/**
+ * Respuesta del detalle de un leaf en el backoffice (v2 in-place).
+ * Devuelve el item del catálogo del conector tal cual — sin paso de merge
+ * (la edición editorial vive in-place en la tabla del conector).
+ */
+export interface BackofficeLeafDetailResponse {
+    leafId: string;
+    benefitId: string;
+    moduleName: string;
+    serviceId: string;
+    item: ConnectorCatalogItem;
+}

package/src/benefitCenter/dtos/BackofficeLeafFacetsResponse.ts

@@ -1,26 +1,26 @@
-/**
- * Respuesta del endpoint GET /backoffice/leaves/facets.
- *
- * Devuelve los valores distintos observados en el catálogo de ben-3 y ben-6
- * (ambos módulos: multicomm + stp). El front lo consume al cargar la pantalla
- * para armar dropdowns dinámicos de category/subcategory.
- *
- * NO incluye providers — esa lista es estática (el enum `Provider` del type-kit).
- */
-export interface BackofficeLeafFacetsResponse {
-    /** Categorías distintas en uso, ordenadas alfabéticamente. */
-    categories: string[];
-
-    /**
-     * Subcategorías por categoría, ordenadas alfabéticamente.
-     * Key = nombre de categoría, value = array de subcategorías que aparecen bajo esa categoría.
-     */
-    subcategoriesByCategory: { [category: string]: string[] };
-
-    /**
-     * Países destino distintos observados en el catálogo (códigos ISO numéricos,
-     * ordenados). El front arma el dropdown de filtro por país; el mapeo
-     * code→nombre/bandera es responsabilidad del front.
-     */
-    countries: string[];
-}
+/**
+ * Respuesta del endpoint GET /backoffice/leaves/facets.
+ *
+ * Devuelve los valores distintos observados en el catálogo de ben-3 y ben-6
+ * (ambos módulos: multicomm + stp). El front lo consume al cargar la pantalla
+ * para armar dropdowns dinámicos de category/subcategory.
+ *
+ * NO incluye providers — esa lista es estática (el enum `Provider` del type-kit).
+ */
+export interface BackofficeLeafFacetsResponse {
+    /** Categorías distintas en uso, ordenadas alfabéticamente. */
+    categories: string[];
+
+    /**
+     * Subcategorías por categoría, ordenadas alfabéticamente.
+     * Key = nombre de categoría, value = array de subcategorías que aparecen bajo esa categoría.
+     */
+    subcategoriesByCategory: { [category: string]: string[] };
+
+    /**
+     * Países destino distintos observados en el catálogo (códigos ISO numéricos,
+     * ordenados). El front arma el dropdown de filtro por país; el mapeo
+     * code→nombre/bandera es responsabilidad del front.
+     */
+    countries: string[];
+}

package/src/benefitCenter/dtos/BackofficeLeafHelpImageUpdateRequest.ts

@@ -1,13 +1,13 @@
-import { IsNotEmpty, IsString } from "class-validator";
-
-/**
- * Body de PUT /backoffice/leaves/{leafId}/help-image.
- *
- * Asigna la imagen de ayuda (`refSrc`) a TODOS los productos del servicio.
- */
-export class BackofficeLeafHelpImageUpdateRequest {
-    /** URL pública de la imagen de ayuda (CloudFront) ya subida. */
-    @IsString()
-    @IsNotEmpty()
-    helpImage!: string;
-}
+import { IsNotEmpty, IsString } from "class-validator";
+
+/**
+ * Body de PUT /backoffice/leaves/{leafId}/help-image.
+ *
+ * Asigna la imagen de ayuda (`refSrc`) a TODOS los productos del servicio.
+ */
+export class BackofficeLeafHelpImageUpdateRequest {
+    /** URL pública de la imagen de ayuda (CloudFront) ya subida. */
+    @IsString()
+    @IsNotEmpty()
+    helpImage!: string;
+}

package/src/benefitCenter/dtos/BackofficeLeafListItem.ts

@@ -1,27 +1,27 @@
-import { Provider } from "../../provider/enums/Provider";
-
-/**
- * Item del listado paginado de leaves en el backoffice (v3 — provider + currency + orders).
- * Cada item representa un servicio del catálogo del conector, ya con
- * los valores editoriales aplicados (no hay "base/override/effective" —
- * la edición es in-place sobre la tabla del conector).
- */
-export interface BackofficeLeafListItem {
-    leafId: string;
-    benefitId: string;
-    moduleName: string;
-    serviceId: string;
-    category: string;
-    subcategory: string;
-    serviceName: string;
-    logo: string;
-    enabled: boolean;
-    updatedAt: number;       // ms epoch — del item del conector
-
-    // v3 additions
-    provider: Provider;      // MULTICOMM | MULTICENTER | STP — read-only, separa el lambda del proveedor real
-    currency: string;        // USD, MXN — moneda con la que se paga
-    countryId: string;       // ISO numérico del país destino de la recarga (840 USA, 484 MX, 192 CU, …)
-    serviceOrder: number;    // orden del leaf en su subcategory
-    subcategoryOrder: number;// orden de la subcategory en su category
-}
+import { Provider } from "../../provider/enums/Provider";
+
+/**
+ * Item del listado paginado de leaves en el backoffice (v3 — provider + currency + orders).
+ * Cada item representa un servicio del catálogo del conector, ya con
+ * los valores editoriales aplicados (no hay "base/override/effective" —
+ * la edición es in-place sobre la tabla del conector).
+ */
+export interface BackofficeLeafListItem {
+    leafId: string;
+    benefitId: string;
+    moduleName: string;
+    serviceId: string;
+    category: string;
+    subcategory: string;
+    serviceName: string;
+    logo: string;
+    enabled: boolean;
+    updatedAt: number;       // ms epoch — del item del conector
+
+    // v3 additions
+    provider: Provider;      // MULTICOMM | MULTICENTER | STP — read-only, separa el lambda del proveedor real
+    currency: string;        // USD, MXN — moneda con la que se paga
+    countryId: string;       // ISO numérico del país destino de la recarga (840 USA, 484 MX, 192 CU, …)
+    serviceOrder: number;    // orden del leaf en su subcategory
+    subcategoryOrder: number;// orden de la subcategory en su category
+}