Compare commits
19 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 26e8f1e2c1 | |||
| 110eddba08 | |||
| 1dc6315ac2 | |||
| 0be5a0bf3d | |||
| 187a273309 | |||
| 1264a11140 | |||
| c2c4fc96a5 | |||
| 7d01fe89bc | |||
| c6a7938a3e | |||
| 41ba5c8e4f | |||
| 41b6f04db6 | |||
| 470f47f8bb | |||
| 8df4e21501 | |||
| ee87a6269e | |||
| 2d76e799a4 | |||
| f24520ea89 | |||
| 5072728118 | |||
| bb4df0c47f | |||
| 101533cddd |
66
.gitea/workflows/default_nottags.yaml
Normal file
66
.gitea/workflows/default_nottags.yaml
Normal file
@ -0,0 +1,66 @@
|
||||
name: Default (not tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags-ignore:
|
||||
- '**'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Install pnpm and npmci
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
|
||||
- name: Run npm prepare
|
||||
run: npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
124
.gitea/workflows/default_tags.yaml
Normal file
124
.gitea/workflows/default_tags.yaml
Normal file
@ -0,0 +1,124 @@
|
||||
name: Default (tags)
|
||||
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- '*'
|
||||
|
||||
env:
|
||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
||||
|
||||
jobs:
|
||||
security:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Audit production dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --prod
|
||||
continue-on-error: true
|
||||
|
||||
- name: Audit development dependencies
|
||||
run: |
|
||||
npmci command npm config set registry https://registry.npmjs.org
|
||||
npmci command pnpm audit --audit-level=high --dev
|
||||
continue-on-error: true
|
||||
|
||||
test:
|
||||
if: ${{ always() }}
|
||||
needs: security
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Test stable
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm test
|
||||
|
||||
- name: Test build
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
npmci npm build
|
||||
|
||||
release:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Release
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm publish
|
||||
|
||||
metadata:
|
||||
needs: test
|
||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
||||
runs-on: ubuntu-latest
|
||||
container:
|
||||
image: ${{ env.IMAGE }}
|
||||
continue-on-error: true
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Prepare
|
||||
run: |
|
||||
pnpm install -g pnpm
|
||||
pnpm install -g @shipzone/npmci
|
||||
npmci npm prepare
|
||||
|
||||
- name: Code quality
|
||||
run: |
|
||||
npmci command npm install -g typescript
|
||||
npmci npm install
|
||||
|
||||
- name: Trigger
|
||||
run: npmci trigger
|
||||
|
||||
- name: Build docs and upload artifacts
|
||||
run: |
|
||||
npmci node install stable
|
||||
npmci npm install
|
||||
pnpm install -g @gitzone/tsdoc
|
||||
npmci command tsdoc
|
||||
continue-on-error: true
|
||||
137
.gitlab-ci.yml
137
.gitlab-ci.yml
@ -1,137 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
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 --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g tslint typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
24
.vscode/launch.json
vendored
24
.vscode/launch.json
vendored
@ -2,28 +2,10 @@
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "current file",
|
||||
"type": "node",
|
||||
"command": "npm test",
|
||||
"name": "Run npm test",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"${relativeFile}"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
},
|
||||
{
|
||||
"name": "test.ts",
|
||||
"type": "node",
|
||||
"request": "launch",
|
||||
"args": [
|
||||
"test/test.ts"
|
||||
],
|
||||
"runtimeArgs": ["-r", "@gitzone/tsrun"],
|
||||
"cwd": "${workspaceRoot}",
|
||||
"protocol": "inspector",
|
||||
"internalConsoleOptions": "openOnSessionStart"
|
||||
"type": "node-terminal"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -3,10 +3,10 @@
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartrouter",
|
||||
"shortDescription": "a router for routing on websites",
|
||||
"npmPackagename": "@pushrocks/smartrouter",
|
||||
"description": "a router for routing on websites",
|
||||
"npmPackagename": "@push.rocks/smartrouter",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
}
|
||||
|
||||
27090
package-lock.json
generated
27090
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
22
package.json
22
package.json
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@pushrocks/smartrouter",
|
||||
"version": "1.0.8",
|
||||
"name": "@push.rocks/smartrouter",
|
||||
"version": "1.0.17",
|
||||
"private": false,
|
||||
"description": "a router for routing on websites",
|
||||
"main": "dist_ts/index.js",
|
||||
@ -10,16 +10,15 @@
|
||||
"scripts": {
|
||||
"test": "(tstest test/)",
|
||||
"build": "(tsbuild --web && tsbundle npm --web)",
|
||||
"format": "(gitzone format)"
|
||||
"format": "(gitzone format)",
|
||||
"buildDocs": "tsdoc"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@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"
|
||||
"@git.zone/tsbuild": "^2.1.70",
|
||||
"@git.zone/tsbundle": "^2.0.7",
|
||||
"@git.zone/tstest": "^1.0.81",
|
||||
"@push.rocks/tapbundle": "^5.0.15",
|
||||
"@types/node": "^20.6.0"
|
||||
},
|
||||
"dependencies": {
|
||||
"path-to-regexp": "^6.2.0"
|
||||
@ -38,5 +37,6 @@
|
||||
],
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
]
|
||||
],
|
||||
"type": "module"
|
||||
}
|
||||
|
||||
5696
pnpm-lock.yaml
generated
Normal file
5696
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
30
readme.md
30
readme.md
@ -1,27 +1,26 @@
|
||||
# @pushrocks/smartrouter
|
||||
# @push.rocks/smartrouter
|
||||
a router for routing on websites
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartrouter)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartrouter)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/smartrouter)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/smartrouter/)
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@push.rocks/smartrouter)
|
||||
* [gitlab.com (source)](https://gitlab.com/push.rocks/smartrouter)
|
||||
* [github.com (source mirror)](https://github.com/push.rocks/smartrouter)
|
||||
* [docs (typedoc)](https://push.rocks.gitlab.io/smartrouter/)
|
||||
|
||||
## Status for master
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
|
||||
## Usage
|
||||
|
||||
@ -33,7 +32,6 @@ We are always happy for code contributions. If you are not the code contributing
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
## Legal
|
||||
> MIT licensed | **©** [Task Venture Capital GmbH](https://task.vc)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
|
||||
@ -1,17 +1,17 @@
|
||||
import { expect, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartrouter from '../ts/index';
|
||||
import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartrouter from '../ts/index.js';
|
||||
|
||||
let testrouter: smartrouter.SmartRouter;
|
||||
|
||||
tap.test('first test', async () => {
|
||||
testrouter = new smartrouter.SmartRouter({});
|
||||
expect(testrouter).to.be.instanceOf(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).to.equal('hello');
|
||||
expect(routeInfoArg.params.any).toEqual('hello');
|
||||
done.resolve();
|
||||
});
|
||||
testrouter.pushUrl('/myawesomeroute/hello');
|
||||
@ -21,26 +21,26 @@ tap.test('should handle a route change', async (toolsArg) => {
|
||||
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');
|
||||
expect(routeInfoArg.params.wow).toEqual('hello2');
|
||||
done.resolve();
|
||||
});
|
||||
testrouter.pushUrl('/myawesomeroute2/hello2');
|
||||
await done.promise;
|
||||
expect(window.location.href).to.equal('http://localhost:3007/myawesomeroute2/hello2');
|
||||
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).to.equal('hello2');
|
||||
expect(routeInfoArg.queryParams.aparam).to.equal('Yes');
|
||||
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))
|
||||
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');
|
||||
})
|
||||
expect(window.location.href).toEqual('http://localhost:3007/myawesomeroute2/hello2?aparam=Yes');
|
||||
});
|
||||
|
||||
tap.start();
|
||||
|
||||
8
ts/00_commitinfo_data.ts
Normal file
8
ts/00_commitinfo_data.ts
Normal file
@ -0,0 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartrouter',
|
||||
version: '1.0.17',
|
||||
description: 'a router for routing on websites'
|
||||
}
|
||||
100
ts/index.ts
100
ts/index.ts
@ -1,99 +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;
|
||||
}
|
||||
|
||||
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,
|
||||
};
|
||||
|
||||
/**
|
||||
* 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;
|
||||
const urlSearchParams = new URLSearchParams(window.location.search);
|
||||
|
||||
// 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: Object.fromEntries(urlSearchParams.entries()),
|
||||
} as IRouteInfo); // not waiting here
|
||||
}
|
||||
}
|
||||
}
|
||||
export * from './smartrouter.classes.smartrouter.js';
|
||||
|
||||
35
ts/smartrouter.classes.queryparams.ts
Normal file
35
ts/smartrouter.classes.queryparams.ts
Normal file
@ -0,0 +1,35 @@
|
||||
import * as plugins from './smartrouter.plugins.js';
|
||||
|
||||
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];
|
||||
}
|
||||
}
|
||||
99
ts/smartrouter.classes.smartrouter.ts
Normal file
99
ts/smartrouter.classes.smartrouter.ts
Normal file
@ -0,0 +1,99 @@
|
||||
import * as plugins from './smartrouter.plugins.js';
|
||||
|
||||
import { QueryParams } from './smartrouter.classes.queryparams.js';
|
||||
|
||||
const routeLog = (message: string) => {
|
||||
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();
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
}
|
||||
}
|
||||
}
|
||||
14
tsconfig.json
Normal file
14
tsconfig.json
Normal file
@ -0,0 +1,14 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
17
tslint.json
17
tslint.json
@ -1,17 +0,0 @@
|
||||
{
|
||||
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||
"rules": {
|
||||
"semicolon": [true, "always"],
|
||||
"no-console": false,
|
||||
"ordered-imports": false,
|
||||
"object-literal-sort-keys": false,
|
||||
"member-ordering": {
|
||||
"options":{
|
||||
"order": [
|
||||
"static-method"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"defaultSeverity": "warning"
|
||||
}
|
||||
Reference in New Issue
Block a user