@camstack/sdk 0.1.26 → 0.1.27

package/dist/types/src/interfaces/api-shared.d.ts

@@ -1,175 +0,0 @@
-/**
- * API-shared types — types that originated in @camstack/core, @camstack/kernel,
- * or server internals and are now canonical here so the generated API type file
- * has zero external dependencies beyond @camstack/types.
- */
-import type { ProviderStatus } from './device-provider.js';
-import type { ElementStatus } from './lifecycle.js';
-import type { CameraPriority, CameraPhase } from './stream-broker.js';
-import type { AddonPageDeclaration } from './addon.js';
-export interface BackupManifest {
-    readonly id: string;
-    readonly timestamp: number;
-    readonly label?: string;
-    readonly locations: readonly string[];
-    readonly sizeMB: number;
-    readonly path: string;
-}
-export interface ProviderListItem {
-    id: string;
-    type: string;
-    name: string;
-    status: ProviderStatus;
-    started: boolean;
-    lifecycle: ElementStatus;
-}
-export interface InstalledPackage {
-    readonly name: string;
-    readonly version: string;
-    readonly dir: string;
-    readonly installSource?: 'npm' | 'workspace' | 'upload';
-}
-export interface PackageVersionInfo {
-    readonly version: string;
-    readonly publishedAt: string;
-    readonly deprecated?: string;
-    readonly distTags: readonly string[];
-}
-export type AutoUpdateChannel = 'off' | 'latest' | 'beta' | 'inherit';
-/** A page declaration enriched with its source addon ID */
-export interface AddonPageInfo {
-    readonly addonId: string;
-    readonly page: AddonPageDeclaration;
-    readonly bundleUrl: string;
-}
-export type BenchmarkPhase = 'init' | 'warmup' | 'running' | 'done';
-export interface BenchmarkProgress {
-    readonly addonId: string;
-    readonly phase: BenchmarkPhase;
-    readonly elapsedSec: number;
-    readonly totalSec: number;
-    readonly warmupFrame: number;
-    readonly warmupTotal: number;
-    readonly framesProcessed: number;
-    readonly totalDetections: number;
-    readonly objectsFound: number;
-    readonly errorCount: number;
-    readonly simulatedCameras: number;
-    readonly batchSize: number;
-    readonly currentDps: number;
-    readonly currentFps: number;
-    readonly recentAvgMs: number;
-    readonly inferenceMs: number;
-}
-export interface BenchmarkResult {
-    readonly addonId: string;
-    readonly addonName: string;
-    readonly referenceImage: string;
-    readonly runtime: string;
-    readonly iterations: number;
-    readonly durationSec: number;
-    readonly warmup: number;
-    readonly inputResolution: string;
-    readonly dps: number;
-    readonly totalDetections: number;
-    readonly objectsFound: number;
-    readonly avgDetectionsPerFrame: number;
-    readonly inferenceAvgMs: number;
-    readonly inferenceP50Ms: number;
-    readonly inferenceP95Ms: number;
-    readonly inferenceP99Ms: number;
-    readonly fps: number;
-    readonly avgMs: number;
-    readonly p50Ms: number;
-    readonly p95Ms: number;
-    readonly p99Ms: number;
-    readonly minMs: number;
-    readonly maxMs: number;
-    readonly peakMemoryMB: number;
-    readonly errorCount: number;
-    readonly successCount: number;
-    readonly modelId: string;
-    readonly simulatedCameras: number;
-    readonly batchSize: number;
-}
-export interface HistoryEntry {
-    readonly id: string;
-    readonly date: string;
-    readonly agentName: string;
-    readonly addonId: string;
-    readonly modelName: string;
-    readonly runtime: string;
-    readonly dps: number;
-    readonly inferenceAvgMs: number;
-    readonly totalDetections: number;
-    readonly fps: number;
-    readonly avgMs: number;
-    readonly p50Ms: number;
-    readonly p95Ms: number;
-    readonly p99Ms: number;
-    readonly minMs: number;
-    readonly maxMs: number;
-    readonly peakMemoryMB: number;
-    readonly iterations: number;
-    readonly warmup: number;
-    readonly inputResolution: string;
-    readonly simulatedCameras?: number;
-    readonly batchSize?: number;
-    readonly errorCount?: number;
-}
-export interface PipelineProgressEvent {
-    readonly step: 'loading-engine' | 'inferring' | 'complete';
-    readonly addonId: string;
-    readonly modelId: string;
-    readonly ms?: number;
-    readonly message?: string;
-}
-export interface OrchestratorMetrics {
-    readonly activeCameras: number;
-    readonly throttledCameras: number;
-    readonly avgInferenceTimeMs: number;
-    readonly queueDepth: number;
-}
-export interface CameraMetrics {
-    readonly priority: CameraPriority;
-    readonly configuredFps: number;
-    readonly actualFps: number;
-    readonly queueDepth: number;
-    readonly avgInferenceTimeMs: number;
-    readonly droppedFrames: number;
-    readonly phase: CameraPhase;
-}
-export interface PackageUpdate {
-    readonly name: string;
-    readonly currentVersion: string;
-    readonly latestVersion: string;
-    readonly category: 'addon' | 'core';
-    readonly requiresRestart: boolean;
-}
-export interface UpdateResult {
-    readonly success: boolean;
-    readonly version: string;
-    readonly requiresRestart: boolean;
-    readonly error?: string;
-}
-export interface DetectorDetails {
-    id: string;
-    name: string;
-    models: Array<{
-        id: string;
-        name: string;
-        inputSize?: {
-            width: number;
-            height: number;
-        };
-    }>;
-    runtimes: Array<{
-        value: string;
-        label: string;
-    }>;
-    backends: Array<{
-        value: string;
-        label: string;
-    }>;
-    defaultConfig: Record<string, unknown> | null;
-}

