2022-06-21 00:18:06 -05:00
|
|
|
// NIRAX --- A lightweight router
|
|
|
|
|
2022-06-20 03:38:49 -05:00
|
|
|
import { EventEmitter } from 'eventemitter3';
|
2023-07-08 01:30:36 -05:00
|
|
|
import { Component, onMounted, shallowRef, ShallowRef } from 'vue';
|
2022-07-13 04:11:54 -05:00
|
|
|
import { safeURIDecode } from '@/scripts/safe-uri-decode';
|
2022-06-20 03:38:49 -05:00
|
|
|
|
|
|
|
type RouteDef = {
|
|
|
|
path: string;
|
|
|
|
component: Component;
|
|
|
|
query?: Record<string, string>;
|
2022-06-29 04:26:06 -05:00
|
|
|
loginRequired?: boolean;
|
2022-06-20 03:38:49 -05:00
|
|
|
name?: string;
|
2022-06-29 02:00:00 -05:00
|
|
|
hash?: string;
|
2022-06-20 03:38:49 -05:00
|
|
|
globalCacheKey?: string;
|
2022-07-20 05:59:27 -05:00
|
|
|
children?: RouteDef[];
|
2022-06-20 03:38:49 -05:00
|
|
|
};
|
|
|
|
|
|
|
|
type ParsedPath = (string | {
|
|
|
|
name: string;
|
|
|
|
startsWith?: string;
|
|
|
|
wildcard?: boolean;
|
|
|
|
optional?: boolean;
|
|
|
|
})[];
|
|
|
|
|
2023-07-07 18:58:35 -05:00
|
|
|
export type Resolved = { route: RouteDef; props: Map<string, string | boolean>; child?: Resolved; };
|
2022-07-20 05:59:27 -05:00
|
|
|
|
2022-06-20 03:38:49 -05:00
|
|
|
function parsePath(path: string): ParsedPath {
|
|
|
|
const res = [] as ParsedPath;
|
|
|
|
|
|
|
|
path = path.substring(1);
|
|
|
|
|
|
|
|
for (const part of path.split('/')) {
|
|
|
|
if (part.includes(':')) {
|
|
|
|
const prefix = part.substring(0, part.indexOf(':'));
|
|
|
|
const placeholder = part.substring(part.indexOf(':') + 1);
|
|
|
|
const wildcard = placeholder.includes('(*)');
|
|
|
|
const optional = placeholder.endsWith('?');
|
|
|
|
res.push({
|
|
|
|
name: placeholder.replace('(*)', '').replace('?', ''),
|
|
|
|
startsWith: prefix !== '' ? prefix : undefined,
|
|
|
|
wildcard,
|
|
|
|
optional,
|
|
|
|
});
|
2022-06-23 11:26:15 -05:00
|
|
|
} else if (part.length !== 0) {
|
2022-06-20 03:38:49 -05:00
|
|
|
res.push(part);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return res;
|
|
|
|
}
|
|
|
|
|
2023-07-17 03:46:32 -05:00
|
|
|
export type NiraxChangeEvent = {
|
|
|
|
beforePath: string;
|
|
|
|
path: string;
|
|
|
|
resolved: Resolved;
|
|
|
|
key: string;
|
|
|
|
};
|
|
|
|
|
|
|
|
export type NiraxExportEvent = {
|
|
|
|
path: string;
|
|
|
|
key: string;
|
|
|
|
};
|
|
|
|
|
|
|
|
export type NiraxPushEvent = {
|
|
|
|
beforePath: string;
|
|
|
|
path: string;
|
|
|
|
route: RouteDef | null;
|
|
|
|
props: Map<string, string> | null;
|
|
|
|
key: string;
|
|
|
|
};
|
|
|
|
|
2022-06-20 03:38:49 -05:00
|
|
|
export class Router extends EventEmitter<{
|
2023-07-17 03:46:32 -05:00
|
|
|
change: (ctx: NiraxChangeEvent) => void;
|
|
|
|
replace: (ctx: NiraxExportEvent) => void;
|
|
|
|
push: (ctx: NiraxExportEvent) => void;
|
2022-07-05 08:25:27 -05:00
|
|
|
same: () => void;
|
2022-06-20 03:38:49 -05:00
|
|
|
}> {
|
|
|
|
private routes: RouteDef[];
|
2022-07-20 05:59:27 -05:00
|
|
|
public current: Resolved;
|
|
|
|
public currentRef: ShallowRef<Resolved> = shallowRef();
|
|
|
|
public currentRoute: ShallowRef<RouteDef> = shallowRef();
|
2022-06-20 03:38:49 -05:00
|
|
|
private currentPath: string;
|
2023-07-07 18:58:35 -05:00
|
|
|
private isLoggedIn: boolean;
|
|
|
|
private notFoundPageComponent: Component;
|
2022-06-20 03:38:49 -05:00
|
|
|
private currentKey = Date.now().toString();
|
|
|
|
|
2022-07-16 15:12:22 -05:00
|
|
|
public navHook: ((path: string, flag?: any) => boolean) | null = null;
|
2022-06-20 03:38:49 -05:00
|
|
|
|
2023-07-07 18:58:35 -05:00
|
|
|
constructor(routes: Router['routes'], currentPath: Router['currentPath'], isLoggedIn: boolean, notFoundPageComponent: Component) {
|
2022-06-20 03:38:49 -05:00
|
|
|
super();
|
|
|
|
|
|
|
|
this.routes = routes;
|
|
|
|
this.currentPath = currentPath;
|
2023-07-07 18:58:35 -05:00
|
|
|
this.isLoggedIn = isLoggedIn;
|
|
|
|
this.notFoundPageComponent = notFoundPageComponent;
|
2022-07-20 05:59:27 -05:00
|
|
|
this.navigate(currentPath, null, false);
|
2022-06-20 03:38:49 -05:00
|
|
|
}
|
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
public resolve(path: string): Resolved | null {
|
2022-06-20 03:38:49 -05:00
|
|
|
let queryString: string | null = null;
|
2022-06-29 02:00:00 -05:00
|
|
|
let hash: string | null = null;
|
2022-06-20 03:38:49 -05:00
|
|
|
if (path[0] === '/') path = path.substring(1);
|
2022-06-29 02:00:00 -05:00
|
|
|
if (path.includes('#')) {
|
|
|
|
hash = path.substring(path.indexOf('#') + 1);
|
|
|
|
path = path.substring(0, path.indexOf('#'));
|
|
|
|
}
|
2022-06-20 03:38:49 -05:00
|
|
|
if (path.includes('?')) {
|
|
|
|
queryString = path.substring(path.indexOf('?') + 1);
|
|
|
|
path = path.substring(0, path.indexOf('?'));
|
|
|
|
}
|
|
|
|
|
|
|
|
if (_DEV_) console.log('Routing: ', path, queryString);
|
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
function check(routes: RouteDef[], _parts: string[]): Resolved | null {
|
|
|
|
forEachRouteLoop:
|
|
|
|
for (const route of routes) {
|
2022-12-12 04:27:47 -06:00
|
|
|
let parts = [..._parts];
|
2022-07-20 05:59:27 -05:00
|
|
|
const props = new Map<string, string>();
|
2022-06-20 03:38:49 -05:00
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
pathMatchLoop:
|
|
|
|
for (const p of parsePath(route.path)) {
|
|
|
|
if (typeof p === 'string') {
|
|
|
|
if (p === parts[0]) {
|
|
|
|
parts.shift();
|
|
|
|
} else {
|
|
|
|
continue forEachRouteLoop;
|
2022-06-20 03:38:49 -05:00
|
|
|
}
|
|
|
|
} else {
|
2022-07-20 05:59:27 -05:00
|
|
|
if (parts[0] == null && !p.optional) {
|
|
|
|
continue forEachRouteLoop;
|
|
|
|
}
|
|
|
|
if (p.wildcard) {
|
|
|
|
if (parts.length !== 0) {
|
|
|
|
props.set(p.name, safeURIDecode(parts.join('/')));
|
|
|
|
parts = [];
|
|
|
|
}
|
|
|
|
break pathMatchLoop;
|
2022-06-21 00:12:39 -05:00
|
|
|
} else {
|
2022-07-20 05:59:27 -05:00
|
|
|
if (p.startsWith) {
|
|
|
|
if (parts[0] == null || !parts[0].startsWith(p.startsWith)) continue forEachRouteLoop;
|
|
|
|
|
|
|
|
props.set(p.name, safeURIDecode(parts[0].substring(p.startsWith.length)));
|
|
|
|
parts.shift();
|
|
|
|
} else {
|
|
|
|
if (parts[0]) {
|
|
|
|
props.set(p.name, safeURIDecode(parts[0]));
|
|
|
|
}
|
|
|
|
parts.shift();
|
2022-07-13 04:28:04 -05:00
|
|
|
}
|
2022-06-21 00:12:39 -05:00
|
|
|
}
|
2022-06-20 03:38:49 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
if (parts.length === 0) {
|
|
|
|
if (route.children) {
|
|
|
|
const child = check(route.children, []);
|
|
|
|
if (child) {
|
|
|
|
return {
|
|
|
|
route,
|
|
|
|
props,
|
|
|
|
child,
|
|
|
|
};
|
|
|
|
} else {
|
|
|
|
continue forEachRouteLoop;
|
|
|
|
}
|
|
|
|
}
|
2022-06-20 03:38:49 -05:00
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
if (route.hash != null && hash != null) {
|
|
|
|
props.set(route.hash, safeURIDecode(hash));
|
|
|
|
}
|
2023-07-07 17:08:16 -05:00
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
if (route.query != null && queryString != null) {
|
|
|
|
const queryObject = [...new URLSearchParams(queryString).entries()]
|
|
|
|
.reduce((obj, entry) => ({ ...obj, [entry[0]]: entry[1] }), {});
|
2023-07-07 17:08:16 -05:00
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
for (const q in route.query) {
|
|
|
|
const as = route.query[q];
|
|
|
|
if (queryObject[q]) {
|
|
|
|
props.set(as, safeURIDecode(queryObject[q]));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2023-07-07 17:08:16 -05:00
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
return {
|
|
|
|
route,
|
|
|
|
props,
|
|
|
|
};
|
|
|
|
} else {
|
|
|
|
if (route.children) {
|
|
|
|
const child = check(route.children, parts);
|
|
|
|
if (child) {
|
|
|
|
return {
|
|
|
|
route,
|
|
|
|
props,
|
|
|
|
child,
|
|
|
|
};
|
|
|
|
} else {
|
|
|
|
continue forEachRouteLoop;
|
|
|
|
}
|
|
|
|
} else {
|
|
|
|
continue forEachRouteLoop;
|
2022-06-20 03:38:49 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2022-06-29 02:00:00 -05:00
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
return null;
|
2022-06-20 03:38:49 -05:00
|
|
|
}
|
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
const _parts = path.split('/').filter(part => part.length !== 0);
|
|
|
|
|
|
|
|
return check(this.routes, _parts);
|
2022-06-20 03:38:49 -05:00
|
|
|
}
|
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
private navigate(path: string, key: string | null | undefined, emitChange = true) {
|
2022-06-20 03:38:49 -05:00
|
|
|
const beforePath = this.currentPath;
|
|
|
|
this.currentPath = path;
|
|
|
|
|
|
|
|
const res = this.resolve(this.currentPath);
|
|
|
|
|
|
|
|
if (res == null) {
|
|
|
|
throw new Error('no route found for: ' + path);
|
|
|
|
}
|
|
|
|
|
2023-07-07 18:58:35 -05:00
|
|
|
if (res.route.loginRequired && !this.isLoggedIn) {
|
|
|
|
res.route.component = this.notFoundPageComponent;
|
|
|
|
res.props.set('showLoginPopup', true);
|
2022-06-29 04:26:06 -05:00
|
|
|
}
|
|
|
|
|
2022-06-20 03:38:49 -05:00
|
|
|
const isSamePath = beforePath === path;
|
|
|
|
if (isSamePath && key == null) key = this.currentKey;
|
2022-07-20 05:59:27 -05:00
|
|
|
this.current = res;
|
|
|
|
this.currentRef.value = res;
|
2022-06-20 03:38:49 -05:00
|
|
|
this.currentRoute.value = res.route;
|
2022-07-20 05:59:27 -05:00
|
|
|
this.currentKey = res.route.globalCacheKey ?? key ?? path;
|
2022-06-20 03:38:49 -05:00
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
if (emitChange) {
|
2022-06-20 03:38:49 -05:00
|
|
|
this.emit('change', {
|
|
|
|
beforePath,
|
|
|
|
path,
|
2022-07-20 05:59:27 -05:00
|
|
|
resolved: res,
|
2022-06-20 03:38:49 -05:00
|
|
|
key: this.currentKey,
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2022-07-20 05:59:27 -05:00
|
|
|
return res;
|
2022-06-20 03:38:49 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
public getCurrentPath() {
|
|
|
|
return this.currentPath;
|
|
|
|
}
|
|
|
|
|
|
|
|
public getCurrentKey() {
|
|
|
|
return this.currentKey;
|
|
|
|
}
|
|
|
|
|
2022-07-16 15:12:22 -05:00
|
|
|
public push(path: string, flag?: any) {
|
2022-07-05 08:25:27 -05:00
|
|
|
const beforePath = this.currentPath;
|
|
|
|
if (path === beforePath) {
|
|
|
|
this.emit('same');
|
|
|
|
return;
|
|
|
|
}
|
2022-06-28 03:59:23 -05:00
|
|
|
if (this.navHook) {
|
2022-07-16 15:12:22 -05:00
|
|
|
const cancel = this.navHook(path, flag);
|
2022-06-28 03:59:23 -05:00
|
|
|
if (cancel) return;
|
|
|
|
}
|
2022-07-20 05:59:27 -05:00
|
|
|
const res = this.navigate(path, null);
|
2022-06-20 03:38:49 -05:00
|
|
|
this.emit('push', {
|
|
|
|
beforePath,
|
|
|
|
path,
|
2022-07-20 05:59:27 -05:00
|
|
|
route: res.route,
|
|
|
|
props: res.props,
|
2022-06-20 03:38:49 -05:00
|
|
|
key: this.currentKey,
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
2023-07-08 01:30:36 -05:00
|
|
|
public replace(path: string, key?: string | null) {
|
2022-06-20 03:38:49 -05:00
|
|
|
this.navigate(path, key);
|
|
|
|
}
|
|
|
|
}
|