use EventEmitter

packages/nostr/src/client/emitter.ts

@@ -0,0 +1,109 @@
+import Base from "events"
+import { Nostr, SubscriptionId } from "."
+import { RawEvent, SignedEvent } from "../event"
+
+/**
+ * Overrides providing better types for EventEmitter methods.
+ */
+export class EventEmitter extends Base {
+  override addListener(eventName: "event", listener: EventListener): this
+  override addListener(eventName: "notice", listener: NoticeListener): this
+  override addListener(eventName: "error", listener: ErrorListener): this
+  override addListener(eventName: EventName, listener: Listener): this {
+    return super.addListener(eventName, listener)
+  }
+
+  override emit(eventName: "event", params: EventParams, nostr: Nostr): boolean
+  override emit(eventName: "notice", notice: string, nostr: Nostr): boolean
+  override emit(eventName: "error", err: unknown, nostr: Nostr): boolean
+  override emit(eventName: EventName, ...args: unknown[]): boolean {
+    return super.emit(eventName, ...args)
+  }
+
+  override eventNames(): EventName[] {
+    return super.eventNames() as EventName[]
+  }
+
+  override listeners(eventName: "event"): EventListener[]
+  override listeners(eventName: "notice"): NoticeListener[]
+  override listeners(eventName: "error"): ErrorListener[]
+  override listeners(eventName: EventName): Listener[] {
+    return super.listeners(eventName) as Listener[]
+  }
+
+  override off(eventName: "event", listener: EventListener): this
+  override off(eventName: "notice", listener: NoticeListener): this
+  override off(eventName: "error", listener: ErrorListener): this
+  override off(eventName: string, listener: Listener): this {
+    return super.off(eventName, listener)
+  }
+
+  override on(eventName: "event", listener: EventListener): this
+  override on(eventName: "notice", listener: NoticeListener): this
+  override on(eventName: "error", listener: ErrorListener): this
+  override on(eventName: EventName, listener: Listener): this {
+    return super.on(eventName, listener)
+  }
+
+  override once(eventName: "event", listener: EventListener): this
+  override once(eventName: "notice", listener: NoticeListener): this
+  override once(eventName: "error", listener: ErrorListener): this
+  override once(eventName: EventName, listener: Listener): this {
+    return super.once(eventName, listener)
+  }
+
+  override prependListener(eventName: "event", listener: EventListener): this
+  override prependListener(eventName: "notice", listener: NoticeListener): this
+  override prependListener(eventName: "error", listener: ErrorListener): this
+  override prependListener(eventName: EventName, listener: Listener): this {
+    return super.prependListener(eventName, listener)
+  }
+
+  override prependOnceListener(
+    eventName: "event",
+    listener: EventListener
+  ): this
+  override prependOnceListener(
+    eventName: "notice",
+    listener: NoticeListener
+  ): this
+  override prependOnceListener(
+    eventName: "error",
+    listener: ErrorListener
+  ): this
+  override prependOnceListener(eventName: EventName, listener: Listener): this {
+    return super.prependOnceListener(eventName, listener)
+  }
+
+  override removeAllListeners(event?: EventName): this {
+    return super.removeAllListeners(event)
+  }
+
+  override removeListener(eventName: "event", listener: EventListener): this
+  override removeListener(eventName: "notice", listener: NoticeListener): this
+  override removeListener(eventName: "error", listener: ErrorListener): this
+  override removeListener(eventName: EventName, listener: Listener): this {
+    return super.removeListener(eventName, listener)
+  }
+
+  override rawListeners(eventName: EventName): Listener[] {
+    return super.rawListeners(eventName) as Listener[]
+  }
+
+  // TODO
+  // emitter[Symbol.for('nodejs.rejection')](err, eventName[, ...args]) shenanigans?
+}
+
+// TODO Also add on: ("subscribed", subscriptionId) which checks "OK"/"NOTICE" and makes a callback?
+// TODO Also add on: ("ok", boolean, eventId) which checks "OK"/"NOTICE" and makes a callback?
+type EventName = "event" | "notice" | "error"
+type EventListener = (params: EventParams, nostr: Nostr) => void
+type NoticeListener = (notice: string, nostr: Nostr) => void
+type ErrorListener = (error: unknown, nostr: Nostr) => void
+type Listener = EventListener | NoticeListener | ErrorListener
+
+interface EventParams {
+  signed: SignedEvent
+  subscriptionId: SubscriptionId
+  raw: RawEvent
+}