@jamx-framework/adapter-lambda
v1.0.0
Published
JAMX Framework — AWS Lambda adapter
Maintainers
Readme
@jamx-framework/adapter-lambda
Descripción
Adaptador de JAMX Framework para AWS Lambda. Permite ejecutar handlers de JAMX como funciones serverless en AWS Lambda, manejando la conversión entre eventos de Lambda y el modelo de request/response de JAMX, incluyendo soporte para API Gateway y otros triggers.
Cómo funciona
El adaptador convierte eventos de Lambda (típicamente de API Gateway) en JamxRequest, ejecuta el handler de JAMX y luego convierte la respuesta en un formato compatible con Lambda (objeto con statusCode, headers y body). Maneja automáticamente:
- Parsing de JSON en el body
- Query strings y path parameters
- Headers HTTP
- CORS (si está configurado)
- Errores y excepciones
Componentes principales
- src/adapter.ts: Función
createLambdaHandlerque adapta un handler de JAMX a Lambda - src/index.ts: Punto de exportación
- src/types.ts: Tipos específicos para Lambda (APIGatewayProxyEvent, etc.)
Uso básico
// lambda.ts
import { createLambdaHandler } from '@jamx-framework/adapter-lambda';
const handler = createLambdaHandler(async (req, res) => {
res.json({ message: 'Hello from JAMX on AWS Lambda!' });
});
export { handler };Con API Gateway
export const apiHandler = createLambdaHandler(async (req, res) => {
const { id } = req.params;
const user = await db.users.findById(id);
if (!user) {
res.notFound('User not found');
return;
}
res.json({ user });
});Ejemplos
Manejo de path parameters
export const handler = createLambdaHandler(async (req, res) => {
// API Gateway v2: params están en req.params
const userId = req.params['userId'] ?? req.params['id'];
if (!userId) {
res.badRequest('Missing user ID');
return;
}
const user = await getUser(userId);
res.json({ user });
});Query strings
export const handler = createLambdaHandler(async (req, res) => {
const page = parseInt(req.query['page'] ?? '1');
const limit = parseInt(req.query['limit'] ?? '10');
const users = await db.users.findAll({ page, limit });
res.json({ users, page, limit });
});Middleware de logging
const withLogging = createLambdaHandler(async (req, res, next) => {
console.log(`[${new Date().toISOString()}] ${req.method} ${req.path}`);
next();
});
export { withLogging };Flujo interno
- Event parsing: El adaptador recibe un evento de Lambda (APIGatewayProxyEvent o similar).
- toJamxRequest: Convierte el evento en
JamxRequestextrayendo método, path, headers, query params y body. - Handler execution: Ejecuta el handler de JAMX con la request y un
ResponseBuilder. - toLambdaResponse: Convierte el
ResponseBuilderen un objeto compatible con Lambda ({ statusCode, headers, body }). - Return: Retorna el objeto de respuesta a Lambda, que API Gateway serializa como HTTP response.
API Reference
createLambdaHandler
(handler: JamxHandler) => (event: APIGatewayProxyEvent, context: Context) => Promise<APIGatewayProxyResult>Crea un handler de Lambda que ejecuta un handler de JAMX.
Tipos soportados
APIGatewayProxyEvent(API Gateway REST API)APIGatewayProxyEventV2(API Gateway HTTP API)SNSEvent,SQSEvent, etc. (otros triggers)
Performance Considerations
- Cold start minimizado: El handler se inicializa una vez y se reutiliza entre invocaciones.
- Body parsing: JSON se parsea automáticamente; otros formatos se dejan como string.
- Header normalization: Los headers se convierten a lowercase para consistencia.
- Error handling: Excepciones no capturadas se convierten en respuestas 500 con mensaje genérico.
Configuration Options
// Configuración opcional del adaptador
const handler = createLambdaHandler(jamxHandler, {
// Si true, parsea automáticamente JSON en el body (default: true)
parseJsonBody: true,
// Headers que se deben excluir de la request (ej: headers de Lambda)
excludedHeaders: ['x-amzn-trace-id'],
// Si true, habilita CORS automático para OPTIONS requests
cors: true,
// Orígenes permitidos para CORS
corsOrigins: ['*'],
});Testing
Tests en packages/adapter-lambda/tests/unit/adapter.test.ts:
pnpm testCubre:
- Conversión de eventos API Gateway a JamxRequest
- Extracción de path parameters, query strings, headers
- Parsing de JSON body
- Construcción de respuestas Lambda
- Manejo de errores
Compatibility
- Compatible con AWS Lambda (Node.js 18.x, 20.x)
- Funciona con API Gateway (REST y HTTP APIs)
- Soporta otros triggers (SNS, SQS, etc.) con adaptación personalizada
- No requiere dependencias de AWS SDK (solo tipos)
CLI Integration
jamx build: Compila el adaptadorjamx deploy lambda: Despliega a AWS Lambda (con SAM/Serverless Framework)
This adapter provides seamless integration between JAMX Framework and AWS Lambda, enabling developers to build serverless applications with type safety and minimal configuration while leveraging the full power of JAMX's handler model.
