@camstack/addon-pipeline 0.1.0

package/dist/addon-CwDFZWAb.d.cts

@@ -0,0 +1,238 @@
+import Database from 'better-sqlite3';
+import { FfmpegConfig, INetworkQualityTracker, IScopedLogger, IEventBus, IStreamingEngine, IPipelineManager, IFileStorage, ICamstackAddon, IConfigurable, AddonManifest, AddonContext, CapabilityProviderMap, ConfigUISchema } from '@camstack/types';
+
+interface RecordingPolicy {
+    readonly deviceId: string;
+    readonly mode: RecordingMode;
+    readonly streams: readonly StreamPolicy[];
+    readonly enabled: boolean;
+    readonly preBufferSec: number;
+    readonly postBufferSec: number;
+    readonly scheduleRules?: readonly ScheduleRule[];
+}
+type RecordingMode = 'continuous' | 'motion' | 'scheduled' | 'composite';
+interface StreamPolicy {
+    readonly streamId: string;
+    readonly mode: 'always' | 'inherit';
+}
+interface ScheduleRule {
+    readonly days: readonly number[];
+    readonly startTime: string;
+    readonly endTime: string;
+    readonly mode: 'continuous' | 'motion';
+}
+interface RecordingStorageConfig {
+    readonly deviceId: string;
+    readonly dataCategory: DataCategory;
+    readonly storageName: string;
+    readonly subDirectory: string;
+    readonly retentionDays: number | null;
+    readonly retentionGb: number | null;
+}
+type DataCategory = 'recording:main' | 'recording:mid' | 'recording:sub' | 'thumbnail:scrub' | 'thumbnail:event';
+interface RecordingSegment {
+    readonly id: string;
+    readonly deviceId: string;
+    readonly streamId: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly duration: number;
+    readonly path: string;
+    readonly storageName: string;
+    readonly subDirectory: string;
+    readonly sizeBytes: number;
+    readonly codec: 'h264' | 'h265';
+    readonly hasAudio: boolean;
+}
+interface RecordingThumbnail {
+    readonly deviceId: string;
+    readonly timestamp: number;
+    readonly path: string;
+    readonly storageName: string;
+    readonly subDirectory: string;
+    readonly sizeBytes: number;
+    readonly category: 'scrub' | 'event';
+}
+type CleanupStatus = 'pending' | 'in_progress' | 'completed' | 'cancelled';
+interface CleanupQueueEntry {
+    readonly deviceId: string;
+    readonly disabledAt: number;
+    readonly cleanupAfter: number;
+    readonly status: CleanupStatus;
+    readonly startedAt: number | null;
+}
+type SegmentWriterState = 'idle' | 'recording' | 'rotating' | 'stopping';
+interface StreamEstimate {
+    readonly bitrateKbps: number;
+    readonly retentionDays: number | null;
+    readonly retentionGb: number | null;
+    readonly estimatedGb: number;
+    readonly estimatedDaysAtCapacity: number | null;
+}
+interface StorageEstimate {
+    readonly perStream: Readonly<Record<string, StreamEstimate>>;
+    readonly thumbnails: {
+        readonly estimatedGb: number;
+    };
+    readonly totalEstimatedGb: number;
+    readonly motionEstimate?: {
+        readonly avgEventsPerDay: number;
+        readonly avgDurationSec: number;
+        readonly dutyCyclePercent: number;
+    };
+}
+interface RecordingEnableConfig {
+    readonly policy: Omit<RecordingPolicy, 'deviceId'>;
+    readonly storageOverrides?: readonly Omit<RecordingStorageConfig, 'deviceId'>[];
+    readonly ffmpegOverrides?: Partial<FfmpegConfig>;
+}
+
+interface StorageUsage {
+    readonly totalBytes: number;
+    readonly segmentCount: number;
+}
+interface AvailabilityRange {
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly streams: readonly string[];
+}
+declare class RecordingDb$1 {
+    private readonly db;
+    constructor(db: Database.Database);
+    initialize(): void;
+    insertSegment(seg: RecordingSegment): void;
+    querySegments(deviceId: string, streamId: string, startTime: number, endTime: number): readonly RecordingSegment[];
+    deleteSegmentsBefore(deviceId: string, streamId: string, beforeTime: number): readonly RecordingSegment[];
+    deleteSegmentsForDevice(deviceId: string): readonly RecordingSegment[];
+    getStorageUsage(deviceId: string, streamId: string): StorageUsage;
+    getOldestSegments(deviceId: string, streamId: string, limit: number): readonly RecordingSegment[];
+    getAvailability(deviceId: string, startTime: number, endTime: number): readonly AvailabilityRange[];
+    getMotionStats(deviceId: string, startTime: number, endTime: number): {
+        readonly totalEvents: number;
+        readonly avgDurationSec: number;
+        readonly avgEventsPerDay: number;
+        readonly dutyCyclePercent: number;
+    };
+    insertThumbnail(thumb: RecordingThumbnail): void;
+    findNearestThumbnail(deviceId: string, timestamp: number, category: string): RecordingThumbnail | null;
+    deleteThumbnailsBefore(deviceId: string, beforeTime: number): number;
+    deleteThumbnailsForDevice(deviceId: string): number;
+    upsertPolicy(policy: {
+        deviceId: string;
+        enabled: boolean;
+        mode: RecordingMode;
+        streams: readonly StreamPolicy[];
+        preBufferSec: number;
+        postBufferSec: number;
+        scheduleRules?: readonly ScheduleRule[];
+    }): void;
+    getPolicy(deviceId: string): RecordingPolicy | null;
+    getEnabledPolicies(): readonly RecordingPolicy[];
+    deletePolicy(deviceId: string): void;
+    upsertStorageConfig(config: RecordingStorageConfig): void;
+    resolveStorageConfig(deviceId: string, category: DataCategory): RecordingStorageConfig | null;
+    addToCleanupQueue(deviceId: string, disabledAt: number): void;
+    cancelCleanup(deviceId: string): void;
+    getCleanupEntry(deviceId: string): CleanupQueueEntry | null;
+    getPendingCleanups(): readonly CleanupQueueEntry[];
+    resetStaleCleanups(maxAgeMs?: number): void;
+    markCleanupInProgress(deviceId: string): void;
+    markCleanupCompleted(deviceId: string): void;
+}
+
+interface PlaylistOptions {
+    readonly live?: boolean;
+}
+declare class PlaylistGenerator {
+    private readonly db;
+    constructor(db: RecordingDb$1);
+    generate(deviceId: string, streamId: string, startTime: number, endTime: number, options?: PlaylistOptions): string;
+    private resolveSegments;
+    private buildPlaylist;
+}
+
+interface MotionEstimateInput {
+    readonly avgEventsPerDay: number;
+    readonly avgDurationSec: number;
+}
+declare class StorageEstimator {
+    private readonly db;
+    private readonly networkTracker;
+    constructor(db: RecordingDb$1, networkTracker: INetworkQualityTracker);
+    estimateForDevice(deviceId: string, motionInput?: MotionEstimateInput): StorageEstimate;
+}
+
+interface RecordingCoordinatorConfig {
+    readonly db: RecordingDb$1;
+    readonly logger: IScopedLogger;
+    readonly eventBus: IEventBus;
+    readonly streamingEngine: IStreamingEngine;
+    readonly pipelineManager: IPipelineManager;
+    readonly networkTracker: INetworkQualityTracker;
+    readonly fileStorage: IFileStorage;
+    readonly storagePath: string;
+    readonly globalFfmpegConfig: Partial<FfmpegConfig>;
+    readonly detectedFfmpegConfig: Partial<FfmpegConfig>;
+}
+declare class RecordingCoordinator$1 {
+    private readonly db;
+    private readonly logger;
+    private readonly eventBus;
+    private readonly streamingEngine;
+    private readonly pipelineManager;
+    private readonly networkTracker;
+    private readonly fileStorage;
+    private readonly storagePath;
+    private readonly globalFfmpegConfig;
+    private readonly detectedFfmpegConfig;
+    private readonly recordings;
+    private policyTimer;
+    private readonly retentionManager;
+    readonly playlistGenerator: PlaylistGenerator;
+    readonly storageEstimator: StorageEstimator;
+    constructor(config: RecordingCoordinatorConfig);
+    start(): Promise<void>;
+    stop(): void;
+    enableRecording(deviceId: string, config: RecordingEnableConfig): Promise<void>;
+    disableRecording(deviceId: string): Promise<void>;
+    isRecording(deviceId: string): boolean;
+    evaluatePolicies(): void;
+    static evaluateScheduleRule(rule: ScheduleRule, date: Date): boolean;
+    private subscribeToMotionEvents;
+    private handleMotionEvent;
+    private stopRecordingInternal;
+}
+
+type RecordingCoordinator = RecordingCoordinator$1;
+type RecordingDb = RecordingDb$1;
+interface RecordingEngineDependencies {
+    readonly streamingEngine: IStreamingEngine;
+    readonly pipelineManager: IPipelineManager;
+    readonly networkTracker: INetworkQualityTracker;
+}
+type RecordingEngineV2Dependencies = RecordingEngineDependencies;
+declare class PipelineAddon implements ICamstackAddon, IConfigurable {
+    readonly manifest: AddonManifest;
+    private brokerManager;
+    private coordinator;
+    private recordingDb;
+    private sqliteDb;
+    private recordingDeps;
+    private currentRecordingConfig;
+    private analysisPipeline;
+    private analysisLogger;
+    private persistenceFacade;
+    setRecordingDependencies(deps: RecordingEngineDependencies): void;
+    initialize(context: AddonContext): Promise<void>;
+    shutdown(): Promise<void>;
+    getCapabilityProvider<K extends keyof CapabilityProviderMap>(name: K): CapabilityProviderMap[K] | null;
+    getCoordinator(): RecordingCoordinator;
+    getRecordingDb(): RecordingDb;
+    /** Whether the analysis pipeline package loaded successfully */
+    isAnalysisAvailable(): boolean;
+    getConfigSchema(): ConfigUISchema;
+    getConfig(): Record<string, unknown>;
+    onConfigChange(config: Record<string, unknown>): Promise<void>;
+}
+
+export { type AvailabilityRange as A, type CleanupQueueEntry as C, type DataCategory as D, PipelineAddon as P, RecordingCoordinator$1 as R, type ScheduleRule as S, type CleanupStatus as a, RecordingDb$1 as b, type RecordingEnableConfig as c, type RecordingEngineDependencies as d, type RecordingEngineV2Dependencies as e, type RecordingMode as f, type RecordingPolicy as g, type RecordingSegment as h, type RecordingStorageConfig as i, type RecordingThumbnail as j, type SegmentWriterState as k, type StorageEstimate as l, type StorageUsage as m, type StreamEstimate as n, type StreamPolicy as o };

