@conform-to/yup 1.0.0-pre.5 → 1.0.0-pre.7

package/README

@@ -0,0 +1,32 @@
+
+
+ ███████╗  ██████╗  ███╗  ██╗ ████████╗  ██████╗  ███████╗  ███╗ ███╗
+██╔═════╝ ██╔═══██╗ ████╗ ██║ ██╔═════╝ ██╔═══██╗ ██╔═══██╗ ████████║
+██║       ██║   ██║ ██╔██╗██║ ███████╗  ██║   ██║ ███████╔╝ ██╔██╔██║
+██║       ██║   ██║ ██║╚████║ ██╔════╝  ██║   ██║ ██╔═══██╗ ██║╚═╝██║
+╚███████╗ ╚██████╔╝ ██║ ╚███║ ██║       ╚██████╔╝ ██║   ██║ ██║   ██║
+ ╚══════╝  ╚═════╝  ╚═╝  ╚══╝ ╚═╝        ╚═════╝  ╚═╝   ╚═╝ ╚═╝   ╚═╝
+
+
+Version 1.0.0-pre.7 / 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.
+
+> Getting Started
+
+Check out the overview and tutorial at our website https://conform.guide
+
+> Documentation
+
+The documentation is divided into several sections:
+
+* Overview: https://conform.guide/overview
+* Example Usages: https://conform.guide/examples
+* Complex structures: https://conform.guide/complex-structures
+* UI Integrations: https://conform.guide/integrations
+* Accessibility Guide: https://conform.guide/accessibility
+* API Reference: https://conform.guide/references
+
+> Support
+
+To report a bug, please open an issue on the repository at https://github.com/edmundhung/conform. For feature requests and questions, you can post them in the Discussions section.

package/index.d.ts

@@ -1,11 +1,11 @@
-import { type Constraint, type FormControl, type Submission } from '@conform-to/dom';
+import { type Constraint, type Intent, type Submission } from '@conform-to/dom';
 import * as yup from 'yup';
-export declare function getFieldsetConstraint<Source extends yup.AnyObjectSchema>(source: Source): Record<string, Constraint>;
+export declare function getYupConstraint<Source extends yup.AnyObjectSchema>(source: Source): Record<string, Constraint>;
 export declare function parseWithYup<Schema extends yup.AnyObjectSchema>(payload: FormData | URLSearchParams, config: {
-    schema: Schema | ((control: FormControl | null) => Schema);
+    schema: Schema | ((intent: Intent | null) => Schema);
     async?: false;
 }): Submission<yup.InferType<Schema>, string[]>;
 export declare function parseWithYup<Schema extends yup.AnyObjectSchema>(payload: FormData | URLSearchParams, config: {
-    schema: Schema | ((control: FormControl | null) => Schema);
+    schema: Schema | ((intent: Intent | null) => Schema);
     async: true;
 }): Promise<Submission<yup.InferType<Schema>, string[]>>;

package/index.js

