@portabletext/editor 3.0.7 → 3.0.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portabletext/editor",
-  "version": "3.0.7",
+  "version": "3.0.8",
   "description": "Portable Text Editor made in React",
   "keywords": [
     "sanity",
@@ -73,7 +73,7 @@
     "slate-dom": "^0.119.0",
     "slate-react": "0.119.0",
     "xstate": "^5.24.0",
-    "@portabletext/block-tools": "^4.1.2",
+    "@portabletext/block-tools": "^4.1.3",
     "@portabletext/keyboard-shortcuts": "^2.1.0",
     "@portabletext/patches": "^2.0.0",
     "@portabletext/schema": "^2.0.0"
@@ -81,8 +81,8 @@
   "devDependencies": {
     "@sanity/diff-match-patch": "^3.2.0",
     "@sanity/pkg-utils": "^9.0.3",
-    "@sanity/schema": "^4.18.0",
-    "@sanity/types": "^4.18.0",
+    "@sanity/schema": "^4.19.0",
+    "@sanity/types": "^4.19.0",
     "@types/debug": "^4.1.12",
     "@types/lodash": "^4.17.20",
     "@types/lodash.startcase": "^4.4.9",
@@ -106,14 +106,14 @@
     "vite": "^7.1.12",
     "vitest": "^4.0.9",
     "vitest-browser-react": "^2.0.2",
-    "@portabletext/sanity-bridge": "1.2.5",
+    "@portabletext/sanity-bridge": "1.2.6",
     "@portabletext/test": "^1.0.0",
     "racejar": "2.0.0"
   },
   "peerDependencies": {
-    "@portabletext/sanity-bridge": "^1.2.5",
-    "@sanity/schema": "^4.18.0",
-    "@sanity/types": "^4.18.0",
+    "@portabletext/sanity-bridge": "^1.2.6",
+    "@sanity/schema": "^4.19.0",
+    "@sanity/types": "^4.19.0",
     "react": "^18.3 || ^19",
     "rxjs": "^7.8.2"
   },

package/src/converters/converter.portable-text.deserialize.test.ts

@@ -81,7 +81,6 @@ describe(converterPortableText.deserialize, () => {
               marks: [],
             },
           ],
-          markDefs: [],
         },
       ],
     })
@@ -117,7 +116,6 @@ describe(converterPortableText.deserialize, () => {
               marks: [],
             },
           ],
-          markDefs: [],
         },
       ],
     })
@@ -263,8 +261,6 @@ describe(converterPortableText.deserialize, () => {
             marks: [],
           },
         ],
-        markDefs: [],
-        style: 'normal',
       },
     ])
   })
@@ -299,8 +295,6 @@ describe(converterPortableText.deserialize, () => {
             marks: [],
           },
         ],
-        markDefs: [],
-        style: 'normal',
       },
     ])
   })
@@ -336,8 +330,6 @@ describe(converterPortableText.deserialize, () => {
             marks: [],
           },
         ],
-        markDefs: [],
-        style: 'normal',
       },
     ])
   })
@@ -377,7 +369,6 @@ describe(converterPortableText.deserialize, () => {
             marks: [],
           },
         ],
-        markDefs: [],
         style: 'h1',
       },
     ])
@@ -415,9 +406,7 @@ describe(converterPortableText.deserialize, () => {
             marks: [],
           },
         ],
-        markDefs: [],
         level: 1,
-        style: 'normal',
       },
     ])
   })
@@ -458,10 +447,8 @@ describe(converterPortableText.deserialize, () => {
             marks: [],
           },
         ],
-        markDefs: [],
         listItem: 'bullet',
         level: 1,
-        style: 'normal',
       },
     ])
   })

package/src/editor/plugins/createWithPortableTextMarkModel.ts

