@camera.ui/sdk 0.0.3 → 0.0.5

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/package.json

@@ -1,58 +1,71 @@
 {
   "name": "@camera.ui/sdk",
-  "version": "0.0.3",
+  "version": "0.0.5",
   "description": "camera.ui sdk",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
       "require": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./internal": {
+      "types": "./dist/internal/index.d.ts",
+      "require": "./dist/internal/index.js",
+      "default": "./dist/internal/index.js"
     }
   },
   "type": "module",
   "scripts": {
     "build": "rimraf dist && tsc --project tsconfig.node.json && rollup --config rollup.config.ts --configPlugin @rollup/plugin-typescript",
+    "docs:dev": "npm run predocs && vitepress dev docs --port 5273",
+    "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",
     "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"
   },
-  "dependencies": {
-    "rxjs": "^7.8.2"
-  },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-typescript": "^12.3.0",
-    "@stylistic/eslint-plugin": "^5.6.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
     "@types/multicast-dns": "^7.2.4",
-    "@types/node": "^24.10.1",
-    "@typescript-eslint/parser": "^8.48.1",
-    "eslint": "^9.39.1",
-    "eslint-plugin-jsdoc": "^61.5.0",
-    "globals": "^16.5.0",
-    "prettier": "^3.7.4",
-    "rimraf": "^6.1.2",
-    "rollup": "^4.53.3",
-    "rollup-plugin-dts": "^6.3.0",
-    "sharp": "^0.34.5",
+    "@types/node": "25.9.3",
+    "@typescript-eslint/parser": "^8.61.0",
+    "cpy-cli": "^7.0.0",
+    "eslint": "9.39.2",
+    "eslint-plugin-jsdoc": "^63.0.2",
+    "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",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.48.1",
-    "updates": "^17.0.4",
-    "werift": "0.22.2",
+    "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",
+    "vitepress": "^1.6.4",
+    "vitest": "^4.1.9",
+    "werift": "0.23.0",
     "werift-rtp": "^0.8.8"
   },
-  "author": "seydx (https://github.com/seydx/camera.ui)",
+  "author": "seydx (https://github.com/cameraui/sdk)",
   "bugs": {
-    "url": "https://github.com/seydx/camera.ui/issues"
+    "url": "https://github.com/cameraui/sdk/issues"
   },
