@camera.ui/sdk 0.0.8 → 0.0.9

package/dist/index.d.ts

@@ -4427,10 +4427,12 @@ type PythonVersion = '3.11' | '3.12';
  */
 declare enum PluginRole {
     /**
-     * Cloud-service integration that manages its own cameras end-to-end via a
-     * vendor account (e.g. a vendor SDK / cloud API). The hub owns camera
-     * creation, streaming and sensors; it cannot expose sensors for cameras
-     * owned by other plugins.
+     * System-wide aggregator that attaches to cameras owned by *other* plugins
+     * to provide a cross-camera service (e.g. bridging cameras and sensors into a
+     * smart-home platform, or recording and notifications). A hub creates no
+     * cameras of its own and provides no sensors (`provides` must be empty); it
+     * attaches to cameras via the `hub` assignment and typically reads camera and
+     * sensor state through `consumes`.
      */
     Hub = "hub",
     /**
@@ -4849,6 +4851,7 @@ interface PluginAPI {
  * Generic notification types — domain-agnostic. The NotificationManager and
  * notifier plugins talk over RPC and JSON-encode these types directly.
  */
+
 /**
  * Severity classifies how urgent a Notification is. Notifiers map this to
  * platform-specific delivery characteristics; the host bypasses user-configured
@@ -4934,6 +4937,18 @@ interface Notification {
      */
     adminOnly?: boolean;
 }
+/**
+ * Result of a {@link NotifierInterface.testNotification} call: whether the
+ * test notification was delivered and, when known, to how many devices.
+ */
+interface TestNotificationResponse {
+    /** True when the notifier accepted and dispatched the test notification. */
+    delivered: boolean;
+    /** Number of devices the test notification was delivered to. */
+    deviceCount?: number;
+    /** Human-readable status or error detail. */
+    message?: string;
+}
 /**
  * Implemented by plugins that deliver notifications. The NotificationManager
  * invokes these methods over RPC. Plugins own their device storage — the
@@ -4972,6 +4987,16 @@ interface NotifierInterface {
      *  manager can probe the next plugin.
      */
     updateDevice(deviceId: string, patch: Record<string, unknown>): Promise<NotifierDevice | null>;
+    /**
+     * Sends a test notification to the given devices and returns the delivery
+     *  result. `deviceIds` optionally restricts delivery to a subset.
+     */
+    testNotification?(notification: Notification, deviceIds?: string[]): Promise<TestNotificationResponse | undefined>;
+    /**
+     * Returns the JSON schema used to render the notifier's settings form in
+     *  the UI, or undefined for no schema.
+     */
+    notificationSettings?(): Promise<JsonSchema[] | undefined>;
 }
 
 /** Image metadata for detection test requests */
