@rocketmakers/orbit-notify-generator

Notify Generator

The purpose of this package is to easy the onboarding and consuming of notifications with the notify microservice.

It will take typescript definitions marked with the notifyRegister decorator and generate a service which will make registering and sending the defined notification payloads a breeze.

Preparing your file

All you need to do is create your notification definition payloads in typescript, and mark them with the notifyRegister. These payloads should contain all of the dynamic data that is required for the notification.

import { notifyRegister } from '/shared/notify/decorator';

@notifyRegister('ResetPassword')
export class ResetPasswordPayload {
  constructor() {
    this.forename = '';
    this.surname = '';
    this.resetPasswordToken = '';
  }

  forename: string;
  surname: string;
  resetPasswordToken: string;
}

Generating the code

At the moment, an example implementation of the tool has been implemented at _build/source/run/genNotifyService.ts.

If we say that the above definition file is located at capsules/auth/notifyDefinitions.ts and we want the generated code to live at /capsules/auth/notify.gen.ts, you can generate the code with the following command

cd _build
npm run -- gen-notify-service -i=../capsules/auth/notifyDefinitions.ts -o=../capsules/auth/notify.gen.ts

Using the generated code

Setup

import { INotificationService, NotificationService } from './notify.gen';
import { ApiClient, IServiceRegistrationResult, INotifyResult } from '../shared/public/api-clients/notifyClientApi';

const fetcher; # Fetcher implementation goes here
const apiClient = new ApiClient(fetcher);
const notificationService = new NotificationService("Auth", apiClient);

kernel.bind<INotificationService<IServiceRegistrationResult, INotifyResult, NotifyTargets>>(types.Services.NotificationService).toConstantValue(notificationService);

Register

import { INotificationService } from './notify.gen';
import { IServiceRegistrationResult, INotifyResult } from '../shared/public/api-clients/notifyClientApi';

const notificationService = kernal.get<INotificationService<IServiceRegistrationResult, INotifyResult, NotifyTargets>>(
  types.Services.NotificationService
);
await notificationService.register();

Send notification

import { INotificationService, INotifyTargets } from './notify.gen';
import { ResetPasswordPayload } from './notifyDefinitions';
import { IServiceRegistrationResult, INotifyResult } from '../shared/public/api-clients/notifyClientApi';

class Test {
  constructor(private service: INotificationService<IServiceRegistrationResult, INotifyResult, NotifyTargets>) {}

  public async resetPassword() {
    # Determine who we are sending the notification to
    const targets: INotifyTargets = {};

    # Construct our payload
    const payload: ResetPasswordPayload = {}

    # Send notification
    await this.service.sendResetPasswordNotification(targets, payload);
  }
}

Notes

So you don't have to provide the generics for the service all of the time, you might want to extend it with an interface where the generics are already specified.

interface IAuthNotificationService implements INotificationService<IServiceRegistrationResult, INotifyResult, NotifyTargets> {
}

Tests

Unit tests for the generator can be found at _tests, which takes a given input file and tests against an expected generated output.

npm run tests