Bug: API Gateway envelopes assumes message body is always a JSON

[dreamorosi]

Expected Behavior

When working with the ApiGatewayEnvelope and ApiGatewayV2Envelope I should be able to extract the message body regardless of whether it's a plain text string, base64-encoded string, or a JSON-stringified one.

Current Behavior

When the message body is not a JSON-stringified object the envelope throws a runtime error as it's unable to parse it with JSON.parse().

Code snippet

import { z } from 'zod';
import { ApiGatewayEnvelope } from '@aws-lambda-powertools/parser/envelopes';

export const handler = async (event) => {
  try {
    ApiGatewayEnvelope.parse(event, z.string());
  } catch (error) {
    console.error(error);
  }
}

Steps to Reproduce

Send a request with a body that is either plain text or an encoded binary.

Possible Solution

No response

Powertools for AWS Lambda (TypeScript) version

latest

AWS Lambda function runtime

22.x

Packaging format used

npm

Execution logs

[github-actions]

⚠️ COMMENT VISIBILITY WARNING ⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.