Merge pull request #7 from kopach/typescript

a7ul · web-flow · commit a52bb348ddfb · 2021-05-05T10:37:04.000+02:00
build: introduce TypeScript to the project
diff --git a/.babelrc b/.babelrc
diff --git a/.npmignore b/.npmignore
@@ -1,4 +1,3 @@
 src
-.babelrc
 webpack.config.js
 assets
diff --git a/README.md b/README.md
@@ -159,5 +159,5 @@ But for implementation purposed use it like a regular child component.
 # TODO
 
 - ~Live Demos~
-- Maybe Typescript this?
+- ~Maybe Typescript this?~
 - Test cases
diff --git a/assets/react-webcomponent.png b/assets/react-webcomponent.png
diff --git a/dist/build.js b/dist/build.js
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -0,0 +1,4 @@
+import React from 'react';
+declare type Mode = 'open' | 'element';
+export declare const registerAsWebComponent: (component: React.ElementType, customElementName: string, mode?: Mode) => void;
+export {};
diff --git a/dist/prop-bridge.d.ts b/dist/prop-bridge.d.ts
@@ -0,0 +1,6 @@
+import React from 'react';
+export declare const renderReact2Node: (RComponent: React.ElementType, initialProps: {}, targetDomNode: Element | DocumentFragment, onRender: (ref: React.RefObject<any>) => void) => void;
+export declare const sendPropsToReact: (propBridgeRef: React.RefObject<any>, props: any) => void;
+export declare const getPropsFromNode: (node: HTMLElement) => {
+    [key: string]: string | JSX.Element;
+};
diff --git a/dist/react-dom-child.d.ts b/dist/react-dom-child.d.ts
@@ -0,0 +1,7 @@
+import React from 'react';
+import 'child-replace-with-polyfill';
+export declare class ReactDomChild extends React.Component {
+    ref: React.RefObject<HTMLDivElement>;
+    componentDidMount(): void;
+    render(): JSX.Element;
+}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -2,7 +2,8 @@
   "name": "react-webcomponentify",
   "version": "1.2.2",
   "description": "Build and export React Components as Web Components without any extra effort.",
-  "main": "dist/build.js",
+  "main": "dist/build",
+  "typings": "dist/index",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "webpack -p"
@@ -26,18 +27,18 @@
   },
   "homepage": "https://github.com/master-atul/react-webcomponentify#readme",
   "dependencies": {
-    "child-replace-with-polyfill": "^1.0.1",
-    "react-create-ref": "^1.0.1"
+    "child-replace-with-polyfill": "1.0.1",
+    "react-create-ref": "1.0.1"
   },
   "devDependencies": {
-    "@babel/core": "^7.2.2",
-    "@babel/plugin-proposal-class-properties": "^7.3.0",
-    "@babel/plugin-syntax-class-properties": "^7.2.0",
-    "@babel/plugin-transform-react-jsx": "^7.3.0",
-    "@babel/preset-env": "^7.3.1",
-    "babel-loader": "^8.0.5",
-    "webpack": "^4.29.0",
-    "webpack-cli": "^3.2.1"
+    "@types/react": "17.0.4",
+    "@types/react-dom": "17.0.3",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "ts-loader": "8.2.0",
+    "typescript": "4.2.4",
+    "webpack": "4.29.0",
+    "webpack-cli": "3.2.1"
   },
   "peerDependencies": {
     "react": "*",
diff --git a/src/index.ts b/src/index.ts
@@ -1,15 +1,21 @@
+import React from 'react';
 import {
   renderReact2Node,
   getPropsFromNode,
-  sendPropsToReact
-} from "./prop-bridge";
+  sendPropsToReact,
+} from './prop-bridge';
 
