@luxonis/depthai-viewer-common 3.8.1 → 3.8.3

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gDAAgD,CAAC;AAC/D,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AAEnD,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,kCAAkC,CAAC;AACjD,cAAc,mCAAmC,CAAC;AAClD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gDAAgD,CAAC;AAC/D,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AAEnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,yBAAyB,CAAC"}

package/dist/models/device-configuration.d.ts

@@ -1,5 +1,8 @@
 import { DeviceListSchema } from '@luxonis/ui-components';
 import { z } from 'zod';
+/**
+ * Runtime validation schema for camera sensor metadata reported by a DepthAI device.
+ */
 export declare const SensorSchema: z.ZodObject<{
     boardSocket: z.ZodString;
     maxFps: z.ZodNumber;
@@ -10,46 +13,112 @@ export declare const SensorSchema: z.ZodObject<{
         height: z.ZodNumber;
     }, z.core.$strip>>;
 }, z.core.$strip>;
+/**
+ * Camera sensor metadata reported by a DepthAI device.
+ */
 export type Sensor = z.infer<typeof SensorSchema>;
+/**
+ * Runtime validation schema for infrared emitter availability.
+ */
 export declare const IrSchema: z.ZodObject<{
     floodLight: z.ZodBoolean;
     dotProjector: z.ZodBoolean;
 }, z.core.$strip>;
+/**
+ * Infrared emitter capabilities reported by a DepthAI device.
+ */
 export type Ir = z.infer<typeof IrSchema>;
+/**
+ * Runtime validation schema for supported DepthAI platform identifiers.
+ */
 export declare const PlatformSchema: z.ZodEnum<{
     UNKNOWN: "UNKNOWN";
     RVC2: "RVC2";
     RVC4: "RVC4";
 }>;
+/**
+ * Supported DepthAI platform identifier.
+ */
 export type Platform = z.infer<typeof PlatformSchema>;
+/**
+ * Human-readable labels for DepthAI platform identifiers.
+ */
 export declare const PLATFORM_NAMES: {
     RVC2: string;
     RVC4: string;
     UNKNOWN: string;
 };
+/**
+ * UI color intents associated with DepthAI platform identifiers.
+ */
 export declare const PLATFORM_COLORS: {
     RVC2: string;
     RVC4: string;
     UNKNOWN: string;
 };
+/**
+ * Runtime validation schema for device connection transport identifiers.
+ */
 export declare const ConnectionTypeSchema: z.ZodEnum<{
     UNKNOWN: "UNKNOWN";
     USB: "USB";
     ETH: "ETH";
 }>;
+/**
+ * Device connection transport identifier.
+ */
 export type ConnectionType = z.infer<typeof ConnectionTypeSchema>;
+/**
+ * Normalized device capability and compatibility data used by Viewer UI surfaces.
+ */
 export type DeviceConfiguration = {
+    /**
+     * Camera sensors present on the device.
+     */
     cameraSensors: Sensor[];
+    /**
+     * Infrared emitter capabilities.
+     */
     ir: Ir;
+    /**
+     * Whether the device has stereo depth support.
+     */
     stereo: boolean;
+    /**
+     * Whether the device has thermal sensing support.
+     */
     thermal: boolean;
+    /**
+     * Product identifier recognized by the shared UI device list schema.
+     */
     productName: z.infer<typeof DeviceListSchema>;
+    /**
+     * DepthAI processing platform.
+     */
     platform: Platform;
+    /**
+     * Whether the device exposes an IMU.
+     */
     imu: boolean;
+    /**
+     * Whether the device calibration is available and valid.
+     */
     calibrated: boolean;
+    /**
+     * Whether dynamic calibration is supported.
+     */
     dynamicCalibration: boolean;
+    /**
+     * Whether the device is fully compatible with the current application.
+     */
     fullyCompatible: boolean;
+    /**
+     * Whether the device is connected over an older USB generation.
+     */
     oldUsbGeneration: boolean;
 };
+/**
+ * Runtime validation schema for normalized DepthAI device configuration.
+ */
 export declare const DeviceConfigurationSchema: z.ZodType<DeviceConfiguration>;
 //# sourceMappingURL=device-configuration.d.ts.map