package/dist/addon-CwDFZWAb.d.ts

@@ -0,0 +1,238 @@
+import Database from 'better-sqlite3';
+import { FfmpegConfig, INetworkQualityTracker, IScopedLogger, IEventBus, IStreamingEngine, IPipelineManager, IFileStorage, ICamstackAddon, IConfigurable, AddonManifest, AddonContext, CapabilityProviderMap, ConfigUISchema } from '@camstack/types';
+
+interface RecordingPolicy {
+    readonly deviceId: string;
+    readonly mode: RecordingMode;
+    readonly streams: readonly StreamPolicy[];
+    readonly enabled: boolean;
+    readonly preBufferSec: number;
+    readonly postBufferSec: number;
+    readonly scheduleRules?: readonly ScheduleRule[];
+}
+type RecordingMode = 'continuous' | 'motion' | 'scheduled' | 'composite';
+interface StreamPolicy {
+    readonly streamId: string;
+    readonly mode: 'always' | 'inherit';
+}
+interface ScheduleRule {
+    readonly days: readonly number[];
+    readonly startTime: string;
+    readonly endTime: string;
+    readonly mode: 'continuous' | 'motion';
+}
+interface RecordingStorageConfig {
+    readonly deviceId: string;
+    readonly dataCategory: DataCategory;
+    readonly storageName: string;
+    readonly subDirectory: string;
+    readonly retentionDays: number | null;
+    readonly retentionGb: number | null;
+}
+type DataCategory = 'recording:main' | 'recording:mid' | 'recording:sub' | 'thumbnail:scrub' | 'thumbnail:event';
+interface RecordingSegment {
+    readonly id: string;
+    readonly deviceId: string;
+    readonly streamId: string;
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly duration: number;
+    readonly path: string;
+    readonly storageName: string;
+    readonly subDirectory: string;
+    readonly sizeBytes: number;
+    readonly codec: 'h264' | 'h265';
+    readonly hasAudio: boolean;
+}
+interface RecordingThumbnail {
+    readonly deviceId: string;
+    readonly timestamp: number;
+    readonly path: string;
+    readonly storageName: string;
+    readonly subDirectory: string;
+    readonly sizeBytes: number;
+    readonly category: 'scrub' | 'event';
+}
+type CleanupStatus = 'pending' | 'in_progress' | 'completed' | 'cancelled';
+interface CleanupQueueEntry {
+    readonly deviceId: string;
+    readonly disabledAt: number;
+    readonly cleanupAfter: number;
+    readonly status: CleanupStatus;
+    readonly startedAt: number | null;
+}
+type SegmentWriterState = 'idle' | 'recording' | 'rotating' | 'stopping';
+interface StreamEstimate {
+    readonly bitrateKbps: number;
+    readonly retentionDays: number | null;
+    readonly retentionGb: number | null;
+    readonly estimatedGb: number;
+    readonly estimatedDaysAtCapacity: number | null;
+}
+interface StorageEstimate {
+    readonly perStream: Readonly<Record<string, StreamEstimate>>;
+    readonly thumbnails: {
+        readonly estimatedGb: number;
+    };
+    readonly totalEstimatedGb: number;
+    readonly motionEstimate?: {
+        readonly avgEventsPerDay: number;
+        readonly avgDurationSec: number;
+        readonly dutyCyclePercent: number;
+    };
+}
+interface RecordingEnableConfig {
+    readonly policy: Omit<RecordingPolicy, 'deviceId'>;
+    readonly storageOverrides?: readonly Omit<RecordingStorageConfig, 'deviceId'>[];
+    readonly ffmpegOverrides?: Partial<FfmpegConfig>;
+}
+
+interface StorageUsage {
+    readonly totalBytes: number;
+    readonly segmentCount: number;
+}
+interface AvailabilityRange {
+    readonly startTime: number;
+    readonly endTime: number;
+    readonly streams: readonly string[];
+}
+declare class RecordingDb$1 {
+    private readonly db;
+    constructor(db: Database.Database);
+    initialize(): void;
+    insertSegment(seg: RecordingSegment): void;
+    querySegments(deviceId: string, streamId: string, startTime: number, endTime: number): readonly RecordingSegment[];
+    deleteSegmentsBefore(deviceId: string, streamId: string, beforeTime: number): readonly RecordingSegment[];
+    deleteSegmentsForDevice(deviceId: string): readonly RecordingSegment[];
+    getStorageUsage(deviceId: string, streamId: string): StorageUsage;
+    getOldestSegments(deviceId: string, streamId: string, limit: number): readonly RecordingSegment[];
+    getAvailability(deviceId: string, startTime: number, endTime: number): readonly AvailabilityRange[];
+    getMotionStats(deviceId: string, startTime: number, endTime: number): {
+        readonly totalEvents: number;
+        readonly avgDurationSec: number;
+        readonly avgEventsPerDay: number;
+        readonly dutyCyclePercent: number;
+    };
+    insertThumbnail(thumb: RecordingThumbnail): void;
+    findNearestThumbnail(deviceId: string, timestamp: number, category: string): RecordingThumbnail | null;
+    deleteThumbnailsBefore(deviceId: string, beforeTime: number): number;
+    deleteThumbnailsForDevice(deviceId: string): number;
+    upsertPolicy(policy: {
+        deviceId: string;
+        enabled: boolean;
+        mode: RecordingMode;
+        streams: readonly StreamPolicy[];
+        preBufferSec: number;
+        postBufferSec: number;
+        scheduleRules?: readonly ScheduleRule[];
+    }): void;
+    getPolicy(deviceId: string): RecordingPolicy | null;
+    getEnabledPolicies(): readonly RecordingPolicy[];
+    deletePolicy(deviceId: string): void;
+    upsertStorageConfig(config: RecordingStorageConfig): void;
+    resolveStorageConfig(deviceId: string, category: DataCategory): RecordingStorageConfig | null;
+    addToCleanupQueue(deviceId: string, disabledAt: number): void;
+    cancelCleanup(deviceId: string): void;
+    getCleanupEntry(deviceId: string): CleanupQueueEntry | null;
+    getPendingCleanups(): readonly CleanupQueueEntry[];
+    resetStaleCleanups(maxAgeMs?: number): void;
+    markCleanupInProgress(deviceId: string): void;
+    markCleanupCompleted(deviceId: string): void;
+}
+
+interface PlaylistOptions {
+    readonly live?: boolean;
+}
+declare class PlaylistGenerator {
+    private readonly db;
+    constructor(db: RecordingDb$1);
+    generate(deviceId: string, streamId: string, startTime: number, endTime: number, options?: PlaylistOptions): string;
+    private resolveSegments;
+    private buildPlaylist;
+}
+
+interface MotionEstimateInput {
+    readonly avgEventsPerDay: number;
+    readonly avgDurationSec: number;
+}
+declare class StorageEstimator {
+    private readonly db;
+    private readonly networkTracker;
+    constructor(db: RecordingDb$1, networkTracker: INetworkQualityTracker);
+    estimateForDevice(deviceId: string, motionInput?: MotionEstimateInput): StorageEstimate;
+}
+
+interface RecordingCoordinatorConfig {
+    readonly db: RecordingDb$1;
+    readonly logger: IScopedLogger;
+    readonly eventBus: IEventBus;
+    readonly streamingEngine: IStreamingEngine;
+    readonly pipelineManager: IPipelineManager;
+    readonly networkTracker: INetworkQualityTracker;
+    readonly fileStorage: IFileStorage;
+    readonly storagePath: string;
+    readonly globalFfmpegConfig: Partial<FfmpegConfig>;
+    readonly detectedFfmpegConfig: Partial<FfmpegConfig>;
+}
+declare class RecordingCoordinator$1 {
+    private readonly db;
+    private readonly logger;
+    private readonly eventBus;
+    private readonly streamingEngine;
+    private readonly pipelineManager;
+    private readonly networkTracker;
+    private readonly fileStorage;
+    private readonly storagePath;
+    private readonly globalFfmpegConfig;
+    private readonly detectedFfmpegConfig;
+    private readonly recordings;
+    private policyTimer;
+    private readonly retentionManager;
+    readonly playlistGenerator: PlaylistGenerator;
+    readonly storageEstimator: StorageEstimator;
+    constructor(config: RecordingCoordinatorConfig);
+    start(): Promise<void>;
+    stop(): void;
+    enableRecording(deviceId: string, config: RecordingEnableConfig): Promise<void>;
+    disableRecording(deviceId: string): Promise<void>;
+    isRecording(deviceId: string): boolean;
+    evaluatePolicies(): void;
+    static evaluateScheduleRule(rule: ScheduleRule, date: Date): boolean;
+    private subscribeToMotionEvents;
+    private handleMotionEvent;
+    private stopRecordingInternal;
+}
+
+type RecordingCoordinator = RecordingCoordinator$1;
+type RecordingDb = RecordingDb$1;
+interface RecordingEngineDependencies {
+    readonly streamingEngine: IStreamingEngine;
+    readonly pipelineManager: IPipelineManager;
+    readonly networkTracker: INetworkQualityTracker;
+}
+type RecordingEngineV2Dependencies = RecordingEngineDependencies;
+declare class PipelineAddon implements ICamstackAddon, IConfigurable {
+    readonly manifest: AddonManifest;
+    private brokerManager;
+    private coordinator;
+    private recordingDb;
+    private sqliteDb;
+    private recordingDeps;
+    private currentRecordingConfig;
+    private analysisPipeline;
+    private analysisLogger;
+    private persistenceFacade;
+    setRecordingDependencies(deps: RecordingEngineDependencies): void;
+    initialize(context: AddonContext): Promise<void>;
+    shutdown(): Promise<void>;
+    getCapabilityProvider<K extends keyof CapabilityProviderMap>(name: K): CapabilityProviderMap[K] | null;
+    getCoordinator(): RecordingCoordinator;
+    getRecordingDb(): RecordingDb;
+    /** Whether the analysis pipeline package loaded successfully */
+    isAnalysisAvailable(): boolean;
+    getConfigSchema(): ConfigUISchema;
+    getConfig(): Record<string, unknown>;
+    onConfigChange(config: Record<string, unknown>): Promise<void>;
+}
+
+export { type AvailabilityRange as A, type CleanupQueueEntry as C, type DataCategory as D, PipelineAddon as P, RecordingCoordinator$1 as R, type ScheduleRule as S, type CleanupStatus as a, RecordingDb$1 as b, type RecordingEnableConfig as c, type RecordingEngineDependencies as d, type RecordingEngineV2Dependencies as e, type RecordingMode as f, type RecordingPolicy as g, type RecordingSegment as h, type RecordingStorageConfig as i, type RecordingThumbnail as j, type SegmentWriterState as k, type StorageEstimate as l, type StorageUsage as m, type StreamEstimate as n, type StreamPolicy as o };