Get help on Discord

TypeScript types for Sanity desk structure builder `S` parameter

16 replies
Last updated: Aug 9, 2023
Hi, I just created a custom desk structure and I was wondering whether there are built-in types for the 
S
structure builder provided by Sanity?
The following is my example code:

export const deskStructure = (S) =>
  S.list()
    .title('Content')
    .items([
      ...S.documentTypeListItems().filter(
        (listItem) => !['archive'].includes(listItem.getId()),
      ),
    ]);
However, since there I am currently not using some 
S
type, there is no intellisense at all.I did look up the official docs on this matter, though I could not seem to find any type for this.

Feedback is much appreciated!
😊
AI Update

Yes, there are built-in TypeScript types for the Structure Builder! The S parameter in your desk structure function is typed.

To get proper TypeScript intellisense, you should import and use the StructureResolver type from sanity/structure. Here's how to add types to your code:

import type {StructureResolver} from 'sanity/structure'

export const structure: StructureResolver = (S) =>
  S.list()
    .title('Content')
    .items([
      ...S.documentTypeListItems().filter(
        (listItem) => !['archive'].includes(listItem.getId()),
      ),
    ])

By typing your structure export as StructureResolver, TypeScript will automatically infer the correct type for the S parameter, giving you full intellisense for all the Structure Builder methods like .list(), .listItem(), .document(), etc.

The Structure Builder API reference documentation has more details on all available methods and their types. The StructureResolver type is the key to unlocking intellisense for your custom desk structures in Sanity Studio v3+.

If you're using JavaScript instead of TypeScript, you can still get some intellisense by adding a JSDoc comment:

/** @type {import('sanity/structure').StructureResolver} */
export const structure = (S) =>
  S.list()
    .title('Content')
    .items([
      // your structure here
    ])
Show original thread
16 replies
Can you try importing the 
StructureResolver
type from 
sanity/desk
? I think that’ll be what you need.
user A
I actually already tried that one before. The structure builder methods don't seem to exist on it, hence using it as the type for 
S
does not work.
And while we are at it, what is the recommended way for generating types for your schemas / groq-query responses? 🙂
Interesting. What if you give 
S
the type 
StructureBuilder
?
user A
That's it! Thank you very much for your time and help!Would you mind to lead me in the right direction on my other question about generating types for your schemas?
🙂
Great! Glad that’s working for you.
I’ve seen offerings like
codegen and sanity-typed , but haven’t used any of them myself and couldn’t offer much in terms of advice, I’m afraid.
user A
Alright, I see! And do you know if there are types for your 
sanity.config.ts
and 
schemas/
files (like intellisense for creating the actual schemas)?Would make it a lot easier to configure things, without constantly having to check the docs
Is that where you use methods like 
defineType()
, 
defineField()
and so on?
user A
One last question: is there a proper way of excluding a document from the "Create new document" menu at the top-left of your studio?I already have overwritten the document actions in my 
sanity.config.ts
, to not show the delete button from some documents, but I don't want multiple instances of them to exist either.
Yes, please check out this guide . It’s about singletons but covers removing a document type from the create new menu.
Thank you! Sometimes I find it hard to actually find these kind of things in your docs.Exceptional support though! Much appreciated!
I wish you a lovely day / evening!
😊
Yes, improvement there is an area of focus right now. If there’s anywhere in particular you feel needs work, please feel free to use the feedback component at the bottom of each page.
Glad we were able to help you here! A great day to you as well!
I see! Will definitely make use of the feedback component!
@sanity-typed/types
looks quite promising, as it almost feels like it is / should be part of the actual main 
sanity
package (by not introducing new complexity and building on top of the existing functionality instead).However, I am wondering how I should get types, which are inferred using 
InferSchemaValues()
into my frontend project, as my frontend website and sanity studio projects are separated into different packages in my codespace.
I’d suggest starting a new thread for that, since the original question is resolved and no one will see the question here unless they click into the replies. That way, everyone in the community can see it and hopefully you’ll get some advice. 🙌
More @sanity-typed packages have been released by yours truly... 👀

Sanity – Build the way you think, not the way your CMS thinks

Sanity is the developer-first content operating system that gives you complete control. Schema-as-code, GROQ queries, and real-time APIs mean no more workarounds or waiting for deployments. Free to start, scale as you grow.

Get started for freeExplore the demo

Was this answer helpful?