@conform-to/dom 1.10.0 → 1.11.0

package/README.md

@@ -7,7 +7,7 @@
  ╚══════╝  ╚═════╝  ╚═╝  ╚══╝ ╚═╝        ╚═════╝  ╚═╝   ╚═╝ ╚═╝   ╚═╝
 ```
 
-Version 1.10.0 / License MIT / Copyright (c) 2025 Edmund Hung
+Version 1.11.0 / License MIT / Copyright (c) 2025 Edmund Hung
 
 Progressively enhance HTML forms with React. Build resilient, type-safe forms with no hassle using web standards.
 

package/dist/formdata.d.ts

@@ -1,4 +1,5 @@
-import type { FormError, FormValue, JsonPrimitive, Serialize, SerializedValue, Submission, SubmissionResult } from './types';
+import type { FormValue, JsonPrimitive, Serialize, SerializedValue, Submission, SubmissionResult } from './types';
+import type { StandardSchemaIssue } from './standard-schema';
 export declare const DEFAULT_INTENT_NAME = "__INTENT__";
 /**
  * Construct a form data with the submitter value.
@@ -153,18 +154,48 @@ export declare function parseSubmission(formData: FormData | URLSearchParams, op
  */
 export declare function report<ErrorShape = string>(submission: Submission, options?: {
     keepFiles?: false;
-    error?: Partial<FormError<ErrorShape>> | null;
+    error?: {
+        issues?: undefined;
+        formErrors?: ErrorShape[];
+        fieldErrors?: Record<string, ErrorShape[]>;
+    } | null;
     intendedValue?: Record<string, FormValue> | null;
     hideFields?: string[];
     reset?: boolean;
 }): SubmissionResult<ErrorShape, Exclude<JsonPrimitive | FormDataEntryValue, File>>;
 export declare function report<ErrorShape = string>(submission: Submission, options: {
     keepFiles: true;
-    error?: Partial<FormError<ErrorShape>> | null;
+    error?: {
+        issues?: undefined;
+        formErrors?: ErrorShape[];
+        fieldErrors?: Record<string, ErrorShape[]>;
+    } | null;
     intendedValue?: Record<string, FormValue> | null;
     hideFields?: string[];
     reset?: boolean;
 }): SubmissionResult<ErrorShape>;
+export declare function report(submission: Submission, options?: {
+    keepFiles?: false;
+    error?: {
+        issues: ReadonlyArray<StandardSchemaIssue>;
+        formErrors?: string[];
+        fieldErrors?: Record<string, string[]>;
+    };
+    intendedValue?: Record<string, FormValue> | null;
+    hideFields?: string[];
+    reset?: boolean;
+}): SubmissionResult<string, Exclude<JsonPrimitive | FormDataEntryValue, File>>;
+export declare function report(submission: Submission, options?: {
+    keepFiles: true;
+    error?: {
+        issues: ReadonlyArray<StandardSchemaIssue>;
+        formErrors?: string[];
+        fieldErrors?: Record<string, string[]>;
+    };
+    intendedValue?: Record<string, FormValue> | null;
+    hideFields?: string[];
+    reset?: boolean;
+}): SubmissionResult<string>;
 /**
  * A utility function that checks whether the current form data differs from the default values.
  *

package/dist/formdata.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var _rollupPluginBabelHelpers = require('./_virtual/_rollupPluginBabelHelpers.js');
 var dom = require('./dom.js');
 var util = require('./util.js');
+var standardSchema = require('./standard-schema.js');
 
 var DEFAULT_INTENT_NAME = '__INTENT__';
 
@@ -327,16 +328,33 @@ function parseSubmission(formData, options) {
  */
 
 function report(submission) {
-  var _options$error$formEr, _options$error$fieldE;
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var error;
+  if (options.error == null) {
+    error = options.error;
+  } else {
+    var _options$error$issues;
+    error = standardSchema.formatIssues((_options$error$issues = options.error.issues) !== null && _options$error$issues !== void 0 ? _options$error$issues : []);
+    if (options.error.formErrors) {
+      error.formErrors.push(...options.error.formErrors);
+    }
+    if (options.error.fieldErrors) {
+      for (var [_name2, messages] of Object.entries(options.error.fieldErrors)) {
+        if (messages.length === 0) {
+          continue;
+        }
+        if (!error.fieldErrors[_name2]) {
+          error.fieldErrors[_name2] = messages;
+        } else {
+          error.fieldErrors[_name2].push(...messages);
+        }
+      }
+    }
+  }
   var intendedValue = options.reset ? null : typeof options.intendedValue === 'undefined' || submission.payload === options.intendedValue ? undefined : options.intendedValue && !options.keepFiles ? util.stripFiles(options.intendedValue) : options.intendedValue;
-  var error = !options.error ? options.error : {
-    formErrors: (_options$error$formEr = options.error.formErrors) !== null && _options$error$formEr !== void 0 ? _options$error$formEr : [],
-    fieldErrors: (_options$error$fieldE = options.error.fieldErrors) !== null && _options$error$fieldE !== void 0 ? _options$error$fieldE : {}
-  };
   if (options.hideFields) {
-    for (var _name2 of options.hideFields) {
-      var path = getPathSegments(_name2);
+    for (var _name3 of options.hideFields) {
+      var path = getPathSegments(_name3);
       setValueAtPath(submission.payload, path, undefined);
       if (intendedValue) {
         setValueAtPath(intendedValue, path, undefined);

package/dist/formdata.mjs

@@ -1,6 +1,7 @@
 import { objectSpread2 as _objectSpread2 } from './_virtual/_rollupPluginBabelHelpers.mjs';
 import { isSubmitter, isGlobalInstance } from './dom.mjs';
 import { isPlainObject, stripFiles, deepEqual } from './util.mjs';
+import { formatIssues } from './standard-schema.mjs';
 
 var DEFAULT_INTENT_NAME = '__INTENT__';
 
@@ -323,16 +324,33 @@ function parseSubmission(formData, options) {
  */
 
 function report(submission) {
-  var _options$error$formEr, _options$error$fieldE;
   var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var error;
+  if (options.error == null) {
+    error = options.error;
+  } else {
+    var _options$error$issues;
+    error = formatIssues((_options$error$issues = options.error.issues) !== null && _options$error$issues !== void 0 ? _options$error$issues : []);
+    if (options.error.formErrors) {
+      error.formErrors.push(...options.error.formErrors);
+    }
+    if (options.error.fieldErrors) {
+      for (var [_name2, messages] of Object.entries(options.error.fieldErrors)) {
+        if (messages.length === 0) {
+          continue;
+        }
+        if (!error.fieldErrors[_name2]) {
+          error.fieldErrors[_name2] = messages;
+        } else {
+          error.fieldErrors[_name2].push(...messages);
+        }
+      }
+    }
+  }
   var intendedValue = options.reset ? null : typeof options.intendedValue === 'undefined' || submission.payload === options.intendedValue ? undefined : options.intendedValue && !options.keepFiles ? stripFiles(options.intendedValue) : options.intendedValue;
-  var error = !options.error ? options.error : {
-    formErrors: (_options$error$formEr = options.error.formErrors) !== null && _options$error$formEr !== void 0 ? _options$error$formEr : [],
-    fieldErrors: (_options$error$fieldE = options.error.fieldErrors) !== null && _options$error$fieldE !== void 0 ? _options$error$fieldE : {}
-  };
   if (options.hideFields) {
-    for (var _name2 of options.hideFields) {
-      var path = getPathSegments(_name2);
+    for (var _name3 of options.hideFields) {
+      var path = getPathSegments(_name3);
       setValueAtPath(submission.payload, path, undefined);
       if (intendedValue) {
         setValueAtPath(intendedValue, path, undefined);

package/dist/future/index.d.ts

@@ -2,4 +2,5 @@ export type { Serialize, FormValue, FormError, Submission, SubmissionResult, Val
 export { DEFAULT_INTENT_NAME, getFormData, isDirty, parseSubmission, getPathSegments, formatPathSegments, appendPathSegment, getRelativePath, getValueAtPath, setValueAtPath, report, serialize, } from '../formdata';
 export { isPlainObject, deepEqual } from '../util';
 export { isFieldElement, isGlobalInstance, updateField, createFileList, createSubmitEvent, createGlobalFormsObserver, focus, change, blur, getFormAction, getFormEncType, getFormMethod, requestSubmit, requestIntent, } from '../dom';
+export { formatIssues } from '../standard-schema';
 //# sourceMappingURL=index.d.ts.map

package/dist/future/index.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 var formdata = require('../formdata.js');
 var util = require('../util.js');
 var dom = require('../dom.js');
+var standardSchema = require('../standard-schema.js');
 
 
 
@@ -36,3 +37,4 @@ exports.isGlobalInstance = dom.isGlobalInstance;
 exports.requestIntent = dom.requestIntent;
 exports.requestSubmit = dom.requestSubmit;
 exports.updateField = dom.updateField;
+exports.formatIssues = standardSchema.formatIssues;

package/dist/future/index.mjs

@@ -1,3 +1,4 @@
 export { DEFAULT_INTENT_NAME, appendPathSegment, formatPathSegments, getFormData, getPathSegments, getRelativePath, getValueAtPath, isDirty, parseSubmission, report, serialize, setValueAtPath } from '../formdata.mjs';
 export { deepEqual, isPlainObject } from '../util.mjs';
 export { blur, change, createFileList, createGlobalFormsObserver, createSubmitEvent, focus, getFormAction, getFormEncType, getFormMethod, isFieldElement, isGlobalInstance, requestIntent, requestSubmit, updateField } from '../dom.mjs';
+export { formatIssues } from '../standard-schema.mjs';

package/dist/standard-schema.d.ts

@@ -0,0 +1,15 @@
+import type { FormError } from './types';
+/**
+ * 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 declare function formatIssues(issues: Readonly<StandardSchemaIssue[]>): FormError<string>;
+//# sourceMappingURL=standard-schema.d.ts.map

package/dist/standard-schema.js

@@ -0,0 +1,41 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var formdata = require('./formdata.js');
+var util = require('./util.js');
+
+/**
+ * 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: [],
+    fieldErrors: {}
+  };
+  for (var issue of issues) {
+    var _issue$path$map, _issue$path;
+    var segments = (_issue$path$map = (_issue$path = issue.path) === null || _issue$path === void 0 ? void 0 : _issue$path.map(segment => {
+      var path = util.isPlainObject(segment) && 'key' in segment ? segment.key : segment;
+      if (typeof path !== 'string' && typeof path !== 'number') {
+        throw new Error("Only string or numeric path segment schemes are supported. Received segment: ".concat(String(path)));
+      }
+      return path;
+    })) !== null && _issue$path$map !== void 0 ? _issue$path$map : [];
+    var name = formdata.formatPathSegments(segments !== null && segments !== void 0 ? segments : []);
+    if (!name) {
+      error.formErrors.push(issue.message);
+    } else {
+      var _error$fieldErrors, _error$fieldErrors$na;
+      (_error$fieldErrors$na = (_error$fieldErrors = error.fieldErrors)[name]) !== null && _error$fieldErrors$na !== void 0 ? _error$fieldErrors$na : _error$fieldErrors[name] = [];
+      error.fieldErrors[name].push(issue.message);
+    }
+  }
+  return error;
+}
+
+exports.formatIssues = formatIssues;

package/dist/standard-schema.mjs

@@ -0,0 +1,37 @@
+import { formatPathSegments } 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: [],
+    fieldErrors: {}
+  };
+  for (var issue of issues) {
+    var _issue$path$map, _issue$path;
+    var segments = (_issue$path$map = (_issue$path = issue.path) === null || _issue$path === void 0 ? void 0 : _issue$path.map(segment => {
+      var path = isPlainObject(segment) && 'key' in segment ? segment.key : segment;
+      if (typeof path !== 'string' && typeof path !== 'number') {
+        throw new Error("Only string or numeric path segment schemes are supported. Received segment: ".concat(String(path)));
+      }
+      return path;
+    })) !== null && _issue$path$map !== void 0 ? _issue$path$map : [];
+    var name = formatPathSegments(segments !== null && segments !== void 0 ? segments : []);
+    if (!name) {
+      error.formErrors.push(issue.message);
+    } else {
+      var _error$fieldErrors, _error$fieldErrors$na;
+      (_error$fieldErrors$na = (_error$fieldErrors = error.fieldErrors)[name]) !== null && _error$fieldErrors$na !== void 0 ? _error$fieldErrors$na : _error$fieldErrors[name] = [];
+      error.fieldErrors[name].push(issue.message);
+    }
+  }
+  return error;
+}
+
+export { formatIssues };

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.10.0",
+  "version": "1.11.0",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",