@arkstack/notifications

Framework-agnostic notification module for Arkstack and Nodejs, providing support for multi-channel notification delivery.

import { Notification } from '@arkstack/notifications'

await Notification.mail()
  .recipient({ '[email protected]': 'Ada Lovelace' })
  .subject('Welcome, {name}')
  .data({ name: 'Ada' })
  .send('Hello {name}, thanks for joining.')

await Notification.sms()
  .recipient('+2348012345678')
  .send('Your code is {code}', undefined, undefined, { code: '123456' })

await Notification.db().recipient(user).send('Your payout has settled', 'Payout settled')

Apps using database notifications should provide a UserNotification model backed by a user_notifications table. The starter templates include this model and migration.

Config

export default () => ({
  default_driver: 'mail',
  drivers: {
    mail: {
      transport: 'smtp',
      from: env('MAIL_FROM_ADDRESS', '[email protected]'),
    },
    sms: {
      transport: 'africastalking',
      from: env('SMS_FROM'),
    },
    db: {
      table: 'user_notifications',
    },
  },
  transports: {
    ses: {
      region: env('MAIL_SES_REGION', env('AWS_DEFAULT_REGION', 'us-east-1')),
      // SESCustomOptionsSetName: "my-config-set",
      // SESCustomOptionsEmailTags: [{ Name: "tag_name", Value: "tag_value" }],
    },
    sendmail: {
      path: env('MAIL_SENDMAIL_PATH', '/usr/sbin/sendmail'),
    },
    smtp: {
      host: env('MAIL_HOST', 'localhost'),
      port: env('MAIL_PORT', 1025),
      auth: {
        user: env('MAIL_USERNAME', ''),
        pass: env('MAIL_PASSWORD', ''),
      },
      debug: env('MAIL_DEBUG', false),
      secure: env('MAIL_SECURE', false),
      logger: env('MAIL_LOGGER', false),
      require_tls: env('MAIL_REQUIRE_TLS', false),
    },
    africastalking: {
      username: env('AFRICASTALKING_USERNAME', 'sandbox'),
      apiKey: env('AFRICASTALKING_API_KEY', 'sandbox'),
    },
    twilio: {
      accountSid: env('TWILIO_ACCOUNT_SID'),
      authToken: env('TWILIO_AUTH_TOKEN'),
      from: env('TWILIO_FROM'),
    },
  },
})

default_driver selects the notification channel used by Notification.channel(). drivers.sms.transport selects the SMS provider transport, either africastalking or twilio.