typed-schema

typed-schemaTypeScript-first Sanity schemas

Declare a content model once. Get its TypeScript types and a runtime validator from the same definition.

Get started
Try the playground
GitHub

  • Inferred types

    Infer<typeof schema> gives you the document type, including _key on array items and the system fields Sanity adds.

  • Constraints at compile time

    Arrays of arrays, untyped object unions and reserved field names are type errors in your editor, not runtime errors in the Studio.

  • Runtime validation

    parse checks incoming data against the same schema and reports every problem with its path.

  • Standard Schema

    Every schema implements Standard Schema, so form libraries, routers and RPC frameworks that support it accept typed schemas directly.

  • Plain, shareable data

    Schemas contain no React or Studio code, so you can publish them to npm and use them in Node, edge runtimes or the browser.

ts
import * as 
s
 from '@sanity-labs/typed-schema'

export const 
Recipe
 = 
s
.
document
({
  
_type
: 
s
.
literal
('recipe'),
  
title
: 
s
.
string
(),
  
servings
: 
s
.
optional
(
s
.
number
()),
})

export type 
Recipe
 = 
s
.
Infer
<typeof 
Recipe
>

const 
result
 = 
s
.
parse
(
Recipe
, await 
client
.
fetch
('*[_type == "recipe"][0]'))

if (
result
.
ok
) {
  const recipe = 
result
.
value
      
const recipe: {
    _type: "recipe";
    _id?: string | undefined;
    _createdAt?: string | undefined;
    _updatedAt?: string | undefined;
    _rev?: string | undefined;
    title: string;
    servings?: number | undefined;
}
} else {
  // for a recipe without a title and with "four" as servings:
  // Invalid input (2 issues):
  //   title: Expected a string
  //   servings: Expected a finite number
  
console
.
error
(
result
.
error
.
message
)
}