@object-ui/fields 17.5.0 → 17.6.0

package/src/__tests__/lookupCellRecordLink.test.tsx

@@ -1,171 +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.
- */
-
-/**
- * objectui#4336 — a lookup value rendered read-only was plain text: the record
- * detail page showed `TYG1WX20260812001001` with a copy button and no way to
- * reach the referenced work order, and the related list's lookup columns had
- * the same dead cells (the reporter's own check: no `<a>` anywhere over the
- * value, every `href` null).
- *
- * `LookupCellRenderer` is the ONE cell renderer both surfaces resolve through
- * (`DetailSection` and `RelatedList` each call `getCellRenderer('lookup')`), so
- * the link belongs here — same path, both halves.
- *
- * The href is NOT assembled here. This package has no router and no idea what
- * an app's record route looks like; the host that owns record URLs publishes
- * them through `RelatedRecordActionsContext` (`recordHref` / `openRecord`),
- * which is the same builder the related list's row navigation already uses. No
- * host → no link, and the value renders exactly as it did before.
- */
-import { describe, it, expect, vi } from 'vitest';
-import { render, screen, fireEvent } from '@testing-library/react';
-import '@testing-library/jest-dom';
-import React from 'react';
-
-import { LookupCellRenderer } from '../index';
-import { RelatedRecordActionsProvider } from '@object-ui/react';
-
-/** The reporter's shape: `$expand`-ed lookup value (display name + record id). */
-const WORK_ORDER = { id: 'wo-1', name: 'TYG1WX20260812001001' };
-const FIELD = { type: 'lookup', reference_to: 'mtc_work_order' } as any;
-
-/** A host that can route to records, mirroring the console bridge's shape. */
-function makeHost(overrides: Record<string, unknown> = {}) {
-  return {
-    resolve: () => ({}),
-    recordHref: (objectName: string, recordId: string | number) =>
-      `/apps/demo/${objectName}/record/${encodeURIComponent(String(recordId))}`,
-    openRecord: vi.fn(),
-    ...overrides,
-  } as any;
-}
-
-function renderWithHost(node: React.ReactElement, host: any = makeHost()) {
-  return render(
-    <RelatedRecordActionsProvider value={host}>{node}</RelatedRecordActionsProvider>,
-  );
-}
-
-describe('LookupCellRenderer — the value links to the referenced record (#4336)', () => {
-  it('expanded value: renders an anchor at the host-built record href', () => {
-    const { container } = renderWithHost(
-      <LookupCellRenderer value={WORK_ORDER} field={FIELD} />,
-    );
-
-    const anchor = container.querySelector('a');
-    expect(anchor).not.toBeNull();
-    expect(anchor).toHaveAttribute('href', '/apps/demo/mtc_work_order/record/wo-1');
-    // Display-name resolution is untouched — the anchor carries the same text.
-    expect(anchor).toHaveTextContent('TYG1WX20260812001001');
-  });
-
-  it('primitive id value: links through the same host builder', () => {
-    const { container } = renderWithHost(
-      <LookupCellRenderer
-        value="wo-2"
-        field={{ ...FIELD, options: [{ value: 'wo-2', label: 'TYG1WX20260812001002' }] }}
-      />,
-    );
-
-    const anchor = container.querySelector('a');
-    expect(anchor).toHaveAttribute('href', '/apps/demo/mtc_work_order/record/wo-2');
-    expect(anchor).toHaveTextContent('TYG1WX20260812001002');
-  });
-
-  it('multi-value: each referenced record gets its own anchor', () => {
-    const { container } = renderWithHost(
-      <LookupCellRenderer
-        value={[WORK_ORDER, { id: 'wo-3', name: 'TYG1WX20260812001003' }]}
-        field={FIELD}
-      />,
-    );
-
-    const hrefs = Array.from(container.querySelectorAll('a')).map((a) => a.getAttribute('href'));
-    expect(hrefs).toEqual([
-      '/apps/demo/mtc_work_order/record/wo-1',
-      '/apps/demo/mtc_work_order/record/wo-3',
-    ]);
-  });
-
-  it('plain click navigates through the host (SPA) instead of reloading', () => {
-    const host = makeHost();
-    const rowClick = vi.fn();
-    const { container } = render(
-      <RelatedRecordActionsProvider value={host}>
-        {/* The surfaces around this cell carry their own click handlers — the
-            detail row copies the value, a related-list row opens the row's own
-            record. Activating the link must do neither. */}
-        <div onClick={rowClick}>
-          <LookupCellRenderer value={WORK_ORDER} field={FIELD} />
-        </div>
-      </RelatedRecordActionsProvider>,
-    );
-
-    const anchor = container.querySelector('a')!;
-    const event = new MouseEvent('click', { bubbles: true, cancelable: true, button: 0 });
-    fireEvent(anchor, event);
-
-    expect(host.openRecord).toHaveBeenCalledWith('mtc_work_order', 'wo-1');
-    expect(event.defaultPrevented).toBe(true);
-    expect(rowClick).not.toHaveBeenCalled();
-  });
-
-  it('modifier click keeps the browser default (open in a new tab)', () => {
-    const host = makeHost();
-    const { container } = renderWithHost(
-      <LookupCellRenderer value={WORK_ORDER} field={FIELD} />,
-      host,
-    );
-
-    const anchor = container.querySelector('a')!;
-    const event = new MouseEvent('click', {
-      bubbles: true,
-      cancelable: true,
-      button: 0,
-      metaKey: true,
-    });
-    fireEvent(anchor, event);
-
-    expect(host.openRecord).not.toHaveBeenCalled();
-    expect(event.defaultPrevented).toBe(false);
-  });
-});
-
-describe('LookupCellRenderer — must-not-change (#4336)', () => {
-  it('no host: renders exactly as before, with no anchor', () => {
-    const { container } = render(<LookupCellRenderer value={WORK_ORDER} field={FIELD} />);
-
-    expect(container.querySelector('a')).toBeNull();
-    expect(screen.getByText('TYG1WX20260812001001')).toBeInTheDocument();
-  });
-
-  it('host cannot route to the target object: no anchor, same text', () => {
-    const { container } = renderWithHost(
-      <LookupCellRenderer value={WORK_ORDER} field={FIELD} />,
-      makeHost({ recordHref: () => null }),
-    );
-
-    expect(container.querySelector('a')).toBeNull();
-    expect(screen.getByText('TYG1WX20260812001001')).toBeInTheDocument();
-  });
-
-  it('no reference target declared: no anchor', () => {
-    const { container } = renderWithHost(
-      <LookupCellRenderer value={WORK_ORDER} field={{ type: 'lookup' } as any} />,
-    );
-
-    expect(container.querySelector('a')).toBeNull();
-  });
-
-  it('empty value: the placeholder stays a placeholder — no empty link', () => {
-    const { container } = renderWithHost(<LookupCellRenderer value={null} field={FIELD} />);
-
-    expect(container.querySelector('a')).toBeNull();
-  });
-});

