Studio v3.16.7

To install and initiate a new Sanity Studio without installing the Sanity CLI globally, run the following command in the terminal:

npm create sanity@latest

To upgrade an existing instance to Sanity Studio v3, run the following commands in the terminal:

# Go to the root folder of the installed Sanity Studio instance
cd /sanity-studio/root-folder

# Upgrade Studio to v3
npm install sanity@latest

🚢 This release: 3.16.7

In a nutshell:

• Blocks only accept objects as members.
• Easier navigation in Sanity Studio.
• Import concurrency increase for faster dataset import.

Previously, blocks also accepted non-object types as members. From this release, it's no longer possible to use primitive types as members of a block. Members of a block must be object-like type.

In this release, we improved the navigation inside the studio by updating the <title> element to make it more specific to the current route every time a user navigates in the studio. This makes it easier to browse documents and switch tools.

Past versions encountered challenges with concurrent operations during parallel reference strengthening. This issue was addressed in a past release. This release enhances import performance by further optimizing the parallel strengthening of references. The concurrency improvement boosts import performance significantly.

• Simplified managing reference publishing icons by adding aria-labels for accessibility.

• Fixes a visibility issue related to breadcrumbing in the review changes section. Breadcrumbs are now consistent with the new breadcrumb styling.
• Fixes an issue where dialogs wouldn't correctly appear at smaller breakpoints.
• Fixes a minor issue affecting restoring document history in the studio desk tool with multiple nested panes.
• Fixes an issue in the studio desk tool using the index as a key instead of the path when handling multiple validation errors for the same field/node.

Studio v3.16.0

To install and initiate a new Sanity Studio without installing the Sanity CLI globally, run the following command in the terminal:

npm create sanity@latest

To upgrade an existing instance to Sanity Studio v3, run the following commands in the terminal:

# Go to the root folder of the installed Sanity Studio instance
cd /sanity-studio/root-folder

# Upgrade Studio to v3
npm install sanity@latest

This release: 3.16.0

In a nutshell:

• Enhanced Portable Text editing experience.
• Faster syncing.
• Full support for Portable Text on Android devices.
• Offline detection.

Sanity Studio uses the diff-match-patch algorithm to match and patch document changes. In previous versions of the Sanity Studio, the underlying library wouldn't work correctly when parsing some Unicode characters. We addressed those issues in this release.

If you experienced issues when using characters such as emojis, Kanji, or other non-Latin characters, this release resolves these issues.

Besides improved Unicode support, the Portable Text Input and the underlying text editor feature several improvements to provide a smoother editing experience.

Previously, prolonged fast typing in the editor would trigger debouncing: the Portable Text Input would temporarily suspend committing edits until you decreased your typing speed below a specified threshold.
This behavior could produce bigger discrepancies between your local value and the corresponding actual value stored on the server side.

Now your changes are committed in a throttled way: the editor commits the changes as you type, without compromising performance.

Undo and redo features have been improved considerably, especially when working with many editors on the same document.

The Portable Text Input is now fully supported on Android. Previously, typing in the editor using an Android on-screen keyboard would cause some issues.

The Portable Text Editor automatically enters read-only mode if it detects that the network is offline.
This behavior helps keep your local document in sync with the corresponding copy on the server when there is no online access, and it prevents losing changes due to not committing them.

• The sanity module is now marked as free of side effects, which can produce smaller bundle sizes (thanks @mckelveygreg! 🙏)
• Improved UX when deleting a document.

• Fixed a bug where changing text styles in the Portable Text Editor would cause the editor to lose focus.
• Fixed a problem that would occur when repeatedly applying and removing text decorators while typing in the Portable Text Input.
• Fixed the odd placement of the “Empty” placeholder in the Portable Text Editor on WebKit browsers.
• Fixed a media visibility issue in Safari occurring in list previews with custom SVG elements.
• Fixed the alignment of action items in pane headers on mobile devices.
• Fixed a padding inconsistency in reference fields.
• Fixed a visibility issue affecting tooltips in the navigation bar, and causing them to be displayed behind open menus.
• Fixed an issue impacting cross-dataset reference fields displayed as nested fields, inconsistent with regular reference fields.
• Fixed a bug that caused specifying apiVersion on documentList() and documentTypeList() to not work in the desk structure.
• Fixed the initial flashes of validation errors for valid content on document load.

Studio v3.15.0

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest


• Adds new token login method for rare cases when the more secure cookie approach is not viable/wanted
• Enables specifying authentication options using an object instead of createAuthStore()
• Adds new is_defined filter to GraphQL APIs, mirroring the defined() function in GROQ. GraphQL APIs will have to be re-deployed to enable the new filter.

• Improves performance when fetching projects list as part of the sanity init CLI command
• Fixes an issue that would give intermittent validation errors for valid string values when using a regex with global flag
• Fixes an issue where references to undeclared document types would never load
• Improves error UIs for reference values
• Improves the changes pane to show path line and change indicator correctly for the following field types:
  • Array of strings (array of type string)
  • Array of tags (array of type string with layout: 'tags')
  • Array of strings (array of type string with options.list)
  • Array of emails (array of type email)

Studio v3.14.5

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

• Various microcopy improvements
• Adds isSlug() method to @sanity/types for type-safe asserting of a slug object
• Fixes an issue where using multiple desk tools in the same studio would cause duplicate "review changes" actions and validation lists to appear. Thanks @andparsons!
• userHasRole will now accept null as well as a user object, making it more convenient in certain situations where the user might not yet be accessible
• Fixes issue with auto scrolling on collapsed fieldset
• Fixes issue where array list would not display all items when wrapped in a custom element
• Fixes issue where array list would not display when inside a popover

GraphQL v2023-08-01

v2023-08-01 is the first update to the Sanity GraphQL API to include breaking changes, and is released as an opt-in upgrade. Your existing projects that query the previous version – v1 – will continue to work as before, and you don’t need to take any action until you are ready to upgrade.

To start using the newest version, please ensure that you have read the section titled Breaking Changes below. Once you are ready, change your query endpoints as follows:

// Old endpoints
https://<yourProjectId>.api.sanity.io/v1/graphql/<dataset>/<tag>
https://<yourProjectId>.apicdn.sanity.io/v1/graphql/<dataset>/<tag>

// New endpoints 
https://<yourProjectId>.api.sanity.io/v2023-08-01/graphql/<dataset>/<tag>
https://<yourProjectId>.apicdn.sanity.io/v2023-08-01/graphql/<dataset>/<tag>

This update adds GraphQL support for several recently added Content Lake features:

• Release announcement
• Documentation

• Release announcement
• Documentation

• Release announcement
• Documentation

Read the updated GraphQL docs to learn how to get started with these features!

This update also introduces several adjustments to how queries are executed, which could potentially impact your query results. Before updating any of your existing v1 queries, make sure you have reviewed the following list of changes:

Previously, empty match patterns would evaluate as true and return all instances of the relevant type. Going forth, they will evaluate to false, resulting in no output.

v1 Behavior

Given the following query, v1 would return all posts:

query {
  allPost(where: {
    title: {
      matches: ""
    }
  }) {
    title
  }
}

v2023-08-01 Behavior:

In v2023-08-01, the same query now returns no results.

Replicate v1 Behavior:

To replicate the behavior of v1, remove the empty match filter.

The method for processing match patterns has changed. Match patterns are now tokenized into terms, and all terms must be present for a match.

v1 Behavior:

In v1, this query would return posts where any of the words “quick”, “brown”, or “dog” were found in the title:

query {
  allPost(where: {
    title: {
      matches: "quick brown dog"
    }
  }) {
    title
  }
}

v2023-08-01 Behavior:

In v2023-08-01, the same query will only return posts where the title contains all three words: “quick”, “brown”, and “dog”.

Replicate v1 Behavior:

The v1 behavior of matching individual words in a string cannot be replicated in v2023-08-01.

The handling of negative limits has been improved to better align with user expectations.

v1 Behavior:

In v1, negative values for the 'limit' parameter did not have the perhaps intuitive effect of reversing the direction of the limit. For example, one might expect that a 'limit' of -1 would exclude the last item from the result set. However, this was not the case, and the following query would return all results:

query {
  allPost(limit: -1, offset: 0, sort: { _createdAt: DESC }) {
    title
  }
}

v2023-08-01 Behavior:

In v2023-08-01, this query now operates as one might intuitively expect: a 'limit' of -1 effectively excludes the last item from the result set.

The handling of null values when sorting has changed.

v1 Behavior:

In v1, when sorting documents by a field, if that field contained a null value, the document would not be returned in the query result. For example, consider this query sorting by _createdAt:

query {
  allPost(limit: 3, sort: { _createdAt: DESC }) {
    title
  }
}

If _createdAt is null, the document will not be returned.

v2023-08-01 Behavior:

In v2023-08-01, matching documents that have _createdAt set to null are placed first in the returned results.

Replicate v1 Behavior:

With this release we have also added a new filter called is_defined you can use this to remove null values from responses.

query {
  allPost(
    where: { _createdAt: { is_defined: true } }
    limit: 3
    sort: { _createdAt: DESC }
  ) {
    title
  }
}

Custom roles that use custom content resources defined as a GROQ filter will be impacted by the move to the new GraphQL API version.

With the new GraphQL API version it now uses GROQ version v2021-03-25 to apply the custom content resource GROQ filter as opposed to v1. As such you must inspect the breaking changes to understand if your GROQ filter will continue to work as expected and update it if needed.

For example, one example is this custom content resource GROQ filter:

foo[].bar == 'something'

In v1 this would have returned documents where any foo.bar equals “something"

This behaves differently in v2021-03-21. Using an equality operator with an array traversal is not supported and will return empty results. Instead, these should be rewritten to use the in operator:

'something' in foo[].bar

A negation of an array traversal expression, e.g., !(foo[].bar == 'something'), is also impacted in version v2021-03-25. In this version, an equality operation on an array traversal will result in false, so the negation will evaluate to true. Therefore, in v2021-03-21, negating the original expression will return all documents.

Studio v3.14.4

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

• Implements the 'document' creation context in the document.newDocumentOptions API
• Fixes an issue where exported datasets with cross-dataset references could not be imported to different projects. Note that referenced datasets must exist within same project - otherwise use --skip-cross-dataset-references.
• Removes warning about missing titles for schema types (titles are automatically created based on schema type name - a title is only necessary if the automatic name is incorrect/inaccurate)
• Titles are now automatically applied to field groups and fieldsets, in the same way as with schema types
• Improves error messages from configuration errors
• Boolean inputs will now show validation errors at the input level
• Fixes alignment/scrolling issues of references in delete/unpublish dialog
• Fixes accessibility issues in tooltip text color contrast
• Fixes various accessibility label issues in the desk tool
• Fixes issue where focus would jump to first element when hovering divider in menu
• Fixes an issue where the fallback editor had the title "Editor", instead of the name of the document being edited

Studio v3.14.3

• Added scrolling to list of workspace (when many workspaces are configured)
• Improved contrast of text in certain tooltips

Studio v3.14.2

• Fixes an issue where the styled-components dependency would not be installed when installing Sanity in an existing project
• Fixes an issue where the "Restore" document action would sometimes not restore the document
• Fixed an issue where the fallback editor had the title "Editor", instead of the name of the document being edited

Studio v3.14.1

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest


• Fixes issue with small hit area for collapsible fieldsets.
• Fixes an issue where using sanity init on a Next.js project with embedded Studio would result in an error if an outdated version of next-sanity was being used.

Studio v3.14.0

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

Coinciding with today's studio release, we're bringing support for trying out Perspectives in the vision plugin.

With Perspectives, you can add a single parameter to fetch a either the latest draft (previewDrafts) or latest published (published) version of a document.

To learn more about Perspectives, read our announcement post or our documentation.

We've consolidated some helpful resources to customize the Studio experience, learn more about our latest updates, and connect with our team. You can also compare your current Studio version to the latest version available.

Studio v3.13.0

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

• New Document inspector @beta API
• Document validation now opens in a sidepanel

• Improves behavior of popovers in the Portable Text editor
• sanity debug now outputs all the roles of the currently authenticated user

Studio v3.12.2

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

• Fixes potential typing issues caused by mismatched versions of @types/react-is
• Fixes issue where validation tooltips were clipped inside of the Portable Text editor
• Improves accessibility of list panes when using screen readers

Studio v3.12.1

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest

• Fixes a issue where documents wasn't locked while a document was being synced
• Fixes a bug where certain references would result in invalid GraphQL union types (thanks @james2doyle!)

Studio v3.12.0

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest


To upgrade a v3 Studio, run this command in its folder:

npm install sanity@latest


Adds support for block, inlineBlock and annotation form components. You can now write plugins or create workspace configuration that change how these types are rendered in the studio. (Documentation forthcoming)

• Fixes a regression that broke document-level readOnly
• Fixes a bug that caused conditional field callbacks inside fieldsets to get passed a wrong parent value
• Improves deep linking to the Portable Text Input for visual editing
• Fixes an issue where @sanity/block-tools would remove whitespace from <pre> tags
• Fixes an issue that could sometimes cause newly inserted array items to be immediately removed

Studio v3.11.5

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue where change indicators were no longer showing up on boolean fields
• Adds document action custom dialog component
• Improves presence rendering performance
• Improves how focus and selection is handled and tracked in Portable Text fields
• Adds support for <sup>, <sub>, <ins> and <mark> in @sanity/block-tools
• Improves how image blocks in Portable Text fields are rendered for custom named image types

Studio v3.11.3

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes a recent regression from v3.11.2 where text annotations nested inside Portable Text inputs could not be edited properly

Studio v3.11.2

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes issue where image and file upload fields were not uploading data
• Fixes issue that would cause the dropdown list of autocomplete suggestions for reference fields to not overflow correctly inside the Portable Text editor
• Fixes issue where the current value of reference fields would not be displayed in the Portable Text editor
• Improves performance for arrays and portable text inputs

Studio v3.11.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue causing field groups to be hidden if they only contain fieldsets

Studio v3.11.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

It's now possible to search within document lists. We've also improved keyboard accessibility, making it much easier to navigate between lists and the document form editor itself.

• Fixes issue where Edit intent links that opens the on-screen keyboard in iOS/android while also opening dialogs would break the layout
• Improves linking to single spans of text in the Portable Text Input
• Fixes a bug that made fields without a group appear in all groups
• Fixes a bug with the Portable Text Editor where single span texts could become out of sync with the server value
• Fixes an issue where an object field’s value is not unset when all object field values are empty

Studio v3.10.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes issue where the Create new document dialog didn't work on smaller screens
• Fixes issue where out of range integers in number fields could crash the studio

Studio v3.10.0

Initiate a new Sanity Studio without installing the CLI globally:

npm create sanity@latest

To upgrade Sanity Studio, update its dependency:

npm install sanity@latest

This release includes support for Visual Editing and Content Source Maps. This feature enables you to make deep edit links from components in a front end that takes you to respective fields in the Studio. This enables a new workflow that substantially reduces the time it takes to make changes by bringing you directly to the relevant field where you can make edits reliably in its appropriate context. For more information on Visual Editing, check out the documentation here.

Visual Editing is available for mutual Sanity and Vercel Enterprise customers. Existing Sanity enterprise customers can contact their dedicated customer success manager to enable this feature. Customers interested in upgrading to an enterprise plan can contact our sales team for more information. You will also need to contact Vercel sales to enable this feature for your Vercel team.

Sanity enterprise customers can also use the Content Source Maps with GROQ to build custom Visual Editing capabilities. For more information, check out the Content Source Maps documentation here.

The sanity init command now recognizes if you are in a Next.js project, and will ask:

• What Sanity project you want to use (use existing or create new)
• Whether you want to place an embedded Studio using pages or app routes
• Whether you want to use TypeScript for your Studio
• What template you want to use (clean or blog)
• Whether you want to append the project ID and dataset to your .env file (you can also specify a custom env file with the --env flag)

If you have a Next.js project and want to quickly deploy an embedded Sanity Studio, you can run npx sanity init within your application's directory to get started.

Minimum version when using pnpm required: 8.x

• Enables fully unattended studio init with CLI when projectId, dataset and --y flags are set
• sanity init will now determine default package manager choice based on currently running package manager

• Updates the Shopify Studio template with various fixes
• Fixes an issue that caused field group buttons to steal focus when deep linking into a Studio value
• Fixes an issue causing focus to be set on wrong element when deep linking to a field inside an array
• Fixes an issue so deep linking to a field/input expands the right fieldsets/collapsed objects along the way
• Fixes an issue where validation errors would not focus on collapsed fieldset
• Fixes an issue where using pnpm to install dependencies would not install the latest available versions when creating a new project
• Resolves issue where unattended mode (--yes flag) for sanity init would still show a confirmation prompt about running a v2-like CLI command
• Fixes a bug with reference fields not receiving focus when clicking a validation error or following a link to the field
• Fixes intent links to focus on the correct location
• Fixes issue with pasting a file from clipboard into a file field that already has a value
• Fixes support for deep linking in image and file fields
• Fixes a bug that broke pasting a file into a file field when a value is already present
  

Studio v3.9.1

To initiate a new Studio without installing the CLI globally:

npm create sanity@latest

To upgrade a Sanity Studio:

npm install sanity@latest

• Adds support for custom favicons - see https://www.sanity.io/docs/favicons for more information
• Improves document history performance
• Enables passing skipVisibilityCheck prop to preview components to avoid flickering when already in the viewport

• Fixes virtualized list (arrays) not rendering properly when inside a modal
• Fixes bug where validation messages on Portable Text annotations were shown twice
• Improves wording on message shown after successfully deleting a document
• Fixes issue where unused references are cleared on clicking outside
• Resolves issue where validation errors are not focused when clicking on an error in the panel
• Fixes issue where annotation popovers were not scrollable in the Portable Text Editor
• Fixes a bug in the Portable Text Editor, which could lead to duplicating single sentence content with mixed marks in the editor when overwritten by another text
• Fixes an issue where creating a portable text annotation and inserting a value inside it would make a listening text editor crash
• Fixes an issue where documents would sometimes automatically scroll without user actually performing a scroll

Studio v3.9.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade an existing Studio (v3):

npm install sanity@latest

The npm create sanity and sanity init CLI commands now have two new flags available:

• --bare - skips the installation of a Sanity Studio. Instead, it takes you through the project and dataset creation process and prints the project ID and dataset names to the console.
• --env [path] - detects the framework used in the current directory and creates a .env file with the correct prefix for environment variables. The path is optional; the default value is .env, but you can change it to anything beginning with .env, for example, .env.local.example.

These flags are useful when you want to integrate an application with a new or existing project, when you have some existing Studio code you want to set up, or when you only need the Content Lake capabilities.

Lists of objects and references are now virtualized in the Sanity Studio UI. This should significantly improve performance in documents with large arrays.

Any custom Vite configuration defined in sanity.cli.ts will now be merged with the default configuration using Vite’s merge logic. This improvement will make it easier customize the Vite configuration without having to deeply understand the defaults. The configuration now also has improved TypeScript types.

• The schema validator now checks for fields that use the block type outside of an array, which is not currently supported (thanks @pauloborges!)

