@dxos/react-ui-form 0.8.4-main.f9ba587 → 0.8.4-main.fd6878d

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/react-ui-form",
-  "version": "0.8.4-main.f9ba587",
+  "version": "0.8.4-main.fd6878d",
   "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"
@@ -29,48 +30,48 @@
     "@radix-ui/react-context": "1.1.1",
     "date-fns": "^3.3.1",
     "jsonpath": "^1.1.1",
-    "@dxos/async": "0.8.4-main.f9ba587",
-    "@dxos/debug": "0.8.4-main.f9ba587",
-    "@dxos/echo": "0.8.4-main.f9ba587",
-    "@dxos/echo-db": "0.8.4-main.f9ba587",
-    "@dxos/echo-schema": "0.8.4-main.f9ba587",
-    "@dxos/effect": "0.8.4-main.f9ba587",
-    "@dxos/invariant": "0.8.4-main.f9ba587",
-    "@dxos/keys": "0.8.4-main.f9ba587",
-    "@dxos/lit-ui": "0.8.4-main.f9ba587",
-    "@dxos/live-object": "0.8.4-main.f9ba587",
-    "@dxos/log": "0.8.4-main.f9ba587",
-    "@dxos/react-client": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-list": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-stack": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-pickers": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-tag-picker": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-types": "0.8.4-main.f9ba587",
-    "@dxos/schema": "0.8.4-main.f9ba587",
-    "@dxos/util": "0.8.4-main.f9ba587"
+    "@dxos/async": "0.8.4-main.fd6878d",
+    "@dxos/echo": "0.8.4-main.fd6878d",
+    "@dxos/debug": "0.8.4-main.fd6878d",
+    "@dxos/echo-db": "0.8.4-main.fd6878d",
+    "@dxos/echo-schema": "0.8.4-main.fd6878d",
+    "@dxos/effect": "0.8.4-main.fd6878d",
+    "@dxos/lit-ui": "0.8.4-main.fd6878d",
+    "@dxos/invariant": "0.8.4-main.fd6878d",
+    "@dxos/keys": "0.8.4-main.fd6878d",
+    "@dxos/live-object": "0.8.4-main.fd6878d",
+    "@dxos/log": "0.8.4-main.fd6878d",
+    "@dxos/react-client": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-list": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-pickers": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-tag-picker": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-types": "0.8.4-main.fd6878d",
+    "@dxos/schema": "0.8.4-main.fd6878d",
+    "@dxos/util": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-stack": "0.8.4-main.fd6878d"
   },
   "devDependencies": {
     "@types/jsonpath": "^0.2.4",
     "@types/react": "~18.2.0",
     "@types/react-dom": "~18.2.0",
-    "effect": "3.16.13",
+    "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.4-main.f9ba587",
-    "@dxos/random": "0.8.4-main.f9ba587",
-    "@dxos/react-ui": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-theme": "0.8.4-main.f9ba587",
-    "@dxos/storybook-utils": "0.8.4-main.f9ba587"
+    "@dxos/echo-signals": "0.8.4-main.fd6878d",
+    "@dxos/random": "0.8.4-main.fd6878d",
+    "@dxos/react-ui": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-syntax-highlighter": "0.8.4-main.fd6878d",
+    "@dxos/storybook-utils": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-theme": "0.8.4-main.fd6878d"
   },
   "peerDependencies": {
     "effect": "^3.13.3",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
-    "@dxos/react-ui": "0.8.4-main.f9ba587",
-    "@dxos/react-ui-theme": "0.8.4-main.f9ba587"
+    "@dxos/react-ui": "0.8.4-main.fd6878d",
+    "@dxos/react-ui-theme": "0.8.4-main.fd6878d"
   },
   "publishConfig": {
     "access": "public"

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

@@ -10,9 +10,10 @@ 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 { ControlPage, ControlSection, type ControlSectionProps } from './ControlSection';
+
 const meta: Meta<ControlSectionProps> = {
   title: 'ui/react-ui-form/ControlSection',
   component: ControlSection,

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

@@ -5,28 +5,28 @@
 import '@dxos-theme';
 
 import { type Meta, type StoryObj } from '@storybook/react-vite';
-import React, { useMemo, useEffect } from 'react';
+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 { FieldEditor, type FieldEditorProps } from './FieldEditor';
 import { translations } from '../../translations';
-import { TestLayout, TestPanel, FIELD_EDITOR_DEBUG_SYMBOL } from '../testing';
+import { FIELD_EDITOR_DEBUG_SYMBOL, TestLayout, TestPanel } from '../testing';
+
+import { FieldEditor, type FieldEditorProps } from './FieldEditor';
 
 // 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,20 +34,23 @@ 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>
   );
@@ -69,8 +72,8 @@ type Story = StoryObj<StoryProps>;
 
 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,26 +5,25 @@
 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 {
-  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;
+  readonly?: boolean;
+  projection: ProjectionModel;
   field: FieldType;
   registry?: SchemaRegistry;
   onSave: () => void;
@@ -35,7 +34,7 @@ export type FieldEditorProps = {
  * Displays a Form representing the metadata for a given `Field` and `View`.
  */
 export const FieldEditor = ({
-  view,
+  readonly,
   projection,
   field,
   registry,
@@ -112,7 +111,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 +120,7 @@ export const FieldEditor = ({
         ];
       }
     },
-    [view.fields, field],
+    [projection.fields, field],
   );
 
   const handleSave = useCallback<NonNullable<FormProps<PropertyType>['onSave']>>(
@@ -188,6 +187,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,18 +6,19 @@ 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 } from './FormContent';
+import { type FormInputStateProps, useFormValues } from './FormContext';
+import { type InputComponent, InputHeader } from './Input';
+
 type ArrayFieldProps = {
   property: SchemaProperty<any>;
   readonly?: boolean;
@@ -113,7 +114,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}

package/src/components/Form/Defaults.tsx

@@ -6,9 +6,10 @@ import React, { useCallback, useEffect, useRef } from 'react';
 
 import { Input, Select, useTranslation } from '@dxos/react-ui';
 
-import { type InputProps, InputHeader } from './Input';
 import { translationKey } from '../../translations';
 
+import { InputHeader, type InputProps } from './Input';
+
 export const TextInput = ({
   type,
   label,

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

@@ -9,17 +9,18 @@ import { Schema } from 'effect';
 import React, { useCallback, useState } from 'react';
 
 import { ContactType } from '@dxos/client/testing';
-import { type BaseObject, Expando, Format, getObjectDXN, Ref, type TypeAnnotation } from '@dxos/echo-schema';
+import { type BaseObject, Expando, Format, Ref, type TypeAnnotation, getObjectDXN } from '@dxos/echo-schema';
 import { live } from '@dxos/live-object';
 import { withSurfaceVariantsLayout } from '@dxos/react-ui/testing';
 import { Testing } from '@dxos/schema/testing';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-import { SelectInput } from './Defaults';
-import { Form, type FormProps } from './Form';
 import { translations } from '../../translations';
 import { TestLayout, TestPanel } from '../testing';
 
+import { SelectInput } from './Defaults';
+import { Form, type FormProps } from './Form';
+
 const AddressSchema = Schema.Struct({
   street: Schema.optional(Schema.String.annotations({ title: 'Street' })),
   city: Schema.optional(Schema.String.annotations({ title: 'City' })),

package/src/components/Form/Form.tsx

@@ -10,11 +10,12 @@ import { type ThemedClassName } from '@dxos/react-ui';
 import { cardDialogOverflow, cardSpacing } from '@dxos/react-ui-stack';
 import { type SchemaProperty } from '@dxos/schema';
 
+import { type FormOptions } from '../../hooks';
+
 import { FormActions, type FormOuterSpacing } from './FormActions';
 import { FormFields, type FormFieldsProps } from './FormContent';
 import { FormProvider } from './FormContext';
-import { type InputProps, type InputComponent } from './Input';
-import { type FormOptions } from '../../hooks';
+import { type InputComponent, type InputProps } from './Input';
 
 export type PropsFilter<T extends BaseObject> = (props: SchemaProperty<T>[]) => SchemaProperty<T>[];
 
@@ -99,7 +100,7 @@ export const Form = <T extends BaseObject>({
           readonly={readonly}
           schema={schema}
         />
-        {(onCancel || onSave) && !autoSave && (
+        {(onCancel || onSave) && !autoSave && !readonly && (
           <FormActions readonly={readonly} onCancel={onCancel} outerSpacing={outerSpacing} />
         )}
       </div>

package/src/components/Form/FormActions.tsx

@@ -8,9 +8,10 @@ import { IconButton, useTranslation } from '@dxos/react-ui';
 import { cardSpacing } from '@dxos/react-ui-stack';
 import { mx } from '@dxos/react-ui-theme';
 
-import { useFormContext } from './FormContext';
 import { translationKey } from '../../translations';
 
+import { useFormContext } from './FormContext';
+
 export type FormOuterSpacing = boolean | 'blockStart-0' | 'scroll-fields';
 
 export type FormActionsProps = {

package/src/components/Form/FormContent.tsx

@@ -9,18 +9,19 @@ import React, { forwardRef, useMemo } from 'react';
 import { createJsonPath, findNode, getDiscriminatedType, isDiscriminatedUnion } from '@dxos/effect';
 import { type ThemedClassName } from '@dxos/react-ui';
 import { mx } from '@dxos/react-ui-theme';
-import { getSchemaProperties, type SchemaProperty } from '@dxos/schema';
+import { type SchemaProperty, getSchemaProperties } from '@dxos/schema';
 import { isNotFalsy } from '@dxos/util';
 
+import { type QueryRefOptions } from '../../hooks';
+import { getRefProps } from '../../util';
+
 import { ArrayField } from './ArrayField';
 import { SelectInput } from './Defaults';
+import { getInputComponent } from './factory';
 import { type ComponentLookup } from './Form';
-import { useInputProps, useFormValues } from './FormContext';
+import { useFormValues, useInputProps } from './FormContext';
 import { type InputComponent } from './Input';
 import { RefField } from './RefField';
-import { getInputComponent } from './factory';
-import { type QueryRefOptions } from '../../hooks';
-import { getRefProps } from '../../util';
 
 export type FormFieldProps = {
   property: SchemaProperty<any>;

package/src/components/Form/FormContext.tsx

@@ -3,19 +3,19 @@
 //
 
 import React, {
-  createContext,
+  type FocusEvent,
+  type PropsWithChildren,
   type RefObject,
+  createContext,
+  useCallback,
   useContext,
   useEffect,
   useMemo,
-  type FocusEvent,
-  type PropsWithChildren,
-  useCallback,
 } from 'react';
 
 import { raise } from '@dxos/debug';
 import { type BaseObject, getValue } from '@dxos/echo-schema';
-import { createJsonPath, type SimpleType } from '@dxos/effect';
+import { type SimpleType, createJsonPath } from '@dxos/effect';
 
 import { type FormHandler, type FormOptions, useForm } from '../../hooks';
 

package/src/components/Form/RefField.tsx

@@ -3,28 +3,29 @@
 //
 
 import { type SchemaAST } from 'effect';
-import React, { useCallback, useMemo, type FocusEvent } from 'react';
+import React, { type FocusEvent, useCallback, useMemo } from 'react';
 
 import {
   Expando,
-  getTypeAnnotation,
   Ref,
   ReferenceAnnotationId,
   type ReferenceAnnotationValue,
+  getTypeAnnotation,
 } from '@dxos/echo-schema';
 import { findAnnotation } from '@dxos/effect';
 import { DXN } from '@dxos/keys';
 import { DxRefTag } from '@dxos/lit-ui/react';
 import { Input, useTranslation } from '@dxos/react-ui';
-import { TagPicker, type TagPickerMode, type TagPickerItemData } from '@dxos/react-ui-tag-picker';
+import { TagPicker, type TagPickerItemData, type TagPickerMode } from '@dxos/react-ui-tag-picker';
 import { descriptionText, mx } from '@dxos/react-ui-theme';
 import { isNonNullable } from '@dxos/util';
 
-import { TextInput } from './Defaults';
-import { InputHeader, type InputProps } from './Input';
 import { type QueryRefOptions, useQueryRefOptions } from '../../hooks';
 import { translationKey } from '../../translations';
 
+import { TextInput } from './Defaults';
+import { InputHeader, type InputProps } from './Input';
+
 type RefFieldProps = InputProps & {
   ast?: SchemaAST.AST;
   array?: boolean;

package/src/components/Form/custom/GeoPointInput.tsx

@@ -2,9 +2,9 @@
 // Copyright 2024 DXOS.org
 //
 
-import React, { useCallback, useState, useEffect, useMemo, type ChangeEvent } from 'react';
+import React, { type ChangeEvent, useCallback, useEffect, useMemo, useState } from 'react';
 
-import { type GeoPoint, GeoLocation } from '@dxos/echo-schema';
+import { GeoLocation, type GeoPoint } from '@dxos/echo-schema';
 import { Input, useTranslation } from '@dxos/react-ui';
 import { safeParseFloat } from '@dxos/util';
 

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

@@ -8,14 +8,15 @@ import { type Meta, type StoryObj } from '@storybook/react-vite';
 import { Schema } from 'effect';
 import React, { useState } from 'react';
 
-import { SelectOptionSchema, type SelectOption } from '@dxos/echo-schema';
+import { type SelectOption, SelectOptionSchema } from '@dxos/echo-schema';
 import { withLayout, withTheme } from '@dxos/storybook-utils';
 
-import { SelectOptionInput } from './SelectOptionsInput';
 import { translations } from '../../../translations';
 import { TestLayout, TestPanel } from '../../testing';
 import { Form } from '../Form';
 
+import { SelectOptionInput } from './SelectOptionsInput';
+
 const schema = Schema.Struct({
   options: Schema.Array(SelectOptionSchema).pipe(Schema.mutable),
 }).pipe(Schema.mutable);