@object-ui/fields 17.7.0 → 18.0.0

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

@@ -14,6 +14,17 @@ export interface FileValueView {
     url?: string;
     size?: number;
     mimeType?: string;
+    /**
+     * `true` when the value is the platform's refused marker
+     * `{ id, metadataRefused: true }` (`FileRefusedValueSchema`): the reader may
+     * read the record but not this file's `sys_file` metadata, so no name, size,
+     * MIME type or URL was served. The view still carries `id` and the
+     * id-derived `url` — the download endpoint judges its own access and may
+     * answer `403 FILE_DOWNLOAD_DENIED` — but a renderer draws a restricted
+     * state rather than a generic file chip, and never attempts a thumbnail
+     * (objectui#12339). Absent on every other form.
+     */
+    metadataRefused?: true;
     /** The value as it arrived, so callers can pass it through untouched. */
     raw: unknown;
 }

package/dist/widgets/longTextCarrierHandoff.d.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 key a HOST writes onto a long-text widget's `field` carrier at runtime —
+ * wider than the shape an author may WRITE, on purpose (objectui#12242,
+ * maintainer ruling A, under AGENTS.md #0.1 and the objectui#6356 pattern).
+ *
+ * `mobile_fullscreen` is a projection of the FORM-level setting
+ * `ObjectFormSchema.mobile.fullscreenLongText`. Its one producer is
+ * `ObjectForm` (`@object-ui/plugin-form`), which stamps it onto the carrier
+ * the form renderer hands each long-text widget (`f.field || f`) while it
+ * builds the form. Its consumers are `TextAreaField` and `RichTextField` here,
+ * which read it off `field` and nowhere else (objectui#3245), and the form
+ * renderer's built-in `textarea` branch in `@object-ui/components`, which
+ * reads it off its own props. Nobody authors it: `@objectstack/spec`'s
+ * `FieldSchema` refuses the key by name, so no published object can carry it,
+ * and `@object-ui/types`' field metadata types no longer declare it.
+ *
+ * ⛔ Deliberately NOT exported from this package's index, and ⛔ never to be
+ * added back to `@object-ui/types`: the authoring face refuses the key, and a
+ * public type naming it would invite the spelling that face refuses.
+ */
+export interface LongTextCarrierHandoff {
+    /**
+     * Draw the fullscreen-edit affordance (an "expand" button opening a
+     * full-height dialog) beside the inline editor. Absent when the form did
+     * not opt in.
+     */
+    mobile_fullscreen?: boolean;
+}

package/dist/widgets/lookupColumnDisplay.d.ts

@@ -23,7 +23,7 @@ export type SchemaOption = {
 /** Translate a schema field's options through the shared i18n option path. */
 export type OptionTranslator = (objectName: string, fieldName: string, options: SchemaOption[]) => SchemaOption[];
 /**
- * Normalise a lookup_columns entry (string | LookupColumnDef) into a
+ * Normalise a lookupColumns entry (string | LookupColumnDef) into a
  * concrete LookupColumnDef object.
  */
 export declare function normalizeColumn(col: string | LookupColumnDef): LookupColumnDef;
@@ -60,7 +60,7 @@ export declare function resolveSchemaOptions(meta: {
  * an unresolved foreign-key id resolves to a name (#5492).
  *
  * Columns whose def carries no `type` inherit the schema field's type, so
- * string-authored `lookup_columns` format identically to object-authored ones.
+ * string-authored `lookupColumns` format identically to object-authored ones.
  */
 export declare function buildLookupColumnDescriptors(columns: LookupColumnDef[], fieldsMeta: Record<string, any> | undefined, objectName: string, translateOptions: OptionTranslator): Record<string, any>;
 export interface LookupColumnRenderContext {

package/dist/widgets/objectRefLabel.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+/**
+ * An object's name as the `object-ref` picker spells it, `Label (name)`, or the
+ * bare name when the object has no label (objectui#12613). `ObjectRefField`
+ * labels each option with it, and the console's read face for the field
+ * (`@object-ui/app-shell`'s widget reference cells) uses it for its tooltip, so
+ * the two faces spell an object one way. Published from the package barrel for
+ * that reader. No React here.
+ */
+export declare function objectRefOptionLabel(name: string, label: string | undefined): string;

package/dist/widgets/recipientKinds.d.ts

@@ -0,0 +1,85 @@
+/**
+ * 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 recipient kinds a `recipient-picker` field stores, and where each kind's
+ * candidates and labels come from (objectui#12613).
+ *
+ * ONE table, two readers: `RecipientPickerField` (the edit widget) lists a
+ * kind's candidates from it, and the console's read face for the field
+ * (`@object-ui/app-shell`'s widget reference cells) names a stored recipient
+ * from it. They lived inside the widget until the face needed the same answer;
+ * a second copy beside the face is the drift this module exists to prevent, so
+ * a kind added here reaches both faces at once. Published from the package
+ * barrel for that reader. The picker's candidate query is not shared: it stops
+ * at 500 rows by name, and the face reads stored ids by exact id instead.
+ *
+ * No React here.
+ */
+export interface RecipientMapping {
+    object: string;
+    /** Which record field to persist into recipient_id. */
+    storeField: 'id' | 'name';
+    /** Candidate display-label fields, in preference order. */
+    labelFields: string[];
+    /**
+     * i18n key for the "choose one" placeholder. Keyed per type rather than
+     * interpolating the enum value into an English sentence — "Select a
+     * business unit" and "选择业务单元" share no structure (objectstack#3821).
+     */
+    placeholderKey: string;
+}
+/**
+ * The recipient kinds whose candidates are RECORDS of one directory object,
+ * stored by the record field the evaluator matches on:
+ *
+ *   user                  → sys_user, store `id`
+ *   team                  → sys_team, store `id`
+ *   business_unit         → sys_business_unit, store `id`
+ *   unit_and_subordinates → sys_business_unit, store `id`
+ */
+export declare const RECIPIENT_RECORD_KINDS: Readonly<Record<string, RecipientMapping>>;
+/** A recipient kind whose candidates are catalog items of one metadata type. */
+export interface RegistryRecipientMapping {
+    /** The metadata type listed — the registry's `GET /api/v1/meta/<type>`. */
+    type: string;
+    /** Catalog items are referenced by machine name (ADR-0131 D4). */
+    storeField: 'name';
+    /** Candidate display-label keys, in preference order. */
+    labelFields: string[];
+    /** i18n key for the "choose one" placeholder (see {@link RecipientMapping}). */
+    placeholderKey: string;
+}
+/**
+ * The recipient kinds whose candidates come from the registry (objectui#7611).
+ *
+ * ADR-0131 D3 gives positions one home, the environment registry, and D7 says
+ * a picker LISTS that registry: one source, with no second list of
+ * `sys_position` rows merged in. The read goes through the console's metadata
+ * store (`useMetadata().ensureType`), the same reader that serves apps and
+ * objects, so the list is fetched once per session and shared with every
+ * other registry consumer.
+ */
+export declare const RECIPIENT_REGISTRY_KINDS: Readonly<Record<string, RegistryRecipientMapping>>;
+/**
+ * The RECORD-RELATIVE recipient kind (maintainer ruling objectstack#14103,
+ * executor objectstack#15072). It is deliberately absent from
+ * `RECIPIENT_RECORD_KINDS`: there is no target object to query and no record id to
+ * store. `recipient_id` holds the NAME of a user-valued column on the SHARED
+ * object, and the recipients are whoever that column names on each matched
+ * record — so this mode reads the object chosen in the sibling `object_name`
+ * field (the same dependency the `filter-condition` widget already reads) and
+ * offers that object's user-valued fields.
+ */
+export declare const FIELD_RECIPIENT_TYPE = "field";
+/**
+ * The display label of one candidate: the first non-empty member of the
+ * kind's `labelFields`, then the record id. The picker labels its options with
+ * it and the read cell names a stored recipient with it, so a recipient reads
+ * the same in the list and in the open picker.
+ */
+export declare function recipientCandidateLabel(labelFields: readonly string[] | undefined, row: unknown): string;

package/dist/widgets/richTextDisplay.d.ts

@@ -86,23 +86,6 @@ export type RichTextFieldType = keyof typeof RICH_TEXT_CELL_RENDERERS;
  * `RichTextField` serves*.
  */
 export declare const RICH_TEXT_FIELD_TYPES: readonly RichTextFieldType[];
-/**
- * The SYNTAX a rich-content type stores, derived from the renderer that type
- * resolves to rather than declared a second time.
- *
- * This is what `RichTextField`'s editor header names ("Format: markdown"), and
- * deriving it from {@link RICH_TEXT_CELL_RENDERERS} is the point: the header
- * used to be computed as `field.format || 'markdown'`, and since `format` is
- * declared on no rich-content field type (only on `date`/`datetime`/`time`/
- * `phone`/`auto_number`), it read `undefined` for every real field and labelled
- * an `html` field "Format: markdown" — a label pointing at a pipeline the value
- * does not go through. Derived, the label cannot disagree with the renderer.
- *
- * `undefined` for a type with no pipeline, rather than a guessed default: the
- * caller has to say what it does with "not a rich-content type" instead of
- * silently getting the markdown answer, which is the bug this replaces.
- */
-export declare function richTextSyntax(fieldType: string): 'markdown' | 'html' | undefined;
 /**
  * The display pipeline a field type reads through, or `undefined` when the
  * type is not one of the three rich-content types.

package/dist/widgets/searchOffer.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 declare function objectResolvesSearch(objectSchema: unknown): boolean | undefined;

package/dist/widgets/toDomProps.d.ts

@@ -93,8 +93,21 @@ declare const DOM_PASS_THROUGH_KEYS: readonly ["id", "name", "autoFocus", "tabIn
  * as a compile-time fact rather than as a comment.
  */
 export 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> = CoreDomProps<P, DomPassThroughKey>;
+/**
+ * The subset of `P` this helper forwards, with each key's declared type.
+ *
+ * Not {@link FieldWidgetDomProps}: that is the contract's DOM block, the
+ * non-generic set of keys a widget may receive; this is the generic RESULT
+ * type of {@link toDomProps}, whatever `P` it is handed narrowed to this
+ * helper's key set.
+ *
+ * Not `DomProps`: `@object-ui/core` publishes that name for the general
+ * mechanism, whose default key set forwards `role` where this one forwards
+ * `name` and `disabled`. One exported name stood for both key sets until this
+ * declaration was renamed, the way `@object-ui/components` names its own
+ * specialisation `FormControlDomProps` (objectui#6349, batch 11).
+ */
+export type FieldDomProps<P> = CoreDomProps<P, DomPassThroughKey>;
 /**
  * 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
@@ -116,5 +129,5 @@ export type DomProps<P> = CoreDomProps<P, DomPassThroughKey>;
  * `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 declare function toDomProps<P extends object>(props: P): FieldDomProps<P>;
 export {};

package/dist/widgets/useRecordQuery.d.ts

@@ -78,6 +78,19 @@ export interface UseRecordQueryResult {
     totalPages: number;
     page: number;
     search: string;
+    /**
+     * The search term `records` answer: the term of the query that committed
+     * them, `''` before the first answer and after a reset. It is set in the same
+     * commit as `records`, so the two never disagree.
+     *
+     * `search` moves on every keystroke, and the query for it runs after the
+     * debounce, so for that window `records` still answer an earlier term. A
+     * consumer that acts on "the rows for what the user typed" compares this
+     * with `search` (objectui#13162): equal means the rows on screen answer the
+     * term in the box. A late answer to a superseded query commits nothing
+     * (objectui#10712), so it cannot set this either.
+     */
+    answeredSearch: string;
     sort: RecordQuerySort | null;
     /** Jump to a page (1-indexed). No-op unless `paginate` is set. */
     setPage: (page: number) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/fields",
-  "version": "17.7.0",
+  "version": "18.0.0",
   "description": "Field renderers and registry for Object UI",
   "license": "MIT",
   "type": "module",
@@ -23,18 +23,18 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@objectstack/spec": "^17.6.0",
+    "@objectstack/spec": "^18.0.0",
     "lucide-react": "^1.43.0",
     "react-markdown": "^10.1.0",
     "rehype-sanitize": "^6.0.0",
     "remark-gfm": "^4.0.1",
-    "@object-ui/components": "17.7.0",
-    "@object-ui/core": "17.7.0",
-    "@object-ui/permissions": "17.7.0",
-    "@object-ui/i18n": "17.7.0",
-    "@object-ui/providers": "17.7.0",
-    "@object-ui/react": "17.7.0",
-    "@object-ui/types": "17.7.0"
+    "@object-ui/components": "18.0.0",
+    "@object-ui/core": "18.0.0",
+    "@object-ui/i18n": "18.0.0",
+    "@object-ui/permissions": "18.0.0",
+    "@object-ui/providers": "18.0.0",
+    "@object-ui/react": "18.0.0",
+    "@object-ui/types": "18.0.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",