Add esm to mdast node type registry

When using this utility, the esm type will automatically be added
to mdast in the correct places.
See DefinitelyTyped/DefinitelyTyped#54421 for more information.

Author: wooorm

.gitignore

@@ -1,6 +1,7 @@
 coverage/
 node_modules/
 *.log
-*.d.ts
+index.d.ts
+test.d.ts
 .DS_Store
 yarn.lock

complex-types.d.ts

@@ -0,0 +1,13 @@
+import {Literal} from 'mdast'
+import {Program} from 'estree-jsx'
+
+export interface MDXJSEsm extends Literal {
+  type: 'mdxjsEsm'
+  data?: {estree?: Program} & Literal['data']
+}
+
+declare module 'mdast' {
+  interface BlockContentMap {
+    mdxjsEsm: MDXJSEsm
+  }
+}

index.js

@@ -1,12 +1,10 @@
 /**
- * @typedef {import('mdast').Literal} Literal
  * @typedef {import('mdast-util-from-markdown').Extension} FromMarkdownExtension
  * @typedef {import('mdast-util-from-markdown').Handle} FromMarkdownHandle
  * @typedef {import('mdast-util-to-markdown').Options} ToMarkdownExtension
  * @typedef {import('mdast-util-to-markdown').Handle} ToMarkdownHandle
- * @typedef {import('estree-jsx').Program} Estree
- *
- * @typedef {Literal & {type: 'mdxjsEsm', data: {estree?: Estree}}} MDXJSEsm
+ * @typedef {import('estree-jsx').Program} Program
+ * @typedef {import('./complex-types').MDXJSEsm} MDXJSEsm
  */
 
 /** @type {FromMarkdownExtension} */
@@ -20,16 +18,15 @@ export const mdxjsEsmToMarkdown = {handlers: {mdxjsEsm: handleMdxjsEsm}}
 
 /** @type {FromMarkdownHandle} */
 function enterMdxjsEsm(token) {
-  // @ts-expect-error: custom.
   this.enter({type: 'mdxjsEsm', value: ''}, token)
   this.buffer() // Capture EOLs
 }
 
 /** @type {FromMarkdownHandle} */
 function exitMdxjsEsm(token) {
   const value = this.resume()
-  const node = this.exit(token)
-  /** @type {Estree?} */
+  const node = /** @type {MDXJSEsm} */ (this.exit(token))
+  /** @type {Program|undefined} */
   // @ts-expect-error: custom.
   const estree = token.estree
 

package.json

@@ -33,6 +33,7 @@
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
+    "complex-types.d.ts",
     "index.d.ts",
     "index.js"
   ],
@@ -58,7 +59,7 @@
     "xo": "^0.39.0"
   },
   "scripts": {
-    "build": "rimraf \"*.d.ts\" && tsc && type-coverage",
+    "build": "rimraf \"{index,test}.d.ts\" && tsc && type-coverage",
     "format": "remark . -qfo && prettier . -w --loglevel warn && xo --fix",
     "test-api": "node --conditions development test.js",
     "test-coverage": "c8 --check-coverage --branches 100 --functions 100 --lines 100 --statements 100 --reporter lcov node --conditions development test.js",

test.js

@@ -215,6 +215,7 @@ test('mdast -> markdown', (t) => {
       {
         type: 'root',
         children: [
+          // @ts-expect-error: `value` missing.
           {type: 'mdxjsEsm'},
           {type: 'paragraph', children: [{type: 'text', value: 'd'}]}
         ]