10 |
ROUTE 1
11 |
12 |       <button onClick={() => setLocation('/')}>Go to index</button>
13 |     </div>
14 |   );
15 | };
16 | 
17 | export default Route1;
18 | 


--------------------------------------------------------------------------------
/example/src/Components/Unauthorized/index.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | 
 3 | import { useLocation } from 'react-awesome-router';
 4 | 
 5 | const Unauthorized: React.FC = () => {
 6 |   const { location, context, setLocation } = useLocation();
 7 | 
 8 |   return (
 9 |     <div className="route">
10 |       <div className="NotAllowed">UNAUTHORIZED</div>
11 |       <textarea defaultValue={`Location: '${location}'\nContext: ${JSON.stringify(context)}`} />
12 |       <button onClick={() => setLocation('/')}>Go to index</button>
13 |     </div>
14 |   );
15 | };
16 | 
17 | export default Unauthorized;
18 | 


--------------------------------------------------------------------------------
/example/src/Components/Route3/index.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | 
 3 | import {useLocation} from 'react-awesome-router';
 4 | 
 5 | const Route3: React.FC = () => {
 6 |   const {location, params, setLocation} = useLocation();
 7 | 
 8 |   return (
 9 |     <div className="route">
10 |       <div className="Allowed">ROUTE 3</div>
11 |       <textarea
12 |         readOnly
13 |         defaultValue={`Location: '${location}'\nParams: ${JSON.stringify(params)}`}
14 |       />
15 |       <button onClick={() => setLocation('/')}>Go to index</button>
16 |     </div>
17 |   );
18 | };
19 | 
20 | export default Route3;
21 | 


--------------------------------------------------------------------------------
/example/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es5",
 4 |     "lib": [
 5 |       "dom",
 6 |       "dom.iterable",
 7 |       "esnext"
 8 |     ],
 9 |     "allowJs": true,
10 |     "skipLibCheck": true,
11 |     "esModuleInterop": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "strict": true,
14 |     "forceConsistentCasingInFileNames": true,
15 |     "module": "esnext",
16 |     "moduleResolution": "node",
17 |     "resolveJsonModule": true,
18 |     "isolatedModules": true,
19 |     "noEmit": true,
20 |     "jsx": "react"
21 |   },
22 |   "include": [
23 |     "src"
24 |   ]
25 | }
26 | 


--------------------------------------------------------------------------------
/example/public/manifest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "short_name": "React App",
 3 |   "name": "Create React App Sample",
 4 |   "icons": [
 5 |     {
 6 |       "src": "favicon.ico",
 7 |       "sizes": "64x64 32x32 24x24 16x16",
 8 |       "type": "image/x-icon"
 9 |     },
10 |     {
11 |       "src": "logo192.png",
12 |       "type": "image/png",
13 |       "sizes": "192x192"
14 |     },
15 |     {
16 |       "src": "logo512.png",
17 |       "type": "image/png",
18 |       "sizes": "512x512"
19 |     }
20 |   ],
21 |   "start_url": ".",
22 |   "display": "standalone",
23 |   "theme_color": "#000000",
24 |   "background_color": "#ffffff"
25 | }
26 | 


--------------------------------------------------------------------------------
/example/src/index.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import ReactDOM from 'react-dom';
 3 | import './index.css';
 4 | import App from './App';
 5 | import * as serviceWorker from './serviceWorker';
 6 | 
 7 | import {Router} from 'react-awesome-router';
 8 | import {routes} from './routes';
 9 | 
10 | ReactDOM.render(
11 |   <Router routes={routes}>
12 |     <App />
13 |   </Router>,
14 |   document.getElementById('root')
15 | );
16 | 
17 | // If you want your app to work offline and load faster, you can change
18 | // unregister() to register() below. Note this comes with some pitfalls.
19 | // Learn more about service workers: https://bit.ly/CRA-PWA
20 | serviceWorker.unregister();
21 | 


--------------------------------------------------------------------------------
/src/PathUtils/index.ts:
--------------------------------------------------------------------------------
 1 | import {pathToRegexp, Key} from 'path-to-regexp';
 2 | 
 3 | const match = (path: string, route: string): boolean => {
 4 |   return pathToRegexp(path).test(route);
 5 | };
 6 | 
 7 | const parse = (path: string, route: string): Array<Object> => {
 8 |   try {
 9 |     const keys: Array<Key> = [];
10 |     const regex = pathToRegexp(path, keys);
11 |     let params: any = {};
12 | 
13 |     regex
14 |       .exec(route)!
15 |       .slice(1)
16 |       .forEach((match, i) => {
17 |         params[keys[i].name] = match;
18 |       });
19 |     return params;
20 |   } catch (e) {
21 |     return [];
22 |   }
23 | };
24 | 
25 | const Path = {
26 |   match,
27 |   parse
28 | };
29 | 
30 | export default Path;
31 | 


