import type { EventArgumentTypes, EventValueTypes } from "./FormComponent";
import type { defs } from "./FormHost";
export { Orientation, TitleLocation } from "./constants";
export type { Text } from "./elements/types";
/**
 * Details about an event to be fired when the value property is updated.
 * If `false`, no event is fired.
 * If `true`, the event is fired with the event object just containing the element's value.
 * If an object containing `"argument"` or `"item" properties, the event is fired and those properties are included in the event object.
 */
type EventOptions = Partial<Pick<defs.Event, "argument" | "item">> | boolean;
export interface ITranslateTextFunction {
    (content: string): string;
    (content: defs.MarkdownRef | defs.StatusRef): defs.MarkdownRef;
    (content: defs.Text | undefined): string | defs.MarkdownRef | undefined;
}
/** @public */
export interface FormElementProps<TValue = undefined> extends FormElementSettableProps<TValue>, FormElementGettableProps {
    className?: string;
    enabled: boolean;
    id: string;
    name: string | undefined;
    /**
     * A callback function to raise an event. The `custom` event accepts any
     * value as the eventValue. Use the Get Form Event Data to access the event
     * data in a sub-workflow of the Display Form activity.
     * @param eventName The name of the event to raise. Currently only `custom`
     * is permitted.
     * @param eventValue The value of the event.
     */
    raiseEvent: <K extends keyof EventValueTypes>(eventName: K, eventValue: EventValueTypes[K], argument?: EventArgumentTypes[K], item?: string, cancellationToken?: PromiseLike<void>) => void;
    /**
     * Set a property on an item in the element.
     * @param property The name of the property to set.
     * @param value The new value to set.
     */
    setItemProperty: <K extends keyof FormElementItemSettableProps>(item: string, property: K, value: FormElementItemProps[K]) => void;
    /**
     * Set a property on the element.
     * @param property The name of the property to set.
     * @param value The new value to set.
     */
    setProperty: <K extends keyof FormElementSettableProps<TValue>>(property: K, value: this[K], event?: EventOptions) => void;
    /**
     * Sets the `value` property of the element. Equivalent to calling
     * `setProperty("value", value)`.
     *
     * Setting the value will raise the `change` event on the element.
     *
     * @param value The new value to set.
     */
    setValue: (value: this["value"], event?: EventOptions) => void;
}
/**
 * Properties of a Form Element that can be read via the component's properties.
 */
declare type FormElementGettableProps = Pick<defs.Element, "accessibleDescription" | "autoActivate" | "checked" | "collapsed" | "current" | "customType" | "delay" | "description" | "error" | "fileTypes" | "format" | "itemLabel" | "items" | "label" | "manualEntry" | "maxLength" | "minLength" | "orientation" | "prompt" | "readOnly" | "require" | "scanType" | "selectionMode" | "showFilter" | "showMinMaxLabels" | "showTickMarks" | "size" | "source" | "state" | "title" | "tooltip" | "type" | "wrap">;
/**
 * Properties of a Form Element that can be set using `SetProperty()`.
 * Any properties defined here can also be read via the component's properties.
 * @public
 */
export interface FormElementSettableProps<TValue = undefined> extends Pick<defs.Element, "autoActivate" | "checked" | "collapsed" | "current" | "error" | "items" | "label" | "state"> {
    /** The value of the element. */
    value: TValue;
}
/** @public */
export interface FormElementItemProps extends FormElementItemSettableProps, Pick<defs.Item, "default" | "enabled" | "index" | "label" | "styleName" | "tooltip" | "validates" | "value" | "visible"> {
}
/** @public */
declare type FormElementItemSettableProps = Pick<defs.Item, "checked">;
type SettablePropsFromProps<TProps extends FormElementProps> = Omit<TProps, keyof FormElementProps> & FormElementSettableProps<TProps["value"]>;
type Unionize<T> = T[keyof T];
/** @public */
export type PropertyChangeEvent<TSettableProps, TSetProperty> = Unionize<{
    [K in keyof Required<TSettableProps>]: {
        properties: Readonly<TSettableProps>;
        property: K;
        setProperty: TSetProperty;
    };
}>;
/** @public */
export interface FormElementRegistration<TProps extends FormElementProps<any> = FormElementProps, TSettableProps extends SettablePropsFromProps<TProps> = SettablePropsFromProps<TProps>> {
    /** The React component definition of the form element. */
    component: React.ComponentType<TProps>;
    /**
     * Generate the initial properties of the form element. This will be assigned to
     * the element properties before first render.
     */
    getInitialProperties?: () => Partial<TSettableProps>;
    /** The unique identifier of the element. */
    id: string;
    /**
     * This function will be invoked prior to updating a property of the element
     * state. It will be invoked even if the element isn't currently visible.
     *
     * @returns Either a new value, an error message, or nothing.
     */
    onPropertyChange?: (event: PropertyChangeEvent<TSettableProps, TProps["setProperty"]>) => void;
}