homebridge-cync-app 0.1.3 → 0.1.6

package/homebridge-ui/public/index.html

@@ -3,119 +3,180 @@
 	<img
 		src="icon.png"
 		alt="Cync App Icon"
-		style="width: 96px; height: 96px; border-radius: 5px;"
+		style="width:96px;height:96px;border-radius:5px;"
 	/>
 </div>
-<div class="card card-body">
-  <div id="options" class="card-body my-3 w-75 mx-auto">
-    <div class="alert alert-warning" role="alert">
-		It is recommended to create a second Cync account and share your home
-		between accounts to avoid issues with Cync servers and the official Cync App.
-    </div>
-
-    <form id="authForm" class="form-horizontal">
-      <div id="codeDiv" class="card-body my-3 w-75 mx-auto">
-        <div class="mb-3">
-          <label class="form-label" for="emailAddress">Cync Email Address</label>
-          <input class="form-control" type="email" id="emailAddress" placeholder="name@example.com" />
-        </div>
-
-        <button type="button" class="btn btn-secondary text-center" id="requestCode">
-          Request 2FA Code
-        </button>
-      </div>
-
-      <div id="authDiv" class="card-body my-3 w-75 mx-auto">
-        <div class="mb-3">
-          <label class="form-label" for="password">Cync Password</label>
-          <input class="form-control" type="password" id="password" />
-        </div>
-
-        <div class="mb-3">
-          <label class="form-label" for="mfaCode">2FA Code</label>
-          <input class="form-control" type="text" id="mfaCode" />
-        </div>
-
-        <button type="button" class="btn btn-primary text-center" id="login">
-          Login
-        </button>
-      </div>
-    </form>
-  </div>
+
+<div class="card mb-3">
+	<div class="card-body">
+		<h3 class="card-title">Homebridge Cync App</h3>
+		<p class="card-text">
+		Enter your Cync Username, Password, and 6 digit verification code emailed to you by Cync.
+		To obtain a fresh code, use the <strong>Request Verification Code</strong> button, then click the Homebridge
+		<strong>Save</strong> button at the bottom once you’ve entered the code.
+		</p>
+	</div>
+</div>
+
+<div class="card mb-3">
+	<div class="card-body">
+		<h5 class="card-title">Cync Cloud Credentials</h5>
+
+		<div class="mb-3">
+			<label for="cyncEmail" class="form-label">Email</label>
+			<input type="email" id="cyncEmail" class="form-control" autocomplete="username">
+		</div>
+
+		<div class="mb-3">
+			<label for="cyncPassword" class="form-label">Password</label>
+			<input type="password" id="cyncPassword" class="form-control" autocomplete="current-password">
+		</div>
+
+		<div class="d-flex flex-wrap gap-2 mb-3">
+			<button id="cyncRequestOtpBtn" class="btn btn-secondary">
+				Request Verification Code
+			</button>
+			<button id="cyncSignOutBtn" class="btn btn-outline-danger">
+				Sign Out
+			</button>
+			<span id="cyncStatus" class="align-self-center text-muted ms-2"></span>
+		</div>
+
+		<div class="mb-3">
+			<label for="cyncOtp" class="form-label">Verification Code (OTP)</label>
+			<input type="text" id="cyncOtp" class="form-control" autocomplete="one-time-code">
+			</div>
+		</div>
+	</div>
 </div>
 
 <script>
