feat(core): schema and field deprecation

[binoy14]

Description

This PR adds ability to deprecate documents and fields.

Example to deprecate a document

defineType({
  name: 'deprecatedDocument',
  title: 'Deprecated Document',
  type: 'document',
  deprecated: {
    reason: 'This document type is deprecated, use the author document',
  },
})

Example to deprecate a field

defineField({
  deprecated: {
    reason:
      'Use the non deprecated string field for new content, this field was originally for the old frontend',
  },
  description: 'This field is used to create the header for the site',
  validation: (Rule) => Rule.required(),
  name: 'string',
  title: 'string',
  type: 'string',
}),

The deprecation messages also gets carried over to the graphql schema

What to review

Test for deprecated fields
Test for deprecated document

Notes for release

• Adds support for deprecating fields and document types

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
performance-studio	✅ Ready (Inspect)	Visit Preview		Jan 23, 2024 4:19pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 23, 2024 4:19pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Jan 23, 2024 4:19pm

[github-actions]

Package	Documentation Change
sanity	-3%

Full Report

@sanity/migrate

This branch	Next branch
0 documented	0 documented
30 not documented	0 not documented

@sanity/diff

This branch	Next branch
13 documented	13 documented
16 not documented	16 not documented

@sanity/block-tools

This branch	Next branch
4 documented	4 documented
9 not documented	9 not documented

@sanity/types

This branch	Next branch
55 documented	55 documented
239 not documented	234 not documented

sanity/desk

This branch	Next branch
84 documented	84 documented
64 not documented	64 not documented

@sanity/portable-text-editor

This branch	Next branch
21 documented	21 documented
44 not documented	44 not documented

@sanity/mutator

This branch	Next branch
7 documented	7 documented
4 not documented	4 not documented

@sanity/cli

This branch	Next branch
1 documented	1 documented
31 not documented	31 not documented

@sanity/schema/_internal

This branch	Next branch
0 documented	0 documented
12 not documented	12 not documented

@sanity/util/paths

This branch	Next branch
1 documented	1 documented
15 not documented	15 not documented

sanity/router

This branch	Next branch
17 documented	17 documented
26 not documented	26 not documented

@sanity/util/legacyDateFormat

This branch	Next branch
0 documented	0 documented
3 not documented	3 not documented

@sanity/schema

This branch	Next branch
0 documented	0 documented
2 not documented	2 not documented

sanity/structure

This branch	Next branch
2 documented	2 documented
6 not documented	6 not documented

sanity/cli

This branch	Next branch
2 documented	2 documented
0 not documented	0 not documented

@sanity/vision

This branch	Next branch
0 documented	0 documented
3 not documented	3 not documented

@sanity/util/fs

This branch	Next branch
0 documented	0 documented
3 not documented	3 not documented

sanity/_internal

This branch	Next branch
0 documented	0 documented
1 not documented	1 not documented

sanity/_internalBrowser

This branch	Next branch
0 documented	0 documented
3 not documented	3 not documented

@sanity/util/content

This branch	Next branch
1 documented	1 documented
5 not documented	5 not documented

sanity

This branch	Next branch
177 documented	183 documented
843 not documented	846 not documented

[github-actions]

Component Testing Report Updated Jan 23, 2024 4:21 PM (UTC)

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	33s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	6s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	13s	3	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	13s	4	2	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	12s	6	0	0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	34s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	18s	9	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 2s	18	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	14s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	7s	3	0	0

[binoy14]

@juice49 could you look at the unit tests and commit snapshots if it looks good

[ricokahler]

Looks great! I had one non-blocking comment in there to consider regarding types but I'd say go to go otherwise.