@dxos/react-ui-form 0.8.4-main.2e9d522 → 0.8.4-main.3c1ae3b

package/src/components/ViewEditor/ViewEditor.tsx

@@ -2,116 +2,227 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
-import React, { useCallback, useMemo, useState } from 'react';
+import * as Array from 'effect/Array';
+import * as Match from 'effect/Match';
+import * as Option from 'effect/Option';
+import * as Schema from 'effect/Schema';
+import React, { forwardRef, useCallback, useImperativeHandle, useMemo, useState } from 'react';
 
-import { type SchemaRegistry } from '@dxos/echo-db';
-import { EchoSchema, Format, type JsonProp, isMutable, toJsonSchema } from '@dxos/echo-schema';
+import { Filter, Format, Query, QueryAST, type SchemaRegistry } from '@dxos/echo';
+import { EchoSchema, type JsonProp, isMutable, toJsonSchema } from '@dxos/echo/internal';
+import {} from '@dxos/echo-db';
 import { invariant } from '@dxos/invariant';
-import { Callout, IconButton, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+import { Callout, IconButton, Input, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+import { QueryForm, type QueryFormProps } from '@dxos/react-ui-components';
 import { List } from '@dxos/react-ui-list';
-import { cardSpacing } from '@dxos/react-ui-stack';
-import { ghostHover, inputTextLabel, mx } from '@dxos/react-ui-theme';
-import { FieldSchema, type FieldType, VIEW_FIELD_LIMIT, type DataType, ProjectionModel } from '@dxos/schema';
+import { mx, subtleHover } from '@dxos/react-ui-theme';
+import {
+  FieldSchema,
+  type FieldType,
+  ProjectionModel,
+  VIEW_FIELD_LIMIT,
+  type View,
+  getTypenameFromQuery,
+} from '@dxos/schema';
 
 import { translationKey } from '../../translations';
 import { FieldEditor } from '../FieldEditor';
-import { Form, type FormProps } from '../Form';
+import {
+  Form,
+  type FormFieldComponent,
+  type FormFieldComponentProps,
+  FormFieldLabel,
+  type FormFieldMap,
+} from '../Form';
 
-const grid = 'grid grid-cols-[32px_1fr_32px_32px] min-bs-[2.5rem]';
-
-const ViewMetaSchema = Schema.Struct({
-  typename: Format.URL.annotations({
-    title: 'Typename',
-  }),
-}).pipe(Schema.mutable);
-
-type ViewMetaType = Schema.Schema.Type<typeof ViewMetaSchema>;
+const listGrid = 'grid grid-cols-[min-content_1fr_min-content_min-content_min-content]';
+const listItemGrid = 'grid grid-cols-subgrid col-span-5';
 
 export type ViewEditorProps = ThemedClassName<
   {
     schema: Schema.Schema.AnyNoContext;
-    view: DataType.View;
-    registry?: SchemaRegistry;
+    view: View.View;
+    mode?: 'schema' | 'tag';
+    registry?: SchemaRegistry.SchemaRegistry;
     readonly?: boolean;
     showHeading?: boolean;
-    onTypenameChanged?: (typename: string) => void;
+    onQueryChanged?: (query: QueryAST.Query, target?: string) => void;
     onDelete?: (fieldId: string) => void;
-  } & Pick<FormProps<any>, 'outerSpacing'>
+  } & Pick<QueryFormProps, 'types' | 'tags'>
 >;
 
 /**
  * Schema-based object form.
  */
-export const ViewEditor = ({
-  classNames,
-  schema,
-  view,
-  registry,
-  readonly: _readonly,
-  showHeading = false,
-  onTypenameChanged,
-  onDelete,
-  outerSpacing = true,
-}: ViewEditorProps) => {
-  const { t } = useTranslation(translationKey);
-  const projection = useMemo(() => {
-    // Use reactive and mutable version of json schema when schema is mutable.
-    const jsonSchema = schema instanceof EchoSchema ? schema.jsonSchema : toJsonSchema(schema);
-    return new ProjectionModel(jsonSchema, view.projection);
-  }, [schema, view.projection]);
-  const [field, setField] = useState<FieldType>();
-  const readonly = _readonly || !isMutable(schema);
-
-  // TODO(burdon): Should be reactive.
-  const viewValues = useMemo(() => {
-    return {
-      // TODO(burdon): Need to warn user of possible consequences of editing.
-      // TODO(burdon): Settings should have domain name owned by user.
-      typename: view.query.typename,
-    };
-  }, [view.query.typename]);
-
-  const handleSelect = useCallback(
-    (field: FieldType) => {
-      if (readonly) {
-        return;
-      }
-      setField((f) => (f === field ? undefined : field));
+export const ViewEditor = forwardRef<ProjectionModel, ViewEditorProps>(
+  (
+    {
+      classNames,
+      schema,
+      view,
+      mode = 'schema',
+      registry,
+      readonly,
+      showHeading = false,
+      types,
+      tags,
+      onQueryChanged,
+      onDelete,
     },
-    [readonly],
-  );
+    forwardedRef,
+  ) => {
+    const schemaReadonly = !isMutable(schema);
+    const { t } = useTranslation(translationKey);
+    const projectionModel = useMemo(() => {
+      // Use reactive and mutable version of json schema when schema is mutable.
+      const jsonSchema = schema instanceof EchoSchema ? schema.jsonSchema : toJsonSchema(schema);
+      return new ProjectionModel(jsonSchema, view.projection);
+    }, [schema, JSON.stringify(view.projection)]);
+    useImperativeHandle(forwardedRef, () => projectionModel, [projectionModel]);
+    const [expandedField, setExpandedField] = useState<FieldType['id']>();
+
+    const queueTarget = Match.value(view.query.ast).pipe(
+      Match.when({ type: 'options' }, ({ options }) => {
+        return Option.fromNullable(options.queues).pipe(
+          Option.flatMap((queues) => Array.head(queues)),
+          Option.getOrUndefined,
+        );
+      }),
+      Match.orElse(() => undefined),
+    );
 
-  // TODO(burdon): Check if mutable; variant of useCallback that return undefined if readonly?
+    const viewSchema = useMemo(() => {
+      const base = Schema.Struct({
+        query:
+          mode === 'schema'
+            ? Format.URL.annotations({ title: 'Record type' })
+            : QueryAST.Query.annotations({ title: 'Query' }),
+      });
+
+      if (mode === 'tag') {
+        return Schema.Struct({
+          ...base.fields,
+          target: Schema.optional(Schema.String.annotations({ title: 'Target Queue' })),
+        }).pipe(Schema.mutable);
+      }
 
-  const handleAdd = useCallback(() => {
-    invariant(!readonly);
-    const field = projection.createFieldProjection();
-    setField(field);
-  }, [schema, projection, readonly]);
+      return base.pipe(Schema.mutable);
+    }, [mode]);
 
-  const handleUpdate = useCallback(
-    ({ typename }: ViewMetaType) => {
+    // TODO(burdon): Need to warn user of possible consequences of editing.
+    // TODO(burdon): Settings should have domain name owned by user.
+    const viewValues = useMemo(
+      () => ({
+        query: mode === 'schema' ? getTypenameFromQuery(view.query.ast) : view.query.ast,
+        target: queueTarget,
+      }),
+      [mode, view.query.ast, queueTarget],
+    );
+
+    const fieldMap = useMemo<FormFieldMap | undefined>(
+      () => (mode === 'tag' ? customFields({ types, tags }) : undefined),
+      [mode, types, tags],
+    );
+
+    // TODO(burdon): Check if mutable.
+    const handleAdd = useCallback(() => {
       invariant(!readonly);
-      requestAnimationFrame(() => {
-        if (view.query.typename !== typename && !readonly) {
-          onTypenameChanged?.(typename);
+      const field = projectionModel.createFieldProjection();
+      setExpandedField(field.id);
+    }, [schema, projectionModel, readonly]);
+
+    const handleUpdate = useCallback(
+      (values: any) => {
+        requestAnimationFrame(() => {
+          const query = mode === 'schema' ? Query.select(Filter.typename(values.query)).ast : values.query;
+          onQueryChanged?.(query, values.target);
+        });
+      },
+      [onQueryChanged, view, queueTarget, mode],
+    );
+
+    const handleDelete = useCallback(
+      (fieldId: string) => {
+        invariant(!readonly);
+        if (fieldId === expandedField) {
+          setExpandedField(undefined);
         }
-      });
+
+        onDelete?.(fieldId);
+      },
+      [expandedField, onDelete, readonly],
+    );
+
+    return (
+      <div role='none' className={mx(classNames)}>
+        {/* If readonly is set, then the callout is not needed. */}
+        {schemaReadonly && !readonly && (
+          <Callout.Root valence='info' classNames='mlb-cardSpacingBlock'>
+            <Callout.Title>{t('system schema description')}</Callout.Title>
+          </Callout.Root>
+        )}
+
+        {/* TODO(burdon): Is the form read-only or just the schema? */}
+        <Form.Root schema={viewSchema} values={viewValues} fieldMap={fieldMap} autoSave onSave={handleUpdate}>
+          <Form.FieldSet />
+
+          <FormFieldLabel label={t('fields label')} asChild />
+          <FieldList
+            schema={schema}
+            view={view}
+            registry={registry}
+            readonly={readonly}
+            showHeading={showHeading}
+            onDelete={handleDelete}
+          />
+        </Form.Root>
+
+        {!readonly && !expandedField && (
+          <div role='none' className='mlb-cardSpacingBlock'>
+            <IconButton
+              icon='ph--plus--regular'
+              label={t('add property button label')}
+              onClick={readonly ? undefined : handleAdd}
+              // TODO(burdon): Show field limit in ux (not tooltip).
+              disabled={view.projection.fields.length >= VIEW_FIELD_LIMIT}
+              classNames='is-full'
+            />
+          </div>
+        )}
+      </div>
+    );
+  },
+);
+
+type FieldListProps = Pick<ViewEditorProps, 'schema' | 'view' | 'registry' | 'readonly' | 'showHeading' | 'onDelete'>;
+
+const FieldList = ({ schema, view, registry, readonly, showHeading = false, onDelete }: FieldListProps) => {
+  const schemaReadonly = !isMutable(schema);
+  const { t } = useTranslation(translationKey);
+  const projectionModel = useMemo(() => {
+    // Use reactive and mutable version of json schema when schema is mutable.
+    const jsonSchema = schema instanceof EchoSchema ? schema.jsonSchema : toJsonSchema(schema);
+    return new ProjectionModel(jsonSchema, view.projection);
+  }, [schema, JSON.stringify(view.projection)]);
+  const [expandedField, setExpandedField] = useState<FieldType['id']>();
+
+  const handleToggleField = useCallback(
+    (field: FieldType) => {
+      setExpandedField((prevExpandedFieldId) => (prevExpandedFieldId === field.id ? undefined : field.id));
     },
-    [view.query.typename, onTypenameChanged, readonly],
+    [readonly],
   );
 
   const handleDelete = useCallback(
     (fieldId: string) => {
       invariant(!readonly);
-      if (fieldId === field?.id) {
-        setField(undefined);
+      if (fieldId === expandedField) {
+        setExpandedField(undefined);
       }
 
       onDelete?.(fieldId);
     },
-    [field, onDelete, readonly],
+    [expandedField, onDelete, readonly],
   );
 
   const handleMove = useCallback(
@@ -126,145 +237,114 @@ export const ViewEditor = ({
     [view.projection.fields, readonly],
   );
 
-  const handleClose = useCallback(() => setField(undefined), []);
-
-  const hiddenProperties = projection.getHiddenProperties();
+  const handleClose = useCallback(() => setExpandedField(undefined), []);
 
   const handleHide = useCallback(
     (fieldId: string) => {
-      setField(undefined);
-      projection.hideFieldProjection(fieldId);
+      setExpandedField(undefined);
+      projectionModel.hideFieldProjection(fieldId);
     },
-    [projection],
+    [projectionModel],
   );
 
   const handleShow = useCallback(
     (property: string) => {
-      setField(undefined);
-      projection.showFieldProjection(property as JsonProp);
+      setExpandedField(undefined);
+      projectionModel.showFieldProjection(property as JsonProp);
     },
-    [projection],
+    [projectionModel],
   );
 
   return (
-    <div role='none' className={mx(classNames)}>
-      {readonly && (
-        <div role='none' className={mx('is-full', outerSpacing && 'plb-cardSpacingBlock pli-cardSpacingInline')}>
-          <Callout.Root valence='info'>
-            <Callout.Title>{t('system schema description')}</Callout.Title>
-          </Callout.Root>
-        </div>
-      )}
-
-      {/* TODO(burdon): Is the form read-only or just the schema? */}
-      {/* TODO(burdon): Readonly fields should take up the same space as editable fields (just be ghosted). */}
-      <Form<ViewMetaType>
-        autoSave
-        schema={ViewMetaSchema}
-        values={viewValues}
-        readonly={readonly}
-        onSave={handleUpdate}
-        outerSpacing={outerSpacing}
-      />
-
-      <div role='none' className={outerSpacing ? cardSpacing : 'mlb-cardSpacingBlock'}>
-        <label className={mx(inputTextLabel)}>{t('fields label')}</label>
-
-        <List.Root<FieldType>
-          items={view.projection.fields}
-          isItem={Schema.is(FieldSchema)}
-          getId={(field) => field.id}
-          readonly={readonly}
-          onMove={readonly ? undefined : handleMove}
-        >
-          {({ items: fields }) => (
-            <>
-              {showHeading && (
-                <div role='heading' className={grid}>
-                  <div />
-                  <div className='flex items-center text-sm'>{t('field path label')}</div>
-                </div>
-              )}
-
-              <div role='list' className='flex flex-col is-full'>
-                {fields?.map((field) => (
-                  <List.Item<FieldType>
-                    key={field.id}
-                    item={field}
-                    classNames={mx(grid, ghostHover, 'overflow-hidden', !readonly && 'cursor-pointer')}
-                  >
-                    <List.ItemDragHandle />
-                    <List.ItemTitle onClick={() => handleSelect(field)}>{field.path}</List.ItemTitle>
+    <List.Root<FieldType>
+      items={view.projection.fields}
+      isItem={Schema.is(FieldSchema)}
+      getId={(field) => field.id}
+      onMove={readonly ? undefined : handleMove}
+      readonly={readonly}
+    >
+      {({ items: fields }) => (
+        <>
+          {showHeading && <h3 className='text-sm'>{t('field path label')}</h3>}
+          <div role='list' className={listGrid}>
+            {fields?.map((field) => {
+              const hidden = field.visible === false;
+              return (
+                <List.Item<FieldType>
+                  key={field.id}
+                  item={field}
+                  classNames={listItemGrid}
+                  aria-expanded={expandedField === field.id}
+                >
+                  <div role='none' className={mx(subtleHover, listItemGrid, 'rounded-sm cursor-pointer min-bs-10')}>
+                    <List.ItemDragHandle disabled={readonly || schemaReadonly} />
+                    <List.ItemTitle classNames={hidden && 'text-subdued'} onClick={() => handleToggleField(field)}>
+                      {field.path}
+                    </List.ItemTitle>
                     <List.ItemButton
-                      data-testid='hide-field-button'
-                      icon='ph--eye-slash--regular'
-                      // TDOO(burdon): Is this the correct test?
-                      disabled={view.projection.fields.length <= 1}
-                      onClick={() => handleHide(field.id)}
+                      label={t(hidden ? 'show field label' : 'hide field label')}
+                      data-testid={hidden ? 'show-field-button' : 'hide-field-button'}
+                      icon={hidden ? 'ph--eye-closed--regular' : 'ph--eye--regular'}
+                      autoHide={false}
+                      disabled={readonly || (!hidden && projectionModel.fields.length <= 1)}
+                      onClick={() => (hidden ? handleShow(field.path) : handleHide(field.id))}
                     />
-                    {/* TODO(burdon): Remove unless implement undo. */}
                     {!readonly && (
-                      <List.ItemDeleteButton
-                        disabled={view.projection.fields.length <= 1}
-                        onClick={() => handleDelete(field.id)}
-                      />
+                      <>
+                        <List.ItemDeleteButton
+                          label={t('delete field label')}
+                          autoHide={false}
+                          disabled={readonly || schemaReadonly || view.projection.fields.length <= 1}
+                          onClick={() => handleDelete(field.id)}
+                          data-testid='field.delete'
+                        />
+                        <IconButton
+                          iconOnly
+                          variant='ghost'
+                          label={t('toggle expand label', { ns: 'os' })}
+                          icon={expandedField === field.id ? 'ph--caret-down--regular' : 'ph--caret-right--regular'}
+                          onClick={() => handleToggleField(field)}
+                          data-testid='field.toggle'
+                        />
+                      </>
                     )}
-                  </List.Item>
-                ))}
-              </div>
-            </>
-          )}
-        </List.Root>
-
-        {hiddenProperties.length > 0 && (
-          <>
-            <label className={mx(inputTextLabel)}>{t('hidden fields label')}</label>
-
-            <List.Root<string>
-              items={hiddenProperties}
-              isItem={(item): item is string => typeof item === 'string'}
-              getId={(property) => property}
-            >
-              {({ items: properties }) => (
-                <div role='list' className='flex flex-col is-full'>
-                  {properties?.map((property) => (
-                    <List.Item<string>
-                      key={property}
-                      item={property}
-                      classNames={mx(grid, ghostHover, !readonly && 'cursor-pointer')}
-                    >
-                      <List.ItemDragHandle disabled />
-                      <List.ItemTitle>{property}</List.ItemTitle>
-                      <List.ItemButton
-                        icon='ph--eye--regular'
-                        onClick={() => handleShow(property)}
-                        data-testid='show-field-button'
+                  </div>
+                  {expandedField === field.id && !readonly && (
+                    <div role='none' className='col-span-5 mbs-1 mbe-1 border border-separator rounded-md'>
+                      <FieldEditor
+                        readonly={readonly || schemaReadonly}
+                        registry={registry}
+                        projection={projectionModel}
+                        field={field}
+                        onSave={handleClose}
                       />
-                    </List.Item>
-                  ))}
-                </div>
-              )}
-            </List.Root>
-          </>
-        )}
-      </div>
-
-      {field && (
-        <FieldEditor key={field.id} projection={projection} field={field} registry={registry} onSave={handleClose} />
-      )}
-
-      {!readonly && !field && (
-        <div role='none' className={outerSpacing ? cardSpacing : 'mlb-cardSpacingBlock'}>
-          <IconButton
-            icon='ph--plus--regular'
-            label={t('button add property')}
-            onClick={readonly ? undefined : handleAdd}
-            // TODO(burdon): Show field limit in ux (not tooltip).
-            disabled={view.projection.fields.length >= VIEW_FIELD_LIMIT}
-            classNames='flex is-full'
-          />
-        </div>
+                    </div>
+                  )}
+                </List.Item>
+              );
+            })}
+          </div>
+        </>
       )}
-    </div>
+    </List.Root>
   );
 };
+
+const customFields = ({
+  types,
+  tags,
+}: Pick<ViewEditorProps, 'types' | 'tags'>): Record<string, FormFieldComponent> => ({
+  query: ({ type, readonly, label, getValue, onValueChange }: FormFieldComponentProps) => {
+    const handleChange = useCallback<NonNullable<QueryFormProps['onChange']>>(
+      (query) => onValueChange(type, query.ast),
+      [onValueChange],
+    );
+
+    return (
+      <Input.Root>
+        <FormFieldLabel readonly={readonly} label={label} />
+        <QueryForm initialQuery={getValue()} types={types} tags={tags} onChange={handleChange} />
+      </Input.Root>
+    );
+  },
+});

package/src/components/index.ts

@@ -2,9 +2,8 @@
 // Copyright 2024 DXOS.org
 //
 
-export * from './deprecated';
-
 export * from './ControlSection';
 export * from './FieldEditor';
 export * from './Form';
+export * from './ObjectPicker';
 export * from './ViewEditor';

package/src/components/testing.tsx

@@ -7,18 +7,28 @@ import React, { type PropsWithChildren } from 'react';
 import { type ThemedClassName } from '@dxos/react-ui';
 import { Card } from '@dxos/react-ui-stack';
 import { JsonFilter } from '@dxos/react-ui-syntax-highlighter';
-import { mx, textBlockWidth } from '@dxos/react-ui-theme';
+import { textBlockWidth } from '@dxos/react-ui-theme';
 
-export const TestLayout = ({ classNames, json, children }: ThemedClassName<PropsWithChildren<{ json?: any }>>) => (
-  <div className='w-full h-full grid grid-cols-[1fr_1fr] gap-2 overflow-hidden'>
-    <div className={mx('p-4 justify-center overflow-y-auto', classNames)}>{children}</div>
-    <JsonFilter data={json} classNames='w-full text-xs' testId='debug' />
-  </div>
-);
+type TestLayoutProps = ThemedClassName<PropsWithChildren<{ json?: any }>>;
 
-export const TestPanel = ({ classNames, children }: ThemedClassName<PropsWithChildren>) => (
-  <Card.StaticRoot classNames={[textBlockWidth, classNames]}>{children}</Card.StaticRoot>
-);
+export const TestLayout = ({ classNames, children, json }: TestLayoutProps) => {
+  return (
+    <div className='is-full bs-full grid grid-cols-[1fr_1fr] p-4 gap-4 overflow-hidden'>
+      <TestPanel classNames={['flex flex-col bs-full overflow-y-auto', classNames]}>{children}</TestPanel>
+      <TestPanel classNames={'overflow-hidden'}>
+        <JsonFilter testId='debug' data={json} classNames='bs-full text-xs' />
+      </TestPanel>
+    </div>
+  );
+};
+
+type TestPanelProps = ThemedClassName<PropsWithChildren>;
+
+const TestPanel = ({ classNames, children }: TestPanelProps) => {
+  return (
+    <Card.StaticRoot classNames={['bs-full overflow-y-auto', textBlockWidth, classNames]}>{children}</Card.StaticRoot>
+  );
+};
 
 // Symbol for accessing debug objects in tests.
 export const VIEW_EDITOR_DEBUG_SYMBOL = Symbol('viewEditorDebug');

package/src/hooks/index.ts

@@ -2,6 +2,7 @@
 // Copyright 2025 DXOS.org
 //
 
-export * from './useForm';
-export * from './useRefQueryLookupHandler';
+export * from './useFormHandler';
+export * from './useKeyHandler';
 export * from './useQueryRefOptions';
+export * from './useRefQueryOptions';