Export all transports as conitional

thegecko · thegecko · commit 179ad502cb33 · 2019-06-07T20:53:12.000+01:00
diff --git a/examples/daplink-flash/hid.js b/examples/daplink-flash/hid.js
@@ -22,7 +22,7 @@
 
 const hid = require("node-hid");
 const common = require("./common");
-const hidTransport = require("../../lib/transport/hid");
+const DAPjs = require("../../");
 
 // Allow user to select a device
 function selectDevice(vendorID) {
@@ -50,7 +50,7 @@ common.getFile()
     common.setupEmitter();
     return selectDevice(0xD28)
     .then(device => {
-        const transport = new hidTransport.HID(device);
+        const transport = new DAPjs.HID(device);
         return common.flash(transport, program);
     });
 })
diff --git a/examples/daplink-flash/usb.js b/examples/daplink-flash/usb.js
@@ -22,7 +22,7 @@
 
 const usb = require("usb");
 const common = require("./common");
-const usbTransport = require("../../lib/transport/usb");
+const DAPjs = require("../../");
 
 // Read USB device descriptor
 function getStringDescriptor(device, index) {
@@ -69,7 +69,7 @@ common.getFile()
     common.setupEmitter();
     return selectDevice(0xD28)
     .then(device => {
-        const transport = new usbTransport.USB(device);
+        const transport = new DAPjs.USB(device);
         return common.flash(transport, program);
     });
 })
diff --git a/examples/daplink-serial/hid.js b/examples/daplink-serial/hid.js
@@ -22,7 +22,7 @@
 
 const hid = require("node-hid");
 const common = require("./common");
