@dxos/react-ui-form 0.8.4-main.b97322e → 0.8.4-main.bc2380dfbc

package/package.json

@@ -1,76 +1,87 @@
 {
   "name": "@dxos/react-ui-form",
-  "version": "0.8.4-main.b97322e",
+  "version": "0.8.4-main.bc2380dfbc",
   "description": "Data components.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
+  "license": "FSL-1.1-Apache-2.0",
   "author": "DXOS.org",
   "type": "module",
+  "imports": {
+    "#translations": "./src/translations.ts"
+  },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": "./dist/lib/node-esm/index.mjs"
+    },
+    "./translations": {
+      "source": "./src/translations.ts",
+      "types": "./dist/types/src/translations.d.ts",
+      "browser": "./dist/lib/browser/translations.mjs",
+      "node": "./dist/lib/node-esm/translations.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "files": [
     "dist",
     "src"
   ],
   "dependencies": {
-    "@atlaskit/pragmatic-drag-and-drop": "^1.4.0",
-    "@atlaskit/pragmatic-drag-and-drop-hitbox": "^1.0.3",
-    "@preact-signals/safe-react": "^0.9.0",
+    "@effect-atom/atom-react": "^0.5.0",
+    "@fluentui/react-tabster": "9.26.11",
     "@radix-ui/react-context": "1.1.1",
-    "date-fns": "^3.3.1",
-    "jsonpath": "^1.1.1",
-    "@dxos/async": "0.8.4-main.b97322e",
-    "@dxos/debug": "0.8.4-main.b97322e",
-    "@dxos/echo-schema": "0.8.4-main.b97322e",
-    "@dxos/echo": "0.8.4-main.b97322e",
-    "@dxos/echo-db": "0.8.4-main.b97322e",
-    "@dxos/effect": "0.8.4-main.b97322e",
-    "@dxos/invariant": "0.8.4-main.b97322e",
-    "@dxos/keys": "0.8.4-main.b97322e",
-    "@dxos/lit-ui": "0.8.4-main.b97322e",
-    "@dxos/log": "0.8.4-main.b97322e",
-    "@dxos/react-client": "0.8.4-main.b97322e",
-    "@dxos/live-object": "0.8.4-main.b97322e",
-    "@dxos/react-ui-list": "0.8.4-main.b97322e",
-    "@dxos/react-ui-stack": "0.8.4-main.b97322e",
-    "@dxos/react-ui-pickers": "0.8.4-main.b97322e",
-    "@dxos/react-ui-types": "0.8.4-main.b97322e",
-    "@dxos/react-ui-tag-picker": "0.8.4-main.b97322e",
-    "@dxos/schema": "0.8.4-main.b97322e",
-    "@dxos/util": "0.8.4-main.b97322e"
+    "@radix-ui/react-use-controllable-state": "1.1.0",
+    "date-fns": "^3.6.0",
+    "tabster": "^8.5.5",
+    "@dxos/async": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo-atom": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo-db": "0.8.4-main.bc2380dfbc",
+    "@dxos/effect": "0.8.4-main.bc2380dfbc",
+    "@dxos/echo-react": "0.8.4-main.bc2380dfbc",
+    "@dxos/invariant": "0.8.4-main.bc2380dfbc",
+    "@dxos/keys": "0.8.4-main.bc2380dfbc",
+    "@dxos/log": "0.8.4-main.bc2380dfbc",
+    "@dxos/lit-ui": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-components": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-editor": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-client": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-list": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-search": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-editor": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-pickers": "0.8.4-main.bc2380dfbc",
+    "@dxos/types": "0.8.4-main.bc2380dfbc",
+    "@dxos/util": "0.8.4-main.bc2380dfbc",
+    "@dxos/schema": "0.8.4-main.bc2380dfbc"
   },
   "devDependencies": {
-    "@types/jsonpath": "^0.2.4",
-    "@types/react": "~18.2.0",
-    "@types/react-dom": "~18.2.0",
-    "effect": "3.17.0",
+    "@types/react": "~19.2.7",
+    "@types/react-dom": "~19.2.3",
+    "effect": "3.20.0",
     "fast-check": "^3.19.0",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/echo-signals": "0.8.4-main.b97322e",
-    "@dxos/random": "0.8.4-main.b97322e",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.b97322e",
-    "@dxos/storybook-utils": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e"
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "vite": "^8.0.13",
+    "@dxos/random": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-client": "0.8.4-main.bc2380dfbc",
+    "@dxos/storybook-utils": "0.8.4-main.bc2380dfbc",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc"
   },
   "peerDependencies": {
-    "effect": "^3.13.3",
-    "react": "~18.2.0",
-    "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.b97322e",
-    "@dxos/react-ui-theme": "0.8.4-main.b97322e"
+    "effect": "3.20.0",
+    "react": "~19.2.3",
+    "react-dom": "~19.2.3",
+    "@dxos/react-ui": "0.8.4-main.bc2380dfbc",
+    "@dxos/ui-theme": "0.8.4-main.bc2380dfbc"
   },
   "publishConfig": {
     "access": "public"

package/src/components/FieldEditor/FieldEditor.stories.tsx

@@ -2,32 +2,55 @@
 // Copyright 2024 DXOS.org
 //
 
-import '@dxos-theme';
-
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useMemo, useEffect } from 'react';
+import React, { useEffect, useMemo } from 'react';
 
