@esrf/daiquiri-lib 5.3.1 → 5.5.0

package/dist/index.d.ts

@@ -3,7 +3,6 @@ import { JSONSchema7 } from 'json-schema';
 import * as react from 'react';
 import react__default, { ComponentType, ReactElement, PropsWithChildren, ReactNode, ChangeEvent, KeyboardEvent, Component } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { Placement } from 'react-bootstrap/esm/types';
 
 interface HardwareError {
     property: string;
@@ -106,6 +105,20 @@ type HardwareComponentType<H extends Hardware = Hardware> = ComponentType<Hardwa
 interface HardwareVariant<H extends Hardware = Hardware> {
     [name: string]: HardwareComponentType<H>;
 }
+/**
+ * Bundles everything a hardware module exposes: its widget
+ * variants, plus optional mocks/simulator/monitor.
+ */
+interface HardwareDesc<H extends Hardware = Hardware> {
+    /** Widget variants, keyed by variant name */
+    variants: HardwareVariant<H>;
+    /** Static mock data samples used for documentation */
+    mocks?: Record<string, unknown>;
+    /** Component emulating live hardware, for tests/demo */
+    simulator?: ComponentType<any>;
+    /** Monitor panel widget override */
+    monitor?: HardwareComponentType<H>;
+}
 /**
  * TODO: Add a description
  */
@@ -129,6 +142,7 @@ type types_d_EditableHardwareWidgetOptions = EditableHardwareWidgetOptions;
 type types_d_Hardware<P extends Record<string, unknown> = Record<string, any>> = Hardware<P>;
 type types_d_HardwareChangeActions = HardwareChangeActions;
 type types_d_HardwareComponentType<H extends Hardware = Hardware> = HardwareComponentType<H>;
+type types_d_HardwareDesc<H extends Hardware = Hardware> = HardwareDesc<H>;
 type types_d_HardwareMonitorOptions = HardwareMonitorOptions;
 type types_d_HardwareObjectProps = HardwareObjectProps;
 type types_d_HardwareSchemaDescription = HardwareSchemaDescription;
@@ -139,7 +153,7 @@ type types_d_LockDescription = LockDescription;
 type types_d_OfflineHardware = OfflineHardware;
 type types_d_OnlineHardware<P extends Record<string, any> = Record<string, never>> = OnlineHardware<P>;
 declare namespace types_d {
-  export type { types_d_AnyHardware as AnyHardware, types_d_BaseHardware as BaseHardware, types_d_EditableHardware as EditableHardware, types_d_EditableHardwareWidgetOptions as EditableHardwareWidgetOptions, types_d_Hardware as Hardware, types_d_HardwareChangeActions as HardwareChangeActions, types_d_HardwareComponentType as HardwareComponentType, types_d_HardwareMonitorOptions as HardwareMonitorOptions, types_d_HardwareObjectProps as HardwareObjectProps, types_d_HardwareSchemaDescription as HardwareSchemaDescription, types_d_HardwareVariant as HardwareVariant, types_d_HardwareWidgetOptions as HardwareWidgetOptions, types_d_HardwareWidgetProps as HardwareWidgetProps, types_d_LockDescription as LockDescription, types_d_OfflineHardware as OfflineHardware, types_d_OnlineHardware as OnlineHardware };
+  export type { types_d_AnyHardware as AnyHardware, types_d_BaseHardware as BaseHardware, types_d_EditableHardware as EditableHardware, types_d_EditableHardwareWidgetOptions as EditableHardwareWidgetOptions, types_d_Hardware as Hardware, types_d_HardwareChangeActions as HardwareChangeActions, types_d_HardwareComponentType as HardwareComponentType, types_d_HardwareDesc as HardwareDesc, types_d_HardwareMonitorOptions as HardwareMonitorOptions, types_d_HardwareObjectProps as HardwareObjectProps, types_d_HardwareSchemaDescription as HardwareSchemaDescription, types_d_HardwareVariant as HardwareVariant, types_d_HardwareWidgetOptions as HardwareWidgetOptions, types_d_HardwareWidgetProps as HardwareWidgetProps, types_d_LockDescription as LockDescription, types_d_OfflineHardware as OfflineHardware, types_d_OnlineHardware as OnlineHardware };
 }
 
 /**
@@ -158,7 +172,7 @@ declare namespace schema_d {
   export type { schema_d_AnySchema as AnySchema, schema_d_GenericSchema as GenericSchema };
 }
 
-declare const Variants$t: HardwareVariant<AnySchema>;
+declare const BaseHardwareDesc: HardwareDesc<AnySchema>;
 
 declare const Mocks$p: {
     default: {
@@ -298,7 +312,7 @@ type ActuatorSchema = Hardware<{
 type AirBearingSchema = Hardware<{
     state: string;
 }>;
-declare const Variants$s: HardwareVariant<AirBearingSchema>;
+declare const AirBearingHardwareDesc: HardwareDesc<AirBearingSchema>;
 
 declare function AirBearing(props: HardwareWidgetProps<AirBearingSchema, HardwareWidgetOptions>): react_jsx_runtime.JSX.Element;
 
@@ -350,7 +364,7 @@ type BeamviewerSchema = Hardware<{
     diode_ranges: string[];
     diode_range: string;
 }>;
-declare const Variants$r: HardwareVariant<BeamviewerSchema>;
+declare const BeamviewerHardwareDesc: HardwareDesc<BeamviewerSchema>;
 
 declare function Beamviewer(props: HardwareWidgetProps<BeamviewerSchema>): react_jsx_runtime.JSX.Element;
 
@@ -382,7 +396,7 @@ type EnergyManagerSchema = Hardware<{
     available_source_names: string[];
     source: string;
 }>;
-declare const Variants$q: HardwareVariant<EnergyManagerSchema>;
+declare const EnergyManagerHardwareDesc: HardwareDesc<EnergyManagerSchema>;
 
 declare function EnergyManagerDefault(props: HardwareWidgetProps<EnergyManagerSchema>): react_jsx_runtime.JSX.Element;
 
@@ -423,7 +437,7 @@ type FrontendSchema = Hardware<{
     pssitlk: string;
     expitlk: string;
 }>;
-declare const Variants$p: HardwareVariant<FrontendSchema>;
+declare const FrontendHardwareDesc: HardwareDesc<FrontendSchema>;
 
 declare function Frontend(props: HardwareWidgetProps<FrontendSchema>): react_jsx_runtime.JSX.Element;
 
@@ -460,7 +474,7 @@ type GaugeSchema = Hardware<{
     pressure: number;
     unit?: string;
 }>;
-declare const Variants$o: HardwareVariant<GaugeSchema>;
+declare const GaugeHardwareDesc: HardwareDesc<GaugeSchema>;
 
 interface GaugeWidgetOptions extends HardwareWidgetOptions {
     /** Unit of pressure */
@@ -508,7 +522,7 @@ type LaserSchema = Hardware<{
     state: string;
     power: number;
 }>;
-declare const Variants$n: HardwareVariant<LaserSchema>;
+declare const LaserHardwareDesc: HardwareDesc<LaserSchema>;
 
 interface LaserWidgetOptions extends HardwareWidgetOptions {
     /** Default step size to use for up / down arrows */
@@ -544,7 +558,7 @@ type LaserHeatingSchema = Hardware<{
     fit_wavelength: number[];
     current_calibration: string;
 }>;
-declare const Variants$m: HardwareVariant<LaserHeatingSchema>;
+declare const LaserHeatingHardwareDesc: HardwareDesc<LaserHeatingSchema>;
 
 interface LaserHeatingWidgetOptions extends HardwareWidgetOptions {
     /** Default step size to use for up / down arrows */
@@ -581,7 +595,7 @@ type LightSchema = Hardware<{
     temperature: number;
     intensity: number;
 }>;
-declare const Variants$l: HardwareVariant<LightSchema>;
+declare const LightHardwareDesc: HardwareDesc<LightSchema>;
 
 declare function Light(props: HardwareWidgetProps<LightSchema>): react_jsx_runtime.JSX.Element;
 
@@ -671,7 +685,7 @@ declare function useLimaHardware(name: string | null): LimaSchema | null;
  * Compute the nb sub frames which will be used for a specific exposure time
  */
 declare function limaGuessSubframes(exposureTime: number, accMaxExpoTime: number): [number, number];
-declare const Variants$k: HardwareVariant<LimaSchema>;
+declare const LimaHardwareDesc: HardwareDesc<LimaSchema>;
 
 declare function LimaBinning(props: HardwareWidgetProps<LimaSchema, EditableHardwareWidgetOptions>): react_jsx_runtime.JSX.Element;
 
@@ -844,7 +858,7 @@ interface MeasurementGroupProperties extends Record<string, unknown> {
  * Hardware as exposed by Redux
  */
 type MeasurementGroupSchema = Hardware<MeasurementGroupProperties>;
-declare const Variants$j: HardwareVariant<MeasurementGroupSchema>;
+declare const MeasurementGroupHardwareDesc: HardwareDesc<MeasurementGroupSchema>;
 
 declare function MeasurementGroup(props: HardwareWidgetProps<MeasurementGroupSchema>): react_jsx_runtime.JSX.Element;
 
@@ -926,7 +940,6 @@ declare function isMotorHardware(entity: Hardware): entity is MotorSchema;
  * @param name: An hardware identifier
  */
 declare function useMotorHardware(name: string | null): MotorSchema | null;
-declare const Variants$i: HardwareVariant<MotorSchema>;
 /**
  * True if the motor positon is clock wise.
  *
@@ -939,6 +952,7 @@ declare function isMotorClockWise(hardware: MotorSchema, options?: {
  * Normalize the limits as finite values or `undefined`.
  */
 declare function motorLimits(hardware: MotorSchema): [number | undefined, number | undefined];
+declare const MotorHardwareDesc: HardwareDesc<MotorSchema>;
 
 interface MotorDefaultOptions extends HardwareWidgetOptions {
     /** Default step size to use for up / down arrows */
@@ -1181,7 +1195,7 @@ type MultipositionSchema = Hardware<{
         }[];
     }[];
 }>;
-declare const Variants$h: HardwareVariant<MultipositionSchema>;
+declare const MultipositionHardwareDesc: HardwareDesc<MultipositionSchema>;
 
 declare function Multiposition$1(props: HardwareWidgetProps<MultipositionSchema>): react_jsx_runtime.JSX.Element;
 
@@ -1236,7 +1250,7 @@ interface OpticProperties extends Record<string, unknown> {
  */
 type OpticSchema = Hardware<OpticProperties>;
 declare function isOpticHardware(entity: Hardware): entity is OpticSchema;
-declare const Variants$g: HardwareVariant<OpticSchema>;
+declare const OpticHardwareDesc: HardwareDesc<OpticSchema>;
 
 interface OpticWidgetOptions extends HardwareWidgetOptions {
     readonly?: boolean;
@@ -1327,7 +1341,7 @@ type ProcedureSchema = Hardware<{
     previous_run_exception: string | null;
     parameters: Record<string, any>;
 }>;
-declare const Variants$f: HardwareVariant<ProcedureSchema>;
+declare const ProcedureHardwareDesc: HardwareDesc<ProcedureSchema>;
 
 interface HardwareFromProcedure {
     __type__: 'hardware';
@@ -1447,8 +1461,16 @@ type RegulationSchema = Hardware<{
     output_unit: string;
     deadband?: number;
 }>;
-declare const Variants$e: HardwareVariant<RegulationSchema>;
+declare const RegulationHardwareDesc: HardwareDesc<RegulationSchema>;
 
+/**
+ * Mirrors react-bootstrap's `Placement` (itself re-exported from
+ * `@restart/ui`/`@popperjs/core` via an inline `import()` type), spelled out
+ * as a literal union so widget-options codegen (which walks these
+ * interfaces with the TypeScript compiler API to produce a JSON Schema) can
+ * represent it — codegen can't resolve through the `import()` type node.
+ */
+type PopupPlacement = 'auto' | 'auto-start' | 'auto-end' | 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'right' | 'right-start' | 'right-end' | 'left' | 'left-start' | 'left-end';
 interface RegulationOptions extends HardwareWidgetOptions {
     /** Default step size to use for up / down arrows */
     step?: number;
@@ -1465,7 +1487,7 @@ interface RegulationOptions extends HardwareWidgetOptions {
     /** Popup button title */
     buttonTitle?: string;
     /** Popup placement */
-    popupPlacement?: Placement;
+    popupPlacement?: PopupPlacement;
 }
 
 declare function RegulationLoop(props: HardwareWidgetProps<RegulationSchema, RegulationOptions>): react_jsx_runtime.JSX.Element;
@@ -1503,7 +1525,7 @@ type ShutterSchema = Hardware<{
     open_text: string;
     closed_text: string;
 }>;
-declare const Variants$d: HardwareVariant<ShutterSchema>;
+declare const ShutterHardwareDesc: HardwareDesc<ShutterSchema>;
 
 declare function ShutterDefault(props: HardwareWidgetProps<ShutterSchema, HardwareWidgetOptions>): react_jsx_runtime.JSX.Element;
 
@@ -1568,7 +1590,7 @@ interface SlitDefaultOptions extends HardwareWidgetOptions {
     /** Setup the widget to be read only */
     readonly?: boolean;
 }
-declare const Variants$c: HardwareVariant<SlitSchema>;
+declare const SlitHardwareDesc: HardwareDesc<SlitSchema>;
 
 declare function SlitDefault(props: HardwareWidgetProps<SlitSchema, SlitDefaultOptions>): react_jsx_runtime.JSX.Element;
 
@@ -1626,7 +1648,7 @@ type PumpSchema = Hardware<{
     current: number;
     unit?: string;
 }>;
-declare const Variants$b: HardwareVariant<PumpSchema>;
+declare const PumpHardwareDesc: HardwareDesc<PumpSchema>;
 
 interface PumpWidgetOptions extends HardwareWidgetOptions {
     unit?: string;
@@ -1659,7 +1681,7 @@ declare const Mocks$7: {
 type PusherSchema = Hardware<{
     state: string;
 }>;
-declare const Variants$a: HardwareVariant<PusherSchema>;
+declare const PusherHardwareDesc: HardwareDesc<PusherSchema>;
 
 interface PusherOptions extends HardwareWidgetOptions {
     /**
@@ -1703,7 +1725,7 @@ declare function PusherSimulator(props: PropsWithSimulator): react_jsx_runtime.J
 type ServiceSchema = Hardware<{
     state: 'STOPPED' | 'STARTING' | 'RUNNING' | 'BACKOFF' | 'STOPPING' | 'EXITED' | 'FATAL' | 'UNKNOWN';
 }>;
-declare const Variants$9: HardwareVariant<ServiceSchema>;
+declare const ServiceHardwareDesc: HardwareDesc<ServiceSchema>;
 
 declare function ServiceDefault(props: HardwareWidgetProps<ServiceSchema, HardwareWidgetOptions>): react_jsx_runtime.JSX.Element;
 
@@ -1750,7 +1772,7 @@ interface TomoFlatMotionProperties extends Record<string, unknown> {
  * Hardware as exposed by Redux
  */
 type TomoFlatMotionSchema = Hardware<TomoFlatMotionProperties>;
-declare const Variants$8: HardwareVariant<TomoFlatMotionSchema>;
+declare const TomoFlatMotionHardwareDesc: HardwareDesc<TomoFlatMotionSchema>;
 
 declare function isTomoFlatMotionHardware(entity: Hardware): entity is TomoFlatMotionSchema;
 declare function useTomoFlatMotionHardware(name: string | null): TomoFlatMotionSchema | null;
@@ -1837,7 +1859,7 @@ declare function TomoFlatMotionSimulator(props: PropsWithSimulator): react_jsx_r
  */
 type TomoReferencePositionSchema = Hardware<Record<string, never>>;
 declare function isTomoReferencePositionHardware(entity: Hardware): entity is TomoReferencePositionSchema;
-declare const Variants$7: HardwareVariant<TomoReferencePositionSchema>;
+declare const TomoReferencePositionHardwareDesc: HardwareDesc<TomoReferencePositionSchema>;
 
 interface TomoReferencePositionDefaultOptions extends HardwareWidgetOptions {
     /**
@@ -1861,7 +1883,7 @@ type TomoDetectorSchema = Hardware<{
     source_distance: number | null;
     acq_mode: 'MANUAL' | 'SINGLE' | 'ACCUMULATION';
 }>;
-declare const Variants$6: HardwareVariant<TomoDetectorSchema>;
+declare const TomoDetectorHardwareDesc: HardwareDesc<TomoDetectorSchema>;
 
 declare function isTomoDetectorHardware(entity: Hardware): entity is TomoDetectorSchema;
 declare function useTomoDetectorHardware(name: string | null): TomoDetectorSchema | null;
@@ -1918,7 +1940,7 @@ type TomoDetectorsSchema = Hardware<{
     active_detector: string;
     target_detector?: string;
 }>;
-declare const Variants$5: HardwareVariant<TomoDetectorsSchema>;
+declare const TomoDetectorsHardwareDesc: HardwareDesc<TomoDetectorsSchema>;
 
 declare function isTomoDetectorsHardware(entity: Hardware): entity is TomoDetectorsSchema;
 declare function useTomoDetectorsHardware(name: string | null): TomoDetectorsSchema | null;
@@ -1954,7 +1976,7 @@ type TomoImagingSchema = Hardware<{
     exposure_time: number;
     settle_time: number;
 }>;
-declare const Variants$4: HardwareVariant<TomoImagingSchema>;
+declare const TomoImagingHardwareDesc: HardwareDesc<TomoImagingSchema>;
 
 interface TomoImagingActionsOptions extends HardwareWidgetOptions {
     /**
@@ -2016,7 +2038,7 @@ type TomoSampleStageSchema = Hardware<{
     x_axis_focal_pos: number | null;
     detector_center: [number | null, number | null];
 }>;
-declare const Variants$3: HardwareVariant<TomoSampleStageSchema>;
+declare const TomoSampleStageHardwareDesc: HardwareDesc<TomoSampleStageSchema>;
 
 declare function isTomoSampleStageHardware(entity: Hardware): entity is TomoSampleStageSchema;
 declare function useTomoSampleStageHardware(name: string | null): TomoSampleStageSchema | null;
@@ -2031,7 +2053,7 @@ type TomoConfigSchema = Hardware<{
     holotomo: string;
     latency_time: number;
 }>;
-declare const Variants$2: HardwareVariant<TomoConfigSchema>;
+declare const TomoConfigHardwareDesc: HardwareDesc<TomoConfigSchema>;
 
 declare function isTomoConfigHardware(entity: Hardware): entity is TomoConfigSchema;
 declare function useTomoConfigHardware(name: string | null): TomoConfigSchema | null;
@@ -2053,7 +2075,7 @@ type TomoHoloSchema = Hardware<{
     nb_distances: number;
     distances: TomoHoloDistance[];
 }>;
-declare const Variants$1: HardwareVariant<TomoHoloSchema>;
+declare const TomoHoloHardwareDesc: HardwareDesc<TomoHoloSchema>;
 
 declare function isTomoHoloHardware(entity: Hardware): entity is TomoHoloSchema;
 declare function useTomoHoloHardware(name: string | null): TomoHoloSchema | null;
@@ -2069,7 +2091,7 @@ type ValveSchema = Hardware<{
     state: string;
     status: string;
 }>;
-declare const Variants: HardwareVariant<ValveSchema>;
+declare const ValveHardwareDesc: HardwareDesc<ValveSchema>;
 
 declare function Valve(props: HardwareWidgetProps<ValveSchema>): react_jsx_runtime.JSX.Element;
 
@@ -2380,7 +2402,11 @@ interface YamlComponent {
     [option: string]: unknown;
 }
 
-declare function Yaml$1(props: YamlComponent): react_jsx_runtime.JSX.Element;
+interface YamlTodoOptions {
+    /** Message to display, defaults to "TODO" */
+    message?: string;
+}
+declare function Yaml$1(props: YamlComponent & YamlTodoOptions): react_jsx_runtime.JSX.Element;
 
 declare function Yaml(props: YamlComponent): react_jsx_runtime.JSX.Element;
 
@@ -2507,6 +2533,14 @@ declare function registerYamlComponent(name: string, component: ComponentType<an
  * Such components are wrapped inside a `Panel`.
  */
 declare function registerYamlComponents(map: Record<string, ComponentType<any>>): void;
+/**
+ * Get the current mapping from Yaml `type` to registered component.
+ */
+declare function getYamlComponents(): Record<string, ComponentType<any>>;
+/**
+ * Get the current mapping from Yaml `type` to registered container.
+ */
+declare function getYamlContainers(): Record<string, ComponentType<any>>;
 
 type Defined<T> = T extends undefined ? never : T;
 declare function assertKeyExpected<T>(yamlNode: YamlNode | undefined, key: string, value: T): asserts value is Defined<T>;
@@ -2583,6 +2617,112 @@ declare namespace asserts_d {
   export { type asserts_d_Schema as Schema, asserts_d_assertBoolean as assertBoolean, asserts_d_assertDataCollectionId as assertDataCollectionId, asserts_d_assertKeyExpected as assertKeyExpected, asserts_d_assertNoUnknownKeys as assertNoUnknownKeys, asserts_d_assertNumber as assertNumber, asserts_d_assertOptionalArgs as assertOptionalArgs, asserts_d_assertOptionalBackend as assertOptionalBackend, asserts_d_assertOptionalBoolean as assertOptionalBoolean, asserts_d_assertOptionalKwargs as assertOptionalKwargs, asserts_d_assertOptionalListOfType as assertOptionalListOfType, asserts_d_assertOptionalNumber as assertOptionalNumber, asserts_d_assertOptionalNumberList as assertOptionalNumberList, asserts_d_assertOptionalString as assertOptionalString, asserts_d_assertOptionalStringList as assertOptionalStringList, asserts_d_assertOptionalStringOrStringList as assertOptionalStringOrStringList, asserts_d_assertString as assertString, asserts_d_assertStringList as assertStringList, asserts_d_assertStringMappingRecord as assertStringMappingRecord };
 }
 
+interface YamlRowOptions {
+    /** Inline CSS styles applied to the row */
+    style?: Record<string, any>;
+}
+
+interface YamlColOptions {
+    /** Inline CSS styles applied to the column */
+    style?: Record<string, any>;
+    /** Bootstrap column width (1-12) */
+    xs?: number;
+}
+
+interface YamlContainerOptions {
+    /** Options spread onto the underlying Container */
+    options?: Record<string, any>;
+    /** Inline CSS styles applied to the row */
+    style?: Record<string, any>;
+}
+
+interface YamlGridOptions {
+    /** Grid panel title */
+    title?: string;
+    /** CSS grid-template-columns value */
+    columns?: string;
+    /** CSS grid-template-rows value */
+    rows?: string;
+    /** Inline CSS styles applied to the column */
+    style?: Record<string, any>;
+}
+/** Options for an individual cell within a grid. */
+interface YamlGridCellOptions {
+    /** Number of grid columns this cell spans */
+    columnSpan?: number;
+    /** Number of grid rows this cell spans */
+    rowSpan?: number;
+}
+
+interface YamlPanelOptions {
+    /** Options spread onto the underlying Panel */
+    options?: Record<string, any>;
+    /** Panel title */
+    title?: string;
+    /** Center the panel's contents */
+    centerContent?: boolean;
+    /** Inline CSS styles applied to the underlying Panel */
+    style?: Record<string, any>;
+}
+
+/** Options for an individual tab within Tabs */
+interface YamlTabsRowOptions {
+    /** Tab header */
+    title?: string;
+    /** Inline CSS styles applied to the tab's content pane */
+    style?: Record<string, any>;
+}
+interface YamlTabsOptions {
+    /** Options spread onto the underlying Panel */
+    options?: Record<string, any>;
+    /** Tabs panel title */
+    title: string;
+    /** Inline CSS styles applied to the underlying Panel */
+    style?: Record<string, any>;
+}
+
+/** A section header spanning both columns of the form grid. */
+interface YamlFormHeaderOptions {
+    type: 'formheader';
+    /** Header text */
+    title?: string;
+    /** Inline CSS styles applied to the form's content grid */
+    style?: Record<string, any>;
+}
+
+/** A single labelled row of the form, rendering its content in the second column. */
+interface YamlFormRowOptions {
+    /** Type of the node rendered in the row's content column (e.g. 'hardware') */
+    type: string;
+    /** Row title shown in the first column; for hardware rows, defaults to the hardware id's name if unset */
+    title: string;
+    /** For hardware rows, show the hardware state under the title */
+    stateinheader?: boolean;
+    /** CSS align-self applied to the title cell */
+    titlealign?: string;
+    /** Hardware id, used for the default title and passed to the rendered content node */
+    id?: string;
+    /** Hardware variant passed to the rendered content node */
+    variant?: string;
+    /** Passed through to the rendered content node */
+    options?: Record<string, any>;
+    /** Passed through to the rendered content node */
+    even: boolean;
+}
+interface YamlFormOptions {
+    /** Form panel title */
+    title?: string;
+    /** Options spread onto the underlying Panel */
+    options?: Record<string, any>;
+    /** Inline CSS styles applied to the form's content grid */
+    style?: Record<string, any>;
+}
+
+interface YamlLabelOptions {
+    /** Text to display */
+    label: string;
+}
+
 interface RuntimeHooks {
     useHardware?: (id: string | null) => AnyHardware | null;
     useHardwareChangeActions?: (name: string | null) => HardwareChangeActions;
@@ -2710,5 +2850,9 @@ declare function registerHardwareVariant(type: string, variant: string, componen
  * @param variant: Variant requested
  */
 declare function getHardwareVariantComponent(type: string, variant: string): HardwareComponentType | null;
+/**
+ * Get the full list of hardware descriptions.
+ */
+declare function getAllHardwareDesc(): Record<string, HardwareDesc<AnyHardware>>;
 
-export { type ActuatorSchema, AirBearing, Mocks$o as AirBearingMocks, AirBearingProtected, type AirBearingSchema, AirBearingSimulator, AirBearingState, Variants$s as AirBearingVariants, type AnyHardware, type AnySchema, type BaseHardware, Info as BaseInfo, type BaseInfoWidgetOptions, Mocks$p as BaseMocks, Name as BaseName, type BaseNameWidgetOptions, Property as BaseProperty, type BasePropertyWidgetOptions, DefaultState as BaseState, Variants$t as BaseVariants, Beamviewer, Mocks$n as BeamviewerMocks, type BeamviewerSchema, BeamviewerSimulator, Variants$r as BeamviewerVariants, EnergyManagerDefault, Mocks$m as EnergyManagerMocks, type EnergyManagerSchema, EnergyManagerSimulator, EnergyManagerState, Variants$q as EnergyManagerVariants, ErrorObject, type ExceptionFromProcedure, formatting_d as Formatting, Frontend, Mocks$l as FrontendMocks, type FrontendSchema, Variants$p as FrontendVariants, FullSizer, Gauge$1 as Gauge, Gauge as GaugeIndicator, Mocks$k as GaugeMocks, type GaugeSchema, Variants$o as GaugeVariants, type GaugeWidgetOptions, type GenericSchema, type Hardware, type HardwareComponentType, type HardwareFromProcedure, HardwareInputNumber, HardwareNumericStep, type HardwareObjectProps, schema_d as HardwareSchema, HardwareState, HardwareTemplate, types_d as HardwareTypes, type HardwareVariant, InfiniteKnob360, KeyError, Laser, LaserHeating, Mocks$i as LaserHeatingMocks, type LaserHeatingSchema, Variants$m as LaserHeatingVariants, type LaserHeatingWidgetOptions, Mocks$j as LaserMocks, type LaserSchema, Variants$n as LaserVariants, type LaserWidgetOptions, Light, Mocks$h as LightMocks, type LightSchema, Variants$l as LightVariants, LimaBinning, LimaDefault, TomoDetectorSize$2 as LimaDescription, TomoDetectorSize$1 as LimaImageRoi, Mocks$g as LimaMocks, type LimaSchema, LimaRoiShape as LimaShape, LimaSimulator, TomoDetectorSize as LimaSize, LimaState, LimaTransformation, Variants$k as LimaVariants, LoadingObject, MeasurementGroup as MeasurementGroupDefault, Mocks$f as MeasurementGroupMocks, type MeasurementGroupSchema, MeasurementGroupSimulator, Variants$j as MeasurementGroupVariants, MissingComponentObject, MissingKeysError, MissingObject, type Monitor, MonitorHardware, MonitorHardwareProperty, MonitorPanel, MonitorPanelItem, type MonitorPanelProps, MotorDefault, type MotorDefaultOptions, Mocks$e as MotorMocks, MotorRotation, type MotorSchema, MotorSimulator, MotorState, MotorText, Variants$i as MotorVariants, MultiState, Multiposition$1 as Multiposition, Multiposition as MultipositionDefault2, type MultipositionDefault2Options, Mocks$d as MultipositionMocks, type MultipositionSchema, MultipositionSimulator, Variants$h as MultipositionVariants, NoObject$1 as NoObject, Yaml as None, NoObject as NullObject, NumericStep, Optic as OpticDefault, Mocks$c as OpticMocks, type OpticSchema, OpticSimulator, OpticState, Variants$g as OpticVariants, type OpticWidgetOptions, Panel, ProcedureExecution, ProcedureManage, Mocks$b as ProcedureMocks, type ProcedureSchema, ProcedureState, ProcedureValidate, Variants$f as ProcedureVariants, Pump as PumpDefault, Mocks$7 as PumpMocks, type PumpSchema, Variants$b as PumpVariants, Pusher as PusherDefault, Mocks$6 as PusherMocks, type PusherOptions, type PusherSchema, PusherSimulator, PusherState, Variants$a as PusherVariants, RegulationLoop as RegulationDefault, Mocks$a as RegulationMocks, type RegulationOptions, RegulationPlot, type RegulationSchema, RegulationSimulator, Variants$e as RegulationVariants, type ScanFromProcedure, ServiceDefault, Mocks$5 as ServiceMocks, ServiceProtected, type ServiceSchema, ServiceState, Variants$9 as ServiceVariants, ShutterDefault, Mocks$9 as ShutterMocks, ShutterProtected, type ShutterSchema, ShutterSimulator, ShutterState, Variants$d as ShutterVariants, SlitDefault, Mocks$8 as SlitMocks, type SlitSchema, SlitState, Variants$c as SlitVariants, State$1 as State, Synoptic, type SynopticElementType, type SynopticType, Yaml$1 as Todo, TomoConfigLatencyTime, type TomoConfigSchema, Variants$2 as TomoConfigVariants, TomoDetectorAcquisitionMode, type TomoDetectorFieldOfViewOptions, Mocks$3 as TomoDetectorMocks, TomoDetectorSamplePixelSize, type TomoDetectorSchema, TomoDetectorState, Variants$6 as TomoDetectorVariants, TomoDetectors as TomoDetectorsDefault, Mocks$2 as TomoDetectorsMocks, type TomoDetectorsSchema, TomoDetectorsState, Variants$5 as TomoDetectorsVariants, TomoFlatMotionDefault, Mocks$4 as TomoFlatMotionMocks, type TomoFlatMotionSchema, TomoFlatMotionSimulator, TomoFlatMotionSmall, TomoFlatMotionState, type TomoFlatMotionStep, Variants$8 as TomoFlatMotionVariants, type TomoHoloDistance, type TomoHoloSchema, TomoHoloState, Variants$1 as TomoHoloVariants, TomoImagingActions, TomoImagingDefault, TomoImagingExposureTime, Mocks$1 as TomoImagingMocks, type TomoImagingOptions, type TomoImagingSchema, TomoImagingSettleTime, TomoImagingSimulator, TomoImagingState, TomoImagingUpdateMode, Variants$4 as TomoImagingVariants, TomoReferencePositionDefault, type TomoReferencePositionSchema, Variants$7 as TomoReferencePositionVariants, type TomoSampleStageSchema, Variants$3 as TomoSampleStageVariants, TypeIcon, type Props$8 as TypeIconOptions, Valve as ValveDefault, Mocks as ValveMocks, type ValveSchema, Variants as ValveVariants, ErrorBoundary as YAMLErrorBoundary, Main as YAMLLayout, asserts_d as YamlAsserts, type YamlComponent, type YamlNode, createMotorMock, dynamicOp, getHardwareVariantComponent, isLimaHardware, isMotorClockWise, isMotorHardware, isOpticHardware, isProcedureHardware, isTomoConfigHardware, isTomoDetectorHardware, isTomoDetectorsHardware, isTomoFlatMotionHardware, isTomoHoloHardware, isTomoReferencePositionHardware, isTomoSampleStageHardware, limaGuessSubframes, motorLimits, registerHardwareVariant, registerMonitorComponent, registerRuntimeHook, registerYamlComponent, registerYamlComponents, registerYamlContainer, renderYamlNode, useHardware, useHardwareChangeActions, useHardwareSchema, useLimaHardware, useMotorHardware, useMotorStates, useOperator, useProcedureHardware, useScanRunning, useTomoConfigHardware, useTomoDetectorHardware, useTomoDetectorsHardware, useTomoFlatMotionHardware, useTomoHoloHardware, useTomoSampleStageHardware, yamlComponents, yamlContainers };
+export { type ActuatorSchema, AirBearing, AirBearingHardwareDesc, Mocks$o as AirBearingMocks, AirBearingProtected, type AirBearingSchema, AirBearingSimulator, AirBearingState, type AnyHardware, type AnySchema, type BaseHardware, BaseHardwareDesc, Info as BaseInfo, type BaseInfoWidgetOptions, Mocks$p as BaseMocks, Name as BaseName, type BaseNameWidgetOptions, Property as BaseProperty, type BasePropertyWidgetOptions, DefaultState as BaseState, Beamviewer, BeamviewerHardwareDesc, Mocks$n as BeamviewerMocks, type BeamviewerSchema, BeamviewerSimulator, EnergyManagerDefault, EnergyManagerHardwareDesc, Mocks$m as EnergyManagerMocks, type EnergyManagerSchema, EnergyManagerSimulator, EnergyManagerState, ErrorObject, type ExceptionFromProcedure, formatting_d as Formatting, Frontend, FrontendHardwareDesc, Mocks$l as FrontendMocks, type FrontendSchema, FullSizer, Gauge$1 as Gauge, GaugeHardwareDesc, Gauge as GaugeIndicator, Mocks$k as GaugeMocks, type GaugeSchema, type GaugeWidgetOptions, type GenericSchema, type Hardware, type HardwareComponentType, type HardwareDesc, type HardwareFromProcedure, HardwareInputNumber, HardwareNumericStep, type HardwareObjectProps, schema_d as HardwareSchema, HardwareState, HardwareTemplate, types_d as HardwareTypes, type HardwareVariant, InfiniteKnob360, KeyError, Laser, LaserHardwareDesc, LaserHeating, LaserHeatingHardwareDesc, Mocks$i as LaserHeatingMocks, type LaserHeatingSchema, type LaserHeatingWidgetOptions, Mocks$j as LaserMocks, type LaserSchema, type LaserWidgetOptions, Light, LightHardwareDesc, Mocks$h as LightMocks, type LightSchema, LimaBinning, LimaDefault, TomoDetectorSize$2 as LimaDescription, LimaHardwareDesc, TomoDetectorSize$1 as LimaImageRoi, Mocks$g as LimaMocks, type LimaSchema, LimaRoiShape as LimaShape, LimaSimulator, TomoDetectorSize as LimaSize, LimaState, LimaTransformation, LoadingObject, MeasurementGroup as MeasurementGroupDefault, MeasurementGroupHardwareDesc, Mocks$f as MeasurementGroupMocks, type MeasurementGroupSchema, MeasurementGroupSimulator, MissingComponentObject, MissingKeysError, MissingObject, type Monitor, MonitorHardware, MonitorHardwareProperty, MonitorPanel, MonitorPanelItem, type MonitorPanelProps, MotorDefault, type MotorDefaultOptions, MotorHardwareDesc, Mocks$e as MotorMocks, MotorRotation, type MotorSchema, MotorSimulator, MotorState, MotorText, MultiState, Multiposition$1 as Multiposition, Multiposition as MultipositionDefault2, type MultipositionDefault2Options, MultipositionHardwareDesc, Mocks$d as MultipositionMocks, type MultipositionSchema, MultipositionSimulator, NoObject$1 as NoObject, Yaml as None, NoObject as NullObject, NumericStep, Optic as OpticDefault, OpticHardwareDesc, Mocks$c as OpticMocks, type OpticSchema, OpticSimulator, OpticState, type OpticWidgetOptions, Panel, ProcedureExecution, ProcedureHardwareDesc, ProcedureManage, Mocks$b as ProcedureMocks, type ProcedureSchema, ProcedureState, ProcedureValidate, Pump as PumpDefault, PumpHardwareDesc, Mocks$7 as PumpMocks, type PumpSchema, Pusher as PusherDefault, PusherHardwareDesc, Mocks$6 as PusherMocks, type PusherOptions, type PusherSchema, PusherSimulator, PusherState, RegulationLoop as RegulationDefault, RegulationHardwareDesc, Mocks$a as RegulationMocks, type RegulationOptions, RegulationPlot, type RegulationSchema, RegulationSimulator, type ScanFromProcedure, ServiceDefault, ServiceHardwareDesc, Mocks$5 as ServiceMocks, ServiceProtected, type ServiceSchema, ServiceState, ShutterDefault, ShutterHardwareDesc, Mocks$9 as ShutterMocks, ShutterProtected, type ShutterSchema, ShutterSimulator, ShutterState, SlitDefault, SlitHardwareDesc, Mocks$8 as SlitMocks, type SlitSchema, SlitState, State$1 as State, Synoptic, type SynopticElementType, type SynopticType, Yaml$1 as Todo, TomoConfigHardwareDesc, TomoConfigLatencyTime, type TomoConfigSchema, TomoDetectorAcquisitionMode, type TomoDetectorFieldOfViewOptions, TomoDetectorHardwareDesc, Mocks$3 as TomoDetectorMocks, TomoDetectorSamplePixelSize, type TomoDetectorSchema, TomoDetectorState, TomoDetectors as TomoDetectorsDefault, TomoDetectorsHardwareDesc, Mocks$2 as TomoDetectorsMocks, type TomoDetectorsSchema, TomoDetectorsState, TomoFlatMotionDefault, TomoFlatMotionHardwareDesc, Mocks$4 as TomoFlatMotionMocks, type TomoFlatMotionSchema, TomoFlatMotionSimulator, TomoFlatMotionSmall, TomoFlatMotionState, type TomoFlatMotionStep, type TomoHoloDistance, TomoHoloHardwareDesc, type TomoHoloSchema, TomoHoloState, TomoImagingActions, TomoImagingDefault, TomoImagingExposureTime, TomoImagingHardwareDesc, Mocks$1 as TomoImagingMocks, type TomoImagingOptions, type TomoImagingSchema, TomoImagingSettleTime, TomoImagingSimulator, TomoImagingState, TomoImagingUpdateMode, TomoReferencePositionDefault, TomoReferencePositionHardwareDesc, type TomoReferencePositionSchema, TomoSampleStageHardwareDesc, type TomoSampleStageSchema, TypeIcon, type Props$8 as TypeIconOptions, Valve as ValveDefault, ValveHardwareDesc, Mocks as ValveMocks, type ValveSchema, ErrorBoundary as YAMLErrorBoundary, Main as YAMLLayout, asserts_d as YamlAsserts, type YamlColOptions, type YamlComponent, type YamlContainerOptions, type YamlFormHeaderOptions, type YamlFormOptions, type YamlFormRowOptions, type YamlGridCellOptions, type YamlGridOptions, type YamlLabelOptions, type YamlNode, type YamlPanelOptions, type YamlRowOptions, type YamlTabsOptions, type YamlTabsRowOptions, type YamlTodoOptions, createMotorMock, dynamicOp, getAllHardwareDesc, getHardwareVariantComponent, getYamlComponents, getYamlContainers, isLimaHardware, isMotorClockWise, isMotorHardware, isOpticHardware, isProcedureHardware, isTomoConfigHardware, isTomoDetectorHardware, isTomoDetectorsHardware, isTomoFlatMotionHardware, isTomoHoloHardware, isTomoReferencePositionHardware, isTomoSampleStageHardware, limaGuessSubframes, motorLimits, registerHardwareVariant, registerMonitorComponent, registerRuntimeHook, registerYamlComponent, registerYamlComponents, registerYamlContainer, renderYamlNode, useHardware, useHardwareChangeActions, useHardwareSchema, useLimaHardware, useMotorHardware, useMotorStates, useOperator, useProcedureHardware, useScanRunning, useTomoConfigHardware, useTomoDetectorHardware, useTomoDetectorsHardware, useTomoFlatMotionHardware, useTomoHoloHardware, useTomoSampleStageHardware, yamlComponents, yamlContainers };