@esrf/daiquiri-lib 5.4.0 → 5.5.1

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;
@@ -121,15 +120,21 @@ interface HardwareDesc<H extends Hardware = Hardware> {
     monitor?: HardwareComponentType<H>;
 }
 /**
- * TODO: Add a description
+ * Props accepted by a hardware widget container
  */
 interface HardwareObjectProps {
+    /** Hardware id to bind to. */
     id: string;
     options: {
+        /** Hardware variant used for the widget container. */
         variant?: string;
+        /** Header text shown above the hardware widget. */
         header?: string;
+        /** Width, in pixels, of the widget container. */
         width?: number;
+        /** Bootstrap column width (1-12) of the widget container. */
         colWidth?: number;
+        /** If true, don't render anything when the underlying value is empty/none. */
         emptyifnone?: boolean;
     };
     propertiesSchema?: Record<string, unknown>;
@@ -1464,6 +1469,14 @@ type RegulationSchema = Hardware<{
 }>;
 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;
@@ -1480,7 +1493,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;
@@ -2395,7 +2408,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;
 
@@ -2522,6 +2539,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>;
@@ -2598,6 +2623,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;
@@ -2730,4 +2861,4 @@ declare function getHardwareVariantComponent(type: string, variant: string): Har
  */
 declare function getAllHardwareDesc(): Record<string, HardwareDesc<AnyHardware>>;
 
-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 YamlComponent, type YamlNode, createMotorMock, dynamicOp, getAllHardwareDesc, 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 };