@breautek/router 3.0.0 → 4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@breautek/router",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "An alternate react router.",
   "main": "dist/router.js",
   "types": "dist/src/api.d.ts",
@@ -11,12 +11,10 @@
   "scripts": {
     "test": "jest",
     "lint": "eslint --ext .ts,.tsx '?(src|spec)/**/*.?(ts|tsx)' --cache",
-    "build": "rollup -c rollup.config.js",
+    "build": "rollup -c rollup.config.js --bundleConfigAsCjs",
     "publish-beta": "npm publish --tag beta",
     "prepublishOnly": "npm run build",
-    "changelog": "auto-changelog --output CHANGELOG.md -p --release-summary --ignore-commit-pattern chore",
-    "docs": "typedoc --excludePrivate --includeVersion -readme ./README.md --out ./docs ./src/api.ts",
-    "version": "npm run-script build && npm run-script docs && npm run changelog && git add CHANGELOG.md docs && git commit -m 'chore: changelog'",
+    "version": "npm run-script build",
     "postversion": "git push && git push --tags"
   },
   "repository": {
@@ -34,50 +32,36 @@
   "license": "MIT",
   "homepage": "https://github.com/breautek/router",
   "peerDependencies": {
-    "react": ">=16.9.0 <17.0.0",
-    "react-dom": ">=16.9.0 <17.0.0"
+    "react": "16.x || 17.x || 18.x",
+    "react-dom": "16.x || 17.x || 18.x"
   },
   "devDependencies": {
-    "@babel/core": "7.18.5",
-    "@babel/plugin-syntax-dynamic-import": "7.8.3",
-    "@babel/preset-env": "7.18.2",
-    "@babel/preset-react": "7.17.12",
-    "@babel/preset-typescript": "7.17.12",
-    "@babel/register": "7.17.7",
-    "@rollup/plugin-babel": "5.3.1",
-    "@rollup/plugin-commonjs": "22.0.0",
-    "@rollup/plugin-json": "4.1.0",
-    "@rollup/plugin-node-resolve": "13.3.0",
-    "@types/enzyme": "3.10.12",
-    "@types/enzyme-adapter-react-16": "1.0.6",
-    "@types/jest": "27.5.1",
-    "@types/react": "16.14.4",
-    "@types/react-dom": "16.9.11",
-    "@types/react-test-renderer": "17.0.1",
-    "@typescript-eslint/eslint-plugin": "5.29.0",
-    "@typescript-eslint/parser": "5.29.0",
-    "ajv": "8.11.0",
-    "auto-changelog": "2.4.0",
-    "babel-jest": "27.5.1",
-    "enzyme": "3.11.0",
-    "enzyme-adapter-react-16": "1.15.6",
-    "eslint": "8.18.0",
-    "eslint-plugin-react": "7.30.0",
-    "glob": "8.0.3",
+    "@rollup/plugin-commonjs": "25.0.3",
+    "@rollup/plugin-json": "6.0.0",
+    "@rollup/plugin-node-resolve": "15.1.0",
+    "@testing-library/jest-dom": "5.16.5",
+    "@testing-library/react": "14.0.0",
+    "@types/jest": "29.5.3",
+    "@types/react": "18.2.15",
+    "@types/react-dom": "18.2.7",
+    "@typescript-eslint/eslint-plugin": "6.1.0",
+    "@typescript-eslint/parser": "6.1.0",
+    "ajv": "8.12.0",
+    "eslint": "8.45.0",
+    "eslint-plugin-react": "7.32.2",
+    "glob": "10.3.3",
     "ignore-styles": "5.0.1",
-    "jest": "27.5.1",
-    "node-sass": "7.0.1",
-    "react": "16.14.0",
-    "react-dom": "16.14.0",
-    "regenerator-runtime": "0.13.9",
-    "rollup": "2.75.7",
+    "jest": "29.6.1",
+    "jest-environment-jsdom": "29.6.1",
+    "node-sass": "9.0.0",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "rollup": "3.26.3",
     "rollup-plugin-progress": "1.1.2",
-    "rollup-plugin-sass": "1.2.12",
-    "rollup-plugin-typescript2": "0.32.1",
-    "ts-jest": "27.1.3",
-    "ts-node": "10.8.1",
-    "typedoc": "0.22.17",
-    "typedoc-plugin-markdown": "3.12.1",
-    "typescript": "4.6.4"
+    "rollup-plugin-sass": "1.12.19",
+    "rollup-plugin-typescript2": "0.35.0",
+    "ts-jest": "29.1.1",
+    "ts-node": "10.9.1",
+    "typescript": "5.1.6"
   }
 }

package/src/HashStrategy.ts

