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

package/src/components/ViewEditor/ViewEditor.tsx

@@ -2,43 +2,43 @@
 // Copyright 2024 DXOS.org
 //
 
-import { Schema } from 'effect';
+import { Match, Schema } from 'effect';
 import React, { useCallback, useMemo, useState } from 'react';
 
 import { type SchemaRegistry } from '@dxos/echo-db';
 import { EchoSchema, Format, type JsonProp, isMutable, toJsonSchema } from '@dxos/echo-schema';
 import { invariant } from '@dxos/invariant';
+import { getSpace } from '@dxos/react-client/echo';
 import { Callout, IconButton, type ThemedClassName, useTranslation } from '@dxos/react-ui';
+import { QueryEditor, QuerySerializer, createExpression } 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, type ViewType, ViewProjection, VIEW_FIELD_LIMIT } from '@dxos/schema';
+import { inputTextLabel, mx, subtleHover } from '@dxos/react-ui-theme';
+import {
+  type DataType,
+  FieldSchema,
+  type FieldType,
+  ProjectionModel,
+  VIEW_FIELD_LIMIT,
+  typenameFromQuery,
+} from '@dxos/schema';
 
 import { translationKey } from '../../translations';
 import { FieldEditor } from '../FieldEditor';
-import { Form, type FormProps } from '../Form';
+import { Form, type FormProps, type InputComponent, type InputProps } from '../Form';
 
-const grid = 'grid grid-cols-[32px_1fr_32px_32px] min-bs-[2.5rem]';
-
-const ViewMetaSchema = Schema.Struct({
-  name: Schema.String.annotations({
-    title: 'View',
-  }),
-  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: ViewType;
+    view: DataType.View;
+    kind?: 'basic' | 'advanced';
     registry?: SchemaRegistry;
     readonly?: boolean;
     showHeading?: boolean;
-    onTypenameChanged?: (typename: string) => void;
+    onQueryChanged?: (query: string) => void;
     onDelete?: (fieldId: string) => void;
   } & Pick<FormProps<any>, 'outerSpacing'>
 >;
@@ -50,38 +50,52 @@ export const ViewEditor = ({
   classNames,
   schema,
   view,
+  kind = 'basic',
   registry,
-  readonly: _readonly,
+  readonly,
   showHeading = false,
-  onTypenameChanged,
+  onQueryChanged,
   onDelete,
   outerSpacing = true,
 }: ViewEditorProps) => {
+  const space = getSpace(view);
+  const schemaReadonly = !isMutable(schema);
   const { t } = useTranslation(translationKey);
-  const projection = useMemo(() => {
+  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 ViewProjection(jsonSchema, view);
-  }, [schema, view]);
-  const [field, setField] = useState<FieldType>();
-  const readonly = _readonly || !isMutable(schema);
+    return new ProjectionModel(jsonSchema, view.projection);
+  }, [schema, view.projection]);
+  const [expandedField, setExpandedField] = useState<FieldType['id']>();
 
