@sanity-typed/groq-zod

[saiichihashimoto]

A schema aware GROQ zod parser would need:

GROQ Zod Parser
= typed runtime ast to zod parser(typed runtime schema, typed runtime groq parsed ast)
= typed runtime ast to zod parser(@sanity-typed/types, @sanity-typed/groq-js)

Is this not technically possible? We have typed runtime values for everything we'd need to generate a zod parser for GROQ queries.

[saiichihashimoto]

https://formidable.com/open-source/groqd/
https://github.com/stipsan/groqz

[saiichihashimoto]

This is... so complicated. Picking apart any zod schema to transform it is very difficult (and sometimes impossible). The fact that @sanity-typed/zod does refinements that create ZodEffects immediately makes this challenging.

[saiichihashimoto]

I don't think I'm going to do this.

• There's no really good way to pick apart zod schemas, arbitrarily. For example, a ZodObject with a few refinements and an intersection immediately becomes un-pickable, let alone able to be transformed with a GROQ projection.
• We'd need an intermediate schema representation of a type that we'd be able to transform like that
• Sanity's schemas wouldn't work for that representation, since there's datatypes involved not represented, so we'd have to create it from scratch (or use some third party one although it would need to preserving type safety throughout transformations).
• Regardless, we'd have to translate sanity's schema types to that representation, just like we did for @sanity-typed/zod or @sanity-typed/faker, which sounds exhausting.

It's definitely possible. But the scope of this rivals the scope of the rest of the monorepo, possibly even more. I'm not doing that. It's still within the vision, but I definitely can't justify actually spending time on that.

[saiichihashimoto]

https://www.npmjs.com/package/groq-builder is definitely my recommended solution atm, so go look there!