matterbridge-lg-thinq-plugin 0.1.0

package/matterbridge-lg-thinq-plugin.schema.json

@@ -0,0 +1,520 @@
+{
+	"title": "Matterbridge LG ThinQ Plugin",
+	"description": "matterbridge-lg-thinq-plugin v. 0.1.0 by https://github.com/RinDevJunior",
+	"type": "object",
+	"properties": {
+		"name": {
+			"description": "Plugin name",
+			"type": "string",
+			"readOnly": true,
+			"ui:widget": "hidden"
+		},
+		"type": {
+			"description": "Plugin type",
+			"type": "string",
+			"readOnly": true,
+			"ui:widget": "hidden"
+		},
+		"thinq": {
+			"title": "LG ThinQ (cloud)",
+			"type": "object",
+			"properties": {
+				"loginType": {
+					"title": "Login Type",
+					"description": "Authenticate with a ThinQ account (username/password) or a pre-issued refresh token.",
+					"type": "string",
+					"enum": ["account", "token"],
+					"default": "account"
+				},
+				"country": {
+					"title": "Country",
+					"description": "ThinQ account country code (e.g. US, KR, GB).",
+					"type": "string",
+					"default": "US"
+				},
+				"language": {
+					"title": "Language",
+					"description": "ThinQ account language/locale (e.g. en-US, ko-KR).",
+					"type": "string",
+					"default": "en-US"
+				},
+				"refreshIntervalSeconds": {
+					"title": "Refresh Interval",
+					"description": "Device state refresh interval in seconds.",
+					"type": "number",
+					"default": 60,
+					"minimum": 1,
+					"maximum": 3600
+				},
+				"filterMonitoringIntervalSeconds": {
+					"title": "Filter Monitoring Interval",
+					"description": "Filter life state refresh interval in seconds (low frequency, filter life changes over days/weeks).",
+					"type": "number",
+					"default": 3600,
+					"minimum": 300,
+					"maximum": 86400
+				}
+			},
+			"required": ["loginType", "country", "language"],
+			"dependencies": {
+				"loginType": {
+					"if": {
+						"properties": {
+							"loginType": {
+								"const": "account"
+							}
+						}
+					},
+					"then": {
+						"properties": {
+							"username": {
+								"title": "ThinQ Account Username",
+								"description": "Email address or phone number used to sign in to LG ThinQ.",
+								"type": "string",
+								"minLength": 3
+							},
+							"password": {
+								"title": "ThinQ Account Password",
+								"description": "Password for your LG ThinQ account.",
+								"type": "string",
+								"ui:widget": "password"
+							},
+							"devices": {
+								"title": "ThinQ Devices",
+								"description": "Auto-populated on discovery. Per-device capability flags gate which Matter features are advertised.",
+								"type": "array",
+								"items": {
+									"type": "object",
+									"properties": {
+										"deviceId": {
+											"title": "Device ID",
+											"type": "string"
+										},
+										"deviceType": {
+											"title": "Device Type",
+											"type": "string",
+											"enum": ["AC", "WASHER"],
+											"readOnly": true
+										},
+										"productName": {
+											"title": "Product Name Override",
+											"description": "Override the Matter product name shown for this device. Only applied when Override Matter Configuration is enabled in Advanced Features.",
+											"type": "string"
+										},
+										"productId": {
+											"title": "Product ID Override",
+											"description": "Override the Matter product id shown for this device. Only applied when Override Matter Configuration is enabled in Advanced Features.",
+											"type": "number"
+										}
+									},
+									"required": ["deviceId"],
+									"dependencies": {
+										"deviceType": {
+											"allOf": [
+												{
+													"if": {
+														"properties": {
+															"deviceType": {
+																"const": "AC"
+															}
+														}
+													},
+													"then": {
+														"properties": {
+															"capabilities": {
+																"title": "Capabilities",
+																"type": "object",
+																"properties": {
+																	"supportsHeat": {
+																		"title": "Supports Heat",
+																		"description": "Whether this device supports heating mode.",
+																		"type": "boolean",
+																		"default": true
+																	},
+																	"supportsFanSpeedControl": {
+																		"title": "Supports Fan Speed Control",
+																		"description": "Whether this device supports adjustable fan speed.",
+																		"type": "boolean",
+																		"default": true
+																	},
+																	"supportsSwingMode": {
+																		"title": "Supports Swing Mode",
+																		"description": "Whether this device supports swing mode (vertical/horizontal vane control).",
+																		"type": "boolean",
+																		"default": false
+																	},
+																	"supportsHumiditySensor": {
+																		"title": "Supports Humidity Sensor",
+																		"description": "Whether this device reports humidity data.",
+																		"type": "boolean",
+																		"default": false
+																	},
+																	"supportsAirQualitySensor": {
+																		"title": "Supports Air-Quality Sensor",
+																		"description": "Whether this device reports air-quality (AQI, PM2.5, PM10) data.",
+																		"type": "boolean",
+																		"default": false
+																	},
+																	"supportsEnergyMonitoring": {
+																		"title": "Supports Energy Monitoring",
+																		"description": "Whether this device reports instantaneous power consumption data.",
+																		"type": "boolean",
+																		"default": false
+																	},
+																	"supportsFilterMonitoring": {
+																		"title": "Supports Filter Monitoring",
+																		"description": "Whether this device reports air-filter life/remaining-percent data.",
+																		"type": "boolean",
+																		"default": false
+																	}
+																}
+															}
+														}
+													}
+												},
+												{
+													"if": {
+														"properties": {
+															"deviceType": {
+																"const": "WASHER"
+															}
+														}
+													},
+													"then": {
+														"properties": {
+															"washerControl": {
+																"title": "Washer Control",
+																"type": "object",
+																"properties": {
+																	"allowRemoteStop": {
+																		"title": "Allow Remote Stop (Washer)",
+																		"description": "Turning this on lets Apple Home send a real stop/cancel command to the physical washer. Off by default.",
+																		"type": "boolean",
+																		"default": false
+																	}
+																}
+															}
+														}
+													}
+												},
+												{
+													"if": {
+														"properties": {
+															"deviceType": {
+																"const": "AC"
+															},
+															"capabilities": {
+																"required": ["supportsFilterMonitoring"],
+																"properties": {
+																	"supportsFilterMonitoring": {
+																		"const": true
+																	}
+																}
+															}
+														},
+														"required": ["capabilities"]
+													},
+													"then": {
+														"properties": {
+															"acFilterControl": {
+																"title": "AC Filter Control",
+																"type": "object",
+																"properties": {
+																	"allowFilterReset": {
+																		"title": "Allow Filter Reset (AC)",
+																		"description": "Turning this on lets Apple Home send a real filter-counter reset command to the physical air conditioner, after you've replaced/cleaned the filter. Off by default. This command has not been live-tested yet — enable only when you are ready to verify it yourself.",
+																		"type": "boolean",
+																		"default": false
+																	}
+																}
+															}
+														}
+													}
+												}
+											]
+										}
+									}
+								}
+							}
+						},
+						"required": ["username", "password"]
+					},
+					"else": {
+						"if": {
+							"properties": {
+								"loginType": {
+									"const": "token"
+								}
+							}
+						},
+						"then": {
+							"properties": {
+								"refreshToken": {
+									"title": "Refresh Token",
+									"description": "Pre-issued ThinQ refresh token, used instead of username/password.",
+									"type": "string",
+									"ui:widget": "password"
+								},
+								"devices": {
+									"title": "ThinQ Devices",
+									"description": "Auto-populated on discovery. Per-device capability flags gate which Matter features are advertised.",
+									"type": "array",
+									"items": {
+										"type": "object",
+										"properties": {
+											"deviceId": {
+												"title": "Device ID",
+												"type": "string"
+											},
+											"deviceType": {
+												"title": "Device Type",
+												"type": "string",
+												"enum": ["AC", "WASHER"],
+												"readOnly": true
+											},
+											"productName": {
+												"title": "Product Name Override",
+												"description": "Override the Matter product name shown for this device. Only applied when Override Matter Configuration is enabled in Advanced Features.",
+												"type": "string"
+											},
+											"productId": {
+												"title": "Product ID Override",
+												"description": "Override the Matter product id shown for this device. Only applied when Override Matter Configuration is enabled in Advanced Features.",
+												"type": "number"
+											}
+										},
+										"required": ["deviceId"],
+										"dependencies": {
+											"deviceType": {
+												"allOf": [
+													{
+														"if": {
+															"properties": {
+																"deviceType": {
+																	"const": "AC"
+																}
+															}
+														},
+														"then": {
+															"properties": {
+																"capabilities": {
+																	"title": "Capabilities",
+																	"type": "object",
+																	"properties": {
+																		"supportsHeat": {
+																			"title": "Supports Heat",
+																			"description": "Whether this device supports heating mode.",
+																			"type": "boolean",
+																			"default": true
+																		},
+																		"supportsFanSpeedControl": {
+																			"title": "Supports Fan Speed Control",
+																			"description": "Whether this device supports adjustable fan speed.",
+																			"type": "boolean",
+																			"default": true
+																		},
+																		"supportsSwingMode": {
+																			"title": "Supports Swing Mode",
+																			"description": "Whether this device supports swing mode (vertical/horizontal vane control).",
+																			"type": "boolean",
+																			"default": false
+																		},
+																		"supportsHumiditySensor": {
+																			"title": "Supports Humidity Sensor",
+																			"description": "Whether this device reports humidity data.",
+																			"type": "boolean",
+																			"default": false
+																		},
+																		"supportsAirQualitySensor": {
+																			"title": "Supports Air-Quality Sensor",
+																			"description": "Whether this device reports air-quality (AQI, PM2.5, PM10) data.",
+																			"type": "boolean",
+																			"default": false
+																		},
+																		"supportsEnergyMonitoring": {
+																			"title": "Supports Energy Monitoring",
+																			"description": "Whether this device reports instantaneous power consumption data.",
+																			"type": "boolean",
+																			"default": false
+																		},
+																		"supportsFilterMonitoring": {
+																			"title": "Supports Filter Monitoring",
+																			"description": "Whether this device reports air-filter life/remaining-percent data.",
+																			"type": "boolean",
+																			"default": false
+																		}
+																	}
+																}
+															}
+														}
+													},
+													{
+														"if": {
+															"properties": {
+																"deviceType": {
+																	"const": "WASHER"
+																}
+															}
+														},
+														"then": {
+															"properties": {
+																"washerControl": {
+																	"title": "Washer Control",
+																	"type": "object",
+																	"properties": {
+																		"allowRemoteStop": {
+																			"title": "Allow Remote Stop (Washer)",
+																			"description": "Turning this on lets Apple Home send a real stop/cancel command to the physical washer. Off by default.",
+																			"type": "boolean",
+																			"default": false
+																		}
+																	}
+																}
+															}
+														}
+													},
+													{
+														"if": {
+															"properties": {
+																"deviceType": {
+																	"const": "AC"
+																},
+																"capabilities": {
+																	"required": ["supportsFilterMonitoring"],
+																	"properties": {
+																		"supportsFilterMonitoring": {
+																			"const": true
+																		}
+																	}
+																}
+															},
+															"required": ["capabilities"]
+														},
+														"then": {
+															"properties": {
+																"acFilterControl": {
+																	"title": "AC Filter Control",
+																	"type": "object",
+																	"properties": {
+																		"allowFilterReset": {
+																			"title": "Allow Filter Reset (AC)",
+																			"description": "Turning this on lets Apple Home send a real filter-counter reset command to the physical air conditioner, after you've replaced/cleaned the filter. Off by default. This command has not been live-tested yet — enable only when you are ready to verify it yourself.",
+																			"type": "boolean",
+																			"default": false
+																		}
+																	}
+																}
+															}
+														}
+													}
+												]
+											}
+										}
+									}
+								}
+							},
+							"required": ["refreshToken"]
+						}
+					}
+				}
+			}
+		},
+		"webos": {
+			"title": "LG webOS TV (local network)",
+			"type": "object",
+			"properties": {
+				"devices": {
+					"title": "webOS TV Devices",
+					"description": "Populated once webOS pairing/control lands (Phase 3+).",
+					"type": "array",
+					"items": {
+						"type": "object"
+					}
+				}
+			}
+		},
+		"advancedFeature": {
+			"title": "Advanced features",
+			"type": "object",
+			"properties": {
+				"settings": {
+					"title": "Advanced Features Configuration",
+					"type": "object",
+					"properties": {
+						"debug": {
+							"title": "Enable Debug Mode",
+							"description": "Enable the debug for the plugin (development only)",
+							"type": "boolean",
+							"default": false
+						},
+						"clearStorageOnStartup": {
+							"title": "Clear Storage On Startup",
+							"description": "Clear persistence storage and re-initialize the plugin on next startup.",
+							"type": "boolean",
+							"default": false
+						},
+						"forceAuthentication": {
+							"title": "Force Authentication",
+							"description": "Ignore any cached/saved login session and always authenticate fresh on every start.",
+							"type": "boolean",
+							"default": false
+						},
+						"unregisterOnShutdown": {
+							"title": "Unregister On Shutdown",
+							"description": "Unregister all devices on shutdown (development only)",
+							"type": "boolean",
+							"default": false
+						},
+						"overrideMatterConfiguration": {
+							"title": "Override Matter Configuration",
+							"description": "Override the Matter vendor/product identity (vendor name, vendor id, product name, product id) shown for AC devices in Apple Home / any Matter controller.",
+							"type": "boolean",
+							"default": false
+						}
+					},
+					"required": [
+						"debug",
+						"clearStorageOnStartup",
+						"forceAuthentication",
+						"unregisterOnShutdown",
+						"overrideMatterConfiguration"
+					],
+					"dependencies": {
+						"overrideMatterConfiguration": {
+							"if": {
+								"properties": {
+									"overrideMatterConfiguration": {
+										"const": true
+									}
+								}
+							},
+							"then": {
+								"properties": {
+									"matterOverrideSettings": {
+										"title": "Matter Override Settings",
+										"type": "object",
+										"properties": {
+											"matterVendorName": {
+												"title": "Vendor Name",
+												"type": "string",
+												"default": "Matterbridge"
+											},
+											"matterVendorId": {
+												"title": "Vendor ID",
+												"type": "number",
+												"default": 65521
+											}
+										},
+										"required": ["matterVendorName", "matterVendorId"]
+									}
+								},
+								"required": ["matterOverrideSettings"]
+							}
+						}
+					}
+				}
+			}
+		}
+	},
+	"required": ["thinq", "webos", "advancedFeature"]
+}

