@object-ui/fields 17.3.0 → 17.5.0

package/src/widgets/toHostGroupProps.ts

@@ -0,0 +1,102 @@
+/**
+ * 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.
+ */
+
+import { toDomProps } from './toDomProps';
+
+/**
+ * The props that make a group-labelled widget's rendered surface the thing its
+ * host label actually NAMES, on the surfaces that are not controls
+ * (objectui#3990).
+ *
+ * ## What it is for
+ *
+ * A widget declared `labelling: 'group'` (objectui#3961) is told by the form
+ * renderer: your label publishes an `id` and drops its `for`, so name yourself
+ * by IDREF. The renderer hands down exactly two facts that address the field as
+ * a WHOLE:
+ *
+ *  - `id` — the host's control id (`…-form-item`), the id the label's `for`
+ *    used to point at;
+ *  - `aria-labelledby` — the IDREF of that visible label.
+ *
+ * Every editable branch already consumes them inside its wider `toDomProps`
+ * spread. The branches that returned EARLY did not — a field-level
+ * `readonly: true`, or an option list with zero offered options — so the label
+ * published an id that no element in the document referenced. Measured on
+ * `origin/main`, one field per row, reading the host label against the DOM:
+ *
+ * ```
+ * multiselect  readonly+value   consumers=0  byLabelText=0  namedByRole=[]
+ * multiselect  readonly+empty   consumers=0  byLabelText=0  namedByRole=[]
+ * multiselect  zeroOptions      consumers=0  byLabelText=0  namedByRole=[]
+ * multiselect  editable         consumers=1  byLabelText=1  namedByRole=[group:1]
+ * ```
+ *
+ * All seven group-labelled types measured the same, in every readonly state.
+ * This is quieter than the dangling `for` #3961 replaced: a `for` that resolves
+ * to nothing can at least be swept for, while "a label published an id and
+ * nobody consumed it" looks like healthy markup.
+ *
+ * ## Why this narrow pair, and not the whole `toDomProps` result
+ *
+ * Everything else in the DOM pass-through addresses a CONTROL, and a readonly
+ * display has none: `aria-describedby` / `aria-required` are announced when
+ * focus lands on something focusable, `disabled` / `tabIndex` / the focus
+ * handlers only mean something on an interactive element, and `name` is
+ * DOM-legal on form controls only — on a `div` it is exactly the leak
+ * objectui#3291 sweeps for. Spreading the full result would also put the host's
+ * `className` on top of the widget's own, because the widgets whose readonly
+ * surface is a placeholder or a plain container (`EmptyValue`, `FileField`,
+ * `AddressField`) keep `className` inside `props`.
+ *
+ * ## Why `role` travels with the two keys
+ *
+ * `aria-labelledby` on a role-less `div` / `span` names NOTHING — `generic`
+ * prohibits an author name — so the pair is inert without a role that supports
+ * naming. `group` is the one that fits a readonly surface: it names a set of
+ * values (chips, checked labels, stars, file names, a formatted address)
+ * without promising the interactivity `textbox` or `radiogroup` would. It is
+ * deliberately NOT the role the same widget answers with while editable:
+ * `RadioField`'s readonly branch renders the chosen label as text with no radios
+ * left in it, and `FileField`'s renders file names with no dropzone button.
+ *
+ * The role is emitted ONLY when a host actually named the field, mirroring
+ * every editable branch's `isLabelledGroup` test: standalone rendering (the
+ * grid's inline cell editor, a bare SDUI node) hands down neither key, so every
+ * value here is `undefined`, React emits no attribute, and that markup stays
+ * byte-identical to what it was.
+ */
+export interface HostGroupProps {
+  /** The host's control id — the id its label would have pointed `for` at. */
+  id?: string;
+  /** IDREF of the host's visible label. */
+  'aria-labelledby'?: string;
+  /** `'group'` when — and only when — a host named this surface. */
+  role?: 'group';
+}
+
+/**
+ * Read the two whole-field keys out of a widget's leftover props, plus the role
+ * that makes them mean something. See {@link HostGroupProps}.
+ *
+ * Routed through {@link toDomProps} rather than reading `props` directly so the
+ * pair keeps ONE gate: those keys reach an element only if the DOM pass-through
+ * whitelist still forwards them, and its two compile-time assertions bind that
+ * whitelist to the props contract in both directions.
+ */
+export function toHostGroupProps(props: {
+  id?: string;
+  'aria-labelledby'?: string;
+}): HostGroupProps {
+  const { id, 'aria-labelledby': labelledBy } = toDomProps(props);
+  return {
+    id,
+    'aria-labelledby': labelledBy,
+    ...(labelledBy != null ? { role: 'group' as const } : null),
+  };
+}

