Merge pull request #8 from IBM/fix-add-more-ts

Fix add more ts

Author: davidnixon

docs/API.md

@@ -29,6 +29,8 @@
 - [rumble(low_frequency_rumble, high_frequency_rumble, duration_ms, player)](#rumble)
 - [rumbleTriggers(left_rumble, right_rumble, duration_ms, player)](#rumbleTriggers)
 
+---
+
 ## error
 
 Emitted if something goes wrong. The `message` is set from [SDL_GetError](https://wiki.libsdl.org/SDL_GetError)
@@ -106,8 +108,8 @@ These names are defined in [SDL source code](https://github.com/libsdl-org/SDL/b
 For example:
 
 ```js
-gamecontroller.on("a:down", (data) => console.log("a pressed", data));
-gamecontroller.on("b", (data) => console.log("b up or down", data));
+gamecontroller.on('a:down', (data) => console.log('a pressed', data));
+gamecontroller.on('b', (data) => console.log('b up or down', data));
 ```
 
 ## controller-button-up
@@ -130,8 +132,8 @@ See [controller-button-down](#controller-button-down)
 For example:
 
 ```js
-gamecontroller.on("a:up", (data) => console.log("a pressed", data));
-gamecontroller.on("b", (data) => console.log("b up or down", data));
+gamecontroller.on('a:up', (data) => console.log('a pressed', data));
+gamecontroller.on('b', (data) => console.log('b up or down', data));
 ```
 
 ## controller-axis-motion
@@ -162,8 +164,8 @@ These names are defined in [SDL source code](https://github.com/libsdl-org/SDL/b
 For example:
 
 ```js
-gamecontroller.on("leftx", (data) =>
-  console.log("left stick moved in the x direction", data)
+gamecontroller.on('leftx', (data) =>
+  console.log('left stick moved in the x direction', data),
 );
 ```
 
@@ -183,7 +185,7 @@ Emitted when a new game controller has been inserted into the system
   serial_number: 'none',        // SDL 2.0.14+
   effects_supported: false,
   haptic: false,
-  has_leds: 'false',            // SDL 2.0.14+
+  has_leds: false,              // SDL 2.0.14+
   num_touchpads: 0,             // SDL 2.0.14+
   has_accelerometer: false,     // SDL 2.0.14+
   has_gyroscope: false,         // SDL 2.0.14+
@@ -237,8 +239,8 @@ An alias for this event is also emitted with the event name set to either `gyros
 For example:
 
 ```js
-gamecontroller.on("gyroscope", (data) =>
-  console.log("gyroscope updated", data)
+gamecontroller.on('gyroscope', (data) =>
+  console.log('gyroscope updated', data),
 );
 ```
 
@@ -371,6 +373,10 @@ Emitted when the controller triggers are successfully rumbled.
 }
 ```
 
+## Functions
+
+---
+
 ## enableGyroscope
 
 `enableGyroscope(enable, player)`
@@ -382,13 +388,13 @@ Emitted when the controller triggers are successfully rumbled.
 
 ```js
 // Enable Gyroscope (if supported) when X button is pressed
-gamecontroller.on("x:down", (data) => {
+gamecontroller.on('x:down', (data) => {
   console.log(`player ${data.player} pressed X`);
   gamecontroller.enableGyroscope(true);
 });
 
 // Disable Gyroscope (if supported) when X button is released
-gamecontroller.on("x:up", (data) => {
+gamecontroller.on('x:up', (data) => {
   console.log(`player ${data.player} released X`);
   gamecontroller.enableGyroscope(false);
 });
@@ -405,13 +411,13 @@ gamecontroller.on("x:up", (data) => {
 
 ```js
 // Enable Accelerometer (if supported) when Y button is pressed
-gamecontroller.on("y:down", (data) => {
+gamecontroller.on('y:down', (data) => {
   console.log(`player ${data.player} pressed Y`);
   gamecontroller.enableAccelerometer(true, data.player);
 });
 
 // Disable Accelerometer (if supported) when Y button is released
-gamecontroller.on("y:up", (data) => {
+gamecontroller.on('y:up', (data) => {
   console.log(`player ${data.player} released Y`);
   gamecontroller.enableAccelerometer(false, data.player);
 });
@@ -431,7 +437,7 @@ gamecontroller.on("y:up", (data) => {
 Example:
 
 ```js
-gamecontroller.on("leftstick:down", (data) => {
+gamecontroller.on('leftstick:down', (data) => {
   gamecontroller.setLeds(0x0f, 0x62, 0xfe);
 });
 ```
@@ -451,7 +457,7 @@ Example:
 
 ```js
 // Rumble (if supported) when A button is pressed
-gamecontroller.on("a:down", (data) => {
+gamecontroller.on('a:down', (data) => {
   gamecontroller.rumble(60000, 40000, 100, data.player);
 });
 ```
@@ -471,7 +477,7 @@ Example:
 
 ```js
 // Rumble triggers (if supported) when B button is pressed
-gamecontroller.on("b:down", (data) => {
+gamecontroller.on('b:down', (data) => {
   gamecontroller.rumbleTriggers(40000, 40000, 100, data.player);
 });
 ```

index.d.ts

@@ -2,24 +2,82 @@ declare const gamecontroller: Gamecontroller;
 
 export default gamecontroller;
 
-export type Message = { message: string };
-export type Player = { player: number };
-export type Error = Message & Player & { operation: string };
-export type Value = { value: number };
-export type TimeStamp = { timestamp: number };
-export type OnButtonPress = Message &
-  Player & { button: ButtonType; pressed: boolean };
+export type Message = {message: string};
+export type Player = {player?: number};
+export type Error = Message & Player & {operation: string};
+export type Warning = Message & {
+  operation: string;
+  elapsed_ms?: number;
+  poll_number?: number;
+};
+export type SdlInit = {
+  compiled_against_SDL_version: string;
+  linkeded_against_SDL_version: string;
+};
+export type DeviceAdded = Message &
+  Player & {
+    which: number;
+    name: string;
+    vendor_id: number;
+    product_id: number;
+    serial_number?: string;
+    effects_supported: boolean;
+    haptic: boolean;
+    has_leds?: boolean;
+    num_touchpads?: number;
+    has_accelerometer?: boolean;
+    has_gyroscope?: boolean;
+    has_rumble?: boolean;
+    has_rumble_trigger?: boolean;
+  };
+export type SensorUpdate = Message & {
+  sensor: 'gyroscope' | 'accelerometer';
+  x: number;
+  y: number;
+  z: number;
+};
+export type SensorUpdateEvents =
+  | 'controller-sensor-update'
+  | 'gyroscope'
+  | 'accelerometer';
+export type SensorStateEvents =
+  | 'accelerometer:enabled'
+  | 'accelerometer:disabled'
+  | 'gyroscope:enabled'
+  | 'gyroscope:disabled';
+
+export type TouchpadUpdate = Message & {
+  touchpad: number;
+  finger: number;
+  x: number;
+  y: number;
+  pressure: number;
+};
+export type TouchpadEvents =
+  | 'controller-touchpad-down'
+  | 'controller-touchpad-up'
+  | 'controller-touchpad-motion';
 
-export type OnTriggerPress = Omit<OnButtonPress, 'pressed'> & {
-  value: number;
-  timestamp: number;
+export type DeviceUpdated = Message & {
+  which: number;
 };
-export type StickType = 'leftx' | 'lefty' | 'rightx' | 'righty';
+export type DeviceUpdateEvents =
+  | 'controller-device-removed'
+  | 'controller-device-remapped';
 
-export type OnStickMoveData = Message &
-  Player &
-  Value &
-  TimeStamp & { button: StickType };
+export type AxisType =
+  | 'leftx'
+  | 'lefty'
+  | 'rightx'
+  | 'righty'
+  | 'lefttrigger'
+  | 'righttrigger';
+
+export type AxisMotionData = Message &
+  Player & {button: AxisType; value: number; timestamp: number};
+
+export type ButtonPress = Message &
+  Player & {button: ButtonType; pressed: boolean};
 
 export type ButtonType =
   | 'a'
@@ -42,38 +100,68 @@ export type ButtonType =
 export type ButtonTypeWithUpsAndDowns =
   | `${ButtonType}:up`
   | `${ButtonType}:down`
-  | ButtonType;
+  | ButtonType
+  | 'controller-button-up'
+  | 'controller-button-down';
 
 export type ControllerButtonDown = Message &
-  Player & { button: ButtonType; pressed: boolean };
+  Player & {button: ButtonType; pressed: boolean};
 
-export type FieldUpdateHandler = (update: any) => unknown;
-export type Handlers = Record<string, FieldUpdateHandler>;
 export type CallBack<T = Record<string, unknown>> = (data: T) => void;
 
 type ON<TEventName, TCallBack> = (
   eventName: TEventName,
-  callBack: CallBack<TCallBack>
+  callBack: CallBack<TCallBack>,
 ) => void;
 
-type OnStickMove = ON<StickType, OnStickMoveData>;
-type OnButtonPressCall = ON<ButtonTypeWithUpsAndDowns, OnButtonPress>;
 type OnErrorCall = ON<'error', Error>;
-type OnControllerButtonUp = ON<'controller-button-up', OnButtonPress>;
-type OnControllerButtonDown = ON<'controller-button-down', OnButtonPress>;
-type OnTrigger = ON<'righttrigger' | 'lefttrigger', OnTriggerPress>;
+type OnWarningCall = ON<'warning', Warning>;
+type OnSdlInitCall = ON<'sdl-init', SdlInit>;
+type OnDeviceAddedCall = ON<'controller-device-added', DeviceAdded>;
+type OnDeviceUpdated = ON<DeviceUpdateEvents, DeviceUpdated>;
+type OnAxisUpdate = ON<AxisType, AxisMotionData>;
+type OnButtonPressCall = ON<ButtonTypeWithUpsAndDowns, ButtonPress>;
+type OnSensorUpdate = ON<SensorUpdateEvents, SensorUpdate>;
+type OnSensorStateChange = ON<SensorStateEvents, Player>;
+type OnTouchpadUpdate = ON<TouchpadEvents, TouchpadUpdate>;
+type OnLed = ON<'led', Player>;
+type OnRumbled = ON<'rumbled', Player>;
+type OnRumbledTriggers = ON<'rumbled-triggers', Player>;
 
 type AllOnOptions = OnButtonPressCall &
-  OnStickMove &
+  OnAxisUpdate &
   OnErrorCall &
-  OnControllerButtonUp &
-  OnControllerButtonDown &
-  OnTrigger;
+  OnWarningCall &
+  OnSdlInitCall &
+  OnDeviceAddedCall &
+  OnDeviceUpdated &
+  OnSensorUpdate &
+  OnSensorStateChange &
+  OnTouchpadUpdate &
+  OnLed &
+  OnRumbled &
+  OnRumbledTriggers;
 
 type Gamecontroller = {
+  enableGyroscope: (enable?: boolean, player?: number) => void;
+  enableAccelerometer: (enable?: boolean, player?: number) => void;
+  setLeds: (
+    red?: number,
+    green?: number,
+    blue?: number,
+    player?: number,
+  ) => void;
+  rumble: (
+    low_frequency_rumble?: number,
+    high_frequency_rumble?: number,
+    duration_ms?: number,
+    player?: number,
+  ) => void;
   rumbleTriggers: (
-    buttonType: ButtonType,
-    callBack: CallBack<OnTriggerPress>
+    left_rumble?: number,
+    right_rumble?: number,
+    duration_ms?: number,
+    player?: number,
   ) => void;
   on: AllOnOptions;
 };

package-lock.json

@@ -1,8 +1,9 @@
 {
   "name": "sdl2-gamecontroller",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "scripts": {
-    "install": "cmake-js compile"
+    "install": "cmake-js compile",
+    "lint": "prettier --write *.js *.ts test/*js test/*.ts"
   },
   "dependencies": {
     "bindings": "^1.5.0",
@@ -23,5 +24,10 @@
     "dualshock"
   ],
   "author": "David Nixon",
-  "license": "apache-2.0"
+  "license": "apache-2.0",
+  "devDependencies": {
+    "prettier": "^2.5.1",
+    "prettier-config-ibm": "^1.0.1"
+  },
+  "prettier": "prettier-config-ibm"
 }