package/package.json

@@ -0,0 +1,107 @@
+{
+	"name": "matterbridge-lg-thinq-plugin",
+	"version": "0.1.0",
+	"description": "Matterbridge LG ThinQ Plugin",
+	"author": "https://github.com/RinDevJunior",
+	"license": "MIT",
+	"homepage": "https://github.com/RinDevJunior/matterbridge-lg-thinq-plugin",
+	"type": "module",
+	"main": "dist/module.js",
+	"types": "dist/module.d.ts",
+	"publishConfig": {
+		"access": "public"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/RinDevJunior/matterbridge-lg-thinq-plugin.git"
+	},
+	"bugs": {
+		"url": "https://github.com/RinDevJunior/matterbridge-lg-thinq-plugin/issues"
+	},
+	"keywords": [
+		"matterbridge",
+		"lg",
+		"thinq",
+		"webos",
+		"matter",
+		"matter.js",
+		"plugin",
+		"homekit",
+		"apple home"
+	],
+	"scripts": {
+		"precommit": "npm run lint && npm run type-check && npm run dup-check && npm run format:check && npm run test",
+		"precommit:ci": "node scripts/run-precommit-summary.mjs",
+		"precondition": "npm install -g matterbridge@3.10.10",
+		"build:local": "npm run deepClean && npm install && npm link matterbridge && npm run build && npm run matterbridge:add",
+		"build:local:ci": "node scripts/run-build-local-summary.mjs",
+		"build:production": "tsc --project tsconfig.production.json",
+		"start": "tsc && matterbridge -childbridge",
+		"cli": "node dist/cli.js",
+		"dup-check": "npx jscpd",
+		"build": "tsc",
+		"type-check": "tsc --noEmit",
+		"type-check:ci": "tsc --noEmit >type-check.log 2>&1; node scripts/parse-tsc-failures.mjs",
+		"watch": "tsc --watch",
+		"test": "vitest run",
+		"test:file": "vitest run",
+		"test:coverage": "vitest run --coverage",
+		"test:report": "vitest run --reporter=junit --outputFile=test-report.junit.xml",
+		"test:ci": "vitest run --reporter=junit --outputFile=test-report.junit.xml >/dev/null 2>&1; node scripts/parse-junit-failures.mjs",
+		"lint": "eslint --max-warnings=0 .",
+		"lint:fix": "eslint --fix --max-warnings=0 .",
+		"lint:fix:ci": "node scripts/run-lint-fix-summary.mjs",
+		"format": "prettier --write \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
+		"format:ci": "node scripts/run-format-summary.mjs",
+		"format:check": "prettier --check \"**/*.{js,jsx,ts,tsx,json,css,md}\"",
+		"deepClean": "npx rimraf tsconfig.tsbuildinfo npm-shrinkwrap.json ./dist ./node_modules",
+		"checkDependencies": "npx npm-check-updates",
+		"updateDependencies": "npx npm-check-updates -u && npm run build:local",
+		"matterbridge:add": "matterbridge -add .\\",
+		"matterbridge:remove": "matterbridge -remove .\\",
+		"matterbridge:enable": "matterbridge -enable .\\",
+		"matterbridge:disable": "matterbridge -disable .\\",
+		"matterbridge:list": "matterbridge -list",
+		"dev:link": "npm link matterbridge",
+		"dev:unlink": "npm unlink matterbridge"
+	},
+	"engines": {
+		"matterbridge": "^3.10.9",
+		"node": ">=24 <25"
+	},
+	"devDependencies": {
+		"@eslint/js": "10.0.1",
+		"@eslint/json": "^1.2.0",
+		"@eslint/markdown": "^8.0.1",
+		"@types/aws-iot-device-sdk": "^2.2.9",
+		"@types/node": "^26.1.0",
+		"@types/node-forge": "^1.3.14",
+		"@types/node-persist": "3.1.8",
+		"@vitest/coverage-v8": "^4.1.10",
+		"@vitest/eslint-plugin": "^1.6.21",
+		"axios-mock-adapter": "^2.1.0",
+		"eslint": "^10.6.0",
+		"eslint-config-prettier": "10.1.8",
+		"eslint-plugin-n": "^18.2.1",
+		"eslint-plugin-prettier": "^5.5.6",
+		"eslint-plugin-simple-import-sort": "^13.0.0",
+		"jscpd": "^4.0.8",
+		"mock-socket": "^9.3.1",
+		"npm-check-updates": "^20.0.0",
+		"prettier": "^3.9.4",
+		"rimraf": "^6.1.3",
+		"typescript": "6.0.3",
+		"typescript-eslint": "^8.62.1",
+		"vite-tsconfig-paths": "^6.1.1",
+		"vitest": "^4.1.10"
+	},
+	"dependencies": {
+		"aws-iot-device-sdk": "^2.2.16",
+		"axios": "^1.18.1",
+		"node-forge": "^1.4.0",
+		"node-persist": "^4.0.4"
+	},
+	"overrides": {
+		"typescript": "6.0.3"
+	}
+}

package/prettier.config.js

@@ -0,0 +1,49 @@
+// @ts-check
+/*
+
+prettier.config.js
+
+Prettier:
+
+How to install:
+  npm install --save-dev prettier eslint-config-prettier eslint-plugin-prettier
+
+
+Add package.json scripts:
+*/
+// "format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,css,md}\"",
+// "format:check": "prettier --check \"src/**/*.{js,jsx,ts,tsx,json,css,md}\"",
+
+/*
+
+Add .prettierignore
+
+# Ignore artifacts:
+dist
+node_modules
+build
+coverage
+
+# Ignore all HTML files:
+*/
+// **/*.html
+
+export default {
+	printWidth: 120, // default 80
+	tabWidth: 2,
+	useTabs: true,
+	semi: true,
+	singleQuote: true, // default false
+	quoteProps: 'preserve', // default 'as-needed'
+	jsxSingleQuote: false,
+	trailingComma: 'all',
+	bracketSpacing: true,
+	bracketSameLine: false,
+	arrowParens: 'always',
+	requirePragma: false,
+	insertPragma: false,
+	proseWrap: 'preserve',
+	endOfLine: 'lf',
+	embeddedLanguageFormatting: 'off', // default 'auto'
+	singleAttributePerLine: false,
+};