@camstack/ui-library 1.2.256 → 1.2.258

package/dist/hooks/use-persisted-page-size.d.ts

@@ -1,18 +1,18 @@
 /** The "All" option — one page holding every row. */
 export declare const PAGE_SIZE_ALL = 0;
 export interface PersistedPageSizeConfig {
-    /** localStorage key, or null for a choice that is not remembered. */
-    readonly storageKey: string | null;
-    /** The selectable sizes, in display order. May include `PAGE_SIZE_ALL`. */
-    readonly options: readonly number[];
-    /** The size before the viewer picks one. Replaced by `options[0]` if not an option. */
-    readonly defaultSize: number;
+	/** localStorage key, or null for a choice that is not remembered. */
+	readonly storageKey: string | null;
+	/** The selectable sizes, in display order. May include `PAGE_SIZE_ALL`. */
+	readonly options: readonly number[];
+	/** The size before the viewer picks one. Replaced by `options[0]` if not an option. */
+	readonly defaultSize: number;
 }
 export type SetPageSize = (next: number) => void;
 /** @returns `[size, setSize]`; `setSize` ignores a size that is not an option. */
-export declare function usePersistedPageSize({ storageKey, options, defaultSize, }: PersistedPageSizeConfig): readonly [number, SetPageSize];
+export declare function usePersistedPageSize({ storageKey, options, defaultSize }: PersistedPageSizeConfig): readonly [number, SetPageSize];
 /**
- * The number of rows one page holds for a chosen size: "All" is every row
- * (at least 1, so the pager arithmetic never divides by zero).
- */
+* The number of rows one page holds for a chosen size: "All" is every row
+* (at least 1, so the pager arithmetic never divides by zero).
+*/
 export declare function effectivePageSize(size: number, totalItems: number): number;

package/dist/hooks/use-ptz.d.ts

