remix-validated-form 0.0.3 → 1.1.1

package/.eslintcache

@@ -0,0 +1 @@
+[{"/Users/aaronpettengill/dev/remix-validated-form/src/server.ts":"1","/Users/aaronpettengill/dev/remix-validated-form/src/validation/types.ts":"2","/Users/aaronpettengill/dev/remix-validated-form/src/validation/withYup.ts":"3","/Users/aaronpettengill/dev/remix-validated-form/test-app/app/routes/validation.tsx":"4","/Users/aaronpettengill/dev/remix-validated-form/test-app/app/routes/validation-fetcher.tsx":"5","/Users/aaronpettengill/dev/remix-validated-form/test-app/cypress/integration/validation-with-fetchers.ts":"6","/Users/aaronpettengill/dev/remix-validated-form/src/validation/validation.test.ts":"7","/Users/aaronpettengill/dev/remix-validated-form/src/validation/withZod.ts":"8","/Users/aaronpettengill/dev/remix-validated-form/src/index.ts":"9"},{"size":207,"mtime":1637876506168,"results":"10","hashOfConfig":"11"},{"size":438,"mtime":1637877226360,"results":"12","hashOfConfig":"11"},{"size":1085,"mtime":1637877476573,"results":"13","hashOfConfig":"11"},{"size":1293,"mtime":1637876566355,"results":"14","hashOfConfig":"11"},{"size":1330,"mtime":1637902697212,"results":"15","hashOfConfig":"11"},{"size":2220,"mtime":1637902736281,"results":"16","hashOfConfig":"11"},{"size":3526,"mtime":1638155421909,"results":"17","hashOfConfig":"11"},{"size":1168,"mtime":1638155747107,"results":"18","hashOfConfig":"11"},{"size":196,"mtime":1638159719317,"results":"19","hashOfConfig":"11"},{"filePath":"20","messages":"21","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"bt07le",{"filePath":"22","messages":"23","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"24","messages":"25","errorCount":0,"fatalErrorCount":0,"warningCount":1,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"26","messages":"27","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"28","messages":"29","errorCount":0,"fatalErrorCount":0,"warningCount":1,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},{"filePath":"30","messages":"31","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"32","messages":"33","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"34","messages":"35","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"36","messages":"37","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/aaronpettengill/dev/remix-validated-form/src/server.ts",[],"/Users/aaronpettengill/dev/remix-validated-form/src/validation/types.ts",[],"/Users/aaronpettengill/dev/remix-validated-form/src/validation/withYup.ts",["38"],"/Users/aaronpettengill/dev/remix-validated-form/test-app/app/routes/validation.tsx",[],"/Users/aaronpettengill/dev/remix-validated-form/test-app/app/routes/validation-fetcher.tsx",["39"],"/Users/aaronpettengill/dev/remix-validated-form/test-app/cypress/integration/validation-with-fetchers.ts",[],"/Users/aaronpettengill/dev/remix-validated-form/src/validation/validation.test.ts",[],"/Users/aaronpettengill/dev/remix-validated-form/src/validation/withZod.ts",[],"/Users/aaronpettengill/dev/remix-validated-form/src/index.ts",[],{"ruleId":"40","severity":1,"message":"41","line":2,"column":23,"nodeType":"42","messageId":"43","endLine":2,"endColumn":39},{"ruleId":"40","severity":1,"message":"44","line":1,"column":26,"nodeType":"42","messageId":"43","endLine":1,"endColumn":39},"@typescript-eslint/no-unused-vars","'ValidationResult' is defined but never used.","Identifier","unusedVar","'useActionData' is defined but never used."]

package/README.md

@@ -1,3 +1,182 @@
 # Remix Validated Form
 
-A form library built for [remix](https://remix.run).
+A form library built for [remix](https://remix.run) to make validation easy.
+
+- Client-side, field-by-field validation (e.g. validate on blur) and form-level validation
+- Set default values for the entire form in one place
+- Re-use validation on the server
+- Show validation errors from the server even without JS
+- Detect if the current form is submitting when there are multiple forms on the page
+- Validation library agnostic
+
+# Demo
+
+https://user-images.githubusercontent.com/25882770/143505448-c4b7e660-7a73-4005-b2ca-17c65a15ef46.mov
+
+# Getting started
+
+## Install
+
+```bash
+npm install remix-validated-form
+```
+
+## Create an input component
+
+In order to display field errors or do field-by-field validation,
+it's recommended to incorporate this library into an input component using `useField`.
+
+```tsx
+import { useField } from "remix-validated-form";
+
+type MyInputProps = {
+  name: string;
+  label: string;
+};
+
+export const MyInput = ({ name, label }: InputProps) => {
+  const { validate, clearError, defaultValue, error } = useField(name);
+  return (
+    <div>
+      <label htmlFor={name}>{label}</label>
+      <input
+        id={name}
+        name={name}
+        onBlur={validate}
+        onChange={clearError}
+        defaultValue={defaultValue}
+      />
+      {error && <span className="my-error-class">{error}</span>}
+    </div>
+  );
+};
+```
+
+## Create a submit button component
+
+To best take advantage of the per-form submission detection, we can create a submit button component.
+
+```tsx
+import { useIsSubmitting } from "../../remix-validated-form";
+
+export const MySubmitButton = () => {
+  const isSubmitting = useIsSubmitting();
+  return (
+    <button type="submit" disabled={isSubmitting}>
+      {isSubmitting ? "Submitting..." : "Submit"}
+    </button>
+  );
+};
+```
+
+## Use the form!
+
+Now that we have our components, making a form is easy!
+
+```tsx
+import { ActionFunction, LoaderFunction, redirect, useLoaderData } from "remix";
+import * as yup from "yup";
+import { validationError, ValidatedForm, withYup } from "remix-validated-form";
+import { MyInput, MySubmitButton } from "~/components/Input";
+
+// Using yup in this example, but you can use anything
+const validator = withYup(
+  yup.object({
+    firstName: yup.string().label("First Name").required(),
+    lastName: yup.string().label("Last Name").required(),
+    email: yup.string().email().label("Email").required(),
+  })
+);
+
+export const action: ActionFunction = async ({ request }) => {
+  const fieldValues = validator.validate(
+    Object.fromEntries(await request.formData())
+  );
+  if (fieldValues.error) return validationError(fieldValues.error);
+  const { firstName, lastName, email } = fieldValues.data;
+
+  // Do something with correctly typed values;
+
+  return redirect("/");
+};
+
+export const loader: LoaderFunction = () => {
+  return {
+    defaultValues: {
+      firstName: "Jane",
+      lastName: "Doe",
+      email: "jane.doe@example.com",
+    },
+  };
+};
+
+export default function MyForm() {
+  const { defaultValues } = useLoaderData();
+  return (
+    <ValidatedForm
+      validator={validator}
+      method="post"
+      defaultValues={defaultValues}
+    >
+      <MyInput name="firstName" label="First Name" />
+      <MyInput name="lastName" label="Last Name" />
+      <MyInput name="email" label="Email" />
+      <MySubmitButton />
+    </ValidatedForm>
+  );
+}
+```
+
+# Validation Library Support
+
+This library currently includes an out-of-the-box adapter for `yup` and `zod`,
+but you can easily support whatever library you want by creating your own adapter.
+
+And if you create an adapter for a library, feel free to make a PR on this library to add official support 😊
+
+## Creating an adapter
+
+Any object that conforms to the `Validator` type can be passed into the the `ValidatedForm`'s `validator` prop.
+
+```ts
+type FieldErrors = Record<string, string>;
+
+type ValidationResult<DataType> =
+  | { data: DataType; error: undefined }
+  | { error: FieldErrors; data: undefined };
+
+type ValidateFieldResult = { error?: string };
+
+type Validator<DataType> = {
+  validate: (unvalidatedData: unknown) => ValidationResult<DataType>;
+  validateField: (
+    unvalidatedData: unknown,
+    field: string
+  ) => ValidateFieldResult;
+};
+```
+
+In order to make an adapter for your validation library of choice,
+you can create a function that accepts a schema from the validation library and turns it into a validator.
+
+The out-of-the-box support for `yup` in this library works like this:
+
+```ts
+export const withYup = <Schema extends AnyObjectSchema>(
+  validationSchema: Schema
+  // For best result with Typescript, we should type the `Validator` we return based on the provided schema
+): Validator<InferType<Schema>> => ({
+  validate: (unvalidatedData) => {
+    // Validate with yup and return the validated & typed data or the error
+
+    if (isValid) return { data: { field1: "someValue" }, error: undefined };
+    else return { error: { field1: "Some error!" }, data: undefined };
+  },
+  validateField: (unvalidatedData, field) => {
+    // Validate the specific field with yup
+
+    if (isValid) return { error: undefined };
+    else return { error: "Some error" };
+  },
+});
+```

package/browser/index.d.ts

@@ -3,3 +3,4 @@ export * from "./server";
 export * from "./ValidatedForm";
 export * from "./validation/types";
 export * from "./validation/withYup";
+export * from "./validation/withZod";

package/browser/index.js

@@ -3,3 +3,4 @@ export * from "./server";
 export * from "./ValidatedForm";
 export * from "./validation/types";
 export * from "./validation/withYup";
+export * from "./validation/withZod";

package/browser/server.d.ts

@@ -1,2 +1,2 @@
 import { FieldErrors } from "./validation/types";
-export declare const fieldErrors: (errors: FieldErrors) => Response;
+export declare const validationError: (errors: FieldErrors) => Response;

package/browser/server.js

@@ -1,2 +1,2 @@
 import { json } from "@remix-run/server-runtime";
-export const fieldErrors = (errors) => json({ fieldErrors: errors }, { status: 422 });
+export const validationError = (errors) => json({ fieldErrors: errors }, { status: 422 });

package/browser/validation/types.d.ts

@@ -10,6 +10,6 @@ export declare type ValidateFieldResult = {
     error?: string;
 };
 export declare type Validator<DataType> = {
-    validate: (formData: unknown) => ValidationResult<DataType>;
-    validateField: (formData: unknown, field: string) => ValidateFieldResult;
+    validate: (unvalidatedData: unknown) => ValidationResult<DataType>;
+    validateField: (unvalidatedData: unknown, field: string) => ValidateFieldResult;
 };

package/browser/validation/validation.test.js

@@ -1,5 +1,7 @@
 import * as yup from "yup";
+import { z } from "zod";
 import { withYup } from "..";
+import { withZod } from "./withZod";
 const validationTestCases = [
     {
         name: "yup",
@@ -9,6 +11,14 @@ const validationTestCases = [
             age: yup.number(),
         })),
     },
+    {
+        name: "zod",
+        validator: withZod(z.object({
+            firstName: z.string().nonempty(),
+            lastName: z.string().nonempty(),
+            age: z.optional(z.number()),
+        })),
+    },
 ];
 // Not going to enforce exact error strings here
 const anyString = expect.any(String);
@@ -40,7 +50,10 @@ describe("Validation", () => {
         });
         describe("validateField", () => {
             it("should not return an error if field is valid", () => {
-                const obj = { firstName: "John", lastName: 123 };
+                const obj = {
+                    firstName: "John",
+                    lastName: {}, // invalid, but we should only be validating firstName
+                };
                 expect(validator.validateField(obj, "firstName")).toEqual({
                     error: undefined,
                 });
@@ -54,3 +67,54 @@ describe("Validation", () => {
         });
     });
 });
+describe("withZod", () => {
+    it("returns coherent errors for complex schemas", () => {
+        const schema = z.union([
+            z.object({
+                type: z.literal("foo"),
+                foo: z.string(),
+            }),
+            z.object({
+                type: z.literal("bar"),
+                bar: z.string(),
+            }),
+        ]);
+        const obj = {
+            type: "foo",
+            bar: 123,
+            foo: 123,
+        };
+        expect(withZod(schema).validate(obj)).toEqual({
+            data: undefined,
+            error: {
+                type: anyString,
+                bar: anyString,
+                foo: anyString,
+            },
+        });
+    });
+    it("returns errors for fields that are unions", () => {
+        const schema = z.object({
+            field1: z.union([z.literal("foo"), z.literal("bar")]),
+            field2: z.union([z.literal("foo"), z.literal("bar")]),
+        });
+        const obj = {
+            field1: "a value",
+            // field2 missing
+        };
+        const validator = withZod(schema);
+        expect(validator.validate(obj)).toEqual({
+            data: undefined,
+            error: {
+                field1: anyString,
+                field2: anyString,
+            },
+        });
+        expect(validator.validateField(obj, "field1")).toEqual({
+            error: anyString,
+        });
+        expect(validator.validateField(obj, "field2")).toEqual({
+            error: anyString,
+        });
+    });
+});

package/browser/validation/withZod.d.ts

@@ -0,0 +1,3 @@
+import type { z } from "zod";
+import { Validator } from "..";
+export declare function withZod<T>(zodSchema: z.Schema<T>): Validator<T>;

package/browser/validation/withZod.js

@@ -0,0 +1,35 @@
+const getIssuesForError = (err) => {
+    return err.issues.flatMap((issue) => {
+        if ("unionErrors" in issue) {
+            return issue.unionErrors.flatMap((err) => getIssuesForError(err));
+        }
+        else {
+            return [issue];
+        }
+    });
+};
+export function withZod(zodSchema) {
+    return {
+        validate: (value) => {
+            const result = zodSchema.safeParse(value);
+            if (result.success)
+                return { data: result.data, error: undefined };
+            const fieldErrors = {};
+            getIssuesForError(result.error).forEach((issue) => {
+                const path = issue.path.join(".");
+                if (!fieldErrors[path])
+                    fieldErrors[path] = issue.message;
+            });
+            return { error: fieldErrors, data: undefined };
+        },
+        validateField: (data, field) => {
+            var _a;
+            const result = zodSchema.safeParse(data);
+            if (result.success)
+                return { error: undefined };
+            return {
+                error: (_a = getIssuesForError(result.error).find((issue) => issue.path.join(".") === field)) === null || _a === void 0 ? void 0 : _a.message,
+            };
+        },
+    };
+}

package/build/index.d.ts

@@ -3,3 +3,4 @@ export * from "./server";
 export * from "./ValidatedForm";
 export * from "./validation/types";
 export * from "./validation/withYup";
+export * from "./validation/withZod";

package/build/index.js

@@ -15,3 +15,4 @@ __exportStar(require("./server"), exports);
 __exportStar(require("./ValidatedForm"), exports);
 __exportStar(require("./validation/types"), exports);
 __exportStar(require("./validation/withYup"), exports);
+__exportStar(require("./validation/withZod"), exports);

package/build/server.d.ts

@@ -1,2 +1,2 @@
 import { FieldErrors } from "./validation/types";
-export declare const fieldErrors: (errors: FieldErrors) => Response;
+export declare const validationError: (errors: FieldErrors) => Response;

package/build/server.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fieldErrors = void 0;
+exports.validationError = void 0;
 const server_runtime_1 = require("@remix-run/server-runtime");
-const fieldErrors = (errors) => (0, server_runtime_1.json)({ fieldErrors: errors }, { status: 422 });
-exports.fieldErrors = fieldErrors;
+const validationError = (errors) => (0, server_runtime_1.json)({ fieldErrors: errors }, { status: 422 });
+exports.validationError = validationError;

package/build/validation/types.d.ts

@@ -10,6 +10,6 @@ export declare type ValidateFieldResult = {
     error?: string;
 };
 export declare type Validator<DataType> = {
-    validate: (formData: unknown) => ValidationResult<DataType>;
-    validateField: (formData: unknown, field: string) => ValidateFieldResult;
+    validate: (unvalidatedData: unknown) => ValidationResult<DataType>;
+    validateField: (unvalidatedData: unknown, field: string) => ValidateFieldResult;
 };

package/build/validation/validation.test.js

@@ -20,7 +20,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const yup = __importStar(require("yup"));
+const zod_1 = require("zod");
 const __1 = require("..");
+const withZod_1 = require("./withZod");
 const validationTestCases = [
     {
         name: "yup",
@@ -30,6 +32,14 @@ const validationTestCases = [
             age: yup.number(),
         })),
     },
