@camstack/addon-provider-onvif 0.1.7 → 0.1.9

package/dist/addon.d.mts

@@ -0,0 +1,14 @@
+import { ICamstackAddon, IConfigurable, AddonManifest, AddonContext, CapabilityProviderMap, ConfigUISchema } from '@camstack/types';
+
+declare class OnvifProviderAddon implements ICamstackAddon, IConfigurable {
+    readonly manifest: AddonManifest;
+    private provider;
+    initialize(context: AddonContext): Promise<void>;
+    shutdown(): Promise<void>;
+    getCapabilityProvider<K extends keyof CapabilityProviderMap>(name: K): CapabilityProviderMap[K] | null;
+    getConfigSchema(): ConfigUISchema;
+    getConfig(): Record<string, unknown>;
+    onConfigChange(_config: Record<string, unknown>): Promise<void>;
+}
+
+export { OnvifProviderAddon };

package/dist/addon.d.ts

@@ -0,0 +1,14 @@
+import { ICamstackAddon, IConfigurable, AddonManifest, AddonContext, CapabilityProviderMap, ConfigUISchema } from '@camstack/types';
+
+declare class OnvifProviderAddon implements ICamstackAddon, IConfigurable {
+    readonly manifest: AddonManifest;
+    private provider;
+    initialize(context: AddonContext): Promise<void>;
+    shutdown(): Promise<void>;
+    getCapabilityProvider<K extends keyof CapabilityProviderMap>(name: K): CapabilityProviderMap[K] | null;
+    getConfigSchema(): ConfigUISchema;
+    getConfig(): Record<string, unknown>;
+    onConfigChange(_config: Record<string, unknown>): Promise<void>;
+}
+
+export { OnvifProviderAddon };

package/dist/index.d.mts

