Add types

Closes GH-6.

Reviewed-by: Christian Murphy <christian.murphy.42@gmail.com>
Reviewed-by: Titus Wormer <tituswormer@gmail.com>

package.json

@@ -23,15 +23,18 @@
   "contributors": [
     "Titus Wormer <tituswormer@gmail.com> (https://wooorm.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"
   },
   "devDependencies": {
     "browserify": "^16.0.0",
     "deepmerge": "^4.0.0",
+    "dtslint": "^3.0.0",
     "nyc": "^15.0.0",
     "prettier": "^2.0.0",
     "rehype": "^11.0.0",
@@ -48,7 +51,8 @@
     "build": "npm run build-bundle && npm run build-mangle",
     "test-api": "node test",
     "test-coverage": "nyc --reporter lcov tape test.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,
@@ -68,7 +72,8 @@
     "prettier": true,
     "esnext": false,
     "rules": {
-      "unicorn/string-content": "off"
+      "unicorn/string-content": "off",
+      "import/no-extraneous-dependencies": "off"
     },
     "ignores": [
       "rehype-sanitize.js"

types/index.d.ts

@@ -0,0 +1,8 @@
+// TypeScript Version: 3.4
+
+import {Plugin} from 'unified'
+import {Schema} from 'hast-util-sanitize'
+
+declare const rehypeSanitize: Plugin<[Schema?]>
+
+export = rehypeSanitize

types/rehype-sanitize-tests.ts

@@ -0,0 +1,13 @@
+import unified = require('unified')
+import sanitize = require('rehype-sanitize')
+
+unified().use(sanitize)
+unified().use(sanitize, {})
+unified().use(sanitize, {
+  attributes: {
+    video: ['src']
+  }
+})
+unified().use(sanitize, {
+  tagNames: ['video']
+})

types/tsconfig.json

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

types/tslint.json

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