-import { createEchoSchema } from '@dxos/live-object/testing';
+import { Filter, Query } from '@dxos/echo';
+import { createEchoSchema } from '@dxos/echo/testing';
 import { log } from '@dxos/log';
-import { ProjectionModel } from '@dxos/schema';
-import { TestSchema, testView } from '@dxos/schema/testing';
-import { withLayout, withTheme } from '@dxos/storybook-utils';
+import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { ProjectionModel, ViewModel, createEchoChangeCallback } from '@dxos/schema';
+import { Example } from '@dxos/schema/testing';
+
+import { translations } from '#translations';
 
+import { FIELD_EDITOR_DEBUG_SYMBOL, TestLayout } from '../testing';
 import { FieldEditor, type FieldEditorProps } from './FieldEditor';
-import { translations } from '../../translations';
-import { TestLayout, TestPanel, FIELD_EDITOR_DEBUG_SYMBOL } from '../testing';
 
-// Type definition for debug objects exposed to tests.
 export type FieldEditorDebugObjects = {
   props: FieldEditorProps;
   projection: ProjectionModel;
 };
 
-type StoryProps = FieldEditorProps;
+const useTestProjection = () => {
+  return useMemo(() => {
+    const schema = createEchoSchema(Example);
+    const view = ViewModel.make({
+      name: 'Test',
+      query: Query.select(Filter.type(Example)),
+      jsonSchema: schema.jsonSchema,
+    });
+    const projection = new ProjectionModel({
+      view,
+      baseSchema: schema.jsonSchema,
+      change: createEchoChangeCallback(view, schema),
+    });
+    projection.normalizeView();
+    return { view, projection };
+  }, []);
+};
+
+const DefaultStory = () => {
+  const { view, projection } = useTestProjection();
 
-const DefaultStory = (props: FieldEditorProps) => {
   const handleComplete: FieldEditorProps['onSave'] = () => {
-    log.info('onClose', { props });
+    log.info('onClose');
+  };
+
+  const props: FieldEditorProps = {
+    projection,
+    field: view.projection.fields[0],
+    onSave: handleComplete,
   };
 
   // Expose objects on window for test access.
@@ -35,44 +58,40 @@ const DefaultStory = (props: FieldEditorProps) => {
     if (typeof window !== 'undefined') {
       (window as any)[FIELD_EDITOR_DEBUG_SYMBOL] = {
         props,
-        projection: props.projection,
+        projection,
       } satisfies FieldEditorDebugObjects;
     }
-  }, [props, props.projection]);
+  }, [props, projection]);
 
   // NOTE(ZaymonFC): This looks awkward but it resolves an infinite parsing issue with sb.
   const json = useMemo(
-    () => JSON.parse(JSON.stringify({ props, projection: props.projection })),
-    [JSON.stringify(props), JSON.stringify(props.projection)],
+    () => JSON.parse(JSON.stringify({ props, projection })),
+    [JSON.stringify(props), JSON.stringify(projection)],
   );
 
   return (
     <TestLayout json={json}>
-      <TestPanel>
-        <FieldEditor {...props} onSave={handleComplete} />
-      </TestPanel>
+      <FieldEditor {...props} />
     </TestLayout>
   );
 };
 
