Proper Typing for Events

Summary of proposed feature Since the arguments to each event in the events object are known, the typing should include that information.

Purpose of proposed feature To making coding easier and prevent errors when using events

Detail about proposed feature Currently the events object has the following typing:

export type EventCallback = (message: any) => Promise<void>;
export type EventsOptions = Partial<Record<EventType, EventCallback>>;

I think it should have an actual shape defining the event names supported and their message types. As an example:

export type EventCallback<MessageType = any> = (message: MessageType) => Promise<void>;

type SignInMessage = {
  user: User;
  account: Record<string, unknown>;
  isNewUser?: boolean;
};

export type EventsOptions = Partial<{
  signIn: EventCallback<SignInMessage>;
  // And so on...
}>;

Potential problems I don’t foresee any issues with this. The only thing I’m unsure about is if your .d.ts files are autogenerated or manually written.

Please indicate if you are willing and able to help implement the proposed feature. Of course, just let me know if your .d.ts files are autogenerated or manually written.

[zackdotcomputer]

@balazsorban44 That’s great! I’ve been pretty busy with a new puppy 🐶 but managed to sneak a PR in during one of her naps.

[zackdotcomputer]

Sorry - just saw your note on the npm package page that typing issues should be directed to DefinitelyTyped. Maybe the .d.ts files in this project should be removed?

Moving my issue over to them.