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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-form",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1f223c7",
   "description": "Data components.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -9,6 +9,7 @@
   "type": "module",
   "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"
@@ -25,54 +26,56 @@
   "dependencies": {
     "@atlaskit/pragmatic-drag-and-drop": "^1.4.0",
     "@atlaskit/pragmatic-drag-and-drop-hitbox": "^1.0.3",
+    "@fluentui/react-tabster": "^9.24.2",
     "@preact-signals/safe-react": "^0.9.0",
     "@radix-ui/react-context": "1.1.1",
     "date-fns": "^3.3.1",
     "jsonpath": "^1.1.1",
-    "@dxos/debug": "0.8.3",
-    "@dxos/echo": "0.8.3",
-    "@dxos/effect": "0.8.3",
-    "@dxos/echo-db": "0.8.3",
-    "@dxos/async": "0.8.3",
-    "@dxos/invariant": "0.8.3",
-    "@dxos/echo-schema": "0.8.3",
-    "@dxos/keys": "0.8.3",
-    "@dxos/lit-ui": "0.8.3",
-    "@dxos/live-object": "0.8.3",
-    "@dxos/log": "0.8.3",
-    "@dxos/react-client": "0.8.3",
-    "@dxos/react-ui-list": "0.8.3",
-    "@dxos/react-ui-pickers": "0.8.3",
-    "@dxos/react-ui-stack": "0.8.3",
-    "@dxos/react-ui-tag-picker": "0.8.3",
-    "@dxos/react-ui-types": "0.8.3",
-    "@dxos/util": "0.8.3",
-    "@dxos/schema": "0.8.3"
+    "@dxos/async": "0.8.4-main.1f223c7",
+    "@dxos/debug": "0.8.4-main.1f223c7",
+    "@dxos/echo": "0.8.4-main.1f223c7",
+    "@dxos/echo-db": "0.8.4-main.1f223c7",
+    "@dxos/echo-schema": "0.8.4-main.1f223c7",
+    "@dxos/effect": "0.8.4-main.1f223c7",
+    "@dxos/keys": "0.8.4-main.1f223c7",
+    "@dxos/invariant": "0.8.4-main.1f223c7",
+    "@dxos/live-object": "0.8.4-main.1f223c7",
+    "@dxos/log": "0.8.4-main.1f223c7",
+    "@dxos/react-client": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-components": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-editor": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-list": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-pickers": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-searchlist": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-stack": "0.8.4-main.1f223c7",
+    "@dxos/lit-ui": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-tag-picker": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-types": "0.8.4-main.1f223c7",
+    "@dxos/schema": "0.8.4-main.1f223c7",
+    "@dxos/util": "0.8.4-main.1f223c7"
   },
   "devDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
     "@types/jsonpath": "^0.2.4",
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
-    "effect": "3.14.21",
+    "effect": "3.17.7",
     "fast-check": "^3.19.0",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "vite": "5.4.7",