@@ -5540,8 +5565,8 @@ declare function getContractValidationErrors(contract: unknown): string[];
  */
 declare function validateContractConsistency(contract: PluginContract, pluginName?: string): void;
 /**
- * Reports whether the plugin's role is Hub (vendor cloud integration that
- * manages its own cameras end-to-end).
+ * Reports whether the plugin's role is Hub (a cross-camera aggregator such as a
+ * smart-home bridge or recorder, which owns no cameras of its own).
  *
  * @param contract - Plugin contract to inspect.
  *
@@ -5738,4 +5763,4 @@ interface OAuthClientCredentialsCapable extends OAuthCapable {
 }
 
 export { API_EVENT, AudioDetectorSensor, AudioProperty, AudioSensor, BASE_AUDIO_LABELS, BasePlugin, BatteryCapability, BatteryInfo, BatteryProperty, BehaviorSubject, ChargingState, ClassifierDetectorSensor, ClassifierProperty, ClassifierSensor, ClipDetectorSensor, ContactProperty, ContactSensor, DETECTION_ATTRIBUTES, DETECTION_LABELS, Disposable, DoorbellProperty, DoorbellTrigger, EVENT_TRIGGER_TYPES, FaceDetectorSensor, FaceProperty, FaceSensor, GarageControl, GarageProperty, GarageState, HumidityInfo, HumidityProperty, LeakProperty, LeakSensor, LicensePlateDetectorSensor, LicensePlateProperty, LicensePlateSensor, LightCapability, LightControl, LightProperty, LockControl, LockProperty, LockState, MotionDetectorSensor, MotionProperty, MotionSensor, ObjectDetectorSensor, ObjectProperty, ObjectSensor, Observable, OccupancyProperty, OccupancySensor, PTZCapability, PTZControl, PTZProperty, PluginCapability, PluginInterface, PluginRole, RING_AUTO_RESET_MS, ReplaySubject, RtpPacket, SecuritySystem, SecuritySystemProperty, SecuritySystemState, Sensor, SensorCategory, SensorType, Severity, SirenCapability, SirenControl, SirenProperty, SmokeProperty, SmokeSensor, Subject, SwitchControl, SwitchProperty, TemperatureInfo, TemperatureProperty, canCreateCameras, canProvideSensorsToAnyCameras, distinctUntilChanged, filter, firstValueFrom, getContractValidationErrors, hasCapability, hasInterface, isHub, map, mergeMap, pairwise, share, validateContractConsistency };
-export type { AssignedPlugin, AudioCodec, AudioCodecProperties, AudioDetectionInterface, AudioDetectionPluginResponse, AudioDetectionSettings, AudioFFmpegCodec, AudioFrameData, AudioInputSpec, AudioLabel, AudioMetadata, AudioModelSpec, AudioResult, AudioSensorLike, AudioSensorProperties, AudioStreamInfo, BaseAudioLabel, BaseCamera, BaseCameraConfig, BatteryInfoLike, BatteryInfoProperties, BoundingBox, Camera, CameraAspectRatio, CameraConfig, CameraConfigInputSettings, CameraDetectionSettings, CameraDevice, CameraDeviceSource, CameraFrameWorkerSettings, CameraImplementation, CameraInformation, CameraInput, CameraPluginInfo, CameraRole, CameraSource, CameraType, CameraUiSettings, ClassifierDetection, ClassifierDetectionInterface, ClassifierDetectionPluginResponse, ClassifierResult, ClassifierSensorLike, ClassifierSensorProperties, ClipDetectionInterface, ClipDetectionPluginResponse, ClipEmbedding, ClipResult, ClipTextEmbeddingResult, ContactSensorLike, ContactSensorProperties, CoreManager, CoreManagerEvent, CreateDownloadOptions, CreateStreamDownloadOptions, Detection, DetectionAttribute, DetectionEvent, DetectionEventState, DetectionEventType, DetectionLabel, DetectionLine, DetectionZone, DeviceManager, DeviceStorage, DiscoveredCamera, DiscoveryProvider, DoorbellTriggerLike, DoorbellTriggerProperties, DownloadCleanup, DownloadManager, DownloadToken, EventAttribute, EventDescription, EventDetection, EventSegment, EventTrigger, EventTriggerType, FMTPInfo, FaceDetection, FaceDetectionInterface, FaceDetectionPluginResponse, FaceResult, FaceSensorLike, FaceSensorProperties, Fmp4Session, Fmp4SessionOptions, FormSubmitResponse, FormSubmitSchema, GarageControlLike, GarageControlProperties, Go2RtcRTSPSource, Go2RtcSnapshotSource, Go2RtcWSSource, HardwareAcceleration, HumidityInfoLike, HumidityInfoProperties, ImageMetadata, JsonArraySchema, JsonBaseSchema, JsonBaseSchemaWithoutCallbacks, JsonBooleanSchema, JsonEnumSchema, JsonFactorySchema, JsonNumberSchema, JsonSchema, JsonSchemaArray, JsonSchemaArrayWithoutCallbacks, JsonSchemaBoolean, JsonSchemaBooleanWithoutCallbacks, JsonSchemaButton, JsonSchemaEnum, JsonSchemaEnumWithoutCallbacks, JsonSchemaNumber, JsonSchemaNumberWithoutCallbacks, JsonSchemaString, JsonSchemaStringWithoutCallbacks, JsonSchemaSubmit, JsonSchemaType, JsonSchemaWithoutCallbacks, JsonSchemaWithoutKey, JsonStringSchema, LeakSensorLike, LeakSensorProperties, LicensePlateDetection, LicensePlateDetectionInterface, LicensePlateDetectionPluginResponse, LicensePlateResult, LicensePlateSensorLike, LicensePlateSensorProperties, LightControlLike, LightControlProperties, LineDirection, LockControlLike, LockControlProperties, LoggerService, ModelSpec, MotionDetectionInterface, MotionDetectionPluginResponse, MotionDetectionSettings, MotionResolution, MotionResult, MotionSensorLike, MotionSensorProperties, Notification, NotificationManager, NotifierDevice, NotifierInterface, OAuthAuthCodeFlowCapable, OAuthCapable, OAuthClientCredentialsCapable, OAuthDeviceFlowCapable, OAuthMetadata, OAuthProviderConfig, OAuthProviderDeclaration, OAuthState, OAuthStatus, ObjectDetectionInterface, ObjectDetectionPluginResponse, ObjectDetectionSettings, ObjectModelSpec, ObjectResult, ObjectSensorLike, ObjectSensorProperties, OccupancySensorLike, OccupancySensorProperties, OperatorFn, PTZControlLike, PTZControlProperties, PTZDirection, PTZPosition, PluginAPI, PluginAssignments, PluginConfig, PluginContract, PluginInfo, PluginInterfaces, Point, ProbeAudioCodec, ProbeConfig, ProbeStream, PropertyChangeOf, PtzAutotrackSettings, PythonVersion, RTPInfo, RTSPAudioCodec, RTSPUrlOptions, RtpSession, RtpSessionBackchannelOptions, RtpSessionOptions, SchemaCondition, SchemaConditionOperator, SchemaConfig, SecuritySystemLike, SecuritySystemProperties, SensorCapability, SensorLike, SensorPropertyType, SensorTriggerRef, SensorTriggerSettings, SirenControlLike, SirenControlProperties, SmokeSensorLike, SmokeSensorProperties, SnapshotInterface, SnapshotSettings, SnapshotUrlOptions, StreamDirection, StreamUrls, StreamingInterface, StreamingRole, SwitchControlLike, SwitchControlProperties, TemperatureInfoLike, TemperatureInfoProperties, ToastMessage, TrackedDetection, VideoCodec, VideoCodecProperties, VideoFFmpegCodec, VideoFrameData, VideoInputSpec, VideoStreamInfo, VideoStreamingMode, ZoneFilter, ZoneType };
+export type { AssignedPlugin, AudioCodec, AudioCodecProperties, AudioDetectionInterface, AudioDetectionPluginResponse, AudioDetectionSettings, AudioFFmpegCodec, AudioFrameData, AudioInputSpec, AudioLabel, AudioMetadata, AudioModelSpec, AudioResult, AudioSensorLike, AudioSensorProperties, AudioStreamInfo, BaseAudioLabel, BaseCamera, BaseCameraConfig, BatteryInfoLike, BatteryInfoProperties, BoundingBox, Camera, CameraAspectRatio, CameraConfig, CameraConfigInputSettings, CameraDetectionSettings, CameraDevice, CameraDeviceSource, CameraFrameWorkerSettings, CameraImplementation, CameraInformation, CameraInput, CameraPluginInfo, CameraRole, CameraSource, CameraType, CameraUiSettings, ClassifierDetection, ClassifierDetectionInterface, ClassifierDetectionPluginResponse, ClassifierResult, ClassifierSensorLike, ClassifierSensorProperties, ClipDetectionInterface, ClipDetectionPluginResponse, ClipEmbedding, ClipResult, ClipTextEmbeddingResult, ContactSensorLike, ContactSensorProperties, CoreManager, CoreManagerEvent, CreateDownloadOptions, CreateStreamDownloadOptions, Detection, DetectionAttribute, DetectionEvent, DetectionEventState, DetectionEventType, DetectionLabel, DetectionLine, DetectionZone, DeviceManager, DeviceStorage, DiscoveredCamera, DiscoveryProvider, DoorbellTriggerLike, DoorbellTriggerProperties, DownloadCleanup, DownloadManager, DownloadToken, EventAttribute, EventDescription, EventDetection, EventSegment, EventTrigger, EventTriggerType, FMTPInfo, FaceDetection, FaceDetectionInterface, FaceDetectionPluginResponse, FaceResult, FaceSensorLike, FaceSensorProperties, Fmp4Session, Fmp4SessionOptions, FormSubmitResponse, FormSubmitSchema, GarageControlLike, GarageControlProperties, Go2RtcRTSPSource, Go2RtcSnapshotSource, Go2RtcWSSource, HardwareAcceleration, HumidityInfoLike, HumidityInfoProperties, ImageMetadata, JsonArraySchema, JsonBaseSchema, JsonBaseSchemaWithoutCallbacks, JsonBooleanSchema, JsonEnumSchema, JsonFactorySchema, JsonNumberSchema, JsonSchema, JsonSchemaArray, JsonSchemaArrayWithoutCallbacks, JsonSchemaBoolean, JsonSchemaBooleanWithoutCallbacks, JsonSchemaButton, JsonSchemaEnum, JsonSchemaEnumWithoutCallbacks, JsonSchemaNumber, JsonSchemaNumberWithoutCallbacks, JsonSchemaString, JsonSchemaStringWithoutCallbacks, JsonSchemaSubmit, JsonSchemaType, JsonSchemaWithoutCallbacks, JsonSchemaWithoutKey, JsonStringSchema, LeakSensorLike, LeakSensorProperties, LicensePlateDetection, LicensePlateDetectionInterface, LicensePlateDetectionPluginResponse, LicensePlateResult, LicensePlateSensorLike, LicensePlateSensorProperties, LightControlLike, LightControlProperties, LineDirection, LockControlLike, LockControlProperties, LoggerService, ModelSpec, MotionDetectionInterface, MotionDetectionPluginResponse, MotionDetectionSettings, MotionResolution, MotionResult, MotionSensorLike, MotionSensorProperties, Notification, NotificationManager, NotifierDevice, NotifierInterface, OAuthAuthCodeFlowCapable, OAuthCapable, OAuthClientCredentialsCapable, OAuthDeviceFlowCapable, OAuthMetadata, OAuthProviderConfig, OAuthProviderDeclaration, OAuthState, OAuthStatus, ObjectDetectionInterface, ObjectDetectionPluginResponse, ObjectDetectionSettings, ObjectModelSpec, ObjectResult, ObjectSensorLike, ObjectSensorProperties, OccupancySensorLike, OccupancySensorProperties, OperatorFn, PTZControlLike, PTZControlProperties, PTZDirection, PTZPosition, PluginAPI, PluginAssignments, PluginConfig, PluginContract, PluginInfo, PluginInterfaces, Point, ProbeAudioCodec, ProbeConfig, ProbeStream, PropertyChangeOf, PtzAutotrackSettings, PythonVersion, RTPInfo, RTSPAudioCodec, RTSPUrlOptions, RtpSession, RtpSessionBackchannelOptions, RtpSessionOptions, SchemaCondition, SchemaConditionOperator, SchemaConfig, SecuritySystemLike, SecuritySystemProperties, SensorCapability, SensorLike, SensorPropertyType, SensorTriggerRef, SensorTriggerSettings, SirenControlLike, SirenControlProperties, SmokeSensorLike, SmokeSensorProperties, SnapshotInterface, SnapshotSettings, SnapshotUrlOptions, StreamDirection, StreamUrls, StreamingInterface, StreamingRole, SwitchControlLike, SwitchControlProperties, TemperatureInfoLike, TemperatureInfoProperties, TestNotificationResponse, ToastMessage, TrackedDetection, VideoCodec, VideoCodecProperties, VideoFFmpegCodec, VideoFrameData, VideoInputSpec, VideoStreamInfo, VideoStreamingMode, ZoneFilter, ZoneType };

package/dist/internal/index.d.ts

@@ -412,10 +412,12 @@ type PythonVersion = '3.11' | '3.12';
  */
 declare enum PluginRole {
     /**
-     * Cloud-service integration that manages its own cameras end-to-end via a
-     * vendor account (e.g. a vendor SDK / cloud API). The hub owns camera
-     * creation, streaming and sensors; it cannot expose sensors for cameras
-     * owned by other plugins.
+     * System-wide aggregator that attaches to cameras owned by *other* plugins
+     * to provide a cross-camera service (e.g. bridging cameras and sensors into a
+     * smart-home platform, or recording and notifications). A hub creates no
+     * cameras of its own and provides no sensors (`provides` must be empty); it
+     * attaches to cameras via the `hub` assignment and typically reads camera and
+     * sensor state through `consumes`.
      */
     Hub = "hub",
     /**

package/dist/plugin/contract.js

@@ -5,10 +5,12 @@
 export var PluginRole;
 (function (PluginRole) {
     /**
-     * Cloud-service integration that manages its own cameras end-to-end via a
-     * vendor account (e.g. a vendor SDK / cloud API). The hub owns camera
-     * creation, streaming and sensors; it cannot expose sensors for cameras
-     * owned by other plugins.
+     * System-wide aggregator that attaches to cameras owned by *other* plugins
+     * to provide a cross-camera service (e.g. bridging cameras and sensors into a
+     * smart-home platform, or recording and notifications). A hub creates no
+     * cameras of its own and provides no sensors (`provides` must be empty); it
+     * attaches to cameras via the `hub` assignment and typically reads camera and
+     * sensor state through `consumes`.
      */
     PluginRole["Hub"] = "hub";
     /**

package/dist/plugin/helper.js

@@ -182,8 +182,8 @@ export function validateContractConsistency(contract, pluginName) {
     }
 }
 /**
- * Reports whether the plugin's role is Hub (vendor cloud integration that
- * manages its own cameras end-to-end).
+ * Reports whether the plugin's role is Hub (a cross-camera aggregator such as a
+ * smart-home bridge or recorder, which owns no cameras of its own).
  *
  * @param contract - Plugin contract to inspect.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camera.ui/sdk",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "camera.ui sdk",
   "exports": {
     ".": {
@@ -34,13 +34,13 @@
     "@rollup/plugin-typescript": "^12.3.0",
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/multicast-dns": "^7.2.4",
-    "@types/node": "26.0.0",
+    "@types/node": "26.0.1",
     "@typescript-eslint/parser": "^8.62.0",
     "cpy-cli": "^7.0.0",
     "eslint": "9.39.2",
-    "eslint-plugin-jsdoc": "^63.0.7",
+    "eslint-plugin-jsdoc": "^63.0.10",
     "globals": "^17.7.0",
-    "prettier": "^3.8.4",
+    "prettier": "^3.9.1",
     "rimraf": "^6.1.3",
     "rollup": "^4.62.2",
     "rollup-plugin-dts": "^6.4.1",