-  // TODO(burdon): Should be reactive.
-  const viewValues = useMemo(() => {
-    return {
-      name: view.name,
-      // 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]);
+  const serializedQuery = Match.value(kind).pipe(
+    Match.when('basic', () => typenameFromQuery(view.query)),
+    Match.when('advanced', () => {
+      if (view.query.type !== 'select') {
+        return '';
+      }
 
-  const handleSelect = useCallback(
+      const serializer = new QuerySerializer();
+      return serializer.serialize(createExpression(view.query.filter));
+    }),
+    Match.exhaustive,
+  );
+
+  const viewSchema = useMemo(() => {
+    return Schema.Struct({
+      query:
+        kind === 'basic'
+          ? Format.URL.annotations({ title: 'Record type' })
+          : Schema.String.annotations({ title: 'Query' }),
+    }).pipe(Schema.mutable);
+  }, [kind]);
+  // 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: serializedQuery }), [serializedQuery]);
+
+  const handleToggleField = useCallback(
     (field: FieldType) => {
-      if (readonly) {
-        return;
-      }
-      setField((f) => (f === field ? undefined : field));
+      setExpandedField((prevExpandedFieldId) => (prevExpandedFieldId === field.id ? undefined : field.id));
     },
     [readonly],
   );
@@ -90,193 +104,183 @@ export const ViewEditor = ({
 
   const handleAdd = useCallback(() => {
     invariant(!readonly);
-    const field = projection.createFieldProjection();
-    setField(field);
-  }, [schema, view, readonly]);
+    const field = projectionModel.createFieldProjection();
+    setExpandedField(field.id);
+  }, [schema, projectionModel, readonly]);
 
   const handleUpdate = useCallback(
-    ({ name, typename }: ViewMetaType) => {
+    ({ query }: Schema.Schema.Type<typeof viewSchema>) => {
       invariant(!readonly);
       requestAnimationFrame(() => {
-        if (view.name !== name) {
-          view.name = name;
-        }
-
-        if (view.query.typename !== typename && !readonly) {
-          onTypenameChanged?.(typename);
+        if (serializedQuery !== query && !readonly) {
+          onQueryChanged?.(query);
         }
       });
     },
-    [schema, view, onTypenameChanged, readonly],
+    [serializedQuery, onQueryChanged, readonly],
   );
 
   const handleDelete = useCallback(
     (fieldId: string) => {
       invariant(!readonly);
-      if (fieldId === field?.id) {
-        setField(undefined);
+      if (fieldId === expandedField) {
+        setExpandedField(undefined);
       }
 
       onDelete?.(fieldId);
     },
-    [schema, field, onDelete, readonly],
+    [expandedField, onDelete, readonly],
   );
 
   const handleMove = useCallback(
     (fromIndex: number, toIndex: number) => {
       invariant(!readonly);
       // NOTE(ZaymonFC): Using arrayMove here causes a race condition with the kanban model.
-      const fields = [...view.fields];
+      const fields = [...view.projection.fields];
       const [moved] = fields.splice(fromIndex, 1);
       fields.splice(toIndex, 0, moved);
-      view.fields = fields;
+      view.projection.fields = fields;
     },
-    [schema, view.fields, readonly],
+    [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],
+  );
+
+  const custom: Partial<Record<string, InputComponent>> = useMemo(
+    () =>
+      kind === 'advanced'
+        ? {
+            ['query' satisfies keyof Schema.Schema.Type<typeof viewSchema>]: (props: InputProps) => {
+              const handleChange = useCallback(
+                (text: string) => props.onValueChange('string', text),
+                [props.onValueChange],
+              );
+
+              // TODO(wittjosiah): Add label & input styles.
+              return <QueryEditor space={space} initialValue={props.getValue()} onChange={handleChange} />;
+            },
+          }
+        : {},
+    [],
   );
 
   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>
+      {schemaReadonly && (
+        <Callout.Root valence='info' classNames={['mlb-cardSpacingBlock', outerSpacing && 'mli-cardSpacingInline']}>
+          <Callout.Title>{t('system schema description')}</Callout.Title>
+        </Callout.Root>
       )}
 
       {/* 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>
+      <Form<Schema.Schema.Type<typeof viewSchema>>
         autoSave
-        schema={ViewMetaSchema}
+        schema={viewSchema}
         values={viewValues}
-        readonly={readonly}
+        readonly={readonly ? 'disabled-input' : false}
         onSave={handleUpdate}
         outerSpacing={outerSpacing}
+        Custom={custom}
       />
 
       <div role='none' className={outerSpacing ? cardSpacing : 'mlb-cardSpacingBlock'}>
-        <label className={mx(inputTextLabel)}>{t('fields label')}</label>
+        <h2 className={mx(inputTextLabel)}>{t('fields label')}</h2>
 
         <List.Root<FieldType>
-          items={view.fields}
+          items={view.projection.fields}
           isItem={Schema.is(FieldSchema)}
           getId={(field) => field.id}
-          readonly={readonly}
           onMove={readonly ? undefined : handleMove}
+          readonly={readonly}
         >
           {({ 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.ItemButton
-                      data-testid='hide-field-button'
-                      icon='ph--eye-slash--regular'
-                      // TDOO(burdon): Is this the correct test?
-                      disabled={view.fields.length <= 1}
-                      onClick={() => handleHide(field.id)}
-                    />
-                    {/* TODO(burdon): Remove unless implement undo. */}
-                    {!readonly && (
-                      <List.ItemDeleteButton
-                        disabled={view.fields.length <= 1}
-                        onClick={() => handleDelete(field.id)}
-                      />
-                    )}
-                  </List.Item>
-                ))}
+              {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} />
+                        <List.ItemTitle classNames={hidden && 'text-subdued'} onClick={() => handleToggleField(field)}>
+                          {field.path}
+                        </List.ItemTitle>
+                        <List.ItemButton
+                          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. */}
+                        <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)}
+                        />
+                      </div>
+                      {expandedField === field.id && (
+                        <div role='none' className='col-span-5 mbs-1 mbe-1 border border-separator rounded-md'>
+                          <FieldEditor
+                            readonly={readonly || schemaReadonly ? 'disabled-input' : false}
+                            projection={projectionModel}
+                            field={field}
+                            registry={registry}
+                            onSave={handleClose}
+                          />
+                        </div>
+                      )}
+                    </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'
-                      />
-                    </List.Item>
-                  ))}
-                </div>
-              )}
-            </List.Root>
-          </>
-        )}
       </div>
 
