fix: auto generate declaration file (#8)

package.json

@@ -9,7 +9,7 @@
   "author": "Justin Schrader <me@justin.beer>",
   "license": "MIT",
   "private": false,
-  "types": "types/use-react-router-breadcrumbs/index.d.ts",
+  "types": "dist/index.d.ts",
   "peerDependencies": {
     "react": ">=16.8",
     "react-router": ">=5.1.0"
@@ -19,9 +19,7 @@
     "build": "rollup -c",
     "test": "jest",
     "test-build": "sh ./scripts/test-build.sh",
-    "types": "yarn type-src && yarn type-descriptions",
-    "type-src": "tsc -p tsconfig.json",
-    "type-descriptions": "tsc -p types/use-react-router-breadcrumbs",
+    "types": "tsc -p tsconfig.json",
     "lint": "eslint ./src/**"
   },
   "husky": {
@@ -66,6 +64,7 @@
     "react-router": "^5.1.2",
     "rollup": "^2.1.0",
     "rollup-plugin-babel": "^4.4.0",
+    "rollup-plugin-typescript2": "^0.27.0",
     "rollup-plugin-uglify": "^6.0.2",
     "typescript": "^3.8.3"
   },

rollup.config.js

@@ -2,6 +2,8 @@ import babel from 'rollup-plugin-babel';
 import commonjs from '@rollup/plugin-commonjs';
 import resolve from '@rollup/plugin-node-resolve';
 import { uglify } from 'rollup-plugin-uglify';
+import typescript from 'rollup-plugin-typescript2';
+import ts from 'typescript';
 
 const pkg = require('./package.json');
 
@@ -10,6 +12,15 @@ const external = Object.keys(pkg.peerDependencies);
 const extensions = ['.js', '.tsx'];
 
 const plugins = [
+  typescript({
+    useTsconfigDeclarationDir: true,
+    tsconfigOverride: {
+      typescript: ts,
+      compilerOptions: {
+        module: 'es2015',
+      },
+    },
+  }),
   babel({
     exclude: 'node_modules/**',
     extensions,

src/index.tsx

@@ -21,8 +21,34 @@
 import React, { createElement } from 'react';
 import { matchPath, useLocation } from 'react-router';
 
-// eslint-disable-next-line import/extensions, import/no-unresolved, no-unused-vars
-import * as types from '../types/use-react-router-breadcrumbs/index';
+type Location = ReturnType<typeof useLocation>;
+
+export interface Options {
+  currentSection?: string;
+  disableDefaults?: boolean;
+  excludePaths?: string[];
+  pathSection?: string;
+}
+
+export interface MatchOptions {
+  exact?: boolean;
+  strict?: boolean;
+  sensitive?: boolean;
+}
+
+export interface BreadcrumbsRoute {
+  path: string;
+  breadcrumb?: React.ComponentType | React.ElementType | string;
+  matchOptions?: MatchOptions;
+  routes?: BreadcrumbsRoute[];
+}
+
+export interface BreadcrumbData {
+  match: { url: string },
+  location: Location,
+  key: string,
+  breadcrumb: React.ReactNode
+}
 
 const DEFAULT_MATCH_OPTIONS = { exact: true };
 const NO_BREADCRUMB = 'NO_BREADCRUMB';
@@ -49,13 +75,8 @@ const render = ({
 }: {
   breadcrumb: React.ComponentType | string,
   match: { url: string },
-  location: types.Location
-}): {
-  match: { url: string },
-  location: types.Location,
-  key: string,
-  breadcrumb: React.ReactNode
-} => {
+  location: Location
+}): BreadcrumbData => {
   const componentProps = { match, location, key: match.url, ...rest };
 
   return {
@@ -75,7 +96,7 @@ const getDefaultBreadcrumb = ({
   pathSection,
 }: {
   currentSection: string,
-  location: types.Location,
+  location: Location,
   pathSection: string,
 }) => {
   const match = matchPath(pathSection, { ...DEFAULT_MATCH_OPTIONS, path: pathSection })
@@ -104,11 +125,11 @@ const getBreadcrumbMatch = ({
   currentSection: string,
   disableDefaults?: boolean,
   excludePaths?: string[],
-  location: { pathname: string },
+  location: Location,
   pathSection: string,
-  routes: types.BreadcrumbsRoute[]
+  routes: BreadcrumbsRoute[]
 }) => {
-  let breadcrumb;
+  let breadcrumb: BreadcrumbData | typeof NO_BREADCRUMB | undefined;
 
   // Check the optional `excludePaths` option in `options` to see if the
   // current path should not include a breadcrumb.
@@ -189,12 +210,12 @@ export const getBreadcrumbs = (
     location,
     options = {},
   }: {
-    routes: types.BreadcrumbsRoute[],
-    location: types.Location,
-    options?: types.Options
+    routes: BreadcrumbsRoute[],
+    location: Location,
+    options?: Options
   },
-): Array<React.ReactNode | string> => {
-  const matches:Array<React.ReactNode | string> = [];
+): Array<BreadcrumbData> => {
+  const matches: Array<BreadcrumbData> = [];
   const { pathname } = location;
 
   pathname
@@ -238,20 +259,20 @@ export const getBreadcrumbs = (
  * Takes a route array and recursively flattens it IF there are
  * nested routes in the config.
 */
-const flattenRoutes = (routes: types.BreadcrumbsRoute[]) => (routes)
-  .reduce((arr, route: types.BreadcrumbsRoute): types.BreadcrumbsRoute[] => {
+const flattenRoutes = (routes: BreadcrumbsRoute[]) => (routes)
+  .reduce((arr, route: BreadcrumbsRoute): BreadcrumbsRoute[] => {
     if (route.routes) {
       return arr.concat([route, ...flattenRoutes(route.routes)]);
     }
     return arr.concat(route);
-  }, [] as types.BreadcrumbsRoute[]);
+  }, [] as BreadcrumbsRoute[]);
 
 /**
  * Default hook function export.
  */
 const useReactRouterBreadcrumbs = (
-  routes?: types.BreadcrumbsRoute[],
-  options?: types.Options,
+  routes?: BreadcrumbsRoute[],
+  options?: Options,
 ) => getBreadcrumbs({
   routes: flattenRoutes(routes || []),
   location: useLocation(),

tsconfig.json

@@ -4,7 +4,10 @@
     "checkJs": true,
     "esModuleInterop": true,
     "jsx": "react",
-    "lib": ["es2015", "dom"],
+    "lib": [
+      "es2015",
+      "dom"
+    ],
     "module": "commonjs",
     "moduleResolution": "node",
     "noEmit": true,
@@ -17,9 +20,11 @@
     "strictFunctionTypes": true,
     "strictNullChecks": true,
     "strictPropertyInitialization": true,
-    "target": "es5"
+    "target": "es5",
+    "declaration": true,
+    "declarationDir": "./dist"
   },
   "files": [
     "src/index.tsx"
   ]
-}
+}