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

package/dist/types/src/components/deprecated/FormInput.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FormInput.d.ts","sourceRoot":"","sources":["../../../../../src/components/deprecated/FormInput.tsx"],"names":[],"mappings":"AAIA,OAAc,EAAE,KAAK,GAAG,EAAE,KAAK,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAEhE,OAAO,EAAS,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAG7D;;GAEG;AACH,eAAO,MAAM,uBAAuB,GAAI,0BAA0B,eAAe,CAAC,iBAAiB,CAAC,gBAQnG,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,GAAG,CAAC,OAAO,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB,GAAI,8CAKjC,iBAAiB,CAAC,wBAAwB,CAAC,gBAkC7C,CAAC"}

package/dist/types/src/components/deprecated/index.d.ts

@@ -1,2 +0,0 @@
-export * from './FormInput';
-//# sourceMappingURL=index.d.ts.map

package/dist/types/src/components/deprecated/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/components/deprecated/index.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC"}

package/dist/types/src/hooks/useForm.d.ts

@@ -1,67 +0,0 @@
-import { type Schema } from 'effect';
-import { type BaseObject } from '@dxos/echo-schema';
-import { type SimpleType, type JsonPath } from '@dxos/effect';
-import { type ValidationError } from '@dxos/schema';
-import { type MaybePromise } from '@dxos/util';
-/**
- * Return type from `useForm` hook.
- */
-export type FormHandler<T extends BaseObject> = {
-    values: Partial<T>;
-    errors: Record<JsonPath, string>;
-    touched: Record<JsonPath, boolean>;
-    changed: Record<JsonPath, boolean>;
-    canSave: boolean;
-    formIsValid: boolean;
-    handleSave: () => void;
-    getStatus: (path: string | (string | number)[]) => {
-        status?: 'error';
-        error?: string;
-    };
-    getValue: <V>(path: (string | number)[]) => V | undefined;
-    onValueChange: <V>(path: (string | number)[], type: SimpleType, value: V) => void;
-    onTouched: (path: (string | number)[]) => void;
-};
-/**
- * Hook options.
- */
-export interface FormOptions<T extends BaseObject> {
-    /**
-     * Effect schema (Type literal).
-     */
-    schema: Schema.Schema<T, any>;
-    /**
-     * Initial values (which may not pass validation).
-     */
-    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: Partial<T>) => void;
-    /**
-     * Custom validation function that runs only after schema validation passes.
-     * Use this for complex validation logic that can't be expressed in the schema.
-     * @returns Array of validation errors, or undefined if validation passes
-     */
-    onValidate?: (values: T) => ValidationError[] | undefined;
-    /**
-     * Called when the form is valid.
-     */
-    onValid?: (values: T, meta: {
-        changed: FormHandler<T>['changed'];
-    }) => void;
-    /**
-     * Called when the form is submitted and passes validation.
-     */
-    onSave?: (values: T, meta: {
-        changed: FormHandler<T>['changed'];
-    }) => MaybePromise<void>;
-}
-/**
- * Creates a hook for managing form state, including values, validation, and submission.
- * Deeply integrated with `@dxos/schema` for schema-based validation.
- */
-export declare const useForm: <T extends BaseObject>({ schema, initialValues, onValuesChanged, onValidate, onValid, onSave, }: FormOptions<T>) => FormHandler<T>;
-//# sourceMappingURL=useForm.d.ts.map

package/dist/types/src/hooks/useForm.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useForm.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useForm.ts"],"names":[],"mappings":"AAIA,OAAO,EAAa,KAAK,MAAM,EAAE,MAAM,QAAQ,CAAC;AAGhD,OAAO,EAAE,KAAK,UAAU,EAAsB,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,QAAQ,EAA4C,MAAM,cAAc,CAAC;AAGxG,OAAO,EAAkB,KAAK,eAAe,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,UAAU,IAAI;IAK9C,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACjC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,IAAI,CAAC;IAMvB,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK;QAAE,MAAM,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxF,QAAQ,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,CAAC,GAAG,SAAS,CAAC;IAC1D,aAAa,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,KAAK,IAAI,CAAC;IAClF,SAAS,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC;CAChD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,UAAU;IAC/C;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAE9B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAE1B;;;;OAIG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAE/C;;;;OAIG;IAEH,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,eAAe,EAAE,GAAG,SAAS,CAAC;IAE1D;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE;QAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;KAAE,KAAK,IAAI,CAAC;IAE5E;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE;QAAE,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAA;KAAE,KAAK,YAAY,CAAC,IAAI,CAAC,CAAC;CAC1F;AAED;;;GAGG;AACH,eAAO,MAAM,OAAO,GAAI,CAAC,SAAS,UAAU,EAAE,0EAO3C,WAAW,CAAC,CAAC,CAAC,KAAG,WAAW,CAAC,CAAC,CAoLhC,CAAC"}

