@osdk/react-components 0.56.0 → 0.57.0-main-9c5a7b17bd0a71c88bf2d3ed29847e6f87975bbf

package/build/cjs/action-form-4OvVNZ6i.d.cts

@@ -0,0 +1,791 @@
+import { ObjectTypeDefinition, Osdk, ObjectSet, ActionDefinition, CompileTimeMetadata, ActionMetadata, ActionParam, DataValueClientToWire, ActionEditResponse, ActionValidationResponse } from '@osdk/api';
+import React__default from 'react';
+
+/**
+ * Element that receives a portal — accepts an HTMLElement, ShadowRoot, a
+ * ref to either, `null` for default body-attachment, or `undefined`.
+ */
+type PortalContainer = HTMLElement | ShadowRoot | null | React__default.RefObject<HTMLElement | ShadowRoot | null>;
+
+/**
+ * Props for the shared DatePicker. Used directly by filter-list and
+ * object-table; wrapped by action-form's FormFieldRenderer for the
+ * `DATETIME_PICKER` field kind. `id` and `error` are optional so non-form
+ * callers can omit them.
+ *
+ * When `formatDate` is omitted, ISO-like format is used (YYYY-MM-DD /
+ * YYYY-MM-DD HH:mm).
+ */
+interface DatePickerProps {
+    /**
+     * The HTML `id` attribute for the input element. Used for `<label htmlFor>`
+     * association in form contexts. Optional in non-form contexts.
+     */
+    id?: string;
+    /**
+     * Visual error state for the input. Set by form validation in
+     * action-form contexts; non-form callers typically omit it.
+     */
+    error?: string;
+    /** The currently-selected Date, or `null` for empty. */
+    value: Date | null;
+    /** Called when the user selects or types a new date. */
+    onChange?: (value: Date | null) => void;
+    /** Whether the picker is disabled. */
+    disabled?: boolean;
+    /** The earliest date the user can select. */
+    min?: Date;
+    /** The latest date the user can select. */
+    max?: Date;
+    /** Whether to show a time picker alongside the date. */
+    showTime?: boolean;
+    /**
+     * Whether to close the popover after selecting a date.
+     * @default true when `showTime` is false, false when `showTime` is true
+     */
+    closeOnSelection?: boolean;
+    /** Placeholder text shown when no value is selected. */
+    placeholder?: string;
+    /**
+     * Formats a Date for display in the input field when not editing.
+     * When typing, the input shows the parsable format (YYYY-MM-DD or
+     * YYYY-MM-DD HH:mm). Provide a matching `parseDate` if using a custom
+     * format.
+     */
+    formatDate?: (date: Date) => string;
+    /**
+     * Parses a user-typed string back into a Date. Must be the inverse of
+     * `formatDate` — if `formatDate(d)` produces string `s`, then
+     * `parseDate(s)` must return an equivalent Date. When omitted, defaults
+     * to parsing "YYYY-MM-DD" (date-only) or "YYYY-MM-DD HH:mm" (with time).
+     */
+    parseDate?: (text: string) => Date | undefined;
+    /**
+     * Ref forwarded to the portal container element. Used to track portaled
+     * content for click-outside detection.
+     */
+    portalRef?: React__default.Ref<HTMLDivElement>;
+    /**
+     * Element that receives the date picker portal. Use this when rendering
+     * inside modal dialogs so popovers stay in the dialog's stacking and
+     * focus context instead of being appended directly to document.body.
+     */
+    portalContainer?: PortalContainer;
+    /**
+     * Accessible label for the input when there is no adjacent `<label>`
+     * element.
+     */
+    ariaLabel?: string;
+    /**
+     * Popover modality. Defaults to `"trap-focus"`, which traps Tab cycling
+     * inside the calendar and renders a transparent dismiss layer over the
+     * page. Pass `false` when nesting this picker inside another popover so
+     * the inner dismiss layer doesn't intercept clicks intended for the
+     * outer popover and base-ui's default outside-click handles dismissal
+     * instead.
+     */
+    modal?: "trap-focus" | false;
+}
+
+/**
+ * A date range represented as a start/end tuple. Either element may be
+ * `null` when the range is partially selected.
+ */
+type DateRange = readonly [Date | null, Date | null];
+/**
+ * Props for the shared DateRangePicker. Used by filter-list's date-range
+ * histogram and action-form's `DATE_RANGE_INPUT` field kind. `id` and
+ * `error` are optional so non-form callers can omit them.
+ *
+ * Renders two text inputs (start / end) with a shared calendar popover
+ * supporting range selection.
+ */
+interface DateRangePickerProps {
+    /**
+     * The HTML `id` attribute for the start input element. Used for
+     * `<label htmlFor>` association in form contexts.
+     */
+    id?: string;
+    /**
+     * Visual error state for the inputs. Set by form validation in
+     * action-form contexts; non-form callers typically omit it.
+     */
+    error?: string;
+    /** The currently-selected range, or `null` for empty. */
+    value: DateRange | null;
+    /** Called when the user selects or types a new range. */
+    onChange?: (value: DateRange | null) => void;
+    /** Whether the picker is disabled. */
+    disabled?: boolean;
+    /** The earliest selectable date. */
+    min?: Date;
+    /** The latest selectable date. */
+    max?: Date;
+    /** Whether to show time pickers for both dates. */
+    showTime?: boolean;
+    /** Placeholder text for the start date input. */
+    placeholderStart?: string;
+    /** Placeholder text for the end date input. */
+    placeholderEnd?: string;
+    /** Whether to allow start and end on the same day. @default true */
+    allowSingleDayRange?: boolean;
+    /** Formats a Date for display. Defaults to "YYYY-MM-DD". */
+    formatDate?: (date: Date) => string;
+    /** Parses a user-typed string back into a Date. */
+    parseDate?: (text: string) => Date | undefined;
+    /**
+     * Element that receives the date range picker portal. Use this when
+     * rendering inside modal dialogs so popovers stay in the dialog's
+     * stacking and focus context instead of being appended directly to
+     * document.body.
+     */
+    portalContainer?: PortalContainer;
+    /**
+     * Popover modality. Defaults to `"trap-focus"`, which traps Tab cycling
+     * inside the calendar and renders a transparent dismiss layer over the
+     * page. Pass `false` when nesting this picker inside another popover so
+     * the inner dismiss layer doesn't intercept clicks intended for the
+     * outer popover and base-ui's default outside-click handles dismissal
+     * instead.
+     */
+    modal?: "trap-focus" | false;
+}
+
+/**
+ * A form field definition specifies configuration for a single field.
+ * Implemented as a distributed mapped type so `fieldComponent` narrows
+ * `fieldComponentProps` to the matching component prop type.
+ */
+type FormFieldDefinition<Q extends ActionDefinition<unknown>, K extends FieldKey<Q> = FieldKey<Q>> = K extends unknown ? {
+    [C in ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>]: {
+        /**
+         * The field's unique key
+         */
+        fieldKey: K;
+        /**
+         * Display label for the field
+         */
+        label: string;
+        /**
+         * Default value of the field
+         */
+        defaultValue?: FieldValueType<Q, K>;
+        /**
+         * Whether the field is required
+         */
+        isRequired?: boolean;
+        /**
+         * Placeholder text
+         */
+        placeholder?: string;
+        /**
+         * Additional information to display on this field.
+         * Accepts plain text or rich content (e.g. JSX with links or formatting).
+         * Rendered as a tooltip icon next to the label by default, or below the
+         * label when helperTextPlacement is "bottom".
+         */
+        helperText?: React__default.ReactNode;
+        /**
+         * The placement of the helper text either below the field or in a tooltip
+         *
+         * @default "tooltip"
+         */
+        helperTextPlacement?: "bottom" | "tooltip";
+        /**
+         * Whether the field is disabled
+         */
+        disabled?: boolean;
+        /**
+         * A callback to customize error messages when a built-in validation rule fails.
+         * Receives a discriminated union with the constraint data (e.g., the min value
+         * that was exceeded) so the message can reference the threshold.
+         *
+         * Return a string to override the default message, or `undefined` to keep it.
+         */
+        onValidationError?: (error: ValidationError) => string | undefined;
+        /**
+         * Additional function to validate the field.
+         *
+         * Return `undefined` if valid, or an error message string if invalid.
+         */
+        validate?: (value: FieldValueType<Q, K>) => Promise<string | undefined>;
+        /**
+         * The form field component type to render
+         */
+        fieldComponent: C;
+        /**
+         * The component props for the form field.
+         * Excludes runtime props (value, onChange) which are managed by ActionForm.
+         */
+        fieldComponentProps: DistributiveOmit<FormFieldPropsByType[C], FormManagedProps<C>>;
+    };
+}[ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>] : never;
+/**
+ * A discriminated union describing which validation rule failed and the
+ * constraint data the user needs to build a meaningful error message.
+ */
+type ValidationError = {
+    type: "required";
+} | {
+    type: "min";
+    min: number | Date;
+} | {
+    type: "max";
+    max: number | Date;
+} | {
+    type: "minLength";
+    minLength: number;
+} | {
+    type: "maxLength";
+    maxLength: number;
+} | {
+    type: "maxSize";
+    maxSize: number;
+} | {
+    type: "validate";
+    message: string;
+};
+/**
+ * Maps field types to their corresponding props
+ */
+interface FormFieldPropsByType {
+    DATE_RANGE_INPUT: DateRangePickerProps;
+    DATETIME_PICKER: DatePickerProps;
+    DROPDOWN: DropdownFieldProps<unknown, boolean>;
+    FILE_PICKER: FilePickerProps;
+    NUMBER_INPUT: NumberInputFieldProps;
+    OBJECT_SELECT: ObjectSelectFieldProps<ObjectTypeDefinition>;
+    OBJECT_SET: ObjectSetFieldProps<ObjectTypeDefinition>;
+    RADIO_BUTTONS: RadioButtonsFieldProps<unknown>;
+    SWITCH: SwitchFieldProps;
+    TEXT_AREA: TextAreaFieldProps;
+    TEXT_INPUT: TextInputFieldProps;
+    CUSTOM: CustomFieldProps<unknown>;
+    UNSUPPORTED: UnsupportedFieldProps;
+}
+/**
+ * Dropdown field props with selectable items
+ */
+interface DropdownFieldProps<V, Multiple extends boolean = false> extends BaseFormFieldProps<Multiple extends true ? V[] : V> {
+    /**
+     * Available items for the dropdown
+     */
+    items: V[];
+    /**
+     * Converts an item to searchable text and the default visual label. Defaults to `String()`.
+     * Use `renderItemLabel` when the visible label needs rich React content.
+     */
+    itemToStringLabel?: (item: V) => string;
+    /**
+     * Renders an item label with custom React content.
+     * `itemToStringLabel` is still used for search, accessibility, and fallback keys.
+     */
+    renderItemLabel?: (item: V) => React__default.ReactNode;
+    /**
+     * Returns a unique string key for a list item. Used as the React `key`.
+     * Falls back to the item's index when not provided.
+     */
+    itemToKey?: (item: V) => string;
+    /**
+     * Custom equality check for item values. Defaults to `Object.is`.
+     * Required when items are objects to ensure correct selection matching.
+     */
+    isItemEqual?: (a: V, b: V) => boolean;
+    /**
+     * Whether the dropdown allows searching/filtering.
+     * When true, renders a Combobox with a search input.
+     * When false (default), renders a Select dropdown.
+     */
+    isSearchable?: boolean;
+    /**
+     * Placeholder text shown when no value is selected.
+     */
+    placeholder?: string;
+    /**
+     * Whether multiple values can be selected
+     */
+    isMultiple?: Multiple;
+    /**
+     * Ref forwarded to the portal container element.
+     * Used to track portaled content for click-outside detection.
+     */
+    portalRef?: React__default.Ref<HTMLDivElement>;
+    /**
+     * Element that receives the dropdown portal. Use this when rendering inside
+     * modal dialogs so popups stay in the dialog's stacking and focus context
+     * instead of being appended directly to document.body.
+     */
+    portalContainer?: PortalContainer;
+    /**
+     * Controlled search input value. Must be provided together with `onQueryChange`.
+     */
+    query?: string;
+    /**
+     * Callback when the search input value changes.
+     * Can be used standalone as an event listener or together with `query`
+     * for fully controlled search state.
+     */
+    onQueryChange?: (query: string) => void;
+    /**
+     * When true, disables the combobox's built-in client-side filtering.
+     * Use when items are already filtered server-side (e.g. via `onQueryChange`).
+     *
+     * @default false
+     */
+    disableClientSideFiltering?: boolean;
+    /**
+     * Status message rendered below the search input and above the item list
+     * inside the popup. Use for loading/error/empty messages.
+     */
+    popupStatus?: React__default.ReactNode;
+    /**
+     * A React node to render after the item list.
+     * Use for infinite scroll sentinels, "load more" buttons, etc.
+     */
+    trailingItem?: React__default.ReactNode;
+    /**
+     * Whether the dropdown locks page scroll and renders a full-viewport
+     * dismiss layer when open. Set to `false` when the dropdown is not
+     * inside a `<label>` to allow normal page scrolling.
+     *
+     * @default true
+     */
+    modal?: boolean;
+}
+interface FilePickerProps extends BaseFormFieldProps<File | File[]> {
+    /**
+     * Whether multiple files can be selected
+     */
+    isMulti?: boolean;
+    /**
+     * Accepted file types (e.g., "image/*", ".pdf")
+     */
+    accept?: string | string[];
+    /**
+     * Maximum file size in bytes
+     */
+    maxSize?: number;
+    /**
+     * The text displayed when no file is selected.
+     *
+     * @default "No file chosen"
+     */
+    text?: string;
+    /**
+     * The text displayed on the browse button.
+     *
+     * @default "Browse"
+     */
+    buttonText?: string;
+}
+/**
+ * Text area field props
+ */
+interface TextAreaFieldProps extends BaseFormFieldProps<string>, Pick<React__default.TextareaHTMLAttributes<HTMLTextAreaElement>, "rows" | "wrap"
+/**
+ * If provided, this will be added to the field validation
+ */
+ | "minLength"
+/**
+ * If provided, this will be added to the field validation
+ */
+ | "maxLength"> {
+    placeholder?: string;
+}
+interface TextInputFieldProps extends BaseFormFieldProps<string>, Pick<React__default.InputHTMLAttributes<HTMLInputElement>, 
+/**
+ * If provided, this will be added to the field validation
+ */
+"minLength"
+/**
+ * If provided, this will be added to the field validation
+ */
+ | "maxLength"> {
+    placeholder?: string;
+}
+/**
+ * Number input field props
+ */
+interface NumberInputFieldProps extends BaseFormFieldProps<number> {
+    /**
+     * Minimum allowed value.
+     */
+    min?: number;
+    /**
+     * Maximum allowed value.
+     */
+    max?: number;
+    /**
+     * Step increment for the input. Used by the stepper buttons and ArrowUp/ArrowDown keyboard stepping.
+     *
+     * @default 1
+     */
+    step?: number;
+    /**
+     * Placeholder text shown when the input is empty.
+     */
+    placeholder?: string;
+}
+/**
+ * Radio buttons field props
+ */
+interface RadioButtonsFieldProps<V> extends BaseFormFieldProps<V> {
+    /**
+     * Available options for radio buttons.
+     *
+     * Values are compared by reference equality (`===`). When options contain
+     * non-primitive values, pass the same object references for `value` and
+     * the corresponding option entry.
+     */
+    options: Option<V>[];
+    /**
+     * Controls the layout direction of the radio buttons.
+     *
+     * - `"vertical"` (default): options are stacked in a column
+     * - `"horizontal"`: options are laid out in a row, wrapping when needed
+     */
+    orientation?: "horizontal" | "vertical";
+}
+/**
+ * Switch field props for boolean values.
+ */
+type SwitchFieldProps = BaseFormFieldProps<boolean>;
+/**
+ * Option interface for radio button options
+ */
+interface Option<V> {
+    label: string;
+    value: V;
+}
+/**
+ * Object set field displays the summary of the count of the given object set
+ */
+interface ObjectSetFieldProps<T extends ObjectTypeDefinition> extends Pick<BaseFormFieldProps<ObjectSet<T>>, "id" | "value" | "disabled"> {
+    /**
+     * Message displayed when no object set is provided.
+     *
+     * @default "Object set is not defined"
+     */
+    emptyMessage?: string;
+}
+type ObjectSelectDataSource<Q extends ObjectTypeDefinition> = {
+    /**
+     * The object type definition to search across.
+     */
+    objectType: Q;
+    objectSet?: never;
+} | {
+    /**
+     * A pre-scoped object set to search within.
+     *
+     * Use this when selectable options should be limited to a subset of
+     * objects. User-entered search text is applied within this set.
+     */
+    objectSet: ObjectSet<Q>;
+    objectType?: never;
+};
+/**
+ * Object select field props for selecting object instances from the ontology.
+ * Used for action parameters that accept a single object or multiple objects.
+ *
+ * Extends DropdownFieldProps with props that ObjectSelectField
+ * manages internally (items, search, filtering) omitted from the public surface.
+ */
+type ObjectSelectFieldProps<Q extends ObjectTypeDefinition = ObjectTypeDefinition> = Omit<DropdownFieldProps<Osdk.Instance<Q>>, "items" | "itemToStringLabel" | "itemToKey" | "isItemEqual" | "isSearchable" | "query" | "onQueryChange" | "disableClientSideFiltering" | "renderItemList"> & ObjectSelectDataSource<Q>;
+/**
+ * Custom field props for user-defined renderers
+ */
+interface CustomFieldProps<V> extends BaseFormFieldProps<V> {
+    /**
+     * Custom renderer function
+     */
+    customRenderer: (props: BaseFormFieldProps<V>) => React__default.ReactNode;
+}
+interface UnsupportedFieldProps extends Pick<BaseFormFieldProps<string>, "id" | "error"> {
+}
+interface BaseFormFieldProps<V> {
+    /**
+     * The HTML `id` attribute for the field input element.
+     * Used for `<label htmlFor>` association.
+     */
+    id?: string;
+    /**
+     * The validation error message for this field, if any.
+     * When set, the field should display a visual error state.
+     */
+    error?: string;
+    /**
+     * The value of the form field
+     */
+    value: V | null;
+    /**
+     * The default value of the form field.
+     */
+    defaultValue?: V;
+    /**
+     * Whether the field is disabled.
+     *
+     * Disabled fields keep their current value in form state and submit payloads,
+     * but built-in renderers block user edits and remove disabled controls from
+     * keyboard navigation.
+     */
+    disabled?: boolean;
+    /**
+     * Called when the field value changes.
+     *
+     * ActionForm internally wraps this to pass the key to `onFieldValueChange`:
+     * ```
+     * <DropdownField
+     *   {...fieldDef}
+     *   onChange={(value) => onFieldValueChange(fieldDef.key, value)}
+     * />
+     * ```
+     *
+     * @param value The new value of the form field
+     */
+    onChange?: (value: V | null) => void;
+}
+type FieldKey<Q extends ActionDefinition<unknown>> = keyof ActionParameters<Q>;
+/**
+ * Extracts parameters from an ActionDefinition
+ */
+type ActionParameters<Q extends ActionDefinition<unknown>> = CompileTimeMetadata<Q>["parameters"];
+/**
+ * Extracts the value type for a specific parameter
+ */
+type FieldValueType<Q extends ActionDefinition<unknown>, K extends keyof ActionParameters<Q> = keyof ActionParameters<Q>> = ActionParameters<Q>[K]["type"] extends ActionMetadata.DataType.Object<infer T> ? ActionParam.ObjectType<T> : ActionParameters<Q>[K]["type"] extends ActionMetadata.DataType.ObjectSet<infer T> ? ActionParam.ObjectSetType<T> : ActionParameters<Q>[K]["type"] extends ActionMetadata.DataType.Interface<infer T> ? ActionParam.InterfaceType<T> : ActionParameters<Q>[K]["type"] extends ActionMetadata.DataType.Struct<infer T> ? ActionParam.StructType<T> : ActionParameters<Q>[K]["type"] extends keyof DataValueClientToWire ? DataValueClientToWire[ActionParameters<Q>[K]["type"]] : never;
+/**
+ * Extracts the parameter type descriptor for a specific action parameter.
+ */
+type FieldDescriptorType<Q extends ActionDefinition<unknown> = ActionDefinition<unknown>, K extends keyof ActionParameters<Q> = keyof ActionParameters<Q>> = ActionParameters<Q>[K]["type"];
+/**
+ * Available form field component types
+ */
+type FieldComponent = "DATE_RANGE_INPUT" | "DATETIME_PICKER" | "DROPDOWN" | "FILE_PICKER" | "NUMBER_INPUT" | "OBJECT_SELECT" | "OBJECT_SET" | "RADIO_BUTTONS" | "SWITCH" | "TEXT_AREA" | "TEXT_INPUT" | "CUSTOM" | "UNSUPPORTED";
+/**
+ * Describes the data type of a form field, independent of OSDK.
+ * Mirrors ActionMetadata.DataType to keep the rendering layer OSDK-agnostic.
+ */
+type FieldType = "boolean" | "string" | "integer" | "long" | "double" | "datetime" | "timestamp" | "attachment" | "marking" | "mediaReference" | "objectType" | "geoshape" | "geohash" | "scenarioReference" | {
+    type: "object";
+    object: string;
+} | {
+    type: "objectSet";
+    objectSet: string;
+} | {
+    type: "interface";
+    interface: string;
+} | {
+    type: "struct";
+    struct: Record<string, string>;
+};
+/**
+ * Props managed by form state infrastructure (FieldBridge / RHF).
+ * Fields with onChange participate in form state → value and onChange are managed
+ * externally. Read-only fields (no onChange, e.g. ObjectSetField) keep value in
+ * fieldComponentProps so it bypasses form state cloning.
+ */
+type FormManagedProps<K extends FieldComponent> = "onChange" extends keyof FormFieldPropsByType[K] ? "value" | "onChange" | "disabled" : "onChange" | "disabled";
+type DistributiveOmit<T, K extends PropertyKey> = T extends unknown ? Omit<T, Extract<keyof T, K>> : never;
+/**
+ * An OSDK-agnostic field definition used by BaseForm and FormFieldRenderer.
+ * Contains only the information needed to render a single field — no generics,
+ * no compile-time parameter constraints.
+ *
+ * Implemented as a distributed mapped type: switching on `fieldComponent`
+ * narrows `fieldComponentProps` to the correct props type automatically.
+ */
+type RendererFieldDefinition = {
+    [K in FieldComponent]: {
+        fieldKey: string;
+        fieldComponent: K;
+        fieldType?: FieldType;
+        label: string;
+        isRequired?: boolean;
+        placeholder?: string;
+        helperText?: React__default.ReactNode;
+        helperTextPlacement?: "bottom" | "tooltip";
+        disabled?: boolean;
+        validate?: (value: unknown) => Promise<string | undefined>;
+        onValidationError?: (error: ValidationError) => string | undefined;
+        fieldComponentProps: DistributiveOmit<FormFieldPropsByType[K], FormManagedProps<K>>;
+    };
+}[FieldComponent];
+/**
+ * Gets valid form field types for a given property type
+ */
+type ValidFormFieldForPropertyType<P extends FieldDescriptorType> = "CUSTOM" | (P extends {
+    type: "objectSet";
+} ? "OBJECT_SET" : P extends {
+    type: "object";
+} ? "OBJECT_SELECT" : P extends {
+    type: "interface";
+} ? "UNSUPPORTED" : P extends {
+    type: "struct";
+} ? "UNSUPPORTED" : P extends "mediaReference" | "attachment" ? "FILE_PICKER" : P extends "boolean" ? "RADIO_BUTTONS" | "DROPDOWN" | "SWITCH" : P extends "string" ? "TEXT_INPUT" | "TEXT_AREA" : P extends "datetime" | "timestamp" ? "DATETIME_PICKER" : P extends "marking" | "geohash" | "geoshape" | "objectType" ? "UNSUPPORTED" : P extends "double" | "integer" | "long" | "float" | "short" | "byte" | "decimal" ? "NUMBER_INPUT" : never);
+
+/**
+ * Props for the ActionForm component.
+ *
+ * A discriminated union ensures that controlled mode (formState provided)
+ * always requires onFormStateChange, and uncontrolled mode makes `onFormStateChange` optional
+ */
+type ActionFormProps<Q extends ActionDefinition<unknown>> = (ActionFormConfigProps<Q> & {
+    /**
+     * The current form values.
+     * If provided, the form state is controlled.
+     */
+    formState: FormState<Q>;
+    /**
+     * Called when a field value changes, with a state updater.
+     * Required when the form state is controlled; also fires in
+     * uncontrolled mode so callers can observe changes.
+     */
+    onFormStateChange: (updater: (prevState: FormState<Q>) => FormState<Q>) => void;
+}) | (ActionFormConfigProps<Q> & {
+    formState?: undefined;
+    onFormStateChange?: (updater: (prevState: FormState<Q>) => FormState<Q>) => void;
+});
+interface ActionFormConfigProps<Q extends ActionDefinition<unknown>> extends Pick<BaseFormProps, "formTitle" | "isSubmitDisabled"> {
+    /**
+     * The OSDK action definition. Its parameters drive the rendered fields
+     * and the submission.
+     */
+    actionDefinition: Q;
+    /**
+     * Whether to show the form title.
+     *
+     * @default false
+     */
+    showFormTitle?: boolean;
+    /**
+     * If not supplied, field definitions are constructed from action metadata.
+     */
+    formFieldDefinitions?: ReadonlyArray<FormFieldDefinition<Q>>;
+    /**
+     * If supplied, this will override the default submit action.
+     * By default, the action's applyAction will be called.
+     *
+     * @param formState all field values when onSubmit is called
+     * @param applyAction the function to execute the action
+     * @returns a promise of the submission response
+     */
+    onSubmit?: (formState: FormState<Q>, applyAction: (formState: FormState<Q>) => Promise<ActionEditResponse | undefined>) => Promise<unknown> | void;
+    /**
+     * Called when the validation response is returned from a validateOnly submission
+     *
+     * @param results the validation response
+     */
+    onValidationResponse?: (results: ActionValidationResponse) => void;
+    /**
+     * Called when the action is successfully executed from a non-validateOnly submission
+     *
+     * @param results the submission response
+     */
+    onSuccess?: (results: ActionEditResponse | undefined) => void;
+    /**
+     * Called when action metadata fails to load or form submission fails.
+     *
+     * @param error the error that occurred
+     */
+    onError?: (error: FormError) => void;
+}
+/**
+ * Form values mapping parameter names to their values
+ */
+type FormState<Q extends ActionDefinition<unknown>> = {
+    [K in FieldKey<Q>]?: FieldValueType<Q, K>;
+};
+/**
+ * Form error discriminated union
+ */
+type FormError = {
+    type: "submission";
+    error: unknown;
+} | {
+    type: "unknown";
+    error: unknown;
+};
+/**
+ * A single item in the form content array — either a standalone field
+ * or a section that groups multiple fields.
+ */
+type FormContentItem = {
+    type: "field";
+    definition: RendererFieldDefinition;
+} | {
+    type: "section";
+    key: string;
+    definition: FormSectionDefinition;
+};
+/**
+ * Configuration for a form section — a visual group of fields with
+ * optional title bar, collapse behavior, and multi-column layout.
+ */
+interface FormSectionDefinition {
+    title: string;
+    description?: string;
+    fields: ReadonlyArray<RendererFieldDefinition>;
+    /** Whether the section starts collapsed. Default `false`. */
+    collapsedByDefault?: boolean;
+    /** Whether to show the title bar. Default `true`. */
+    showTitleBar?: boolean;
+    /** Number of columns for fields. Default `1`. */
+    columnCount?: 1 | 2;
+    /** Visual style. `"box"` = bordered card, `"minimal"` = heading only. Default `"box"`. */
+    style?: "box" | "minimal";
+}
+/**
+ * Props for the `BaseForm` component, which renders a form without
+ * OSDK data fetching.
+ *
+ * Uses a discriminated union so that controlled mode (`formState` provided)
+ * always requires `onFieldValueChange`; uncontrolled mode omits `formState`
+ * (`onFieldValueChange` stays optional).
+ * `onSubmit` receives the current form state so callers can access values
+ * even in uncontrolled mode.
+ */
+type BaseFormProps = BaseFormCommonProps & ({
+    /**
+     * The current field values keyed by field key.
+     * If provided, the form state is controlled.
+     */
+    formState: Record<string, unknown>;
+    /**
+     * Called when a field value changes.
+     * Required when the form state is controlled; also fires in
+     * uncontrolled mode so callers can observe changes.
+     */
+    onFieldValueChange: (fieldKey: string, value: unknown) => void;
+} | {
+    formState?: undefined;
+    onFieldValueChange?: (fieldKey: string, value: unknown) => void;
+});
+interface BaseFormCommonProps {
+    /** Title shown in the form header. Omit to hide the header. */
+    formTitle?: string;
+    /** The fields and sections to render, in order. */
+    formContent: ReadonlyArray<FormContentItem>;
+    /** Called when the form is submitted with valid values. Receives the current form state. */
+    onSubmit: (formState: Record<string, unknown>) => Promise<void> | void;
+    /** Whether the submit button is disabled. Default `false`. */
+    isSubmitDisabled?: boolean;
+    /** Whether a submission is in progress. Shows the submit button in a pending state. Default `false`. */
+    isPending?: boolean;
+    /** Whether the form is loading its fields. Shows a skeleton placeholder. Default `false`. */
+    isLoading?: boolean;
+    /** Additional CSS class name for the root element. */
+    className?: string;
+    /** Label for the submit button. Default `"Submit"`. */
+    submitButtonText?: string;
+    /** Visual variant of the submit button. Default `"primary"`. */
+    submitButtonVariant?: "primary" | "secondary";
+}
+
+declare const ActionForm$1: <Q extends ActionDefinition<unknown>>(props: ActionFormProps<Q>) => React__default.ReactElement;
+
+declare const BaseForm: React__default.FC<BaseFormProps>;
+
+declare const ActionForm: typeof ActionForm$1;
+
+export { ActionForm as A, BaseForm as B, type CustomFieldProps as C, type DropdownFieldProps as D, type FieldComponent as F, type NumberInputFieldProps as N, type ObjectSelectFieldProps as O, type PortalContainer as P, type RadioButtonsFieldProps as R, type TextAreaFieldProps as T, type UnsupportedFieldProps as U, type ValidationError as V, type ActionFormProps as a, type ActionParameters as b, type BaseFormFieldProps as c, type BaseFormProps as d, type FieldValueType as e, type FilePickerProps as f, type FormContentItem as g, type FormError as h, type FieldKey as i, type FormFieldDefinition as j, type FormFieldPropsByType as k, type FormSectionDefinition as l, type FormState as m, type ObjectSetFieldProps as n, type Option as o, type RendererFieldDefinition as p, type TextInputFieldProps as q };