@dxos/react-ui-form 0.8.4-main.a4bbb77 → 0.8.4-main.ae835ea

package/src/components/ObjectPicker/ObjectPicker.stories.tsx

@@ -0,0 +1,207 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Schema from 'effect/Schema';
+import React, { useCallback, useEffect, useMemo, useState } from 'react';
+import { expect, fn, userEvent, within } from 'storybook/test';
+
+import { Obj } from '@dxos/echo';
+import { faker } from '@dxos/random';
+import { Filter, useQuery } from '@dxos/react-client/echo';
+import { useClientProvider, withClientProvider } from '@dxos/react-client/testing';
+import { Button } from '@dxos/react-ui';
+import { withTheme } from '@dxos/react-ui/testing';
+import { DataType } from '@dxos/schema';
+
+import { translations } from '../../translations';
+
+import { ObjectPicker } from './ObjectPicker';
+
+faker.seed(1);
+
+const createPerson = () =>
+  Obj.make(DataType.Person, {
+    fullName: faker.person.fullName(),
+  });
+
+const omitId = Schema.omit<any, any, ['id']>('id');
+const personSchema = omitId(DataType.Person);
+
+// Mock functions for testing
+const mockHandleSelect = fn();
+const mockHandleCreate = fn();
+
+const DefaultStory = () => {
+  const { space } = useClientProvider();
+  const [isOpen, setIsOpen] = useState(false);
+
+  // Create sample Person objects
+  useEffect(() => {
+    if (space) {
+      // Create some sample Person objects for testing
+      Array.from({ length: 10 }).forEach(() => {
+        space.db.add(createPerson());
+      });
+    }
+  }, [space]);
+
+  // Get all objects in the space (similar to BoardContainer)
+  const allObjects = useQuery(space, Filter.everything());
+
+  // Map objects to options format expected by ObjectPicker
+  const options = useMemo(
+    () =>
+      allObjects.map((obj) => ({
+        id: obj.id,
+        label: obj.fullName || obj.name || obj.title || obj.id,
+        hue: 'neutral' as const,
+      })),
+    [allObjects],
+  );
+
+  const handleCreateCallback = useCallback(
+    (values: any) => {
+      console.log('[on create]', values);
+      if (!space) return;
+      const newPerson = space.db.add(Obj.make(DataType.Person, values));
+      mockHandleCreate(values);
+      return newPerson;
+    },
+    [space],
+  );
+
+  return (
+    <div className='p-4'>
+      <ObjectPicker.Root open={isOpen} onOpenChange={setIsOpen}>
+        <ObjectPicker.Trigger asChild>
+          <Button variant='primary' data-testid='trigger'>
+            Select Person
+          </Button>
+        </ObjectPicker.Trigger>
+        <ObjectPicker.Content
+          options={options}
+          onSelect={mockHandleSelect}
+          createSchema={personSchema}
+          createOptionLabel={['create new person label', { ns: 'os' }]}
+          createOptionIcon='ph--user-plus--regular'
+          createInitialValuePath='fullName'
+          onCreate={handleCreateCallback}
+          classNames='popover-card-width'
+        />
+      </ObjectPicker.Root>
+    </div>
+  );
+};
+
+const meta = {
+  title: 'ui/react-ui-form/ObjectPicker',
+  render: DefaultStory,
+  decorators: [
+    withTheme,
+    withClientProvider({
+      types: [DataType.Person],
+      createIdentity: true,
+      createSpace: true,
+    }),
+  ],
+  parameters: {
+    layout: 'centered',
+    controls: { disable: true },
+    translations,
+  },
+} satisfies Meta<typeof DefaultStory>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {};
+
+export const WithTest: Story = {
+  play: async ({ canvasElement }) => {
+    const canvas = within(canvasElement);
+    const body = within(document.body);
+
+    // Find and click the trigger button.
+    const triggerButton = await canvas.findByTestId('trigger', undefined, { timeout: 5000 });
+    await expect(triggerButton).toBeVisible();
+    await userEvent.click(triggerButton);
+
+    // Check that the listbox renders when the trigger is clicked.
+    const listbox = await body.findByRole('listbox', undefined, { timeout: 5000 });
+    await expect(listbox).toBeVisible();
+
+    // Find the search input.
+    const searchInput = await body.findByPlaceholderText('Search…');
+    await expect(searchInput).toBeVisible();
+
+    // Test searching filters the results - get initial options count.
+    const initialOptions = await body.findAllByRole('option');
+    const initialCount = initialOptions.length;
+    await expect(initialCount).toBeGreaterThan(0);
+
+    // Type a search term that should filter results.
+    await userEvent.type(searchInput, 'John');
+
+    // Wait a moment for filtering.
+    await new Promise((resolve) => setTimeout(resolve, 100));
+
+    // Check that results are filtered (should be fewer options)
+    const _filteredOptions = await body.findAllByRole('option');
+    // Note: We expect either fewer results or the same if no John exists
+
+    // Clear search and test selecting a result
+    await userEvent.clear(searchInput);
+
+    // Get the first option and click it
+    const updatedOptions = await body.findAllByRole('option');
+    const firstOption = updatedOptions[0];
+    await expect(firstOption).toBeVisible();
+
+    const _firstOptionText = firstOption.textContent;
+    await userEvent.click(firstOption);
+
+    // Check that clicking a result fires onSelect with that id
+    // The onSelect should have been called with the selected option's id
+    await expect(mockHandleSelect).toHaveBeenCalled();
+
+    // Re-open the picker to test create functionality.
+    await userEvent.click(triggerButton);
+
+    // Wait for listbox to appear again.
+    const newListbox = await body.findByRole('listbox', undefined, { timeout: 5000 });
+    await expect(newListbox).toBeVisible();
+
+    const newSearchInput = await body.findByPlaceholderText('Search…');
+
+    // Test searching an unrelated term provides the __create__ option.
+    const unrelatedTerm = 'ZxyUnrelatedName123';
+    await userEvent.type(newSearchInput, unrelatedTerm);
+
+    // Wait for the create option to appear.
+    await new Promise((resolve) => setTimeout(resolve, 200));
+
+    // Look for the create option.
+    const createOption = await body.findByRole('option', undefined, { timeout: 3000 });
+    await expect(createOption).toBeVisible();
+
+    // Click the create option - this should change state to the form field.
+    await userEvent.click(createOption);
+
+    // Check that clicking that option changes state to the form field.
+    const form = await body.findByTestId('create-referenced-object-form', undefined, { timeout: 5000 });
+    await expect(form).toBeVisible();
+
+    // Find and click the save button.
+    const saveButton = await within(form).findByTestId('save-button');
+    await expect(saveButton).toBeVisible();
+    await userEvent.click(saveButton);
+
+    // Check that clicking the save button calls onCreate with expected values.
+    await expect(mockHandleCreate).toHaveBeenCalledWith({
+      fullName: unrelatedTerm,
+    });
+  },
+};

