@osdk/react-components 0.2.0-beta.21 → 0.2.0-beta.23

package/build/cjs/public/experimental.d.cts

@@ -1,7 +1,10 @@
 import * as React from 'react';
-import React__default, { ReactNode, ReactElement } from 'react';
-import { ObjectTypeDefinition, ObjectSet, WhereClause, PropertyKeys, LinkNames, LinkedType, WirePropertyTypes, CompileTimeMetadata, ObjectOrInterfaceDefinition, SimplePropertyDef, QueryDefinition, QueryMetadata, Osdk, DerivedProperty, PrimaryKeyType, Media } from '@osdk/api';
+import React__default, { ReactNode, ReactElement, RefObject } from 'react';
+import { ObjectTypeDefinition, ObjectSet, WhereClause, PropertyKeys, LinkNames, LinkedType, WirePropertyTypes, CompileTimeMetadata, ObjectOrInterfaceDefinition, SimplePropertyDef, QueryDefinition, QueryMetadata, Osdk, DerivedProperty, PrimaryKeyType, Media, ActionDefinition, ActionMetadata, ActionParam, DataValueClientToWire, ActionEditResponse, ActionValidationResponse } from '@osdk/api';
 import { RowData, Table, Cell, VisibilityState, ColumnOrderState } from '@tanstack/react-table';
+import { PDFDocumentProxy } from 'pdfjs-dist';
+import { PDFViewer, EventBus, PDFFindController } from 'pdfjs-dist/web/pdf_viewer.mjs';
+import { ActionValidationError } from '@osdk/client';
 
 /**
  * State for custom filter
@@ -358,6 +361,8 @@ type RenderFilterInput<D> = (props: {
     filterKey: string;
     filterState: FilterState | undefined;
     onFilterStateChanged: (state: FilterState) => void;
+    searchQuery?: string;
+    excludeRowOpen?: boolean;
 }) => React__default.ReactNode;
 interface BaseFilterListProps<D> {
     filterDefinitions?: Array<D>;
@@ -372,10 +377,11 @@ interface BaseFilterListProps<D> {
     onFilterRemoved?: (filterKey: string) => void;
     collapsed?: boolean;
     onCollapsedChange?: (collapsed: boolean) => void;
-    title?: string;
+    title?: React__default.ReactNode;
     titleIcon?: React__default.ReactNode;
     showResetButton?: boolean;
     showActiveFilterCount?: boolean;
+    hasVisibilityChanges?: boolean;
     enableSorting?: boolean;
     className?: string;
     renderAddFilterButton?: () => React__default.ReactNode;
@@ -403,7 +409,7 @@ interface FilterListProps<Q extends ObjectTypeDefinition> {
     /**
      * Optional title to display in the filter list header
      */
-    title?: string;
+    title?: ReactNode;
     /**
      * Optional icon to display next to the title
      */
@@ -442,14 +448,14 @@ interface FilterListProps<Q extends ObjectTypeDefinition> {
     /**
      * Controls how filter visibility (add/remove) is managed.
      *
-     * - `"controlled"` (default): The consumer manages which filters are
-     *   visible via `filterDefinitions`. Filters with `isVisible: false` are
-     *   excluded from the rendered list.
-     * - `"uncontrolled"`: FilterList manages visibility internally. An "Add
-     *   filter" popover is rendered for filters with `isVisible: false`, and
-     *   each visible filter shows a remove button.
+     * - `"uncontrolled"` (default): FilterList manages visibility internally.
+     *   An "Add filter" popover is rendered for filters with `isVisible: false`,
+     *   and each visible filter shows a remove button.
+     * - `"controlled"`: The consumer manages which filters are visible via
+     *   `filterDefinitions`. Filters with `isVisible: false` are excluded from
+     *   the rendered list.
      *
-     * @default "controlled"
+     * @default "uncontrolled"
      */
     addFilterMode?: "controlled" | "uncontrolled";
     /**
@@ -510,8 +516,11 @@ interface FilterListProps<Q extends ObjectTypeDefinition> {
     className?: string;
     /**
      * Custom render function for the "Add filter" button.
-     * Only used in controlled mode. In uncontrolled mode, the built-in
-     * AddFilterPopover is rendered automatically.
+     *
+     * - In uncontrolled mode: customizes the trigger element for the built-in
+     *   add-filter popover. The popover behavior is handled automatically.
+     * - In controlled mode: replaces the entire add-filter button area.
+     *   The consumer is responsible for all add-filter behavior.
      */
     renderAddFilterButton?: () => React__default.ReactNode;
 }
