@dxos/react-ui-form 0.8.4-main.84f28bd → 0.8.4-main.9735255

package/src/components/FieldEditor/FieldEditor.tsx

@@ -4,51 +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 } 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 ProjectionModel,
   type PropertyType,
-  type ViewType,
-  type ViewProjection,
-  type SchemaProperty,
+  formatToAdditionalPropertyAttributes,
+  getFormatSchema,
 } from '@dxos/schema';
 
 import { translationKey } from '../../translations';
-import { Form, type FormProps, type InputComponent, SelectInput, SelectOptionInput } from '../Form';
+import { getFormProperties } from '../../util';
+import { Form, type FormFieldMap, type FormRootProps, SelectField, SelectOptionField } from '../Form';
 
 export type FieldEditorProps = {
-  view: ViewType;
-  projection: ViewProjection;
+  projection: ProjectionModel;
   field: FieldType;
-  registry?: SchemaRegistry;
+  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 = ({
-  view,
-  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;
     }
@@ -56,14 +47,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>();
@@ -75,11 +62,47 @@ export const FieldEditor = ({
   //  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}`),
+          }))}
+        />
+      ),
+      ['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) {
@@ -100,8 +123,10 @@ export const FieldEditor = ({
 
       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;
@@ -110,9 +135,9 @@ export const FieldEditor = ({
     [schemas, props.format, props.referenceSchema],
   );
 
-  const handleValidate = useCallback<NonNullable<FormProps<PropertyType>['onValidate']>>(
+  const handleValidate = useCallback<NonNullable<FormRootProps<PropertyType>['onValidate']>>(
     ({ property }) => {
-      if (property && view.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',
@@ -121,83 +146,53 @@ export const FieldEditor = ({
         ];
       }
     },
-    [view.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.change(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/Form-old.stories.tsx

@@ -0,0 +1,314 @@
+//
+// Copyright 2024 DXOS.org
+//
+
+import { type Meta, type StoryObj } from '@storybook/react-vite';
+import * as Schema from 'effect/Schema';
+import React, { useCallback, useState } from 'react';
+
+import { Format } from '@dxos/echo';
+import { type AnyProperties } from '@dxos/echo/internal';
+import { Tooltip } from '@dxos/react-ui';
+import { withLayoutVariants, withTheme } from '@dxos/react-ui/testing';
+import { TestSchema } from '@dxos/schema/testing';
+
+import { translations } from '../../translations';
+import { TestLayout } from '../testing';
+
+import { SelectField } from './fields';
+import { Form, type FormRootProps } from './Form';
+
+// TODO(burdon): Extract into Form.stories.tsx
+
+type StoryProps<T extends AnyProperties> = {
+  debug?: boolean;
+  schema: Schema.Schema.AnyNoContext;
+} & FormRootProps<T>;
+
+const DefaultStory = <T extends AnyProperties = any>({
+  debug,
+  schema,
+  values: valuesProp,
+  ...props
+}: StoryProps<T>) => {
+  const [values, setValues] = useState(valuesProp);
+  const handleSave = useCallback<NonNullable<FormRootProps<T>['onSave']>>((values) => {
+    setValues(values);
+  }, []);
+
+  if (debug) {
+    return (
+      <Tooltip.Provider>
+        <TestLayout json={{ values, schema: schema.ast }}>
+          <Form.Root<T> schema={schema} values={values} onSave={handleSave} {...props}>
+            <Form.Content>
+              <Form.FieldSet />
+              <Form.Actions />
+            </Form.Content>
+          </Form.Root>
+        </TestLayout>
+      </Tooltip.Provider>
+    );
+  }
+
+  return (
+    <Form.Root<T> schema={schema} values={values} onSave={handleSave} {...props}>
+      <Form.Content>
+        <Form.FieldSet />
+        <Form.Actions />
+      </Form.Content>
+    </Form.Root>
+  );
+};
+
+// const RefStory = <T extends AnyProperties = any>(props: StoryProps<T>) => {
+//   const onQueryRefOptions = useCallback<NonNullable<FormRootProps<T>['onQueryRefOptions']>>(({ typename }) => {
+//     switch (typename) {
+//       case TestSchema.Person.typename:
+//         return [
+//           { dxn: Obj.getDXN(contact1), label: 'Alice' },
+//           { dxn: Obj.getDXN(contact2), label: 'Bob' },
+//         ];
+//       default:
+//         return [];
+//     }
+//   }, []);
+
+//   return <DefaultStory<T> onQueryRefOptions={onQueryRefOptions} {...props} />;
+// };
+
+const AddressSchema = Schema.Struct({
+  street: Schema.optional(Schema.String.annotations({ title: 'Street' })),
+  city: Schema.optional(Schema.String.annotations({ title: 'City' })),
+  zip: Schema.optional(Schema.String.pipe(Schema.pattern(/^\d{5}(-\d{4})?$/)).annotations({ title: 'ZIP' })),
+  location: Schema.optional(Format.GeoPoint.annotations({ title: 'Location' })),
+}).annotations({ title: 'Address' });
+
+const PersonSchema = Schema.Struct({
+  name: Schema.optional(Schema.String.annotations({ title: 'Name' })),
+  active: Schema.optional(Schema.Boolean.annotations({ title: 'Active' })),
+  rank: Schema.optional(Schema.Number.annotations({ title: 'Rank' })),
+  website: Schema.optional(Format.URL.annotations({ title: 'Website' })),
+  address: Schema.optional(AddressSchema),
+}).pipe(Schema.mutable);
+
+type PersonSchema = Schema.Schema.Type<typeof PersonSchema>;
+
+const meta = {
+  title: 'ui/react-ui-form/Form-Old',
+  component: Form.Root as any,
+  render: DefaultStory,
+  decorators: [withTheme, withLayoutVariants()],
+  parameters: {
+    layout: 'fullscreen',
+    translations,
+  },
+  argTypes: {
+    readonly: {
+      control: 'boolean',
+      description: 'Readonly',
+    },
+  },
+} satisfies Meta<StoryProps<any>>;
+
+export default meta;
+
+type Story = StoryObj<typeof meta>;
+
+export const Default: Story = {
+  args: {
+    schema: PersonSchema,
+    values: {
+      name: 'DXOS',
+      active: true,
+      address: {
+        zip: '11205',
+      },
+    },
+    readonly: false,
+  },
+};
+
+export const Organization: Story = {
+  args: {
+    debug: true,
+    schema: TestSchema.OrganizationSchema,
+    values: {
+      name: 'DXOS',
+      website: 'https://dxos.org',
+    },
+    readonly: false,
+  },
+};
+
+export const OrganizationAutoSave: Story = {
+  args: {
+    debug: true,
+    schema: TestSchema.OrganizationSchema,
+    values: {
+      name: 'DXOS',
+      website: 'https://dxos.org',
+    },
+    autoSave: true,
+    readonly: false,
+  },
+};
+
+// TODO(burdon): Type issue with employer reference.
+// TODO(burdon): Test table/form with compound values (e.g., address).
+// Property name is missing in type EncodedReference but required in type
+export const Person: Story = {
+  args: {
+    debug: true,
+    schema: TestSchema.Person,
+    values: {
+      name: 'Bot',
+    },
+  },
+};
+
+//
+// Union
+//
+
+const ShapeSchema = Schema.Struct({
+  shape: Schema.optional(
+    Schema.Union(
+      Schema.Struct({
+        type: Schema.Literal('circle').annotations({ title: 'Type' }),
+        radius: Schema.optional(Schema.Number.annotations({ title: 'Radius' })),
+      }),
+      Schema.Struct({
+        type: Schema.Literal('square').annotations({ title: 'Type' }),
+        size: Schema.optional(Schema.Number.pipe(Schema.nonNegative()).annotations({ title: 'Size' })),
+      }),
+    ).annotations({ title: 'Shape' }),
+  ),
+}).pipe(Schema.mutable);
+
+type ShapeSchema = Schema.Schema.Type<typeof ShapeSchema>;
+
+export const DiscriminatedShape: StoryObj<StoryProps<ShapeSchema>> = {
+  args: {
+    debug: true,
+    schema: ShapeSchema,
+    readonly: false,
+    values: {
+      shape: {
+        type: 'circle',
+        radius: 5,
+      },
+    },
+    fieldMap: {
+      ['shape.type' as const]: (props) => (
+        <SelectField
+          {...props}
+          options={['circle', 'square'].map((value) => ({
+            value,
+            label: value,
+          }))}
+        />
+      ),
+    },
+  },
+};
+
+//
+// Arrays
+//
+
+const ArraysSchema = Schema.Struct({
+  names: Schema.Array(Schema.String.pipe(Schema.nonEmptyString())),
+  addresses: Schema.Array(AddressSchema),
+}).pipe(Schema.mutable);
+
+type ArraysSchema = Schema.Schema.Type<typeof ArraysSchema>;
+
+export const Arrays: StoryObj<StoryProps<ArraysSchema>> = {
+  args: {
+    debug: true,
+    schema: ArraysSchema,
+    readonly: false,
+    values: {
+      names: ['Alice', 'Bob'],
+      addresses: [],
+    },
+  },
+};
+
+//
+// Tuple
+//
+
+// TODO(wittjosiah): Only GeoPoint is works currently.
+const TupleSchema = Schema.Struct({
+  tuple: Schema.Tuple(Schema.Number, Schema.String, Schema.Boolean),
+  geopoint: Format.GeoPoint,
+}).pipe(Schema.mutable);
+
+type TupleSchema = Schema.Schema.Type<typeof TupleSchema>;
+
+export const Tuple: StoryObj<StoryProps<TupleSchema>> = {
+  args: {
+    debug: true,
+    schema: TupleSchema,
+    readonly: false,
+    values: {
+      tuple: [1, 'a', true],
+      geopoint: [-122.41941, 37.77492],
+    },
+  },
+};
+
+//
+// Enum
+//
+
+const ColorSchema = Schema.Struct({
+  color: Schema.Union(Schema.Literal('red'), Schema.Literal('green'), Schema.Literal('blue')).annotations({
+    title: 'Color',
+  }),
+}).pipe(Schema.mutable);
+
+type ColorType = Schema.Schema.Type<typeof ColorSchema>;
+
+export const Enum: StoryObj<StoryProps<ColorType>> = {
+  args: {
+    debug: true,
+    schema: ColorSchema,
+    readonly: false,
+    values: {
+      color: 'red',
+    },
+  },
+};
+
+//
+// Refs
+//
+
+// const RefSchema = Schema.Struct({
+//   contact: Type.Ref(TestSchema.Person).annotations({ title: 'Contact Reference' }),
+//   optionalContact: Schema.optional(Type.Ref(TestSchema.Person).annotations({ title: 'Optional Contact Reference' })),
+//   refArray: Schema.optional(Schema.Array(Type.Ref(TestSchema.Person))),
+//   unknownExpando: Schema.optional(
+//     Type.Ref(TestSchema.Expando).annotations({ title: 'Optional Ref to an Expando (DXN Input)' }),
+//   ),
+// });
+
+// type RefSchema = Schema.Schema.Type<typeof RefSchema>;
+
+// const contact1 = Obj.make(TestSchema.Person, { name: 'Alice' });
+// const contact2 = Obj.make(TestSchema.Person, { name: 'Bob' });
+
+// export const Refs: StoryObj<StoryProps<RefSchema>> = {
+//   render: RefStory,
+//   args: {
+//     debug: true,
+//     schema: RefSchema,
+//     readonly: false,
+//     values: {
+//       refArray: [Ref.make(contact1), Ref.make(contact2)],
+//     },
+//   },
+// };