Passing relevant event maps into DeviceConnection

Author: microbit-grace

lib/bluetooth.ts

@@ -33,7 +33,8 @@ export interface MicrobitWebBluetoothConnectionOptions {
   logging?: Logging;
 }
 
-export interface MicrobitWebBluetoothConnection extends DeviceConnection {
+export interface MicrobitWebBluetoothConnection
+  extends DeviceConnection<ServiceConnectionEventMap> {
   /**
    * Sets micro:bit name filter for device requesting.
    *
@@ -143,7 +144,8 @@ export interface MicrobitWebBluetoothConnection extends DeviceConnection {
  */
 export const createWebBluetoothConnection = (
   options?: MicrobitWebBluetoothConnectionOptions,
-) => new MicrobitWebBluetoothConnectionImpl(options);
+): MicrobitWebBluetoothConnection =>
+  new MicrobitWebBluetoothConnectionImpl(options);
 
 /**
  * A Bluetooth connection to a micro:bit device.

lib/device.ts

@@ -3,8 +3,7 @@
  *
  * SPDX-License-Identifier: MIT
  */
-import { TypedEventTarget } from "./events.js";
-import { UARTDataEvent } from "./uart.js";
+import { TypedEventTarget, ValueIsEvent } from "./events.js";
 
 /**
  * Specific identified error types.
@@ -134,30 +133,6 @@ export class ConnectionStatusEvent extends Event {
   }
 }
 
-export class SerialDataEvent extends Event {
-  constructor(public readonly data: string) {
-    super("serialdata");
-  }
-}
-
-export class SerialResetEvent extends Event {
-  constructor() {
-    super("serialreset");
-  }
-}
-
-export class SerialErrorEvent extends Event {
-  constructor(public readonly error: unknown) {
-    super("serialerror");
-  }
-}
-
-export class FlashEvent extends Event {
-  constructor() {
-    super("flash");
-  }
-}
-
 export class BeforeRequestDevice extends Event {
   constructor() {
     super("beforerequestdevice");
@@ -178,18 +153,13 @@ export class BackgroundErrorEvent extends Event {
 
 export class DeviceConnectionEventMap {
   "status": ConnectionStatusEvent;
-  "serialdata": SerialDataEvent;
-  "serialreset": Event;
-  "serialerror": SerialErrorEvent;
-  "uartdata": UARTDataEvent;
-  "flash": Event;
+  "backgrounderror": BackgroundErrorEvent;
   "beforerequestdevice": Event;
   "afterrequestdevice": Event;
-  "backgrounderror": BackgroundErrorEvent;
 }
 
-export interface DeviceConnection
-  extends TypedEventTarget<DeviceConnectionEventMap> {
+export interface DeviceConnection<M extends ValueIsEvent<M>>
+  extends TypedEventTarget<DeviceConnectionEventMap & M> {
   status: ConnectionStatus;
 
   /**

lib/events.ts

@@ -40,7 +40,7 @@ export type TypedEventListenerOrEventListenerObject<M, T extends keyof M> =
   | TypedEventListener<M, T>
   | TypedEventListenerObject<M, T>;
 
-type ValueIsEvent<T> = {
+export type ValueIsEvent<T> = {
   [key in keyof T]: Event;
 };
 

lib/index.ts

@@ -19,17 +19,20 @@ import {
   DeviceErrorCode,
   FlashDataError,
   FlashDataSource,
-  FlashEvent,
   FlashOptions,
-  SerialDataEvent,
-  SerialErrorEvent,
-  SerialResetEvent,
 } from "./device.js";
 import { TypedEventTarget } from "./events.js";
 import { createUniversalHexFlashDataSource } from "./hex-flash-data-source.js";
 import { LedMatrix } from "./led.js";
 import { Logging, LoggingEvent } from "./logging.js";
 import { MagnetometerData, MagnetometerDataEvent } from "./magnetometer.js";
+import {
+  FlashEvent,
+  SerialConnectionEventMap,
+  SerialDataEvent,
+  SerialErrorEvent,
+  SerialResetEvent,
+} from "./serial-events.js";
 import { ServiceConnectionEventMap } from "./service-events.js";
 import { UARTDataEvent } from "./uart.js";
 import {
@@ -58,6 +61,7 @@ export {
   DeviceError,
   FlashDataError,
   FlashEvent,
+  SerialConnectionEventMap,
   SerialDataEvent,
   SerialErrorEvent,
   SerialResetEvent,

lib/serial-events.ts

@@ -0,0 +1,30 @@
+export class SerialDataEvent extends Event {
+  constructor(public readonly data: string) {
+    super("serialdata");
+  }
+}
+
+export class SerialResetEvent extends Event {
+  constructor() {
+    super("serialreset");
+  }
+}
+
+export class SerialErrorEvent extends Event {
+  constructor(public readonly error: unknown) {
+    super("serialerror");
+  }
+}
+
+export class FlashEvent extends Event {
+  constructor() {
+    super("flash");
+  }
+}
+
+export class SerialConnectionEventMap {
+  "serialdata": SerialDataEvent;
+  "serialreset": SerialResetEvent;
+  "serialerror": SerialErrorEvent;
+  "flash": FlashEvent;
+}

lib/usb-radio-bridge.ts

@@ -12,11 +12,10 @@ import {
   ConnectionStatusEvent,
   DeviceConnection,
   DeviceConnectionEventMap,
-  SerialDataEvent,
-  SerialErrorEvent,
 } from "./device.js";
 import { TypedEventTarget } from "./events.js";
 import { Logging, NullLogging } from "./logging.js";
+import { SerialDataEvent, SerialErrorEvent } from "./serial-events.js";
 import {
   ServiceConnectionEventMap,
   TypedServiceEventDispatcher,
@@ -41,7 +40,8 @@ interface ConnectCallbacks {
   onSuccess: () => void;
 }
 
-export interface MicrobitRadioBridgeConnection extends DeviceConnection {
+export interface MicrobitRadioBridgeConnection
+  extends DeviceConnection<ServiceConnectionEventMap> {
   /**
    * Sets remote device.
    *
@@ -56,7 +56,8 @@ export interface MicrobitRadioBridgeConnection extends DeviceConnection {
 export const createRadioBridgeConnection = (
   delegate: MicrobitWebUSBConnection,
   options?: MicrobitRadioBridgeConnectionOptions,
-) => new MicrobitRadioBridgeConnectionImpl(delegate, options);
+): MicrobitRadioBridgeConnection =>
+  new MicrobitRadioBridgeConnectionImpl(delegate, options);
 
 /**
  * Wraps around a USB connection to implement a subset of services over a serial protocol.

lib/usb.ts

@@ -15,15 +15,18 @@ import {
   DeviceError,
   FlashDataError,
   FlashDataSource,
-  FlashEvent,
   FlashOptions,
-  SerialDataEvent,
-  SerialErrorEvent,
-  SerialResetEvent,
 } from "./device.js";
 import { TypedEventTarget } from "./events.js";
 import { Logging, NullLogging } from "./logging.js";
 import { PromiseQueue } from "./promise-queue.js";
+import {
+  FlashEvent,
+  SerialConnectionEventMap,
+  SerialDataEvent,
+  SerialErrorEvent,
+  SerialResetEvent,
+} from "./serial-events.js";
 import { DAPWrapper } from "./usb-device-wrapper.js";
 import { PartialFlashing } from "./usb-partial-flashing.js";
 
@@ -41,7 +44,8 @@ export interface MicrobitWebUSBConnectionOptions {
   logging: Logging;
 }
 
-export interface MicrobitWebUSBConnection extends DeviceConnection {
+export interface MicrobitWebUSBConnection
+  extends DeviceConnection<SerialConnectionEventMap> {
   /**
    * Gets micro:bit deviceId.
    *
@@ -80,13 +84,13 @@ export interface MicrobitWebUSBConnection extends DeviceConnection {
  */
 export const createWebUSBConnection = (
   options?: MicrobitWebUSBConnectionOptions,
-) => new MicrobitWebUSBConnectionImpl(options);
+): MicrobitWebUSBConnection => new MicrobitWebUSBConnectionImpl(options);
 
 /**
  * A WebUSB connection to a micro:bit device.
  */
 class MicrobitWebUSBConnectionImpl