-  homebridge.addEventListener('ready', async () => {
-    const pluginConfig = await homebridge.getPluginConfig();
-
-    if (pluginConfig[0]) {
-      const cfg = pluginConfig[0];
-      document.getElementById('emailAddress').value =
-        cfg.username || cfg.email || '';
-    }
-
-    document
-      .getElementById('requestCode')
-      .addEventListener('click', () => {
-        document.getElementById('mfaCode').value = '';
-
-        const emailAddress =
-          document.getElementById('emailAddress').value || '';
-        if (!emailAddress) {
-          homebridge.toast.error('Please enter your Cync email address.');
-          return;
-        }
-
-        homebridge
-          .request('/requestCode', { emailAddress })
-          .then(() => {
-            homebridge.toast.info(
-              `Please check your ${emailAddress} inbox for your 2FA code.`,
-            );
-          })
-          .catch((err) => {
-            homebridge.toast.error(
-              `Failed to request 2FA code: ${String(err)}`,
-            );
-          });
-      });
-
-    document.getElementById('login').addEventListener('click', () => {
-      const payload = {
-        emailAddress: document.getElementById('emailAddress').value || '',
-        password: document.getElementById('password').value || '',
-        mfaCode: document.getElementById('mfaCode').value || '',
-      };
-
-      if (!payload.emailAddress || !payload.password || !payload.mfaCode) {
-        homebridge.toast.error(
-          'Please enter email, password, and 2FA code.',
-        );
-        return;
-      }
-
-      homebridge
-        .request('/login', payload)
-        .then(async (config) => {
-          if (config && config.error) {
-            homebridge.toast.error(config.error);
-            document.getElementById('password').value = '';
-            document.getElementById('mfaCode').value = '';
-            return;
-          }
-
-          await homebridge.updatePluginConfig([config]);
-          homebridge.toast.success(
-            'You have successfully authenticated with Cync!',
-          );
-          await homebridge.savePluginConfig();
-          homebridge.closeSettings();
-        })
-        .catch((err) => {
-          homebridge.toast.error(
-            `Login failed: ${String(err)}`,
-          );
-        });
-    });
-  });
+homebridge.addEventListener('ready', async () => {
+	const emailInput = document.getElementById('cyncEmail');
+	const passwordInput = document.getElementById('cyncPassword');
+	const otpInput = document.getElementById('cyncOtp');
+	const requestOtpBtn = document.getElementById('cyncRequestOtpBtn');
+	const signOutBtn = document.getElementById('cyncSignOutBtn');
+	const statusEl = document.getElementById('cyncStatus');
+
+	let pluginConfig = await homebridge.getPluginConfig();
+	let cfg = pluginConfig[0] || {};
+
+	// Helper to update in-memory pluginConfig (persisted when user clicks Save in HB)
+	async function updateConfig(partial) {
+		cfg = { ...cfg, ...partial };
+		pluginConfig = [cfg];
+		await homebridge.updatePluginConfig(pluginConfig);
+	}
+
+	function setLockedState(locked) {
+		emailInput.disabled = locked;
+		passwordInput.disabled = locked;
+		otpInput.disabled = locked;
+		requestOtpBtn.disabled = locked;
+		// Sign Out remains enabled so the user can clear things
+	}
+
+	// Load from config.json into UI
+	emailInput.value = cfg.username || '';
+	passwordInput.value = cfg.password || '';
+	otpInput.value = cfg.twoFactor || '';
+
+	// Check token status and lock fields if a token exists
+	try {
+		const status = await homebridge.request('/status');
+		if (status && status.ok && status.hasToken) {
+			setLockedState(true);
+			statusEl.textContent = 'Signed in. Click Sign Out to change credentials.';
+		}
+	} catch (e) {
+		console.error('[cync-ui] /status request failed:', e);
+	}
+
+	// Request OTP email via server.js
+	requestOtpBtn.addEventListener('click', async () => {
+		const email = emailInput.value.trim();
+		const password = passwordInput.value; // do not trim
+
+		if (!email || !password) {
+			homebridge.toast.warning('Enter email and password first.', 'Missing Credentials');
+			return;
+		}
+
+		homebridge.showSpinner();
+		statusEl.textContent = 'Requesting verification code…';
+
+		try {
+			// Persist latest credentials BEFORE requesting OTP
+			await updateConfig({
+				username: email,
+				password,
+			});
+
+			const res = await homebridge.request('/request-otp', { email });
+
+			if (res && res.ok) {
+				statusEl.textContent = 'Code requested. Check your email.';
+				homebridge.toast.success('Verification code sent.', 'OTP Requested');
+			} else {
+				statusEl.textContent = 'Request may have failed. Check logs.';
+				homebridge.toast.warning('Unexpected response requesting code.', 'OTP Request');
+			}
+		} catch (err) {
+			console.error('[cync-ui] Failed to request OTP:', err);
+			statusEl.textContent = 'OTP request failed. See logs.';
+			homebridge.toast.error('Failed to request 2FA code.', 'Error');
+		} finally {
+			homebridge.hideSpinner();
+		}
+	});
+
+	// OTP field updates config; Homebridge Save persists it
+	otpInput.addEventListener('change', async () => {
+		try {
+			await updateConfig({
+				username: emailInput.value.trim(),
+				password: passwordInput.value,
+				twoFactor: otpInput.value.trim(),
+			});
+			statusEl.textContent = 'Verification code updated. Click Save.';
+		} catch (e) {
+			console.error('[cync-ui] Failed to update OTP in config:', e);
+			statusEl.textContent = 'Failed to update verification code.';
+		}
+	});
+
+	// Sign Out: clear token + unlock fields
+	signOutBtn.addEventListener('click', async () => {
+		homebridge.showSpinner();
+		statusEl.textContent = 'Signing out…';
+
+		try {
+			await homebridge.request('/sign-out');
+
+			// Clear UI fields
+			emailInput.value = '';
+			passwordInput.value = '';
+			otpInput.value = '';
+
+			// Clear config (in memory) and unlock inputs
+			await updateConfig({
+				username: '',
+				password: '',
+				twoFactor: '',
+			});
+
+			setLockedState(false);
+
+			statusEl.textContent = 'Signed out. Click Save to apply.';
+			homebridge.toast.success('Signed out. Click Save to apply.', 'Signed Out');
+		} catch (e) {
+			console.error('[cync-ui] Sign-out failed:', e);
+			statusEl.textContent = 'Sign-out failed.';
+			homebridge.toast.error('Failed to sign out.', 'Error');
+		} finally {
+			homebridge.hideSpinner();
+		}
+	});
+});
 </script>

