Overview

The beacon module allows you to notify users in a multitude of different ways, including:

• Email
• SMS
• Instant Messaging
• Push Notifications
• In-app Notifications
• Webhooks

The beacon module also integrated directly into other modules when installed. See below for a full list of possible integrations.

Usage

Import the module into your application:

//app.module.ts
import { forwardRef, Module } from '@nestjs/common'
import { BeaconModule } from '@juicyllama/core'

@Module({
    imports: [forwardRef(() => BeaconModule)],
})
export class AppModule {}

Inject the service into your classes:

//example.service.ts
import { BeaconService } from '@juicyllama/core'

@Injectable()
export class ExampleService {
    constructor(@Inject(forwardRef(() => BeaconService)) readonly beaconService: BeaconService) {}
}

Send notifications using the service:

//example.service.ts

await this.beaconService.notify(options)

Methods

The following methods are available:

Notify

The main method for sending notifications, this method takes a single options object as a parameter which can be used to configure which types of notifications to send and their contents.

await this.beaconService.notify({})

Examples

Send an email

Send a push notification

Send a In-app notification

Send an IM

await this.beaconService.notify({
    methods: {
        im: true,
    },
    communication: {
        im: {
            slack: {
                channel: `example_channel`,
            },
        },
    },
    markdown: `⚠️ The cat is on fire! ⚠️`,
    unique: `cat_fire_${Dates.format(new Date(), 'YYYY_MM_DD')}`, //limit this type of alert to daily
})

Integrations

The beacon module can integrate with the following modules:

Templates

The framework ships with very basic messages which you can enable by adding the relevent entry to your .env file.

Custom Templates

However we recommend adding your own custom templates.

To setup your custom templates, you can add the following files:

• email.md

Before the template is sent, we automatically convert ${values} from the injected object details below.

Once you have added the above templates to your project, you can then add the reference in your .env file, for example:

BEACON_ACCOUNT_CREATE="lib/common/beacons/accounts/create"

The system will then look for the above template files in that folder, if it does not find the file, it will revert to the frameworks default.

Template Hooks

Add the hook to your .env file pointing to your template directory