-  extends TypedEventTarget<DeviceConnectionEventMap>
+  extends TypedEventTarget<DeviceConnectionEventMap & SerialConnectionEventMap>
   implements MicrobitWebUSBConnection
 {
   status: ConnectionStatus =
@@ -477,7 +481,7 @@ class MicrobitWebUSBConnectionImpl
   }
 
   protected eventActivated(type: string): void {
-    switch (type as keyof DeviceConnectionEventMap) {
+    switch (type as keyof SerialConnectionEventMap) {
       case "serialdata": {
         this.startSerialInternal();
         break;
@@ -486,7 +490,7 @@ class MicrobitWebUSBConnectionImpl
   }
 
   protected async eventDeactivated(type: string) {
-    switch (type as keyof DeviceConnectionEventMap) {
+    switch (type as keyof SerialConnectionEventMap) {
       case "serialdata": {
         this.stopSerialInternal();
         break;

src/demo.ts

@@ -14,10 +14,10 @@ import {
   BackgroundErrorEvent,
   ConnectionStatus,
   ConnectionStatusEvent,
-  SerialDataEvent,
 } from "../lib/device";
 import { createUniversalHexFlashDataSource } from "../lib/hex-flash-data-source";
 import { MagnetometerDataEvent } from "../lib/magnetometer";
+import { SerialDataEvent } from "../lib/serial-events";
 import { UARTDataEvent } from "../lib/uart";
 import { createWebUSBConnection, MicrobitWebUSBConnection } from "../lib/usb";
 import {