@object-ui/fields 17.1.0 → 17.3.0

package/dist/widgets/QRCodeField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * QR Code field widget - generates QR codes from text
  * Uses a simple SVG-based QR code generator
  */
-export declare function QRCodeField({ value, onChange, field, readonly, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function QRCodeField({ value, onChange, field, readonly, error, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/RadioField.d.ts

@@ -1,5 +1,5 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * RadioField - choose exactly one value from a fixed option set, rendered as a
  * radio group. The stored value is the selected option value (string). Used for
@@ -12,4 +12,4 @@ import { FieldWidgetProps } from './types';
  * first" hint while a dependency is empty, and a value no longer offered (parent
  * changed / predicate flipped) is cleared.
  */
-export declare function RadioField({ value, onChange, field, readonly, className, schema, dependentValues, dependsOn: dependsOnProp, emptyHint: _emptyHint, dataSource: _dataSource, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function RadioField({ value, onChange, field, readonly, className, dependentValues, dependsOn: dependsOnProp, emptyHint, dataSource: _dataSource, error, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/RatingField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * Rating field widget - provides a star rating input
  * Supports numeric values from 0 to max (default 5)
  */
-export declare function RatingField({ value, onChange, field, readonly, className, ...props }: FieldWidgetProps<number>): React.JSX.Element;
+export declare function RatingField({ value, onChange, field, readonly, className, error, ...props }: FieldWidgetComponentProps<number>): React.JSX.Element;

package/dist/widgets/RecipientPickerField.d.ts

@@ -1,4 +1,4 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
-export declare function RecipientPickerField({ value, onChange, readonly, className, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+import { FieldWidgetComponentProps } from './types';
+export declare function RecipientPickerField({ value, onChange, readonly, className, error, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;
 export default RecipientPickerField;

package/dist/widgets/RecordPickerDialog.d.ts

@@ -140,6 +140,22 @@ export interface RecordPickerDialogProps {
      * Typically pass `getCellRenderer` from @object-ui/fields.
      */
     cellRenderer?: CellRendererResolver;
+    /**
+     * The referenced object's schema `fields` map (field name → field
+     * definition). When provided, cell renderers receive the FULL field
+     * metadata — `options`, `currency`, `scale`, `precision`, `format`,
+     * `reference_to`, … — exactly like the list view enriches its columns from
+     * the object schema. Without it a `select` column falls back to
+     * title-casing the raw stored value instead of resolving the option label
+     * (#3333: `manufacturing` rendered as "Manufacturing" instead of the
+     * authored option label).
+     *
+     * The filter bar reads the same map: a `select` filter column with no
+     * authored `options` takes them from the schema field here, so the filter
+     * panel's dropdown offers exactly the options the table cells render
+     * (#3336 — it used to open empty, leaving the field unfilterable).
+     */
+    fieldsMeta?: Record<string, any>;
     /**
      * Filter bar column definitions.
      * When provided, shows an inline filter bar below the search input.
@@ -185,4 +201,4 @@ export interface RecordPickerDialogProps {
  * states, and single/multi-select.  Responsive: mobile-friendly width
  * via Tailwind breakpoints.
  */
-export declare function RecordPickerDialog({ open, onOpenChange, title, multiple, dataSource, objectName, columns: columnsProp, displayField, titleFormat, idField, pageSize, value, onSelect, onSelectRecords, lookupFilters, baseFilter, cellRenderer, filterColumns, renderFilterBar, renderGrid, }: RecordPickerDialogProps): React.JSX.Element;
+export declare function RecordPickerDialog({ open, onOpenChange, title, multiple, dataSource, objectName, columns: columnsProp, displayField, titleFormat, idField, pageSize, value, onSelect, onSelectRecords, lookupFilters, baseFilter, cellRenderer, fieldsMeta, filterColumns, renderFilterBar, renderGrid, }: RecordPickerDialogProps): React.JSX.Element;

package/dist/widgets/RecordPickerDialog.filterOptions.test.d.ts

@@ -0,0 +1,8 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export {};

package/dist/widgets/RecordPickerDialog.selectLabel.test.d.ts

@@ -0,0 +1,8 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export {};

package/dist/widgets/RichTextField.d.ts

@@ -1,8 +1,26 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * Rich text field with markdown/HTML support
  * For now, this is a simple textarea. A full implementation would use
  * a rich text editor like TipTap, Lexical, or Slate.
+ *
+ * Reached by forms as `field:markdown` and `field:html`; both resolve here.
+ *
+ * ## Fullscreen editing (objectui#3301)
+ *
+ * `ObjectForm` stamps `mobile_fullscreen` onto the metadata of every long-text
+ * field — textarea AND rich-text — when `ObjectFormSchema.mobile
+ * .fullscreenLongText` is set, and `ObjectFormSchema.mobile`'s own JSDoc has
+ * always promised "textarea/rich-text get an expand button". This widget never
+ * read the flag, so for `field:markdown` / `field:html` that promise did
+ * nothing at all: the producer stamped, and no consumer existed.
+ *
+ * The flag is read off `field` and nowhere else — the single metadata carrier
+ * since objectui#3233 — matching `TextAreaField` read for read, so a
+ * misspelled flag stays inert in both widgets rather than being caught by a
+ * tolerant fallback in one of them. The affordance and dialog themselves come
+ * from the shared `FullscreenFieldEditor`, so one form-level setting keeps
+ * producing one behaviour across both widgets.
  */
-export declare function RichTextField({ value, onChange, field, readonly, errorMessage, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function RichTextField({ value, onChange, field, readonly, error, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/SelectField.d.ts

@@ -1,5 +1,5 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * SelectField - dropdown selection widget.
  *
@@ -15,4 +15,4 @@ import { FieldWidgetProps } from './types';
  * the shared {@link useCascadingOptions} hook (#2715), so single and multi stay
  * in lockstep.
  */
-export declare function SelectField(props: FieldWidgetProps<any>): React.JSX.Element;
+export declare function SelectField(props: FieldWidgetComponentProps<any>): React.JSX.Element;

package/dist/widgets/SignatureField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * Signature field widget - provides a signature pad for capturing signatures
  * Outputs signature as a base64 PNG image
  */
-export declare function SignatureField({ value, onChange, readonly }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function SignatureField({ value, onChange, readonly }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/SliderField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * Slider field widget - provides a range slider input
  * Supports numeric values with configurable min, max, and step
  */
-export declare function SliderField({ value, onChange, field, readonly, ...props }: FieldWidgetProps<number>): React.JSX.Element;
+export declare function SliderField({ value, onChange, field, readonly, ...props }: FieldWidgetComponentProps<number>): React.JSX.Element;

package/dist/widgets/SummaryField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * SummaryField - Read-only aggregation field
  * Values are aggregated from related records and cannot be edited
  */
-export declare function SummaryField({ value, field, ...props }: FieldWidgetProps<any>): React.JSX.Element;
+export declare function SummaryField({ value, field, ...props }: FieldWidgetComponentProps<any>): React.JSX.Element;

package/dist/widgets/TagsField.d.ts

@@ -1,8 +1,8 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * TagsField - free-form list of string tags. Type a value and press Enter (or
  * comma) to add it; click a tag's × to remove it. The stored value is a
  * string[]. Used for the `tags` field type.
  */
-export declare function TagsField({ value, onChange, field, readonly, className, ...props }: FieldWidgetProps<string[]>): React.JSX.Element;
+export declare function TagsField({ value, onChange, field, readonly, className, error, ...props }: FieldWidgetComponentProps<string[]>): React.JSX.Element;

package/dist/widgets/TextAreaField.d.ts

@@ -1,12 +1,51 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * TextAreaField - Multi-line text input widget
  * Supports configurable row count and preserves whitespace in readonly mode.
  *
- * Mobile UX (round 3): when the host form passes `mobileFullscreen` (or the
- * field schema sets `mobile_fullscreen: true`), an "expand" affordance opens
- * a fullscreen edit dialog — much easier on phones than tapping a 4-row
- * textarea trapped between other fields.
+ * Mobile UX (round 3): when the FIELD METADATA carries `mobile_fullscreen:
+ * true`, an "expand" affordance opens a fullscreen edit dialog — much easier
+ * on phones than tapping a 4-row textarea trapped between other fields.
+ *
+ * That flag has exactly one producer: `ObjectForm` stamps it onto every
+ * long-text field when `ObjectFormSchema.mobile.fullscreenLongText` is set
+ * (`plugin-form/src/ObjectForm.tsx`). It reaches this widget on `field` — the
+ * single metadata carrier since objectui#3233. A `SchemaRenderer`-hosted node
+ * arrives there too: the registry adapter (`withFieldCarrier`) maps the SDUI
+ * `schema` node onto `field` before the widget sees it.
+ *
+ * The affordance, the dialog and the draft/commit semantics live in the shared
+ * `FullscreenFieldEditor` — the same producer stamps the same flag on
+ * rich-text fields, and `RichTextField` renders it from there too
+ * (objectui#3301). Only the EDITOR differs per widget; here it is a
+ * full-height `Textarea`.
+ *
+ * There is deliberately NO widget-prop override. A `mobileFullscreen`
+ * (camelCase) prop was read here and written by nobody in the repo, and the
+ * snake_case `mobile_fullscreen` prop cannot arrive either: the form renderer
+ * strips both `mobile_fullscreen` and `fullscreen` from the props it forwards
+ * to registered widgets (`stripRegisteredFieldProps` in
+ * `components/src/renderers/form/form.tsx`). Reading keys nobody produces
+ * documented a contract that never held and invited the next author to pass a
+ * silently-ignored prop, so the reads are gone (objectui#3232). If a host
+ * override is ever genuinely needed, declare ONE key on
+ * `FieldWidgetComponentProps`, stop stripping it, and have a host pass it.
+ *
+ * ## The character counter (objectui#3408, shared across surfaces in #3417)
+ *
+ * Both editing surfaces below — the inline `<Textarea>` and the fullscreen
+ * dialog's — render the SAME `CharacterCount`, which owns the three-node
+ * GOV.UK shape (decorative digits / accessible description / gated status
+ * region) and the debounce and threshold behind it. Until #3417 the fullscreen
+ * footer had its own hand-written copy that was digits and nothing else, which
+ * is what a second copy of a UI always costs: it drifts, and nothing reports
+ * the drift.
+ *
+ * This widget's remaining job is the part only it can do — mint the two
+ * description ids and name each one in the `aria-describedby` of the control
+ * it describes. The surfaces differ in exactly one behaviour, and it is
+ * declared rather than implied: `announceNearLimit`. Inline announces
+ * (unchanged since #3408); the fullscreen dialog does not.
  */
-export declare function TextAreaField({ value, onChange, field, readonly, errorMessage, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function TextAreaField({ value, onChange, field, readonly, error, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/TextField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * TextField - Standard single-line or multi-line text input
  * Automatically renders as a textarea when rows are configured in field metadata
  */
-export declare function TextField({ value, onChange, field, readonly, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function TextField({ value, onChange, field, readonly, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/TimeField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * TimeField - Time picker input widget
  * Uses native time input for hour and minute selection
  */
-export declare function TimeField({ value, onChange, field, readonly, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function TimeField({ value, onChange, field, readonly, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/UrlField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * UrlField - URL input with clickable link in readonly mode
  * Validates URLs to only render http/https links for security
  */
-export declare function UrlField({ value, onChange, field, readonly, errorMessage, ...props }: FieldWidgetProps<string>): React.JSX.Element;
+export declare function UrlField({ value, onChange, field, readonly, error, ...props }: FieldWidgetComponentProps<string>): React.JSX.Element;

package/dist/widgets/UserField.d.ts

@@ -1,3 +1,3 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
-export declare function UserField(props: FieldWidgetProps<any>): React.JSX.Element;
+import { FieldWidgetComponentProps } from './types';
+export declare function UserField(props: FieldWidgetComponentProps<any>): React.JSX.Element;

package/dist/widgets/VectorField.d.ts

@@ -1,7 +1,7 @@
 import { default as React } from 'react';
-import { FieldWidgetProps } from './types';
+import { FieldWidgetComponentProps } from './types';
 /**
  * VectorField - Vector/embedding data display
  * Shows vector embeddings in a read-only format
  */
-export declare function VectorField({ value, field, ...props }: FieldWidgetProps<number[]>): React.JSX.Element;
+export declare function VectorField({ value, field, ...props }: FieldWidgetComponentProps<number[]>): React.JSX.Element;

package/dist/widgets/file-value.d.ts

@@ -1,33 +1,4 @@
-/**
- * File field value shapes (ObjectStack ADR-0104 D3 wave 2).
- *
- * A `file`/`image`/`avatar`/`video`/`audio` field value reaches the UI in one
- * of three forms, and every widget that renders one has to cope with all
- * three — so the rules live here once rather than being re-derived per widget.
- *
- *  1. **Reference** — a bare `sys_file` id string. The form the backend stores
- *     once file-as-reference is adopted.
- *  2. **Expanded** — `{ id, name, size, mimeType, url }`, what the read path
- *     returns after resolving a stored reference. Note `mimeType`: this comes
- *     from the platform's spec-owned `FileValueSchema` and is **camelCase**.
- *  3. **Legacy inline blob** — `{ file_id?, name, original_name, size,
- *     mime_type, url }`, the pre-reference shape this package used to build
- *     itself, with **snake_case** `mime_type`.
- *
- * That casing split is the whole reason this module exists: a widget reading
- * only `mime_type` silently stops recognising images the moment the backend
- * starts returning the expanded form, and the failure looks like "thumbnails
- * disappeared" rather than anything pointing at a value shape.
- *
- * ## Submitting
- *
- * When the upload adapter surfaced a `fileId`, the widget submits the **bare
- * id** — the reference form. When it did not (the object-URL fallback adapter,
- * an older backend), it submits the legacy blob unchanged. So the same build
- * works against a backend that has adopted references and one that has not.
- * Action params already POST a bare fileId; this brings record field values
- * onto the same contract.
- */
+import { isFileIdToken } from '@objectstack/spec/data';
 /** A file value normalised for rendering, whatever form it arrived in. */
 export interface FileValueView {
     /** `sys_file` id, when the value carries one. */
@@ -43,10 +14,26 @@ export interface FileValueView {
 }
 /**
  * A minted file id: uuid/nanoid-shaped, and crucially not a URL — a URL always
- * carries `:`, `/` or `.`, so it can never match. Mirrors the platform's
- * `isFileIdToken`, which is the arbiter on the server side of the same question.
+ * carries `:`, `/` or `.`, so it can never match.
+ *
+ * This IS the platform's arbiter now, not a mirror of it (objectui#3161,
+ * objectstack#4115 ledger batch 7). The declaration that stood here said it
+ * "mirrors the platform's `isFileIdToken`" while being a character-for-character
+ * copy of that function's body under that function's own name — the shape
+ * objectui#3003 argued about and objectui#3169 caught again in
+ * `isAggregatedViewContainer`: every value test and every behaviour test passes
+ * against a faithful copy, so reference identity is the only check that can tell
+ * a re-export from a fork. It is asserted in
+ * `__tests__/spec-symbol-batch7.test.ts`.
+ *
+ * Why it matters that this one is shared rather than duplicated: the regex is a
+ * WIRE decision. Widening it server-side (say, ids grow past 64 chars) while a
+ * copy here keeps the old bound turns every new id into "not a reference", and
+ * the widget then submits the legacy inline blob against a backend that expects
+ * a reference. That failure surfaces as a broken thumbnail, nowhere near a
+ * regex.
  */
-export declare function isFileIdToken(value: unknown): value is string;
+export { isFileIdToken };
 /**
  * The `sys_file` id a value refers to, or `undefined`.
  *

package/dist/widgets/toDomProps.d.ts

@@ -0,0 +1,91 @@
+/**
+ * ObjectUI
+ * Copyright (c) 2024-present ObjectStack Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+/**
+ * The RUNTIME EXECUTOR of the "DOM pass-through" section of
+ * {@link FieldWidgetComponentProps} (objectui#3291).
+ *
+ * ## The defect
+ *
+ * Field widgets forwarded their leftover props to a control with a bare
+ * spread — `const { inputType, ...domProps } = props as any; <Input
+ * {...domProps} />`. Whatever a host handed the widget therefore became a DOM
+ * attribute. Measured on `origin/main`, a real form + a real widget:
+ *
+ * ```
+ * <input placeholder="PH-f" zzcanary="CANARY-STR" zzcanaryobj="[object Object]"
+ *        zzcanarynum="42" id="…" type="text" value="" name="f">
+ * ```
+ *
+ * The `[object Object]` this issue is named for is an authored field-config
+ * key being `String()`-ed onto an attribute. React 19 does not warn: an
+ * all-lowercase unknown attribute is passed through in complete silence, which
+ * is why this survived so long.
+ *
+ * ## Why a whitelist, and not a list of keys to drop
+ *
+ * The biggest leak source is not any NAMED renderer prop — it is the open tail
+ * of author-supplied keys. The form renderer destructures a fixed set of known
+ * keys and forwards `...fieldProps` verbatim
+ * (`components/src/renderers/form/form.tsx`), and `SchemaRenderer` is wider
+ * still: it spreads the whole authored node as props and has no strip layer at
+ * all, so on the SDUI path a widget's own spread is the ONLY line of defence.
+ *
+ * A blacklist enumerating today's renderer-only keys (`error`, `emptyHint`,
+ * `dataSource`, `dependentValues`, `dependsOn`, `options`, `inputType`, …)
+ * would pass every one of the canaries above and would not stop the next
+ * authored key either. Only "keep the known-safe set, drop the rest" closes
+ * it, which is what this function does.
+ *
+ * ## Declared = enforced
+ *
+ * {@link FieldWidgetComponentProps} already DECLARES the closed set of keys a
+ * widget may receive, and {@link FieldWidgetDomProps} names the subset that may
+ * legitimately reach a DOM element (objectui#3221). Until now that was a
+ * type-level claim a widget could violate at runtime simply by spreading. This
+ * function is that declaration's executable form, and TWO compile-time
+ * assertions below bind them in both directions — forwarding an undeclared key
+ * and declaring an unforwarded DOM key are each a compile error. Neither
+ * direction can drift silently.
+ *
+ * ## Deliberately NOT forwarded
+ *
+ * `role` and other HTML global attributes are absent because the contract does
+ * not declare them. They reached the DOM before this change only through the
+ * open spread. If a field node should be able to author one, DECLARE it on
+ * `FieldWidgetComponentProps` first and add it here — do not reopen the spread
+ * (AGENTS.md #0.1: fix the contract, never widen the consumer).
+ */
+declare const DOM_PASS_THROUGH_KEYS: readonly ["id", "name", "autoFocus", "tabIndex", "onBlur", "onFocus", "onClick", "className", "disabled"];
+type DomPassThroughKey = (typeof DOM_PASS_THROUGH_KEYS)[number];
+/** The subset of `P` this helper forwards, with each key's declared type. */
+export type DomProps<P> = Pick<P, Extract<keyof P, DomPassThroughKey>> & {
+    [K in Extract<keyof P, `data-${string}` | `aria-${string}`>]: P[K];
+};
+/**
+ * Keep only what may legitimately become a DOM attribute, and drop everything
+ * else — renderer plumbing, and any extra key an author put on the field
+ * config or SDUI node.
+ *
+ * Replaces the bare `{...props}` spread in every field widget that renders a
+ * host element:
+ *
+ * ```tsx
+ * // before — forwards whatever it was handed
+ * const { inputType, ...domProps } = props as any;
+ * return <Input {...domProps} … />;
+ *
+ * // after
+ * return <Input {...toDomProps(props)} … />;
+ * ```
+ *
+ * Semantic props a widget INTERPRETS (`value`, `onChange`, `field`,
+ * `readonly`, `error`, …) are read from `props` as before; this function only
+ * governs what gets spread.
+ */
+export declare function toDomProps<P extends object>(props: P): DomProps<P>;
+export {};