@mega-yfue/eufy-sdk 0.3.0-beta.4 → 0.3.0-beta.5

package/dist/transport/push/push-client.d.ts

@@ -10,6 +10,10 @@ import type { FcmCredentials, PushEvent, RawPushMessage } from "./types.js";
 import { type Logger } from "../../core/logger.js";
 /**
  * Normalises a decoded eufy envelope without consulting device semantics; semantic event names remain unset.
+ *
+ * The detail (`event_type`, `pic_url`, `cipher`) is read from the deepest level of
+ * `payloadLevels`; identity (`device_sn`, `station_sn`) is gathered from every level, deepest
+ * first, so a serial is found whichever level the push carries it on.
  * @internal
  */
 export declare function normalizePushEvent(raw: RawPushMessage): PushEvent;
@@ -55,6 +59,13 @@ export declare class PushClient extends EventEmitter {
      * {@link MAX_LOGIN_FAILURES} consecutive attempts (creds genuinely stale) is it emitted as `error`.
      */
     private onLoginError;
+    /**
+     * Decode one MCS `DataMessageStanza` into a {@link RawPushMessage} and the normalised event.
+     *
+     * `payload` carries the whole app_data envelope, with its `payload` entry (base64 of NUL-terminated
+     * JSON) parsed in place: the envelope's own keys, `device_sn` and `station_sn` among them, sit beside
+     * that entry.
+     */
     private handleDataMessage;
     private startHeartbeat;
     private stopHeartbeat;

package/dist/transport/push/types.d.ts

@@ -1,11 +1,11 @@
 /**
  * eufy FCM push payload types.
  *
- * A push arrives as an MCS DataMessageStanza whose `app_data` has a `payload`
- * entry = base64( NUL-terminated JSON ). That JSON is the EufyPushMessage; its
- * nested `payload` is device-type specific. The v6 app enriches these with AI
- * detection fields (person/vehicle/pet/package/faces/crops/short video) — see
- * PushEnrichment.
+ * A push arrives as an MCS DataMessageStanza whose `app_data` entries make up the
+ * EufyPushMessage envelope. Its `payload` entry is base64( NUL-terminated JSON ), the
+ * device-type specific detail, which may itself nest a further `payload`. The v6 app
+ * enriches these with AI detection fields (person/vehicle/pet/package/faces/crops/short
+ * video) — see PushEnrichment.
  */
 /**
  * Raw MCS frame: a tag + the decoded protobuf object.
@@ -31,10 +31,10 @@ export interface RawPushMessage {
     persistentId?: string;
     ttl?: number;
     sent?: string;
-    /** The decoded eufy payload (the `payload` app_data entry, JSON-parsed). */
+    /** The eufy envelope, as `EufyPushMessage` describes it. */
     payload: EufyPushMessage;
 }
-/** The eufy JSON envelope inside the push. */
+/** The eufy envelope: the push's `app_data` entries, with the `payload` entry JSON-parsed in place. */
 export interface EufyPushMessage {
     type?: string | number;
     title?: string;
@@ -45,7 +45,7 @@ export interface EufyPushMessage {
     push_time?: string;
     doorbell?: string;
     "google.c.sender.id"?: string;
-    /** Device-type specific body (often a JSON string that we further parse). */
+    /** The decoded `payload` entry: device-type specific detail, which may nest a further `payload`. */
     payload?: PushPayload;
     [k: string]: unknown;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mega-yfue/eufy-sdk",
-  "version": "0.3.0-beta.4",
+  "version": "0.3.0-beta.5",
   "description": "One typed TypeScript client for the Anker eufy v6 cloud — capability-driven devices, realtime events over P2P/MQTT/push, and live media",
   "license": "Apache-2.0",
   "author": "mega-yfue",