feat(parser): add TransferFamilySchema for AWS Transfer Family events

docs/utilities/parser.md

@@ -85,6 +85,7 @@ Parser comes with the following built-in schemas:
 | **SesSchema**                                | Lambda Event Source payload for Amazon Simple Email Service                           |
 | **SnsSchema**                                | Lambda Event Source payload for Amazon Simple Notification Service                    |
 | **SqsSchema**                                | Lambda Event Source payload for Amazon SQS                                            |
+| **TransferFamilySchema**                     | Lambda Event Source payload for AWS Transfer Family events                            |
 | **VpcLatticeSchema**                         | Lambda Event Source payload for Amazon VPC Lattice                                    |
 | **VpcLatticeV2Schema**                       | Lambda Event Source payload for Amazon VPC Lattice v2 payload                         |
 

packages/parser/src/schemas/index.ts

@@ -61,5 +61,6 @@ export {
   SnsNotificationSchema,
 } from './sns.js';
 export { SqsSchema, SqsRecordSchema } from './sqs.js';
+export { TransferFamilySchema } from './transfer-family.js';
 export { VpcLatticeSchema } from './vpc-lattice.js';
 export { VpcLatticeV2Schema } from './vpc-latticev2.js';

packages/parser/src/schemas/transfer-family.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+
+/**
+ * TransferFamilySchema validates events coming from AWS Transfer Family.
+ */
+export const TransferFamilySchema = z.object({
+  username: z.string(),
+  password: z.string(),
+  protocol: z.string(),
+  serverId: z.string(),
+  // Validates that sourceIp is a valid IPv4/IPv6 string. Adjust as needed.
+  sourceIp: z
+    .string()
+    .refine(
+      (ip) =>
+        /^(\d{1,3}\.){3}\d{1,3}$/.test(ip) ||
+        !!ip.match(/^([0-9a-f]{0,4}:){2,7}[0-9a-f]{0,4}$/i),
+      { message: 'Invalid IP address' }
+    ),
+});
+
+/**
+ * Type alias for TransferFamilyEvent, inferred from this schema.
+ */
+export type TransferFamilyEvent = z.infer<typeof TransferFamilySchema>;

packages/parser/src/types/schema.ts

@@ -37,6 +37,7 @@ import type {
   SnsSqsNotificationSchema,
   SqsRecordSchema,
   SqsSchema,
+  TransferFamilySchema,
   VpcLatticeSchema,
   VpcLatticeV2Schema,
 } from '../schemas/index.js';
@@ -129,6 +130,8 @@ type SqsEvent = z.infer<typeof SqsSchema>;
 
 type SqsRecord = z.infer<typeof SqsRecordSchema>;
 
+type TransferFamilyEvent = z.infer<typeof TransferFamilySchema>;
+
 type VpcLatticeEvent = z.infer<typeof VpcLatticeSchema>;
 
 type VpcLatticeEventV2 = z.infer<typeof VpcLatticeV2Schema>;
@@ -171,6 +174,7 @@ export type {
   SnsRecord,
   SqsEvent,
   SqsRecord,
+  TransferFamilyEvent,
   VpcLatticeEvent,
   VpcLatticeEventV2,
 };

packages/parser/tests/events/transfer-family/base.json

@@ -0,0 +1,8 @@
+{
+    "username": "value",
+    "password": "value",
+    "protocol": "SFTP",
+    "serverId": "s-abcd123456",
+    "sourceIp": "192.168.0.100"
+  }
+

packages/parser/tests/unit/schema/transfer-family.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, it } from 'vitest'; // or jest, depending on the project configuration
+import { TransferFamilySchema } from '../../../src/schemas/transfer-family';
+
+describe('TransferFamilySchema', () => {
+  it('should validate a valid TransferFamily event', () => {
+    const validEvent = {
+      username: 'testUser',
+      password: 'testPass',
+      protocol: 'SFTP',
+      serverId: 's-abcd123456',
+      sourceIp: '192.168.0.100',
+    };
+
+    // This should not throw an error if the event is valid.
+    expect(() => TransferFamilySchema.parse(validEvent)).not.toThrow();
+  });
+
+  it('should throw an error for an invalid TransferFamily event', () => {
+    const invalidEvent = {
+      username: 'testUser',
+      // missing password
+      protocol: 'SFTP',
+      serverId: 's-abcd123456',
+      sourceIp: 'invalid-ip',
+    };
+
+    // This should throw an error due to missing fields / invalid IP.
+    expect(() => TransferFamilySchema.parse(invalidEvent)).toThrow();
+  });
+});