@@ -1,128 +1,128 @@
-import { UseDeviceProxyTrpc } from './use-device-proxy';
+import { type UseDeviceProxyTrpc } from "./use-device-proxy";
 /**
- * Cardinal + intercardinal direction tokens. The hook translates them
- * into normalised `(pan, tilt)` vectors before calling the underlying
- * cap so the cap surface stays speed-vector-shaped.
- */
-export type PTZDirection = 'up' | 'down' | 'left' | 'right' | 'up-left' | 'up-right' | 'down-left' | 'down-right';
+* Cardinal + intercardinal direction tokens. The hook translates them
+* into normalised `(pan, tilt)` vectors before calling the underlying
+* cap so the cap surface stays speed-vector-shaped.
+*/
+export type PTZDirection = "up" | "down" | "left" | "right" | "up-left" | "up-right" | "down-left" | "down-right";
 /** The camera's idle-return behaviour: whether, and after how long. */
 interface PTZHomeReturn {
-    readonly enabled: boolean;
-    readonly seconds: number;
+	readonly enabled: boolean;
+	readonly seconds: number;
 }
 /** Which preset `goHome` targets on this camera, and who decided it. */
 interface PTZHomePreset {
-    readonly presetId: string | null;
-    readonly source: 'operator' | 'firmware' | 'native' | 'none';
+	readonly presetId: string | null;
+	readonly source: "operator" | "firmware" | "native" | "none";
 }
 interface PTZPreset {
-    readonly id: string;
-    readonly name: string;
-    /**
-     * The firmware function this id performs, or `null` for a stored position.
-     * A camera's reserved band shares the preset namespace: the dispensa camera
-     * returns `34 Back to origin`, `94 Remote reboot`, `95 Call OSD menu`
-     * alongside the operator's own.
-     */
-    readonly fn: string | null;
-    /**
-     * Whether the camera accepts a write on this id. Overwriting a reserved one
-     * is what produced `PUT .../presets/34 -> HTTP 500`, which reached the
-     * operator as a transport failure with no hint of the cause.
-     */
-    readonly writable: boolean;
+	readonly id: string;
+	readonly name: string;
+	/**
+	* The firmware function this id performs, or `null` for a stored position.
+	* A camera's reserved band shares the preset namespace: the dispensa camera
+	* returns `34 Back to origin`, `94 Remote reboot`, `95 Call OSD menu`
+	* alongside the operator's own.
+	*/
+	readonly fn: string | null;
+	/**
+	* Whether the camera accepts a write on this id. Overwriting a reserved one
+	* is what produced `PUT .../presets/34 -> HTTP 500`, which reached the
+	* operator as a transport failure with no hint of the cause.
+	*/
+	readonly writable: boolean;
 }
 /**
- * Per-camera PTZ availability descriptor returned by `ptz.getOptions`.
- * Drives which controls the UI shows — preset save/delete is gated on
- * `supportsPresets`, and the save button disables once `maxPresets`
- * (when known) is reached.
- */
+* Per-camera PTZ availability descriptor returned by `ptz.getOptions`.
+* Drives which controls the UI shows — preset save/delete is gated on
+* `supportsPresets`, and the save button disables once `maxPresets`
+* (when known) is reached.
+*/
 export interface PTZOptions {
-    readonly hasPan: boolean;
-    readonly hasTilt: boolean;
-    readonly hasZoom: boolean;
-    readonly supportsPresets: boolean;
-    readonly maxPresets?: number;
-    /** Whether the camera exposes a controllable autofocus toggle. */
-    readonly hasAutofocus: boolean;
+	readonly hasPan: boolean;
+	readonly hasTilt: boolean;
+	readonly hasZoom: boolean;
+	readonly supportsPresets: boolean;
+	readonly maxPresets?: number;
+	/** Whether the camera exposes a controllable autofocus toggle. */
+	readonly hasAutofocus: boolean;
 }
 /**
- * Backwards-compatible alias for the trpc shape — historically the
- * hook took its own narrow contract; the proxy generalisation
- * supersedes that.
- */
+* Backwards-compatible alias for the trpc shape — historically the
+* hook took its own narrow contract; the proxy generalisation
+* supersedes that.
+*/
 export type PTZTrpcProxy = UseDeviceProxyTrpc;
 export interface UsePTZOptions {
-    /** Default speed (0..1) for moves when the caller omits one. */
-    readonly defaultSpeed?: number;
-    /** Pulse duration (ms) for one-shot `move` calls. */
-    readonly pulseMs?: number;
-    /**
-     * Gate the hook's network calls. When `false`, the initial preset
-     * refresh is skipped and every method becomes a no-op. Use to avoid
-     * "provider not available" errors on devices that don't advertise
-     * the `ptz` capability.
-     */
-    readonly enabled?: boolean;
+	/** Default speed (0..1) for moves when the caller omits one. */
+	readonly defaultSpeed?: number;
+	/** Pulse duration (ms) for one-shot `move` calls. */
+	readonly pulseMs?: number;
+	/**
+	* Gate the hook's network calls. When `false`, the initial preset
+	* refresh is skipped and every method becomes a no-op. Use to avoid
+	* "provider not available" errors on devices that don't advertise
+	* the `ptz` capability.
+	*/
+	readonly enabled?: boolean;
 }
 export interface UsePTZResult {
-    /** One-shot directional pulse. Stops itself after `pulseMs`. */
-    readonly move: (direction: PTZDirection, speed?: number) => Promise<void>;
-    /** Begin continuous motion in `direction` until `stopContinuous` is called. */
-    readonly startContinuous: (direction: PTZDirection, speed?: number) => Promise<void>;
-    /** Stop any ongoing continuous motion. Idempotent. */
-    readonly stopContinuous: () => Promise<void>;
-    /** Discrete zoom step (in or out). */
-    readonly zoom: (direction: 'in' | 'out', speed?: number) => Promise<void>;
-    /** Jump to the home preset (0 on most cameras). */
-    readonly goHome: () => Promise<void>;
-    /** Which preset `goHome` targets and who decided; `null` until loaded. */
-    readonly homePreset: PTZHomePreset | null;
-    /** Pin the home preset. `null` clears the operator's choice. */
-    readonly setHomePreset: (presetId: string | null) => Promise<void>;
-    /**
-     * Make where the head is pointing RIGHT NOW this camera's home. The natural
-     * gesture — aim, then say "here" — and the only one a camera whose home is
-     * not a preset can accept.
-     */
-    readonly captureHomeHere: () => Promise<void>;
-    /**
-     * Whether the camera returns home by itself when left idle, and after how
-     * long. `null` = it has no such behaviour. The two are ONE fact on the
-     * camera and are read and written together.
-     */
-    readonly homeReturn: PTZHomeReturn | null;
-    readonly setHomeReturn: (enabled: boolean, seconds: number) => Promise<void>;
-    /** Jump to a named preset. */
-    readonly goToPreset: (presetId: string) => Promise<void>;
-    /**
-     * Save the camera's current position as a new preset. Picks the
-     * lowest unused numeric slot id, then refreshes the presets list.
-     * Resolves to the created preset id, or `undefined` on failure.
-     */
-    readonly savePreset: (name: string) => Promise<string | undefined>;
-    /**
-     * Overwrite an EXISTING preset with the camera's current position, keeping
-     * its id and name. Provider-agnostic: reuses the real id the camera reported
-     * (via `getPtzPresets`), so it works regardless of the vendor's slot scheme.
-     */
-    readonly updatePreset: (presetId: string) => Promise<void>;
-    /** Delete a preset by id, then refresh the presets list. */
-    readonly deletePreset: (presetId: string) => Promise<void>;
-    /** List of presets reported by the camera. Empty until first refresh. */
-    readonly presets: readonly PTZPreset[];
-    /** Force a refresh of the presets list. */
-    readonly refreshPresets: () => Promise<void>;
-    /**
-     * Per-camera PTZ availability descriptor, or null until the first
-     * `getOptions` refresh resolves (or on cameras without the cap).
-     */
-    readonly options: PTZOptions | null;
-    /** True while a control call is in flight (any path). */
-    readonly busy: boolean;
-    /** Last error message from any cap call, or null. */
-    readonly error: string | null;
+	/** One-shot directional pulse. Stops itself after `pulseMs`. */
+	readonly move: (direction: PTZDirection, speed?: number) => Promise<void>;
+	/** Begin continuous motion in `direction` until `stopContinuous` is called. */
+	readonly startContinuous: (direction: PTZDirection, speed?: number) => Promise<void>;
+	/** Stop any ongoing continuous motion. Idempotent. */
+	readonly stopContinuous: () => Promise<void>;
+	/** Discrete zoom step (in or out). */
+	readonly zoom: (direction: "in" | "out", speed?: number) => Promise<void>;
+	/** Jump to the home preset (0 on most cameras). */
+	readonly goHome: () => Promise<void>;
+	/** Which preset `goHome` targets and who decided; `null` until loaded. */
+	readonly homePreset: PTZHomePreset | null;
+	/** Pin the home preset. `null` clears the operator's choice. */
+	readonly setHomePreset: (presetId: string | null) => Promise<void>;
+	/**
+	* Make where the head is pointing RIGHT NOW this camera's home. The natural
+	* gesture — aim, then say "here" — and the only one a camera whose home is
+	* not a preset can accept.
+	*/
+	readonly captureHomeHere: () => Promise<void>;
+	/**
+	* Whether the camera returns home by itself when left idle, and after how
+	* long. `null` = it has no such behaviour. The two are ONE fact on the
+	* camera and are read and written together.
+	*/
+	readonly homeReturn: PTZHomeReturn | null;
+	readonly setHomeReturn: (enabled: boolean, seconds: number) => Promise<void>;
+	/** Jump to a named preset. */
+	readonly goToPreset: (presetId: string) => Promise<void>;
+	/**
+	* Save the camera's current position as a new preset. Picks the
+	* lowest unused numeric slot id, then refreshes the presets list.
+	* Resolves to the created preset id, or `undefined` on failure.
+	*/
+	readonly savePreset: (name: string) => Promise<string | undefined>;
+	/**
+	* Overwrite an EXISTING preset with the camera's current position, keeping
+	* its id and name. Provider-agnostic: reuses the real id the camera reported
+	* (via `getPtzPresets`), so it works regardless of the vendor's slot scheme.
+	*/
+	readonly updatePreset: (presetId: string) => Promise<void>;
+	/** Delete a preset by id, then refresh the presets list. */
+	readonly deletePreset: (presetId: string) => Promise<void>;
+	/** List of presets reported by the camera. Empty until first refresh. */
+	readonly presets: readonly PTZPreset[];
+	/** Force a refresh of the presets list. */
+	readonly refreshPresets: () => Promise<void>;
+	/**
+	* Per-camera PTZ availability descriptor, or null until the first
+	* `getOptions` refresh resolves (or on cameras without the cap).
+	*/
+	readonly options: PTZOptions | null;
+	/** True while a control call is in flight (any path). */
+	readonly busy: boolean;
+	/** Last error message from any cap call, or null. */
+	readonly error: string | null;
 }
 export declare function usePTZ(trpc: UseDeviceProxyTrpc, deviceId: number, hookOptions?: UsePTZOptions): UsePTZResult;
 export {};