package/dist/types/src/hooks/useRefQueryLookupHandler.d.ts

@@ -1,8 +0,0 @@
-import { type Space } from '@dxos/react-client/echo';
-import { type QueryRefOptions } from './useQueryRefOptions';
-type UseRefQueryLookupProps = {
-    space?: Space;
-};
-export declare const useRefQueryLookupHandler: ({ space }: UseRefQueryLookupProps) => QueryRefOptions;
-export {};
-//# sourceMappingURL=useRefQueryLookupHandler.d.ts.map

package/dist/types/src/hooks/useRefQueryLookupHandler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useRefQueryLookupHandler.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useRefQueryLookupHandler.ts"],"names":[],"mappings":"AAOA,OAAO,EAAU,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAE5D,KAAK,sBAAsB,GAAG;IAAE,KAAK,CAAC,EAAE,KAAK,CAAA;CAAE,CAAC;AAEhD,eAAO,MAAM,wBAAwB,GAAI,WAAW,sBAAsB,KAAG,eAwB5E,CAAC"}

package/dist/types/src/util/schema.d.ts

@@ -1,3 +0,0 @@
-import { SchemaAST } from 'effect';
-export declare const findArrayElementType: (ast: SchemaAST.AST) => SchemaAST.AST | undefined;
-//# sourceMappingURL=schema.d.ts.map

package/dist/types/src/util/schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../../src/util/schema.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAInC,eAAO,MAAM,oBAAoB,GAAI,KAAK,SAAS,CAAC,GAAG,8BAKtD,CAAC"}

package/src/components/Form/ArrayField.tsx

@@ -1,124 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-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 { invariant } from '@dxos/invariant';
-import { IconButton, useTranslation } from '@dxos/react-ui';
-import { getSchemaProperties, type SchemaProperty } 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';
-
-type ArrayFieldProps = {
-  property: SchemaProperty<any>;
-  readonly?: boolean;
-  inputProps: FormInputStateProps;
-  path?: (string | number)[];
-  Custom?: Partial<Record<string, InputComponent>>;
-  lookupComponent?: ComponentLookup;
-};
-
-export const ArrayField = ({ property, readonly, path, inputProps, Custom, lookupComponent }: ArrayFieldProps) => {
-  const { t } = useTranslation(translationKey);
-  const { ast, name, type, title } = property;
-  // TODO(wittjosiah): The fallback to an empty array stops the form from crashing but isn't immediately live.
-  //  It doesn't become live until another field is touched, but that's better than the whole form crashing.
-  const values = (useFormValues(path ?? []) ?? []) as any[];
-  invariant(Array.isArray(values), `Values at path ${path?.join('.')} must be an array.`);
-  const label = title ?? pipe(name, capitalize);
-
-  const elementType = findArrayElementType(ast);
-
-  const getDefaultObjectValue = (typeNode: SchemaAST.AST): any => {
-    const baseNode = findNode(typeNode, isDiscriminatedUnion);
-    const typeLiteral = baseNode ? getDiscriminatedType(baseNode, {}) : findNode(typeNode, SchemaAST.isTypeLiteral);
-    if (!typeLiteral) {
-      return {};
-    }
-
-    return Object.fromEntries(getSchemaProperties(typeLiteral, {}).map((prop) => [prop.name, prop.defaultValue]));
-  };
-
-  const getDefaultValue = () =>
-    type === 'object' && elementType ? getDefaultObjectValue(elementType) : SimpleType.getDefaultValue(type);
-
-  const handleAdd = useCallback(() => {
-    inputProps.onValueChange(type, [...values, getDefaultValue()]);
-  }, [type, elementType, inputProps, values]);
-
-  const handleRemove = useCallback(
-    (index: number) => {
-      const newValues = values.filter((_, i) => i !== index);
-      inputProps.onValueChange(type, newValues);
-    },
-    [type, inputProps, values],
-  );
-
-  if (!elementType) {
-    return null;
-  }
-
-  return readonly && values.length < 1 ? null : (
-    <>
-      <InputHeader readonly label={label} />
-      <div
-        role='none'
-        className={
-          readonly
-            ? 'flex flex-wrap gap-1 mlb-1'
-            : values.length > 0
-              ? 'grid gap-1 grid-cols-[1fr_min-content] mlb-1'
-              : 'hidden'
-        }
-      >
-        {values.map((_value, index) => {
-          const field = (
-            <FormField
-              property={{
-                ...property,
-                array: false, // NOTE(ZaymonFC): This breaks arrays of arrays but ¯\_(ツ)_/¯. Ping me if you need that.
-                ast: elementType,
-              }}
-              path={[...(path ?? []), index]}
-              readonly={readonly}
-              inline
-              Custom={Custom}
-              lookupComponent={lookupComponent}
-            />
-          );
-          return readonly ? (
-            field
-          ) : (
-            <Fragment key={index}>
-              <div role='none'>{field}</div>
-              <IconButton
-                icon='ph--trash--regular'
-                iconOnly
-                label={t('button remove')}
-                onClick={() => handleRemove(index)}
-                classNames='self-center'
-              />
-            </Fragment>
-          );
-        })}
-      </div>
-      {!readonly && (
-        <IconButton
-          classNames='is-full mlb-cardSpacingBlock flex'
-          icon='ph--plus--regular'
-          label={t('add field')}
-          onClick={handleAdd}
-        />
-      )}
-    </>
-  );
-};