@@ -30,6 +30,9 @@ export function createWithPortableTextMarkModel(
     const decorators = editorActor
       .getSnapshot()
       .context.schema.decorators.map((t) => t.name)
+    const defaultStyle = editorActor
+      .getSnapshot()
+      .context.schema.styles.at(0)?.name
 
     // Extend Slate's default normalization. Merge spans with same set of .marks when doing merge_node operations, and clean up markDefs / marks
     editor.normalizeNode = (nodeEntry) => {
@@ -74,6 +77,22 @@ export function createWithPortableTextMarkModel(
         return
       }
 
+      /**
+       * Add missing .style to block nodes
+       */
+      if (
+        defaultStyle &&
+        editor.isTextBlock(node) &&
+        typeof node.style === 'undefined'
+      ) {
+        debug('Adding .style to block node')
+
+        withNormalizeNode(editor, () => {
+          Transforms.setNodes(editor, {style: defaultStyle}, {at: path})
+        })
+        return
+      }
+
       /**
        * Add missing .marks to span nodes
        */

package/src/internal-utils/__tests__/values.test.ts

@@ -51,7 +51,6 @@ describe(toSlateBlock.name, () => {
           text: '123',
         },
       ],
-      style: 'normal',
     })
   })
 
@@ -106,7 +105,6 @@ describe(toSlateBlock.name, () => {
           },
         },
       ],
-      style: 'normal',
     })
   })
 })

package/src/internal-utils/values.test.ts

@@ -32,7 +32,6 @@ describe(toSlateBlock.name, () => {
               text: 'foo',
             },
           ],
-          style: 'normal',
         })
       })
 
@@ -62,7 +61,6 @@ describe(toSlateBlock.name, () => {
               text: 'foo',
             },
           ],
-          style: 'normal',
         })
       })
 
@@ -101,7 +99,6 @@ describe(toSlateBlock.name, () => {
               __inline: true,
             },
           ],
-          style: 'normal',
         })
       })
     })
@@ -148,7 +145,6 @@ describe(toSlateBlock.name, () => {
               },
             },
           ],
-          style: 'normal',
         })
       })
 
@@ -191,7 +187,6 @@ describe(toSlateBlock.name, () => {
               },
             },
           ],
-          style: 'normal',
         })
       })
     })
@@ -238,7 +233,6 @@ describe(toSlateBlock.name, () => {
               },
             },
           ],
-          style: 'normal',
         })
       })
 
@@ -281,7 +275,6 @@ describe(toSlateBlock.name, () => {
               },
             },
           ],
-          style: 'normal',
         })
       })
     })

package/src/internal-utils/values.ts

