Update @types/xast, utilities

Author: wooorm

lib/index.js

@@ -1,12 +1,11 @@
 /**
  * @typedef {import('xast').Literal} Literal
- * @typedef {import('xast').Root} Root
- * @typedef {import('xast').RootChildMap} RootChildMap
+ * @typedef {import('xast').Nodes} Nodes
  */
 
 /**
  * @typedef {Literal & {type: 'raw'}} Raw
- * @typedef {Root | RootChildMap[keyof RootChildMap]} Node
+ *   To do: improved `Raw` type?
  *
  * @typedef {'"' | "'"} Quote
  *   XML quotes for attribute values.
@@ -45,7 +44,7 @@ import {one} from './one.js'
 /**
  * Serialize a xast tree to XML.
  *
- * @param {Node | Array<Node>} tree
+ * @param {Array<Nodes> | Nodes} tree
  *   xast node(s) to serialize.
  * @param {Options | null | undefined} [options]
  *   Configuration.
@@ -67,7 +66,7 @@ export function toXml(tree, options) {
     )
   }
 
-  /** @type {Node} */
+  /** @type {Nodes} */
   // @ts-expect-error Assume no `root` in `node`.
   const node = Array.isArray(tree) ? {type: 'root', children: tree} : tree
 

lib/one.js

@@ -1,16 +1,10 @@
 /**
- * @typedef {import('unist').Parent} UnistParent
- * @typedef {import('xast').Root} Root
- * @typedef {import('xast').RootChildMap} RootChildMap
+ * @typedef {import('xast').Nodes} Nodes
+ * @typedef {import('xast').Parents} Parents
+ * @typedef {import('xast').RootContent} RootContent
  * @typedef {import('./index.js').State} State
  */
 
-/**
- * @typedef {Root | RootChildMap[keyof RootChildMap]} Node
- * @typedef {Extract<Node, UnistParent>} Parent
- * @typedef {Parent['children'][number]} Child
- */
-
 import {element} from './element.js'
 import {text} from './text.js'
 import {comment} from './comment.js'
@@ -35,7 +29,7 @@ const handlers = {
 /**
  * Serialize a node.
  *
- * @param {Node} node
+ * @param {Nodes} node
  *   xast node.
  * @param {State} state
  *   Info passed around about the current state.
@@ -63,15 +57,15 @@ export function one(node, state) {
 /**
  * Serialize all children of `parent`.
  *
- * @param {Parent} parent
+ * @param {Parents} parent
  *   xast parent node.
  * @param {State} state
  *   Info passed around about the current state.
  * @returns {string}
  *   Serialized XML.
  */
 export function all(parent, state) {
-  /** @type {Array<Child>} */
+  /** @type {Array<RootContent>} */
   const children = (parent && parent.children) || []
   let index = -1
   /** @type {Array<string>} */

package.json

@@ -31,7 +31,7 @@
     "index.js"
   ],
   "dependencies": {
-    "@types/xast": "^1.0.0",
+    "@types/xast": "^2.0.0",
     "ccount": "^2.0.0",
     "stringify-entities": "^4.0.0"
   },
@@ -43,8 +43,8 @@
     "remark-preset-wooorm": "^9.0.0",
     "type-coverage": "^2.0.0",
     "typescript": "^5.0.0",
-    "unist-builder": "^3.0.0",
-    "xastscript": "^3.0.0",
+    "unist-builder": "^4.0.0",
+    "xastscript": "^4.0.0",
     "xo": "^0.55.0"
   },
   "scripts": {

test/attribute.js

@@ -6,7 +6,10 @@ import {toXml} from '../index.js'
 
 test('`element` attributes', async (t) => {
   assert.deepEqual(
-    toXml(u('element', {name: 'y'}, [])),
+    toXml(
+      // @ts-expect-error: check how runtime does not fail on missing `attributes`.
+      u('element', {name: 'y'}, [])
+    ),
     '<y></y>',
     'should ignore missing attributes'
   )