fix(schema-extraction): check for _required field in validation rules (…

…#6151) * fix(schema-extraction): check for _required field in validation rules * test(schema): add test case for extraction on explicit optional field --------- Co-authored-by: Espen Hovlandsdal <[email protected]>
sanity-io · Apr 1, 2024 · 5ba26a5 · 5ba26a5
1 parent 5756753
commit 5ba26a5
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/packages/@sanity/schema/src/sanity/extractSchema.ts b/packages/@sanity/schema/src/sanity/extractSchema.ts
@@ -315,12 +315,19 @@ function isFieldRequired(field: ObjectField): boolean {
         },
       },
     ) as Rule
+
     if (typeof rule === 'function') {
       rule(proxy)
       if (required) {
         return true
       }
     }
+
+    if (typeof rule === 'object' && rule !== null && '_required' in rule) {
+      if (rule._required === 'required') {
+        return true
+      }
+    }
   }
 
   return false

diff --git a/packages/@sanity/schema/test/extractSchema/extractSchema.test.ts b/packages/@sanity/schema/test/extractSchema/extractSchema.test.ts
@@ -387,6 +387,12 @@ describe('Extract schema test', () => {
               type: 'string',
               validation: (Rule) => Rule.required(),
             }),
+            {
+              title: 'Another Title',
+              name: 'anotherTitle',
+              type: 'string',
+              validation: {_required: 'required'},
+            },
           ],
         },
       ],
@@ -400,6 +406,7 @@ describe('Extract schema test', () => {
     assert(book.type === 'document') // this is a workaround for TS, but leave the expect above for clarity in case of failure
     expect(book.attributes.title.optional).toBe(true)
     expect(book.attributes.subtitle.optional).toBe(true)
+    expect(book.attributes.anotherTitle.optional).toBe(true)
   })
 
   test('can extract with enforceRequiredFields', () => {
@@ -422,6 +429,18 @@ describe('Extract schema test', () => {
               type: 'string',
               validation: (Rule) => Rule.required(),
             }),
+            {
+              title: 'Another Title',
+              name: 'anotherTitle',
+              type: 'string',
+              validation: {_required: 'required'},
+            },
+            {
+              title: 'Optional Title',
+              name: 'optionalTitle',
+              type: 'string',
+              validation: {_required: 'optional'},
+            },
           ],
         },
       ],
@@ -435,6 +454,8 @@ describe('Extract schema test', () => {
     assert(book.type === 'document') // this is a workaround for TS, but leave the expect above for clarity in case of failure
     expect(book.attributes.title.optional).toBe(true)
     expect(book.attributes.subtitle.optional).toBe(false)
+    expect(book.attributes.anotherTitle.optional).toBe(false)
+    expect(book.attributes.optionalTitle.optional).toBe(true)
   })
 
   describe('can handle `list` option that is not an array', () => {