• Resolves an error that occurred when attempting to create a document of a certain type with an empty object as the initial value, resulting in a permission error
• Addresses an issue where CSS files were not properly updated with a configured Studio base path
• Fixes a bug that caused the Studio to crash when trying to fetch user data without proper permissions
• Resolves a problem where multiple sorting options could be selected at the same time in a dropdown menu
• Addresses an issue where long filenames/MIME types were not truncated in the file picker list
• Resolves a bug that caused the Portable Text Editor to crash when encountering an invalid value.

Studio v3.8.3

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Improves performance when entering text in large documents
• Fixes the issue where the document pane title, as defined in the desk structure, was not being utilized properly
• Fixes a problem where intent route would not open the correct desk structure

Studio v3.8.2

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes a recent regression where Portable Text annotations within nested content could not be properly edited

Studio v3.8.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes a regression from v3.8.0 where annotations could not be edited in Safari
• Fixes an issue with duplicate keys when pasting empty lines into an empty Portable Text input

Studio v3.8.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

The global create menu has been updated with alphabetically sorted options and a search field, providing a more convenient way to find a desired document. The menu has also been redesigned to appear in a popover instead of a full screen dialog for improved UX and less context switching.

• Fixes a recent regression in the Portable Text Editor where pasting content into an empty editor would cause an error
• Fixes content overflow bug for query results in Vision and adds scroll bars to the result pane
• Fixes issue where focus was not being returned to the editor after changing the style of a Portable Text block
• Improves performance and issues related to validation in the Portable Text Editor

Studio v3.7.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue where an array field’s value is not set to undefined when the last item is removed
• Fixes hydration mismatch issues
• Fixes an issue where preview panes are not preserved on smaller screens
• Fixes an issue where the studio may crash when accessing history changes with reduced permissions

Studio v2.36.0

⚠️ THIS IS A MAINTENANCE RELEASE OF A PREVIOUS MAJOR VERSION OF SANITY

We recommend updating to Sanity Studio v3 which provides exceptional flexibility and an unparalleled developer experience. The core packages for Sanity Studio v2 will only receive critical bug fixes until Dec 7th, 2023

Please head over to the documentation for Sanity Studio v3 to learn more.

You can find migration guides from Studio v2 here.

Upgrade the v2 version of the Command Line Interface (CLI) with:

npm install --global @sanity/cli@v2

Upgrade Sanity Studio with:

sanity upgrade

Studio v3.7.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Adds getClient() method to reference filter context

• Invalid references can now be removed from array inputs
• Validation error will now appear when missing a _ref in array of items
• Removes convert to reference button when converting array of references to singular reference
• patch.execute() now reflects that the second argument is optional

Studio v2.35.7

⚠️ THIS IS A MAINTENANCE RELEASE OF A PREVIOUS MAJOR VERSION OF SANITY

We recommend updating to Sanity Studio v3 which provides exceptional flexibility and an unparalleled developer experience. The core packages for Sanity Studio v2 will only receive critical bug fixes until Dec 7th, 2023

Please head over to the documentation for Sanity Studio v3 to learn more.

You can find migration guides from Studio v2 here.

Upgrade the v2 version of the Command Line Interface (CLI) with:

npm install --global @sanity/cli@v2

Upgrade Sanity Studio with:

sanity upgrade

• Fixes issue where clicking a document reference while still loading would result in an invalid link and cause the studio to crash
• Fixes an issue that might cause the studio to crash when trying to view history in a dataset copied with the --skip-history flag

Studio v3.6.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• General search performance improvements on larger studios (containing thousands of fields)
• Desk Structure is now able to auto-generate IDs from non-ascii source values (for instance cyrillic characters)
• Allows fractional section of a number to have leading zeros (thanks @pauloborges!)
• Fixes studio authentication when using a custom API hostname
• Makes schemas in Shopify online storefront template compatible with GraphQL deployments
• Fixes an issue of document type icons not showing up in array fields
• Fixes a bug where opening a reference field dropdown would not trigger a defined filtering function
• Restores functionality of the "Open in new tab" function for arrays of references
• Fixes issue where clicking a document reference while still loading would result in an invalid link and cause the studio to crash
• Fixes several issues that might occur when dealing with duplicate document IDs across workspaces
• Fixes an issue that might cause the studio to crash when trying to view history in a dataset copied with the --skip-history flag

Webhooks v2023-03-07

• The set of origin IP addresses for webhook calls are now published in the documentation and always kept up-to-date. See more details on the documentation page here.
• Webhook calls now include by default Sanity-specific headers with additional metadata useful for debugging. See more details on the documentation page here.

Mutation API v2023-03-07

• Document deletion mutations can now fully purge the history of a document, specially important for privacy and compliance requirements. See more information in the documentation page here.

Studio v3.5.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue where the accept option for file and image schema types would not be respected by the image and file picker, only new uploads
• Fixes dialog closing behavior in the studio to be more consistent
• Improves readability of date and datetime diffs in the review changes panel
• Fixes an issue where the first focusable element in a document was not focused when opening the document
• Fixes an issue where form dialogs were not closing as esxpected when navigating to a new document
• Fixes an issue where the selected sort option in the document list was not highlighted in the UI
• Fixes an issue where the correct default fieldgroup was not set in an array of objects
• Fixes an issue where opening a browser from the CLI tool on Windows might cause the login process to crash
• Adds missing options in mobile sidebar menu
• Fixes a regression from v3.4.0 in the Portable Text Editor that could corrupt text when typing fast and toggling text decorators (I.e. bold or italic) while typing
• Fixes a regression from v3.4.0 in the Portable Text Editor where it sometimes would error when toggling between different versions in the History View

Studio v3.5.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

Over the past few releases we have been addressing some inconsistencies in how environment variables can be used. This release greatly improves how "dotenv" (.env) files are handled. To summarize the new behavior of environment variables and dotenv files from this release (v3.5.0) and onward:

• All environment variables with the SANITY_STUDIO_ prefix is exposed to the bundle, and is available through process.env.SANITY_STUDIO_.... While they are theoretically also available under import.meta.env, it is not recommended to use them this way since it’s behavior specific to Vite, and thus not available under the same location in Node.js and other environments.
• We now load both .env, .env.local, .env.<mode> and .env.<mode>.local files from the studio root folder. This is consistent with Vite’s behavior.
• The .env files are loaded in the following order:
  • .env
  • .env.local
  • .env.<mode>
  • .env.<mode>.local
• By default, sanity build and sanity deploy will use the production mode, while all other commands will default to the development mode.
  • Setting NODE_ENV to production will set the mode to production, but setting it to other values (such as test) will not change the mode.
  • To use a custom mode, you can set the SANITY_ACTIVE_ENV environment variable.
  • Both NODE_ENV and SANITY_ACTIVE_ENV must be set as a regular shell environment variable, not in .env files, since knowing which .env file to load is based on it.
• Environment variables set in the shell will override variables set in the .env files.
• The environment variables are loaded into both the browser bundle environment, and the CLI context. In other words, running scripts through sanity exec will have access to the same environment variables as the Studio bundle, and you can use environment variables in your sanity.cli.ts/sanity.config.ts files. Make sure you use process.env and not import.meta.env for cross-environment support.

Note that we encourage you to use environment variables sparingly, and define them in a single location instead of spreading them throughout the code base. This makes it easier to see which environment variables are in use, and allows you to easier transition between different environments should you need to. For instance, one might create a src/environment.ts file which re-exports the environment variables:

export const myCompanyInternalApiUrl = process.env.SANITY_STUDIO_MY_COMPANY_INTERNAL_API_URL
export const someOtherVariable = process.env.SANITY_STUDIO_SOME_OTHER_VARIABLE

Should you want to reuse the environment variable handling in other contexts (your own scripts, or using a different bundler etc), you can import and utilize the new getStudioEnvironmentVariables() method from sanity/cli:

import {getStudioEnvironmentVariables} from 'sanity/cli'

console.log(getStudioEnvironmentVariables())
// {SANITY_STUDIO_SOME_VAR: 'yourVariableValue'}

Note that .env files are not loaded by default when using this method. To do so, pass an envFile option:

import {getStudioEnvironmentVariables} from 'sanity/cli'

console.log(
  getStudioEnvironmentVariables({
    envFile: {
      mode: 'production',
      envDir: '/path/to/some-dotenv-root'
    }
  })
)

• Fixes an issue where generation 1 GraphQL APIs would have changed pluralization rules for types ending with a number.

Studio v3.4.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• The studio has been upgraded to use @sanity/client v5, which boasts full Node.js ESM runtime support, a smaller footprint and much more

• Fixed a bug that could lead to duplication of a single block in the Portable Text Editor

Studio v3.3.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

A custom API hostname can now be configured for the studio through the apiHost configuration parameter. Note that the configured API host must behave the same as Sanity's API. This is mostly useful for enterprise customers with custom API CNAME enabled (get in touch if you are interested in this feature).

• Disables sorting of array items when readOnly is set
• Updates design of the presence menu to make non-clickable users appear greyed out
• Updates @sanity/schema module with a new named export – the default export is now deprecated and will give a warning when used
• Fixes behaviour so that the editing pane will now scroll the relevant field into view when validation does not pass
• Improves readability for tags array inputs in read-only mode
• Enables fetching unresolved cross-dataset references through GraphQL API

Studio v3.3.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Added ability to mark project studio templates as typescript-only

Manage v2023-02-01

This release introduces support for granting project access and roles to users through declarative rules when using SSO. Read more in the announcement blog post.

Studio v3.2.6

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue that in some cases would prevent validation status from appearing for a document
• Fixes an issue that ignored the readOnly state for fields inside fieldsets

Studio v3.2.5

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

The document history timeline now displays full dates in tooltips on hover

Studio v3.2.4

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

It’s now possible to easily search for documents between two dates in the global search.

