@camera.ui/sdk 0.0.12 → 0.0.14

package/dist/index.d.ts

@@ -705,6 +705,9 @@ interface DeviceStorage<T extends Record<string, any> = Record<string, any>> {
     /**
      * Get a configuration value.
      *
+     * Resolves in order: the schema's `onGet` callback (if any), then the stored
+     * value, then the schema default, then the provided default.
+     *
      * @param key - Configuration key
      *
      * @returns Value or undefined
@@ -723,9 +726,15 @@ interface DeviceStorage<T extends Record<string, any> = Record<string, any>> {
     /**
      * Set a configuration value.
      *
+     * Takes effect only if a schema exists for the key. Passing `null` or
+     * `undefined` deletes the key — it reads as never-set again and the schema
+     * default applies. For a field whose schema opts into storage (`store: true`)
+     * the value is durably persisted before the returned promise resolves; the
+     * schema's `onSet` fires afterwards.
+     *
      * @param key - Configuration key
      *
-     * @param newValue - New value to set
+     * @param newValue - New value to set, or `null`/`undefined` to delete the key
      */
     setValue<U = string>(key: string, newValue: U): Promise<void>;
     /**
@@ -751,9 +760,13 @@ interface DeviceStorage<T extends Record<string, any> = Record<string, any>> {
      */
     getConfig(): Promise<SchemaConfig>;
     /**
-     * Set the full configuration.
+     * Merge configuration values into the current config.
      *
-     * @param newConfig - New configuration values
+     * Only keys present in `newConfig` are updated (not a full replace); arrays
+     * are replaced, not merged. Values are durably persisted before the returned
+     * promise resolves; `onSet` fires for each key whose value actually changed.
+     *
+     * @param newConfig - Configuration values to merge in
      */
     setConfig(newConfig: T): Promise<void>;
     /**
@@ -771,17 +784,24 @@ interface DeviceStorage<T extends Record<string, any> = Record<string, any>> {
     /**
      * Remove a schema field.
      *
+     * The field's stored value is deleted along with the schema; the removal
+     * is durably persisted when the returned promise resolves.
+     *
      * @param key - Schema key to remove
      */
     removeSchema(key: string): Promise<void>;
     /**
-     * Update an existing schema field.
+     * Replace an existing schema field with a full schema.
      *
-     * @param key - Schema key to update
+     * The whole schema is replaced — individual fields are not merged. It is a
+     * no-op when no schema with that key is registered (use {@link addSchema} to
+     * add a new field). The passed key always wins.
      *
-     * @param newSchema - Partial schema with updated fields
+     * @param key - Schema key to replace
+     *
+     * @param newSchema - Full schema definition that replaces the current one
      */
-    changeSchema(key: string, newSchema: Partial<JsonSchema>): Promise<void>;
+    changeSchema(key: string, newSchema: JsonSchema): Promise<void>;
     /**
      * Get a schema definition by key.
      *
@@ -799,13 +819,18 @@ interface DeviceStorage<T extends Record<string, any> = Record<string, any>> {
     /**
      * Set a system-internal value (e.g. _displayName) without requiring a schema and persist it.
      *
+     * When the returned promise resolves, the value is durably persisted.
+     * Passing `null` or `undefined` deletes the key — it reads as never-set again.
+     *
      * @param key - Internal key (typically prefixed with '_')
      *
-     * @param value - Value to set
+     * @param value - Value to set, or `null`/`undefined` to delete the key
      */
     setInternalValue(key: string, value: unknown): Promise<void>;
     /**
      * Persist all changes to storage.
+     *
+     * When the returned promise resolves, all values are durably persisted.
      */
     save(): Promise<void>;
 }
@@ -3348,6 +3373,23 @@ interface PtzAutotrackSettings {
      * no motor command is issued. Range 0 - 0.3.
      */
     triggerDeadZone: number;
+    /**
+     * How aggressively the camera moves to re-center the target. Higher reaches
+     * full pan/tilt speed at a smaller off-center error. Range 1 - 5.
+     */
+    trackingSpeed: number;
+    /**
+     * Motion prediction: aim this many detection-frames ahead along the target's
+     * measured velocity so a moving target is followed without lag. 0 disables
+     * prediction. Range 0 - 6.
+     */
+    leadFrames: number;
+    /**
+     * Camera pan-rate calibration — assumed pan travel at full motor speed, in
+     * normalized frame-widths per second. Lower it if the camera stops short of
+     * the target, raise it if it overshoots. Range 0.1 - 3.
+     */
+    panRate: number;
     /** Return to home position when no target is found for homeWaitMs */
     returnToHome: boolean;
     /** How long to wait (ms) without a target before returning home */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camera.ui/sdk",
-  "version": "0.0.12",
+  "version": "0.0.14",
   "description": "camera.ui sdk",
   "exports": {
     ".": {
@@ -34,11 +34,11 @@
     "@rollup/plugin-typescript": "^12.3.0",
     "@stylistic/eslint-plugin": "^5.10.0",
     "@types/multicast-dns": "^7.2.4",
-    "@types/node": "26.1.0",
-    "@typescript-eslint/parser": "^8.62.1",
+    "@types/node": "26.1.1",
+    "@typescript-eslint/parser": "^8.63.0",
     "cpy-cli": "^7.0.0",
     "eslint": "9.39.2",
-    "eslint-plugin-jsdoc": "^63.0.11",
+    "eslint-plugin-jsdoc": "^63.0.12",
     "globals": "^17.7.0",
     "prettier": "^3.9.4",
     "rimraf": "^6.1.3",
@@ -48,9 +48,9 @@
     "typedoc-plugin-markdown": "^4.12.0",
     "typedoc-vitepress-theme": "^1.1.3",
     "typescript": "5.9.3",
-    "typescript-eslint": "^8.62.1",
+    "typescript-eslint": "^8.63.0",
     "vitepress": "^1.6.4",
-    "vitest": "^4.1.9",
+    "vitest": "^4.1.10",
     "werift": "0.23.0",
     "werift-rtp": "^0.8.8"
   },