npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@rocketmakers/orbit-notify-generator

v1.0.5

Published

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

Downloads

19

Readme

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