@conform-to/dom 1.0.0-pre.7 → 1.0.0-rc.1

package/README

@@ -8,9 +8,9 @@
  ╚══════╝  ╚═════╝  ╚═╝  ╚══╝ ╚═╝        ╚═════╝  ╚═╝   ╚═╝ ╚═╝   ╚═╝
 
 
-Version 1.0.0-pre.7 / License MIT / Copyright (c) 2024 Edmund Hung
+Version 1.0.0-rc.0 / License MIT / Copyright (c) 2024 Edmund Hung
 
-A type-safe form validation library utilizing web fundamentals to progressively enhance HTML Forms with full support for server frameworks like Remix route action and Next.js server actions.
+A type-safe form validation library utilizing web fundamentals to progressively enhance HTML Forms with full support for server frameworks like Remix and Next.js.
 
 > Getting Started
 
@@ -21,7 +21,7 @@ Check out the overview and tutorial at our website https://conform.guide
 The documentation is divided into several sections:
 
 * Overview: https://conform.guide/overview
-* Example Usages: https://conform.guide/examples
+* Examples: https://conform.guide/examples
 * Complex structures: https://conform.guide/complex-structures
 * UI Integrations: https://conform.guide/integrations
 * Accessibility Guide: https://conform.guide/accessibility

package/dom.js

