@esrf/daiquiri-lib 0.0.2-alpha.4 → 0.0.2-alpha.6

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import * as react from 'react';
-import { ReactElement, PropsWithChildren, ReactChild, ChangeEvent, KeyboardEvent } from 'react';
+import { ReactElement, Component, ComponentType, PropsWithChildren, ReactChild, ChangeEvent, KeyboardEvent } from 'react';
 
 interface HardwareError {
     property: string;
@@ -229,7 +229,7 @@ declare function Property(props: HardwareWidgetProps<GenericSchema, PropertyWidg
 
 declare function ShutterDefault(props: HardwareWidgetProps<ShutterSchema, HardwareWidgetOptions>): JSX.Element;
 
-interface Props$3 {
+interface Props$4 {
     online: boolean;
     activeMessage?: string;
     inactiveMessage?: string;
@@ -237,9 +237,9 @@ interface Props$3 {
     icon: string;
     name: string;
 }
-declare function TypeIcon(props: Props$3): JSX.Element;
+declare function TypeIcon(props: Props$4): JSX.Element;
 
-interface Props$2 {
+interface Props$3 {
     hardware: Hardware;
     headerMode?: string;
     widgetIcon: ReactElement;
@@ -250,7 +250,7 @@ interface Props$2 {
  * Normalized way to compose hardware component in order to provide the same
  * kind of layout
  */
-declare function HardwareTemplate(props: Props$2): JSX.Element;
+declare function HardwareTemplate(props: Props$3): JSX.Element;
 
 /**
  * Input number synchronized with a hardware.
@@ -355,12 +355,24 @@ declare namespace formatting_d {
   export { formatting_d_formatEng as formatEng, formatting_d_round as round, formatting_d_toEnergy as toEnergy, formatting_d_toHoursMins as toHoursMins, formatting_d_ucfirst as ucfirst };
 }
 
-interface Props$1 {
+interface HardwareVariantOptions {
+    options: {
+        variant: string;
+    };
+}
+declare class HardwareVariant extends Component<HardwareVariantOptions, void> {
+    variants: {
+        [name: string]: ComponentType<any>;
+    };
+    render(): JSX.Element;
+}
+
+interface Props$2 {
     className?: string;
 }
-declare function FullSizer(props: PropsWithChildren<Props$1>): JSX.Element;
+declare function FullSizer(props: PropsWithChildren<Props$2>): JSX.Element;
 
-interface Props {
+interface Props$1 {
     step?: number;
     steps?: number[];
     disabled: boolean;
@@ -382,6 +394,119 @@ interface Props {
     }) => void;
     onKeyDown?: (e: KeyboardEvent<HTMLInputElement>) => void;
 }
-declare const NumericStep: react.ForwardRefExoticComponent<Props & react.RefAttributes<HTMLInputElement>>;
+declare const NumericStep: react.ForwardRefExoticComponent<Props$1 & react.RefAttributes<HTMLInputElement>>;
+
+interface YamlNode {
+    type: string;
+    children?: YamlNode[];
+    _parentNode: YamlNode | null;
+    _indexFromParent: number | null;
+}
+interface YamlRoot extends YamlNode {
+    name: string;
+    error: string;
+}
+interface YamlComponent {
+    providers?: Record<string, any>;
+    yamlNode: YamlNode;
+    [option: string]: unknown;
+}
+
+declare function registerComponent(name: string, component: React.ComponentType<any>): void;
+
+interface Props {
+    id: string;
+    layout: YamlRoot;
+    className?: string;
+}
+declare function Main(props: Props): JSX.Element;
+
+/**
+ * Register the Yaml type with the component used to render this Yaml node.
+ */
+declare function registerYamlType(name: string, component: React.ComponentType<any>): void;
+declare class LayoutError extends Error {
+    readonly yamlNode: YamlNode;
+    constructor(message: string, yamlNode: YamlNode);
+}
+declare class MissingKeysError extends LayoutError {
+    readonly keys: string[];
+    constructor(yamlNode: YamlNode, missingKeys: string[]);
+}
+declare class KeyError extends LayoutError {
+    readonly key: string;
+    readonly keyMessage: string;
+    constructor(yamlNode: YamlNode, key: string, message: string);
+}
+
+declare type Defined<T> = T extends undefined ? never : T;
+declare function assertKeyExpected<T>(yamlNode: YamlNode | undefined, key: string, value: T): asserts value is Defined<T>;
+declare function assertString(yamlNode: YamlNode, key: string, value: any): asserts value is string;
+declare function assertBoolean(yamlNode: YamlNode, key: string, value: unknown): asserts value is boolean;
+declare function assertNumber(yamlNode: YamlNode, key: string, value: unknown): asserts value is number;
+declare function assertOptionalBoolean(yamlNode: YamlNode, key: string, value: unknown): asserts value is boolean | undefined;
+declare function assertOptionalString(yamlNode: YamlNode, key: string, value: unknown): asserts value is string | undefined;
+declare function assertStringList(yamlNode: YamlNode, key: string, value: unknown): asserts value is string[];
+declare function assertOptionalStringOrStringList(yamlNode: YamlNode, key: string, value: unknown): asserts value is string | string[] | undefined;
+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 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;
+
+declare const asserts_d_assertBoolean: typeof assertBoolean;
+declare const asserts_d_assertDataCollectionId: typeof assertDataCollectionId;
+declare const asserts_d_assertKeyExpected: typeof assertKeyExpected;
+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_assertOptionalNumber: typeof assertOptionalNumber;
+declare const asserts_d_assertOptionalNumberList: typeof assertOptionalNumberList;
+declare const asserts_d_assertOptionalString: typeof assertOptionalString;
+declare const asserts_d_assertOptionalStringList: typeof assertOptionalStringList;
+declare const asserts_d_assertOptionalStringOrStringList: typeof assertOptionalStringOrStringList;
+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 };
+}
+
+interface HardwareObjectProps {
+    id: string;
+    actions: {
+        requestChange: (data: any) => void;
+        addToast: (data: any) => void;
+    };
+    options: {
+        variant?: string;
+        header?: string;
+        width?: number;
+        colWidth?: number;
+        emptyifnone?: boolean;
+    };
+    propertiesSchema?: Record<string, unknown>;
+    callablesSchema?: Record<string, unknown>;
+}
+interface ResolvedHardwareObjectProps extends HardwareObjectProps {
+    operator?: boolean;
+    obj: Hardware | null;
+}
+interface ComponentMapping {
+    [name: string]: ComponentType<any> | typeof HardwareVariant;
+}
+
+type HardwareObject_d_ComponentMapping = ComponentMapping;
+type HardwareObject_d_HardwareObjectProps = HardwareObjectProps;
+type HardwareObject_d_ResolvedHardwareObjectProps = ResolvedHardwareObjectProps;
+declare namespace HardwareObject_d {
+  export type { HardwareObject_d_ComponentMapping as ComponentMapping, HardwareObject_d_HardwareObjectProps as HardwareObjectProps, HardwareObject_d_ResolvedHardwareObjectProps as ResolvedHardwareObjectProps };
+}
+
+/**
+ * Register the Yaml type with the component used to render this Yaml node.
+ */
+declare function registerHardwareComponent(name: string, component: React.ComponentType<any>): void;
 
-export { formatting_d as Formatting, Frontend, FullSizer, HardwareInputNumber, HardwareNumericStep, schema_d as HardwareSchema, State_d as HardwareState, HardwareTemplate, types_d as HardwareTypes, Info, MotorDefault, type MotorDefaultOptions, Multiposition, NoObject, NumericStep, Property, ShutterDefault, TypeIcon };
+export { formatting_d as Formatting, Frontend, FullSizer, HardwareObject_d as HWObject, HardwareInputNumber, HardwareNumericStep, schema_d as HardwareSchema, State_d as HardwareState, HardwareTemplate, types_d as HardwareTypes, HardwareVariant, Info, KeyError, MissingKeysError, MotorDefault, type MotorDefaultOptions, Multiposition, NoObject, NumericStep, Property, ShutterDefault, TypeIcon, Main as YAMLLayout, asserts_d as YamlAsserts, type YamlComponent, type YamlNode, registerHardwareComponent, registerComponent as registerYamlComponent, registerYamlType };