@fiado/type-kit 3.33.0 → 3.36.0

package/src/benefitCenter/dtos/FavoriteValidationResult.ts

@@ -1,37 +1,37 @@
-import { AmountTypeEnum } from "../../servicePayment/enums/AmountTypeEnum";
-import { FavoriteDisabledReasonEnum } from "../enums/FavoriteDisabledReasonEnum";
-
-/**
- * Información del leaf incluida en el response del validate cuando se pudo
- * resolver. Si el leaf no existe (`reason === LEAF_NOT_FOUND`), no viaja.
- */
-export class FavoriteValidationLeaf {
-    name: string;
-    logo: string;
-    enabled: boolean;
-}
-
-/**
- * Información del producto. `price` es `null` cuando `amountType === VARIABLE`
- * (productos de monto abierto donde el usuario decide cuánto pagar).
- */
-export class FavoriteValidationProduct {
-    productId: string;
-    productName: string;
-    amountType: AmountTypeEnum;
-    price: number | null;
-    currency: string;
-}
-
-/**
- * Resultado del endpoint `POST /favorites/{id}/validate`. Si `valid === false`,
- * el backend ya marcó `disabled: true` con `disabledReason: <reason>` en la
- * misma operación (excepto `USER`, que solo se setea por soft-delete del usuario).
- */
-export class FavoriteValidationResult {
-    id: string;
-    valid: boolean;
-    reason?: FavoriteDisabledReasonEnum;   // Nunca `USER` — eso es soft delete, no validación.
-    leaf?: FavoriteValidationLeaf;
-    product?: FavoriteValidationProduct;
-}
+import { AmountTypeEnum } from "../../servicePayment/enums/AmountTypeEnum";
+import { FavoriteDisabledReasonEnum } from "../enums/FavoriteDisabledReasonEnum";
+
+/**
+ * Información del leaf incluida en el response del validate cuando se pudo
+ * resolver. Si el leaf no existe (`reason === LEAF_NOT_FOUND`), no viaja.
+ */
+export class FavoriteValidationLeaf {
+    name: string;
+    logo: string;
+    enabled: boolean;
+}
+
+/**
+ * Información del producto. `price` es `null` cuando `amountType === VARIABLE`
+ * (productos de monto abierto donde el usuario decide cuánto pagar).
+ */
+export class FavoriteValidationProduct {
+    productId: string;
+    productName: string;
+    amountType: AmountTypeEnum;
+    price: number | null;
+    currency: string;
+}
+
+/**
+ * Resultado del endpoint `POST /favorites/{id}/validate`. Si `valid === false`,
+ * el backend ya marcó `disabled: true` con `disabledReason: <reason>` en la
+ * misma operación (excepto `USER`, que solo se setea por soft-delete del usuario).
+ */
+export class FavoriteValidationResult {
+    id: string;
+    valid: boolean;
+    reason?: FavoriteDisabledReasonEnum;   // Nunca `USER` — eso es soft delete, no validación.
+    leaf?: FavoriteValidationLeaf;
+    product?: FavoriteValidationProduct;
+}

package/src/benefitCenter/dtos/InputField.ts

@@ -1,14 +1,14 @@
-import { InputFieldTypeEnum } from "../enums/InputFieldTypeEnum";
-import { SelectOption } from "./SelectOption";
-
-export class InputField {
-    key: string;
-    type: InputFieldTypeEnum;
-    label: string;
-    required: boolean;
-    placeholder?: string;
-    helpImage?: string;
-    showHelp?: boolean;
-    options?: SelectOption[];
-    dependsOn?: string;
-}
+import { InputFieldTypeEnum } from "../enums/InputFieldTypeEnum";
+import { SelectOption } from "./SelectOption";
+
+export class InputField {
+    key: string;
+    type: InputFieldTypeEnum;
+    label: string;
+    required: boolean;
+    placeholder?: string;
+    helpImage?: string;
+    showHelp?: boolean;
+    options?: SelectOption[];
+    dependsOn?: string;
+}

package/src/benefitCenter/dtos/InputSchema.ts

@@ -1,7 +1,7 @@
-import { InputField } from "./InputField";
-import { InputValidation } from "./InputValidation";
-
-export class InputSchema {
-    fields: InputField[];
-    validations?: Record<string, InputValidation>;
-}
+import { InputField } from "./InputField";
+import { InputValidation } from "./InputValidation";
+
+export class InputSchema {
+    fields: InputField[];
+    validations?: Record<string, InputValidation>;
+}

package/src/benefitCenter/dtos/InputValidation.ts

