Fix types of classic, automatic runtime

Co-authored-by: Remco Haszing <[email protected]>

Author: wooorm

.gitignore

@@ -1,7 +1,9 @@
 .DS_Store
-*.d.ts
 *.log
 coverage/
 node_modules/
 test/jsx-*.js
 yarn.lock
+**/*.d.ts
+!lib/jsx-classic.d.ts
+!lib/jsx-automatic.d.ts

html.js

@@ -0,0 +1,6 @@
+/**
+ * @typedef {import('./lib/index.js').Child} Child Acceptable child value
+ * @typedef {import('./lib/index.js').Properties} Properties Acceptable properties value.
+ */
+
+export {h} from './lib/html.js'

html/jsx-runtime.js

@@ -0,0 +1,5 @@
+/**
+ * @typedef {import('../lib/runtime.js').JSXProps}} JSXProps
+ */
+
+export * from '../lib/runtime-html.js'

index.js

@@ -1 +1,6 @@
+/**
+ * @typedef {import('./lib/index.js').Child} Child Acceptable child value
+ * @typedef {import('./lib/index.js').Properties} Properties Acceptable properties value.
+ */
+
 export {h, s} from './lib/index.js'

jsx-runtime.js

@@ -0,0 +1,5 @@
+/**
+ * @typedef {import('./lib/runtime.js').JSXProps}} JSXProps
+ */
+
+export * from './lib/runtime-html.js'

lib/core.js

@@ -1,14 +1,13 @@
 /**
- * @typedef {import('hast').Root} HastRoot
- * @typedef {import('hast').Element} HastElement
+ * @typedef {import('hast').Root} Root
+ * @typedef {import('hast').Element} Element
  * @typedef {import('hast').Properties} Properties
- * @typedef {HastRoot['children'][number]} HastChild
- * @typedef {import('property-information').html['property'][string]} Info
- * @typedef {typeof import('property-information').html} Schema
- */
-
-/**
- * @typedef {HastRoot|HastElement} HResult
+ * @typedef {Root['children'][number]} Child
+ * @typedef {Child|Root} Node
+ * @typedef {import('property-information').Info} Info
+ * @typedef {import('property-information').Schema} Schema
+ *
+ * @typedef {Root|Element} HResult
  * @typedef {string|number} HStyleValue
  * @typedef {Object.<string, HStyleValue>} HStyle
  * @typedef {string|number|boolean|null|undefined} HPrimitiveValue
@@ -17,9 +16,8 @@
  * @typedef {{[property: string]: HPropertyValue|HStyle}} HProperties
  *
  * @typedef {string|number|null|undefined} HPrimitiveChild
- * @typedef {HastChild|HastRoot} HNodeChild
- * @typedef {Array.<HPrimitiveChild|HNodeChild>} HArrayChild
- * @typedef {HPrimitiveChild|HNodeChild|HArrayChild} HChild
+ * @typedef {Array.<Node|HPrimitiveChild>} HArrayChild
+ * @typedef {Node|HPrimitiveChild|HArrayChild} HChild
  */
 
 import {find, normalize} from 'property-information'
@@ -42,10 +40,10 @@ export function core(schema, defaultTagName, caseSensitive) {
   const h =
     /**
      * @type {{
-     *   (): HastRoot
-     *   (selector: null|undefined, ...children: HChild[]): HastRoot
-     *   (selector: string, properties: HProperties, ...children: HChild[]): HastElement
-     *   (selector: string, ...children: HChild[]): HastElement
+     *   (): Root
+     *   (selector: null|undefined, ...children: HChild[]): Root
+     *   (selector: string, properties: HProperties, ...children: HChild[]): Element
+     *   (selector: string, ...children: HChild[]): Element
      * }}
      */
     (
@@ -59,7 +57,7 @@ export function core(schema, defaultTagName, caseSensitive) {
        */
       function (selector, properties, ...children) {
         var index = -1
-        /** @type {HResult|HastElement} */
+        /** @type {HResult} */
         var node
         /** @type {string} */
         var key
@@ -202,7 +200,7 @@ function addProperty(schema, properties, key, value) {
 }
 
 /**
- * @param {Array.<HastChild>} nodes
+ * @param {Array.<Child>} nodes
  * @param {HChild} value
  * @returns {void}
  */

lib/html.js

@@ -1,3 +1,13 @@
+/**
+ * @typedef {import('./core.js').HChild} Child Acceptable child value
+ * @typedef {import('./core.js').HProperties} Properties Acceptable properties value.
+ *
+ * @typedef {import('./jsx-classic').Element} h.JSX.Element
+ * @typedef {import('./jsx-classic').IntrinsicAttributes} h.JSX.IntrinsicAttributes
+ * @typedef {import('./jsx-classic').IntrinsicElements} h.JSX.IntrinsicElements
+ * @typedef {import('./jsx-classic').ElementChildrenAttribute} h.JSX.ElementChildrenAttribute
+ */
+
 import {html} from 'property-information'
 import {core} from './core.js'
 

lib/index.js

@@ -1,2 +1,7 @@
+/**
+ * @typedef {import('./core.js').HChild} Child Acceptable child value
+ * @typedef {import('./core.js').HProperties} Properties Acceptable properties value.
+ */
+
 export {h} from './html.js'
 export {s} from './svg.js'

lib/jsx-automatic.d.ts

@@ -0,0 +1,42 @@
+import {HProperties, HChild, HResult} from './core.js'
+
+export namespace JSX {
+  /**
+   * This defines the return value of JSX syntax.
+   */
+  type Element = HResult
+
+  /**
+   * This disallows the use of functional components.
+   */
+  type IntrinsicAttributes = never
+
+  /**
+   * This defines the prop types for known elements.
+   *
+   * For `hastscript` this defines any string may be used in combination with `hast` `Properties`.
+   *
+   * This **must** be an interface.
+   */
+  // eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
+  interface IntrinsicElements {
+    [name: string]:
+      | HProperties
+      | {
+          /**
+           * The prop that matches `ElementChildrenAttribute` key defines the type of JSX children, defines the children type.
+           */
+          children?: HChild
+        }
+  }
+
+  /**
+   * The key of this interface defines as what prop children are passed.
+   */
+  interface ElementChildrenAttribute {
+    /**
+     * Only the key matters, not the value.
+     */
+    children?: never
+  }
+}

lib/jsx-automatic.js

@@ -0,0 +1,2 @@
+// Empty (only used for TypeScript).
+export {}