package/src/components/ObjectPicker/ObjectPicker.tsx

@@ -0,0 +1,161 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import type * as Schema from 'effect/Schema';
+import React, { type KeyboardEvent, type MouseEvent, forwardRef, useCallback, useMemo, useState } from 'react';
+
+import { Icon, Popover, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+import { Combobox } from '@dxos/react-ui-searchlist';
+
+import { type QueryTag } from '../../hooks';
+import { translationKey } from '../../translations';
+import { Form } from '../Form';
+
+export type ObjectPickerContentProps = ThemedClassName<{
+  options: QueryTag[];
+  selectedIds?: string[];
+  createSchema?: Schema.Schema.AnyNoContext;
+  createOptionLabel?: [string, { ns: string }];
+  createOptionIcon?: string;
+  createInitialValuePath?: string;
+  onSelect: (id: string) => void;
+  onCreate?: (values: any) => void;
+}>;
+
+const ObjectPickerContent = forwardRef<HTMLDivElement, ObjectPickerContentProps>(
+  (
+    {
+      options,
+      selectedIds,
+      createSchema,
+      createOptionLabel,
+      createOptionIcon,
+      createInitialValuePath,
+      onSelect,
+      onCreate,
+      ...props
+    },
+    ref,
+  ) => {
+    const { t } = useTranslation(translationKey);
+
+    const [searchString, setSearchString] = useState('');
+    const [showForm, setShowForm] = useState(false);
+
+    const handleFormSave = useCallback(
+      (values: any) => {
+        onCreate?.(values);
+        setShowForm(false);
+        setSearchString('');
+      },
+      [onCreate],
+    );
+
+    const handleFormCancel = useCallback(() => {
+      setShowForm(false);
+      setSearchString('');
+    }, []);
+
+    // TODO(thure): The following click and keydown handlers are necessary because `onSelect` is called after the
+    //  Popover is already closed. Augment/refactor CmdK, if possible, to facilitate stopping event default
+    //  and propagation.
+
+    const handleClick = useCallback(
+      (event: MouseEvent) => {
+        if (createSchema && (event.target as HTMLElement).closest('[data-value="__create__"]')) {
+          event.stopPropagation();
+          event.preventDefault();
+          setShowForm(true);
+        }
+      },
+      [createSchema],
+    );
+
+    const handleKeyDown = useCallback(
+      (event: KeyboardEvent) => {
+        if (
+          event.key === 'Enter' &&
+          createSchema &&
+          (event.currentTarget as HTMLElement).querySelector(
+            '[role="option"][aria-selected="true"][data-value="__create__"]',
+          )
+        ) {
+          event.stopPropagation();
+          event.preventDefault();
+          setShowForm(true);
+        }
+      },
+      [createSchema],
+    );
+
+    const labelById = useMemo(
+      () =>
+        options.reduce((acc: Record<string, string>, option) => {
+          acc[option.id.toLowerCase()] = option.label.toLowerCase();
+          return acc;
+        }, {}),
+      [options],
+    );
+
+    return (
+      <Combobox.Content
+        {...props}
+        ref={ref}
+        filter={(value, search) => (value === '__create__' || labelById[value]?.includes(search.toLowerCase()) ? 1 : 0)}
+        onClickCapture={handleClick}
+        onKeyDownCapture={handleKeyDown}
+      >
+        {showForm && createSchema ? (
+          <Popover.Viewport>
+            <Form
+              schema={createSchema}
+              values={createInitialValuePath ? { [createInitialValuePath]: searchString } : {}}
+              onSave={handleFormSave}
+              onCancel={handleFormCancel}
+              testId='create-referenced-object-form'
+            />
+          </Popover.Viewport>
+        ) : (
+          <>
+            <Combobox.Input
+              placeholder={t('ref field combobox input placeholder')}
+              value={searchString}
+              onValueChange={setSearchString}
+              autoFocus
+            />
+            <Combobox.List>
+              {options.map((option) => (
+                <Combobox.Item
+                  key={option.id}
+                  value={option.id}
+                  onSelect={() => onSelect(option.id)}
+                  classNames='flex items-center gap-2'
+                >
+                  <span className='grow'>{option.label}</span>
+                  {selectedIds?.includes(option.id) && <Icon icon='ph--check--regular' />}
+                </Combobox.Item>
+              ))}
+              {searchString.length > 0 && createOptionLabel && createOptionIcon && createSchema && onCreate && (
+                <Combobox.Item value='__create__' classNames='flex items-center gap-2'>
+                  <Icon icon={createOptionIcon} />
+                  {t(createOptionLabel[0], { ns: createOptionLabel[1].ns, text: searchString })}
+                </Combobox.Item>
+              )}
+            </Combobox.List>
+          </>
+        )}
+        <Combobox.Arrow />
+      </Combobox.Content>
+    );
+  },
+);
+
+ObjectPickerContent.displayName = 'ObjectPickerContent';
+
+export const ObjectPicker = {
+  Root: Combobox.Root,
+  Trigger: Combobox.Trigger,
+  VirtualTrigger: Combobox.VirtualTrigger,
+  Content: ObjectPickerContent,
+};

package/src/components/ObjectPicker/index.ts

@@ -0,0 +1,5 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+export * from './ObjectPicker';

package/src/components/ViewEditor/ViewEditor.stories.tsx

@@ -3,23 +3,30 @@
 //
 
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import { Schema } from 'effect';
+import * as Schema from 'effect/Schema';
 import React, { useCallback, useEffect, useMemo, useRef, useState } from 'react';
 
-import { DXN, Filter, Obj, Query, Type } from '@dxos/echo';
-import { QueryBuilder } from '@dxos/echo-query';
-import { type EchoSchema, Format, toJsonSchema } from '@dxos/echo-schema';
-import { useSpace } from '@dxos/react-client/echo';
-import { withClientProvider } from '@dxos/react-client/testing';
+import { DXN, Filter, Obj, Query, type QueryAST, Tag, Type } from '@dxos/echo';
+import { type EchoSchema, Format } from '@dxos/echo/internal';
+import { useQuery } from '@dxos/react-client/echo';
+import { useClientProvider, withClientProvider } from '@dxos/react-client/testing';
 import { useAsyncEffect } from '@dxos/react-ui';
 import { withTheme } from '@dxos/react-ui/testing';
-import { type DataType, type ProjectionModel, createView, typenameFromQuery } from '@dxos/schema';
+import { DataType, type ProjectionModel, createView, getTypenameFromQuery } from '@dxos/schema';
 
 import { translations } from '../../translations';
 import { TestLayout, TestPanel, VIEW_EDITOR_DEBUG_SYMBOL } from '../testing';
 
 import { ViewEditor, type ViewEditorProps } from './ViewEditor';
 
+const types = [
+  // TODO(burdon): Get label from annotation.
+  { value: Type.getTypename(DataType.Organization), label: 'Organization' },
+  { value: Type.getTypename(DataType.Person), label: 'Person' },
+  { value: Type.getTypename(DataType.Project), label: 'Project' },
+  { value: Type.getTypename(DataType.Employer), label: 'Employer' },
+];
+
 // Type definition for debug objects exposed to tests.
 export type ViewEditorDebugObjects = {
   schema: EchoSchema;
@@ -30,11 +37,13 @@ export type ViewEditorDebugObjects = {
 type StoryProps = Pick<ViewEditorProps, 'readonly' | 'mode'>;
 
 const DefaultStory = (props: StoryProps) => {
-  const space = useSpace();
+  const { space } = useClientProvider();
   const [schema, setSchema] = useState<EchoSchema>();
   const [view, setView] = useState<DataType.View>();
   const projectionRef = useRef<ProjectionModel>(null);
 
+  const tags = useQuery(space, Filter.type(Tag.Tag));
+
   useAsyncEffect(async () => {
     if (space) {
       const TestSchema = Schema.Struct({
@@ -62,9 +71,8 @@ const DefaultStory = (props: StoryProps) => {
       const [testSchema] = await space.db.schemaRegistry.register([TestSchema, AlternateSchema]);
       const view = createView({
         name: 'Test',
-        query: Query.select(Filter.type(TestSchema)),
-        queryString: 'Query.select(Filter.type(TestSchema))',
-        jsonSchema: toJsonSchema(TestSchema),
+        query: Query.select(Filter.typename(TestSchema.typename)),
+        jsonSchema: Type.toJsonSchema(TestSchema),
         presentation: Obj.make(Type.Expando, {}),
       });
 
@@ -74,38 +82,33 @@ const DefaultStory = (props: StoryProps) => {
   }, [space]);
 
   const updateViewQuery = useCallback(
-    async (queryString: string, target?: string) => {
+    async (newQuery: QueryAST.Query, target?: string) => {
       if (!schema || !view || !space) {
         return;
       }
 
       if (props.mode === 'query') {
-        view.query.string = queryString;
-
-        const builder = new QueryBuilder();
-        const filter = builder.build(queryString) ?? Filter.nothing();
         const queue = target && DXN.tryParse(target) ? target : undefined;
-        const newQuery = queue ? Query.select(filter).options({ queues: [queue] }) : Query.select(filter);
-        view.query.ast = newQuery.ast;
+        const query = queue ? Query.fromAst(newQuery).options({ queues: [queue] }) : Query.fromAst(newQuery);
+        view.query.ast = query.ast;
 
-        const typename = typenameFromQuery(newQuery.ast);
+        const typename = getTypenameFromQuery(query.ast);
         const [newSchema] = await space.db.schemaRegistry.query({ typename }).run();
         if (!newSchema) {
           return;
         }
 
         const newView = createView({
-          query: newQuery,
+          query,
           jsonSchema: newSchema.jsonSchema,
           presentation: Obj.make(Type.Expando, {}),
         });
         view.projection = Obj.getSnapshot(newView).projection;
         setSchema(() => newSchema);
       } else {
-        const typename = queryString;
-        const newQuery = Query.select(Filter.typename(typename));
-        view.query.ast = newQuery.ast;
-        schema.updateTypename(typename);
+        console.log('updateViewQuery', { newQuery });
+        view.query.ast = newQuery;
+        schema.updateTypename(getTypenameFromQuery(newQuery));
       }
     },
     [view, schema],
@@ -147,6 +150,8 @@ const DefaultStory = (props: StoryProps) => {
           registry={space?.db.schemaRegistry}
           mode={props.mode}
           readonly={props.readonly}
+          types={types}
+          tags={tags}
           onQueryChanged={updateViewQuery}
           onDelete={handleDelete}
         />
@@ -158,7 +163,18 @@ const DefaultStory = (props: StoryProps) => {
 const meta = {
   title: 'ui/react-ui-form/ViewEditor',
   render: DefaultStory,
-  decorators: [withClientProvider({ createSpace: true }), withTheme],
+  decorators: [
+    withClientProvider({
+      createSpace: true,
+      types: [Tag.Tag],
+      onCreateSpace: ({ space }) => {
+        space.db.add(Tag.make({ label: 'Important' }));
+        space.db.add(Tag.make({ label: 'Investor' }));
+        space.db.add(Tag.make({ label: 'New' }));
+      },
+    }),
+    withTheme,
+  ],
   parameters: {
     layout: 'fullscreen',
     translations,

package/src/components/ViewEditor/ViewEditor.test.tsx

@@ -6,7 +6,7 @@ import { composeStories } from '@storybook/react';
 import { cleanup, fireEvent, screen, waitFor } from '@testing-library/react';
 import { afterEach, describe, expect, test } from 'vitest';
 
-import { EchoSchema, isInstanceOf } from '@dxos/echo-schema';
+import { EchoSchema, isInstanceOf } from '@dxos/echo/internal';
 import { DataType, ProjectionModel } from '@dxos/schema';
 
 import { VIEW_EDITOR_DEBUG_SYMBOL } from '../testing';
@@ -134,7 +134,8 @@ describe('ViewEditor', () => {
     expect(addedPropertyProjection!.props.property).toBe('added_property');
   });
 
-  test('delete property', async () => {
+  // TODO(mykola): Fix flaky test.
+  test('delete property', { retry: 2 }, async () => {
     await Default.run();
     await waitForViewEditor();