@@ -1,8 +1,8 @@
-export class InputValidation {
-    pattern?: string;
-    maxLength?: number;
-    minLength?: number;
-    min?: number;
-    max?: number;
-    hasCheckDigit?: boolean;
-}
+export class InputValidation {
+    pattern?: string;
+    maxLength?: number;
+    minLength?: number;
+    min?: number;
+    max?: number;
+    hasCheckDigit?: boolean;
+}

package/src/benefitCenter/dtos/ProductItem.ts

@@ -1,11 +1,11 @@
-import { AmountTypeEnum } from "../../servicePayment";
-
-export class ProductItem {
-    productId: string;
-    productName: string;
-    price: number;
-    fee: number;
-    amountType: AmountTypeEnum;
-    logo: string;
-    helpText: string;
-}
+import { AmountTypeEnum } from "../../servicePayment";
+
+export class ProductItem {
+    productId: string;
+    productName: string;
+    price: number;
+    fee: number;
+    amountType: AmountTypeEnum;
+    logo: string;
+    helpText: string;
+}

package/src/benefitCenter/dtos/PublicVerifyReferenceRequest.ts

@@ -1,33 +1,33 @@
-import { IsNotEmpty, IsString, Length } from "class-validator";
-
-/**
- * Request del endpoint público POST /benefits/{benefitId}/verificateReference del
- * `benefits-marketplace-business`. Combina:
- *  - Los campos de `BenefitReferenceVerificationRequest` (serviceId/productId/reference)
- *  - Un `leafId` adicional para que el lambda del Centro sepa a qué módulo rutear
- *    la verificación sin tener que buscar por anchor.
- *
- * Se expone separado de `BenefitReferenceVerificationRequest` porque éste último
- * es el contrato DIRECTO al conector (no conoce de leafIds).
- */
-export class PublicVerifyReferenceRequest {
-    @IsNotEmpty()
-    @IsString()
-    @Length(1, 100)
-    leafId!: string;
-
-    @IsNotEmpty()
-    @IsString()
-    @Length(1, 50)
-    serviceId!: string;
-
-    @IsNotEmpty()
-    @IsString()
-    @Length(1, 50)
-    productId!: string;
-
-    @IsNotEmpty()
-    @IsString()
-    @Length(1, 100)
-    reference!: string;
-}
+import { IsNotEmpty, IsString, Length } from "class-validator";
+
+/**
+ * Request del endpoint público POST /benefits/{benefitId}/verificateReference del
+ * `benefits-marketplace-business`. Combina:
+ *  - Los campos de `BenefitReferenceVerificationRequest` (serviceId/productId/reference)
+ *  - Un `leafId` adicional para que el lambda del Centro sepa a qué módulo rutear
+ *    la verificación sin tener que buscar por anchor.
+ *
+ * Se expone separado de `BenefitReferenceVerificationRequest` porque éste último
+ * es el contrato DIRECTO al conector (no conoce de leafIds).
+ */
+export class PublicVerifyReferenceRequest {
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 100)
+    leafId!: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 50)
+    serviceId!: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 50)
+    productId!: string;
+
+    @IsNotEmpty()
+    @IsString()
+    @Length(1, 100)
+    reference!: string;
+}

package/src/benefitCenter/dtos/SelectOption.ts

@@ -1,4 +1,4 @@
-export class SelectOption {
-    value: string;
-    label: string;
-}
+export class SelectOption {
+    value: string;
+    label: string;
+}

package/src/benefitCenter/dtos/ServiceLeaf.ts

@@ -1,14 +1,14 @@
-import { ProductItem } from "./ProductItem";
-import { InputSchema } from "./InputSchema";
-
-export class ServiceLeaf {
-    leafId: string;
-    serviceId: string;
-    moduleName: string;
-    currency: string;
-    countryId: string;
-    requiresReferenceVerification: boolean;
-    products: ProductItem[];
-    inputSchema: InputSchema;
-    updatedAt: number;
-}
+import { ProductItem } from "./ProductItem";
+import { InputSchema } from "./InputSchema";
+
+export class ServiceLeaf {
+    leafId: string;
+    serviceId: string;
+    moduleName: string;
+    currency: string;
+    countryId: string;
+    requiresReferenceVerification: boolean;
+    products: ProductItem[];
+    inputSchema: InputSchema;
+    updatedAt: number;
+}

package/src/benefitCenter/enums/BannerActionTypeEnum.ts