--------------------------------------------------------------------------------
/example/src/Components/Route2/index.tsx:
--------------------------------------------------------------------------------
 1 | import React, {useEffect} from 'react';
 2 | 
 3 | import {useLocation} from 'react-awesome-router';
 4 | 
 5 | const Route2: React.FC = () => {
 6 |   const {location, context, setLocation} = useLocation();
 7 | 
 8 |   useEffect(() => {
 9 |     if (!context?.auth?.logued) {
10 |       alert('Logued out!');
11 |       setLocation('/');
12 |     }
13 |   }, [context, setLocation]);
14 | 
15 |   return (
16 |     <div className="route">
17 |       <div className="Allowed">Private Route</div>
18 |       <textarea
19 |         readOnly
20 |         defaultValue={`Location: '${location}'\nContext: ${JSON.stringify(context)}`}
21 |       />
22 |       <div></div>
23 |       <button onClick={() => setLocation('/')}>Go to index</button>
24 |     </div>
25 |   );
26 | };
27 | 
28 | export default Route2;
29 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "react-awesome-router",
 3 |   "version": "2.0.1",
 4 |   "description": "Lightweight middleware-based react router",
 5 |   "repository": {
 6 |     "type": "git",
 7 |     "url": "https://github.com/hryuk/react-awesome-router"
 8 |   },
 9 |   "files": [
10 |     "dist"
11 |   ],
12 |   "main": "dist/index.js",
13 |   "types": "dist/index.d.ts",
14 |   "scripts": {
15 |     "start": "tsc -w",
16 |     "build": "tsc",
17 |     "test": "echo \"Error: no test specified\" && exit 1"
18 |   },
19 |   "author": "Hryuk <edusvh@gmail.com>",
20 |   "license": "MIT",
21 |   "devDependencies": {
22 |     "@types/history": "^5.0.0",
23 |     "@types/react": "^18.0.9",
24 |     "prettier": "^2.6.2",
25 |     "typescript": "^4.6.4"
26 |   },
27 |   "dependencies": {
28 |     "history": "^5.3.0",
29 |     "path-to-regexp": "^6.2.1",
30 |     "react": "^18.1.0"
31 |   }
32 | }
33 | 


--------------------------------------------------------------------------------
/example/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "example",
 3 |   "version": "0.1.0",
 4 |   "private": true,
 5 |   "dependencies": {
 6 |     "@testing-library/jest-dom": "^5.16.4",
 7 |     "@testing-library/react": "^13.2.0",
 8 |     "@testing-library/user-event": "^14.1.1",
 9 |     "@types/jest": "^27.5.0",
10 |     "@types/react": "^18.0.9",
11 |     "@types/react-dom": "^18.0.3",
12 |     "react": "^18.1.0",
13 |     "react-dom": "^18.1.0",
14 |     "react-scripts": "^5.0.1",
15 |     "typescript": "^4.6.4"
16 |   },
17 |   "scripts": {
18 |     "start": "react-scripts start",
19 |     "build": "react-scripts build",
20 |     "test": "react-scripts test",
21 |     "eject": "react-scripts eject"
22 |   },
23 |   "eslintConfig": {
24 |     "extends": "react-app"
25 |   },
26 |   "browserslist": {
27 |     "production": [
28 |       ">0.2%",
29 |       "not dead",
30 |       "not op_mini all"
31 |     ],
32 |     "development": [
33 |       "last 1 chrome version",
34 |       "last 1 firefox version",
35 |       "last 1 safari version"
36 |     ]
37 |   }
38 | }
39 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2020
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining a copy
 4 | of this software and associated documentation files (the "Software"), to deal
 5 | in the Software without restriction, including without limitation the rights
 6 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 7 | copies of the Software, and to permit persons to whom the Software is
 8 | furnished to do so, subject to the following conditions:
 9 | 
10 | The above copyright notice and this permission notice shall be included in
11 | all copies or substantial portions of the Software.
12 | 
13 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19 | SOFTWARE.


--------------------------------------------------------------------------------
/example/src/routes.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import { Guard, Route } from 'react-awesome-router';
 3 | 
 4 | import Route1 from './Components/Route1';
 5 | import Route2 from './Components/Route2';
 6 | import Route3 from './Components/Route3';
 7 | import Unauthorized from './Components/Unauthorized';
 8 | 
 9 | const authGuard: Guard = (router, next) => {
10 |   const authenticated = !!router.context?.auth?.logued;
11 |   if (authenticated) {
12 |     return next();
13 |   } else {
14 |     return <Unauthorized />;
15 |   }
16 | };
17 | 
18 | const adminGuard: Guard = (router, next) => {
19 |   const isAdmin = !!(router.context?.auth?.username === 'admin');
20 |   if (isAdmin) {
21 |     next();
22 |   } else {
23 |     return <Unauthorized />;
24 |   }
25 | };
26 | 
27 | export const routes: Array<Route> = [
28 |   {
29 |     path: '/',
30 |     component: <Route1 />
31 |   },
32 |   {
33 |     path: '/private',
34 |     component: <Route2 />,
35 |     guards: [authGuard]
36 |   },
37 |   {
38 |     path: '/route3/:param1/:param2',
39 |     component: <Route3 />
40 |   },
41 |   {
42 |     path: '/admin',
43 |     component: <Route3 />,
44 |     guards: [authGuard, adminGuard]
45 |   }
46 | ];
47 | 


