refactor(types): moved to root

Author: AndrewLeedham

types/index.d.ts renamed to index.d.ts

@@ -1,6 +1,9 @@
 // TypeScript Version: 3.3
 
 import * as React from 'react';
+import { DomElement } from 'domhandler';
+
+export { DomElement };
 
 export as namespace HTMLReactParser;
 
@@ -10,12 +13,12 @@ type ReactElement = React.DetailedReactHTMLElement<{}, HTMLElement>;
 
 export interface HTMLReactParserOptions {
   // TODO: Replace `object` by type for objects like `{ type: 'h1', props: { children: 'Heading' } }`
-  replace(domNode: DomNode): React.ReactElement | object | undefined | false;
+  replace(domNode: DomElement): React.ReactElement | object | undefined | false;
 }
 
 /**
  * Convert HTML string to React elements.
- * 
+ *
  * @param - Raw string of HTML to parse.
  * @param options - Options to use when converting to react.
  * @returns ReactElement on successful parse or string when `html` cannot be
@@ -25,19 +28,3 @@ declare function HTMLReactParser(
   html: string,
   options?: HTMLReactParserOptions
 ): ReactElement | ReactElement[] | string;
-
-/** domhandler node */
-export interface DomNode {
-  type: 'tag' | 'text' | 'directive' | 'comment' | 'script' | 'style';
-  name: string;
-  data?: string;
-  attribs?: {
-    [attributeName: string]: string;
-  };
-  children?: DomNode[];
-  parent?: DomNode;
-  prev?: DomNode;
-  next?: DomNode;
-  startIndex?: number;
-  endIndex?: number;
-}

types/lib/dom-to-react.d.ts renamed to lib/dom-to-react.d.ts

@@ -1,5 +1,8 @@
+// TypeScript Version: 3.3
+
 import * as React from 'react';
-import { DomNode, HTMLReactParserOptions } from 'html-react-parser';
+import { HTMLReactParserOptions } from '..';
+import { DomElement } from 'domhandler';
 
 /**
  * Converts DOM nodes to React elements.
@@ -9,6 +12,6 @@ import { DomNode, HTMLReactParserOptions } from 'html-react-parser';
  * @returns ReactElement or and array of ReactElements.
  */
 export default function domToReact(
-  nodes: DomNode[],
+  nodes: DomElement[],
   options?: HTMLReactParserOptions
 ): React.ReactElement | React.ReactElement[];

package.json

@@ -4,7 +4,6 @@
   "description": "An HTML to React parser.",
   "author": "Mark <mark@remarkablemark.org>",
   "main": "index.js",
-  "types": "types",
   "scripts": {
     "benchmark": "node benchmark",
     "build": "npm run clean && npm run build:min && npm run build:unmin",
@@ -15,7 +14,7 @@
     "coveralls": "cat coverage/lcov.info | coveralls",
     "lint": "eslint --ignore-path .gitignore .",
     "lint:fix": "npm run lint -- --fix",
-    "dtslint": "dtslint types",
+    "dtslint": "dtslint .",
     "prepublishOnly": "npm run build",
     "release": "standard-version --no-verify",
     "test": "mocha"
@@ -35,6 +34,7 @@
     "converter"
   ],
   "dependencies": {
+    "@types/domhandler": "2.4.1",
     "html-dom-parser": "0.2.0",
     "react-dom-core": "0.0.4",
     "style-to-object": "0.2.2"
@@ -67,8 +67,7 @@
   "files": [
     "dist",
     "lib",
-    "types/index.d.ts",
-    "types/lib"
+    "index.d.ts"
   ],
   "license": "MIT"
 }

types/index.test.tsx renamed to test/types/index.test.tsx

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "lib": ["es6"],
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "baseUrl": ".",
+    "types": [],
+    "noEmit": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": { "html-react-parser": ["."], "html-react-parser/lib/*": ["./lib/*"] },
+    "jsx": "react"
+  },
+  "files": [
+    "index.d.ts",
+    "lib/dom-to-react.d.ts",
+    "test/types/index.test.tsx",
+    "test/types/lib/dom-to-react.test.tsx"
+  ]
+}

types/lib/dom-to-react.test.tsx renamed to test/types/lib/dom-to-react.test.tsx

@@ -0,0 +1,3 @@
+{
+  "extends": "dtslint/dtslint.json"
+}