@@ -911,6 +920,16 @@ interface ColumnConfigDialogProps {
 }
 declare function ColumnConfigDialog({ isOpen, onClose, columnOptions, currentVisibility, currentColumnOrder, onApply, isValidConfig, }: ColumnConfigDialogProps): React__default.ReactElement | null;
 
+/** Which sidebar panel to display when the sidebar is open. */
+type SidebarMode = "thumbnails" | "outline";
+/** A single item in the PDF document outline (table of contents). */
+interface OutlineItem {
+    title: string;
+    depth: number;
+    pageNumber: number;
+    bold: boolean;
+    italic: boolean;
+}
 /** The visual style of an annotation rendered on the PDF. */
 type AnnotationType = "highlight" | "underline" | "comment" | "pin";
 /** A single annotation positioned on a specific page of the PDF. */
@@ -933,6 +952,14 @@ interface PdfAnnotation {
     /** Optional color override (CSS color string) */
     color?: string;
 }
+/** Result passed to the {@link PdfViewerProps.onDownload} callback. */
+type PdfDownloadResult = {
+    success: true;
+    filename: string;
+} | {
+    success: false;
+    error: Error;
+};
 /** Props for the {@link PdfViewer} component. */
 interface PdfViewerProps {
     /** PDF source — URL string or ArrayBuffer */
@@ -946,22 +973,663 @@ interface PdfViewerProps {
      * @returns void
      */
     onAnnotationClick?: (annotation: PdfAnnotation) => void;
+    /**
+     * Callback fired when a download completes or fails.
+     *
+     * @param result - The download result indicating success with the filename, or failure with an error
+     * @returns void
+     */
+    onDownload?: (result: PdfDownloadResult) => void;
     /** Initial page number (1-indexed, default 1) */
     initialPage?: number;
     /** Initial zoom scale (default 1.0) */
     initialScale?: number;
     /** Whether the sidebar is initially open (default false) */
     initialSidebarOpen?: boolean;
+    /**
+     * Whether the download button is shown in the toolbar.
+     * @default false
+     */
+    enableDownload?: boolean;
+    /**
+     * Which sidebar panel to show: thumbnails or document outline.
+     * @default "thumbnails"
+     */
+    sidebarMode?: SidebarMode;
+    /**
+     * Custom icon components for each outline depth level (0-indexed).
+     * Key 0 = top-level items, 1 = first nesting level, etc.
+     * If omitted, no icons are rendered.
+     */
+    outlineIcons?: Partial<Record<number, React__default.ComponentType>>;
+    /** Additional CSS class name for the root element */
+    className?: string;
+}
+
+declare function BasePdfViewer({ src, annotations, onAnnotationClick, onDownload, initialPage, initialScale, initialSidebarOpen, enableDownload, sidebarMode: sidebarModeProp, outlineIcons, className, }: PdfViewerProps): React__default.ReactElement;
+
+interface PdfViewerAnnotationLayerProps {
+    annotations: PdfAnnotation[];
+    pageHeight: number;
+    scale: number;
+    onAnnotationClick?: (annotation: PdfAnnotation) => void;
+}
+declare function PdfViewerAnnotationLayer({ annotations, pageHeight, scale, onAnnotationClick, }: PdfViewerAnnotationLayerProps): React__default.ReactElement;
+
+interface PdfViewerContentProps {
+    /** PDF source — URL string or ArrayBuffer */
+    src: string | ArrayBuffer;
+    /** Annotations to overlay on the PDF, keyed by page number (1-indexed) */
+    annotations?: Record<number, PdfAnnotation[]>;
+    /** Callback fired when an annotation is clicked */
+    onAnnotationClick?: (annotation: PdfAnnotation) => void;
+    /** Initial page number (1-indexed, default 1) */
+    initialPage?: number;
+    /** Initial zoom scale (default 1.0) */
+    initialScale?: number;
+    /** Callback fired when the current page changes during scrolling */
+    onPageChange?: (page: number) => void;
+    /** Callback fired when the zoom scale changes */
+    onScaleChange?: (scale: number) => void;
     /** Additional CSS class name for the root element */
     className?: string;
 }
+declare function PdfViewerContent({ src, annotations, onAnnotationClick, initialPage, initialScale, onPageChange: onPageChangeProp, onScaleChange: onScaleChangeProp, className, }: PdfViewerContentProps): React__default.ReactElement;
+
+interface PdfViewerOutlineSidebarProps {
+    outlineItems: OutlineItem[];
+    currentPage: number;
+    onItemClick: (pageNumber: number) => void;
+    sidebarMode: SidebarMode;
+    onSidebarModeChange: (mode: SidebarMode) => void;
+    outlineIcons?: Partial<Record<number, React__default.ComponentType>>;
+}
+declare function PdfViewerOutlineSidebar({ outlineItems, currentPage, onItemClick, sidebarMode, onSidebarModeChange, outlineIcons, }: PdfViewerOutlineSidebarProps): React__default.ReactElement;
+
+interface PdfViewerSearchBarProps {
+    query: string;
+    totalMatches: number;
+    currentMatchIndex: number;
+    onQueryChange: (query: string) => void;
+    onNext: () => void;
+    onPrev: () => void;
+    onClose: () => void;
+}
+declare function PdfViewerSearchBar({ query, totalMatches, currentMatchIndex, onQueryChange, onNext, onPrev, onClose, }: PdfViewerSearchBarProps): React__default.ReactElement;
+
+interface PdfViewerSidebarProps {
+    document: PDFDocumentProxy;
+    numPages: number;
+    currentPage: number;
+    onPageClick: (page: number) => void;
+    sidebarMode: SidebarMode;
+    onSidebarModeChange: (mode: SidebarMode) => void;
+}
+declare function PdfViewerSidebar({ document, numPages, currentPage, onPageClick, sidebarMode, onSidebarModeChange, }: PdfViewerSidebarProps): React__default.ReactElement;
+
+interface PdfViewerToolbarProps {
+    currentPage: number;
+    numPages: number;
+    scale: number;
+    sidebarOpen: boolean;
+    onPageChange: (page: number) => void;
+    onScaleChange: (scale: number) => void;
+    onSearchOpen: () => void;
+    onSidebarToggle: () => void;
+    onDownload: () => void;
+    enableDownload: boolean;
+    onRotateLeft: () => void;
+    onRotateRight: () => void;
+}
+declare function PdfViewerToolbar({ currentPage, numPages, scale, sidebarOpen, onPageChange, onScaleChange, onSearchOpen, onSidebarToggle, onDownload, enableDownload, onRotateLeft, onRotateRight, }: PdfViewerToolbarProps): React__default.ReactElement;
+
+interface AnnotationPortalTarget {
+    pageNumber: number;
+    container: HTMLDivElement;
+    pageHeight: number;
+    scale: number;
+}
+declare function usePdfAnnotationPortals(pdfViewerRef: RefObject<PDFViewer | null>, eventBusRef: RefObject<EventBus | null>, document: PDFDocumentProxy | undefined): AnnotationPortalTarget[];
+
+interface UsePdfDocumentResult {
+    document: PDFDocumentProxy | undefined;
+    numPages: number;
+    loading: boolean;
+    error: Error | undefined;
+}
+declare function usePdfDocument(src: string | ArrayBuffer): UsePdfDocumentResult;
+
+declare function usePdfOutline(document: PDFDocumentProxy | undefined): OutlineItem[];
+
+interface UsePdfViewerResult {
+    pdfViewerRef: RefObject<PDFViewer | null>;
+    eventBusRef: RefObject<EventBus | null>;
+    findControllerRef: RefObject<PDFFindController | null>;
+}
+declare function usePdfViewer(containerRef: RefObject<HTMLDivElement | null>, viewerRef: RefObject<HTMLDivElement | null>, document: PDFDocumentProxy | undefined, initialScale?: number, initialPage?: number): UsePdfViewerResult;
+
+interface UsePdfViewerSearchResult {
+    query: string;
+    totalMatches: number;
+    currentMatchIndex: number;
+    isSearchOpen: boolean;
+    setQuery: (query: string) => void;
+    nextMatch: () => void;
+    prevMatch: () => void;
+    openSearch: () => void;
+    closeSearch: () => void;
+}
+declare function usePdfViewerSearch(eventBusRef: RefObject<EventBus | null>, findControllerRef: RefObject<PDFFindController | null>, document: PDFDocumentProxy | undefined): UsePdfViewerSearchResult;
+
+interface UsePdfViewerSyncOptions {
+    pdfViewerRef: RefObject<PDFViewer | null>;
+    eventBusRef: RefObject<EventBus | null>;
+    document: PDFDocumentProxy | undefined;
+    scale: number;
+    onScaleChange: (scale: number) => void;
+    onPageChange: (page: number) => void;
+}
+declare function usePdfViewerSync({ pdfViewerRef, eventBusRef, document, scale, onScaleChange, onPageChange, }: UsePdfViewerSyncOptions): {
+    scrollToPage: (page: number) => void;
+};
+
+interface UsePdfViewerCoreOptions {
+    /** PDF source — URL string or ArrayBuffer */
+    src: string | ArrayBuffer;
+    /** Initial page number (1-indexed, default 1) */
+    initialPage?: number;
+    /** Initial zoom scale (default 1.0) */
+    initialScale?: number;
+}
+interface UsePdfViewerCoreResult {
+    /** The loaded PDF document, or undefined while loading */
+    document: PDFDocumentProxy | undefined;
+    /** Total number of pages in the document */
+    numPages: number;
+    /** Whether the document is currently loading */
+    loading: boolean;
+    /** Error encountered while loading the document */
+    error: Error | undefined;
+    /** Ref to attach to the scroll-container div */
+    containerRef: RefObject<HTMLDivElement>;
+    /** Ref to attach to the inner viewer div (className="pdfViewer") */
+    viewerRef: RefObject<HTMLDivElement>;
+    /** Current page number (1-indexed) */
+    currentPage: number;
+    /** Navigate to a specific page (updates state and scrolls the viewer) */
+    scrollToPage: (page: number) => void;
+    /** Current zoom scale */
+    scale: number;
+    /** Set the zoom scale directly */
+    setScale: (scale: number) => void;
+    /** Portal targets for rendering annotation overlays on each page */
+    portalTargets: AnnotationPortalTarget[];
+    /** Ref to the internal pdfjs PDFViewer instance */
+    pdfViewerRef: RefObject<PDFViewer | null>;
+    /** Ref to the internal pdfjs EventBus instance */
+    eventBusRef: RefObject<EventBus | null>;
+    /** Ref to the internal pdfjs PDFFindController instance */
+    findControllerRef: RefObject<PDFFindController | null>;
+}
+declare function usePdfViewerCore({ src, initialPage, initialScale, }: UsePdfViewerCoreOptions): UsePdfViewerCoreResult;
 
-declare function BasePdfViewer({ src, annotations, onAnnotationClick, initialPage, initialScale, initialSidebarOpen, className, }: PdfViewerProps): React__default.ReactElement;
+interface UsePdfViewerStateOptions extends UsePdfViewerCoreOptions {
+    /** Whether the sidebar is initially open (default false) */
+    initialSidebarOpen?: boolean;
+    /** Which sidebar panel to show (default "thumbnails") */
+    sidebarMode?: SidebarMode;
+    /** Callback fired when a download completes or fails */
+    onDownload?: (result: PdfDownloadResult) => void;
+}
+interface UsePdfViewerStateResult extends UsePdfViewerCoreResult {
+    /** Zoom in by one step */
+    zoomIn: () => void;
+    /** Zoom out by one step */
+    zoomOut: () => void;
+    /** Current rotation in degrees (0, 90, 180, 270) */
+    rotation: number;
+    /** Rotate 90 degrees counter-clockwise */
+    rotateLeft: () => void;
+    /** Rotate 90 degrees clockwise */
+    rotateRight: () => void;
+    /** Whether the sidebar panel is open */
+    sidebarOpen: boolean;
+    /** Which sidebar panel is active */
+    sidebarMode: SidebarMode;
+    /** Change the active sidebar panel */
+    setSidebarMode: (mode: SidebarMode) => void;
+    /** Toggle sidebar open/closed */
+    toggleSidebar: () => void;
+    /** Search state and actions */
+    search: UsePdfViewerSearchResult;
+    /** Document outline items (from bookmarks or text extraction) */
+    outlineItems: ReturnType<typeof usePdfOutline>;
+    /** Download the PDF as a file */
+    download: (filename?: string) => void;
+}
+declare function usePdfViewerState({ src, initialPage, initialScale, initialSidebarOpen, sidebarMode: sidebarModeProp, onDownload, }: UsePdfViewerStateOptions): UsePdfViewerStateResult;
 
-interface PdfRendererProps extends Omit<PdfViewerProps, "src"> {
+interface PdfViewerMediaProps extends Omit<PdfViewerProps, "src"> {
     /** The Media object to fetch PDF contents from */
     media: Media;
 }
-declare function PdfRenderer({ media, className, ...pdfViewerProps }: PdfRendererProps): React__default.ReactElement;
+declare function PdfViewer({ media, className, ...pdfViewerProps }: PdfViewerMediaProps): React__default.ReactElement;
+
+/**
+ * A form field definition specifies configuration for a single field
+ */
+interface FormFieldDefinition<Q extends ActionDefinition<unknown>, K extends FieldKey<Q> = FieldKey<Q>> {
+    /**
+     * The field's unique key
+     */
+    fieldKey: K;
+    /**
+     * Display label for the field
+     * If not provided, the form field will not show any label.
+     */
+    label?: string;
+    /**
+     * Default value of the field
+     */
+    defaultValue?: FieldValueType<Q, K>;
+    /**
+     * The form field component type to render
+     */
+    fieldComponent: ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>;
+    /**
+     * Whether the field is required
+     */
+    isRequired?: boolean;
+    /**
+     * Placeholder text
+     */
+    placeholder?: string;
+    /**
+     * Additional information to display on this field
+     * The placement of helper text depends on the value of helperTextPlacement prop
+     */
+    helperText?: string;
+    /**
+     * The placement of the helper text either below the field or in a tooltip
+     *
+     * @default "tooltip"
+     */
+    helperTextPlacement?: "bottom" | "tooltip";
+    /**
+     * Whether the field is disabled
+     */
+    isDisabled?: boolean;
+    /**
+     * A callback to return a custom error message if validation failed
+     *
+     * @param validationRule the validation rule that failed with the error message
+     * @returns the error message to display
+     */
+    onValidationError?: (error: ValidationError) => string;
+    /**
+     * Additional function to validate the field
+     *
+     * @param value the current field value
+     * @returns a boolean promise indicating whether the value is valid
+     */
+    validate?: (value: FieldValueType<Q, K>) => Promise<boolean>;
+    /**
+     * The component props for the form field
+     * Excludes runtime props (key, onChange) which are managed by ActionForm
+     */
+    fieldComponentProps?: Omit<FormFieldPropsByType[ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>], "key" | "onChange">;
+}
+type ValidationError = {
+    type: ValidationRule;
+    error: string;
+};
+type ValidationRule = "required" | "min" | "max" | "minLength" | "maxLength" | "pattern" | "validate";
+/**
+ * Maps field types to their corresponding props
+ */
+interface FormFieldPropsByType {
+    DATETIME_PICKER: DatetimePickerFieldProps;
+    DROPDOWN: DropdownFieldProps<unknown, boolean>;
+    FILE_PICKER: FilePickerProps;
+    NUMBER_INPUT: NumberInputFieldProps;
+    OBJECT_SET: ObjectSetFieldProps<ObjectTypeDefinition>;
+    RADIO_BUTTONS: RadioButtonsFieldProps<unknown>;
+    TEXT_AREA: TextAreaFieldProps;
+    TEXT_INPUT: TextInputFieldProps;
+    CUSTOM: CustomFieldProps<unknown>;
+}
+/**
+ * Datetime picker field props.
+ *
+ * When `formatDate` is omitted, ISO-like format is used (YYYY-MM-DD / YYYY-MM-DD HH:mm).
+ */
+interface DatetimePickerFieldProps extends BaseFormFieldProps<Date> {
+    /**
+     * The earliest date the user can select.
+     * If provided, this will be added to the field validation.
+     */
+    min?: Date;
+    /**
+     * The latest date the user can select.
+     * If provided, this will be added to the field validation.
+     */
+    max?: Date;
+    /**
+     * Whether to show time picker.
+     */
+    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 trigger button. */
+    formatDate?: (date: Date) => string;
+}
+/**
+ * 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 a display string. Defaults to `String()`.
+     */
+    itemToStringLabel?: (item: V) => string;
+    /**
+     * 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;
+}
+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;
+}
+/**
+ * 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"> {
+}
+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>, Pick<React__default.InputHTMLAttributes<HTMLInputElement>, 
+/**
+ * If provided, this will be added to the field validation
+ */
+"min"
+/**
+ * If provided, this will be added to the field validation
+ */
+ | "max" | "step"> {
+}
+/**
+ * Radio buttons field props
+ */
+interface RadioButtonsFieldProps<V> extends BaseFormFieldProps<V> {
+    /**
+     * Available options for radio buttons
+     */
+    options: Option<V>[];
+}
+/**
+ * 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 BaseFormFieldProps<ObjectSet<T>> {
+}
+/**
+ * Custom field props for user-defined renderers
+ */
+interface CustomFieldProps<V> extends BaseFormFieldProps<V> {
+    /**
+     * Custom renderer function
+     */
+    customRenderer: (props: BaseFormFieldProps<V>) => React__default.ReactNode;
+}
+interface BaseFormFieldProps<V> {
+    /**
+     * The HTML `id` attribute for the field input element.
+     * Used for `<label htmlFor>` association.
+     */
+    id?: string;
+    /**
+     * The value of the form field
+     */
+    value: V | null;
+    /**
+     * 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
+ *
+ * TODO: Re-use `BaseType`
+ */
+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.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 = "DATETIME_PICKER" | "DROPDOWN" | "FILE_PICKER" | "NUMBER_INPUT" | "RADIO_BUTTONS" | "OBJECT_SET" | "TEXT_AREA" | "TEXT_INPUT" | "CUSTOM";
+/**
+ * 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" | {
+    type: "object";
+    object: string;
+} | {
+    type: "objectSet";
+    objectSet: string;
+} | {
+    type: "interface";
+    interface: string;
+} | {
+    type: "struct";
+    struct: Record<string, string>;
+};
+/**
+ * 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;
+        defaultValue?: unknown;
+        isRequired?: boolean;
+        placeholder?: string;
+        helperText?: string;
+        helperTextPlacement?: "bottom" | "tooltip";
+        fieldComponentProps?: Omit<FormFieldPropsByType[K], "value" | "onChange">;
+    };
+}[FieldComponent];
+/**
+ * Gets valid form field types for a given property type
+ */
+type ValidFormFieldForPropertyType<P extends FieldDescriptorType> = P extends "objectSet" ? "OBJECT_SET" : P extends "object" ? "DROPDOWN" : P extends "mediaReference" | "attachment" ? "FILE_PICKER" : P extends "boolean" ? "RADIO_BUTTONS" | "DROPDOWN" : P extends "string" ? "TEXT_INPUT" | "TEXT_AREA" : P extends "datetime" | "timestamp" ? "DATETIME_PICKER" : 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> & {
+    formState: FormState<Q>;
+    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"> {
+    actionDefinition: Q;
+    /**
+     * If not supplied, field definitions are constructed from `ActionParameters`.
+     */
+    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: (args: ActionParameters<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 there is an error in form submission
+     *
+     * @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: "validation";
+    error: ActionValidationError;
+} | {
+    type: "submission";
+    error: unknown;
+} | {
+    type: "unknown";
+    error: unknown;
+};
+/**
+ * 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`, and uncontrolled mode omits both.
+ * `onSubmit` receives the current form state so callers can access values
+ * even in uncontrolled mode.
+ */
+type BaseFormProps = BaseFormCommonProps & ({
+    formState: Record<string, unknown>;
+    onFieldValueChange: (fieldKey: string, value: unknown) => void;
+} | {
+    formState?: undefined;
+    onFieldValueChange?: (fieldKey: string, value: unknown) => void;
+});
+interface BaseFormCommonProps {
+    formTitle?: string;
+    fieldDefinitions: ReadonlyArray<RendererFieldDefinition>;
+    onSubmit: (formState: Record<string, unknown>) => void;
+    isSubmitDisabled?: boolean;
+    isPending?: boolean;
+    isLoading?: boolean;
+    className?: string;
+}
+
+declare const ActionForm: <Q extends ActionDefinition<unknown>>(props: ActionFormProps<Q>) => React__default.ReactElement;
+
+declare const BaseForm: React__default.FC<BaseFormProps>;
 
-export { type AnnotationType, BaseFilterList, type BaseFilterListProps, BasePdfViewer, BaseTable, type BaseTableProps, type CellEditInfo, ColumnConfigDialog, type ColumnConfigDialogProps, type ColumnConfigOptions, type ColumnDefinition, type ColumnDefinitionLocator, type CustomColumnLocator, type FilterComponentType, type FilterDefinitionUnion, FilterList, type FilterListItemProps, type FilterListProps, type FilterState, type FunctionColumnLocator, ObjectTable, type ObjectTableProps, type PdfAnnotation, PdfRenderer, type PdfRendererProps, type PdfViewerProps, type PropertyColumnLocator, type PropertyFilterDefinition, type RdpColumnLocator, type RenderFilterInput, deserializeFilterStates, serializeFilterStates };
+export { ActionForm, type ActionFormProps, type ActionParameters, type AnnotationPortalTarget, type AnnotationType, BaseFilterList, type BaseFilterListProps, BaseForm, type BaseFormFieldProps, type BaseFormProps, BasePdfViewer, BaseTable, type BaseTableProps, type CellEditInfo, ColumnConfigDialog, type ColumnConfigDialogProps, type ColumnConfigOptions, type ColumnDefinition, type ColumnDefinitionLocator, type CustomColumnLocator, type CustomFieldProps, type DatetimePickerFieldProps, type DropdownFieldProps, type FieldComponent, type FieldValueType, type FilePickerProps, type FilterComponentType, type FilterDefinitionUnion, FilterList, type FilterListItemProps, type FilterListProps, type FilterState, type FormError, type FormFieldDefinition, type FormFieldPropsByType, type FormState, type FunctionColumnLocator, type NumberInputFieldProps, type ObjectSetFieldProps, ObjectTable, type ObjectTableProps, type Option, type OutlineItem, type PdfAnnotation, type PdfDownloadResult, PdfViewer, PdfViewerAnnotationLayer, type PdfViewerAnnotationLayerProps, PdfViewerContent, type PdfViewerContentProps, type PdfViewerMediaProps, PdfViewerOutlineSidebar, type PdfViewerOutlineSidebarProps, type PdfViewerProps, PdfViewerSearchBar, type PdfViewerSearchBarProps, PdfViewerSidebar, type PdfViewerSidebarProps, PdfViewerToolbar, type PdfViewerToolbarProps, type PropertyColumnLocator, type PropertyFilterDefinition, type RadioButtonsFieldProps, type RdpColumnLocator, type RenderFilterInput, type RendererFieldDefinition, type SidebarMode, type TextAreaFieldProps, type TextInputFieldProps, type UsePdfViewerCoreOptions, type UsePdfViewerCoreResult, type UsePdfViewerResult, type UsePdfViewerSearchResult, type UsePdfViewerStateOptions, type UsePdfViewerStateResult, deserializeFilterStates, serializeFilterStates, usePdfAnnotationPortals, usePdfDocument, usePdfOutline, usePdfViewer, usePdfViewerCore, usePdfViewerSearch, usePdfViewerState, usePdfViewerSync };