@esrf/daiquiri-lib 3.0.1 → 4.0.1

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { JSONSchema7 } from 'json-schema';
 import * as React$1 from 'react';
 import React__default, { ComponentType, ReactElement, PropsWithChildren, ReactNode, ChangeEvent, KeyboardEvent, Component } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
@@ -10,28 +11,8 @@ interface HardwareError {
     traceback: string;
 }
 interface HardwareSchemaDescription {
-    properties: {
-        additionalProperties?: boolean;
-        properties: {
-            [property: string]: any;
-        };
-        type: string;
-        uischema: {
-            position: [Record<string, unknown>];
-        };
-        uiorder?: string[];
-    };
-    callables: {
-        additionalProperties?: boolean;
-        properties: {
-            [property: string]: any;
-        };
-        type: string;
-        uischema: {
-            position: [Record<string, unknown>];
-        };
-        uiorder?: string[];
-    };
+    properties: JSONSchema7;
+    callables: JSONSchema7;
 }
 interface BaseHardware<O = boolean, P extends Record<string, any> = Record<string, never>> {
     /** Object name */
@@ -87,8 +68,6 @@ type EditableHardware<H extends Hardware = Hardware> = H & {
 interface HardwareWidgetProps<H extends Hardware = Hardware, O extends HardwareWidgetOptions = HardwareWidgetOptions> {
     /** Dynamic state of the hardware */
     hardware: EditableHardware<H>;
-    /** Static schema describing the hardware */
-    schema: HardwareSchemaDescription;
     /** Options passed to the widget by the yaml configuration */
     options: O;
     /** Global state of the widget (aggregating scan/operator/hardware states) */
@@ -1034,11 +1013,11 @@ type MultipositionSchema = Hardware<{
     position: string;
     positions: {
         position: string;
-        description: string;
+        description?: string;
         target: {
-            axis: string;
-            destination: number;
-            tolerance: number;
+            object: string;
+            destination: number | string;
+            tolerance?: number;
         }[];
     }[];
     state: string;
@@ -1189,8 +1168,6 @@ interface HardwareFromProcedure {
 }
 interface ScanFromProcedure {
     __type__: 'scan';
-    mmh3: number;
-    node?: string;
     key?: string;
 }
 interface ExceptionFromProcedure {
@@ -1490,7 +1467,7 @@ interface TomoFlatMotionStep {
     relative_position: number | null;
 }
 interface TomoFlatMotionProperties extends Record<string, unknown> {
-    state: 'READY';
+    state: 'READY' | 'IN' | 'OUT' | 'MOVING_IN' | 'MOVING_OUT' | 'UNKNOWN';
     available_axes: string[];
     motion: TomoFlatMotionStep[];
     move_in_parallel: boolean;
@@ -1590,7 +1567,13 @@ type TomoReferencePositionSchema = Hardware<Record<string, never>>;
 declare function isTomoReferencePositionHardware(entity: Hardware): entity is TomoReferencePositionSchema;
 declare const Variants$7: HardwareVariant<TomoReferencePositionSchema>;
 
-declare function TomoReferencePositionDefault(props: HardwareWidgetProps<TomoReferencePositionSchema>): react_jsx_runtime.JSX.Element;
+interface TomoReferencePositionDefaultOptions extends HardwareWidgetOptions {
+    /**
+     * If defined, this label is displayed in the button.
+     */
+    label?: string;
+}
+declare function TomoReferencePositionDefault(props: HardwareWidgetProps<TomoReferencePositionSchema, TomoReferencePositionDefaultOptions>): react_jsx_runtime.JSX.Element;
 
 /**
  * Hardware as exposed by Redux
@@ -1687,7 +1670,13 @@ type TomoImagingSchema = Hardware<{
 }>;
 declare const Variants$4: HardwareVariant<TomoImagingSchema>;
 
-declare function TomoImagingActions(props: HardwareWidgetProps<TomoImagingSchema>): react_jsx_runtime.JSX.Element;
+interface TomoImagingActionsOptions extends HardwareWidgetOptions {
+    /**
+     * If true, the default, the sample location is restored after the action.
+     */
+    restore_sample?: boolean;
+}
+declare function TomoImagingActions(props: HardwareWidgetProps<TomoImagingSchema, TomoImagingActionsOptions>): react_jsx_runtime.JSX.Element;
 
 declare function TomoImagingDefault(props: HardwareWidgetProps<TomoImagingSchema>): react_jsx_runtime.JSX.Element;
 
@@ -2257,6 +2246,7 @@ declare function assertOptionalStringOrStringList(yamlNode: YamlNode, key: strin
 declare function assertOptionalStringList(yamlNode: YamlNode, key: string, value: unknown): asserts value is string[] | undefined;
 declare function assertOptionalNumber(yamlNode: YamlNode, key: string, value: unknown): asserts value is number | undefined;
 declare function assertOptionalNumberList(yamlNode: YamlNode, key: string, value: unknown): asserts value is string[] | undefined;
+declare function assertOptionalListOfType<Y>(yamlNode: YamlNode, key: string, value: unknown, isType: (value: Y) => boolean, typeName: string): asserts value is Y[] | undefined;
 declare function assertNoUnknownKeys(yamlNode: YamlNode | undefined, remainingContent: Record<string, any>): void;
 declare function assertDataCollectionId(yamlNode: YamlNode, key: string, value: unknown): asserts value is number | 'last';
 declare function assertOptionalBackend(yamlNode: YamlNode, key: string, value: unknown): asserts value is 'plotly' | 'h5web' | undefined;
@@ -2268,6 +2258,7 @@ declare const asserts_d_assertNoUnknownKeys: typeof assertNoUnknownKeys;
 declare const asserts_d_assertNumber: typeof assertNumber;
 declare const asserts_d_assertOptionalBackend: typeof assertOptionalBackend;
 declare const asserts_d_assertOptionalBoolean: typeof assertOptionalBoolean;
+declare const asserts_d_assertOptionalListOfType: typeof assertOptionalListOfType;
 declare const asserts_d_assertOptionalNumber: typeof assertOptionalNumber;
 declare const asserts_d_assertOptionalNumberList: typeof assertOptionalNumberList;
 declare const asserts_d_assertOptionalString: typeof assertOptionalString;
@@ -2276,14 +2267,55 @@ declare const asserts_d_assertOptionalStringOrStringList: typeof assertOptionalS
 declare const asserts_d_assertString: typeof assertString;
 declare const asserts_d_assertStringList: typeof assertStringList;
 declare namespace asserts_d {
-  export { 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_assertOptionalBackend as assertOptionalBackend, asserts_d_assertOptionalBoolean as assertOptionalBoolean, 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 };
+  export { 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_assertOptionalBackend as assertOptionalBackend, asserts_d_assertOptionalBoolean as assertOptionalBoolean, 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 };
 }
 
 interface RuntimeHooks {
     useHardware?: (id: string | null) => AnyHardware | null;
     useHardwareChangeActions?: (name: string | null) => HardwareChangeActions;
+    useHardwareSchema?: (hardware: {
+        id: string;
+        type: string;
+    } | null) => HardwareSchemaDescription | null;
+    useOperator?: () => boolean;
+    useScanRunning?: () => boolean;
 }
 declare function registerRuntimeHook(hooks: Partial<RuntimeHooks>): void;
+/**
+ * Return a hardware from it's hardware name.
+ *
+ * Return `null` if the name refers to nothing.
+ *
+ * @param name: An hardware identifier, or null
+ */
+declare function useHardware(id: string | null): AnyHardware | null;
+/**
+ * Expose the generic actions provided by a specific hardware.
+ *
+ * If null is passed, dummy actions are exposed.
+ *
+ * @param name: Am hardware identifier, or null
+ */
+declare function useHardwareChangeActions(name: string | null): HardwareChangeActions;
+/**
+ * Expose the generic actions provided by a specific hardware.
+ *
+ * If null is passed, dummy actions are exposed.
+ *
+ * @param name: Am hardware identifier, or null
+ */
+declare function useHardwareSchema(hardware: {
+    id: string;
+    type: string;
+} | null): HardwareSchemaDescription | null;
+/**
+ * True if the actual user can control the beamline (like moving motors)
+ */
+declare function useOperator(): boolean;
+/**
+ * True if a scan is actually running
+ */
+declare function useScanRunning(): boolean;
 
 interface HardwareObjectProps {
     id: string;
@@ -2297,16 +2329,10 @@ interface HardwareObjectProps {
     propertiesSchema?: Record<string, unknown>;
     callablesSchema?: Record<string, unknown>;
 }
-interface ResolvedHardwareObjectProps extends HardwareObjectProps {
-    operator?: boolean;
-    runningScan?: boolean;
-    obj: Hardware | null;
-}
 
 type HardwareObject_d_HardwareObjectProps = HardwareObjectProps;
-type HardwareObject_d_ResolvedHardwareObjectProps = ResolvedHardwareObjectProps;
 declare namespace HardwareObject_d {
-  export type { HardwareObject_d_HardwareObjectProps as HardwareObjectProps, HardwareObject_d_ResolvedHardwareObjectProps as ResolvedHardwareObjectProps };
+  export type { HardwareObject_d_HardwareObjectProps as HardwareObjectProps };
 }
 
 /**
@@ -2340,4 +2366,4 @@ interface MonitorPanelItemProps {
 }
 declare function MonitorPanelItem(props: PropsWithChildren<MonitorPanelItemProps>): react_jsx_runtime.JSX.Element;
 
-export { type ActuatorSchema, AirBearing, Mocks$l as AirBearingMocks, AirBearingProtected, type AirBearingSchema, AirBearingSimulator, AirBearingState, Variants$p as AirBearingVariants, type AnyHardware, type AnySchema, type BaseHardware, Info as BaseInfo, type BaseInfoWidgetOptions, Mocks$m as BaseMocks, Name as BaseName, type BaseNameWidgetOptions, Property as BaseProperty, type BasePropertyWidgetOptions, DefaultState as BaseState, Variants$q as BaseVariants, ErrorObject, type ExceptionFromProcedure, formatting_d as Formatting, Frontend, Mocks$k as FrontendMocks, type FrontendSchema, Variants$o as FrontendVariants, FullSizer, Gauge, Mocks$j as GaugeMocks, type GaugeSchema, Variants$n as GaugeVariants, type GaugeWidgetOptions, type GenericSchema, HardwareObject_d as HWObject, type Hardware, type HardwareComponentType, type HardwareFromProcedure, HardwareInputNumber, HardwareNumericStep, schema_d as HardwareSchema, State_d as HardwareState, HardwareTemplate, types_d as HardwareTypes, type HardwareVariant, KeyError, Laser, LaserHeating, Mocks$h as LaserHeatingMocks, type LaserHeatingSchema, Variants$l as LaserHeatingVariants, type LaserHeatingWidgetOptions, Mocks$i as LaserMocks, type LaserSchema, Variants$m as LaserVariants, type LaserWidgetOptions, Light, Mocks$g as LightMocks, type LightSchema, Variants$k as LightVariants, LimaBinning, LimaDefault, TomoDetectorSize$2 as LimaDescription, TomoDetectorSize$1 as LimaImageRoi, Mocks$f as LimaMocks, type LimaSchema, LimaRoiShape as LimaShape, LimaSimulator, TomoDetectorSize as LimaSize, LimaState, LimaTransformation, Variants$j as LimaVariants, LoadingObject, MeasurementGroup as MeasurementGroupDefault, Mocks$e as MeasurementGroupMocks, type MeasurementGroupSchema, MeasurementGroupSimulator, Variants$i as MeasurementGroupVariants, MissingComponentObject, MissingKeysError, MissingObject, type Monitor, MonitorHardware, MonitorPanel, MonitorPanelItem, type MonitorPanelProps, MotorDefault, type MotorDefaultOptions, Mocks$d as MotorMocks, type MotorSchema, MotorSimulator, MotorState, MotorText, Variants$h as MotorVariants, Multiposition, Mocks$c as MultipositionMocks, type MultipositionSchema, MultipositionSimulator, Variants$g as MultipositionVariants, NoObject$1 as NoObject, Yaml as None, NoObject as NullObject, NumericStep, Optic as OpticDefault, Mocks$b as OpticMocks, type OpticSchema, OpticSimulator, OpticState, Variants$f as OpticVariants, type OpticWidgetOptions, Panel, ProcedureExecution, ProcedureManage, Mocks$a as ProcedureMocks, type ProcedureSchema, ProcedureState, ProcedureValidate, Variants$e as ProcedureVariants, Pump as PumpDefault, Mocks$7 as PumpMocks, type PumpSchema, Variants$b as PumpVariants, Pusher as PusherDefault, Mocks$6 as PusherMocks, type PusherSchema, PusherSimulator, PusherState, Variants$a as PusherVariants, 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, Yaml$1 as Todo, TomoConfigLatencyTime, type TomoConfigSchema, Variants$2 as TomoConfigVariants, TomoDetectorAcquisitionMode, 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 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$b 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$1 as YamlComponent, type YamlNode, componentMap, createMotorMock, dynamicOp, isLimaHardware, isMotorHardware, isOpticHardware, isProcedureHardware, isTomoConfigHardware, isTomoDetectorHardware, isTomoDetectorsHardware, isTomoFlatMotionHardware, isTomoHoloHardware, isTomoReferencePositionHardware, isTomoSampleStageHardware, limaGuessSubframes, registerHardwareComponent, registerMonitorComponent, registerRuntimeHook, registerComponent as registerYamlComponent, registerComponents as registerYamlComponents, registerYamlType, renderYamlNode, useLimaHardware, useMotorHardware, useMotorStates, useProcedureHardware, useTomoConfigHardware, useTomoDetectorHardware, useTomoDetectorsHardware, useTomoFlatMotionHardware, useTomoHoloHardware, useTomoSampleStageHardware, yamlContainers, yamlMap };
+export { type ActuatorSchema, AirBearing, Mocks$l as AirBearingMocks, AirBearingProtected, type AirBearingSchema, AirBearingSimulator, AirBearingState, Variants$p as AirBearingVariants, type AnyHardware, type AnySchema, type BaseHardware, Info as BaseInfo, type BaseInfoWidgetOptions, Mocks$m as BaseMocks, Name as BaseName, type BaseNameWidgetOptions, Property as BaseProperty, type BasePropertyWidgetOptions, DefaultState as BaseState, Variants$q as BaseVariants, ErrorObject, type ExceptionFromProcedure, formatting_d as Formatting, Frontend, Mocks$k as FrontendMocks, type FrontendSchema, Variants$o as FrontendVariants, FullSizer, Gauge, Mocks$j as GaugeMocks, type GaugeSchema, Variants$n as GaugeVariants, type GaugeWidgetOptions, type GenericSchema, HardwareObject_d as HWObject, type Hardware, type HardwareComponentType, type HardwareFromProcedure, HardwareInputNumber, HardwareNumericStep, schema_d as HardwareSchema, State_d as HardwareState, HardwareTemplate, types_d as HardwareTypes, type HardwareVariant, KeyError, Laser, LaserHeating, Mocks$h as LaserHeatingMocks, type LaserHeatingSchema, Variants$l as LaserHeatingVariants, type LaserHeatingWidgetOptions, Mocks$i as LaserMocks, type LaserSchema, Variants$m as LaserVariants, type LaserWidgetOptions, Light, Mocks$g as LightMocks, type LightSchema, Variants$k as LightVariants, LimaBinning, LimaDefault, TomoDetectorSize$2 as LimaDescription, TomoDetectorSize$1 as LimaImageRoi, Mocks$f as LimaMocks, type LimaSchema, LimaRoiShape as LimaShape, LimaSimulator, TomoDetectorSize as LimaSize, LimaState, LimaTransformation, Variants$j as LimaVariants, LoadingObject, MeasurementGroup as MeasurementGroupDefault, Mocks$e as MeasurementGroupMocks, type MeasurementGroupSchema, MeasurementGroupSimulator, Variants$i as MeasurementGroupVariants, MissingComponentObject, MissingKeysError, MissingObject, type Monitor, MonitorHardware, MonitorPanel, MonitorPanelItem, type MonitorPanelProps, MotorDefault, type MotorDefaultOptions, Mocks$d as MotorMocks, type MotorSchema, MotorSimulator, MotorState, MotorText, Variants$h as MotorVariants, Multiposition, Mocks$c as MultipositionMocks, type MultipositionSchema, MultipositionSimulator, Variants$g as MultipositionVariants, NoObject$1 as NoObject, Yaml as None, NoObject as NullObject, NumericStep, Optic as OpticDefault, Mocks$b as OpticMocks, type OpticSchema, OpticSimulator, OpticState, Variants$f as OpticVariants, type OpticWidgetOptions, Panel, ProcedureExecution, ProcedureManage, Mocks$a as ProcedureMocks, type ProcedureSchema, ProcedureState, ProcedureValidate, Variants$e as ProcedureVariants, Pump as PumpDefault, Mocks$7 as PumpMocks, type PumpSchema, Variants$b as PumpVariants, Pusher as PusherDefault, Mocks$6 as PusherMocks, type PusherSchema, PusherSimulator, PusherState, Variants$a as PusherVariants, 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, Yaml$1 as Todo, TomoConfigLatencyTime, type TomoConfigSchema, Variants$2 as TomoConfigVariants, TomoDetectorAcquisitionMode, 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 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$b 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$1 as YamlComponent, type YamlNode, componentMap, createMotorMock, dynamicOp, isLimaHardware, isMotorHardware, isOpticHardware, isProcedureHardware, isTomoConfigHardware, isTomoDetectorHardware, isTomoDetectorsHardware, isTomoFlatMotionHardware, isTomoHoloHardware, isTomoReferencePositionHardware, isTomoSampleStageHardware, limaGuessSubframes, registerHardwareComponent, registerMonitorComponent, registerRuntimeHook, registerComponent as registerYamlComponent, registerComponents as registerYamlComponents, registerYamlType, renderYamlNode, useHardware, useHardwareChangeActions, useHardwareSchema, useLimaHardware, useMotorHardware, useMotorStates, useOperator, useProcedureHardware, useScanRunning, useTomoConfigHardware, useTomoDetectorHardware, useTomoDetectorsHardware, useTomoFlatMotionHardware, useTomoHoloHardware, useTomoSampleStageHardware, yamlContainers, yamlMap };