• Fixes an issue where a configured studio-wide basePath would not be respected in build output, and workspaces would have to manually include the prefix in each workspace base path
• Enables access to studio-prefixed environment variables through process.env
• Fixes an issue where replacing the image asset in an image field would sometimes fail silently
• Fixes an issue where using React components in field titles or descriptions could crash global search

Studio v3.2.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes a regression in groq@3.2.0 that is missing a default export affecting Node.js ESM runtimes

Studio v3.2.3

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes issue in the Node.js runtime wrapper causing the groq tagged template literal to sometimes be undefined

Studio v3.2.2

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue where the Node.js ESM specific export for groq were missing from the package published to npm
• Fixes a potential race condition with duplicate keys when an editor deletes all the content of a portable text editor while other editors are editing the same document

Studio v3.2.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

This is an internal change, but if you have RxJS as a dependency in your Studio project you should make sure to upgrade to v7 of RxJS in your package.json. Otherwise you may get build errors due to changes in the Observable interface between v6 and v7 (note: this is a type change only, and should not affect the runtime behavior of your studio).

If you get a build error saying something similar to:

TS2322: Type 'Observable<…>' is not assignable to type 'ObservableInput<any>'. Type 'Observable<…>' is not assignable to type 'Observable<any>'. The types of 'source.operator.call' are incompatible between these types. …

Then the solution is to upgrade the version of RxJS used in your project or library to 7.x. See the full list of breaking changes in RxJS 7

This is an internal change, but theoretically there might be small changes to how assets are handled between v3 and v4. If you're using custom Vite plugins or you are loading CSS or other files, please make sure they still work after the upgrade.

• Reintroduces some flags for sanity graphql deploy. Note that flags will apply to all configured GraphQL APIs.

• Fixes issue with useFormValue hook lagging one iteration behind
• Fixes issue where the uploaded images menu was inaccessible
• Fixes some incorrect typings in defineField() when using Rule.valueOfField() - thanks @fritz-c
• Adds schema validation error when defining already defined field names for image and file types
• Supports Node ESM (>=14)

Studio v3.2.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

This is an internal change, but if you have RxJS as a dependency in your Studio project you should make sure to upgrade to v7 of RxJS in your package.json. Otherwise you may get build errors due to changes in the Observable interface between v6 and v7 (note: this is a type change only, and should not affect the runtime behavior of your studio).

If you get a build error saying something similar to:

TS2322: Type 'Observable<…>' is not assignable to type 'ObservableInput<any>'. 
  Type 'Observable<…>' is not assignable to type 'Observable<any>'. 
  The types of 'source.operator.call' are incompatible between these types. 
…

Then the solution is to upgrade the version of RxJS used in your project or library to 7.x. See the full list of breaking changes in RxJS 7

This is an internal change, but theoretically there might be small changes to how assets are handled between v3 and v4. If you're using custom Vite plugins or you are loading CSS or other files, please make sure they still work after the upgrade.

• Reintroduces some flags for sanity graphql deploy. Note that flags will apply to all configured GraphQL APIs.

• Fixes issue with useFormValue hook lagging one iteration behind
• Fixes issue where the uploaded images menu was inaccessible
• Fixes some incorrect typings in defineField() when using Rule.valueOfField() - thanks @fritz-c
• Adds schema validation error when defining already defined field names for image and file types
• Supports Node ESM (>=14)

Studio v3.1.3

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue that could give false validation errors for complex documents
• Hides restore action when revision is latest version
• Improves responsiveness of file and image inputs for narrow widths
• Restores transition effect when reordering primitive array values
• Fixes an issue with the vision tool causing the query param errors tooltip disappear behind the above panel

Studio v3.1.2

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixed a regression with release 3.1.0 where a custom style in the portable text input would not fallback to be rendered as the normal style when a rendering-component for that style was not defined.

Studio v3.1.0

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

Improved support for custom rendering of the content in the Portable Text input via .components.block, component.inlineBlock and .components.annotation render callbacks for object-like schema types, references and type aliases.

While this has been possible previously by modifying the block schema locally, these customizations can now also be put directly on the various content types themselves, to be shared between different Portable Text inputs using them. For example you can now customize how an author reference would appear in various Portable Text contexts on the author schema itself.

Also text specific schema properties like decorators, styles and lists for the block type itself have slighly changed their configuration in order to better align with the rest of the studio. More info: Changes in block schema customization properties.

If you previously did customization of the editor using your own render callbacks or icons through the .blockEditor property in the block schema, you will get a deprecation warning, but they will still continue to work until further notice.

Please refer to the documentation for how to customize the block type and the Portable Text editor for v3 of the studio.

Besides this, the Portable Text input related code and schema types have been given a TypeScript update for better type safety and developer experience.

The user menu now has options to select the appearance (color scheme) of the Studio. The selected appearance is stored in local storage and is reused on the next visit.

The button in the navbar that wraps the custom logo component has no padding anymore. This update is made in order to give the custom logo component full control over how big the button in the navbar should be. Therefore, the custom logo component may need to be updated in order to achieve the previous look. Below is an example of how to recreate the same result as before:

import {defineConfig} from 'sanity'
import {Box} from '@sanity/ui'

function MyLogo() {
  return (
    <Box padding={3}> // <-- Wrap your custom logo with a `Box` with `padding={3}`
      <CustomLogo />
    </Box>
  )
}

export default defineConfig({
  // ... rest of config

  studio: {
    components: {
      logo: MyLogo,
    },
  },
})

• This update fixes so that the component in the root config (ie in defineConfig) is the component that receives the result of the props passed on with renderDefault in previous custom components.
• Fixed an issue with custom sort orders

Studio v3.1.1

To initiate a new Studio without installing the CLI globally:

npx create-sanity@latest

To upgrade a v3 Studio:

npm install sanity@latest

• Fixes an issue where createAuthStore would incorrectly require a client factory to be passed
• Fixes an issue where lodash was not optimized in all released Sanity packages
• Fixes an issue where disabling direct uploads when using multiple asset sources would not work

Studio v3.0.2

This is the release of the stable, production-ready version the new major version (v3) of Sanity Studio. It deprecates Studio v2 and earlier versions. Studio v3 brings new features for content creators and developers, as well as a completely rewritten studio customization framework.

• The Parts system is deprecated and replaced with a new studio customization framework
• Custom webpack tooling is replaced with Vite
• Sanity Studio now ships as a single npm dependency (sanity) with JavaScript-based configuration (sanity.config.js|ts / sanity.cli.js|ts)
• The Studio module also has full ECMAScript Modules (ESM) support and CommonJS fallback and can be run in all modern browsers without bundling and embedded in any web project
• Full TypeScript coverage with annotated APIs (@internal, @beta, @public), new helper functions (defineType,defineField), and emerging inline documentation with TS Doc
• Better abstractions for wrapping and composing Studio and Form Components with renderDefault(props) and other convenience functions.
• New Plugins API with plugin development tooling (plugin-kit) that makes it easier to build, maintain, and publish plugins on npm
• New Studio v3 templates that let you get up and running with best practices

• New documentation
• Migration guides

Studio v2.35.2

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an edge case where a cross dataset reference to a deleted document would prevent you from changing the referring document

Studio v2.35.1

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an issue with documents not loading when rxjs version 7 is installed as a dependency

Studio v2.35.0

This release introduces support for shared content through cross-dataset references. Read more in the announcement: https://www.sanity.io/blog/shared-content-introduction

Order search results by relevance, created and last updated date.

• Fixes an issue where split panes might not persist after reloading the studio
• Fixes a bug causing revision history selector to always display the current version instead of the selected revision
  

Studio v2.34.2

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

Studio v2.34.1

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an issue causing content to be inserted twice when using custom paste handler

Studio v2.34.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

