rename HandlerOptions to RequestContext

Author: svozza

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

@@ -9,10 +9,10 @@ import type {
   ErrorConstructor,
   ErrorHandler,
   ErrorResolveOptions,
-  HandlerOptions,
   HttpMethod,
   Middleware,
   Path,
+  RequestContext,
   RouteHandler,
   RouteOptions,
   RouterOptions,
@@ -211,7 +211,7 @@ abstract class BaseRouter {
 
     const request = proxyEventToWebRequest(event);
 
-    const handlerOptions: HandlerOptions = {
+    const handlerOptions: RequestContext = {
       event,
       context,
       request,

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

@@ -2,11 +2,11 @@ import { isRecord, isString } from '@aws-lambda-powertools/commons/typeutils';
 import type { APIGatewayProxyEvent, APIGatewayProxyResult } from 'aws-lambda';
 import type {
   CompiledRoute,
-  HandlerOptions,
   HandlerResponse,
   HttpMethod,
   Middleware,
   Path,
+  RequestContext,
   ValidationResult,
 } from '../types/rest.js';
 import {
@@ -146,7 +146,7 @@ export const isAPIGatewayProxyResult = (
 export const composeMiddleware = (middleware: Middleware[]): Middleware => {
   return async (
     params: Record<string, string>,
-    options: HandlerOptions,
+    options: RequestContext,
     next: () => Promise<HandlerResponse | void>
   ): Promise<HandlerResponse | void> => {
     let index = -1;

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

@@ -14,18 +14,18 @@ type ErrorResponse = {
   message: string;
 };
 
-type HandlerOptions = {
+type RequestContext = {
   request: Request;
   event: APIGatewayProxyEvent;
   context: Context;
   res: Response;
 };
 
-type ErrorResolveOptions = HandlerOptions & ResolveOptions;
+type ErrorResolveOptions = RequestContext & ResolveOptions;
 
 type ErrorHandler<T extends Error = Error> = (
   error: T,
-  options: HandlerOptions
+  options: RequestContext
 ) => Promise<ErrorResponse>;
 
 interface ErrorConstructor<T extends Error = Error> {
@@ -59,7 +59,7 @@ type HandlerResponse = Response | JSONObject;
 type RouteHandler<
   TParams = Record<string, unknown>,
   TReturn = HandlerResponse,
-> = (args: TParams, options: HandlerOptions) => Promise<TReturn>;
+> = (args: TParams, options: RequestContext) => Promise<TReturn>;
 
 type HttpMethod = keyof typeof HttpVerbs;
 
@@ -84,7 +84,7 @@ type NextFunction = () => Promise<HandlerResponse | void>;
 
 type Middleware = (
   params: Record<string, string>,
-  options: HandlerOptions,
+  options: RequestContext,
   next: NextFunction
 ) => Promise<void | HandlerResponse>;
 
@@ -124,7 +124,7 @@ export type {
   HttpMethod,
   Middleware,
   Path,
-  HandlerOptions,
+  RequestContext,
   RouterOptions,
   RouteHandler,
   RouteOptions,

packages/event-handler/tests/unit/rest/BaseRouter.test.ts

@@ -10,10 +10,10 @@ import {
   type NotFoundError,
 } from '../../../src/rest/errors.js';
 import type {
-  HandlerOptions,
   HttpMethod,
   Middleware,
   Path,
+  RequestContext,
   RouteHandler,
   RouterOptions,
 } from '../../../src/types/rest.js';
@@ -233,7 +233,7 @@ describe('Class: BaseRouter', () => {
       // Prepare
       const app = new TestResolver();
       let middlewareParams: Record<string, string> | undefined;
-      let middlewareOptions: HandlerOptions | undefined;
+      let middlewareOptions: RequestContext | undefined;
 
       app.use(async (params, options, next) => {
         middlewareParams = params;
@@ -895,7 +895,7 @@ describe('Class: BaseRouter', () => {
       // Prepare
       const app = new TestResolver();
       let middlewareParams: Record<string, string> | undefined;
-      let middlewareOptions: HandlerOptions | undefined;
+      let middlewareOptions: RequestContext | undefined;
 
       const routeMiddleware: Middleware = async (params, options, next) => {
         middlewareParams = params;

packages/event-handler/tests/unit/rest/ErrorHandlerRegistry.test.ts

@@ -2,13 +2,13 @@ import { describe, expect, it } from 'vitest';
 import { HttpErrorCodes } from '../../../src/rest/constants.js';
 import { ErrorHandlerRegistry } from '../../../src/rest/ErrorHandlerRegistry.js';
 import type {
-  HandlerOptions,
   HttpStatusCode,
+  RequestContext,
 } from '../../../src/types/rest.js';
 
 const createErrorHandler =
   (statusCode: HttpStatusCode, message?: string) =>
-  async (error: Error, _options: HandlerOptions) => ({
+  async (error: Error, _options: RequestContext) => ({
     statusCode,
     error: error.name,
     message: message ?? error.message,

packages/event-handler/tests/unit/rest/utils.test.ts

@@ -8,9 +8,9 @@ import {
   validatePathPattern,
 } from '../../../src/rest/utils.js';
 import type {
-  HandlerOptions,
   Middleware,
   Path,
+  RequestContext,
 } from '../../../src/types/rest.js';
 
 describe('Path Utilities', () => {
@@ -370,7 +370,7 @@ describe('Path Utilities', () => {
   });
 
   describe('composeMiddleware', () => {
-    const mockOptions: HandlerOptions = {
+    const mockOptions: RequestContext = {
       event: {} as APIGatewayProxyEvent,
       context: {} as any,
       request: new Request('https://example.com'),