Merge pull request #1212 from naorpeled/fix/http-router/resolve-too-w…

…ide-return-type fix(packages/http-router): refine return type to include event and response
middyjs · May 16, 2024 · 2a9abae · 2a9abae
2 parents 37632cf + eeda959
commit 2a9abae
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 7 deletions.
diff --git a/packages/http-router/index.d.ts b/packages/http-router/index.d.ts
@@ -11,9 +11,7 @@ import {
 
 export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'ANY'
 
-type TResult = ALBResult | APIGatewayProxyResult | APIGatewayProxyResultV2
-
-export interface Route<TEvent> {
+export interface Route<TEvent, TResult> {
   method: Method
   path: string
   handler: LambdaHandler<TEvent, TResult> | MiddyfiedHandler<TEvent, TResult, any, any>
@@ -23,7 +21,11 @@ declare function httpRouterHandler<
   TEvent extends
   | ALBEvent
   | APIGatewayProxyEvent
-  | APIGatewayProxyEventV2 = APIGatewayProxyEvent
-> (routes: Array<Route<TEvent>>): middy.MiddyfiedHandler
+  | APIGatewayProxyEventV2 = APIGatewayProxyEvent,
+  TResult extends
+  | ALBResult
+  | APIGatewayProxyResult
+  | APIGatewayProxyResultV2 = APIGatewayProxyResult
+> (routes: Array<Route<TEvent, TResult>>): middy.MiddyfiedHandler<TEvent, TResult>
 
 export default httpRouterHandler
diff --git a/packages/http-router/index.test-d.ts b/packages/http-router/index.test-d.ts
@@ -2,6 +2,7 @@ import { expectType } from 'tsd'
 import middy from '@middy/core'
 import httpRouterHandler from '.'
 import {
+  ALBEvent, ALBResult,
   APIGatewayProxyEvent,
   APIGatewayProxyEventV2,
   APIGatewayProxyResult,
@@ -23,7 +24,7 @@ const middleware = httpRouterHandler([
     handler: lambdaHandler
   }
 ])
-expectType<middy.MiddyfiedHandler>(middleware)
+expectType<middy.MiddyfiedHandler<APIGatewayProxyEvent, APIGatewayProxyResult>>(middleware)
 
 const lambdaHandlerV2: LambdaHandler<APIGatewayProxyEventV2, APIGatewayProxyResultV2> = async (event) => {
   return {
@@ -39,4 +40,21 @@ const middlewareV2 = httpRouterHandler([
     handler: lambdaHandlerV2
   }
 ])
-expectType<middy.MiddyfiedHandler>(middlewareV2)
+expectType<middy.MiddyfiedHandler<APIGatewayProxyEventV2, APIGatewayProxyResultV2>>(middlewareV2)
+
+const lambdaHandlerALB: LambdaHandler<ALBEvent, ALBResult> = async (event) => {
+  return {
+    statusCode: 200,
+    body: 'Hello world'
+  }
+}
+
+const middlewareALB = httpRouterHandler([
+  {
+    method: 'GET',
+    path: '/',
+    handler: lambdaHandlerALB
+  }
+])
+
+expectType<middy.MiddyfiedHandler<ALBEvent, ALBResult>>(middlewareALB)