@mega-yfue/eufy-sdk 0.1.0 → 0.1.1-beta.0

package/README.md

@@ -23,10 +23,9 @@
 
 ---
 
-> [!IMPORTANT]
-> **Not usable yet.** This repository is being set up: the scaffold, the CI gate and the docs pipeline
-> are in place, the library source lands next. `0.0.1` exists on npm only to prove the release
-> pipeline works — it is an empty package. Wait for `0.1.0`.
+> [!NOTE]
+> Pre-1.0, so a minor bump may break: old shapes are removed rather than kept beside their
+> replacements. Each release's notes state what changed — see [Releases][releases].
 
 ## What it is
 
@@ -37,14 +36,18 @@ you drive through a **typed, fluent API**:
 ```ts
 const dev = await eufy.getDevice(sn);
 
-const stored = await dev.camera()?.snapshotStored?.(); // latest retained push JPEG
-const fresh = await dev.camera()?.snapshotLive(); // explicit fresh live capture
-await dev.panTilt()?.rotate(PtzDirection.left);
-await dev.light()?.setBrightness(60);
+const stored = await dev.camera?.()?.snapshotStored?.(); // latest retained push JPEG
+const fresh = await dev.camera?.()?.snapshotLive?.(); // explicit fresh live capture
+await dev.ptz?.()?.rotate(PtzDirection.left);
+await dev.light?.()?.setBrightness(60);
 
-eufy.on("motion", (e) => console.log(e.device.name, "saw something"));
+eufy.on("motion", (e) => console.log(e.deviceSn, "saw something"));
 ```
 
+Every accessor and every method is optional because both are **evidence-gated**: a device advertises
+exactly what it reported, so `?.` is not defensive style here — it is the type telling you the feature
+may not be there.
+
 Realtime arrives over **P2P** (cameras and HomeBases), **secure MQTT** (appliances) and **push**
 (events), all surfaced as typed semantic events. Live **video streaming** works, with one shared pull
 fanned out to every consumer.
@@ -132,3 +135,5 @@ temporary cooldown.
 The vendor now brands the line **Anker eufy**; "eufy" alone is the short form and still the name on
 the wire (`eufy_security`, `eufy_life`, `eufy_mega`) and in every product name (eufyCam, eufy Clean,
 eufy Life). Protocol vocabulary follows the device, not the marketing, so those are not renamed here.
+
+[releases]: https://github.com/mega-yfue/eufy-sdk/releases

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mega-yfue/eufy-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1-beta.0",
   "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",