@dxos/react-ui-form 0.8.4-main.3eb6e50203 → 0.8.4-main.3fbcb4aa9b

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-form",
-  "version": "0.8.4-main.3eb6e50203",
+  "version": "0.8.4-main.3fbcb4aa9b",
   "description": "Data components.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -11,77 +11,77 @@
   "license": "MIT",
   "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.7.7",
-    "@atlaskit/pragmatic-drag-and-drop-hitbox": "1.1.0",
     "@effect-atom/atom-react": "^0.5.0",
     "@fluentui/react-tabster": "9.26.11",
     "@radix-ui/react-context": "1.1.1",
     "@radix-ui/react-use-controllable-state": "1.1.0",
-    "date-fns": "^3.3.1",
-    "jsonpath": "^1.1.1",
+    "date-fns": "^3.6.0",
     "tabster": "^8.5.5",
-    "@dxos/echo-query": "0.8.4-main.3eb6e50203",
-    "@dxos/echo-react": "0.8.4-main.3eb6e50203",
-    "@dxos/async": "0.8.4-main.3eb6e50203",
-    "@dxos/effect": "0.8.4-main.3eb6e50203",
-    "@dxos/invariant": "0.8.4-main.3eb6e50203",
-    "@dxos/echo": "0.8.4-main.3eb6e50203",
-    "@dxos/keys": "0.8.4-main.3eb6e50203",
-    "@dxos/lit-ui": "0.8.4-main.3eb6e50203",
-    "@dxos/log": "0.8.4-main.3eb6e50203",
-    "@dxos/react-client": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-editor": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-list": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-mosaic": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-pickers": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-searchlist": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-stack": "0.8.4-main.3eb6e50203",
-    "@dxos/schema": "0.8.4-main.3eb6e50203",
-    "@dxos/types": "0.8.4-main.3eb6e50203",
-    "@dxos/ui-types": "0.8.4-main.3eb6e50203",
-    "@dxos/util": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-components": "0.8.4-main.3eb6e50203",
-    "@dxos/debug": "0.8.4-main.3eb6e50203"
+    "@dxos/async": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/echo": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/echo-atom": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/echo-db": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/echo-react": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/effect": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/invariant": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/keys": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/lit-ui": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-ui-components": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-client": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-ui-editor": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-ui-list": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/log": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-ui-pickers": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-ui-search": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/types": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/util": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/ui-editor": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/schema": "0.8.4-main.3fbcb4aa9b"
   },
   "devDependencies": {
-    "@types/jsonpath": "^0.2.4",
     "@types/react": "~19.2.7",
     "@types/react-dom": "~19.2.3",
-    "effect": "3.19.16",
+    "effect": "3.20.0",
     "fast-check": "^3.19.0",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
-    "vite": "7.1.9",
-    "@dxos/random": "0.8.4-main.3eb6e50203",
-    "@dxos/react-client": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.3eb6e50203",
-    "@dxos/react-ui": "0.8.4-main.3eb6e50203",
-    "@dxos/storybook-utils": "0.8.4-main.3eb6e50203",
-    "@dxos/ui-theme": "0.8.4-main.3eb6e50203"
+    "vite": "^8.0.10",
+    "@dxos/random": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-client": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-ui": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/storybook-utils": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/ui-theme": "0.8.4-main.3fbcb4aa9b"
   },
   "peerDependencies": {
-    "effect": "3.19.16",
+    "effect": "3.20.0",
     "react": "~19.2.3",
     "react-dom": "~19.2.3",
-    "@dxos/react-ui": "0.8.4-main.3eb6e50203",
-    "@dxos/ui-theme": "0.8.4-main.3eb6e50203"
+    "@dxos/react-ui": "0.8.4-main.3fbcb4aa9b",
+    "@dxos/ui-theme": "0.8.4-main.3fbcb4aa9b"
   },
   "publishConfig": {
     "access": "public"

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

@@ -8,26 +8,24 @@ import React, { useEffect, useMemo } from 'react';
 import { Filter, Query } from '@dxos/echo';
 import { createEchoSchema } from '@dxos/echo/testing';
 import { log } from '@dxos/log';
-import { withTheme } from '@dxos/react-ui/testing';
-import { ProjectionModel, View, createEchoChangeCallback } from '@dxos/schema';
+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 { translations } from '#translations';
 
+import { FIELD_EDITOR_DEBUG_SYMBOL, TestLayout } from '../testing';
 import { FieldEditor, type FieldEditorProps } from './FieldEditor';
 
-// Type definition for debug objects exposed to tests.
 export type FieldEditorDebugObjects = {
   props: FieldEditorProps;
   projection: ProjectionModel;
 };
 
-// TODO(wittjosiah): ECHO objects don't work when passed via Storybook args.
 const useTestProjection = () => {
   return useMemo(() => {
     const schema = createEchoSchema(Example);
-    const view = View.make({
+    const view = ViewModel.make({
       name: 'Test',
       query: Query.select(Filter.type(Example)),
       jsonSchema: schema.jsonSchema,
@@ -82,7 +80,7 @@ const meta = {
   title: 'ui/react-ui-form/FieldEditor',
   component: FieldEditor as any,
   render: DefaultStory,
-  decorators: [withTheme()],
+  decorators: [withTheme(), withLayout({ layout: 'fullscreen' })],
   parameters: {
     layout: 'fullscreen',
     translations,

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

@@ -9,7 +9,6 @@ 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';
 

package/src/components/FieldEditor/FieldEditor.tsx

@@ -4,26 +4,26 @@
 
 import React, { useCallback, useEffect, useMemo, useState } from 'react';
 
-import { Obj, type SchemaRegistry } from '@dxos/echo';
+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 { useAsyncEffect, useTranslation } from '@dxos/react-ui';
 import {
-  type FieldType,
   type ProjectionModel,
   type PropertyType,
   formatToAdditionalPropertyAttributes,
   getFormatSchema,
 } from '@dxos/schema';
 
-import { translationKey } from '../../translations';
+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;
+  field: View.FieldType;
   registry?: SchemaRegistry.SchemaRegistry;
   view?: Obj.Unknown;
   onSave: () => void;
@@ -69,7 +69,7 @@ export const FieldEditor = ({ readonly, projection, field, registry, view, onSav
           {...props}
           options={FormatEnums.filter((value) => value !== Format.TypeFormat.None).map((value) => ({
             value,
-            label: t(`format ${value}`),
+            label: t(`format.${value}.label`),
           }))}
         />
       ),
@@ -152,7 +152,7 @@ export const FieldEditor = ({ readonly, projection, field, registry, view, onSav
   const handleSave = useCallback<NonNullable<FormRootProps<PropertyType>['onSave']>>(
     (props) => {
       if (view) {
-        Obj.change(view, () => {
+        Obj.update(view, () => {
           projection.setFieldProjection({ field, props });
         });
       } else {

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)

package/src/components/Form/Form.stories.tsx

@@ -6,24 +6,24 @@ import { type Meta, type StoryObj } from '@storybook/react-vite';
 import * as Schema from 'effect/Schema';
 import React, { useCallback, useState } from 'react';
 
-import { Annotation, Format, Obj, Tag, Type } from '@dxos/echo';
+import { Annotation, Format, Obj, Ref, Tag, Type } from '@dxos/echo';
 import { type AnyProperties } from '@dxos/echo/internal';
 import { log } from '@dxos/log';
-import { useClient } from '@dxos/react-client';
+import { useSpaces } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
 import { Tooltip } from '@dxos/react-ui';
-import { withLayout, withTheme } from '@dxos/react-ui/testing';
+import { Loading, withLayout, withTheme } from '@dxos/react-ui/testing';
 
-import { translations } from '../../translations';
-import { TestLayout } from '../testing';
+import { translations } from '#translations';
 
+import { TestLayout } from '../testing';
 import { type ExcludeId, Form, type FormRootProps, omitId } from './Form';
 
 const Organization = Schema.Struct({
   name: Schema.String.pipe(Schema.minLength(1)).annotations({ title: 'Full name' }),
 }).pipe(
   Type.object({
-    typename: 'example.com/type/Organization', // TODO(burdon): Change all types to /schema
+    typename: 'com.example.type.organization',
     version: '0.1.0',
   }),
 );
@@ -43,11 +43,11 @@ const Person = Schema.Struct({
         title: 'State',
         description: 'State code',
       }),
-      zip: Schema.Number,
+      zip: Schema.Number.annotations({ title: 'ZIP Code' }),
     }).annotations({ title: 'Address' }),
   ),
-  employer: Schema.optional(Type.Ref(Organization).annotations({ title: 'Employer' })),
-  tags: Schema.optional(Schema.Array(Type.Ref(Tag.Tag)).annotations({ title: 'Tags' })),
+  employer: Schema.optional(Ref.Ref(Organization).annotations({ title: 'Employer' })),
+  tags: Schema.optional(Schema.Array(Ref.Ref(Tag.Tag)).annotations({ title: 'Tags' })),
   status: Schema.optional(Schema.Literal('active', 'inactive').annotations({ title: 'Status' })),
   notes: Schema.optional(Format.Text.annotations({ title: 'Notes' })),
   location: Schema.optional(Format.GeoPoint.annotations({ title: 'Location' })),
@@ -65,16 +65,16 @@ const Person = Schema.Struct({
   ),
 }).pipe(
   Type.object({
-    typename: 'dxos.org/type/Person', // TODO(burdon): Change all types to /schema
+    typename: 'org.dxos.type.person', // TODO(burdon): Change all types to /schema
     version: '0.1.0',
   }),
 );
 
 export interface Person extends Schema.Schema.Type<typeof Person> {}
 
-type StoryProps<T extends AnyProperties> = {
+type DefaultStoryProps<T extends AnyProperties> = {
+  schema?: Schema.Schema<T>;
   debug?: boolean;
-  schema: Schema.Schema<T>;
 } & FormRootProps<T>;
 
 const DefaultStory = <T extends AnyProperties = AnyProperties>({
@@ -82,10 +82,10 @@ const DefaultStory = <T extends AnyProperties = AnyProperties>({
   schema,
   values: valuesProp,
   ...props
-}: StoryProps<T>) => {
+}: DefaultStoryProps<T>) => {
   const [values, setValues] = useState<Partial<T>>(valuesProp ?? {});
-  const client = useClient();
-  const space = client.spaces.default;
+  const spaces = useSpaces();
+  const space = spaces[0];
 
   const handleSave = useCallback<NonNullable<FormRootProps<T>['onSave']>>((values) => {
     log.info('save', { values, meta });
@@ -97,13 +97,17 @@ const DefaultStory = <T extends AnyProperties = AnyProperties>({
     setValues(valuesProp ?? {});
   }, []);
 
+  if (!space) {
+    return <Loading />;
+  }
+
   return (
     <Tooltip.Provider>
-      <TestLayout json={{ values, schema: schema.ast }}>
+      <TestLayout json={{ values, schema: schema?.ast }}>
         <Form.Root
           debug={debug}
           schema={schema}
-          values={values}
+          defaultValues={values}
           db={space.db}
           onSave={handleSave}
           onCancel={handleCancel}
@@ -111,6 +115,7 @@ const DefaultStory = <T extends AnyProperties = AnyProperties>({
         >
           <Form.Viewport>
             <Form.Content>
+              <Form.Section label='Section' description='This is a section' />
               <Form.FieldSet />
               <Form.Actions />
             </Form.Content>
@@ -125,26 +130,17 @@ const meta = {
   title: 'ui/react-ui-form/Form',
   component: Form.Root,
   render: DefaultStory,
-
   decorators: [
     withTheme(),
-    withLayout({
-      layout: 'fullscreen',
-    }),
+    withLayout({ layout: 'fullscreen' }),
     withClientProvider({
       createIdentity: true,
       createSpace: true,
       types: [Tag.Tag, Organization, Person],
-      onCreateIdentity: ({ client }) => {
-        const space = client.spaces.default;
+      onCreateSpace: ({ space }) => {
         [
-          Obj.make(Organization, { name: 'DXOS' }),
-          Obj.make(Organization, { name: 'BlueYard' }),
-          Obj.make(Organization, { name: 'Backed' }),
-          Obj.make(Organization, { name: 'BCV' }),
-          Tag.make({ label: 'Tag 1' }),
-          Tag.make({ label: 'Tag 2' }),
-          Tag.make({ label: 'Tag 3' }),
+          ...Array.from({ length: 3 }).map((_, i) => Obj.make(Tag.Tag, { label: `Tag ${i}` })),
+          ...Array.from({ length: 50 }).map((_, i) => Obj.make(Organization, { name: `Organization ${i}` })),
         ].map((obj) => space.db.add(obj));
       },
     }),
@@ -153,11 +149,11 @@ const meta = {
     layout: 'fullscreen',
     translations,
   },
-} satisfies Meta<StoryProps<any>>;
+} satisfies Meta<DefaultStoryProps<any>>;
 
 export default meta;
 
-type Story<T extends AnyProperties> = StoryObj<StoryProps<T>>;
+type Story<T extends AnyProperties> = StoryObj<DefaultStoryProps<T>>;
 
 const values: Partial<Person> = {
   name: 'Alice',
@@ -190,16 +186,5 @@ export const Static: Story<ExcludeId<typeof Person>> = {
 };
 
 export const Empty: Story<ExcludeId<typeof Person>> = {
-  render: () => (
-    <TestLayout>
-      <Form.Root>
-        <Form.Viewport>
-          <Form.Content>
-            <Form.FieldSet />
-            <Form.Actions />
-          </Form.Content>
-        </Form.Viewport>
-      </Form.Root>
-    </TestLayout>
-  ),
+  args: {},
 };