@dxos/react-ui-table 0.8.4-main.e8ec1fe → 0.8.4-main.effb148878

package/src/testing/useTestTableModel.ts

@@ -2,54 +2,62 @@
 // Copyright 2025 DXOS.org
 //
 
-import { useCallback, useMemo, useRef } from 'react';
+import { RegistryContext } from '@effect-atom/atom-react';
+import { type RefObject, useCallback, useContext, useMemo, useRef } from 'react';
 
-import { isMutable, toJsonSchema } from '@dxos/echo/internal';
-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 { ProjectionModel, View, getTypenameFromQuery } from '@dxos/schema';
+import { type Database, Filter, Type } from '@dxos/echo';
+import { random } from '@dxos/random';
+import { useQuery, useType } from '@dxos/react-client/echo';
+import { useClientStory } from '@dxos/react-client/testing';
+import { useGlobalFilteredObjects } from '@dxos/react-ui-search';
+import { type ProjectionModel, getTypenameFromQuery } 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.
+import { useAddRow, useProjectionModel, useTableModel } from '../hooks';
+import { type TableModel, TablePresentation } from '../model';
+import { Table } from '../types';
+
+random.seed(0); // NOTE(ZaymonFC): Required for smoke tests.
+
+export type TestTableModel<T extends Type.AnyObj = Type.AnyObj> = {
+  schema: T | undefined;
+  table: Table.Table | undefined;
+  projection: ProjectionModel | undefined;
+  tableRef: RefObject<TableController | null>;
+  model: TableModel | undefined;
+  presentation: TablePresentation | undefined;
+  db: Database.Database | undefined;
+  handleInsertRow: () => void;
+  handleSaveView: () => void;
+  handleDeleteRows: (rowIndex: number, objects: any[]) => void;
+  handleDeleteColumn: (fieldId: string) => void;
+};
 
 /**
  * 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(View.View));
-  const view = useMemo(() => views.at(0), [views]);
-  const typename = view?.query ? getTypenameFromQuery(view.query.ast) : undefined;
-  const schema = useSchema(client, space, typename);
-  const jsonSchema = useMemo(() => (schema ? toJsonSchema(schema) : undefined), [schema]);
-
-  const projection = useMemo(() => {
-    if (schema && view?.projection) {
-      const projection = new ProjectionModel(toJsonSchema(schema), view.projection);
-      projection.normalizeView();
-      return projection;
-    }
-  }, [schema, view?.projection]);
+export const useTestTableModel = <T extends Type.AnyObj = Type.AnyObj>(): TestTableModel<T> => {
+  const registry = useContext(RegistryContext);
+  const { space } = useClientStory();
+  const db = space?.db;
+
+  const tables = useQuery(space?.db, Filter.type(Table.Table));
+  const table = tables.at(0);
+  const typename = table?.view.target?.query ? getTypenameFromQuery(table.view.target.query.ast) : undefined;
+  const schema = useType<T>(space?.db, typename);
+  const projection = useProjectionModel(schema, table, registry);
 
   const features = useMemo(
     () => ({
       selection: { enabled: true, mode: 'multiple' as const },
       dataEditable: true,
-      schemaEditable: schema && isMutable(schema),
+      schemaEditable: schema != null && Type.getDatabase(schema) != null,
     }),
     [schema],
   );
 
-  const objects = useQuery(space, schema ? Filter.type(schema) : Filter.nothing());
+  const objects = useQuery(db, schema ? Filter.type(schema) : Filter.nothing());
   const filteredObjects = useGlobalFilteredObjects(objects);
 
   const tableRef = useRef<TableController>(null);
@@ -61,15 +69,15 @@ export const useTestTableModel = () => {
     tableRef.current?.update?.();
   }, []);
 
-  const addRow = useAddRow({ space, schema });
+  const addRow = useAddRow({ db, schema });
 
   const handleDeleteRows = useCallback(
     (_: number, objects: any[]) => {
       for (const object of objects) {
-        space?.db.remove(object);
+        db?.remove(object);
       }
     },
-    [space],
+    [db],
   );
 
   const handleDeleteColumn = useCallback(
@@ -82,14 +90,13 @@ export const useTestTableModel = () => {
   );
 
   const model = useTableModel({
-    view,
-    schema: jsonSchema,
+    object: table,
     projection,
     features,
     rows: filteredObjects,
     onInsertRow: addRow,
     onDeleteRows: handleDeleteRows,
-    onDeleteColumn: handleDeleteColumn,
+    onColumnDelete: handleDeleteColumn,
     onCellUpdate: handleCellUpdate,
     onRowOrderChange: handleRowOrderChange,
   });
@@ -97,7 +104,7 @@ export const useTestTableModel = () => {
   const handleInsertRow = useCallback(() => {
     const insertResult = model?.insertRow();
     tableRef.current?.handleInsertRowResult?.(insertResult);
-  }, [model, tableRef.current]);
+  }, [model]);
 
   const handleSaveView = useCallback(() => {
     model?.saveView();
@@ -105,19 +112,18 @@ export const useTestTableModel = () => {
 
   const presentation = useMemo(() => {
     if (model) {
-      return new TablePresentation(model);
+      return new TablePresentation(registry, model);
     }
-  }, [model]);
+  }, [registry, model]);
 
   return {
     schema,
-    view,
+    table,
     projection,
     tableRef,
     model,
     presentation,
-    space,
-    client,
+    db,
     handleInsertRow,
     handleSaveView,
     handleDeleteRows,

package/src/translations.ts

@@ -4,33 +4,31 @@
 
 import { type Resource } from '@dxos/react-ui';
 
-export const translationKey = 'react-ui-table';
+export const translationKey = '@dxos/react-ui-table';
 
 export const translations = [
   {
     'en-US': {
       [translationKey]: {
-        'object placeholder': 'New table',
-        'create object label': 'Create table',
-        'table name placeholder': 'Table name',
-        'settings title': 'Table settings',
-        'table schema label': 'Record type',
-        'new schema': 'New record type',
-        'continue label': 'Continue',
-        'create stack section label': 'Create table',
-        'add row label': 'Add row',
-        'create comment': 'Create thread',
-        'column action sort descending': 'Sort Descending',
-        'column action sort ascending': 'Sort Ascending',
-        'column action clear sorting': 'Clear Sorting',
-        'column action settings': 'Column Settings',
-        'column action delete': 'Delete Column',
-        'delete row label': 'Delete row',
-        'bulk delete row label': 'Delete selected rows',
-        'column deleted label': 'Column deleted',
-        'new column button label': 'Create column',
-        'create new object label': 'Create new object “{{text}}”',
-        'save view label': 'Save changes to view',
+        'object.placeholder': 'New table',
+        'create-object.label': 'Create table',
+        'table-name.placeholder': 'Table name',
+        'settings.title': 'Table settings',
+        'table-schema.label': 'Type',
+        'continue.label': 'Continue',
+        'create-stack-section.label': 'Create table',
+        'add-row.label': 'Add row',
+        'column-action-sort-descending.menu': 'Sort Descending',
+        'column-action-sort-ascending.menu': 'Sort Ascending',
+        'column-action-clear-sorting.menu': 'Clear Sorting',
+        'column-action-settings.menu': 'Column Settings',
+        'column-action-delete.menu': 'Delete Column',
+        'delete-row.label': 'Delete row',
+        'bulk-delete-row.label': 'Delete selected rows',
+        'column-deleted.label': 'Column deleted',
+        'new-column-button.label': 'Create column',
+        'create-new-object.label': 'Create new object “{{text}}”',
+        'save-view.label': 'Save changes to view',
       },
     },
   },

package/src/types/Table.ts

@@ -0,0 +1,81 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Match from 'effect/Match';
+import * as Schema from 'effect/Schema';
+import * as SchemaAST from 'effect/SchemaAST';
+
+// QueryAST is referenced indirectly through `Type.InstanceType<typeof TableSchema>`
+// (Ref.Ref(View.View) → View.View → QueryAST.Query) in the emitted .d.ts; the
+// namespace import keeps the inferred types portable.
+// eslint-disable-next-line unused-imports/no-unused-imports
+import { DXN, Annotation, JsonSchema, Obj, QueryAST, Ref, Type, View } from '@dxos/echo';
+import { FormInputAnnotation, type JsonPath, type JsonSchemaType, LabelAnnotation } from '@dxos/echo/internal';
+import { ViewAnnotation } from '@dxos/schema';
+
+const TableSchema = Schema.Struct({
+  name: Schema.String.pipe(Schema.optional),
+
+  view: Ref.Ref(View.View).pipe(FormInputAnnotation.set(false)),
+
+  sizes: Schema.Record({
+    // TODO(wittjosiah): Should be JsonPath.
+    key: Schema.String,
+    value: Schema.Number,
+  }).pipe(Schema.mutable, FormInputAnnotation.set(false)),
+}).pipe(
+  LabelAnnotation.set(['name']),
+  ViewAnnotation.set(['view']),
+  Annotation.IconAnnotation.set({
+    icon: 'ph--table--regular',
+    hue: 'green',
+  }),
+  Type.makeObject(DXN.make('org.dxos.type.table', '0.1.0')),
+);
+
+// TODO(wittjosiah): Try to clean up this type inference.
+export interface Table extends Type.InstanceType<typeof TableSchema> {}
+export const Table = TableSchema;
+
+type MakeProps = {
+  name?: string;
+  sizes?: Record<string, number>;
+  view: View.View;
+  /** Required to auto-size columns. */
+  jsonSchema?: JsonSchemaType;
+};
+
+/**
+ * Make a table as a view of a data set.
+ */
+export const make = ({ name, sizes = {}, view, jsonSchema }: MakeProps): Table => {
+  const table = Obj.make(Table, { name, view: Ref.make(view), sizes } as Obj.MakeProps<typeof Table>);
+
+  // Preset sizes.
+  if (jsonSchema) {
+    const schema = JsonSchema.toEffectSchema(jsonSchema);
+    const properties = SchemaAST.getPropertySignatures(schema.ast);
+    for (const property of properties) {
+      const name = property.name.toString() as JsonPath;
+      if (sizes?.[name]) {
+        table.sizes[name] = sizes[name];
+        continue;
+      }
+
+      Match.type<SchemaAST.AST>().pipe(
+        Match.when({ _tag: 'BooleanKeyword' }, () => {
+          table.sizes[name] = 100;
+        }),
+        Match.when({ _tag: 'NumberKeyword' }, () => {
+          table.sizes[name] = 100;
+        }),
+        Match.orElse(() => {
+          // Noop.
+        }),
+      )(property.type);
+    }
+  }
+
+  return table;
+};

