feat: support nullish values for html rich text serializer functions

prismicio · Jul 18, 2024 · eff843a · eff843a
1 parent 5cff6b3
commit eff843a
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 3 deletions.
diff --git a/src/richtext/utils/hastUtilToRichText.ts b/src/richtext/utils/hastUtilToRichText.ts
@@ -90,7 +90,9 @@ type RichTextHTMLMapSerializerFunction = (
 	| RichTextHTMLMapSerializerShorthand
 	| RTNode
 	| RTInlineNode
-	| RTPartialInlineNode;
+	| RTPartialInlineNode
+	| null
+	| undefined;
 
 /**
  * Serializes an hast {@link Element} node matching the given HTML tag name or
@@ -209,8 +211,14 @@ export const hastUtilToRichText = (
 					context: { listType: lastListType },
 				});
 
-				// When the serializer returns a rich text node, we append it and return.
-				if (typeof shorthandOrNode === "object" && "type" in shorthandOrNode) {
+				if (!shorthandOrNode) {
+					// Exit on unhandled node.
+					return;
+				} else if (
+					typeof shorthandOrNode === "object" &&
+					"type" in shorthandOrNode
+				) {
+					// When the serializer returns a rich text node, we append it and return.
 					switch (shorthandOrNode.type) {
 						case RichTextNodeType.strong:
 						case RichTextNodeType.em:

diff --git a/test/richtext/__snapshots__/htmlAsRichText.test.ts.snap b/test/richtext/__snapshots__/htmlAsRichText.test.ts.snap
@@ -288,6 +288,23 @@ exports[`transforms HTML to rich text > configuration > serializer > function se
 ]
 `;
 
+exports[`transforms HTML to rich text > configuration > serializer > function serializer > nullish 1`] = `
+[
+  {
+    "direction": "ltr",
+    "spans": [],
+    "text": "lorem ipsum dolor sit amet",
+    "type": "paragraph",
+  },
+  {
+    "direction": "ltr",
+    "spans": [],
+    "text": "consectetur adipiscing elit",
+    "type": "paragraph",
+  },
+]
+`;
+
 exports[`transforms HTML to rich text > configuration > serializer > function serializer > span nodes > full 1`] = `
 [
   {

diff --git a/test/richtext/htmlAsRichText.test.ts b/test/richtext/htmlAsRichText.test.ts
@@ -233,6 +233,17 @@ describe("transforms HTML to rich text", () => {
 					expectAsHTMLNotToMatchInput: true,
 				});
 
+				testHTMLAsRichTextHelper("nullish", {
+					input: /* html */ `<p data-heading>lorem ipsum dolor sit amet</p><p>consectetur adipiscing elit</p>`,
+					config: {
+						serializer: {
+							p: ({ node }) =>
+								"dataHeading" in node.properties ? null : "paragraph",
+						},
+					},
+					expectAsHTMLNotToMatchInput: true,
+				});
+
 				testHTMLAsRichTextHelper("text nodes", {
 					input: /* html */ `<div>lorem ipsum dolor sit amet</div>`,
 					config: {