@conform-to/dom 1.0.0-pre.6 → 1.0.0-rc.0

package/submission.js

@@ -9,20 +9,20 @@ var util = require('./util.js');
 /**
  * The name to be used when submitting a form control
  */
-var CONTROL = '__control__';
+var INTENT = '__intent__';
 
 /**
  * The name to be used when submitting a state
  */
 var STATE = '__state__';
 function getSubmissionContext(body) {
-  var control = body.get(CONTROL);
+  var intent = body.get(INTENT);
   var state = body.get(STATE);
   var payload = {};
   var fields = [];
-  util.invariant((typeof control === 'string' || control === null) && (typeof state === 'string' || state === null), "The input name \"".concat(CONTROL, "\" and \"").concat(STATE, "\" are reserved by Conform. Please use another name for your input."));
+  util.invariant((typeof intent === 'string' || intent === null) && (typeof state === 'string' || state === null), "The input name \"".concat(INTENT, "\" and \"").concat(STATE, "\" are reserved by Conform. Please use another name for your input."));
   var _loop = function _loop(next) {
-    if (name === CONTROL || name === STATE) {
+    if (name === INTENT || name === STATE) {
       return 1; // continue
     }
     fields.push(name);
@@ -41,7 +41,7 @@ function getSubmissionContext(body) {
   }
   return {
     payload,
-    control: getControl(control),
+    intent: getIntent(intent),
     state: state ? JSON.parse(state) : {
       validated: {}
     },
@@ -50,68 +50,64 @@ function getSubmissionContext(body) {
 }
 function parse(payload, options) {
   var context = getSubmissionContext(payload);
-  var control = context.control;
-  if (control) {
-    switch (control.type) {
+  var intent = context.intent;
+  if (intent) {
+    switch (intent.type) {
       case 'validate':
-        if (control.payload.name) {
-          context.state.validated[control.payload.name] = true;
+        if (intent.payload.name) {
+          context.state.validated[intent.payload.name] = true;
         }
         break;
-      case 'replace':
+      case 'update':
         {
           var {
             name,
             value: _value,
             validated
-          } = control.payload;
-          if (name) {
-            formdata.setValue(context.payload, name, () => _value);
-          } else {
-            // @ts-expect-error FIXME - it must be an object if there is no name
-            context.payload = _value;
+          } = intent.payload;
+          if (typeof _value !== 'undefined') {
+            if (name) {
+              formdata.setValue(context.payload, name, () => _value);
+            } else {
+              // @ts-expect-error FIXME - it must be an object if there is no name
+              context.payload = _value;
+            }
           }
-          if (validated) {
-            if (formdata.isPlainObject(_value) || Array.isArray(_value)) {
-              // Clean up previous validated state
+          if (typeof validated !== 'undefined') {
+            // Clean up previous validated state
+            if (name) {
               setState(context.state.validated, name, () => undefined);
-              Object.assign(context.state.validated, formdata.flatten(_value, {
-                resolve() {
-                  return true;
-                },
-                prefix: name
-              }));
+            } else {
+              context.state.validated = {};
             }
-            context.state.validated[name] = true;
-          } else {
-            if (formdata.isPlainObject(_value) || Array.isArray(_value)) {
-              setState(context.state.validated, name, () => undefined);
+            if (validated) {
+              if (formdata.isPlainObject(_value) || Array.isArray(_value)) {
+                Object.assign(context.state.validated, formdata.flatten(_value, {
+                  resolve() {
+                    return true;
+                  },
+                  prefix: name
+                }));
+              }
+              context.state.validated[name !== null && name !== void 0 ? name : ''] = true;
+            } else if (name) {
+              delete context.state.validated[name];
             }
-            delete context.state.validated[name];
           }
           break;
         }
       case 'reset':
         {
           var {
-            name: _name,
-            value: _value2,
-            validated: _validated
-          } = control.payload;
-          if (typeof _value2 === 'undefined' || _value2) {
-            if (_name) {
-              formdata.setValue(context.payload, _name, () => undefined);
-            } else {
-              context.payload = {};
-            }
-          }
-          if (typeof _validated === 'undefined' || _validated) {
-            if (_name) {
-              setState(context.state.validated, _name, () => undefined);
-              delete context.state.validated[_name];
-            } else {
-              context.state.validated = {};
-            }
+            name: _name
+          } = intent.payload;
+          if (_name) {
+            formdata.setValue(context.payload, _name, () => undefined);
+            setState(context.state.validated, _name, () => undefined);
+            delete context.state.validated[_name];
+          } else {
+            context.payload = {};
+            context.state.validated = {};
           }
           break;
         }
@@ -119,17 +115,17 @@ function parse(payload, options) {
       case 'remove':
       case 'reorder':
         {
-          setListValue(context.payload, control);
-          setListState(context.state.validated, control);
-          context.state.validated[control.payload.name] = true;
+          setListValue(context.payload, intent);
+          setListState(context.state.validated, intent);
+          context.state.validated[intent.payload.name] = true;
           break;
         }
     }
   }
-  var result = options.resolve(context.payload, control);
+  var result = options.resolve(context.payload, intent);
   var mergeResolveResult = resolved => {
     var error = typeof resolved.error !== 'undefined' ? resolved.error : {};
-    if (!control || control.type === 'validate' && !control.payload.name) {
+    if (!intent || intent.type === 'validate' && !intent.payload.name) {
       for (var _name2 of [...context.fields, ...Object.keys(error !== null && error !== void 0 ? error : {})]) {
         context.state.validated[_name2] = true;
       }
@@ -145,9 +141,9 @@ function parse(payload, options) {
   return mergeResolveResult(result);
 }
 function createSubmission(context) {
-  if (context.control || !context.value || context.error) {
+  if (context.intent || !context.value || context.error) {
     return {
-      status: !context.control ? 'error' : undefined,
+      status: !context.intent ? 'error' : undefined,
       payload: context.payload,
       error: typeof context.error !== 'undefined' ? context.error : {},
       reply(options) {
@@ -165,13 +161,13 @@ function createSubmission(context) {
   };
 }
 function replySubmission(context) {
-  var _context$control, _context$error, _simplify;
+  var _context$intent, _context$error, _simplify;
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  switch ((_context$control = context.control) === null || _context$control === void 0 ? void 0 : _context$control.type) {
+  switch ((_context$intent = context.intent) === null || _context$intent === void 0 ? void 0 : _context$intent.type) {
     case 'reset':
       {
-        var _context$control$payl;
-        var name = (_context$control$payl = context.control.payload.name) !== null && _context$control$payl !== void 0 ? _context$control$payl : '';
+        var _context$intent$paylo;
+        var name = (_context$intent$paylo = context.intent.payload.name) !== null && _context$intent$paylo !== void 0 ? _context$intent$paylo : '';
         if (name === '') {
           return {
             initialValue: null
@@ -186,8 +182,8 @@ function replySubmission(context) {
   }
   if ('hideFields' in options && options.hideFields) {
     for (var _name3 of options.hideFields) {
-      var _value3 = formdata.getValue(context.payload, _name3);
-      if (typeof _value3 !== 'undefined') {
+      var _value2 = formdata.getValue(context.payload, _name3);
+      if (typeof _value2 !== 'undefined') {
         formdata.setValue(context.payload, _name3, () => undefined);
       }
     }
@@ -204,47 +200,47 @@ function replySubmission(context) {
   }, options.fieldErrors)) : null;
   var error = formdata.simplify(_rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, submissionError), extraError));
   return {
-    status: context.control ? undefined : error ? 'error' : 'success',
-    control: context.control ? context.control : undefined,
+    status: context.intent ? undefined : error ? 'error' : 'success',
+    intent: context.intent ? context.intent : undefined,
     initialValue: (_simplify = formdata.simplify(context.payload)) !== null && _simplify !== void 0 ? _simplify : {},
     error,
     state: context.state
   };
 }
-function getControl(serializedControl) {
-  if (!serializedControl) {
+function getIntent(serializedIntent) {
+  if (!serializedIntent) {
     return null;
   }
-  var control = JSON.parse(serializedControl);
+  var control = JSON.parse(serializedIntent);
   if (typeof control.type !== 'string' || typeof control.payload === 'undefined') {
-    throw new Error('Unknown control');
+    throw new Error('Unknown form control intent');
   }
   return control;
 }
-function serializeControl(control) {
-  return JSON.stringify(control);
+function serializeIntent(intent) {
+  return JSON.stringify(intent);
 }
-function updateList(list, control) {
-  var _control$payload$inde;
+function updateList(list, intent) {
+  var _intent$payload$index;
   util.invariant(Array.isArray(list), "Failed to update list. The value is not an array.");
-  switch (control.type) {
+  switch (intent.type) {
     case 'insert':
-      list.splice((_control$payload$inde = control.payload.index) !== null && _control$payload$inde !== void 0 ? _control$payload$inde : list.length, 0, serialize(control.payload.defaultValue));
+      list.splice((_intent$payload$index = intent.payload.index) !== null && _intent$payload$index !== void 0 ? _intent$payload$index : list.length, 0, serialize(intent.payload.defaultValue));
       break;
     case 'remove':
-      list.splice(control.payload.index, 1);
+      list.splice(intent.payload.index, 1);
       break;
     case 'reorder':
-      list.splice(control.payload.to, 0, ...list.splice(control.payload.from, 1));
+      list.splice(intent.payload.to, 0, ...list.splice(intent.payload.from, 1));
       break;
     default:
-      throw new Error('Unknown list control received');
+      throw new Error('Unknown list intent received');
   }
 }
-function setListValue(data, control) {
-  formdata.setValue(data, control.payload.name, value => {
+function setListValue(data, intent) {
+  formdata.setValue(data, intent.payload.name, value => {
     var list = value !== null && value !== void 0 ? value : [];
-    updateList(list, control);
+    updateList(list, intent);
     return list;
   });
 }
@@ -292,20 +288,20 @@ function setState(state, name, valueFn) {
     prefix: name
   }));
 }
-function setListState(state, control, getDefaultValue) {
-  setState(state, control.payload.name, value => {
+function setListState(state, intent, getDefaultValue) {
+  setState(state, intent.payload.name, value => {
     var list = value !== null && value !== void 0 ? value : [];
-    switch (control.type) {
+    switch (intent.type) {
       case 'insert':
         updateList(list, {
-          type: control.type,
-          payload: _rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, control.payload), {}, {
+          type: intent.type,
+          payload: _rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, intent.payload), {}, {
             defaultValue: getDefaultValue === null || getDefaultValue === void 0 ? void 0 : getDefaultValue()
           })
         });
         break;
       default:
-        updateList(list, control);
+        updateList(list, intent);
         break;
     }
     return list;
@@ -339,28 +335,16 @@ function serialize(defaultValue) {
     return defaultValue !== null && defaultValue !== void 0 ? defaultValue : undefined;
   }
 }
-var control = new Proxy({}, {
-  get(_, type) {
-    return function () {
-      var payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      return {
-        type,
-        payload
-      };
-    };
-  }
-});
 
-exports.CONTROL = CONTROL;
+exports.INTENT = INTENT;
 exports.STATE = STATE;
-exports.control = control;
 exports.createSubmission = createSubmission;
-exports.getControl = getControl;
+exports.getIntent = getIntent;
 exports.getSubmissionContext = getSubmissionContext;
 exports.parse = parse;
 exports.replySubmission = replySubmission;
 exports.serialize = serialize;
-exports.serializeControl = serializeControl;
+exports.serializeIntent = serializeIntent;
 exports.setListState = setListState;
 exports.setListValue = setListValue;
 exports.setState = setState;

package/submission.mjs

@@ -5,20 +5,20 @@ import { invariant } from './util.mjs';
 /**
  * The name to be used when submitting a form control
  */
-var CONTROL = '__control__';
+var INTENT = '__intent__';
 
 /**
  * The name to be used when submitting a state
  */
 var STATE = '__state__';
 function getSubmissionContext(body) {
-  var control = body.get(CONTROL);
+  var intent = body.get(INTENT);
   var state = body.get(STATE);
   var payload = {};
   var fields = [];
-  invariant((typeof control === 'string' || control === null) && (typeof state === 'string' || state === null), "The input name \"".concat(CONTROL, "\" and \"").concat(STATE, "\" are reserved by Conform. Please use another name for your input."));
+  invariant((typeof intent === 'string' || intent === null) && (typeof state === 'string' || state === null), "The input name \"".concat(INTENT, "\" and \"").concat(STATE, "\" are reserved by Conform. Please use another name for your input."));
   var _loop = function _loop(next) {
-    if (name === CONTROL || name === STATE) {
+    if (name === INTENT || name === STATE) {
       return 1; // continue
     }
     fields.push(name);
@@ -37,7 +37,7 @@ function getSubmissionContext(body) {
   }
   return {
     payload,
-    control: getControl(control),
+    intent: getIntent(intent),
     state: state ? JSON.parse(state) : {
       validated: {}
     },
@@ -46,68 +46,64 @@ function getSubmissionContext(body) {
 }
 function parse(payload, options) {
   var context = getSubmissionContext(payload);
-  var control = context.control;
-  if (control) {
-    switch (control.type) {
+  var intent = context.intent;
+  if (intent) {
+    switch (intent.type) {
       case 'validate':
-        if (control.payload.name) {
-          context.state.validated[control.payload.name] = true;
+        if (intent.payload.name) {
+          context.state.validated[intent.payload.name] = true;
         }
         break;
-      case 'replace':
+      case 'update':
         {
           var {
             name,
             value: _value,
             validated
-          } = control.payload;
-          if (name) {
-            setValue(context.payload, name, () => _value);
-          } else {
-            // @ts-expect-error FIXME - it must be an object if there is no name
-            context.payload = _value;
+          } = intent.payload;
+          if (typeof _value !== 'undefined') {
+            if (name) {
+              setValue(context.payload, name, () => _value);
+            } else {
+              // @ts-expect-error FIXME - it must be an object if there is no name
+              context.payload = _value;
+            }
           }
-          if (validated) {
-            if (isPlainObject(_value) || Array.isArray(_value)) {
-              // Clean up previous validated state
+          if (typeof validated !== 'undefined') {
+            // Clean up previous validated state
+            if (name) {
               setState(context.state.validated, name, () => undefined);
-              Object.assign(context.state.validated, flatten(_value, {
-                resolve() {
-                  return true;
-                },
-                prefix: name
-              }));
+            } else {
+              context.state.validated = {};
             }
-            context.state.validated[name] = true;
-          } else {
-            if (isPlainObject(_value) || Array.isArray(_value)) {
-              setState(context.state.validated, name, () => undefined);
+            if (validated) {
+              if (isPlainObject(_value) || Array.isArray(_value)) {
+                Object.assign(context.state.validated, flatten(_value, {
+                  resolve() {
+                    return true;
+                  },
+                  prefix: name
+                }));
+              }
+              context.state.validated[name !== null && name !== void 0 ? name : ''] = true;
+            } else if (name) {
+              delete context.state.validated[name];
             }
-            delete context.state.validated[name];
           }
           break;
         }
       case 'reset':
         {
           var {
-            name: _name,
-            value: _value2,
-            validated: _validated
-          } = control.payload;
-          if (typeof _value2 === 'undefined' || _value2) {
-            if (_name) {
-              setValue(context.payload, _name, () => undefined);
-            } else {
-              context.payload = {};
-            }
-          }
-          if (typeof _validated === 'undefined' || _validated) {
-            if (_name) {
-              setState(context.state.validated, _name, () => undefined);
-              delete context.state.validated[_name];
-            } else {
-              context.state.validated = {};
-            }
+            name: _name
+          } = intent.payload;
+          if (_name) {
+            setValue(context.payload, _name, () => undefined);
+            setState(context.state.validated, _name, () => undefined);
+            delete context.state.validated[_name];
+          } else {
+            context.payload = {};
+            context.state.validated = {};
           }
           break;
         }
@@ -115,17 +111,17 @@ function parse(payload, options) {
       case 'remove':
       case 'reorder':
         {
-          setListValue(context.payload, control);
-          setListState(context.state.validated, control);
-          context.state.validated[control.payload.name] = true;
+          setListValue(context.payload, intent);
+          setListState(context.state.validated, intent);
+          context.state.validated[intent.payload.name] = true;
           break;
         }
     }
   }
-  var result = options.resolve(context.payload, control);
+  var result = options.resolve(context.payload, intent);
   var mergeResolveResult = resolved => {
     var error = typeof resolved.error !== 'undefined' ? resolved.error : {};
-    if (!control || control.type === 'validate' && !control.payload.name) {
+    if (!intent || intent.type === 'validate' && !intent.payload.name) {
       for (var _name2 of [...context.fields, ...Object.keys(error !== null && error !== void 0 ? error : {})]) {
         context.state.validated[_name2] = true;
       }
@@ -141,9 +137,9 @@ function parse(payload, options) {
   return mergeResolveResult(result);
 }
 function createSubmission(context) {
-  if (context.control || !context.value || context.error) {
+  if (context.intent || !context.value || context.error) {
     return {
-      status: !context.control ? 'error' : undefined,
+      status: !context.intent ? 'error' : undefined,
       payload: context.payload,
       error: typeof context.error !== 'undefined' ? context.error : {},
       reply(options) {
@@ -161,13 +157,13 @@ function createSubmission(context) {
   };
 }
 function replySubmission(context) {
-  var _context$control, _context$error, _simplify;
+  var _context$intent, _context$error, _simplify;
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  switch ((_context$control = context.control) === null || _context$control === void 0 ? void 0 : _context$control.type) {
+  switch ((_context$intent = context.intent) === null || _context$intent === void 0 ? void 0 : _context$intent.type) {
     case 'reset':
       {
-        var _context$control$payl;
-        var name = (_context$control$payl = context.control.payload.name) !== null && _context$control$payl !== void 0 ? _context$control$payl : '';
+        var _context$intent$paylo;
+        var name = (_context$intent$paylo = context.intent.payload.name) !== null && _context$intent$paylo !== void 0 ? _context$intent$paylo : '';
         if (name === '') {
           return {
             initialValue: null
@@ -182,8 +178,8 @@ function replySubmission(context) {
   }
   if ('hideFields' in options && options.hideFields) {
     for (var _name3 of options.hideFields) {
-      var _value3 = getValue(context.payload, _name3);
-      if (typeof _value3 !== 'undefined') {
+      var _value2 = getValue(context.payload, _name3);
+      if (typeof _value2 !== 'undefined') {
         setValue(context.payload, _name3, () => undefined);
       }
     }
@@ -200,47 +196,47 @@ function replySubmission(context) {
   }, options.fieldErrors)) : null;
   var error = simplify(_objectSpread2(_objectSpread2({}, submissionError), extraError));
   return {
-    status: context.control ? undefined : error ? 'error' : 'success',
-    control: context.control ? context.control : undefined,
+    status: context.intent ? undefined : error ? 'error' : 'success',
+    intent: context.intent ? context.intent : undefined,
     initialValue: (_simplify = simplify(context.payload)) !== null && _simplify !== void 0 ? _simplify : {},
     error,
     state: context.state
   };
 }
-function getControl(serializedControl) {
-  if (!serializedControl) {
+function getIntent(serializedIntent) {
+  if (!serializedIntent) {
     return null;
   }
-  var control = JSON.parse(serializedControl);
+  var control = JSON.parse(serializedIntent);
   if (typeof control.type !== 'string' || typeof control.payload === 'undefined') {
-    throw new Error('Unknown control');
+    throw new Error('Unknown form control intent');
   }
   return control;
 }
-function serializeControl(control) {
-  return JSON.stringify(control);
+function serializeIntent(intent) {
+  return JSON.stringify(intent);
 }
-function updateList(list, control) {
-  var _control$payload$inde;
+function updateList(list, intent) {
+  var _intent$payload$index;
   invariant(Array.isArray(list), "Failed to update list. The value is not an array.");
-  switch (control.type) {
+  switch (intent.type) {
     case 'insert':
-      list.splice((_control$payload$inde = control.payload.index) !== null && _control$payload$inde !== void 0 ? _control$payload$inde : list.length, 0, serialize(control.payload.defaultValue));
+      list.splice((_intent$payload$index = intent.payload.index) !== null && _intent$payload$index !== void 0 ? _intent$payload$index : list.length, 0, serialize(intent.payload.defaultValue));
       break;
     case 'remove':
-      list.splice(control.payload.index, 1);
+      list.splice(intent.payload.index, 1);
       break;
     case 'reorder':
-      list.splice(control.payload.to, 0, ...list.splice(control.payload.from, 1));
+      list.splice(intent.payload.to, 0, ...list.splice(intent.payload.from, 1));
       break;
     default:
-      throw new Error('Unknown list control received');
+      throw new Error('Unknown list intent received');
   }
 }
-function setListValue(data, control) {
-  setValue(data, control.payload.name, value => {
+function setListValue(data, intent) {
+  setValue(data, intent.payload.name, value => {
     var list = value !== null && value !== void 0 ? value : [];
-    updateList(list, control);
+    updateList(list, intent);
     return list;
   });
 }
@@ -288,20 +284,20 @@ function setState(state, name, valueFn) {
     prefix: name
   }));
 }
-function setListState(state, control, getDefaultValue) {
-  setState(state, control.payload.name, value => {
+function setListState(state, intent, getDefaultValue) {
+  setState(state, intent.payload.name, value => {
     var list = value !== null && value !== void 0 ? value : [];
-    switch (control.type) {
+    switch (intent.type) {
       case 'insert':
         updateList(list, {
-          type: control.type,
-          payload: _objectSpread2(_objectSpread2({}, control.payload), {}, {
+          type: intent.type,
+          payload: _objectSpread2(_objectSpread2({}, intent.payload), {}, {
             defaultValue: getDefaultValue === null || getDefaultValue === void 0 ? void 0 : getDefaultValue()
           })
         });
         break;
       default:
-        updateList(list, control);
+        updateList(list, intent);
         break;
     }
     return list;
@@ -335,16 +331,5 @@ function serialize(defaultValue) {
     return defaultValue !== null && defaultValue !== void 0 ? defaultValue : undefined;
   }
 }
-var control = new Proxy({}, {
-  get(_, type) {
-    return function () {
-      var payload = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      return {
-        type,
-        payload
-      };
-    };
-  }
-});
 
-export { CONTROL, STATE, control, createSubmission, getControl, getSubmissionContext, parse, replySubmission, serialize, serializeControl, setListState, setListValue, setState, updateList };
+export { INTENT, STATE, createSubmission, getIntent, getSubmissionContext, parse, replySubmission, serialize, serializeIntent, setListState, setListValue, setState, updateList };

package/README.md

@@ -1,17 +0,0 @@
-# @conform-to/dom
-
-> This package is a transitive dependency for the rest of the conform packages with no intention to be used directly at the moment. Use at your own risk.
-
-Conform is a progressive enhancement first form validation library for [Remix](https://remix.run)
-
-### Highlights
-
-- Focused on progressive enhancment by default
-- Simplifed intergration through event delegation
-- Server first validation with Zod / Yup schema support
-- Field name inference with type checking
-- Focus management
-- Accessibility support
-- About 5kb compressed
-
-Checkout the [repository](https://github.com/edmundhung/conform) if you want to know more!