--------------------------------------------------------------------------------
/example/src/App.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react';
 2 | import './App.css';
 3 | import logo from './logo.svg';
 4 | import {Routes, useLocation} from 'react-awesome-router';
 5 | 
 6 | const App: React.FC = () => {
 7 |   const {location, context, setLocation, setContext} = useLocation();
 8 | 
 9 |   const login = () => {
10 |     setContext({auth: {logued: true, username: 'notadmin'}});
11 |     //Optional, force refresh on login
12 |     setLocation(location);
13 |   };
14 | 
15 |   const logout = () => {
16 |     setContext({auth: {logued: false, username: ''}});
17 |   };
18 | 
19 |   return (
20 |     <div className="App">
21 |       <header className="App-header">
22 |         <div className="navbar">
23 |           <button onClick={() => setLocation('/')}>Index</button>
24 |           <button onClick={() => setLocation('/private')}>Private Route</button>
25 |           <button onClick={() => setLocation('/route3/hello/world')}>Param Route</button>
26 |           <button onClick={() => setLocation('/admin')}>Admin</button>
27 |           {context?.auth?.logued ? (
28 |             <button className="logout" onClick={() => logout()}>
29 |               Logout
30 |             </button>
31 |           ) : (
32 |             <button className="login" onClick={() => login()}>
33 |               Login
34 |             </button>
35 |           )}
36 |         </div>
37 |         <img src={logo} className="App-logo" alt="logo" />
38 |         <Routes />
39 |       </header>
40 |     </div>
41 |   );
42 | };
43 | 
44 | export default App;
45 | 


--------------------------------------------------------------------------------
/example/public/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8" />
 5 |     <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
 7 |     <meta name="theme-color" content="#000000" />
 8 |     <meta
 9 |       name="description"
10 |       content="Web site created using create-react-app"
11 |     />
12 |     <link rel="apple-touch-icon" href="%PUBLIC_URL%/logo192.png" />
13 |     <!--
14 |       manifest.json provides metadata used when your web app is installed on a
15 |       user's mobile device or desktop. See https://developers.google.com/web/fundamentals/web-app-manifest/
16 |     -->
17 |     <link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
18 |     <!--
19 |       Notice the use of %PUBLIC_URL% in the tags above.
20 |       It will be replaced with the URL of the `public` folder during the build.
21 |       Only files inside the `public` folder can be referenced from the HTML.
22 | 
23 |       Unlike "/favicon.ico" or "favicon.ico", "%PUBLIC_URL%/favicon.ico" will
24 |       work correctly both with client-side routing and a non-root public URL.
25 |       Learn how to configure a non-root public URL by running `npm run build`.
26 |     -->
27 |     <title>React App</title>
28 |   </head>
29 |   <body>
30 |     <noscript>You need to enable JavaScript to run this app.</noscript>
31 |     <div id="root"></div>
32 |     <!--
33 |       This HTML file is a template.
34 |       If you open it directly in the browser, you will see an empty page.
35 | 
36 |       You can add webfonts, meta tags, or analytics to this file.
37 |       The build step will place the bundled scripts into the <body> tag.
38 | 
39 |       To begin the development, run `npm start` or `yarn start`.
40 |       To create a production bundle, use `npm run build` or `yarn build`.
41 |     -->
42 |   </body>
43 | </html>
44 | 


--------------------------------------------------------------------------------
/example/src/App.css:
--------------------------------------------------------------------------------
  1 | .App {
  2 |   text-align: center;
  3 | }
  4 | 
  5 | .App-logo {
  6 |   height: 40vmin;
  7 |   pointer-events: none;
  8 | }
  9 | 
 10 | @media (prefers-reduced-motion: no-preference) {
 11 |   .App-logo {
 12 |     animation: App-logo-spin infinite 20s linear;
 13 |   }
 14 | }
 15 | 
 16 | .App-header {
 17 |   background-color: #282c34;
 18 |   min-height: 100vh;
 19 |   display: flex;
 20 |   flex-direction: column;
 21 |   align-items: center;
 22 |   justify-content: center;
 23 |   font-size: calc(10px + 2vmin);
 24 |   color: white;
 25 | }
 26 | 
 27 | .App-header .navbar {
 28 |   display: flex;
 29 | }
 30 | 
 31 | .App-header .navbar .login {
 32 |   background-color: lightgreen !important;
 33 | }
 34 | 
 35 | .App-header .navbar .logout {
 36 |   background-color: dimgray !important;
 37 |   color: white !important;
 38 | }
 39 | 
 40 | .App-header .route {
 41 |   display: flex;
 42 |   flex-direction: column;
 43 |   min-height: 200px;
 44 |   max-height: 200px;
 45 |   max-width: 400px;
 46 |   min-width: 400px;
 47 |   border: 1px solid dimgray;
 48 |   padding: 20px;
 49 |   padding-left: 200px;
 50 |   padding-right: 200px;
 51 | }
 52 | 
 53 | .App-header .route .Allowed {
 54 |   color: lightgreen;
 55 |   font-weight: 600;
 56 | }
 57 | 
 58 | .App-header .route .NotAllowed {
 59 |   color: lightcoral;
 60 |   font-weight: 600;
 61 | }
 62 | 
 63 | .App button {
 64 |   background-color: #61dafb;
 65 |   border: 2px solid black;
 66 |   margin: 10px;
 67 |   font-size: 18px;
 68 |   border-radius: 5px;
 69 |   padding: 5px;
 70 |   padding-left: 20px;
 71 |   padding-right: 20px;
 72 |   transition: background-color 0.2s ease;
 73 |   transition: border 0.2s ease;
 74 |   cursor: pointer;
 75 | }
 76 | 
 77 | .App textarea {
 78 |   resize: none;
 79 |   background: #282c34;
 80 |   color: white;
 81 |   border: 1px solid black;
 82 |   min-height: 50px;
 83 |   margin-top: 50px;
 84 | }
 85 | 
 86 | .App button:hover {
 87 |   background-color: #99e7fd;
 88 |   border: 2px solid white;
 89 | }
 90 | 
 91 | .App-link {
 92 |   color: #61dafb;
 93 | }
 94 | 
 95 | @keyframes App-logo-spin {
 96 |   from {
 97 |     transform: rotate(0deg);
 98 |   }
 99 |   to {
100 |     transform: rotate(360deg);
101 |   }
102 | }
103 | 


