Fix TypeScript generating broken types

Author: wooorm

.gitignore

@@ -7,5 +7,7 @@ coverage/
 node_modules/
 test/jsx-*.js
 yarn.lock
+!/lib/automatic-runtime-html.d.ts
+!/lib/automatic-runtime-svg.d.ts
 !/lib/jsx-automatic.d.ts
 !/lib/jsx-classic.d.ts

index.js

@@ -1,7 +1,7 @@
 /**
- * @typedef {import('./lib/index.js').Child} Child
- * @typedef {import('./lib/index.js').Properties} Properties
- * @typedef {import('./lib/index.js').Result} Result
+ * @typedef {import('./lib/create-h.js').Child} Child
+ * @typedef {import('./lib/create-h.js').Properties} Properties
+ * @typedef {import('./lib/create-h.js').Result} Result
  */
 
 export {h, s} from './lib/index.js'

lib/automatic-runtime-html.d.ts

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
+import type {Element, Root} from 'hast'
+import type {Child} from './create-h.js'
+import type {JSXProps} from './create-automatic-runtime.js'
+
+export * from './jsx-automatic.js'
+
+export const Fragment: null
+
+export const jsxDEV: {
+  (
+    type: null,
+    properties: {children?: Child},
+    key?: string | null | undefined
+  ): Root
+  (type: string, properties: JSXProps, key?: string | null | undefined): Element
+}
+
+export const jsxs: {
+  (
+    type: null,
+    properties: {children?: Child},
+    key?: string | null | undefined
+  ): Root
+  (type: string, properties: JSXProps, key?: string | null | undefined): Element
+}
+
+export const jsx: {
+  (
+    type: null,
+    properties: {children?: Child},
+    key?: string | null | undefined
+  ): Root
+  (type: string, properties: JSXProps, key?: string | null | undefined): Element
+}

lib/automatic-runtime-html.js

@@ -1,3 +1,5 @@
+// Note: types exposed from `automatic-runtime-html.d.ts` because TS has bugs
+// when generating types.
 import {createAutomaticRuntime} from './create-automatic-runtime.js'
 import {h} from './index.js'
 

lib/automatic-runtime-svg.d.ts

@@ -0,0 +1,36 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+
+import type {Element, Root} from 'hast'
+import type {Child} from './create-h.js'
+import type {JSXProps} from './create-automatic-runtime.js'
+
+export * from './jsx-automatic.js'
+
+export const Fragment: null
+
+export const jsxDEV: {
+  (
+    type: null,
+    properties: {children?: Child},
+    key?: string | null | undefined
+  ): Root
+  (type: string, properties: JSXProps, key?: string | null | undefined): Element
+}
+
+export const jsxs: {
+  (
+    type: null,
+    properties: {children?: Child},
+    key?: string | null | undefined
+  ): Root
+  (type: string, properties: JSXProps, key?: string | null | undefined): Element
+}
+
+export const jsx: {
+  (
+    type: null,
+    properties: {children?: Child},
+    key?: string | null | undefined
+  ): Root
+  (type: string, properties: JSXProps, key?: string | null | undefined): Element
+}

lib/create-automatic-runtime.js

@@ -1,14 +1,9 @@
 /**
- * @typedef {import('hast').Element} Element
- * @typedef {import('hast').Root} Root
- *
- * @typedef {import('./create-h.js').Child} Child
- * @typedef {import('./create-h.js').Properties} Properties
- * @typedef {import('./create-h.js').PropertyValue} PropertyValue
- * @typedef {import('./create-h.js').Result} Result
- * @typedef {import('./create-h.js').Style} Style
- * @typedef {import('./create-h.js').createH} CreateH
- *
+ * @import {Element, Root} from 'hast'
+ * @import {Child, Properties, PropertyValue, Result, Style, createH as CreateH} from './create-h.js'
+ */
+
+/**
  * @typedef {Record<string, Child | PropertyValue | Style>} JSXProps
  */
 

lib/create-h.js

@@ -1,11 +1,6 @@
 /**
- * @typedef {import('hast').Element} Element
- * @typedef {import('hast').Nodes} Nodes
- * @typedef {import('hast').RootContent} RootContent
- * @typedef {import('hast').Root} Root
- *
- * @typedef {import('property-information').Info} Info
- * @typedef {import('property-information').Schema} Schema
+ * @import {Element, Nodes, RootContent, Root} from 'hast'
+ * @import {Info, Schema} from 'property-information'
  */
 
 /**

lib/index.js

@@ -1,18 +1,3 @@
-/**
- * @typedef {import('./create-h.js').Child} Child
- *   Acceptable child value.
- */
-
-/**
- * @typedef {import('./create-h.js').Properties} Properties
- *   Acceptable value for element properties.
- */
-
-/**
- * @typedef {import('./create-h.js').Result} Result
- *   Result from a `h` (or `s`) call.
- */
-
 // Register the JSX namespace on `h`.
 /**
  * @typedef {import('./jsx-classic.js').Element} h.JSX.Element

package.json

@@ -26,7 +26,7 @@
     "svg-tag-names": "^3.0.0",
     "tsd": "^0.31.0",
     "type-coverage": "^2.0.0",
-    "typescript": "~5.4.0",
+    "typescript": "^5.0.0",
     "xo": "^0.60.0"
   },
   "exports": {

tsconfig.json

@@ -16,6 +16,8 @@
   "include": [
     "**/**.js",
     "**/**.jsx",
+    "lib/automatic-runtime-html.d.ts",
+    "lib/automatic-runtime-svg.d.ts",
     "lib/jsx-automatic.d.ts",
     "lib/jsx-classic.d.ts"
   ]