Add types

Closes GH-28.
Closes GH-32.

Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>
Reviewed-by: Jonathan Haines <jonno.haines@gmail.com>
Reviewed-by: Junyoung Choi <fluke8259@gmail.com>
Reviewed-by: Titus Wormer <tituswormer@gmail.com>

Author: TaylorBeeston

package.json

@@ -28,18 +28,21 @@
     "Junyoung Choi <fluke8259@gmail.com>",
     "Jonathan Soeder <jonathan.soeder@gmail.com>"
   ],
+  "types": "types/index.d.ts",
   "files": [
+    "types/index.d.ts",
     "index.js"
   ],
   "dependencies": {
-    "hast-util-sanitize": "^2.0.0",
+    "hast-util-sanitize": "^3.0.0",
     "hast-util-to-html": "^7.0.0",
-    "mdast-util-to-hast": "^8.2.0",
+    "mdast-util-to-hast": "^9.0.0",
     "xtend": "^4.0.1"
   },
   "devDependencies": {
     "browserify": "^16.0.0",
     "commonmark.json": "^0.29.0",
+    "dtslint": "^3.0.0",
     "is-hidden": "^1.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
@@ -51,6 +54,7 @@
     "tape": "^5.0.0",
     "tinyify": "^2.0.0",
     "to-vfile": "^6.0.0",
+    "unified": "^9.0.0",
     "xo": "^0.32.0"
   },
   "scripts": {
@@ -60,7 +64,8 @@
     "build": "npm run build-bundle && npm run build-mangle",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test/index.js",
-    "test": "npm run format && npm run build && npm run test-coverage"
+    "test-types": "dtslint types",
+    "test": "npm run format && npm run build && npm run test-coverage && npm run test-types"
   },
   "nyc": {
     "check-coverage": true,

types/index.d.ts

@@ -0,0 +1,21 @@
+// TypeScript Version: 3.5
+
+import {Plugin} from 'unified'
+import {HastUtilToHtmlOptions} from 'hast-util-to-html'
+import {Schema} from 'hast-util-sanitize'
+import {Handlers} from 'mdast-util-to-hast'
+
+interface htmlOptions extends HastUtilToHtmlOptions {
+  /**
+   * How to sanitize the output
+   */
+  sanitize?: boolean | Schema
+
+  /**
+   * Object mapping mdast nodes to functions handling them
+   */
+  handlers?: Handlers
+}
+
+declare const html: Plugin<[htmlOptions?]>
+export = html

types/remark-html-tests.ts

@@ -0,0 +1,9 @@
+import unified = require('unified')
+import html = require('remark-html')
+
+unified().use(html)
+unified().use(html, {preferUnquoted: true})
+unified().use(html, {sanitize: false})
+unified().use(html, {sanitize: false})
+unified().use(html, {sanitize: {allowComments: false}})
+unified().use(html, {handlers: {hr: (h, node) => h(node, 'hr')}})

types/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "lib": ["es2015"],
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "remark-html": ["index.d.ts"]
+    }
+  }
+}

types/tslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": "dtslint/dtslint.json",
+  "rules": {
+    "semicolon": false,
+    "whitespace": false
+  }
+}