--------------------------------------------------------------------------------
/example/README.md:
--------------------------------------------------------------------------------
 1 | This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 2 | 
 3 | ## Available Scripts
 4 | 
 5 | In the project directory, you can run:
 6 | 
 7 | ### `yarn start`
 8 | 
 9 | Runs the app in the development mode.<br />
10 | Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
11 | 
12 | The page will reload if you make edits.<br />
13 | You will also see any lint errors in the console.
14 | 
15 | ### `yarn test`
16 | 
17 | Launches the test runner in the interactive watch mode.<br />
18 | See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
19 | 
20 | ### `yarn build`
21 | 
22 | Builds the app for production to the `build` folder.<br />
23 | It correctly bundles React in production mode and optimizes the build for the best performance.
24 | 
25 | The build is minified and the filenames include the hashes.<br />
26 | Your app is ready to be deployed!
27 | 
28 | See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
29 | 
30 | ### `yarn eject`
31 | 
32 | **Note: this is a one-way operation. Once you `eject`, you can’t go back!**
33 | 
34 | If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
35 | 
36 | Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
37 | 
38 | You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
39 | 
40 | ## Learn More
41 | 
42 | You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
43 | 
44 | To learn React, check out the [React documentation](https://reactjs.org/).
45 | 


--------------------------------------------------------------------------------
/example/src/logo.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 841.9 595.3">
2 |     <g fill="#61DAFB">
3 |         <path d="M666.3 296.5c0-32.5-40.7-63.3-103.1-82.4 14.4-63.6 8-114.2-20.2-130.4-6.5-3.8-14.1-5.6-22.4-5.6v22.3c4.6 0 8.3.9 11.4 2.6 13.6 7.8 19.5 37.5 14.9 75.7-1.1 9.4-2.9 19.3-5.1 29.4-19.6-4.8-41-8.5-63.5-10.9-13.5-18.5-27.5-35.3-41.6-50 32.6-30.3 63.2-46.9 84-46.9V78c-27.5 0-63.5 19.6-99.9 53.6-36.4-33.8-72.4-53.2-99.9-53.2v22.3c20.7 0 51.4 16.5 84 46.6-14 14.7-28 31.4-41.3 49.9-22.6 2.4-44 6.1-63.6 11-2.3-10-4-19.7-5.2-29-4.7-38.2 1.1-67.9 14.6-75.8 3-1.8 6.9-2.6 11.5-2.6V78.5c-8.4 0-16 1.8-22.6 5.6-28.1 16.2-34.4 66.7-19.9 130.1-62.2 19.2-102.7 49.9-102.7 82.3 0 32.5 40.7 63.3 103.1 82.4-14.4 63.6-8 114.2 20.2 130.4 6.5 3.8 14.1 5.6 22.5 5.6 27.5 0 63.5-19.6 99.9-53.6 36.4 33.8 72.4 53.2 99.9 53.2 8.4 0 16-1.8 22.6-5.6 28.1-16.2 34.4-66.7 19.9-130.1 62-19.1 102.5-49.9 102.5-82.3zm-130.2-66.7c-3.7 12.9-8.3 26.2-13.5 39.5-4.1-8-8.4-16-13.1-24-4.6-8-9.5-15.8-14.4-23.4 14.2 2.1 27.9 4.7 41 7.9zm-45.8 106.5c-7.8 13.5-15.8 26.3-24.1 38.2-14.9 1.3-30 2-45.2 2-15.1 0-30.2-.7-45-1.9-8.3-11.9-16.4-24.6-24.2-38-7.6-13.1-14.5-26.4-20.8-39.8 6.2-13.4 13.2-26.8 20.7-39.9 7.8-13.5 15.8-26.3 24.1-38.2 14.9-1.3 30-2 45.2-2 15.1 0 30.2.7 45 1.9 8.3 11.9 16.4 24.6 24.2 38 7.6 13.1 14.5 26.4 20.8 39.8-6.3 13.4-13.2 26.8-20.7 39.9zm32.3-13c5.4 13.4 10 26.8 13.8 39.8-13.1 3.2-26.9 5.9-41.2 8 4.9-7.7 9.8-15.6 14.4-23.7 4.6-8 8.9-16.1 13-24.1zM421.2 430c-9.3-9.6-18.6-20.3-27.8-32 9 .4 18.2.7 27.5.7 9.4 0 18.7-.2 27.8-.7-9 11.7-18.3 22.4-27.5 32zm-74.4-58.9c-14.2-2.1-27.9-4.7-41-7.9 3.7-12.9 8.3-26.2 13.5-39.5 4.1 8 8.4 16 13.1 24 4.7 8 9.5 15.8 14.4 23.4zM420.7 163c9.3 9.6 18.6 20.3 27.8 32-9-.4-18.2-.7-27.5-.7-9.4 0-18.7.2-27.8.7 9-11.7 18.3-22.4 27.5-32zm-74 58.9c-4.9 7.7-9.8 15.6-14.4 23.7-4.6 8-8.9 16-13 24-5.4-13.4-10-26.8-13.8-39.8 13.1-3.1 26.9-5.8 41.2-7.9zm-90.5 125.2c-35.4-15.1-58.3-34.9-58.3-50.6 0-15.7 22.9-35.6 58.3-50.6 8.6-3.7 18-7 27.7-10.1 5.7 19.6 13.2 40 22.5 60.9-9.2 20.8-16.6 41.1-22.2 60.6-9.9-3.1-19.3-6.5-28-10.2zM310 490c-13.6-7.8-19.5-37.5-14.9-75.7 1.1-9.4 2.9-19.3 5.1-29.4 19.6 4.8 41 8.5 63.5 10.9 13.5 18.5 27.5 35.3 41.6 50-32.6 30.3-63.2 46.9-84 46.9-4.5-.1-8.3-1-11.3-2.7zm237.2-76.2c4.7 38.2-1.1 67.9-14.6 75.8-3 1.8-6.9 2.6-11.5 2.6-20.7 0-51.4-16.5-84-46.6 14-14.7 28-31.4 41.3-49.9 22.6-2.4 44-6.1 63.6-11 2.3 10.1 4.1 19.8 5.2 29.1zm38.5-66.7c-8.6 3.7-18 7-27.7 10.1-5.7-19.6-13.2-40-22.5-60.9 9.2-20.8 16.6-41.1 22.2-60.6 9.9 3.1 19.3 6.5 28.1 10.2 35.4 15.1 58.3 34.9 58.3 50.6-.1 15.7-23 35.6-58.4 50.6zM320.8 78.4z"/>
4 |         <circle cx="420.9" cy="296.5" r="45.7"/>
5 |         <path d="M520.5 78.1z"/>
6 |     </g>
7 | </svg>
8 | 


--------------------------------------------------------------------------------
/src/Router/index.tsx:
--------------------------------------------------------------------------------
  1 | import React, { useState, useEffect, useRef } from 'react';
  2 | import { createBrowserHistory, History } from 'history';
  3 | import { RouterContext } from '../Context';
  4 | 
  5 | import { Route } from '../types';
  6 | import Path from '../PathUtils';
  7 | 
  8 | export interface RouterState {
  9 |   location: string;
 10 |   params: Object;
 11 |   routes: Array<Route>;
 12 |   context: Object;
 13 |   forceRefresh: number;
 14 |   routedElement: React.ReactNode | undefined;
 15 | }
 16 | 
 17 | export interface IRouterProps {
 18 |   routes: Array<Route>;
 19 |   children: React.ReactNode
 20 | }
 21 | 
 22 | export const Router: React.FC<IRouterProps> = props => {
 23 |   const history = useRef<History | undefined>(undefined);
 24 |   const initialState: RouterState = {
 25 |     location: '',
 26 |     params: {},
 27 |     context: {},
 28 |     routes: props.routes,
 29 |     routedElement: undefined,
 30 |     forceRefresh: 0
 31 |   };
 32 | 
 33 |   const [state, setState] = useState(initialState);
 34 | 
 35 |   const setLocation = (location: string) => {
 36 |     if (state.location !== location) {
 37 |       history.current?.push(location);
 38 |     } else {
 39 |       setState({
 40 |         ...state,
 41 |         forceRefresh: state.forceRefresh + 1
 42 |       });
 43 |     }
 44 |   };
 45 | 
 46 |   const setContext = (context: Object) => {
 47 |     setState({
 48 |       ...state,
 49 |       context: Object.assign(state.context, context)
 50 |     });
 51 |   };
 52 | 
 53 |   useEffect(() => {
 54 |     history.current = createBrowserHistory();
 55 |     setState({
 56 |       ...state,
 57 |       location: history.current.location.pathname
 58 |     });
 59 | 
 60 |     const unlisten = history.current.listen(update => {
 61 |       setState({
 62 |         ...state,
 63 |         location: update.location.pathname
 64 |       });
 65 |     });
 66 | 
 67 |     return () => {
 68 |       unlisten();
 69 |     };
 70 |   }, []);
 71 | 
 72 |   useEffect(() => {
 73 |     let route = state.routes.find(route => {
 74 |       return Path.match(route.path, state.location);
 75 |     });
 76 | 
 77 |     if (route) {
 78 |       let guardReturn: React.ReactNode = undefined;
 79 |       let nexted = false;
 80 | 
 81 |       if (route.guards) {
 82 |         for (const guard of route.guards) {
 83 |           guardReturn = guard({
 84 |             location: state.location,
 85 |             setLocation,
 86 |             setContext,
 87 |             context: state.context,
 88 |             params: state.params,
 89 |           }, () => {
 90 |             nexted = true
 91 |             return undefined
 92 |           });
 93 |           if (!nexted && guardReturn) break;
 94 |         }
 95 |       }
 96 | 
 97 |       setState({
 98 |         ...state,
 99 |         params: Path.parse(route.path, state.location),
100 |         routedElement: guardReturn ?? route.component
101 |       });
102 | 
103 |     }
104 | 
105 | 
106 | 
107 |   }, [state.location, state.forceRefresh]);
108 | 
109 |   return (
110 |     <RouterContext.Provider
111 |       value={{
112 |         location: state.location,
113 |         context: state.context,
114 |         setLocation: setLocation,
115 |         setContext: setContext,
116 |         params: state.params,
117 |         component: state.routedElement
118 |       }}
119 |     >
120 |       {props.children}
121 |     </RouterContext.Provider>
122 |   );
123 | };
124 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     /* Basic Options */
 4 |     "target": "es2015" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
 5 |     "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
 6 |     "lib": [
 7 |       "es2015",
 8 |       "es2016",
 9 |       "DOM"
10 |     ] /* Specify library files to be included in the compilation. */,
11 |     // "allowJs": true,                       /* Allow javascript files to be compiled. */
12 |     // "checkJs": true,                       /* Report errors in .js files. */
13 |     "jsx": "react" /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */,
14 |     "declaration": true /* Generates corresponding '.d.ts' file. */,
15 |     // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
16 |     // "sourceMap": true,                     /* Generates corresponding '.map' file. */
17 |     // "outFile": "./",                       /* Concatenate and emit output to single file. */
18 |     "outDir": "./dist" /* Redirect output structure to the directory. */,
19 |     "rootDir": "./src" /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */,
20 |     // "composite": true,                     /* Enable project compilation */
21 |     // "incremental": true,                   /* Enable incremental compilation */
22 |     // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
23 |     "removeComments": true /* Do not emit comments to output. */,
24 |     // "noEmit": true,                        /* Do not emit outputs. */
25 |     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
26 |     // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
27 |     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
28 |     /* Strict Type-Checking Options */
29 |     "strict": true /* Enable all strict type-checking options. */,
30 |     "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
31 |     "strictNullChecks": true /* Enable strict null checks. */,
32 |     // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
33 |     // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
34 |     // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
35 |     // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
36 |     // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
37 |     /* Additional Checks */
38 |     // "noUnusedLocals": true,                /* Report errors on unused locals. */
39 |     // "noUnusedParameters": true,            /* Report errors on unused parameters. */
40 |     // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
41 |     // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
42 |     /* Module Resolution Options */
43 |     // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
44 |     // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
45 |     // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
46 |     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
47 |     // "typeRoots": [],                       /* List of folders to include type definitions from. */
48 |     // "types": [],                           /* Type declaration files to be included in compilation. */
49 |     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
50 |     "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
51 |     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
52 |     /* Source Map Options */
53 |     // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
54 |     // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
55 |     // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
56 |     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
57 |     /* Experimental Options */
58 |     // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
59 |     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
60 |   },
61 |   "exclude": [
62 |     "dist",
63 |     "example"
64 |   ]
65 | }