package/src/__tests__/lookupCellReferenceKey.test.tsx

@@ -1,57 +0,0 @@
-/**
- * Regression: LookupCellRenderer must resolve a bare foreign-key id to a
- * display name when the field metadata carries the ObjectStack `reference`
- * key (as produced by `Field.lookup('...')` in @objectstack/spec) — not only
- * the objectui `reference_to` alias.
- *
- * Real-world symptom (framework app-showcase): inline-edit a lookup cell, pick
- * a record, click another row → the cell showed a muted "—" forever because
- * the just-picked opaque id could not be resolved. Every other reader in the
- * codebase (LookupField, UserField, DetailSection, RelatedList, …) already
- * accepts `reference_to || reference`; this read cell used to read only
- * `reference_to`.
- */
-import { describe, it, expect, vi } from 'vitest';
-import { render, screen, waitFor } from '@testing-library/react';
-import '@testing-library/jest-dom';
-import React from 'react';
-
-import { LookupCellRenderer } from '../index';
-import { SchemaRendererProvider } from '@object-ui/react';
-
-// A ULID-style id: `isLikelyOpaqueId` returns true for it, so the OLD code
-// (which failed to resolve) would fall back to the muted "—" placeholder.
-const OPAQUE_ID = '01ARZ3NDEKTSV4RRFFQ69G5FAV';
-
-function makeDataSource() {
-  const findOne = vi.fn(async (object: string, id: string) => {
-    if (object === 'showcase_account' && id === OPAQUE_ID) {
-      return { id, name: 'Globex' };
-    }
-    return null;
-  });
-  return { findOne, find: vi.fn() } as any;
-}
-
-describe('LookupCellRenderer — reference key resolution', () => {
-  it('resolves an opaque id to a name via the `reference` key (not just reference_to)', async () => {
-    const ds = makeDataSource();
-    render(
-      <SchemaRendererProvider dataSource={ds}>
-        <LookupCellRenderer
-          value={OPAQUE_ID}
-          // ObjectStack convention: the lookup target lives under `reference`.
-          field={{ type: 'lookup', reference: 'showcase_account' } as any}
-        />
-      </SchemaRendererProvider>,
-    );
-
-    // The related record's display name must appear…
-    await waitFor(() => {
-      expect(screen.getByText('Globex')).toBeInTheDocument();
-    });
-    // …and the muted placeholder must NOT be what the user sees.
-    expect(screen.queryByText('—')).not.toBeInTheDocument();
-    expect(ds.findOne).toHaveBeenCalledWith('showcase_account', OPAQUE_ID);
-  });
-});

