To substitute the appropriate text for `firstName`, `lastName`, and `email`, users can provide the appropriate data to the `send()` function. This data is then passed to the template and rendered automatically.

# Examples for using this library

This library can be used to easily send a variety of notifications. In this section, we'll cover how to implement some simple use cases.

## Sending a simple email

Using the send function, we can email '[email protected]' from '[email protected]' using the generic template 'generic-template-foo'. We'll also use the provider type `AirhornProviderType.SMTP` to indicate that we're sending an email:

```javascript
import { Airhorn, AirhornProviderType } from 'airhorn';
const airhorn = new Airhorn();
await airhorn.send('[email protected]', '[email protected]', 'generic-template-foo', AirhornProviderType.SMTP);

Sending a simple webhook

Here, we'll send a simple webhook to the URL 'https://httpbin.org/post':

const airhorn = new Airhorn();
airhorn.send('https://httpbin.org/post', 'foo', 'bar', AirhornProviderType.WEBHOOK);

Using multiple providers

In this example, we'll send a message using multiple email providers:

1. Add in the AWS SES configuration
2. Add in the Sendgrid configuration
3. Send the message and it will randomly balance between the two providers.

const airhorn = new Airhorn({
        AWS_SES_REGION = 'us-east-1',
        TWILIO_SENDGRID_API_KEY = 'SENDGRID_API_KEY'
	});

await airhorn.send('[email protected]', '[email protected]', 'generic-template-foo', AirhornProviderType.SMTP);

Supported Cloud Service Providers

This library supports sending notifications via email, SMS, and Mobile Push for the following providers:

• Email: AWS SES and Twilio Sendgrid
• SMS: AWS SMS and Twilio
• Mobile Push: AWS SNS and Google Firebase

In this section, we'll describe how to use each of these notification services.

Email providers

This library supports sending emails via AWS SES and Twilio Sendgrid.

AWS SES

After configuring your system to use AWS SES, you can easily use airhorn to send emails. In this example, we'll email '[email protected]' from '[email protected]' using the email template 'generic-template-foo'. We'll list the provider type as AirhornProviderType.SMTP to indicate that we're sending an email:

const airhorn = new Airhorn({
        AWS_SES_REGION = 'us-east-1',
	});
await airhorn.send('[email protected]', '[email protected]', 'generic-template-foo', AirhornProviderType.SMTP);

Twilio Sendgrid

To send emails via Twilio Sendgrid, first update the TWILIO_SENDGRID_API_KEY value via AirhornOptions. Then, we can use the same syntax as above to send an email through Twilio Sendgrid:

const airhorn = new Airhorn({
        TWILIO_SENDGRID_API_KEY = 'SENDGRID_API_KEY'
	});
await airhorn.send('[email protected]', '[email protected]', 'generic-template-foo', AirhornProviderType.SMTP);

SMS providers

This library supports sending SMS using AWS SMS and Twilio.

AWS SMS

Once your system is configured to use AWS SMS, you can send SMS notifications through AWS SMS. In this example, we'll send the notification to the phone number '5555555555' from the number '5552223333' with the raw text data 'Test message text'. Then, we'll list the provider type as AirhornProviderType.SMS.

const airhorn = new Airhorn({
        AWS_SMS_REGION = 'us-east-1',
    });
await airhorn.send('5555555555', '5552223333', 'Test message text', AirhornProviderType.SMS);

Twilio SMS

To send SMS notifications via Twilio SMS, first update the TWILIO_SMS_ACCOUNT_SID and the TWILIO_SMS_AUTH_TOKEN values via the AirhornOptions as shown below. Then, we can send an SMS notification using the same syntax as above:

const airhorn = new Airhorn({
        TWILIO_SMS_ACCOUNT_SID = 'TWILIO_SMS_ACCOUNT_SID',
        TWILIO_SMS_AUTH_TOKEN = 'TWILIO_SMS_AUTH_TOKEN'
    });
await airhorn.send('5555555555', '5552223333', 'Test message text', AirhornProviderType.SMS);

Mobile push providers

This library supports sending Mobile Push notifications using AWS SNS and Google Firebase.

AWS SNS

To use AWS SNS you will need to create a new SNS application in the AWS console and integrate the AWS SNS SDK into your application.

1. Obtain the credentials and device token for the mobile platforms that you want to support.
2. Use the credentials to create a platform application object (PlatformApplicationArn) using Amazon SNS. For more information, see Creating a platform endpoint.
3. Use the returned credentials to request a device token for your mobile app and device from the mobile platforms. The token you receive represents your mobile app and device.
4. Use the device token and the PlatformApplicationArn to create a platform endpoint object (EndpointArn) using Amazon SNS. For more information, see Creating a platform endpoint.

Then, you can send the push message to the device endpoint using airhorn:

const airhorn = new Airhorn({
        AWS_SNS_REGION = 'us-east-1',
    });
await airhorn.send('endpointArn', '', 'generic-template-foo', AirhornProviderType.MOBILE_PUSH);

Firebase for Mobile Push

To use Firebase in your application, you will need to create a new project in the Firebase console and integrate the Firebase SDK according to the Firebase documentation.

In your Firebase Project Settings, go to the Service accounts tab to generate your private key as a json file and put the content of the file as FIREBASE_CERT environment variable.

Then, you can send the push message to the device endpoint using airhorn:

const airhorn = new Airhorn({
        FIREBASE_CERT = 'FIREBASE_CERT'
    });
await airhorn.send('endpointArn', '', 'generic-template-foo', AirhornProviderType.MOBILE_PUSH);

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.

Setting up your Development Environment

To set up your development environment, you'll need the following dependencies:

• Node.js (latest)
• Docker
• Firebase Account (this is for the firebase-cert.json file)

Set up your firebase account and generate the firebase-cert.json file. Then, place the file in the root of the project. This is needed even for testing as mocking the firebase-admin is almost impossible. After that you should run the following commands:

npm i && npm run test:services:start && npm test

This will start the services needed for testing and run the tests.

To stop the services, you can run:

npm run test:services:stop

If you are using nvm you can run the following:

nvm use && npm i && npm run test:services:start && npm test

Licensing

This project is licensed under MIT and copyright by Jared Wray 2021-future.