⚠ Please use latest version

All bugs related to peer dependency, fail to parsing, and other bugs has been fixed in latest version

If you still have any problem, please make an issue in the GitHub repository

---

What's New on v.1.5.5?

• Add support for ZodDefault, ZodPromise, ZodReadonly, and ZodNaN
• Add support for ZodEffects (refine, transform, etc)
• BREAKING CHANGE: If you use customStringParser, the props is now an object instead of single string
• Add more string parser options
• Fix broken Date validation
• Deprecating prismaKeys, use selectKeys instead

Zod Key Parser

Parse your Zod schema into keys or ORM select format

What This Do?

Transform this schema:

1import { parseZodSchema } from "zod-key-parser";
2
3const schema = z.object({
4    a: z.boolean(),
5    b: z.string(),
6    c: z.string(),
7    d: z.string(),
8    e: z.string(),
9    f: z.string(),
10    g: z.string(),
11    h: z.array(
12        z.object({
13            ha: z.number(),
14            hb: z.string(),
15            hc: z.boolean(),
16            hd: z.string(),
17        })
18    ),
19    i: z.object({
20        ia: z.number(),
21    }),
22});

Into This

1// schema.keys
2
3{
4  "a": "a",
5  "b": "b",
6  "c": "c",
7  "d": "d",
8  "e": "e",
9  "f": "f",
10  "g": "g",
11  "h": (index: number) => {
12  	"ha": `h.${index}.ha`,
13  	"hb": `h.${index}.hb`,
14  	"hc": `h.${index}.hc`,
15  	"hd": `h.${index}.hd`,
16  },
17  "i": {
18    "ia": "i.ia"
19  }
20}

So that you can use it on your form like this:

1
2<input name={schema.keys.a} type="string" ... />
3

And This

1// schema.selectKeys
2{
3  "a": true,
4  "b": true,
5  "c": true,
6  "d": true,
7  "e": true,
8  "f": true,
9  "g": true,
10  "h": {
11    "select": {
12      "ha": true,
13      "hb": true,
14      "hc": true,
15      "hd": true
16    }
17  },
18  "i": {
19    "select": {
20      "ia": true
21    }
22  }
23}

So that you can use it on your ORM like this

1const something = await orm.table.findUnique({
2  where: ...,
3  select: schema.selectKeys
4})

How About the Opposite? Don't Worry

There's 2 function, formatObject and formatFormData() that you can use

1. formatObject(object)

Use it to format object to keys format

• Format this:

1const inputData = {
2    formkey1: "something",
3    formkey2: "something",
4    "formkey3.a": "something",
5    "formkey3.b": "something",
6    "formkey5.c": "something",
7    "formarray.0.a": "something",
8    "formarray.1.a": "something",
9    "formarray.1.ab": "something",
10    "formarray.2.c.d.0.a": "true",
11    "formarray.2.c.d.1.a": "true",
12};
13
14const formattedData = formatObject(inputData);

• Into this

1// formattedData
2{
3  "formkey1": "something",
4  "formkey2": "something",
5  "formkey3": {
6    "a": "something",
7    "b": "something"
8  },
9  "formkey5": {
10    "c": "something"
11  },
12  "formarray": [
13    {
14      "a": "something"
15    },
16    {
17      "a": "something",
18      "ab": "something"
19    },
20    {
21      "c": {
22        "d": [
23          {
24            "a": true
25          },
26          {
27            "a": true
28          }
29        ]
30      }
31    }
32  ]
33}

2. formatFormData(formData)

Use it to format data from form action directly, especially for React/Next.js user who use server action

It also use formatObject() under the hood

1const formAction = (formData: FormData) => {
2  const parsed = schema.safeParse(formatFormData(formData));
3
4  if (!parsed.success) {
5    ...
6  }
7}
8
9return (
10  <form action={formAction}>
11      <input name={schema.keys.a} />
12      <input name={schema.keys.b} />
13  </form>
14)

What's The Point of This?

Pros

• Avoid typos in form name
• Easily parsed form data with a little lines of code
• For ORM, improve your database performance by only selecting data to be used
• You'll lovin it like McDonalds says

Cons

• Idk, maybe it's just too much for you? let me know

What You Should Know

• Currently it doesn't support non object schema, if your schema is just like z.string() it wont parse anything since it doesn't have a key
• It Supports ZodEnum, ZodUnion, ZodIntersection, ZodArray, ZodOptional, ZodNullable, and ZodObject also of course the primitives type like string, boolean and so on, i don't know if there are any Zod class that i should be aware of since i myself doesn't use anything beside what I've specify before.

Any Suggestion or Problem?

Feel free to reach me at me@raflymaulana.me or just make a GitHub issue at this repository.