package/src/components/Form/Defaults.tsx

@@ -1,203 +0,0 @@
-//
-// Copyright 2024 DXOS.org
-//
-
-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';
-
-export const TextInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  getStatus,
-  getValue,
-  onValueChange,
-  onBlur,
-}: InputProps) => {
-  const { status, error } = getStatus();
-
-  return disabled && !getValue() ? null : disabled && inputOnly ? (
-    <p>{getValue() ?? ''}</p>
-  ) : (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{getValue() ?? ''}</p>
-      ) : (
-        <Input.TextInput
-          disabled={disabled}
-          placeholder={placeholder}
-          value={getValue() ?? ''}
-          onChange={(event) => onValueChange(type, event.target.value)}
-          onBlur={onBlur}
-        />
-      )}
-      {inputOnly && <Input.Validation>{error}</Input.Validation>}
-    </Input.Root>
-  );
-};
-
-export const NumberInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  getStatus,
-  getValue,
-  onValueChange,
-  onBlur,
-}: InputProps) => {
-  const { status, error } = getStatus();
-
-  return disabled && !getValue() ? null : disabled && inputOnly ? (
-    <p>{getValue() ?? ''}</p>
-  ) : (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{getValue() ?? ''}</p>
-      ) : (
-        <Input.TextInput
-          type='number'
-          disabled={disabled}
-          placeholder={placeholder}
-          value={getValue() ?? 0}
-          onChange={(event) => onValueChange(type, event.target.value)}
-          onBlur={onBlur}
-        />
-      )}
-      {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
-    </Input.Root>
-  );
-};
-
-export const BooleanInput = ({ type, label, inputOnly, getStatus, getValue, onValueChange, disabled }: InputProps) => {
-  const { status, error } = getStatus();
-  const checked = Boolean(getValue());
-  const { t } = useTranslation(translationKey);
-
-  return (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{t(checked ? 'boolean input true value' : 'boolean input false value')}</p>
-      ) : (
-        <Input.Switch checked={checked} onCheckedChange={(value) => onValueChange(type, value)} />
-      )}
-      {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
-    </Input.Root>
-  );
-};
-
-export type SelectInputOptions = InputProps & {
-  options?: Array<{ value: string | number; label?: string }>;
-};
-
-export const SelectInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  options,
-  getStatus,
-  getValue,
-  onValueChange,
-}: SelectInputOptions) => {
-  const { status, error } = getStatus();
-
-  const value = getValue() as string | undefined;
-  const handleValueChange = useCallback((value: string | number) => onValueChange(type, value), [type, onValueChange]);
-
-  return disabled && !value ? null : (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{options?.find(({ value: optionValue }) => optionValue === value)?.label ?? String(value)}</p>
-      ) : (
-        <Select.Root value={value} onValueChange={handleValueChange}>
-          {/* TODO(burdon): Placeholder not working? */}
-          <Select.TriggerButton classNames='is-full' disabled={disabled} placeholder={placeholder} />
-          <Select.Portal>
-            <Select.Content>
-              <Select.Viewport>
-                {options?.map(({ value, label }) => (
-                  // NOTE: Numeric values are converted to and from strings.
-                  <Select.Option key={String(value)} value={String(value)}>
-                    {label ?? String(value)}
-                  </Select.Option>
-                ))}
-              </Select.Viewport>
-            </Select.Content>
-          </Select.Portal>
-        </Select.Root>
-      )}
-      {inputOnly && <Input.DescriptionAndValidation>{error}</Input.DescriptionAndValidation>}
-    </Input.Root>
-  );
-};
-
-export const MarkdownInput = ({
-  type,
-  label,
-  inputOnly,
-  disabled,
-  placeholder,
-  getStatus,
-  getValue,
-  onValueChange,
-  onBlur,
-}: InputProps) => {
-  const { status, error } = getStatus();
-  const textareaRef = useRef<HTMLTextAreaElement>(null);
-
-  // TODO(ZaymonFC): If we start using `Enter` for form submission, we should prevent default behavior here
-  //  since we're using a textarea element and the user needs to be able to enter new lines.
-
-  const adjustHeight = useCallback(() => {
-    const textarea = textareaRef.current;
-    if (textarea) {
-      textarea.style.blockSize = 'auto'; // For measurement.
-      textarea.style.blockSize = `${textarea.scrollHeight + 2}px`;
-    }
-  }, []);
-
-  // Adjust height on initial render.
-  useEffect(() => {
-    adjustHeight();
-  }, [adjustHeight]);
-
-  // Adjust height when the content changes.
-  useEffect(() => {
-    adjustHeight();
-  }, [getValue(), adjustHeight]);
-
-  return (
-    <Input.Root validationValence={status}>
-      {!inputOnly && <InputHeader error={error} label={label} />}
-      {disabled ? (
-        <p>{getValue() ?? ''}</p>
-      ) : (
-        <Input.TextArea
-          ref={textareaRef}
-          disabled={disabled}
-          placeholder={placeholder}
-          value={getValue() ?? ''}
-          classNames={'min-bs-auto max-h-40 overflow-auto'}
-          onChange={(event) => onValueChange(type, event.target.value)}
-          onBlur={onBlur}
-          style={{ resize: 'none' }}
-          spellCheck={false}
-        />
-      )}
-      {inputOnly && <Input.Validation>{error}</Input.Validation>}
-    </Input.Root>
-  );
-};

