removed the ErrorResponse and used HandlerResponse

Author: sdangol

packages/event-handler/src/rest/Router.ts

@@ -4,7 +4,7 @@ import {
   isDevMode,
 } from '@aws-lambda-powertools/commons/utils/env';
 import type { APIGatewayProxyResult, Context } from 'aws-lambda';
-import type { ResolveOptions } from '../types/index.js';
+import type { HandlerResponse, ResolveOptions } from '../types/index.js';
 import type {
   ErrorConstructor,
   ErrorHandler,
@@ -22,7 +22,6 @@ import {
   handlerResultToProxyResult,
   handlerResultToWebResponse,
   proxyEventToWebRequest,
-  webResponseToProxyResult,
 } from './converters.js';
 import { ErrorHandlerRegistry } from './ErrorHandlerRegistry.js';
 import {
@@ -36,6 +35,7 @@ import { RouteHandlerRegistry } from './RouteHandlerRegistry.js';
 import {
   composeMiddleware,
   isAPIGatewayProxyEvent,
+  isAPIGatewayProxyResult,
   isHttpMethod,
 } from './utils.js';
 
@@ -280,7 +280,12 @@ class Router {
         ...requestContext,
         scope: options?.scope,
       });
-      return await webResponseToProxyResult(result);
+      return handlerResultToProxyResult(
+        result,
+        (result.status ??
+          result.statusCode ??
+          HttpErrorCodes.INTERNAL_SERVER_ERROR) as (typeof HttpErrorCodes)[keyof typeof HttpErrorCodes]
+      );
     }
   }
 
@@ -310,13 +315,13 @@ class Router {
   protected async handleError(
     error: Error,
     options: ErrorResolveOptions
-  ): Promise<Response> {
+  ): Promise<HandlerResponse> {
     const handler = this.errorHandlerRegistry.resolve(error);
     if (handler !== null) {
       try {
         const { scope, ...reqCtx } = options;
         const body = await handler.apply(scope ?? this, [error, reqCtx]);
-        if (body instanceof Response) {
+        if (body instanceof Response || isAPIGatewayProxyResult(body)) {
           return body;
         }
         if (!body.statusCode) {

packages/event-handler/src/rest/converters.ts

@@ -1,6 +1,6 @@
 import type { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
 import type { CompressionOptions, HandlerResponse } from '../types/rest.js';
-import { COMPRESSION_ENCODING_TYPES } from './constants.js';
+import { COMPRESSION_ENCODING_TYPES, HttpErrorCodes } from './constants.js';
 import { isAPIGatewayProxyResult } from './utils.js';
 
 /**
@@ -181,10 +181,12 @@ export const handlerResultToWebResponse = (
  * Handles APIGatewayProxyResult, Response objects, and plain objects.
  *
  * @param response - The handler response (APIGatewayProxyResult, Response, or plain object)
+ * @param statusCode - The response status code to return
  * @returns An API Gateway proxy result
  */
 export const handlerResultToProxyResult = async (
-  response: HandlerResponse
+  response: HandlerResponse,
+  statusCode: (typeof HttpErrorCodes)[keyof typeof HttpErrorCodes] = HttpErrorCodes.OK
 ): Promise<APIGatewayProxyResult> => {
   if (isAPIGatewayProxyResult(response)) {
     return response;
@@ -193,7 +195,7 @@ export const handlerResultToProxyResult = async (
     return await webResponseToProxyResult(response);
   }
   return {
-    statusCode: 200,
+    statusCode,
     body: JSON.stringify(response),
     headers: { 'content-type': 'application/json' },
     isBase64Encoded: false,

packages/event-handler/src/rest/errors.ts

@@ -1,4 +1,4 @@
-import type { ErrorResponse, HttpStatusCode } from '../types/rest.js';
+import type { HandlerResponse, HttpStatusCode } from '../types/rest.js';
 import { HttpErrorCodes } from './constants.js';
 
 export class RouteMatchingError extends Error {
@@ -34,7 +34,7 @@ export abstract class ServiceError extends Error {
     this.details = details;
   }
 
-  toJSON(): ErrorResponse {
+  toJSON(): HandlerResponse {
     return {
       statusCode: this.statusCode,
       error: this.errorType,

packages/event-handler/src/types/index.ts

@@ -35,7 +35,6 @@ export type {
   CorsOptions,
   ErrorHandler,
   ErrorResolveOptions,
-  ErrorResponse,
   HandlerResponse,
   HttpMethod,
   HttpStatusCode,

packages/event-handler/src/types/rest.ts

@@ -3,27 +3,11 @@ import type {
   JSONObject,
 } from '@aws-lambda-powertools/commons/types';
 import type { APIGatewayProxyEvent, Context } from 'aws-lambda';
-import type {
-  MethodNotAllowedError,
-  NotFoundError,
-} from '../../src/rest/errors.js';
 import type { HttpErrorCodes, HttpVerbs } from '../rest/constants.js';
 import type { Route } from '../rest/Route.js';
 import type { Router } from '../rest/Router.js';
 import type { ResolveOptions } from './common.js';
 
-type ErrorResponse =
-  | {
-      statusCode: HttpStatusCode;
-      error: string;
-      message?: string;
-    }
-  | {
-      statusCode: HttpStatusCode;
-      error?: string;
-      message: string;
-    };
-
 type RequestContext = {
   req: Request;
   event: APIGatewayProxyEvent;
@@ -34,17 +18,10 @@ type RequestContext = {
 
 type ErrorResolveOptions = RequestContext & ResolveOptions;
 
-type ErrorHandler<T extends Error = Error> = T extends
-  | NotFoundError
-  | MethodNotAllowedError
-  ? (
-      error: T,
-      reqCtx: RequestContext
-    ) => Promise<Omit<ErrorResponse, 'statusCode'> | Response | JSONObject>
-  : (
-      error: T,
-      reqCtx: RequestContext
-    ) => Promise<ErrorResponse | Response | JSONObject>;
+type ErrorHandler<T extends Error = Error> = (
+  error: T,
+  reqCtx: RequestContext
+) => Promise<HandlerResponse>;
 
 interface ErrorConstructor<T extends Error = Error> {
   new (...args: any[]): T;
@@ -182,7 +159,6 @@ export type {
   CompiledRoute,
   CorsOptions,
   DynamicRoute,
-  ErrorResponse,
   ErrorConstructor,
   ErrorHandlerRegistryOptions,
   ErrorHandler,