homebridge-flume 2.0.0 → 2.0.3

package/CHANGELOG.md

@@ -2,6 +2,26 @@
 
 All notable changes to homebridge-flume will be documented in this file.
 
+## 2.0.3 (2022-05-28)
+
+### Changed
+
+- More fixes and refactoring
+
+## 2.0.2 (2022-05-28)
+
+### Changed
+
+- Bump `node` recommended versions to v14.19.3 or v16.15.0
+- Updated dependencies
+
+## 2.0.1 (2022-04-30)
+
+### Changed
+
+- Bump `axios` to v0.27.2
+- Bump `node` recommended versions to v14.19.1 or v16.15.0
+
 ## 2.0.0 (2022-04-23)
 
 ### Potentially Breaking Changes

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Darrin Thomas & Ben Potter
+Copyright (c) 2022 Darrin Thomas & Ben Potter
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/lib/connection/http.js

@@ -1,7 +1,7 @@
 import axios from 'axios';
 import jwtDecode from 'jwt-decode';
 import platformConsts from '../utils/constants.js';
-import platformFuncs from '../utils/functions.js';
+import { sleep } from '../utils/functions.js';
 import platformLang from '../utils/lang-en.js';
 
 export default class {
@@ -87,7 +87,7 @@ export default class {
       if (err.code && platformConsts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
         this.log.warn('[HTTP obtainToken()] %s [%s].', platformLang.httpRetry, err.code);
-        await platformFuncs.sleep(30000);
+        await sleep(30000);
         return this.obtainToken();
       }
       throw new Error(`[HTTP obtainToken()] ${err.message}`);
@@ -155,7 +155,7 @@ export default class {
       if (err.code && platformConsts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
         this.log.warn('[HTTP renewToken()] %s [%s].', platformLang.httpRetry, err.code);
-        await platformFuncs.sleep(30000);
+        await sleep(30000);
         return this.renewToken();
       }
       throw new Error(`[HTTP renewToken()] ${err.message}`);
@@ -190,7 +190,7 @@ export default class {
       if (err.code && platformConsts.httpRetryCodes.includes(err.code)) {
         // Retry if another attempt could be successful
         this.log.warn('[HTTP getDevices()] %s [%s].', platformLang.httpRetry, err.code);
-        await platformFuncs.sleep(30000);
+        await sleep(30000);
         return this.getDevices();
       }
       throw new Error(`[HTTP getDevices()] ${err.message}`);

package/lib/device/leak-sensor.js

@@ -1,4 +1,4 @@
-import platformFuncs from '../utils/functions.js';
+import { hasProperty } from '../utils/functions.js';
 
 export default class {
   constructor(platform, accessory) {
@@ -6,11 +6,9 @@ export default class {
     this.accessory = accessory;
     this.cusChar = platform.cusChar;
     this.hapChar = platform.api.hap.Characteristic;
-    this.hapErr = platform.api.hap.HapStatusError;
     this.hapServ = platform.api.hap.Service;
     this.log = platform.config.disableDeviceLogging ? () => {} : platform.log;
     this.name = accessory.displayName;
-    this.platform = platform;
     this.refreshInterval = platform.config.refreshInterval;
 
     // Add the leak sensor service if it doesn't exist already
@@ -36,7 +34,7 @@ export default class {
   externalUpdate(params) {
     // Check the data for leak detection
     if (
-      platformFuncs.hasProperty(params.leakInfo, 'active')
+      hasProperty(params.leakInfo, 'active')
       && params.leakInfo.active !== this.cacheLeak
     ) {
       this.cacheLeak = params.leakInfo.active;
@@ -46,7 +44,7 @@ export default class {
 
     // Check the data for battery level, cacheBatt is true for OK and false for LOW
     if (
-      platformFuncs.hasProperty(params.devInfo, 'battery_level')
+      hasProperty(params.devInfo, 'battery_level')
       && (params.devInfo.battery_level !== 'low') !== this.cacheBatt
     ) {
       this.cacheBatt = params.devInfo.battery_level !== 'low';
@@ -56,7 +54,7 @@ export default class {
 
     // Check the data for connectivity, cacheStatus is true for OK and false for NOT CONNECTED
     if (
-      platformFuncs.hasProperty(params.devInfo, 'connected')
+      hasProperty(params.devInfo, 'connected')
       && params.devInfo.connected !== this.cacheStatus
     ) {
       this.cacheStatus = params.devInfo.connected;
@@ -69,7 +67,7 @@ export default class {
       if (
         params.waterInfo.today
         && params.waterInfo.today[0]
-        && platformFuncs.hasProperty(params.waterInfo.today[0], 'value')
+        && hasProperty(params.waterInfo.today[0], 'value')
       ) {
         this.leakService.updateCharacteristic(
           this.cusChar.TodayUsage,
@@ -79,7 +77,7 @@ export default class {
       if (
         params.waterInfo.month
         && params.waterInfo.month[0]
-        && platformFuncs.hasProperty(params.waterInfo.month[0], 'value')
+        && hasProperty(params.waterInfo.month[0], 'value')
       ) {
         this.leakService.updateCharacteristic(
           this.cusChar.MonthUsage,
@@ -89,7 +87,7 @@ export default class {
       if (
         params.waterInfo.prevMonth
         && params.waterInfo.prevMonth[0]
-        && platformFuncs.hasProperty(params.waterInfo.prevMonth[0], 'value')
+        && hasProperty(params.waterInfo.prevMonth[0], 'value')
       ) {
         this.leakService.updateCharacteristic(
           this.cusChar.PrevMonthUsage,

package/lib/platform.js

@@ -1,19 +1,16 @@
-// Packages and constant variables for this class
 import { createRequire } from 'module';
 import httpClient from './connection/http.js';
 import deviceLeakSensor from './device/leak-sensor.js';
 import platformConsts from './utils/constants.js';
 import platformChars from './utils/custom-chars.js';
-import platformFuncs from './utils/functions.js';
+import { parseError } from './utils/functions.js';
 import platformLang from './utils/lang-en.js';
 
 const require = createRequire(import.meta.url);
 const plugin = require('../package.json');
 
-// Create the platform class
 export default class {
   constructor(log, config, api) {
-    // Don't load the plugin if these aren't accessible for any reason
     if (!log || !api) {
       return;
     }
@@ -26,8 +23,8 @@ export default class {
       // Configuration objects for accessories
       this.devicesInHB = new Map();
 
-      // Make sure user is running Homebridge v1.3 or above
-      if (!api?.versionGreaterOrEqual?.('1.4.0')) {
+      // Make sure user is running Homebridge v1.4 or above
+      if (!api?.versionGreaterOrEqual('1.4.0')) {
         throw new Error(platformLang.hbVersionFail);
       }
 
@@ -56,7 +53,7 @@ export default class {
       this.api.on('shutdown', () => this.pluginShutdown());
     } catch (err) {
       // Catch any errors during initialisation
-      const eText = platformFuncs.parseError(err, [platformLang.hbVersionFail, platformLang.pluginNotConf]);
+      const eText = parseError(err, [platformLang.hbVersionFail, platformLang.pluginNotConf]);
       log.warn('***** %s. *****', platformLang.disabling);
       log.warn('***** %s. *****', eText);
     }
@@ -104,7 +101,6 @@ export default class {
           break;
         case 'name':
         case 'platform':
-        case 'plugin_map':
           break;
         case 'refreshInterval': {
           if (typeof val === 'string') {
@@ -132,15 +128,15 @@ export default class {
   async pluginSetup() {
     // Plugin has finished initialising so now onto setup
     try {
+      // Log that the plugin initialisation has been successful
+      this.log('%s.', platformLang.initialised);
+
       // If the user has disabled the plugin then remove all accessories
       if (this.config.disablePlugin) {
         this.devicesInHB.forEach((accessory) => this.removeAccessory(accessory));
         throw new Error(platformLang.disabled);
       }
 
-      // Log that the plugin initialisation has been successful
-      this.log('%s.', platformLang.initialised);
-
       // Ensure username and password have been provided
       if (
         !this.config.username
@@ -193,7 +189,7 @@ export default class {
       this.log('%s. %s', platformLang.complete, platformLang.zWelcome[randIndex]);
     } catch (err) {
       // Catch any errors during setup
-      const eText = platformFuncs.parseError(err, [
+      const eText = parseError(err, [
         platformLang.noCreds,
         platformLang.noDevices,
         platformLang.disabled,
@@ -232,14 +228,14 @@ export default class {
           toReturn.leakInfo = await this.httpClient.getLeakInfo(accessory.context.deviceId);
           accessory.control.externalUpdate(toReturn);
         } catch (err) {
-          const eText = platformFuncs.parseError(err);
+          const eText = parseError(err);
           this.log.warn('[%s] %s %s.', accessory.displayName, platformLang.devNotRef, eText);
         }
         this.counter += 1;
       });
     } catch (err) {
       // Catch any errors performing the sync
-      const eText = platformFuncs.parseError(err, []);
+      const eText = parseError(err, []);
       this.log.warn('%s %s.', platformLang.syncFailed, eText);
     }
   }
@@ -278,7 +274,7 @@ export default class {
       this.log('[%s] %s [%s].', accessory.displayName, platformLang.devInit, device.id);
     } catch (err) {
       // Catch any errors during device initialisation
-      const eText = platformFuncs.parseError(err, [platformLang.accNotFound]);
+      const eText = parseError(err, [platformLang.accNotFound]);
       this.log.warn('[%s] %s %s.', device.id, platformLang.devNotInit, eText);
     }
   }
@@ -303,7 +299,7 @@ export default class {
       return accessory;
     } catch (err) {
       // Catch any errors during add
-      const eText = platformFuncs.parseError(err);
+      const eText = parseError(err);
       this.log.warn('[%s] %s %s.', platformLang.brand, platformLang.devNotAdd, eText);
       return false;
     }
@@ -322,7 +318,7 @@ export default class {
       this.log('[%s] %s.', accessory.displayName, platformLang.devRemove);
     } catch (err) {
       // Catch any errors during remove
-      const eText = platformFuncs.parseError(err);
+      const eText = parseError(err);
       const name = accessory.displayName;
       this.log.warn('[%s] %s %s.', name, platformLang.devNotRemove, eText);
     }

package/lib/utils/functions.js

@@ -1,27 +1,18 @@
-export default {
-  hasProperty: (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop),
+const hasProperty = (obj, prop) => Object.prototype.hasOwnProperty.call(obj, prop);
 
-  sleep: (ms) => new Promise((resolve) => {
-    setTimeout(resolve, ms);
-  }),
-
-  parseError: (err, hideStack = []) => {
-    let toReturn = err.message;
-    if (err.stack && err.stack.length > 0 && !hideStack.includes(err.message)) {
-      const stack = err.stack.split('\n');
-      if (stack[1]) {
-        toReturn += stack[1].replace('   ', '');
-      }
-    }
-    return toReturn;
-  },
-
-  generateRandomString: (length) => {
-    const chars = 'abcdefghijklmnopqrstuvwxyz0123456789';
-    let nonce = '';
-    while (nonce.length < length) {
-      nonce += chars.charAt(Math.floor(Math.random() * chars.length));
+const parseError = (err, hideStack = []) => {
+  let toReturn = err.message;
+  if (err?.stack.length > 0 && !hideStack.includes(err.message)) {
+    const stack = err.stack.split('\n');
+    if (stack[1]) {
+      toReturn += stack[1].replace('   ', '');
     }
-    return nonce;
-  },
+  }
+  return toReturn;
 };
+
+const sleep = (ms) => new Promise((resolve) => {
+  setTimeout(resolve, ms);
+});
+
+export { hasProperty, parseError, sleep };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-flume",
   "alias": "Flume",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "author": {
     "name": "Ben Potter",
     "email": "bwp91@icloud.com"
@@ -29,7 +29,7 @@
   },
   "engines": {
     "homebridge": "^1.4.0",
-    "node": "^14.19.0 || ^16.14.0"
+    "node": "^14.19.3 || ^16.15.0"
   },
   "repository": {
     "type": "git",
@@ -58,13 +58,13 @@
   ],
   "dependencies": {
     "@homebridge/plugin-ui-utils": "^0.0.19",
-    "axios": "^0.26.1",
+    "axios": "^0.27.2",
     "jwt-decode": "^3.1.2"
   },
   "devDependencies": {
     "eslint-config-airbnb": "^19.0.4",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-sort-exports": "^0.6.0",
-    "eslint": "^8.14.0"
+    "eslint": "^8.16.0"
   }
 }