fix(block-tools): enforce list support in schema

HTML lists should not be deserialized to list blocks if there is no such support in schema
sanity-io · Oct 10, 2023 · 882e4f1 · 882e4f1
1 parent 4151f2e
commit 882e4f1
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 7 deletions.
diff --git a/packages/@sanity/block-tools/src/HtmlDeserializer/helpers.ts b/packages/@sanity/block-tools/src/HtmlDeserializer/helpers.ts
@@ -26,10 +26,12 @@ export function createRuleOptions(blockContentType: ArraySchemaType): BlockEnabl
   const enabledBlockStyles = features.styles.map((item) => item.value || item.title)
   const enabledSpanDecorators = features.decorators.map((item) => item.value || item.title)
   const enabledBlockAnnotations = features.annotations.map((item) => item.value || item.title || '')
+  const enabledListTypes = features.lists.map((item) => item.value || item.title || '')
   return {
     enabledBlockStyles,
     enabledSpanDecorators,
     enabledBlockAnnotations,
+    enabledListTypes,
   }
 }
 

diff --git a/packages/@sanity/block-tools/src/HtmlDeserializer/rules/html.ts b/packages/@sanity/block-tools/src/HtmlDeserializer/rules/html.ts
@@ -14,17 +14,24 @@ import {
 } from '../../constants'
 import {BlockEnabledFeatures, DeserializerRule} from '../../types'
 
-export function resolveListItem(listNodeTagName: string): string {
+export function resolveListItem(
+  listNodeTagName: string,
+  enabledListTypes: string[],
+): string | undefined {
   let listStyle
   switch (listNodeTagName) {
     case 'ul':
-      listStyle = 'bullet'
+      if (enabledListTypes.includes('bullet')) {
+        listStyle = 'bullet'
+      }
       break
     case 'ol':
-      listStyle = 'number'
+      if (enabledListTypes.includes('number')) {
+        listStyle = 'number'
+      }
       break
     default:
-      listStyle = 'bullet'
+      listStyle = undefined
   }
   return listStyle
 }
@@ -188,15 +195,19 @@ export default function createHTMLRules(
       },
     }, // Deal with list items
     {
-      deserialize(el, next) {
+      deserialize(el, next, block) {
         const tag = tagName(el)
         const listItem = tag ? HTML_LIST_ITEM_TAGS[tag] : undefined
         const parentTag = tagName(el.parentNode) || ''
+        const enabledListItem = resolveListItem(parentTag, options.enabledListTypes)
         if (!listItem || !el.parentNode || !HTML_LIST_CONTAINER_TAGS[parentTag]) {
           return undefined
         }
-
-        listItem.listItem = resolveListItem(parentTag)
+        // If list item style is not supported, return a defaultBlockType
+        if (!enabledListItem) {
+          return block({_type: blockContentType.name, children: next(el.childNodes)})
+        }
+        listItem.listItem = enabledListItem
         return {
           ...listItem,
           children: next(el.childNodes),

diff --git a/packages/@sanity/block-tools/src/types.ts b/packages/@sanity/block-tools/src/types.ts
@@ -118,5 +118,6 @@ export interface DeserializerRule {
 export interface BlockEnabledFeatures {
   enabledBlockStyles: string[]
   enabledSpanDecorators: string[]
+  enabledListTypes: string[]
   enabledBlockAnnotations: string[]
 }