Update @types/mdast

Author: wooorm

lib/contents.js

@@ -2,7 +2,6 @@
  * @typedef {import('mdast').List} List
  * @typedef {import('mdast').ListItem} ListItem
  * @typedef {import('mdast').PhrasingContent} PhrasingContent
- * @typedef {import('mdast').StaticPhrasingContent} StaticPhrasingContent
  * @typedef {import('./search.js').SearchEntry} SearchEntry
  */
 
@@ -133,10 +132,10 @@ function insert(entry, parent, settings) {
 
 /**
  * @param {Array<PhrasingContent>} [nodes]
- * @returns {Array<StaticPhrasingContent>}
+ * @returns {Array<PhrasingContent>}
  */
 function all(nodes) {
-  /** @type {Array<StaticPhrasingContent>} */
+  /** @type {Array<PhrasingContent>} */
   let result = []
   let index = -1
 
@@ -151,18 +150,14 @@ function all(nodes) {
 
 /**
  * @param {PhrasingContent} node
- * @returns {StaticPhrasingContent | Array<StaticPhrasingContent>}
+ * @returns {PhrasingContent | Array<PhrasingContent>}
  */
 function one(node) {
   if (node.type === 'footnoteReference') {
     return []
   }
 
-  if (
-    node.type === 'link' ||
-    node.type === 'linkReference' ||
-    node.type === 'footnote'
-  ) {
+  if (node.type === 'link' || node.type === 'linkReference') {
     return all(node.children)
   }
 

lib/index.js

@@ -1,13 +1,11 @@
 /**
- * @typedef {import('mdast').Root} Root
- * @typedef {import('mdast').Content} Content
+ * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('mdast').List} List
  * @typedef {import('./search.js').SearchOptions} SearchOptions
  * @typedef {import('./contents.js').ContentsOptions} ContentsOptions
  */
 
 /**
- * @typedef {Root | Content} Node
  * @typedef {SearchOptions & ContentsOptions & ExtraOptions} Options
  *
  * @typedef ExtraOptions
@@ -48,7 +46,7 @@ import {toExpression} from './to-expression.js'
  * Only top-level headings (those not in blockquotes or lists), are used.
  * This default behavior can be changed by passing `options.parents`.
  *
- * @param {Node} tree
+ * @param {Nodes} tree
  *   Tree to search and generate from.
  * @param {Options | null | undefined} [options]
  *   Configuration.

lib/search.js

@@ -1,13 +1,11 @@
 /**
- * @typedef {import('mdast').Root} Root
- * @typedef {import('mdast').Content} Content
+ * @typedef {import('mdast').Nodes} Nodes
  * @typedef {import('mdast').Heading} Heading
  * @typedef {import('mdast').PhrasingContent} PhrasingContent
  * @typedef {import('unist-util-is').Test} Test
  */
 
 /**
- * @typedef {Root | Content} Node
  * @typedef {Heading['depth']} Rank
  *
  */
@@ -62,7 +60,7 @@ const slugs = new Slugger()
 /**
  * Search a node for a toc.
  *
- * @param {Node} root
+ * @param {Nodes} root
  * @param {RegExp | undefined} expression
  * @param {SearchOptions} settings
  * @returns {SearchResult}
@@ -95,15 +93,20 @@ export function search(root, expression, settings) {
     }
 
     // Our opening heading.
-    if (position !== null && expression && !index && expression.test(value)) {
+    if (
+      position !== undefined &&
+      expression &&
+      !index &&
+      expression.test(value)
+    ) {
       index = position + 1
       opening = node
       return
     }
 
     // Our closing heading.
     if (
-      position !== null &&
+      position !== undefined &&
       opening &&
       !endIndex &&
       node.depth <= opening.depth

package.json

@@ -36,12 +36,12 @@
   ],
   "dependencies": {
     "@types/extend": "^3.0.0",
-    "@types/mdast": "^3.0.0",
+    "@types/mdast": "^4.0.0",
     "extend": "^3.0.0",
     "github-slugger": "^2.0.0",
-    "mdast-util-to-string": "^3.1.0",
-    "unist-util-is": "^5.0.0",
-    "unist-util-visit": "^4.0.0"
+    "mdast-util-to-string": "^4.0.0",
+    "unist-util-is": "^6.0.0",
+    "unist-util-visit": "^5.0.0"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",
@@ -86,7 +86,8 @@
       {
         "files": "example.js",
         "rules": {
-          "capitalized-comments": "off"
+          "capitalized-comments": "off",
+          "import/order": "off"
         }
       }
     ]

test/index.js

@@ -28,14 +28,10 @@ test('toc', () => {
     'should expose the public api'
   )
 
-  assert.throws(
-    () => {
-      // @ts-expect-error runtime.
-      toc()
-    },
-    /Cannot read propert/,
-    'should fail without node'
-  )
+  assert.throws(() => {
+    // @ts-expect-error runtime.
+    toc()
+  }, 'should fail without node')
 })
 
 test('Fixtures', async () => {
@@ -60,10 +56,13 @@ test('Fixtures', async () => {
 
     const {useCustomHProperty, ...options} = config
 
-    const tree = fromMarkdown(input, {
-      mdastExtensions: [gfmFromMarkdown()],
-      extensions: [gfm()]
-    })
+    // To do: remove cast when `from-markdown` is released.
+    const tree = /** @type {Root} */ (
+      fromMarkdown(input, {
+        mdastExtensions: [gfmFromMarkdown()],
+        extensions: [gfm()]
+      })
+    )
 
     if (useCustomHProperty) {
       visit(tree, 'heading', (heading) => {