package/dist/types/src/interfaces/auth-provider.d.ts

@@ -1,38 +0,0 @@
-/**
- * Result returned by an auth provider after successful authentication.
- */
-export interface AuthResult {
-    readonly externalId: string;
-    readonly username: string;
-    readonly email?: string;
-    readonly displayName?: string;
-    readonly avatarUrl?: string;
-    readonly groups?: string[];
-    readonly rawProfile?: unknown;
-}
-/**
- * Pluggable authentication provider.
- * Each addon can register one or more auth providers (collection capability).
- */
-export interface IAuthProvider {
-    readonly id: string;
-    readonly name: string;
-    readonly icon: string;
-    /** Type of auth flow */
-    readonly flowType: 'credentials' | 'redirect' | 'token';
-    /**
-     * For 'credentials' flow: validate username/password, return user info.
-     */
-    validateCredentials?(username: string, password: string): Promise<AuthResult | null>;
-    /**
-     * For 'redirect' flow (OIDC, OAuth2):
-     * getLoginUrl() returns the URL to redirect the user to.
-     * handleCallback() processes the callback and returns user info.
-     */
-    getLoginUrl?(state: string): string;
-    handleCallback?(params: Record<string, string>): Promise<AuthResult>;
-    /**
-     * For 'token' flow: validate an external token (e.g., from mobile app).
-     */
-    validateToken?(token: string): Promise<AuthResult | null>;
-}

package/dist/types/src/interfaces/auth.d.ts

@@ -1,46 +0,0 @@
-export type UserRole = 'super_admin' | 'admin' | 'viewer' | 'agent';
-export interface UserPermissions {
-    role: UserRole;
-    allowedProviders: string[] | '*';
-    allowedDevices: Record<string, string[] | '*'>;
-}
-export interface UserRecord {
-    id: string;
-    username: string;
-    passwordHash: string;
-    role: UserRole;
-    allowedProviders: string[] | '*';
-    allowedDevices: Record<string, string[] | '*'>;
-    createdAt: number;
-    updatedAt: number;
-}
-export interface ApiKeyRecord {
-    id: string;
-    label: string;
-    role: UserRole;
-    allowedProviders: string[] | '*';
-    allowedDevices: Record<string, string[] | '*'>;
-    tokenHash: string;
-    tokenPrefix: string;
-    createdAt: number;
-    lastUsedAt?: number;
-}
-export interface TokenPayload {
-    type?: 'api_key' | 'service';
-    keyId?: string;
-    userId?: string;
-    username?: string;
-    role: UserRole;
-    agentId?: string;
-    allowedProviders: string[] | '*';
-    allowedDevices: Record<string, string[] | '*'>;
-    iat?: number;
-    exp?: number;
-}
-export interface AuthenticatedUser {
-    id: string;
-    username: string;
-    role: UserRole;
-    permissions: UserPermissions;
-    isApiKey: boolean;
-}

