1.0.12

.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.12",
   "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.29",
+    "@gitzone/tsbundle": "^1.0.88",
+    "@gitzone/tstest": "^1.0.60",
+    "@pushrocks/tapbundle": "^4.0.0",
+    "@types/node": "^17.0.10",
+    "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, expectAsync, 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).toBeInstanceOf(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).toEqual('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).toEqual('hello2');
+    done.resolve();
+  });
+  testrouter.pushUrl('/myawesomeroute2/hello2');
+  await done.promise;
+  expect(window.location.href).toEqual('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).toEqual('hello2');
+    expect(routeInfoArg.queryParams.aparam).toEqual('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).toEqual('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

@@ -1,83 +1 @@
-import * as plugins from './smartrouter.plugins';
-
-const routeLog = (message) => {
-  console.log(`%c[Router]%c ${message}`, 'color: rgb(255, 105, 100);', 'color: inherit');
-};
-
-export interface IRouterOptions {
-  debug?: boolean;
-}
-
-/**
- * Router
- */
-export class SmartRouter {
-  public options: IRouterOptions = {
-    debug: false,
-  };
-
-  /**
-   * the routes we are handling
-   */
-  public routes: Array<{ matchFunction: plugins.pathToRegExp.MatchFunction; handler: <T extends object>(matchArg: plugins.pathToRegExp.Match<T>) => Promise<any> }> = [];
-
-  /**
-   * Creates an instance of Router.
-   */
-  constructor(optionsArg: IRouterOptions) {
-    // lets set the router options
-    this.options = {
-      ...this.options,
-      ...optionsArg,
-    };
-
-    // lets subscribe to route changes
-    window.addEventListener('popstate', (popStateEventArg) => {
-      popStateEventArg.preventDefault();
-      this._handleRouteState();
-    });
-    window.addEventListener('DOMContentLoaded', () => {
-      this._handleRouteState();
-    });
-  }
-
-  /**
-   * Push route state to history stack
-   */
-  public async pushUrl(url: string = '/', state: any = {}) {
-    if (url !== window.location.pathname) {
-      window.history.pushState(state, window.document.title, url);
-    } else {
-      window.history.replaceState(state, window.document.title, url);
-    }
-    await this._handleRouteState();
-  }
-
-  /**
-   * Attach route with handler
-   * @param {string|RegExp} routeArg
-   * @param {function} handlerArg
-   */
-  public on(routeArg: string, handlerArg: () => Promise<any>) {
-    
-    this.routes.push({
-      matchFunction: plugins.pathToRegExp.match(routeArg),
-      handler: handlerArg,
-    });
-  }
-
-  /**
-   * Apply routes handler to current route
-   */
-  async _handleRouteState() {
-    const currentLocation = window.location.pathname;
-    const wantedRoute = this.routes.find(routeArg => {
-      return !!routeArg.matchFunction(currentLocation);
-    });
-
-    if (wantedRoute) {
-      const routeResult = wantedRoute.matchFunction(currentLocation);
-      await wantedRoute.handler(routeResult);
-    }
-  }
-}
+export * from './smartrouter.classes.smartrouter';

ts/smartrouter.classes.queryparams.ts

@@ -0,0 +1,31 @@
+import * as plugins from './smartrouter.plugins';
+
+export class QueryParams {
+  constructor() {}
+
+  public getAllAsObject() {
+    const urlSearchParams = new URLSearchParams(window.location.search);
+    return Object.fromEntries((urlSearchParams as any).entries());
+  }
+
+  public setQueryParam(queryKeyArg: string, queryContentArg: string, pushOrReplaceArg: 'push' | 'replace' = 'replace') {
+    var queryParams = new URLSearchParams(window.location.search);
+    queryParams.set(queryKeyArg, queryContentArg);
+    pushOrReplaceArg === 'push'
+      ? history.pushState(null, null, '?' + queryParams.toString())
+      : history.replaceState(null, null, '?' + queryParams.toString());
+  }
+
+  public deleteQueryParam(queryKeyArg: string, pushOrReplaceArg: 'push' | 'replace' = 'replace') {
+    var queryParams = new URLSearchParams(window.location.search);
+    queryParams.delete(queryKeyArg);
+    pushOrReplaceArg === 'push'
+      ? history.pushState(null, null, '?' + queryParams.toString())
+      : history.replaceState(null, null, '?' + queryParams.toString());
+  }
+
+  public getQueryParam(queryParamName: string) {
+    const queryParams = this.getAllAsObject();
+    return queryParams[queryParamName];
+  }
+}

ts/smartrouter.classes.smartrouter.ts

@@ -0,0 +1,105 @@
+import * as plugins from './smartrouter.plugins';
+
+import { QueryParams } from './smartrouter.classes.queryparams';
+
+const routeLog = (message) => {
+  console.log(`%c[Router]%c ${message}`, 'color: rgb(255, 105, 100);', 'color: inherit');
+};
+
+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
+ */
+export class SmartRouter {
+  public options: IRouterOptions = {
+    debug: false,
+  };
+
+  public queryParams = new QueryParams();
+
+  /**
+   * the routes we are handling
+   */
+  public routes: Array<{
+    matchFunction: plugins.pathToRegExp.MatchFunction;
+    handler: THandlerFunction;
+  }> = [];
+
+  /**
+   * Creates an instance of Router.
+   */
+  constructor(optionsArg: IRouterOptions) {
+    // lets set the router options
+    this.options = {
+      ...this.options,
+      ...optionsArg,
+    };
+
+    // lets subscribe to route changes
+    window.addEventListener('popstate', (popStateEventArg) => {
+      popStateEventArg.preventDefault();
+      this._handleRouteState();
+    });
+    window.addEventListener('DOMContentLoaded', () => {
+      this._handleRouteState();
+    });
+  }
+
+  /**
+   * Push route state to history stack
+   */
+  public async pushUrl(url: string = '/', state: any = {}) {
+    if (url !== window.location.pathname) {
+      window.history.pushState(state, window.document.title, url);
+    } else {
+      window.history.replaceState(state, window.document.title, url);
+    }
+    await this._handleRouteState();
+  }
+
+  /**
+   * Attach route with handler
+   * @param {string|RegExp} routeArg
+   * @param {function} handlerArg
+   */
+  public on(routeArg: string, handlerArg: THandlerFunction) {
+    this.routes.push({
+      matchFunction: plugins.pathToRegExp.match(routeArg),
+      handler: handlerArg,
+    });
+  }
+
+  /**
+   * Apply routes handler to current route
+   */
+  async _handleRouteState() {
+    const currentLocation = window.location.pathname;
+    
+
+    // lets find all wanted routes.
+    const wantedRoutes = this.routes.filter((routeArg) => {
+      return !!routeArg.matchFunction(currentLocation);
+    });
+
+    for (const wantedRoute of wantedRoutes) {
+      const routeResult = wantedRoute.matchFunction(currentLocation);
+      wantedRoute.handler({
+        ...(routeResult.valueOf() as Object),
+        queryParams: this.queryParams.getAllAsObject(), // TODO check wether entries is supported in typings
+      } as IRouteInfo); // not waiting here
+    }
+  }
+
+  
+}

ts/smartrouter.plugins.ts

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