@conform-to/react 0.4.1 → 0.5.0

package/index.js

@@ -16,14 +16,30 @@ Object.defineProperty(exports, 'hasError', {
 	enumerable: true,
 	get: function () { return dom.hasError; }
 });
+Object.defineProperty(exports, 'list', {
+	enumerable: true,
+	get: function () { return dom.list; }
+});
 Object.defineProperty(exports, 'parse', {
 	enumerable: true,
 	get: function () { return dom.parse; }
 });
+Object.defineProperty(exports, 'requestCommand', {
+	enumerable: true,
+	get: function () { return dom.requestCommand; }
+});
+Object.defineProperty(exports, 'requestSubmit', {
+	enumerable: true,
+	get: function () { return dom.requestSubmit; }
+});
 Object.defineProperty(exports, 'shouldValidate', {
 	enumerable: true,
 	get: function () { return dom.shouldValidate; }
 });
+Object.defineProperty(exports, 'validate', {
+	enumerable: true,
+	get: function () { return dom.validate; }
+});
 exports.useControlledInput = hooks.useControlledInput;
 exports.useFieldList = hooks.useFieldList;
 exports.useFieldset = hooks.useFieldset;

package/module/helpers.js

@@ -1,11 +1,9 @@
 function input(config) {
-  var {
-    type,
-    value
-  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var isCheckboxOrRadio = type === 'checkbox' || type === 'radio';
+  var _config$initialError;
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var attributes = {
-    type,
+    id: config.id,
+    type: options.type,
     name: config.name,
     form: config.form,
     required: config.required,
@@ -15,27 +13,33 @@ function input(config) {
     max: config.max,
     step: config.step,
     pattern: config.pattern,
-    multiple: config.multiple
+    multiple: config.multiple,
+    'aria-invalid': Boolean((_config$initialError = config.initialError) === null || _config$initialError === void 0 ? void 0 : _config$initialError.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;
   }
-  if (isCheckboxOrRadio) {
-    attributes.value = value !== null && value !== void 0 ? value : 'on';
+  if (options.type === 'checkbox' || options.type === 'radio') {
+    var _options$value;
+    attributes.value = (_options$value = options.value) !== null && _options$value !== void 0 ? _options$value : 'on';
     attributes.defaultChecked = config.defaultValue === attributes.value;
-  } else {
+  } else if (options.type !== 'file') {
     attributes.defaultValue = config.defaultValue;
   }
   return attributes;
 }
 function select(config) {
-  var _config$defaultValue;
+  var _config$defaultValue, _config$initialError2;
   var attributes = {
+    id: config.id,
     name: config.name,
     form: config.form,
     defaultValue: config.multiple ? Array.isArray(config.defaultValue) ? config.defaultValue : [] : "".concat((_config$defaultValue = config.defaultValue) !== null && _config$defaultValue !== void 0 ? _config$defaultValue : ''),
     required: config.required,
-    multiple: config.multiple
+    multiple: config.multiple,
+    'aria-invalid': Boolean((_config$initialError2 = config.initialError) === null || _config$initialError2 === void 0 ? void 0 : _config$initialError2.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;
@@ -43,15 +47,18 @@ function select(config) {
   return attributes;
 }
 function textarea(config) {
-  var _config$defaultValue2;
+  var _config$defaultValue2, _config$initialError3;
   var attributes = {
+    id: config.id,
     name: config.name,
     form: config.form,
     defaultValue: "".concat((_config$defaultValue2 = config.defaultValue) !== null && _config$defaultValue2 !== void 0 ? _config$defaultValue2 : ''),
     required: config.required,
     minLength: config.minLength,
     maxLength: config.maxLength,
-    autoFocus: Boolean(config.initialError)
+    autoFocus: Boolean(config.initialError),
+    'aria-invalid': Boolean((_config$initialError3 = config.initialError) === null || _config$initialError3 === void 0 ? void 0 : _config$initialError3.length),
+    'aria-describedby': config.errorId
   };
   if (config.initialError && config.initialError.length > 0) {
     attributes.autoFocus = true;

package/module/hooks.js

@@ -1,5 +1,5 @@
 import { objectSpread2 as _objectSpread2 } from './_virtual/_rollupPluginBabelHelpers.js';
-import { getSubmissionType, setFormError, focusFirstInvalidField, requestSubmit, isFieldElement, getFormData, parse, hasError, getPaths, getName, requestValidate, getFormElement, parseListCommand, updateList } from '@conform-to/dom';
+import { shouldValidate, reportSubmission, getFormData, parse, isFieldElement, hasError, getPaths, getName, requestCommand, validate, getFormElement, parseListCommand, updateList } from '@conform-to/dom';
 import { useRef, useState, useEffect } from 'react';
 import { input } from './helpers.js';
 
@@ -7,7 +7,7 @@ import { input } from './helpers.js';
  * Returns properties required to hook into form events.
  * Applied custom validation and define when error should be reported.
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#useform
+ * @see https://conform.guide/api/react#useform
  */
 function useForm() {
   var config = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -21,17 +21,26 @@ function useForm() {
     })) !== null && _config$state$error$f !== void 0 ? _config$state$error$f : [];
     return message !== null && message !== void 0 ? message : '';
   });
-  var [fieldsetConfig, setFieldsetConfig] = useState(() => {
-    var _config$state$error2, _config$state2, _config$state$value, _config$state3;
-    var error = (_config$state$error2 = (_config$state2 = config.state) === null || _config$state2 === void 0 ? void 0 : _config$state2.error) !== null && _config$state$error2 !== void 0 ? _config$state$error2 : [];
+  var [uncontrolledState, setUncontrolledState] = useState(() => {
+    var submission = config.state;
+    if (!submission) {
+      return {
+        defaultValue: config.defaultValue
+      };
+    }
     return {
-      defaultValue: (_config$state$value = (_config$state3 = config.state) === null || _config$state3 === void 0 ? void 0 : _config$state3.value) !== null && _config$state$value !== void 0 ? _config$state$value : config.defaultValue,
-      initialError: error.filter(_ref2 => {
+      defaultValue: submission.value,
+      initialError: submission.error.filter(_ref2 => {
         var [name] = _ref2;
-        return name !== '' && getSubmissionType(name) === null;
+        return name !== '' && shouldValidate(submission, name);
       })
     };
   });
+  var fieldsetConfig = _objectSpread2(_objectSpread2({}, uncontrolledState), {}, {
+    constraint: config.constraint,
+    form: config.id
+  });
+  var fieldset = useFieldset(ref, fieldsetConfig);
   var [noValidate, setNoValidate] = useState(config.noValidate || !config.fallbackNative);
   useEffect(() => {
     configRef.current = config;
@@ -44,11 +53,7 @@ function useForm() {
     if (!form || !config.state) {
       return;
     }
-    setFormError(form, config.state);
-    if (!form.reportValidity()) {
-      focusFirstInvalidField(form);
-    }
-    requestSubmit(form);
+    reportSubmission(form, config.state);
   }, [config.state]);
   useEffect(() => {
     // Revalidate the form when input value is changed
@@ -59,11 +64,8 @@ function useForm() {
       if (!form || !isFieldElement(field) || field.form !== form) {
         return;
       }
-      if (formConfig.initialReport === 'onChange') {
-        field.dataset.conformTouched = 'true';
-      }
-      if (field.dataset.conformTouched) {
-        requestValidate(form, field.name);
+      if (field.dataset.conformTouched || formConfig.initialReport === 'onChange') {
+        requestCommand(form, validate(field.name));
       }
     };
     var handleBlur = event => {
@@ -74,14 +76,13 @@ function useForm() {
         return;
       }
       if (formConfig.initialReport === 'onBlur' && !field.dataset.conformTouched) {
-        field.dataset.conformTouched = 'true';
-        requestValidate(form, field.name);
+        requestCommand(form, validate(field.name));
       }
     };
     var handleInvalid = event => {
       var form = getFormElement(ref.current);
       var field = event.target;
-      if (!form || !isFieldElement(field) || field.form !== form || field.name !== '') {
+      if (!form || !isFieldElement(field) || field.form !== form || field.name !== '__form__') {
         return;
       }
       event.preventDefault();
@@ -100,11 +101,12 @@ function useForm() {
       for (var field of form.elements) {
         if (isFieldElement(field)) {
           delete field.dataset.conformTouched;
+          field.setAttribute('aria-invalid', 'false');
           field.setCustomValidity('');
         }
       }
       setError('');
-      setFieldsetConfig({
+      setUncontrolledState({
         defaultValue: formConfig.defaultValue,
         initialError: []
       });
@@ -127,22 +129,18 @@ function useForm() {
       document.removeEventListener('reset', handleReset);
     };
   }, []);
-  return {
+  var form = {
+    id: config.id,
     ref,
     error,
     props: {
       ref,
+      id: config.id,
       noValidate,
       onSubmit(event) {
         var form = event.currentTarget;
         var nativeEvent = event.nativeEvent;
         var submitter = nativeEvent.submitter;
-        for (var element of form.elements) {
-          if (isFieldElement(element) && element.name === '' && element.willValidate) {
-            setError(element.validationMessage);
-            break;
-          }
-        }
 
         /**
          * It checks defaultPrevented to confirm if the submission is intentional
@@ -150,8 +148,7 @@ function useForm() {
          * event is captured and revalidate the form with new fields without triggering
          * a form submission at the same time.
          */
-        if (!submitter || event.defaultPrevented) {
-          event.preventDefault();
+        if (event.defaultPrevented) {
           return;
         }
         try {
@@ -172,29 +169,15 @@ function useForm() {
                *
                * This is mainly used to showcase the constraint validation API.
                */
-              setFormError(form, {
-                type: 'submit',
-                value: {},
-                error: []
-              });
-              for (var _element of form.elements) {
-                if (isFieldElement(_element) && _element.willValidate) {
-                  submission.error.push([_element.name, _element.validationMessage]);
+              for (var element of form.elements) {
+                if (isFieldElement(element) && element.willValidate) {
+                  element.setCustomValidity('');
+                  submission.error.push([element.name, element.validationMessage]);
                 }
               }
             }
           }
-
-          // Touch all fields only if the submitter is not a command button
-          if (submission.type === 'submit') {
-            for (var field of form.elements) {
-              if (isFieldElement(field)) {
-                // Mark the field as touched
-                field.dataset.conformTouched = 'true';
-              }
-            }
-          }
-          if (!config.noValidate && !submitter.formNoValidate && hasError(submission.error) || submission.type === 'validate' && config.mode !== 'server-validation') {
+          if (!config.noValidate && !(submitter !== null && submitter !== void 0 && submitter.formNoValidate) && hasError(submission.error) || submission.type === 'validate' && config.mode !== 'server-validation') {
             event.preventDefault();
           } else {
             var _config$onSubmit;
@@ -204,10 +187,7 @@ function useForm() {
             });
           }
           if (event.defaultPrevented) {
-            setFormError(form, submission);
-            if (!form.reportValidity()) {
-              focusFirstInvalidField(form);
-            }
+            reportSubmission(form, submission);
           }
         } catch (e) {
           console.warn(e);
@@ -216,6 +196,7 @@ function useForm() {
     },
     config: fieldsetConfig
   };
+  return [form, fieldset];
 }
 
 /**
@@ -276,6 +257,10 @@ function useFieldset(ref, config) {
       // Update the error only if the field belongs to the fieldset
       if (typeof key === 'string' && paths.length === 0) {
         if (field.dataset.conformTouched) {
+          // Update the aria attribute only if it is set
+          if (field.getAttribute('aria-invalid')) {
+            field.setAttribute('aria-invalid', field.validationMessage !== '' ? 'true' : 'false');
+          }
           setError(prev => {
             var _prev$key;
             var prevMessage = (_prev$key = prev === null || prev === void 0 ? void 0 : prev[key]) !== null && _prev$key !== void 0 ? _prev$key : '';
@@ -290,38 +275,6 @@ function useFieldset(ref, config) {
         event.preventDefault();
       }
     };
-    var submitHandler = event => {
-      var form = getFormElement(ref.current);
-      if (!form || event.target !== form) {
-        return;
-      }
-
-      /**
-       * Reset the error state of each field if its validity is changed.
-       *
-       * This is a workaround as no official way is provided to notify
-       * when the validity of the field is changed from `invalid` to `valid`.
-       */
-      setError(prev => {
-        var _configRef$current$na2;
-        var next = prev;
-        var fieldsetName = (_configRef$current$na2 = configRef.current.name) !== null && _configRef$current$na2 !== void 0 ? _configRef$current$na2 : '';
-        for (var field of form.elements) {
-          if (isFieldElement(field) && field.name.startsWith(fieldsetName)) {
-            var _next$key, _next;
-            var key = fieldsetName ? field.name.slice(fieldsetName.length + 1) : field.name;
-            var prevMessage = (_next$key = (_next = next) === null || _next === void 0 ? void 0 : _next[key]) !== null && _next$key !== void 0 ? _next$key : '';
-            var nextMessage = field.validationMessage;
-            if (prevMessage !== '' && nextMessage === '') {
-              next = _objectSpread2(_objectSpread2({}, next), {}, {
-                [key]: ''
-              });
-            }
-          }
-        }
-        return next;
-      });
-    };
     var resetHandler = event => {
       var _fieldsetConfig$defau;
       var form = getFormElement(ref.current);
@@ -339,11 +292,9 @@ function useFieldset(ref, config) {
 
     // The invalid event does not bubble and so listening on the capturing pharse is needed
     document.addEventListener('invalid', invalidHandler, true);
-    document.addEventListener('submit', submitHandler);
     document.addEventListener('reset', resetHandler);
     return () => {
       document.removeEventListener('invalid', invalidHandler, true);
-      document.removeEventListener('submit', submitHandler);
       document.removeEventListener('reset', resetHandler);
     };
   }, [ref]);
@@ -364,21 +315,26 @@ function useFieldset(ref, config) {
       var field = {
         config: _objectSpread2({
           name: fieldsetConfig.name ? "".concat(fieldsetConfig.name, ".").concat(key) : key,
-          form: fieldsetConfig.form,
           defaultValue: uncontrolledState.defaultValue[key],
           initialError: uncontrolledState.initialError[key]
         }, constraint),
         error: (_error$key = error === null || error === void 0 ? void 0 : error[key]) !== null && _error$key !== void 0 ? _error$key : ''
       };
+      if (fieldsetConfig.form) {
+        field.config.form = fieldsetConfig.form;
+        field.config.id = "".concat(fieldsetConfig.form, "-").concat(field.config.name);
+        field.config.errorId = "".concat(field.config.id, "-error");
+      }
       return field;
     }
   });
 }
+
 /**
  * Returns a list of key and config, with a group of helpers
  * configuring buttons for list manipulation
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#usefieldlist
+ * @see https://conform.guide/api/react#usefieldlist
  */
 function useFieldList(ref, config) {
   var configRef = useRef(config);
@@ -404,48 +360,40 @@ function useFieldList(ref, config) {
       initialError
     };
   });
+  var [error, setError] = useState(() => uncontrolledState.initialError.map(error => error === null || error === void 0 ? void 0 : error[0][1]));
   var [entries, setEntries] = useState(() => {
     var _config$defaultValue3;
     return Object.entries((_config$defaultValue3 = config.defaultValue) !== null && _config$defaultValue3 !== void 0 ? _config$defaultValue3 : [undefined]);
   });
-  var list = entries.map((_ref3, index) => {
-    var [key, defaultValue] = _ref3;
-    return {
-      key,
-      config: {
-        name: "".concat(config.name, "[").concat(index, "]"),
-        form: config.form,
-        defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : uncontrolledState.defaultValue[index],
-        initialError: uncontrolledState.initialError[index]
-      }
-    };
-  });
-
-  /***
-   * This use proxy to capture all information about the command and
-   * have it encoded in the value.
-   */
-  var command = new Proxy({}, {
-    get(_target, type) {
-      return function () {
-        var payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-        return {
-          name: 'conform/list',
-          value: JSON.stringify({
-            type,
-            scope: config.name,
-            payload
-          }),
-          form: config.form,
-          formNoValidate: true
-        };
-      };
-    }
-  });
   useEffect(() => {
     configRef.current = config;
   });
   useEffect(() => {
+    var invalidHandler = event => {
+      var _configRef$current$na2;
+      var form = getFormElement(ref.current);
+      var field = event.target;
+      var prefix = (_configRef$current$na2 = configRef.current.name) !== null && _configRef$current$na2 !== void 0 ? _configRef$current$na2 : '';
+      if (!form || !isFieldElement(field) || field.form !== form || !field.name.startsWith(prefix)) {
+        return;
+      }
+      var [index, ...paths] = getPaths(prefix.length > 0 ? field.name.slice(prefix.length) : field.name);
+
+      // Update the error only if the field belongs to the fieldset
+      if (typeof index === 'number' && paths.length === 0) {
+        if (field.dataset.conformTouched) {
+          setError(prev => {
+            var _prev$index;
+            var prevMessage = (_prev$index = prev === null || prev === void 0 ? void 0 : prev[index]) !== null && _prev$index !== void 0 ? _prev$index : '';
+            if (prevMessage === field.validationMessage) {
+              return prev;
+            }
+            return [...prev.slice(0, index), field.validationMessage, ...prev.slice(index + 1)];
+          });
+        }
+        event.preventDefault();
+      }
+    };
     var submitHandler = event => {
       var form = getFormElement(ref.current);
       if (!form || event.target !== form || !(event.submitter instanceof HTMLButtonElement) || event.submitter.name !== 'conform/list') {
@@ -472,6 +420,22 @@ function useFieldList(ref, config) {
             }
         }
       });
+      setError(error => {
+        switch (command.type) {
+          case 'append':
+          case 'prepend':
+          case 'replace':
+            return updateList([...error], _objectSpread2(_objectSpread2({}, command), {}, {
+              payload: _objectSpread2(_objectSpread2({}, command.payload), {}, {
+                defaultValue: undefined
+              })
+            }));
+          default:
+            {
+              return updateList([...error], command);
+            }
+        }
+      });
       event.preventDefault();
     };
     var resetHandler = event => {
@@ -486,24 +450,42 @@ function useFieldList(ref, config) {
         initialError: []
       });
       setEntries(Object.entries((_fieldConfig$defaultV2 = fieldConfig.defaultValue) !== null && _fieldConfig$defaultV2 !== void 0 ? _fieldConfig$defaultV2 : [undefined]));
+      setError([]);
     };
     document.addEventListener('submit', submitHandler, true);
+    document.addEventListener('invalid', invalidHandler, true);
     document.addEventListener('reset', resetHandler);
     return () => {
       document.removeEventListener('submit', submitHandler, true);
+      document.removeEventListener('invalid', invalidHandler, true);
       document.removeEventListener('reset', resetHandler);
     };
   }, [ref]);
-  return [list,
-  // @ts-expect-error proxy type
-  command];
+  return entries.map((_ref3, index) => {
+    var [key, defaultValue] = _ref3;
+    var fieldConfig = {
+      name: "".concat(config.name, "[").concat(index, "]"),
+      defaultValue: defaultValue !== null && defaultValue !== void 0 ? defaultValue : uncontrolledState.defaultValue[index],
+      initialError: uncontrolledState.initialError[index]
+    };
+    if (config.form) {
+      fieldConfig.form = config.form;
+      fieldConfig.id = "".concat(config.form, "-").concat(config.name);
+      fieldConfig.errorId = "".concat(fieldConfig.id, "-error");
+    }
+    return {
+      key,
+      error: error[index],
+      config: fieldConfig
+    };
+  });
 }
 /**
  * Returns the properties required to configure a shadow input for validation.
  * This is particular useful when integrating dropdown and datepicker whichs
  * introduces custom input mode.
  *
- * @see https://github.com/edmundhung/conform/tree/v0.4.1/packages/conform-react/README.md#usecontrolledinput
+ * @see https://conform.guide/api/react#usecontrolledinput
  */
 function useControlledInput(config) {
   var _config$defaultValue4;

package/module/index.js

@@ -1,4 +1,4 @@
-export { getFormElements, hasError, parse, shouldValidate } from '@conform-to/dom';
+export { getFormElements, hasError, list, parse, requestCommand, requestSubmit, shouldValidate, validate } from '@conform-to/dom';
 export { useControlledInput, useFieldList, useFieldset, useForm } from './hooks.js';
 import * as helpers from './helpers.js';
 export { helpers as conform };

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@conform-to/react",
 	"description": "Conform view adapter for react",
 	"license": "MIT",
-	"version": "0.4.1",
+	"version": "0.5.0",
 	"main": "index.js",
 	"module": "module/index.js",
 	"repository": {
@@ -19,7 +19,7 @@
 		"url": "https://github.com/edmundhung/conform/issues"
 	},
 	"dependencies": {
-		"@conform-to/dom": "0.4.1"
+		"@conform-to/dom": "0.5.0"
 	},
 	"peerDependencies": {
 		"react": ">=16.8"