package/dist/types/src/interfaces/camera-pipeline.d.ts

@@ -1,120 +0,0 @@
-/**
- * Camera Analysis Pipeline -- unified stream processing.
- */
-export interface IStreamSourceAdapter {
-    protocol: string;
-    connect(config: Record<string, unknown>): Promise<NormalizedSource>;
-    disconnect(): Promise<void>;
-    getStatus(): SourceAdapterStatus;
-}
-export interface NormalizedSource {
-    type: 'url' | 'pipe';
-    url?: string;
-    pipe?: NodeJS.ReadableStream;
-    capabilities: SourceCapabilities;
-}
-export interface SourceCapabilities {
-    hasVideo: boolean;
-    hasAudio: boolean;
-    videoCodec?: 'h264' | 'h265' | 'mjpeg' | 'vp8' | 'vp9' | 'av1';
-    audioCodec?: 'aac' | 'opus' | 'pcm' | 'g711';
-    width?: number;
-    height?: number;
-    fps?: number;
-    sampleRate?: number;
-    audioChannels?: number;
-}
-export interface SourceAdapterStatus {
-    connected: boolean;
-    protocol: string;
-    error?: string;
-    bytesReceived?: number;
-    connectedSince?: number;
-}
-export interface VideoFrame {
-    data: Buffer;
-    format: 'jpeg' | 'raw-yuv420' | 'raw-rgb' | 'h264-nal';
-    width: number;
-    height: number;
-    pts: number;
-    timestamp: number;
-    keyframe?: boolean;
-}
-export interface AudioChunk {
-    data: Buffer;
-    format: 'pcm-s16le' | 'pcm-f32le' | 'aac' | 'opus';
-    sampleRate: number;
-    channels: number;
-    pts: number;
-    timestamp: number;
-    dBFS?: number;
-}
-export interface ICameraPipeline {
-    readonly deviceId: string;
-    readonly active: boolean;
-    start(): Promise<void>;
-    stop(): Promise<void>;
-    onVideoFrame(callback: VideoFrameCallback, options?: FrameSubscriptionOptions): () => void;
-    getLatestFrame(): VideoFrame | null;
-    onAudioChunk(callback: AudioChunkCallback): () => void;
-    getAudioLevel(): number;
-    getOutputStream(format: PipelineOutputFormat): PipelineOutputStream | null;
-    getAvailableOutputs(): PipelineOutputFormat[];
-    getStatus(): PipelineStatusInfo;
-}
-export type VideoFrameCallback = (frame: VideoFrame) => void;
-export type AudioChunkCallback = (chunk: AudioChunk) => void;
-export interface FrameSubscriptionOptions {
-    maxFps?: number;
-    format?: 'jpeg' | 'raw-yuv420' | 'raw-rgb';
-    maxWidth?: number;
-    maxHeight?: number;
-    keyframeOnly?: boolean;
-}
-export type PipelineOutputFormat = 'webrtc' | 'hls' | 'mjpeg' | 'rtsp' | 'raw-h264';
-export interface PipelineOutputStream {
-    format: PipelineOutputFormat;
-    url?: string;
-    createOffer?(): Promise<string>;
-    handleAnswer?(sdp: string): Promise<void>;
-    pipe?: NodeJS.ReadableStream;
-    consumerCount: number;
-}
-export interface PipelineStatusInfo {
-    active: boolean;
-    source: {
-        protocol: string;
-        connected: boolean;
-        capabilities: SourceCapabilities;
-    } | null;
-    decode: {
-        fps: number;
-        droppedFrames: number;
-        totalFrames: number;
-    };
-    videoConsumers: number;
-    audioConsumers: number;
-    outputs: Array<{
-        format: PipelineOutputFormat;
-        consumers: number;
-        active: boolean;
-    }>;
-    uptime: number;
-}
-export interface IPipelineManager {
-    getPipeline(deviceId: string): ICameraPipeline | null;
-    createPipeline(deviceId: string, source: NormalizedSource): ICameraPipeline;
-    destroyPipeline(deviceId: string): Promise<void>;
-    listPipelines(): Array<{
-        deviceId: string;
-        status: PipelineStatusInfo;
-    }>;
-}
-export interface IPipelineConsumer {
-    id: string;
-    name: string;
-    videoRequirements?: FrameSubscriptionOptions;
-    needsAudio: boolean;
-    attachToPipeline(pipeline: ICameraPipeline, deviceId: string): void;
-    detachFromPipeline(deviceId: string): void;
-}