@@ -35,7 +35,6 @@ export function toSlateBlock(
   if (isPortableText) {
     const textBlock = block as PortableTextTextBlock
     let hasInlines = false
-    const hasMissingStyle = typeof textBlock.style === 'undefined'
     const hasMissingMarkDefs = typeof textBlock.markDefs === 'undefined'
     const hasMissingChildren = typeof textBlock.children === 'undefined'
 
@@ -86,7 +85,6 @@ export function toSlateBlock(
 
     // Return original block
     if (
-      !hasMissingStyle &&
       !hasMissingMarkDefs &&
       !hasMissingChildren &&
       !hasInlines &&
@@ -96,11 +94,6 @@ export function toSlateBlock(
       return block
     }
 
-    // TODO: remove this when we have a better way to handle missing style
-    if (hasMissingStyle) {
-      rest.style = schemaTypes.styles[0].name
-    }
-
     return keepObjectEquality(
       {_type, _key, ...rest, children},
       keyMap,
@@ -176,25 +169,76 @@ export function fromSlateBlock(
 }
 
 export function isEqualToEmptyEditor(
-  children: Descendant[] | PortableTextBlock[],
+  blocks: Array<Descendant> | Array<PortableTextBlock>,
   schemaTypes: EditorSchema,
 ): boolean {
-  return (
-    children === undefined ||
-    (children && Array.isArray(children) && children.length === 0) ||
-    (children &&
-      Array.isArray(children) &&
-      children.length === 1 &&
-      Element.isElement(children[0]) &&
-      children[0]._type === schemaTypes.block.name &&
-      'style' in children[0] &&
-      children[0].style === schemaTypes.styles[0].name &&
-      !('listItem' in children[0]) &&
-      Array.isArray(children[0].children) &&
-      children[0].children.length === 1 &&
-      Text.isText(children[0].children[0]) &&
-      children[0].children[0]._type === 'span' &&
-      !children[0].children[0].marks?.join('') &&
-      children[0].children[0].text === '')
-  )
+  // Must have exactly one block
+  if (blocks.length !== 1) {
+    return false
+  }
+
+  const firstBlock = blocks.at(0)
+
+  if (!firstBlock) {
+    return true
+  }
+
+  if (!Element.isElement(firstBlock)) {
+    return false
+  }
+
+  // Must be a text block
+  if (firstBlock._type !== schemaTypes.block.name) {
+    return false
+  }
+
+  // Must not be a list item
+  if ('listItem' in firstBlock) {
+    return false
+  }
+
+  // Style must exist and be the default style
+  if (
+    !('style' in firstBlock) ||
+    firstBlock.style !== schemaTypes.styles.at(0)?.name
+  ) {
+    return false
+  }
+
+  // Must have children array
+  if (!Array.isArray(firstBlock.children)) {
+    return false
+  }
+
+  // Must have exactly one child
+  if (firstBlock.children.length !== 1) {
+    return false
+  }
+
+  const firstChild = firstBlock.children.at(0)
+
+  if (!firstChild) {
+    return false
+  }
+
+  if (!Text.isText(firstChild)) {
+    return false
+  }
+
+  // Must be a span type
+  if (!('_type' in firstChild) || firstChild._type !== schemaTypes.span.name) {
+    return false
+  }
+
+  // Must have empty text
+  if (firstChild.text !== '') {
+    return false
+  }
+
+  // Must have no marks (marks can be undefined or empty array)
+  if (firstChild.marks?.join('')) {
+    return false
+  }
+
+  return true
 }

package/src/utils/parse-blocks.test.ts

@@ -129,8 +129,6 @@ describe(parseBlock.name, () => {
             marks: [],
           },
         ],
-        markDefs: [],
-        style: 'normal',
       })
     })
 
@@ -160,8 +158,6 @@ describe(parseBlock.name, () => {
             marks: [],
           },
         ],
-        markDefs: [],
-        style: 'normal',
       })
     })
 
@@ -271,8 +267,6 @@ describe(parseBlock.name, () => {
             marks: ['em'],
           },
         ],
-        markDefs: [],
-        style: 'normal',
       })
     })
 
@@ -301,9 +295,7 @@ describe(parseBlock.name, () => {
             marks: [],
           },
         ],
-        markDefs: [],
         listItem: 'bullet',
-        style: 'normal',
       })
     })
 
@@ -332,8 +324,6 @@ describe(parseBlock.name, () => {
             marks: [],
           },
         ],
-        markDefs: [],
-        style: 'normal',
       })
     })
 
@@ -363,8 +353,6 @@ describe(parseBlock.name, () => {
               marks: [],
             },
           ],
-          markDefs: [],
-          style: 'normal',
         })
       })
 
@@ -398,8 +386,6 @@ describe(parseBlock.name, () => {
               marks: [],
             },
           ],
-          markDefs: [],
-          style: 'normal',
         })
       })
 
@@ -432,8 +418,6 @@ describe(parseBlock.name, () => {
               marks: [],
             },
           ],
-          markDefs: [],
-          style: 'normal',
         })
       })
     })

package/src/utils/parse-blocks.ts

@@ -249,25 +249,20 @@ export function parseTextBlock({
     _type: context.schema.block.name,
     _key,
     children: normalizedChildren,
-    markDefs: options.removeUnusedMarkDefs
-      ? markDefs.filter((markDef) => marks.includes(markDef._key))
-      : markDefs,
     ...customFields,
   }
 
+  if (typeof block.markDefs === 'object' && block.markDefs !== null) {
+    parsedBlock.markDefs = options.removeUnusedMarkDefs
+      ? markDefs.filter((markDef) => marks.includes(markDef._key))
+      : markDefs
+  }
+
   if (
     typeof block.style === 'string' &&
     context.schema.styles.find((style) => style.name === block.style)
   ) {
     parsedBlock.style = block.style
-  } else {
-    const defaultStyle = context.schema.styles.at(0)?.name
-
-    if (defaultStyle !== undefined) {
-      parsedBlock.style = defaultStyle
-    } else {
-      console.error('Expected default style')
-    }
   }
 
   if (