Feature request: Add named type for values parsed by `DynamoDBStreamRecord[Schema]`

[benthorner]

Use case

There's no named type for values parsed by DynamoDBStreamRecord (the schema) ¹:

const DynamoDBStreamRecord = z.object({...

Conversely, there is a named type for the overall Stream (Event) ²:

type DynamoDBStreamEvent = z.infer<typeof DynamoDBStreamSchema>;

While the documentation encourages overriding the schemas ³, in our app we want to defer this and therefore pass values conforming to the original "raw" or "base" DynamoDBStreamRecord schema. Hence wanting to import a type for values parsed by the schema.

Although this is just a one-liner, it would be nice not to have to write it in our app.

Solution/User Experience

Add the following in packages/parser/src/types/schema.ts:

import { DynamoDBStreamRecord as DynamoDBStreamRecordSchema } from '../schemas/index.js'

...

type DynamoDBStreamRecord = z.infer<typeof DynamoDBStreamRecordSchema>;

Alternative solutions

Acknowledgment

• This feature request meets Powertools for AWS Lambda (TypeScript) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Python, Java, and .NET

Future readers

Please react with 👍 and your use case to help us understand customer demand.

Footnotes

1. https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/packages/parser/src/schemas/dynamodb.ts ↩

2. https://github.com/aws-powertools/powertools-lambda-typescript/blob/main/packages/parser/src/types/schema.ts#L104 ↩

3. https://docs.aws.amazon.com/powertools/typescript/latest/features/parser/#dynamodb-stream-event-parsing ↩

[boring-cyborg]

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #typescript channel on our Powertools for AWS Lambda Discord: Invite link

[dreamorosi]

Hi @benthorner, thanks for opening the issue.

I think the proposal makes sense, would you like to send a PR to add this type?

[benthorner]

@dreamorosi sure, here you go: #4793