@object-ui/react 17.6.0 → 17.7.0

package/dist/spec-bridge/bridges/list-view.js

@@ -1,268 +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.
- */
-/**
- * A spec `ListColumn` in, the same column out — in the spelling the spec
- * declares (objectui#5068).
- *
- * This used to down-translate every column to the data-table adapter's
- * `{ accessorKey, header }` before handing it to an `object-grid` node, and
- * `ObjectGrid` translated it straight back through a tolerance branch that
- * sniffed `columns[0]`. A round trip whose input was ALREADY canonical: the
- * bridge's own parameter is `@objectstack/spec/ui`'s `ListColumn`, where
- * `field` is required and `accessorKey` / `header` are refused by name
- * (`ListColumnSchema` is a strict object). So the producer emitted a spelling
- * the contract rejects, and the renderer grew a second de-facto contract to
- * read it back — exactly the shape AGENTS.md #0.1 forbids, and the disposition
- * objectui#3951 already settled: unify at the producer, no consumer-side alias.
- *
- * `accessorKey` is not retired as a concept — it is the TanStack adapter key
- * `@object-ui/core` deliberately keeps OUT of the metadata identity fold
- * (`column-identity.ts`'s `TABLE_ADAPTER_COLUMN_KEY`). `ObjectGrid` still
- * applies it on the way OUT, at the one boundary that owns it. Metadata
- * vocabulary comes in; adapter vocabulary goes out; one translation, one place.
- *
- * Nothing is invented on the way through, which is the second half of the fix.
- * `header: col.label ?? col.field` used to turn "no label declared" into "the
- * machine name was declared as the label", and that synthesized value then
- * pre-empted `ObjectGrid`'s own header chain — `col.label` → the OBJECT
- * FIELD's label → the prettified name — whose whole purpose is a column
- * authored as a bare `{ field }`, and whose middle step exists so a localized
- * field label wins over the name-derived English one on a non-English app. A
- * bridged view therefore rendered raw machine names where a directly authored
- * `object-grid` rendered the field's real, localizable label. It now forwards
- * the declaration and lets the renderer resolve what was left unsaid.
- */
-function mapColumn(col) {
-    // Spec shorthand: a bare field name stands for a default column.
-    if (typeof col === 'string') {
-        return { field: col };
-    }
-    const mapped = {
-        field: col.field,
-    };
-    if (col.label != null)
-        mapped.label = col.label;
-    if (col.width != null)
-        mapped.width = col.width;
-    if (col.align)
-        mapped.align = col.align;
-    if (col.hidden != null)
-        mapped.hidden = col.hidden;
-    if (col.sortable != null)
-        mapped.sortable = col.sortable;
-    if (col.resizable != null)
-        mapped.resizable = col.resizable;
-    if (col.wrap != null)
-        mapped.wrap = col.wrap;
-    if (col.type)
-        mapped.type = col.type;
-    if (col.pinned)
-        mapped.pinned = col.pinned;
-    if (col.summary)
-        mapped.summary = col.summary;
-    if (col.link)
-        mapped.link = col.link;
-    if (col.action)
-        mapped.action = col.action;
-    return mapped;
-}
-/**
- * The spec's five row heights collapsed onto the renderer's three densities.
- *
- * `Record<RowHeight, …>` on purpose (objectui#4352): the key set is the spec's,
- * so a row height added upstream fails the build here instead of silently
- * arriving with no density. The table used to carry four more keys —
- * `comfortable`, `spacious`, `small`, `large` — which `RowHeightSchema` does
- * not admit, so no spec-valid list view could ever reach them; they only
- * survived because the parameter was widened back to `string` and the fixture
- * asserting three of them compiled against nothing. Deleting them is AGENTS.md
- * #0.1: a renderer-side dialect for off-spec metadata is a second de-facto
- * contract, and one strict contract beats N. An off-spec `rowHeight` now falls
- * through to `undefined` — the producer is where it gets fixed.
- */
-const ROW_HEIGHT_TO_DENSITY = {
-    compact: 'compact',
-    short: 'compact',
-    medium: 'comfortable',
-    tall: 'spacious',
-    extra_tall: 'spacious',
-};
-/**
- * Runtime reader for {@link ROW_HEIGHT_TO_DENSITY} — the five spec row heights
- * and **nothing else**.
- *
- * `hasOwnProperty`, not a bare index (objectui#4442): the table is a plain
- * object literal, so indexing it with an unchecked key reaches
- * `Object.prototype`. The parameter is typed `RowHeight`, but the boundary a
- * host's stored view definition actually crosses is `SpecBridge.transformListView`,
- * whose parameter is `any` — so `rowHeight: 'toString'` used to come back as
- * `Object.prototype.toString`, a FUNCTION returned from a signature that
- * promises three strings or nothing. `bridgeListView` then writes the key under
- * `if (density)`, and a function is truthy, so it landed on the SchemaNode.
- *
- * This is the same guard `@object-ui/core`'s `rowHeightToDensityMode` grew in
- * objectui#4440, and the repo's existing convention (`freeze-schema.ts:135`,
- * `metadata-admin/predicate.ts:305`, six more). Both rowHeight surfaces now
- * abstain identically on every off-spec spelling; the agreement is pinned by
- * `__tests__/RowHeightDensityAgreement.test.ts`.
- *
- * `typeof rowHeight !== 'string'`, not `!rowHeight` (objectui#4459): the
- * truthiness guard this replaces rejected only FALSY values, so every truthy
- * non-string walked past it into a lookup that coerces its key — both
- * `hasOwnProperty.call` and the index run `String(...)`. `['compact']`, a boxed
- * `String('compact')` and `{ toString: () => 'compact' }` therefore each
- * selected a real density, where core's twin abstained
- * (`packages/core/src/utils/normalize-list-view.ts:83`, which has opened with
- * the type guard since #4440). Note the direction against #4442: that leak produced a
- * FUNCTION, visibly wrong to everything downstream; this one produced a
- * legitimate-looking `'compact'` that nothing can tell apart from an authored
- * value. The type guard subsumes the old one — `undefined`, `null`, `0` and
- * `false` are all non-strings — and `''` keeps its answer while changing route:
- * a string, so it passes here and is refused by `hasOwnProperty` one line down.
- */
-function mapDensity(rowHeight) {
-    if (typeof rowHeight !== 'string')
-        return undefined;
-    if (!Object.prototype.hasOwnProperty.call(ROW_HEIGHT_TO_DENSITY, rowHeight)) {
-        return undefined;
-    }
-    return ROW_HEIGHT_TO_DENSITY[rowHeight];
-}
-/**
- * The spec's own parse-time lift, applied where `parse` cannot reach
- * (objectui#4585).
- *
- * `@objectstack/spec` accepts BOTH spellings of `view.exportOptions` and lifts
- * the legacy bare format array to the object form at parse (objectstack#8010,
- * `ui/view.zod.ts`):
- *
- *     z.array(ListViewExportFormatSchema).transform((formats) => ({ formats }))
- *
- * That transform never runs on this path. The bridge's input is a TypeScript
- * type, not a parsed value — there is no `parse`/`safeParse` anywhere under
- * `spec-bridge/` — so a host that parses first hands over the object form while
- * a host that forwards raw stored metadata hands over whatever was authored,
- * and nothing here can tell them apart. The legacy array therefore used to
- * reach the `object-grid` node verbatim, where `ObjectGrid` reads
- * `exportOptions.formats` and only that: `.formats` on an array is `undefined`,
- * the renderer's `['csv', 'json']` default won, and the view's declared formats
- * were dropped with no error and no console line — the export button still
- * showed, because a non-empty array is truthy.
- *
- * This mirrors that transform and NOTHING more: the same contract applied one
- * layer out, not a second de-facto one (AGENTS.md #0.1 — the consumer-side
- * `Array.isArray` fallback in the renderer is what that rule forbids). Hence:
- *
- * - the object form passes through by reference, unread and unrewritten;
- * - an empty array lifts to `{ formats: [] }`, exactly as the spec's transform
- *   does — its `z.array()` carries no `.min(1)`, so `[]` is a legal input that
- *   wraps rather than defaults. ObjectGrid then offers no format and hides the
- *   export button: "declared zero formats", read literally;
- * - a `'pdf'` stored before its retirement is carried, not filtered. The spec
- *   REFUSES `'pdf'` at parse with a migration prescription (objectstack#8010;
- *   PDF export itself was declined as objectstack#1301 NOT_PLANNED) — it does
- *   not silently drop the value, so neither may this. Such a format dies
- *   downstream in ObjectGrid's format-AGNOSTIC menu filter, kept deliberately
- *   at objectui#4535 for metadata predating `os migrate meta --from 16`.
- */
-function liftExportOptions(exportOptions) {
-    if (!Array.isArray(exportOptions))
-        return exportOptions;
-    // The pinned `@objectstack/spec@17.0.0-rc.6` still admits `'pdf'` as an array
-    // member (the enum narrowing arrives with the pin bump), so the element type
-    // here is wider than the renderer-side `ListViewExportFormat`. Narrowing it by
-    // filtering would invent precisely the silent drop the spec declines to do.
-    return { formats: exportOptions };
-}
-/** Transforms a ListView spec into a DataTable SchemaNode */
-export const bridgeListView = (spec, _context) => {
-    const columns = (spec.columns ?? []).map(mapColumn);
-    const density = mapDensity(spec.rowHeight);
-    const node = {
-        type: 'object-grid',
-        id: spec.name,
-        columns,
-        data: spec.data,
-    };
-    if (spec.label)
-        node.label = spec.label;
-    if (spec.selection)
-        node.selection = spec.selection;
-    if (spec.pagination)
-        node.pagination = spec.pagination;
-    if (spec.sort)
-        node.sort = spec.sort;
-    if (spec.filter)
-        node.filter = spec.filter;
-    if (density)
-        node.density = density;
-    if (spec.grouping)
-        node.grouping = spec.grouping;
-    if (spec.rowColor)
-        node.rowColor = spec.rowColor;
-    if (spec.searchableFields)
-        node.searchableFields = spec.searchableFields;
-    if (spec.filterableFields)
-        node.filterableFields = spec.filterableFields;
-    if (spec.resizable != null)
-        node.resizable = spec.resizable;
-    if (spec.navigation)
-        node.navigation = spec.navigation;
-    if (spec.kanban)
-        node.kanban = spec.kanban;
-    if (spec.calendar)
-        node.calendar = spec.calendar;
-    if (spec.gantt)
-        node.gantt = spec.gantt;
-    if (spec.gallery)
-        node.gallery = spec.gallery;
-    if (spec.timeline)
-        node.timeline = spec.timeline;
-    // P1.1 — Spec Protocol Alignment additions
-    if (spec.rowActions)
-        node.rowActions = spec.rowActions;
-    if (spec.bulkActions)
-        node.bulkActions = spec.bulkActions;
-    if (spec.bulkActionDefs)
-        node.bulkActionDefs = spec.bulkActionDefs;
-    if (spec.conditionalFormatting)
-        node.conditionalFormatting = spec.conditionalFormatting;
-    if (spec.inlineEdit != null)
-        node.inlineEdit = spec.inlineEdit;
-    if (spec.exportOptions)
-        node.exportOptions = liftExportOptions(spec.exportOptions);
-    if (spec.emptyState)
-        node.emptyState = spec.emptyState;
-    if (spec.userActions)
-        node.userActions = spec.userActions;
-    if (spec.appearance)
-        node.appearance = spec.appearance;
-    if (spec.compactToolbar != null)
-        node.compactToolbar = spec.compactToolbar;
-    if (spec.addRecord)
-        node.addRecord = spec.addRecord;
-    if (spec.showRecordCount != null)
-        node.showRecordCount = spec.showRecordCount;
-    if (spec.allowPrinting != null)
-        node.allowPrinting = spec.allowPrinting;
-    // P1.6 — i18n & ARIA
-    if (spec.aria)
-        node.aria = spec.aria;
-    // `sharing` is already the spec's `ViewSharing` shape on both sides (#2890) —
-    // this used to DOWNGRADE it here, inventing a legacy `visibility` audience and
-    // an `enabled` flag that the renderer then had to fold back.
-    if (spec.sharing)
-        node.sharing = spec.sharing;
-    if (spec.hiddenFields)
-        node.hiddenFields = spec.hiddenFields;
-    if (spec.fieldOrder)
-        node.fieldOrder = spec.fieldOrder;
-    if (spec.description)
-        node.description = spec.description;
-    return node;
-};