-    "@dxos/echo-signals": "0.8.3",
-    "@dxos/random": "0.8.3",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/react-ui-syntax-highlighter": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3",
-    "@dxos/storybook-utils": "0.8.3"
+    "vite": "7.1.1",
+    "@dxos/random": "0.8.4-main.1f223c7",
+    "@dxos/react-ui": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-theme": "0.8.4-main.1f223c7",
+    "@dxos/storybook-utils": "0.8.4-main.1f223c7",
+    "@dxos/echo-signals": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.1f223c7"
   },
   "peerDependencies": {
-    "@phosphor-icons/react": "^2.1.5",
-    "effect": "3.13.3",
+    "effect": "^3.13.3",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.3",
-    "@dxos/react-ui-theme": "0.8.3"
+    "@dxos/react-ui": "0.8.4-main.1f223c7",
+    "@dxos/react-ui-theme": "0.8.4-main.1f223c7"
   },
   "publishConfig": {
     "access": "public"

package/src/components/ControlSection/ControlSection.stories.tsx

@@ -4,34 +4,32 @@
 
 import '@dxos-theme';
 
-import { type Meta, type StoryObj } from '@storybook/react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
 import React from 'react';
 
-import { StackItem } from '@dxos/react-ui-stack';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-import { ControlPage, ControlSection, type ControlSectionProps } from './ControlSection';
-import translations from '../../translations';
+import { translations } from '../../translations';
 
-const meta: Meta<ControlSectionProps> = {
+import { ControlPage, ControlSection } from './ControlSection';
+
+const meta = {
   title: 'ui/react-ui-form/ControlSection',
   component: ControlSection,
   render: (args) => (
-    <StackItem.Content classNames='w-[40rem]'>
-      <ControlPage>
-        <ControlSection {...args} />
-      </ControlPage>
-    </StackItem.Content>
+    <ControlPage classNames='w-[40rem]'>
+      <ControlSection {...args} />
+    </ControlPage>
   ),
   decorators: [withLayout({ fullscreen: true, classNames: 'justify-center' }), withTheme],
   parameters: {
     translations,
   },
-};
+} satisfies Meta<typeof ControlSection>;
 
 export default meta;
 
-type Story = StoryObj<ControlSectionProps>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
   args: {

package/src/components/ControlSection/ControlSection.tsx

@@ -13,6 +13,7 @@ import {
   toLocalizedString,
   useTranslation,
 } from '@dxos/react-ui';
+import { StackItem } from '@dxos/react-ui-stack';
 import { mx } from '@dxos/react-ui-theme';
 
 import { translationKey } from '../../translations';
@@ -21,9 +22,11 @@ export type ControlPageProps = ThemedClassName<ComponentPropsWithoutRef<'div'>>;
 
 export const ControlPage = ({ children, classNames, ...props }: ControlPageProps) => {
   return (
-    <div role='none' className={mx('pli-cardSpacingInline', classNames)} {...props}>
-      {children}
-    </div>
+    <StackItem.Content classNames='block overflow-y-auto [--control-spacing:var(--dx-trimMd)]'>
+      <div role='none' className={mx('pli-cardSpacingInline pbe-trimLg', classNames)} {...props}>
+        {children}
+      </div>
+    </StackItem.Content>
   );
 };
 
@@ -59,12 +62,16 @@ export const ControlGroupButton = ({ classNames, ...props }: ButtonProps) => {
   return <Button {...props} classNames={['md:col-span-2', classNames]} />;
 };
 
-export type ControlGroupProps = ThemedClassName<PropsWithChildren<{}>>;
+export type ControlGroupProps = ThemedClassName<PropsWithChildren>;
 
 export const ControlGroup = ({ children, classNames }: ControlGroupProps) => (
   <div
     role='none'
-    className={mx('group container-max-width grid grid-cols-1 md:grid-cols-[1fr_min-content] gap-trimMd', classNames)}
+    className={mx(
+      'group container-max-width grid grid-cols-1 md:grid-cols-[1fr_min-content] gap-trimMd',
+      '[--control-spacing:0px] [&_input]:justify-self-end [&_button]:justify-self-end',
+      classNames,
+    )}
   >
     {children}
   </div>
@@ -73,23 +80,30 @@ export const ControlGroup = ({ children, classNames }: ControlGroupProps) => (
 export const ControlFrame = ({ children }: ControlGroupProps) => (
   <div
     role='none'
-    className='p-trimMd container-max-width grid grid-cols-1 md:grid-cols-[1fr_1fr] gap-trimSm md:gap-trimMd border border-separator rounded-md'
+    className={mx(
+      'container-max-width grid grid-cols-1 md:grid-cols-[1fr_1fr] gap-trimSm md:gap-trimMd p-trimMd',
+      'border border-separator rounded-md',
+    )}
   >
     {children}
   </div>
 );
 
+export const controlItemClasses = mx([
+  'container-max-width grid md:col-span-2 grid-cols-subgrid gap-trimSm items-center',
+  // TODO(burdon): Use grid gap consistently or apply margins consistently?
+  'mlb-[--control-spacing] *:first:!mbs-0 *:last:!mbe-0 pli-trimMd plb-trimMd',
+  'border border-separator rounded-md',
+]);
+
+const controlItemTitleClasses = 'mbe-0 text-lg text-baseText font-normal';
+const controlItemDescriptionClasses = 'mlb-trimSm md:mbe-0 text-base text-description';
+
 export type ControlItemProps = PropsWithChildren<{
   title: Label;
   description?: Label;
 }>;
 
-export const controlItemClasses =
-  'pli-trimMd plb-trimMd container-max-width grid md:col-span-2 grid-cols-subgrid items-center gap-trimSm border border-separator rounded-md *:first:!mbs-0 *:last:!mbe-0';
-
-const controlItemTitleClasses = 'text-lg font-normal';
-const controlItemDescriptionClasses = 'text-base mlb-trimSm md:mbe-0 text-description';
-
 export const ControlItem = ({ title, description, children }: ControlItemProps) => {
   const { t } = useTranslation(translationKey);
 

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

@@ -4,29 +4,27 @@
 
 import '@dxos-theme';
 
-import { type Meta, type StoryObj } from '@storybook/react';
-import React, { useMemo, useEffect } from 'react';
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import React, { useEffect, useMemo } from 'react';
 
 import { createEchoSchema } from '@dxos/live-object/testing';
 import { log } from '@dxos/log';
-import { ViewProjection } from '@dxos/schema';
+import { ProjectionModel } from '@dxos/schema';
 import { TestSchema, testView } from '@dxos/schema/testing';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
+import { translations } from '../../translations';
+import { FIELD_EDITOR_DEBUG_SYMBOL, TestLayout, TestPanel } 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: ViewProjection;
+  projection: ProjectionModel;
 };
 
-type StoryProps = FieldEditorProps;
-
 const DefaultStory = (props: FieldEditorProps) => {
-  const projection = useMemo(() => new ViewProjection(createEchoSchema(TestSchema).jsonSchema, testView), []);
   const handleComplete: FieldEditorProps['onSave'] = () => {
     log.info('onClose', { props });
   };
@@ -34,43 +32,46 @@ const DefaultStory = (props: FieldEditorProps) => {
   // Expose objects on window for test access.
   useEffect(() => {
     if (typeof window !== 'undefined') {
-      (window as any)[FIELD_EDITOR_DEBUG_SYMBOL] = { props, projection } satisfies FieldEditorDebugObjects;
+      (window as any)[FIELD_EDITOR_DEBUG_SYMBOL] = {
+        props,
+        projection: props.projection,
+      } satisfies FieldEditorDebugObjects;
     }
-  }, [props, projection]);
+  }, [props, 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 })),
-    [JSON.stringify(props), JSON.stringify(projection)],
+    () => JSON.parse(JSON.stringify({ props, projection: props.projection })),
+    [JSON.stringify(props), JSON.stringify(props.projection)],
   );
 
   return (
     <TestLayout json={json}>
       <TestPanel>
-        <FieldEditor {...props} projection={projection} onSave={handleComplete} />
+        <FieldEditor {...props} onSave={handleComplete} />
       </TestPanel>
     </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],
   parameters: {
     translations,
   },
-};
+} satisfies Meta<typeof DefaultStory>;
 
 export default meta;
 