@@ -25,7 +25,7 @@ function _interopNamespace(e) {
 
 var yup__namespace = /*#__PURE__*/_interopNamespace(yup);
 
-function getFieldsetConstraint(source) {
+function getYupConstraint(source) {
   var description = source.describe();
   return Object.fromEntries(Object.entries(description.fields).map(_ref => {
     var _test$params, _test$params3, _test$params5, _test$params6, _test$params8;
@@ -70,14 +70,18 @@ function getFieldsetConstraint(source) {
               constraint.required = true;
               break;
             case 'min':
-              dom.invariant(typeof constraint.min !== 'string', 'min is not a number');
+              if (typeof constraint.min === 'string') {
+                throw new Error('min should not be a string');
+              }
               if (!constraint.min || constraint.min < Number((_test$params6 = _test.params) === null || _test$params6 === void 0 ? void 0 : _test$params6.min)) {
                 var _test$params7;
                 constraint.min = Number((_test$params7 = _test.params) === null || _test$params7 === void 0 ? void 0 : _test$params7.min);
               }
               break;
             case 'max':
-              dom.invariant(typeof constraint.max !== 'string', 'max is not a number');
+              if (typeof constraint.max === 'string') {
+                throw new Error('max should not be a number');
+              }
               if (!constraint.max || constraint.max > Number((_test$params8 = _test.params) === null || _test$params8 === void 0 ? void 0 : _test$params8.max)) {
                 var _test$params9;
                 constraint.max = Number((_test$params9 = _test.params) === null || _test$params9 === void 0 ? void 0 : _test$params9.max);
@@ -92,8 +96,8 @@ function getFieldsetConstraint(source) {
 }
 function parseWithYup(payload, config) {
   return dom.parse(payload, {
-    resolve(payload, control) {
-      var schema = typeof config.schema === 'function' ? config.schema(control) : config.schema;
+    resolve(payload, intent) {
+      var schema = typeof config.schema === 'function' ? config.schema(intent) : config.schema;
       var resolveData = value => ({
         value
       });
@@ -127,5 +131,5 @@ function parseWithYup(payload, config) {
   });
 }
 
-exports.getFieldsetConstraint = getFieldsetConstraint;
+exports.getYupConstraint = getYupConstraint;
 exports.parseWithYup = parseWithYup;

package/index.mjs

@@ -1,7 +1,7 @@
-import { invariant, parse } from '@conform-to/dom';
+import { parse } from '@conform-to/dom';
 import * as yup from 'yup';
 
-function getFieldsetConstraint(source) {
+function getYupConstraint(source) {
   var description = source.describe();
   return Object.fromEntries(Object.entries(description.fields).map(_ref => {
     var _test$params, _test$params3, _test$params5, _test$params6, _test$params8;
@@ -46,14 +46,18 @@ function getFieldsetConstraint(source) {
               constraint.required = true;
               break;
             case 'min':
-              invariant(typeof constraint.min !== 'string', 'min is not a number');
+              if (typeof constraint.min === 'string') {
+                throw new Error('min should not be a string');
+              }
               if (!constraint.min || constraint.min < Number((_test$params6 = _test.params) === null || _test$params6 === void 0 ? void 0 : _test$params6.min)) {
                 var _test$params7;
                 constraint.min = Number((_test$params7 = _test.params) === null || _test$params7 === void 0 ? void 0 : _test$params7.min);
               }
               break;
             case 'max':
-              invariant(typeof constraint.max !== 'string', 'max is not a number');
+              if (typeof constraint.max === 'string') {
+                throw new Error('max should not be a number');
+              }
               if (!constraint.max || constraint.max > Number((_test$params8 = _test.params) === null || _test$params8 === void 0 ? void 0 : _test$params8.max)) {
                 var _test$params9;
                 constraint.max = Number((_test$params9 = _test.params) === null || _test$params9 === void 0 ? void 0 : _test$params9.max);
@@ -68,8 +72,8 @@ function getFieldsetConstraint(source) {
 }
 function parseWithYup(payload, config) {
   return parse(payload, {
-    resolve(payload, control) {
-      var schema = typeof config.schema === 'function' ? config.schema(control) : config.schema;
+    resolve(payload, intent) {
+      var schema = typeof config.schema === 'function' ? config.schema(intent) : config.schema;
       var resolveData = value => ({
         value
       });
@@ -103,4 +107,4 @@ function parseWithYup(payload, config) {
   });
 }
 
-export { getFieldsetConstraint, parseWithYup };
+export { getYupConstraint, parseWithYup };

package/package.json

@@ -3,7 +3,7 @@
 	"description": "Conform helpers for integrating with yup",
 	"homepage": "https://conform.guide",
 	"license": "MIT",
-	"version": "1.0.0-pre.5",
+	"version": "1.0.0-pre.7",
 	"main": "index.js",
 	"module": "index.mjs",
 	"types": "index.d.ts",
@@ -25,7 +25,7 @@
 		"url": "https://github.com/edmundhung/conform/issues"
 	},
 	"peerDependencies": {
-		"@conform-to/dom": "1.0.0-pre.5",
+		"@conform-to/dom": "1.0.0-pre.7",
 		"yup": ">=0.32.0"
 	},
 	"devDependencies": {

package/README.md

@@ -1,92 +0,0 @@
-# @conform-to/yup
-
-> [Conform](https://github.com/edmundhung/conform) helpers for integrating with [Yup](https://github.com/jquense/yup)
-
-<!-- aside -->
-
-## API Reference
-
-- [getFieldsetConstraint](#getfieldsetconstraint)
-- [parse](#parse)
-
-<!-- /aside -->
-
-### getFieldsetConstraint
-
-This tries to infer constraint of each field based on the yup schema. This is useful for:
-
-1. Making it easy to style input using CSS, e.g. `:required`
-2. Having some basic validation working before/without JS.
-
-```tsx
-import { useForm } from '@conform-to/react';
-import { getFieldsetConstraint } from '@conform-to/yup';
-import * as yup from 'yup';
-
-const schema = yup.object({
-  email: yup.string().required(),
-  password: yup.string().required(),
-});
-
-function Example() {
-  const [form, { email, password }] = useForm({
-    constraint: getFieldsetConstraint(schema),
-  });
-
-  // ...
-}
-```
-
-### parse
-
-It parses the formData and returns a submission result with the validation error. If no error is found, the parsed data will also be populated as `submission.value`.
-
-```tsx
-import { useForm } from '@conform-to/react';
-import { parse } from '@conform-to/yup';
-import * as yup from 'yup';
-
-const schema = yup.object({
-  email: yup.string().required(),
-  password: yup.string().required(),
-});
-
-function ExampleForm() {
-  const [form] = useForm({
-    onValidate({ formData }) {
-      return parse(formData, { schema });
-    },
-  });
-
-  // ...
-}
-```
-
-Or when parsing the formData on server side (e.g. Remix):
-
-```tsx
-import { useForm } from '@conform-to/react';
-import { parse } from '@conform-to/yup';
-import * as yup from 'yup';
-
-const schema = yup.object({
-  // Define the schema with yup
-});
-
-export async function action({ request }) {
-  const formData = await request.formData();
-  const submission = parse(formData, {
-    // If you need extra validation on server side
-    schema: schema.test(/* ... */),
-
-    // If the schema definition includes async validation
-    async: true,
-  });
-
-  if (submission.intent !== 'submit' || !submission.value) {
-    return submission;
-  }
-
-  // ...
-}
-```