-      {field && (
-        <FieldEditor
-          key={field.id}
-          view={view}
-          projection={projection}
-          field={field}
-          registry={registry}
-          onSave={handleClose}
-        />
-      )}
-
-      {!readonly && !field && (
+      {!readonly && !expandedField && (
         <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.fields.length >= VIEW_FIELD_LIMIT}
-            classNames='flex is-full'
+            disabled={view.projection.fields.length >= VIEW_FIELD_LIMIT}
+            classNames='is-full'
           />
         </div>
       )}

package/src/components/index.ts

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

package/src/components/testing.tsx

@@ -9,16 +9,22 @@ import { Card } from '@dxos/react-ui-stack';
 import { JsonFilter } from '@dxos/react-ui-syntax-highlighter';
 import { mx, 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.Content classNames={[textBlockWidth, classNames]}>{children}</Card.Content>
-);
+export const TestLayout = ({ classNames, children, json }: TestLayoutProps) => {
+  return (
+    <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 TestPanelProps = ThemedClassName<PropsWithChildren>;
+
+export const TestPanel = ({ classNames, children }: TestPanelProps) => {
+  return <Card.StaticRoot classNames={[textBlockWidth, classNames]}>{children}</Card.StaticRoot>;
+};
 
 // Symbol for accessing debug objects in tests.
 export const VIEW_EDITOR_DEBUG_SYMBOL = Symbol('viewEditorDebug');

package/src/hooks/useForm.ts

@@ -2,14 +2,14 @@
 // Copyright 2025 DXOS.org
 //
 
-import { SchemaAST, type Schema } from 'effect';
+import { type Schema, SchemaAST } from 'effect';
 import { useCallback, useEffect, useMemo, useState } from 'react';
 
 import { type BaseObject, getValue, setValue } from '@dxos/echo-schema';
-import { type SimpleType, type JsonPath, createJsonPath, fromEffectValidationPath } from '@dxos/effect';
+import { type JsonPath, type SimpleType, createJsonPath, fromEffectValidationPath } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
-import { validateSchema, type ValidationError } from '@dxos/schema';
+import { type ValidationError, validateSchema } from '@dxos/schema';
 import { type MaybePromise } from '@dxos/util';
 
 /**
@@ -26,6 +26,8 @@ export type FormHandler<T extends BaseObject> = {
   changed: Record<JsonPath, boolean>;
   canSave: boolean;
   formIsValid: boolean;
+
+  // TODO(burdon): Return onSave.
   handleSave: () => void;
 
   //

package/src/hooks/useRefQueryLookupHandler.ts

@@ -4,7 +4,7 @@
 
 import { useCallback } from 'react';
 
-import { getObjectDXN, type TypeAnnotation } from '@dxos/echo-schema';
+import { type TypeAnnotation, getObjectDXN } from '@dxos/echo-schema';
 import { Filter, type Space } from '@dxos/react-client/echo';
 import { isNonNullable } from '@dxos/util';
 

package/src/index.ts

@@ -2,7 +2,7 @@
 // Copyright 2024 DXOS.org
 //
 
-import translations from './translations';
+import { translations } from './translations';
 
 export * from './components';
 export * from './hooks';

package/src/translations.ts

@@ -2,9 +2,11 @@
 // Copyright 2023 DXOS.org
 //
 
+import { type Resource } from '@dxos/react-ui';
+
 export const translationKey = 'react-ui-form';
 
-export default [
+export const translations = [
   {
     'en-US': {
       [translationKey]: {
@@ -23,6 +25,11 @@ export default [
         'field limit reached': 'Maximum number of fields reached',
         'boolean input true value': 'Yes',
         'boolean input false value': 'No',
+        'show field label': 'Show field',
+        'hide field label': 'Hide field',
+        'delete field label': 'Delete field',
+        'ref field placeholder_one': 'Select…',
+        'ref field placeholder_other': 'Select items…',
 
         // TODO(burdon): Factor out?
         'button cancel': 'Cancel',
@@ -58,9 +65,9 @@ export default [
         'format url': 'URL',
         'format uuid': 'UUID',
 
-        // Placeholders.
-        'placeholder latitude': 'Latitude',
-        'placeholder longitude': 'Longitude',
+        // GeoPointInput.
+        'latitude label': 'Latitude',
+        'longitude label': 'Longitude',
 
         // SelectOptionsInput.
         'select option label': 'Label',
@@ -70,9 +77,10 @@ export default [
         'select option add': 'Add option',
 
         // System schema message.
-        'system schema title': 'System Schema',
-        'system schema description': 'This is a system schema and cannot be modified.',
+        'system schema title': 'System record type',
+        'system schema description':
+          'This is a system record type and cannot be modified, though the view can still be configured.',
       },
     },
   },
-];
+] as const satisfies Resource[];

package/src/util/field.ts

@@ -112,24 +112,7 @@ export type CellClassesForFieldTypeProps = {
 };
 
 export const cellClassesForFieldType = ({ type, format }: CellClassesForFieldTypeProps): string[] | undefined => {
-  if (!format) {
-    switch (type) {
-      case TypeEnum.Number:
-        return ['text-right', 'font-mono'];
-      case TypeEnum.Boolean:
-        return ['text-right', 'font-mono'];
-      case TypeEnum.String:
-        return undefined;
-      case TypeEnum.Ref:
-        return undefined;
-
-      default: {
-        return undefined;
-      }
-    }
-  }
-
-  switch (format) {
+  switch (format || type) {
     case FormatEnum.Markdown:
       return undefined;
     case FormatEnum.Time:
@@ -143,6 +126,13 @@ export const cellClassesForFieldType = ({ type, format }: CellClassesForFieldTyp
     case FormatEnum.JSON:
     case FormatEnum.DID:
       return ['font-mono'];
+    case TypeEnum.Number:
+    case TypeEnum.Boolean:
+      return ['text-right', 'font-mono'];
+    case TypeEnum.String:
+      return undefined;
+    case TypeEnum.Ref:
+      return undefined;
     default:
       return undefined;
   }