@camera.ui/server 2.0.15 → 2.0.17

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/battery.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,7 +10,7 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class BatteryCapability(str, Enum):
+class BatteryCapability(StrEnum):
     """Optional capabilities for battery info sensors."""
 
     LowBattery = "lowBattery"
@@ -19,15 +19,18 @@ class BatteryCapability(str, Enum):
     """Sensor reports charging state."""
 
 
-class BatteryProperty(str, Enum):
+class BatteryProperty(StrEnum):
     """Properties for battery info sensors."""
 
     Level = "level"
+    """Battery level percentage (0-100)."""
     Charging = "charging"
+    """Current charging state."""
     Low = "low"
+    """Whether battery is critically low."""
 
 
-class ChargingState(str, Enum):
+class ChargingState(StrEnum):
     """Battery charging state."""
 
     NotChargeable = "NOT_CHARGEABLE"
@@ -125,7 +128,7 @@ class BatteryInfo(Sensor[BatteryInfoProperties, TStorage, BatteryCapability], Ge
         """Report a new battery level (percentage). Clamped to [0, 100].
 
         Args:
-            value: Battery level percentage in the range 0–100.
+            value: Battery level percentage in the range 0-100.
 
         Example:
             ```python

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/classifier.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from abc import abstractmethod
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -13,7 +13,7 @@ from .detection import Detection, VideoFrameData
 from .spec import ModelSpec
 
 
-class ClassifierProperty(str, Enum):
+class ClassifierProperty(StrEnum):
     """Property names of a classifier sensor."""
 
     Detected = "detected"  # Whether any classification result is active

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/contact.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,10 +10,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class ContactProperty(str, Enum):
+class ContactProperty(StrEnum):
     """Properties for contact sensors."""
 
     Detected = "detected"
+    """Whether the contact is open (true = open, false = closed)."""
 
 
 class ContactSensorProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/detection.py

@@ -4,8 +4,14 @@ from typing import Literal, NotRequired
 
 from typing_extensions import TypedDict
 
+#: Object-detection labels the detector groups its classes into.
+OBJECT_DETECTION_LABELS = ("person", "vehicle", "animal", "package")
+
+#: Union of the object-detection label strings.
+ObjectDetectionLabel = Literal["person", "vehicle", "animal", "package"]
+
 #: Built-in detection label types recognized across the system.
-DETECTION_LABELS = ("motion", "person", "vehicle", "animal", "package", "audio")
+DETECTION_LABELS = ("motion", *OBJECT_DETECTION_LABELS, "audio")
 
 #: Union of the built-in detection label strings.
 DetectionLabel = Literal["motion", "person", "vehicle", "animal", "package", "audio"]

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/doorbell.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import threading
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -11,10 +11,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class DoorbellProperty(str, Enum):
+class DoorbellProperty(StrEnum):
     """Properties for doorbell triggers."""
 
     Ring = "ring"
+    """Whether the doorbell is currently ringing."""
 
 
 class DoorbellTriggerProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/face.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from abc import abstractmethod
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, NotRequired, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -13,7 +13,7 @@ from .detection import Detection, VideoFrameData
 from .spec import ModelSpec
 
 
-class FaceProperty(str, Enum):
+class FaceProperty(StrEnum):
     """Property names of a face detection sensor."""
 
     Detected = "detected"  # Whether any face is currently detected

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/garage.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum, IntEnum
+from enum import IntEnum, StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -20,12 +20,15 @@ class GarageState(IntEnum):
     Stopped = 4
 
 
-class GarageProperty(str, Enum):
+class GarageProperty(StrEnum):
     """Properties for garage controls."""
 
     CurrentState = "currentState"
+    """The actual current state of the garage door."""
     TargetState = "targetState"
+    """The desired target state (set by user, transitions to currentState)."""
     ObstructionDetected = "obstructionDetected"
+    """Whether an obstruction is detected."""
 
 
 class GarageControlProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/humidity.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,10 +10,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class HumidityProperty(str, Enum):
+class HumidityProperty(StrEnum):
     """Properties for humidity info sensors."""
 
     Current = "current"
+    """Current relative humidity (0-100%)."""
 
 
 class HumidityInfoProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/leak.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,10 +10,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class LeakProperty(str, Enum):
+class LeakProperty(StrEnum):
     """Properties for leak sensors."""
 
     Detected = "detected"
+    """Whether a leak is detected."""
 
 
 class LeakSensorProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/license_plate.py

@@ -2,8 +2,8 @@ from __future__ import annotations
 
 from abc import abstractmethod
 from collections.abc import Mapping
-from enum import Enum
-from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
+from enum import StrEnum
+from typing import Any, Generic, Literal, NotRequired, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
 
@@ -13,7 +13,7 @@ from .detection import Detection, VideoFrameData
 from .spec import ModelSpec
 
 
-class LicensePlateProperty(str, Enum):
+class LicensePlateProperty(StrEnum):
     """Property names of a license plate detection sensor."""
 
     Detected = "detected"  # Whether any license plate is currently detected
@@ -25,6 +25,9 @@ class LicensePlateDetection(Detection):
 
     attribute: Literal["license_plate"]  # type: ignore[misc]  # Sub-detection attribute, fixed to "license_plate"
     plateText: str  # Recognized plate text (e.g. "ABC 1234")
+    ocrConfidence: NotRequired[
+        float
+    ]  # Average text recognition confidence (0-1), separate from the box confidence
 
 
 class LicensePlateSensorProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/light.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,18 +10,20 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class LightCapability(str, Enum):
+class LightCapability(StrEnum):
     """Optional capabilities for light controls."""
 
     Brightness = "brightness"
-    """Light supports brightness adjustment (0–100)."""
+    """Light supports brightness adjustment (0-100)."""
 
 
-class LightProperty(str, Enum):
+class LightProperty(StrEnum):
     """Properties for light controls."""
 
     On = "on"
+    """Whether the light is on."""
     Brightness = "brightness"
+    """Brightness level (0-100)."""
 
 
 class LightControlProperties(TypedDict):
@@ -134,7 +136,7 @@ class LightControl(Sensor[LightControlProperties, TStorage, LightCapability], Ge
         succeeds. The default implementation clamps the value to [0, 100].
 
         Args:
-            value: Brightness level in the range 0–100.
+            value: Brightness level in the range 0-100.
 
         Example:
             ```python

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/lock.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum, IntEnum
+from enum import IntEnum, StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -18,11 +18,13 @@ class LockState(IntEnum):
     Unknown = 2
 
 
-class LockProperty(str, Enum):
+class LockProperty(StrEnum):
     """Properties for lock controls."""
 
     CurrentState = "currentState"
+    """The actual current state of the lock."""
     TargetState = "targetState"
+    """The desired target state (set by user, transitions to currentState)."""
 
 
 class LockControlProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/motion.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from abc import abstractmethod
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -38,7 +38,7 @@ __all__ = [
 ]
 
 
-class MotionProperty(str, Enum):
+class MotionProperty(StrEnum):
     """Property names of a motion sensor."""
 
     Detected = "detected"  # Whether motion is currently detected

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/object.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from abc import abstractmethod
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -13,7 +13,7 @@ from .detection import Detection, DetectionLabel, VideoFrameData
 from .spec import ObjectModelSpec
 
 
-class ObjectProperty(str, Enum):
+class ObjectProperty(StrEnum):
     """Property names of an object detection sensor."""
 
     Detected = "detected"  # Whether any object is currently detected

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/occupancy.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,10 +10,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class OccupancyProperty(str, Enum):
+class OccupancyProperty(StrEnum):
     """Properties for occupancy sensors."""
 
     Detected = "detected"
+    """Whether occupancy is detected (true = occupied)."""
 
 
 class OccupancySensorProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/ptz.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, NotRequired, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,28 +10,44 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class PTZCapability(str, Enum):
+class PTZCapability(StrEnum):
     """Optional capabilities for PTZ controls."""
 
     Pan = "pan"
+    """Camera supports panning (horizontal movement)."""
     Tilt = "tilt"
+    """Camera supports tilting (vertical movement)."""
     Zoom = "zoom"
+    """Camera supports zoom."""
     Presets = "presets"
+    """Camera supports named position presets."""
     Home = "home"
+    """Camera supports a home position."""
     RelativeMove = "relativeMove"
+    """Camera executes relative displacement moves."""
     AbsolutePosition = "absolutePosition"
+    """Camera accepts absolute position writes via `setPosition()`."""
     VelocityControl = "velocityControl"
+    """Camera accepts continuous-move commands via `setVelocity()`."""
 
 
-class PTZProperty(str, Enum):
+class PTZProperty(StrEnum):
     """Properties for PTZ controls."""
 
     Position = "position"
+    """Current pan/tilt/zoom position."""
     Moving = "moving"
+    """Whether the camera is currently moving."""
     Presets = "presets"
+    """List of available preset names."""
     Velocity = "velocity"
+    """Current movement velocity (continuous move)."""
     TargetPreset = "targetPreset"
+    """Target preset to move to."""
     RelativeMove = "relativeMove"
+    """Relative displacement move command (write-only)."""
+    Home = "home"
+    """Move to the home position (write-only command, carries no state)."""
 
 
 class PTZPosition(TypedDict):
@@ -284,8 +300,8 @@ class PTZControl(Sensor[PTZControlProperties, TStorage, PTZCapability], Generic[
         """Routes generic property writes to semantic methods.
 
         `moving` and `presets` are observed/discovered state and not externally
-        writable; only `Position`, `Velocity`, `TargetPreset`, and
-        `RelativeMove` may be set.
+        writable; only `Position`, `Velocity`, `TargetPreset`, `RelativeMove`
+        and `Home` may be set.
         """
         if property == PTZProperty.Position.value:
             await self.setPosition(value)
@@ -299,4 +315,7 @@ class PTZControl(Sensor[PTZControlProperties, TStorage, PTZCapability], Generic[
         if property == PTZProperty.RelativeMove.value:
             await self.setRelativeMove(value)
             return
+        if property == PTZProperty.Home.value:
+            await self.goHome()
+            return
         # Unknown / non-writable property (incl. moving, presets) — ignored.

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/security_system.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum, IntEnum
+from enum import IntEnum, StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -25,11 +25,13 @@ class SecuritySystemState(IntEnum):
     """Alarm is triggered."""
 
 
-class SecuritySystemProperty(str, Enum):
+class SecuritySystemProperty(StrEnum):
     """Properties for security system controls."""
 
     CurrentState = "currentState"
+    """The actual current state of the security system."""
     TargetState = "targetState"
+    """The desired target state (set by user, transitions to currentState)."""
 
 
 class SecuritySystemProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/siren.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,18 +10,20 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class SirenCapability(str, Enum):
+class SirenCapability(StrEnum):
     """Optional capabilities for siren controls."""
 
     Volume = "volume"
-    """Siren supports volume adjustment (0–100)."""
+    """Siren supports volume adjustment (0-100)."""
 
 
-class SirenProperty(str, Enum):
+class SirenProperty(StrEnum):
     """Properties for siren controls."""
 
     Active = "active"
+    """Whether the siren is currently active."""
     Volume = "volume"
+    """Volume level (0-100)."""
 
 
 class SirenControlProperties(TypedDict):
@@ -127,7 +129,7 @@ class SirenControl(Sensor[SirenControlProperties, TStorage, SirenCapability], Ge
         clamps the value to [0, 100].
 
         Args:
-            value: Volume level in the range 0–100.
+            value: Volume level in the range 0-100.
 
         Example:
             ```python

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/smoke.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,10 +10,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class SmokeProperty(str, Enum):
+class SmokeProperty(StrEnum):
     """Properties for smoke sensors."""
 
     Detected = "detected"
+    """Whether smoke is detected."""
 
 
 class SmokeSensorProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/switch.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,10 +10,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class SwitchProperty(str, Enum):
+class SwitchProperty(StrEnum):
     """Properties for switch controls."""
 
     On = "on"
+    """Whether the switch is on."""
 
 
 class SwitchControlProperties(TypedDict):

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/sensor/temperature.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from enum import Enum
+from enum import StrEnum
 from typing import Any, Generic, Literal, Protocol, overload, runtime_checkable
 
 from typing_extensions import TypedDict, TypeVar
@@ -10,10 +10,11 @@ from ..observable import Observable
 from .base import Sensor, SensorCategory, SensorLike, SensorType
 
 
-class TemperatureProperty(str, Enum):
+class TemperatureProperty(StrEnum):
     """Properties for temperature info sensors."""
 
     Current = "current"
+    """Current temperature in degrees Celsius."""
 
 
 class TemperatureInfoProperties(TypedDict):

package/dist/server/src/api/controllers/auth.controller.d.ts

@@ -9,6 +9,7 @@ export declare class AuthController {
     private remoteAccessManager;
     constructor(_app: FastifyInstance);
     check(_req: FastifyRequest<AuthLoginRequest>, reply: FastifyReply): FastifyReply;
+    me(req: FastifyRequest<AuthLoginRequest>, reply: FastifyReply): FastifyReply;
     list(req: FastifyRequest<AuthLoginRequest & PaginationRequest>, reply: FastifyReply): FastifyReply | SessionInfo[];
     listAll(req: FastifyRequest<AuthLoginRequest & PaginationRequest>, reply: FastifyReply): FastifyReply | SessionInfo[];
     login(req: FastifyRequest<AuthNewLoginRequest>, reply: FastifyReply): Promise<FastifyReply | void>;

package/dist/server/src/api/controllers/auth.controller.js

@@ -37,6 +37,25 @@ export class AuthController {
             });
         }
     }
+    me(req, reply) {
+        try {
+            const user = req.locals.user;
+            return reply.code(200).send({
+                _id: user._id,
+                username: user.username,
+                avatar: user.avatar,
+                role: user.role,
+                firstLogin: user.firstLogin,
+                language: user.preferences.language ?? 'auto',
+            });
+        }
+        catch (error) {
+            return reply.code(500).send({
+                statusCode: 500,
+                message: error.message,
+            });
+        }
+    }
     list(req, reply) {
         try {
             const user = req.locals.user;