@camera.ui/sdk 0.0.3 → 0.0.4

package/dist/sensor/switch.js

@@ -0,0 +1,72 @@
+import { Sensor, SensorType, SensorCategory } from './base.js';
+/**
+ * Properties for switch controls
+ *
+ * @internal
+ */
+export var SwitchProperty;
+(function (SwitchProperty) {
+    /** Whether the switch is on */
+    SwitchProperty["On"] = "on";
+})(SwitchProperty || (SwitchProperty = {}));
+/**
+ * Generic on/off switch control. Override `setOn()` / `setOff()` to drive
+ * hardware and call `await super.setOn()` / `await super.setOff()` after
+ * success to sync the SDK state. For hardware-pushed updates, call the `super`
+ * methods from your event handler.
+ */
+export class SwitchControl extends Sensor {
+    type = SensorType.Switch;
+    category = SensorCategory.Control;
+    constructor(name = 'Switch') {
+        super(name);
+        this._writeState({ [SwitchProperty.On]: false });
+    }
+    get on() {
+        return this.props.on;
+    }
+    /**
+     * Turn the switch on. Override to drive hardware and call `await super.setOn()`
+     * after success to sync the SDK state.
+     *
+     * @example
+     * ```ts
+     * await sw.setOn();
+     * ```
+     */
+    async setOn() {
+        this._writeState({ [SwitchProperty.On]: true });
+    }
+    /**
+     * Turn the switch off. Override to drive hardware and call `await super.setOff()`
+     * after success to sync the SDK state.
+     *
+     * @example
+     * ```ts
+     * await sw.setOff();
+     * ```
+     */
+    async setOff() {
+        this._writeState({ [SwitchProperty.On]: false });
+    }
+    /**
+     * Cross-process consumer entry point. Dispatches writable properties
+     * to semantic methods so plugin overrides (hardware actions) are honored.
+     * Unknown properties are ignored — only `On` is externally writable.
+     *
+     * @param property - Property name to write.
+     *
+     * @param value - New value for the property.
+     *
+     * @internal
+     */
+    async updateValue(property, value) {
+        if (property === SwitchProperty.On) {
+            if (value)
+                await this.setOn();
+            else
+                await this.setOff();
+        }
+        // Unknown / non-writable property — ignored.
+    }
+}

package/dist/sensor/temperature.js

@@ -0,0 +1,52 @@
+import { Sensor, SensorType, SensorCategory } from './base.js';
+/**
+ * Properties for temperature sensors
+ *
+ * @internal
+ */
+export var TemperatureProperty;
+(function (TemperatureProperty) {
+    /** Current temperature in degrees Celsius */
+    TemperatureProperty["Current"] = "current";
+})(TemperatureProperty || (TemperatureProperty = {}));
+/** Temperature info sensor. Reports current temperature in °C. */
+export class TemperatureInfo extends Sensor {
+    type = SensorType.Temperature;
+    category = SensorCategory.Info;
+    constructor(name = 'Temperature') {
+        super(name);
+        this._writeState({ [TemperatureProperty.Current]: 20 });
+    }
+    get current() {
+        return this.props.current;
+    }
+    /**
+     * Report a new temperature reading. Clamped to [-270, 100] °C.
+     *
+     * @param value - Temperature reading in degrees Celsius.
+     *
+     * @example
+     * ```ts
+     * temperature.setCurrent(21.5);
+     * ```
+     */
+    setCurrent(value) {
+        this._writeState({ [TemperatureProperty.Current]: Math.max(-270, Math.min(100, value)) });
+    }
+    /**
+     * Read-only sensor: external writes are ignored. Reading via `setCurrent` is plugin-only.
+     *
+     * Called by the cross-process plugin host when a generic property write is received.
+     * Temperature sensors have no externally writable properties, so the parameters are
+     * unused (underscore-prefixed) and the call is a no-op.
+     *
+     * @param _property - Unused — temperature sensors expose no writable properties.
+     *
+     * @param _value - Unused — temperature sensors expose no writable properties.
+     *
+     * @internal
+     */
+    updateValue(_property, _value) {
+        // No-op — temperature is reported by the plugin, not set externally.
+    }
+}

package/dist/storage/index.js

@@ -1,2 +1 @@
-export * from './schema.js';
-export * from './storages.js';
+export {};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/docs/.vitepress/config.ts

@@ -0,0 +1,77 @@
+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

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

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

@@ -0,0 +1,117 @@
+@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

@@ -0,0 +1,16 @@
+# 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

@@ -0,0 +1 @@
+<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

@@ -0,0 +1,7 @@
+# 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.