package/dist/spec-bridge/index.d.ts

@@ -1,11 +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 { SpecBridge } from './SpecBridge.js';
-export type { BridgeContext, BridgeFn, ObjectDefLite } from './types.js';
-export { bridgeListView } from './bridges/list-view.js';
-export { bridgeFormView } from './bridges/form-view.js';

package/dist/spec-bridge/index.js

@@ -1,10 +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 { SpecBridge } from './SpecBridge.js';
-export { bridgeListView } from './bridges/list-view.js';
-export { bridgeFormView } from './bridges/form-view.js';

package/dist/spec-bridge/types.d.ts

@@ -1,55 +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.
- */
-import type { BaseSchema } from '@object-ui/types';
-/** Context passed to all bridge functions */
-export interface BridgeContext {
-    /** Current user context for permission checks */
-    user?: Record<string, any>;
-    /** App-level variables */
-    variables?: Record<string, any>;
-    /** Registered object definitions for field metadata lookup */
-    objectDefs?: Record<string, ObjectDefLite>;
-}
-/** Lightweight object definition for field metadata resolution */
-export interface ObjectDefLite {
-    name: string;
-    label?: string;
-    fields: Array<{
-        name: string;
-        label?: string;
-        type: string;
-        required?: boolean;
-        options?: Array<{
-            label: string;
-            value: string;
-        }>;
-    }>;
-}
-/**
- * A bridge function transforms a spec schema into a schema node tree.
- *
- * Returns **`BaseSchema`**, not `SchemaNode` (objectui#4580, ruling Q4-B).
- * Once core's `SchemaNode` became `@object-ui/types`' union
- * (`BaseSchema | string | number | boolean | null | undefined`), declaring the
- * return as `SchemaNode` made every caller re-ask a question no bridge has ever
- * answered "yes" to: *is this a bare string / null?* Both shipped bridges end
- * in a single `return node` on an object literal — `bridges/list-view.ts:226`
- * and `bridges/form-view.ts:195` — so the wider declaration described nothing
- * real while forcing a narrowing at every read.
- *
- * That cost was measured, not assumed: round 1 of this card recorded **272**
- * mechanical errors across five spec-bridge suites, all of them TS18049
- * (`'node' is possibly 'null' or 'undefined'`) and TS2339
- * (`Property 'formType' does not exist on type
- * 'string | number | boolean | BaseSchema'`) — the union being destructured by
- * tests reading properties off a node the bridge always produces.
- *
- * This is a type ANNOTATION only: no runtime behaviour changes, and the emitted
- * JavaScript is byte-identical (proven by bundle sha256 on this PR).
- */
-export type BridgeFn<T = any> = (spec: T, context: BridgeContext) => BaseSchema;

package/dist/spec-bridge/types.js

@@ -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 {};