-const getCustomElementFromReactComponent = (RComponent, mode) => {
+type Mode = 'open' | 'element';
+
+const getCustomElementFromReactComponent = (
+  RComponent: React.ElementType,
+  mode?: Mode
+) => {
   return class ReactAsCustomElement extends HTMLElement {
-    targetNode = null;
-    propBridgeRef = null;
+    targetNode: this | ShadowRoot = null;
+    propBridgeRef: any = null;
     props = {};
-    observer = null;
+    observer: MutationObserver = null;
 
     constructor() {
       super();
@@ -28,27 +34,38 @@ const getCustomElementFromReactComponent = (RComponent, mode) => {
           break;
       }
 
-      renderReact2Node(RComponent, this.props, this.targetNode, this._onReactMount);
+      renderReact2Node(
+        RComponent,
+        this.props,
+        this.targetNode,
+        this._onReactMount
+      );
     }
 
-    setProps = newProps => {
+    setProps = (newProps: {}) => {
       this.props = { ...this.props, ...newProps };
       sendPropsToReact(this.propBridgeRef, this.props);
     };
 
-    _onReactMount = propBridgeRef => {
+    _onReactMount = (propBridgeRef: React.RefObject<any>) => {
       this.propBridgeRef = propBridgeRef;
       this.setProps(this.props);
     };
 
-    _onMutation = mutationsList => {
-      const newProps = mutationsList.reduce((props, mutation) => {
-        if (mutation.type === "attributes") {
-          const propKey = mutation.attributeName;
-          props[propKey] = this.getAttribute(propKey);
-        }
-        return props;
-      }, {});
+    _onMutation = (mutationsList: any[]) => {
+      const newProps = mutationsList.reduce(
+        (
+          props: { [x: string]: string },
+          mutation: { type: string; attributeName: string }
+        ) => {
+          if (mutation.type === 'attributes') {
+            const propKey = mutation.attributeName;
+            props[propKey] = this.getAttribute(propKey);
+          }
+          return props;
+        },
+        {}
+      );
       this.setProps(newProps);
     };
     /*
@@ -73,7 +90,11 @@ const getCustomElementFromReactComponent = (RComponent, mode) => {
   - "open" - open shadow DOM
   - "element" - no shadow DOM
 */
-export const registerAsWebComponent = (component, customElementName, mode) => {
+export const registerAsWebComponent = (
+  component: React.ElementType,
+  customElementName: string,
+  mode?: Mode
+) => {
   const ReactCustomElement = getCustomElementFromReactComponent(
     component,
     mode
diff --git a/src/prop-bridge.tsx b/src/prop-bridge.tsx
@@ -1,7 +1,7 @@
-import ReactDOM from "react-dom";
-import React from "react";
-import { ReactDomChild } from "./react-dom-child";
-import createRef from "react-create-ref";
+import ReactDOM from 'react-dom';
+import React from 'react';
+import { ReactDomChild } from './react-dom-child';
+import createRef from 'react-create-ref';
 
 /*
 PropBridge stores props passed to it via setProps in the state.
@@ -11,36 +11,43 @@ and then passing those as props to the react component.
 */
 
 export const renderReact2Node = (
-  RComponent,
-  initialProps,
-  targetDomNode,
-  onRender
+  RComponent: React.ElementType,
+  initialProps: {},
+  targetDomNode: Element | DocumentFragment,
+  onRender: (ref: React.RefObject<any>) => void
 ) => {
   class PropBridge extends React.PureComponent {
     state = { ...initialProps };
-    setProps = props => this.setState(() => props);
+    setProps = (props: React.RefObject<PropBridge>) =>
+      this.setState(() => props);
     render() {
       return <RComponent {...this.props} {...this.state} />;
     }
   }
-  const propBridgeRef = createRef();
+  const propBridgeRef = createRef<PropBridge>();
   ReactDOM.render(<PropBridge ref={propBridgeRef} />, targetDomNode, () =>
     onRender(propBridgeRef)
   );
 };
 
-export const sendPropsToReact = (propBridgeRef, props) => {
+export const sendPropsToReact = (
+  propBridgeRef: React.RefObject<any>,
+  props: any
+) => {
   if (propBridgeRef && propBridgeRef.current) {
     propBridgeRef.current.setProps(props);
   }
 };
 
-export const getPropsFromNode = node => {
+export const getPropsFromNode = (node: HTMLElement) => {
   const attributeNames = node.getAttributeNames();
-  const mappedProps = attributeNames.reduce((props, name) => {
-    props[name] = node.getAttribute(name);
-    return props;
-  }, {});
+  const mappedProps = attributeNames.reduce(
+    (props: { [key: string]: string | JSX.Element }, name: string) => {
+      props[name] = node.getAttribute(name);
+      return props;
+    },
+    {}
+  );
 
   const children = Array.from(node.children).map((e) => e.cloneNode(true));
   mappedProps.children = <ReactDomChild>{children}</ReactDomChild>;
diff --git a/src/react-dom-child.tsx b/src/react-dom-child.tsx
@@ -1,14 +1,15 @@
-import React from "react";
-import "child-replace-with-polyfill";
-import createRef from "react-create-ref";
+import React from 'react';
+import 'child-replace-with-polyfill';
+import createRef from 'react-create-ref';
+
 /*
  Wrapper class to wrap the raw html nodes in a 
  react component before passing it down to react as children
 */
 export class ReactDomChild extends React.Component {
-  ref = createRef();
+  ref = createRef<HTMLDivElement>();
   componentDidMount() {
-    const childNodes = this.props.children;
+    const childNodes: Node[] = this.props.children as Node[];
     this.ref.current.replaceWith(...childNodes);
   }
   render() {
diff --git a/src/types/react-create-ref.d.ts b/src/types/react-create-ref.d.ts
@@ -0,0 +1,9 @@
+declare module 'react-create-ref' {
+  import React from 'react';
+
+  type ReactCreateRef<T> = typeof React.createRef extends Function
+    ? React.RefObject<T>
+    : () => { current: null };
+
+  export default function createRef<T>(): ReactCreateRef<T>;
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "outDir": "./dist/",
+        "declaration": true,
+        "noImplicitAny": true,
+        "module": "es6",
+        "sourceMap": true,
+        "target": "es6",
+        "allowSyntheticDefaultImports": true,
+        "jsx": "react",
+        "typeRoots": [
+            "node_modules/@types",
+            "src/types"
+        ],
+        "lib": [
+            "ES2017",
+            "DOM"
+        ]
+    }
+}
diff --git a/webpack.config.js b/webpack.config.js
@@ -1,39 +1,40 @@
-var path = require("path");
+var path = require('path');
 
 module.exports = {
-  entry: "./src/index.js",
-  mode: "development",
+  entry: './src/index.ts',
+  devtool: 'inline-source-map',
+  mode: 'development',
+  resolve: {
+    extensions: ['.ts', '.js', '.tsx'],
+  },
   output: {
-    path: path.resolve(__dirname, "dist"),
-    filename: "build.js",
-    libraryTarget: "commonjs2"
+    path: path.resolve(__dirname, 'dist'),
+    filename: 'build.js',
+    libraryTarget: 'commonjs2',
   },
-  devtool: "none",
   module: {
     rules: [
       {
-        test: /\.js$/,
-        exclude: /(node_modules|bower_components)/,
-        use: {
-          loader: "babel-loader"
-        }
-      }
-    ]
+        test: /\.tsx?/,
+        use: 'ts-loader',
+        exclude: /node_modules/,
+      },
+    ],
   },
   externals: {
     react: {
-      root: "React",
-      commonjs2: "react",
-      commonjs: "react",
-      amd: "react",
-      umd: "react"
+      root: 'React',
+      commonjs2: 'react',
+      commonjs: 'react',
+      amd: 'react',
+      umd: 'react',
+    },
+    'react-dom': {
+      root: 'ReactDOM',
+      commonjs2: 'react-dom',
+      commonjs: 'react-dom',
+      amd: 'react-dom',
+      umd: 'react-dom',
     },
-    "react-dom": {
-      root: "ReactDOM",
-      commonjs2: "react-dom",
-      commonjs: "react-dom",
-      amd: "react-dom",
-      umd: "react-dom"
-    }
-  }
+  },
 };

-Original file line number
+Diff line change
@@ @@ -1,4 +1,3 @@ @@
 src
 -.babelrc
 webpack.config.js
 assets