Reference

Compatibility notes, in full

The complete list of what works, what is partial and what is out of scope — the same claims the compatibility page makes, in one place for reference.

This page is the reference form of the compatibility page. Where the two ever disagree, this one is the one that was written next to the code.

Fully supported

  • @sanity/client and next-sanity, unmodified, against any well-formed pinned API version.
  • GROQ evaluation: full semantics.
  • Perspectives: published, drafts, previewDrafts and raw, including the overlay's identifier rules.
  • Mutations: create, createIfNotExists, createOrReplace, patch (set, setIfMissing, unset, inc, dec, insert, diffMatchPatch) and delete, including delete by query.
  • Document actions: create, edit, publish, discard, delete, unpublish.
  • Optimistic concurrency by revision.
  • Strong-reference integrity and unique published slugs, enforced by the platform.
  • History: document at revision or time, event lists including deletions, and the transaction log.
  • Real-time listen over server-sent events, with a polling fallback.
  • Asset uploads including browser-direct, content-addressed ids, and the transform parameters listed below.
  • Portable Text, in its standard shape, so any renderer works.

Partial

  • Image transforms. Width, height, fit, quality, format, auto-format and device pixel ratio are served. Hotspot and crop rectangles, blur, sharpen, flip, rect, palette extraction and LQIP are ignored.
  • Text search ranking. Matching works and pushes down to Postgres; ordering is Postgres' scoring.
  • resultSourceMap. Emitted, incomplete for some projection shapes, which limits click-to-edit overlays.
  • Presence, comments and tasks. Stored, served and surfaced in the Studio; not at parity.
  • The CLI. Two commands.

Not supported, by design

  • Sanity's hosted Content Lake, and anything that only exists inside it.
  • Scheduled publishing and releases.
  • Canvas, and the hosted Media Library product.
  • Sanity's hosted authentication and SSO. Identity is Supabase Auth in your own project.
  • The Sanity CLI's project and dataset management commands.

Not supported, not by design

  • The ?dl= download flag on asset delivery.
  • Geospatial GROQ functions.