Migrate to TypesScript (#45)

Author: bastengao

.gitignore

@@ -30,3 +30,6 @@ android/gradlew
 android/gradlew.bat
 
 .vscode
+
+# generated by bob
+lib/

index.js

@@ -3,16 +3,23 @@
   "title": "React Native Serial Port API",
   "version": "1.3.4",
   "description": "React Native Serial Port API",
-  "main": "index.js",
+  "main": "lib/commonjs/index.js",
+  "react-native": "src/index.ts",
+  "module": "lib/module/index.js",
+  "types": "lib/typescript/src/index.d.ts",
   "files": [
-    "index.js",
-    "src/",
+    "src",
+    "lib",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
     "android/src/",
     "android/build.gradle"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "generate-docs": "node_modules/.bin/jsdoc src -r -R README.md -t node_modules/docdash -d ./docs"
+    "generate-docs": "node_modules/.bin/jsdoc src -r -R README.md -t node_modules/docdash -d ./docs",
+    "prepack": "bob build"
   },
   "repository": {
     "type": "git",
@@ -39,12 +46,27 @@
     "docdash": "^1.1.1",
     "jsdoc": "^3.6.3",
     "react": "^16.8.3",
-    "react-native": "^0.59.10"
+    "react-native": "^0.59.10",
+    "react-native-builder-bob": "^0.20.3",
+    "typescript": "^4.9.5"
   },
   "dependencies": {
     "buffer": "^5.4.3"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
-  }
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module",
+      "typescript"
+    ]
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ]
 }

package-lock.json

@@ -1,5 +1,5 @@
 import { NativeEventEmitter, NativeModules, Platform } from 'react-native';
-import SerialPort from './SerialPort';
+import SerialPort, { SerialPortWrapper } from './SerialPort';
 
 const { SerialPortAPI } = NativeModules;
 const eventEmitter = Platform.OS === 'android' ? new NativeEventEmitter(SerialPortAPI) : null;
@@ -28,7 +28,7 @@ export default class API {
    * Get serial port device names
    * @param {stringArrayCallback} callback
    */
-  static deviceNames(callback) {
+  static deviceNames(callback: (names: string[]) => void) {
     if (Platform.OS !== 'android') throw new Error(`Not support ${Platform.OS}`)
     SerialPortAPI.deviceNames(callback);
   }
@@ -37,7 +37,7 @@ export default class API {
    * Get serial port device paths
    * @param {stringArrayCallback} callback
    */
-  static devicePaths(callback) {
+  static devicePaths(callback: (paths: string[]) => void) {
     if (Platform.OS !== 'android') throw new Error(`Not support ${Platform.OS}`)
     SerialPortAPI.devicePaths(callback);
   }
@@ -48,7 +48,7 @@ export default class API {
    */
   static devicePathsAsync() {
     if (Platform.OS !== 'android') throw new Error(`Not support ${Platform.OS}`)
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve) => {
       SerialPortAPI.devicePaths(resolve);
     });
   }
@@ -57,7 +57,7 @@ export default class API {
    * set su binary path
    * @param {string} suPath
    */
-  static setSuPath(suPath) {
+  static setSuPath(suPath: string) {
     if (Platform.OS !== 'android') throw new Error(`Not support ${Platform.OS}`)
     SerialPortAPI.setSuPath(suPath);
   }
@@ -66,7 +66,7 @@ export default class API {
    * get su binary path
    * @param {stringCallback} callback
    */
-  static getSuPath(callback) {
+  static getSuPath(callback: (suPath: string) => void) {
     if (Platform.OS !== 'android') throw new Error(`Not support ${Platform.OS}`)
     SerialPortAPI.getSuPath(callback)
   }
@@ -77,11 +77,11 @@ export default class API {
    * @param {openOptions} options
    * @returns {Promise<SerialPort>} connected serial port
    */
-  static open(devicePath, {baudRate, parity = 0, dataBits = 8, stopBits = 1}) {
+  static open(devicePath: string, {baudRate, parity = 0, dataBits = 8, stopBits = 1}: { baudRate: number, parity?: number, dataBits?: number, stopBits?: number }) {
     if (Platform.OS !== 'android') throw new Error(`Not support ${Platform.OS}`)
     return SerialPortAPI.open(devicePath, baudRate, parity, dataBits, stopBits)
-      .then(serialPort => {
-        return Promise.resolve(new SerialPort(serialPort, eventEmitter));
+      .then((serialPort: SerialPortWrapper) => {
+        return Promise.resolve(new SerialPort(serialPort, eventEmitter!));
       })
   }
 }

package.json

@@ -1,9 +1,22 @@
-import { NativeModules } from 'react-native';
+import { EventEmitter, EventSubscription, NativeModules } from 'react-native';
 import { Buffer } from 'buffer';
 
 const { SerialPortAPI } = NativeModules;
 const DataReceivedEvent = 'dataReceived';
 
+export interface SerialPortWrapper {
+  path: string;
+}
+
+export interface EventData {
+  data: string;
+}
+
+export interface ListenerProxy {
+  event: string;
+  listener: (data: EventData) => void;
+}
+
 /**
  * @name Subscription
  * @class
@@ -27,9 +40,13 @@ const DataReceivedEvent = 'dataReceived';
  * @hideconstructor
  */
 class SerialPort {
-  constructor(serialPort, eventEmitter) {
+  private path: string;
+  private eventEmitter: any;
+  private listeners: ListenerProxy[];
+  private subscriptions: EventSubscription[];
+
+  constructor(serialPort: SerialPortWrapper, eventEmitter: EventEmitter) {
     this.path = serialPort.path;
-    this.serialPort = serialPort;
     this.eventEmitter = eventEmitter;
     this.listeners = [];
     this.subscriptions = [];
@@ -47,7 +64,7 @@ class SerialPort {
    * @param {string} hex the hex of data
    * @returns {Promise} success promise
    */
-  send(hex) {
+  send(hex: string) {
     return SerialPortAPI.send(this.path, hex)
   }
 
@@ -56,8 +73,8 @@ class SerialPort {
    * @param {listener} listener
    * @returns {Subscription} subscription
    */
-  onReceived(listener) {
-    const listenerProxy = (event) => {
+  onReceived(listener: (data: Buffer) => void): EventSubscription {
+    const listenerProxy = (event: EventData) => {
       if (!event.data) {
         return;
       }

src/API.js renamed to src/API.ts

@@ -0,0 +1,4 @@
+import SerialPortAPI from './API';
+export { default as  SerialPort } from './SerialPort';
+
+export default SerialPortAPI;

src/SerialPort.js renamed to src/SerialPort.ts

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "allowUnreachableCode": false,
+    "allowUnusedLabels": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "jsx": "react",
+    "lib": [
+      "esnext"
+    ],
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noFallthroughCasesInSwitch": true,
+    "noImplicitReturns": true,
+    "noImplicitUseStrict": false,
+    "noStrictGenericChecks": false,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "esnext"
+  }
+}