@camera.ui/sdk 0.0.3 → 0.0.4

package/scripts/build-example-docs.mjs

@@ -0,0 +1,62 @@
+/* eslint-disable @stylistic/max-len */
+import { readdirSync, readFileSync, writeFileSync, mkdirSync, statSync, rmSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const here = dirname(fileURLToPath(import.meta.url));
+const examplesDir = join(here, '..', 'examples');
+const outDir = join(here, '..', 'docs', 'examples');
+const apiDir = join(here, '..', 'docs', 'api');
+
+const apiIndex = `# API Reference
+
+Module-by-module reference, auto-generated from the JSDoc in \`@camera.ui/sdk\`.
+
+| Module | What's in it |
+| --- | --- |
+| [Plugin API](./plugin/) | \`BasePlugin\`, the manifest contract, optional interfaces (discovery, notifier, detection). |
+| [Camera](./camera/) | Camera config, frames, streaming sessions, detection events, runtime device API. |
+| [Sensors](./sensor/) | Detection sensors (motion, object, face, license-plate, audio, classifier, clip) and smart-home sensors (contact, doorbell, lock, garage, light, switch, ptz, security system, environmental). |
+| [Storage & Schema](./storage/) | Schema-driven per-device config rendered as UI forms by the host. |
+| [Manager](./manager/) | \`CoreManager\` / \`DeviceManager\` / \`DownloadManager\` for system-level services. |
+| [Observable](./observable/) | Reactive primitives — \`Observable\`, \`Subject\`, \`BehaviorSubject\`, \`ReplaySubject\` — and operators. |
+| [Types](./types/) | Shared types (\`LoggerService\`, \`PluginAPI\`, …). |
+
+If you're new to the SDK, start with the [Plugin Guide](/examples/getting-started) instead — it walks through these modules in the order you'll actually use them.
+`;
+
+writeFileSync(join(apiDir, 'index.md'), apiIndex);
+
+rmSync(outDir, { recursive: true, force: true });
+mkdirSync(outDir, { recursive: true });
+
+const indexSrc = readFileSync(join(examplesDir, 'README.md'), 'utf8');
+const indexOut = indexSrc.replace(/\[`([^`]+)\/`\]\(\.\/\1\/\)/g, '[`$1`](/examples/$1)').replace(/^# .+/m, '# Examples');
+writeFileSync(join(outDir, 'index.md'), indexOut);
+
+const entries = readdirSync(examplesDir).sort();
+
+for (const name of entries) {
+  const full = join(examplesDir, name);
+  const stat = statSync(full);
+
+  if (stat.isFile() && name.endsWith('.md') && name !== 'README.md') {
+    const src = readFileSync(full, 'utf8');
+    writeFileSync(join(outDir, name), src);
+    continue;
+  }
+
+  if (!stat.isDirectory()) continue;
+
+  const readme = readFileSync(join(full, 'README.md'), 'utf8');
+  const contract = readFileSync(join(full, 'contract.ts'), 'utf8');
+  const index = readFileSync(join(full, 'index.ts'), 'utf8');
+
+  const page = [readme.trimEnd(), '', '## `contract.ts`', '', '```ts', contract.trimEnd(), '```', '', '## `index.ts`', '', '```ts', index.trimEnd(), '```', ''].join(
+    '\n',
+  );
+
+  writeFileSync(join(outDir, `${name}.md`), page);
+}
+
+console.log(`Built example pages to ${outDir}`);

package/tsconfig.node.json

@@ -1,11 +1,11 @@
 {
   "compilerOptions": {
     "outDir": "./dist",
-    "target": "ES2022",
+    "target": "es2024",
     "moduleResolution": "NodeNext",
     "module": "NodeNext",
     "lib": [
-      "ES2022",
+      "ES2024",
     ],
     "declaration": false,
     "strict": true,
@@ -26,5 +26,6 @@
   "exclude": [
     "node_modules",
     "dist",
+    "src/**/*.test.ts",
   ],
 }

package/typedoc.json

@@ -0,0 +1,42 @@
+{
+  "plugin": [
+    "typedoc-plugin-markdown",
+    "typedoc-vitepress-theme"
+  ],
+  "entryPoints": [
+    "./src/camera/index.ts",
+    "./src/sensor/index.ts",
+    "./src/plugin/index.ts",
+    "./src/manager/index.ts",
+    "./src/storage/index.ts",
+    "./src/observable/index.ts",
+    "./src/types.ts"
+  ],
+  "exclude": [
+    "**/*.test.ts",
+    "**/dist/**",
+    "**/node_modules/**"
+  ],
+  "externalPattern": [
+    "**/*.test.ts",
+    "**/dist/**",
+    "**/node_modules/**"
+  ],
+  "excludeExternals": true,
+  "excludeInternal": true,
+  "out": "./docs/api",
+  "docsRoot": "./docs",
+  "sidebar": {
+    "autoConfiguration": true,
+    "format": "vitepress",
+    "pretty": false,
+    "collapsed": true
+  },
+  "validation": {
+    "notExported": true,
+    "invalidLink": true,
+    "rewrittenLink": true,
+    "notDocumented": false,
+    "unusedMergeModuleWith": true
+  }
+}

package/dist/sensor/guards.js

@@ -1,133 +0,0 @@
-import { SensorType } from './types.js';
-/**
- * Type guard for Motion sensors
- *
- * Narrows a SensorLike to MotionSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Motion sensor
- */
-export function isMotionSensor(sensor) {
-    return sensor.type === SensorType.Motion;
-}
-/**
- * Type guard for Object detection sensors
- *
- * Narrows a SensorLike to ObjectSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is an Object sensor
- */
-export function isObjectSensor(sensor) {
-    return sensor.type === SensorType.Object;
-}
-/**
- * Type guard for Audio sensors
- *
- * Narrows a SensorLike to AudioSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is an Audio sensor
- */
-export function isAudioSensor(sensor) {
-    return sensor.type === SensorType.Audio;
-}
-/**
- * Type guard for Face detection sensors
- *
- * Narrows a SensorLike to FaceSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Face sensor
- */
-export function isFaceSensor(sensor) {
-    return sensor.type === SensorType.Face;
-}
-/**
- * Type guard for License Plate detection sensors
- *
- * Narrows a SensorLike to LicensePlateSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a License Plate sensor
- */
-export function isLicensePlateSensor(sensor) {
-    return sensor.type === SensorType.LicensePlate;
-}
-/**
- * Type guard for Contact sensors
- *
- * Narrows a SensorLike to ContactSensorLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Contact sensor
- */
-export function isContactSensor(sensor) {
-    return sensor.type === SensorType.Contact;
-}
-/**
- * Type guard for Light controls
- *
- * Narrows a SensorLike to LightControlLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Light control
- */
-export function isLightControl(sensor) {
-    return sensor.type === SensorType.Light;
-}
-/**
- * Type guard for Siren controls
- *
- * Narrows a SensorLike to SirenControlLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Siren control
- */
-export function isSirenControl(sensor) {
-    return sensor.type === SensorType.Siren;
-}
-/**
- * Type guard for PTZ controls
- *
- * Narrows a SensorLike to PTZControlLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a PTZ control
- */
-export function isPTZControl(sensor) {
-    return sensor.type === SensorType.PTZ;
-}
-/**
- * Type guard for Doorbell triggers
- *
- * Narrows a SensorLike to DoorbellTriggerLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Doorbell trigger
- */
-export function isDoorbellTrigger(sensor) {
-    return sensor.type === SensorType.Doorbell;
-}
-/**
- * Type guard for Battery info sensors
- *
- * Narrows a SensorLike to BatteryInfoLike for type-safe property access.
- *
- * @param sensor - The sensor to check
- *
- * @returns True if the sensor is a Battery info sensor
- */
-export function isBatteryInfo(sensor) {
-    return sensor.type === SensorType.Battery;
-}

package/dist/sensor/types.js

@@ -1,46 +0,0 @@
-/**
- * Charging state for battery
- */
-export var ChargingState;
-(function (ChargingState) {
-    ChargingState["NotChargeable"] = "NOT_CHARGEABLE";
-    ChargingState["NotCharging"] = "NOT_CHARGING";
-    ChargingState["Charging"] = "CHARGING";
-    ChargingState["Full"] = "FULL";
-})(ChargingState || (ChargingState = {}));
-// ========== Sensor Types ==========
-/**
- * Sensor Type Enum - identifies the type of sensor/control/trigger/info
- */
-export var SensorType;
-(function (SensorType) {
-    // Detection Sensors
-    SensorType["Motion"] = "motion";
-    SensorType["Object"] = "object";
-    SensorType["Audio"] = "audio";
-    SensorType["Face"] = "face";
-    SensorType["LicensePlate"] = "licensePlate";
-    SensorType["Contact"] = "contact";
-    // Controls
-    SensorType["Light"] = "light";
-    SensorType["Siren"] = "siren";
-    SensorType["PTZ"] = "ptz";
-    // Triggers
-    SensorType["Doorbell"] = "doorbell";
-    // Info
-    SensorType["Battery"] = "battery";
-})(SensorType || (SensorType = {}));
-/**
- * Sensor Category - categorizes sensors by their behavior
- */
-export var SensorCategory;
-(function (SensorCategory) {
-    /** Detection sensors (read-only, 1 provider) */
-    SensorCategory["Sensor"] = "sensor";
-    /** Bidirectional controls */
-    SensorCategory["Control"] = "control";
-    /** Event-based triggers */
-    SensorCategory["Trigger"] = "trigger";
-    /** Read-only hardware status */
-    SensorCategory["Info"] = "info";
-})(SensorCategory || (SensorCategory = {}));

package/dist/service/base.js

@@ -1,96 +0,0 @@
-/**
- * Service types that can be registered by plugins
- */
-export var ServiceType;
-(function (ServiceType) {
-    /** Streaming URL generation */
-    ServiceType["Streaming"] = "streaming";
-    /** Snapshot capture */
-    ServiceType["Snapshot"] = "snapshot";
-})(ServiceType || (ServiceType = {}));
-/**
- * Abstract base class for all camera services
- *
- * Plugins extend this class to implement custom service functionality.
- * The service communicates with the server via RPC, with the base class
- * handling online/offline status management.
- *
- * @example
- * ```typescript
- * class MyStreamingService extends Service implements StreamingService {
- *   readonly type = ServiceType.Streaming;
- *
- *   async streamUrl(sourceName: string): Promise<string> {
- *     return `rtsp://my-camera/${sourceName}`;
- *   }
- * }
- *
- * // In plugin:
- * const service = new MyStreamingService(camera.id, this.pluginId);
- * await camera.registerService(service);
- * ```
- */
-export class Service {
-    /**
-     * Camera ID this service is associated with
-     */
-    cameraId;
-    /**
-     * Plugin ID that provides this service
-     */
-    pluginId;
-    /**
-     * Internal online state
-     */
-    _online = false;
-    /**
-     * Callback for online status changes (set by runtime)
-     */
-    _onlineChangeFn;
-    /**
-     * Create a new service instance
-     *
-     * @param cameraId - ID of the camera this service is for
-     *
-     * @param pluginId - ID of the plugin providing this service
-     */
-    constructor(cameraId, pluginId) {
-        this.cameraId = cameraId;
-        this.pluginId = pluginId;
-    }
-    /**
-     * Whether the service is currently online/available
-     *
-     * Setting this property notifies the server of the status change.
-     */
-    get online() {
-        return this._online;
-    }
-    set online(value) {
-        if (this._online !== value) {
-            this._online = value;
-            this._onlineChangeFn?.(value);
-        }
-    }
-    /**
-     * Internal initialization - sets up the online status callback
-     *
-     * Called by the runtime when the service is registered.
-     *
-     * @param onlineChangeFn - Callback to notify server of online status changes
-     *
-     * @internal
-     */
-    _init(onlineChangeFn) {
-        this._onlineChangeFn = onlineChangeFn;
-    }
-    /**
-     * Internal cleanup - called when service is unregistered
-     *
-     * @internal
-     */
-    _cleanup() {
-        this._onlineChangeFn = undefined;
-        this._online = false;
-    }
-}

package/dist/service/index.js

@@ -1,3 +0,0 @@
-export * from './base.js';
-export * from './services.js';
-export * from './types.js';