@fiado/api-invoker 4.57.0 → 4.59.0

package/src/benefits-marketplace/api/BenefitsMarketplaceApi.ts

@@ -1,59 +1,59 @@
-import {IBenefitsMarketplaceApi} from "./interfaces/IBenefitsMarketplaceApi.js";
-import {inject, injectable} from "inversify";
-import {IHttpRequest} from "@fiado/http-client";
-import {BenefitPaymentRequest, BenefitPaymentResponse} from "@fiado/type-kit/bin/benefitCenter/index.js";
-import {ApiGatewayResponse} from "@fiado/gateway-adapter";
-import {BenefitLeafDisplayResponse} from "./dtos/BenefitLeafDisplayResponse.js";
-import {
-    CreateFundingReferenceRequest,
-    CreateFundingReferenceResponse,
-    ListFundingReferencesResponse,
-} from "@fiado/type-kit/bin/walletFunding/index.js";
-
-@injectable()
-export default class BenefitsMarketplaceApi implements IBenefitsMarketplaceApi {
-    private readonly baseUrl = process.env.BENEFITS_MARKETPLACE_LAMBDA_URL || "";
-
-    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) {
-    }
-
-    async pay(moduleName: string, request: BenefitPaymentRequest): Promise<ApiGatewayResponse<BenefitPaymentResponse>> {
-        const url = `${this.baseUrl}/pay/${encodeURIComponent(moduleName)}`;
-        return await this.httpRequest.post(url, request);
-    }
-
-    async consultPayment(
-        moduleName: string,
-        transactionNumber: string,
-    ): Promise<ApiGatewayResponse<BenefitPaymentResponse>> {
-        const url = `${this.baseUrl}/pay/${encodeURIComponent(moduleName)}/transactions/${encodeURIComponent(transactionNumber)}`;
-        return await this.httpRequest.get(url);
-    }
-
-    async getLeafDisplay(
-        benefitId: string,
-        leafId: string,
-    ): Promise<ApiGatewayResponse<BenefitLeafDisplayResponse>> {
-        const url = `${this.baseUrl}/${encodeURIComponent(benefitId)}/leaves/${encodeURIComponent(leafId)}/display`;
-        return await this.httpRequest.get(url);
-    }
-
-    async fundingCreate(
-        moduleName: string,
-        request: CreateFundingReferenceRequest,
-    ): Promise<ApiGatewayResponse<CreateFundingReferenceResponse>> {
-        const url = `${this.baseUrl}/funding/${encodeURIComponent(moduleName)}`;
-        return await this.httpRequest.post(url, request);
-    }
-
-    async fundingList(
-        moduleName: string,
-        directoryId: string,
-        status?: string,
-    ): Promise<ApiGatewayResponse<ListFundingReferencesResponse>> {
-        const params = new URLSearchParams({ directoryId });
-        if (status) params.set("status", status);
-        const url = `${this.baseUrl}/funding/${encodeURIComponent(moduleName)}/references?${params.toString()}`;
-        return await this.httpRequest.get(url);
-    }
-}
+import {IBenefitsMarketplaceApi} from "./interfaces/IBenefitsMarketplaceApi.js";
+import {inject, injectable} from "inversify";
+import {IHttpRequest} from "@fiado/http-client";
+import {BenefitPaymentRequest, BenefitPaymentResponse} from "@fiado/type-kit/bin/benefitCenter/index.js";
+import {ApiGatewayResponse} from "@fiado/gateway-adapter";
+import {BenefitLeafDisplayResponse} from "./dtos/BenefitLeafDisplayResponse.js";
+import {
+    CreateFundingReferenceRequest,
+    CreateFundingReferenceResponse,
+    ListFundingReferencesResponse,
+} from "@fiado/type-kit/bin/walletFunding/index.js";
+
+@injectable()
+export default class BenefitsMarketplaceApi implements IBenefitsMarketplaceApi {
+    private readonly baseUrl = process.env.BENEFITS_MARKETPLACE_LAMBDA_URL || "";
+
+    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) {
+    }
+
+    async pay(moduleName: string, request: BenefitPaymentRequest): Promise<ApiGatewayResponse<BenefitPaymentResponse>> {
+        const url = `${this.baseUrl}/pay/${encodeURIComponent(moduleName)}`;
+        return await this.httpRequest.post(url, request);
+    }
+
+    async consultPayment(
+        moduleName: string,
+        transactionNumber: string,
+    ): Promise<ApiGatewayResponse<BenefitPaymentResponse>> {
+        const url = `${this.baseUrl}/pay/${encodeURIComponent(moduleName)}/transactions/${encodeURIComponent(transactionNumber)}`;
+        return await this.httpRequest.get(url);
+    }
+
+    async getLeafDisplay(
+        benefitId: string,
+        leafId: string,
+    ): Promise<ApiGatewayResponse<BenefitLeafDisplayResponse>> {
+        const url = `${this.baseUrl}/${encodeURIComponent(benefitId)}/leaves/${encodeURIComponent(leafId)}/display`;
+        return await this.httpRequest.get(url);
+    }
+
+    async fundingCreate(
+        moduleName: string,
+        request: CreateFundingReferenceRequest,
+    ): Promise<ApiGatewayResponse<CreateFundingReferenceResponse>> {
+        const url = `${this.baseUrl}/funding/${encodeURIComponent(moduleName)}`;
+        return await this.httpRequest.post(url, request);
+    }
+
+    async fundingList(
+        moduleName: string,
+        directoryId: string,
+        status?: string,
+    ): Promise<ApiGatewayResponse<ListFundingReferencesResponse>> {
+        const params = new URLSearchParams({ directoryId });
+        if (status) params.set("status", status);
+        const url = `${this.baseUrl}/funding/${encodeURIComponent(moduleName)}/references?${params.toString()}`;
+        return await this.httpRequest.get(url);
+    }
+}