package/dist/types/src/interfaces/capability.d.ts

@@ -1,83 +0,0 @@
-import type { IStorageProvider } from './storage.js';
-import type { ILogDestination } from './logging.js';
-import type { IAnalysisAddon } from './analysis.js';
-import type { IAddonPageProvider, IAdminUI } from './addon.js';
-import type { IAuthProvider } from './auth-provider.js';
-import type { INotificationOutput } from './notification.js';
-import type { IAddonRouteProvider } from './addon-routes.js';
-import type { IAnalysisDataPersistence } from './analysis-persistence.js';
-import type { ISceneIntelligence } from './scene-intelligence.js';
-import type { IAdvancedNotifier } from './advanced-notifier.js';
-/**
- * Whether a capability allows one active provider (singleton) or many (collection).
- */
-export type CapabilityMode = 'singleton' | 'collection';
-/**
- * Declared in addon package.json manifests under camstack.addons[].capabilities.
- */
-export interface CapabilityDeclaration {
-    /** Capability name (e.g. 'storage', 'decoder', 'analysis-pipeline') */
-    readonly name: string;
-    /** singleton: one active at a time. collection: all active in parallel. */
-    readonly mode: CapabilityMode;
-    /** Optional dependencies — addon won't initialize until these capabilities are available */
-    readonly dependsOn?: readonly string[];
-}
-/**
- * Registration object for a service that consumes a capability.
- * The registry calls the appropriate callback when providers are added/removed/replaced.
- */
-export interface CapabilityConsumerRegistration<T = unknown> {
-    /** Which capability this consumer needs */
-    readonly capability: string;
-    /** Called when a singleton provider is set or replaced. Async for teardown of previous. */
-    onSet?(provider: T): void | Promise<void>;
-    /** Called when a collection provider is added */
-    onAdded?(provider: T): void | Promise<void>;
-    /** Called when a collection provider is removed (addon disabled) */
-    onRemoved?(provider: T): void | Promise<void>;
-}
-/**
- * Introspection data for a registered capability.
- */
-export interface CapabilityInfo {
-    readonly name: string;
-    readonly mode: CapabilityMode;
-    /** All addon IDs that provide this capability */
-    readonly providers: readonly string[];
-    /** For singleton: the active addon ID (null if none) */
-    readonly activeProvider: string | null;
-}
-/**
- * Maps capability names to their provider interfaces.
- * Extensible via TypeScript declaration merging:
- *
- * ```typescript
- * declare module '@camstack/types' {
- *   interface CapabilityProviderMap {
- *     'my-custom-capability': IMyProvider
- *   }
- * }
- * ```
- */
-export interface CapabilityProviderMap {
-    'storage': IStorageProvider;
-    'log-destination': ILogDestination;
-    'analysis-pipeline': IAnalysisAddon;
-    'restreamer': unknown;
-    'webrtc': unknown;
-    'stream-broker': unknown;
-    'addon-pages': IAddonPageProvider;
-    'admin-ui': IAdminUI;
-    'auth-provider': IAuthProvider;
-    'notification-output': INotificationOutput;
-    'addon-routes': IAddonRouteProvider;
-    'recording-engine': unknown;
-    'analysis-data-persistence': IAnalysisDataPersistence;
-    'device-provider': unknown;
-    'network-access': unknown;
-    'streaming-engine': unknown;
-    'scene-intelligence': ISceneIntelligence;
-    'advanced-notifier': IAdvancedNotifier;
-    [key: string]: unknown;
-}

package/dist/types/src/interfaces/classifier.d.ts

