zod-to-camel-case

zod-to-camel-case

Convert zod schema object keys to camel case.

Usage

The zodToCamelCase supports both unidirectional and bidirectional transformation of zod schemas

zodToCamelCase (unidirectional)

By default zodToCamelCase supports unidirectional transformation of the schema.

So the input will be expected to in the original snake-case format. The output data/type will still be camel-case.

import { z } from "zod";
import zodToCamelCase from "zod-to-camel-case";

const userSchemaSnake = z.object({
  full_name: z.string(),
  user: z.object({
    email_addresses: z.array(z.email()),
  }),
});
const userSchema = zodToCamelCase(userSchemaSnake);

// Infer the type using zod
type User = z.infer<typeof userSchema>;
// type => { fullName: string, user: { emailAddresses: string[] } }

// This input is snake-case
const results = userSchema.parse({
  full_name: "Turanga Leela",
  user: {
    email_addresses: ["[e-mail]"],
  },
});

// Assert that the output is camel-case
expect(results).toEqual({
  fullName: "Turanga Leela",
  user: {
    emailAddresses: ["[e-mail]"],
  },
});

zodToCamelCase (bidirectional)

By passing {bidirectional: true} as a second option to zodToCamelCase will change the expected input to be camel-case.

import { z } from "zod";
import zodToCamelCase from "zod-to-camel-case";

const userSchemaSnake = z.object({
  full_name: z.string(),
  user: z.object({
    email_addresses: z.array(z.email()),
  }),
});
const userSchema = zodToCamelCase(userSchemaSnake, {
  bidirectional: true, // ‼️ enabling bidirectional mode
});

// Infer the type using zod
type User = z.infer<typeof userSchema>;
// type => { fullName: string, user: { emailAddresses: string[] } }

// This input is camel-case
// 🎉 The input to parse() & safeParse() is now camel case
const results = userSchema.parse({
  fullName: "Turanga Leela",
  user: {
    emailAddresses: ["[e-mail]"],
  },
});

// Assert that the output is camel-case
expect(results).toEqual({
  fullName: "Turanga Leela",
  user: {
    emailAddresses: ["[e-mail]"],
  },
});

Test

To run the tests run, in non-watch mode the coverage reports are available at ./coverage/index.html

npm test

Or for watch mode (no coverage reports)

npm run test:watch

License

MIT