package/src/types/index.ts

@@ -2,4 +2,4 @@
 // Copyright 2025 DXOS.org
 //
 
-export * as Table from './schema';
+export * as Table from './Table';

package/src/util/dynamic-table.test.ts

@@ -0,0 +1,63 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Registry } from '@effect-atom/atom-react';
+import { describe, expect, test } from 'vitest';
+
+import { Format } from '@dxos/echo';
+
+import { type TablePropertyDefinition, getBaseSchema, makeDynamicTable } from './dynamic-table';
+
+describe('makeDynamicTable', () => {
+  /**
+   * Builds the Type entity from a JSON schema, then makes the table.
+   * Confirms makeDynamicTable + setProperties (title) works for the jsonSchema path.
+   */
+  test('makeDynamicTable from a jsonSchema with properties with title does not throw', () => {
+    const registry = Registry.make();
+    const jsonSchema = {
+      typename: 'com.example.type.dynamicTablePlain',
+      version: '0.1.0',
+      type: 'object' as const,
+      properties: {
+        id: { type: 'string' as const },
+        name: { type: 'string' as const },
+      },
+      required: ['id'],
+    };
+    const properties: TablePropertyDefinition[] = [
+      { name: 'id', format: Format.TypeFormat.String },
+      { name: 'name', format: Format.TypeFormat.String, title: 'Name' },
+    ];
+
+    expect(() => {
+      const { type } = getBaseSchema({ jsonSchema });
+      const { projection, object } = makeDynamicTable({ registry, type, properties });
+      expect(projection).toBeDefined();
+      expect(object).toBeDefined();
+      expect(projection.getFields().length).toBeGreaterThan(0);
+    }).not.toThrow();
+  });
+
+  /**
+   * Builds the Type entity from property definitions, then makes the table.
+   * Confirms makeDynamicTable + setProperties (title) works for the property-definitions path.
+   */
+  test('makeDynamicTable from getBaseSchema(typename, properties) with properties with title does not throw', () => {
+    const registry = Registry.make();
+    const typename = 'com.example.type.dynamicTableTest';
+    const properties: TablePropertyDefinition[] = [
+      { name: 'id', format: Format.TypeFormat.String },
+      { name: 'name', format: Format.TypeFormat.String, title: 'Name' },
+    ];
+
+    expect(() => {
+      const { type } = getBaseSchema({ typename, properties });
+      const { projection, object } = makeDynamicTable({ registry, type, properties });
+      expect(projection).toBeDefined();
+      expect(object).toBeDefined();
+      expect(projection.getFields().length).toBeGreaterThan(0);
+    }).not.toThrow();
+  });
+});

