@myshkouski/web-serial-polyfill 2.0.0

package/.eslintrc.cjs

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in
+ * compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *    https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in
+ * writing, software distributed under the License is
+ * distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
+ * OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing
+ * permissions and limitations under the License.
+ */
+
+module.exports = {
+  "extends": [
+      "eslint:recommended",
+      "plugin:@typescript-eslint/eslint-recommended",
+      "plugin:@typescript-eslint/recommended",
+      "google"
+  ],
+  "env": {
+      "browser": true,
+      "es6": true
+  },
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+}

package/.github/workflows/node.js.yml

@@ -0,0 +1,30 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [14.x, 16.x, 18.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm install
+    - run: npm run build
+    - run: npm run lint

package/.github/workflows/npm_publish.yml

@@ -0,0 +1,24 @@
+# This workflow will do a clean install of node dependencies, build the source code and publish the code to the web-serial-polyfill npm package
+# For more information see: https://github.com/marketplace/actions/npm-publish
+
+name: NPM publish
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+      with:
+        node-version: '18'
+    - run: npm install
+    - run: npm run build
+    - uses: JS-DevTools/npm-publish@v1
+      with:
+        token: ${{ secrets.NPM_TOKEN }}

package/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# How to Contribute
+
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
+
+## Contributor License Agreement
+
+Contributions to this project must be accompanied by a Contributor License
+Agreement. You (or your employer) retain the copyright to your contribution;
+this simply gives us permission to use and redistribute your contributions as
+part of the project. Head over to <https://cla.developers.google.com/> to see
+your current agreements on file or to sign a new one.
+
+You generally only need to submit a CLA once, so if you've already submitted one
+(even if it was for a different project), you probably don't need to do it
+again.
+
+## Code reviews
+
+All submissions, including submissions by project members, require review. We
+use GitHub pull requests for this purpose. Consult
+[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
+information on using pull requests.
+
+## Community Guidelines
+
+This project follows [Google's Open Source Community
+Guidelines](https://opensource.google.com/conduct/).

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,18 @@
+# Serial API Polyfill
+
+An implementation of the [Web 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 was used to prototype the design of
+the Web Serial API and remains useful for platforms (such as Android) which
+support the WebUSB API but do not support the Web Serial API.
+
+This is also available as an npm package
+[here](https://www.npmjs.com/package/web-serial-polyfill) for convenience.
+
+A demo of this library is provided as part of the
+[serial terminal demo](https://github.com/GoogleChromeLabs/serial-terminal)
+and can be activated by clicking the
+"[Switch to API polyfill](https://googlechromelabs.github.io/serial-terminal/?polyfill)"
+link.

package/dist/serial.d.ts

@@ -0,0 +1,155 @@
+/// <reference types="w3c-web-usb" />
+/// <reference types="web" />
+/// <reference types="w3c-web-serial" />
+export declare enum SerialPolyfillProtocol {
+    UsbCdcAcm = 0
+}
+export interface SerialPolyfillOptions {
+    protocol?: SerialPolyfillProtocol;
+    usbControlInterfaceClass?: number;
+    usbTransferInterfaceClass?: number;
+}
+/** a class used to control serial devices over WebUSB */
+export declare class SerialPort {
+    private polyfillOptions_;
+    private device_;
+    private controlInterface_;
+    private transferInterface_;
+    private inEndpoint_;
+    private outEndpoint_;
+    private serialOptions_;
+    private readable_;
+    private writable_;
+    private outputSignals_;
+    /**
+     * constructor taking a WebUSB device that creates a SerialPort instance.
+     * @param {USBDevice} device A device acquired from the WebUSB API
+     * @param {SerialPolyfillOptions} polyfillOptions Optional options to
+     * configure the polyfill.
+     */
+    constructor(device: USBDevice, polyfillOptions?: SerialPolyfillOptions);
+    /**
+     * Getter for the readable attribute. Constructs a new ReadableStream as
+     * necessary.
+     * @return {ReadableStream} the current readable stream
+     */
+    get readable(): ReadableStream<Uint8Array> | null;
+    /**
+     * Getter for the writable attribute. Constructs a new WritableStream as
+     * necessary.
+     * @return {WritableStream} the current writable stream
+     */
+    get writable(): WritableStream<Uint8Array> | null;
+    /**
+     * a function that opens the device and claims all interfaces needed to
+     * control and communicate to and from the serial device
+     * @param {SerialOptions} options Object containing serial options
+     * @return {Promise<void>} A promise that will resolve when device is ready
+     * for communication
+     */
+    open(options: SerialOptions): Promise<void>;
+    /**
+     * Closes the port.
+     *
+     * @return {Promise<void>} A promise that will resolve when the port is
+     * closed.
+     */
+    close(): Promise<void>;
+    /**
+     * Forgets the port.
+     *
+     * @return {Promise<void>} A promise that will resolve when the port is
+     * forgotten.
+     */
+    forget(): Promise<void>;
+    /**
+     * A function that returns properties of the device.
+     * @return {SerialPortInfo} Device properties.
+     */
+    getInfo(): SerialPortInfo;
+    /**
+     * A function used to change the serial settings of the device
+     * @param {object} options the object which carries serial settings data
+     * @return {Promise<void>} A promise that will resolve when the options are
+     * set
+     */
+    reconfigure(options: SerialOptions): Promise<void>;
+    /**
+     * Sets control signal state for the port.
+     * @param {SerialOutputSignals} signals The signals to enable or disable.
+     * @return {Promise<void>} a promise that is resolved when the signal state
+     * has been changed.
+     */
+    setSignals(signals: SerialOutputSignals): Promise<void>;
+    /**
+     * Checks the serial options for validity and throws an error if it is
+     * not valid
+     */
+    private validateOptions;
+    /**
+     * Checks the baud rate for validity
+     * @param {number} baudRate the baud rate to check
+     * @return {boolean} A boolean that reflects whether the baud rate is valid
+     */
+    private isValidBaudRate;
+    /**
+     * Checks the data bits for validity
+     * @param {number} dataBits the data bits to check
+     * @return {boolean} A boolean that reflects whether the data bits setting is
+     * valid
+     */
+    private isValidDataBits;
+    /**
+     * Checks the stop bits for validity
+     * @param {number} stopBits the stop bits to check
+     * @return {boolean} A boolean that reflects whether the stop bits setting is
+     * valid
+     */
+    private isValidStopBits;
+    /**
+     * Checks the parity for validity
+     * @param {string} parity the parity to check
+     * @return {boolean} A boolean that reflects whether the parity is valid
+     */
+    private isValidParity;
+    /**
+     * sends the options alog the control interface to set them on the device
+     * @return {Promise} a promise that will resolve when the options are set
+     */
+    private setLineCoding;
+}
+/** generic implementation of navigator.serial object */
+export declare abstract class BaseSerial<T extends SerialPort> {
+    protected readonly usb: USB;
+    /**
+     * @param {USB} usb Instance of navigator.usb object
+     */
+    constructor(usb: USB);
+    protected abstract createPort(device: USBDevice, options?: SerialPolyfillOptions): T;
+    /**
+     * Requests permission to access a new port.
+     *
+     * @param {SerialPortRequestOptions} options
+     * @param {SerialPolyfillOptions} polyfillOptions
+     * @return {Promise<SerialPort>}
+     */
+    requestPort(options?: SerialPortRequestOptions, polyfillOptions?: SerialPolyfillOptions): Promise<T>;
+    /**
+     * Get the set of currently available ports.
+     *
+     * @param {SerialPolyfillOptions} polyfillOptions Polyfill configuration that
+     * should be applied to these ports.
+     * @return {Promise<SerialPort[]>} a promise that is resolved with a list of
+     * ports.
+     */
+    getPorts(polyfillOptions?: SerialPolyfillOptions): Promise<T[]>;
+}
+/** default implementation of the global navigator.serial object */
+export declare class Serial extends BaseSerial<SerialPort> {
+    /**
+     * @param {USBDevice} device
+     * @param {SerialPolyfillOptions} options
+     * @return {SerialPort} Default serial port implementation
+     */
+    protected createPort(device: USBDevice, options?: SerialPolyfillOptions): SerialPort;
+}