Update @types/xast, utilities

Author: wooorm

lib/index.js

@@ -14,7 +14,9 @@
  * @typedef {import('xast').Doctype} Doctype
  * @typedef {import('xast').Element} Element
  * @typedef {import('xast').Instruction} Instruction
+ * @typedef {import('xast').Nodes} Nodes
  * @typedef {import('xast').Root} Root
+ * @typedef {import('xast').RootContent} RootContent
  * @typedef {import('xast').Text} Text
  */
 
@@ -23,10 +25,6 @@
  *   Nodes that occur in XML documents (`parse-xml`).
  * @typedef {XmlContent | XmlDocument} XmlNode
  *   Nodes that occur (`parse-xml`).
- * @typedef {Cdata | Comment | Doctype | Element | Instruction | Text} Content
- *   Nodes that occur in documents (`xast`).
- * @typedef {Content | Root} Node
- *   Nodes that occur (`xast`).
  *
  * @typedef State
  *   Info passed around.
@@ -47,7 +45,6 @@ import {VFileMessage} from 'vfile-message'
  *   xast root.
  */
 export function fromXml(value) {
-  // @ts-expect-error: to do: update.
   const loc = location(value)
   /** @type {XmlDocument} */
   let xmlDocument
@@ -68,7 +65,6 @@ export function fromXml(value) {
   } catch (error_) {
     const error = /** @type {XmlError} */ (error_)
     const point = loc.toPoint(error.pos)
-    // @ts-expect-error: to do: update.
     throw new VFileMessage(error.message, point, 'xast-util-from-xml:error')
   }
 
@@ -82,7 +78,7 @@ export function fromXml(value) {
  * Transform CDATA.
  *
  * @param {XmlCdata} node
- * @returns {Content}
+ * @returns {Cdata}
  */
 function transformCdata(node) {
   return {type: 'cdata', value: node.text}
@@ -93,7 +89,7 @@ function transformCdata(node) {
  *
  * @param {XmlComment} node
  *   XML node (`parse-xml`).
- * @returns {Content}
+ * @returns {Comment}
  *   xast node.
  */
 function transformComment(node) {
@@ -120,17 +116,15 @@ function transformDocument(node, state) {
  *
  * @param {XmlDocumentType} node
  *   XML node (`parse-xml`).
- * @returns {Content}
+ * @returns {Doctype}
  *   xast node.
  */
 function transformDoctype(node) {
   return {
     type: 'doctype',
     name: node.name,
-    // @ts-expect-error: `@types/xast` should allow `null`.
-    public: node.publicId,
-    // @ts-expect-error: `@types/xast` should allow `null`.
-    system: node.systemId
+    public: node.publicId || undefined,
+    system: node.systemId || undefined
   }
 }
 
@@ -141,7 +135,7 @@ function transformDoctype(node) {
  *   XML node (`parse-xml`).
  * @param {State} state
  *   Info passed around.
- * @returns {Content}
+ * @returns {Element}
  *   xast node.
  */
 function transformElement(node, state) {
@@ -160,7 +154,7 @@ function transformElement(node, state) {
  *
  * @param {XmlProcessingInstruction} node
  *   XML node (`parse-xml`).
- * @returns {Content}
+ * @returns {Instruction}
  *   xast node.
  */
 function transformInstruction(node) {
@@ -172,7 +166,7 @@ function transformInstruction(node) {
  *
  * @param {XmlText} node
  *   XML node (`parse-xml`).
- * @returns {Content}
+ * @returns {Text}
  *   xast node.
  */
 function transformText(node) {
@@ -184,7 +178,7 @@ function transformText(node) {
  *
  * @param {XmlDeclaration} node
  *   XML node (`parse-xml`).
- * @returns {Content}
+ * @returns {Instruction}
  *   xast node.
  */
 function transformXmlDeclaration(node) {
@@ -222,17 +216,17 @@ function transformXmlDeclaration(node) {
  *   Nodes to transform (`parse-xml`).
  * @param {State} state
  *   Info passed around.
- * @returns {Array<Content>}
+ * @returns {Array<RootContent>}
  *   xast nodes.
  */
 function transformChildren(children, state) {
-  /** @type {Array<Content>} */
+  /** @type {Array<RootContent>} */
   const results = []
   let index = -1
 
   while (++index < children.length) {
     const from = children[index]
-    /** @type {Content | undefined} */
+    /** @type {RootContent | undefined} */
     let to
 
     if (from.type === 'cdata') {
@@ -273,7 +267,7 @@ function transformChildren(children, state) {
  *
  * @param {XmlNode} from
  *   XML node (`parse-xml`).
- * @param {Node} to
+ * @param {Nodes} to
  *   xast node.
  * @param {State} state
  *   Info passed around.
@@ -292,7 +286,6 @@ function patch(from, to, state) {
     from.end === -1 ? undefined : state.location.toPoint(from.end)
 
   if (start && end) {
-    // @ts-expect-error: to do: update.
     to.position = {start, end}
   }
 }

package.json

@@ -39,9 +39,9 @@
   ],
   "dependencies": {
     "@rgrove/parse-xml": "^4.1.0",
-    "@types/xast": "^1.0.0",
-    "vfile-location": "^4.0.0",
-    "vfile-message": "^3.0.0"
+    "@types/xast": "^2.0.0",
+    "vfile-location": "^5.0.0",
+    "vfile-message": "^4.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",

test/fixtures/doctype-name-only/index.json

@@ -4,8 +4,6 @@
     {
       "type": "doctype",
       "name": "HTML",
-      "public": null,
-      "system": null,
       "position": {
         "start": {
           "line": 1,

test/fixtures/doctype-name-trailing-whitespace/index.json

@@ -4,8 +4,6 @@
     {
       "type": "doctype",
       "name": "HTML",
-      "public": null,
-      "system": null,
       "position": {
         "start": {
           "line": 1,

test/fixtures/doctype-system-apostrophe/index.json

@@ -4,7 +4,6 @@
     {
       "type": "doctype",
       "name": "HTML",
-      "public": null,
       "system": "http://www.w3.org/TR/REC-html40/loose.dtd",
       "position": {
         "start": {

test/fixtures/doctype-system/index.json

@@ -4,7 +4,6 @@
     {
       "type": "doctype",
       "name": "HTML",
-      "public": null,
       "system": "http://www.w3.org/TR/REC-html40/loose.dtd",
       "position": {
         "start": {

test/fixtures/html-in-svg-in-html/index.json

@@ -4,8 +4,6 @@
     {
       "type": "doctype",
       "name": "HTML",
-      "public": null,
-      "system": null,
       "position": {
         "start": {
           "line": 1,

test/index.js

@@ -86,7 +86,9 @@ test('fixtures', async () => {
     const inputUrl = new URL(folder + '/index.xml', base)
     const treeUrl = new URL(folder + '/index.json', base)
     const input = await fs.readFile(inputUrl)
-    const actual = fromXml(input)
+    /** @type {Root} */
+    // Remove `undefined`s.
+    const actual = JSON.parse(JSON.stringify(fromXml(input)))
     /** @type {Root} */
     let expected