@@ -1,14 +1,14 @@
-/**
- * Tipos de acción de un banner.
- *
- * - URL          → abre una URL externa en el navegador del sistema
- * - NAVIGATION   → navegación interna basada en `flow` + `props` opcionales
- *
- * Cuando un banner es puramente informativo (no debe responder al tap),
- * se omite el campo `action` por completo del documento — no existe un
- * type "NONE".
- */
-export enum BannerActionTypeEnum {
-    URL = "URL",
-    NAVIGATION = "NAVIGATION",
-}
+/**
+ * Tipos de acción de un banner.
+ *
+ * - URL          → abre una URL externa en el navegador del sistema
+ * - NAVIGATION   → navegación interna basada en `flow` + `props` opcionales
+ *
+ * Cuando un banner es puramente informativo (no debe responder al tap),
+ * se omite el campo `action` por completo del documento — no existe un
+ * type "NONE".
+ */
+export enum BannerActionTypeEnum {
+    URL = "URL",
+    NAVIGATION = "NAVIGATION",
+}

package/src/benefitCenter/enums/BannerAssetKindEnum.ts

@@ -1,11 +1,11 @@
-/**
- * Tipo de asset que el backoffice quiere subir para un banner.
- *
- * Determina el whitelist de MIME types y el tamaño máximo permitido por la
- * presigned URL que devuelve el backend.
- */
-export enum BannerAssetKindEnum {
-    IMAGE = "IMAGE",
-    VIDEO = "VIDEO",
-    POSTER = "POSTER",
-}
+/**
+ * Tipo de asset que el backoffice quiere subir para un banner.
+ *
+ * Determina el whitelist de MIME types y el tamaño máximo permitido por la
+ * presigned URL que devuelve el backend.
+ */
+export enum BannerAssetKindEnum {
+    IMAGE = "IMAGE",
+    VIDEO = "VIDEO",
+    POSTER = "POSTER",
+}

package/src/benefitCenter/enums/BannerContentTypeEnum.ts

@@ -1,14 +1,14 @@
-/**
- * Tipos de contenido de un banner.
- *
- * - IMAGE     → imagen estática (URL por idioma).
- * - HTML      → fragmento de markup que la app renderiza en una WebView.
- * - VIDEO     → video con autoplay/muted/loop, fallback a posterUrl si falla la reproducción.
- * - TEMPLATE  → layout pre-definido renderizado nativamente, parametrizado por variante + theme.
- */
-export enum BannerContentTypeEnum {
-    IMAGE = "IMAGE",
-    HTML = "HTML",
-    VIDEO = "VIDEO",
-    TEMPLATE = "TEMPLATE",
-}
+/**
+ * Tipos de contenido de un banner.
+ *
+ * - IMAGE     → imagen estática (URL por idioma).
+ * - HTML      → fragmento de markup que la app renderiza en una WebView.
+ * - VIDEO     → video con autoplay/muted/loop, fallback a posterUrl si falla la reproducción.
+ * - TEMPLATE  → layout pre-definido renderizado nativamente, parametrizado por variante + theme.
+ */
+export enum BannerContentTypeEnum {
+    IMAGE = "IMAGE",
+    HTML = "HTML",
+    VIDEO = "VIDEO",
+    TEMPLATE = "TEMPLATE",
+}

package/src/benefitCenter/enums/BannerLocaleEnum.ts

@@ -1,4 +1,4 @@
-export enum BannerLocaleEnum {
-    ES = "ES",
-    EN = "EN",
-}
+export enum BannerLocaleEnum {
+    ES = "ES",
+    EN = "EN",
+}

package/src/benefitCenter/enums/BannerScreenEnum.ts

@@ -1,11 +1,11 @@
-/**
- * Pantallas donde un banner puede aparecer.
- *
- * El admin elige una o más al crear el banner. La motivación es regulatoria:
- * algunos benefits no se pueden promocionar en HOME y la decisión se delega
- * caso por caso al admin.
- */
-export enum BannerScreenEnum {
-    HOME = "HOME",
-    BENEFIT_CENTER = "BENEFIT_CENTER",
-}
+/**
+ * Pantallas donde un banner puede aparecer.
+ *
+ * El admin elige una o más al crear el banner. La motivación es regulatoria:
+ * algunos benefits no se pueden promocionar en HOME y la decisión se delega
+ * caso por caso al admin.
+ */
+export enum BannerScreenEnum {
+    HOME = "HOME",
+    BENEFIT_CENTER = "BENEFIT_CENTER",
+}

package/src/benefitCenter/enums/BannerStatusEnum.ts

