@osdk/react-components 0.2.0-beta.24 → 0.2.0-beta.26

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

@@ -1,6 +1,7 @@
 import * as React from 'react';
 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 { ObjectTypeDefinition, ObjectSet, WhereClause, PropertyKeys, LinkNames, LinkedType, WirePropertyTypes, CompileTimeMetadata, ObjectOrInterfaceDefinition, SimplePropertyDef, QueryDefinition, Osdk, DerivedProperty, PrimaryKeyType, Media, ActionDefinition, ActionMetadata, ActionParam, DataValueClientToWire, ActionEditResponse, ActionValidationResponse } from '@osdk/api';
+import { QueryParameterType } from '@osdk/client/unstable-do-not-use';
 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';
@@ -604,7 +605,7 @@ type ColumnDefinition<Q extends ObjectOrInterfaceDefinition, RDPs extends Record
      */
     renderHeader?: () => React.ReactNode;
 };
-type ExtractQueryParameters<TQueryDef extends QueryDefinition> = TQueryDef["__DefinitionMetadata"] extends QueryMetadata ? TQueryDef["__DefinitionMetadata"]["parameters"] : never;
+type ExtractQueryParameters<Q extends QueryDefinition> = CompileTimeMetadata<Q>["parameters"] extends Record<string, never> ? undefined : QueryParameterType<CompileTimeMetadata<Q>["parameters"]>;
 interface PropertyColumnLocator<Q extends ObjectOrInterfaceDefinition> {
     type: "property";
     id: PropertyKeys<Q>;
@@ -622,7 +623,7 @@ interface FunctionColumnLocator<Q extends ObjectOrInterfaceDefinition, RDPs exte
      * @param objectSet - The current object set.
      * @returns - The function's input parameters including the object set.
      */
-    getFunctionParams: (objectSet: ObjectSet<Q>) => ExtractQueryParameters<FunctionColumns[keyof FunctionColumns]>;
+    getFunctionParams: (objectSet: ObjectSet<Q, RDPs>) => ExtractQueryParameters<FunctionColumns[keyof FunctionColumns]>;
     /**
      * Function to generate keys for looking up results in the FunctionsMap.
      * @param object - The object instance
@@ -931,27 +932,49 @@ interface OutlineItem {
     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. */
-interface PdfAnnotation {
+type AnnotationType = "highlight" | "underline" | "comment" | "pin" | "custom";
+/** A rectangle in PDF coordinate space (origin: bottom-left of page). */
+interface PdfRect {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/** Props passed to a custom annotation renderer. */
+interface PdfAnnotationRenderProps {
+    annotation: PdfAnnotation;
+    scale: number;
+    pageHeight: number;
+}
+/** Common fields shared by all annotation types. */
+interface PdfAnnotationBase {
     /** Unique identifier for this annotation */
     id: string;
-    /** The type of annotation to render */
-    type: AnnotationType;
     /** Page number (1-indexed) */
     page: number;
     /** Coordinates in PDF points (origin: bottom-left of page) */
-    rect: {
-        x: number;
-        y: number;
-        width: number;
-        height: number;
-    };
+    rect: PdfRect;
+    /** Additional rects for multi-line text highlights. When present, all rects are rendered. */
+    rects?: PdfRect[];
     /** Optional label or tooltip text */
     label?: string;
     /** Optional color override (CSS color string) */
     color?: string;
 }
+/** A built-in annotation type (highlight, underline, comment, pin). */
+interface PdfStandardAnnotation extends PdfAnnotationBase {
+    /** The type of annotation to render */
+    type: "highlight" | "underline" | "comment" | "pin";
+}
+/** A custom annotation with a user-provided renderer. */
+interface PdfCustomAnnotation extends PdfAnnotationBase {
+    /** Must be "custom" for custom-rendered annotations */
+    type: "custom";
+    /** Render function for the custom annotation content (required for custom type) */
+    render: (props: PdfAnnotationRenderProps) => React__default.ReactNode;
+}
+/** A single annotation positioned on a specific page of the PDF. */
+type PdfAnnotation = PdfStandardAnnotation | PdfCustomAnnotation;
 /** Result passed to the {@link PdfViewerProps.onDownload} callback. */
 type PdfDownloadResult = {
     success: true;
@@ -960,12 +983,72 @@ type PdfDownloadResult = {
     success: false;
     error: Error;
 };
+/** Possible values for a PDF form field. */
+type PdfFormFieldValue = string | boolean | string[];
+/** Data emitted when the user creates a text highlight via the highlight editor. */
+interface PdfTextHighlightEvent {
+    /** Internal PDF.js editor ID. Use with `deleteHighlight` to programmatically remove. */
+    editorId: string;
+    /** Page number (1-indexed) */
+    page: number;
+    /** Bounding rects in PDF coordinate space (bottom-left origin) */
+    rects: PdfRect[];
+    /** The selected text content */
+    selectedText: string;
+    /** Highlight color as CSS color string */
+    color: string;
+}
+/** Imperative handle for programmatic control of a {@link PdfViewer} or {@link BasePdfViewer}. */
+interface PdfViewerHandle {
+    /** Scroll the viewer to the given page number (1-indexed). */
+    scrollToPage: (page: number) => void;
+    /** Programmatically delete a highlight by its `editorId` (from {@link PdfTextHighlightEvent}). */
+    deleteHighlight: (editorId: string) => void;
+}
+/**
+ * Options for {@link usePdfViewerInstance}.
+ * Equivalent to {@link PdfViewerProps} minus the `className` rendering concern.
+ */
+interface PdfViewerInstanceOptions {
+    /** PDF source — URL string or ArrayBuffer */
+    src: string | ArrayBuffer;
+    /** Annotations to overlay on the PDF */
+    annotations?: PdfAnnotation[];
+    /** Callback fired when an annotation is clicked */
+    onAnnotationClick?: (annotation: PdfAnnotation) => void;
+    /** Callback fired when a download completes or fails */
+    onDownload?: (result: PdfDownloadResult) => void;
+    /** Whether the highlight toggle button is shown in the toolbar */
+    highlightEnabled?: boolean;
+    /** Callback fired when the user creates a text highlight */
+    onTextHighlight?: (event: PdfTextHighlightEvent) => void;
+    /** Callback fired when the user deletes a highlight */
+    onHighlightDelete?: (event: PdfTextHighlightEvent) => void;
+    /** Initial form field values keyed by field name */
+    formData?: Record<string, PdfFormFieldValue>;
+    /** Callback fired when the user clicks the save button */
+    onFormSubmit?: (data: Record<string, PdfFormFieldValue>) => void;
+    /** Callback fired when any form field value changes */
+    onFormChange?: (fieldName: string, value: PdfFormFieldValue) => 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 */
+    enableDownload?: boolean;
+    /** Which sidebar panel to show: thumbnails or document outline */
+    sidebarMode?: SidebarMode;
+    /** Custom icon components for each outline depth level (0-indexed) */
+    outlineIcons?: Partial<Record<number, React__default.ComponentType>>;
+}
 /** Props for the {@link PdfViewer} component. */
 interface PdfViewerProps {
     /** 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[]>;
+    /** Annotations to overlay on the PDF */
+    annotations?: PdfAnnotation[];
     /**
      * Callback fired when an annotation is clicked.
      *
@@ -980,6 +1063,26 @@ interface PdfViewerProps {
      * @returns void
      */
     onDownload?: (result: PdfDownloadResult) => void;
+    /**
+     * Whether the highlight toggle button is shown in the toolbar.
+     * @default false
+     */
+    enableHighlight?: boolean;
+    /**
+     * Callback fired when the user creates a text highlight.
+     * Only fires when highlight mode is active.
+     *
+     * @param event - The highlight event with page, rects, text, and color
+     * @returns void
+     */
+    onTextHighlight?: (event: PdfTextHighlightEvent) => void;
+    /**
+     * Callback fired when the user deletes a highlight via the PDF.js editor UI.
+     *
+     * @param event - The highlight event that was deleted
+     * @returns void
+     */
+    onHighlightDelete?: (event: PdfTextHighlightEvent) => void;
     /** Initial page number (1-indexed, default 1) */
     initialPage?: number;
     /** Initial zoom scale (default 1.0) */
@@ -1002,11 +1105,32 @@ interface PdfViewerProps {
      * If omitted, no icons are rendered.
      */
     outlineIcons?: Partial<Record<number, React__default.ComponentType>>;
+    /**
+     * Initial form field values keyed by field name. Applied when the document loads.
+     * Use this to pre-populate form fields when resuming a previously edited PDF.
+     */
+    formData?: Record<string, PdfFormFieldValue>;
+    /**
+     * Callback fired when the user clicks the save button in the toolbar.
+     * Receives all current form field values keyed by field name.
+     *
+     * @param data - All form field values keyed by field name
+     * @returns void
+     */
+    onFormSubmit?: (data: Record<string, PdfFormFieldValue>) => void;
+    /**
+     * Callback fired when any form field value changes.
+     *
+     * @param fieldName - The name of the field that changed
+     * @param value - The new value
+     * @returns void
+     */
+    onFormChange?: (fieldName: string, value: PdfFormFieldValue) => void;
     /** 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;
+declare const BasePdfViewer: React__default.ForwardRefExoticComponent<PdfViewerProps & React__default.RefAttributes<PdfViewerHandle>>;
 
 interface PdfViewerAnnotationLayerProps {
     annotations: PdfAnnotation[];
@@ -1019,8 +1143,8 @@ declare function PdfViewerAnnotationLayer({ annotations, pageHeight, scale, onAn
 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[]>;
+    /** Annotations to overlay on the PDF */
+    annotations?: PdfAnnotation[];
     /** Callback fired when an annotation is clicked */
     onAnnotationClick?: (annotation: PdfAnnotation) => void;
     /** Initial page number (1-indexed, default 1) */
@@ -1031,10 +1155,14 @@ interface PdfViewerContentProps {
     onPageChange?: (page: number) => void;
     /** Callback fired when the zoom scale changes */
     onScaleChange?: (scale: number) => void;
+    /** Initial form field values keyed by field name. Applied when the document loads. */
+    formData?: Record<string, PdfFormFieldValue>;
+    /** Callback fired when any form field value changes. */
+    onFormChange?: (fieldName: string, value: PdfFormFieldValue) => 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;
+declare function PdfViewerContent({ src, annotations, onAnnotationClick, initialPage, initialScale, onPageChange: onPageChangeProp, onScaleChange: onScaleChangeProp, formData, onFormChange, className, }: PdfViewerContentProps): React__default.ReactElement;
 
 interface PdfViewerOutlineSidebarProps {
     outlineItems: OutlineItem[];
@@ -1080,8 +1208,13 @@ interface PdfViewerToolbarProps {
     enableDownload: boolean;
     onRotateLeft: () => void;
     onRotateRight: () => void;
+    enableHighlight: boolean;
+    highlightModeActive: boolean;
+    onHighlightToggle: () => void;
+    enableFormSave?: boolean;
+    onFormSave?: () => void;
 }
-declare function PdfViewerToolbar({ currentPage, numPages, scale, sidebarOpen, onPageChange, onScaleChange, onSearchOpen, onSidebarToggle, onDownload, enableDownload, onRotateLeft, onRotateRight, }: PdfViewerToolbarProps): React__default.ReactElement;
+declare function PdfViewerToolbar({ currentPage, numPages, scale, sidebarOpen, onPageChange, onScaleChange, onSearchOpen, onSidebarToggle, onDownload, enableDownload, onRotateLeft, onRotateRight, enableHighlight, highlightModeActive, onHighlightToggle, enableFormSave, onFormSave, }: PdfViewerToolbarProps): React__default.ReactElement;
 
 interface AnnotationPortalTarget {
     pageNumber: number;
@@ -1091,6 +1224,11 @@ interface AnnotationPortalTarget {
 }
 declare function usePdfAnnotationPortals(pdfViewerRef: RefObject<PDFViewer | null>, eventBusRef: RefObject<EventBus | null>, document: PDFDocumentProxy | undefined): AnnotationPortalTarget[];
 
+/**
+ * Groups a flat array of annotations by page number for efficient per-page lookup.
+ */
+declare function usePdfAnnotationsByPage(annotations: PdfAnnotation[]): Record<number, PdfAnnotation[]>;
+
 interface UsePdfDocumentResult {
     document: PDFDocumentProxy | undefined;
     numPages: number;
@@ -1099,6 +1237,46 @@ interface UsePdfDocumentResult {
 }
 declare function usePdfDocument(src: string | ArrayBuffer): UsePdfDocumentResult;
 
+interface UsePdfFormFieldsOptions {
+    pdfViewerRef: RefObject<PDFViewer | null>;
+    eventBusRef: RefObject<EventBus | null>;
+    document: PDFDocumentProxy | undefined;
+    formData?: Record<string, PdfFormFieldValue>;
+    onFormSubmit?: (data: Record<string, PdfFormFieldValue>) => void;
+    onFormChange?: (fieldName: string, value: PdfFormFieldValue) => void;
+}
+interface UsePdfFormFieldsResult {
+    /** Whether the loaded PDF contains interactive form fields. */
+    hasFormFields: boolean;
+    /** Collect all current form field values and invoke onFormSubmit. */
+    submitFormData: () => void;
+}
+/**
+ * Hook that manages interactive PDF form fields.
+ * Builds a field metadata map, pre-populates initial values,
+ * listens for field changes, and collects values on submit.
+ */
+declare function usePdfFormFields({ pdfViewerRef, eventBusRef, document, formData, onFormSubmit, onFormChange, }: UsePdfFormFieldsOptions): UsePdfFormFieldsResult;
+
+interface UsePdfHighlightModeOptions {
+    pdfViewerRef: RefObject<PDFViewer | null>;
+    document: PDFDocumentProxy | undefined;
+    enabled: boolean;
+    onTextHighlight?: (event: PdfTextHighlightEvent) => void;
+    onHighlightDelete?: (event: PdfTextHighlightEvent) => void;
+}
+interface UsePdfHighlightModeResult {
+    highlightModeActive: boolean;
+    toggleHighlightMode: () => void;
+    deleteHighlight: (editorId: string) => void;
+}
+/**
+ * Hook that manages the PDF.js built-in highlight annotation editor mode.
+ * When active, users can select text to create highlights.
+ * A callback fires with the annotation details for persistence.
+ */
+declare function usePdfHighlightMode({ pdfViewerRef, document, enabled, onTextHighlight, onHighlightDelete, }: UsePdfHighlightModeOptions): UsePdfHighlightModeResult;
+
 declare function usePdfOutline(document: PDFDocumentProxy | undefined): OutlineItem[];
 
 interface UsePdfViewerResult {
@@ -1133,6 +1311,64 @@ declare function usePdfViewerSync({ pdfViewerRef, eventBusRef, document, scale,
     scrollToPage: (page: number) => void;
 };
 
+/** The shape of the value provided by {@link PdfViewerProvider}. */
+interface PdfViewerContextValue {
+    document: PDFDocumentProxy | undefined;
+    numPages: number;
+    loading: boolean;
+    error: Error | undefined;
+    containerRef: RefObject<HTMLDivElement>;
+    viewerRef: RefObject<HTMLDivElement>;
+    currentPage: number;
+    scrollToPage: (page: number) => void;
+    scale: number;
+    setScale: (scale: number) => void;
+    zoomIn: () => void;
+    zoomOut: () => void;
+    rotation: number;
+    rotateLeft: () => void;
+    rotateRight: () => void;
+    sidebarOpen: boolean;
+    sidebarMode: SidebarMode;
+    setSidebarMode: (mode: SidebarMode) => void;
+    toggleSidebar: () => void;
+    search: UsePdfViewerSearchResult;
+    outlineItems: OutlineItem[];
+    download: (filename?: string) => void;
+    portalTargets: AnnotationPortalTarget[];
+    highlightEnabled: boolean;
+    highlightModeActive: boolean;
+    toggleHighlightMode: () => void;
+    hasFormFields: boolean;
+    submitFormData: () => void;
+    annotations: PdfAnnotation[];
+    annotationsByPage: Record<number, PdfAnnotation[]>;
+    onAnnotationClick: ((annotation: PdfAnnotation) => void) | undefined;
+    enableDownload: boolean;
+    enableFormSave: boolean;
+    outlineIcons: Partial<Record<number, React__default.ComponentType>> | undefined;
+    pdfViewerRef: RefObject<PDFViewer | null>;
+    eventBusRef: RefObject<EventBus | null>;
+    findControllerRef: RefObject<PDFFindController | null>;
+}
+interface PdfViewerProviderProps {
+    value: PdfViewerContextValue;
+    children: React__default.ReactNode;
+}
+/** Provides {@link PdfViewerContextValue} to descendant components. */
+declare function PdfViewerProvider({ value, children }: PdfViewerProviderProps): React__default.ReactElement;
+/**
+ * Returns the nearest {@link PdfViewerContextValue} from a {@link PdfViewerProvider}.
+ * Throws if called outside a provider.
+ */
+declare function usePdfViewerContext(): PdfViewerContextValue;
+/**
+ * Consumer-facing setup hook analogous to react-hook-form's `useForm()`.
+ * Accepts viewer options and returns a {@link PdfViewerContextValue} suitable
+ * for passing to {@link PdfViewerProvider}.
+ */
+declare function usePdfViewerInstance(options: PdfViewerInstanceOptions): PdfViewerContextValue;
+
 interface UsePdfViewerCoreOptions {
     /** PDF source — URL string or ArrayBuffer */
     src: string | ArrayBuffer;
@@ -1275,9 +1511,9 @@ interface FormFieldDefinition<Q extends ActionDefinition<unknown>, K extends Fie
     validate?: (value: FieldValueType<Q, K>) => Promise<boolean>;
     /**
      * The component props for the form field
-     * Excludes runtime props (key, onChange) which are managed by ActionForm
+     * Excludes runtime props (value, onChange) which are managed by ActionForm
      */
-    fieldComponentProps?: Omit<FormFieldPropsByType[ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>], "key" | "onChange">;
+    fieldComponentProps: Omit<FormFieldPropsByType[ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>], "value" | "onChange">;
 }
 type ValidationError = {
     type: ValidationRule;
@@ -1393,6 +1629,7 @@ interface TextAreaFieldProps extends BaseFormFieldProps<string>, Pick<React__def
  * If provided, this will be added to the field validation
  */
  | "maxLength"> {
+    placeholder?: string;
 }
 interface TextInputFieldProps extends BaseFormFieldProps<string>, Pick<React__default.InputHTMLAttributes<HTMLInputElement>, 
 /**
@@ -1423,7 +1660,11 @@ interface NumberInputFieldProps extends BaseFormFieldProps<number>, Pick<React__
  */
 interface RadioButtonsFieldProps<V> extends BaseFormFieldProps<V> {
     /**
-     * Available options for radio buttons
+     * 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>[];
 }
@@ -1528,7 +1769,7 @@ type RendererFieldDefinition = {
         placeholder?: string;
         helperText?: string;
         helperTextPlacement?: "bottom" | "tooltip";
-        fieldComponentProps?: Omit<FormFieldPropsByType[K], "value" | "onChange">;
+        fieldComponentProps: Omit<FormFieldPropsByType[K], "value" | "onChange">;
     };
 }[FieldComponent];
 /**
@@ -1632,4 +1873,4 @@ declare const ActionForm: <Q extends ActionDefinition<unknown>>(props: ActionFor
 
 declare const BaseForm: React__default.FC<BaseFormProps>;
 
-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 };
+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 PdfAnnotationRenderProps, type PdfCustomAnnotation, type PdfDownloadResult, type PdfFormFieldValue, type PdfRect, type PdfTextHighlightEvent, PdfViewer, PdfViewerAnnotationLayer, type PdfViewerAnnotationLayerProps, PdfViewerContent, type PdfViewerContentProps, type PdfViewerContextValue, type PdfViewerHandle, type PdfViewerInstanceOptions, type PdfViewerMediaProps, PdfViewerOutlineSidebar, type PdfViewerOutlineSidebarProps, type PdfViewerProps, PdfViewerProvider, 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 UsePdfFormFieldsOptions, type UsePdfFormFieldsResult, type UsePdfHighlightModeOptions, type UsePdfHighlightModeResult, type UsePdfViewerCoreOptions, type UsePdfViewerCoreResult, type UsePdfViewerResult, type UsePdfViewerSearchResult, type UsePdfViewerStateOptions, type UsePdfViewerStateResult, deserializeFilterStates, serializeFilterStates, usePdfAnnotationPortals, usePdfAnnotationsByPage, usePdfDocument, usePdfFormFields, usePdfHighlightMode, usePdfOutline, usePdfViewer, usePdfViewerContext, usePdfViewerCore, usePdfViewerInstance, usePdfViewerSearch, usePdfViewerState, usePdfViewerSync };

package/build/cjs/public/primitives.cjs

@@ -1,25 +1,25 @@
 'use strict';
 
-var chunkGT6IV6LV_cjs = require('../chunk-GT6IV6LV.cjs');
+var chunkMRRRZN44_cjs = require('../chunk-MRRRZN44.cjs');
 require('../chunk-HMQTYQEX.cjs');
 
 
 
 Object.defineProperty(exports, "ActionButton", {
   enumerable: true,
-  get: function () { return chunkGT6IV6LV_cjs.ActionButton; }
+  get: function () { return chunkMRRRZN44_cjs.ActionButton; }
 });
 Object.defineProperty(exports, "Dialog", {
   enumerable: true,
-  get: function () { return chunkGT6IV6LV_cjs.Dialog; }
+  get: function () { return chunkMRRRZN44_cjs.Dialog; }
 });
 Object.defineProperty(exports, "Tooltip", {
   enumerable: true,
-  get: function () { return chunkGT6IV6LV_cjs.Tooltip; }
+  get: function () { return chunkMRRRZN44_cjs.Tooltip; }
 });
 Object.defineProperty(exports, "TooltipArrow", {
   enumerable: true,
-  get: function () { return chunkGT6IV6LV_cjs.TooltipArrow; }
+  get: function () { return chunkMRRRZN44_cjs.TooltipArrow; }
 });
 //# sourceMappingURL=primitives.cjs.map
 //# sourceMappingURL=primitives.cjs.map

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

@@ -8,13 +8,14 @@ declare function ActionButton({ variant, className, ...rest }: ButtonProps): Rea
 
 interface DialogProps {
     isOpen: boolean;
-    onOpenChange: () => void;
+    onOpenChange: (open: boolean) => void;
     title: React__default.ReactNode;
     children: React__default.ReactNode;
     footer?: React__default.ReactNode;
     className?: string;
+    disablePointerDismissal?: boolean;
 }
-declare function Dialog({ isOpen, onOpenChange, title, children, footer, className, }: DialogProps): React__default.ReactElement;
+declare function Dialog({ isOpen, onOpenChange, title, children, footer, className, disablePointerDismissal, }: DialogProps): React__default.ReactElement;
 
 interface TooltipProps extends Omit<TooltipRootProps, "className"> {
 }

package/build/esm/action-form/ActionForm.js

@@ -53,17 +53,21 @@ export const ActionForm = typedReactMemo(function ({
     }
   }, [metadataError, onError]);
   const parameters = metadata?.parameters;
-  const resolvedFieldDefinitions = useMemo(() => formFieldDefinitions ?? (metadata != null ? getDefaultFieldDefinitions(metadata) : EMPTY_FIELD_DEFINITIONS), [formFieldDefinitions, metadata]);
-  const rendererFieldDefinitions = useMemo(() =>
-  // RendererFieldDefinition is a discriminated union keyed by fieldComponent.
-  // TypeScript can't verify that the spread preserves the fieldComponent ↔
-  // fieldComponentProps pairing, but FormFieldDefinition guarantees it.
-  resolvedFieldDefinitions.map(def => ({
-    ...def,
-    fieldKey: String(def.fieldKey),
-    fieldType: parameters?.[String(def.fieldKey)]?.type,
-    defaultValue: def.defaultValue
-  })), [resolvedFieldDefinitions, parameters]);
+  const customFieldDefinitions = useMemo(() => {
+    if (formFieldDefinitions == null) {
+      return null;
+    }
+    // RendererFieldDefinition is a discriminated union keyed by fieldComponent.
+    // TypeScript can't verify that the spread preserves the fieldComponent ↔
+    // fieldComponentProps pairing, but FormFieldDefinition guarantees it.
+    return formFieldDefinitions.map(def => ({
+      ...def,
+      fieldKey: String(def.fieldKey),
+      fieldType: parameters?.[String(def.fieldKey)]?.type,
+      defaultValue: def.defaultValue
+    }));
+  }, [formFieldDefinitions, parameters]);
+  const rendererFieldDefinitions = useMemo(() => customFieldDefinitions ?? (metadata != null ? getDefaultFieldDefinitions(metadata) : EMPTY_FIELD_DEFINITIONS), [customFieldDefinitions, metadata]);
   const coerceFormState = useCallback(rawState => {
     const coerced = {};
     for (const [key, value] of Object.entries(rawState)) {

package/build/esm/action-form/ActionForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"ActionForm.js","names":["useOsdkMetadata","useOsdkAction","React","useCallback","useEffect","useMemo","typedReactMemo","BaseForm","coerceFieldValue","getDefaultFieldDefinitions","EMPTY_FIELD_DEFINITIONS","ActionForm","actionDefinition","formTitle","formFieldDefinitions","formState","controlledFormState","onFormStateChange","isSubmitDisabled","onSubmit","onValidationResponse","_onValidationResponse","onSuccess","onError","applyAction","osdkApplyAction","isPending","metadata","loading","metadataLoading","error","metadataError","type","parameters","resolvedFieldDefinitions","rendererFieldDefinitions","map","def","fieldKey","String","fieldType","defaultValue","coerceFormState","rawState","coerced","key","value","Object","entries","handleSubmit","rawFormState","result","e","handleFieldValueChange","prev","resolvedTitle","displayName","apiName","commonProps","fieldDefinitions","isLoading","onFieldValueChange","createElement","_extends"],"sources":["ActionForm.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { ActionDefinition } from \"@osdk/api\";\nimport { useOsdkMetadata } from \"@osdk/react\";\nimport { useOsdkAction } from \"@osdk/react/experimental\";\nimport React, { useCallback, useEffect, useMemo } from \"react\";\nimport { typedReactMemo } from \"../shared/typedMemo.js\";\nimport type { ActionFormProps, FormState } from \"./ActionFormApi.js\";\nimport { BaseForm } from \"./BaseForm.js\";\nimport type { RendererFieldDefinition } from \"./FormFieldApi.js\";\nimport { coerceFieldValue } from \"./utils/coerceFieldValue.js\";\nimport { getDefaultFieldDefinitions } from \"./utils/getDefaultFieldDefinitions.js\";\n\nconst EMPTY_FIELD_DEFINITIONS: readonly [] = [];\n\nexport const ActionForm: <Q extends ActionDefinition<unknown>>(\n  props: ActionFormProps<Q>,\n) => React.ReactElement = typedReactMemo(function ActionFormFn<\n  Q extends ActionDefinition<unknown>,\n>({\n  actionDefinition,\n  formTitle,\n  formFieldDefinitions,\n  formState: controlledFormState,\n  onFormStateChange,\n  isSubmitDisabled,\n  onSubmit,\n  onValidationResponse: _onValidationResponse,\n  onSuccess,\n  onError,\n}: ActionFormProps<Q>): React.ReactElement {\n  const { applyAction: osdkApplyAction, isPending } = useOsdkAction(\n    actionDefinition,\n  );\n  const {\n    metadata,\n    loading: metadataLoading,\n    error: metadataError,\n  } = useOsdkMetadata(actionDefinition);\n\n  useEffect(\n    function saveMetadataError() {\n      if (metadataError != null) {\n        onError?.({ type: \"unknown\", error: metadataError });\n      }\n    },\n    [metadataError, onError],\n  );\n\n  const parameters = metadata?.parameters;\n\n  const resolvedFieldDefinitions = useMemo(\n    () =>\n      formFieldDefinitions\n        ?? (metadata != null\n          ? getDefaultFieldDefinitions<Q>(metadata)\n          : EMPTY_FIELD_DEFINITIONS),\n    [formFieldDefinitions, metadata],\n  );\n\n  const rendererFieldDefinitions: ReadonlyArray<RendererFieldDefinition> =\n    useMemo(\n      () =>\n        // RendererFieldDefinition is a discriminated union keyed by fieldComponent.\n        // TypeScript can't verify that the spread preserves the fieldComponent ↔\n        // fieldComponentProps pairing, but FormFieldDefinition guarantees it.\n        resolvedFieldDefinitions.map((def) =>\n          ({\n            ...def,\n            fieldKey: String(def.fieldKey),\n            fieldType: parameters?.[String(def.fieldKey)]?.type,\n            defaultValue: def.defaultValue,\n          }) as RendererFieldDefinition\n        ),\n      [resolvedFieldDefinitions, parameters],\n    );\n\n  const coerceFormState = useCallback(\n    (rawState: Record<string, unknown>): Record<string, unknown> => {\n      const coerced: Record<string, unknown> = {};\n      for (const [key, value] of Object.entries(rawState)) {\n        coerced[key] = coerceFieldValue(parameters?.[key]?.type, value);\n      }\n      return coerced;\n    },\n    [parameters],\n  );\n\n  const handleSubmit = useCallback(\n    async (rawFormState: Record<string, unknown>) => {\n      const formState = coerceFormState(rawFormState) as FormState<Q>;\n      try {\n        if (onSubmit != null) {\n          await onSubmit(formState, osdkApplyAction);\n        } else {\n          const result = await osdkApplyAction(formState);\n          onSuccess?.(result);\n        }\n      } catch (e) {\n        onError?.({ type: \"submission\", error: e });\n      }\n    },\n    [coerceFormState, onSubmit, osdkApplyAction, onSuccess, onError],\n  );\n\n  const handleFieldValueChange = useCallback(\n    (fieldKey: string, value: unknown) => {\n      onFormStateChange?.(\n        (prev) =>\n          ({\n            ...prev,\n            [fieldKey]: value,\n          }) as FormState<Q>,\n      );\n    },\n    [onFormStateChange],\n  );\n\n  const resolvedTitle = formTitle ?? metadata?.displayName\n    ?? actionDefinition.apiName;\n\n  const isControlled = controlledFormState != null;\n\n  const commonProps = {\n    formTitle: resolvedTitle,\n    fieldDefinitions: rendererFieldDefinitions,\n    onSubmit: handleSubmit,\n    isSubmitDisabled,\n    isPending,\n    isLoading: metadataLoading,\n    onFieldValueChange: handleFieldValueChange,\n  };\n\n  if (!isControlled) {\n    return <BaseForm {...commonProps} />;\n  }\n\n  return <BaseForm {...commonProps} formState={controlledFormState} />;\n});\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,eAAe,QAAQ,aAAa;AAC7C,SAASC,aAAa,QAAQ,0BAA0B;AACxD,OAAOC,KAAK,IAAIC,WAAW,EAAEC,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAC9D,SAASC,cAAc,QAAQ,wBAAwB;AAEvD,SAASC,QAAQ,QAAQ,eAAe;AAExC,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,0BAA0B,QAAQ,uCAAuC;AAElF,MAAMC,uBAAoC,GAAG,EAAE;AAE/C,OAAO,MAAMC,UAEU,GAAGL,cAAc,CAAC,UAEvC;EACAM,gBAAgB;EAChBC,SAAS;EACTC,oBAAoB;EACpBC,SAAS,EAAEC,mBAAmB;EAC9BC,iBAAiB;EACjBC,gBAAgB;EAChBC,QAAQ;EACRC,oBAAoB,EAAEC,qBAAqB;EAC3CC,SAAS;EACTC;AACkB,CAAC,EAAsB;EACzC,MAAM;IAAEC,WAAW,EAAEC,eAAe;IAAEC;EAAU,CAAC,GAAGzB,aAAa,CAC/DW,gBACF,CAAC;EACD,MAAM;IACJe,QAAQ;IACRC,OAAO,EAAEC,eAAe;IACxBC,KAAK,EAAEC;EACT,CAAC,GAAG/B,eAAe,CAACY,gBAAgB,CAAC;EAErCR,SAAS,CACP,YAA6B;IAC3B,IAAI2B,aAAa,IAAI,IAAI,EAAE;MACzBR,OAAO,GAAG;QAAES,IAAI,EAAE,SAAS;QAAEF,KAAK,EAAEC;MAAc,CAAC,CAAC;IACtD;EACF,CAAC,EACD,CAACA,aAAa,EAAER,OAAO,CACzB,CAAC;EAED,MAAMU,UAAU,GAAGN,QAAQ,EAAEM,UAAU;EAEvC,MAAMC,wBAAwB,GAAG7B,OAAO,CACtC,MACES,oBAAoB,KACda,QAAQ,IAAI,IAAI,GAChBlB,0BAA0B,CAAIkB,QAAQ,CAAC,GACvCjB,uBAAuB,CAAC,EAChC,CAACI,oBAAoB,EAAEa,QAAQ,CACjC,CAAC;EAED,MAAMQ,wBAAgE,GACpE9B,OAAO,CACL;EACE;EACA;EACA;EACA6B,wBAAwB,CAACE,GAAG,CAAEC,GAAG,KAC9B;IACC,GAAGA,GAAG;IACNC,QAAQ,EAAEC,MAAM,CAACF,GAAG,CAACC,QAAQ,CAAC;IAC9BE,SAAS,EAAEP,UAAU,GAAGM,MAAM,CAACF,GAAG,CAACC,QAAQ,CAAC,CAAC,EAAEN,IAAI;IACnDS,YAAY,EAAEJ,GAAG,CAACI;EACpB,CAAC,CACH,CAAC,EACH,CAACP,wBAAwB,EAAED,UAAU,CACvC,CAAC;EAEH,MAAMS,eAAe,GAAGvC,WAAW,CAChCwC,QAAiC,IAA8B;IAC9D,MAAMC,OAAgC,GAAG,CAAC,CAAC;IAC3C,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACL,QAAQ,CAAC,EAAE;MACnDC,OAAO,CAACC,GAAG,CAAC,GAAGrC,gBAAgB,CAACyB,UAAU,GAAGY,GAAG,CAAC,EAAEb,IAAI,EAAEc,KAAK,CAAC;IACjE;IACA,OAAOF,OAAO;EAChB,CAAC,EACD,CAACX,UAAU,CACb,CAAC;EAED,MAAMgB,YAAY,GAAG9C,WAAW,CAC9B,MAAO+C,YAAqC,IAAK;IAC/C,MAAMnC,SAAS,GAAG2B,eAAe,CAACQ,YAAY,CAAiB;IAC/D,IAAI;MACF,IAAI/B,QAAQ,IAAI,IAAI,EAAE;QACpB,MAAMA,QAAQ,CAACJ,SAAS,EAAEU,eAAe,CAAC;MAC5C,CAAC,MAAM;QACL,MAAM0B,MAAM,GAAG,MAAM1B,eAAe,CAACV,SAAS,CAAC;QAC/CO,SAAS,GAAG6B,MAAM,CAAC;MACrB;IACF,CAAC,CAAC,OAAOC,CAAC,EAAE;MACV7B,OAAO,GAAG;QAAES,IAAI,EAAE,YAAY;QAAEF,KAAK,EAAEsB;MAAE,CAAC,CAAC;IAC7C;EACF,CAAC,EACD,CAACV,eAAe,EAAEvB,QAAQ,EAAEM,eAAe,EAAEH,SAAS,EAAEC,OAAO,CACjE,CAAC;EAED,MAAM8B,sBAAsB,GAAGlD,WAAW,CACxC,CAACmC,QAAgB,EAAEQ,KAAc,KAAK;IACpC7B,iBAAiB,GACdqC,IAAI,KACF;MACC,GAAGA,IAAI;MACP,CAAChB,QAAQ,GAAGQ;IACd,CAAC,CACL,CAAC;EACH,CAAC,EACD,CAAC7B,iBAAiB,CACpB,CAAC;EAED,MAAMsC,aAAa,GAAG1C,SAAS,IAAIc,QAAQ,EAAE6B,WAAW,IACnD5C,gBAAgB,CAAC6C,OAAO;EAI7B,MAAMC,WAAW,GAAG;IAClB7C,SAAS,EAAE0C,aAAa;IACxBI,gBAAgB,EAAExB,wBAAwB;IAC1ChB,QAAQ,EAAE8B,YAAY;IACtB/B,gBAAgB;IAChBQ,SAAS;IACTkC,SAAS,EAAE/B,eAAe;IAC1BgC,kBAAkB,EAAER;EACtB,CAAC;EAED,IAAI,EAZiBrC,mBAAmB,IAAI,IAAI,CAY/B,EAAE;IACjB,oBAAOd,KAAA,CAAA4D,aAAA,CAACvD,QAAQ,EAAKmD,WAAc,CAAC;EACtC;EAEA,oBAAOxD,KAAA,CAAA4D,aAAA,CAACvD,QAAQ,EAAAwD,QAAA,KAAKL,WAAW;IAAE3C,SAAS,EAAEC;EAAoB,EAAE,CAAC;AACtE,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"ActionForm.js","names":["useOsdkMetadata","useOsdkAction","React","useCallback","useEffect","useMemo","typedReactMemo","BaseForm","coerceFieldValue","getDefaultFieldDefinitions","EMPTY_FIELD_DEFINITIONS","ActionForm","actionDefinition","formTitle","formFieldDefinitions","formState","controlledFormState","onFormStateChange","isSubmitDisabled","onSubmit","onValidationResponse","_onValidationResponse","onSuccess","onError","applyAction","osdkApplyAction","isPending","metadata","loading","metadataLoading","error","metadataError","type","parameters","customFieldDefinitions","map","def","fieldKey","String","fieldType","defaultValue","rendererFieldDefinitions","coerceFormState","rawState","coerced","key","value","Object","entries","handleSubmit","rawFormState","result","e","handleFieldValueChange","prev","resolvedTitle","displayName","apiName","commonProps","fieldDefinitions","isLoading","onFieldValueChange","createElement","_extends"],"sources":["ActionForm.tsx"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type { ActionDefinition } from \"@osdk/api\";\nimport { useOsdkMetadata } from \"@osdk/react\";\nimport { useOsdkAction } from \"@osdk/react/experimental\";\nimport React, { useCallback, useEffect, useMemo } from \"react\";\nimport { typedReactMemo } from \"../shared/typedMemo.js\";\nimport type { ActionFormProps, FormState } from \"./ActionFormApi.js\";\nimport { BaseForm } from \"./BaseForm.js\";\nimport type { RendererFieldDefinition } from \"./FormFieldApi.js\";\nimport { coerceFieldValue } from \"./utils/coerceFieldValue.js\";\nimport { getDefaultFieldDefinitions } from \"./utils/getDefaultFieldDefinitions.js\";\n\nconst EMPTY_FIELD_DEFINITIONS: readonly [] = [];\n\nexport const ActionForm: <Q extends ActionDefinition<unknown>>(\n  props: ActionFormProps<Q>,\n) => React.ReactElement = typedReactMemo(function ActionFormFn<\n  Q extends ActionDefinition<unknown>,\n>({\n  actionDefinition,\n  formTitle,\n  formFieldDefinitions,\n  formState: controlledFormState,\n  onFormStateChange,\n  isSubmitDisabled,\n  onSubmit,\n  onValidationResponse: _onValidationResponse,\n  onSuccess,\n  onError,\n}: ActionFormProps<Q>): React.ReactElement {\n  const { applyAction: osdkApplyAction, isPending } = useOsdkAction(\n    actionDefinition,\n  );\n  const {\n    metadata,\n    loading: metadataLoading,\n    error: metadataError,\n  } = useOsdkMetadata(actionDefinition);\n\n  useEffect(\n    function saveMetadataError() {\n      if (metadataError != null) {\n        onError?.({ type: \"unknown\", error: metadataError });\n      }\n    },\n    [metadataError, onError],\n  );\n\n  const parameters = metadata?.parameters;\n\n  const customFieldDefinitions: ReadonlyArray<RendererFieldDefinition> | null =\n    useMemo(() => {\n      if (formFieldDefinitions == null) {\n        return null;\n      }\n      // RendererFieldDefinition is a discriminated union keyed by fieldComponent.\n      // TypeScript can't verify that the spread preserves the fieldComponent ↔\n      // fieldComponentProps pairing, but FormFieldDefinition guarantees it.\n      return formFieldDefinitions.map(\n        (def) =>\n          ({\n            ...def,\n            fieldKey: String(def.fieldKey),\n            fieldType: parameters?.[String(def.fieldKey)]?.type,\n            defaultValue: def.defaultValue,\n          }) as RendererFieldDefinition,\n      );\n    }, [formFieldDefinitions, parameters]);\n\n  const rendererFieldDefinitions = useMemo(\n    () =>\n      customFieldDefinitions\n        ?? (metadata != null\n          ? getDefaultFieldDefinitions(metadata)\n          : EMPTY_FIELD_DEFINITIONS),\n    [customFieldDefinitions, metadata],\n  );\n\n  const coerceFormState = useCallback(\n    (rawState: Record<string, unknown>): Record<string, unknown> => {\n      const coerced: Record<string, unknown> = {};\n      for (const [key, value] of Object.entries(rawState)) {\n        coerced[key] = coerceFieldValue(parameters?.[key]?.type, value);\n      }\n      return coerced;\n    },\n    [parameters],\n  );\n\n  const handleSubmit = useCallback(\n    async (rawFormState: Record<string, unknown>) => {\n      const formState = coerceFormState(rawFormState) as FormState<Q>;\n      try {\n        if (onSubmit != null) {\n          await onSubmit(formState, osdkApplyAction);\n        } else {\n          const result = await osdkApplyAction(formState);\n          onSuccess?.(result);\n        }\n      } catch (e) {\n        onError?.({ type: \"submission\", error: e });\n      }\n    },\n    [coerceFormState, onSubmit, osdkApplyAction, onSuccess, onError],\n  );\n\n  const handleFieldValueChange = useCallback(\n    (fieldKey: string, value: unknown) => {\n      onFormStateChange?.(\n        (prev) =>\n          ({\n            ...prev,\n            [fieldKey]: value,\n          }) as FormState<Q>,\n      );\n    },\n    [onFormStateChange],\n  );\n\n  const resolvedTitle = formTitle ?? metadata?.displayName\n    ?? actionDefinition.apiName;\n\n  const isControlled = controlledFormState != null;\n\n  const commonProps = {\n    formTitle: resolvedTitle,\n    fieldDefinitions: rendererFieldDefinitions,\n    onSubmit: handleSubmit,\n    isSubmitDisabled,\n    isPending,\n    isLoading: metadataLoading,\n    onFieldValueChange: handleFieldValueChange,\n  };\n\n  if (!isControlled) {\n    return <BaseForm {...commonProps} />;\n  }\n\n  return <BaseForm {...commonProps} formState={controlledFormState} />;\n});\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAGA,SAASA,eAAe,QAAQ,aAAa;AAC7C,SAASC,aAAa,QAAQ,0BAA0B;AACxD,OAAOC,KAAK,IAAIC,WAAW,EAAEC,SAAS,EAAEC,OAAO,QAAQ,OAAO;AAC9D,SAASC,cAAc,QAAQ,wBAAwB;AAEvD,SAASC,QAAQ,QAAQ,eAAe;AAExC,SAASC,gBAAgB,QAAQ,6BAA6B;AAC9D,SAASC,0BAA0B,QAAQ,uCAAuC;AAElF,MAAMC,uBAAoC,GAAG,EAAE;AAE/C,OAAO,MAAMC,UAEU,GAAGL,cAAc,CAAC,UAEvC;EACAM,gBAAgB;EAChBC,SAAS;EACTC,oBAAoB;EACpBC,SAAS,EAAEC,mBAAmB;EAC9BC,iBAAiB;EACjBC,gBAAgB;EAChBC,QAAQ;EACRC,oBAAoB,EAAEC,qBAAqB;EAC3CC,SAAS;EACTC;AACkB,CAAC,EAAsB;EACzC,MAAM;IAAEC,WAAW,EAAEC,eAAe;IAAEC;EAAU,CAAC,GAAGzB,aAAa,CAC/DW,gBACF,CAAC;EACD,MAAM;IACJe,QAAQ;IACRC,OAAO,EAAEC,eAAe;IACxBC,KAAK,EAAEC;EACT,CAAC,GAAG/B,eAAe,CAACY,gBAAgB,CAAC;EAErCR,SAAS,CACP,YAA6B;IAC3B,IAAI2B,aAAa,IAAI,IAAI,EAAE;MACzBR,OAAO,GAAG;QAAES,IAAI,EAAE,SAAS;QAAEF,KAAK,EAAEC;MAAc,CAAC,CAAC;IACtD;EACF,CAAC,EACD,CAACA,aAAa,EAAER,OAAO,CACzB,CAAC;EAED,MAAMU,UAAU,GAAGN,QAAQ,EAAEM,UAAU;EAEvC,MAAMC,sBAAqE,GACzE7B,OAAO,CAAC,MAAM;IACZ,IAAIS,oBAAoB,IAAI,IAAI,EAAE;MAChC,OAAO,IAAI;IACb;IACA;IACA;IACA;IACA,OAAOA,oBAAoB,CAACqB,GAAG,CAC5BC,GAAG,KACD;MACC,GAAGA,GAAG;MACNC,QAAQ,EAAEC,MAAM,CAACF,GAAG,CAACC,QAAQ,CAAC;MAC9BE,SAAS,EAAEN,UAAU,GAAGK,MAAM,CAACF,GAAG,CAACC,QAAQ,CAAC,CAAC,EAAEL,IAAI;MACnDQ,YAAY,EAAEJ,GAAG,CAACI;IACpB,CAAC,CACL,CAAC;EACH,CAAC,EAAE,CAAC1B,oBAAoB,EAAEmB,UAAU,CAAC,CAAC;EAExC,MAAMQ,wBAAwB,GAAGpC,OAAO,CACtC,MACE6B,sBAAsB,KAChBP,QAAQ,IAAI,IAAI,GAChBlB,0BAA0B,CAACkB,QAAQ,CAAC,GACpCjB,uBAAuB,CAAC,EAChC,CAACwB,sBAAsB,EAAEP,QAAQ,CACnC,CAAC;EAED,MAAMe,eAAe,GAAGvC,WAAW,CAChCwC,QAAiC,IAA8B;IAC9D,MAAMC,OAAgC,GAAG,CAAC,CAAC;IAC3C,KAAK,MAAM,CAACC,GAAG,EAAEC,KAAK,CAAC,IAAIC,MAAM,CAACC,OAAO,CAACL,QAAQ,CAAC,EAAE;MACnDC,OAAO,CAACC,GAAG,CAAC,GAAGrC,gBAAgB,CAACyB,UAAU,GAAGY,GAAG,CAAC,EAAEb,IAAI,EAAEc,KAAK,CAAC;IACjE;IACA,OAAOF,OAAO;EAChB,CAAC,EACD,CAACX,UAAU,CACb,CAAC;EAED,MAAMgB,YAAY,GAAG9C,WAAW,CAC9B,MAAO+C,YAAqC,IAAK;IAC/C,MAAMnC,SAAS,GAAG2B,eAAe,CAACQ,YAAY,CAAiB;IAC/D,IAAI;MACF,IAAI/B,QAAQ,IAAI,IAAI,EAAE;QACpB,MAAMA,QAAQ,CAACJ,SAAS,EAAEU,eAAe,CAAC;MAC5C,CAAC,MAAM;QACL,MAAM0B,MAAM,GAAG,MAAM1B,eAAe,CAACV,SAAS,CAAC;QAC/CO,SAAS,GAAG6B,MAAM,CAAC;MACrB;IACF,CAAC,CAAC,OAAOC,CAAC,EAAE;MACV7B,OAAO,GAAG;QAAES,IAAI,EAAE,YAAY;QAAEF,KAAK,EAAEsB;MAAE,CAAC,CAAC;IAC7C;EACF,CAAC,EACD,CAACV,eAAe,EAAEvB,QAAQ,EAAEM,eAAe,EAAEH,SAAS,EAAEC,OAAO,CACjE,CAAC;EAED,MAAM8B,sBAAsB,GAAGlD,WAAW,CACxC,CAACkC,QAAgB,EAAES,KAAc,KAAK;IACpC7B,iBAAiB,GACdqC,IAAI,KACF;MACC,GAAGA,IAAI;MACP,CAACjB,QAAQ,GAAGS;IACd,CAAC,CACL,CAAC;EACH,CAAC,EACD,CAAC7B,iBAAiB,CACpB,CAAC;EAED,MAAMsC,aAAa,GAAG1C,SAAS,IAAIc,QAAQ,EAAE6B,WAAW,IACnD5C,gBAAgB,CAAC6C,OAAO;EAI7B,MAAMC,WAAW,GAAG;IAClB7C,SAAS,EAAE0C,aAAa;IACxBI,gBAAgB,EAAElB,wBAAwB;IAC1CtB,QAAQ,EAAE8B,YAAY;IACtB/B,gBAAgB;IAChBQ,SAAS;IACTkC,SAAS,EAAE/B,eAAe;IAC1BgC,kBAAkB,EAAER;EACtB,CAAC;EAED,IAAI,EAZiBrC,mBAAmB,IAAI,IAAI,CAY/B,EAAE;IACjB,oBAAOd,KAAA,CAAA4D,aAAA,CAACvD,QAAQ,EAAKmD,WAAc,CAAC;EACtC;EAEA,oBAAOxD,KAAA,CAAA4D,aAAA,CAACvD,QAAQ,EAAAwD,QAAA,KAAKL,WAAW;IAAE3C,SAAS,EAAEC;EAAoB,EAAE,CAAC;AACtE,CAAC,CAAC","ignoreList":[]}

package/build/esm/action-form/FormFieldApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"FormFieldApi.js","names":[],"sources":["FormFieldApi.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ActionDefinition,\n  ActionMetadata,\n  ActionParam,\n  CompileTimeMetadata,\n  DataValueClientToWire,\n  ObjectSet,\n  ObjectTypeDefinition,\n} from \"@osdk/api\";\nimport type React from \"react\";\n\n/**\n * A form field definition specifies configuration for a single field\n */\nexport interface FormFieldDefinition<\n  Q extends ActionDefinition<unknown>,\n  K extends FieldKey<Q> = FieldKey<Q>,\n> {\n  /**\n   * The field's unique key\n   */\n  fieldKey: K;\n\n  /**\n   * Display label for the field\n   * If not provided, the form field will not show any label.\n   */\n  label?: string;\n\n  /**\n   * Default value of the field\n   */\n  defaultValue?: FieldValueType<Q, K>;\n\n  /**\n   * The form field component type to render\n   */\n  fieldComponent: ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>;\n\n  /**\n   * Whether the field is required\n   */\n  isRequired?: boolean;\n\n  /**\n   * Placeholder text\n   */\n  placeholder?: string;\n\n  /**\n   * Additional information to display on this field\n   * The placement of helper text depends on the value of helperTextPlacement prop\n   */\n  helperText?: string;\n\n  /**\n   * The placement of the helper text either below the field or in a tooltip\n   *\n   * @default \"tooltip\"\n   */\n  helperTextPlacement?: \"bottom\" | \"tooltip\";\n\n  /**\n   * Whether the field is disabled\n   */\n  isDisabled?: boolean;\n\n  /**\n   * A callback to return a custom error message if validation failed\n   *\n   * @param validationRule the validation rule that failed with the error message\n   * @returns the error message to display\n   */\n  onValidationError?: (error: ValidationError) => string;\n\n  /**\n   * Additional function to validate the field\n   *\n   * @param value the current field value\n   * @returns a boolean promise indicating whether the value is valid\n   */\n  validate?: (value: FieldValueType<Q, K>) => Promise<boolean>;\n\n  /**\n   * The component props for the form field\n   * Excludes runtime props (key, onChange) which are managed by ActionForm\n   */\n  fieldComponentProps?: Omit<\n    FormFieldPropsByType[\n      ValidFormFieldForPropertyType<\n        FieldDescriptorType<Q, K>\n      >\n    ],\n    \"key\" | \"onChange\"\n  >;\n}\n\ntype ValidationError = { type: ValidationRule; error: string };\n\ntype ValidationRule =\n  | \"required\"\n  | \"min\"\n  | \"max\"\n  | \"minLength\"\n  | \"maxLength\"\n  | \"pattern\"\n  | \"validate\";\n\n/**\n * Maps field types to their corresponding props\n */\nexport interface FormFieldPropsByType {\n  DATETIME_PICKER: DatetimePickerFieldProps;\n  DROPDOWN: DropdownFieldProps<unknown, boolean>;\n  FILE_PICKER: FilePickerProps;\n  NUMBER_INPUT: NumberInputFieldProps;\n  OBJECT_SET: ObjectSetFieldProps<ObjectTypeDefinition>;\n  RADIO_BUTTONS: RadioButtonsFieldProps<unknown>;\n  TEXT_AREA: TextAreaFieldProps;\n  TEXT_INPUT: TextInputFieldProps;\n  CUSTOM: CustomFieldProps<unknown>;\n}\n\n/**\n * Datetime picker field props.\n *\n * When `formatDate` is omitted, ISO-like format is used (YYYY-MM-DD / YYYY-MM-DD HH:mm).\n */\nexport interface DatetimePickerFieldProps extends BaseFormFieldProps<Date> {\n  /**\n   * The earliest date the user can select.\n   * If provided, this will be added to the field validation.\n   */\n  min?: Date;\n\n  /**\n   * The latest date the user can select.\n   * If provided, this will be added to the field validation.\n   */\n  max?: Date;\n\n  /**\n   * Whether to show time picker.\n   */\n  showTime?: boolean;\n\n  /**\n   * Whether to close the popover after selecting a date.\n   * @default true when `showTime` is false, false when `showTime` is true\n   */\n  closeOnSelection?: boolean;\n\n  /**\n   * Placeholder text shown when no value is selected.\n   */\n  placeholder?: string;\n\n  /** Formats a Date for display in the trigger button. */\n  formatDate?: (date: Date) => string;\n}\n\n/**\n * Dropdown field props with selectable items\n */\nexport interface DropdownFieldProps<V, Multiple extends boolean = false>\n  extends BaseFormFieldProps<Multiple extends true ? V[] : V>\n{\n  /**\n   * Available items for the dropdown\n   */\n  items: V[];\n\n  /**\n   * Converts an item to a display string. Defaults to `String()`.\n   */\n  itemToStringLabel?: (item: V) => string;\n\n  /**\n   * Returns a unique string key for a list item. Used as the React `key`.\n   * Falls back to the item's index when not provided.\n   */\n  itemToKey?: (item: V) => string;\n\n  /**\n   * Custom equality check for item values. Defaults to `Object.is`.\n   * Required when items are objects to ensure correct selection matching.\n   */\n  isItemEqual?: (a: V, b: V) => boolean;\n\n  /**\n   * Whether the dropdown allows searching/filtering.\n   * When true, renders a Combobox with a search input.\n   * When false (default), renders a Select dropdown.\n   */\n  isSearchable?: boolean;\n\n  /**\n   * Placeholder text shown when no value is selected.\n   */\n  placeholder?: string;\n\n  /**\n   * Whether multiple values can be selected\n   */\n  isMultiple?: Multiple;\n}\n\nexport interface FilePickerProps extends BaseFormFieldProps<File | File[]> {\n  /**\n   * Whether multiple files can be selected\n   */\n  isMulti?: boolean;\n\n  /**\n   * Accepted file types (e.g., \"image/*\", \".pdf\")\n   */\n  accept?: string | string[];\n\n  /**\n   * Maximum file size in bytes\n   */\n  maxSize?: number;\n}\n\n/**\n * Text area field props\n */\nexport interface TextAreaFieldProps extends\n  BaseFormFieldProps<string>,\n  Pick<\n    React.TextareaHTMLAttributes<HTMLTextAreaElement>,\n    | \"rows\"\n    | \"wrap\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"minLength\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"maxLength\"\n  >\n{}\n\nexport interface TextInputFieldProps extends\n  BaseFormFieldProps<string>,\n  Pick<\n    React.InputHTMLAttributes<HTMLInputElement>,\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"minLength\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"maxLength\"\n  >\n{\n  placeholder?: string;\n}\n\n/**\n * Number input field props\n */\nexport interface NumberInputFieldProps extends\n  BaseFormFieldProps<number>,\n  Pick<\n    React.InputHTMLAttributes<HTMLInputElement>,\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"min\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"max\"\n    | \"step\"\n  >\n{}\n\n/**\n * Radio buttons field props\n */\nexport interface RadioButtonsFieldProps<V> extends BaseFormFieldProps<V> {\n  /**\n   * Available options for radio buttons\n   */\n  options: Option<V>[];\n}\n\n/**\n * Option interface for radio button options\n */\nexport interface Option<V> {\n  label: string;\n  value: V;\n}\n\n/**\n * Object set field displays the summary of the count of the given object set\n */\nexport interface ObjectSetFieldProps<T extends ObjectTypeDefinition>\n  extends BaseFormFieldProps<ObjectSet<T>>\n{}\n\n/**\n * Custom field props for user-defined renderers\n */\nexport interface CustomFieldProps<V> extends BaseFormFieldProps<V> {\n  /**\n   * Custom renderer function\n   */\n  customRenderer: (props: BaseFormFieldProps<V>) => React.ReactNode;\n}\n\nexport interface BaseFormFieldProps<V> {\n  /**\n   * The HTML `id` attribute for the field input element.\n   * Used for `<label htmlFor>` association.\n   */\n  id?: string;\n\n  /**\n   * The value of the form field\n   */\n  value: V | null;\n  /**\n   * Called when the field value changes.\n   *\n   * ActionForm internally wraps this to pass the key to `onFieldValueChange`:\n   * ```\n   * <DropdownField\n   *   {...fieldDef}\n   *   onChange={(value) => onFieldValueChange(fieldDef.key, value)}\n   * />\n   * ```\n   *\n   * @param value The new value of the form field\n   */\n  onChange?: (value: V | null) => void;\n}\n\nexport type FieldKey<Q extends ActionDefinition<unknown>> =\n  keyof ActionParameters<Q>;\n\n/**\n * Extracts parameters from an ActionDefinition\n */\nexport type ActionParameters<Q extends ActionDefinition<unknown>> =\n  CompileTimeMetadata<Q>[\"parameters\"];\n\n/**\n * Extracts the value type for a specific parameter\n *\n * TODO: Re-use `BaseType`\n */\nexport type FieldValueType<\n  Q extends ActionDefinition<unknown>,\n  K extends keyof ActionParameters<Q> = keyof ActionParameters<Q>,\n> = ActionParameters<Q>[K][\"type\"] extends\n  ActionMetadata.DataType.Object<infer T> ? ActionParam.ObjectType<T>\n  : ActionParameters<Q>[K][\"type\"] extends ActionMetadata.DataType.ObjectSet<\n    infer T\n  > ? ActionParam.ObjectSetType<T>\n  : ActionParameters<Q>[K][\"type\"] extends ActionMetadata.DataType.Struct<\n    infer T\n  > ? ActionParam.StructType<T>\n  : ActionParameters<Q>[K][\"type\"] extends keyof DataValueClientToWire\n    ? DataValueClientToWire[ActionParameters<Q>[K][\"type\"]]\n  : never;\n\n/**\n * Extracts the parameter type descriptor for a specific action parameter.\n */\nexport type FieldDescriptorType<\n  Q extends ActionDefinition<unknown> = ActionDefinition<unknown>,\n  K extends keyof ActionParameters<Q> = keyof ActionParameters<Q>,\n> = ActionParameters<Q>[K][\"type\"];\n\n/**\n * Available form field component types\n */\nexport type FieldComponent =\n  | \"DATETIME_PICKER\"\n  | \"DROPDOWN\"\n  | \"FILE_PICKER\"\n  | \"NUMBER_INPUT\"\n  | \"RADIO_BUTTONS\"\n  | \"OBJECT_SET\"\n  | \"TEXT_AREA\"\n  | \"TEXT_INPUT\"\n  | \"CUSTOM\";\n\n/**\n * Describes the data type of a form field, independent of OSDK.\n * Mirrors ActionMetadata.DataType to keep the rendering layer OSDK-agnostic.\n */\nexport type FieldType =\n  | \"boolean\"\n  | \"string\"\n  | \"integer\"\n  | \"long\"\n  | \"double\"\n  | \"datetime\"\n  | \"timestamp\"\n  | \"attachment\"\n  | \"marking\"\n  | \"mediaReference\"\n  | \"objectType\"\n  | \"geoshape\"\n  | \"geohash\"\n  | { type: \"object\"; object: string }\n  | { type: \"objectSet\"; objectSet: string }\n  | { type: \"interface\"; interface: string }\n  | { type: \"struct\"; struct: Record<string, string> };\n\n/**\n * An OSDK-agnostic field definition used by BaseForm and FormFieldRenderer.\n * Contains only the information needed to render a single field — no generics,\n * no compile-time parameter constraints.\n *\n * Implemented as a distributed mapped type: switching on `fieldComponent`\n * narrows `fieldComponentProps` to the correct props type automatically.\n */\nexport type RendererFieldDefinition = {\n  [K in FieldComponent]: {\n    fieldKey: string;\n    fieldComponent: K;\n    fieldType?: FieldType;\n    label?: string;\n    defaultValue?: unknown;\n    isRequired?: boolean;\n    placeholder?: string;\n    helperText?: string;\n    helperTextPlacement?: \"bottom\" | \"tooltip\";\n    fieldComponentProps?: Omit<FormFieldPropsByType[K], \"value\" | \"onChange\">;\n  };\n}[FieldComponent];\n\n/**\n * Gets valid form field types for a given property type\n */\nexport type ValidFormFieldForPropertyType<P extends FieldDescriptorType> =\n  P extends \"objectSet\" ? \"OBJECT_SET\"\n    : P extends \"object\" ? \"DROPDOWN\"\n    : P extends \"mediaReference\" | \"attachment\" ? \"FILE_PICKER\"\n    : P extends \"boolean\" ? \"RADIO_BUTTONS\" | \"DROPDOWN\"\n    : P extends \"string\" ? \"TEXT_INPUT\" | \"TEXT_AREA\"\n    : P extends \"datetime\" | \"timestamp\" ? \"DATETIME_PICKER\"\n    : P extends\n      | \"double\"\n      | \"integer\"\n      | \"long\"\n      | \"float\"\n      | \"short\"\n      | \"byte\"\n      | \"decimal\" ? \"NUMBER_INPUT\"\n    : never;\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"FormFieldApi.js","names":[],"sources":["FormFieldApi.ts"],"sourcesContent":["/*\n * Copyright 2025 Palantir Technologies, Inc. All rights reserved.\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport type {\n  ActionDefinition,\n  ActionMetadata,\n  ActionParam,\n  CompileTimeMetadata,\n  DataValueClientToWire,\n  ObjectSet,\n  ObjectTypeDefinition,\n} from \"@osdk/api\";\nimport type React from \"react\";\n\n/**\n * A form field definition specifies configuration for a single field\n */\nexport interface FormFieldDefinition<\n  Q extends ActionDefinition<unknown>,\n  K extends FieldKey<Q> = FieldKey<Q>,\n> {\n  /**\n   * The field's unique key\n   */\n  fieldKey: K;\n\n  /**\n   * Display label for the field\n   * If not provided, the form field will not show any label.\n   */\n  label?: string;\n\n  /**\n   * Default value of the field\n   */\n  defaultValue?: FieldValueType<Q, K>;\n\n  /**\n   * The form field component type to render\n   */\n  fieldComponent: ValidFormFieldForPropertyType<FieldDescriptorType<Q, K>>;\n\n  /**\n   * Whether the field is required\n   */\n  isRequired?: boolean;\n\n  /**\n   * Placeholder text\n   */\n  placeholder?: string;\n\n  /**\n   * Additional information to display on this field\n   * The placement of helper text depends on the value of helperTextPlacement prop\n   */\n  helperText?: string;\n\n  /**\n   * The placement of the helper text either below the field or in a tooltip\n   *\n   * @default \"tooltip\"\n   */\n  helperTextPlacement?: \"bottom\" | \"tooltip\";\n\n  /**\n   * Whether the field is disabled\n   */\n  isDisabled?: boolean;\n\n  /**\n   * A callback to return a custom error message if validation failed\n   *\n   * @param validationRule the validation rule that failed with the error message\n   * @returns the error message to display\n   */\n  onValidationError?: (error: ValidationError) => string;\n\n  /**\n   * Additional function to validate the field\n   *\n   * @param value the current field value\n   * @returns a boolean promise indicating whether the value is valid\n   */\n  validate?: (value: FieldValueType<Q, K>) => Promise<boolean>;\n\n  /**\n   * The component props for the form field\n   * Excludes runtime props (value, onChange) which are managed by ActionForm\n   */\n  fieldComponentProps: Omit<\n    FormFieldPropsByType[\n      ValidFormFieldForPropertyType<\n        FieldDescriptorType<Q, K>\n      >\n    ],\n    \"value\" | \"onChange\"\n  >;\n}\n\ntype ValidationError = { type: ValidationRule; error: string };\n\ntype ValidationRule =\n  | \"required\"\n  | \"min\"\n  | \"max\"\n  | \"minLength\"\n  | \"maxLength\"\n  | \"pattern\"\n  | \"validate\";\n\n/**\n * Maps field types to their corresponding props\n */\nexport interface FormFieldPropsByType {\n  DATETIME_PICKER: DatetimePickerFieldProps;\n  DROPDOWN: DropdownFieldProps<unknown, boolean>;\n  FILE_PICKER: FilePickerProps;\n  NUMBER_INPUT: NumberInputFieldProps;\n  OBJECT_SET: ObjectSetFieldProps<ObjectTypeDefinition>;\n  RADIO_BUTTONS: RadioButtonsFieldProps<unknown>;\n  TEXT_AREA: TextAreaFieldProps;\n  TEXT_INPUT: TextInputFieldProps;\n  CUSTOM: CustomFieldProps<unknown>;\n}\n\n/**\n * Datetime picker field props.\n *\n * When `formatDate` is omitted, ISO-like format is used (YYYY-MM-DD / YYYY-MM-DD HH:mm).\n */\nexport interface DatetimePickerFieldProps extends BaseFormFieldProps<Date> {\n  /**\n   * The earliest date the user can select.\n   * If provided, this will be added to the field validation.\n   */\n  min?: Date;\n\n  /**\n   * The latest date the user can select.\n   * If provided, this will be added to the field validation.\n   */\n  max?: Date;\n\n  /**\n   * Whether to show time picker.\n   */\n  showTime?: boolean;\n\n  /**\n   * Whether to close the popover after selecting a date.\n   * @default true when `showTime` is false, false when `showTime` is true\n   */\n  closeOnSelection?: boolean;\n\n  /**\n   * Placeholder text shown when no value is selected.\n   */\n  placeholder?: string;\n\n  /** Formats a Date for display in the trigger button. */\n  formatDate?: (date: Date) => string;\n}\n\n/**\n * Dropdown field props with selectable items\n */\nexport interface DropdownFieldProps<V, Multiple extends boolean = false>\n  extends BaseFormFieldProps<Multiple extends true ? V[] : V>\n{\n  /**\n   * Available items for the dropdown\n   */\n  items: V[];\n\n  /**\n   * Converts an item to a display string. Defaults to `String()`.\n   */\n  itemToStringLabel?: (item: V) => string;\n\n  /**\n   * Returns a unique string key for a list item. Used as the React `key`.\n   * Falls back to the item's index when not provided.\n   */\n  itemToKey?: (item: V) => string;\n\n  /**\n   * Custom equality check for item values. Defaults to `Object.is`.\n   * Required when items are objects to ensure correct selection matching.\n   */\n  isItemEqual?: (a: V, b: V) => boolean;\n\n  /**\n   * Whether the dropdown allows searching/filtering.\n   * When true, renders a Combobox with a search input.\n   * When false (default), renders a Select dropdown.\n   */\n  isSearchable?: boolean;\n\n  /**\n   * Placeholder text shown when no value is selected.\n   */\n  placeholder?: string;\n\n  /**\n   * Whether multiple values can be selected\n   */\n  isMultiple?: Multiple;\n}\n\nexport interface FilePickerProps extends BaseFormFieldProps<File | File[]> {\n  /**\n   * Whether multiple files can be selected\n   */\n  isMulti?: boolean;\n\n  /**\n   * Accepted file types (e.g., \"image/*\", \".pdf\")\n   */\n  accept?: string | string[];\n\n  /**\n   * Maximum file size in bytes\n   */\n  maxSize?: number;\n}\n\n/**\n * Text area field props\n */\nexport interface TextAreaFieldProps extends\n  BaseFormFieldProps<string>,\n  Pick<\n    React.TextareaHTMLAttributes<HTMLTextAreaElement>,\n    | \"rows\"\n    | \"wrap\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"minLength\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"maxLength\"\n  >\n{\n  placeholder?: string;\n}\n\nexport interface TextInputFieldProps extends\n  BaseFormFieldProps<string>,\n  Pick<\n    React.InputHTMLAttributes<HTMLInputElement>,\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"minLength\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"maxLength\"\n  >\n{\n  placeholder?: string;\n}\n\n/**\n * Number input field props\n */\nexport interface NumberInputFieldProps extends\n  BaseFormFieldProps<number>,\n  Pick<\n    React.InputHTMLAttributes<HTMLInputElement>,\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"min\"\n    /**\n     * If provided, this will be added to the field validation\n     */\n    | \"max\"\n    | \"step\"\n  >\n{}\n\n/**\n * Radio buttons field props\n */\nexport interface RadioButtonsFieldProps<V> extends BaseFormFieldProps<V> {\n  /**\n   * Available options for radio buttons.\n   *\n   * Values are compared by reference equality (`===`). When options contain\n   * non-primitive values, pass the same object references for `value` and\n   * the corresponding option entry.\n   */\n  options: Option<V>[];\n}\n\n/**\n * Option interface for radio button options\n */\nexport interface Option<V> {\n  label: string;\n  value: V;\n}\n\n/**\n * Object set field displays the summary of the count of the given object set\n */\nexport interface ObjectSetFieldProps<T extends ObjectTypeDefinition>\n  extends BaseFormFieldProps<ObjectSet<T>>\n{}\n\n/**\n * Custom field props for user-defined renderers\n */\nexport interface CustomFieldProps<V> extends BaseFormFieldProps<V> {\n  /**\n   * Custom renderer function\n   */\n  customRenderer: (props: BaseFormFieldProps<V>) => React.ReactNode;\n}\n\nexport interface BaseFormFieldProps<V> {\n  /**\n   * The HTML `id` attribute for the field input element.\n   * Used for `<label htmlFor>` association.\n   */\n  id?: string;\n\n  /**\n   * The value of the form field\n   */\n  value: V | null;\n  /**\n   * Called when the field value changes.\n   *\n   * ActionForm internally wraps this to pass the key to `onFieldValueChange`:\n   * ```\n   * <DropdownField\n   *   {...fieldDef}\n   *   onChange={(value) => onFieldValueChange(fieldDef.key, value)}\n   * />\n   * ```\n   *\n   * @param value The new value of the form field\n   */\n  onChange?: (value: V | null) => void;\n}\n\nexport type FieldKey<Q extends ActionDefinition<unknown>> =\n  keyof ActionParameters<Q>;\n\n/**\n * Extracts parameters from an ActionDefinition\n */\nexport type ActionParameters<Q extends ActionDefinition<unknown>> =\n  CompileTimeMetadata<Q>[\"parameters\"];\n\n/**\n * Extracts the value type for a specific parameter\n *\n * TODO: Re-use `BaseType`\n */\nexport type FieldValueType<\n  Q extends ActionDefinition<unknown>,\n  K extends keyof ActionParameters<Q> = keyof ActionParameters<Q>,\n> = ActionParameters<Q>[K][\"type\"] extends\n  ActionMetadata.DataType.Object<infer T> ? ActionParam.ObjectType<T>\n  : ActionParameters<Q>[K][\"type\"] extends ActionMetadata.DataType.ObjectSet<\n    infer T\n  > ? ActionParam.ObjectSetType<T>\n  : ActionParameters<Q>[K][\"type\"] extends ActionMetadata.DataType.Struct<\n    infer T\n  > ? ActionParam.StructType<T>\n  : ActionParameters<Q>[K][\"type\"] extends keyof DataValueClientToWire\n    ? DataValueClientToWire[ActionParameters<Q>[K][\"type\"]]\n  : never;\n\n/**\n * Extracts the parameter type descriptor for a specific action parameter.\n */\nexport type FieldDescriptorType<\n  Q extends ActionDefinition<unknown> = ActionDefinition<unknown>,\n  K extends keyof ActionParameters<Q> = keyof ActionParameters<Q>,\n> = ActionParameters<Q>[K][\"type\"];\n\n/**\n * Available form field component types\n */\nexport type FieldComponent =\n  | \"DATETIME_PICKER\"\n  | \"DROPDOWN\"\n  | \"FILE_PICKER\"\n  | \"NUMBER_INPUT\"\n  | \"RADIO_BUTTONS\"\n  | \"OBJECT_SET\"\n  | \"TEXT_AREA\"\n  | \"TEXT_INPUT\"\n  | \"CUSTOM\";\n\n/**\n * Describes the data type of a form field, independent of OSDK.\n * Mirrors ActionMetadata.DataType to keep the rendering layer OSDK-agnostic.\n */\nexport type FieldType =\n  | \"boolean\"\n  | \"string\"\n  | \"integer\"\n  | \"long\"\n  | \"double\"\n  | \"datetime\"\n  | \"timestamp\"\n  | \"attachment\"\n  | \"marking\"\n  | \"mediaReference\"\n  | \"objectType\"\n  | \"geoshape\"\n  | \"geohash\"\n  | { type: \"object\"; object: string }\n  | { type: \"objectSet\"; objectSet: string }\n  | { type: \"interface\"; interface: string }\n  | { type: \"struct\"; struct: Record<string, string> };\n\n/**\n * An OSDK-agnostic field definition used by BaseForm and FormFieldRenderer.\n * Contains only the information needed to render a single field — no generics,\n * no compile-time parameter constraints.\n *\n * Implemented as a distributed mapped type: switching on `fieldComponent`\n * narrows `fieldComponentProps` to the correct props type automatically.\n */\nexport type RendererFieldDefinition = {\n  [K in FieldComponent]: {\n    fieldKey: string;\n    fieldComponent: K;\n    fieldType?: FieldType;\n    label?: string;\n    defaultValue?: unknown;\n    isRequired?: boolean;\n    placeholder?: string;\n    helperText?: string;\n    helperTextPlacement?: \"bottom\" | \"tooltip\";\n    fieldComponentProps: Omit<FormFieldPropsByType[K], \"value\" | \"onChange\">;\n  };\n}[FieldComponent];\n\n/**\n * Gets valid form field types for a given property type\n */\nexport type ValidFormFieldForPropertyType<P extends FieldDescriptorType> =\n  P extends \"objectSet\" ? \"OBJECT_SET\"\n    : P extends \"object\" ? \"DROPDOWN\"\n    : P extends \"mediaReference\" | \"attachment\" ? \"FILE_PICKER\"\n    : P extends \"boolean\" ? \"RADIO_BUTTONS\" | \"DROPDOWN\"\n    : P extends \"string\" ? \"TEXT_INPUT\" | \"TEXT_AREA\"\n    : P extends \"datetime\" | \"timestamp\" ? \"DATETIME_PICKER\"\n    : P extends\n      | \"double\"\n      | \"integer\"\n      | \"long\"\n      | \"float\"\n      | \"short\"\n      | \"byte\"\n      | \"decimal\" ? \"NUMBER_INPUT\"\n    : never;\n"],"mappings":"","ignoreList":[]}