@@ -0,0 +1,169 @@
+export { OnvifProviderAddon } from './addon.mjs';
+import { IScopedLogger, IDevice, DeviceType, DeviceCapabilityName, CamstackContext, IDeviceCapability, DeviceState, DeviceMetadata, IDeviceProvider, ProviderStatus, DiscoveredDevice, LiveEvent } from '@camstack/types';
+
+declare class OnvifClient {
+    private readonly host;
+    private readonly port;
+    private readonly username;
+    private readonly password;
+    private readonly logger;
+    private cam;
+    constructor(host: string, port: number, username: string, password: string, logger: IScopedLogger);
+    /** Connect to the camera */
+    connect(): Promise<void>;
+    /** Get device info */
+    getDeviceInfo(): Promise<{
+        manufacturer: string;
+        model: string;
+        firmwareVersion: string;
+        serialNumber: string;
+    }>;
+    /** Get RTSP stream URI */
+    getStreamUri(profileToken?: string): Promise<string>;
+    /** Get available media profiles */
+    getProfiles(): Promise<Array<{
+        token: string;
+        name: string;
+        videoWidth?: number;
+        videoHeight?: number;
+    }>>;
+    /** Get snapshot URI */
+    getSnapshotUri(profileToken?: string): Promise<string>;
+    /** Check if PTZ is supported */
+    hasPtz(): boolean;
+    /** PTZ move (continuous) */
+    ptzMove(options: {
+        x?: number;
+        y?: number;
+        zoom?: number;
+        speed?: number;
+    }): Promise<void>;
+    /** PTZ stop */
+    ptzStop(): Promise<void>;
+    /** PTZ absolute move */
+    ptzAbsoluteMove(options: {
+        x: number;
+        y: number;
+        zoom: number;
+    }): Promise<void>;
+    /** Get PTZ presets */
+    getPtzPresets(): Promise<Array<{
+        token: string;
+        name: string;
+    }>>;
+    /** Go to PTZ preset */
+    gotoPreset(presetToken: string): Promise<void>;
+    disconnect(): void;
+}
+
+interface OnvifDeviceConfig {
+    readonly cameraId: string;
+    readonly cameraName: string;
+    readonly providerId: string;
+    readonly rtspUrl: string;
+    readonly subStreamUrl?: string;
+    readonly snapshotUrl?: string;
+    readonly hasPtz: boolean;
+    readonly profiles: ReadonlyArray<{
+        token: string;
+        name: string;
+        videoWidth?: number;
+        videoHeight?: number;
+    }>;
+    readonly manufacturer?: string;
+    readonly model?: string;
+    readonly firmware?: string;
+}
+declare class OnvifDevice implements IDevice {
+    private readonly client;
+    private readonly config;
+    readonly id: string;
+    readonly name: string;
+    readonly providerId: string;
+    readonly type: DeviceType;
+    readonly capabilities: DeviceCapabilityName[];
+    readonly ctx: CamstackContext;
+    private readonly capabilityMap;
+    constructor(client: OnvifClient, config: OnvifDeviceConfig, ctx: CamstackContext);
+    getCapability<T extends IDeviceCapability>(cap: DeviceCapabilityName): T | null;
+    hasCapability(cap: DeviceCapabilityName): boolean;
+    getState(): DeviceState;
+    getMetadata(): DeviceMetadata;
+    private createCamera;
+    private createPtz;
+}
+
+interface OnvifProviderConfig {
+    readonly id: string;
+    readonly name: string;
+    /** Discovery settings */
+    readonly discovery?: {
+        readonly enabled: boolean;
+        readonly timeout: number;
+    };
+    /** Manually added cameras (in addition to discovered) */
+    readonly cameras?: readonly OnvifCameraConfig[];
+    /** Default credentials for discovered cameras */
+    readonly defaultUsername?: string;
+    readonly defaultPassword?: string;
+}
+interface OnvifCameraConfig {
+    readonly id: string;
+    readonly name: string;
+    readonly host: string;
+    readonly port?: number;
+    readonly username?: string;
+    readonly password?: string;
+    /** Override RTSP URL (skip ONVIF stream URI query) */
+    readonly rtspUrl?: string;
+}
+interface DiscoveredOnvifCamera {
+    readonly host: string;
+    readonly port: number;
+    readonly name?: string;
+    readonly manufacturer?: string;
+    readonly model?: string;
+    readonly firmwareVersion?: string;
+    readonly hardwareId?: string;
+    readonly scopes?: readonly string[];
+}
+
+declare class OnvifProvider implements IDeviceProvider {
+    private readonly config;
+    readonly id: string;
+    readonly type = "onvif";
+    readonly name: string;
+    readonly discoveryMode: 'both';
+    readonly ctx: CamstackContext;
+    private devices;
+    private readonly clients;
+    private lastDiscoveredCameras;
+    constructor(config: OnvifProviderConfig, ctx: CamstackContext);
+    start(): Promise<void>;
+    private addCamera;
+    private loadAdoptedCameras;
+    stop(): Promise<void>;
+    getStatus(): ProviderStatus;
+    discoverDevices(): Promise<DiscoveredDevice[]>;
+    adoptDevice(externalId: string, config?: Record<string, unknown>): Promise<IDevice>;
+    private persistAdoptedCamera;
+    getDevices(): IDevice[];
+    getDeviceConfigSchema(): {
+        id: string;
+        name: string;
+        host: string;
+        port: string;
+        username: string;
+        password: string;
+        rtspUrl: string;
+    };
+    subscribeLiveEvents(_callback: (event: LiveEvent) => void): () => void;
+}
+
+/**
+ * Discovers ONVIF cameras on the local network via WS-Discovery.
+ * Returns a list of found cameras after the given timeout.
+ */
+declare function discoverOnvifCameras(timeout?: number): Promise<readonly DiscoveredOnvifCamera[]>;
+
+export { type DiscoveredOnvifCamera, type OnvifCameraConfig, OnvifClient, OnvifDevice, OnvifProvider, type OnvifProviderConfig, discoverOnvifCameras };

package/dist/index.d.ts

