Merge pull request #98 from Financial-Times/support-text-nodes

adgad · web-flow · commit 1e271e992a54 · 2025-09-05T15:56:07.000+01:00
Support text nodes
diff --git a/README.md b/README.md
@@ -105,6 +105,7 @@ type BodyBlock =
 	| Tweet
 	| Video
 	| YoutubeVideo
+	| Text
 ```
 
 `BodyBlock` nodes are the only things that are valid as the top level of a `Body`.
diff --git a/content-tree.d.ts b/content-tree.d.ts
@@ -1,5 +1,5 @@
 export declare namespace ContentTree {
-    type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo;
+    type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
     type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
     type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
     interface Node {
@@ -274,7 +274,7 @@ export declare namespace ContentTree {
         attributes: CustomCodeComponentAttributes;
     }
     namespace full {
-        type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo;
+        type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
         type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
         type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
         interface Node {
@@ -550,7 +550,7 @@ export declare namespace ContentTree {
         }
     }
     namespace transit {
-        type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo;
+        type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
         type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
         type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
         interface Node {
@@ -811,7 +811,7 @@ export declare namespace ContentTree {
         }
     }
     namespace loose {
-        type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo;
+        type BodyBlock = Paragraph | Heading | ImageSet | Flourish | BigNumber | CustomCodeComponent | Layout | List | Blockquote | Pullquote | ScrollyBlock | ThematicBreak | Table | Recommended | Tweet | Video | YoutubeVideo | Text;
         type LayoutWidth = "auto" | "in-line" | "inset-left" | "inset-right" | "full-bleed" | "full-grid" | "mid-grid" | "full-width";
         type Phrasing = Text | Break | Strong | Emphasis | Strikethrough | Link;
         interface Node {
diff --git a/libraries/from-bodyxml/index.js b/libraries/from-bodyxml/index.js
@@ -448,19 +448,11 @@ export function fromXast(bodyxast, transformers = defaultTransformers) {
   })(bodyxast);
 }
 
-/**
- * Turns e.g. </p> </body> into </p></body>, which a lot of our content has
- * This prevents random strat text nodes being created in bodyTree
- * @param {string} xml
- * @returns {string}
- */
-function removeWhitespaceBeforeBodyTag(xml) {
-  return xml.replace(/<\/p>\s+<\/body>/gi, '</p></body>');
-}
+
 
 /** @param {string} bodyxml */
 export function fromXML(bodyxml) {
-  return fromXast(xastFromXml(removeWhitespaceBeforeBodyTag(bodyxml)));
+  return fromXast(xastFromXml(bodyxml));
 }
 
 export default fromXML;
diff --git a/libraries/to-string/test.js b/libraries/to-string/test.js
@@ -3,7 +3,7 @@ import assert from "node:assert"
 import stringify from "@content-tree/to-string"
 import fs from "fs/promises"
 
-let testBase = "../../tests/content-tree-to-string"
+let testBase = "../../tests/transit-tree-to-string"
 let inputNames = await fs.readdir(`${testBase}/input/`)
 
 for (let inputName of inputNames) {
diff --git a/schemas/body-tree.schema.json b/schemas/body-tree.schema.json
@@ -119,6 +119,9 @@
                 },
                 {
                     "$ref": "#/definitions/ContentTree.transit.YoutubeVideo"
+                },
+                {
+                    "$ref": "#/definitions/ContentTree.transit.Text"
                 }
             ]
         },
diff --git a/schemas/content-tree.schema.json b/schemas/content-tree.schema.json
@@ -144,6 +144,9 @@
                 },
                 {
                     "$ref": "#/definitions/ContentTree.full.YoutubeVideo"
+                },
+                {
+                    "$ref": "#/definitions/ContentTree.full.Text"
                 }
             ]
         },
diff --git a/schemas/transit-tree.schema.json b/schemas/transit-tree.schema.json
@@ -144,6 +144,9 @@
                 },
                 {
                     "$ref": "#/definitions/ContentTree.transit.YoutubeVideo"
+                },
+                {
+                    "$ref": "#/definitions/ContentTree.transit.Text"
                 }
             ]
         },
diff --git a/tests/body-tree-to-string/output/kitchen-snippet-full.text b/tests/body-tree-to-string/output/kitchen-snippet-full.text
diff --git a/tests/body-tree-to-string/output/kitchen-snippet.text b/tests/body-tree-to-string/output/kitchen-snippet.text
diff --git a/tests/bodyxml-to-content-tree/input/simple-old-post.xml b/tests/bodyxml-to-content-tree/input/simple-old-post.xml
@@ -8,5 +8,5 @@
     <pull-quote-text><p>Maecenas ac ipsum in elit aliquam consectetur. Proin felis metus, efficitur et nulla eu, interdum malesuada diam.</p></pull-quote-text><pull-quote-image><ft-content data-embedded="true" url="http://api-t.ft.com/content/77c8a5b5-c9e3-4df2-ad5f-3ef35fe1d9d4" type="http://www.ft.com/ontology/content/ImageSet"></ft-content></pull-quote-image><pull-quote-source>Pellentesque habitant, morbi tristique</pull-quote-source>
 </pull-quote>
 <p>Donec id faucibus erat. Suspendisse tempor laoreet lorem, sit amet vehicula massa facilisis at. Nulla quis feugiat massa. Praesent viverra non lectus ut ullamcorper. Phasellus <ft-content url="http://api-t.ft.com/content/c71efed9-fe5a-488d-9f47-20c15d177153" type="http://www.ft.com/ontology/content/Article">porttitor neque</ft-content> at volutpat pulvinar.</p>
-<p>“Curabitur fermentum, dolor vel interdum varius, tellus justo dapibus velit, interdum sollicitudin dolor nibh varius velit.”</p> 
+<p>“Curabitur fermentum, dolor vel interdum varius, tellus justo dapibus velit, interdum sollicitudin dolor nibh varius velit.”</p>
 </body>
diff --git a/tests/bodyxml-to-content-tree/output/kitchen-snippet.json b/tests/bodyxml-to-content-tree/output/kitchen-snippet.json
@@ -716,8 +716,7 @@
 			},
 			{
 				"type": "video",
-				"id": "http://api-t.ft.com/content/9eef331b-04f0-4774-b487-a5aef2995e4d",
-				"embedded": true
+				"id": "http://api-t.ft.com/content/9eef331b-04f0-4774-b487-a5aef2995e4d"
 			},
 			{
 				"type": "paragraph",
diff --git a/tests/schema/body-tree/valid/kitchen-snippet.json b/tests/schema/body-tree/valid/kitchen-snippet.json
@@ -1283,6 +1283,10 @@
           "value": "If this sounds all-too-familiar, stick with me. I have a proven treatment for Kitchen Sink Syndrome."
         }
       ]
+    },
+    {
+      "type": "text",
+      "value": "",
     }
   ]
 }
diff --git a/tests/transit-tree-to-string/output/kitchen-snippet-full.text b/tests/transit-tree-to-string/output/kitchen-snippet-full.text
diff --git a/tests/transit-tree-to-string/output/kitchen-snippet.text b/tests/transit-tree-to-string/output/kitchen-snippet.text

Original file line number	Diff line number	Diff line change
`@@ -119,6 +119,9 @@`
`119`	`119`	`},`
`120`	`120`	`{`
`121`	`121`	`"$ref": "#/definitions/ContentTree.transit.YoutubeVideo"`
	`122`	`+ },`
	`123`	`+ {`
	`124`	`+ "$ref": "#/definitions/ContentTree.transit.Text"`
`122`	`125`	`}`
`123`	`126`	`]`
`124`	`127`	`},`
Original file line number	Diff line number	Diff line change
`@@ -144,6 +144,9 @@`
`144`	`144`	`},`
`145`	`145`	`{`
`146`	`146`	`"$ref": "#/definitions/ContentTree.full.YoutubeVideo"`
	`147`	`+ },`
	`148`	`+ {`
	`149`	`+ "$ref": "#/definitions/ContentTree.full.Text"`
`147`	`150`	`}`
`148`	`151`	`]`
`149`	`152`	`},`