@conform-to/dom 1.17.1 → 1.19.0

package/dist/standard-schema.mjs

@@ -1,16 +1,9 @@
-import { formatPathSegments } from './formdata.mjs';
+import { formatPath } from './formdata.mjs';
 import { isPlainObject } from './util.mjs';
 
-/**
- * A widened version of `StandardSchemaV1.Issue`.
- *
- * The `path` elements and `PropertyKey` fields are loosened to `unknown`
- * to stay compatible with Valibot's native issue type.
- */
-
 function formatIssues(issues) {
   var error = {
-    formErrors: [],
+    formErrors: null,
     fieldErrors: {}
   };
   for (var issue of issues) {
@@ -22,8 +15,10 @@ function formatIssues(issues) {
       }
       return path;
     })) !== null && _issue$path$map !== void 0 ? _issue$path$map : [];
-    var name = formatPathSegments(segments !== null && segments !== void 0 ? segments : []);
+    var name = formatPath(segments !== null && segments !== void 0 ? segments : []);
     if (!name) {
+      var _error$formErrors;
+      (_error$formErrors = error.formErrors) !== null && _error$formErrors !== void 0 ? _error$formErrors : error.formErrors = [];
       error.formErrors.push(issue.message);
     } else {
       var _error$fieldErrors, _error$fieldErrors$na;

package/dist/submission.js

@@ -33,7 +33,7 @@ function getSubmissionContext(body) {
       return 1; // continue
     }
     context.fields.add(name);
-    formdata.setValueAtPath(context.payload, name, prev => {
+    formdata.setPathValue(context.payload, name, prev => {
       if (!prev) {
         return next;
       } else if (Array.isArray(prev)) {
@@ -57,11 +57,11 @@ function parse(payload, options) {
     switch (intent.type) {
       case 'update':
         {
-          var name = formdata.appendPathSegment(intent.payload.name, intent.payload.index);
+          var name = formdata.appendPath(intent.payload.name, intent.payload.index);
           var _value = intent.payload.value;
           if (typeof intent.payload.value !== 'undefined') {
             if (name) {
-              formdata.setValueAtPath(context.payload, name, () => _value);
+              formdata.setPathValue(context.payload, name, () => _value);
             } else {
               context.payload = _value;
             }
@@ -70,9 +70,9 @@ function parse(payload, options) {
         }
       case 'reset':
         {
-          var _name = formdata.appendPathSegment(intent.payload.name, intent.payload.index);
+          var _name = formdata.appendPath(intent.payload.name, intent.payload.index);
           if (_name) {
-            formdata.setValueAtPath(context.payload, _name, () => undefined);
+            formdata.setPathValue(context.payload, _name, () => undefined);
           } else {
             context.payload = {};
           }
@@ -127,9 +127,9 @@ function replySubmission(context) {
   }
   if ('hideFields' in options && options.hideFields) {
     for (var name of options.hideFields) {
-      var _value2 = formdata.getValueAtPath(context.payload, name);
+      var _value2 = formdata.getPathValue(context.payload, name);
       if (typeof _value2 !== 'undefined') {
-        formdata.setValueAtPath(context.payload, name, () => undefined);
+        formdata.setPathValue(context.payload, name, () => undefined);
       }
     }
   }
@@ -201,7 +201,7 @@ function updateList(list, intent) {
   }
 }
 function setListValue(data, intent) {
-  formdata.setValueAtPath(data, intent.payload.name, value => {
+  formdata.setPathValue(data, intent.payload.name, value => {
     var list = value !== null && value !== void 0 ? value : [];
     updateList(list, intent);
     return list;
@@ -218,8 +218,8 @@ function setState(state, name, valueFn) {
   var target = {};
   var _loop2 = function _loop2() {
     var value = state[_key];
-    if (formdata.isPrefix(_key, name) && _key !== name) {
-      formdata.setValueAtPath(target, _key, currentValue => {
+    if (formdata.isPathPrefix(_key, name) && _key !== name) {
+      formdata.setPathValue(target, _key, currentValue => {
         if (typeof currentValue === 'undefined') {
           return value;
         }
@@ -239,7 +239,7 @@ function setState(state, name, valueFn) {
   for (var _key of keys) {
     _loop2();
   }
-  var result = valueFn(formdata.getValueAtPath(target, name));
+  var result = valueFn(formdata.getPathValue(target, name));
   Object.assign(state, flatten(result, {
     resolve(data) {
       if (util.isPlainObject(data) || Array.isArray(data)) {

package/dist/submission.mjs

@@ -1,6 +1,6 @@
 import { objectSpread2 as _objectSpread2 } from './_virtual/_rollupPluginBabelHelpers.mjs';
 import { isGlobalInstance } from './dom.mjs';
-import { appendPathSegment, setValueAtPath, getValueAtPath, isPrefix } from './formdata.mjs';
+import { appendPath, setPathValue, getPathValue, isPathPrefix } from './formdata.mjs';
 import { isPlainObject, invariant } from './util.mjs';
 
 /**
@@ -29,7 +29,7 @@ function getSubmissionContext(body) {
       return 1; // continue
     }
     context.fields.add(name);
-    setValueAtPath(context.payload, name, prev => {
+    setPathValue(context.payload, name, prev => {
       if (!prev) {
         return next;
       } else if (Array.isArray(prev)) {
@@ -53,11 +53,11 @@ function parse(payload, options) {
     switch (intent.type) {
       case 'update':
         {
-          var name = appendPathSegment(intent.payload.name, intent.payload.index);
+          var name = appendPath(intent.payload.name, intent.payload.index);
           var _value = intent.payload.value;
           if (typeof intent.payload.value !== 'undefined') {
             if (name) {
-              setValueAtPath(context.payload, name, () => _value);
+              setPathValue(context.payload, name, () => _value);
             } else {
               context.payload = _value;
             }
@@ -66,9 +66,9 @@ function parse(payload, options) {
         }
       case 'reset':
         {
-          var _name = appendPathSegment(intent.payload.name, intent.payload.index);
+          var _name = appendPath(intent.payload.name, intent.payload.index);
           if (_name) {
-            setValueAtPath(context.payload, _name, () => undefined);
+            setPathValue(context.payload, _name, () => undefined);
           } else {
             context.payload = {};
           }
@@ -123,9 +123,9 @@ function replySubmission(context) {
   }
   if ('hideFields' in options && options.hideFields) {
     for (var name of options.hideFields) {
-      var _value2 = getValueAtPath(context.payload, name);
+      var _value2 = getPathValue(context.payload, name);
       if (typeof _value2 !== 'undefined') {
-        setValueAtPath(context.payload, name, () => undefined);
+        setPathValue(context.payload, name, () => undefined);
       }
     }
   }
@@ -197,7 +197,7 @@ function updateList(list, intent) {
   }
 }
 function setListValue(data, intent) {
-  setValueAtPath(data, intent.payload.name, value => {
+  setPathValue(data, intent.payload.name, value => {
     var list = value !== null && value !== void 0 ? value : [];
     updateList(list, intent);
     return list;
@@ -214,8 +214,8 @@ function setState(state, name, valueFn) {
   var target = {};
   var _loop2 = function _loop2() {
     var value = state[_key];
-    if (isPrefix(_key, name) && _key !== name) {
-      setValueAtPath(target, _key, currentValue => {
+    if (isPathPrefix(_key, name) && _key !== name) {
+      setPathValue(target, _key, currentValue => {
         if (typeof currentValue === 'undefined') {
           return value;
         }
@@ -235,7 +235,7 @@ function setState(state, name, valueFn) {
   for (var _key of keys) {
     _loop2();
   }
-  var result = valueFn(getValueAtPath(target, name));
+  var result = valueFn(getPathValue(target, name));
   Object.assign(state, flatten(result, {
     resolve(data) {
       if (isPlainObject(data) || Array.isArray(data)) {

package/dist/types.d.ts

@@ -12,15 +12,35 @@ export type FormValue<Type extends JsonPrimitive | FormDataEntryValue = JsonPrim
 /**
  * Form error object that contains both form errors and field errors.
  */
-export type FormError<ErrorShape = string> = {
+export type FormError<ErrorShape = string[]> = {
     /**
-     * The error of the form.
+     * The form-level error payload.
+     * Set to `null` when there is no form-level error.
      */
-    formErrors: ErrorShape[];
+    formErrors: ErrorShape | null;
     /**
-     * The field errors based on the field name.
+     * Field-level error payloads mapped by field name.
+     * Use `null` to explicitly clear a field error.
      */
-    fieldErrors: Record<string, ErrorShape[]>;
+    fieldErrors: Record<string, ErrorShape | null>;
+};
+/**
+ * A widened version of `StandardSchemaV1.Issue`.
+ *
+ * The `path` elements and `PropertyKey` fields are loosened to `unknown`
+ * to stay compatible with Valibot's native issue type.
+ */
+export type StandardSchemaIssue = {
+    readonly message: string;
+    readonly path?: ReadonlyArray<unknown | {
+        key: unknown;
+    }> | undefined;
+};
+export type StandardSchemaError = Partial<Record<keyof FormError, never>> & {
+    issues: ReadonlyArray<StandardSchemaIssue>;
+};
+export type CustomError<ErrorShape> = Partial<FormError<ErrorShape>> & {
+    issues?: never;
 };
 /**
  * Structured data parsed from a form submission.
@@ -30,7 +50,7 @@ export type Submission<ValueType extends JsonPrimitive | FormDataEntryValue = Js
      * The submitted values mapped by field name.
      * Supports nested names like `user.email` or indexed names like `items[0].id`.
      *
-     * @example
+     * **Example:**
      * ```json
      * {
      *   "username": "johndoe",
@@ -58,7 +78,7 @@ export type Submission<ValueType extends JsonPrimitive | FormDataEntryValue = Js
 /**
  * The result of a submission.
  */
-export type SubmissionResult<ErrorShape = string, ValueType extends JsonPrimitive | FormDataEntryValue = JsonPrimitive | FormDataEntryValue> = {
+export type SubmissionResult<ErrorShape = string[], ValueType extends JsonPrimitive | FormDataEntryValue = JsonPrimitive | FormDataEntryValue> = {
     /**
      * The original submission data.
      */
@@ -81,8 +101,9 @@ export type FieldName<FieldShape> = string & {
     '~shape'?: FieldShape;
 };
 /**
- * The input attributes related to form field constraints
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation
+ * The input attributes related to form field constraints.
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/HTML/Constraint_validation
  */
 export type ValidationAttributes = {
     required?: boolean | undefined;
@@ -103,23 +124,22 @@ export type Serializable<T> = T extends File ? undefined : T extends Array<infer
     [K in keyof T]: Serializable<T[K]>;
 } : T;
 /**
- * Converts an arbitrary value into a {@link SerializedValue}.
+ * Converts an arbitrary value into a form value.
  *
  * This function is used to prepare field values for submission,
  * ensuring they are compatible with the browser's `FormData` API.
- *
- * @param value - The original value to serialize.
- * @returns A `SerializedValue` if the input can be represented in `FormData`,
- *          or `undefined` if it cannot be serialized.
  */
-export type Serialize = (value: unknown) => SerializedValue | null | undefined;
+export type Serialize = (value: unknown, ctx: {
+    name: string | undefined;
+}) => FormValue<FormDataEntryValue> | null | undefined;
 /**
- * A value that can be serialized into `FormData`.
- *
- * - `string` and `File` are supported natively by `FormData`.
- * - Arrays allow representing multi-value fields.
+ * A custom serializer that can override specific values and delegate everything
+ * else back to the default serializer.
  */
-export type SerializedValue = string | string[] | File | File[];
+export type CustomSerialize = (value: unknown, ctx: {
+    name: string | undefined;
+    defaultSerialize: (value: unknown) => ReturnType<Serialize>;
+}) => FormValue<FormDataEntryValue> | null | undefined;
 /**
  * Flatten a discriminated union into a single type with all properties.
  */

package/package.json

@@ -3,7 +3,7 @@
   "description": "A set of opinionated helpers built on top of the Constraint Validation API",
   "homepage": "https://conform.guide",
   "license": "MIT",
-  "version": "1.17.1",
+  "version": "1.19.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",