@mega-yfue/eufy-sdk 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 mega-yfue
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,115 @@
+<div align="center">
+
+<!--
+  The suffix names the MODE, not the ink: logo-dark.svg is the white glyph for a dark background,
+  logo.svg the near-black one for a light background. The fallback <img> must be the light-mode file,
+  since that is what any renderer without prefers-color-scheme support will show.
+-->
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/mega-yfue/eufy-sdk/main/docs/public/logo-dark.svg">
+  <img src="https://raw.githubusercontent.com/mega-yfue/eufy-sdk/main/docs/public/logo.svg" alt="eufy-sdk" height="72">
+</picture>
+
+**One typed client for the whole eufy ecosystem — devices, realtime events, and live media.**
+
+[Documentation](https://mega-yfue.github.io/) · [Contributing](./CONTRIBUTING.md) · [Changelog](./CHANGELOG.md)
+
+</div>
+
+---
+
+> [!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`.
+
+## What it is
+
+A TypeScript SDK for the eufy cloud that the current eufy app speaks. It logs in (captcha and 2FA
+included), keeps a **persistent session**, and models every device as a capability-driven `Device`
+you drive through a **typed, fluent API**:
+
+```ts
+const dev = await eufy.getDevice(sn);
+
+await dev.camera()?.snapshot();
+await dev.panTilt()?.rotate(PtzDirection.left);
+await dev.light()?.setBrightness(60);
+
+eufy.on("motion", (e) => console.log(e.device.name, "saw something"));
+```
+
+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.
+
+The SDK targets the **whole** ecosystem — security, robot vacuums and mowers, smart lights — not just
+cameras. Devices are classified dynamically from what the account reports, so there is no per-model
+code path and an unlisted or future device resolves the same way as a known one.
+
+## Install
+
+Once published:
+
+```bash
+npm install @mega-yfue/eufy-sdk
+```
+
+**Node.js ≥ 24.5.0** is required, not just recommended (see [`.nvmrc`](./.nvmrc)). `ffmpeg` is
+optional — only the JPEG-snapshot, one-shot mp4 record and WebRTC container-output paths use it.
+
+## Documentation
+
+The guides at **<https://mega-yfue.github.io/>** are the source of truth; this README stays a thin
+landing page. They cover installing and logging in, devices and capabilities, events and realtime
+transports, consuming live media, and the generated API reference. Runnable, typechecked samples live
+in [`examples/`](./examples/).
+
+## Design
+
+Four layers, one dependency direction — `core` → `transport` → `model` → `client`:
+
+```
+src/
+  core/         shared floor: crypto, cross-layer contracts, value types, session store
+  transport/    every byte-on-a-wire module: http, mqtt, p2p, push, webrtc
+  model/        Device + one self-contained module per capability
+  client/       the facade: login, device registry, event fan-out
+  index.ts      public surface — one `export *` per layer barrel
+```
+
+**Capability ↔ transport decorrelation is a hard, CI-enforced rule:** `model/` never imports
+`transport/` and vice versa. A capability describes what a value MEANS; a transport moves bytes and
+never names a feature. Anything genuinely shared is a contract in `core/`. That rule and the rest of
+the code practice are in [AGENTS.md](./AGENTS.md).
+
+Three runtime dependencies — `mqtt`, `protobufjs`, `werift` — and that is deliberate. HTTP is native
+`fetch`, hashing and ciphers are `node:crypto`, 64-bit integers are `BigInt`.
+
+**Unverified write paths throw rather than guess.** Some writes are fire-and-forget, so a guessed
+frame looks exactly like success; the SDK refuses instead of pretending.
+
+## Develop
+
+```bash
+nvm use            # Node 24.5.0
+npm install
+npm run verify     # the full CI gate in one command — run it green before a PR
+```
+
+## Contributing
+
+PRs welcome. [CONTRIBUTING.md](./CONTRIBUTING.md) covers setup, the dev workflow and the PR process;
+[AGENTS.md](./AGENTS.md) is the code practice — the architecture invariants and the rules CI enforces.
+Security issues go through [SECURITY.md](./SECURITY.md), never a public issue.
+
+## License
+
+[Apache-2.0](./LICENSE). Contributions are accepted under the same license (inbound = outbound).
+
+## Disclaimer
+
+Independent and unofficial, built for interoperability with eufy devices you own. **Not affiliated
+with, endorsed by, or sponsored by Anker Innovations or eufy.** "eufy" and "Anker" are trademarks of
+their respective owners and appear here only to identify the hardware this SDK talks to. Use
+responsibly — rapid or failed logins can trigger a captcha or a temporary cooldown.

package/dist/client/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The facade: login, session lifecycle, the device registry, and the realtime event surface.
+ *
+ * This is what a caller imports; the layers below it are implementation detail.
+ */
+export {};

package/dist/client/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":""}

package/dist/core/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Shared primitives: crypto, cross-layer contracts, value types, session store, logging, utilities.
+ *
+ * `core/` is the only layer both `model/` and `transport/` may depend on, which is what keeps the
+ * two decorrelated.
+ */
+export {};

package/dist/core/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/core/index.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Public entry point of the SDK.
+ *
+ * The library is split into four layers, each behind its own barrel. `model/` and `transport/` are
+ * decorrelated by design — neither imports the other, and anything genuinely shared between them is
+ * a contract in `core/`. `client/` is the facade a caller actually holds.
+ *
+ * The layers are empty in this scaffold commit; the implementation lands with the source move.
+ */
+export * from "./core/index.js";
+export * from "./transport/index.js";
+export * from "./model/index.js";
+export * from "./client/index.js";

package/dist/index.js

@@ -0,0 +1,14 @@
+/**
+ * Public entry point of the SDK.
+ *
+ * The library is split into four layers, each behind its own barrel. `model/` and `transport/` are
+ * decorrelated by design — neither imports the other, and anything genuinely shared between them is
+ * a contract in `core/`. `client/` is the facade a caller actually holds.
+ *
+ * The layers are empty in this scaffold commit; the implementation lands with the source move.
+ */
+export * from "./core/index.js";
+export * from "./transport/index.js";
+export * from "./model/index.js";
+export * from "./client/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/dist/model/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Device domain: the `Device` record, its capabilities, classification, events and parameters.
+ *
+ * Describes what a device MEANS, never how it is spoken to. It never imports `transport/` or a wire
+ * library.
+ */
+export {};

package/dist/model/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/model/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/model/index.ts"],"names":[],"mappings":""}

package/dist/transport/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Wire layer: HTTP, MQTT, P2P, push and WebRTC.
+ *
+ * Owns framing in both directions and every wire identifier. It never imports `model/` — a
+ * capability's vocabulary stops at the contract boundary in `core/`.
+ */
+export {};

package/dist/transport/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/transport/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/transport/index.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,86 @@
+{
+  "name": "@mega-yfue/eufy-sdk",
+  "version": "0.0.1",
+  "description": "One typed TypeScript client for the eufy v6 cloud — capability-driven devices, realtime events over P2P/MQTT/push, and live media",
+  "license": "Apache-2.0",
+  "author": "mega-yfue",
+  "contributors": [
+    "max246",
+    "lenoxys",
+    "martijnpoppen"
+  ],
+  "keywords": [
+    "eufy",
+    "anker",
+    "eufy-security",
+    "smart-home",
+    "camera",
+    "doorbell",
+    "vacuum",
+    "smart-light",
+    "p2p",
+    "mqtt",
+    "webrtc",
+    "typescript",
+    "sdk"
+  ],
+  "homepage": "https://mega-yfue.github.io/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/mega-yfue/eufy-sdk.git"
+  },
+  "bugs": {
+    "url": "https://github.com/mega-yfue/eufy-sdk/issues"
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prebuild": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\"",
+    "build": "tsc -p tsconfig.build.json",
+    "dev": "tsc -p tsconfig.build.json --watch",
+    "typecheck": "tsc --noEmit",
+    "typecheck:examples": "tsc -p examples/tsconfig.json",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "guard:consumer-agnostic": "bash scripts/ci/guard-consumer-agnostic.sh",
+    "guard:decorrelation": "bash scripts/ci/guard-decorrelation.sh",
+    "guard:docrefs": "bash scripts/ci/guard-doc-refs.sh",
+    "guard:lines": "bash scripts/ci/guard-lines.sh",
+    "guard:seal": "bash scripts/ci/guard-seal.sh",
+    "check:esm": "node -e \"import('./dist/index.js').then(m=>console.log('ESM OK:',Object.keys(m).length,'exports'))\"",
+    "verify": "npm run format:check && npm run typecheck && npm run guard:decorrelation && npm run guard:lines && npm run guard:docrefs && npm run guard:consumer-agnostic && npm run build && npm run guard:seal && npm run check:esm && npm run typecheck:examples && npm test"
+  },
+  "engines": {
+    "node": ">=24.5.0"
+  },
+  "dependencies": {
+    "mqtt": "^5.15.2",
+    "protobufjs": "^8.7.1",
+    "werift": "^0.24.2"
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.2",
+    "prettier": "^3.9.6",
+    "typescript": "^7.0.2",
+    "vitest": "^4.1.10"
+  },
+  "allowScripts": {
+    "esbuild@0.28.1": true,
+    "unrs-resolver@1.12.2": true
+  }
+}