@airhornjs/aws

Table of Contents

tests codecov license npm npm

@airhornjs/aws

AWS SNS and SES provider for Airhorn.

Installation

npm install airhorn @airhornjs/aws

Features

  • SMS sending via Amazon SNS (Simple Notification Service)
  • Email sending via Amazon SES (Simple Email Service)
  • Automatic error handling and retry support
  • Integration with Airhorn's notification system
  • Support for AWS credentials from environment variables or explicit configuration

Usage

SMS with Amazon SNS

import { Airhorn } from 'airhorn';
import { AirhornAws } from '@airhornjs/aws';

// Create AWS provider for SMS
const awsProvider = new AirhornAws({
  region: 'us-east-1',
  accessKeyId: 'your-access-key', // Optional, uses AWS SDK credential chain
  secretAccessKey: 'your-secret-key', // Optional, uses AWS SDK credential chain
});

// Create Airhorn instance with AWS provider
const airhorn = new Airhorn({
  providers: [awsProvider],
});

// Send SMS
const message = {
  from: '+1234567890', // Your sender ID or phone number
  content: 'Hello John!, your order #12345 has been shipped!',
  type: AirhornSendType.SMS,
};

const result = await airhorn.send(
  '+0987654321', // to
  message,
);

Email with Amazon SES

import { Airhorn } from 'airhorn';
import { AirhornAws } from '@airhornjs/aws';

// Create AWS provider with SES support
const awsProvider = new AirhornAws({
  region: 'us-east-1',
  accessKeyId: 'your-access-key', // Optional
  secretAccessKey: 'your-secret-key', // Optional
});

// Create Airhorn instance
const airhorn = new Airhorn({
  providers: [awsProvider],
});

const data = {
  orderId: '656565',
  customerName: 'John',
};

// Send Email
const template = {
  from: '[email protected]', // Must be verified in SES
  subject: 'Order <%= orderId %> Confirmation',
  content: '
Hello <%= customerName %>
Your order #<%= orderId %> has been confirmed!
',
};

const result = await airhorn.send(
  '[email protected]', // to
  template,
  data,
  AirhornSendType.Email
);

Both SMS and Email

By default, the provider supports both SMS and email notifications:

const provider = new AirhornAws({
  region: 'us-east-1',
  // AWS credentials can be provided explicitly or loaded from environment
  accessKeyId: 'your-access-key',
  secretAccessKey: 'your-secret-key',
  sessionToken: 'your-session-token', // Optional for temporary credentials
});

// Provider capabilities will include both 'sms' and 'email' by default
console.log(provider.capabilities); // ['sms', 'email']

Custom Capabilities

You can specify which services to enable using the capabilities option:

// SMS only
const smsProvider = new AirhornAws({
  region: 'us-east-1',
  capabilities: [AirhornSendType.SMS],
});

// Email only
const emailProvider = new AirhornAws({
  region: 'us-east-1',
  capabilities: [AirhornSendType.Email],
});

// Both (explicit)
const bothProvider = new AirhornAws({
  region: 'us-east-1',
  capabilities: [AirhornSendType.SMS, AirhornSendType.Email],
});

Push Notifications to Mobile Devices (iOS/Android)

Amazon SNS can send push notifications to mobile devices through platform application endpoints. Here's how to send notifications to Apple (APNs) and Android (FCM/GCM) devices:

import { Airhorn } from 'airhorn';
import { AirhornAws } from '@airhornjs/aws';

const awsProvider = new AirhornAws({
  region: 'us-east-1',
  capabilities: [AirhornSendType.SMS], // SNS handles mobile push
});

const airhorn = new Airhorn({
  providers: [awsProvider],
});

const data = {
  orderId: '12345',
};

// Send to iOS device via APNs
const template = {
  from: 'YourApp', // Sender ID
  content: JSON.stringify({
    aps: {
      alert: {
        title: 'New Order',
        body: 'You have a new order #<%= orderId %>',
      },
      badge: 1,
      sound: 'default',
    },
    // Custom data
    orderId: '12345',
  }),
};

// Send to Apple device endpoint ARN
await airhorn.send(
  'arn:aws:sns:us-east-1:123456789012:endpoint/APNS/YourApp/abc123', // iOS endpoint ARN
  template,
  AirhornSendType.MobilePush,
  {
    MessageStructure: 'json', // Required for platform-specific payloads
    MessageAttributes: {
      'AWS.SNS.MOBILE.APNS.PUSH_TYPE': {
        DataType: 'String',
        StringValue: 'alert', // or 'background'
      },
    },
  },
);

Note: Before sending push notifications, you need to:

  1. Create platform applications in SNS for APNs/FCM
  2. Register device tokens and create platform endpoints
  3. Optionally create SNS topics for broadcasting
  4. Configure proper IAM permissions for SNS platform endpoints

Configuration

AirhornAwsOptions

  • region (required): AWS region (e.g., 'us-east-1', 'eu-west-1')
  • accessKeyId (optional): AWS access key ID (uses AWS SDK credential chain if not provided)
  • secretAccessKey (optional): AWS secret access key (uses AWS SDK credential chain if not provided)
  • sessionToken (optional): AWS session token for temporary credentials
  • capabilities (optional): Array of AirhornSendType values to specify which services to enable (defaults to both SMS and Email)

Additional Options

You can pass additional provider-specific options as the second parameter to the send method:

Amazon SNS Options

await airhorn.send(to, message, {
  smsType: 'Promotional', // or 'Transactional' (default)
  maxPrice: '0.50', // Maximum price in USD
  // ... other SNS PublishCommand options
});

Amazon SES Options

await airhorn.send(to, message, {
  ccAddresses: ['[email protected]'],
  bccAddresses: ['[email protected]'],
  replyToAddresses: ['[email protected]'],
  returnPath: '[email protected]',
  configurationSetName: 'my-configuration-set',
  tags: [
    { Name: 'campaign', Value: 'summer-sale' },
    { Name: 'customer', Value: 'vip' }
  ],
  // ... other SES SendEmailCommand options
});

Prerequisites

AWS Credentials

The AWS SDK will automatically look for credentials in the following order:

  1. Credentials passed explicitly in AirhornAwsOptions
  2. Environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
  3. Shared credentials file (~/.aws/credentials)
  4. IAM role (when running on EC2, ECS, Lambda, etc.)

Amazon SNS Setup

  1. Ensure your AWS account has SNS permissions
  2. Configure SMS settings in SNS console if needed
  3. Note that SMS capabilities and pricing vary by region

Amazon SES Setup

  1. Verify your sender email address or domain in SES
  2. Request production access (SES starts in sandbox mode)
  3. Configure any necessary SES settings (configuration sets, etc.)

IAM Permissions

Minimum required IAM permissions:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": [
        "sns:Publish"
      ],
      "Resource": "*"
    },
    {
      "Effect": "Allow",
      "Action": [
        "ses:SendEmail"
      ],
      "Resource": "*"
    }
  ]
}

How to Contribute

Now that you've set up your workspace, you're ready to contribute changes to the airhorn repository you can refer to the CONTRIBUTING guide. If you have any questions please feel free to ask by creating an issue and label it question.

Licensing and Copyright

This project is MIT License © Jared Wray