@dxos/react-ui-table 0.8.3 → 0.8.4-main.1f223c7

package/src/playwright/smoke.spec.ts

@@ -4,16 +4,20 @@
 
 import { expect, test } from '@playwright/test';
 
+import { type DxGrid } from '@dxos/lit-grid';
+import { faker } from '@dxos/random';
 import { setupPage, storybookUrl } from '@dxos/test-utils/playwright';
 
 import { TableManager } from './TableManager';
 
-const storyUrl = storybookUrl('ui-react-ui-table-table--default');
+const storyUrl = storybookUrl('ui-react-ui-table-table--default', 9004);
+const relationsStoryUrl = storybookUrl('ui-react-ui-table-relations--default', 9004);
 
 // NOTE(ZaymonFC): This test suite relies on the faker seed being set to 0 in the story.
 test.describe('Table', () => {
   test('Loads', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
@@ -23,22 +27,24 @@ test.describe('Table', () => {
 
   test('sort', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
     await table.grid.ready();
     await table.sortColumn(0, 'descending');
-    await expect(table.grid.cell(0, 0, 'grid')).toHaveText('Uwe Øvergård');
-    await expect(table.grid.cell(0, 9, 'grid')).toContainText('Anita');
+    await expect(table.grid.cell(0, 0, 'grid')).toHaveText('Sit.');
+    await expect(table.grid.cell(0, 9, 'grid')).toContainText('Aut.');
 
     await table.sortColumn(0, 'ascending');
-    await expect(table.grid.cell(0, 0, 'grid')).toContainText('Anita');
-    await expect(table.grid.cell(0, 9, 'grid')).toHaveText('Uwe Øvergård');
+    await expect(table.grid.cell(0, 0, 'grid')).toContainText('Aut.');
+    await expect(table.grid.cell(0, 9, 'grid')).toHaveText('Sit.');
     await page.close();
   });
 
   test('selection', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
@@ -60,17 +66,19 @@ test.describe('Table', () => {
 
   test('delete row', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
     await table.grid.ready();
     await table.deleteRow(0);
-    await expect(page.getByRole('gridcell', { name: 'Anita Mayer' })).toHaveCount(0);
+    await expect(page.getByRole('gridcell', { name: 'Sapiente.' })).toHaveCount(0);
     await page.close();
   });
 
   test('delete row--select all', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
@@ -80,14 +88,15 @@ test.describe('Table', () => {
     // Delete action affects all selected rows.
     await table.deleteRow(0);
 
-    await expect(page.getByRole('gridcell', { name: 'Anita Mayer' })).toHaveCount(0);
-    await expect(page.getByRole('gridcell', { name: 'Phonthip Sigurjónsson' })).toHaveCount(0);
+    await expect(page.getByRole('gridcell', { name: 'Sapiente.' })).toHaveCount(0);
+    await expect(page.getByRole('gridcell', { name: 'Beatae.' })).toHaveCount(0);
     await expect(table.grid.cellsWithinPlane('grid')).toHaveCount(0);
     await page.close();
   });
 
   test('delete column', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
@@ -112,9 +121,9 @@ test.describe('Table', () => {
   });
 
   // Rest of add column test remains the same as it's a more complex flow.
-  // TODO(ZaymonFC): Restore this after fixing format selection.
   test('add column', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
@@ -127,58 +136,142 @@ test.describe('Table', () => {
     await page.close();
   });
 
-  test('reference > reference / create new object', async ({ browser, browserName }) => {
+  test.skip('test toggles', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
     const { page } = await setupPage(browser, { url: storyUrl });
     const table = new TableManager(page);
 
     await table.grid.ready();
 
-    // Reference existing object.
-    // Scroll over to the manager column.
-    await table.grid.panByWheel(10000, 0);
-
-    await table.grid.cell(4, 0, 'grid').click();
-    await page.keyboard.press('A');
-    await page.keyboard.press('N');
-    await page.getByRole('option', { name: 'Anita Mayer' }).click();
-
-    // Assert that the value is shown in the cell.
-    await expect(page.getByRole('gridcell', { name: 'Anita Mayer' }).first()).toBeVisible();
-
-    // Create new object.
-    await table.grid.cell(4, 1, 'grid').click();
-    await page.keyboard.type('t');
-    await page.keyboard.type('e');
-    await page.keyboard.type('s');
-    await page.keyboard.type('t');
-    await page.getByText('Create new object', { exact: false }).click();
+    await page.getByTestId('table-switch').first().click();
+    await page.getByTestId('table-switch').nth(7).click();
+
+    // Test that checks are durable in the data model by sorting.
+    await table.sortColumn(1, 'descending');
+
+    // Assert the first two switch checkboxes are checked.
+    await expect(page.getByTestId('table-switch').first()).toBeChecked();
+    await expect(page.getByTestId('table-switch').nth(1)).toBeChecked();
+    await expect(table.grid.cell(0, 0, 'grid')).toHaveText('Sapiente.');
+    await expect(table.grid.cell(0, 1, 'grid')).toHaveText('Beatae.');
+
+    await page.close();
+  });
+
+  test('extant relations work as expected', async ({ browser, browserName }) => {
+    test.skip(browserName === 'webkit');
+    test.skip(browserName === 'firefox');
+    const { page } = await setupPage(browser, { url: relationsStoryUrl });
+
+    // Wait for the page to load
+    await page.locator('dx-grid > .dx-grid').nth(1).waitFor({ state: 'visible' });
+
+    // Find the dx-grid element for the contactModel (second table)
+    // The contactModel is used in the second Table.Main component in the story
+    const dxGrid = page.locator('dx-grid').nth(1);
+    await dxGrid.waitFor({ state: 'visible' });
+
+    // Scroll to the last column (column 4)
+    await dxGrid.evaluate(async (dxGridElement: DxGrid) => {
+      dxGridElement.scrollToColumn(4);
+    });
+
+    // Click on the cell at aria-rowindex=0 aria-colindex=4 to focus it
+    const targetCell = dxGrid.locator('[data-dx-grid-plane="grid"] [aria-rowindex="0"][aria-colindex="4"]');
+    await targetCell.click();
+
+    // Click again to engage edit mode
+    await page.keyboard.press('Enter');
+
+    // Click on the combobox to open options
+    await page.getByRole('combobox').click();
+    await page.pause();
+    await page.getByPlaceholder('Search...').focus();
+
+    // Type the first few letters of an org name.
+    const orgName =
+      (await page
+        .locator('dx-grid')
+        .nth(0)
+        .locator('[data-dx-grid-plane="grid"] [aria-rowindex="0"][aria-colindex="0"] .dx-grid__cell__content')
+        .textContent()) ?? 'never';
+    await page.keyboard.type(orgName.substring(0, 4), { delay: 500 });
+
+    // Assert that there is an element with aria-selected on the page
+    await expect(page.locator('[role="option"][aria-selected]')).toBeVisible();
+
+    // Type the enter key
+    await page.keyboard.press('Enter');
+
+    // Save the result
     await page.getByTestId('save-button').click();
 
-    // Scroll to the left.
-    await page.getByRole('gridcell', { name: 'test' }).first().click();
+    // Assert that the cell element has the org name
+    await expect(targetCell).toHaveText(orgName);
 
     await page.close();
   });
 
-  test('test toggles', async ({ browser, browserName }) => {
+  test('new relations work as expected', async ({ browser, browserName }) => {
     test.skip(browserName === 'webkit');
-    const { page } = await setupPage(browser, { url: storyUrl });
-    const table = new TableManager(page);
+    test.skip(browserName === 'firefox');
+    const { page } = await setupPage(browser, { url: relationsStoryUrl });
 
-    await table.grid.ready();
+    // Wait for the page to load
+    await page.locator('dx-grid > .dx-grid').nth(1).waitFor({ state: 'visible' });
 
-    await page.getByTestId('table-switch').first().click();
-    await page.getByTestId('table-switch').nth(7).click();
+    // Find the dx-grid element for the contactModel (second table)
+    // The contactModel is used in the second Table.Main component in the story
+    const dxGrid = page.locator('dx-grid').nth(1);
+    await dxGrid.waitFor({ state: 'visible' });
 
-    // Test that checks are durable in the data model by sorting.
-    await table.sortColumn(3, 'descending');
+    // Scroll to the last column (column 4)
+    await dxGrid.evaluate(async (dxGridElement: DxGrid) => {
+      dxGridElement.scrollToColumn(4);
+    });
 
-    // Assert the first two switch checkboxes are checked.
-    await expect(page.getByTestId('table-switch').first()).toBeChecked();
-    await expect(page.getByTestId('table-switch').nth(1)).toBeChecked();
-    await expect(table.grid.cell(0, 0, 'grid')).toHaveText('Anita Mayer');
-    await expect(table.grid.cell(0, 1, 'grid')).toHaveText('Uwe Øvergård');
+    // Click on the cell at aria-rowindex=0 aria-colindex=8 to focus it
+    const targetCell = dxGrid.locator('[data-dx-grid-plane="grid"] [aria-rowindex="0"][aria-colindex="4"]');
+    await targetCell.click();
+
+    // Click again to engage edit mode
+    await page.keyboard.press('Enter');
+
+    // Click on the combobox to open options
+    await page.getByRole('combobox').click();
+    await page.getByPlaceholder('Search...').focus();
+
+    // Type the first few letters of an org name.
+    const orgName = 'Sally';
+    await page.keyboard.type(orgName, { delay: 500 });
+
+    // Assert that there is an element with aria-selected on the page
+    await expect(page.locator('[role="option"][aria-selected]')).toBeVisible();
+
+    // Type the enter key
+    await page.keyboard.press('Enter');
+    await page.pause();
+
+    // Click the save button in the popover
+    await page.getByTestId('save-button').click();
+
+    // Assert that the cell element has the org name
+    await expect(targetCell).toHaveText(orgName);
+
+    // Make a change to a non-ref cell to check that populated refs don’t cause problems with snapshots or schemas.
+    await dxGrid.evaluate(async (dxGridElement: DxGrid) => {
+      dxGridElement.scrollToColumn(6);
+    });
+
+    const nonRefContent = faker.lorem.words(3);
+    const nonRefCell = dxGrid.locator('[data-dx-grid-plane="grid"] [aria-rowindex="0"][aria-colindex="6"]');
+    await nonRefCell.click();
+    await page.keyboard.press('Enter');
+    await page.getByTestId('grid.cell-editor').waitFor({ state: 'visible' });
+    await page.keyboard.type(nonRefContent, { delay: 500 });
+    await page.keyboard.press('Enter');
+    await expect(nonRefCell).toHaveText(nonRefContent);
 
     await page.close();
   });

package/src/testing/index.ts

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

package/src/testing/useTestTableModel.ts

@@ -0,0 +1,124 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { useCallback, useMemo, useRef } from 'react';
+
+import { isMutable, toJsonSchema } from '@dxos/echo-schema';
+import { useGlobalFilteredObjects } from '@dxos/plugin-search';
+import { faker } from '@dxos/random';
+import { useClient } from '@dxos/react-client';
+import { Filter, useQuery, useSchema } from '@dxos/react-client/echo';
+import { useClientProvider } from '@dxos/react-client/testing';
+import { DataType, ProjectionModel, typenameFromQuery } from '@dxos/schema';
+
+import { type TableController } from '../components';
+import { useAddRow, useTableModel } from '../hooks';
+import { TablePresentation } from '../model';
+
+faker.seed(0); // NOTE(ZaymonFC): Required for smoke tests.
+
+/**
+ * Custom hook to create and manage a test table model for storybook demonstrations.
+ * Provides table data, schema, and handlers for table operations.
+ */
+export const useTestTableModel = () => {
+  const client = useClient();
+  const { space } = useClientProvider();
+
+  const views = useQuery(space, Filter.type(DataType.View));
+  const view = useMemo(() => views.at(0), [views]);
+  const typename = view?.query ? typenameFromQuery(view.query) : undefined;
+  const schema = useSchema(client, space, typename);
+  const jsonSchema = useMemo(() => (schema ? toJsonSchema(schema) : undefined), [schema]);
+
+  const projection = useMemo(() => {
+    if (schema && view?.projection) {
+      return new ProjectionModel(toJsonSchema(schema), view.projection);
+    }
+  }, [schema, view?.projection]);
+
+  const features = useMemo(
+    () => ({
+      selection: { enabled: true, mode: 'multiple' as const },
+      dataEditable: true,
+      schemaEditable: schema && isMutable(schema),
+    }),
+    [schema],
+  );
+
+  const objects = useQuery(space, schema ? Filter.type(schema) : Filter.nothing());
+  const filteredObjects = useGlobalFilteredObjects(objects);
+
+  const tableRef = useRef<TableController>(null);
+  const handleCellUpdate = useCallback((cell: any) => {
+    tableRef.current?.update?.(cell);
+  }, []);
+
+  const handleRowOrderChange = useCallback(() => {
+    tableRef.current?.update?.();
+  }, []);
+
+  const addRow = useAddRow({ space, schema });
+
+  const handleDeleteRows = useCallback(
+    (_: number, objects: any[]) => {
+      for (const object of objects) {
+        space?.db.remove(object);
+      }
+    },
+    [space],
+  );
+
+  const handleDeleteColumn = useCallback(
+    (fieldId: string) => {
+      if (projection) {
+        projection.deleteFieldProjection(fieldId);
+      }
+    },
+    [projection],
+  );
+
+  const model = useTableModel({
+    view,
+    schema: jsonSchema,
+    projection,
+    features,
+    rows: filteredObjects,
+    onInsertRow: addRow,
+    onDeleteRows: handleDeleteRows,
+    onDeleteColumn: handleDeleteColumn,
+    onCellUpdate: handleCellUpdate,
+    onRowOrderChange: handleRowOrderChange,
+  });
+
+  const handleInsertRow = useCallback(() => {
+    const insertResult = model?.insertRow();
+    tableRef.current?.handleInsertRowResult?.(insertResult);
+  }, [model, tableRef.current]);
+
+  const handleSaveView = useCallback(() => {
+    model?.saveView();
+  }, [model]);
+
+  const presentation = useMemo(() => {
+    if (model) {
+      return new TablePresentation(model);
+    }
+  }, [model]);
+
+  return {
+    schema,
+    view,
+    projection,
+    tableRef,
+    model,
+    presentation,
+    space,
+    client,
+    handleInsertRow,
+    handleSaveView,
+    handleDeleteRows,
+    handleDeleteColumn,
+  };
+};

package/src/translations.ts

@@ -2,9 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
-export const translationKey = 'table';
+import { type Resource } from '@dxos/react-ui';
 
-export default [
+export const translationKey = 'react-ui-table';
+
+export const translations = [
   {
     'en-US': {
       [translationKey]: {
@@ -12,8 +14,8 @@ export default [
         'create object label': 'Create table',
         'table name placeholder': 'Table name',
         'settings title': 'Table settings',
-        'table schema label': 'Schema',
-        'new schema': 'New schema',
+        'table schema label': 'Record type',
+        'new schema': 'New record type',
         'continue label': 'Continue',
         'create stack section label': 'Create table',
         'add row label': 'Add row',
@@ -32,4 +34,4 @@ export default [
       },
     },
   },
-] as const;
+] as const satisfies Resource[];

package/src/types/index.ts

@@ -1,5 +1,5 @@
 //
-// Copyright 2024 DXOS.org
+// Copyright 2025 DXOS.org
 //
 
-export * from './table';
+export * as Table from './schema';

package/src/types/schema.ts

@@ -0,0 +1,73 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Schema } from 'effect';
+import { Match } from 'effect';
+
+import { Obj, Type } from '@dxos/echo';
+import { JsonPath, type JsonSchemaType, toEffectSchema } from '@dxos/echo-schema';
+import { ViewAnnotation } from '@dxos/echo-schema';
+import { type SimpleType } from '@dxos/effect';
+import { type CreateViewFromSpaceProps, type DataType, createViewFromSpace, getSchemaProperties } from '@dxos/schema';
+
+export const Table = Schema.Struct({
+  sizes: Schema.Record({
+    key: JsonPath,
+    value: Schema.Number,
+  }).pipe(Schema.mutable),
+}).pipe(
+  Type.Obj({
+    typename: 'dxos.org/type/Table',
+    version: '0.1.0',
+  }),
+  ViewAnnotation.set(true),
+);
+
+export type Table = Schema.Schema.Type<typeof Table>;
+
+/**
+ * Make a table view.
+ */
+export const make = (props: Partial<Obj.MakeProps<typeof Table>> = {}) => Obj.make(Table, { sizes: {}, ...props });
+
+type MakeViewProps = Omit<CreateViewFromSpaceProps, 'presentation'> & {
+  sizes?: Record<string, number>;
+};
+
+export const makeView = async ({
+  sizes,
+  ...props
+}: MakeViewProps): Promise<{
+  jsonSchema: JsonSchemaType;
+  view: DataType.View;
+  schema: ReturnType<typeof toEffectSchema>;
+}> => {
+  const table = Obj.make(Table, { sizes: {} });
+  const { jsonSchema, view } = await createViewFromSpace({ ...props, presentation: table });
+
+  // Preset sizes.
+  const schema = toEffectSchema(jsonSchema);
+  const shouldIncludeId = props.fields?.find((field) => field === 'id') !== undefined;
+  const properties = getSchemaProperties(schema.ast, {}, shouldIncludeId);
+  for (const property of properties) {
+    if (sizes?.[property.name]) {
+      table.sizes[property.name as JsonPath] = sizes[property.name];
+      continue;
+    }
+
+    Match.type<SimpleType>().pipe(
+      Match.when('boolean', () => {
+        table.sizes[property.name as JsonPath] = 100;
+      }),
+      Match.when('number', () => {
+        table.sizes[property.name as JsonPath] = 100;
+      }),
+      Match.orElse(() => {
+        // Noop.
+      }),
+    )(property.type);
+  }
+
+  return { jsonSchema, schema, view };
+};

package/src/util/dynamic-table.ts

@@ -4,18 +4,19 @@
 
 import { type Schema } from 'effect';
 
-import { Obj, Ref } from '@dxos/echo';
+import { Filter, Obj, Query } from '@dxos/echo';
 import { getTypename, toJsonSchema } from '@dxos/echo-schema';
-import type { JsonSchemaType, SortDirectionType } from '@dxos/echo-schema';
+import type { JsonSchemaType } from '@dxos/echo-schema';
 import {
+  type DataType,
+  ProjectionModel,
+  type SchemaPropertyDefinition,
+  type SortDirectionType,
   createView,
   getSchemaFromPropertyDefinitions,
-  ViewProjection,
-  type ViewType,
-  type SchemaPropertyDefinition,
 } from '@dxos/schema';
 
-import { TableType } from '../types';
+import { Table } from '../types';
 
 // TODO(ZaymonFC): Upstream these extra fields to SchemaPropertyDefinition to enhance schema-tools schema creation.
 type PropertyDisplayProps = {
@@ -61,32 +62,34 @@ export const makeDynamicTable = ({
   typename: string;
   jsonSchema: JsonSchemaType;
   properties?: TablePropertyDefinition[];
-}): { table: TableType; projection: ViewProjection } => {
+}): { projection: ProjectionModel; view: DataType.View } => {
+  const table = Obj.make(Table.Table, { sizes: {} });
   const view = createView({
-    name: 'dynamic-table',
-    typename,
+    query: Query.select(Filter.typename(typename)),
     jsonSchema,
+    presentation: table,
     ...(properties && { fields: properties.map((property) => property.name) }),
   });
 
-  const table = Obj.make(TableType, { name: 'dynamic-table', view: Ref.make(view) });
-  const projection = new ViewProjection(jsonSchema, view);
-  if (properties && view.fields) {
-    setProperties(view, projection, properties);
+  const projection = new ProjectionModel(jsonSchema, view.projection);
+  if (properties && projection.fields) {
+    setProperties(view, projection, table, properties);
   }
 
-  return {
-    table,
-    projection,
-  };
+  return { projection, view };
 };
 
-const setProperties = (view: ViewType, projection: ViewProjection, properties: TablePropertyDefinition[]) => {
+const setProperties = (
+  view: DataType.View,
+  projection: ProjectionModel,
+  table: Table.Table,
+  properties: TablePropertyDefinition[],
+) => {
   for (const property of properties) {
-    const field = view.fields.find((field) => field.path === property.name);
+    const field = projection.fields.find((field) => field.path === property.name);
     if (field) {
       if (property.size !== undefined) {
-        field.size = property.size;
+        table.sizes[field.path] = property.size;
       }
 
       if (property.title !== undefined) {
@@ -99,7 +102,7 @@ const setProperties = (view: ViewType, projection: ViewProjection, properties: T
 
       if (property.sort) {
         const fieldId = field.id;
-        view.query.sort = [{ fieldId, direction: property.sort }];
+        view.sort = [{ fieldId, direction: property.sort }];
       }
     }
   }

package/src/util/index.ts

@@ -4,7 +4,6 @@
 
 export * from './dynamic-table';
 export * from './signals';
-export * from './table';
 export * from './table-buttons';
 export * from './table-controls';
 export * from './schema';

package/src/util/schema.ts

@@ -3,7 +3,7 @@
 //
 
 import { Schema } from 'effect';
-import { isTypeLiteral, TypeLiteral } from 'effect/SchemaAST';
+import { TypeLiteral, isTypeLiteral } from 'effect/SchemaAST';
 
 /**
  * Creates a narrowed schema from an original schema that only includes