@esrf/daiquiri-lib 5.6.0 → 5.7.1

package/dist/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { JSONSchema7 } from 'json-schema';
 import * as react from 'react';
 import react__default, { ComponentType, ReactElement, PropsWithChildren, ReactNode, ChangeEvent, KeyboardEvent, Component } from 'react';
@@ -180,7 +179,7 @@ declare namespace schema_d {
 
 declare const BaseHardwareDesc: HardwareDesc<AnySchema>;
 
-declare const Mocks$p: {
+declare const Mocks$q: {
     default: {
         response: {
             callables: never[];
@@ -282,7 +281,7 @@ declare const Mocks$p: {
     };
 };
 
-declare function DefaultState(props: HardwareWidgetProps<AnySchema>): react_jsx_runtime.JSX.Element;
+declare function DefaultState$1(props: HardwareWidgetProps<AnySchema>): react_jsx_runtime.JSX.Element;
 
 interface BaseNameWidgetOptions extends HardwareWidgetOptions {
     overrideName?: string;
@@ -328,7 +327,7 @@ declare function AirBearingState(props: {
     hardware: AirBearingSchema;
 }): react_jsx_runtime.JSX.Element;
 
-declare const Mocks$o: {
+declare const Mocks$p: {
     default: {
         callables: string[];
         id: string;
@@ -356,6 +355,14 @@ type PropsWithSimulator<P = Record<string, never>> = P & {
 
 declare function AirBearingSimulator(props: PropsWithSimulator): react_jsx_runtime.JSX.Element;
 
+/**
+ * Hardware as exposed by Redux
+ */
+type BeamlineSchema = Hardware<{
+    mdt_mode: boolean;
+}>;
+declare const BeamlineHardwareDesc: HardwareDesc<BeamlineSchema>;
+
 /**
  * Hardware as exposed by Redux
  */
@@ -374,7 +381,7 @@ declare const BeamviewerHardwareDesc: HardwareDesc<BeamviewerSchema>;
 
 declare function Beamviewer(props: HardwareWidgetProps<BeamviewerSchema>): react_jsx_runtime.JSX.Element;
 
-declare const Mocks$n: {
+declare const Mocks$o: {
     default: {
         callables: string[];
         id: string;
@@ -410,7 +417,7 @@ declare function EnergyManagerState(props: {
     hardware: EnergyManagerSchema;
 }): react_jsx_runtime.JSX.Element;
 
-declare const Mocks$m: {
+declare const Mocks$n: {
     default: {
         callables: never[];
         id: string;
@@ -430,6 +437,75 @@ declare const Mocks$m: {
 
 declare function EnergyManagerSimulator(props: PropsWithSimulator): react_jsx_runtime.JSX.Element;
 
+interface FilterDescription {
+    name: string;
+    description: string;
+    state: 'IN' | 'OUT' | 'IN_OUT' | 'MOVING' | 'UNKNOWN';
+}
+type FiltersetStateType = 'READY' | 'MOVING' | 'DISABLED' | 'UNKNOWN' | 'OFFLINE' | 'FAULT';
+type FiltersetSchema = Hardware<{
+    /**
+     * Actual state of the device.
+     *
+     * Can be READY and MOVING at the same time.
+     */
+    state: FiltersetStateType;
+    /**
+     * Human readable reason of the state
+     */
+    status?: string | null;
+    /**
+     * Actual state of the filters
+     */
+    filters: FilterDescription[];
+}>;
+declare const FiltersetHardwareDesc: HardwareDesc<FiltersetSchema>;
+
+declare function FiltersetDefault(props: HardwareWidgetProps<FiltersetSchema, HardwareWidgetOptions>): react_jsx_runtime.JSX.Element;
+
+declare function DefaultState(props: HardwareWidgetProps<FiltersetSchema>): react_jsx_runtime.JSX.Element;
+
+declare const Mocks$m: {
+    default: {
+        callables: string[];
+        id: string;
+        name: string;
+        online: boolean;
+        properties: {
+            state: string;
+            status: string;
+            filters: {
+                name: string;
+                description: string;
+                state: string;
+            }[];
+        };
+        protocol: string;
+        require_staff: boolean;
+        type: string;
+    };
+    small: {
+        callables: string[];
+        id: string;
+        name: string;
+        online: boolean;
+        properties: {
+            state: string;
+            status: string;
+            filters: {
+                name: string;
+                description: string;
+                state: string;
+            }[];
+        };
+        protocol: string;
+        require_staff: boolean;
+        type: string;
+    };
+};
+
+declare function FiltersetSimulator(props: PropsWithSimulator): react_jsx_runtime.JSX.Element;
+
 type FrontendSchema = Hardware<{
     state: string;
     status: string;
@@ -1373,6 +1449,9 @@ declare function isProcedureHardware(entity: Hardware): entity is ProcedureSchem
  */
 declare function useProcedureHardware(name: string | null): ProcedureSchema | null;
 
+declare function FinishedState(props: {
+    hardware: EditableHardware<ProcedureSchema>;
+}): react_jsx_runtime.JSX.Element;
 declare function ProcedureExecution(props: HardwareWidgetProps<ProcedureSchema>): react_jsx_runtime.JSX.Element;
 
 interface ProcedureOptions extends HardwareWidgetOptions {
@@ -1388,6 +1467,11 @@ interface ProcedureOptions extends HardwareWidgetOptions {
      */
     foreground?: boolean;
 }
+declare function Actions(props: {
+    hardware: EditableHardware<ProcedureSchema>;
+    disabled: boolean;
+    options: ProcedureOptions;
+}): react_jsx_runtime.JSX.Element;
 declare function ProcedureManage(props: HardwareWidgetProps<ProcedureSchema, ProcedureOptions>): react_jsx_runtime.JSX.Element;
 
 declare function ProcedureValidate(props: HardwareWidgetProps<ProcedureSchema>): react_jsx_runtime.JSX.Element;
@@ -2202,12 +2286,16 @@ declare function HardwareNumericStep(props: {
  *
  * If `minWidth` is pecified (in `em`) it ensure the widget width will stay the
  * same when the state change
+ *
+ * A `hardwareStatus` can be defined, which is a human readable global description
+ * of the state of the device.
  */
 declare function State$1(props: {
     state: string;
     variant: string;
     minWidth?: number;
     description?: string;
+    hardwareStatus?: string;
 }): react_jsx_runtime.JSX.Element;
 /**
  * Normalize the way to display an hardware exposing multiple states.
@@ -2215,6 +2303,7 @@ declare function State$1(props: {
  * - `states` is the states exposed by the hardware.
  * - `variants` contains a variant for each of this states, else `fatal` is used.
  * - `descriptions` can be provided to add a description to the state.
+ * - `hardwareStatus` A global description of the state of the device
  *
  * If `minWidth` is pecified (in `em`) it ensure the widget width will stay the
  * same when the state change
@@ -2224,6 +2313,7 @@ declare function MultiState(props: {
     variants?: Record<string, string>;
     descriptions?: Record<string, string>;
     minWidth?: number;
+    hardwareStatus?: string;
 }): react_jsx_runtime.JSX.Element;
 
 declare function formatEng(scalar: number): {
@@ -2863,7 +2953,7 @@ interface MonitorPanelItemProps {
  *              OverlayTrigger. It contains callbacks.
  */
 declare const MonitorPanelItem: react.ForwardRefExoticComponent<MonitorPanelItemProps & {
-    children?: react.ReactNode;
+    children?: react.ReactNode | undefined;
 } & react.RefAttributes<HTMLDivElement>>;
 
 /**
@@ -2896,4 +2986,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, COMPARATORS, 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$a 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, getAllMonitors, getHardwareVariantComponent, getYamlComponents, getYamlContainers, isLimaHardware, isMotorClockWise, isMotorHardware, isOpticHardware, isProcedureHardware, isTomoConfigHardware, isTomoDetectorHardware, isTomoDetectorsHardware, isTomoFlatMotionHardware, isTomoHoloHardware, isTomoReferencePositionHardware, isTomoSampleStageHardware, limaGuessSubframes, motorLimits, normalizeId, 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$p as AirBearingMocks, AirBearingProtected, type AirBearingSchema, AirBearingSimulator, AirBearingState, type AnyHardware, type AnySchema, type BaseHardware, BaseHardwareDesc, Info as BaseInfo, type BaseInfoWidgetOptions, Mocks$q as BaseMocks, Name as BaseName, type BaseNameWidgetOptions, Property as BaseProperty, type BasePropertyWidgetOptions, DefaultState$1 as BaseState, BeamlineHardwareDesc, Beamviewer, BeamviewerHardwareDesc, Mocks$o as BeamviewerMocks, type BeamviewerSchema, BeamviewerSimulator, COMPARATORS, EnergyManagerDefault, EnergyManagerHardwareDesc, Mocks$n as EnergyManagerMocks, type EnergyManagerSchema, EnergyManagerSimulator, EnergyManagerState, ErrorObject, type ExceptionFromProcedure, FiltersetDefault, FiltersetHardwareDesc, Mocks$m as FiltersetMocks, type FiltersetSchema, FiltersetSimulator, DefaultState as FiltersetState, 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, Actions as ProcedureActions, ProcedureExecution, FinishedState as ProcedureFinishedState, ProcedureHardwareDesc, ProcedureManage, Mocks$b as ProcedureMocks, type ProcedureOptions, 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$a 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, getAllMonitors, getHardwareVariantComponent, getYamlComponents, getYamlContainers, isLimaHardware, isMotorClockWise, isMotorHardware, isOpticHardware, isProcedureHardware, isTomoConfigHardware, isTomoDetectorHardware, isTomoDetectorsHardware, isTomoFlatMotionHardware, isTomoHoloHardware, isTomoReferencePositionHardware, isTomoSampleStageHardware, limaGuessSubframes, motorLimits, normalizeId, registerHardwareVariant, registerMonitorComponent, registerRuntimeHook, registerYamlComponent, registerYamlComponents, registerYamlContainer, renderYamlNode, useHardware, useHardwareChangeActions, useHardwareSchema, useLimaHardware, useMotorHardware, useMotorStates, useOperator, useProcedureHardware, useScanRunning, useTomoConfigHardware, useTomoDetectorHardware, useTomoDetectorsHardware, useTomoFlatMotionHardware, useTomoHoloHardware, useTomoSampleStageHardware, yamlComponents, yamlContainers };