@object-ui/fields 16.0.0 → 17.1.0

package/dist/index.d.ts

@@ -67,7 +67,7 @@ export interface DateDisplayOptions {
 }
 /**
  * Format date as relative time (e.g., "3 days ago", "Today", "Overdue 3d"),
- * localized via `Intl.RelativeTimeFormat` (objectstack-ai/framework#3040).
+ * localized via `Intl.RelativeTimeFormat` (objectstack-ai/objectstack#3040).
  *
  * `dueLike` gates the "Overdue" wording — a past `start_date`/`created_at`
  * isn't overdue, only a past due/deadline-semantic field is. Non-due-like
@@ -162,7 +162,17 @@ export declare function PhoneCellRenderer({ value }: CellRendererProps): React.R
  */
 export declare function FileCellRenderer({ value, field }: CellRendererProps): React.ReactElement;
 /**
- * Image field cell renderer (with thumbnails)
+ * Image field cell renderer (with thumbnails + click-to-zoom).
+ *
+ * An image value may be a plain URL string, an object ({ url | src | href … }),
+ * a bare `sys_file` id, or an array of any of those. Normalising through
+ * `readFileValues` (which resolves a bare id to its stable download URL) means
+ * a string-URL field, a CDN link, and an unexpanded reference all render a
+ * thumbnail instead of a broken `<img src="">` placeholder.
+ *
+ * Clicking a thumbnail opens a full-screen lightbox (single or gallery). The
+ * click is `stopPropagation`-guarded so, inside a grid row, enlarging an image
+ * doesn't also trigger row navigation.
  */
 export declare function ImageCellRenderer({ value }: CellRendererProps): React.ReactElement;
 /**
@@ -234,15 +244,7 @@ export declare function LocationCellRenderer({ value }: CellRendererProps): Reac
  * Get the appropriate cell renderer for a field type
  */
 export declare function getCellRenderer(fieldType: string): React.FC<CellRendererProps>;
-/**
- * Map field type to form component type
- *
- * @param fieldType - The ObjectQL field type identifier to convert
- * (for example: `"text"`, `"number"`, `"date"`, `"lookup"`).
- * @returns The normalized form field type string used in the form schema
- * (for example: `"input"`, `"textarea"`, `"date-picker"`, `"select"`).
- */
-export declare function mapFieldTypeToFormType(fieldType: string): string;
+export { mapFieldTypeToFormType } from './field-type-alias';
 /**
  * Formats file size in bytes to human-readable string
  * @param bytes - File size in bytes (must be non-negative)
@@ -269,6 +271,27 @@ export declare function evaluateCondition(condition: any, formData: any): boolea
  * `INLINE_EXCLUDED_FIELD_TYPES` and its drift-guard test.
  */
 export declare const FORM_FIELD_TYPES: readonly string[];
+/**
+ * Resolve an arbitrary field-type spelling to the widget key the form uses.
+ * A key already present in the widget map resolves to itself; spec aliases
+ * (`toggle`, `json`, `repeater`, `secret`, …) resolve through
+ * {@link mapFieldTypeToFormType}; anything unknown falls back to `text` —
+ * the same fallback the form renderer applies.
+ *
+ * Consumers that render field widgets outside the form (e.g. the app-shell
+ * `ActionParamDialog`) use this + {@link getLazyFieldWidget} so their type
+ * support can never drift behind the form surface (ADR-0059).
+ */
+export declare function resolveFormWidgetType(fieldType: string): string;
+/**
+ * Lazily-loaded form field widget for a field type. Shares the exact loaders
+ * of {@link fieldWidgetMap} (the same components `registerField` registers for
+ * forms), wrapped in `React.lazy` and cached per type — so a consumer can
+ * render any form-supported field type without eagerly bundling every widget.
+ * Render inside a `<Suspense>` boundary. Unknown types resolve to the `text`
+ * widget via {@link resolveFormWidgetType}.
+ */
+export declare function getLazyFieldWidget(fieldType: string): React.ComponentType<any>;
 export declare function registerField(fieldType: string): void;
 /**
  * Register all field types (for backward compatibility)
@@ -287,6 +310,7 @@ export declare function registerAllFields(): void;
  */
 export declare function registerFields(): void;
 export * from './widgets/types';
+export * from './widgets/file-value';
 export * from './FieldEditWidget';
 export * from './widgets/TextField';
 export * from './widgets/NumberField';