package/dist/models/device-configuration.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"device-configuration.d.ts","sourceRoot":"","sources":["../../src/models/device-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,YAAY;;;;;;;;;iBAMvB,CAAC;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAElD,eAAO,MAAM,QAAQ;;;iBAGnB,CAAC;AACH,MAAM,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAE1C,eAAO,MAAM,cAAc;;;;EAAsC,CAAC;AAClE,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AACtD,eAAO,MAAM,cAAc;;;;CAI1B,CAAC;AACF,eAAO,MAAM,eAAe;;;;CAI3B,CAAC;AAEF,eAAO,MAAM,oBAAoB;;;;EAAoC,CAAC;AACtE,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE,MAAM,MAAM,mBAAmB,GAAG;IACjC,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,EAAE,EAAE,EAAE,CAAC;IACP,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAC9C,QAAQ,EAAE,QAAQ,CAAC;IACnB,GAAG,EAAE,OAAO,CAAC;IACb,UAAU,EAAE,OAAO,CAAC;IACpB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,eAAe,EAAE,OAAO,CAAC;IACzB,gBAAgB,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAYnE,CAAC"}
+{"version":3,"file":"device-configuration.d.ts","sourceRoot":"","sources":["../../src/models/device-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,YAAY;;;;;;;;;iBAMvB,CAAC;AACH;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;AAElD;;GAEG;AACH,eAAO,MAAM,QAAQ;;;iBAGnB,CAAC;AACH;;GAEG;AACH,MAAM,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAE1C;;GAEG;AACH,eAAO,MAAM,cAAc;;;;EAAsC,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,cAAc;;;;CAI1B,CAAC;AACF;;GAEG;AACH,eAAO,MAAM,eAAe;;;;CAI3B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;EAAoC,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAC;AAElE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IACjC;;OAEG;IACH,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;OAEG;IACH,EAAE,EAAE,EAAE,CAAC;IACP;;OAEG;IACH,MAAM,EAAE,OAAO,CAAC;IAChB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,gBAAgB,CAAC,CAAC;IAC9C;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,GAAG,EAAE,OAAO,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAYnE,CAAC"}

package/dist/models/device-configuration.js

@@ -1,5 +1,8 @@
 import { DeviceListSchema } from '@luxonis/ui-components';
 import { z } from 'zod';
+/**
+ * Runtime validation schema for camera sensor metadata reported by a DepthAI device.
+ */
 export const SensorSchema = z.object({
     boardSocket: z.string(),
     maxFps: z.number(),
@@ -7,22 +10,40 @@ export const SensorSchema = z.object({
     type: z.string(),
     supportedResolutions: z.array(z.object({ width: z.number(), height: z.number() })),
 });
+/**
+ * Runtime validation schema for infrared emitter availability.
+ */
 export const IrSchema = z.object({
     floodLight: z.boolean(),
     dotProjector: z.boolean(),
 });
+/**
+ * Runtime validation schema for supported DepthAI platform identifiers.
+ */
 export const PlatformSchema = z.enum(['RVC2', 'RVC4', 'UNKNOWN']);
+/**
+ * Human-readable labels for DepthAI platform identifiers.
+ */
 export const PLATFORM_NAMES = {
     RVC2: 'RVC2',
     RVC4: 'RVC4',
     UNKNOWN: 'Unknown',
 };
+/**
+ * UI color intents associated with DepthAI platform identifiers.
+ */
 export const PLATFORM_COLORS = {
     RVC2: 'active',
     RVC4: 'success',
     UNKNOWN: 'gray',
 };
+/**
+ * Runtime validation schema for device connection transport identifiers.
+ */
 export const ConnectionTypeSchema = z.enum(['USB', 'ETH', 'UNKNOWN']);
+/**
+ * Runtime validation schema for normalized DepthAI device configuration.
+ */
 export const DeviceConfigurationSchema = z.object({
     cameraSensors: z.array(SensorSchema),
     ir: IrSchema,

package/dist/models/device-configuration.js.map

@@ -1 +1 @@
-{"version":3,"file":"device-configuration.js","sourceRoot":"","sources":["../../src/models/device-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,oBAAoB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;CAClF,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC;AAGH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;AAElE,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;CAClB,CAAC;AACF,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,MAAM;CACf,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;AAiBtE,MAAM,CAAC,MAAM,yBAAyB,GAAmC,CAAC,CAAC,MAAM,CAAC;IACjF,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;IACpC,EAAE,EAAE,QAAQ;IACZ,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,WAAW,EAAE,gBAAgB;IAC7B,QAAQ,EAAE,cAAc;IACxB,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC/B,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE;IAC5B,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;CAC7B,CAAC,CAAC"}
+{"version":3,"file":"device-configuration.js","sourceRoot":"","sources":["../../src/models/device-configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC1D,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACpC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;IAClB,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,oBAAoB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;CAClF,CAAC,CAAC;AAMH;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC;IAChC,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC;AAMH;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;AAOlE;;GAEG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC7B,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;CAClB,CAAC;AACF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC9B,IAAI,EAAE,QAAQ;IACd,IAAI,EAAE,SAAS;IACf,OAAO,EAAE,MAAM;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;AAyDtE;;GAEG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAmC,CAAC,CAAC,MAAM,CAAC;IACjF,aAAa,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC;IACpC,EAAE,EAAE,QAAQ;IACZ,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE;IACnB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,WAAW,EAAE,gBAAgB;IAC7B,QAAQ,EAAE,cAAc;IACxB,GAAG,EAAE,CAAC,CAAC,OAAO,EAAE;IAChB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;IACvB,kBAAkB,EAAE,CAAC,CAAC,OAAO,EAAE;IAC/B,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE;IAC5B,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;CAC7B,CAAC,CAAC"}

package/dist/providers/ConnectionProvider.d.ts

@@ -1,13 +1,67 @@
 import React from 'react';
 import type { DAIService, MessageHandlerVersion } from '../dai-connection/connection.js';
 import { type ConnectionData, type TokenRefreshHandler } from '../hooks/connection.js';
+/**
+ * React context containing the current DepthAI connection state.
+ *
+ * @remarks
+ * The default value represents a disconnected, idle provider state and is used only
+ * before a matching {@link ConnectionProvider} is mounted.
+ */
 export declare const ConnectionContext: React.Context<ConnectionData>;
-export declare const ConnectionProvider: React.FC<React.PropsWithChildren<{
+/**
+ * Props for the DepthAI connection provider.
+ */
+export type ConnectionProviderProps = React.PropsWithChildren<{
+    /**
+     * DepthAI service names polled while the connection is alive.
+     *
+     * @defaultValue `[]`
+     */
     activeServices: DAIService[];
+    /**
+     * Enables verbose connection logging.
+     *
+     * @defaultValue `false`
+     */
     withDebugLogs?: boolean;
+    /**
+     * Stream topics opened automatically after connection.
+     *
+     * @remarks
+     * `undefined` preserves the connection/backend default topic behavior.
+     */
     defaultTopics?: string[];
+    /**
+     * Backend message handling protocol expected by the visualizer connection.
+     */
     messageHandlerVersion?: MessageHandlerVersion;
+    /**
+     * Controls how refreshed WebRTC tokens are propagated to the host application.
+     *
+     * @defaultValue `false`
+     */
     tokenRefresh?: TokenRefreshHandler;
-}>>;
+}>;
+/**
+ * Creates and provides a DepthAI connection based on data provider connection settings.
+ *
+ * @remarks
+ * This provider reads transport settings from {@link DataProvider}, delegates connection
+ * creation to {@link useCreateConnection}, and wraps children with the visualizer
+ * connection context used by stream panels.
+ *
+ * @example
+ * ```tsx
+ * <ConnectionProvider activeServices={[]}>{children}</ConnectionProvider>
+ * ```
+ */
+export declare const ConnectionProvider: React.FC<ConnectionProviderProps>;
+/**
+ * Returns the current DepthAI connection context.
+ *
+ * @remarks
+ * Outside {@link ConnectionProvider}, this hook returns the disconnected default context.
+ */
 export declare const useDaiConnection: () => ConnectionData;
 //# sourceMappingURL=ConnectionProvider.d.ts.map

package/dist/providers/ConnectionProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConnectionProvider.d.ts","sourceRoot":"","sources":["../../src/providers/ConnectionProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EAExB,MAAM,wBAAwB,CAAC;AAKhC,eAAO,MAAM,iBAAiB,+BAc5B,CAAC;AAEH,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CACxC,KAAK,CAAC,iBAAiB,CAAC;IACvB,cAAc,EAAE,UAAU,EAAE,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACnC,CAAC,CA4BF,CAAC;AAEF,eAAO,MAAM,gBAAgB,sBAA4C,CAAC"}
+{"version":3,"file":"ConnectionProvider.d.ts","sourceRoot":"","sources":["../../src/providers/ConnectionProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,KAAK,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACzF,OAAO,EACN,KAAK,cAAc,EACnB,KAAK,mBAAmB,EAExB,MAAM,wBAAwB,CAAC;AAKhC;;;;;;GAMG;AACH,eAAO,MAAM,iBAAiB,+BAc5B,CAAC;AAEH;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG,KAAK,CAAC,iBAAiB,CAAC;IAC7D;;;;OAIG;IACH,cAAc,EAAE,UAAU,EAAE,CAAC;IAC7B;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,qBAAqB,CAAC;IAC9C;;;;OAIG;IACH,YAAY,CAAC,EAAE,mBAAmB,CAAC;CACnC,CAAC,CAAC;AAEH;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,EAAE,KAAK,CAAC,EAAE,CAAC,uBAAuB,CA2BhE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,sBAA4C,CAAC"}

package/dist/providers/ConnectionProvider.js

@@ -4,6 +4,13 @@ import { useCreateConnection, } from '../hooks/connection.js';
 import { noop } from '../utils/functions.js';
 import { VisualizerContext } from '../visualizer/index.js';
 import { useData } from './DataProvider.js';
+/**
+ * React context containing the current DepthAI connection state.
+ *
+ * @remarks
+ * The default value represents a disconnected, idle provider state and is used only
+ * before a matching {@link ConnectionProvider} is mounted.
+ */
 export const ConnectionContext = React.createContext({
     daiConnection: null,
     connected: false,
@@ -19,6 +26,19 @@ export const ConnectionContext = React.createContext({
     toggleTopic: noop,
     isConnectionError: false,
 });
+/**
+ * Creates and provides a DepthAI connection based on data provider connection settings.
+ *
+ * @remarks
+ * This provider reads transport settings from {@link DataProvider}, delegates connection
+ * creation to {@link useCreateConnection}, and wraps children with the visualizer
+ * connection context used by stream panels.
+ *
+ * @example
+ * ```tsx
+ * <ConnectionProvider activeServices={[]}>{children}</ConnectionProvider>
+ * ```
+ */
 export const ConnectionProvider = ({ children, activeServices, withDebugLogs, defaultTopics, messageHandlerVersion, tokenRefresh, }) => {
     const { connectionType, wsUrl, token, clientId } = useData();
     const connectionData = useCreateConnection({
@@ -34,5 +54,11 @@ export const ConnectionProvider = ({ children, activeServices, withDebugLogs, de
     });
     return (_jsx(VisualizerContext, { connections: connectionData.connections, children: _jsx(ConnectionContext.Provider, { value: connectionData, children: children }) }));
 };
+/**
+ * Returns the current DepthAI connection context.
+ *
+ * @remarks
+ * Outside {@link ConnectionProvider}, this hook returns the disconnected default context.
+ */
 export const useDaiConnection = () => React.useContext(ConnectionContext);
 //# sourceMappingURL=ConnectionProvider.js.map

package/dist/providers/ConnectionProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConnectionProvider.js","sourceRoot":"","sources":["../../src/providers/ConnectionProvider.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAGN,mBAAmB,GACnB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAiB;IACpE,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,EAAE;IACV,aAAa,EAAE,KAAK;IACpB,iBAAiB,EAAE,EAAE;IACrB,QAAQ,EAAE,SAAS;IACnB,YAAY,EAAE,SAAS;IACvB,aAAa,EAAE,SAAS;IACxB,iBAAiB,EAAE,KAAK;IACxB,oBAAoB,EAAE,IAAI;IAC1B,WAAW,EAAE,EAAE;IACf,WAAW,EAAE,IAAI;IACjB,iBAAiB,EAAE,KAAK;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAQ3B,CAAC,EACJ,QAAQ,EACR,cAAc,EACd,aAAa,EACb,aAAa,EACb,qBAAqB,EACrB,YAAY,GACZ,EAAE,EAAE;IACJ,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IAE7D,MAAM,cAAc,GAAG,mBAAmB,CAAC;QAC1C,IAAI,EAAE,cAAc;QACpB,KAAK;QACL,QAAQ;QACR,aAAa,EAAE,KAAK;QACpB,cAAc;QACd,aAAa;QACb,aAAa;QACb,qBAAqB,EAAE,qBAAqB;QAC5C,YAAY;KACZ,CAAC,CAAC;IAEH,OAAO,CACN,KAAC,iBAAiB,IAAC,WAAW,EAAE,cAAc,CAAC,WAAW,YACzD,KAAC,iBAAiB,CAAC,QAAQ,IAAC,KAAK,EAAE,cAAc,YAAG,QAAQ,GAA8B,GACvE,CACpB,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC"}
+{"version":3,"file":"ConnectionProvider.js","sourceRoot":"","sources":["../../src/providers/ConnectionProvider.tsx"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAGN,mBAAmB,GACnB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,CAAC,aAAa,CAAiB;IACpE,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,KAAK;IAChB,MAAM,EAAE,EAAE;IACV,aAAa,EAAE,KAAK;IACpB,iBAAiB,EAAE,EAAE;IACrB,QAAQ,EAAE,SAAS;IACnB,YAAY,EAAE,SAAS;IACvB,aAAa,EAAE,SAAS;IACxB,iBAAiB,EAAE,KAAK;IACxB,oBAAoB,EAAE,IAAI;IAC1B,WAAW,EAAE,EAAE;IACf,WAAW,EAAE,IAAI;IACjB,iBAAiB,EAAE,KAAK;CACxB,CAAC,CAAC;AAqCH;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAsC,CAAC,EACrE,QAAQ,EACR,cAAc,EACd,aAAa,EACb,aAAa,EACb,qBAAqB,EACrB,YAAY,GACZ,EAAE,EAAE;IACJ,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IAE7D,MAAM,cAAc,GAAG,mBAAmB,CAAC;QAC1C,IAAI,EAAE,cAAc;QACpB,KAAK;QACL,QAAQ;QACR,aAAa,EAAE,KAAK;QACpB,cAAc;QACd,aAAa;QACb,aAAa;QACb,qBAAqB,EAAE,qBAAqB;QAC5C,YAAY;KACZ,CAAC,CAAC;IAEH,OAAO,CACN,KAAC,iBAAiB,IAAC,WAAW,EAAE,cAAc,CAAC,WAAW,YACzD,KAAC,iBAAiB,CAAC,QAAQ,IAAC,KAAK,EAAE,cAAc,YAAG,QAAQ,GAA8B,GACvE,CACpB,CAAC;AACH,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC"}

package/dist/providers/DataProvider.d.ts

@@ -1,28 +1,157 @@
 import React from 'react';
+/**
+ * Shared UI state derived from URL parameters and connection configuration.
+ *
+ * @remarks
+ * Values come from explicit `connectionConfig` first, then URL parameters, then local
+ * defaults. Mutation helpers update both React state and the relevant URL parameters.
+ */
 export type DataContext = {
+    /**
+     * Number of stream columns requested by the layout state, or `null` for automatic layout.
+     *
+     * @remarks
+     * `null` is persisted as layout `0` in the URL.
+     */
     columns: number | null;
+    /**
+     * Whether the user is controlling panel layout manually instead of using column layout.
+     *
+     * @defaultValue `false`
+     */
     customLayout: boolean;
+    /**
+     * Updates the number of stream columns and persists it to the URL.
+     *
+     * @remarks
+     * Calling this also disables custom layout mode.
+     */
     changeColumns: (columns: number | null) => void;
+    /**
+     * Enables or disables custom stream layout mode.
+     *
+     * @remarks
+     * Calling this resets `columns` to `null` and persists layout `0` to the URL.
+     */
     changeCustomLayout: (value: boolean) => void;
+    /**
+     * Updates the WebSocket URL and clears WebRTC URL parameters.
+     *
+     * @remarks
+     * Calling this removes `t` and `cid` from the URL so the next connection uses
+     * WebSocket settings.
+     */
     changeWsUrl: (url: string) => void;
+    /**
+     * Active connection transport selected from props or URL parameters.
+     *
+     * @remarks
+     * WebRTC is selected only when token and client id are available.
+     */
     connectionType: 'ws' | 'webrtc';
+    /**
+     * WebSocket endpoint used when `connectionType` is `ws`.
+     *
+     * @remarks
+     * Defaults to the local backend URL on localhost/Electron and to the production
+     * default URL elsewhere.
+     */
     wsUrl: string;
+    /**
+     * WebRTC auth token used when `connectionType` is `webrtc`.
+     *
+     * @remarks
+     * Empty when WebRTC parameters are not available.
+     */
     token: string;
+    /**
+     * WebRTC client id used when `connectionType` is `webrtc`.
+     *
+     * @remarks
+     * Empty when WebRTC parameters are not available.
+     */
     clientId: string;
+    /**
+     * Selected distance unit system for stream overlays.
+     *
+     * @defaultValue `'metric'`
+     */
     units: SelectedUnits;
+    /**
+     * Updates the selected distance unit system.
+     */
     setUnits: (units: SelectedUnits) => void;
 };
+/**
+ * Returns shared URL, layout, connection, and unit preferences for viewer components.
+ *
+ * @remarks
+ * Outside {@link DataProvider}, this hook returns the default WebSocket-based context.
+ */
 export declare const useData: () => DataContext;
+/**
+ * Supported unit systems for stream overlay distance values.
+ */
 export type SelectedUnits = 'imperial' | 'metric';
+/**
+ * Props for the shared data provider.
+ */
 export type DataProviderProps = React.PropsWithChildren & {
+    /**
+     * Optional connection configuration supplied by the host application instead of URL parameters.
+     *
+     * @remarks
+     * When omitted, the provider reads WebRTC parameters from `t` and `cid`, or a WebSocket
+     * URL from `ws_url`. If no URL parameters are present, it falls back to the default
+     * WebSocket URL.
+     */
     connectionConfig?: {
+        /**
+         * Selects a WebSocket connection.
+         */
         type: 'ws';
+        /**
+         * WebSocket URL of the DepthAI backend.
+         *
+         * @remarks
+         * This value takes precedence over `ws_url` from the current URL.
+         */
         wsUrl: string;
     } | {
+        /**
+         * Selects a WebRTC connection.
+         */
         type: 'webrtc';
+        /**
+         * WebRTC auth token.
+         *
+         * @remarks
+         * This value takes precedence over `t` from the current URL.
+         */
         token: string;
+        /**
+         * WebRTC client id.
+         *
+         * @remarks
+         * This value takes precedence over `cid` from the current URL.
+         */
         clientId: string;
     };
 };
+/**
+ * Provides shared viewer state resolved from explicit connection config and URL parameters.
+ *
+ * @remarks
+ * The provider keeps layout state synchronized with URL search parameters and chooses
+ * the active transport in this order: explicit `connectionConfig`, WebRTC URL params,
+ * WebSocket URL param, environment default URL.
+ *
+ * @example
+ * ```tsx
+ * <DataProvider connectionConfig={{ type: 'ws', wsUrl: 'ws://localhost:8765' }}>
+ * 	{children}
+ * </DataProvider>
+ * ```
+ */
 export declare const DataProvider: React.FC<DataProviderProps>;
 //# sourceMappingURL=DataProvider.d.ts.map

package/dist/providers/DataProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DataProvider.d.ts","sourceRoot":"","sources":["../../src/providers/DataProvider.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,MAAM,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,YAAY,EAAE,OAAO,CAAC;IACtB,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAChD,kBAAkB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAC7C,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,cAAc,EAAE,IAAI,GAAG,QAAQ,CAAC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,aAAa,CAAC;IACrB,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;CACzC,CAAC;AAgBF,eAAO,MAAM,OAAO,mBAAsC,CAAC;AAE3D,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAC;AAElD,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,GAAG;IACzD,gBAAgB,CAAC,EACd;QACA,IAAI,EAAE,IAAI,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;KACb,GACD;QACA,IAAI,EAAE,QAAQ,CAAC;QACf,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;KAChB,CAAC;CACL,CAAC;AAIF,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAoGpD,CAAC"}
+{"version":3,"file":"DataProvider.d.ts","sourceRoot":"","sources":["../../src/providers/DataProvider.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG;IACzB;;;;;OAKG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;;OAIG;IACH,YAAY,EAAE,OAAO,CAAC;IACtB;;;;;OAKG;IACH,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAChD;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAC7C;;;;;;OAMG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC;;;;;OAKG;IACH,cAAc,EAAE,IAAI,GAAG,QAAQ,CAAC;IAChC;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,KAAK,EAAE,aAAa,CAAC;IACrB;;OAEG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI,CAAC;CACzC,CAAC;AAgBF;;;;;GAKG;AACH,eAAO,MAAM,OAAO,mBAAsC,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAC;AAElD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,GAAG;IACzD;;;;;;;OAOG;IACH,gBAAgB,CAAC,EACd;QACA;;WAEG;QACH,IAAI,EAAE,IAAI,CAAC;QACX;;;;;WAKG;QACH,KAAK,EAAE,MAAM,CAAC;KACb,GACD;QACA;;WAEG;QACH,IAAI,EAAE,QAAQ,CAAC;QACf;;;;;WAKG;QACH,KAAK,EAAE,MAAM,CAAC;QACd;;;;;WAKG;QACH,QAAQ,EAAE,MAAM,CAAC;KAChB,CAAC;CACL,CAAC;AAIF;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,YAAY,EAAE,KAAK,CAAC,EAAE,CAAC,iBAAiB,CAoGpD,CAAC"}

package/dist/providers/DataProvider.js

@@ -17,8 +17,29 @@ const DataContext = React.createContext({
     units: 'metric',
     setUnits: noop,
 });
+/**
+ * Returns shared URL, layout, connection, and unit preferences for viewer components.
+ *
+ * @remarks
+ * Outside {@link DataProvider}, this hook returns the default WebSocket-based context.
+ */
 export const useData = () => React.useContext(DataContext);
 const DEFAULT_SEARCH_INIT = { layout: '0', t: '', cid: '' };
+/**
+ * Provides shared viewer state resolved from explicit connection config and URL parameters.
+ *
+ * @remarks
+ * The provider keeps layout state synchronized with URL search parameters and chooses
+ * the active transport in this order: explicit `connectionConfig`, WebRTC URL params,
+ * WebSocket URL param, environment default URL.
+ *
+ * @example
+ * ```tsx
+ * <DataProvider connectionConfig={{ type: 'ws', wsUrl: 'ws://localhost:8765' }}>
+ * 	{children}
+ * </DataProvider>
+ * ```
+ */
 export const DataProvider = ({ children, connectionConfig }) => {
     const { search, updateSearch } = useFlatSearch({
         defaultInit: DEFAULT_SEARCH_INIT,

package/dist/providers/DataProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"DataProvider.js","sourceRoot":"","sources":["../../src/providers/DataProvider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAgB7C,MAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAc;IACpD,OAAO,EAAE,IAAI;IACb,YAAY,EAAE,KAAK;IACnB,cAAc,EAAE,IAAI;IACpB,KAAK,EAAE,cAAc;IACrB,aAAa,EAAE,IAAI;IACnB,kBAAkB,EAAE,IAAI;IACxB,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,EAAE;IACT,QAAQ,EAAE,EAAE;IACZ,KAAK,EAAE,QAAQ;IACf,QAAQ,EAAE,IAAI;CACd,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAiB3D,MAAM,mBAAmB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;AAE5D,MAAM,CAAC,MAAM,YAAY,GAAgC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,EAAE,EAAE;IAC3F,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;QAC9C,WAAW,EAAE,mBAAmB;KAChC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACvC,IAAI,gBAAgB,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;YACzC,OAAO;gBACN,CAAC,EAAE,gBAAgB,CAAC,KAAK;gBACzB,GAAG,EAAE,gBAAgB,CAAC,QAAQ;aAC9B,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;YAC5B,OAAO;gBACN,CAAC,EAAE,MAAM,CAAC,CAAW;gBACrB,GAAG,EAAE,MAAM,CAAC,GAAa;aACzB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7C,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACnC,IAAI,gBAAgB,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;YACrC,OAAO;gBACN,MAAM,EAAE,gBAAgB,CAAC,KAAK;aAC9B,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO;gBACN,MAAM,EAAE,MAAM,CAAC,MAAgB;aAC/B,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAgB,GAAG,EAAE;QAChE,OAAO,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,CAAC;IACvE,MAAM,CAAC,sBAAsB,EAAE,yBAAyB,CAAC,GAAG,KAAK,CAAC,QAAQ,CACzE,YAAY;QACX,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,QAAQ,EAAE,MAAM;YACjB,CAAC,CAAC,QAAQ,CAAC,MAAM;YACjB,CAAC,CAAC,YAAY,IAAI,WAAW;gBAC5B,CAAC,CAAC,gBAAgB;gBAClB,CAAC,CAAC,cAAc,CACnB,CAAC;IACF,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAgB,QAAQ,CAAC,CAAC;IAElE,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CACtC,CAAC,OAAsB,EAAE,EAAE;QAC1B,UAAU,CAAC,OAAO,CAAC,CAAC;QACpB,eAAe,CAAC,KAAK,CAAC,CAAC;QACvB,YAAY,CAAC,QAAQ,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC,EACD,CAAC,YAAY,CAAC,CACd,CAAC;IAEF,MAAM,kBAAkB,GAAG,KAAK,CAAC,WAAW,CAC3C,CAAC,KAAc,EAAE,EAAE;QAClB,eAAe,CAAC,KAAK,CAAC,CAAC;QACvB,UAAU,CAAC,IAAI,CAAC,CAAC;QACjB,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC3B,CAAC,EACD,CAAC,YAAY,CAAC,CACd,CAAC;IAEF,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CACpC,CAAC,GAAW,EAAE,EAAE;QACf,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3B,CAAC,EACD,CAAC,YAAY,CAAC,CACd,CAAC;IAEF,OAAO,CACN,KAAC,WAAW,CAAC,QAAQ,IACpB,KAAK,EAAE;YACN,KAAK,EAAE,YAAY,EAAE,CAAW;YAChC,QAAQ,EAAE,YAAY,EAAE,GAAa;YACrC,KAAK,EAAE,sBAAsB;YAC7B,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;YAC9C,OAAO;YACP,YAAY;YACZ,aAAa;YACb,kBAAkB;YAClB,WAAW;YACX,KAAK;YACL,QAAQ;SACR,YAEA,QAAQ,GACa,CACvB,CAAC;AACH,CAAC,CAAC"}
+{"version":3,"file":"DataProvider.js","sourceRoot":"","sources":["../../src/providers/DataProvider.tsx"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gCAAgC,CAAC;AAC7D,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACrF,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAsF7C,MAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAc;IACpD,OAAO,EAAE,IAAI;IACb,YAAY,EAAE,KAAK;IACnB,cAAc,EAAE,IAAI;IACpB,KAAK,EAAE,cAAc;IACrB,aAAa,EAAE,IAAI;IACnB,kBAAkB,EAAE,IAAI;IACxB,WAAW,EAAE,IAAI;IACjB,KAAK,EAAE,EAAE;IACT,QAAQ,EAAE,EAAE;IACZ,KAAK,EAAE,QAAQ;IACf,QAAQ,EAAE,IAAI;CACd,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAuD3D,MAAM,mBAAmB,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC;AAE5D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,YAAY,GAAgC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,EAAE,EAAE,EAAE;IAC3F,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,GAAG,aAAa,CAAC;QAC9C,WAAW,EAAE,mBAAmB;KAChC,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACvC,IAAI,gBAAgB,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;YACzC,OAAO;gBACN,CAAC,EAAE,gBAAgB,CAAC,KAAK;gBACzB,GAAG,EAAE,gBAAgB,CAAC,QAAQ;aAC9B,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;YAC5B,OAAO;gBACN,CAAC,EAAE,MAAM,CAAC,CAAW;gBACrB,GAAG,EAAE,MAAM,CAAC,GAAa;aACzB,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7C,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE;QACnC,IAAI,gBAAgB,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;YACrC,OAAO;gBACN,MAAM,EAAE,gBAAgB,CAAC,KAAK;aAC9B,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YACnB,OAAO;gBACN,MAAM,EAAE,MAAM,CAAC,MAAgB;aAC/B,CAAC;QACH,CAAC;QAED,OAAO,IAAI,CAAC;IACb,CAAC,EAAE,CAAC,gBAAgB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAEtC,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAgB,GAAG,EAAE;QAChE,OAAO,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAU,KAAK,CAAC,CAAC;IACvE,MAAM,CAAC,sBAAsB,EAAE,yBAAyB,CAAC,GAAG,KAAK,CAAC,QAAQ,CACzE,YAAY;QACX,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC,QAAQ,EAAE,MAAM;YACjB,CAAC,CAAC,QAAQ,CAAC,MAAM;YACjB,CAAC,CAAC,YAAY,IAAI,WAAW;gBAC5B,CAAC,CAAC,gBAAgB;gBAClB,CAAC,CAAC,cAAc,CACnB,CAAC;IACF,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAgB,QAAQ,CAAC,CAAC;IAElE,MAAM,aAAa,GAAG,KAAK,CAAC,WAAW,CACtC,CAAC,OAAsB,EAAE,EAAE;QAC1B,UAAU,CAAC,OAAO,CAAC,CAAC;QACpB,eAAe,CAAC,KAAK,CAAC,CAAC;QACvB,YAAY,CAAC,QAAQ,EAAE,OAAO,IAAI,CAAC,CAAC,CAAC;IACtC,CAAC,EACD,CAAC,YAAY,CAAC,CACd,CAAC;IAEF,MAAM,kBAAkB,GAAG,KAAK,CAAC,WAAW,CAC3C,CAAC,KAAc,EAAE,EAAE;QAClB,eAAe,CAAC,KAAK,CAAC,CAAC;QACvB,UAAU,CAAC,IAAI,CAAC,CAAC;QACjB,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IAC3B,CAAC,EACD,CAAC,YAAY,CAAC,CACd,CAAC;IAEF,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CACpC,CAAC,GAAW,EAAE,EAAE;QACf,yBAAyB,CAAC,GAAG,CAAC,CAAC;QAC/B,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QACxB,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC3B,CAAC,EACD,CAAC,YAAY,CAAC,CACd,CAAC;IAEF,OAAO,CACN,KAAC,WAAW,CAAC,QAAQ,IACpB,KAAK,EAAE;YACN,KAAK,EAAE,YAAY,EAAE,CAAW;YAChC,QAAQ,EAAE,YAAY,EAAE,GAAa;YACrC,KAAK,EAAE,sBAAsB;YAC7B,cAAc,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI;YAC9C,OAAO;YACP,YAAY;YACZ,aAAa;YACb,kBAAkB;YAClB,WAAW;YACX,KAAK;YACL,QAAQ;SACR,YAEA,QAAQ,GACa,CACvB,CAAC;AACH,CAAC,CAAC"}

package/dist/providers/ThemeProvider.d.ts

@@ -1,25 +1,85 @@
 import React from 'react';
-/** What the user picked. `system` follows the OS and keeps following it. */
+/**
+ * Theme preference selected by the user.
+ *
+ * @remarks
+ * `system` follows the operating system preference and keeps listening for OS changes.
+ */
 export type ThemePreference = 'light' | 'dark' | 'system';
-/** What is actually on screen. `system` has already been resolved. */
+/**
+ * Theme that is currently rendered on screen after resolving `system`.
+ */
 export type ResolvedTheme = 'light' | 'dark';
+/**
+ * Supported theme preferences shown by the theme picker.
+ */
 export declare const THEME_PREFERENCES: ThemePreference[];
+/**
+ * Resolves a user theme preference into the theme currently rendered by the UI.
+ *
+ * @param preference - User-selected theme preference.
+ * @returns Concrete light or dark theme.
+ */
 export declare const resolveTheme: (preference: ThemePreference) => ResolvedTheme;
+/**
+ * Reads the stored theme preference from local storage.
+ *
+ * @returns Stored theme preference, or `system` when the stored value is missing or invalid.
+ */
 export declare const readStoredTheme: () => ThemePreference;
 /**
- * Applied both from React and from the inline bootstrap script in index.html, which
- * runs before first paint so the app never flashes the light theme on load.
+ * Applies a resolved theme to the document root.
+ *
+ * @remarks
+ * This toggles the `dark` class on `document.documentElement`. It is used both from
+ * React and from the inline bootstrap script in `index.html`, which runs before first
+ * paint so the app never flashes the light theme on load.
  */
 export declare const applyTheme: (theme: ResolvedTheme) => void;
+/**
+ * Theme state and actions exposed by {@link ThemeProvider}.
+ */
 export type ThemeContext = {
-    /** The user's choice, including `system`. */
+    /**
+     * User-selected preference, including `system`.
+     *
+     * @defaultValue `'system'`
+     */
     theme: ThemePreference;
-    /** The theme currently rendered. */
+    /**
+     * Concrete theme currently rendered on screen.
+     *
+     * @defaultValue `'light'`
+     */
     resolvedTheme: ResolvedTheme;
+    /**
+     * Updates the user-selected theme and persists it to local storage.
+     */
     setTheme: (theme: ThemePreference) => void;
-    /** Flips between light and dark, resolving `system` first. */
+    /**
+     * Flips between light and dark, resolving `system` first.
+     */
     toggleTheme: () => void;
 };
+/**
+ * Returns the current theme context.
+ *
+ * @remarks
+ * Outside {@link ThemeProvider}, this hook returns the default system/light context.
+ */
 export declare const useTheme: () => ThemeContext;
+/**
+ * Provides shared theme state and keeps DOM/local storage in sync.
+ *
+ * @remarks
+ * The provider reads the initial preference from local storage, follows OS theme changes
+ * while the preference is `system`, persists explicit user changes, and applies the
+ * resolved theme to the document root.
+ *
+ * @example
+ * ```tsx
+ * <ThemeProvider>{children}</ThemeProvider>
+ * ```
+ */
 export declare const ThemeProvider: React.FC<React.PropsWithChildren>;
 //# sourceMappingURL=ThemeProvider.d.ts.map

package/dist/providers/ThemeProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ThemeProvider.d.ts","sourceRoot":"","sources":["../../src/providers/ThemeProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B,4EAA4E;AAC5E,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE1D,sEAAsE;AACtE,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,CAAC;AAE7C,eAAO,MAAM,iBAAiB,EAAE,eAAe,EAAgC,CAAC;AAWhF,eAAO,MAAM,YAAY,GAAI,YAAY,eAAe,KAAG,aACe,CAAC;AAE3E,eAAO,MAAM,eAAe,QAAO,eAGlC,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,aAAa,SAE9C,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,6CAA6C;IAC7C,KAAK,EAAE,eAAe,CAAC;IACvB,oCAAoC;IACpC,aAAa,EAAE,aAAa,CAAC;IAC7B,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC3C,8DAA8D;IAC9D,WAAW,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AASF,eAAO,MAAM,QAAQ,oBAAuC,CAAC;AAE7D,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAsC3D,CAAC"}
+{"version":3,"file":"ThemeProvider.d.ts","sourceRoot":"","sources":["../../src/providers/ThemeProvider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAI1B;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,CAAC;AAE7C;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,eAAe,EAAgC,CAAC;AAWhF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,GAAI,YAAY,eAAe,KAAG,aACe,CAAC;AAE3E;;;;GAIG;AACH,eAAO,MAAM,eAAe,QAAO,eAGlC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,UAAU,GAAI,OAAO,aAAa,SAE9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B;;;;OAIG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;;;OAIG;IACH,aAAa,EAAE,aAAa,CAAC;IAC7B;;OAEG;IACH,QAAQ,EAAE,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;IAC3C;;OAEG;IACH,WAAW,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AASF;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,oBAAuC,CAAC;AAE7D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,iBAAiB,CAsC3D,CAAC"}