A typed, zero-dependency schema generator and query builder for Sanity.
MIT License
A zero-dependency schema generator and query builder that is fully-typed and works in JavaScript and TypeScript.
"prop": my.prop
)Help and contributions are welcome.
First install sanity-typed-queries
:
yarn add sanity-typed-queries
# or npm
npm install sanity-typed-queries --save
Now you will need to generate your Sanity schema documents using the schema builder. You will get documentation as you type, and enforced compliance with Sanity's schema builder, such as being able to see validation rules applicable to the type of field you are creating, and so on.
schema/author.js
:
import { defineDocument } from 'sanity-typed-queries'
const { document } = defineDocument('author', {
name: {
type: 'string',
validation: Rule => Rule.required(),
},
biography: {
type: 'text',
rows: 4,
},
yearOfBirth: {
type: 'number',
},
})
export default document
This is equivalent to defining the following schema:
export default {
name: 'author',
title: 'Author',
type: 'document',
fields: [
{
name: 'name',
title: 'Name',
type: 'string',
validation: Rule => Rule.required(),
},
{
name: 'biography',
title: 'Biography',
type: 'text',
rows: 4,
},
{
name: 'yearOfBirth',
title: 'Year Of Birth',
type: 'number',
},
],
}
For more documentation, see this GROQ/query builder cheat sheet.
You can also export a query builder from the same file.
import { defineDocument } from 'sanity-typed-queries'
const { document, builder } = defineDocument('author', {
...
})
// Export your query builder for use elsewhere
export { builder }
export default document
You can use this builder elsewhere to generate the appropriate types and GROQ queries. For example:
import { builder as authorBuilder } from './cms/schema/author.js'
const [query, type] = authorBuilder.pick('name').first().use()
// *[_type == 'author'][0].name
const queryString = query
// string
type AuthorName = typeof type
If you're using the Sanity client, you might use it like this:
import sanityClient from '@sanity/client'
import { author } from './cms/schema/author.js'
const [query, type] = author.pick('name').first().use()
const client = sanityClient(config)
// Promise<string>
const result = client.fetch<typeof type>(query)
You can export utility objects or documents for reference within other schemas.
schema/tag.js
:
import { defineObject } from 'sanity-typed-queries'
const { tag, object } = defineObject('tag', {
...
})
export { tag }
export default object
Then you can pass that when defining documents that reference it.
schema/author.js
:
import { defineObject } from 'sanity-typed-queries'
import { tag } from './tag'
const { builder, document } = defineDocument(
'author',
{
tag: {
type: 'tag',
},
},
[tag]
)
export default document
Projects I've found helpful are:
This has been developed to suit my needs but additional use cases and contributions are very welcome.
MIT License - Copyright © Daniel Roe