This release includes several performance fixes that should now make the Studio more responsive while editing documents. (See more details in individual PRs #3668, #3662, #3660)

Search for documents containing an exact phrase by wrapping text inside double quotes.

• Upgrade @sanity/ui to v.0.37.22

• Fixes an issue where the scroll position in global search wasn’t being correctly retained in some instances.
• Fixes an issue in global search that would cause the studio to crash if Local Storage is unavailable.

Studio v2.33.3

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

We've added a few new flags to make automation easier!

The --force flag was added to a few already existing commands and will skip the confirmation prompt and proceed with the command:

sanity dataset alias unlink <alias-name> --force

sanity dataset alias delete <alias-name> --force

sanity dataset delete <dataset-name> --force

sanity graphql undeploy --dataset <dataset-name> --force

When added, the --no-open flag prevents the login page from automatically opening in the browser.

sanity login --provider <provider-name> --no-open

Studio v2.33.2

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes styling of a columnar fieldsets
• Fixes an issue where older versions of Safari might crash when opening a referenced document
• Fixes an issue with the cursor disappearing when arrowing down to the bottom of a collapsed Portable Text Input field
• Fixes a Safari issue where the Portable Text editor's selection is reset when returning from an object edit modal of an embedded Portable Text object
• Improved read only mode for the Portable Text Input

Studio v2.33.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli 

Upgrade Sanity Studio with:

sanity upgrade 

This release brings a number of performance improvements, mostly related to excessive re-rendering of components that do not change. Notable improvements are:

• Better performance for presence indicators when many users are logged in at the same time
• The Portable Text Editor should be faster and re-render less often

• Mitigated an issue that could cause a draft document to be overwritten by an earlier version after publish
• The Presence list in the toolbar will now only show users who are working in the same dataset

Studio v2.32.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Screen readers will now identify that the main language in the Studio is English
• Various accessibility improvements
  

Studio v2.31.1

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixed an issue where incorrect references to image and file assets would crash the studio and display invalid diffs

Studio v2.31.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Adds support for filtering search results by any number of document types. You can also browse documents from any number of types without entering a search query.
• Search is now toggleable with a hotkey (Command/Control-K) and fully navigable by keyboard.
• Recent searches (including selected document types) are stored for later use
• Search terms and results are retained upon close: handy if you want to quickly revisit or amend your last search
• Improves performance when rendering and scrolling through large result sets
• The search dialog is wider, giving you more space for the search result listing

NOTE: Documents listed in search results will no longer resolve custom components for block content and array views

Studio v2.30.5

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Improved the UX of the new reference indicator in document pane.

Studio v2.30.4

Upgrade Sanity Studio with:

sanity upgrade

• Fixes a bug where desk tool document lists would sometimes fail to resolve a schema type for new documents when pane supports multiple types
• Reduces amount of requests triggered by new reference indication
• Fixes 404-errors being printed in developer console when checking references for unpublished documents

Studio v2.30.3

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• A document that has references to it will now clearly indicate this with a differently colored header/footer, as well as with a link symbol. Additionally, prior to publishing a referenced document, a confirmation dialog will indicate that the change might affect referencing documents
• Added support for the presence feature when not using cookies for authentication
• Dependencies upgraded for the Portable Text Editor, fixing issues where Chrome would be reported as missing beforeInput- support after Chrome went above version 100. This broke spellchecking in Chrome and degraded performance
• Updated UI of dashboard feeds

• Fixes rare occurring bug in the Portable Text Editor where it would stop producing patches due to non-updated instance props
• Fixes issue where the newest get-started templates did not include a gitignore file
• Fixes a potential error when trying to access a file that does not exist
• Fixes issue where field validation tooltips would sometimes be cut off when inside of modals
• Fixes an issue where exporting certain old assets would fail because of an md5 mismatch
• Fixes an issue where the unpublish dialog would use the term "delete" instead of "unpublish" in the confirm dialog
• Fixes a few warnings from being printed when navigating the dashboard
• Fixes an issue where documents with a large amount of references would sometimes fail to be published because of a failing request
• Fixes an issue where a stray margins property would be passed to a div-element (thanks @KittyGiraudel!)
• Fixes a few typos in the pets project template (thanks @nick-krantz!)Upgrade the Command Line Interface (CLI) with:

Studio v2.30.2

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

This new command will help users find out the status of jobs without needing the job id.

`sanity dataset jobs list`

Studio v2.30.1

Upgrade Sanity Studio with:

sanity upgrade

• Fixes hovering issue in array input with portable text block
• Fixes issue where selected list ordering in desk structure would not be respected
• Fixes issue where document list appeared to be loading forever when changing the ordering
• Fixes issue where the the code input file name field would disappear when the language option was set
• Improves error message when copying a dataset and the target dataset already exists, but a copy operation is already in progress

Studio v2.30.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• CLI copy dataset command now always prints a job id to make it easier to resume watching running jobs
• It is now possible to navigate to a referring document from the 'delete document' dialog

• Fixed an issue where sanity deploy would return "Hostname already taken" for all errors
• Added explanation in sanity exec --help on how to add arbitrary arguments to the script
• Fixed date formatting issue in validation tooltip
• Added scroll to the types dropdown menu when creating a new reference

Studio v2.29.8

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an issue where the studio might crash when publishing due to a change in a third party dependency
• Fixes an issue where user avatar from Google would sometimes not appear
• Fixes a typo in the studio update dialog
• Fixes a bug where initializing new projects with a dash in its name would not include it in the suggested output path

Studio v2.29.7

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

As part of a general effort to improve our onboarding experience, this release updates the studio templates available in the CLI.

These release notes also covers v.2.29.6

Studio v2.29.5

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

You can now preview GraphQL deployments and check for breaking changes without deploying.

Studio v2.29.4

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes regression in the previous release regarding pasting of HTML into the Portable Text Editor.
• Fixes a rare bug with pasting plain text into the Portable Text editor where it sometimes would error and deny the paste.

Studio v2.29.3

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

Allow selecting an organization to attach new projects to during sanity init.

• Update image input height based on image size.
• Adds support for @sanity/language-filter to fallback to a different language select implementation when the current one is not relevant. (thank you @LiamMartens)

• Improves how patches are sent to the server in the Portable Text editor, potentially fixing a very rare heisenbug where the latest change in the editor would not be persisted.
• Fixes a regression in the Portable Text editor's custom paste handler support.
• Fixes issues in the Portable Text editor when merging two paragraphs with text annotations in some circumstances.
• Fixes an issue where the number input wasn't allowing for decimal numbers (when the input is active).
• Fixes an issue with the changelog when filtering out entries without data to display.

Studio v2.29.2

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an issue where client configured with a token via part:@sanity/base/configure-client would be reset.

Studio v2.29.1

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an issue with the v2.29.0 release that prevented the @sanity/default-layout module from being installed

Studio v2.29.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

The Studio now has a new changelog dialog that features more in-depth information about the latest features and bugfixes.

• Fixes an issue in array inputs where the input was disabled when dragging items within a Portable Text Editor

Content Lake v2022-03-13

Added a new point of presence for our APICDN in Mumbai, India.

Studio v2.28.2

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an issue where sanity exec would use an unauthenticated user session for the client

Studio v2.28.1

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Temporarily bring back the internal ConfirmDelete component from @sanity/desk-tool which was depended on by certain plugins

• Allow using a writable stream as the output destination in the @sanity/export module (thanks @tsolbjor!)

Studio v2.28.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Adds a check for superfluous image metadata properties being specified
• The studio now supports authentication for browsers that block third-party cookies

• Fixes a bug where document lists would not always show items in the correct order until scrolling down and back up again
• Fixes a bug where the studio could crash if a user had insufficient permissions to fetch user profiles while collaborating with others
• Fixes a number of issues with the sanity upgrade command when using --tag or --range
• Upgraded @sanity/base to use react-refractor version 2.1.6 (thanks @JamesSingleton!)
• Upgraded @sanity/base to use refractor version 3.6.0 (thanks @miketheman!)

Studio v2.27.3

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes a number of issues with the sanity upgrade command when using --tag and/or --range (#3176)
• Fixes a bug in the Portable Text editor where selecting all the content and overwriting it by inserting text would cause an error

Studio v2.27.2

Upgrade Sanity Studio with:

sanity upgrade

• Fixes an issue where the defined `apiVersion` would not be used for document lists in the desk tool structure (thanks @barbogast!) (#3174)

• Upgrades refractor dependency to ensure a prismjs security upgrade is included (thanks @miketheman!) (#3170)

Studio v2.27.1

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Adds keyboard arrow navigation in the Portable Text Editor toolbar (#3126)

• Fixes an issue where spellchecking in the Portable Text Editor would not be enabled when omitted in schema options. (#3146)
• Fixes a bug where Portable Text block values without a defined style property would throw an error when editing that block. (#3161)
• Improves the performance of the reference search. (#3159)

Studio v2.27.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

Presence, the ability to see where your collaborators are, is now visible in document lists, search results, and reference previews.

• You can now configure the default API version for Vision (#3127)

• Removes a false positive validation error with some nested image and file fields (#3119)
• Fixes a bug where adding marks to a Portable Text block would remove some existing marks (#3124)
• Fixes a bug where list items in Portable Text without a level would cause an error (#3129)
• Fixes a bug where read-only arrays showed an empty actions menu (#3130)
• Improves empty read-only state for arrays (#3131)
• Adds validation warnings on incorrectly implemented asset sources (#3135)

Studio v2.26.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Empty state takes up much less vertical space
• Field with file selected also takes up less vertical space
• Display original file name and size
• Options to download the file or copy the url

• Empty state takes up much less vertical space
• Image is vertically responsive to the height of the window, taking up less vertical space
• Images are no longer enlarged to fit the size of the field
• Options to copy image url and download the image

• Shows full name, email and login provider of the logged in user
• Link to project management interface

• Fixes an issue where the empty editor placeholder text would sometimes cause focus problems in Webkit.
• Fixes an issue where multiple types in array input would prevent it from being scrollable

Studio v2.25.4

Upgrade the Command Line Interface (CLI) with:

Comment

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes a bug in the Portable Text Editor where opening inline objects of type reference would not open the editing interface if the reference was set already
• Fixes issue where document preview images weren’t updating when changed
• Fixes issue where array items with initial value were overriding set values when duplicating

Studio v2.25.3

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes a bug where pasting into an empty Portable Text Editor would cause an error
• Fixes race condition that caused a crash in the studio when arrays were used

JavaScript Client v3.0.0

Breaking changes:

• The client will now fetch from the API CDN when a token and useCdn: true are passed together.
• The client now only supports Node.js v12 and higher.
• The deprecated merge patch operator was removed.
• The deprecated document property on assets.upload was removed.
• client.observable.fetch() returns a cold observable.

Studio v2.25.2

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes a bug introduced in v2.25.1 where inserting object blocks in the Portable Text Editor would cause an error

Studio v2.25.1

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

• Fixes some permission issues where users weren't able to edit documents when they should be
• Fixes a bug where placeholder text in an empty Portable Text Editor would be stuck for a split second when it should not be
• Fixes a bug where splitting lines in the Portable Text Editor including an inline object would corrupt the inline object data
• Fixes an issue in Vision where controls and result were cut off in smaller viewports

Manage v2022-01-26

Adds filtering by name, email and roles in project members list

Studio v2.25.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

This update brings fixes for several bugs and improvements to the Portable Text Editor's performance and reliability. It also includes:

• Better keyboard accessibility when editing embedded objects
• Better tracking of validation errors within the editor
• Better Android and IME support

New projects bootstrapped with the CLI will now contain a default .eslintrc that extends our new shared ESLint config @sanity/eslint-config-studio.

• Fixed an issue where sanity upgrade would fail if @sanity/code-input was installed. (Thanks Tommy for the PR!)
• Fixed an issue where sanity upgrade, sanity versions and sanity debug would fail if running without any dependencies installed.
• Removed third party dependency causing security warnings with npm audit (immer.js)

Studio v2.24.1

• Allow loading more syntaxes for the @sanity/code-input programmatically, see the code input README for more details
• You can now specify coupon codes when creating a new project using the CLI, by using the --coupon flag, eg sanity init --coupon <code>

• Fixes bug where initial values would no longer work when inserting in arrays
• Fixes a bug that caused some false warnings with duplicate and update permissions

Studio v2.24.0

Upgrade the Command Line Interface (CLI) with:

npm install --global @sanity/cli

Upgrade Sanity Studio with:

sanity upgrade

Added Field Groups to schemas and document view. Read more about the feature here: https://www.sanity.io/docs/field-groups.

Arrays now support adding new items before/after existing array items, and also duplicating existing items.

Updated document status indicator with saving state and animation.

• Added SANITY_STUDIO_PROJECT_NAME environment config variable

• Fixed an issue that could in some cases cause matching documents to be excluded from the search results
• Made the default title of referenced document types more user friendly
• Fixes an issue that could occasionally cause a query error during publish of a new document created directly from the reference input
• Fixes an issue that caused singleton documents to never load if no schemaType was provided.
• Fixes UI issue in Portable Text toolbar

Studio v2.23.3

sanity upgrade now behaves slightly different:

• It now respects the version ranges and pinned versions declared in your package.json
• Tries not to upgrade non-studio modules such as @sanity/block-content-to-html
• Shows a more prominent message if there are major updates available with a link to the changelog

• Fixes an issue that caused a crash instead of a warning screen when omitting schemaType from S.documentList() (#3022)
• Fixes an issue that caused singleton documents to never load if no schemaType was provided (#3043)

Studio v2.23.2

• Fixes a bug that caused focus loss on an array item after closing the edit dialog
• Fixes a bug that caused popovers from closing when clicking outside of the current pane content
• Fixes an issue that could cause a max request size exceeded error for documents that had many references.
• Fixes a bug that could sometimes cause document preview for object fields with name "title" to crash on reload
• Added more details in docs for the client.delete() API

Studio v2.23.1

• Fixes an issue where previews of a reference to a document with a field named 'title' did not display correctly
• Fixes a visual error where popover dialogs were appearing beneath other panes
• Fixes an issue where 'create' intents set in custom structures would not appear in pane headers
• Fixes sanity dataset import when targeting an ndjson file with relative file URLs
• Fixes a bug preventing sanity logout from working in the case of expired sessions
• Fixes a bug where the CLI would not be able to log a user in if an existing invalid/expired session was present

• Added support for HTTP proxies when using dataset import/export commands
• Validation menu button now reflects the highest level of validation

Studio v2.23.0

Users can now create a reference to a draft within the context of the referring document. This allows for a smoother workflow where having to leave the document you are working on in order to create and publish the document you wish to refer to is no longer necessary,
This new behavior of the reference input can be disabled by setting the property disableNew: true.

More:

• Reference schema type documentation
• Connected Content – Introduction to references in Sanity
  

The ability to define if a field is editable based on conditions defined in a schema.

In addition to being able to provide validation errors, developers can also provide guidance with ℹ️ -symbols to give in-line help to editors.

The Portable Text editor now supports a new modal option with a type and width property. This means you can customize the size of annotation popovers (a much requested feature).

  type: 'block',
  marks: {
    annotations: [
      {
        type: 'object',
        name: 'link',
        title: 'Link',
        options: {
          // 👇👇👇
          modal: {
            type: 'popover',
            width: 'medium' // the default is "small"
          },
          // 👆👆👆
        },
      },
    ],
  },
  // ...

• Fixes a case where the sanity graphql deploy command would not exit after a successful deploy.
• Fixes a bug where importing the @sanity/eventsource module in non-browser, non-node.js environments could potentially crash because of a window reference.

Studio v2.22.5

• Fixes an issue where desk structures with observables would be stuck loading.
• Fixes an issue where the new-document dialog would not use the selected template

Studio v2.22.4

Fixes a bug that disabled all options in the global 'create document'-menu due to insufficient permissions.

Studio v2.22.3

• Introduces a larger initial min-width for the DocumentPane.
• Huge GROQ queries will now use the API-CDN when useCdn: true. Previously these would go to the regular API endpoint.
• Fixes typo in deferred-visibility for mutations
• Added schema option to configure spell-checking for Portable Text via options.spellCheck on the block type.

Studio v2.22.2

Fixes a bug in Safari where editing annotations (like links) in the portable text editor would make the popover dialog jump around.

Studio v2.22.1

Fixes an issue where some custom styles implementations for the Portable Text Editor caused an error.

Studio v2.22.0

We have now migrated the Portable Text (PT) editor in the Sanity Studio to use Sanity UI. This marks the completion of the migration of the entire Studio to @sanity/ui.

In addition to the migration:

• Generally improved stability and performance of the PT editor.
• Added a new affordance for editing/removing text annotations. This will make it easier to e.g. edit link details.
• Fixed a bug where undo/redo history was not maintained in memory when collapsing/expanding the editor.

• Allows plan selection with sanity init --project-plan <plan>
• Improves usability of ValidationError by making cloneWithMessage optional

Studio v2.21.11

Fixes an issue causing sanity exec to crash

Studio v2.21.10

This release includes a new implementation of our pane and intent resolver that resolves intents deeper in your structure and provides more consistency with getDefaultDocumentNode. The Studio will now do a better job at opening a document within a structure instead of opening it on the root level outside of its usual context.

• Fixes an issue where creating a new document would open in the fallback editor instead of as a child to the current pane.
• Fixes an issue where opening a search item from the top search would result in the fallback editor instead of user-defined structure.
• Fixes inconsistencies with getDefaultDocumentNode where configured views would not appear in the fallback editor.

• Fixes an issue with GraphQL deploy causing "Error: Cannot find module '@sanity/core/_internal'
• Support for GROQ query params in patch and delete methods in the client (#1826). Thanks, @KarlGe!

Studio v2.21.9

Fixes a regression introduced in #2884 that caused the saving spinner to not appear while a change was still syncing

Studio v2.21.8

Fixes an issue causing GraphQL deploys to fail after installing to babel ^7.16.0 see (#2899).

Studio v2.21.7

• Fixes a bug where removing an annotation from text would interfere with other annotations within that same block
• Fixes a bug where the correct version of a document did not appear when selected in the select revision menu
• CLI now supports an increased maximum dataset name length of up to 64 characters

Content Lake v2021-10-21

Fixes match operator bug

Up until now, the match operator has not handled wildcards correctly in some specific situations.

For example, name match "foo.*bar" would be equivalent to foo * bar, because . would be considered a word-splitting character, and so foo.*bar would never match the string foo.bar.

While rare, this also turned out to affect some languages where we would split words incorrectly: "創傷ケア" match "創傷ケア*" would return false, but "創傷ケア" match "創傷ケア" would return true.

We are now releasing the API version 20211021, which fixes this.

In short, the new algorithm honours Unicode word segmentation rules and considers the wildcard character, *, to be a word character. This fixes the internal tokenization to be consistent.

Correct Content-Type for /history and /export

Previously the /export and /history endpoints was returning Content-Type: text/plain even though they were streaming JSON. After this version they return Content-Type: application/x-ndjson instead.

Studio v2.21.6

Fixes an issue that could cause an error saying “This document is of type X and cannot be edited as Y.” when navigating between singleton documents

Studio v2.21.5

Fixes a bug where if a space was configured as the default but not the first in the spaces array, the initial studio load would redirect to the correct URL but not configure the client to use the correct dataset.

• Fixes an edge case for user-defined components. All user-defined components are re-rendered on navigation regardless if the structure child is a function or not.
• Fixes an issue where user-defined components would not be hidden when pane was collapsed.
• Fixes sluggish UI in the image select dialog when the list contained large GIFs.
• Fixes image select dialog scrolling to top when loading a new page.
• Fixes an issue where deploying a GraphQL API might crash if schema-imported component tries to access localStorage.
• Fixes an issue where switching betweeen two "singletons" (document list items) without a defined schema type might result in the incorrect schema type being used.
• Fixes a styling issue in the @sanity/vision autocomplete styling.
• Fixes an earlier regression that caused the withDocument higher-order component to pass on the edited document before it was fully loaded.
• Fixes a bug where removing an annotation in the beginning of a Portable Text block would accidentally mutate trailing annotations inside that same block.

Studio v2.21.4

• Fixes a bug where the withDocument higher-order component would sometimes return null initially
• Fixes a bug where collapsed panes might not show their content when expanded
• Fixes a bug where tools would not get passed the tool property, resulting in incorrect context

Studio v2.21.3

• Fixes an issue that caused the GraphQL schema deployment to either be slow or hang on schemas with many references
• Fixes an error where the image and file inputs might throw an error about unsetting deep values on a primitive value
• Fixes glitches in logo animation when the studio is loading
• Fixes an issue where the desk tool would in certain cases give an error message saying Unknown document type *
• Fixes an issue where document list items inside of non-document lists would be rendered with “Untitled” as the title, instead of the full document preview
• Fixes an issue where the schema error summary would not be displayed because the studio would crash before being able to display it
• Fixes a regression that caused the withDocument higher-order component to get stuck on an initial null value
• Fixes an error where the client would fail to set up a listener when sending huge queries, without giving a developer-friendly error message

Studio v2.21.2

• Fixes UX issues with collapsing and expanding panes in the Desk Tool.
• Adds support for scrolling in the date picker‘s popover, when it’s not able to show all the contents at once.

Studio v2.21.1

• Fixes issue with experimental spaces not loading correctly (#2835)
• Fixes an issue with nested document lists. (#2834)
• Fixes an issue that would disallow deleting an unpublished document for users with access to update the draft
• Fixes an issue that would disable discarding drafts even for users that had access to it

Studio v2.21.0

The navbar and all of its elements have been migrated with @sanity/ui. The migration fixes a long-standing issue with responsiveness of the navbar, especially when it comes to the tool menu.

The pane system has been rewritten from scratch, and the UI of Desk Tool is completely refactored to using @sanity/ui.

Panes now support dynamic minimum and maximum widths, to provide a more responsive behavior.

• Newly initialized studios will now include a .gitignore
• Speed of dataset imports improved when assets already exists
• sanity hook commands updated to be forwards-compatible with upcoming webhook changes

• fix(language-filter): fixes popover placement issue when language list is long (#2801)

Webhooks v2021-10-04

A complete revamp of the webhooks API, which allows for sophisticated webhook configuration using GROQ. Read more in the docs, or read the announcement blog post.

If you need to recreate the previous webhook behavior – triggering on all changes, and on a dataset level rather than document-level – you can do so by following these steps:

1. Create a webhook set to trigger on create, update and delete
2. Leave the Filter field empty
3. Add the following to the Projection field

// webhook projection
{
  "transactionId": "Not supported",
  "projectId": sanity::projectId(),
  "dataset": sanity::dataset(),
  "ids": {
    "created": [
    	select(before() == null && after() != null => _id)
    ],
    "deleted": [
      select(before() != null && after() == null => _id)
    ],
    "updated": [
      select(before() != null && after() != null => _id)
    ],
    "all": [
      _id
    ]
  }
}

You can also click this link to get a template with the settings described above.

In addition to the filter and projection functionality, we’ve made a bunch of other improvements as well:

• There’s a new UI for webhooks in the management interface and a full RESTful API
• Webhooks can now be edited after you have created them
• You can enable and disable webhooks
• Webhook entries contain more metadata, including name, description, and more
• You can add custom headers, and specify its HTTP method
• There’s a new attempts log that makes troubleshooting and testing easier
• Webhooks support a secret that will be hashed in the request which you can use to authenticate that the request originates from your project
• We include idempotency keys in the headers, which you can use when syncing data to verify you haven’t received it before
• Webhook configurations can be shared via URL
• Webhooks are now guaranteed to include the content changes that caused them
• Webhooks will now be retried (and are also rate-limited to 60 per second)
• We also added a `sanity` namespace to GROQ that can be used in projections

GraphQL v2021-09-28

Fixes a bug when trying to filter on a Date type

Studio v2.19.0

We've been hard at work migrating the internals of Sanity Studio from CSS modules Sanity UI, which is based on styled-components.

Over the past releases, we've seen a few reported issues where multiple versions of the styled-components dependency could end up in the same studio, causing issues that were hard to understand (sanity is undefined) and would require a full dependency tree reinstall to resolve (rm -rf node_modules && sanity install).

In this version, we're introducing styled-components as a first-level dependency in the studio, in the same way that react and react-dom is.

The first time you run sanity start, sanity build or sanity upgrade after the upgrade, you will be asked to install the dependency - and in non-interactive it will install automatically.

This migration should be seamless for most studios. We anticipate that in certain cases (custom monorepo setups, for instance) it might require manual changes, like adding styled-components as a dependency of the studio.

For a more in-depth look at the rationale behind this change, see the pull request for this change.

The sanity documents query CLI command now has a new flag: --api-version.

This is useful for testing how queries behave in different API versions. For now, the command will still use v1 as the default.

• Fixes a rare case where an error could be thrown during the React render lifecycle without being an Error instance, which would crash the error boundary

Manage v2021-09-13

Login screens are refactored to use Sanity UI.

Image URL library v1.0.0

Previously, the @sanity/image-url library would return `null` if you passed an invalid source (such as an object without the expected properties, or an invalid image asset ID). From 1.0.0 and onwards, the library will throw when receiving an invalid source. This makes it more obvious when there is invalid data passed to it, as well as ensuring that the function always returns a string (which is a much requested feature for TypeScript users).

Studio v2.17.2

If you add schema fields and run sanity graphql deploy you will no longer be warned about “dangerous changes.” Previously, our GraphQL validation followed the behavior of graphql.js, which treats added fields as “dangerous.” We have had a lot of feedback, that in practice, it has been more bothersome than useful.

• Since v2.16.0, (inline) references in Portable Text would not be saved properly and left an arbitrary attribute. This version fixes that.

Studio v2.17.0

A lot of you have been waiting for this for a while: A way to show and hide fields based on the value of some other field. The wait is over! In this release of the Sanity Studio the hidden field has been upgraded to take a callback function.

export default {
 type: 'object',
 name: 'dropdownExample',
 fields: [
   {
     name: 'kind',
     type: 'string',
     options: {list: ['foo', 'bar', 'baz']},
   },
   {
     name: 'fooOptions',
     type: 'object',
     hidden: ({parent}) => !(parent?.kind === 'foo'),
     fields: [/* ... */],
   },
   {
     name: 'barOptions',
     type: 'number',
     hidden: ({parent}) => !(parent?.kind === 'bar'),
     fields: [/* ... */],
   },
 ],
}

Get more code examples and read more about the details in our docs.

Studio v2.15.0

• Migrates `color-input` to `@sanity/ui`
• Migrates `google-maps-input` to `@sanity/ui`
• Migrates the document status bar and document actions to `@sanity/ui`
• Migrates the default preview to `@sanity/ui`

• Adds a visible indicator on the focused day when using arrow keys to navigate through the calendar days in the date input
• Fixes an issue that in some rare cases could make the preview selection result in an invalid query
• Fixes an active state issue with `PaneItem` in `DocumentsListPane`

Studio v2.14.0

• 
  Adds a notice for insufficient permissions to references
• Adds strict dependency checking to all packages
• Adds better feedback about accepted files when dragging over file and image inputs
  

• Enforces that DateInput value is constrained to timeStep
• Fixes issue where importing JSON files would crash the studio build process
• Fixes an issue where the form was visible above the PTE toolbar in fullscreen mode
• Adds safeguard against missing .focus() method on components used with the withDocument() higher order component.
• Adds a visible indicator on the focused day when using arrow keys to navigate through the calendar days in the date input
• Fixes an issue that in some rare cases could make the preview selection result in an invalid query

next-sanity v0.2.0

The first version of next-sanity shipped with the picosanity client built-in. This caused some confusion for people who wants not only to pull data from their Sanity.io content lake, but also send patches and mutations via API routes. Since picosanity only supported fetching content, it had a smaller bundle size than the full SDK.

This version replaces picosanity with the full client. You can use Next.js' tree shaking to keep the client out of the app bundle or install picosanity if you still prefer to use that.

Studio v2.10.0

This upgrade extends support for initial values to any field, not just the document type. You can now set initial values on a field that's shared between schema types. It also allows for initial values for fields inside of arrays and the Portable Text editor, which has been a frequent request. Initial values still supports promises if you need to set values from external data sources.

• Fixes a few performance regressions in the array input
• Fixes an issue where the "revert changes"-dialog confirmation would sometimes be hidden behind the form dialog

Studio v2.9.0

The image fields has seen a number of bugfixes and now properly display presence and change indicators, including for hotspot/crop fields and other image fields that opens in dialogs.

The default reference input in Sanity Studio has been refactored to use the Autocomplete component from Sanity UI which improves overall accessibility and fixes keyboard navigation bugs.

• The language filter can now be configured with an array of document types to control which schemas the filter will appear on (thanks @spacedawwg!).

• Fixes false positive with image fields in dialogs, indicating that there’s a change when there is none
• The code input now wraps text inside the input so that all the code is visible without having to scroll horizontally (thanks @katherinepeterson!)

Gatsby source plugin v7.0.3

• Bring back the gatsbyImageData on image nodes
• Set more specific peer dependencies and engines update

Explore the diff

Sanity UI v0.33.11

Most changes in this version are improvements and bug fixes behind the scenes – however there are a few new APIs:

• Introduced the onItemSelect property ((index: number) => void) to the Menu component props, to make it possible to subscribe to which MenuButton is currently selected.
• The MenuItem now takes the selected property (boolean) to indicate which item in a Menu should be selected by default.
• The MenuButton component now takes the popover property (PopoverProps), which is an object containing properties for the Popover component (like arrow, preventOverflow, portal, and so on).
• The Popover component now takes a matchReferenceWidth property (boolean) to render the popover with same width as the referred element.

next-sanity v0.11.1

This release upgrades the picosanity dependency that brings support for configuring the client's API version:

import {
  createClient
} from 'next-sanity'

const config = {
  dataset: process.env.NEXT_PUBLIC_SANITY_DATASET || 'production',
  projectId: process.env.NEXT_PUBLIC_SANITY_PROJECT_ID,
  useCdn: process.env.NODE_ENV === 'production',
  apiVersion: '2021-03-25'
}

export const sanityClient = createClient(config)

GROQ v2021-03-25

• Optimize *[a[].b match "foo"]
• Optimize nested paths (e.g. *[foo[].bar[].baz match "bar"]). This also makes them possible to use inside score().

• Fix *[foo == null] when foo refers to an empty object
• Fix some edge case bugs related to negation.

GROQ v2021-03-25

Content Lake is a full refactor of Sanity's backend and query engine. You can start using it by upgrading and specifying an API version for your client. Content Lake follows the GROQ specification and introduces both bug fixes and new features.

We have updated the documentation to reflect the newest version. This changelog contains the breaking changes and migration paths you need to take. You can take your time and stay on v1 for as long as you need, while you test and compare your queries against the new version. You can also specify the API version for only new queries to gradually move over. Let us know in the community if you have questions or need help.

The GROQ ^ operator now works correctly in all scopes.

This fixes the known issue where the ^ operator only worked in subqueries. In all other scopes, it returned the root of the current scope, instead of the parent scope.

*[_type=="person"]{
  name,
  someObj{
    name,
    // Old Behavior: "parentName" returns someObj.name
    // New Behavior: "parentName" returns root name value
    "parentName": ^.name
  }
}

GROQ now uses three-valued logic consistently:

• >, >=, <, <= returns null when the operands are of different types.
• &&, || handles null "as expected": null && true ⇒ null and null || true ⇒ true.

Note that == has changed slightly:

• It now always return either true or false (never null).
• You can compare against null and get the expected result: 123 == null ⇒ false and null == null ⇒ true.
• Comparisons between other types than strings/booleans/numbers always return false.

This also means that in works with null: null in foo will return true if foo is [null, 1, 2].

in null always returns null.

We have cleaned up the behavior for array traversal. For example, queries that contained multiple array traversals that don't work in v1, now work as expected in v2021-03-25 and onward.

*["link" in body[].markDefs[]._type]
// v1: No results
// v2021-03-25: An array of documents that has a link annotation in their "body" field

// Data:
[
  {
    "_type": "book",
    "authors": [
      { "names": ["MH", "Holm"] },
      { "names": ["Bob"] },
    ]
  }
]

// Query:
*[_type == "book"].authors[].names

// v1:
[null]

// v2021-03-25:
[
  [
    "MH",
    "Holm",
  ],
  [
    "Bob"
  ]
]

// You can also add an additional `[]` to flatten it completely:

// Query:
*[_type == "book"].authors[].names[]

// v2021-03-25:
[
  "MH",
  "Holm",
  "Bob"
]

If you have stored null values in your documents, these are no longer removed in projections.

You can now override attributes while using the spread operator (...).

// Data
[{"title": "A", "customTitle": "B", "_type": "post"}]

// Query:
*[_type == "post"]{..., "title": customTitle}

// Output from v1: 
[{"title": "A"}]

// Output from v2021-03-25:
[{"title": "B"}]

All numbers are now 64-bit floats. Previously we used 64-bit integer representation in certain contexts.

Previously ordering by strings would in some context use a "smart" numeric ordering instead of proper string comparison:

// Query:
["foo4", "foo12"]|order(@)

// v1:
["foo4", "foo12"]

// v2021-03-25:
["foo12", "foo4"]

// However, *|order(foo) has always (both before and after) used proper string comparison.

The is operator has been deprecated. You can use the equivalent comparison instead:

// v1:
*[_type is "post"]

// v2021-03-25:
*[_type == "post"]

Previously you could call functions without parentheses: *[length "foo" > 3]. This is now no longer possible and is a syntax error. You should use *[length(foo) > 3] instead.

You can use now() and identity() instead.

Whenever you apply the projection operator ({}) on a non-object then it returns null instead of executing the object expression.

This means that the following query *[foo == bar][0]{a} now correctly returns null if there were no results. Previously this returned {}.

Previously negative indexes were not respected: [_type == "article"][-1] was equivalent to [_type == "article"][1]. This has now been fixed and -1 returns the last document.

The following query now fails: *[_type == "bar" && @[""] == "bar"] since empty attribute keys are not allowed.

Passing | order(…) on non-arrays return a null value instead of converting it to an array.

defined(x) is now only false when x is null. Previously it was false for empty arrays and objects as well.

The pipe operator (|) used to work between nearly all access operators, filters, and slices (e.g., * | [filter], * | (foo), * | [2..4], and * | [2] were all permitted). The pipe operator remains required before the score() and order() pipe functions, and is optional before a projection, but using one before a filter or traversal syntax will throw an error.

Namespaces allow for a stronger grouping of functionality within the GROQ specification. They create dedicated spaces for global functions, as well as safer distinctions for specific implementations of GROQ. Learn more.

The score() function computes a _score for each document from how well the expression matches the document. The documents will also be sorted by score (from high to low) if no other order() function is specified. Note that all documents will be scored (even those that don't match it at all) so you typically want to add a limit. Read more about scoring and boosting.

The pt::text() function takes either a Portable Text block or an array of blocks and returns a string in which blocks are appended with a double newline character (\n\n). Text spans within a block are appended without space or newline. Read more about getting plain text from Portable Text.

The geo namespace contains a number of useful functions for creating and querying against locations in your data. Query for distance, intersections, and more.

It's now possible to filter and order efficiently on date times:

// Filter
*[_type == "post" && dateTime(publishedAt) > dateTime("2021-01-01T12:00:00")]

// Order
*[_type == "post"]|order(dateTime(publishedAt) desc)

If you have huge documents, but your queries have projections that filter away most of the data (e.g., *[_type == "post"]{title, description}) you may see performance improvements.

Expressions that use both && and || will now often be much faster (depending on how complicated they are).

*[
  _type == "post" &&
  slug == "hello" &&
  ("news" in tags || products[0].name == "Sanity")
]

// v1: Slow!
// v2021-03-25: Much faster!

Content Lake v2021-03-25

The following bugfixes has been put into production:

• Make listeners work in v2021-03-25
• Fix bug where it was possible to change the _id of a document.
• Fix bug which prevented datasets to be deleted

GROQ v2021-03-25

This release fixes smaller bugs for GROQ v2021-03-25.

• Fixes a bug where dereferencing inside sliced arrays (e.g. *[_type == "book"]{"authors": authors[0...2]{era->}}) would return incorrect result.
• Fixes a bug where scoping was incorrect while dereferencing arrays: *[_type == "book"]{"authors": authors[]->{..., "bookName": ^.name}}
• select now produces a query error when given invalid arguments. Examples of invalid arguments are select(title, title2) (multiple fallback values) and select(title, isGood => title2) (alternatives after the fallback)

Content Lake v2021-03-25

This release targeting v2021-03-25 and v2021-10-21 of the Content Lake brings several new function namespaces to GROQ, as well as introduces the first formalized version of the GROQ language specification.

There are three new namespaces for functions added to the specification, which have been implemented across all GROQ tooling. These are:

array:: functions: Perform array operations on lists, such as removing all null values, building text strings from a list of names, or generating a list of all unique document _types.

• array::compact(<array>) - removes all null values from an array
• array::join(<array>, <token>) - concatenates all array elements into one string, separated by a specified token.
• array::unique(<array>) - removes duplicate values from an array (this works for values that can be compared for equality, specifically numbers, strings, booleans, and null, and will not work for values that are arrays or objects)

math:: functions: Run common mathematical operators on numeric values. For example, you can add the prices across multiple products or return the maximum discount available within a cart of products.

• math::avg(<array-of-numbers>) - calculates the average value (arithmetic mean) of an array of numbers.
• math::max(<array-of-numbers>) - returns the largest numeric value of an array of numbers.
• math::min(<array-of-numbers>) - returns the smallest numeric value of an array of numbers.
• math::sum(<array-of-numbers>) - calculates the sum of an array of numbers.

string:: functions: Manipulate text or validate that information matches a given prefix. For example, get a list of the articles that start with “How to” or split a comma-separated string of author names into an array.

• string::split(<string>, <delimiter-token>) - turns a string into an array of substrings based on a delimiting token.
• string::startsWith(<string>, <string-pattern>) - checks if a prefix string exactly matches the start of another string.

To learn all about the new GROQ functions, read the developer update accompanying this release, and visit our documentation.

With this release, we are also pleased to announce the formal language specification of GROQ, as well as a new versioning scheme. Taking inspiration from other well-known language specs, like HTML and SQL, we settled on the following format:

GROQ-<major version #>.revision<#>

The current version of the specification is GROQ-1.revision1. This version does not include any breaking changes. To learn more about the history and future of the GROQ language, read the blog post from Co-founder and CTO Simen Svale Skogsrud: Content is Queryable: (Re)Introducing GROQ.

Studio v2.6.3

This release includes a ground-up rewrite of the default Date and DateTime inputs in the Sanity Studio. The new date inputs are powered by Sanity UI and come with improved keyboard accessibility and fewer bugs.

Gatsby source plugin v7.0.0

Breaking changes in v7.x

Starting at v7.0.0, this plugin requires Gatsby v3 and no longer supports Gatsby v2 or earlier. See the migration guide for instructions on how to upgrade to v7 of this plugin. If you're not yet ready to upgrade to Gatsby v3 we recommend staying at v6.x of this plugin.

GraphQL v2020-12-07

Breaking changes between gen2 and gen3

The third generation of the GraphQL API adds support for querying all documents through the new allDocument type. However, with a new generation comes breaking changes.

We had to rename a type to avoid conflicts. DocumentFilter has been renamed to Sanity_DocumentFilter. In other words, if you for example have a query like this:

query GetAllUser($docFilter: Sanity_DocumentFilter) {
  allUser(_: $docFilter) {
    _id
  }
}

It should now look like this in gen3:

query GetAllUser($docFilter: DocumentFilter) {
  allUser(_: $docFilter) {
    _id
    
  }
}

GraphQL v2020-02-27

In order to use the old beta version of the GraphQL API, you can specify it when running the GraphQL command from the CLI. We call these older versions generations. The beta generation is named gen1, and the current generation is named gen2.

To deploy the old generation (beta), you can use the --generation flag in the CLI like this:

sanity graphql deploy --generation gen1

The second generation of the GraphQL API has more features, and does not pluralize the top-level collection types:

• Generation 1: post, allPosts
• Generation 2: post, allPost

The CLI will warn you if there are breaking changes to the schema you deploy and show you where they are. The breaking changes prompt can be disabled by running the deploy command with the --force flag.