4.0.0 (#9)

* Cam Profiles & Levels, rmDirSync, Versions * Various * Update README.md * Update README.md * Update README.md * Update README.md * callback object * Update HAPRouter.js * Update Bridge.js * Remove Matcher * Formatting * Update package.json * HTTP Auth for HTTP route * Update CHANGELOG.md * Change Log * Bridge switch * Module * Update RouteModule.md * Local * Update CHANGELOG.md * TV Icon * Update HAPRouter.js
marcus-j-davies · Jun 19, 2022 · bc30851 · bc30851
1 parent eb9bfa5
commit bc30851
Show file tree

Hide file tree

Showing 44 changed files with 1,661 additions and 222 deletions.
diff --git a/@marcus-j-davies/haprouter-route-console/index.js b/@marcus-j-davies/haprouter-route-console/index.js
@@ -9,7 +9,7 @@ const Icon = 'icon.png';
 class ConsoleClass {
 	/* Constructor */
 	constructor(route, statusnotify) {
-		statusnotify(true);
+		statusnotify({ success: true });
 	}
 }
 

diff --git a/@marcus-j-davies/haprouter-route-console/package.json b/@marcus-j-davies/haprouter-route-console/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@marcus-j-davies/haprouter-route-console",
   "description": "The stock HAP Router CONSOLE route",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "main": "index.js",
   "author": {
     "name": "Marcus Davies",

diff --git a/@marcus-j-davies/haprouter-route-file/index.js b/@marcus-j-davies/haprouter-route-file/index.js
@@ -18,7 +18,7 @@ class File {
 	/* Constructor */
 	constructor(route, statusnotify) {
 		this.Route = route;
-		statusnotify(true);
+		statusnotify({ success: true });
 		this.StatusNotify = statusnotify;
 	}
 }
@@ -35,7 +35,8 @@ File.prototype.process = async function (payload) {
 		try {
 			fs.mkdirSync(Directory, { recursive: true });
 		} catch (err) {
-			this.StatusNotify(false, err.message);
+			this.StatusNotify({ success: false, message: err.message });
+
 			return;
 		}
 	}
@@ -47,9 +48,9 @@ File.prototype.process = async function (payload) {
 
 	try {
 		fs.writeFileSync(_Path, JSONs, 'utf8');
-		this.StatusNotify(true);
+		this.StatusNotify({ success: true });
 	} catch (err) {
-		this.StatusNotify(false, err.message);
+		this.StatusNotify({ success: false, message: err.message });
 	}
 };
 

diff --git a/@marcus-j-davies/haprouter-route-file/package.json b/@marcus-j-davies/haprouter-route-file/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@marcus-j-davies/haprouter-route-file",
   "description": "The stock HAP Router FILE route",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "main": "index.js",
   "author": {
     "name": "Marcus Davies",

diff --git a/@marcus-j-davies/haprouter-route-http/index.js b/@marcus-j-davies/haprouter-route-http/index.js
@@ -5,6 +5,15 @@ const Params = [
 	{
 		id: 'destinationURI',
 		label: 'HTTP URI'
+	},
+	{
+		id: 'username',
+		label: 'HTTP Username (optional)'
+	},
+	{
+		id: 'password',
+		label: 'HTTP Password (optional)',
+		type: 'password'
 	}
 ];
 
@@ -18,7 +27,7 @@ class HTTPRoute {
 	constructor(route, statusnotify) {
 		this.StatusNotify = statusnotify;
 		this.Route = route;
-		statusnotify(true);
+		statusnotify({ success: true });
 	}
 }
 
@@ -36,12 +45,23 @@ HTTPRoute.prototype.process = async function (payload) {
 		data: payload
 	};
 
+	if (
+		this.Route.username !== undefined &&
+		this.Route.username.length > 0 &&
+		this.Route.password !== undefined &&
+		this.Route.password.length > 0
+	) {
+		CFG.auth = {};
+		CFG.auth.username = this.Route.username;
+		CFG.auth.password = this.Route.password;
+	}
+
 	try {
 		await axios.request(CFG);
-		this.StatusNotify(true);
+		this.StatusNotify({ success: true });
 	} catch (err) {
 		if (err) {
-			this.StatusNotify(false, err.message);
+			this.StatusNotify({ success: false, message: err.message });
 		}
 	}
 };

diff --git a/@marcus-j-davies/haprouter-route-http/package.json b/@marcus-j-davies/haprouter-route-http/package.json
@@ -1,14 +1,14 @@
 {
   "name": "@marcus-j-davies/haprouter-route-http",
   "description": "The stock HAP Router HTTP route",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "main": "index.js",
   "author": {
     "name": "Marcus Davies",
     "email": "[email protected]"
   },
   "license": "MIT",
   "dependencies": {
-    "axios": "^0.24.0"
+    "axios": "^0.27.2"
   }
 }
diff --git a/@marcus-j-davies/haprouter-route-mqtt/index.js b/@marcus-j-davies/haprouter-route-mqtt/index.js
@@ -51,7 +51,7 @@ MQTTRoute.prototype._init = function () {
 		this.MQTTBroker.on('error', (e) => this.mqttError(e));
 		this.MQTTBroker.on('close', () => this.mqttClose());
 	} catch (err) {
-		this.StatusNotify(false, err.message);
+		this.StatusNotify({ success: false, message: err.message });
 	}
 };
 
@@ -74,32 +74,36 @@ MQTTRoute.prototype.close = function () {
 
 MQTTRoute.prototype.mqttClose = function () {
 	if (this.Retries >= _MaxRetries) {
-		this.StatusNotify(false, 'Connection was closed. Recovery Failed.');
+		this.StatusNotify({
+			success: false,
+			message: 'Connection was closed. Recovery Failed.'
+		});
 	} else {
 		this.Retries++;
-		this.StatusNotify(
-			false,
-			'Connection was closed. Recovery Scheduled (' +
+		this.StatusNotify({
+			success: false,
+			message:
+				'Connection was closed. Recovery Scheduled (' +
 				this.Retries +
 				'/' +
 				_MaxRetries +
 				')'
-		);
+		});
 		setTimeout(() => {
 			this._init();
 		}, _RetryWaitTime);
 	}
 };
 
 MQTTRoute.prototype.mqttConnected = function () {
-	this.StatusNotify(true);
+	this.StatusNotify({ success: true });
 };
 
 MQTTRoute.prototype.mqttError = function (err) {
 	if (err) {
-		this.StatusNotify(false, err.message);
+		this.StatusNotify({ success: false, message: err.message });
 	} else {
-		this.StatusNotify(true);
+		this.StatusNotify({ success: true });
 	}
 };
 

diff --git a/@marcus-j-davies/haprouter-route-mqtt/package.json b/@marcus-j-davies/haprouter-route-mqtt/package.json
@@ -1,14 +1,14 @@
 {
   "name": "@marcus-j-davies/haprouter-route-mqtt",
   "description": "The stock HAP Router MQTT route",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "main": "index.js",
   "author": {
     "name": "Marcus Davies",
     "email": "[email protected]"
   },
   "license": "MIT",
   "dependencies": {
-    "mqtt": "^4.3.2"
+    "mqtt": "^4.3.7"
   }
 }
diff --git a/@marcus-j-davies/haprouter-route-null/index.js b/@marcus-j-davies/haprouter-route-null/index.js
@@ -9,7 +9,7 @@ const Icon = 'icon.png';
 class Null {
 	/* Constructor */
 	constructor(route, statusnotify) {
-		statusnotify(true);
+		statusnotify({ success: true });
 	}
 }
 

diff --git a/@marcus-j-davies/haprouter-route-null/package.json b/@marcus-j-davies/haprouter-route-null/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@marcus-j-davies/haprouter-route-null",
   "description": "The stock HAP Router NULL route",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "main": "index.js",
   "author": {
     "name": "Marcus Davies",

diff --git a/@marcus-j-davies/haprouter-route-udp/index.js b/@marcus-j-davies/haprouter-route-udp/index.js
@@ -29,7 +29,7 @@ class UDP {
 			this.UDPServer.on('error', (e) => this.UDPBindError(e));
 			this.UDPServer.bind(() => this.UDPConnected());
 		} catch (err) {
-			statusnotify(false, err.message);
+			statusnotify({ success: false, message: err.message });
 		}
 	}
 }
@@ -47,7 +47,7 @@ UDP.prototype.process = async function (payload) {
 				(e) => this.UDPDone(e)
 			);
 		} catch (err) {
-			this.StatusNotify(false, err.message);
+			this.StatusNotify({ success: false, message: err.message });
 		}
 	}
 };
