@object-ui/fields 17.5.0 → 17.7.0

package/src/widgets/LookupField.dependsOn.test.tsx

@@ -1,233 +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.
- */
-
-/**
- * Dependent (cascading) lookups — #2215.
- *
- * A lookup with `depends_on` must:
- *  1. gate every candidate surface while a dependency is empty,
- *  2. unlock as soon as the dependent values arrive (the form renderer
- *     injects live form values via the `dependentValues` prop), and
- *  3. scope EVERY candidate query — quick-select popover, Level-2 table
- *     picker and PeoplePicker — with the dependent-lookup chain as a hard
- *     `$filter` no user filter input can override.
- *
- * Pre-fix, `dependentValues` was never injected by the form renderer (the
- * context fallback read a member that does not exist), so create-mode
- * cascades stayed gated forever; and the table picker only received
- * `lookupFilters`, listing the full unfiltered record set.
- */
-
-import { render, screen, fireEvent, waitFor, act } from '@testing-library/react';
-import { describe, it, expect, vi, beforeEach } from 'vitest';
-import { LookupField } from './LookupField';
-import { RecordPickerDialog } from './RecordPickerDialog';
-import { PeoplePicker } from './PeoplePicker';
-
-const contacts = [
-  { id: 'c1', name: 'Nora Field', account: 'a1' },
-  { id: 'c2', name: 'Oscar Grant', account: 'a2' },
-];
-
-function makeDataSource() {
-  const find = vi.fn(async (_obj: string, params: any) => {
-    const account = params?.$filter?.account ?? params?.$filter?.account_id;
-    const data = account ? contacts.filter(c => c.account === account) : contacts;
-    return { data, total: data.length };
-  });
-  return { find } as any;
-}
-
-beforeEach(() => {
-  // jsdom has no matchMedia; PeoplePicker's useIsMobile needs it.
-  Object.defineProperty(window, 'innerWidth', { writable: true, configurable: true, value: 1280 });
-  window.matchMedia = ((query: string) => ({
-    matches: false,
-    media: query,
-    onchange: null,
-    addEventListener: () => {},
-    removeEventListener: () => {},
-    addListener: () => {},
-    removeListener: () => {},
-    dispatchEvent: () => false,
-  })) as any;
-  try {
-    localStorage.clear();
-  } catch {
-    /* jsdom */
-  }
-});
-
-describe('LookupField — depends_on gating and cascade filter (#2215)', () => {
-  const dependentField = {
-    name: 'contact',
-    label: 'Contact',
-    reference_to: 'contacts',
-    reference_field: 'name',
-    depends_on: ['account'],
-  } as any;
-
-  it('gates the trigger while the dependency is empty', () => {
-    render(
-      <LookupField
-        field={dependentField}
-        value={undefined}
-        onChange={vi.fn()}
-        readonly={false}
-        dataSource={makeDataSource()}
-        {...({ dependentValues: { account: null } } as any)}
-      />,
-    );
-
-    const trigger = screen.getByTestId('lookup-trigger-gated');
-    expect(trigger).toBeDisabled();
-    expect(trigger).toHaveTextContent(/select account first/i);
-  });
-
-  it('unlocks when dependentValues carry the parent value and scopes the popover query', async () => {
-    const ds = makeDataSource();
-    render(
-      <LookupField
-        field={dependentField}
-        value={undefined}
-        onChange={vi.fn()}
-        readonly={false}
-        dataSource={ds}
-        {...({ dependentValues: { account: 'a1' } } as any)}
-      />,
-    );
-
-    const trigger = screen.getByRole('button', { name: /select/i });
-    expect(trigger).not.toBeDisabled();
-
-    await act(async () => {
-      fireEvent.click(trigger);
-    });
-
-    await waitFor(() => {
-      expect(ds.find).toHaveBeenCalledWith(
-        'contacts',
-        expect.objectContaining({ $filter: expect.objectContaining({ account: 'a1' }) }),
-      );
-    });
-
-    await waitFor(() => {
-      expect(screen.getByText('Nora Field')).toBeInTheDocument();
-      expect(screen.queryByText('Oscar Grant')).not.toBeInTheDocument();
-    });
-  });
-
-  it('maps the explicit { field, param } shape onto the remote filter field', async () => {
-    const ds = makeDataSource();
-    const explicitField = {
-      ...dependentField,
-      depends_on: [{ field: 'account', param: 'account_id' }],
-    };
-    render(
-      <LookupField
-        field={explicitField}
-        value={undefined}
-        onChange={vi.fn()}
-        readonly={false}
-        dataSource={ds}
-        {...({ dependentValues: { account: 'a1' } } as any)}
-      />,
-    );
-
-    await act(async () => {
-      fireEvent.click(screen.getByRole('button', { name: /select/i }));
-    });
-
-    await waitFor(() => {
-      expect(ds.find).toHaveBeenCalledWith(
-        'contacts',
-        expect.objectContaining({ $filter: expect.objectContaining({ account_id: 'a1' }) }),
-      );
-    });
-  });
-});
-
-describe('RecordPickerDialog — baseFilter is a hard constraint (#2215)', () => {
-  it('applies baseFilter over the lookupFilters base on the same field', async () => {
-    const ds = makeDataSource();
-    render(
-      <RecordPickerDialog
-        open
-        onOpenChange={vi.fn()}
-        dataSource={ds}
-        objectName="contacts"
-        onSelect={vi.fn()}
-        lookupFilters={[{ field: 'account', operator: 'eq', value: 'stale' }]}
-        baseFilter={{ account: 'a1' }}
-      />,
-    );
-
-    await waitFor(() => {
-      expect(ds.find).toHaveBeenCalled();
-    });
-    const lastParams = ds.find.mock.calls[ds.find.mock.calls.length - 1][1];
-    expect(lastParams.$filter).toMatchObject({ account: 'a1' });
-  });
-
-  it('cannot be widened back out by filter-bar input on the same field', async () => {
-    const ds = makeDataSource();
-    render(
-      <RecordPickerDialog
-        open
-        onOpenChange={vi.fn()}
-        dataSource={ds}
-        objectName="contacts"
-        onSelect={vi.fn()}
-        lookupFilters={[{ field: 'account', operator: 'eq', value: 'stale' }]}
-        baseFilter={{ account: 'a1' }}
-      />,
-    );
-
-    await waitFor(() => {
-      expect(ds.find).toHaveBeenCalled();
-    });
-
-    // Open the filter bar (auto-derived from lookupFilters) and try to
-    // override the cascaded field by hand.
-    fireEvent.click(screen.getByRole('button', { name: /filters/i }));
-    const panel = await screen.findByTestId('record-picker-filter-panel');
-    const input = panel.querySelector('input')!;
-    fireEvent.change(input, { target: { value: 'a2' } });
-
-    // The hard constraint wins: no query may ever go out with the user's
-    // widened value.
-    await waitFor(() => {
-      for (const call of ds.find.mock.calls) {
-        expect(call[1]?.$filter?.account).toBe('a1');
-      }
-    });
-  });
-});
-
-describe('PeoplePicker — baseFilter scopes the candidate query (#2215)', () => {
-  it('merges baseFilter after lookupFilters so the cascade wins', async () => {
-    const ds = makeDataSource();
-    render(
-      <PeoplePicker
-        open
-        onOpenChange={vi.fn()}
-        dataSource={ds}
-        objectName="contacts"
-        onSelect={vi.fn()}
-        lookupFilters={[{ field: 'account', operator: 'eq', value: 'stale' }]}
-        baseFilter={{ account: 'a1' }}
-      />,
-    );
-
-    await waitFor(() => {
-      expect(ds.find).toHaveBeenCalled();
-    });
-    const lastParams = ds.find.mock.calls[ds.find.mock.calls.length - 1][1];
-    expect(lastParams.$filter).toMatchObject({ account: 'a1' });
-  });
-});