package/src/util/dynamic-table.ts

@@ -2,16 +2,16 @@
 // Copyright 2025 DXOS.org
 //
 
-import type * as Schema from 'effect/Schema';
+import { type Registry } from '@effect-atom/atom-react';
+import type * as Types from 'effect/Types';
 
-import { Filter, Obj, Query } from '@dxos/echo';
-import { getTypename, toJsonSchema } from '@dxos/echo/internal';
-import type { JsonSchemaType } from '@dxos/echo/internal';
+import { Filter, type JsonSchema, Obj, Order, Query, type QueryAST, Ref, Type, type View } from '@dxos/echo';
 import {
   ProjectionModel,
   type SchemaPropertyDefinition,
-  type SortDirectionType,
-  View,
+  ViewModel,
+  createEchoChangeCallback,
+  getSchemaFromJsonSchema,
   getSchemaFromPropertyDefinitions,
 } from '@dxos/schema';
 
@@ -21,7 +21,7 @@ import { Table } from '../types';
 type PropertyDisplayProps = {
   size: number;
   title: string;
-  sort: SortDirectionType;
+  sort: QueryAST.OrderDirection;
 };
 
 export type TablePropertyDefinition = SchemaPropertyDefinition & Partial<PropertyDisplayProps>;
@@ -31,50 +31,57 @@ export type TablePropertyDefinition = SchemaPropertyDefinition & Partial<Propert
  */
 // TODO(burdon): Remove variance.
 export const getBaseSchema = ({
+  type,
   typename,
   properties,
   jsonSchema,
-  schema,
 }: {
+  type?: Type.AnyEntity;
   typename?: string;
   properties?: TablePropertyDefinition[];
-  jsonSchema?: JsonSchemaType;
-  schema?: Schema.Schema.AnyNoContext;
-}): { typename: string; jsonSchema: JsonSchemaType } => {
-  if (typename && properties) {
-    const schema = getSchemaFromPropertyDefinitions(typename, properties);
-    return { typename: schema.typename, jsonSchema: schema.jsonSchema };
-  } else if (schema) {
-    return { typename: getTypename(schema)!, jsonSchema: toJsonSchema(schema) };
-  } else if (typename && jsonSchema) {
-    return { typename, jsonSchema };
-  } else {
+  jsonSchema?: Types.DeepMutable<JsonSchema.JsonSchema>;
+}): { typename: string; type: Type.AnyEntity } => {
+  const resolved =
+    typename && properties
+      ? getSchemaFromPropertyDefinitions(typename, properties)
+      : (type ?? (jsonSchema ? getSchemaFromJsonSchema(jsonSchema, typename) : undefined));
+  if (!resolved) {
     throw new Error('invalid properties');
   }
+
+  return { typename: Type.getTypename(resolved)!, type: resolved };
 };
 
 export const makeDynamicTable = ({
-  jsonSchema,
+  registry,
+  type,
   properties,
 }: {
-  jsonSchema: JsonSchemaType;
+  registry: Registry.Registry;
+  type: Type.AnyEntity;
   properties?: TablePropertyDefinition[];
-}): { projection: ProjectionModel; view: View.View } => {
-  const table = Obj.make(Table.Table, { sizes: {} });
-  const view = View.make({
+}): { projection: ProjectionModel; object: Table.Table } => {
+  const jsonSchema = type.jsonSchema;
+  const view = ViewModel.make({
     query: Query.select(Filter.everything()),
     jsonSchema,
-    presentation: table,
+    type,
     ...(properties && { fields: properties.map((property) => property.name) }),
   });
+  const object = Obj.make(Table.Table, { view: Ref.make(view), sizes: {} });
 
-  const projection = new ProjectionModel(jsonSchema, view.projection);
+  const projection = new ProjectionModel({
+    registry,
+    view,
+    baseSchema: jsonSchema,
+    change: createEchoChangeCallback(view, type),
+  });
   projection.normalizeView();
-  if (properties && projection.fields) {
-    setProperties(view, projection, table, properties);
+  if (properties && projection.getFields()) {
+    setProperties(view, projection, object, properties);
   }
 
-  return { projection, view };
+  return { projection, object };
 };
 
 const setProperties = (
@@ -84,10 +91,12 @@ const setProperties = (
   properties: TablePropertyDefinition[],
 ) => {
   for (const property of properties) {
-    const field = projection.fields.find((field) => field.path === property.name);
+    const field = projection.getFields().find((field) => field.path === property.name);
     if (field) {
       if (property.size !== undefined) {
-        table.sizes[field.path] = property.size;
+        Obj.update(table, (table) => {
+          table.sizes[field.path] = property.size!;
+        });
       }
 
       if (property.title !== undefined) {
@@ -99,8 +108,14 @@ const setProperties = (
       }
 
       if (property.sort) {
-        const fieldId = field.id;
-        view.sort = [{ fieldId, direction: property.sort }];
+        // Apply sort to query instead of deprecated view.sort
+        const currentQuery = Query.fromAst(Obj.getSnapshot(view).query.ast);
+        // Use any type parameter since we're working with dynamic field paths
+        const newQuery = currentQuery.orderBy(Order.property<any>(field.path as string, property.sort));
+        Obj.update(view, (view) => {
+          // Type assertion needed because Query AST types have some variance issues.
+          view.query.ast = newQuery.ast as typeof view.query.ast;
+        });
       }
     }
   }

package/src/util/index.ts

@@ -3,7 +3,9 @@
 //
 
 export * from './dynamic-table';
+export * from './query-ast';
 export * from './signals';
+export * from './sort';
 export * from './table-buttons';
 export * from './table-controls';
 export * from './schema';

package/src/util/query-ast.ts

@@ -0,0 +1,22 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { type QueryAST } from '@dxos/echo';
+
+/**
+ * Extracts order clauses from a query AST.
+ * Handles nested structures (options, order, etc.).
+ */
+export const extractOrder = (queryAst: QueryAST.Query): readonly QueryAST.Order[] | undefined => {
+  if (queryAst.type === 'order') {
+    return queryAst.order;
+  }
+  if (queryAst.type === 'options') {
+    return extractOrder(queryAst.query);
+  }
+  if (queryAst.type === 'from') {
+    return extractOrder(queryAst.query);
+  }
+  return undefined;
+};

package/src/util/sort.ts

@@ -0,0 +1,90 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { Format, type QueryAST } from '@dxos/echo';
+
+/**
+ * Gets a normalized sort value for a given value and format.
+ * This ensures consistent sorting behavior across different data types.
+ */
+export const getSortValue = (value: any, format: Format.TypeFormat): any => {
+  // Handle null/undefined
+  if (value === undefined || value === null) {
+    return null;
+  }
+
+  // Handle dates chronologically if schema indicates date format
+  const isDateFormat = format === Format.TypeFormat.DateTime || format === Format.TypeFormat.Date;
+  if (isDateFormat) {
+    const date = new Date(value);
+    if (!isNaN(date.getTime())) {
+      return date.getTime();
+    }
+    // Fallback to string if date parsing fails
+    return String(value);
+  }
+
+  // Handle numbers if schema indicates number format
+  if (
+    format === Format.TypeFormat.Number ||
+    format === Format.TypeFormat.Integer ||
+    format === Format.TypeFormat.Currency ||
+    format === Format.TypeFormat.Percent ||
+    format === Format.TypeFormat.Duration
+  ) {
+    const num = typeof value === 'number' ? value : Number(value);
+    if (!isNaN(num)) {
+      return num;
+    }
+    // Fallback to string if number parsing fails
+    return String(value);
+  }
+
+  // Default to string comparison
+  if (typeof value === 'string') {
+    return value;
+  }
+  if (typeof value === 'number') {
+    return value;
+  }
+
+  // Fallback to string representation
+  return String(value);
+};
+
+/**
+ * Compares two values for sorting based on the field format.
+ * Handles dates, numbers, and strings appropriately.
+ */
+export const compareValues = (
+  aValue: any,
+  bValue: any,
+  format: Format.TypeFormat,
+  direction: QueryAST.OrderDirection,
+): number => {
+  // Handle null/undefined values - nulls sort to the end
+  if (aValue === undefined || aValue === null) {
+    return bValue === undefined || bValue === null ? 0 : 1;
+  }
+  if (bValue === undefined || bValue === null) {
+    return -1;
+  }
+
+  // Get normalized sort values
+  const aSortValue = getSortValue(aValue, format);
+  const bSortValue = getSortValue(bValue, format);
+
+  // Compare based on type
+  let comparison = 0;
+  if (typeof aSortValue === 'number' && typeof bSortValue === 'number') {
+    comparison = aSortValue - bSortValue;
+  } else if (typeof aSortValue === 'string' && typeof bSortValue === 'string') {
+    comparison = aSortValue.localeCompare(bSortValue);
+  } else {
+    // Mixed types - convert both to strings
+    comparison = String(aSortValue).localeCompare(String(bSortValue));
+  }
+
+  return direction === 'desc' ? -comparison : comparison;
+};

package/src/util/table-buttons.ts

@@ -39,7 +39,7 @@ const createButton = ({
     .map(([k, v]) => `${k}="${v}"`)
     .join(' ');
 
-  return `<button ${attr} data-testid="${testId}" class="dx-button is-6 aspect-square pli-0.5 min-bs-0" ${dataAttrs} ${disabled ? 'disabled' : ''} data-dx-grid-action="accessory"><svg data-size="4"><use href="/icons.svg#${icon}"/></svg></button>`;
+  return `<button ${attr} data-testid="${testId}" class="dx-button w-6 aspect-square px-0.5 min-h-0" ${dataAttrs} ${disabled ? 'disabled' : ''} data-dx-grid-action="accessory"><svg data-size="4"><use href="/icons.svg#${icon}"/></svg></button>`;
 };
 
 const addColumnButton = {

package/src/util/table-controls.ts

@@ -25,8 +25,8 @@ export const CONTROL_IDENTIFIERS = {
 } as const;
 
 const BASE_CLASSES = {
-  checkbox: 'absolute inset-block-[.375rem] inline-end-[.375rem] dx-checkbox',
-  switch: 'absolute inset-block-[.25rem] inline-end-[.25rem] dx-checkbox--switch',
+  checkbox: 'absolute inset-y-[.375rem] end-[.375rem] dx-checkbox',
+  switch: 'absolute inset-y-[.25rem] end-[.25rem] dx-checkbox--switch',
 } as const;
 
 const renderAttributes = (data: Record<string, string>) => {