@edusperoni/nativescript-mqtt - npm Package Compare versions

Comparing version 2.0.0-alpha.0 to 2.0.0-alpha.2

common.d.ts

 import { Message } from './paho-mqtt';
-interface IEvent<T> {
+export { Message };
+export interface IEvent<T> {
     on(handler: {
@@ -10,3 +11,3 @@ (data?: T): void;
 }
-declare class EventHandler<T> implements IEvent<T> {
+export declare class EventHandler<T> implements IEvent<T> {
     private handlers;
@@ -21,3 +22,2 @@ on(handler: {
 }
-declare function guid(): string;
-export { IEvent, EventHandler, guid, Message };
+export declare function guid(): string;

common.js

 import { Message } from './paho-mqtt';
-class EventHandler {
+export { Message };
+export class EventHandler {
     constructor() {
@@ -38,3 +39,3 @@ this.handlers = [];
 // }
-function guid() {
+export function guid() {
     function s4() {
@@ -49,3 +50,2 @@ return Math.floor((1 + Math.random()) * 0x10000)
 ;
-export { EventHandler, guid, Message };
 //# sourceMappingURL=common.js.map

index.d.ts

@@ -1,2 +0,3 @@
-import { IEvent, EventHandler, guid, Message } from './common';
+import { EventHandler, guid, Message } from './common';
+import type { IEvent } from './common';
 export { IEvent, EventHandler, guid, Message };
@@ -3,0 +4,0 @@ import * as MQTT from './paho-mqtt';

index.js

@@ -69,3 +69,3 @@ import { EventHandler, guid, Message } from './common';
         const deferred = this.defer();
-        let mqttConnectOptions = Object.assign(Object.assign({}, connectOptions), { onSuccess: () => {
+        const mqttConnectOptions = Object.assign(Object.assign({}, connectOptions), { onSuccess: () => {
                 this._connectionState = ConnectionState.CONNECTED;
@@ -72,0 +72,0 @@ deferred.resolve();

package.json

 {
   "name": "@edusperoni/nativescript-mqtt",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.2",
   "description": "Add a plugin description",
@@ -5,0 +5,0 @@ "main": "index",

README.md

@@ -1,13 +0,249 @@
-# @edusperoni/nativescript-mqtt
+# NativeScript MQTT 3.1.1 Module ![Build Status](https://travis-ci.org/edusperoni/nativescript-mqtt.svg?branch=master)
 
-```javascript
-ns plugin add @edusperoni/nativescript-mqtt
+This nativescript-mqtt module is a cross-platofrm javascript implementation leveraging native socket support and the open source [MQTT PAHO library link](http://www.eclipse.org/paho). Currently the library only supports the websocket protocol for cross-platform on port 80 or 443 for SSL.
+
+## Usage Sample
+### Create an MQTT Client
+```typescript
+import {MQTTClient, ClientOptions, SubscribeOptions} from "@edusperoni/nativescript-mqtt";
+...
+class MyMQTT {
+    ...
+    mqtt_host: string = "broker.mqttdashboard.com";
+    mqtt_port: number = 8000;
+
+    mqtt_clientOptions: ClientOptions = {
+        host: this.mqtt_host,
+        port: this.mqtt_port
+    };
+
+    mqtt_client: MQTTClient = new MQTTClient(this.mqtt_clientOptions);
+}
 ```
+### Setup Handlers
+```typescript
+class MyMQTT {
+    ...
+    mqtt_topic: string = "sample-topic";
 
-## Usage
+    constructor() {
+        this.setupHandlers();
+    }
 
-// TODO
+    setupHandlers(): void {
+        this.mqtt_client.onConnectionFailure.on((err: any) => {
+            console.log("Connection failed: " + JSON.stringify(err));
+        });
+        this.mqtt_client.onConnectionSuccess.on(() => {
+            console.log("Connected successfully!");
+            this.subscribe();
+        });
+        this.mqtt_client.onConnectionLost.on((err: any) => {
+            console.log("Connection lost: " + JSON.stringify(err));
+        });
+        this.mqtt_client.onMessageArrived.on((message: Message) => {
+            console.log("Message received: " + message.payload);
+        });
+        this.mqtt_client.onMessageDelivered.on((message: Message) => {
+            console.log("Message delivered: " + message.payload);
+        });
+    }
 
-## License
+    subscribe(): void {
+        const opts: SubscribeOptions = {
+            qos: 1
+        };
 
-Apache License Version 2.0
+        this.mqtt_client.subscribe(this.mqtt_topic, opts).then(
+            (params) => console.log(`subscribed to ${this.mqtt_topic} with QoS ${params.grantedQos}`),
+            (err) => console.log("error subscribing")
+        );
+    }
+}
+```
+
+### Connect
+```typescript
+class MyMQTT {
+    ...
+    mqtt_username: string = "";
+    mqtt_password: string = "";
+    mqtt_useSSL: boolean = false;
+    mqtt_cleanSession: boolean = false;
+    mqtt_autoReconnect: boolean = false;
+
+    connect(): void {
+        const connOptions: ConnectionOptions = {
+            cleanSession: this.mqtt_cleanSession,
+            reconnect: this.autoReconnect,
+            useSSL: this.mqtt_useSSL,
+            userName: this.mqtt_username,
+            password: this.mqtt_password
+        }
+        this.mqtt_client.connect(connOptions);
+    }
+}
+```
+And in the template:
+```html
+<Button text="Connect" (tap)="connect()"></Button>
+```
+### Message Object
+```typescript
+class Message {
+    /**
+     * The name of the destination to which the message is to be sent
+     * (for messages about to be sent) or the name of the destination from which the message has been received.
+     * (for messages received by the onMessage function).
+     */
+    destinationName: string;
+
+    /**
+     * If true, this message might be a duplicate of one which has already been received.
+     * This is only set on messages received from the server.
+     */
+    readonly duplicate: boolean;
+
+    /**
+     * The payload.
+     * @return if payload is a string. Return the original otherwise.
+     */
+    readonly payloadBytes: ArrayBuffer | TypedArray;
+
+    /**
+     *  The payload as a string if the payload consists of valid UTF-8 characters.
+     *  @throw {Error} if the payload is not valid UTF-8
+     */
+    readonly payloadString: string;
+
+    /**
+     * The Quality of Service used to deliver the message.
+     * <dl>
+     *     <dt>0 Best effort (default).
+     *     <dt>1 At least once.
+     *     <dt>2 Exactly once.
+     * </dl>
+     *
+     * @default 0
+     */
+    qos: Qos;
+
+    /**
+     * If true, the message is to be retained by the server and delivered to both current and future
+     * subscriptions. If false the server only delivers the message to current subscribers, this is the default
+     * for new Messages. A received message has the retained boolean set to true if the message was published
+     * with the retained boolean set to true and the subscription was made after the message has been published.
+     *
+     * @default false
+     */
+    retained: boolean;
+
+    /**
+     * @param payload The message data to be sent.
+     */
+    constructor(payload: string | ArrayBuffer | TypedArray);
+}
+```
+### A full Angular 2/4 Component and Template Sample
+#### app.component.ts
+```typescript
+import {Component} from "@angular/core";
+import {MQTTClient, ClientOptions, SubscribeOptions, Message} from "@edusperoni/nativescript-mqtt";
+import {Message} from "@edusperoni/nativescript-mqtt/common";
+
+@Component({
+    selector: "ns-app",
+    templateUrl: "app.component.html",
+})
+export class AppComponent {
+    mqtt_host: string = "broker.mqttdashboard.com";
+    mqtt_port: number = 8000;
+    mqtt_useSSL: boolean = false;
+    mqtt_path: string = "/mqtt";
+    mqtt_username: string = "";
+    mqtt_password: string = "";
+    mqtt_topic: string = "ninja-topic";
+    mqtt_cleanSession: boolean = true;
+
+    mqtt_clientOptions: ClientOptions = {
+        host: this.mqtt_host,
+        port: this.mqtt_port,
+        path: this.mqtt_path,
+    };
+
+    mqtt_client: MQTTClient = new MQTTClient(this.mqtt_clientOptions);
+
+    loading: boolean = false;
+
+    constructor() {
+        this.setupHandlers();
+    }
+
+    connect(): void {
+        const connOptions: ConnectionOptions = {
+            cleanSession: this.mqtt_cleanSession,
+            useSSL: this.mqtt_useSSL,
+            userName: this.mqtt_username,
+            password: this.mqtt_password
+        };
+        this.mqtt_client.connect(connOptions).then(() => {
+            console.log("connected");
+        }, (err) => {
+            console.log("connection error: " + err);
+        });
+    }
+
+    sendMessage() {
+        const m = new Message("message content");
+        m.destinationName = this.mqtt_topic;
+        m.qos = 1;
+        m.retained = false;
+        this.mqttClient.publish(m);
+    }
+
+    subscribe(): void {
+        try {
+            const opts: SubscribeOptions = {
+                qos: 0
+            };
+
+            this.mqtt_client.subscribe(this.mqtt_topic, opts);
+        }
+        catch (e) {
+            console.log("Caught error: " + e);
+        }
+    }
+
+    setupHandlers(): void {
+        this.mqtt_client.onConnectionFailure.on((err) => {
+            console.log("Connection failed: " + err);
+        });
+
+        this.mqtt_client.onConnectionSuccess.on(() => {
+            console.log("Connected successfully!");
+            this.subscribe();
+        });
+
+        this.mqtt_client.onConnectionLost.on((err) => {
+            console.log("Connection lost: " + err);
+        });
+
+        this.mqtt_client.onMessageArrived.on((message: Message) => {
+            console.log("Message received: " + message.payloadString);
+        });
+
+        this.mqtt_client.onMessageDelivered.on((message: Message) => {
+            console.log("Message delivered: " + message.payloadString);
+        });
+    }
+}
+```
+#### app.component.html
+```html
+<ActionBar title="My App" class="action-bar"></ActionBar>
+<StackLayout>
+    <Label text="Hello World!"></Label>
+    <Button text="Connect" (tap)="connect()" style="horizontal-align: center;"></Button>
+    <ActivityIndicator busy="{{loading}}"></ActivityIndicator>
+</StackLayout>
+```

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

151876

increased by352.96%

Number of package files

11

increased by22.22%

Lines of code

2972

increased by684.17%

Number of lines in readme file

250

increased by1685.71%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes