@potatosalad775/eqcaps-device-bridge 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (148) hide show
  1. package/LICENSE +21 -0
  2. package/NOTICE.md +54 -0
  3. package/README.md +112 -0
  4. package/dist/analysis.d.ts +34 -0
  5. package/dist/analysis.d.ts.map +1 -0
  6. package/dist/analysis.js +92 -0
  7. package/dist/analysis.js.map +1 -0
  8. package/dist/biquad.d.ts +9 -0
  9. package/dist/biquad.d.ts.map +1 -0
  10. package/dist/biquad.js +50 -0
  11. package/dist/biquad.js.map +1 -0
  12. package/dist/browser/index.d.ts +14 -0
  13. package/dist/browser/index.d.ts.map +1 -0
  14. package/dist/browser/index.js +12 -0
  15. package/dist/browser/index.js.map +1 -0
  16. package/dist/browser/stream.d.ts +15 -0
  17. package/dist/browser/stream.d.ts.map +1 -0
  18. package/dist/browser/stream.js +51 -0
  19. package/dist/browser/stream.js.map +1 -0
  20. package/dist/browser/web-apis.d.ts +136 -0
  21. package/dist/browser/web-apis.d.ts.map +1 -0
  22. package/dist/browser/web-apis.js +13 -0
  23. package/dist/browser/web-apis.js.map +1 -0
  24. package/dist/browser/webbluetooth.d.ts +30 -0
  25. package/dist/browser/webbluetooth.d.ts.map +1 -0
  26. package/dist/browser/webbluetooth.js +80 -0
  27. package/dist/browser/webbluetooth.js.map +1 -0
  28. package/dist/browser/webhid.d.ts +33 -0
  29. package/dist/browser/webhid.d.ts.map +1 -0
  30. package/dist/browser/webhid.js +90 -0
  31. package/dist/browser/webhid.js.map +1 -0
  32. package/dist/browser/webserial.d.ts +34 -0
  33. package/dist/browser/webserial.d.ts.map +1 -0
  34. package/dist/browser/webserial.js +133 -0
  35. package/dist/browser/webserial.js.map +1 -0
  36. package/dist/bytes.d.ts +40 -0
  37. package/dist/bytes.d.ts.map +1 -0
  38. package/dist/bytes.js +74 -0
  39. package/dist/bytes.js.map +1 -0
  40. package/dist/chooser.d.ts +40 -0
  41. package/dist/chooser.d.ts.map +1 -0
  42. package/dist/chooser.js +49 -0
  43. package/dist/chooser.js.map +1 -0
  44. package/dist/device.d.ts +51 -0
  45. package/dist/device.d.ts.map +1 -0
  46. package/dist/device.js +94 -0
  47. package/dist/device.js.map +1 -0
  48. package/dist/errors.d.ts +24 -0
  49. package/dist/errors.d.ts.map +1 -0
  50. package/dist/errors.js +12 -0
  51. package/dist/errors.js.map +1 -0
  52. package/dist/handler.d.ts +161 -0
  53. package/dist/handler.d.ts.map +1 -0
  54. package/dist/handler.js +3 -0
  55. package/dist/handler.js.map +1 -0
  56. package/dist/handlers/airoha.d.ts +12 -0
  57. package/dist/handlers/airoha.d.ts.map +1 -0
  58. package/dist/handlers/airoha.js +135 -0
  59. package/dist/handlers/airoha.js.map +1 -0
  60. package/dist/handlers/conexant-usb-hid.d.ts +4 -0
  61. package/dist/handlers/conexant-usb-hid.d.ts.map +1 -0
  62. package/dist/handlers/conexant-usb-hid.js +103 -0
  63. package/dist/handlers/conexant-usb-hid.js.map +1 -0
  64. package/dist/handlers/edifier-serial.d.ts +6 -0
  65. package/dist/handlers/edifier-serial.d.ts.map +1 -0
  66. package/dist/handlers/edifier-serial.js +111 -0
  67. package/dist/handlers/edifier-serial.js.map +1 -0
  68. package/dist/handlers/fiio-f110.d.ts +7 -0
  69. package/dist/handlers/fiio-f110.d.ts.map +1 -0
  70. package/dist/handlers/fiio-f110.js +101 -0
  71. package/dist/handlers/fiio-f110.js.map +1 -0
  72. package/dist/handlers/fiio-usb-hid.d.ts +39 -0
  73. package/dist/handlers/fiio-usb-hid.d.ts.map +1 -0
  74. package/dist/handlers/fiio-usb-hid.js +143 -0
  75. package/dist/handlers/fiio-usb-hid.js.map +1 -0
  76. package/dist/handlers/fiio-usb-serial.d.ts +9 -0
  77. package/dist/handlers/fiio-usb-serial.d.ts.map +1 -0
  78. package/dist/handlers/fiio-usb-serial.js +122 -0
  79. package/dist/handlers/fiio-usb-serial.js.map +1 -0
  80. package/dist/handlers/fosi-audio-usb-hid.d.ts +19 -0
  81. package/dist/handlers/fosi-audio-usb-hid.d.ts.map +1 -0
  82. package/dist/handlers/fosi-audio-usb-hid.js +165 -0
  83. package/dist/handlers/fosi-audio-usb-hid.js.map +1 -0
  84. package/dist/handlers/index.d.ts +25 -0
  85. package/dist/handlers/index.d.ts.map +1 -0
  86. package/dist/handlers/index.js +36 -0
  87. package/dist/handlers/index.js.map +1 -0
  88. package/dist/handlers/jds-labs-usb-serial.d.ts +5 -0
  89. package/dist/handlers/jds-labs-usb-serial.d.ts.map +1 -0
  90. package/dist/handlers/jds-labs-usb-serial.js +156 -0
  91. package/dist/handlers/jds-labs-usb-serial.js.map +1 -0
  92. package/dist/handlers/ktmicro-usb-hid.d.ts +20 -0
  93. package/dist/handlers/ktmicro-usb-hid.d.ts.map +1 -0
  94. package/dist/handlers/ktmicro-usb-hid.js +144 -0
  95. package/dist/handlers/ktmicro-usb-hid.js.map +1 -0
  96. package/dist/handlers/moondrop-edge-serial.d.ts +8 -0
  97. package/dist/handlers/moondrop-edge-serial.d.ts.map +1 -0
  98. package/dist/handlers/moondrop-edge-serial.js +100 -0
  99. package/dist/handlers/moondrop-edge-serial.js.map +1 -0
  100. package/dist/handlers/moondrop-old-fashioned-hid.d.ts +4 -0
  101. package/dist/handlers/moondrop-old-fashioned-hid.d.ts.map +1 -0
  102. package/dist/handlers/moondrop-old-fashioned-hid.js +102 -0
  103. package/dist/handlers/moondrop-old-fashioned-hid.js.map +1 -0
  104. package/dist/handlers/moondrop-usb-hid.d.ts +8 -0
  105. package/dist/handlers/moondrop-usb-hid.d.ts.map +1 -0
  106. package/dist/handlers/moondrop-usb-hid.js +134 -0
  107. package/dist/handlers/moondrop-usb-hid.js.map +1 -0
  108. package/dist/handlers/nothing-usb-serial.d.ts +19 -0
  109. package/dist/handlers/nothing-usb-serial.d.ts.map +1 -0
  110. package/dist/handlers/nothing-usb-serial.js +141 -0
  111. package/dist/handlers/nothing-usb-serial.js.map +1 -0
  112. package/dist/handlers/qudelix-usb-hid.d.ts +16 -0
  113. package/dist/handlers/qudelix-usb-hid.d.ts.map +1 -0
  114. package/dist/handlers/qudelix-usb-hid.js +127 -0
  115. package/dist/handlers/qudelix-usb-hid.js.map +1 -0
  116. package/dist/handlers/tanchjim-rita-serial.d.ts +5 -0
  117. package/dist/handlers/tanchjim-rita-serial.d.ts.map +1 -0
  118. package/dist/handlers/tanchjim-rita-serial.js +89 -0
  119. package/dist/handlers/tanchjim-rita-serial.js.map +1 -0
  120. package/dist/handlers/walkplay-hid.d.ts +12 -0
  121. package/dist/handlers/walkplay-hid.d.ts.map +1 -0
  122. package/dist/handlers/walkplay-hid.js +150 -0
  123. package/dist/handlers/walkplay-hid.js.map +1 -0
  124. package/dist/identity.d.ts +20 -0
  125. package/dist/identity.d.ts.map +1 -0
  126. package/dist/identity.js +30 -0
  127. package/dist/identity.js.map +1 -0
  128. package/dist/index.d.ts +18 -0
  129. package/dist/index.d.ts.map +1 -0
  130. package/dist/index.js +12 -0
  131. package/dist/index.js.map +1 -0
  132. package/dist/io.d.ts +50 -0
  133. package/dist/io.d.ts.map +1 -0
  134. package/dist/io.js +119 -0
  135. package/dist/io.js.map +1 -0
  136. package/dist/platform.d.ts +9 -0
  137. package/dist/platform.d.ts.map +1 -0
  138. package/dist/platform.js +59 -0
  139. package/dist/platform.js.map +1 -0
  140. package/dist/protocols.d.ts +52 -0
  141. package/dist/protocols.d.ts.map +1 -0
  142. package/dist/protocols.js +204 -0
  143. package/dist/protocols.js.map +1 -0
  144. package/dist/transport.d.ts +59 -0
  145. package/dist/transport.d.ts.map +1 -0
  146. package/dist/transport.js +12 -0
  147. package/dist/transport.js.map +1 -0
  148. package/package.json +38 -0