package/src/__tests__/percent-cell-vs-measure-4576.test.ts

@@ -1,115 +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.
- */
-
-/**
- * objectui#4576, asserted where the two surfaces can actually be compared.
- *
- * The card's complaint is a CROSS-PACKAGE one: the same stored number renders
- * `1.234,5 %` through `formatPercent` (this package, the list cell) and
- * `1.234,5%` through `formatMeasure` (`@object-ui/core`, the dashboard measure).
- * Neither package's own suite can see that — `core` sits below this one and
- * cannot import `formatPercent` — so the agreement is pinned here, the one
- * place both are in scope.
- *
- * This file adds no implementation. `formatPercent` was untouched by #4576; it
- * has rendered through `Intl` since #4553 / PR #4565 and was the SIDE the measure
- * formatter moved onto.
- *
- * ── objectui#4590 ──
- * The last case in this file was a NOT-a-defect pin recording that the two
- * surfaces still disagreed at rounding TIES. #4590 closed that at the
- * `formatPercent` end (it now renders percentage points directly, through the
- * same `style: 'percentPoints'` the measure uses), so that pin is now an
- * AGREEMENT pin. It is declared in place, at the case itself.
- *
- * ── PREDICTIONS, written before the run ──
- * RED before the fix: every locale whose percent convention has a space or a
- * different sign — de, fr, es, ru, tr, ar. `formatMeasure` returned a literal
- * '%' with no space, `formatPercent` returned the locale's convention.
- * GREEN on both sides: en-US, ja-JP, zh-CN, whose convention is a bare
- * trailing '%' — the must-not-change half, and the reason this was invisible in
- * an English session for three cards running.
- *
- * Runner measured: node v22.22.2, ICU 78.2, machine locale en-US.
- */
-
-import { describe, it, expect } from 'vitest';
-import { formatMeasure } from '@object-ui/core';
-import { formatPercent } from '../index';
-
-/**
- * Strip the digits out of a rendered percentage, leaving only the CONVENTION —
- * the sign, its position and any separator before it. Comparing conventions
- * rather than whole strings is deliberate: the two formatters are reached with
- * different scaling inputs and different decimal widths, and it is the
- * convention, not the digits, that #4576 is about.
- */
-function convention(rendered: string): string {
-  return rendered.replace(/[\d]/gu, '#').replace(/#+/gu, '#');
-}
-
-describe('a percent renders under ONE convention in a cell and in a measure (#4576)', () => {
-  it.each([
-    ['de-DE'],
-    ['fr-FR'],
-    ['es-ES'],
-    ['ru-RU'],
-    ['tr-TR'],
-    ['ar-EG'],
-    // must-not-change half — no space in the convention, identical before and after
-    ['en-US'],
-    ['ja-JP'],
-    ['zh-CN'],
-  ])('%s renders the same percent convention on both surfaces', (locale) => {
-    // The same underlying value on both paths: `formatPercent` takes the STORED
-    // value and scales it through `percentDisplayValue`; `formatMeasure` is
-    // told the column is already in whole percentage points.
-    const cell = formatPercent(0.805, 1, locale);
-    const measure = formatMeasure(80.5, '0.0%', undefined, 'whole', locale);
-    expect(convention(measure)).toBe(convention(cell));
-  });
-
-  it('the German case the card was filed for, spelled out', () => {
-    // Both `1.234,5` followed by U+00A0 and the sign. Before #4576 the measure
-    // had no space.
-    expect(formatPercent(1234.5, 1, 'de-DE')).toBe('1.234,5\u00a0%');
-    expect(formatMeasure(1234.5, '0.0%', undefined, 'whole', 'de-DE')).toBe('1.234,5\u00a0%');
-  });
-
-  it('MUST NOT CHANGE: English was always identical on both paths, and stays so', () => {
-    expect(formatPercent(1234.5, 1, 'en-US')).toBe('1,234.5%');
-    expect(formatMeasure(1234.5, '0.0%', undefined, 'whole', 'en-US')).toBe('1,234.5%');
-  });
-
-  it('AGREEMENT pin — the two now round ties the same way (was NOT-a-defect, closed by #4590)', () => {
-    // ── PIN MOVED (objectui#4590) ──
-    // This case was a NOT-a-defect pin: it asserted the two surfaces DISAGREED
-    // at rounding ties, recorded honestly rather than omitted, and said the gap
-    // was #4565's residue rather than #4576's business. #4590 closed it at the
-    // `formatPercent` end, so the pin flips from recording a divergence to
-    // asserting the agreement.
-    //
-    // Before:  formatPercent(1.005, 2, 'en-US')  ->  '1.00%'   (the artefact)
-    //          formatMeasure(1.005, …)           ->  '1.01%'   (the faithful one)
-    // After:   both -> '1.01%'.
-    //
-    // The cause was `formatPercent` dividing by 100 so `Intl`'s
-    // `style: 'percent'` could multiply back — lossy at ties, because the
-    // quotient's shortest decimal representation is not the authored one.
-    // `formatMeasure` had already moved onto `style: 'percentPoints'` in #4576;
-    // the cell now renders through the same option, so there is one route and
-    // no second rounding behaviour to keep in step.
-    expect(formatPercent(1.005, 2, 'en-US')).toBe('1.01%');
-    expect(formatMeasure(1.005, '0.00%', undefined, 'whole', 'en-US')).toBe('1.01%');
-    // …and asserted as an AGREEMENT rather than two coincidences, so a future
-    // divergence at either end fails here whatever the two happen to render.
-    expect(formatPercent(1.005, 2, 'en-US')).toBe(
-      formatMeasure(1.005, '0.00%', undefined, 'whole', 'en-US'),
-    );
-  });
-});

package/src/__tests__/percent-formatter-locale-4553.test.ts

@@ -1,147 +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.
- */
-
-/**
- * objectui#4553 phase 2 — `formatPercent` was the last formatter outside the
- * display-locale channel, and it was outside it in a different way from its
- * siblings.
- *
- * PR #4557 threaded the gantt tooltip's number and currency rows and measured
- * that percent could not follow: `formatPercent(value, precision)` took no
- * locale parameter, and its whole body was
- * `${percentDisplayValue(value).toFixed(precision)}%`. It built no
- * `Intl.NumberFormat` and never reached `formatDisplayNumber`, so its output
- * was not the MACHINE's locale (the defect its siblings had) but NO locale at
- * all: an ASCII decimal mark, never a grouping separator, byte-identical on
- * every machine on earth.
- *
- * That is why grouping and locale land together here. `1235%` is not merely
- * un-German — it is wrong in en-US too, where the number is `1,235%`. So the
- * English output MOVES, and that move is the fix, not a regression.
- *
- * ── Directions, predicted in writing BEFORE the run, then measured ───────
- * Runner: node v22.22.2 / ICU 78.2 / machine locale en-US.
- *
- *   en 1234.5 p0   `1235%`   → `1,235%`      RED — the grouping move
- *   de 1234.5 p0   `1235%`   → `1.235 %`     RED — separators inverted + NBSP
- *   de 80     p0   `80%`     → `80 %`        RED — de writes a no-break space
- *                                             before the sign; en does not
- *   de 12.5   p1   `12.5%`   → `12,5 %`      RED — the ruling's named form
- *   en 80     p0   `80%`     → `80%`         PIN, green both sides
- *   en 12.5   p1   `12.5%`   → `12.5%`       PIN, green both sides
- *   fraction scaling (0.8 → 80%)             PIN, green both sides
- *
- * The `en` pins are byte-identical because `en` and the runner's `en-US` agree
- * and because grouping only shows from four digits up — they are NOT evidence
- * the fix works; the `de` cases and the en GROUPING case carry that.
- *
- * Provider-less by construction (objectui#4514): these are pure-function cases
- * that touch no hook. The provider-mounted half of this card lives in
- * `PercentCellRenderer.locale.test.tsx`.
- */
-
-import { describe, it, expect } from 'vitest';
-import { formatPercent } from '../index';
-
-/**
- * German puts a NO-BREAK SPACE (U+00A0) between the number and the percent
- * sign. Written as an escape rather than pasted, so the expectation is
- * readable and greppable in both spellings.
- */
-const NBSP = '\u00a0';
-
-describe('formatPercent groups its output (objectui#4553)', () => {
-  /**
-   * THE en RED CASE, and the one that justifies calling this a defect rather
-   * than a localization nicety: four digits went out ungrouped in English too.
-   */
-  it('en groups from four digits up — the output MOVES, and that is the fix', () => {
-    expect(formatPercent(1234.5, 0, 'en')).toBe('1,235%');
-    expect(formatPercent(1000000, 0, 'en')).toBe('1,000,000%');
-  });
-
-  /** PIN, green both sides: below the grouping threshold nothing changes. */
-  it('en output below the grouping threshold is byte-identical (must-not-change)', () => {
-    expect(formatPercent(80, 0, 'en')).toBe('80%');
-    expect(formatPercent(12.5, 1, 'en')).toBe('12.5%');
-    expect(formatPercent(33.33, 2, 'en')).toBe('33.33%');
-    expect(formatPercent(0, 0, 'en')).toBe('0%');
-  });
-});
-
-describe('formatPercent follows the display locale (objectui#4553)', () => {
-  /**
-   * The separators invert AND a no-break space appears before the sign, so the
-   * German form cannot coincide with the machine's on this runner.
-   */
-  it('de inverts the separators and spaces the percent sign', () => {
-    expect(formatPercent(1234.5, 0, 'de')).toBe(`1.235${NBSP}%`);
-    expect(formatPercent(12.5, 1, 'de')).toBe(`12,5${NBSP}%`);
-  });
-
-  /**
-   * Even with no separator in play, German still differs from English: the
-   * space before the sign is part of the locale's percent CONVENTION, which is
-   * what routing through `Intl` buys over appending a literal '%'.
-   */
-  it('de spaces the sign even for a value with no separators', () => {
-    expect(formatPercent(80, 0, 'de')).toBe(`80${NBSP}%`);
-  });
-
-  /** `Intl` accepts `'zh'` verbatim — no mapping table anywhere. */
-  it('zh renders its own convention', () => {
-    expect(formatPercent(1234.5, 0, 'zh')).toBe('1,235%');
-  });
-
-  /**
-   * A malformed tag from a tenant config must never take a cell down —
-   * `formatDisplayNumber` catches it and retries without the locale.
-   */
-  it('a malformed locale tag falls back instead of throwing', () => {
-    expect(() => formatPercent(80, 0, 'not a locale')).not.toThrow();
-    expect(formatPercent(80, 0, 'not a locale')).toContain('80');
-  });
-});
-
-describe('formatPercent keeps its existing contract (objectui#4553 must-not-change)', () => {
-  /**
-   * PIN: the fraction/whole disambiguation is `percentDisplayValue`'s, shared
-   * with the dashboard measure formatter. The locale parameter must not have
-   * moved it.
-   */
-  it('still scales a fraction-stored percent and passes a whole one through', () => {
-    expect(formatPercent(0.8, 0, 'en')).toBe('80%');
-    expect(formatPercent(0.5, 0, 'en')).toBe('50%');
-    expect(formatPercent(0.075, 1, 'en')).toBe('7.5%');
-    // >= 1 is already in display magnitude and is NOT scaled again.
-    expect(formatPercent(80, 0, 'en')).toBe('80%');
-    expect(formatPercent(100, 0, 'en')).toBe('100%');
-  });
-
-  it('still honors the precision it is given', () => {
-    expect(formatPercent(33.333, 0, 'en')).toBe('33%');
-    expect(formatPercent(33.333, 1, 'en')).toBe('33.3%');
-    expect(formatPercent(33.333, 2, 'en')).toBe('33.33%');
-  });
-
-  it('still handles negatives', () => {
-    expect(formatPercent(-45.5, 1, 'en')).toBe('-45.5%');
-  });
-
-  /**
-   * The parameter is OPTIONAL and third, matching `formatNumber(value,
-   * decimals, locale)` and `formatCurrency(value, currency, locale)`. An
-   * existing caller passing nothing still gets the runtime default locale —
-   * though it now also gets grouping, which is the deliberate output move.
-   */
-  it('is callable with no locale, and with no precision either', () => {
-    expect(() => formatPercent(80)).not.toThrow();
-    expect(formatPercent(80)).toBe('80%');
-    expect(formatPercent(80, 0)).toBe('80%');
-  });
-});