@homebridge-plugins/homebridge-eufy-security 0.0.1

package/homebridge-ui/public/services/api.js

@@ -0,0 +1,214 @@
+/**
+ * API service — wraps homebridge.request() and push event listeners.
+ * Communicates with server.ts endpoints.
+ */
+// eslint-disable-next-line no-unused-vars
+const Api = {
+  /** @private Track registered listeners to prevent stacking on re-render */
+  _listeners: {},
+
+  /**
+   * Register an event listener, replacing any previous listener for the same event.
+   * Prevents listener stacking when views re-render.
+   * @param {string} event
+   * @param {function} handler
+   */
+  _on(event, handler) {
+    if (this._listeners[event]) {
+      homebridge.removeEventListener(event, this._listeners[event]);
+    }
+    this._listeners[event] = handler;
+    homebridge.addEventListener(event, handler);
+  },
+
+  /**
+   * Remove a previously registered listener for an event.
+   * Views can call this on teardown to explicitly detach their callbacks.
+   * @param {string} event
+   */
+  _off(event) {
+    if (this._listeners[event]) {
+      homebridge.removeEventListener(event, this._listeners[event]);
+      delete this._listeners[event];
+    }
+  },
+
+  /**
+   * Login with credentials, TFA code, or captcha
+   * @param {object} options - { username, password, country, deviceName } | { verifyCode } | { captcha: { captchaCode, captchaId } }
+   * @returns {Promise<{success: boolean, failReason?: number, data?: any}>}
+   */
+  async login(options) {
+    return homebridge.request('/login', options);
+  },
+
+  /**
+   * Check if a valid persistent cache file exists on the server.
+   * @returns {Promise<{valid: boolean}>}
+   */
+  async checkCache() {
+    return homebridge.request('/checkCache');
+  },
+
+  /**
+   * Load stored accessories from server (cached from last login)
+   * @returns {Promise<Array>} Array of L_Station objects
+   */
+  async loadStoredAccessories() {
+    return homebridge.request('/storedAccessories');
+  },
+
+  /**
+   * Load unsupported device intel from server (raw properties for triage)
+   * @returns {Promise<{devices: Array}>} Array of unsupported device entries
+   */
+  async loadUnsupportedDevices() {
+    return homebridge.request('/unsupportedDevices');
+  },
+
+  /**
+   * Reset plugin data (removes persistent storage)
+   * @returns {Promise<{result: number}>}
+   */
+  async resetPlugin() {
+    return homebridge.request('/reset');
+  },
+
+  /**
+   * Download compressed diagnostics archive (logs + accessories)
+   * @returns {Promise<{buffer: Buffer, filename: string}>}
+   */
+  async downloadDiagnostics() {
+    return homebridge.request('/downloadDiagnostics');
+  },
+
+  /**
+   * Delete all files except persistent data and accessories
+   * @returns {Promise<{deleted: number}>}
+   */
+  async cleanStorage() {
+    return homebridge.request('/cleanStorage');
+  },
+
+  /**
+   * Register a listener for the 'addAccessory' push event.
+   * Fired by server after batch processing completes (~45s after login).
+   * Replaces any previously registered listener.
+   * @param {function} callback - receives array of L_Station objects
+   */
+  onAccessoriesReady(callback) {
+    this._on('addAccessory', (event) => {
+      callback(event.data);
+    });
+  },
+
+  /**
+   * Register a listener for discovery warnings (e.g. extended discovery due to unsupported devices)
+   * @param {function} callback - receives { unsupportedCount, unsupportedNames, waitSeconds, message }
+   */
+  onDiscoveryWarning(callback) {
+    this._on('discoveryWarning', (event) => {
+      callback(event.data);
+    });
+  },
+
+  /**
+   * Register a listener for real-time discovery progress events.
+   * @param {function} callback - receives { phase, stations?, devices?, message }
+   */
+  onDiscoveryProgress(callback) {
+    this._on('discoveryProgress', (event) => {
+      callback(event.data);
+    });
+  },
+  /**
+   * Register a listener for TFA (two-factor auth) request from the server.
+   * Fired when the Eufy server requires a verification code.
+   * @param {function} callback - receives no arguments
+   */
+  onTfaRequest(callback) {
+    this._on('tfaRequest', () => callback());
+  },
+
+  /**
+   * Register a listener for Captcha request from the server.
+   * Fired when the Eufy server requires captcha verification.
+   * @param {function} callback - receives { id, captcha }
+   */
+  onCaptchaRequest(callback) {
+    this._on('captchaRequest', (event) => callback(event.data));
+  },
+
+  /**
+   * Register a listener for successful authentication.
+   * @param {function} callback - receives no arguments
+   */
+  onAuthSuccess(callback) {
+    this._on('authSuccess', () => callback());
+  },
+
+  /**
+   * Register a listener for authentication errors (timeout, bad credentials, etc.).
+   * @param {function} callback - receives { message }
+   */
+  onAuthError(callback) {
+    this._on('authError', (event) => callback(event.data));
+  },
+  /**
+   * Tell the server to skip the unsupported-device intel wait and proceed immediately.
+   * @returns {Promise<{ok: boolean}>}
+   */
+  async skipIntelWait() {
+    return homebridge.request('/skipIntelWait');
+  },
+
+  /**
+   * Get the current discovery state (phase + pending counts).
+   * Used by the discovery UI to catch up on events that fired during login.
+   * @returns {Promise<{phase: string, stations: number, devices: number}>}
+   */
+  async getDiscoveryState() {
+    return homebridge.request('/discoveryState');
+  },
+
+  /**
+   * Register a listener for admin account error.
+   * Replaces any previously registered listener.
+   * @param {function} callback
+   */
+  onAdminAccountUsed(callback) {
+    this._on('AdminAccountUsed', () => {
+      callback();
+    });
+  },
+
+  /**
+   * Register a listener for cache warnings (stale, version mismatch).
+   * Replaces any previously registered listener.
+   * @param {function} callback - receives { reason, ageDays?, currentVersion?, storedVersion? }
+   */
+  onCacheWarning(callback) {
+    this._on('cacheWarning', (event) => {
+      callback(event.data);
+    });
+  },
+
+  /**
+   * Register a listener for diagnostics download progress.
+   * Replaces any previously registered listener.
+   * @param {function} callback - receives { progress, status }
+   */
+  onDiagnosticsProgress(callback) {
+    this._on('diagnosticsProgress', (event) => {
+      callback(event.data);
+    });
+  },
+
+  /**
+   * Get system and environment information for issue reporting
+   * @returns {Promise<{pluginVersion: string, eufyClientVersion: string, homebridgeVersion: string, nodeVersion: string, os: string, devices: Array}>}
+   */
+  async getSystemInfo() {
+    return homebridge.request('/systemInfo');
+  },
+};