--------------------------------------------------------------------------------
/example/src/serviceWorker.ts:
--------------------------------------------------------------------------------
  1 | // This optional code is used to register a service worker.
  2 | // register() is not called by default.
  3 | 
  4 | // This lets the app load faster on subsequent visits in production, and gives
  5 | // it offline capabilities. However, it also means that developers (and users)
  6 | // will only see deployed updates on subsequent visits to a page, after all the
  7 | // existing tabs open on the page have been closed, since previously cached
  8 | // resources are updated in the background.
  9 | 
 10 | // To learn more about the benefits of this model and instructions on how to
 11 | // opt-in, read https://bit.ly/CRA-PWA
 12 | 
 13 | const isLocalhost = Boolean(
 14 |   window.location.hostname === 'localhost' ||
 15 |     // [::1] is the IPv6 localhost address.
 16 |     window.location.hostname === '[::1]' ||
 17 |     // 127.0.0.0/8 are considered localhost for IPv4.
 18 |     window.location.hostname.match(
 19 |       /^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/
 20 |     )
 21 | );
 22 | 
 23 | type Config = {
 24 |   onSuccess?: (registration: ServiceWorkerRegistration) => void;
 25 |   onUpdate?: (registration: ServiceWorkerRegistration) => void;
 26 | };
 27 | 
 28 | export function register(config?: Config) {
 29 |   if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) {
 30 |     // The URL constructor is available in all browsers that support SW.
 31 |     const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href);
 32 |     if (publicUrl.origin !== window.location.origin) {
 33 |       // Our service worker won't work if PUBLIC_URL is on a different origin
 34 |       // from what our page is served on. This might happen if a CDN is used to
 35 |       // serve assets; see https://github.com/facebook/create-react-app/issues/2374
 36 |       return;
 37 |     }
 38 | 
 39 |     window.addEventListener('load', () => {
 40 |       const swUrl = `${process.env.PUBLIC_URL}/service-worker.js`;
 41 | 
 42 |       if (isLocalhost) {
 43 |         // This is running on localhost. Let's check if a service worker still exists or not.
 44 |         checkValidServiceWorker(swUrl, config);
 45 | 
 46 |         // Add some additional logging to localhost, pointing developers to the
 47 |         // service worker/PWA documentation.
 48 |         navigator.serviceWorker.ready.then(() => {
 49 |           console.log(
 50 |             'This web app is being served cache-first by a service ' +
 51 |               'worker. To learn more, visit https://bit.ly/CRA-PWA'
 52 |           );
 53 |         });
 54 |       } else {
 55 |         // Is not localhost. Just register service worker
 56 |         registerValidSW(swUrl, config);
 57 |       }
 58 |     });
 59 |   }
 60 | }
 61 | 
 62 | function registerValidSW(swUrl: string, config?: Config) {
 63 |   navigator.serviceWorker
 64 |     .register(swUrl)
 65 |     .then(registration => {
 66 |       registration.onupdatefound = () => {
 67 |         const installingWorker = registration.installing;
 68 |         if (installingWorker == null) {
 69 |           return;
 70 |         }
 71 |         installingWorker.onstatechange = () => {
 72 |           if (installingWorker.state === 'installed') {
 73 |             if (navigator.serviceWorker.controller) {
 74 |               // At this point, the updated precached content has been fetched,
 75 |               // but the previous service worker will still serve the older
 76 |               // content until all client tabs are closed.
 77 |               console.log(
 78 |                 'New content is available and will be used when all ' +
 79 |                   'tabs for this page are closed. See https://bit.ly/CRA-PWA.'
 80 |               );
 81 | 
 82 |               // Execute callback
 83 |               if (config && config.onUpdate) {
 84 |                 config.onUpdate(registration);
 85 |               }
 86 |             } else {
 87 |               // At this point, everything has been precached.
 88 |               // It's the perfect time to display a
 89 |               // "Content is cached for offline use." message.
 90 |               console.log('Content is cached for offline use.');
 91 | 
 92 |               // Execute callback
 93 |               if (config && config.onSuccess) {
 94 |                 config.onSuccess(registration);
 95 |               }
 96 |             }
 97 |           }
 98 |         };
 99 |       };
100 |     })
101 |     .catch(error => {
102 |       console.error('Error during service worker registration:', error);
103 |     });
104 | }
105 | 
106 | function checkValidServiceWorker(swUrl: string, config?: Config) {
107 |   // Check if the service worker can be found. If it can't reload the page.
108 |   fetch(swUrl, {
109 |     headers: {'Service-Worker': 'script'}
110 |   })
111 |     .then(response => {
112 |       // Ensure service worker exists, and that we really are getting a JS file.
113 |       const contentType = response.headers.get('content-type');
114 |       if (
115 |         response.status === 404 ||
116 |         (contentType != null && contentType.indexOf('javascript') === -1)
117 |       ) {
118 |         // No service worker found. Probably a different app. Reload the page.
119 |         navigator.serviceWorker.ready.then(registration => {
120 |           registration.unregister().then(() => {
121 |             window.location.reload();
122 |           });
123 |         });
124 |       } else {
125 |         // Service worker found. Proceed as normal.
126 |         registerValidSW(swUrl, config);
127 |       }
128 |     })
129 |     .catch(() => {
130 |       console.log(
131 |         'No internet connection found. App is running in offline mode.'
132 |       );
133 |     });
134 | }
135 | 
136 | export function unregister() {
137 |   if ('serviceWorker' in navigator) {
138 |     navigator.serviceWorker.ready.then(registration => {
139 |       registration.unregister();
140 |     });
141 |   }
142 | }
143 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # React Awesome Router
  2 | 
  3 | A simple, lightweight, middleware oriented router for react applications.
  4 | 
  5 | ## Motivation
  6 | 
  7 | Comming from non-react world, routing throgh JSX components feels annoying to me. I don't like to spread the routing logic between different react components or write JSX components to extend router capabilities (like auth). I also missed other features I enjoy and was used to like [Angular guards](https://angular.io/api/router/CanActivate) and [Koa](https://github.com/koajs/koa) middleware based architecture.
  8 | 
  9 | When starting with react hooks, I realized how simple it will be to write a react router with hooks, [history.js](https://github.com/ReactTraining/history) and [path-to-regexp](https://github.com/pillarjs/path-to-regexp); indeed I think the whole module is far below 200 lines of code. This module provides basic routing features to small applications, and allows more advanced features on bigger applications through the use of custom ad-hoc middlewares.
 10 | 
 11 | ## Installation
 12 | 
 13 | ```bash
 14 | npm i react-awesome-router --save
 15 | ```
 16 | 
 17 | ## Getting started
 18 | 
 19 | First, wrap the component you want to enable router on with the router component.
 20 | 
 21 | ```jsx
 22 | import {Router} from 'react-awesome-router';
 23 | import {routes} from './routes';
 24 | 
 25 | ReactDOM.render(
 26 |   <Router routes={routes}>
 27 |     <App />
 28 |   </Router>,
 29 |   document.getElementById('root')
 30 | );
 31 | ```
 32 | 
 33 | Then, use Routes component where you want the routes to be rendered:
 34 | 
 35 | ```jsx
 36 | const App = () => {
 37 |   return (
 38 |     <div className="App">
 39 |       <header className="App-header">
 40 |         <img src={logo} className="App-logo" alt="logo" />
 41 |         <Routes />
 42 |       </header>
 43 |     </div>
 44 |   );
 45 | };
 46 | export default App;
 47 | ```
 48 | 
 49 | Routes are defined as an array of routes. A route is an object with a path and a JSX Component that will be rendered when the path match the current location.
 50 | 
 51 | ```jsx
 52 | import Route1 from './Components/Route1';
 53 | 
 54 | export const routes: = [
 55 |   {
 56 |     path: '/',
 57 |     component: <Route1 />
 58 |   }
 59 | ];
 60 | ```
 61 | 
 62 | A react hook is provided to access router resources anywhere inside the Router component.
 63 | 
 64 | ```js
 65 | import {useLocation} from 'react-awesome-router';
 66 | 
 67 | const {location, context, params, setLocation, setContext} = useLocation();
 68 | ```
 69 | 
 70 | | Property        |           Type           | Description                                                                                                                                |
 71 | | --------------- | :----------------------: | ------------------------------- |
 72 | | **location**    |         `string`         | The current routed path                                                                                                                    |
 73 | | **setLocation** | `function(string)=>void` | Sets the current location. If the location provided is the current location, triggers another render of the current route                  |
 74 | | **context**     |         `Object`         | A global router state. Can be used to set global state related to router, such as authentication state or user information                 |
 75 | | **setContext**  | `function(Object)=>void` | Add information to router state. Note that Object properties are copied to current router state, only existing properties will be replaced |
 76 | | **params**      |         `Object`         | An Object representing the current route params                                                                                            |
 77 | 
 78 | > Note that you can only use the hook on components that are children of the component wrapped by Router
 79 | 
 80 | You can define route params and access them with ease with the hook:
 81 | 
 82 | ```jsx
 83 | export const routes: = [
 84 |   {
 85 |     path: '/',
 86 |     component: <Route1 />
 87 |   },
 88 |   {
 89 |     path: '/route3/:param1/:param2',
 90 |     component: <Route3 />
 91 |   }
 92 | ];
 93 | ```
 94 | 
 95 | ```jsx
 96 | import {useLocation} from 'react-awesome-router';
 97 | 
 98 | const Route3 = () => {
 99 |   const {params} = useLocation();
100 | 
101 |   return (
102 |     <div className="route">
103 |       <div>Param1: {params.param1}</div>
104 |       <div>Param2: {params.param2}</div>
105 |     </div>
106 |   );
107 | };
108 | 
109 | export default Route3;
110 | ```
111 | 
112 | You can also define Route guards. Guards are executed after route resolution and before component render, allowing to conditionally render the component basend on custom rules like authentication or user role. A guard is a function returning either a React.ReactNode or ```next()```. A router object is provided as first param, which allows the middleware to access the same resources as the useLocation hook. Returning ```next()``` states the guard don't want to take actions, and the router should return the routed component if no remaining guards says otherwise.
113 | 
114 | ```jsx
115 | const authGuard = (router, next) => {
116 |   const authenticated = !!router.context?.auth?.logued;
117 |   if (authenticated) {
118 |     return next();
119 |   } else {
120 |     return <Unauthorized />;
121 |   }
122 | };
123 | 
124 | export const routes = [
125 |   {
126 |     path: '/',
127 |     component: <Route1 />
128 |   },
129 |   {
130 |     path: '/private',
131 |     component: <Route2 />,
132 |     guards: [authGuard]
133 |   }
134 | ];
135 | ```
136 | 
137 | > Note that guards are defined as an array, and are executed in the same order as provided: The router will render the first guard's fallback that returns false, or the route component if all guards return true.
138 | 
139 | Fully working example application, bootstraped with create-react-app is provided in the [example](https://github.com/hzeroo/react-awesome-router/tree/master/example) directory.
140 | 
141 | ## Upgrading from v1
142 | Route definition changed from being defined as an object in v1:
143 | ```jsx
144 | const authGuard = {
145 |   middleware: router => {
146 |     const authenticated = !!router.context?.auth?.logued;
147 |     return authenticated;
148 |   },
149 | 
150 |   fallback: <Unauthorized />
151 | };
152 | ```
153 | 
154 | In v2, routes are defined as functions:
155 | ```jsx
156 | const authGuard = (router, next) => {
157 |   const authenticated = !!router.context?.auth?.logued;
158 |   if (authenticated) {
159 |     return next();
160 |   } else {
161 |     return <Unauthorized />;
162 |   }
163 | };
164 | ```
165 | 
166 | ## Running for developement
167 | 
168 | To run both the router module and the example together with live reloading, first clone the repository:
169 | 
170 | ```bash
171 | git clone https://github.com/hzeroo/react-awesome-router.git
172 | ```
173 | 
174 | Then install dependencies and run the router module:
175 | 
176 | ```bash
177 | cd react-awesome-router
178 | npm i
179 | # Link the package to the global npm package folder
180 | sudo npm link
181 | npm start
182 | ```
183 | 
184 | On another shell, install the example dependencies and and run it:
185 | 
186 | ```bash
187 | cd example
188 | npm i
189 | npm link react-awesome-router
190 | # Remove react dependency, as react-awesome-router module
191 | # already provides it and using both will result on runtime error
192 | rm -rf node_modules/react
193 | npm start
194 | ```
195 | 
196 | This will open http://localhost:3000 with the example application running. Any changes either to the router or the example will live reload the example.
197 | 
198 | ## Previous work I liked and guided me
199 | 
200 | - [Angular router](https://angular.io/guide/router)
201 | - [universal-router](https://github.com/kriasoft/universal-router) by Kriasoft
202 | 


--------------------------------------------------------------------------------