@homebound/beam 3.86.0 → 3.87.0

package/dist/index.d.cts

@@ -4888,6 +4888,8 @@ interface BeamTextFieldProps<X> extends BeamFocusableProps, PresentationFieldPro
     /** Marks the field as required or optional, the default is assumed ambiguous/unknown. */
     required?: boolean;
     value: string | undefined;
+    /** Value proposed by an AI model; puts the field in AI mode. */
+    proposedValue?: string;
     /** Handler called when the interactive element state changes. */
     onChange: (value: string | undefined) => void;
     /** Called when the component loses focus, mostly for BoundTextField to use. */
@@ -7916,6 +7918,14 @@ type TextFieldBaseProps<X> = {
     hideErrorMessage?: boolean;
     alwaysShowHelperText?: boolean;
     unfocusedPlaceholder?: ReactNode;
+    /** Value proposed by an AI model; puts the field in AI mode. Pre-formatted for display. */
+    proposedValue?: string;
+    /** The formatted value on record, rendered struck through beside the input. Independent of `proposedValue`. */
+    originalValue?: string;
+    /** Called on any edit the user makes, so the owning field can end AI mode. */
+    onUserEdit?: VoidFunction;
+    /** Called when the user leaves the field, so the owning field can retire the struck-through original. */
+    onUserBlur?: VoidFunction;
     /** Allow focusing without selecting, i.e. to let the user keep typing after we've pre-filled text + called focus, like the Add New component. */
     selectOnFocus?: boolean;
 } & Pick<BeamTextFieldProps<X>, "label" | "required" | "errorMsg" | "errorInTooltip" | "onBlur" | "onFocus" | "helperText" | "labelStyle" | "placeholder" | "compact" | "borderless" | "borderOnHover" | "visuallyDisabled" | "fullWidth" | "xss" | "inputStylePalette"> & Partial<Pick<BeamTextFieldProps<X>, "onChange">>;
@@ -7958,7 +7968,7 @@ type AutocompleteProps<T> = {
         value: Value;
         reason: string;
     })[];
-} & Pick<PresentationFieldProps, "labelStyle"> & Pick<TextFieldBaseProps<any>, "label" | "clearable" | "startAdornment" | "fullWidth">;
+} & Pick<PresentationFieldProps, "labelStyle"> & Pick<TextFieldBaseProps<any>, "label" | "clearable" | "startAdornment" | "fullWidth" | "proposedValue">;
 declare function Autocomplete<T extends object>(props: AutocompleteProps<T>): JSX.Element;
 
 interface CheckboxProps {
@@ -8095,11 +8105,15 @@ type DateFieldCommonProps = Pick<TextFieldBaseProps<Properties>, "borderless" |
     /** Render header that skips years in addition to months */
     useYearPicker?: boolean;
 };