package/homebridge-ui/server.js

@@ -1,97 +1,62 @@
 // homebridge-ui/server.js
 import { HomebridgePluginUiServer } from '@homebridge/plugin-ui-utils';
-import fetch from 'node-fetch';
+import { ConfigClient } from '../dist/cync/config-client.js';
+import { CyncTokenStore } from '../dist/cync/token-store.js';
 
-class PluginUiServer extends HomebridgePluginUiServer {
+class CyncUiServer extends HomebridgePluginUiServer {
 	constructor() {
 		super();
 
-		this.onRequest('/requestCode', this.handleRequestCode.bind(this));
-		this.onRequest('/login', this.handleLogin.bind(this));
+		this.configClient = new ConfigClient({
+			debug: (...a) => console.debug('[cync-ui-config]', ...a),
+			info:  (...a) => console.info('[cync-ui-config]', ...a),
+			warn:  (...a) => console.warn('[cync-ui-config]', ...a),
+			error: (...a) => console.error('[cync-ui-config]', ...a),
+		});
+
+		this.tokenStore = new CyncTokenStore(this.homebridgeStoragePath);
+
+		this.onRequest('/request-otp', this.handleRequestOtp.bind(this));
+		this.onRequest('/sign-out', this.handleSignOut.bind(this));
+		this.onRequest('/status', this.handleStatus.bind(this));
 
-		// Tell Homebridge UI that we’re ready
 		this.ready();
 	}
 
-	// Request a 2FA code via email
-	async handleRequestCode(payload) {
-		const email = (payload?.emailAddress || '').trim();
+	async handleRequestOtp(payload) {
+		const email = typeof payload?.email === 'string' ? payload.email.trim() : '';
 		if (!email) {
-			throw new Error('Email address is required to request a 2FA code.');
+			return { ok: false, error: 'Missing email' };
 		}
 
-		const requestBody = {
-			corp_id: '1007d2ad150c4000',
-			email,
-			local_lang: 'en-us',
-		};
-
-		await fetch(
-			'https://api.gelighting.com/v2/two_factor/email/verifycode',
-			{
-				method: 'POST',
-				body: JSON.stringify(requestBody),
-				headers: { 'Content-Type': 'application/json' },
-			},
-		);
+		await this.configClient.sendTwoFactorCode(email);
+		return { ok: true };
 	}
 
-	// Validate email + password + 2FA against Cync and return platform config
-	async handleLogin(payload) {
-		const email = (payload?.emailAddress || '').trim();
-		const password = (payload?.password || '').trim();
-		const mfaCode = (payload?.mfaCode || '').trim();
-
-		if (!email || !password || !mfaCode) {
-			return {
-				error: 'Email, password, and 2FA code are required.',
-			};
-		}
-
-		const requestBody = {
-			corp_id: '1007d2ad150c4000',
-			email,
-			password,
-			two_factor: mfaCode,
-			resource: 'abcdefghijk',
-		};
+	// Delete token file
+	async handleSignOut() {
+		await this.tokenStore.clear();
+		return { ok: true };
+	}
 
+	// Report whether a token exists
+	async handleStatus() {
 		try {
-			const response = await fetch(
-				'https://api.gelighting.com/v2/user_auth/two_factor',
-				{
-					method: 'POST',
-					body: JSON.stringify(requestBody),
-					headers: { 'Content-Type': 'application/json' },
-				},
-			);
-
-			const data = await response.json();
-			if (data && data.error) {
-				return {
-					error:
-						'Login failed. Please check your password and 2FA code.',
-				};
+			const token = await this.tokenStore.load();
+			if (!token) {
+				return { ok: true, hasToken: false };
 			}
-		} catch (err) {
-			console.error('[cync-ui] Login request failed:', err);
 			return {
-				error:
-					'Login failed due to a network or server error. Please try again.',
+				ok: true,
+				hasToken: true,
+				userId: token.userId,
+				expiresAt: token.expiresAt ?? null,
 			};
+		} catch {
+			// On error, just say "no token"
+			return { ok: true, hasToken: false };
 		}
-
-		// At this point, Cync accepted the credentials.
-		// Return the platform config that your platform.ts expects.
-		return {
-			platform: 'CyncAppPlatform',
-			name: 'Cync App',
-			username: email,
-			password,
-			twoFactor: mfaCode,
-		};
 	}
 }
 
-// Start the instance
-(() => new PluginUiServer())();
+(() => new CyncUiServer())();

package/package.json

@@ -2,7 +2,7 @@
 	"name": "homebridge-cync-app",
 	"displayName": "Homebridge Cync App",
 	"type": "module",
-	"version": "0.1.3",
+	"version": "0.1.6",
 	"private": false,
 	"description": "Homebridge plugin that integrates your GE Cync account (via the Cync app/API) and exposes all supported devices: plugs, lights, switches, etc",
 	"author": "Dustin Newell",
@@ -19,21 +19,20 @@
 		"homebridge-plugin",
 		"homebridge",
 		"cync",
-		"ge",
 		"ge cync",
-		"ge-lighting",
 		"smart plug",
 		"smart lights",
 		"C by GE"
 	],
 	"main": "dist/index.js",
-	"publishConfig": {
-		"access": "public"
-	},
 	"homebridge": {
 		"pluginType": "platform",
 		"platform": "CyncAppPlatform"
 	},
+	"funding": {
+		"type" : "paypal",
+		"url" : "https://paypal.me/DustinNewell"
+	},
 	"engines": {
 		"node": "^20.18.0 || ^22.10.0 || ^24.0.0",
 		"homebridge": "^1.8.0 || ^2.0.0-beta.0"
@@ -45,9 +44,7 @@
 		"watch": "npm run build && npm link && nodemon"
 	},
 	"dependencies": {
-		"homebridge-lib": "^7.1.12",
-		"node-fetch": "^3.3.2",
-		"@homebridge/plugin-ui-utils": "^1.0.0"
+		"@homebridge/plugin-ui-utils": "^2.1.2"
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.39.1",

package/src/cync/cync-client.ts

@@ -42,7 +42,12 @@ export class CyncClient {
 	private switchIdToHomeId: Record<number, string> = {};
 
 	// Credentials from config.json, used to drive 2FA bootstrap.
-	private readonly loginConfig: { email: string; password: string; twoFactor?: string };
+	//
+	// Canonical keys (must match platform + config):
+	//   - username: login identifier (email address used in Cync app)
+	//   - password: account password
+	//   - twoFactor: 6-digit OTP, optional; when present we complete 2FA on restart.
+	private readonly loginConfig: { username: string; password: string; twoFactor?: string };
 
 	// Optional LAN update hook for the platform
 	private lanUpdateHandler: ((update: unknown) => void) | null = null;
@@ -70,7 +75,7 @@ export class CyncClient {
 	constructor(
 		configClient: ConfigClient,
 		tcpClient: TcpClient,
-		loginConfig: { email: string; password: string; twoFactor?: string },
+		loginConfig: { username: string; password: string; twoFactor?: string },
 		storagePath: string,
 		logger?: CyncLogger,
 	) {
@@ -80,7 +85,18 @@ export class CyncClient {
 
 		this.loginConfig = loginConfig;
 		this.tokenStore = new CyncTokenStore(storagePath);
+
+		// One-time sanity log so we can see exactly what was passed in from platform/config.
+		this.log.debug(
+			'CyncClient: constructed with loginConfig=%o',
+			{
+				username: loginConfig.username,
+				hasPassword: !!loginConfig.password,
+				twoFactor: loginConfig.twoFactor,
+			},
+		);
 	}
+
 	// ### 🧩 LAN Login Code Builder
 	private buildLanLoginCode(authorize: string, userId: number): Uint8Array {
 		const authorizeBytes = Buffer.from(authorize, 'ascii');
@@ -133,17 +149,20 @@ export class CyncClient {
 		}
 
 		// 2) No stored token – run 2FA bootstrap
-		const { email, password, twoFactor } = this.loginConfig;
+		const { username, password, twoFactor } = this.loginConfig;
 
-		if (!email || !password) {
-			this.log.error('CyncClient: email and password are required to obtain a new token.');
+		if (!username || !password) {
+			this.log.error('CyncClient: username and password are required to obtain a new token.');
 			return false;
 		}
 
-		if (!twoFactor || String(twoFactor).trim() === '') {
+		const trimmedCode = typeof twoFactor === 'string' ? twoFactor.trim() : '';
+		const hasTwoFactor = trimmedCode.length > 0;
+
+		if (!hasTwoFactor) {
 			// No 2FA code – request one
-			this.log.info('Cync: starting 2FA handshake for %s', email);
-			await this.requestTwoFactorCode(email);
+			this.log.info('Cync: starting 2FA handshake for %s', username);
+			await this.requestTwoFactorCode(username);
 			this.log.info(
 				'Cync: 2FA code sent to your email. Enter the code as "twoFactor" in the plugin config and restart Homebridge to complete login.',
 			);
@@ -151,11 +170,11 @@ export class CyncClient {
 		}
 
 		// We have a 2FA code – complete login and persist token
-		this.log.info('Cync: completing 2FA login for %s', email);
+		this.log.info('Cync: completing 2FA login for %s', username);
 		const loginResult = await this.completeTwoFactorLogin(
-			email,
+			username,
 			password,
-			String(twoFactor).trim(),
+			trimmedCode,
 		);
 
 		// Build LAN login code
@@ -191,25 +210,22 @@ export class CyncClient {
 		this.applyAccessToken(tokenData);
 
 		this.log.info('Cync login successful; userId=%s (token stored)', tokenData.userId);
-		this.log.info(
-			'Cync: 2FA login complete and a token has been stored. You may now clear the "twoFactor" code from the plugin config; ' +
-					'it will only be needed again if the stored token expires or is removed.',
-		);
 		return true;
 	}
 
 
 	/**
-		 * Internal helper: request a 2FA email code using existing authenticate().
-		 */
-	private async requestTwoFactorCode(email: string): Promise<void> {
-		await this.authenticate(email);
+	 * Internal helper: request a 2FA email code using existing authenticate().
+	 * Accepts the same username value we store in loginConfig (email address for Cync).
+	 */
+	private async requestTwoFactorCode(username: string): Promise<void> {
+		await this.authenticate(username);
 	}
 
 	/**
-		 * Internal helper: complete 2FA login using existing submitTwoFactor().
-		 * This converts CyncLoginSession into the richer shape we want for token storage.
-		 */
+	 * Internal helper: complete 2FA login using existing submitTwoFactor().
+	 * This converts CyncLoginSession into the richer shape we want for token storage.
+	 */
 	private async completeTwoFactorLogin(
 		email: string,
 		password: string,
@@ -222,12 +238,15 @@ export class CyncClient {
 		}
 	> {
 		const session = await this.submitTwoFactor(email, password, code);
+
 		// Extract authorize field from session.raw (Cync returns it)
 		const raw = session.raw as Record<string, unknown>;
 		const authorize = typeof raw?.authorize === 'string' ? raw.authorize : undefined;
 
 		if (!authorize) {
-			throw new Error('CyncClient: missing "authorize" field from login response; LAN login cannot be generated.');
+			throw new Error(
+				'CyncClient: missing "authorize" field from login response; LAN login cannot be generated.',
+			);
 		}
 
 		const s = session as unknown as SessionWithPossibleTokens;
@@ -320,11 +339,11 @@ export class CyncClient {
 	 * in the same process, so it works across Homebridge restarts.
 	 */
 	public async submitTwoFactor(
-		email: string,
+		username: string,
 		password: string,
 		code: string,
 	): Promise<CyncLoginSession> {
-		const trimmedEmail = email.trim();
+		const trimmedEmail = username.trim();
 		const trimmedCode = code.trim();
 
 		this.log.info('CyncClient: completing 2FA login for %s', trimmedEmail);
@@ -351,7 +370,6 @@ export class CyncClient {
 		return session;
 	}
 
-
 	/**
 	 * Fetch and cache the cloud configuration (meshes/devices) for the logged-in user.
 	 * Also builds HA-style LAN topology mappings:
@@ -409,6 +427,26 @@ export class CyncClient {
 						bulbsArray[0] ? Object.keys(bulbsArray[0] as Record<string, unknown>) : [],
 					);
 
+					// ### 🧩 Bulb Capability Debug: log each bulb so we can classify plugs vs lights
+					bulbsArray.forEach((bulb, index) => {
+						const record = bulb as Record<string, unknown>;
+
+						this.log.debug(
+							'CyncClient: bulb #%d for mesh %s → %o',
+							index,
+							meshName,
+							{
+								displayName: record.displayName,
+								deviceID: record.deviceID ?? record.deviceId,
+								deviceType: record.deviceType,
+								loadSelection: record.loadSelection,
+								defaultBrightness: record.defaultBrightness,
+								lightRingColor: record.lightRingColor,
+								raw: record,
+							},
+						);
+					});
+
 					type RawDevice = Record<string, unknown>;
 					const rawDevices = bulbsArray as unknown[];