stq
5.0/51
sanity-typed-queries
npm i sanity-typed-queries
stq

sanity-typed-queries

A typed, zero-dependency schema generator and query builder for Sanity.

by Daniel Roe

0.9.1 (see all)License:MITTypeScript:Built-In
npm i sanity-typed-queries
Readme

🔤 sanity-typed-queries

A typed query generator for Sanity

A zero-dependency schema generator and query builder that is fully-typed and works in JavaScript and TypeScript.

Features

  • 📚 Documentation: Sanity documentation appears as you type.
  • 💪 TypeScript: Written in TypeScript.

Progress

  • Fully typed schema builder
  • Query builder (working with string, boolean, number), ordering, projections
  • Inferred type of arrays
  • Support for object types with subfields
  • Custom mappings ("prop": my.prop)
  • Resolving image and file types
  • Resolving custom object/document types
  • Distinguish object/document types within valid field types
  • Additional query filters
  • Querying multiple types of document

Help and contributions are welcome.

Quick Start

First install sanity-typed-queries:

yarn add sanity-typed-queries

# or npm

npm install sanity-typed-queries --save

Schema definition

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',
    },
  ],
}

Query builder

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)

Custom types

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

Inspirations

Projects I've found helpful are:

Contributors

This has been developed to suit my needs but additional use cases and contributions are very welcome.

License

MIT License - Copyright © Daniel Roe

Downloads/wk

1.4K

GitHub Stars

110

LAST COMMIT

7mos ago

MAINTAINERS

1

CONTRIBUTORS

6

OPEN ISSUES

5

OPEN PRs

1
VersionTagPublished
0.9.1
latest
2mos ago
0.6.5-beta.0
beta
3yrs ago
No alternatives found
No tutorials found
Add a tutorial
No dependencies found

Rate & Review

100