-type Story = StoryObj<StoryProps>;
+type Story = StoryObj<typeof meta>;
 
 export const Default: Story = {
   args: {
-    view: testView,
-    field: testView.fields[0],
+    projection: new ProjectionModel(createEchoSchema(TestSchema).jsonSchema, testView.projection),
+    field: testView.projection.fields[0],
   },
   parameters: { controls: { disabled: true } },
 };

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

@@ -3,25 +3,18 @@
 //
 
 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 { ViewProjection } from '@dxos/schema';
+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);
 
-const getFieldEditorDebugObjects = (): FieldEditorDebugObjects => {
-  const debugObjects = (window as any)[FIELD_EDITOR_DEBUG_SYMBOL] as FieldEditorDebugObjects;
-  expect(debugObjects).toBeDefined();
-  expect(debugObjects.props).toBeInstanceOf(Object); // Props object
-  expect(debugObjects.projection).toBeInstanceOf(ViewProjection);
-  return debugObjects;
-};
-
 describe('FieldEditor', () => {
   afterEach(() => {
     cleanup();
@@ -33,7 +26,7 @@ describe('FieldEditor', () => {
     expect(screen.getByText('Type format')).toBeInTheDocument();
     expect(screen.getByText('String')).toBeInTheDocument();
 
-    // Verify the initial field shows as String type
+    // Verify the initial field shows as String type.
     expect(screen.getByText('String')).toBeInTheDocument();
 
     fireEvent.click(screen.getByRole('combobox'));
@@ -49,9 +42,17 @@ describe('FieldEditor', () => {
     // Access the live objects directly from window using symbol.
     const debugObjects = getFieldEditorDebugObjects();
 
-    const name = debugObjects.projection.schema.properties!.name;
+    const name = debugObjects.projection.baseSchema.properties!.name;
     expect(name.type).toBe('number');
     expect(name.format).toBe('number');
     expect(name.description).toBe('Full name.');
   });
 });
+
+const getFieldEditorDebugObjects = (): FieldEditorDebugObjects => {
+  const debugObjects = (window as any)[FIELD_EDITOR_DEBUG_SYMBOL] as FieldEditorDebugObjects;
+  expect(debugObjects).toBeDefined();
+  expect(debugObjects.props).toBeInstanceOf(Object); // Props object
+  expect(debugObjects.projection).toBeInstanceOf(ProjectionModel);
+  return debugObjects;
+};

package/src/components/FieldEditor/FieldEditor.tsx

@@ -5,37 +5,35 @@
 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 { type EchoSchema, FormatEnum, FormatEnums, formatToType } from '@dxos/echo-schema';
 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 ProjectionModel,
   type PropertyType,
-  type ViewType,
-  type ViewProjection,
   type SchemaProperty,
+  getFormatSchema,
+  getSchemaProperties,
+  sortProperties,
 } from '@dxos/schema';
 
 import { translationKey } from '../../translations';
 import { Form, type FormProps, type InputComponent, SelectInput, SelectOptionInput } from '../Form';
 
 export type FieldEditorProps = {
-  view: ViewType;
-  projection: ViewProjection;
+  projection: ProjectionModel;
   field: FieldType;
   registry?: SchemaRegistry;
   onSave: () => void;
   onCancel?: () => void;
-} & Pick<FormProps<any>, 'outerSpacing'>;
+} & Pick<FormProps<any>, 'outerSpacing' | 'readonly'>;
 
 /**
  * Displays a Form representing the metadata for a given `Field` and `View`.
  */
 export const FieldEditor = ({
-  view,
+  readonly,
   projection,
   field,
   registry,
@@ -48,7 +46,7 @@ export const FieldEditor = ({
   useEffect(() => setProps(projection.getFieldProjection(field.id).props), [field, projection]);
 
   const [schemas, setSchemas] = useState<EchoSchema[]>([]);
-  useEffect(() => {
+  useAsyncEffect(async () => {
     if (!registry) {
       return;
     }
@@ -56,14 +54,10 @@ export const FieldEditor = ({
     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>();
@@ -112,7 +106,7 @@ export const FieldEditor = ({
 
   const handleValidate = useCallback<NonNullable<FormProps<PropertyType>['onValidate']>>(
     ({ property }) => {
-      if (property && view.fields.find((f) => f.path === property && f.path !== field.path)) {
+      if (property && projection.fields.find((f) => f.path === property && f.path !== field.path)) {
         return [
           {
             path: 'property',
@@ -121,7 +115,7 @@ export const FieldEditor = ({
         ];
       }
     },
-    [view.fields, field],
+    [projection.fields, field],
   );
 
   const handleSave = useCallback<NonNullable<FormProps<PropertyType>['onSave']>>(
@@ -188,6 +182,7 @@ export const FieldEditor = ({
     <Form<PropertyType>
       key={field.id}
       autoFocus
+      readonly={readonly}
       values={props}
       schema={fieldSchema}
       filter={propIsNotType}

package/src/components/Form/ArrayField.tsx

@@ -6,26 +6,26 @@ import { SchemaAST, pipe } from 'effect';
 import { capitalize } from 'effect/String';
 import React, { Fragment, useCallback } from 'react';
 
-import { findNode, getDiscriminatedType, isDiscriminatedUnion, SimpleType } from '@dxos/effect';
+import { SimpleType, findNode, getDiscriminatedType, isDiscriminatedUnion } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 import { IconButton, useTranslation } from '@dxos/react-ui';
-import { getSchemaProperties, type SchemaProperty } from '@dxos/schema';
+import { type SchemaProperty, getSchemaProperties } from '@dxos/schema';
 
-import { type ComponentLookup } from './Form';
-import { FormField } from './FormContent';
-import { useFormValues, type FormInputStateProps } from './FormContext';
-import { InputHeader, type InputComponent } from './Input';
 import { translationKey } from '../../translations';
 import { findArrayElementType } from '../../util';
 
+import { type ComponentLookup } from './Form';
+import { FormField, type FormFieldProps } from './FormContent';
+import { type FormInputStateProps, useFormValues } from './FormContext';
+import { type InputComponent, InputHeader } from './Input';
+
 type ArrayFieldProps = {
   property: SchemaProperty<any>;
-  readonly?: boolean;
   inputProps: FormInputStateProps;
   path?: (string | number)[];
   Custom?: Partial<Record<string, InputComponent>>;
   lookupComponent?: ComponentLookup;
-};
+} & Pick<FormFieldProps, 'readonly'>;
 
 export const ArrayField = ({ property, readonly, path, inputProps, Custom, lookupComponent }: ArrayFieldProps) => {
   const { t } = useTranslation(translationKey);
@@ -113,7 +113,7 @@ export const ArrayField = ({ property, readonly, path, inputProps, Custom, looku
       </div>
       {!readonly && (
         <IconButton
-          classNames='is-full mlb-1 flex'
+          classNames='is-full mlb-cardSpacingBlock flex'
           icon='ph--plus--regular'
           label={t('add field')}
           onClick={handleAdd}