+    {
+        name: "zod",
+        validator: (0, withZod_1.withZod)(zod_1.z.object({
+            firstName: zod_1.z.string().nonempty(),
+            lastName: zod_1.z.string().nonempty(),
+            age: zod_1.z.optional(zod_1.z.number()),
+        })),
+    },
 ];
 // Not going to enforce exact error strings here
 const anyString = expect.any(String);
@@ -61,7 +71,10 @@ describe("Validation", () => {
         });
         describe("validateField", () => {
             it("should not return an error if field is valid", () => {
-                const obj = { firstName: "John", lastName: 123 };
+                const obj = {
+                    firstName: "John",
+                    lastName: {}, // invalid, but we should only be validating firstName
+                };
                 expect(validator.validateField(obj, "firstName")).toEqual({
                     error: undefined,
                 });
@@ -75,3 +88,54 @@ describe("Validation", () => {
         });
     });
 });
+describe("withZod", () => {
+    it("returns coherent errors for complex schemas", () => {
+        const schema = zod_1.z.union([
+            zod_1.z.object({
+                type: zod_1.z.literal("foo"),
+                foo: zod_1.z.string(),
+            }),
+            zod_1.z.object({
+                type: zod_1.z.literal("bar"),
+                bar: zod_1.z.string(),
+            }),
+        ]);
+        const obj = {
+            type: "foo",
+            bar: 123,
+            foo: 123,
+        };
+        expect((0, withZod_1.withZod)(schema).validate(obj)).toEqual({
+            data: undefined,
+            error: {
+                type: anyString,
+                bar: anyString,
+                foo: anyString,
+            },
+        });
+    });
+    it("returns errors for fields that are unions", () => {
+        const schema = zod_1.z.object({
+            field1: zod_1.z.union([zod_1.z.literal("foo"), zod_1.z.literal("bar")]),
+            field2: zod_1.z.union([zod_1.z.literal("foo"), zod_1.z.literal("bar")]),
+        });
+        const obj = {
+            field1: "a value",
+            // field2 missing
+        };
+        const validator = (0, withZod_1.withZod)(schema);
+        expect(validator.validate(obj)).toEqual({
+            data: undefined,
+            error: {
+                field1: anyString,
+                field2: anyString,
+            },
+        });
+        expect(validator.validateField(obj, "field1")).toEqual({
+            error: anyString,
+        });
+        expect(validator.validateField(obj, "field2")).toEqual({
+            error: anyString,
+        });
+    });
+});

