fix(middlewares/http-json-body-parser): narrow body type to string

packages/http-json-body-parser/index.d.ts

@@ -1,19 +1,11 @@
 import middy from '@middy/core'
-import { APIGatewayEvent } from 'aws-lambda'
-import { JsonValue } from 'type-fest'
+import { APIGatewayEvent, APIGatewayProxyEventV2 } from 'aws-lambda'
 
 interface Options {
   reviver?: (key: string, value: any) => any
   disableContentTypeError?: boolean
 }
 
-export type Event = Omit<APIGatewayEvent, 'body'> & {
-  /**
-   * The body of the HTTP request.
-   */
-  body: JsonValue
-}
-
-declare function jsonBodyParser (options?: Options): middy.MiddlewareObj<Event>
+declare function jsonBodyParser (options?: Options): middy.MiddlewareObj<APIGatewayEvent | APIGatewayProxyEventV2>
 
 export default jsonBodyParser

packages/http-json-body-parser/index.test-d.ts

@@ -1,13 +1,76 @@
 import middy from '@middy/core'
-import { expectType } from 'tsd'
-import jsonBodyParser, { Event } from '.'
+import { expectType, expectError } from 'tsd'
+import jsonBodyParser from '.'
+import { APIGatewayProxyEvent, APIGatewayProxyEventV2 } from 'aws-lambda'
 
 // use with default options
 let middleware = jsonBodyParser()
-expectType<middy.MiddlewareObj<Event>>(middleware)
+expectType<middy.MiddlewareObj<APIGatewayProxyEvent | APIGatewayProxyEventV2>>(middleware)
 
 // use with all options
 middleware = jsonBodyParser({
   reviver: (key: string, value: any) => Boolean(value)
 })
-expectType<middy.MiddlewareObj<Event>>(middleware)
+expectType<middy.MiddlewareObj<APIGatewayProxyEvent | APIGatewayProxyEventV2>>(middleware)
+
+const baseEvent: Omit<APIGatewayProxyEvent, 'body'> = {
+  headers: {},
+  multiValueHeaders: {},
+  httpMethod: 'GET',
+  isBase64Encoded: false,
+  path: '/',
+  pathParameters: null,
+  queryStringParameters: null,
+  multiValueQueryStringParameters: null,
+  stageVariables: null,
+  requestContext: {
+    accountId: '',
+    apiId: '',
+    authorizer: null,
+    protocol: '',
+    httpMethod: '',
+    path: '',
+    stage: '',
+    requestId: '',
+    requestTimeEpoch: 0,
+    resourceId: '',
+    resourcePath: '',
+    identity: {
+      accessKey: null,
+      accountId: null,
+      apiKey: null,
+      apiKeyId: null,
+      caller: null,
+      clientCert: null,
+      cognitoAuthenticationProvider: null,
+      cognitoAuthenticationType: null,
+      cognitoIdentityId: null,
+      cognitoIdentityPoolId: null,
+      principalOrgId: null,
+      sourceIp: '',
+      user: null,
+      userAgent: null,
+      userArn: null
+    }
+  },
+  resource: ''
+}
+
+// allow body to only be string or null
+middleware = jsonBodyParser()
+const middifiedHandler = middy(()=>{}).use(middleware)
+
+expectType<Promise<void>>(middifiedHandler({
+  ...baseEvent,
+  body: 'string'
+}, {} as any))
+expectType<Promise<void>>(middifiedHandler({
+  ...baseEvent,
+  body: null
+}, {} as any))
+
+middifiedHandler({
+  ...baseEvent,
+  // @ts-expect-error
+  body: {}
+}, {} as any)