feat(types): add lib/dom-to-react declaration

Author: AndrewLeedham

package.json

@@ -67,7 +67,8 @@
   "files": [
     "dist",
     "lib",
-    "types/index.d.ts"
+    "types/index.d.ts",
+    "types/lib"
   ],
   "license": "MIT"
 }

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

@@ -0,0 +1,11 @@
+import * as React from 'react';
+import { DomNode, HTMLReactParserOptions } from 'html-react-parser';
+
+/**
+ * Converts DOM nodes to React elements.
+ * @returns ReactElement or and array of ReactElements.
+ */
+export default function domToReact(
+  nodes: DomNode[],
+  options?: HTMLReactParserOptions
+): React.ReactElement | React.ReactElement[];

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

@@ -0,0 +1,42 @@
+import { HTMLReactParserOptions } from 'html-react-parser';
+import domToReact from 'html-react-parser/lib/dom-to-react';
+import * as React from 'react';
+import htmlToDOM from 'html-dom-parser';
+
+/* $ExpectType ReactElement<any, string | ((props: any) => ReactElement<any, string | any | (new (props: any) => Component<any, any, any>)> | null) |
+(new (props: any) => Component<any, any, any>)> |
+ReactElement<any, string | ((props: any) => ReactElement<any, string | any | (new (props: any) => Component<any, any, any>)> | null) |
+(new (props: any) => Component<any, any, any>)>[] */
+domToReact(htmlToDOM('<div>text</div>'));
+
+// `options.replace`
+
+// Return React.createElement from `replace`
+domToReact(htmlToDOM('<p id="replace">text</p>'), {
+  replace: domNode => {
+    if (domNode.attribs && domNode.attribs.id === 'replace') {
+      return React.createElement('span', {}, 'replaced');
+    }
+  }
+});
+
+// Return ReactElement
+const options: HTMLReactParserOptions = {
+  replace({ attribs }) {
+    return attribs && attribs.id === 'remove' && <React.Fragment />;
+  }
+};
+
+domToReact(htmlToDOM('<p><br id="remove"></p>'), options);
+
+// Return domhandler node
+domToReact(htmlToDOM('<a id="header" href="#">Heading</a>'), {
+  replace: node => {
+    if (node.attribs && node.attribs.id === 'header') {
+      return {
+        type: 'h1',
+        props: { children: 'Heading' }
+      };
+    }
+  }
+});

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

@@ -9,7 +9,7 @@
     "noEmit": true,
     "jsx": "react",
     "baseUrl": ".",
-    "paths": { "html-react-parser": ["."] },
+    "paths": { "html-react-parser": ["."], "html-react-parser/*": ["./*"] },
     "moduleResolution": "node"
   }
 }