@@ -59,19 +59,19 @@ UDP.prototype.close = function () {
 };
 
 UDP.prototype.UDPBindError = function (err) {
-	this.StatusNotify(false, err.message);
+	this.StatusNotify({ success: false, message: err.message });
 };
 
 UDP.prototype.UDPConnected = function () {
 	this.UDPServer.setBroadcast(true);
-	this.StatusNotify(true);
+	this.StatusNotify({ success: true });
 };
 
 UDP.prototype.UDPDone = function (err) {
 	if (err) {
-		this.StatusNotify(false, err.message);
+		this.StatusNotify({ success: false, message: err.message });
 	} else {
-		this.StatusNotify(true);
+		this.StatusNotify({ success: true });
 	}
 };
 

diff --git a/@marcus-j-davies/haprouter-route-udp/package.json b/@marcus-j-davies/haprouter-route-udp/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@marcus-j-davies/haprouter-route-udp",
   "description": "The stock HAP Router UDP route",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "main": "index.js",
   "author": {
     "name": "Marcus Davies",

diff --git a/@marcus-j-davies/haprouter-route-websocket/index.js b/@marcus-j-davies/haprouter-route-websocket/index.js
@@ -33,7 +33,7 @@ WebsocketClass.prototype._init = function () {
 		this.Websocket.on('error', (e) => this.WSError(e));
 		this.Websocket.on('close', () => this.HandleWSClose());
 	} catch (err) {
-		this.StatusNotify(false, err.message);
+		this.StatusNotify({ success: false, message: err.message });
 	}
 };
 