package/src/benefits-marketplace/api/dtos/BenefitLeafDisplayResponse.ts

@@ -1,33 +1,33 @@
-import { Provider } from "@fiado/type-kit/bin/provider/index.js";
-
-/**
- * Respuesta del endpoint privado `GET /{benefitId}/leaves/{leafId}/display`
- * del marketplace. Pensado para que el procesador resuelva nombres legibles
- * (categoria/servicio) al armar la transacción, sin descargar el árbol entero
- * del catálogo.
- *
- * Equivalente conceptual al `subcategoria`/`servicio` que el procesador lee
- * del catálogo SPEI cuando arma `productDetail.targetName`.
- */
-export interface BenefitLeafDisplayResponse {
-    /**
-     * Nombre de la subcategoría a la que pertenece el leaf (ej. "TELMEX", "CFE").
-     * El procesador lo usa como `targetName` con `.toUpperCase()`, paridad con SPEI.
-     */
-    subcategoryName: string;
-    /**
-     * Nombre del servicio específico dentro de la subcategoría (ej. "Telmex Hogar Plan 500").
-     * Disponible para descripciones / detalle de transacción si el caller lo necesita.
-     */
-    serviceName: string;
-    /**
-     * Proveedor real del servicio según el catálogo del conector
-     * (MULTICOMM_SERVICE_PAYMENT | MULTICENTER_SERVICE_PAYMENT | STP_SERVICE_PAYMENT).
-     * El procesador lo usa para fijar el `type` correcto de la transacción
-     * (ej. MULTICENTER_SERV_SA vs STP_SERV_SA) en `authorize()` — paridad con
-     * MexServicePaymentService, que lee `provider` del body. Aquí el `moduleName`
-     * NO discrimina (MULTICOMM y MULTICENTER comparten conector); el proveedor
-     * real solo se conoce vía este campo del catálogo.
-     */
-    provider: Provider;
-}
+import { Provider } from "@fiado/type-kit/bin/provider/index.js";
+
+/**
+ * Respuesta del endpoint privado `GET /{benefitId}/leaves/{leafId}/display`
+ * del marketplace. Pensado para que el procesador resuelva nombres legibles
+ * (categoria/servicio) al armar la transacción, sin descargar el árbol entero
+ * del catálogo.
+ *
+ * Equivalente conceptual al `subcategoria`/`servicio` que el procesador lee
+ * del catálogo SPEI cuando arma `productDetail.targetName`.
+ */
+export interface BenefitLeafDisplayResponse {
+    /**
+     * Nombre de la subcategoría a la que pertenece el leaf (ej. "TELMEX", "CFE").
+     * El procesador lo usa como `targetName` con `.toUpperCase()`, paridad con SPEI.
+     */
+    subcategoryName: string;
+    /**
+     * Nombre del servicio específico dentro de la subcategoría (ej. "Telmex Hogar Plan 500").
+     * Disponible para descripciones / detalle de transacción si el caller lo necesita.
+     */
+    serviceName: string;
+    /**
+     * Proveedor real del servicio según el catálogo del conector
+     * (MULTICOMM_SERVICE_PAYMENT | MULTICENTER_SERVICE_PAYMENT | STP_SERVICE_PAYMENT).
+     * El procesador lo usa para fijar el `type` correcto de la transacción
+     * (ej. MULTICENTER_SERV_SA vs STP_SERV_SA) en `authorize()` — paridad con
+     * MexServicePaymentService, que lee `provider` del body. Aquí el `moduleName`
+     * NO discrimina (MULTICOMM y MULTICENTER comparten conector); el proveedor
+     * real solo se conoce vía este campo del catálogo.
+     */
+    provider: Provider;
+}

