@middy/http-event-normalizer/index.d.ts

HTTP event normalizer middleware for the middy framework

// Copyright 2017 - 2026 will Farrell, Luciano Mammino, and Middy contributors.
// SPDX-License-Identifier: MIT
import type middy from "@middy/core";
import type {
	APIGatewayEvent,
	APIGatewayProxyEventMultiValueQueryStringParameters,
	APIGatewayProxyEventPathParameters,
	APIGatewayProxyEventQueryStringParameters,
	APIGatewayProxyEventV2,
} from "aws-lambda";

// TODO: Import from 'aws-lambda' when @types/aws-lambda adds VPC Lattice types
// https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/aws-lambda
export interface VPCLatticeEvent {
	body: string | null;
	headers: { [name: string]: string | undefined };
	is_base64_encoded: boolean;
	isBase64Encoded: boolean;
	method: string;
	path: string;
	pathParameters: APIGatewayProxyEventPathParameters;
	query_string_parameters: APIGatewayProxyEventQueryStringParameters | null;
	queryStringParameters: APIGatewayProxyEventQueryStringParameters;
}

export type RequestEvent = APIGatewayEvent | APIGatewayProxyEventV2;

export type Event<T extends RequestEvent = RequestEvent> =
	T extends APIGatewayEvent
		? APIGatewayEvent & {
				multiValueQueryStringParameters: APIGatewayProxyEventMultiValueQueryStringParameters;
				pathParameters: APIGatewayProxyEventPathParameters;
				queryStringParameters: APIGatewayProxyEventQueryStringParameters;
			}
		: T extends APIGatewayProxyEventV2
			? APIGatewayProxyEventV2 & {
					pathParameters: Record<string, string>;
					queryStringParameters: Record<string, string>;
				}
			: never;

declare function httpEventNormalizer<
	EventType extends RequestEvent = RequestEvent,
>(): middy.MiddlewareObj<Event<EventType>, unknown, Error>;

export declare function httpEventNormalizerValidateOptions(
	options?: Record<string, unknown>,
): void;

export default httpEventNormalizer;