-const meta: Meta<StoryProps> = {
+const meta = {
   title: 'ui/react-ui-form/FieldEditor',
-  component: FieldEditor,
+  component: FieldEditor as any,
   render: DefaultStory,
-  decorators: [withLayout({ fullscreen: true }), withTheme],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
   parameters: {
+    layout: 'fullscreen',
     translations,
+    controls: {
+      disabled: true,
+    },
   },
-};
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
-type Story = StoryObj<StoryProps>;
+type Story = StoryObj<typeof meta>;
 
-export const Default: Story = {
-  args: {
-    projection: new ProjectionModel(createEchoSchema(TestSchema).jsonSchema, testView.projection),
-    field: testView.projection.fields[0],
-  },
-  parameters: { controls: { disabled: true } },
-};
+export const Default: Story = {};

package/src/components/FieldEditor/FieldEditor.test.tsx

@@ -3,14 +3,14 @@
 //
 
 import { composeStories } from '@storybook/react';
-import { screen, cleanup, fireEvent, act } from '@testing-library/react';
+import { act, cleanup, fireEvent, screen } from '@testing-library/react';
 import { afterEach, describe, expect, test } from 'vitest';
 
 import { ProjectionModel } from '@dxos/schema';
 
+import { FIELD_EDITOR_DEBUG_SYMBOL } from '../testing';
 import * as stories from './FieldEditor.stories';
 import { type FieldEditorDebugObjects } from './FieldEditor.stories';
-import { FIELD_EDITOR_DEBUG_SYMBOL } from '../testing';
 
 const { Default } = composeStories(stories);
 

package/src/components/FieldEditor/FieldEditor.tsx

@@ -4,41 +4,42 @@
 
 import React, { useCallback, useEffect, useMemo, useState } from 'react';
 
-import { type SchemaRegistry } from '@dxos/echo-db';
-import { FormatEnum, FormatEnums, formatToType, type EchoSchema } from '@dxos/echo-schema';
+import { Obj, type SchemaRegistry, type View } from '@dxos/echo';
+import { type EchoSchema, Format, FormatEnums, formatToType } from '@dxos/echo/internal';
+import { type SchemaProperty } from '@dxos/effect';
 import { log } from '@dxos/log';
-import { useTranslation } from '@dxos/react-ui';
+import { useAsyncEffect, useTranslation } from '@dxos/react-ui';
 import {
-  getFormatSchema,
-  getSchemaProperties,
-  sortProperties,
-  type FieldType,
-  type PropertyType,
   type ProjectionModel,
-  type SchemaProperty,
+  type PropertyType,
+  formatToAdditionalPropertyAttributes,
+  getFormatSchema,
 } from '@dxos/schema';
 
-import { translationKey } from '../../translations';
-import { Form, type FormProps, type InputComponent, SelectInput, SelectOptionInput } from '../Form';
+import { translationKey } from '#translations';
+
+import { getFormProperties } from '../../util';
+import { Form, type FormFieldMap, type FormRootProps, SelectField, SelectOptionField } from '../Form';
 
 export type FieldEditorProps = {
   projection: ProjectionModel;
-  field: FieldType;
-  registry?: SchemaRegistry;
+  field: View.FieldType;
+  registry?: SchemaRegistry.SchemaRegistry;
+  view?: Obj.Unknown;
   onSave: () => void;
   onCancel?: () => void;
-} & Pick<FormProps<any>, 'outerSpacing'>;
+} & Pick<FormRootProps<any>, 'readonly'>;
 
 /**
  * Displays a Form representing the metadata for a given `Field` and `View`.
  */