@@ -1,7 +0,0 @@
-import type { IPipelineSlotProvider } from './pipeline-slot.js';
-import type { CropInput } from '../types/detection.js';
-import type { ClassifierOutput } from '../types/detection.js';
-export interface IClassifierProvider extends IPipelineSlotProvider {
-    readonly slot: 'classifier';
-    classify(input: CropInput): Promise<ClassifierOutput>;
-}

package/dist/types/src/interfaces/config-ui.d.ts

@@ -1,151 +0,0 @@
-import type { ModelCatalogEntry, ModelFormat, ModelOutputFormat, CustomModelMetadata } from '../types/models.js';
-/**
- * Configuration UI Schema -- declarative form definition for any element.
- *
- * Used by addons, providers, and devices to declare their settings UI.
- * The admin UI renders these schemas as responsive forms.
- */
-export interface ConfigUISchema {
-    sections: ConfigSection[];
-}
-export interface ConfigSection {
-    id: string;
-    title: string;
-    description?: string;
-    style?: 'card' | 'accordion';
-    defaultCollapsed?: boolean;
-    columns?: 1 | 2 | 3 | 4;
-    fields: ConfigField[];
-}
-export type ConfigField = ConfigTextField | ConfigNumberField | ConfigBooleanField | ConfigSelectField | ConfigMultiSelectField | ConfigColorField | ConfigPasswordField | ConfigTextAreaField | ConfigSliderField | ConfigTagsField | ConfigGroupField | ConfigSeparatorField | ConfigInfoField | ConfigModelSelectorField | ConfigStorageLocationField;
-export interface ConfigFieldBase {
-    key: string;
-    label: string;
-    description?: string;
-    required?: boolean;
-    disabled?: boolean;
-    placeholder?: string;
-    span?: 1 | 2 | 3 | 4;
-    showWhen?: ConfigCondition;
-}
-export interface ConfigCondition {
-    field: string;
-    equals?: unknown;
-    notEquals?: unknown;
-    in?: unknown[];
-    notIn?: unknown[];
-}
-export interface ConfigTextField extends ConfigFieldBase {
-    type: 'text';
-    maxLength?: number;
-    pattern?: string;
-    inputType?: 'text' | 'url' | 'email';
-}
-export interface ConfigNumberField extends ConfigFieldBase {
-    type: 'number';
-    min?: number;
-    max?: number;
-    step?: number;
-    unit?: string;
-}
-export interface ConfigBooleanField extends ConfigFieldBase {
-    type: 'boolean';
-    style?: 'switch' | 'checkbox';
-}
-export interface ConfigSelectField extends ConfigFieldBase {
-    type: 'select';
-    options: ConfigOption[];
-    dependsOn?: Record<string, unknown>;
-}
-export interface ConfigMultiSelectField extends ConfigFieldBase {
-    type: 'multiselect';
-    options: ConfigOption[];
-    maxItems?: number;
-}
-export interface ConfigColorField extends ConfigFieldBase {
-    type: 'color';
-    presets?: string[];
-}
-export interface ConfigPasswordField extends ConfigFieldBase {
-    type: 'password';
-    showToggle?: boolean;
-}
-export interface ConfigTextAreaField extends ConfigFieldBase {
-    type: 'textarea';
-    rows?: number;
-    maxLength?: number;
-}
-export interface ConfigSliderField extends ConfigFieldBase {
-    type: 'slider';
-    min: number;
-    max: number;
-    step?: number;
-    showValue?: boolean;
-    unit?: string;
-    default?: number;
-}
-export interface ConfigTagsField extends ConfigFieldBase {
-    type: 'tags';
-    suggestions?: string[];
-    maxTags?: number;
-}
-export interface ConfigGroupField extends ConfigFieldBase {
-    type: 'group';
-    fields: ConfigField[];
-    style?: 'card' | 'inline' | 'accordion';
-    defaultCollapsed?: boolean;
-}
-/** Visual separator between fields */
-export interface ConfigSeparatorField {
-    type: 'separator';
-    key: string;
-}
-/** Read-only informational text */
-export interface ConfigInfoField {
-    type: 'info';
-    key: string;
-    label: string;
-    content: string;
-    variant?: 'info' | 'warning' | 'success' | 'danger';
-}
-export interface ConfigOption {
-    value: string;
-    label: string;
-    description?: string;
-    icon?: string;
-}
-export interface ConfigModelSelectorField extends ConfigFieldBase {
-    type: 'model-selector';
-    /** Filter models by type */
-    modelType?: string;
-    /** Allow user to enter a custom local path or URL (default: true) */
-    allowCustomPath?: boolean;
-    /** Allow file upload via UI (default: true) */
-    allowUpload?: boolean;
-    /** Accepted file extensions for upload (default: ['.onnx']) */
-    acceptExtensions?: string[];
-    /** URL to model conversion documentation/guide */
-    conversionGuideUrl?: string;
-    /** Brief text explaining what models are compatible */
-    compatibilityNote?: string;
-    /** Legacy: inline catalog entries */
-    catalog?: readonly ModelCatalogEntry[];
-    allowCustom?: boolean;
-    acceptFormats?: readonly ModelFormat[];
-    allowConversion?: boolean;
-    requiredMetadata?: readonly (keyof CustomModelMetadata)[];
-    outputFormatHint?: ModelOutputFormat;
-}
-import type { StorageLocationType } from './storage.js';
-export interface ConfigStorageLocationField extends ConfigFieldBase {
-    type: 'storage-location';
-    /** Which location type this field selects a provider for */
-    locationType: StorageLocationType;
-    /** Show available space indicator next to each provider option */
-    showAvailableSpace?: boolean;
-}
-export interface IConfigurable {
-    getConfigSchema(): ConfigUISchema;
-    getConfig(): Record<string, unknown>;
-    onConfigChange(config: Record<string, unknown>): Promise<void>;
-}

