@object-ui/fields 17.1.0 → 17.3.0

package/src/widgets/useFieldTranslation.ts

@@ -39,6 +39,12 @@ const FIELD_DEFAULTS: Record<string, string> = {
   'lookup.nextPage': 'Next page',
   'lookup.jumpToPage': 'Jump to page',
   'lookup.retry': 'Retry',
+  // objectui#3231 — the empty / dependency-gated state of the fixed-option
+  // widgets (select, multiselect, radio, checkboxes). Only used when the host
+  // supplies no `emptyHint`; the gate sentence shares its key with the form
+  // renderer so both cannot drift apart in a locale.
+  'fields.options.empty': 'No options available',
+  'fields.options.selectFirst': 'Select {{fields}} first',
   // objectstack#3821 — sharing-rule authoring widgets (object-ref /
   // recipient-picker / filter-condition). The recipient placeholder is keyed
   // PER TYPE rather than interpolating the enum value into an English
@@ -69,6 +75,60 @@ const FIELD_DEFAULTS: Record<string, string> = {
   'fields.filterCondition.jsonOnly': 'This criteria can only be edited as JSON',
   'fields.filterCondition.editAsJson': 'Edit as JSON',
   'fields.filterCondition.useVisualBuilder': 'Use visual builder',
+  // objectui#3342 — the tags widget's input hint. Used only when the field
+  // author declared no `placeholder` of their own (author declaration wins).
+  'fields.tags.placeholder': 'Type and press Enter to add…',
+  // objectui#3406 — the accessible name of `TextAreaField`'s character
+  // counter, rendered only when the field declares `maxLength`. The visible
+  // `{n}/{max}` is digits; this sentence is what a screen reader speaks, and
+  // the element is `aria-live`, so before the key existed a non-English
+  // session heard English on every keystroke. Byte-identical to the literal
+  // it replaces, so a no-provider render is unchanged.
+  'fields.textarea.characterCount': 'Character count: {{count}} of {{max}}',
+  // objectui#3408 — the NEAR-LIMIT warning, spoken by the counter's status
+  // region after the typist pauses and only once they are inside the last 10%
+  // (or last 20 characters) of the cap. The sentence above became the field's
+  // `aria-describedby` description in the same change; this one is the only
+  // thing that is ever announced mid-typing, which is why it says what is
+  // LEFT rather than repeating the whole count.
+  //
+  // Colon form, not "You have {{count}} characters remaining": `count` makes
+  // i18next attempt plural lookup (`_one` / `_few` / …) before the base key,
+  // and these packs declare the base key only — the same base-key fallback
+  // `characterCount` already relies on. A sentence whose grammar does not
+  // 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).
+  //
+  // 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',
   // objectui#2600 B5 — capability picker scope group headers.
   'capability.group.platform': 'Platform',
   'capability.group.org': 'Organization',

package/src/withFieldCarrier.tsx

@@ -0,0 +1,75 @@
+/**
+ * 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 React from 'react';
+
+/**
+ * Adapt `SchemaRenderer`'s SDUI carrier onto the field-widget contract —
+ * objectui#3233, the producer-side half of retiring `schema` from
+ * {@link import('./widgets/types').FieldWidgetComponentProps}.
+ *
+ * ## Why this exists
+ *
+ * Two kinds of host render a registered field widget, and they name the
+ * metadata differently *for good reason*:
+ *
+ *  - the **form renderer** (`renderFieldComponent` in
+ *    `@object-ui/components`), the inline-edit hosts (`FieldEditWidget`) and
+ *    the action dialogs pass **`field`** — the field metadata they already
+ *    hold;
+ *  - **`SchemaRenderer`** (`@object-ui/react`) passes **`schema`** — the
+ *    authored node. That key is the UNIVERSAL SDUI contract *every* registered
+ *    component receives (`element:*`, `page:*`, `object-grid`,
+ *    `ReportRenderer` …). It is not being retired and must not be: it is what
+ *    the renderer means by "the node you were rendered from".
+ *
+ * What WAS wrong is that both keys reached the widget, so ~30 widgets resolved
+ * their config as `field || schema` — one concept under two spellings, a second
+ * de-facto contract on the widget side (AGENTS.md #0.1) and precisely the shape
+ * that lets an AI-written widget pick one spelling and appear to work under one
+ * host while reading `undefined` under the other.
+ *
+ * The translation belongs at the seam, exactly once: here. Downstream `field`
+ * is the only carrier, and a widget reading `props.schema` no longer compiles.
+ *
+ * ## Guarantee
+ *
+ * Payload-preserving by construction: the node is forwarded **by reference**,
+ * so a widget's `field` is the very object it used to read through `schema`.
+ * `field` wins when a host supplies both (the form path always does, and it
+ * holds the resolved metadata rather than the raw node).
+ *
+ * `schema` is *consumed* here rather than forwarded — with the key gone from
+ * the contract, passing it on would only reach the DOM as a stray attribute
+ * through a widget's `...props` spread.
+ *
+ * ## For widget authors outside this repo
+ *
+ * Registering a widget raw means `SchemaRenderer` hands it `schema` and no
+ * `field`. Wrap it once at registration and the widget only ever implements
+ * `FieldWidgetComponentProps`:
+ *
+ * ```tsx
+ * import { withFieldCarrier } from '@object-ui/fields';
+ *
+ * ComponentRegistry.register('color', withFieldCarrier(ColorPickerField), {
+ *   namespace: 'field',
+ * });
+ * ```
+ */
+export function withFieldCarrier<P extends object>(
+  FieldWidget: React.ComponentType<P>,
+): React.FC<Record<string, any>> {
+  const FieldCarrierAdapter: React.FC<Record<string, any>> = ({ schema, field, ...props }) => (
+    <FieldWidget {...(props as unknown as P)} field={field ?? schema} />
+  );
+  FieldCarrierAdapter.displayName = `FieldCarrier(${
+    (FieldWidget as any).displayName || (FieldWidget as any).name || 'Component'
+  })`;
+  return FieldCarrierAdapter;
+}