@camera.ui/sdk 0.0.4 → 0.0.7

package/dist/internal/index.d.ts

@@ -547,8 +547,9 @@ interface PluginContract {
      */
     pythonVersion?: PythonVersion;
     /**
-     * Extra package dependencies installed into the plugin's runtime (PyPI
-     *  for Python plugins, npm for Node plugins).
+     * Extra package dependencies installed into the plugin's runtime (Go
+     *  module paths for Go plugins; PyPI / npm names for Python and Node
+     *  plugins).
      */
     dependencies?: string[];
 }

package/dist/observable/index.js

@@ -5,7 +5,6 @@
  * ReplaySubject) and a small set of composable operators for building
  * property-change notifications and event streams throughout the SDK.
  */
-// ── Disposable ───────────────────────────────────────────────────────
 /**
  * Subscription handle returned by `subscribe()`.
  *
@@ -32,7 +31,6 @@ export class Disposable {
         this.dispose();
     }
 }
-// ── Observable ───────────────────────────────────────────────────────
 /**
  * Cold producer of a push-based value stream.
  *
@@ -74,7 +72,6 @@ export class Observable {
         return result;
     }
 }
-// ── Subject ──────────────────────────────────────────────────────────
 /**
  * Multicast value source.
  *
@@ -85,6 +82,7 @@ export class Observable {
  */
 export class Subject {
     #subscribers = new Set();
+    #completeHandlers = new Set();
     #completed = false;
     get closed() {
         return this.#completed;
@@ -101,6 +99,31 @@ export class Subject {
             return;
         this.#completed = true;
         this.#subscribers.clear();
+        const handlers = [...this.#completeHandlers];
+        this.#completeHandlers.clear();
+        for (const handler of handlers) {
+            handler();
+        }
+    }
+    /**
+     * Register a handler invoked once when this Subject completes. Runs
+     * immediately if already completed. Used by {@link firstValueFrom}.
+     *
+     * @internal
+     *
+     * @param handler - Completion callback.
+     *
+     * @returns Disposable that cancels the registration.
+     */
+    _onComplete(handler) {
+        if (this.#completed) {
+            handler();
+            return new Disposable(() => { });
+        }
+        this.#completeHandlers.add(handler);
+        return new Disposable(() => {
+            this.#completeHandlers.delete(handler);
+        });
     }
     subscribe(callback) {
         if (this.#completed) {
@@ -135,7 +158,6 @@ export class Subject {
         return new Observable((cb) => this.subscribe(cb));
     }
 }
-// ── BehaviorSubject ──────────────────────────────────────────────────
 /**
  * Subject seeded with an initial value that always remembers the latest
  * emission. New subscribers receive the current value immediately on
@@ -166,7 +188,6 @@ export class BehaviorSubject extends Subject {
         return disposable;
     }
 }
-// ── ReplaySubject ────────────────────────────────────────────────────
 /**
  * Subject that buffers up to the last `bufferSize` values (configurable,
  * defaults to unbounded). New subscribers immediately receive every
@@ -196,7 +217,6 @@ export class ReplaySubject extends Subject {
         return super.subscribe(callback);
     }
 }
-// ── Operators ────────────────────────────────────────────────────────
 /**
  * Emit only the values for which `predicate` returns `true`.
  *
@@ -372,11 +392,12 @@ export function share(config) {
         });
     };
 }
-// ── Utilities ────────────────────────────────────────────────────────
 /**
  * Subscribe to the source and return a Promise that resolves with its first
- * emitted value, then disposes the subscription. Rejects if the source has
- * already completed without emitting.
+ * emitted value, then disposes the subscription. Rejects if the source
+ * completes before emitting (Subject, BehaviorSubject, ReplaySubject). A bare
+ * Observable has no completion signal, so the Promise stays pending until it
+ * emits.
  *
  * @param observable - Source stream to await.
  *
@@ -392,28 +413,35 @@ export function share(config) {
  */
 export function firstValueFrom(observable) {
     return new Promise((resolve, reject) => {
-        let resolved = false;
-        // The callback may fire synchronously during subscribe() (BehaviorSubject/
-        // ReplaySubject), so declare sub up front to avoid the temporal dead zone.
-        let sub = undefined;
-        sub = observable.subscribe((value) => {
-            if (!resolved) {
-                resolved = true;
-                // sub may not be assigned yet if value is emitted synchronously (BehaviorSubject/ReplaySubject)
-                if (sub) {
-                    sub.dispose();
-                }
-                resolve(value);
-            }
+        let settled = false;
+        // Callbacks may fire synchronously during subscribe()/_onComplete()
+        // (BehaviorSubject/ReplaySubject/already-completed), so declare the
+        // handles up front and clean up both on settle.
+        let valueSub = undefined;
+        let completeSub = undefined;
+        const cleanup = () => {
+            valueSub?.dispose();
+            completeSub?.dispose();
+        };
+        valueSub = observable.subscribe((value) => {
+            if (settled)
+                return;
+            settled = true;
+            cleanup();
+            resolve(value);
         });
-        // Already resolved synchronously — clean up immediately
-        if (resolved) {
-            sub.dispose();
+        if (settled) {
+            cleanup();
             return;
         }
-        // If the observable completed without emitting (closed subject)
-        if ('closed' in observable && observable.closed && !resolved) {
-            reject(new Error('Observable completed without emitting a value'));
+        if (observable instanceof Subject) {
+            completeSub = observable._onComplete(() => {
+                if (settled)
+                    return;
+                settled = true;
+                cleanup();
+                reject(new Error('Observable completed without emitting a value'));
+            });
         }
     });
 }

package/dist/plugin/interfaces.js

@@ -29,8 +29,6 @@
  *   }
  * }
  * ```
- *
- * @see /examples/getting-started — end-to-end walkthrough.
  */
 export class BasePlugin {
     logger;

package/dist/sensor/battery.js

@@ -24,9 +24,13 @@ export var BatteryProperty;
 /** Battery charging state */
 export var ChargingState;
 (function (ChargingState) {
+    /** Device has no rechargeable battery */
     ChargingState["NotChargeable"] = "NOT_CHARGEABLE";
+    /** Battery is not charging */
     ChargingState["NotCharging"] = "NOT_CHARGING";
+    /** Battery is currently charging */
     ChargingState["Charging"] = "CHARGING";
+    /** Battery is fully charged */
     ChargingState["Full"] = "FULL";
 })(ChargingState || (ChargingState = {}));
 /**

package/dist/sensor/securitySystem.js

@@ -2,10 +2,15 @@ import { Sensor, SensorType, SensorCategory } from './base.js';
 /** Security system arm/disarm states (HomeKit-compatible values) */
 export var SecuritySystemState;
 (function (SecuritySystemState) {
+    /** Armed, occupants home */
     SecuritySystemState[SecuritySystemState["StayArm"] = 0] = "StayArm";
+    /** Armed, occupants away */
     SecuritySystemState[SecuritySystemState["AwayArm"] = 1] = "AwayArm";
+    /** Armed for night mode */
     SecuritySystemState[SecuritySystemState["NightArm"] = 2] = "NightArm";
+    /** System disarmed */
     SecuritySystemState[SecuritySystemState["Disarmed"] = 3] = "Disarmed";
+    /** Alarm is triggered */
     SecuritySystemState[SecuritySystemState["AlarmTriggered"] = 4] = "AlarmTriggered";
 })(SecuritySystemState || (SecuritySystemState = {}));
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camera.ui/sdk",
-  "version": "0.0.4",
+  "version": "0.0.7",
   "description": "camera.ui sdk",
   "exports": {
     ".": {
@@ -21,14 +21,13 @@
     "docs:build": "npm run predocs && rimraf docs/.vitepress/dist && vitepress build docs && cpy --flat docs/logo.png docs/.vitepress/dist",
     "docs:preview": "npm run predocs && vitepress preview docs --port 5274",
     "format": "prettier --write 'src/' --ignore-unknown --no-error-on-unmatched-pattern",
+    "install-updates": "npm i --save",
     "lint": "eslint .",
-    "type-check": "tsc --noEmit --project tsconfig.node.json",
     "lint:fix": "eslint --fix .",
-    "test": "vitest run",
-    "update": "updates --update ./",
-    "install-updates": "npm i --save",
     "predocs": "typedoc && node scripts/build-example-docs.mjs",
-    "prepublishOnly": "npm i --package-lock-only && npm run lint:fix && npm run format && npm run build"
+    "prepublishOnly": "npm i --package-lock-only && npm run lint:fix && npm run format && npm run build",
+    "test": "vitest run",
+    "type-check": "tsc --noEmit --project tsconfig.node.json"
   },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^16.0.3",
@@ -36,22 +35,20 @@
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/multicast-dns": "^7.2.4",
     "@types/node": "25.9.3",
-    "@typescript-eslint/parser": "^8.61.0",
+    "@typescript-eslint/parser": "^8.61.1",
     "cpy-cli": "^7.0.0",
     "eslint": "9.39.2",
-    "eslint-plugin-jsdoc": "^63.0.2",
+    "eslint-plugin-jsdoc": "^63.0.6",
     "globals": "^17.6.0",
     "prettier": "^3.8.4",
     "rimraf": "^6.1.3",
     "rollup": "^4.62.0",
     "rollup-plugin-dts": "^6.4.1",
-    "sharp": "^0.35.1",
     "tsyringe": "^4.10.0",
     "typedoc-plugin-markdown": "^4.12.0",
     "typedoc-vitepress-theme": "^1.1.3",
     "typescript": "5.9.3",
-    "typescript-eslint": "^8.61.0",
-    "updates": "^17.18.0",
+    "typescript-eslint": "^8.61.1",
     "vitepress": "^1.6.4",
     "vitest": "^4.1.9",
     "werift": "0.23.0",

package/CHANGELOG.md

@@ -1,8 +0,0 @@
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [X.X.X] - ???
-
-- Initial Release

package/CONTRIBUTING.md

@@ -1 +0,0 @@
-# Contributing

package/docs/.vitepress/config.ts

@@ -1,77 +0,0 @@
-import { createRequire } from 'node:module';
-import { defineConfig } from 'vitepress';
-
-const require = createRequire(import.meta.url);
-const typedocSidebar = require('../api/typedoc-sidebar.json');
-
-// https://vitepress.dev/reference/site-config
-export default defineConfig({
-  srcDir: '.',
-  base: '/sdk/node/',
-  title: 'camera.ui Node SDK',
-  description: 'TypeScript SDK for building camera.ui plugins',
-  lastUpdated: true,
-  head: [
-    ['link', { rel: 'icon', type: 'image/x-icon', sizes: '32x32', href: '/sdk/node/favicon.ico' }],
-    ['link', { rel: 'icon', type: 'image/x-icon', sizes: '16x16', href: '/sdk/node/favicon-16.ico' }],
-    ['link', { rel: 'apple-touch-icon', sizes: '180x180', href: '/sdk/node/apple-touch-icon.png' }],
-    ['meta', { name: 'theme-color', content: '#df2a4c' }],
-  ],
-  themeConfig: {
-    logo: '/logo.svg',
-
-    // typedocSidebar entries are alphabetical:
-    //   [0] camera, [1] manager, [2] observable, [3] plugin,
-    //   [4] sensor, [5] storage, [6] types
-    sidebar: [
-      {
-        text: 'Plugin API',
-        items: typedocSidebar[3].items,
-      },
-      {
-        text: 'Camera',
-        items: typedocSidebar[0].items,
-      },
-      {
-        text: 'Sensors',
-        items: typedocSidebar[4].items,
-      },
-      {
-        text: 'Storage & Schema',
-        items: typedocSidebar[5].items,
-      },
-      {
-        text: 'Manager',
-        items: typedocSidebar[1].items,
-      },
-      {
-        text: 'Observable',
-        items: typedocSidebar[2].items,
-      },
-      {
-        text: 'Types',
-        items: typedocSidebar[6].items,
-      },
-      {
-        text: 'Plugin Guide',
-        link: '/examples/getting-started',
-      },
-    ],
-
-    search: {
-      provider: 'local',
-    },
-
-    socialLinks: [
-      { icon: 'github', link: 'https://github.com/seydx/camera.ui' },
-      { icon: 'discord', link: 'https://discord.gg/bBGnGcbz8N' },
-      {
-        icon: {
-          svg: '<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20"><path fill="currentColor" d="M20 10.04a2.18 2.18 0 0 0-3.7-1.55a10.7 10.7 0 0 0-5.79-1.83l.99-4.65l3.23.69a1.55 1.55 0 1 0 .15-.74l-3.59-.76a.37.37 0 0 0-.44.28l-1.1 5.18a10.74 10.74 0 0 0-5.87 1.83a2.19 2.19 0 1 0-2.41 3.59a4 4 0 0 0-.05.66c0 3.36 3.91 6.09 8.74 6.09s8.74-2.73 8.74-6.09a4 4 0 0 0-.05-.66A2.19 2.19 0 0 0 20 10.04m-15 1.56a1.56 1.56 0 1 1 1.56 1.56A1.56 1.56 0 0 1 5 11.6m8.71 4.13c-1.07.81-2.39 1.21-3.71 1.16a5.85 5.85 0 0 1-3.71-1.16a.4.4 0 1 1 .55-.59A4.94 4.94 0 0 0 10 16.1a4.94 4.94 0 0 0 3.16-.96a.41.41 0 0 1 .57.04a.41.41 0 0 1-.02.55m-.16-2.55a1.56 1.56 0 1 1 1.56-1.56a1.56 1.56 0 0 1-1.55 1.56z"/></svg>',
-        },
-        link: 'https://www.reddit.com/r/cameraui/',
-        ariaLabel: 'Reddit',
-      },
-    ],
-  },
-});

package/docs/.vitepress/theme/index.ts

@@ -1,5 +0,0 @@
-import DefaultTheme from 'vitepress/theme';
-
-import './style.css';
-
-export default DefaultTheme;

package/docs/.vitepress/theme/style.css

@@ -1,117 +0,0 @@
-@import 'vitepress/dist/client/theme-default/styles/vars.css';
-
-/* camera.ui brand colors — mirror ui/src/plugins/preset.ts */
-:root {
-  --cui-primary-50: #fdf4f6;
-  --cui-primary-100: #f7ccd4;
-  --cui-primary-200: #f1a3b2;
-  --cui-primary-300: #eb7b90;
-  --cui-primary-400: #e5526e;
-  --cui-primary-500: #df2a4c;
-  --cui-primary-600: #be2441;
-  --cui-primary-700: #9c1d35;
-  --cui-primary-800: #7b172a;
-  --cui-primary-900: #59111e;
-  --cui-primary-950: #380b13;
-}
-
-:root {
-  --vp-c-brand-1: var(--cui-primary-500);
-  --vp-c-brand-2: var(--cui-primary-600);
-  --vp-c-brand-3: var(--cui-primary-700);
-  --vp-c-brand-soft: rgba(223, 42, 76, 0.14);
-
-  --vp-c-default-1: var(--vp-c-gray-1);
-  --vp-c-default-2: var(--vp-c-gray-2);
-  --vp-c-default-3: var(--vp-c-gray-3);
-  --vp-c-default-soft: var(--vp-c-gray-soft);
-
-  --vp-button-brand-border: transparent;
-  --vp-button-brand-text: #ffffff;
-  --vp-button-brand-bg: var(--cui-primary-500);
-  --vp-button-brand-hover-border: transparent;
-  --vp-button-brand-hover-text: #ffffff;
-  --vp-button-brand-hover-bg: var(--cui-primary-600);
-  --vp-button-brand-active-border: transparent;
-  --vp-button-brand-active-text: #ffffff;
-  --vp-button-brand-active-bg: var(--cui-primary-700);
-
-  --vp-home-hero-name-color: transparent;
-  --vp-home-hero-name-background: linear-gradient(
-    135deg,
-    var(--cui-primary-500) 0%,
-    var(--cui-primary-700) 100%
-  );
-  --vp-home-hero-image-background-image: linear-gradient(
-    135deg,
-    rgba(223, 42, 76, 0.32) 0%,
-    rgba(123, 23, 42, 0.32) 100%
-  );
-  --vp-home-hero-image-filter: blur(56px);
-
-  --vp-custom-block-tip-border: transparent;
-  --vp-custom-block-tip-text: var(--cui-primary-700);
-  --vp-custom-block-tip-bg: var(--vp-c-brand-soft);
-  --vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
-}
-
-/* dark surface palette mirrors ui preset.ts (neutral grey, not slate) */
-.dark {
-  --cui-surface-0: #ffffff;
-  --cui-surface-50: #f5f5f5;
-  --cui-surface-100: #d1d1d1;
-  --cui-surface-200: #adadad;
-  --cui-surface-300: #898989;
-  --cui-surface-400: #646464;
-  --cui-surface-500: #404040;
-  --cui-surface-600: #363636;
-  --cui-surface-700: #2d2d2d;
-  --cui-surface-800: #232323;
-  --cui-surface-850: #1d1d1d;
-  --cui-surface-900: #1a1a1a;
-  --cui-surface-925: #161616;
-  --cui-surface-950: #101010;
-  --cui-surface-1000: #0d0d0d;
-
-  --vp-c-brand-1: var(--cui-primary-400);
-  --vp-c-brand-2: var(--cui-primary-300);
-  --vp-c-brand-3: var(--cui-primary-200);
-  --vp-c-brand-soft: rgba(229, 82, 110, 0.16);
-
-  --vp-c-bg: var(--cui-surface-900);
-  --vp-c-bg-alt: var(--cui-surface-950);
-  --vp-c-bg-elv: var(--cui-surface-800);
-  --vp-c-bg-soft: var(--cui-surface-850);
-
-  --vp-c-divider: var(--cui-surface-800);
-  --vp-c-gutter: var(--cui-surface-950);
-  --vp-c-border: var(--cui-surface-700);
-
-  --vp-c-default-1: var(--cui-surface-800);
-  --vp-c-default-2: var(--cui-surface-700);
-  --vp-c-default-3: var(--cui-surface-600);
-  --vp-c-default-soft: rgba(64, 64, 64, 0.4);
-
-  --vp-c-text-1: rgba(255, 255, 255, 0.92);
-  --vp-c-text-2: rgba(255, 255, 255, 0.66);
-  --vp-c-text-3: rgba(255, 255, 255, 0.42);
-
-  --vp-code-bg: var(--cui-surface-925);
-  --vp-code-block-bg: var(--cui-surface-925);
-
-  --vp-button-brand-text: #ffffff;
-  --vp-button-brand-bg: var(--cui-primary-500);
-  --vp-button-brand-hover-bg: var(--cui-primary-400);
-  --vp-button-brand-active-bg: var(--cui-primary-600);
-
-  --vp-custom-block-tip-text: var(--cui-primary-200);
-}
-
-/* Pull search/box accents in line with brand */
-.dark .DocSearch {
-  --docsearch-primary-color: var(--cui-primary-400);
-}
-
-.DocSearch {
-  --docsearch-primary-color: var(--cui-primary-500);
-}

package/docs/index.md

@@ -1,16 +0,0 @@
-# camera.ui Node SDK
-
-TypeScript SDK for building plugins that extend [camera.ui](https://github.com/seydx/camera.ui) — add cameras, run motion / object / face / license-plate / audio detection, deliver notifications, and more.
-
-## Install
-
-```bash
-npm install @camera.ui/sdk
-```
-
-## Next steps
-
-- **[Plugin Guide](/examples/getting-started)** — everything you need to ship a Node plugin in one page: contract, lifecycle, sensors, storage, optional interfaces.
-- **[API Reference](/api/)** — module-by-module reference auto-generated from JSDoc.
-
-For complete production plugins to study, see [`plugins/`](https://github.com/seydx/camera.ui/tree/main/plugins) in the camera.ui repo.

package/docs/public/logo.svg

@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 233.63 233.63"><defs><style>.cls-1{fill:url(#dark_wine);}.cls-2{fill:url(#light_wine);}.cls-3{fill:none;stroke:#000;stroke-miterlimit:10;opacity:0;}.cls-4{fill:#c5c6c8;}.cls-5{fill:#1a1e21;stroke:#3a3a3a;stroke-width:2px;}.cls-6{fill:#fff;}</style><linearGradient id="dark_wine" x1="87.36" y1="158.67" x2="87.36" y2="59.85" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#730000"/><stop offset="0.49" stop-color="#a51733"/></linearGradient><linearGradient id="light_wine" x1="113.06" y1="197.59" x2="113.06" y2="80.87" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#f44a6b"/><stop offset="0.28" stop-color="#df294c"/></linearGradient></defs><g id="CameraUI_U"><path id="U_Left" class="cls-1" d="M47.05,119.47s7.58,16,14.12,23.42a45.28,45.28,0,0,0,16.37,11.86A49.46,49.46,0,0,0,99,158.62c9.43-.46,20.55-3.87,29.24-11.86-3.9,2.5-9.87,5.1-15.9,4.77a25.63,25.63,0,0,1-18.38-9.09c-9.39-10.31-7.62-28.35-7.75-32.68-.35-11.42.77-21.92-1.76-36.19-.46-2.64-1.79-5.19-4.55-8-1.83-1.86-8.4-5.75-13.42-5.74-7.31,0-12.95,3.71-15.38,7.84-2,3.41-3.06,4.22-4.23,25.08a217.23,217.23,0,0,0,.22,26.76Z" transform="translate(0.5 0.5)"/><path id="U_Right" class="cls-2" d="M144.12,89.6a16.24,16.24,0,0,1,4.06-4.9c4.16-3.4,9-3.67,10.92-3.82a19.7,19.7,0,0,1,12.53,4.58c1.19,1,6.11,5.58,7.13,17.29.73,8.51,3.31,65.93-37,87.14-4.22,2.22-18,9.25-35.66,7.38a62.43,62.43,0,0,1-20.8-6.11,65.8,65.8,0,0,1-18.89-14.23c-20.21-21.67-19.36-57.46-19.36-57.46s7.58,16,14.12,23.42a45.28,45.28,0,0,0,16.37,11.86A49.46,49.46,0,0,0,99,158.62c11.66-.57,25.93-5.64,35-18.32C143.52,126.8,138.46,100.51,144.12,89.6Z" transform="translate(0.5 0.5)"/></g><g id="CameraUI_Lens"><circle id="ellipse" class="cls-3" cx="116.81" cy="116.81" r="116.31"/><g id="lens"><circle id="lens_bg" class="cls-4" cx="159.13" cy="58.39" r="18.66"/><path id="lens_inner" class="cls-5" d="M169.64,58.31a11,11,0,1,1-22,0c0-6.08,4.93-11.86,11-11.86S169.64,52.23,169.64,58.31Z" transform="translate(0.5 0.5)"/><g id="reflections"><ellipse id="dot_1" class="cls-6" cx="174.36" cy="53.69" rx="1.84" ry="1.42"/><ellipse id="dot_2" class="cls-6" cx="174.36" cy="57.08" rx="1.84" ry="1.42"/><ellipse id="dot_3" class="cls-6" cx="174.36" cy="60.46" rx="1.84" ry="1.42"/><circle id="dot_4" class="cls-6" cx="164.09" cy="63.77" r="1.66"/><path id="wide_1" class="cls-6" d="M156.63,48.9c-1.07-.88-5.52,3.09-6.31,5.43a1.53,1.53,0,0,0,0,1.26c.43.69,1.73.61,2.19.54,2.68-.44,4.71-4.09,4.8-4.37A3.21,3.21,0,0,0,156.63,48.9Z" transform="translate(0.5 0.5)"/></g></g></g></svg>

package/examples/README.md

@@ -1,7 +0,0 @@
-# Plugin Guide
-
-Everything you need to ship a camera.ui plugin in one page: contract, lifecycle, sensors, storage, optional interfaces (discovery, notifier, detection), and inter-plugin communication.
-
-[Read the guide →](./getting-started.md)
-
-For complete production plugins to read alongside, see [`plugins/`](https://github.com/seydx/camera.ui/tree/main/plugins) in the camera.ui repo.