@@ -84,17 +84,16 @@ function getFormMethod(event) {
  */
 function requestSubmit(form, submitter) {
   util.invariant(!!form, 'Failed to submit the form. The element provided is null or undefined.');
-
-  // if (typeof form.requestSubmit === 'function') {
-  // 	form.requestSubmit(submitter);
-  // } else {
-  var event = new SubmitEvent('submit', {
-    bubbles: true,
-    cancelable: true,
-    submitter
-  });
-  form.dispatchEvent(event);
-  // }
+  if (typeof form.requestSubmit === 'function') {
+    form.requestSubmit(submitter);
+  } else {
+    var event = new SubmitEvent('submit', {
+      bubbles: true,
+      cancelable: true,
+      submitter
+    });
+    form.dispatchEvent(event);
+  }
 }
 
 exports.getFormAction = getFormAction;

package/dom.mjs

@@ -80,17 +80,16 @@ function getFormMethod(event) {
  */
 function requestSubmit(form, submitter) {
   invariant(!!form, 'Failed to submit the form. The element provided is null or undefined.');
-
-  // if (typeof form.requestSubmit === 'function') {
-  // 	form.requestSubmit(submitter);
-  // } else {
-  var event = new SubmitEvent('submit', {
-    bubbles: true,
-    cancelable: true,
-    submitter
-  });
-  form.dispatchEvent(event);
-  // }
+  if (typeof form.requestSubmit === 'function') {
+    form.requestSubmit(submitter);
+  } else {
+    var event = new SubmitEvent('submit', {
+      bubbles: true,
+      cancelable: true,
+      submitter
+    });
+    form.dispatchEvent(event);
+  }
 }
 
 export { getFormAction, getFormEncType, getFormMethod, isFieldElement, isFormControl, requestSubmit };

package/form.d.ts

@@ -62,7 +62,7 @@ export type FormOptions<Schema, FormError = string[], FormValue = Schema> = {
     /**
      * An object describing the result of the last submission
      */
-    lastResult?: SubmissionResult<FormError> | null;
+    lastResult?: SubmissionResult<FormError> | null | undefined;
     /**
      * Define when conform should start validation.
      * Support "onSubmit", "onInput", "onBlur".
@@ -90,16 +90,6 @@ export type FormOptions<Schema, FormError = string[], FormValue = Schema> = {
         submitter: HTMLInputElement | HTMLButtonElement | null;
         formData: FormData;
     }) => Submission<Schema, FormError, FormValue>;
-    /**
-     * A function to be called before the form is submitted.
-     */
-    onSubmit?: (event: SubmitEvent, context: {
-        formData: FormData;
-        action: ReturnType<typeof getFormAction>;
-        encType: ReturnType<typeof getFormEncType>;
-        method: ReturnType<typeof getFormMethod>;
-        submission?: Submission<Schema, FormError, FormValue>;
-    }) => void;
 };
 export type SubscriptionSubject = {
     [key in 'error' | 'initialValue' | 'value' | 'key' | 'valid' | 'dirty']?: SubscriptionScope;
@@ -116,9 +106,15 @@ export type ControlButtonProps = {
     form: string;
     formNoValidate: boolean;
 };
-export type FormContext<Schema extends Record<string, any> = any, FormValue = Schema, FormError = string[]> = {
+export type FormContext<Schema extends Record<string, any> = any, FormError = string[], FormValue = Schema> = {
     formId: string;
-    submit(event: SubmitEvent): Submission<Schema, FormError, FormValue> | undefined;
+    submit(event: SubmitEvent): {
+        formData: FormData;
+        action: ReturnType<typeof getFormAction>;
+        encType: ReturnType<typeof getFormEncType>;
+        method: ReturnType<typeof getFormMethod>;
+        submission?: Submission<Schema, FormError, FormValue>;
+    };
     onReset(event: Event): void;
     onInput(event: Event): void;
     onBlur(event: Event): void;
@@ -143,5 +139,5 @@ export type FormContext<Schema extends Record<string, any> = any, FormValue = Sc
         }>['payload']): ControlButtonProps;
     };
 };
-export declare function createFormContext<Schema extends Record<string, any>, FormValue, FormError>(options: FormOptions<Schema, FormError, FormValue>): FormContext<Schema, FormValue, FormError>;
+export declare function createFormContext<Schema extends Record<string, any>, FormError = string[], FormValue = Schema>(options: FormOptions<Schema, FormError, FormValue>): FormContext<Schema, FormError, FormValue>;
 export {};

package/form.js

@@ -145,7 +145,7 @@ function createKeyProxy(key) {
     if (typeof parentKey === 'undefined') {
       return currentKey;
     }
-    return "".concat(parentKey, "/").concat(currentKey !== null && currentKey !== void 0 ? currentKey : name);
+    return "".concat(parentKey, "/").concat(currentKey !== null && currentKey !== void 0 ? currentKey : paths.at(-1));
   });
 }
 function createValidProxy(error) {
@@ -292,16 +292,14 @@ function createFormContext(options) {
     // To ensure it capturing latest state before parsing
     input.value = getSerializedState();
     var formData = formdata.getFormData(form, submitter);
-    var context = {
+    var result = {
       formData,
       action: dom.getFormAction(event),
       encType: dom.getFormEncType(event),
       method: dom.getFormMethod(event)
     };
     if (typeof (latestOptions === null || latestOptions === void 0 ? void 0 : latestOptions.onValidate) === 'undefined') {
-      var _latestOptions$onSubm;
-      (_latestOptions$onSubm = latestOptions.onSubmit) === null || _latestOptions$onSubm === void 0 || _latestOptions$onSubm.call(latestOptions, event, context);
-      return;
+      return result;
     }
     var submission = latestOptions.onValidate({
       form,
@@ -310,13 +308,10 @@ function createFormContext(options) {
     });
     if (submission.status !== 'success' && submission.error !== null) {
       report(submission.reply());
-    } else {
-      var _latestOptions$onSubm2;
-      (_latestOptions$onSubm2 = latestOptions.onSubmit) === null || _latestOptions$onSubm2 === void 0 || _latestOptions$onSubm2.call(latestOptions, event, _rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, context), {}, {
-        submission
-      }));
     }
-    return submission;
+    return _rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, result), {}, {
+      submission
+    });
   }
   function resolveTarget(event) {
     var form = getFormElement();

package/form.mjs

@@ -141,7 +141,7 @@ function createKeyProxy(key) {
     if (typeof parentKey === 'undefined') {
       return currentKey;
     }
-    return "".concat(parentKey, "/").concat(currentKey !== null && currentKey !== void 0 ? currentKey : name);
+    return "".concat(parentKey, "/").concat(currentKey !== null && currentKey !== void 0 ? currentKey : paths.at(-1));
   });
 }
 function createValidProxy(error) {
@@ -288,16 +288,14 @@ function createFormContext(options) {
     // To ensure it capturing latest state before parsing
     input.value = getSerializedState();
     var formData = getFormData(form, submitter);
-    var context = {
+    var result = {
       formData,
       action: getFormAction(event),
       encType: getFormEncType(event),
       method: getFormMethod(event)
     };
     if (typeof (latestOptions === null || latestOptions === void 0 ? void 0 : latestOptions.onValidate) === 'undefined') {
-      var _latestOptions$onSubm;
-      (_latestOptions$onSubm = latestOptions.onSubmit) === null || _latestOptions$onSubm === void 0 || _latestOptions$onSubm.call(latestOptions, event, context);
-      return;
+      return result;
     }
     var submission = latestOptions.onValidate({
       form,
@@ -306,13 +304,10 @@ function createFormContext(options) {
     });
     if (submission.status !== 'success' && submission.error !== null) {
       report(submission.reply());
-    } else {
-      var _latestOptions$onSubm2;
-      (_latestOptions$onSubm2 = latestOptions.onSubmit) === null || _latestOptions$onSubm2 === void 0 || _latestOptions$onSubm2.call(latestOptions, event, _objectSpread2(_objectSpread2({}, context), {}, {
-        submission
-      }));
     }
-    return submission;
+    return _objectSpread2(_objectSpread2({}, result), {}, {
+      submission
+    });
   }
   function resolveTarget(event) {
     var form = getFormElement();

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.0.0-pre.7",
+	"version": "1.0.0-rc.1",
 	"main": "index.js",
 	"module": "index.mjs",
 	"types": "index.d.ts",