-export const FieldEditor = ({ projection, field, registry, onSave, onCancel, outerSpacing }: FieldEditorProps) => {
+export const FieldEditor = ({ readonly, projection, field, registry, view, onSave, onCancel }: FieldEditorProps) => {
   const { t } = useTranslation(translationKey);
   const [props, setProps] = useState<PropertyType>(projection.getFieldProjection(field.id).props);
   useEffect(() => setProps(projection.getFieldProjection(field.id).props), [field, projection]);
 
   const [schemas, setSchemas] = useState<EchoSchema[]>([]);
-  useEffect(() => {
+  useAsyncEffect(async () => {
     if (!registry) {
       return;
     }
@@ -46,14 +47,10 @@ export const FieldEditor = ({ projection, field, registry, onSave, onCancel, out
     const subscription = registry.query().subscribe((query) => setSchemas(query.results), { fire: true });
 
     // TODO(dmaretskyi): This shouldn't be needed.
-    const t = setTimeout(async () => {
-      const schemas = await registry.query().run();
-      setSchemas(schemas);
-    });
-    return () => {
-      clearTimeout(t);
-      subscription?.();
-    };
+    const schemas = await registry.query().run();
+    setSchemas(schemas);
+
+    return () => subscription?.();
   }, [registry]);
 
   const [referenceSchema, setReferenceSchema] = useState<EchoSchema>();
@@ -65,11 +62,47 @@ export const FieldEditor = ({ projection, field, registry, onSave, onCancel, out
   //  Class constructor SchemaClass cannot be invoked without 'new'.
   const [{ fieldSchema }, setFieldSchema] = useState({ fieldSchema: getFormatSchema(props?.format) });
 
-  const handleValuesChanged = useCallback<NonNullable<FormProps<PropertyType>['onValuesChanged']>>(
+  const fieldMap = useMemo<FormFieldMap>(
+    () => ({
+      ['format' satisfies keyof PropertyType]: (props) => (
+        <SelectField
+          {...props}
+          options={FormatEnums.filter((value) => value !== Format.TypeFormat.None).map((value) => ({
+            value,
+            label: t(`format.${value}.label`),
+          }))}
+        />
+      ),
+      ['referenceSchema' satisfies keyof PropertyType]: (props) => (
+        <SelectField
+          {...props}
+          options={schemas.map((schema) => ({
+            value: schema.typename,
+          }))}
+        />
+      ),
+      ['referencePath' satisfies keyof PropertyType]: (props) => (
+        <SelectField
+          {...props}
+          options={
+            referenceSchema
+              ? getFormProperties(referenceSchema.ast)
+                  .sort((a, b) => a.name.toString().localeCompare(b.name.toString()))
+                  .map((p) => ({ value: p.name.toString() }))
+              : []
+          }
+        />
+      ),
+      ['options' satisfies keyof PropertyType]: (props) => <SelectOptionField {...props} />,
+    }),
+    [t, schemas, referenceSchema],
+  );
+
+  const propIsNotType = useCallback((props: SchemaProperty[]) => props.filter((prop) => prop.name !== 'type'), []);
+
+  const handleValuesChanged = useCallback<NonNullable<FormRootProps<PropertyType>['onValuesChanged']>>(
     (_props) => {
-      // TODO(burdon): Callback should pass `changed` to indicate which fields have changed.
-      // TODO(Zaymon): Workout why old and new format values are the same sometimes even when
-      //   selecting novel format values.
+      // TODO(Zaymon): Workout why old and new format values are the same sometimes even when selecting novel format values.
       setFieldSchema((prev) => {
         const fieldSchema = getFormatSchema(_props.format);
         if (prev.fieldSchema === fieldSchema) {
@@ -90,8 +123,10 @@ export const FieldEditor = ({ projection, field, registry, onSave, onCancel, out
 
       setProps((props) => {
         const type = formatToType[_props.format as keyof typeof formatToType];
+        const additionalProps =
+          formatToAdditionalPropertyAttributes[_props.format as keyof typeof formatToAdditionalPropertyAttributes];
         if (props.type !== type) {
-          return { ...props, ..._props, type };
+          return { ...props, ..._props, ...additionalProps, type } as PropertyType;
         }
 
         return _props as PropertyType;
@@ -100,9 +135,9 @@ export const FieldEditor = ({ projection, field, registry, onSave, onCancel, out
     [schemas, props.format, props.referenceSchema],
   );
 
-  const handleValidate = useCallback<NonNullable<FormProps<PropertyType>['onValidate']>>(
+  const handleValidate = useCallback<NonNullable<FormRootProps<PropertyType>['onValidate']>>(
     ({ property }) => {
-      if (property && projection.fields.find((f) => f.path === property && f.path !== field.path)) {
+      if (property && projection.getFields().find((f) => f.path === property && f.path !== field.path)) {
         return [
           {
             path: 'property',
@@ -111,83 +146,53 @@ export const FieldEditor = ({ projection, field, registry, onSave, onCancel, out
         ];
       }
     },
-    [projection.fields, field],
+    [projection.getFields(), field],
   );
 
-  const handleSave = useCallback<NonNullable<FormProps<PropertyType>['onSave']>>(
+  const handleSave = useCallback<NonNullable<FormRootProps<PropertyType>['onSave']>>(
     (props) => {
-      projection.setFieldProjection({ field, props });
+      if (view) {
+        Obj.update(view, () => {
+          projection.setFieldProjection({ field, props });
+        });
+      } else {
+        projection.setFieldProjection({ field, props });
+      }
       onSave();
     },
-    [projection, field, onSave],
+    [projection, field, view, onSave],
   );
 
-  const handleCancel = useCallback<NonNullable<FormProps<PropertyType>['onCancel']>>(() => {
+  const handleCancel = useCallback<NonNullable<FormRootProps<PropertyType>['onCancel']>>(() => {
+    onSave();
     // Need to defer to allow form to close.
     requestAnimationFrame(() => onCancel?.());
-    onSave();
   }, [onSave]);
 
-  const custom: Partial<Record<string, InputComponent>> = useMemo(
-    () => ({
-      ['format' satisfies keyof PropertyType]: (props) => (
-        <SelectInput
-          {...props}
-          options={FormatEnums.filter((value) => value !== FormatEnum.None).map((value) => ({
-            value,
-            label: t(`format ${value}`),
-          }))}
-        />
-      ),
-      ['referenceSchema' satisfies keyof PropertyType]: (props) => (
-        <SelectInput
-          {...props}
-          options={schemas.map((schema) => ({
-            value: schema.typename,
-          }))}
-        />
-      ),
-      ['referencePath' satisfies keyof PropertyType]: (props) => (
-        <SelectInput
-          {...props}
-          options={
-            referenceSchema
-              ? getSchemaProperties(referenceSchema.ast)
-                  .sort(sortProperties)
-                  .map((p) => ({ value: p.name }))
-              : []
-          }
-        />
-      ),
-      ['options' satisfies keyof PropertyType]: (props) => <SelectOptionInput {...props} />,
-    }),
-    [t, schemas, referenceSchema],
-  );
-
-  const propIsNotType = useCallback(
-    (props: SchemaProperty<PropertyType>[]) => props.filter((p) => p.name !== 'type'),
-    [],
-  );
-
   if (!fieldSchema) {
     log.warn('invalid format', { props });
     return null;
   }
 
   return (
-    <Form<PropertyType>
+    <Form.Root<PropertyType>
       key={field.id}
+      fieldMap={fieldMap}
       autoFocus
-      values={props}
+      readonly={readonly}
       schema={fieldSchema}
-      filter={propIsNotType}
+      values={props}
+      exclude={propIsNotType}
       sort={['property', 'format']}
       onValuesChanged={handleValuesChanged}
       onValidate={handleValidate}
       onSave={handleSave}
       onCancel={handleCancel}
-      Custom={custom}
-      outerSpacing={outerSpacing}
-    />
+    >
+      <Form.Content>
+        <Form.FieldSet />
+        <Form.Actions />
+      </Form.Content>
+    </Form.Root>
   );
 };

package/src/components/Form/AUDIT.md

@@ -0,0 +1,17 @@
+# Form
+
+## New features/polish
+
+- [x] Unify readonly/inline modes.
+- [x] Refs
+  - [x] Single-select (fix popover)
+  - [x] Multi-select (array)
+- [ ] auto save doesn't work for combobox + select due to only firing on blur (workaround is to use onValuesChanged).
+- [ ] Don't call save/autoSave if value hasn't changed.
+- [ ] Fix onCancel (restore values).
+- [ ] Fix useSchema Type.AnyObj cast.
+- [ ] TableCellEditor (handleEnter/ModalController).
+- [ ] Use FormFieldWrapper uniformly
+- [ ] Inline tables.
+- [ ] Defer query until popover.
+- [ ] Omit id from sub properties (tune Omit)