package/src/widgets/useFieldTranslation.ts

@@ -6,14 +6,13 @@ import { createSafeTranslation } from '@object-ui/i18n';
 
 const FIELD_DEFAULTS: Record<string, string> = {
   'common.selectOption': 'Select an option',
-  'common.select': 'Select...',
-  'common.search': 'Search',
-  'common.loading': 'Loading...',
+  'common.select': 'Select…',
+  'common.loading': 'Loading…',
   'common.noResults': 'No results found',
   'common.cancel': 'Cancel',
   'common.confirm': 'Confirm',
   'table.selected': '{{count}} selected',
-  'table.search': 'Search...',
+  'table.search': 'Search…',
   'lookup.loading': 'Loading…',
   'lookup.noOptions': 'No options found',
   'lookup.noRecords': 'No records found',
@@ -99,36 +98,19 @@ const FIELD_DEFAULTS: Record<string, string> = {
   // depend on the number stays correct at 1 without ten plural entries per
   // pack, and matches the sibling key's shape.
   'fields.textarea.charactersRemaining': 'Characters remaining: {{count}}',
-  // objectui#3404 — the shared fullscreen long-text dialog
-  // (`FullscreenFieldEditor`, reached from `TextAreaField` and
-  // `RichTextField` when `mobile_fullscreen` is set).
+  // The fullscreen long-text dialog's copy (objectui#3404) is NOT declared
+  // here any more. It moved with the implementation: `FullscreenFieldEditor` is
+  // a thin wrapper over `FullscreenEditor` in `@object-ui/components`
+  // (objectui#3398), and that primitive carries its own `createSafeTranslation`
+  // defaults for the same `form.fullscreen.*` / `common.cancel` keys — still
+  // the built-in branch's keys, still byte-identical English, so provider-less
+  // rendering is unchanged and the ten locale packs need no edit. Leaving the
+  // entries here would have re-created in the defaults map exactly the
+  // duplication #3398 removed from the components, and this map's own
+  // discipline is that a default is declared where it is read.
   //
-  // Deliberately the SAME `form.fullscreen.*` / `common.cancel` keys the
-  // built-in branch consumes (`FullscreenTextarea` in
-  // `components/src/renderers/form/form.tsx`, objectui#3272) rather than
-  // `fields.fullscreen.*` twins. One form-level setting
-  // (`ObjectFormSchema.mobile.fullscreenLongText`) projects onto BOTH render
-  // paths inside a single form, so a second copy of this copy is guaranteed
-  // drift — the shape #3231/#3263 had to undo — and would mean editing ten
-  // locale packs to say what they already say. `common.cancel` is already
-  // declared above and is reused here for exactly that reason.
-  //
-  // The values are byte-identical to the English literals they replaced, so
-  // a widget rendered with no I18nProvider (standalone/embedded hosts, and
-  // every bare-render test in this package) shows what it always did instead
-  // of a raw key. Measured before the change: with no provider mounted, bare
-  // `useObjectTranslation().t` returns the key itself
-  // (`common.cancel` → "common.cancel"), which is why this goes through
-  // `createSafeTranslation` like the built-in branch does.
-  'form.fullscreen.title': 'Edit text',
-  'form.fullscreen.description': 'Edit the full text value, then save or cancel your changes.',
-  'form.fullscreen.done': 'Done',
-  // Kept as ONE interpolated sentence with a translated generic noun standing
-  // in for a missing label — the literal's own shape
-  // (`Edit ${label ?? 'text'} fullscreen`). A second, label-less sentence key
-  // would need ten new pack entries to say the same thing.
-  'form.fullscreen.toggle': 'Edit {{label}} fullscreen',
-  'form.fullscreen.textFallback': 'text',
+  // `common.cancel` stays above: `RecordPickerDialog` and `PeoplePicker` read
+  // it independently of anything fullscreen.
   // objectui#2600 B5 — capability picker scope group headers.
   'capability.group.platform': 'Platform',
   'capability.group.org': 'Organization',

package/src/widgets/useRecordQuery.ts

@@ -56,8 +56,14 @@ export interface UseRecordQueryOptions {
    * `$filter` — already merged by the caller (base `lookup_filters`, dependent
    * lookup chain, candidate hygiene like `banned != true`, …). Compared by
    * value, so a referentially-new-but-equal object each render will not loop.
+   *
+   * Either the `QueryParams.$filter` record form or a lowered ObjectQL AST node
+   * (an array), since the picker's merge now produces both (#3831). Typed
+   * `unknown` rather than `Record< string, any >` so an array cannot slip
+   * through a type that silently accepts it; emptiness is decided by
+   * {@link hasFilter}, not by `Object.keys`.
    */
-  filter?: Record<string, any>;
+  filter?: unknown;
   /** `$expand` — related entities to include (e.g. `['primary_business_unit_id']`). */
   expand?: string[];
   /** `$searchFields` — narrow the server searchable set (ADR-0061). */
@@ -97,6 +103,22 @@ export interface UseRecordQueryResult {
   refetch: () => void;
 }
 
+/**
+ * Is this filter source worth sending as `$filter` at all?
+ *
+ * Array-aware on purpose. The picker's merge yields either the
+ * `QueryParams.$filter` record form or a lowered ObjectQL AST node (#3831), and
+ * `Object.keys` on an array returns its INDICES — so the record-only test read
+ * `['0','1','2']` for an AST node and was right only by accident. An empty array
+ * is "no filter" for the same reason an empty object is.
+ */
+function hasFilter(filter: unknown): boolean {
+  if (filter === null || filter === undefined) return false;
+  if (Array.isArray(filter)) return filter.length > 0;
+  if (typeof filter !== 'object') return false;
+  return Object.keys(filter as object).length > 0;
+}
+
 export function useRecordQuery(options: UseRecordQueryOptions): UseRecordQueryResult {
   const {
     dataSource,
@@ -123,7 +145,7 @@ export function useRecordQuery(options: UseRecordQueryOptions): UseRecordQueryRe
   // Stable signatures for object/array inputs so the fetch effect keys on their
   // *value*, not a fresh reference every render.
   const filterSignature = useMemo(
-    () => (filter && Object.keys(filter).length ? JSON.stringify(filter) : ''),
+    () => (hasFilter(filter) ? JSON.stringify(filter) : ''),
     [filter],
   );
   const expandSignature = useMemo(() => (expand?.length ? expand.join(',') : ''), [expand]);
@@ -150,7 +172,12 @@ export function useRecordQuery(options: UseRecordQueryOptions): UseRecordQueryRe
         if (searchTerm && searchTerm.trim()) params.$search = searchTerm.trim();
         if (searchFields && searchFields.length > 0) params.$searchFields = searchFields;
         if (sortArg) params.$orderby = { [sortArg.field]: sortArg.direction };
-        if (filter && Object.keys(filter).length > 0) params.$filter = filter;
+        // `QueryParams.$filter` is declared `Record< string, any >`, which the
+        // AST-array form does not describe — the cast is at this ONE assignment
+        // rather than widening a shared type that several other producers
+        // (plugin-list's `buildEffectiveFilter`, plugin-view's ObjectView)
+        // already feed arrays through.
+        if (hasFilter(filter)) params.$filter = filter as Record<string, any>;
         if (expand && expand.length > 0) params.$expand = expand;
 
         const result = await dataSource.find(objectName, params);

package/dist/FieldEditWidget.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/__tests__/resolveFieldCurrency.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/__tests__/spec-symbol-batch7.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/__tests__/widget-props-contract.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/coerce-safe-value.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/complex-widgets.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/datetime-widgets.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/field-type-coverage.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/widgets/GridField.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/widgets/ImageLightbox.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/widgets/LookupField.dependsOn.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/LookupField.gateHintLabel.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/LookupField.hydration.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/widgets/LookupField.idField.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/widgets/PeoplePicker.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/PeoplePickerComponents.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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.filterOptions.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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

@@ -1,8 +0,0 @@
-/**
- * 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/UserFieldPicker.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/__tests__/FilterConditionField.matchAll.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/__tests__/FilterConditionField.operators.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/deriveLookupColumns.test.d.ts

@@ -1 +0,0 @@
-export {};

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

@@ -1 +0,0 @@
-export {};

package/dist/widgets/personDisplay.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/recentLookups.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/widgets/useRecordQuery.test.d.ts

@@ -1,8 +0,0 @@
-/**
- * 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/useUploadingSignal.test.d.ts

@@ -1 +0,0 @@
-export {};