package/homebridge-ui/public/services/config.js

@@ -0,0 +1,144 @@
+/**
+ * Config service — wraps homebridge plugin config CRUD operations.
+ * Manages reading/writing plugin configuration via the Homebridge API.
+ */
+// eslint-disable-next-line no-unused-vars
+const Config = {
+  _cache: null,
+
+  /**
+   * Get the current plugin config (first block).
+   * Uses cache if available; call load() to force a fresh read.
+   * @returns {Promise<object>}
+   */
+  async get() {
+    if (this._cache) return this._cache;
+    return this.load();
+  },
+
+  /**
+   * Load config from Homebridge (always fetches fresh, no side-effects).
+   * @returns {Promise<object>}
+   */
+  async load() {
+    const configs = await homebridge.getPluginConfig();
+    this._cache = configs.length > 0 ? configs[0] : {};
+    return this._cache;
+  },
+
+  /**
+   * Update config in memory (does NOT save to disk).
+   * @param {object} config - full config object
+   */
+  async update(config) {
+    this._cache = config;
+    await homebridge.updatePluginConfig([config]);
+  },
+
+  /**
+   * Save current config to disk (config.json).
+   * Call sparingly — only after login or explicit user save.
+   */
+  async save() {
+    await homebridge.savePluginConfig();
+  },
+
+  /**
+   * Update config and immediately save to disk.
+   * @param {object} config
+   */
+  async updateAndSave(config) {
+    await this.update(config);
+    await this.save();
+  },
+
+  /**
+   * Get device config for a specific device by serial number.
+   * @param {string} serialNumber
+   * @returns {object|undefined}
+   */
+  getDeviceConfig(serialNumber) {
+    if (!this._cache) return undefined;
+    const cameras = this._cache.cameras || [];
+    return cameras.find((c) => c.serialNumber === serialNumber);
+  },
+
+  /**
+   * Get station config for a specific station by serial number.
+   * @param {string} serialNumber
+   * @returns {object|undefined}
+   */
+  getStationConfig(serialNumber) {
+    if (!this._cache) return undefined;
+    const stations = this._cache.stations || [];
+    return stations.find((s) => s.serialNumber === serialNumber);
+  },
+
+  /**
+   * Update or create camera config for a device.
+   * @param {string} serialNumber
+   * @param {object} options - config properties to merge
+   */
+  async updateDeviceConfig(serialNumber, options) {
+    const config = this._cache || await this.get();
+    if (!config.cameras) config.cameras = [];
+
+    const idx = config.cameras.findIndex((c) => c.serialNumber === serialNumber);
+    if (idx !== -1) {
+      Object.assign(config.cameras[idx], options);
+    } else {
+      config.cameras.push({ serialNumber, ...options });
+    }
+
+    await this.update(config);
+  },
+
+  /**
+   * Update or create station config.
+   * @param {string} serialNumber
+   * @param {object} options - config properties to merge
+   */
+  async updateStationConfig(serialNumber, options) {
+    const config = this._cache || await this.get();
+    if (!config.stations) config.stations = [];
+
+    const idx = config.stations.findIndex((s) => s.serialNumber === serialNumber);
+    if (idx !== -1) {
+      Object.assign(config.stations[idx], options);
+    } else {
+      config.stations.push({ serialNumber, ...options });
+    }
+
+    await this.update(config);
+  },
+
+  /**
+   * Update global config options (top-level properties).
+   * @param {object} options - properties to merge into top-level config
+   */
+  async updateGlobal(options) {
+    const config = this._cache || await this.get();
+    Object.assign(config, options);
+    await this.update(config);
+  },
+
+  /**
+   * Toggle a device in the ignore list.
+   * @param {string} serialNumber
+   * @param {boolean} ignored - true to ignore, false to un-ignore
+   * @param {'device'|'station'} type
+   */
+  async toggleIgnore(serialNumber, ignored, type) {
+    const config = this._cache || await this.get();
+    const key = type === 'device' ? 'ignoreDevices' : 'ignoreStations';
+    if (!config[key]) config[key] = [];
+
+    if (ignored && !config[key].includes(serialNumber)) {
+      config[key].push(serialNumber);
+    } else if (!ignored) {
+      config[key] = config[key].filter((id) => id !== serialNumber);
+    }
+
+    await this.update(config);
+  },
+};