@myshkouski/web-serial-polyfill 2.0.3 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myshkouski/web-serial-polyfill",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "An implementation of the [Serial API](https://wicg.github.io/serial) on top of the [WebUSB API](https://wicg.github.io/webusb) for use with USB-to-serial adapters. Use of this library is limited to hardware and platforms where the device is accessible via the WebUSB API because it has not been claimed by a built-in device driver. This project will be used to prototype the design of the Serial API.",
   "type": "module",
   "main": "./dist/serial.js",

package/serial.ts

@@ -198,8 +198,10 @@ class UsbEndpointUnderlyingSink implements UnderlyingSink<Uint8Array> {
   }
 }
 
+export type BaseSerialPort = Omit<SerialPort, "getSignals" | "onconnect" | "ondisconnect" | keyof EventTarget>
+
 /** a class used to control serial devices over WebUSB */
-export class SerialPort {
+class SerialPortPolyfill implements BaseSerialPort {
   private polyfillOptions_: SerialPolyfillOptions;
   private device_: USBDevice;
   private controlInterface_: USBInterface;
@@ -239,6 +241,17 @@ export class SerialPort {
     this.outEndpoint_ = findEndpoint(this.transferInterface_, 'out');
   }
 
+  /**
+   * Getter for checking whether device is connected.
+   * Since there is no equivalent getter on USBDevice instance, 
+   * this getter returns "true" when device is opened, not connected. 
+   * 
+   * @returns {boolean} "true" when the underlying USB device is opened. 
+   */
+  public get connected(): boolean {
+    return this.device_.opened
+  }
+
   /**
    * Getter for the readable attribute. Constructs a new ReadableStream as
    * necessary.
@@ -282,15 +295,12 @@ export class SerialPort {
    * Used before closing device.
    */
   private async releaseInterfaces_(): Promise<void> {
-    if (this.transferInterface_.claimed) {
-      await this.device_.releaseInterface(
-          this.transferInterface_.interfaceNumber
-      );
-    }
-    if (this.controlInterface_.claimed) {
-      await this.device_.releaseInterface(
-          this.controlInterface_.interfaceNumber);
-    }
+    await this.device_.releaseInterface(
+        this.transferInterface_.interfaceNumber
+    );
+    await this.device_.releaseInterface(
+        this.controlInterface_.interfaceNumber
+    );
   }
 
   /**
@@ -528,8 +538,10 @@ export class SerialPort {
   }
 }
 
+export { SerialPortPolyfill as SerialPort }
+
 /** generic implementation of navigator.serial object */
-export abstract class BaseSerial<T extends SerialPort> {
+export abstract class BaseSerial<T extends BaseSerialPort> {
   /**
    * @param {USB} usb Instance of navigator.usb object
    */
@@ -545,7 +557,7 @@ export abstract class BaseSerial<T extends SerialPort> {
    *
    * @param {SerialPortRequestOptions} options
    * @param {SerialPolyfillOptions} polyfillOptions
-   * @return {Promise<SerialPort>}
+   * @return {Promise<T>}
    */
   async requestPort(
       options?: SerialPortRequestOptions,
@@ -584,7 +596,7 @@ export abstract class BaseSerial<T extends SerialPort> {
    *
    * @param {SerialPolyfillOptions} polyfillOptions Polyfill configuration that
    * should be applied to these ports.
-   * @return {Promise<SerialPort[]>} a promise that is resolved with a list of
+   * @return {Promise<T[]>} a promise that is resolved with a list of
    * ports.
    */
   async getPorts(polyfillOptions?: SerialPolyfillOptions): Promise<T[]> {
@@ -605,15 +617,15 @@ export abstract class BaseSerial<T extends SerialPort> {
 }
 
 /** default implementation of the global navigator.serial object */
-export class Serial extends BaseSerial<SerialPort> {
+export class Serial extends BaseSerial<SerialPortPolyfill> {
   /**
    * @param {USBDevice} device
    * @param {SerialPolyfillOptions} options
-   * @return {SerialPort} Default serial port implementation
+   * @return {SerialPortPolyfill} Default serial port implementation
    */
   protected createPort(device: USBDevice,
-      options?: SerialPolyfillOptions): SerialPort {
-    return new SerialPort(device, options);
+      options?: SerialPolyfillOptions): SerialPortPolyfill {
+    return new SerialPortPolyfill(device, options);
   }
 }