1.0.10

.gitlab-ci.yml

@@ -19,23 +19,35 @@ mirror:
   stage: security
   script:
     - npmci git mirror
+  only:
+    - tags
   tags:
     - lossless
     - docker
     - notpriv
 
-audit:
+auditProductionDependencies:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
+  stage: security
+  script:
+    - npmci npm prepare
+    - npmci command npm install --production --ignore-scripts
+    - npmci command npm config set registry https://registry.npmjs.org
+    - npmci command npm audit --audit-level=high --only=prod --production
+  tags:
+    - docker
+
+auditDevDependencies:
   image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
   stage: security
   script:
     - npmci npm prepare
     - npmci command npm install --ignore-scripts
     - npmci command npm config set registry https://registry.npmjs.org
-    - npmci command npm audit --audit-level=high
+    - npmci command npm audit --audit-level=high --only=dev
   tags:
-    - lossless
     - docker
-    - notpriv
+  allow_failure: true
 
 # ====================
 # test stage
@@ -50,9 +62,7 @@ testStable:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - priv
 
 testBuild:
   stage: test
@@ -63,9 +73,7 @@ testBuild:
     - npmci command npm run build
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
-    - lossless
     - docker
-    - notpriv
 
 release:
   stage: release
@@ -85,6 +93,8 @@ release:
 codequality:
   stage: metadata
   allow_failure: true
+  only:
+    - tags
   script:
     - npmci command npm install -g tslint typescript
     - npmci npm prepare

.vscode/settings.json

@@ -15,7 +15,7 @@
             "properties": {
               "projectType": {
                 "type": "string",
-                "enum": ["website", "element", "service", "npm"]
+                "enum": ["website", "element", "service", "npm", "wcc"]
               }
             }
           }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartrouter",
-  "version": "1.0.2",
+  "version": "1.0.10",
   "private": false,
   "description": "a router for routing on websites",
   "main": "dist_ts/index.js",
@@ -13,16 +13,16 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.0.22",
-    "@gitzone/tsbundle": "^1.0.69",
-    "@gitzone/tstest": "^1.0.15",
-    "@pushrocks/tapbundle": "^3.0.7",
-    "@types/node": "^10.11.7",
-    "tslint": "^5.11.0",
+    "@gitzone/tsbuild": "^2.1.26",
+    "@gitzone/tsbundle": "^1.0.87",
+    "@gitzone/tstest": "^1.0.57",
+    "@pushrocks/tapbundle": "^3.2.14",
+    "@types/node": "^16.7.13",
+    "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.15.0"
   },
   "dependencies": {
-    "path-to-regexp": "^6.1.0"
+    "path-to-regexp": "^6.2.0"
   },
   "files": [
     "ts/**/*",
@@ -35,5 +35,8 @@
     "cli.js",
     "npmextra.json",
     "readme.md"
+  ],
+  "browserslist": [
+    "last 1 chrome versions"
   ]
 }

readme.md

