Feature request: add TransferFamilySchema to Parser

[dreamorosi]

Use case

Powertools for AWS Lambda (Python) recently added a Parser built-in schema for customers who work with Transfer Family (aws-powertools/powertools-lambda-python#5903). We should do the same and add a schema to our version as well.

Note

If you're interested in picking this up please leave a comment to claim it. A maintainer will assign the issue to you and help you with reviewing your PR. Likewise, if you have any questions before starting, feel free to leave a comment below.

Solution/User Experience

Customers should be able to use the built-in schema the same way as they use all the other built-in ones. For example:

import { TransferFamilySchema } from '@aws-lambda-powertools/parser/schemas/transfer-family';
import type { TransferFamilyEvent } from '@aws-lambda-powertools/parser/types';

export const handler = middy(async (event: TransferFamilyEvent) => {
  // ... handle event
}).use(
  parser({ schema: TransferFamilySchema })
);

To work on the issue, we should:

• Add the new schema under packages/parser/src/schemas/transfer-family.ts
• Add the TransferFamilyEvent type in packagesparser/src/types/schema.ts & corresponding packagesparser/src/types/index (you can import the schema directly from the packages/parser/src/schemas/transfer-family.ts file rather than adding it to the barrel file - which we want to move away from)
• Add the export to the packages/parser/package.json exports here and typesVersions here
• Add the new built-in schema to the table within the docs here
• Add the test event below at packages/parser/tests/events/transfer-family/base.json and write unit tests following the same style and conventions of the ones for other schemas, for example packages/parser/tests/unit/schema/alb.test.ts

{
    "username": "value",
    "password": "value",
    "protocol": "SFTP",
    "serverId": "s-abcd123456",
    "sourceIp": "192.168.0.100"
}

Alternative solutions

N/A

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.

[VatsalGoel3]

Hi, I’d like to work on adding the Transfer Family built-in schema. Please assign this issue to me. Thanks!

[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.

[github-actions]

This is now released under v2.14.0 version!