package/src/widgets/LookupField.gateHintLabel.test.tsx

@@ -1,135 +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 gated lookup names its controlling field by LABEL — objectstack#5407.
- *
- * The gate sentence (`lookup.selectFirst`) is translated in all ten packs, but
- * its `{{fields}}` interpolation came straight off `depends_on`, which holds
- * API names. So the rendered hint was localized around a raw identifier in
- * every locale, English included:
- *
- *     en    Select crm_account first
- *     zh-CN 请先选择crm_account
- *
- * The `en` row is why this is not merely an i18n bug: an English user was shown
- * an internal identifier. The form renderer knows the label (it already
- * resolves the same map for the fixed-option widgets' `emptyHint`) and now
- * hands it over as `dependsOnLabels`.
- *
- * All three gated surfaces are asserted — the trigger's visible text, the
- * trigger's `title`, and the "browse all" button's `title` — because they were
- * three independent copies of the same expression and a fix applied to one of
- * them looks identical from the outside.
- */
-
-import { render, screen, cleanup } from '@testing-library/react';
-import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
-import { LookupField } from './LookupField';
-
-/** Mirrors the reported metadata: the parent field's API name IS an object-ish
- *  name (`crm_account`), which is exactly what made the leak so legible. */
-const gatedField = {
-  name: 'contact',
-  label: 'Contact',
-  reference_to: 'crm_contact',
-  reference_field: 'name',
-  depends_on: ['crm_account'],
-} as any;
-
-const dataSource = { find: vi.fn(async () => ({ data: [], total: 0 })) } as any;
-
-function renderGated(extra: Record<string, unknown>) {
-  return render(
-    <LookupField
-      field={gatedField}
-      value={undefined}
-      onChange={vi.fn()}
-      readonly={false}
-      dataSource={dataSource}
-      {...({ dependentValues: { crm_account: null }, ...extra } as any)}
-    />,
-  );
-}
-
-beforeEach(() => {
-  Object.defineProperty(window, 'innerWidth', { writable: true, configurable: true, value: 1280 });
-  window.matchMedia = ((query: string) => ({
-    matches: false,
-    media: query,
-    onchange: null,
-    addEventListener: () => {},
-    removeEventListener: () => {},
-    addListener: () => {},
-    removeListener: () => {},
-    dispatchEvent: () => false,
-  })) as any;
-});
-
-afterEach(() => cleanup());
-
-describe('LookupField gate hint names the controlling field (objectstack#5407)', () => {
-  it('interpolates the label the host supplied, not the API name', () => {
-    renderGated({ dependsOnLabels: { crm_account: 'Account' } });
-
-    const trigger = screen.getByTestId('lookup-trigger-gated');
-    expect(trigger).toHaveTextContent('Select Account first');
-    // The identifier must be gone from the copy entirely, not merely
-    // accompanied by the label.
-    expect(trigger).not.toHaveTextContent('crm_account');
-    expect(trigger).toHaveAttribute('title', 'Select Account first');
-  });
-
-  it('labels the gated "browse all" button the same way', () => {
-    renderGated({ dependsOnLabels: { crm_account: 'Account' } });
-
-    const browse = screen.getByTestId('browse-all-records');
-    expect(browse).toBeDisabled();
-    expect(browse).toHaveAttribute('title', 'Select Account first');
-  });
-
-  it('joins several controlling fields by their labels', () => {
-    render(
-      <LookupField
-        field={{ ...gatedField, depends_on: ['crm_account', 'lead_source'] }}
-        value={undefined}
-        onChange={vi.fn()}
-        readonly={false}
-        dataSource={dataSource}
-        {...({
-          dependentValues: { crm_account: null, lead_source: null },
-          dependsOnLabels: { crm_account: 'Account', lead_source: 'Lead Source' },
-        } as any)}
-      />,
-    );
-
-    expect(screen.getByTestId('lookup-trigger-gated')).toHaveTextContent(
-      'Select Account, Lead Source first',
-    );
-  });
-
-  it('falls back to the API name for a field the host did not map', () => {
-    // Standalone use (no host form) has to keep rendering what it rendered
-    // before — the map is an enrichment, not a new requirement. This is also
-    // the assertion that would go red if `dependsOnLabels` were consulted for
-    // its VALUES rather than keyed by field name.
-    renderGated({ dependsOnLabels: { some_other_field: 'Irrelevant' } });
-
-    expect(screen.getByTestId('lookup-trigger-gated')).toHaveTextContent(
-      'Select crm_account first',
-    );
-  });
-
-  it('falls back to the API name when the host passes no map at all', () => {
-    renderGated({});
-
-    expect(screen.getByTestId('lookup-trigger-gated')).toHaveTextContent(
-      'Select crm_account first',
-    );
-  });
-});

package/src/widgets/LookupField.hydration.test.tsx

@@ -1,136 +0,0 @@
-// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.
-
-/**
- * Regression (#3108): a multi-value lookup hydrated its committed ids with a
- * SERIAL `findOne` per id — 41 selected users meant 41 sequential round-trips,
- * during which the trigger rendered the bare "Select…" placeholder,
- * indistinguishable from having no value at all.
- *
- * Fixed behaviour under test:
- *  1. unresolved ids are fetched in ONE batched `$in` query (chunked), not
- *     one findOne per id;
- *  2. while hydration is in flight the trigger shows a loading indicator and
- *     the committed-value count instead of the empty placeholder;
- *  3. the loading state settles (falls back to placeholder) when hydration
- *     fails, instead of spinning forever.
- */
-
-import * as React from 'react';
-import { describe, it, expect, vi, afterEach } from 'vitest';
-import { render, cleanup, waitFor, screen } from '@testing-library/react';
-import { LookupField } from './LookupField';
-
-afterEach(cleanup);
-
-const USERS = [
-  { id: 'u1', name: 'Ada Lovelace' },
-  { id: 'u2', name: 'Grace Hopper' },
-  { id: 'u3', name: 'Margaret Hamilton' },
-];
-
-describe('LookupField — multi-value hydration batches and shows loading (#3108)', () => {
-  it('hydrates several ids with one $in query instead of a findOne per id', async () => {
-    const find = vi.fn(async (_obj: string, params: any) => {
-      const wanted: any[] = params?.$filter?.id?.$in ?? [];
-      return { data: USERS.filter((u) => wanted.includes(u.id)) };
-    });
-    const findOne = vi.fn(async () => null);
-    render(
-      <LookupField
-        value={['u1', 'u2', 'u3']}
-        onChange={() => {}}
-        dataSource={{ find, findOne } as never}
-        field={{ reference_to: 'sys_user', multiple: true } as never}
-      />,
-    );
-
-    await waitFor(() => expect(screen.getByText('Ada Lovelace')).toBeTruthy());
-    expect(screen.getByText('Grace Hopper')).toBeTruthy();
-    expect(screen.getByText('Margaret Hamilton')).toBeTruthy();
-
-    // One batched round-trip, zero per-id GETs.
-    expect(findOne).not.toHaveBeenCalled();
-    const hydrationCalls = find.mock.calls.filter((c) => c[1]?.$filter?.id?.$in);
-    expect(hydrationCalls).toHaveLength(1);
-    expect(hydrationCalls[0][1].$filter.id.$in).toEqual(['u1', 'u2', 'u3']);
-  });
-
-  it('shows the committed count + spinner while hydration is in flight, never the empty placeholder', async () => {
-    let resolveFind!: (v: any) => void;
-    const find = vi.fn(
-      () => new Promise((resolve) => { resolveFind = resolve; }),
-    );
-    render(
-      <LookupField
-        value={['u1', 'u2', 'u3']}
-        onChange={() => {}}
-        dataSource={{ find } as never}
-        field={{ reference_to: 'sys_user', multiple: true } as never}
-      />,
-    );
-
-    // In-flight: loading indicator + raw committed count, no "Select…".
-    await waitFor(() => expect(screen.getByTestId('lookup-hydrating')).toBeTruthy());
-    expect(screen.queryByText('Select…')).toBeNull();
-    expect(screen.getByText(/3/)).toBeTruthy();
-
-    resolveFind({ data: USERS });
-    await waitFor(() => expect(screen.getByText('Ada Lovelace')).toBeTruthy());
-    expect(screen.queryByTestId('lookup-hydrating')).toBeNull();
-  });
-
-  it('settles (no infinite spinner) when the hydration fetch fails', async () => {
-    const find = vi.fn(async (_obj: string, params: any) => {
-      if (params?.$filter?.id?.$in) throw new Error('boom');
-      return { data: [] };
-    });
-    render(
-      <LookupField
-        value={['u1', 'u2']}
-        onChange={() => {}}
-        dataSource={{ find } as never}
-        field={{ reference_to: 'sys_user', multiple: true } as never}
-      />,
-    );
-
-    await waitFor(() => expect(find).toHaveBeenCalled());
-    // The failed attempt is marked settled — the spinner clears instead of
-    // spinning forever (pre-existing fallback: unresolvable ids drop).
-    await waitFor(() => expect(screen.queryByTestId('lookup-hydrating')).toBeNull());
-  });
-
-  it('readonly mode shows the loading count instead of an empty value while hydrating', async () => {
-    let resolveFind!: (v: any) => void;
-    const find = vi.fn(
-      () => new Promise((resolve) => { resolveFind = resolve; }),
-    );
-    render(
-      <LookupField
-        value={['u1', 'u2']}
-        onChange={() => {}}
-        readonly
-        dataSource={{ find } as never}
-        field={{ reference_to: 'sys_user', multiple: true } as never}
-      />,
-    );
-
-    await waitFor(() => expect(screen.getByTestId('lookup-hydrating')).toBeTruthy());
-
-    resolveFind({ data: USERS.slice(0, 2) });
-    await waitFor(() => expect(screen.getByText('Ada Lovelace')).toBeTruthy());
-  });
-
-  it('keeps the cheap findOne GET for a single unresolved primary id', async () => {
-    const find = vi.fn(async () => ({ data: [] }));
-    const findOne = vi.fn(async () => ({ id: 'u1', name: 'Ada' }));
-    render(
-      <LookupField
-        value={['u1']}
-        onChange={() => {}}
-        dataSource={{ find, findOne } as never}
-        field={{ reference_to: 'sys_user', multiple: true } as never}
-      />,
-    );
-    await waitFor(() => expect(findOne).toHaveBeenCalledWith('sys_user', 'u1'));
-  });
-});

package/src/widgets/LookupField.idField.test.tsx

@@ -1,61 +0,0 @@
-// Copyright (c) 2026 ObjectStack. Licensed under the Apache-2.0 license.
-
-/**
- * Regression (objectstack #3508): a lookup whose committed value is NOT the
- * primary id (`id_field: 'name'` — e.g. approval `position` approvers, which
- * the engine routes by machine name) must hydrate its display label by
- * FILTERING on that field. The old path always called `findOne(object, value)`
- * — a primary-id GET — so a stored machine name never resolved and the field
- * showed an empty placeholder over a real value.
- */
-
-import * as React from 'react';
-import { describe, it, expect, vi, afterEach } from 'vitest';
-import { render, cleanup, waitFor } from '@testing-library/react';
-import { LookupField } from './LookupField';
-
-afterEach(cleanup);
-
-describe('LookupField — id_field hydration (#3508)', () => {
-  it('hydrates by filtering on id_field when it is not the primary id', async () => {
-    const find = vi.fn(async () => ({
-      data: [{ id: 'pos_1', name: 'sales_manager', label: 'Sales Manager' }],
-    }));
-    const findOne = vi.fn(async () => null);
-    render(
-      <LookupField
-        value="sales_manager"
-        onChange={() => {}}
-        dataSource={{ find, findOne } as never}
-        field={{
-          reference_to: 'sys_position',
-          id_field: 'name',
-          display_field: 'label',
-          multiple: false,
-        } as never}
-      />,
-    );
-    await waitFor(() => expect(find).toHaveBeenCalled());
-    // The stored machine name is not a primary id — findOne(object, name)
-    // would 404; hydration must go through $filter on the committed field.
-    expect(findOne).not.toHaveBeenCalled();
-    const hydration = find.mock.calls.find(
-      (c) => (c as unknown[])[1] && ((c as never[])[1] as { $filter?: Record<string, unknown> }).$filter?.name === 'sales_manager',
-    );
-    expect(hydration).toBeTruthy();
-  });
-
-  it('keeps findOne hydration for the default primary-id lookup', async () => {
-    const find = vi.fn(async () => ({ data: [] }));
-    const findOne = vi.fn(async () => ({ id: 'u1', name: 'Ada' }));
-    render(
-      <LookupField
-        value="u1"
-        onChange={() => {}}
-        dataSource={{ find, findOne } as never}
-        field={{ reference_to: 'sys_user', multiple: false } as never}
-      />,
-    );
-    await waitFor(() => expect(findOne).toHaveBeenCalledWith('sys_user', 'u1'));
-  });
-});