@@ -53,30 +53,34 @@ WebsocketClass.prototype.close = function () {
 
 WebsocketClass.prototype.HandleWSOpen = function () {
 	this.Retries = 0;
-	this.StatusNotify(true);
+	this.StatusNotify({ success: true });
 };
 
 WebsocketClass.prototype.WSError = function (err) {
 	if (err) {
-		this.StatusNotify(false, err.message);
+		this.StatusNotify({ success: false, message: err.message });
 	} else {
-		this.StatusNotify(true);
+		this.StatusNotify({ success: true });
 	}
 };
 
 WebsocketClass.prototype.HandleWSClose = function () {
 	if (this.Retries >= _MaxRetries) {
-		this.StatusNotify(false, 'Connection was closed. Recovery Failed.');
+		this.StatusNotify({
+			success: false,
+			message: 'Connection was closed. Recovery Failed.'
+		});
 	} else {
 		this.Retries++;
-		this.StatusNotify(
-			false,
-			'Connection was closed. Recovery Scheduled (' +
+		this.StatusNotify({
+			success: false,
+			message:
+				'Connection was closed. Recovery Scheduled (' +
 				this.Retries +
 				'/' +
 				_MaxRetries +
 				')'
-		);
+		});
 		setTimeout(() => {
 			this._init();
 		}, _RetryWaitTime);

diff --git a/@marcus-j-davies/haprouter-route-websocket/package.json b/@marcus-j-davies/haprouter-route-websocket/package.json
@@ -1,14 +1,14 @@
 {
   "name": "@marcus-j-davies/haprouter-route-websocket",
   "description": "The stock HAP Router WEB SOCKET route",
-  "version": "3.2.1",
+  "version": "4.0.0",
   "main": "index.js",
   "author": {
     "name": "Marcus Davies",
     "email": "[email protected]"
   },
   "license": "MIT",
   "dependencies": {
-    "ws":"^8.4.0"
+    "ws":"^8.8.0"
   }
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,25 @@
+  - **4.0.0** 
+
+    - **Breaking Changes**
+      - Min NodeJS version is now 14.14.0
+      - Route status callback has been updated, and now requires an object to be passed.
+        ```javascript
+        {
+          "success": boolean,
+          "message": string
+        }
+        ```
+    - **Fixes**
+      - Fix missing HAPRouter folder at start up.
+      - Fix multisensor config, affecting other instances of the same accessory type.
+      - Address minor security warnings
+
+    - **New Features**
+      - Characteristic values are now written to disc every hour, to ensure most recent values are saved, in case of unexpected termination.
+      - Bridge functionality can now be independently switched off.
+      - Television Accessory, can now have different icons.
+
+
   - **3.0.2** 
 
     - **Changes**