JSON utility type

I just found myself needing a generic type for any valid JSON and put this together:

type Literal = boolean | null | number | string;
type Json = Literal | { [key: string]: Json } | Json[];

const Literal = Zod.union([Zod.boolean(), Zod.null(), Zod.number(), Zod.string()]);
const Json: Zod.ZodType<Json> = Zod.lazy(() =>
  Zod.union([Literal, Zod.array(Json), Zod.record(Json)])
);

Putting this in an issue for anyone who might be on the lookout or if the library might want to integrate a higher-level utility constructs like this.

[deini]

Now that the requirement is 4.1+, any chance z.json() gets revisited?

[colinhacks]

Yikes! When I copied the snippet above into the README I renamed Json to jsonSchema (to avoid confusion with the built-in JSON class) but I forgot to change it everywhere 😬 Here’s the correct snippet:

type Literal = boolean | null | number | string;
type Json = Literal | { [key: string]: Json } | Json[];
const literalSchema = z.union([z.string(), z.number(), z.boolean(), z.null()]);
const jsonSchema: z.ZodSchema<Json> = z.lazy(() =>
  z.union([literalSchema, z.array(jsonSchema), z.record(jsonSchema)]),
);

jsonSchema.parse({
  // data
})

Thanks for pointing this out! I fixed this in the README as well.