unnbound-events 1.0.17 → 1.0.19

package/README.md

@@ -160,7 +160,17 @@ interface QueueEnvelope {
 
 The SDK supports automatic handling of large payloads (>256KB) stored in S3, which is necessary since SQS has a 256KB message size limit.
 
-### Configuration
+The S3 SDK (`@aws-sdk/client-s3`) is included as a dependency, so no additional installation is required.
+
+### Automatic Configuration
+
+The SDK will automatically enable S3 support when environment variables are set:
+
+- `UNNBOUND_S3_PAYLOAD_BUCKET` or `S3_BUCKET` - S3 bucket name for payload storage
+
+No code changes needed! Just set the environment variable and the SDK will handle S3 payloads automatically.
+
+### Manual Configuration
 
 Configure S3 support when starting the client:
 
@@ -191,14 +201,19 @@ await client.sqsListen({
 The SDK supports two S3 payload formats:
 
 1. **ExtendedSQSClient Pointer Format** (AWS Extended Client Library compatible):
+
    ```json
-   ["software.amazon.payloadoffloading.PayloadS3Pointer", {
-     "s3BucketName": "bucket-name",
-     "s3Key": "key-path"
-   }]
+   [
+     "software.amazon.payloadoffloading.PayloadS3Pointer",
+     {
+       "s3BucketName": "bucket-name",
+       "s3Key": "key-path"
+     }
+   ]
    ```
 
 2. **Envelope-based S3 Payloads** (Unnbound format):
+
    ```json
    {
      "payload": {
@@ -220,6 +235,7 @@ The SDK supports two S3 payload formats:
 ### Compression Support
 
 The SDK automatically decompresses payloads with:
+
 - `brotli` compression
 - `gzip` compression
 

package/dist/lib/client.js

@@ -48,17 +48,7 @@ exports.shouldIgnorePath = shouldIgnorePath;
 exports.defaultIgnoreTraceRoutes = ['/health', '/healthcheck'];
 // Helper function to create S3 client
 function createS3Client(options) {
-    const awsS3 = (() => {
-        try {
-            return require('@aws-sdk/client-s3');
-        }
-        catch {
-            return null;
-        }
-    })();
-    if (!awsS3) {
-        throw new Error('@aws-sdk/client-s3 is required for S3 payload support');
-    }
+    const awsS3 = require('@aws-sdk/client-s3');
     const env = globalThis.process
         ?.env ?? {};
     const region = options.region || env.AWS_REGION || 'us-east-1';
@@ -76,7 +66,7 @@ async function fetchS3Payload(s3Client, bucket, key, versionId) {
         params.VersionId = versionId;
     }
     try {
-        const response = await s3Client.send(new awsS3.GetObjectCommand(params));
+        const response = (await s3Client.send(new awsS3.GetObjectCommand(params)));
         const body = response.Body;
         // Convert stream to string
         const chunks = [];
@@ -353,7 +343,8 @@ function createEventsClient(ignoreTraceRoutes = exports.defaultIgnoreTraceRoutes
                         try {
                             const parsed = JSON.parse(recordBody);
                             // Detect S3 pointer format: ["software.amazon.payloadoffloading.PayloadS3Pointer", {...}]
-                            if (Array.isArray(parsed) && parsed.length === 2 &&
+                            if (Array.isArray(parsed) &&
+                                parsed.length === 2 &&
                                 parsed[0] === 'software.amazon.payloadoffloading.PayloadS3Pointer') {
                                 const pointer = parsed[1];
                                 if (!s3Client) {
@@ -373,7 +364,8 @@ function createEventsClient(ignoreTraceRoutes = exports.defaultIgnoreTraceRoutes
                             throw error;
                         }
                         // Check if envelope payload is stored in S3
-                        if (envelope.payload.type === 's3-single' || envelope.payload.type === 's3-multipart') {
+                        if (envelope.payload.type === 's3-single' ||
+                            envelope.payload.type === 's3-multipart') {
                             if (!envelope.payload.location) {
                                 throw new Error(`Payload type is ${envelope.payload.type} but no location specified`);
                             }
@@ -383,7 +375,7 @@ function createEventsClient(ignoreTraceRoutes = exports.defaultIgnoreTraceRoutes
                             unnbound_logger_sdk_1.logger.info({
                                 type: envelope.payload.type,
                                 bucket: envelope.payload.location.bucket,
-                                key: envelope.payload.location.key
+                                key: envelope.payload.location.key,
                             }, 'Fetching S3 envelope payload');
                             let payloadData = await fetchS3Payload(s3Client, envelope.payload.location.bucket, envelope.payload.location.key, envelope.payload.location.versionId);
                             // Handle decompression if needed
@@ -466,18 +458,18 @@ function createEventsClient(ignoreTraceRoutes = exports.defaultIgnoreTraceRoutes
             };
         },
         sqsListen(options) {
-            // Initialize S3 client if options provided
-            if (options?.s3) {
-                s3Options = options.s3;
-                const env = globalThis
-                    .process?.env ?? {};
-                const bucketName = options.s3.bucketName || env.UNNBOUND_S3_PAYLOAD_BUCKET || env.S3_BUCKET;
+            // Initialize S3 client if options provided OR if environment variables are set
+            const env = globalThis
+                .process?.env ?? {};
+            const bucketName = options?.s3?.bucketName || env.UNNBOUND_S3_PAYLOAD_BUCKET || env.S3_BUCKET;
+            if (bucketName || options?.s3) {
+                s3Options = options?.s3 || {};
                 if (!bucketName) {
                     unnbound_logger_sdk_1.logger.warn('S3 options provided but no bucket name specified. S3 payload support disabled.');
                 }
                 else {
                     try {
-                        s3Client = createS3Client({ ...options.s3, bucketName });
+                        s3Client = createS3Client({ ...s3Options, bucketName });
                         unnbound_logger_sdk_1.logger.info({ bucket: bucketName }, 'S3 client initialized for payload offloading');
                     }
                     catch (error) {
@@ -498,8 +490,6 @@ function createEventsClient(ignoreTraceRoutes = exports.defaultIgnoreTraceRoutes
             if (!awsSqs) {
                 throw new Error('@aws-sdk/client-sqs is required to use sqsListen');
             }
-            const env = globalThis
-                .process?.env ?? {};
             const queueUrl = options?.queueUrl || env.UNNBOUND_SQS_QUEUE_URL || env.SQS_QUEUE_URL || env.QUEUE_URL;
             if (!queueUrl || queueUrl === undefined) {
                 throw new Error('SQS queue URL not provided. Set UNNBOUND_SQS_QUEUE_URL, SQS_QUEUE_URL env or pass options.queueUrl');
@@ -581,9 +571,7 @@ function createEventsClient(ignoreTraceRoutes = exports.defaultIgnoreTraceRoutes
             const httpOptions = options?.http ?? { port: 3000 };
             const sqsOptions = options?.sqs ?? {};
             // Pass S3 options through to SQS listener if provided
-            const sqsListenOptions = options?.s3
-                ? { ...sqsOptions, s3: options.s3 }
-                : sqsOptions;
+            const sqsListenOptions = options?.s3 ? { ...sqsOptions, s3: options.s3 } : sqsOptions;
             // Start HTTP server
             let httpServer;
             try {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "unnbound-events",
   "description": "Unified events SDK to handle HTTP routes and SQS messages with a single routing API.",
-  "version": "1.0.17",
+  "version": "1.0.19",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -33,18 +33,15 @@
   "dependencies": {
     "express": "^4.0.0 || ^5.0.0",
     "@aws-sdk/client-sqs": "^3.0.0",
+    "@aws-sdk/client-s3": "^3.0.0",
     "unnbound-logger-sdk": "^3.0.22"
   },
   "peerDependencies": {
-    "express": "^4.0.0 || ^5.0.0",
-    "@aws-sdk/client-s3": "^3.0.0"
+    "express": "^4.0.0 || ^5.0.0"
   },
   "peerDependenciesMeta": {
     "express": {
       "optional": true
-    },
-    "@aws-sdk/client-s3": {
-      "optional": true
     }
   },
   "devDependencies": {