package/src/components/Form/FormActions.tsx

@@ -1,53 +0,0 @@
-//
-// Copyright 2025 DXOS.org
-//
-
-import React from 'react';
-
-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';
-
-export type FormOuterSpacing = boolean | 'blockStart-0' | 'scroll-fields';
-
-export type FormActionsProps = {
-  readonly?: boolean;
-  onCancel?: () => void;
-  outerSpacing?: FormOuterSpacing;
-};
-
-export const FormActions = ({ readonly, onCancel, outerSpacing = true }: FormActionsProps) => {
-  const { t } = useTranslation(translationKey);
-  const { canSave, handleSave } = useFormContext();
-
-  return (
-    <div
-      role='none'
-      className={mx(
-        outerSpacing === 'scroll-fields'
-          ? 'pli-cardSpacingInline mbe-cardSpacingBlock'
-          : outerSpacing
-            ? cardSpacing
-            : 'mbs-cardSpacingBlock',
-        'flex [&_button]:grow gap-1 first:mbs-0',
-      )}
-    >
-      {onCancel && !readonly && (
-        <IconButton data-testid='cancel-button' icon='ph--x--regular' label={t('button cancel')} onClick={onCancel} />
-      )}
-      {handleSave && (
-        <IconButton
-          type='submit'
-          data-testid='save-button'
-          disabled={!canSave}
-          icon='ph--check--regular'
-          label={t('button save')}
-          onClick={handleSave}
-        />
-      )}
-    </div>
-  );
-};