@dxos/react-ui-form 0.7.4 → 0.7.5-main.499c70c

package/src/components/ViewEditor/ViewEditor.stories.tsx

@@ -5,11 +5,12 @@
 import '@dxos-theme';
 
 import { type Meta, type StoryObj } from '@storybook/react';
-import React, { useCallback, useEffect, useState } from 'react';
+import React, { useCallback, useState } from 'react';
 
-import { Format, type MutableSchema, S, toJsonSchema, TypedObject } from '@dxos/echo-schema';
+import { Format, type EchoSchema, S, toJsonSchema, TypedObject } from '@dxos/echo-schema';
 import { useSpace } from '@dxos/react-client/echo';
 import { withClientProvider } from '@dxos/react-client/testing';
+import { useAsyncEffect } from '@dxos/react-ui';
 import { type ViewType, ViewProjection, createView } from '@dxos/schema';
 import { withTheme, withLayout } from '@dxos/storybook-utils';
 
@@ -19,10 +20,10 @@ import { TestLayout, TestPanel } from '../testing';
 
 const DefaultStory = () => {
   const space = useSpace();
-  const [schema, setSchema] = useState<MutableSchema>();
+  const [schema, setSchema] = useState<EchoSchema>();
   const [view, setView] = useState<ViewType>();
   const [projection, setProjection] = useState<ViewProjection>();
-  useEffect(() => {
+  useAsyncEffect(async () => {
     if (space) {
       class TestSchema extends TypedObject({ typename: 'example.com/type/Test', version: '0.1.0' })({
         name: S.String,
@@ -30,7 +31,7 @@ const DefaultStory = () => {
         salary: Format.Currency(),
       }) {}
 
-      const schema = space.db.schemaRegistry.addSchema(TestSchema);
+      const [schema] = await space.db.schemaRegistry.register([TestSchema]);
       const view = createView({ name: 'Test', typename: schema.typename, jsonSchema: toJsonSchema(TestSchema) });
       const projection = new ViewProjection(schema, view);
 

package/src/components/ViewEditor/ViewEditor.tsx

@@ -4,8 +4,8 @@
 
 import React, { useCallback, useMemo, useState } from 'react';
 
-import { type SchemaResolver } from '@dxos/echo-db';
-import { AST, Format, type MutableSchema, S } from '@dxos/echo-schema';
+import { type SchemaRegistry } from '@dxos/echo-db';
+import { AST, Format, type EchoSchema, S } from '@dxos/echo-schema';
 import { IconButton, type ThemedClassName, useTranslation } from '@dxos/react-ui';
 import { List } from '@dxos/react-ui-list';
 import { ghostHover, inputTextLabel, mx } from '@dxos/react-ui-theme';
@@ -30,9 +30,9 @@ const ViewMetaSchema = S.Struct({
 type ViewMetaType = S.Schema.Type<typeof ViewMetaSchema>;
 
 export type ViewEditorProps = ThemedClassName<{
-  schema: MutableSchema;
+  schema: EchoSchema;
   view: ViewType;
-  registry?: SchemaResolver;
+  registry?: SchemaRegistry;
   readonly?: boolean;
   showHeading?: boolean;
   onDelete: (fieldId: string) => void;

package/src/hooks/useForm.ts

@@ -4,16 +4,13 @@
 
 import { type FocusEvent, useCallback, useEffect, useMemo, useState } from 'react';
 
-import { type BaseObject, type PropertyKey } from '@dxos/echo-schema';
-import { type SimpleType, type S } from '@dxos/effect';
+import { type BaseObject, type PropertyKey, getValue, setValue } from '@dxos/echo-schema';
+import { type SimpleType, type S, type JsonPath } from '@dxos/effect';
 import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 import { validateSchema, type ValidationError } from '@dxos/schema';
 import { type MaybePromise } from '@dxos/util';
 
-// TODO(ZaymonFC): Where should this live?
-export type FormPath<T extends object = {}> = PropertyKey<T> | `${PropertyKey<T>}.${number}`;
-
 /**
  * Return type from `useForm` hook.
  */
@@ -22,10 +19,10 @@ export type FormHandler<T extends BaseObject> = {
   // Form state management.
   //
 
-  values: T;
-  errors: Record<FormPath<T>, string>;
-  touched: Record<FormPath<T>, boolean>;
-  changed: Record<FormPath<T>, boolean>;
+  values: Partial<T>;
+  errors: Record<PropertyKey<T>, string>;
+  touched: Record<PropertyKey<T>, boolean>;
+  changed: Record<PropertyKey<T>, boolean>;
   canSave: boolean;
   handleSave: () => void;
 
@@ -33,9 +30,9 @@ export type FormHandler<T extends BaseObject> = {
   // Form input component helpers.
   //
 
-  getStatus: (property: FormPath<T>) => { status?: 'error'; error?: string };
-  getValue: <V>(property: FormPath<T>) => V;
-  onValueChange: <V>(property: FormPath<T>, type: SimpleType, value: V) => void;
+  getStatus: (property: PropertyKey<T>) => { status?: 'error'; error?: string };
+  getValue: <V>(property: PropertyKey<T>) => V | undefined;
+  onValueChange: <V>(property: PropertyKey<T>, type: SimpleType, value: V) => void;
   onBlur: (event: FocusEvent<HTMLInputElement | HTMLTextAreaElement>) => void;
 };
 
@@ -52,15 +49,14 @@ export interface FormOptions<T extends BaseObject> {
   /**
    * Initial values (which may not pass validation).
    */
-  // TODO(burdon): Should be partial?
-  initialValues: T;
+  initialValues: Partial<T>;
 
   /**
    * Callback for value changes. Note: This is called even when values are invalid.
    * Sometimes the parent component may want to know about changes even if the form is
    * in an invalid state.
    */
-  onValuesChanged?: (values: T) => void;
+  onValuesChanged?: (values: Partial<T>) => void;
 
   /**
    * Custom validation function that runs only after schema validation passes.
@@ -93,14 +89,14 @@ export const useForm = <T extends BaseObject>({
   onValid,
   onSave,
 }: FormOptions<T>): FormHandler<T> => {
-  const [values, setValues] = useState<T>(initialValues);
+  const [values, setValues] = useState<Partial<T>>(initialValues);
   useEffect(() => {
     setValues(initialValues);
   }, [initialValues]);
 
-  const [touched, setTouched] = useState<Record<FormPath<T>, boolean>>(createKeySet(initialValues, false));
-  const [changed, setChanged] = useState<Record<FormPath<T>, boolean>>(createKeySet(initialValues, false));
-  const [errors, setErrors] = useState<Record<FormPath<T>, string>>({} as Record<FormPath<T>, string>);
+  const [touched, setTouched] = useState<Record<PropertyKey<T>, boolean>>(createKeySet(initialValues, false));
+  const [changed, setChanged] = useState<Record<PropertyKey<T>, boolean>>(createKeySet(initialValues, false));
+  const [errors, setErrors] = useState<Record<PropertyKey<T>, string>>({} as Record<PropertyKey<T>, string>);
   const [saving, setSaving] = useState(false);
 
   //
@@ -109,14 +105,16 @@ export const useForm = <T extends BaseObject>({
 
   // TODO(burdon): Validate each property separately.
   const validate = useCallback(
-    (values: T) => {
+    (values: Partial<T>): values is T => {
       let errors: ValidationError[] = validateSchema(schema, values) ?? [];
       if (errors.length === 0 && onValidate) {
-        errors = onValidate(values) ?? [];
+        const validatedValues = values as T;
+        errors = onValidate(validatedValues) ?? [];
       }
 
       setErrors(flatMap(errors));
-      return errors.length === 0;
+      const valid = errors.length === 0;
+      return valid;
     },
     [schema, onValidate],
   );
@@ -138,9 +136,7 @@ export const useForm = <T extends BaseObject>({
   const canSave = useMemo(
     () =>
       !saving &&
-      Object.keys(values).every(
-        (property) => touched[property as PropertyKey<T>] === false || !errors[property as PropertyKey<T>],
-      ),
+      Object.keys(values).every((property) => touched[property as JsonPath] === false || !errors[property as JsonPath]),
     [values, touched, errors, saving],
   );
 
@@ -153,14 +149,14 @@ export const useForm = <T extends BaseObject>({
         setSaving(false);
       }
     }
-  }, [values, validate, onSave]);
+  }, [values, validate, onSave, changed]);
 
   //
   // Fields.
   //
 
   const getStatus = useCallback<FormHandler<T>['getStatus']>(
-    (property: FormPath<T>) => ({
+    (property: PropertyKey<T>) => ({
       status: errors[property] ? 'error' : undefined,
       error: errors[property] ? errors[property] : undefined,
     }),
@@ -168,12 +164,11 @@ export const useForm = <T extends BaseObject>({
   );
 
   // TODO(burdon): Use path to extract hierarchical value.
-  const getValue = <V>(property: FormPath<T>): V => {
-    return getByPath(values, property);
+  const getFormValue = <V>(property: PropertyKey<T>): V | undefined => {
+    return getValue(values, property as any as JsonPath);
   };
 
-  // TODO(burdon): Use path to set hierarchical value.
-  const onValueChange = (property: FormPath<T>, type: SimpleType, value: any) => {
+  const onValueChange = (property: PropertyKey<T>, type: SimpleType, value: any) => {
     let parsedValue = value;
     try {
       if (type === 'number') {
@@ -184,7 +179,7 @@ export const useForm = <T extends BaseObject>({
       parsedValue = undefined;
     }
 
-    const newValues = setByPath(values, property, parsedValue);
+    const newValues = { ...setValue(values, property as any as JsonPath, parsedValue) };
     setValues(newValues);
     setChanged((prev) => ({ ...prev, [property]: true }));
     onValuesChanged?.(newValues);
@@ -224,40 +219,25 @@ export const useForm = <T extends BaseObject>({
 
     // Field utils.
     getStatus,
-    getValue,
+    getValue: getFormValue,
     onValueChange,
     onBlur,
   } satisfies FormHandler<T>;
 };
 
-const createKeySet = <T extends BaseObject, V>(obj: T, value: V): Record<FormPath<T>, V> => {
+const createKeySet = <T extends BaseObject, V>(obj: T, value: V): Record<PropertyKey<T>, V> => {
   invariant(obj);
-  return Object.keys(obj).reduce((acc, key) => ({ ...acc, [key]: value }), {} as Record<FormPath<T>, V>);
+  return Object.keys(obj).reduce((acc, key) => ({ ...acc, [key]: value }), {} as Record<PropertyKey<T>, V>);
 };
 
 const flatMap = <T extends BaseObject>(errors: ValidationError[]) => {
   return errors.reduce(
     (result, { path, message }) => {
       if (!(path in result)) {
-        result[path as FormPath<T>] = message;
+        result[path as PropertyKey<T>] = message;
       }
       return result;
     },
-    {} as Record<FormPath<T>, string>,
+    {} as Record<PropertyKey<T>, string>,
   );
 };
-
-// TODO(ZaymonFC): Move to util?
-const getByPath = <T extends object, V>(obj: T, path: FormPath<T>): V => {
-  const [key, index] = path.split('.');
-  return index === undefined ? (obj[key as keyof T] as V) : ((obj[key as keyof T] as any[])[parseInt(index)] as V);
-};
-
-const setByPath = <T extends object>(obj: T, path: FormPath<T>, value: any): T => {
-  const [key, index] = path.split('.');
-  const newValue =
-    index === undefined
-      ? value
-      : [...(obj[key as keyof T] as any[])].map((v, i) => (i === parseInt(index) ? value : v));
-  return { ...obj, [key]: newValue };
-};

package/dist/types/src/components/Form/Custom.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Custom.d.ts","sourceRoot":"","sources":["../../../../../src/components/Form/Custom.tsx"],"names":[],"mappings":"AAIA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,KAAK,UAAU,EAAiB,MAAM,mBAAmB,CAAC;AAGnE,OAAO,EAAe,KAAK,UAAU,EAAE,MAAM,SAAS,CAAC;AAOvD,eAAO,MAAM,aAAa,GAAI,CAAC,SAAS,UAAU,oFAS/C,UAAU,CAAC,CAAC,CAAC,sBA8Bf,CAAC"}