package/dist/hooks/use-stationary-overlay.d.ts

@@ -1,46 +1,46 @@
-import { StationaryOverlayBox } from '@camstack/types';
+import type { StationaryOverlayBox } from "@camstack/types";
 /**
- * The ONE route this hook needs.
- *
- * Deliberately NOT the device proxy. The proxy exposes only the caps BOUND to
- * a device, and `zone-analytics` is not one of them — on device 617 the
- * bindings are `pipeline-analytics` and `motion-zones`. Reading the census
- * through `dev?.zoneAnalytics?.…` therefore resolved to `undefined`, the hook
- * returned an empty census, and the overlay drew nothing while reporting
- * nothing: an unreachable cap was indistinguishable from an empty lot. The cap
- * ROUTE is mounted system-wide and takes the `deviceId` as input, which is how
- * every other caller reaches it.
- */
+* The ONE route this hook needs.
+*
+* Deliberately NOT the device proxy. The proxy exposes only the caps BOUND to
+* a device, and `zone-analytics` is not one of them — on device 617 the
+* bindings are `pipeline-analytics` and `motion-zones`. Reading the census
+* through `dev?.zoneAnalytics?.…` therefore resolved to `undefined`, the hook
+* returned an empty census, and the overlay drew nothing while reporting
+* nothing: an unreachable cap was indistinguishable from an empty lot. The cap
+* ROUTE is mounted system-wide and takes the `deviceId` as input, which is how
+* every other caller reaches it.
+*/
 export interface UseStationaryOverlayTrpc {
-    readonly zoneAnalytics: {
-        readonly getCurrentSnapshot: {
-            readonly query: (input: {
-                deviceId: number;
-            }) => Promise<unknown>;
-        };
-    };
+	readonly zoneAnalytics: {
+		readonly getCurrentSnapshot: {
+			readonly query: (input: {
+				deviceId: number;
+			}) => Promise<unknown>;
+		};
+	};
 }
 interface SnapshotStationary {
-    readonly id: string;
-    readonly className: string;
-    readonly bbox: {
-        readonly x: number;
-        readonly y: number;
-        readonly w: number;
-        readonly h: number;
-    };
-    readonly frameWidth: number;
-    readonly frameHeight: number;
-    readonly becameStationaryAt: number;
-    readonly label?: string;
+	readonly id: string;
+	readonly className: string;
+	readonly bbox: {
+		readonly x: number;
+		readonly y: number;
+		readonly w: number;
+		readonly h: number;
+	};
+	readonly frameWidth: number;
+	readonly frameHeight: number;
+	readonly becameStationaryAt: number;
+	readonly label?: string;
 }
 /**
- * Normalise one census row against the frame it was measured in.
- *
- * A row with no frame dims is DROPPED, not drawn at 0,0: an entry whose own
- * frame is unknown cannot be placed on this one, and a box pinned to the corner
- * reads as a real detection in the wrong place.
- */
+* Normalise one census row against the frame it was measured in.
+*
+* A row with no frame dims is DROPPED, not drawn at 0,0: an entry whose own
+* frame is unknown cannot be placed on this one, and a box pinned to the corner
+* reads as a real detection in the wrong place.
+*/
 export declare function toStationaryOverlayBox(row: SnapshotStationary): StationaryOverlayBox | null;
 export declare function useStationaryOverlay(trpc: UseStationaryOverlayTrpc, deviceId: number | null): readonly StationaryOverlayBox[] | undefined;
 export {};