package/src/benefits-marketplace/api/interfaces/IBenefitsMarketplaceApi.ts

@@ -1,93 +1,93 @@
-import {BenefitPaymentRequest, BenefitPaymentResponse} from "@fiado/type-kit/bin/benefitCenter/index.js";
-import {ApiGatewayResponse} from "@fiado/gateway-adapter";
-import {BenefitLeafDisplayResponse} from "../dtos/BenefitLeafDisplayResponse.js";
-import {
-    CreateFundingReferenceRequest,
-    CreateFundingReferenceResponse,
-    ListFundingReferencesResponse,
-} from "@fiado/type-kit/bin/walletFunding/index.js";
-
-/**
- * Cliente único del procesador hacia benefits-marketplace-business (Fase 2).
- *
- * Lo consume exclusivamente BenefitsMarketplaceTransactionService dentro de
- * transaction-processor-business. Ningún otro service del procesador conoce
- * este cliente.
- *
- * Endpoint backend: POST /pay/{moduleName} (privado, dentro de la VPC).
- * El marketplace resuelve `moduleName` a un publisher y reenvía la request
- * tal cual al conector correspondiente con `BenefitPaymentRequest`.
- *
- * Schema v3 (2026-06-24): método `fundingCancel` eliminado. Las referencias
- * OPEN no se cancelan por regla de negocio.
- */
-export interface IBenefitsMarketplaceApi {
-    /**
-     * Invoca el pago contra el marketplace. Backend: POST /pay/{moduleName}.
-     *
-     * @param moduleName  Nombre del conector destino (ej. "stp-service-pay-connector",
-     *                    "multicomm-service-pay-connector", "donations-pay-connector").
-     *                    Se transmite como path-param y NO debe llevar slashes ni codificación
-     *                    extra: el cliente lo aplica directamente en la URL.
-     * @param request     Cuerpo estandarizado de la transacción.
-     */
-    pay(moduleName: string, request: BenefitPaymentRequest): Promise<ApiGatewayResponse<BenefitPaymentResponse>>;
-
-    /**
-     * Consulta el estado actual de un pago previamente enviado al marketplace.
-     * Backend: GET /pay/{moduleName}/transactions/{transactionNumber}.
-     *
-     * Lo consume el cron de timeout reconciliation del procesador
-     * (BenefitsMarketplaceTimeOutService) para decidir si publicar la
-     * transacción a la cola (cuando el marketplace confirma APPROVED) o
-     * reversar el débito ya hecho (cuando confirma REJECTED).
-     *
-     * @param moduleName         Mismo identificador del conector usado en pay().
-     * @param transactionNumber  Identificador único de la transacción del lado
-     *                           del procesador. Es el mismo `transactionNumber`
-     *                           que viajó en el `BenefitPaymentRequest` original.
-     */
-    consultPayment(moduleName: string, transactionNumber: string): Promise<ApiGatewayResponse<BenefitPaymentResponse>>;
-
-    /**
-     * Resuelve los nombres legibles del leaf (subcategoría y servicio) para que
-     * el procesador arme `productDetail.targetName` con paridad al flujo SPEI.
-     * Backend: GET /{benefitId}/leaves/{leafId}/display.
-     *
-     * Endpoint dedicado y barato: solo trae los dos nombres necesarios, sin
-     * descargar el árbol completo del catálogo. El procesador lo invoca dentro
-     * de `authorize()`, antes de cualquier débito, y aborta la operación si la
-     * respuesta no es válida.
-     *
-     * @param benefitId  Identificador del beneficio (filtro requerido por el
-     *                   resolver del marketplace para invocar al conector correcto).
-     * @param leafId     Identificador del leaf (`base64url("<moduleName>::<idServicio>")`).
-     */
-    getLeafDisplay(
-        benefitId: string,
-        leafId: string,
-    ): Promise<ApiGatewayResponse<BenefitLeafDisplayResponse>>;
-
-    /**
-     * Genera una referencia de fondeo de wallet via Passport.
-     * Backend: POST /funding/{moduleName} (privado VPC).
-     *
-     * El marketplace resuelve `moduleName` a un EqualityFundingPublisher y delega.
-     * Hoy `moduleName` es siempre `"equality-connector"`; queda extensible para
-     * futuros providers (OpenPay, etc.).
-     */
-    fundingCreate(
-        moduleName: string,
-        request: CreateFundingReferenceRequest,
-    ): Promise<ApiGatewayResponse<CreateFundingReferenceResponse>>;
-
-    /**
-     * Lista las referencias del usuario.
-     * Backend: GET /funding/{moduleName}/references?directoryId=&status=
-     */
-    fundingList(
-        moduleName: string,
-        directoryId: string,
-        status?: string,
-    ): Promise<ApiGatewayResponse<ListFundingReferencesResponse>>;
-}
+import {BenefitPaymentRequest, BenefitPaymentResponse} from "@fiado/type-kit/bin/benefitCenter/index.js";
+import {ApiGatewayResponse} from "@fiado/gateway-adapter";
+import {BenefitLeafDisplayResponse} from "../dtos/BenefitLeafDisplayResponse.js";
+import {
+    CreateFundingReferenceRequest,
+    CreateFundingReferenceResponse,
+    ListFundingReferencesResponse,
+} from "@fiado/type-kit/bin/walletFunding/index.js";
+
+/**
+ * Cliente único del procesador hacia benefits-marketplace-business (Fase 2).
+ *
+ * Lo consume exclusivamente BenefitsMarketplaceTransactionService dentro de
+ * transaction-processor-business. Ningún otro service del procesador conoce
+ * este cliente.
+ *
+ * Endpoint backend: POST /pay/{moduleName} (privado, dentro de la VPC).
+ * El marketplace resuelve `moduleName` a un publisher y reenvía la request
+ * tal cual al conector correspondiente con `BenefitPaymentRequest`.
+ *
+ * Schema v3 (2026-06-24): método `fundingCancel` eliminado. Las referencias
+ * OPEN no se cancelan por regla de negocio.
+ */
+export interface IBenefitsMarketplaceApi {
+    /**
+     * Invoca el pago contra el marketplace. Backend: POST /pay/{moduleName}.
+     *
+     * @param moduleName  Nombre del conector destino (ej. "stp-service-pay-connector",
+     *                    "multicomm-service-pay-connector", "donations-pay-connector").
+     *                    Se transmite como path-param y NO debe llevar slashes ni codificación
+     *                    extra: el cliente lo aplica directamente en la URL.
+     * @param request     Cuerpo estandarizado de la transacción.
+     */
+    pay(moduleName: string, request: BenefitPaymentRequest): Promise<ApiGatewayResponse<BenefitPaymentResponse>>;
+
+    /**
+     * Consulta el estado actual de un pago previamente enviado al marketplace.
+     * Backend: GET /pay/{moduleName}/transactions/{transactionNumber}.
+     *
+     * Lo consume el cron de timeout reconciliation del procesador
+     * (BenefitsMarketplaceTimeOutService) para decidir si publicar la
+     * transacción a la cola (cuando el marketplace confirma APPROVED) o
+     * reversar el débito ya hecho (cuando confirma REJECTED).
+     *
+     * @param moduleName         Mismo identificador del conector usado en pay().
+     * @param transactionNumber  Identificador único de la transacción del lado
+     *                           del procesador. Es el mismo `transactionNumber`
+     *                           que viajó en el `BenefitPaymentRequest` original.
+     */
+    consultPayment(moduleName: string, transactionNumber: string): Promise<ApiGatewayResponse<BenefitPaymentResponse>>;
+
+    /**
+     * Resuelve los nombres legibles del leaf (subcategoría y servicio) para que
+     * el procesador arme `productDetail.targetName` con paridad al flujo SPEI.
+     * Backend: GET /{benefitId}/leaves/{leafId}/display.
+     *
+     * Endpoint dedicado y barato: solo trae los dos nombres necesarios, sin
+     * descargar el árbol completo del catálogo. El procesador lo invoca dentro
+     * de `authorize()`, antes de cualquier débito, y aborta la operación si la
+     * respuesta no es válida.
+     *
+     * @param benefitId  Identificador del beneficio (filtro requerido por el
+     *                   resolver del marketplace para invocar al conector correcto).
+     * @param leafId     Identificador del leaf (`base64url("<moduleName>::<idServicio>")`).
+     */
+    getLeafDisplay(
+        benefitId: string,
+        leafId: string,
+    ): Promise<ApiGatewayResponse<BenefitLeafDisplayResponse>>;
+
+    /**
+     * Genera una referencia de fondeo de wallet via Passport.
+     * Backend: POST /funding/{moduleName} (privado VPC).
+     *
+     * El marketplace resuelve `moduleName` a un EqualityFundingPublisher y delega.
+     * Hoy `moduleName` es siempre `"equality-connector"`; queda extensible para
+     * futuros providers (OpenPay, etc.).
+     */
+    fundingCreate(
+        moduleName: string,
+        request: CreateFundingReferenceRequest,
+    ): Promise<ApiGatewayResponse<CreateFundingReferenceResponse>>;
+
+    /**
+     * Lista las referencias del usuario.
+     * Backend: GET /funding/{moduleName}/references?directoryId=&status=
+     */
+    fundingList(
+        moduleName: string,
+        directoryId: string,
+        status?: string,
+    ): Promise<ApiGatewayResponse<ListFundingReferencesResponse>>;
+}

