Schema package APIs

CMS schemas describe the payload that the Dart content registry will receive. Keep the schema type name, deserializer, content descriptor, and default layout together when adding a content type.

Shared schema primitives

@vyuh/sanity-schema-core, @vyuh/sanity-schema-system, and @vyuh/sanity-schema-forms are published packages consumed by this repository. Their implementation is owned outside the checked-out framework. The framework’s schema packages use their feature descriptors and configuration descriptors to contribute types to Sanity Studio.

Consult the schema design guide and the documentation published with each npm package for its release-specific exports. The Dart API catalog does not claim to document external TypeScript implementations.

Authentication

The local @vyuh/sanity-schema-auth package exports its feature descriptor and configuration descriptors for authentication content. Its source is in schemas/vyuh-sanity-schema-auth.

Pair the Studio schemas with the authentication feature API and an app-selected authentication plugin. Register only the sign-in capabilities your provider supports.

Onboarding

The local @vyuh/sanity-schema-onboarding package exports its onboarding feature descriptor from schemas/vyuh-sanity-schema-onboarding. It describes onboarding steps and their content and actions.

Pair these schemas with the onboarding feature API.

Example schemas

The repository also contains schema packages for example features, alongside their Dart implementations. Use them to trace a complete type from authoring to rendering. The examples explain the relevant feature boundaries and source locations.

Contract alignment

How the pieces fit together