unnbound-events 1.0.2 → 1.0.3

package/README.md

@@ -67,7 +67,7 @@ await client.http({ port: 3000 });
 export const handler = client.sqs();
 
 // SQS long-poll listener (env-driven)
-// Env: SQS_QUEUE_URL, AWS_REGION, AWS_SQS_ENDPOINT (optional)
+// Env: UNNBOUND_SQS_QUEUE_URL (or SQS_QUEUE_URL), AWS_REGION, AWS_SQS_ENDPOINT (optional)
 await client.sqsListen();
 ```
 
@@ -94,3 +94,42 @@ interface QueueEnvelope {
   addons?: Record<string, unknown>;
 }
 ```
+
+## Environment Variables
+
+### SQS Configuration
+
+The SDK looks for SQS configuration in this order:
+
+1. **Options passed to `sqsListen()` or `start()`**
+2. **Environment variables** (in order of preference):
+   - `UNNBOUND_SQS_QUEUE_URL` (custom Unnbound variable)
+   - `SQS_QUEUE_URL` (standard variable)
+   - `QUEUE_URL` (fallback)
+
+**Required:**
+
+- `UNNBOUND_SQS_QUEUE_URL` or `SQS_QUEUE_URL` - The SQS queue URL
+
+**Optional:**
+
+- `AWS_REGION` - AWS region (defaults to `us-east-1`)
+- `AWS_SQS_ENDPOINT` - Custom SQS endpoint (for LocalStack, etc.)
+
+**Example:**
+
+```bash
+export UNNBOUND_SQS_QUEUE_URL="https://sqs.us-west-2.amazonaws.com/123456789012/my-queue"
+export AWS_REGION="us-west-2"
+```
+
+### AWS Credentials
+
+When running in ECS with a Task Role, no additional credentials are needed. The AWS SDK will automatically use the ECS Task Role credentials.
+
+For local development or other environments, set:
+
+```bash
+export AWS_ACCESS_KEY_ID="your-access-key"
+export AWS_SECRET_ACCESS_KEY="your-secret-key"
+```

package/dist/lib/client.js

@@ -196,9 +196,9 @@ function createEventsClient() {
             }
             const env = globalThis
                 .process?.env ?? {};
-            const queueUrl = options?.queueUrl || env.SQS_QUEUE_URL || env.QUEUE_URL;
+            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 SQS_QUEUE_URL env or pass options.queueUrl');
+                throw new Error('SQS queue URL not provided. Set UNNBOUND_SQS_QUEUE_URL, SQS_QUEUE_URL env or pass options.queueUrl');
             }
             const region = options?.region || env.AWS_REGION || 'us-east-1';
             const endpoint = env.AWS_SQS_ENDPOINT || env.AWS_ENDPOINT_URL || undefined;

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.2",
+  "version": "1.0.3",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {