@conform-to/react 1.8.2 → 1.9.0

package/dist/future/util.js

@@ -2,146 +2,228 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var dom = require('@conform-to/dom');
+var _rollupPluginBabelHelpers = require('../_virtual/_rollupPluginBabelHelpers.js');
+var future = require('@conform-to/dom/future');
 
-function getFormElement(formRef) {
-  var _element$form;
-  if (typeof formRef === 'string') {
-    return document.forms.namedItem(formRef);
-  }
-  var element = formRef === null || formRef === void 0 ? void 0 : formRef.current;
-  if (element instanceof HTMLFormElement) {
-    return element;
-  }
-  return (_element$form = element === null || element === void 0 ? void 0 : element.form) !== null && _element$form !== void 0 ? _element$form : null;
+var _excluded = [""];
+function isUndefined(value) {
+  return value === undefined;
 }
-function focusable(element) {
-  if (!element.hidden && element.type !== 'hidden') {
-    return;
-  }
-
-  // Style the element to be visually hidden
-  element.style.position = 'absolute';
-  element.style.width = '1px';
-  element.style.height = '1px';
-  element.style.padding = '0';
-  element.style.margin = '-1px';
-  element.style.overflow = 'hidden';
-  element.style.clip = 'rect(0,0,0,0)';
-  element.style.whiteSpace = 'nowrap';
-  element.style.border = '0';
-
-  // Hide the element from screen readers
-  element.setAttribute('aria-hidden', 'true');
-
-  // Make sure people won't tab to this element
-  element.tabIndex = -1;
-
-  // Set the element to be visible again so it can be focused
-  if (element.hidden) {
-    element.hidden = false;
-  }
-  if (element.type === 'hidden') {
-    element.setAttribute('type', 'text');
-  }
+function isString(value) {
+  return typeof value === 'string';
+}
+function isNumber(value) {
+  return typeof value === 'number';
 }
-function initializeField(element, options) {
-  var _options$value;
-  if (element.dataset.conform) {
-    return;
+function isOptional(value, typeGuard) {
+  return isUndefined(value) || typeGuard(value);
+}
+function getArrayAtPath(formValue, name) {
+  var _getValueAtPath;
+  var value = (_getValueAtPath = future.getValueAtPath(formValue, name)) !== null && _getValueAtPath !== void 0 ? _getValueAtPath : [];
+  if (!Array.isArray(value)) {
+    throw new Error("The value of \"".concat(name, "\" is not an array"));
   }
-  var defaultValue = typeof (options === null || options === void 0 ? void 0 : options.value) === 'string' || typeof (options === null || options === void 0 ? void 0 : options.defaultChecked) === 'boolean' ? options.defaultChecked ? (_options$value = options.value) !== null && _options$value !== void 0 ? _options$value : 'on' : null : options === null || options === void 0 ? void 0 : options.defaultValue;
-
-  // Update the value of the element, including the default value
-  dom.unstable_updateField(element, {
-    value: defaultValue,
-    defaultValue
-  });
-  element.dataset.conform = 'initialized';
+  return value;
 }
-function getRadioGroupValue(inputs) {
-  for (var input of inputs) {
-    if (input.type === 'radio' && input.checked) {
-      return input.value;
+
+/**
+ * Immutably updates a value at the specified path.
+ * Empty path replaces the entire object.
+ */
+function updateValueAtPath(data, name, value) {
+  if (name === '') {
+    if (!future.isPlainObject(value)) {
+      throw new Error('The value must be an object');
     }
+    return value;
   }
+  return future.setValueAtPath(data, future.getPathSegments(name), value, {
+    clone: true
+  });
 }
-function getCheckboxGroupValue(inputs) {
-  var values;
-  for (var input of inputs) {
-    if (input.type === 'checkbox') {
-      var _values;
-      (_values = values) !== null && _values !== void 0 ? _values : values = [];
-      if (input.checked) {
-        values.push(input.value);
+
+/**
+ * Creates a function that updates array indices in field paths.
+ * Returns null to remove fields, or updated path with new index.
+ */
+function createPathIndexUpdater(listName, update) {
+  var listPaths = future.getPathSegments(listName);
+  return name => {
+    var paths = future.getPathSegments(name);
+    if (paths.length > listPaths.length && listPaths.every((path, index) => paths[index] === path)) {
+      var currentIndex = paths[listPaths.length];
+      if (typeof currentIndex === 'number') {
+        var newIndex = update(currentIndex);
+        if (newIndex === null) {
+          // To remove the item instead of updating it
+          return null;
+        }
+        if (newIndex !== currentIndex) {
+          // Replace the index
+          paths.splice(listPaths.length, 1, newIndex);
+          return future.formatPathSegments(paths);
+        }
       }
     }
+    return name;
+  };
+}
+
+/**
+ * Returns null if error object has no actual error messages,
+ * otherwise returns the error as-is.
+ */
+function normalizeFormError(error) {
+  if (error && error.formErrors.length === 0 && Object.entries(error.fieldErrors).every(_ref => {
+    var [, messages] = _ref;
+    return Array.isArray(messages) ? messages.length === 0 : !messages;
+  })) {
+    return null;
   }
-  return values;
-}
-function getInputSnapshot(input) {
-  if (input instanceof HTMLInputElement) {
-    switch (input.type) {
-      case 'file':
-        return {
-          files: input.files ? Array.from(input.files) : undefined
-        };
-      case 'radio':
-      case 'checkbox':
-        return {
-          value: input.value,
-          checked: input.checked
-        };
-    }
-  } else if (input instanceof HTMLSelectElement && input.multiple) {
+  return error;
+}
+function normalizeValidateResult(result) {
+  if (result !== null && 'error' in result) {
     return {
-      options: Array.from(input.selectedOptions).map(option => option.value)
+      error: normalizeFormError(result.error),
+      value: result.value
     };
   }
   return {
-    value: input.value
+    error: normalizeFormError(result)
   };
 }
-function getDefaultSnapshot(defaultValue, defaultChecked, value) {
-  if (typeof value === 'string' || typeof defaultChecked === 'boolean') {
-    return {
-      value: value !== null && value !== void 0 ? value : 'on',
-      checked: defaultChecked
-    };
+
+/**
+ * Handles different validation result formats:
+ * - Promise: async validation only
+ * - Array: [syncResult, asyncPromise]
+ * - Object: sync validation only
+ */
+function resolveValidateResult(result) {
+  var syncResult;
+  var asyncResult;
+  if (result instanceof Promise) {
+    asyncResult = result;
+  } else if (Array.isArray(result)) {
+    syncResult = result[0];
+    asyncResult = result[1];
+  } else {
+    syncResult = result;
   }
-  if (typeof defaultValue === 'string') {
+  return {
+    syncResult: syncResult ? normalizeValidateResult(syncResult) : undefined,
+    asyncResult: asyncResult ? asyncResult.then(normalizeValidateResult) : undefined
+  };
+}
+function resolveStandardSchemaPath(issue) {
+  if (!issue.path) {
+    return [];
+  }
+  var segments = issue.path.map(segment => typeof segment === 'object' && 'key' in segment ? segment.key : segment);
+  if (!segments.every(segment => typeof segment !== 'symbol')) {
+    throw new Error('Path segments must not contain symbols. Use strings or numbers instead.');
+  }
+  return segments;
+}
+function resolveStandardSchemaResult(result) {
+  if (!result.issues) {
     return {
-      value: defaultValue
+      error: null,
+      value: result.value
     };
   }
-  if (Array.isArray(defaultValue)) {
-    if (defaultValue.every(item => typeof item === 'string')) {
-      return {
-        options: defaultValue
-      };
-    } else {
-      return {
-        files: defaultValue
-      };
+  var errorByName = {};
+  for (var issue of result.issues) {
+    var _errorByName$_name;
+    var path = resolveStandardSchemaPath(issue);
+    var _name = future.formatPathSegments(path);
+    (_errorByName$_name = errorByName[_name]) !== null && _errorByName$_name !== void 0 ? _errorByName$_name : errorByName[_name] = [];
+    errorByName[_name].push(issue.message);
+  }
+  var {
+      '': formErrors = []
+    } = errorByName,
+    fieldErrors = _rollupPluginBabelHelpers.objectWithoutProperties(errorByName, _excluded);
+  return {
+    error: {
+      formErrors,
+      fieldErrors
     }
+  };
+}
+
+/**
+ * Create a copy of the object with the updated properties if there is any change
+ */
+function merge(obj, update) {
+  if (obj === update || Object.entries(update).every(_ref2 => {
+    var [key, value] = _ref2;
+    return obj[key] === value;
+  })) {
+    return obj;
   }
-  if (dom.isGlobalInstance(defaultValue, 'File')) {
-    return {
-      files: [defaultValue]
-    };
+  return Object.assign({}, obj, update);
+}
+
+/**
+ * Transforms object keys using a mapping function.
+ * Keys mapped to null are filtered out.
+ */
+function transformKeys(obj, fn) {
+  var result = {};
+  for (var [_key, _value] of Object.entries(obj)) {
+    var _name2 = fn(_key);
+    if (_name2 !== null) {
+      result[_name2] = _value;
+    }
   }
-  if (dom.isGlobalInstance(defaultValue, 'FileList')) {
-    return {
-      files: Array.from(defaultValue)
-    };
+  return result;
+}
+
+/**
+ * Appends item to array only if not already present.
+ * Returns original array if item exists, new array if added.
+ */
+function appendUniqueItem(list, item) {
+  if (list.includes(item)) {
+    return list;
+  }
+  return list.concat(item);
+}
+
+/**
+ * Maps over array and filters out null results.
+ */
+function compactMap(list, fn) {
+  var result = [];
+  for (var item of list) {
+    var _value2 = fn(item);
+    if (_value2 !== null) {
+      result.push(_value2);
+    }
   }
-  return {};
+  return result;
+}
+function generateUniqueKey() {
+  return Math.trunc(Date.now() * Math.random()).toString(36);
 }
 
-exports.focusable = focusable;
-exports.getCheckboxGroupValue = getCheckboxGroupValue;
-exports.getDefaultSnapshot = getDefaultSnapshot;
-exports.getFormElement = getFormElement;
-exports.getInputSnapshot = getInputSnapshot;
-exports.getRadioGroupValue = getRadioGroupValue;
-exports.initializeField = initializeField;
+exports.appendUniqueItem = appendUniqueItem;
+exports.compactMap = compactMap;
+exports.createPathIndexUpdater = createPathIndexUpdater;
+exports.generateUniqueKey = generateUniqueKey;
+exports.getArrayAtPath = getArrayAtPath;
+exports.isNumber = isNumber;
+exports.isOptional = isOptional;
+exports.isString = isString;
+exports.isUndefined = isUndefined;
+exports.merge = merge;
+exports.normalizeFormError = normalizeFormError;
+exports.normalizeValidateResult = normalizeValidateResult;
+exports.resolveStandardSchemaPath = resolveStandardSchemaPath;
+exports.resolveStandardSchemaResult = resolveStandardSchemaResult;
+exports.resolveValidateResult = resolveValidateResult;
+exports.transformKeys = transformKeys;
+exports.updateValueAtPath = updateValueAtPath;

package/dist/future/util.mjs

@@ -1,137 +1,209 @@
-import { unstable_updateField, isGlobalInstance } from '@conform-to/dom';
+import { objectWithoutProperties as _objectWithoutProperties } from '../_virtual/_rollupPluginBabelHelpers.mjs';
+import { formatPathSegments, getValueAtPath, isPlainObject, setValueAtPath, getPathSegments } from '@conform-to/dom/future';
 
-function getFormElement(formRef) {
-  var _element$form;
-  if (typeof formRef === 'string') {
-    return document.forms.namedItem(formRef);
-  }
-  var element = formRef === null || formRef === void 0 ? void 0 : formRef.current;
-  if (element instanceof HTMLFormElement) {
-    return element;
-  }
-  return (_element$form = element === null || element === void 0 ? void 0 : element.form) !== null && _element$form !== void 0 ? _element$form : null;
+var _excluded = [""];
+function isUndefined(value) {
+  return value === undefined;
 }
-function focusable(element) {
-  if (!element.hidden && element.type !== 'hidden') {
-    return;
-  }
-
-  // Style the element to be visually hidden
-  element.style.position = 'absolute';
-  element.style.width = '1px';
-  element.style.height = '1px';
-  element.style.padding = '0';
-  element.style.margin = '-1px';
-  element.style.overflow = 'hidden';
-  element.style.clip = 'rect(0,0,0,0)';
-  element.style.whiteSpace = 'nowrap';
-  element.style.border = '0';
-
-  // Hide the element from screen readers
-  element.setAttribute('aria-hidden', 'true');
-
-  // Make sure people won't tab to this element
-  element.tabIndex = -1;
-
-  // Set the element to be visible again so it can be focused
-  if (element.hidden) {
-    element.hidden = false;
-  }
-  if (element.type === 'hidden') {
-    element.setAttribute('type', 'text');
-  }
+function isString(value) {
+  return typeof value === 'string';
+}
+function isNumber(value) {
+  return typeof value === 'number';
 }
-function initializeField(element, options) {
-  var _options$value;
-  if (element.dataset.conform) {
-    return;
+function isOptional(value, typeGuard) {
+  return isUndefined(value) || typeGuard(value);
+}
+function getArrayAtPath(formValue, name) {
+  var _getValueAtPath;
+  var value = (_getValueAtPath = getValueAtPath(formValue, name)) !== null && _getValueAtPath !== void 0 ? _getValueAtPath : [];
+  if (!Array.isArray(value)) {
+    throw new Error("The value of \"".concat(name, "\" is not an array"));
   }
-  var defaultValue = typeof (options === null || options === void 0 ? void 0 : options.value) === 'string' || typeof (options === null || options === void 0 ? void 0 : options.defaultChecked) === 'boolean' ? options.defaultChecked ? (_options$value = options.value) !== null && _options$value !== void 0 ? _options$value : 'on' : null : options === null || options === void 0 ? void 0 : options.defaultValue;
-
-  // Update the value of the element, including the default value
-  unstable_updateField(element, {
-    value: defaultValue,
-    defaultValue
-  });
-  element.dataset.conform = 'initialized';
+  return value;
 }
-function getRadioGroupValue(inputs) {
-  for (var input of inputs) {
-    if (input.type === 'radio' && input.checked) {
-      return input.value;
+
+/**
+ * Immutably updates a value at the specified path.
+ * Empty path replaces the entire object.
+ */
+function updateValueAtPath(data, name, value) {
+  if (name === '') {
+    if (!isPlainObject(value)) {
+      throw new Error('The value must be an object');
     }
+    return value;
   }
+  return setValueAtPath(data, getPathSegments(name), value, {
+    clone: true
+  });
 }
-function getCheckboxGroupValue(inputs) {
-  var values;
-  for (var input of inputs) {
-    if (input.type === 'checkbox') {
-      var _values;
-      (_values = values) !== null && _values !== void 0 ? _values : values = [];
-      if (input.checked) {
-        values.push(input.value);
+
+/**
+ * Creates a function that updates array indices in field paths.
+ * Returns null to remove fields, or updated path with new index.
+ */
+function createPathIndexUpdater(listName, update) {
+  var listPaths = getPathSegments(listName);
+  return name => {
+    var paths = getPathSegments(name);
+    if (paths.length > listPaths.length && listPaths.every((path, index) => paths[index] === path)) {
+      var currentIndex = paths[listPaths.length];
+      if (typeof currentIndex === 'number') {
+        var newIndex = update(currentIndex);
+        if (newIndex === null) {
+          // To remove the item instead of updating it
+          return null;
+        }
+        if (newIndex !== currentIndex) {
+          // Replace the index
+          paths.splice(listPaths.length, 1, newIndex);
+          return formatPathSegments(paths);
+        }
       }
     }
+    return name;
+  };
+}
+
+/**
+ * Returns null if error object has no actual error messages,
+ * otherwise returns the error as-is.
+ */
+function normalizeFormError(error) {
+  if (error && error.formErrors.length === 0 && Object.entries(error.fieldErrors).every(_ref => {
+    var [, messages] = _ref;
+    return Array.isArray(messages) ? messages.length === 0 : !messages;
+  })) {
+    return null;
   }
-  return values;
-}
-function getInputSnapshot(input) {
-  if (input instanceof HTMLInputElement) {
-    switch (input.type) {
-      case 'file':
-        return {
-          files: input.files ? Array.from(input.files) : undefined
-        };
-      case 'radio':
-      case 'checkbox':
-        return {
-          value: input.value,
-          checked: input.checked
-        };
-    }
-  } else if (input instanceof HTMLSelectElement && input.multiple) {
+  return error;
+}
+function normalizeValidateResult(result) {
+  if (result !== null && 'error' in result) {
     return {
-      options: Array.from(input.selectedOptions).map(option => option.value)
+      error: normalizeFormError(result.error),
+      value: result.value
     };
   }
   return {
-    value: input.value
+    error: normalizeFormError(result)
   };
 }
-function getDefaultSnapshot(defaultValue, defaultChecked, value) {
-  if (typeof value === 'string' || typeof defaultChecked === 'boolean') {
-    return {
-      value: value !== null && value !== void 0 ? value : 'on',
-      checked: defaultChecked
-    };
+
+/**
+ * Handles different validation result formats:
+ * - Promise: async validation only
+ * - Array: [syncResult, asyncPromise]
+ * - Object: sync validation only
+ */
+function resolveValidateResult(result) {
+  var syncResult;
+  var asyncResult;
+  if (result instanceof Promise) {
+    asyncResult = result;
+  } else if (Array.isArray(result)) {
+    syncResult = result[0];
+    asyncResult = result[1];
+  } else {
+    syncResult = result;
   }
-  if (typeof defaultValue === 'string') {
+  return {
+    syncResult: syncResult ? normalizeValidateResult(syncResult) : undefined,
+    asyncResult: asyncResult ? asyncResult.then(normalizeValidateResult) : undefined
+  };
+}
+function resolveStandardSchemaPath(issue) {
+  if (!issue.path) {
+    return [];
+  }
+  var segments = issue.path.map(segment => typeof segment === 'object' && 'key' in segment ? segment.key : segment);
+  if (!segments.every(segment => typeof segment !== 'symbol')) {
+    throw new Error('Path segments must not contain symbols. Use strings or numbers instead.');
+  }
+  return segments;
+}
+function resolveStandardSchemaResult(result) {
+  if (!result.issues) {
     return {
-      value: defaultValue
+      error: null,
+      value: result.value
     };
   }
-  if (Array.isArray(defaultValue)) {
-    if (defaultValue.every(item => typeof item === 'string')) {
-      return {
-        options: defaultValue
-      };
-    } else {
-      return {
-        files: defaultValue
-      };
+  var errorByName = {};
+  for (var issue of result.issues) {
+    var _errorByName$_name;
+    var path = resolveStandardSchemaPath(issue);
+    var _name = formatPathSegments(path);
+    (_errorByName$_name = errorByName[_name]) !== null && _errorByName$_name !== void 0 ? _errorByName$_name : errorByName[_name] = [];
+    errorByName[_name].push(issue.message);
+  }
+  var {
+      '': formErrors = []
+    } = errorByName,
+    fieldErrors = _objectWithoutProperties(errorByName, _excluded);
+  return {
+    error: {
+      formErrors,
+      fieldErrors
     }
+  };
+}
+
+/**
+ * Create a copy of the object with the updated properties if there is any change
+ */
+function merge(obj, update) {
+  if (obj === update || Object.entries(update).every(_ref2 => {
+    var [key, value] = _ref2;
+    return obj[key] === value;
+  })) {
+    return obj;
   }
-  if (isGlobalInstance(defaultValue, 'File')) {
-    return {
-      files: [defaultValue]
-    };
+  return Object.assign({}, obj, update);
+}
+
+/**
+ * Transforms object keys using a mapping function.
+ * Keys mapped to null are filtered out.
+ */
+function transformKeys(obj, fn) {
+  var result = {};
+  for (var [_key, _value] of Object.entries(obj)) {
+    var _name2 = fn(_key);
+    if (_name2 !== null) {
+      result[_name2] = _value;
+    }
   }
-  if (isGlobalInstance(defaultValue, 'FileList')) {
-    return {
-      files: Array.from(defaultValue)
-    };
+  return result;
+}
+
+/**
+ * Appends item to array only if not already present.
+ * Returns original array if item exists, new array if added.
+ */
+function appendUniqueItem(list, item) {
+  if (list.includes(item)) {
+    return list;
+  }
+  return list.concat(item);
+}
+
+/**
+ * Maps over array and filters out null results.
+ */
+function compactMap(list, fn) {
+  var result = [];
+  for (var item of list) {
+    var _value2 = fn(item);
+    if (_value2 !== null) {
+      result.push(_value2);
+    }
   }
-  return {};
+  return result;
+}
+function generateUniqueKey() {
+  return Math.trunc(Date.now() * Math.random()).toString(36);
 }
 
-export { focusable, getCheckboxGroupValue, getDefaultSnapshot, getFormElement, getInputSnapshot, getRadioGroupValue, initializeField };
+export { appendUniqueItem, compactMap, createPathIndexUpdater, generateUniqueKey, getArrayAtPath, isNumber, isOptional, isString, isUndefined, merge, normalizeFormError, normalizeValidateResult, resolveStandardSchemaPath, resolveStandardSchemaResult, resolveValidateResult, transformKeys, updateValueAtPath };