Refactor to move types to index.d.ts

Author: wooorm

.gitignore

@@ -1,8 +1,8 @@
 .DS_Store
-lib/**/*.d.ts
-test/**/*.d.ts
-index.d.ts
+*.d.ts
 *.log
 coverage/
 node_modules/
 yarn.lock
+!/complex-types.d.ts
+!/index.d.ts

complex-types.d.ts

@@ -1,18 +1,4 @@
-import type {Literal} from 'hast'
+// To do: next major: remove this file.
+export type {Raw} from './index.js'
 
-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export interface Raw extends Literal {
-  type: 'raw'
-}
-
-declare module 'hast' {
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-  interface RootContentMap {
-    raw: Raw
-  }
-
-  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-  interface ElementContentMap {
-    raw: Raw
-  }
-}
+/// <reference types="./index.js" />

index.d.ts

@@ -0,0 +1,39 @@
+import type {Literal} from 'hast'
+
+// Expose types.
+export type {Options, Handler, Handlers, H} from './lib/index.js'
+
+// Expose JS API.
+export {one, all} from './lib/traverse.js'
+export {defaultHandlers, toHast} from './lib/index.js'
+
+// Expose node type.
+/**
+ * Raw string of HTML embedded into HTML AST.
+ */
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export interface Raw extends Literal {
+  /**
+   * Node type.
+   */
+  type: 'raw'
+}
+
+// Register nodes in content.
+declare module 'hast' {
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+  interface RootContentMap {
+    /**
+     * Raw string of HTML embedded into HTML AST.
+     */
+    raw: Raw
+  }
+
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+  interface ElementContentMap {
+    /**
+     * Raw string of HTML embedded into HTML AST.
+     */
+    raw: Raw
+  }
+}

index.js

@@ -1,10 +1,3 @@
-/**
- * @typedef {import('./lib/index.js').Options} Options
- * @typedef {import('./lib/index.js').Handler} Handler
- * @typedef {import('./lib/index.js').Handlers} Handlers
- * @typedef {import('./lib/index.js').H} H
- * @typedef {import('./complex-types.js').Raw} Raw
- */
-
+// Note: types exposed from `index.d.ts`.
 export {one, all} from './lib/traverse.js'
 export {defaultHandlers, toHast} from './lib/index.js'

tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "include": ["**/*.js", "complex-types.d.ts"],
+  "include": ["**/*.js", "complex-types.d.ts", "index.d.ts"],
   "exclude": ["coverage/", "node_modules/"],
   "compilerOptions": {
     "checkJs": true,