@fiado/api-invoker 1.0.4 → 1.0.5

package/README.md

@@ -1,43 +1,63 @@
 # fiado-api-invoker
 
+`fiado-api-invoker` es una librería diseñada para facilitar la invocación de APIs privadas de AWS Lambda a través de API Gateway dentro de la misma VPC. Esta librería simplifica el proceso de configuración y llamada a servicios, permitiendo a los desarrolladores centrarse en la lógica de negocio.
 
 
 ## Configuración
 
 Antes de usar la librería, asegúrate de configurar la URL base del API Gateway privado que corresponda por ejemplo si vas a usar los servicios del Lambda `Directory` se puede hacer estableciendo la variable de entorno `DIRECTORY_LAMBDA_URL`.
 
-## Uso
+
+## Instalación
+
+npm install fiado-api-invoker @fiado/http-client
+
+## Configuración del Contenedor de InversifyJS
 
 ```typescript
+import { Container } from "inversify";
+import { apiInvokerContainer } from '@fiado/api-invoker';
 import { IHttpRequest, AxiosHttpRequest } from "@fiado/http-client";
-import { IDirectoryApi } from "ruta/a/fiado-api-invoker/interfaces/IDirectoryApi";
-import { DirectoryService } from "ruta/a/fiado-api-invoker/services/DirectoryService";
+
+// Crea el contenedor principal de tu aplicación
+const container = new Container();
+
+// Establece el contenedor de la biblioteca fiado-api-invoker como contenedor padre
+// Esto permite que tu aplicación resuelva dependencias definidas en fiado-api-invoker
+container.parent = apiInvokerContainer;
 
 // Registro del cliente HTTP
-container.bind<IHttpRequest>(IHttpRequest).to(AxiosHttpRequest);
+container.bind<IHttpRequest>("IHttpRequest").to(AxiosHttpRequest);
+
+// Exporta el contenedor para su uso en toda tu aplicación
+export { container };
 
-// Registro de DirectoryService
-container.bind<IDirectoryApi>(IDirectoryApi).to(DirectoryService);
+```
 
 
-//Uso de IDirectoryApi en Servicios del Proyecto
+## Uso de IDirectoryApi en Servicios del Proyecto
 
+Para utilizar `fiado-api-invoker`, necesitas configurar el contenedor de InversifyJS en tu aplicación. Aquí te mostramos cómo registrar las dependencias necesarias:
+
+```typescript
 import { inject, injectable } from "inversify";
-import { IDirectoryApi } from "ruta/a/fiado-api-invoker/interfaces/IDirectoryApi";
+import { IDirectoryApi } from "fiado-api-invoker";
+import { log } from "@fiado/logger";
 
 @injectable()
 export class SomeService {
-    constructor(private directoryApi: IDirectoryApi) {}
+    constructor(@inject("IDirectoryApi") private directoryApi: IDirectoryApi) {}
 
     public async fetchDirectoryDetails(directoryIds: string[]): Promise<void> {
         try {
             const details = await this.directoryApi.getByIds(directoryIds);
             log.info(details);
-            // Tu lógica según sea necesario...
+            // Procesa los detalles según sea necesario...
         } catch (error) {
             log.error("Error fetching directory details:", error);
         }
     }
 }
+```
 
 

package/bin/container.config.d.ts

@@ -1,2 +1,2 @@
-import { Container } from "inversify";
-export declare const apiInvokerContainer: Container;
+import { ContainerModule } from "inversify";
+export declare const apiInvokerBindings: ContainerModule;

package/bin/container.config.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.apiInvokerContainer = void 0;
+exports.apiInvokerBindings = void 0;
 const inversify_1 = require("inversify");
 const directory_1 = require("./directory");
-exports.apiInvokerContainer = new inversify_1.Container();
-exports.apiInvokerContainer.bind("IDirectoryApi").to(directory_1.DirectoryApi);
+exports.apiInvokerBindings = new inversify_1.ContainerModule((bind) => {
+    bind("IDirectoryApi").to(directory_1.DirectoryApi);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiado/api-invoker",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Sirve como un puente entre diferentes funciones lambda, facilitando la comunicación entre ellas a traves de invocaciones http",
   "main": "bin/index.js",
   "types": "bin/index.d.ts",

package/src/container.config.ts

@@ -1,8 +1,7 @@
 
-import { Container } from "inversify";
+import { ContainerModule, interfaces } from "inversify";
 import { DirectoryApi, IDirectoryApi } from "./directory";
 
-
-export const apiInvokerContainer = new Container();
-
-apiInvokerContainer.bind<IDirectoryApi>("IDirectoryApi").to(DirectoryApi);
+export const apiInvokerBindings = new ContainerModule((bind: interfaces.Bind) => {
+    bind<IDirectoryApi>("IDirectoryApi").to(DirectoryApi)
+});