package/dist/hooks/use-system-query.d.ts

@@ -1,12 +1,35 @@
-import { QueryKey, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
-import { System } from '@camstack/sdk';
 /**
- * `select` MUST return a thunk that, when invoked, performs the
- * request. Two-step factory keeps the query-key + thunk identities
- * stable between renders: the hook re-creates the thunk on every
- * render (cheap), but React Query keys off `[queryKey]` only.
- */
+* useSystemQuery / useSystemMutation — generic escape hatches over the
+* unified `System` SDK class for tRPC calls that don't (yet) have a
+* codegen'd named hook.
+*
+* Codegen'd hooks (see `../generated/system-hooks.ts`) cover every
+* `scope: 'system'` capability method automatically; reach for these
+* helpers when:
+*   1. The call goes through a core (non-cap) router, or
+*   2. You want to compose multiple cap calls into a single React
+*      Query bookkeeping unit (single staleTime, single retry policy).
+*
+* The query helper takes a `select(system) → () => Promise<T>` factory
+* so the caller picks any tRPC procedure off the System namespaces.
+* Inputs are passed via the closure — keeps deps explicit and avoids
+* the React Query input-as-cache-key magic that surprises new readers.
+*/
+import { type QueryKey, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
+import type { System } from "@camstack/sdk";
+/**
+* `select` MUST return a thunk that, when invoked, performs the
+* request. Two-step factory keeps the query-key + thunk identities
+* stable between renders: the hook re-creates the thunk on every
+* render (cheap), but React Query keys off `[queryKey]` only.
+*/
 export type SystemQuerySelector<TData> = (system: System) => () => Promise<TData>;
-export type SystemMutationSelector<TInput, TData> = (system: System) => (input: TInput) => Promise<TData>;
-export declare function useSystemQuery<TData>(queryKey: QueryKey, select: SystemQuerySelector<TData>, opts?: Omit<UseQueryOptions<TData, Error, TData>, 'queryKey' | 'queryFn'>): UseQueryResult<TData, Error>;
-export declare function useSystemMutation<TInput, TData>(select: SystemMutationSelector<TInput, TData>, opts?: Omit<UseMutationOptions<TData, Error, TInput>, 'mutationFn'>): UseMutationResult<TData, Error, TInput>;
+export type SystemMutationSelector<
+	TInput,
+	TData
+> = (system: System) => (input: TInput) => Promise<TData>;
+export declare function useSystemQuery<TData>(queryKey: QueryKey, select: SystemQuerySelector<TData>, opts?: Omit<UseQueryOptions<TData, Error, TData>, "queryKey" | "queryFn">): UseQueryResult<TData, Error>;
+export declare function useSystemMutation<
+	TInput,
+	TData
+>(select: SystemMutationSelector<TInput, TData>, opts?: Omit<UseMutationOptions<TData, Error, TInput>, "mutationFn">): UseMutationResult<TData, Error, TInput>;

package/dist/hooks/use-url-query.d.ts

@@ -1,5 +1,5 @@
 /**
- * One query param as React state. `null` means absent.
- * Changing it replaces the URL without a navigation.
- */
+* One query param as React state. `null` means absent.
+* Changing it replaces the URL without a navigation.
+*/
 export declare function useUrlQueryParam(key: string): readonly [string | null, (next: string | null) => void];

package/dist/icons/index.d.ts

@@ -1,2 +1,2 @@
-export * from './provider-icons';
-export * from './status-icons';
+export * from "./provider-icons";
+export * from "./status-icons";

package/dist/icons/provider-icons.d.ts

@@ -1,3 +1,3 @@
-import { LucideIcon } from 'lucide-react';
-export type ProviderType = 'onvif' | 'hikvision' | 'reolink' | 'homeAssistant' | 'rtsp';
+import { type LucideIcon } from "lucide-react";
+export type ProviderType = "onvif" | "hikvision" | "reolink" | "homeAssistant" | "rtsp";
 export declare const providerIcons: Record<ProviderType, LucideIcon>;

package/dist/icons/status-icons.d.ts

@@ -1,3 +1,3 @@
-import { LucideIcon } from 'lucide-react';
-export type StatusType = 'online' | 'offline' | 'degraded' | 'unknown';
+import { type LucideIcon } from "lucide-react";
+export type StatusType = "online" | "offline" | "degraded" | "unknown";
 export declare const statusIcons: Record<StatusType, LucideIcon>;