-const hidTransport = require("../../lib/transport/hid");
+const DAPjs = require("../../");
 
 // Allow user to select a device
 function selectDevice(vendorID) {
@@ -56,7 +56,7 @@ function selectDevice(vendorID) {
 
 selectDevice(0xD28)
 .then(device => {
-    const transport = new hidTransport.HID(device);
+    const transport = new DAPjs.HID(device);
     return common.listen(transport);
 })
 .catch(error => {
diff --git a/examples/daplink-serial/usb.js b/examples/daplink-serial/usb.js
@@ -22,7 +22,7 @@
 
 const usb = require("usb");
 const common = require("./common");
-const usbTransport = require("../../lib/transport/usb");
+const DAPjs = require("../../");
 
 // Read USB device descriptor
 function getStringDescriptor(device, index) {
@@ -75,7 +75,7 @@ function selectDevice(vendorID) {
 
 selectDevice(0xD28)
 .then(device => {
-    const transport = new usbTransport.USB(device);
+    const transport = new DAPjs.USB(device);
     return common.listen(transport);
 })
 .catch(error => {
diff --git a/examples/read-registers/hid.js b/examples/read-registers/hid.js
@@ -22,7 +22,7 @@
 
 const hid = require("node-hid");
 const common = require("./common");
-const hidTransport = require("../../lib/transport/hid");
+const DAPjs = require("../../");
 
 // Allow user to select a device
 function selectDevice(vendorID) {
@@ -48,7 +48,7 @@ function selectDevice(vendorID) {
 
 selectDevice(0xD28)
 .then(device => {
-    const transport = new hidTransport.HID(device);
+    const transport = new DAPjs.HID(device);
     return common.readRegisters(transport);
 })
 .then(() => {
diff --git a/examples/read-registers/usb.js b/examples/read-registers/usb.js
@@ -22,7 +22,7 @@
 
 const usb = require("usb");
 const common = require("./common");
-const usbTransport = require("../../lib/transport/usb");
+const DAPjs = require("../../");
 
 // Read USB device descriptor
 function getStringDescriptor(device, index) {
@@ -66,7 +66,7 @@ function selectDevice(vendorID) {
 
 selectDevice(0xD28)
 .then(device => {
-    const transport = new usbTransport.USB(device);
+    const transport = new DAPjs.USB(device);
     return common.readRegisters(transport);
 })
 .then(() => {
diff --git a/package.json b/package.json
@@ -34,7 +34,7 @@
     "webusb"
   ],
   "scripts": {
-    "build": "rollup -c && typedoc src",
+    "build": "rollup -c && typedoc --tsconfig ./typedoc.tsconfig.json src",
     "watch": "rollup -c -w"
   },
   "engines": {
diff --git a/src/transport/hid.ts b/src/transport/hid.ts
@@ -58,8 +58,11 @@ export class HID implements Transport {
             }
 
             try {
-                this.device = new nodeHID(this.path);
-                resolve();
+                return import("node-hid")
+                .then(hid => {
+                    this.device = new hid.HID(this.path);
+                    resolve();
+                });
             } catch (ex) {
                 reject(ex);
             }
diff --git a/src/transport/index.ts b/src/transport/index.ts
@@ -56,4 +56,6 @@ export interface Transport {
     write(data: BufferSource): Promise<void>;
 }
 
+export * from "./hid";
+export * from "./usb";
 export * from "./webusb";
diff --git a/src/transport/usb.ts b/src/transport/usb.ts
@@ -21,17 +21,25 @@
 * SOFTWARE.
 */
 
-import {
-    LIBUSB_REQUEST_TYPE_CLASS,
-    LIBUSB_RECIPIENT_INTERFACE,
-    LIBUSB_ENDPOINT_IN,
-    LIBUSB_ENDPOINT_OUT,
-    Device,
-    InEndpoint,
-    OutEndpoint
-} from "usb";
+import { Device, InEndpoint, OutEndpoint} from "usb";
 import { Transport } from "./";
 
+/**
+ * @hidden
+ */
+const LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5);
+/**
+ * @hidden
+ */
+const LIBUSB_RECIPIENT_INTERFACE = 0x01;
+/**
+ * @hidden
+ */
+const LIBUSB_ENDPOINT_OUT = 0x00;
+/**
+ * @hidden
+ */
+const LIBUSB_ENDPOINT_IN = 0x80;
 /**
  * @hidden
  */
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,6 +1,7 @@
 {
     "compilerOptions": {
         "target": "es5",
+        "module": "esNext",
         "lib": [
             "es5",
             "dom",
diff --git a/typedoc.json b/typedoc.json
@@ -3,10 +3,11 @@
     "readme": "./README.md",
     "theme": "./docs-theme",
     "module": "commonjs",
-    "target": "es6",
     "mode": "file",
     "out": "docs",
     "excludeExternals": true,
+    "excludeNotExported": true,
+    "excludeProtected": true,
     "excludePrivate": true,
     "hideGenerator": true
 }
diff --git a/typedoc.tsconfig.json b/typedoc.tsconfig.json
@@ -0,0 +1,9 @@
+{
+    "compilerOptions": {
+        "lib": [
+            "es5",
+            "dom",
+            "es2015.promise"
+        ]
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -58,8 +58,11 @@ export class HID implements Transport {`
`58`	`58`	`}`
`59`	`59`
`60`	`60`	`try {`
`61`		`- this.device = new nodeHID(this.path);`
`62`		`- resolve();`
	`61`	`+ return import("node-hid")`
	`62`	`+ .then(hid => {`
	`63`	`+ this.device = new hid.HID(this.path);`
	`64`	`+ resolve();`
	`65`	`+ });`
`63`	`66`	`} catch (ex) {`
`64`	`67`	`reject(ex);`
`65`	`68`	`}`
Original file line number	Diff line number	Diff line change
`@@ -56,4 +56,6 @@ export interface Transport {`
`56`	`56`	`write(data: BufferSource): Promise<void>;`
`57`	`57`	`}`
`58`	`58`
	`59`	`+export * from "./hid";`
	`60`	`+export * from "./usb";`
`59`	`61`	`export * from "./webusb";`