-type DateFieldProps = DateFieldCommonProps & {
+/** Value proposed by an AI model; puts the field in AI mode. */
+type ProposedValue<V> = {
+    proposedValue?: V;
+};
+type DateFieldProps = DateFieldCommonProps & ProposedValue<PlainDate> & {
     value: PlainDate | undefined;
     onChange: (value: PlainDate | undefined) => void;
 };
-type DateRangeFieldProps = DateFieldCommonProps & {
+type DateRangeFieldProps = DateFieldCommonProps & ProposedValue<DateRange> & {
     value: DateRange | undefined;
     onChange: (value: DateRange | undefined) => void;
 };
@@ -8130,6 +8144,8 @@ type ComboBoxBaseProps<O, V extends Value> = {
     getOptionLabel: (opt: O) => string;
     /** The current value; it can be `undefined`, even if `V` cannot be. */
     values: V[] | undefined;
+    /** Values proposed by an AI model; puts the field in AI mode. */
+    proposedValues?: V[];
     onSelect: (values: V[], opts: O[]) => void;
     multiselect?: boolean;
     disabledOptions?: (V | {
@@ -8236,6 +8252,8 @@ interface NumberFieldProps extends Pick<PresentationFieldProps, "labelStyle" | "
     /** If set, the label will be defined as 'aria-label` on the input element */
     type?: NumberFieldType;
     value: number | undefined;
+    /** Value proposed by an AI model; puts the field in AI mode. */
+    proposedValue?: number;
     onChange: (value: number | undefined) => void;
     compact?: boolean;
     clearable?: boolean;
@@ -8406,13 +8424,15 @@ declare function SelectCardGroup<V extends Value>(props: SelectCardGroupProps<V>
 type SelectFieldProps<O, V extends Value> = {
     /** The current value; it can be `undefined`, even if `V` cannot be. */
     value: V | undefined;
+    /** Value proposed by an AI model; puts the field in AI mode. */
+    proposedValue?: V;
     /**
      * Called when a value is selected, or `undefined` if `unsetLabel` is being used.
      *
      * Ideally callers that didn't pass `unsetLabel` would not have to handle the ` | undefined` here.
      */
     onSelect: (value: V | undefined, opt: O | undefined) => void;
-} & Omit<ComboBoxBaseProps<O, V>, "values" | "onSelect" | "multiselect">;
+} & Omit<ComboBoxBaseProps<O, V>, "values" | "proposedValues" | "onSelect" | "multiselect">;
 /**
  * Provides a non-native select/dropdown widget.
  *

package/dist/index.d.ts

@@ -4888,6 +4888,8 @@ interface BeamTextFieldProps<X> extends BeamFocusableProps, PresentationFieldPro
     /** Marks the field as required or optional, the default is assumed ambiguous/unknown. */
     required?: boolean;
     value: string | undefined;
+    /** Value proposed by an AI model; puts the field in AI mode. */
+    proposedValue?: string;
     /** Handler called when the interactive element state changes. */
     onChange: (value: string | undefined) => void;
     /** Called when the component loses focus, mostly for BoundTextField to use. */
@@ -7916,6 +7918,14 @@ type TextFieldBaseProps<X> = {
     hideErrorMessage?: boolean;
     alwaysShowHelperText?: boolean;
     unfocusedPlaceholder?: ReactNode;
+    /** Value proposed by an AI model; puts the field in AI mode. Pre-formatted for display. */
+    proposedValue?: string;
+    /** The formatted value on record, rendered struck through beside the input. Independent of `proposedValue`. */
+    originalValue?: string;
+    /** Called on any edit the user makes, so the owning field can end AI mode. */
+    onUserEdit?: VoidFunction;
+    /** Called when the user leaves the field, so the owning field can retire the struck-through original. */
+    onUserBlur?: VoidFunction;
     /** Allow focusing without selecting, i.e. to let the user keep typing after we've pre-filled text + called focus, like the Add New component. */
     selectOnFocus?: boolean;
 } & Pick<BeamTextFieldProps<X>, "label" | "required" | "errorMsg" | "errorInTooltip" | "onBlur" | "onFocus" | "helperText" | "labelStyle" | "placeholder" | "compact" | "borderless" | "borderOnHover" | "visuallyDisabled" | "fullWidth" | "xss" | "inputStylePalette"> & Partial<Pick<BeamTextFieldProps<X>, "onChange">>;
@@ -7958,7 +7968,7 @@ type AutocompleteProps<T> = {
         value: Value;
         reason: string;
     })[];
-} & Pick<PresentationFieldProps, "labelStyle"> & Pick<TextFieldBaseProps<any>, "label" | "clearable" | "startAdornment" | "fullWidth">;
+} & Pick<PresentationFieldProps, "labelStyle"> & Pick<TextFieldBaseProps<any>, "label" | "clearable" | "startAdornment" | "fullWidth" | "proposedValue">;
 declare function Autocomplete<T extends object>(props: AutocompleteProps<T>): JSX.Element;
 
 interface CheckboxProps {
@@ -8095,11 +8105,15 @@ type DateFieldCommonProps = Pick<TextFieldBaseProps<Properties>, "borderless" |
     /** Render header that skips years in addition to months */
     useYearPicker?: boolean;
 };
-type DateFieldProps = DateFieldCommonProps & {
+/** Value proposed by an AI model; puts the field in AI mode. */
+type ProposedValue<V> = {
+    proposedValue?: V;
+};
+type DateFieldProps = DateFieldCommonProps & ProposedValue<PlainDate> & {
     value: PlainDate | undefined;
     onChange: (value: PlainDate | undefined) => void;
 };
-type DateRangeFieldProps = DateFieldCommonProps & {
+type DateRangeFieldProps = DateFieldCommonProps & ProposedValue<DateRange> & {
     value: DateRange | undefined;
     onChange: (value: DateRange | undefined) => void;
 };
@@ -8130,6 +8144,8 @@ type ComboBoxBaseProps<O, V extends Value> = {
     getOptionLabel: (opt: O) => string;
     /** The current value; it can be `undefined`, even if `V` cannot be. */
     values: V[] | undefined;
+    /** Values proposed by an AI model; puts the field in AI mode. */
+    proposedValues?: V[];
     onSelect: (values: V[], opts: O[]) => void;
     multiselect?: boolean;
     disabledOptions?: (V | {
@@ -8236,6 +8252,8 @@ interface NumberFieldProps extends Pick<PresentationFieldProps, "labelStyle" | "
     /** If set, the label will be defined as 'aria-label` on the input element */
     type?: NumberFieldType;
     value: number | undefined;
+    /** Value proposed by an AI model; puts the field in AI mode. */
+    proposedValue?: number;
     onChange: (value: number | undefined) => void;
     compact?: boolean;
     clearable?: boolean;
@@ -8406,13 +8424,15 @@ declare function SelectCardGroup<V extends Value>(props: SelectCardGroupProps<V>
 type SelectFieldProps<O, V extends Value> = {
     /** The current value; it can be `undefined`, even if `V` cannot be. */
     value: V | undefined;
+    /** Value proposed by an AI model; puts the field in AI mode. */
+    proposedValue?: V;
     /**
      * Called when a value is selected, or `undefined` if `unsetLabel` is being used.
      *
      * Ideally callers that didn't pass `unsetLabel` would not have to handle the ` | undefined` here.
      */
     onSelect: (value: V | undefined, opt: O | undefined) => void;
-} & Omit<ComboBoxBaseProps<O, V>, "values" | "onSelect" | "multiselect">;
+} & Omit<ComboBoxBaseProps<O, V>, "values" | "proposedValues" | "onSelect" | "multiselect">;
 /**
  * Provides a non-native select/dropdown widget.
  *