package/src/benefits-marketplace/index.ts

@@ -1,3 +1,3 @@
-export * from './api/interfaces/IBenefitsMarketplaceApi.js';
-export * from './api/BenefitsMarketplaceApi.js';
-export * from './api/dtos/BenefitLeafDisplayResponse.js';
+export * from './api/interfaces/IBenefitsMarketplaceApi.js';
+export * from './api/BenefitsMarketplaceApi.js';
+export * from './api/dtos/BenefitLeafDisplayResponse.js';

package/src/blacklist/BlackListApi.ts

@@ -1,20 +1,20 @@
-import { inject, injectable } from "inversify";
-import { IHttpRequest } from "@fiado/http-client";
-import dotenv from 'dotenv';
-import { IBlackListApi } from "./interfaces/IBlackListApi.js";
-import { IdentificationParameter } from "@fiado/type-kit/bin/blacklist/index.js";
-dotenv.config();
-
-@injectable()
-export class BlackListApi implements IBlackListApi {
-
-    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) { }
-
-    private readonly baseUrl = process.env.BLACKLIST_BUSINESS_URL || "";
-    
-    async getByIdentificationParameter(params: { identificationParameter: IdentificationParameter; value: string; }): Promise<void> {
-        const url = `${this.baseUrl}/search/${params.identificationParameter}/${params.value}`;
-        return await this.httpRequest.get(url);
-    }
-    
+import { inject, injectable } from "inversify";
+import { IHttpRequest } from "@fiado/http-client";
+import dotenv from 'dotenv';
+import { IBlackListApi } from "./interfaces/IBlackListApi.js";
+import { IdentificationParameter } from "@fiado/type-kit/bin/blacklist/index.js";
+dotenv.config();
+
+@injectable()
+export class BlackListApi implements IBlackListApi {
+
+    constructor(@inject("IHttpRequest") private httpRequest: IHttpRequest) { }
+
+    private readonly baseUrl = process.env.BLACKLIST_BUSINESS_URL || "";
+    
+    async getByIdentificationParameter(params: { identificationParameter: IdentificationParameter; value: string; }): Promise<void> {
+        const url = `${this.baseUrl}/search/${params.identificationParameter}/${params.value}`;
+        return await this.httpRequest.get(url);
+    }
+    
 }