@@ -19,7 +19,7 @@ TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x
 node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
 Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
 PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartrouter)](https://lossless.cloud)
-PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartrouter)](https://lossless.cloud)
+PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartrouter)](https://lossless.cloud)
 BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartrouter)](https://lossless.cloud)
 Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
 

test/test.browser.ts

@@ -0,0 +1,46 @@
+import { expect, tap } from '@pushrocks/tapbundle';
+import * as smartrouter from '../ts/index';
+
+let testrouter: smartrouter.SmartRouter;
+
+tap.test('first test', async () => {
+  testrouter = new smartrouter.SmartRouter({});
+  expect(testrouter).to.be.instanceOf(smartrouter.SmartRouter);
+});
+
+tap.test('should handle a route change', async (toolsArg) => {
+  const done = toolsArg.defer();
+  testrouter.on('/myawesomeroute/:any', async (routeInfoArg) => {
+    expect(routeInfoArg.params.any).to.equal('hello');
+    done.resolve();
+  });
+  testrouter.pushUrl('/myawesomeroute/hello');
+  await done.promise;
+});
+
+tap.test('should handle a route change', async (toolsArg) => {
+  const done = toolsArg.defer();
+  testrouter.on('/myawesomeroute2/:wow', async (routeInfoArg) => {
+    expect(routeInfoArg.params.wow).to.equal('hello2');
+    done.resolve();
+  });
+  testrouter.pushUrl('/myawesomeroute2/hello2');
+  await done.promise;
+  expect(window.location.href).to.equal('http://localhost:3007/myawesomeroute2/hello2');
+});
+
+tap.test('should find a query param', async (toolsArg) => {
+  const done = toolsArg.defer();
+  testrouter.on('/myawesomeroute2/:wow', async (routeInfoArg) => {
+    expect(routeInfoArg.params.wow).to.equal('hello2');
+    expect(routeInfoArg.queryParams.aparam).to.equal('Yes');
+    console.log('Here is what queryParams looks like');
+    console.log(JSON.stringify(routeInfoArg.queryParams));
+    done.resolve();
+  });
+  testrouter.pushUrl('/myawesomeroute2/hello2?aparam=Yes');
+  await done.promise;
+  expect(window.location.href).to.equal('http://localhost:3007/myawesomeroute2/hello2?aparam=Yes');
+});
+
+tap.start();

test/test.ts

@@ -1,8 +0,0 @@
-import { expect, tap } from '@pushrocks/tapbundle';
-import * as smartrouter from '../ts/index';
-
-tap.test('first test', async () => {
-  const router = new smartrouter.SmartRouter({});
-});
-
-tap.start();

ts/index.ts

@@ -8,6 +8,14 @@ export interface IRouterOptions {
   debug?: boolean;
 }
 
+export type THandlerFunction = <T extends object>(routeArg: IRouteInfo) => Promise<any>;
+export interface IRouteInfo {
+  path: string;
+  index: number;
+  params: { [key: string]: string };
+  queryParams: { [key: string]: string };
+}
+
 /**
  * Router
  */
@@ -19,7 +27,10 @@ export class SmartRouter {
   /**
    * the routes we are handling
    */
-  public routes: Array<{ matchFunction: plugins.pathToRegExp.MatchFunction; handler: <T extends object>(matchArg: plugins.pathToRegExp.Match<T>) => Promise<any> }> = [];
+  public routes: Array<{
+    matchFunction: plugins.pathToRegExp.MatchFunction;
+    handler: THandlerFunction;
+  }> = [];
 
   /**
    * Creates an instance of Router.
@@ -58,8 +69,7 @@ export class SmartRouter {
    * @param {string|RegExp} routeArg
    * @param {function} handlerArg
    */
-  public on(routeArg: string, handlerArg: () => Promise<any>) {
-    
+  public on(routeArg: string, handlerArg: THandlerFunction) {
     this.routes.push({
       matchFunction: plugins.pathToRegExp.match(routeArg),
       handler: handlerArg,
@@ -71,13 +81,19 @@ export class SmartRouter {
    */
   async _handleRouteState() {
     const currentLocation = window.location.pathname;
-    const wantedRoute = this.routes.find(routeArg => {
+    const urlSearchParams = new URLSearchParams(window.location.search);
+
+    // lets find all wanted routes.
+    const wantedRoutes = this.routes.filter((routeArg) => {
       return !!routeArg.matchFunction(currentLocation);
     });
 
-    if (wantedRoute) {
+    for (const wantedRoute of wantedRoutes) {
       const routeResult = wantedRoute.matchFunction(currentLocation);
-      await wantedRoute.handler(routeResult);
+      wantedRoute.handler({
+        ...(routeResult.valueOf() as Object),
+        queryParams: Object.fromEntries(urlSearchParams.entries()),
+      } as IRouteInfo); // not waiting here
     }
   }
 }

ts/smartrouter.plugins.ts

@@ -1,5 +1,3 @@
 import * as pathToRegExp from 'path-to-regexp';
 
-export {
-  pathToRegExp
-};
+export { pathToRegExp };