package/dist/types/src/interfaces/context.d.ts

@@ -1,43 +0,0 @@
-import type { IScopedLogger } from './logging.js';
-import type { IEventBus } from './event-bus.js';
-import type { IStorageLocation } from './storage.js';
-/**
- * CamstackContext -- injected into every provider, device, and addon.
- *
- * Each element receives a context scoped to its identity:
- * - logger is pre-scoped: (Frigate)[FrontDoor] for a device, (Frigate) for a provider
- * - storage is namespaced: all reads/writes are relative to this element's ID
- * - eventBus is shared (system-wide) but the source is pre-filled
- * - config provides read/write access to this element's persisted configuration
- *
- * The `id` is an immutable progressive identifier assigned at creation time.
- * It never changes even if the element is renamed.
- */
-export interface CamstackContext {
-    /** Immutable progressive ID of this element (e.g., 'provider:frigate-1', 'device:frigate-1/front-door') */
-    readonly id: string;
-    /** Pre-scoped logger -- logs automatically include this element's scope chain */
-    readonly logger: IScopedLogger;
-    /** Event bus -- shared system-wide, use for emitting and subscribing to events */
-    readonly eventBus: IEventBus;
-    /** Storage scoped to this element -- all paths are relative to this element's namespace */
-    readonly storage: IStorageLocation;
-    /** Persisted configuration for this element -- read/write/subscribe to changes */
-    readonly config: IElementConfig;
-}
-/**
- * Scoped configuration store for an element.
- * Values are persisted in the element's storage namespace.
- */
-export interface IElementConfig {
-    /** Get the full config object */
-    getAll(): Record<string, unknown>;
-    /** Get a single value by dot-path (e.g., 'mqtt.brokerUrl') */
-    get<T = unknown>(key: string): T | undefined;
-    /** Set a single value */
-    set(key: string, value: unknown): Promise<void>;
-    /** Set the entire config object (merge or replace) */
-    setAll(config: Record<string, unknown>): Promise<void>;
-    /** Subscribe to config changes -- callback receives the new full config */
-    onChange(callback: (config: Record<string, unknown>) => void): () => void;
-}

package/dist/types/src/interfaces/cropper.d.ts

@@ -1,7 +0,0 @@
-import type { IPipelineSlotProvider } from './pipeline-slot.js';
-import type { CropInput } from '../types/detection.js';
-import type { CropperOutput } from '../types/detection.js';
-export interface ICropperProvider extends IPipelineSlotProvider {
-    readonly slot: 'cropper';
-    crop(input: CropInput): Promise<CropperOutput>;
-}