-  "homepage": "https://github.com/seydx/camera.ui#readme",
+  "homepage": "https://github.com/cameraui/sdk#readme",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/seydx/camera.ui.git"
+    "url": "git+https://github.com/cameraui/sdk.git"
   },
   "keywords": [
     "camera.ui",

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/LICENSE.md

@@ -1,22 +0,0 @@
-MIT License
-
-Copyright (c) 2023-2024 seydx <dev@seydx.com>
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/sensor/guards.js

@@ -1,133 +0,0 @@
-import { SensorType } from './types.js';
-/**
- * Type guard for Motion sensors
- *
- * Narrows a SensorLike to MotionSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Motion sensor
- */
-export function isMotionSensor(sensor) {
-    return sensor.type === SensorType.Motion;
-}
-/**
- * Type guard for Object detection sensors
- *
- * Narrows a SensorLike to ObjectSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is an Object sensor
- */
-export function isObjectSensor(sensor) {
-    return sensor.type === SensorType.Object;
-}
-/**
- * Type guard for Audio sensors
- *
- * Narrows a SensorLike to AudioSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is an Audio sensor
- */
-export function isAudioSensor(sensor) {
-    return sensor.type === SensorType.Audio;
-}
-/**
- * Type guard for Face detection sensors
- *
- * Narrows a SensorLike to FaceSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Face sensor
- */
-export function isFaceSensor(sensor) {
-    return sensor.type === SensorType.Face;
-}
-/**
- * Type guard for License Plate detection sensors
- *
- * Narrows a SensorLike to LicensePlateSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a License Plate sensor
- */
-export function isLicensePlateSensor(sensor) {
-    return sensor.type === SensorType.LicensePlate;
-}
-/**
- * Type guard for Contact sensors
- *
- * Narrows a SensorLike to ContactSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Contact sensor
- */
-export function isContactSensor(sensor) {
-    return sensor.type === SensorType.Contact;
-}
-/**
- * Type guard for Light controls
- *
- * Narrows a SensorLike to LightControlLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Light control
- */
-export function isLightControl(sensor) {
-    return sensor.type === SensorType.Light;
-}
-/**
- * Type guard for Siren controls
- *
- * Narrows a SensorLike to SirenControlLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Siren control
- */
-export function isSirenControl(sensor) {
-    return sensor.type === SensorType.Siren;
-}
-/**
- * Type guard for PTZ controls
- *
- * Narrows a SensorLike to PTZControlLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a PTZ control
- */
-export function isPTZControl(sensor) {
-    return sensor.type === SensorType.PTZ;
-}
-/**
- * Type guard for Doorbell triggers
- *
- * Narrows a SensorLike to DoorbellTriggerLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Doorbell trigger
- */
-export function isDoorbellTrigger(sensor) {
-    return sensor.type === SensorType.Doorbell;
-}
-/**
- * Type guard for Battery info sensors
- *
- * Narrows a SensorLike to BatteryInfoLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Battery info sensor
- */
-export function isBatteryInfo(sensor) {
-    return sensor.type === SensorType.Battery;
-}

package/dist/sensor/types.js

@@ -1,46 +0,0 @@
-/**
- * Charging state for battery
- */
-export var ChargingState;
-(function (ChargingState) {
-    ChargingState["NotChargeable"] = "NOT_CHARGEABLE";
-    ChargingState["NotCharging"] = "NOT_CHARGING";
-    ChargingState["Charging"] = "CHARGING";
-    ChargingState["Full"] = "FULL";
-})(ChargingState || (ChargingState = {}));
-// ========== Sensor Types ==========
-/**
- * Sensor Type Enum - identifies the type of sensor/control/trigger/info
- */
-export var SensorType;
-(function (SensorType) {
-    // Detection Sensors
-    SensorType["Motion"] = "motion";
-    SensorType["Object"] = "object";
-    SensorType["Audio"] = "audio";
-    SensorType["Face"] = "face";
-    SensorType["LicensePlate"] = "licensePlate";
-    SensorType["Contact"] = "contact";
-    // Controls
-    SensorType["Light"] = "light";
-    SensorType["Siren"] = "siren";
-    SensorType["PTZ"] = "ptz";
-    // Triggers
-    SensorType["Doorbell"] = "doorbell";
-    // Info
-    SensorType["Battery"] = "battery";
-})(SensorType || (SensorType = {}));
-/**
- * Sensor Category - categorizes sensors by their behavior
- */
-export var SensorCategory;
-(function (SensorCategory) {
-    /** Detection sensors (read-only, 1 provider) */
-    SensorCategory["Sensor"] = "sensor";
-    /** Bidirectional controls */
-    SensorCategory["Control"] = "control";
-    /** Event-based triggers */
-    SensorCategory["Trigger"] = "trigger";
-    /** Read-only hardware status */
-    SensorCategory["Info"] = "info";
-})(SensorCategory || (SensorCategory = {}));

package/dist/service/base.js

@@ -1,96 +0,0 @@
-/**
- * Service types that can be registered by plugins
- */
-export var ServiceType;
-(function (ServiceType) {
-    /** Streaming URL generation */
-    ServiceType["Streaming"] = "streaming";
-    /** Snapshot capture */
-    ServiceType["Snapshot"] = "snapshot";
-})(ServiceType || (ServiceType = {}));
-/**
- * Abstract base class for all camera services
- *
- * Plugins extend this class to implement custom service functionality.
- * The service communicates with the server via RPC, with the base class
- * handling online/offline status management.
- *
- * @example
- * ```typescript
- * class MyStreamingService extends Service implements StreamingService {
- *   readonly type = ServiceType.Streaming;
- *
- *   async streamUrl(sourceName: string): Promise<string> {
- *     return `rtsp://my-camera/${sourceName}`;
- *   }
- * }
- *
- * // In plugin:
- * const service = new MyStreamingService(camera.id, this.pluginId);
- * await camera.registerService(service);
- * ```
- */
-export class Service {
-    /**
-     * Camera ID this service is associated with
-     */
-    cameraId;
-    /**
-     * Plugin ID that provides this service
-     */
-    pluginId;
-    /**
-     * Internal online state
-     */
-    _online = false;
-    /**
-     * Callback for online status changes (set by runtime)
-     */
-    _onlineChangeFn;
-    /**
-     * Create a new service instance
-     *
-     * @param cameraId - ID of the camera this service is for
-     *
-     * @param pluginId - ID of the plugin providing this service
-     */
-    constructor(cameraId, pluginId) {
-        this.cameraId = cameraId;
-        this.pluginId = pluginId;
-    }
-    /**
-     * Whether the service is currently online/available
-     *
-     * Setting this property notifies the server of the status change.
-     */
-    get online() {
-        return this._online;
-    }
-    set online(value) {
-        if (this._online !== value) {
-            this._online = value;
-            this._onlineChangeFn?.(value);
-        }
-    }
-    /**
-     * Internal initialization - sets up the online status callback
-     *
-     * Called by the runtime when the service is registered.
-     *
-     * @param onlineChangeFn - Callback to notify server of online status changes
-     *
-     * @internal
-     */
-    _init(onlineChangeFn) {
-        this._onlineChangeFn = onlineChangeFn;
-    }
-    /**
-     * Internal cleanup - called when service is unregistered
-     *
-     * @internal
-     */
-    _cleanup() {
-        this._onlineChangeFn = undefined;
-        this._online = false;
-    }
-}

package/dist/service/index.js

@@ -1,3 +0,0 @@
-export * from './base.js';
-export * from './services.js';
-export * from './types.js';

package/tsconfig.node.json

@@ -1,30 +0,0 @@
-{
-  "compilerOptions": {
-    "outDir": "./dist",
-    "target": "ES2022",
-    "moduleResolution": "NodeNext",
-    "module": "NodeNext",
-    "lib": [
-      "ES2022",
-    ],
-    "declaration": false,
-    "strict": true,
-    "esModuleInterop": true,
-    "preserveConstEnums": true,
-    "skipLibCheck": true,
-    "useUnknownInCatchVariables": false,
-    "allowSyntheticDefaultImports": true,
-    "resolveJsonModule": true,
-    "experimentalDecorators": true,
-    "emitDecoratorMetadata": true,
-    "verbatimModuleSyntax": true,
-    "noImplicitAny": true,
-  },
-  "include": [
-    "src",
-  ],
-  "exclude": [
-    "node_modules",
-    "dist",
-  ],
-}