Forward HIDInputReportEvent.timeStamp to button listeners

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "dictation_support",
-  "version": "1.0.5",
-  "description": "SDK to interact with dictation devices",
+  "name": "@mouadennasri/dictation_support",
+  "version": "1.1.0",
+  "description": "SDK to interact with dictation devices (RADPAIR fork — forwards HIDInputReportEvent.timeStamp to button listeners)",
   "scripts": {
     "build": "rimraf dist && npx webpack --config=webpack.config.js",
     "lint": "eslint --ignore-path .gitignore --ext .ts .",
@@ -18,9 +18,12 @@
     "/dist/index.js",
     "/dist/index.d.ts"
   ],
+  "publishConfig": {
+    "access": "public"
+  },
   "repository": {
     "type": "git",
-    "url": "https://github.com/GoogleChromeLabs/dictation_support.git"
+    "url": "https://github.com/mouadennasri/dictation_support.git"
   },
   "devDependencies": {
     "@types/jasmine": "^4.3.0",

src/dictation_device_base.ts

@@ -77,7 +77,8 @@ export enum ButtonEvent {
 }
 
 export type ButtonEventListener =
-    (device: DictationDevice, bitMask: ButtonEvent) => void|Promise<void>;
+    (device: DictationDevice, bitMask: ButtonEvent,
+     eventTimeStamp: number) => void|Promise<void>;
 
 export abstract class DictationDeviceBase {
   private static next_id = 0;
@@ -117,11 +118,10 @@ export abstract class DictationDeviceBase {
   }
 
   protected async onInputReport(event: HIDInputReportEvent) {
-    const data = event.data;
-    await this.handleButtonPress(data);
+    await this.handleButtonPress(event.data, event.timeStamp);
   }
 
-  protected async handleButtonPress(data: DataView) {
+  protected async handleButtonPress(data: DataView, eventTimeStamp: number) {
     const buttonMappings = this.getButtonMappings();
     const inputBitMask = this.getInputBitmask(data);
     let outputBitMask = 0;
@@ -135,7 +135,8 @@ export abstract class DictationDeviceBase {
     outputBitMask = this.filterOutputBitMask(outputBitMask);
 
     await Promise.all([...this.buttonEventListeners].map(
-        listener => listener(this.getThisAsDictationDevice(), outputBitMask)));
+        listener => listener(
+            this.getThisAsDictationDevice(), outputBitMask, eventTimeStamp)));
   }
 
   protected filterOutputBitMask(outputBitMask: number): number {

src/speechmike_hid_device.ts

@@ -261,14 +261,17 @@ export class SpeechMikeHidDevice extends DictationDeviceBase {
     }
     this.proxyDevice = proxyDevice;
     this.proxyDevice.addButtonEventListener(
-        (_device: DictationDevice, bitMask: ButtonEvent) =>
-            this.onProxyButtonEvent(bitMask));
+        (_device: DictationDevice, bitMask: ButtonEvent,
+         eventTimeStamp: number) =>
+            this.onProxyButtonEvent(bitMask, eventTimeStamp));
   }
 
   // See comment in DictationDeviceManager
-  protected async onProxyButtonEvent(bitMask: ButtonEvent) {
+  protected async onProxyButtonEvent(
+      bitMask: ButtonEvent, eventTimeStamp: number) {
     await Promise.all([...this.buttonEventListeners].map(
-        listener => listener(this.getThisAsDictationDevice(), bitMask)));
+        listener => listener(
+            this.getThisAsDictationDevice(), bitMask, eventTimeStamp)));
   }
 
   protected async handleCommandResponse(command: Command, data: DataView) {
@@ -360,7 +363,7 @@ export class SpeechMikeHidDevice extends DictationDeviceBase {
     const command = data.getUint8(0);
 
     if (command === Command.BUTTON_PRESS_EVENT) {
-      await this.handleButtonPress(data);
+      await this.handleButtonPress(data, event.timeStamp);
     } else if (command === Command.MOTION_EVENT) {
       await this.handleMotionEvent(data);
     } else if (command === Command.WIRELESS_STATUS_EVENT) {

src/speechmike_hid_device_test.ts

@@ -873,11 +873,14 @@ describe('SpeechMikeHidDevice', () => {
 
     it('propagates button press events from proxy device', async () => {
       const button = ButtonEvent.RECORD;
+      const eventTimeStamp = 1234;
       expect(state.buttonEventListener).not.toHaveBeenCalled();
       await Promise.all([...state.proxyDicationDeviceButtonEventListeners].map(
-          listener => listener(state.proxyDicationDevice, button)));
+          listener =>
+              listener(state.proxyDicationDevice, button, eventTimeStamp)));
       expect(state.buttonEventListener)
-          .toHaveBeenCalledOnceWith(state.dictationDevice, button);
+          .toHaveBeenCalledOnceWith(
+              state.dictationDevice, button, eventTimeStamp);
     });
   });
 });

src/test_util/check_button_mapping.ts

@@ -33,7 +33,8 @@ export async function checkButtonMapping(
       expect(buttonEventListener)
           .withContext(contextMessageButtonPress)
           .toHaveBeenCalledOnceWith(
-              expectedDicationDevice, testCase.expectedButtonEvents);
+              expectedDicationDevice, testCase.expectedButtonEvents,
+              jasmine.any(Number));
     }
     else {
       expect(buttonEventListener)
@@ -51,7 +52,8 @@ export async function checkButtonMapping(
     if (testCase.expectedButtonEvents !== undefined) {
       expect(buttonEventListener)
           .withContext(contextMessageButtonRelease)
-          .toHaveBeenCalledOnceWith(expectedDicationDevice, ButtonEvent.NONE);
+          .toHaveBeenCalledOnceWith(
+              expectedDicationDevice, ButtonEvent.NONE, jasmine.any(Number));
     }
     else {
       expect(buttonEventListener)

src/test_util/fake_hid_device.ts

@@ -76,10 +76,10 @@ export class FakeHidDevice implements HIDDevice {
     if (type === 'inputreport') this.inputReportListeners.delete(listener);
   }
 
-  async handleInputReport(data: number[]) {
+  async handleInputReport(data: number[], timeStamp = 0) {
     const dataView = new DataView(new Uint8Array(data).buffer);
-    const event: HIDInputReportEvent = {data: dataView} as unknown as
-        HIDInputReportEvent;
+    const event: HIDInputReportEvent =
+        {data: dataView, timeStamp} as unknown as HIDInputReportEvent;
     await Promise.all(
         [...this.inputReportListeners].map(listener => listener(event)));
   }