sanity-zodify v0.0.4

Sanity Zodify

A toolkit to maintain typesafety when working with data from Sanity - intended for use with groq, but not a requirement.

Now

This kit includes Zod models to help build your schema faster.

Next

I hope to generate models from your Sanity Schema to reduce the time to setup your queries.

Why not just use Zod types?

You could use Zod types, but you would need to write more boilerplate. This kit aims to codify the proccess of setting up types for your project with convenient transforms of values like date strings into Date objects you can use in your code.

Installation

# npm
npm i -D sanity-zodify

# yarn
yarn add -D sanity-zodify

# pnpm
pnpm add -D sanity-zodify

Usage

Note: This is a work in progress, I'll add better docs later™️

import { z } from 'zod';
import * as S from './src';

const colors = z.union([z.literal('red'), z.literal('green'), z.literal('blue')]);

const Homepage = S.Document.extend({
	title: z.String,
	subtitle: S.String.optional(),
	thumbnail: S.Image,
	colors: z.union([z.literal('red'), z.literal('green'), z.literal('blue')]),
	authors: z.array(S.String),
	publishAt: S.Datetime,
});

// raw_data is NOT type safe.
const awesome_data = Homepage.parse(raw_data);

// awesome_data IS type safe.
console.log(awesome_data.title);