@@ -20,7 +20,7 @@ export class HashStrategy extends RouterStrategy {
         this.$base = '#';
         this.$stack = [];
         this.$position = -1;
-        this.$lastFiredLocation = null; //this.getLocation();
+        this.$lastFiredLocation = null;
 
         window.addEventListener('popstate', (ev: PopStateEvent) => {
             let location = this.getLocation();

package/src/RouteMatcher.ts

@@ -1,6 +1,4 @@
 
-import "regenerator-runtime/runtime";
-
 import {URLParser, IURLParams} from './URLParser';
 import {cloneElement} from 'react';
 import {IComponentProps, IRouteProps} from './Route';

package/src/Router.tsx

@@ -1,6 +1,4 @@
 
-import "regenerator-runtime/runtime";
-
 import * as React from 'react';
 
 import {DefaultStrategy} from './DefaultStrategy';
@@ -13,6 +11,7 @@ import { Route } from "./Route";
 export interface IRouterProps {
     strategy?: IRouterStrategyClass;
     component: React.ComponentClass<any>;
+    children?: React.ReactNode;
     onNoRoute?: IOnNoRoute;
 }
 
@@ -275,6 +274,10 @@ export class Router<TRouterProps extends IRouterProps = IRouterProps> extends Re
     }
 }
 
+/**
+ * @deprecated Use Router.getInstance() instead.
+ * @returns {RouterStrategy}
+ */
 export let getRouter = (): RouterStrategy => {
     console.warn('getRouter() is deprecated. use Router.getInstance() instead.');
     return Router.getInstance();

package/src/RouterStrategy.ts

@@ -1,16 +1,69 @@
 import { EventEmitter } from 'events';
 import { Router } from './Router';
+import {View} from './View';
 
 export const EVENT_URL_CHANGE: string = 'urlchange';
 
 export type URLChangeCallback = (url: string) => void;
 
+/**
+ * Invoked when the view's componentDidMount/componentWillUnmount fires.
+ */
+export type ViewMountChangeCallback = (view: View) => void;
+
 export abstract class RouterStrategy extends EventEmitter {
     private $router: Router;
 
+    private $viewMountListeners: ViewMountChangeCallback[];
+    private $viewUnmountListneners: ViewMountChangeCallback[];
+
     public constructor(router: Router) {
         super();
         this.$router = router;
+        this.$viewMountListeners = [];
+        this.$viewUnmountListneners = [];
+    }
+
+    public addViewMountCallback(cb: ViewMountChangeCallback): void {
+        this.$viewMountListeners.push(cb);
+    }
+
+    public removeViewMountCallback(cb: ViewMountChangeCallback): void {
+        let idx: number = this.$viewMountListeners.indexOf(cb);
+        if (idx > -1) {
+            this.$viewMountListeners.splice(idx, 1);
+        }
+    }
+
+    public addViewUnmountCallback(cb: ViewMountChangeCallback): void {
+        this.$viewUnmountListneners.push(cb);
+    }
+
+    public removeViewUnmountCallback(cb: ViewMountChangeCallback): void {
+        let idx: number = this.$viewUnmountListneners.indexOf(cb);
+        if (idx > -1) {
+            this.$viewUnmountListneners.splice(idx, 1);
+        }
+    }
+
+    /**
+     * @internal
+     * @param view 
+     */
+    public __onViewMount(view: View): void {
+        for (let i: number = 0; i < this.$viewMountListeners.length; i++) {
+            this.$viewMountListeners[i](view);
+        }
+    }
+
+    /**
+     * @internal
+     * @param view 
+     */
+    public __onViewUnmount(view: View): void {
+        for (let i: number = 0; i < this.$viewUnmountListneners.length; i++) {
+            this.$viewUnmountListneners[i](view);
+        }
     }
 
     /**

package/src/URLStrategy.ts

@@ -119,6 +119,7 @@ export class URLStrategy extends RouterStrategy {
         else {
             window.history.pushState({}, null, this.$base + url);
         }
+
         this._fireURLChange(this.getLocation());
     }
 }

package/src/View.tsx

@@ -1,8 +1,5 @@
 
-import "regenerator-runtime/runtime";
-
 import * as React from 'react';
-
 import { RouterStrategy } from './RouterStrategy';
 import { TransitionStrategy } from './TransitionStrategy';
 import { IViewStylesheet } from './IViewStylesheet';
@@ -52,6 +49,8 @@ export abstract class View<TPageProps extends IViewProps = IViewProps> extends R
         if (stylesheet) {
             stylesheet.use();
         }
+
+        this.props.router.__onViewMount(this);
     }
 
     /**
@@ -62,6 +61,7 @@ export abstract class View<TPageProps extends IViewProps = IViewProps> extends R
         if (stylesheet) {
             stylesheet.unuse();
         }
+        this.props.router.__onViewUnmount(this);
     }
 
     /**

package/src/api.ts

@@ -1,6 +1,4 @@
 
-import "regenerator-runtime/runtime";
-
 export * from './Router';
 export * from './DefaultStrategy';
 export * from './HashStrategy';