@@ -0,0 +1,59 @@
1
+ /** One report a HID collection declares, as the descriptor states it. */
2
+ export interface HidReportInfo {
3
+ reportId: number;
4
+ /** Payload size in bytes, report id excluded. Undefined when the descriptor doesn't say. */
5
+ size?: number;
6
+ }
7
+ /** A HID collection, as far as a bridge or a descriptor dump needs it (INSPECTOR §2 T1). */
8
+ export interface HidCollectionInfo {
9
+ usagePage: number;
10
+ usage: number;
11
+ inputReports: HidReportInfo[];
12
+ outputReports: HidReportInfo[];
13
+ featureReports: HidReportInfo[];
14
+ children: HidCollectionInfo[];
15
+ }
16
+ export interface HidTransport {
17
+ readonly kind: 'hid';
18
+ readonly vendorId: number;
19
+ readonly productId: number;
20
+ /** Exactly as the device reports it, trailing spaces included. */
21
+ readonly productName: string;
22
+ readonly collections: readonly HidCollectionInfo[];
23
+ /** Output report. `data` excludes the report id. */
24
+ sendReport(reportId: number, data: Uint8Array): Promise<void>;
25
+ sendFeatureReport(reportId: number, data: Uint8Array): Promise<void>;
26
+ /**
27
+ * Feature report as the platform returns it. WebHID prepends the report id on numbered
28
+ * reports; handlers that read feature reports cope with both shapes.
29
+ */
30
+ receiveFeatureReport(reportId: number): Promise<Uint8Array>;
31
+ /** Subscribes to input reports (`data` excludes the report id). Returns the unsubscribe. */
32
+ onInputReport(listener: (reportId: number, data: Uint8Array) => void): () => void;
33
+ close(): Promise<void>;
34
+ }
35
+ /** Identity of a serial port, as Web Serial's `getInfo()` exposes it. */
36
+ export interface SerialPortIdentity {
37
+ usbVendorId?: number;
38
+ usbProductId?: number;
39
+ /** Bluetooth RFCOMM (SPP) ports: the service class UUID, lower case. */
40
+ bluetoothServiceClassId?: string;
41
+ }
42
+ /**
43
+ * A byte stream: a USB CDC or Bluetooth SPP serial port, or a BLE GATT pair (writes go to the TX
44
+ * characteristic, notifications come back through `read`). Framing is the handler's job.
45
+ */
46
+ export interface StreamTransport {
47
+ readonly kind: 'serial' | 'ble';
48
+ /** Serial ports only. */
49
+ readonly serial?: SerialPortIdentity;
50
+ /** BLE devices only: the advertised name, if any. */
51
+ readonly bleName?: string;
52
+ write(data: Uint8Array): Promise<void>;
53
+ /** The next received bytes, or null if nothing arrives within `timeoutMs`. */
54
+ read(timeoutMs: number): Promise<Uint8Array | null>;
55
+ close(): Promise<void>;
56
+ }
57
+ export type Transport = HidTransport | StreamTransport;
58
+ export type TransportKind = Transport['kind'];
59
+ //# sourceMappingURL=transport.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAWA,yEAAyE;AACzE,MAAM,WAAW,aAAa;IAC7B,QAAQ,EAAE,MAAM,CAAC;IACjB,4FAA4F;IAC5F,IAAI,CAAC,EAAE,MAAM,CAAC;CACd;AAED,4FAA4F;AAC5F,MAAM,WAAW,iBAAiB;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,aAAa,EAAE,CAAC;IAC9B,aAAa,EAAE,aAAa,EAAE,CAAC;IAC/B,cAAc,EAAE,aAAa,EAAE,CAAC;IAChC,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC9B;AAED,MAAM,WAAW,YAAY;IAC5B,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,kEAAkE;IAClE,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACnD,oDAAoD;IACpD,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9D,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrE;;;OAGG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAC5D,4FAA4F;IAC5F,aAAa,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,UAAU,KAAK,IAAI,GAAG,MAAM,IAAI,CAAC;IAClF,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAED,yEAAyE;AACzE,MAAM,WAAW,kBAAkB;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wEAAwE;IACxE,uBAAuB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,KAAK,CAAC;IAChC,yBAAyB;IACzB,QAAQ,CAAC,MAAM,CAAC,EAAE,kBAAkB,CAAC;IACrC,qDAAqD;IACrD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,KAAK,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvC,8EAA8E;IAC9E,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IACpD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACvB;AAED,MAAM,MAAM,SAAS,GAAG,YAAY,GAAG,eAAe,CAAC;AACvD,MAAM,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC"}
@@ -0,0 +1,12 @@
1
+ // Transports carry bytes between a handler and a device. Handlers only ever
2
+ // see these interfaces, never a browser or platform API (DECISIONS D20, D27, D33), so the same
3
+ // handler runs over WebHID in a browser and over a native USB plugin in an Android app.
4
+ //
5
+ // The browser implementations are in `./browser`. Anyone else (a Capacitor plugin, a Node test
6
+ // rig) implements the interface for their platform. Implementations should keep these rules:
7
+ // - an input listener sees every report that arrives after it subscribes, in order;
8
+ // - `read()` returns the bytes that arrived since the last read, buffered, so nothing is lost
9
+ // between two reads;
10
+ // - methods reject with a `BridgeError` of code `transport` when the device is gone.
11
+ export {};
12
+ //# sourceMappingURL=transport.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transport.js","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,+FAA+F;AAC/F,wFAAwF;AACxF,EAAE;AACF,+FAA+F;AAC/F,6FAA6F;AAC7F,oFAAoF;AACpF,8FAA8F;AAC9F,uBAAuB;AACvB,qFAAqF"}
package/package.json ADDED
@@ -0,0 +1,38 @@
1
+ {
2
+ "name": "@potatosalad775/eqcaps-device-bridge",
3
+ "version": "0.2.0",
4
+ "publishConfig": {
5
+ "access": "public"
6
+ },
7
+ "description": "Reads and writes parametric EQ on audio hardware over HID, serial and Bluetooth, behind a transport interface with no browser types.",
8
+ "license": "MIT",
9
+ "repository": {
10
+ "type": "git",
11
+ "url": "git+https://github.com/potatosalad775/eqcaps.git",
12
+ "directory": "packages/device-bridge"
13
+ },
14
+ "type": "module",
15
+ "sideEffects": false,
16
+ "files": [
17
+ "dist",
18
+ "NOTICE.md"
19
+ ],
20
+ "exports": {
21
+ ".": {
22
+ "eqcaps:source": "./src/index.ts",
23
+ "types": "./dist/index.d.ts",
24
+ "default": "./dist/index.js"
25
+ },
26
+ "./browser": {
27
+ "eqcaps:source": "./src/browser/index.ts",
28
+ "types": "./dist/browser/index.d.ts",
29
+ "default": "./dist/browser/index.js"
30
+ }
31
+ },
32
+ "scripts": {
33
+ "build": "node -e \"require('fs').rmSync('dist', { recursive: true, force: true })\" && tsc -p tsconfig.build.json"
34
+ },
35
+ "dependencies": {
36
+ "@potatosalad775/eqcaps-core": "0.2.0"
37
+ }
38
+ }