@camstack/addon-provider-rtsp 0.1.13 → 0.1.14

package/dist/index.d.mts

@@ -1,48 +1,83 @@
 export { RtspProviderAddon } from './addon.mjs';
-import { IDevice, DeviceType, DeviceCapabilityName, CamstackContext, Device, IDeviceCapability, DeviceState, DeviceMetadata, IDeviceProvider, Integration, IIntegrationRegistry, ProviderStatus, DiscoveredDevice, ConfigUISchema, LiveEvent } from '@camstack/types';
+import { z } from 'zod';
+import { BaseDevice, ICameraDevice, DeviceType, DeviceContext, StreamSourceEntry, ConfigUISchemaWithValues } from '@camstack/types';
 
-declare class RtspDevice implements IDevice {
-    readonly id: string;
-    readonly name: string;
-    readonly providerId: string;
-    readonly type: DeviceType;
-    readonly capabilities: DeviceCapabilityName[];
-    readonly ctx: CamstackContext;
-    readonly stableId: string;
-    private readonly settings;
-    private readonly capabilityMap;
-    constructor(device: Device, settings: Record<string, unknown>, ctx: CamstackContext);
-    getCapability<T extends IDeviceCapability>(cap: DeviceCapabilityName): T | null;
-    hasCapability(cap: DeviceCapabilityName): boolean;
-    getState(): DeviceState;
-    getMetadata(): DeviceMetadata;
-    private createCamera;
+declare const rtspCameraSchema: z.ZodObject<{
+    streams: z.ZodPreprocess<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        url: z.ZodString;
+        profileHint: z.ZodOptional<z.ZodEnum<{
+            high: "high";
+            mid: "mid";
+            low: "low";
+        }>>;
+        resolution: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    snapshotUrl: z.ZodDefault<z.ZodString>;
+    username: z.ZodDefault<z.ZodString>;
+    password: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+declare class RtspCamera extends BaseDevice<typeof rtspCameraSchema> implements ICameraDevice {
+    readonly type: DeviceType.Camera;
+    features: readonly [];
+    constructor(ctx: DeviceContext);
+    /**
+     * Detect legacy `{label, url}` stream shapes and reshape to
+     * `{id, url, profileHint}`. Persists via `config.setAll` once, so
+     * subsequent boots find the new shape and this branch is inert.
+     *
+     * Runs fire-and-forget — the constructor can't await. The reshape is
+     * additive (ids are newly minted) so a failed persist is recoverable
+     * on next boot.
+     */
+    private migrateLegacyStreamsIfNeeded;
+    /**
+     * Publish every configured stream to the system stream-broker as a
+     * `pull-rtsp` cam stream. Idempotent — the broker's publishCameraStream
+     * entry is keyed by `(deviceId, camStreamId)` so callers may invoke
+     * this at will (e.g. on stream-broker restart). Fire-and-forget safe.
+     */
+    /**
+     * Lifecycle hook fired by the kernel after registration. Publishes
+     * the camera's streams to the broker — the kernel doesn't know
+     * about the broker, but the camera does. Best-effort: if the
+     * broker isn't ready, the provider's `system.ready-state`
+     * subscription re-publishes on the next ready fire.
+     */
+    onActivate(): Promise<void>;
+    publishToBroker(): Promise<void>;
+    /**
+     * Thin compat shim: reflects the stored `{id, url, profileHint?}`
+     * streams into the legacy `StreamSourceEntry` shape so
+     * `ICameraDevice`-aware consumers (device-manager legacy paths,
+     * device-cap-proxy fallback) still find data. The broker itself does
+     * NOT read this anymore — it consumes `publishCameraStream`. This
+     * shim goes away when every consumer migrates (C5/C7).
+     */
+    getStreamSources(): Promise<readonly StreamSourceEntry[]>;
+    removeDevice(): Promise<void>;
+    getSettingsUISchema(): ConfigUISchemaWithValues;
+    /**
+     * Project stored config into the flat UI keys referenced by the schema.
+     * Form only sees URLs — the internal id/profileHint/resolution stay
+     * invisible to the operator (the broker decides profiles from probed
+     * metadata at save time).
+     */
+    private collectFormValues;
+    applySettingsPatch(patch: Record<string, unknown>): Promise<void>;
+    /**
+     * Probe a list of RTSP URLs through the kernel stream-probe and return
+     * the new `{id, url, profileHint?, resolution?}` entries. Ids are
+     * assigned `stream-1/2/3` in input order so the UI's slot ordering is
+     * preserved across edits. The broker is in charge of the actual
+     * (high/mid/low) profile assignment via `computeInitialAssignment`.
+     */
+    private probeAndClassify;
+    private registerSnapshotProvider;
+    private fetchHttpSnapshot;
 }
 
-declare class RtspProvider implements IDeviceProvider {
-    readonly id: string;
-    readonly type = "rtsp";
-    readonly name: string;
-    readonly discoveryMode: 'manual';
-    readonly ctx: CamstackContext;
-    private readonly integration;
-    private readonly registry;
-    private readonly devices;
-    constructor(integration: Integration, registry: IIntegrationRegistry, ctx: CamstackContext);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    getStatus(): ProviderStatus;
-    discoverDevices(): Promise<DiscoveredDevice[]>;
-    getDevices(): IDevice[];
-    getDeviceConfigSchema(): ConfigUISchema;
-    createDevice(config: Record<string, unknown>): Promise<IDevice>;
-    subscribeLiveEvents(_callback: (event: LiveEvent) => void): () => void;
-    private buildDevice;
-}
-
-interface RtspProviderConfig {
-    readonly id: string;
-    readonly name: string;
-}
-
-export { RtspDevice, RtspProvider, type RtspProviderConfig };
+export { RtspCamera, rtspCameraSchema };

package/dist/index.d.ts

@@ -1,48 +1,83 @@
 export { RtspProviderAddon } from './addon.js';
-import { IDevice, DeviceType, DeviceCapabilityName, CamstackContext, Device, IDeviceCapability, DeviceState, DeviceMetadata, IDeviceProvider, Integration, IIntegrationRegistry, ProviderStatus, DiscoveredDevice, ConfigUISchema, LiveEvent } from '@camstack/types';
+import { z } from 'zod';
+import { BaseDevice, ICameraDevice, DeviceType, DeviceContext, StreamSourceEntry, ConfigUISchemaWithValues } from '@camstack/types';
 
-declare class RtspDevice implements IDevice {
-    readonly id: string;
-    readonly name: string;
-    readonly providerId: string;
-    readonly type: DeviceType;
-    readonly capabilities: DeviceCapabilityName[];
-    readonly ctx: CamstackContext;
-    readonly stableId: string;
-    private readonly settings;
-    private readonly capabilityMap;
-    constructor(device: Device, settings: Record<string, unknown>, ctx: CamstackContext);
-    getCapability<T extends IDeviceCapability>(cap: DeviceCapabilityName): T | null;
-    hasCapability(cap: DeviceCapabilityName): boolean;
-    getState(): DeviceState;
-    getMetadata(): DeviceMetadata;
-    private createCamera;
+declare const rtspCameraSchema: z.ZodObject<{
+    streams: z.ZodPreprocess<z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        url: z.ZodString;
+        profileHint: z.ZodOptional<z.ZodEnum<{
+            high: "high";
+            mid: "mid";
+            low: "low";
+        }>>;
+        resolution: z.ZodOptional<z.ZodObject<{
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>>;
+    snapshotUrl: z.ZodDefault<z.ZodString>;
+    username: z.ZodDefault<z.ZodString>;
+    password: z.ZodDefault<z.ZodString>;
+}, z.core.$strip>;
+declare class RtspCamera extends BaseDevice<typeof rtspCameraSchema> implements ICameraDevice {
+    readonly type: DeviceType.Camera;
+    features: readonly [];
+    constructor(ctx: DeviceContext);
+    /**
+     * Detect legacy `{label, url}` stream shapes and reshape to
+     * `{id, url, profileHint}`. Persists via `config.setAll` once, so
+     * subsequent boots find the new shape and this branch is inert.
+     *
+     * Runs fire-and-forget — the constructor can't await. The reshape is
+     * additive (ids are newly minted) so a failed persist is recoverable
+     * on next boot.
+     */
+    private migrateLegacyStreamsIfNeeded;
+    /**
+     * Publish every configured stream to the system stream-broker as a
+     * `pull-rtsp` cam stream. Idempotent — the broker's publishCameraStream
+     * entry is keyed by `(deviceId, camStreamId)` so callers may invoke
+     * this at will (e.g. on stream-broker restart). Fire-and-forget safe.
+     */
+    /**
+     * Lifecycle hook fired by the kernel after registration. Publishes
+     * the camera's streams to the broker — the kernel doesn't know
+     * about the broker, but the camera does. Best-effort: if the
+     * broker isn't ready, the provider's `system.ready-state`
+     * subscription re-publishes on the next ready fire.
+     */
+    onActivate(): Promise<void>;
+    publishToBroker(): Promise<void>;
+    /**
+     * Thin compat shim: reflects the stored `{id, url, profileHint?}`
+     * streams into the legacy `StreamSourceEntry` shape so
+     * `ICameraDevice`-aware consumers (device-manager legacy paths,
+     * device-cap-proxy fallback) still find data. The broker itself does
+     * NOT read this anymore — it consumes `publishCameraStream`. This
+     * shim goes away when every consumer migrates (C5/C7).
+     */
+    getStreamSources(): Promise<readonly StreamSourceEntry[]>;
+    removeDevice(): Promise<void>;
+    getSettingsUISchema(): ConfigUISchemaWithValues;
+    /**
+     * Project stored config into the flat UI keys referenced by the schema.
+     * Form only sees URLs — the internal id/profileHint/resolution stay
+     * invisible to the operator (the broker decides profiles from probed
+     * metadata at save time).
+     */
+    private collectFormValues;
+    applySettingsPatch(patch: Record<string, unknown>): Promise<void>;
+    /**
+     * Probe a list of RTSP URLs through the kernel stream-probe and return
+     * the new `{id, url, profileHint?, resolution?}` entries. Ids are
+     * assigned `stream-1/2/3` in input order so the UI's slot ordering is
+     * preserved across edits. The broker is in charge of the actual
+     * (high/mid/low) profile assignment via `computeInitialAssignment`.
+     */
+    private probeAndClassify;
+    private registerSnapshotProvider;
+    private fetchHttpSnapshot;
 }
 
-declare class RtspProvider implements IDeviceProvider {
-    readonly id: string;
-    readonly type = "rtsp";
-    readonly name: string;
-    readonly discoveryMode: 'manual';
-    readonly ctx: CamstackContext;
-    private readonly integration;
-    private readonly registry;
-    private readonly devices;
-    constructor(integration: Integration, registry: IIntegrationRegistry, ctx: CamstackContext);
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    getStatus(): ProviderStatus;
-    discoverDevices(): Promise<DiscoveredDevice[]>;
-    getDevices(): IDevice[];
-    getDeviceConfigSchema(): ConfigUISchema;
-    createDevice(config: Record<string, unknown>): Promise<IDevice>;
-    subscribeLiveEvents(_callback: (event: LiveEvent) => void): () => void;
-    private buildDevice;
-}
-
-interface RtspProviderConfig {
-    readonly id: string;
-    readonly name: string;
-}
-
-export { RtspDevice, RtspProvider, type RtspProviderConfig };
+export { RtspCamera, rtspCameraSchema };