fix(schemaExtract): guard for list options not being an array (#6128)

* fix(schemaExtract): guard for list options not being an array * test(schema): add non-array field `list` option --------- Co-authored-by: Espen Hovlandsdal <[email protected]>
sanity-io · Mar 26, 2024 · e4f28e5 · e4f28e5
1 parent aca88e9
commit e4f28e5
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 8 deletions.
diff --git a/packages/@sanity/schema/src/sanity/extractSchema.ts b/packages/@sanity/schema/src/sanity/extractSchema.ts
@@ -347,10 +347,11 @@ function isNumberType(typeDef: SanitySchemaType): typeDef is NumberSchemaType {
 function createStringTypeNodeDefintion(
   stringSchemaType: StringSchemaType,
 ): StringTypeNode | UnionTypeNode<StringTypeNode> {
-  if (stringSchemaType.options?.list) {
+  const listOptions = stringSchemaType.options?.list
+  if (listOptions && Array.isArray(listOptions)) {
     return {
       type: 'union',
-      of: stringSchemaType.options.list.map((v) => ({
+      of: listOptions.map((v) => ({
         type: 'string',
         value: typeof v === 'string' ? v : v.value,
       })),
@@ -364,10 +365,11 @@ function createStringTypeNodeDefintion(
 function createNumberTypeNodeDefintion(
   numberSchemaType: NumberSchemaType,
 ): NumberTypeNode | UnionTypeNode<NumberTypeNode> {
-  if (numberSchemaType.options?.list) {
+  const listOptions = numberSchemaType.options?.list
+  if (listOptions && Array.isArray(listOptions)) {
     return {
       type: 'union',
-      of: numberSchemaType.options.list.map((v) => ({
+      of: listOptions.map((v) => ({
         type: 'number',
         value: typeof v === 'number' ? v : v.value,
       })),

diff --git a/packages/@sanity/schema/test/extractSchema/extractSchema.test.ts b/packages/@sanity/schema/test/extractSchema/extractSchema.test.ts
@@ -437,6 +437,17 @@ describe('Extract schema test', () => {
     expect(book.attributes.subtitle.optional).toBe(false)
   })
 
+  describe('can handle `list` option that is not an array', () => {
+    const schema = createSchema(schemaFixtures.listObjectOption)
+    const extracted = extractSchema(schema)
+
+    const post = extracted.find((type) => type.name === 'post')
+    assert(post !== undefined) // this is a workaround for TS, but leave the expect above for clarity in case of failure
+    assert(post.type === 'document') // this is a workaround for TS, but leave the expect above for clarity in case of failure
+
+    expect(post.attributes.align.value.type).toBe('string')
+  })
+
   describe('Can extract sample fixtures', () => {
     const cases = Object.keys(schemaFixtures).map((schemaName) => {
       const schema = createSchema(schemaFixtures[schemaName])

diff --git a/packages/@sanity/schema/test/legacy/fixtures/schemas/index.ts b/packages/@sanity/schema/test/legacy/fixtures/schemas/index.ts
@@ -3,6 +3,7 @@ import assets from './assets'
 import blocks from './blocks'
 import exampleBlog from './example-blog'
 import fieldsets from './fieldsets'
+import listObjectOption from './listObjectOption'
 import messyDevSchema from './messy-dev'
 import oma from './oma'
 import reference from './reference'
@@ -12,12 +13,13 @@ import vega from './vega'
 export default {
   arrays,
   assets,
+  blocks,
   exampleBlog,
   fieldsets,
-  reference,
-  vega,
-  blocks,
+  listObjectOption,
+  messyDevSchema,
   oma,
+  reference,
   selects,
-  messyDevSchema,
+  vega,
 }
diff --git a/packages/@sanity/schema/test/legacy/fixtures/schemas/listObjectOption.ts b/packages/@sanity/schema/test/legacy/fixtures/schemas/listObjectOption.ts
@@ -0,0 +1,30 @@
+export default {
+  name: 'listObjectOption',
+  types: [
+    {
+      name: 'stringWithListOption',
+      type: 'string',
+    },
+    {
+      name: 'post',
+      type: 'document',
+      fields: [
+        {
+          name: 'title',
+          title: 'Title',
+          type: 'string',
+        },
+        {
+          name: 'align',
+          title: 'Alignment',
+          type: 'stringWithListOption',
+          options: {
+            list: {
+              options: ['left', 'right', 'center'],
+            },
+          },
+        },
+      ],
+    },
+  ],
+}