@@ -1,5 +1,5 @@
-export enum BannerStatusEnum {
-    ACTIVE = "ACTIVE",
-    INACTIVE = "INACTIVE",
-    SCHEDULED = "SCHEDULED",
-}
+export enum BannerStatusEnum {
+    ACTIVE = "ACTIVE",
+    INACTIVE = "INACTIVE",
+    SCHEDULED = "SCHEDULED",
+}

package/src/benefitCenter/enums/BannerTemplateVariantEnum.ts

@@ -1,14 +1,14 @@
-/**
- * Variantes del banner type === "TEMPLATE".
- *
- * Cada variante define un layout pre-definido que la app renderiza
- * nativamente. La elección determina qué slots de translation son
- * requeridos y si el theme exige campos adicionales (botón, etc.).
- */
-export enum BannerTemplateVariantEnum {
-    /** Card con título, descripción y arte lateral. Sin botón. */
-    TITLE_DESCRIPTION_IMAGE = "TITLE_DESCRIPTION_IMAGE",
-
-    /** Card con título, descripción, arte lateral y botón CTA destacado. */
-    TITLE_DESCRIPTION_IMAGE_BUTTON = "TITLE_DESCRIPTION_IMAGE_BUTTON",
-}
+/**
+ * Variantes del banner type === "TEMPLATE".
+ *
+ * Cada variante define un layout pre-definido que la app renderiza
+ * nativamente. La elección determina qué slots de translation son
+ * requeridos y si el theme exige campos adicionales (botón, etc.).
+ */
+export enum BannerTemplateVariantEnum {
+    /** Card con título, descripción y arte lateral. Sin botón. */
+    TITLE_DESCRIPTION_IMAGE = "TITLE_DESCRIPTION_IMAGE",
+
+    /** Card con título, descripción, arte lateral y botón CTA destacado. */
+    TITLE_DESCRIPTION_IMAGE_BUTTON = "TITLE_DESCRIPTION_IMAGE_BUTTON",
+}

package/src/benefitCenter/enums/BenefitFlowEnum.ts

@@ -1,9 +1,9 @@
-export enum BenefitFlowEnum {
-    TOPUPS = "TOPUPS",
-    BILL_PAYMENT = "BILL_PAYMENT",
-    CREDIT = "CREDIT",
-    INSURANCE = "INSURANCE",
-    DONATION = "DONATION",
-    PHARMACY = "PHARMACY",
-    REMITTANCE = "REMITTANCE",
-}
+export enum BenefitFlowEnum {
+    TOPUPS = "TOPUPS",
+    BILL_PAYMENT = "BILL_PAYMENT",
+    CREDIT = "CREDIT",
+    INSURANCE = "INSURANCE",
+    DONATION = "DONATION",
+    PHARMACY = "PHARMACY",
+    REMITTANCE = "REMITTANCE",
+}

package/src/benefitCenter/enums/BenefitPaymentErrorCodeEnum.ts

@@ -1,17 +1,17 @@
-/**
- * Códigos canónicos de error del pago. Cada conector mapea sus errores internos
- * a esta lista antes de devolverle al marketplace. Solo se popula cuando
- * `status === REJECTED` (o `PENDING` si el conector quiere comunicar la causa
- * de la espera).
- *
- * Lista canónica documentada en doc Fase 2 §6.5.
- */
-export enum BenefitPaymentErrorCodeEnum {
-    LEAF_NOT_FOUND = "LEAF_NOT_FOUND",
-    LEAF_DISABLED = "LEAF_DISABLED",
-    LEAF_NOT_VISIBLE = "LEAF_NOT_VISIBLE",
-    PRODUCT_NOT_FOUND = "PRODUCT_NOT_FOUND",
-    PROVIDER_REJECTED = "PROVIDER_REJECTED",
-    PROVIDER_TIMEOUT = "PROVIDER_TIMEOUT",
-    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
-}
+/**
+ * Códigos canónicos de error del pago. Cada conector mapea sus errores internos
+ * a esta lista antes de devolverle al marketplace. Solo se popula cuando
+ * `status === REJECTED` (o `PENDING` si el conector quiere comunicar la causa
+ * de la espera).
+ *
+ * Lista canónica documentada en doc Fase 2 §6.5.
+ */
+export enum BenefitPaymentErrorCodeEnum {
+    LEAF_NOT_FOUND = "LEAF_NOT_FOUND",
+    LEAF_DISABLED = "LEAF_DISABLED",
+    LEAF_NOT_VISIBLE = "LEAF_NOT_VISIBLE",
+    PRODUCT_NOT_FOUND = "PRODUCT_NOT_FOUND",
+    PROVIDER_REJECTED = "PROVIDER_REJECTED",
+    PROVIDER_TIMEOUT = "PROVIDER_TIMEOUT",
+    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
+}