package/src/blacklist/index.ts

@@ -1,3 +1,3 @@
-
-export * from './interfaces/IBlackListApi.js';
+
+export * from './interfaces/IBlackListApi.js';
 export * from './BlackListApi.js';

package/src/blacklist/interfaces/IBlackListApi.ts

@@ -1,20 +1,20 @@
-import { IdentificationParameter } from "@fiado/type-kit/bin/blacklist/index.js";
-
-/**
- * Interfaz que define las operaciones que se pueden realizar en el servicio de black list.
- */
-export interface IBlackListApi {
-
-    /**
-     * Obtener por parametro de identificacion.
-     * @param identificationParameter tipo de parametro.
-     * @param value valor del parametro.
-     * @returns Una promesa que resuelve a void.
-     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
-     */
-    getByIdentificationParameter(params:{
-        identificationParameter:IdentificationParameter,
-        value:string,
-    }): Promise<void>;
-
-}
+import { IdentificationParameter } from "@fiado/type-kit/bin/blacklist/index.js";
+
+/**
+ * Interfaz que define las operaciones que se pueden realizar en el servicio de black list.
+ */
+export interface IBlackListApi {
+
+    /**
+     * Obtener por parametro de identificacion.
+     * @param identificationParameter tipo de parametro.
+     * @param value valor del parametro.
+     * @returns Una promesa que resuelve a void.
+     * @throws {Error} Lanza un error si los parámetros de entrada son inválidos.
+     */
+    getByIdentificationParameter(params:{
+        identificationParameter:IdentificationParameter,
+        value:string,
+    }): Promise<void>;
+
+}