sinricpro 2.2.8 → 2.3.1

package/.github/workflows/npm-publish.yml

@@ -0,0 +1,32 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+      - run: npm ci 
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/README.md

@@ -1,191 +1,15 @@
-# SinricPro (NodeJs-SDK)
-
-[![](https://img.shields.io/npm/v/sinricpro)](https://www.npmjs.com/package/sinricpro)
-[![](https://img.shields.io/npm/dependency-version/sinricpro/dev/eslint)](https://www.npmjs.com/package/sinricpro)
-[![](https://img.shields.io/bundlephobia/min/sinricpro)](https://www.npmjs.com/package/sinricpro)
-[![](https://img.shields.io/github/languages/code-size/sinricpro/nodejs-sdk)](https://www.npmjs.com/package/sinricpro)
-
-### Installation
-
-```
-npm install sinricpro
-```
-
-### Dependencies
-
-- [websockets](https://www.npmjs.com/package/ws)
-
-- [crypto](https://nodejs.org/api/crypto.html)
-
-- [uuid](https://www.npmjs.com/package/uuid)
-
-- [dgram]()
-
-- [rxjs](https://www.npmjs.com/package/rxjs)
-
-### Basic example
-
-```javascript 1.8
-const {
-  SinricPro,
-  SinricProActions,
-  raiseEvent,
-  eventNames,
-  SinricProUdp
-} = require("../index"); // Use require('sinricpro'); if you are using NPM
-
-const appKey = ""; // d89f1***-****-****-****-************
-const secretKey = ""; // f44d1d31-1c19-****-****-9bc96c34b5bb-d19f42dd-****-****-****-************
-const device1 = ""; // 5d7e7d96069e275ea9******
-const device2 = ""; // 5d80ac5713fa175e99******
-const deviceId = [device1, device2];
-
-function setPowerState(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-const callbacks = {
-  setPowerState
-};
-
-const sinricpro = new SinricPro(appKey, deviceId, secretKey, true);
-
-SinricProActions(sinricpro, callbacks);
-
-setInterval(() => {
-  raiseEvent(sinricpro, eventNames.powerState, device1, { state: "On" });
-}, 2000);
-
-// https://github.com/sinricpro/nodejs-sdk/blob/master/examples/simple-example/simple-example.js
-```
-
-### Advanced example
-
-#### Add a credential file into your root folder (credential.js)
-
-```javascript 1.8
-const credential = {
-  appkey: "",
-  secretKey: ""
-};
-
-const deviceIds = {
-  deviceId1: "",
-  deviceId2: "",
-  deviceId3: ""
-};
-
-// No need to edit the code below
-
-let deviceIdT = [];
-
-for (let key in deviceIds) {
-  if (deviceIds.hasOwnProperty(key)) {
-    deviceIdT.push(deviceIds[key]);
-  }
-}
-
-module.exports = {
-  appKey: credential.appkey,
-  secretKey: credential.secretKey,
-  deviceId: deviceIdT
-};
-```
-
-#### Example (app.js)
-
-```javascript
-const { appKey, deviceId, secretKey } = require("../credentials");
-const {
-  SinricPro,
-  SinricProActions,
-  raiseEvent,
-  eventNames,
-  SinricProUdp
-} = require("../index");
-
-function setPowerState(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-function setPowerLevel(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function adjustPowerLevel(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setColor(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setRangeValue(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-function setLockState(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setBrightness(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setVolume(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function adjustVolume(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-function setMute(deviceid, data) {
-  console.log(deviceid, data);
-  return true;
-}
-
-const callbacks = {
-  setPowerState,
-  setPowerLevel,
-  adjustPowerLevel,
-  setColor,
-  setRangeValue,
-  setLockState,
-  setBrightness,
-  setVolume,
-  adjustVolume,
-  setMute
-};
-
-const sinricpro = new SinricPro(appKey, deviceId, secretKey, true);
-SinricProActions(sinricpro, callbacks);
-
-setInterval(() => {
-  // raiseEvent(sinricpro, eventNames.powerState, 'deviceId', { state: 'On' });
-  // raiseEvent(sinricpro, eventNames.setBrightness, 'deviceId', { brightness: 44 });
-  // raiseEvent(sinricpro, eventNames.powerLevel, 'deviceId', { powerLevel: 44 });
-  // raiseEvent(sinricpro, eventNames.color, 'DeviceId', { color: { b: 0, g: 0, r: 0 } });
-  // raiseEvent(sinricpro, eventNames.colorTemperature, 'Deviceid', { colorTemperature: 8 });
-  // raiseEvent(sinricpro, eventNames.doorBell, 'DeviceId', { state: 'pressed' });
-  // raiseEvent(sinricpro, eventNames.thermostatMode, 'DeviceId', { thermostatMode: 'AUTO' });
-  // raiseEvent(sinricpro, eventNames.rangvalue, 'DeviceId', { rangvalue: 3 });
-  // raiseEvent(sinricpro, eventNames.motion, 'DeviceId', { state: 'detected' });
-  // raiseEvent(sinricpro, eventNames.contact, 'DeviceId', { state: 'closed' });
-  // raiseEvent(sinricpro, eventNames.setVolume, 'DeviceId', { volume: 29 });
-  // raiseEvent(sinricpro, eventNames.selectInput, 'DeviceId', { input: 'HDMI' });
-  // raiseEvent(sinricpro, eventNames.media, 'DeviceId', { control: 'FastForward' });
-  // raiseEvent(sinricpro, eventNames.channel, 'DeviceId', { channel: { name: 'HBO' } });
-  // raiseEvent(sinricpro, eventNames.mode, 'DeviceId', { mode: 'MOVIE' });
-  // raiseEvent(sinricpro, eventNames.lock, 'DeviceId', { state: 'LOCKED' });
-  // raiseEvent(sinricpro, eventNames.mute, 'DeviceId', { mute: true });
-}, 2000);
-```
+# SinricPro (NodeJs-SDK)
+
+[![](https://img.shields.io/npm/v/sinricpro)](https://www.npmjs.com/package/sinricpro)
+[![](https://img.shields.io/npm/dependency-version/sinricpro/dev/eslint)](https://www.npmjs.com/package/sinricpro)
+[![](https://img.shields.io/bundlephobia/min/sinricpro)](https://www.npmjs.com/package/sinricpro)
+[![](https://img.shields.io/github/languages/code-size/sinricpro/nodejs-sdk)](https://www.npmjs.com/package/sinricpro)
+
+### Installation
+
+```
+npm install sinricpro
+```
+
+### Examples
+Check the examples [here](https://github.com/sinricpro/nodejs-sdk/tree/master/examples) 

package/lib/contorllers/tv_controller.js

@@ -55,7 +55,7 @@ const Media = (payload, callbacks) => {
 };
 
 const ChangeChannel = (payload, callbacks) => {
-  const channel = payload.value.channel.name ?? payload.value.channel.number;
+  const channel = payload.value.channel.name || payload.value.channel.number;
   const resp = callbacks.changeChannel(payload.deviceId, channel);
   return new Promise((resolve, reject) => {
     if (channel && resp) resolve(payload.value);

package/lib/sinrcpro.js

@@ -8,20 +8,19 @@
 const Websocket = require("ws");
 const rx = require("rxjs");
 
-const callbackHandler = require("./cbhandler");
-const { raiseEvent, eventNames } = require("./events/event_handler");
-const SinricProUdp = require("./sinricproudp");
-
-const VERSION = "2.2.2";
+const callbackHandler = require('./cbhandler');
+const { raiseEvent, eventNames } = require('./events/event_handler');
+const SinricProUdp = require('./sinricproudp');
+const sdkVersion = require('./../package.json').version;
 
 class SinricPro extends Websocket {
   constructor(appkey, deviceids, secretKey, restoreStates) {
     super("ws://ws.sinric.pro", {
       headers: {
         appkey,
-        deviceids: deviceids.join(";"),
-        platform: "nodejs",
-        version: VERSION,
+        deviceids: deviceids.join(';'),
+        platform: 'nodejs',
+        sdkversion: sdkVersion,
         restoredevicestates: restoreStates,
       },
     });
@@ -37,9 +36,9 @@ class SinricPro extends Websocket {
   }
 }
 
-const SinricProActions = (client, callbacks) => {
-  client.on("open", () => {
-    console.log("Connected to Sinric Pro");
+const startSinricPro = (client, callbacks) => {
+  client.on('open', () => {
+    console.log('Connected to Sinric Pro');
   });
 
   client.on("message", (data) => {
@@ -73,9 +72,9 @@ const SinricProActions = (client, callbacks) => {
   });
 };
 
-const SinricProActionsObservable = (client, callbacks) => new rx.Observable((observer) => {
-  client.on("open", () => {
-    console.log("Connected");
+const startSinricProObservable = (client, callbacks) => new rx.Observable((observer) => {
+  client.on('open', () => {
+    console.log('Connected');
   });
 
   client.on("message", (data) => {
@@ -114,8 +113,8 @@ const SinricProActionsObservable = (client, callbacks) => new rx.Observable((obs
 
 module.exports = {
   SinricPro,
-  SinricProActions,
-  SinricProActionsObservable,
+  startSinricPro,
+  startSinricProObservable,
   raiseEvent,
   eventNames,
   SinricProUdp,

package/lib/storage.js

@@ -15,7 +15,7 @@ let data = {
   lockState: '',
   thermostat: {
     mode: '',
-    temperature: 0
+    temperature: 0,
   },
   rangeValue: 0,
   volume: 0,

package/package.json

@@ -1,42 +1,38 @@
-{
-  "name": "sinricpro",
-  "version": "2.2.8",
-  "description": "Sinric Pro Nodejs SDK",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "lint": "eslint --fix ./"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/sinricpro/nodejs-sdk.git"
-  },
-  "author": "Dhanush",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/sinricpro/nodejs-sdk/issues"
-  },
-  "homepage": "https://github.com/sinricpro/nodejs-sdk#readme",
-  "dependencies": {
-    "dgram": "^1.0.1",
-    "leaky-bucket": "^3.0.4",
-    "process": "^0.11.10",
-    "rate-limiter-flexible": "^2.2.1",
-    "rxjs": "^6.6.3",
-    "uuid": "^3.3.3",
-    "ws": "^7.4.2"
-  },
-  "keywords": [
-    "sinricpro",
-    "sinric"
-  ],
-  "devDependencies": {
-    "eslint": "^6.8.0",
-    "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-config-standard": "^14.1.0",
-    "eslint-plugin-import": "^2.18.2",
-    "eslint-plugin-node": "^10.0.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "eslint-plugin-standard": "^4.0.1"
-  }
-}
+{
+  "name": "sinricpro",
+  "version": "2.3.1",
+  "description": "Sinric Pro Nodejs SDK",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sinricpro/nodejs-sdk.git"
+  },
+  "author": "Dhanush",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/sinricpro/nodejs-sdk/issues"
+  },
+  "homepage": "https://github.com/sinricpro/nodejs-sdk#readme",
+  "dependencies": {
+    "dgram": "^1.0.1",
+    "leaky-bucket": "^4.1.4",
+    "process": "^0.11.10",
+    "rate-limiter-flexible": "^2.3.6",
+    "rxjs": "^6.6.3",
+    "uuid": "^3.3.3",
+    "ws": "^8.5.0"
+  },
+  "keywords": [
+    "sinricpro",
+    "sinric"
+  ],
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-config-airbnb-base": "^14.0.0",
+    "eslint-config-standard": "^14.1.0",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-node": "^10.0.0",
+    "eslint-plugin-promise": "^4.2.1",
+    "eslint-plugin-standard": "^4.0.1"
+  }
+}