package/src/benefitCenter/enums/BenefitPaymentStatusEnum.ts

@@ -1,12 +1,12 @@
-/**
- * Estado del pago devuelto por el marketplace al procesador.
- *
- * Lo decide el conector (STP, Multicomm, donaciones, etc.) en su `/pay/standard`;
- * el marketplace lo reenvía sin transformar. APPROVED dispara el upsert in-process
- * del favorito (ver doc Fase 2 §4.3); REJECTED y PENDING no.
- */
-export enum BenefitPaymentStatusEnum {
-    APPROVED = "APPROVED",
-    REJECTED = "REJECTED",
-    PENDING = "PENDING",
-}
+/**
+ * Estado del pago devuelto por el marketplace al procesador.
+ *
+ * Lo decide el conector (STP, Multicomm, donaciones, etc.) en su `/pay/standard`;
+ * el marketplace lo reenvía sin transformar. APPROVED dispara el upsert in-process
+ * del favorito (ver doc Fase 2 §4.3); REJECTED y PENDING no.
+ */
+export enum BenefitPaymentStatusEnum {
+    APPROVED = "APPROVED",
+    REJECTED = "REJECTED",
+    PENDING = "PENDING",
+}

package/src/benefitCenter/enums/CatalogNodeTypeEnum.ts

@@ -1,4 +1,4 @@
-export enum CatalogNodeTypeEnum {
-    BRANCH = "BRANCH",
-    LEAF = "LEAF",
-}
+export enum CatalogNodeTypeEnum {
+    BRANCH = "BRANCH",
+    LEAF = "LEAF",
+}

package/src/benefitCenter/enums/FavoriteDisabledReasonEnum.ts

@@ -1,15 +1,15 @@
-/**
- * Razón por la que un favorito quedó deshabilitado (`disabled === true`).
- *
- * - `USER` solo aparece como motivo de deshabilitación (soft delete del usuario);
- *   nunca aparece como `reason` en el response del endpoint de validación.
- * - Las otras 4 razones describen por qué el favorito no es usable contra el
- *   catálogo actual y SÍ pueden aparecer en el `ValidationResult.reason`.
- */
-export enum FavoriteDisabledReasonEnum {
-    USER = "USER",
-    LEAF_NOT_FOUND = "LEAF_NOT_FOUND",
-    LEAF_DISABLED = "LEAF_DISABLED",
-    LEAF_NOT_VISIBLE = "LEAF_NOT_VISIBLE",
-    PRODUCT_NOT_FOUND = "PRODUCT_NOT_FOUND",
-}
+/**
+ * Razón por la que un favorito quedó deshabilitado (`disabled === true`).
+ *
+ * - `USER` solo aparece como motivo de deshabilitación (soft delete del usuario);
+ *   nunca aparece como `reason` en el response del endpoint de validación.
+ * - Las otras 4 razones describen por qué el favorito no es usable contra el
+ *   catálogo actual y SÍ pueden aparecer en el `ValidationResult.reason`.
+ */
+export enum FavoriteDisabledReasonEnum {
+    USER = "USER",
+    LEAF_NOT_FOUND = "LEAF_NOT_FOUND",
+    LEAF_DISABLED = "LEAF_DISABLED",
+    LEAF_NOT_VISIBLE = "LEAF_NOT_VISIBLE",
+    PRODUCT_NOT_FOUND = "PRODUCT_NOT_FOUND",
+}

package/src/benefitCenter/enums/InputFieldTypeEnum.ts

@@ -1,10 +1,10 @@
-export enum InputFieldTypeEnum {
-    PHONE = "PHONE",
-    BARCODE = "BARCODE",
-    ACCOUNT_NUMBER = "ACCOUNT_NUMBER",
-    TEXT = "TEXT",
-    NUMBER = "NUMBER",
-    MONEY = "MONEY",
-    SELECT = "SELECT",
-    DATE = "DATE",
-}
+export enum InputFieldTypeEnum {
+    PHONE = "PHONE",
+    BARCODE = "BARCODE",
+    ACCOUNT_NUMBER = "ACCOUNT_NUMBER",
+    TEXT = "TEXT",
+    NUMBER = "NUMBER",
+    MONEY = "MONEY",
+    SELECT = "SELECT",
+    DATE = "DATE",
+}