package/build/validation/withZod.d.ts

@@ -0,0 +1,3 @@
+import type { z } from "zod";
+import { Validator } from "..";
+export declare function withZod<T>(zodSchema: z.Schema<T>): Validator<T>;

package/build/validation/withZod.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withZod = void 0;
+const getIssuesForError = (err) => {
+    return err.issues.flatMap((issue) => {
+        if ("unionErrors" in issue) {
+            return issue.unionErrors.flatMap((err) => getIssuesForError(err));
+        }
+        else {
+            return [issue];
+        }
+    });
+};
+function withZod(zodSchema) {
+    return {
+        validate: (value) => {
+            const result = zodSchema.safeParse(value);
+            if (result.success)
+                return { data: result.data, error: undefined };
+            const fieldErrors = {};
+            getIssuesForError(result.error).forEach((issue) => {
+                const path = issue.path.join(".");
+                if (!fieldErrors[path])
+                    fieldErrors[path] = issue.message;
+            });
+            return { error: fieldErrors, data: undefined };
+        },
+        validateField: (data, field) => {
+            var _a;
+            const result = zodSchema.safeParse(data);
+            if (result.success)
+                return { error: undefined };
+            return {
+                error: (_a = getIssuesForError(result.error).find((issue) => issue.path.join(".") === field)) === null || _a === void 0 ? void 0 : _a.message,
+            };
+        },
+    };
+}
+exports.withZod = withZod;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remix-validated-form",
-  "version": "0.0.3",
+  "version": "1.1.1",
   "description": "Form component and utils for easy form validation in remix",
   "browser": "./browser/index.js",
   "main": "./build/index.js",
@@ -64,7 +64,8 @@
     "react": "^17.0.2",
     "ts-jest": "^27.0.7",
     "typescript": "^4.5.2",
-    "yup": "^0.32.11"
+    "yup": "^0.32.11",
+    "zod": "^3.11.6"
   },
   "dependencies": {
     "tiny-invariant": "^1.2.0"