Merge pull request shehankonecranes#1 from taoqf/master

Add typescript definition.

Author: SudoPlz

README.md

@@ -1,43 +1,54 @@
-[![npm](https://img.shields.io/npm/dt/react-native-mqtt.svg)]()
+[![npm version](https://badge.fury.io/js/sp-react-native-mqtt.svg)](https://badge.fury.io/js/sp-react-native-mqtt)
 
 ## Description
 
 [react-native](https://github.com/facebook/react-native) mqtt client module
 
 ## MQTT Features (inherit from native MQTT framework)
+
 * Use [MQTT Framework](https://github.com/ckrey/MQTT-Client-Framework) for IOS, [Paho MQTT Client](https://eclipse.org/paho/clients/android/) for Android
 * Support both IOS and Android
 * SSL/TLS
 * Native library, support mqtt over tcp
 
 ## Warning
+
 This library in progress developing, api may change, SSL/TLS non verify
 
 ## Getting started
 
 ### Manual install
 
 #### JS
+
 ```bash
-npm install rusfearuth/react-native-mqtt --save
+npm install sp-react-native-mqtt --save
 ```
+
 or
+
 ```bash
-yarn add rusfearuth/react-native-mqtt
+yarn add sp-react-native-mqtt
 ```
 
+### Linking
+
+```sh
+react-native link sp-react-native-mqtt
+```
 
 #### iOS
--  In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
-- Go to `node_modules` ➜ `react-native-mqtt` and add `RCTMqtt.xcodeproj`
-- In XCode, in the project navigator, select your project. Add `libRCTmqtt.a` and `libicucore.tbd` to your project's `Build Phases` ➜ `Link Binary With Libraries`
-- Click `RCTMqtt.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` - mark  as `recursive`.
-Add `pod 'MQTTClient'` to your podfile and `pod install`
-- Run your project (`Cmd+R`)
 
+* In XCode, in the project navigator, right click `Libraries` ➜ `Add Files to [your project's name]`
+* Go to `node_modules` ➜ `react-native-mqtt` and add `RCTMqtt.xcodeproj`
+* In XCode, in the project navigator, select your project. Add `libRCTmqtt.a` and `libicucore.tbd` to your project's `Build Phases` ➜ `Link Binary With Libraries`
+* Click `RCTMqtt.xcodeproj` in the project navigator and go the `Build Settings` tab. Make sure 'All' is toggled on (instead of 'Basic'). In the `Search Paths` section, look for `Header Search Paths` and make sure it contains both `$(SRCROOT)/../../react-native/React` - mark  as `recursive`.
+* Add `pod 'MQTTClient'` to your podfile and `pod install`
+* Run your project (`Cmd+R`)
 
 #### Android
--   Modify the ReactInstanceManager.builder() calls chain in `android/app/main/java/.../MainActivity.java` to include:
+
+* Modify the ReactInstanceManager.builder() calls chain in `android/app/main/java/.../MainActivity.java` to include:
 
 ```java
 import com.tuanpm.RCTMqtt.*; // import
@@ -48,30 +59,28 @@ import com.tuanpm.RCTMqtt.*; // import
 new RCTMqttPackage()           // for newest version of react-native
 ```
 
--  Append the following lines to `android/settings.gradle` before `include ':app'`:
+* Append the following lines to `android/settings.gradle` before `include ':app'`:
 
-```
+```gradle
 include ':react-native-mqtt'
 project(':react-native-mqtt').projectDir = new File(rootProject.projectDir,  '../node_modules/react-native-mqtt/android')
 
 ```
 
+* Insert the following lines inside the dependencies block in `android/app/build.gradle`, don't missing `apply plugin:'java'` on top:
 
-- Insert the following lines inside the dependencies block in `android/app/build.gradle`, don't missing `apply plugin:'java'` on top:
-
-```
+```gradle
 compile project(':react-native-mqtt')
 ```
 
 Notes:
 
-```
+```gradle
 dependencies {
   compile project(':react-native-mqtt')
 }
 ```
 
-
 ## Usage
 
 ```javascript
@@ -109,42 +118,42 @@ MQTT.createClient({
 ```
 
 ## API
+
 * `mqtt.createClient(options)`  create new client instance with `options`, async operation
-  - `uri`: `protocol://host:port`, protocol is [mqtt | mqtts]
-  - `host`: ipaddress or host name (override by uri if set)
-  - `port`: port number (override by uri if set)
-  - `tls`: true/false (override by uri if set to mqtts or wss)
-  - `user`: string username
-  - `pass`: string password
-  - `auth`: true/false - override = true if `user` or `pass` exist
-  - `clientId`: string client id
-  - `keepalive`
+  * `uri`: `protocol://host:port`, protocol is [mqtt | mqtts]
+  * `host`: ipaddress or host name (override by uri if set)
+  * `port`: port number (override by uri if set)
+  * `tls`: true/false (override by uri if set to mqtts or wss)
+  * `user`: string username
+  * `pass`: string password
+  * `auth`: true/false - override = true if `user` or `pass` exist
+  * `clientId`: string client id
+  * `keepalive`
 
 * `client`
-  - `on(event, callback)`: add event listener for
-    + event: `connect` - client connected
-    + event: `closed` - client disconnected
-    + event: `error` - error
-    + event: `message` - message object
-  - `connect`: begin connection
-  - `disconnect`: disconnect
-  - `subscribe(topic, qos)`
-  - `publish(topic, payload, qos, retain)`
+  * `on(event, callback)`: add event listener for
+    * event: `connect` - client connected
+    * event: `closed` - client disconnected
+    * event: `error` - error
+    * event: `message` - message object
+  * `connect`: begin connection
+  * `disconnect`: disconnect
+  * `subscribe(topic, qos)`
+  * `publish(topic, payload, qos, retain)`
 
 * `message`
-  - `retain`: *boolean* `false`
-  - `qos`: *number* `2`
-  - `data`: *string* `"test message"`
-  - `topic`: *string* `"/data"`
+  * `retain`: *boolean* `false`
+  * `qos`: *number* `2`
+  * `data`: *string* `"test message"`
+  * `topic`: *string* `"/data"`
 
 ## Todo
 
 * [ ] Use WeakReference for timer
 * [ ] Add disconnecting event
 
-
 ## LICENSE
 
-```
+```text
 INHERIT FROM MQTT LIBRARY (progress)
 ```

android/build.gradle

@@ -1,3 +1,7 @@
+def safeExtGet(prop, fallback) {
+    rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}
+
 buildscript {
   repositories {
     google()
@@ -12,12 +16,12 @@ buildscript {
 apply plugin: 'com.android.library'
 
 android {
-  compileSdkVersion 28
-  buildToolsVersion "28.0.3"
+  compileSdkVersion safeExtGet('compileSdkVersion', 28)
+  buildToolsVersion safeExtGet('buildToolsVersion', '28.0.3')
 
   defaultConfig {
-    minSdkVersion 16
-    targetSdkVersion 26
+    minSdkVersion safeExtGet('minSdkVersion', 16)
+    targetSdkVersion safeExtGet('targetSdkVersion', 26)
     versionCode 1
     versionName "1.0"
   }

android/src/main/java/com/tuanpm/RCTMqtt/RCTMqtt.java

@@ -65,7 +65,6 @@ public RCTMqtt(@NonNull final String ref, final ReactApplicationContext reactCon
         defaultOptions.putString("user", "");
         defaultOptions.putString("pass", "");
         defaultOptions.putBoolean("will", false);
-        defaultOptions.putInt("protocolLevel", 4);
         defaultOptions.putString("willMsg", "");
         defaultOptions.putString("willtopic", "");
         defaultOptions.putInt("willQos", 0);
@@ -155,7 +154,7 @@ private void createClient(@NonNull final ReadableMap params) {
                 /*
                  * http://stackoverflow.com/questions/3761737/https-get-ssl-with-android-and-
                  * self-signed-server-certificate
-                 * 
+                 *
                  * WARNING: for anybody else arriving at this answer, this is a dirty, horrible
                  * hack and you must not use it for anything that matters. SSL/TLS without
                  * authentication is worse than no encryption at all - reading and modifying

android/src/main/java/com/tuanpm/RCTMqtt/RCTMqttPackage.java

@@ -10,8 +10,7 @@
 import java.util.Collections;
 import java.util.List;
 
-public class RCTMqttPackage
-        implements ReactPackage
+public class RCTMqttPackage implements ReactPackage
 {
 
     @Override

index.d.ts

@@ -0,0 +1,48 @@
+export type QoS = 0 | 1 | 2;
+
+export class IMqttClient {
+	constructor(options: {
+		clientId: string;
+		uri: string;
+		host?: string;
+		port?: number;
+		protocol?: 'mqtt' | 'tcp' | 'wss' | 'mqtts' | 'ws';
+		tls?: boolean;
+		keepalive?: number;	// seconds
+		protocolLevel?: number;
+		clean?: boolean;
+		auth?: boolean;
+		user?: string;	// only used when auth is true
+		pass?: string;	// only used when auth is true
+		will?: boolean;
+		willMsg?: string;	// only used when will is true
+		willtopic?: string;	// only used when will is true
+		willQos?: QoS;	// only used when will is true
+		willRetainFlag: boolean;	// only used when will is true
+		automaticReconnect?: boolean;	// android only
+	})
+	on(event: 'closed', cb: (msg: string) => void): void
+	on(event: 'error', cb: (msg: string) => void): void
+	on(event: 'message', cb: (msg: {
+		data: string;
+		qos: QoS;
+		retain: boolean;
+		topic: string;
+	}) => void): void
+	on(event: 'connect', cb: (msg: { reconnect: boolean; }) => void): void
+	connect(): void;
+	disconnect(): void;
+	subscribe(topic: string, qos: QoS): void;
+	unsubscribe(topic: string): void;
+	publish(topic: string, payload: string, qos: QoS, retain: boolean): void;
+	reconnect(): void;
+	isConnected(): Promise<boolean>;
+}
+
+declare namespace mqtt {
+	function createClient(options: { uri: string, clientId?: string }): Promise<IMqttClient>;
+	function removeClient(client: IMqttClient): void;
+	function disconnectAll(): void;
+}
+
+export default mqtt;

package.json

@@ -8,7 +8,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/hawkingnetwork/react-native-mqtt.git"
+    "url": "git+https://github.com/SudoPlz/react-native-mqtt.git"
   },
   "keywords": [
     "mqtt",
@@ -35,6 +35,11 @@
       "name": "Tuan PM",
       "email": "[email protected]",
       "url": "http://tuanpm.net"
+    },
+    {
+      "name": "taoqf",
+      "email": "[email protected]",
+      "url": "http://github.com/taoqf"
     }
   ],  
   "license": "MIT",