feat(TypeScript): TS module defintions

Author: Rendez

package.json

@@ -42,59 +42,45 @@
     "standard-version": "^4.2.0",
     "storybook-readme": "^3.1.1",
     "style-loader": "^0.19.0",
+    "typescript": "^2.6.2",
     "validate-commit-msg": "^2.14.0"
   },
-  "files": [
-    "lib"
-  ],
+  "files": ["lib", "types/index.d.ts"],
+  "types": "types/index.d.ts",
   "homepage": "https://github.com/researchgate/react-intersection-observer#readme",
-  "keywords": [
-    "Intersection",
-    "Observer",
-    "react",
-    "component",
-    "viewport",
-    "visible",
-    "invisible",
-    "researchgate"
-  ],
+  "keywords": ["Intersection", "Observer", "react", "component", "viewport", "visible", "invisible", "researchgate"],
   "license": "MIT",
   "lint-staged": {
-    "{src,docs/docs}/**/*.js": [
-      "eslint --fix",
-      "git add"
-    ]
+    "{src,docs/docs}/**/*.js": ["eslint --fix", "git add"]
   },
   "main": "lib/js/index.js",
   "module": "lib/es/index.js",
   "peerDependencies": {
-    "react": "^15.4.0 || ^16.0.0",
-    "react-dom": "^15.4.0 || ^16.0.0"
+    "react": ">=15",
+    "react-dom": ">=15"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/researchgate/react-intersection-observer"
   },
   "jest": {
     "rootDir": "src",
-    "testMatch": [
-      "**/__tests__/**/*.spec.js"
-    ],
-    "setupFiles": [
-      "raf/polyfill"
-    ]
+    "testMatch": ["**/__tests__/**/*.spec.js"],
+    "setupFiles": ["raf/polyfill"]
   },
   "scripts": {
     "build": "yarn build:js && yarn build:es",
-    "build:js": "cross-env BABEL_ENV=production BABEL_OUTPUT=cjs babel src --out-dir lib/js --ignore __tests__ --copy-files",
-    "build:es": "cross-env BABEL_ENV=production BABEL_OUTPUT=esm babel src --out-dir lib/es --ignore __tests__ --copy-files",
+    "build:js":
+      "cross-env BABEL_ENV=production BABEL_OUTPUT=cjs babel src --out-dir lib/js --ignore __tests__ --copy-files",
+    "build:es":
+      "cross-env BABEL_ENV=production BABEL_OUTPUT=esm babel src --out-dir lib/es --ignore __tests__ --copy-files",
     "build:storybook": "build-storybook --output-dir docs",
     "clear": "rimraf ./lib",
     "commitmsg": "validate-commit-msg",
     "coverage": "yarn test -- --coverage",
     "create-github-release": "conventional-github-releaser -p angular",
     "format": "eslint --fix {src,docs/docs}/**/*.js",
-    "lint": "eslint {src,docs/docs}/.",
+    "lint": "eslint {src,docs/docs}/. && tsc --project types",
     "precommit": "yarn lint-staged && yarn test",
     "prepare": "yarn clear && yarn build",
     "prepublishOnly": "yarn test",

types/index.d.ts

@@ -0,0 +1,13 @@
+import * as React from 'react';
+
+export default class IntersectionObserver extends React.Component<Props> {}
+
+interface Props {
+    children: React.ReactElement<any>;
+    root?: string | Element | null;
+    rootMargin?: string;
+    threshold?: number | number[];
+    onlyOnce?: boolean;
+    disabled?: boolean;
+    onChange: (entry: IntersectionObserverEntry) => void;
+}

types/test.tsx

@@ -0,0 +1,13 @@
+import * as React from 'react';
+import Observer from '..';
+
+const noop = () => {};
+const Component = () => <span />;
+
+<Observer threshold={1} disabled={false} root="#foo" rootMargin="10px" onChange={noop}>
+    <span style={{ height: 1, display: 'block' }} />
+</Observer>;
+
+<Observer threshold={[0.5, 1]} onlyOnce root={document.body} onChange={noop}>
+    <Component />
+</Observer>;

types/tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "jsx": "react",
+    "noEmit": true
+  }
+}

yarn.lock

@@ -7198,6 +7198,10 @@ typedarray@^0.0.6:
   version "0.0.6"
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
 
+typescript@^2.6.2:
+  version "2.6.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.6.2.tgz#3c5b6fd7f6de0914269027f03c0946758f7673a4"
+
 ua-parser-js@^0.7.9:
   version "0.7.14"
   resolved "https://registry.yarnpkg.com/ua-parser-js/-/ua-parser-js-0.7.14.tgz#110d53fa4c3f326c121292bbeac904d2e03387ca"