sinricpro 2.3.1 → 2.6.1

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

@@ -1,32 +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}}
+# 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/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [2.6.1]
+
+### Features
+
+* **Custom device types support**
+* **SR_DEBUG to support debug logs**

package/README.md

@@ -1,15 +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
-```
-
-### Examples
-Check the examples [here](https://github.com/sinricpro/nodejs-sdk/tree/master/examples) 
+# 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/cbhandler.js

@@ -15,16 +15,18 @@ const { RangeValue, RangeValueAdjust } = require('./contorllers/range_value_cont
 const { Volume, VolumeAdjust, Mute } = require('./contorllers/tv_controller');
 const { ChangeChannel, SkipChannel, Media } = require('./contorllers/tv_controller');
 const { Input } = require('./contorllers/tv_controller');
-const { Bands, Mode, BandReset } = require('./contorllers/speaker_controller');
+const { Bands, BandReset } = require('./contorllers/speaker_controller');
 const { AdjustBands } = require('./contorllers/speaker_controller');
+const { ToggleState } = require('./contorllers/toggle_state_controller');
+const { Mode } = require('./contorllers/mode_controller');
 
-const jsonResponse = (client, defaultPayload, dValue) => {
+const jsonResponse = (client, defaultPayload, payloadValue, instanceId) => {
   const header = {
     payloadVersion: 2,
     signatureVersion: 1,
   };
 
-  const payload = {
+  let payload = {
     action: defaultPayload.action,
     clientId: defaultPayload.clientId,
     createdAt: Math.floor(new Date() / 1000),
@@ -33,9 +35,11 @@ const jsonResponse = (client, defaultPayload, dValue) => {
     replyToken: defaultPayload.replyToken,
     success: true,
     type: 'response',
-    value: dValue,
+    value: payloadValue,
   };
 
+  if(instanceId) payload.instanceId = instanceId;
+ 
   const signature = {
     HMAC: getSignature(client, JSON.stringify(payload)),
   };
@@ -49,144 +53,150 @@ const handlePayload = (client, payload, signature, callbacks) => verifySignature
       return powerState(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setPowerLevel') {
       return powerLevel(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'adjustPowerLevel') {
       return powerLevelAdjust(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setBrightness') {
       return Brightness(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'adjustBrightness') {
       return BrightnessAdjust(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setColor') {
       return Color(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setColorTemperature') {
       return ColorTemperature(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setThermostatMode') {
       return ThermoStatMode(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'targetTemperature') {
       return ThermoStatTemperature(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setRangeValue') {
       return RangeValue(payload, callbacks)
-        .then((value) => jsonResponse(client, payload, value))
+        .then(([value, instanceId]) => jsonResponse(client, payload, value, instanceId))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'adjustRangeValue') {
       return RangeValueAdjust(payload, callbacks)
-        .then((value) => jsonResponse(client, payload, value))
+        .then(([value, instanceId]) => jsonResponse(client, payload, value, instanceId))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setVolume') {
       return Volume(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'adjustVolume') {
       return VolumeAdjust(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'selectInput') {
       return Input(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'mediaControl') {
       return Media(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'changeChannel') {
       return ChangeChannel(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'skipChannels') {
       return SkipChannel(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setBands') {
       return Bands(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'adjustBands') {
       return AdjustBands(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'resetBands') {
       return BandReset(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setMode') {
       return Mode(payload, callbacks)
-        .then((value) => jsonResponse(client, payload, value))
+        .then(([value, instanceId]) => jsonResponse(client, payload, value, instanceId))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setLockState') {
       return Lock(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     } else if (action === 'setMute') {
       return Mute(payload, callbacks)
         .then((value) => jsonResponse(client, payload, value))
         .catch((err) => {
-          console.log(err.message);
+          if (process.env.SR_DEBUG) console.log(err.message);
+        });
+    } else if (action === 'setToggleState') {
+      return ToggleState(payload, callbacks)
+        .then(([value, instanceId]) => jsonResponse(client, payload, value, instanceId))
+        .catch((err) => {
+          if (process.env.SR_DEBUG) console.log(err.message);
         });
     }
     return {};
   })
   .catch((err) => {
-    console.log(err.message);
+    console.error(err.message);
   });
 module.exports = handlePayload;

package/lib/contorllers/mode_controller.js

@@ -0,0 +1,21 @@
+/*
+ *  Copyright (c) 2019 Sinric. All rights reserved.
+ *  Licensed under Creative Commons Attribution-Share Alike (CC BY-SA)
+ *
+ *  This file is part of the Sinric Pro (https://github.com/sinricpro/)
+ */
+
+const sinricData = require('../storage');
+ 
+const Mode = (payload, callbacks) => {
+  const resp = callbacks.setMode(payload.deviceId, payload.value.mode, payload.instanceId);
+  
+  return new Promise((resolve, reject) => {
+    if (resp) resolve([payload.value, payload.instanceId]);
+    else reject(new Error('Mode undefined'));
+  });
+};
+
+module.exports = {
+  Mode
+};

package/lib/contorllers/range_value_controller.js

@@ -1,4 +1,3 @@
-
 /*
  *  Copyright (c) 2019 Sinric. All rights reserved.
  *  Licensed under Creative Commons Attribution-Share Alike (CC BY-SA)
@@ -10,20 +9,25 @@ const sinricProData = require('../storage');
 
 const RangeValue = (payload, callbacks) => {
   sinricProData.rangeValue = payload.value.rangeValue;
-  const resp = callbacks.setRangeValue(payload.deviceId, sinricProData.rangeValue);
+  
+  const resp = callbacks.setRangeValue(payload.deviceId, sinricProData.rangeValue, payload.instanceId);
+
   return new Promise((resolve, reject) => {
-    if (payload.value.rangeValue && resp) resolve(payload.value);
+    if (payload.value.rangeValue !== undefined && resp) resolve([payload.value, payload.instanceId]);
     else reject(new Error('RangeValue is undefined'));
   });
 };
 
 const RangeValueAdjust = (payload, callbacks) => {
-  sinricProData.rangeValue += payload.value.rangeValueDelta;
+  sinricProData.rangeValue += payload.value.rangeValueDelta; 
+
   if (sinricProData.rangeValue < 0) sinricProData.rangeValue = 0;
   else if (sinricProData.rangeValue > 100) sinricProData.rangeValue = 100;
-  const resp = callbacks.adjustRangeValue(payload.deviceId, sinricProData.rangeValue);
+
+  const resp = callbacks.adjustRangeValue(payload.deviceId, sinricProData.rangeValue, payload.instanceId);
+
   return new Promise((resolve, reject) => {
-    if (payload.value.rangeValueDelta && resp) resolve({ rangeValue: sinricProData.rangeValue });
+    if (payload.value.rangeValueDelta && resp) resolve([{ rangeValue: sinricProData.rangeValue }, payload.instanceId]);
     else reject(new Error('RangeValue undefined'));
   });
 };

package/lib/contorllers/speaker_controller.js

@@ -18,14 +18,6 @@ const Bands = (payload, callbacks) => {
   });
 };
 
-const Mode = (payload, callbacks) => {
-  const resp = callbacks.setMode(payload.deviceId, payload.value.mode);
-  return new Promise((resolve, reject) => {
-    if (resp) resolve(payload.value);
-    else reject(new Error('Mode undefined'));
-  });
-};
-
 const BandReset = (payload, callbacks) => {
   const resp = callbacks.resetBands(payload.deviceId, payload.value);
   return new Promise((resolve, reject) => {
@@ -45,6 +37,7 @@ const AdjustBands = (payload, callbacks) => {
     else reject(new Error('Rest Bands Failed'));
   });
 };
+
 module.exports = {
-  Bands, Mode, BandReset, AdjustBands,
+  Bands, BandReset, AdjustBands,
 };

package/lib/contorllers/toggle_state_controller.js

@@ -0,0 +1,19 @@
+/*
+ *  Copyright (c) 2019 Sinric. All rights reserved.
+ *  Licensed under Creative Commons Attribution-Share Alike (CC BY-SA)
+ *
+ *  This file is part of the Sinric Pro (https://github.com/sinricpro/)
+ */
+
+const ToggleState = (payload, callbacks) => {
+    const resp = callbacks.setToggleState(payload.deviceId, payload.value.state, payload.instanceId);
+
+    return new Promise((resolve, reject) => {
+        if (resp) resolve([payload.value, payload.instanceId]);
+        else reject(new Error('Toggle State Error'));
+    });
+};
+
+module.exports = {
+    ToggleState
+};

package/lib/events/event_handler.js

@@ -86,7 +86,9 @@ const raiseEvent = async (client, eventName, deviceId, value) => {
   if (actionArr.includes(eventName)) {
     try {
       await burstyLimiter.consume('queue');
-      client.send(JSON.stringify(getJson(client, eventName, deviceId, value)));
+      const request = JSON.stringify(getJson(client, eventName, deviceId, value));
+      if (process.env.SR_DEBUG) console.log('>> %j', request);
+      client.send(request);
     } catch (rlRejected) {
       console.log('Too many events!');
     }

package/lib/sinrcpro.js

@@ -42,12 +42,14 @@ const startSinricPro = (client, callbacks) => {
   });
 
   client.on("message", (data) => {
+    if (process.env.SR_DEBUG) console.log('<< %s', data.toString());
+
     const parsedData = JSON.parse(data);
 
     if (parsedData.timestamp) {
       if (Math.floor(new Date() / 1000) - parsedData.timestamp > 60000) {
-        console.log("Timestamp is not in sync");
-      } else console.log("TimeStamp is in sync");
+        if (process.env.SR_DEBUG) console.log("Timestamp is not in sync");
+      } else if (process.env.SR_DEBUG) console.log("TimeStamp is in sync");
     } else {
       const response = callbackHandler(
         client,
@@ -57,7 +59,9 @@ const startSinricPro = (client, callbacks) => {
       );
       response
         .then((res) => {
-          client.send(JSON.stringify(res));
+          const reqResponse = JSON.stringify(res);
+          if (process.env.SR_DEBUG) console.log('>> %s', reqResponse);
+          client.send(reqResponse);
         })
         .catch((err) => {
           console.log(err.message);
@@ -74,15 +78,15 @@ const startSinricPro = (client, callbacks) => {
 
 const startSinricProObservable = (client, callbacks) => new rx.Observable((observer) => {
   client.on('open', () => {
-    console.log('Connected');
+    console.log('Connected to Sinric Pro');
   });
 
   client.on("message", (data) => {
     const parsedData = JSON.parse(data);
     if (parsedData.timestamp) {
       if (Math.floor(new Date() / 1000) - parsedData.timestamp > 60000) {
-        console.log("Timestamp is not in sync");
-      } else console.log("TimeStamp is in sync");
+        if (process.env.SR_DEBUG) console.log("Timestamp is not in sync");
+      } else if (process.env.SR_DEBUG) console.log("TimeStamp is in sync");
     } else {
       const response = callbackHandler(
         client,
@@ -93,7 +97,9 @@ const startSinricProObservable = (client, callbacks) => new rx.Observable((obser
       response
         .then((res) => {
           observer.next(res);
-          client.send(JSON.stringify(res));
+          const reqResponse = JSON.stringify(res);
+          if (process.env.SR_DEBUG) console.log('>> %s', reqResponse);
+          client.send(reqResponse);
         })
         .catch((err) => {
           observer.error(err.message);

package/notes-to-aruna.txt

@@ -0,0 +1,6 @@
+Switch to Login module (by typing "how-to-npm" on command line)
+Type "npm adduser" to login
+Type "npm whoami" to confirm if logged in
+Switch back to the package at which you are getting error(my case it was Publish Again)
+Type "npm publish"
+Done

package/package.json

@@ -1,38 +1,37 @@
-{
-  "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"
-  }
-}
+{
+  "name": "sinricpro",
+  "version": "2.6.1",
+  "description": "Sinric Pro Nodejs SDK",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sinricpro/nodejs-sdk.git"
+  },
+  "author": "SinricPro",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/sinricpro/nodejs-sdk/issues"
+  },
+  "homepage": "https://github.com/sinricpro/nodejs-sdk#readme",
+  "dependencies": {
+    "dgram": "^1.0.1",
+    "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": "^8.9.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"
+  }
+}