@@ -0,0 +1,169 @@
+export { OnvifProviderAddon } from './addon.js';
+import { IScopedLogger, IDevice, DeviceType, DeviceCapabilityName, CamstackContext, IDeviceCapability, DeviceState, DeviceMetadata, IDeviceProvider, ProviderStatus, DiscoveredDevice, LiveEvent } from '@camstack/types';
+
+declare class OnvifClient {
+    private readonly host;
+    private readonly port;
+    private readonly username;
+    private readonly password;
+    private readonly logger;
+    private cam;
+    constructor(host: string, port: number, username: string, password: string, logger: IScopedLogger);
+    /** Connect to the camera */
+    connect(): Promise<void>;
+    /** Get device info */
+    getDeviceInfo(): Promise<{
+        manufacturer: string;
+        model: string;
+        firmwareVersion: string;
+        serialNumber: string;
+    }>;
+    /** Get RTSP stream URI */
+    getStreamUri(profileToken?: string): Promise<string>;
+    /** Get available media profiles */
+    getProfiles(): Promise<Array<{
+        token: string;
+        name: string;
+        videoWidth?: number;
+        videoHeight?: number;
+    }>>;
+    /** Get snapshot URI */
+    getSnapshotUri(profileToken?: string): Promise<string>;
+    /** Check if PTZ is supported */
+    hasPtz(): boolean;
+    /** PTZ move (continuous) */
+    ptzMove(options: {
+        x?: number;
+        y?: number;
+        zoom?: number;
+        speed?: number;
+    }): Promise<void>;
+    /** PTZ stop */
+    ptzStop(): Promise<void>;
+    /** PTZ absolute move */
+    ptzAbsoluteMove(options: {
+        x: number;
+        y: number;
+        zoom: number;
+    }): Promise<void>;
+    /** Get PTZ presets */
+    getPtzPresets(): Promise<Array<{
+        token: string;
+        name: string;
+    }>>;
+    /** Go to PTZ preset */
+    gotoPreset(presetToken: string): Promise<void>;
+    disconnect(): void;
+}
+
+interface OnvifDeviceConfig {
+    readonly cameraId: string;
+    readonly cameraName: string;
+    readonly providerId: string;
+    readonly rtspUrl: string;
+    readonly subStreamUrl?: string;
+    readonly snapshotUrl?: string;
+    readonly hasPtz: boolean;
+    readonly profiles: ReadonlyArray<{
+        token: string;
+        name: string;
+        videoWidth?: number;
+        videoHeight?: number;
+    }>;
+    readonly manufacturer?: string;
+    readonly model?: string;
+    readonly firmware?: string;
+}
+declare class OnvifDevice implements IDevice {
+    private readonly client;
+    private readonly config;
+    readonly id: string;
+    readonly name: string;
+    readonly providerId: string;
+    readonly type: DeviceType;
+    readonly capabilities: DeviceCapabilityName[];
+    readonly ctx: CamstackContext;
+    private readonly capabilityMap;
+    constructor(client: OnvifClient, config: OnvifDeviceConfig, ctx: CamstackContext);
+    getCapability<T extends IDeviceCapability>(cap: DeviceCapabilityName): T | null;
+    hasCapability(cap: DeviceCapabilityName): boolean;
+    getState(): DeviceState;
+    getMetadata(): DeviceMetadata;
+    private createCamera;
+    private createPtz;
+}
+
+interface OnvifProviderConfig {
+    readonly id: string;
+    readonly name: string;
+    /** Discovery settings */
+    readonly discovery?: {
+        readonly enabled: boolean;
+        readonly timeout: number;
+    };
+    /** Manually added cameras (in addition to discovered) */
+    readonly cameras?: readonly OnvifCameraConfig[];
+    /** Default credentials for discovered cameras */
+    readonly defaultUsername?: string;
+    readonly defaultPassword?: string;
+}
+interface OnvifCameraConfig {
+    readonly id: string;
+    readonly name: string;
+    readonly host: string;
+    readonly port?: number;
+    readonly username?: string;
+    readonly password?: string;
+    /** Override RTSP URL (skip ONVIF stream URI query) */
+    readonly rtspUrl?: string;
+}
+interface DiscoveredOnvifCamera {
+    readonly host: string;
+    readonly port: number;
+    readonly name?: string;
+    readonly manufacturer?: string;
+    readonly model?: string;
+    readonly firmwareVersion?: string;
+    readonly hardwareId?: string;
+    readonly scopes?: readonly string[];
+}
+
+declare class OnvifProvider implements IDeviceProvider {
+    private readonly config;
+    readonly id: string;
+    readonly type = "onvif";
+    readonly name: string;
+    readonly discoveryMode: 'both';
+    readonly ctx: CamstackContext;
+    private devices;
+    private readonly clients;
+    private lastDiscoveredCameras;
+    constructor(config: OnvifProviderConfig, ctx: CamstackContext);
+    start(): Promise<void>;
+    private addCamera;
+    private loadAdoptedCameras;
+    stop(): Promise<void>;
+    getStatus(): ProviderStatus;
+    discoverDevices(): Promise<DiscoveredDevice[]>;
+    adoptDevice(externalId: string, config?: Record<string, unknown>): Promise<IDevice>;
+    private persistAdoptedCamera;
+    getDevices(): IDevice[];
+    getDeviceConfigSchema(): {
+        id: string;
+        name: string;
+        host: string;
+        port: string;
+        username: string;
+        password: string;
+        rtspUrl: string;
+    };
+    subscribeLiveEvents(_callback: (event: LiveEvent) => void): () => void;
+}
+
+/**
+ * Discovers ONVIF cameras on the local network via WS-Discovery.
+ * Returns a list of found cameras after the given timeout.
+ */
+declare function discoverOnvifCameras(timeout?: number): Promise<readonly DiscoveredOnvifCamera[]>;
+
+export { type DiscoveredOnvifCamera, type OnvifCameraConfig, OnvifClient, OnvifDevice, OnvifProvider, type OnvifProviderConfig, discoverOnvifCameras };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/addon-provider-onvif",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "ONVIF camera device provider addon for CamStack",
   "keywords": [
     "camstack",
@@ -21,9 +21,9 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "require": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },