@wot-ui/router 0.0.4 → 0.0.19

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-PRESENT KeJun
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.cjs

@@ -68,21 +68,16 @@ function createRouter(options) {
 		if (typeof to === "string") return resolvePath(to);
 		if (to.name) {
 			const route = routes.find((r) => r.name === to.name);
-			if (!route) {
-				console.warn(`[router] Route with name '${to.name}' not found`);
-				return {
-					...START_LOCATION_NORMALIZED,
-					path: "/"
-				};
-			}
+			if (!route) throw new Error(`您正在尝试访问的路由 '${to.name}' 未在路由表中定义。请检查您的路由配置。`);
 			const path = fillParams(route.path, to.params);
+			const finalQuery = to.params || {};
 			return {
 				path,
 				name: to.name,
 				params: to.params || {},
-				query: to.query || {},
+				query: finalQuery,
 				hash: to.hash || "",
-				fullPath: stringifyQuery(path, to.query || {}),
+				fullPath: stringifyQuery(path, finalQuery),
 				meta: route.meta || {}
 			};
 		}
@@ -92,6 +87,7 @@ function createRouter(options) {
 	function resolvePath(path, query) {
 		const normalizedPath = normalizeUrl(path.split("?")[0]);
 		const route = routes.find((r) => r.path === normalizedPath || r.aliasPath === normalizedPath);
+		if (!route) throw new Error(`您正在尝试访问的路由 '${normalizedPath}' 未在路由表中定义。请检查您的路由配置。`);
 		const finalQuery = {
 			...getUrlParams(path),
 			...query || {}
@@ -128,57 +124,82 @@ function createRouter(options) {
 		if (back$1 === void 0 || typeof back$1 === "number") uni.navigateBack({ delta: back$1 ?? 1 });
 		else uni.navigateBack(back$1);
 	}
-	async function navigate(to, type) {
+	async function navigate(to, type, skipGuards = false) {
 		const targetLocation = resolve(to);
 		const fromLocation = (0, vue.unref)(currentRoute);
-		try {
+		if (!skipGuards) try {
 			await runGuardQueue(beforeGuards, targetLocation, fromLocation);
 		} catch (error) {
 			if (error && (error.message === "NavigationCancelled" || error.message === "NavigationRedirect")) {
-				if (error.message === "NavigationRedirect" && error.to) return navigate(error.to, type);
+				if (error.message === "NavigationRedirect" && error.to) return navigate(error.to, type, true);
 				return Promise.reject(error);
 			}
 			return Promise.reject(error);
 		}
 		const url = targetLocation.fullPath;
-		performUniNavigate(typeof to === "object" && to.navType || type || "push", url);
-		currentRoute.value = targetLocation;
-		afterGuards.forEach((guard) => guard(targetLocation, fromLocation));
-		return Promise.resolve();
+		const finalType = typeof to === "object" && to.navType || type || "push";
+		try {
+			await performUniNavigate(finalType, url);
+			currentRoute.value = targetLocation;
+			afterGuards.forEach((guard) => guard(targetLocation, fromLocation));
+			return Promise.resolve();
+		} catch (error) {
+			return Promise.reject(error);
+		}
 	}
 	function performUniNavigate(type, url) {
-		switch (type) {
-			case "push":
-				uni.navigateTo({ url });
-				break;
-			case "replace":
-				uni.redirectTo({ url });
-				break;
-			case "pushTab":
-				uni.switchTab({ url });
-				break;
-			case "replaceAll":
-				uni.reLaunch({ url });
-				break;
-			case "back":
-				uni.navigateBack({});
-				break;
-			default: uni.navigateTo({ url });
-		}
+		return new Promise((resolve$1, reject) => {
+			const success = () => resolve$1();
+			const fail = (error) => {
+				reject(/* @__PURE__ */ new Error(`Navigation failed: ${error.message || error.errMsg || "Unknown error"}`));
+			};
+			switch (type) {
+				case "push":
+					uni.navigateTo({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "replace":
+					uni.redirectTo({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "pushTab":
+					uni.switchTab({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "replaceAll":
+					uni.reLaunch({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "back":
+					uni.navigateBack({
+						success,
+						fail
+					});
+					break;
+				default: uni.navigateTo({
+					url,
+					success,
+					fail
+				});
+			}
+		});
 	}
 	async function runGuardQueue(guards, to, from) {
 		for (const guard of guards) await new Promise((resolve$1, reject) => {
 			const next = (val) => {
-				if (val === false) reject(/* @__PURE__ */ new Error("NavigationCancelled"));
-				else if (val === void 0) resolve$1();
-				else {
-					const error = /* @__PURE__ */ new Error("NavigationRedirect");
-					error.to = val;
-					reject(error);
-				}
-			};
-			const res = guard(to, from, next);
-			if (res instanceof Promise) res.then((val) => {
+				next._called = true;
 				if (val === false) reject(/* @__PURE__ */ new Error("NavigationCancelled"));
 				else if (val === void 0 || val === true) resolve$1();
 				else {
@@ -186,14 +207,26 @@ function createRouter(options) {
 					error.to = val;
 					reject(error);
 				}
-			}).catch(reject);
-			else if (res !== void 0 && typeof res !== "function") if (res === false) reject(/* @__PURE__ */ new Error("NavigationCancelled"));
-			else if (res === true) resolve$1();
+			};
+			const guardReturn = guard(to, from, next);
+			let guardCall = Promise.resolve(guardReturn);
+			if (guard.length < 3) guardCall = guardCall.then(next);
 			else {
-				const error = /* @__PURE__ */ new Error("NavigationRedirect");
-				error.to = res;
-				reject(error);
+				const message = `The "next" callback was never called inside of ${guard.name ? `"${guard.name}"` : ""}:\n${guard.toString()}\n. If you are returning a value instead of calling "next", make sure to remove the "next" parameter from your function.`;
+				if (guardReturn !== null && typeof guardReturn === "object" && "then" in guardReturn) guardCall = guardCall.then((resolvedValue) => {
+					if (!next._called) {
+						console.warn(message);
+						return Promise.reject(/* @__PURE__ */ new Error("Invalid navigation guard"));
+					}
+					return resolvedValue;
+				});
+				else if (!next._called) {
+					console.warn(message);
+					reject(/* @__PURE__ */ new Error("Invalid navigation guard"));
+					return;
+				}
 			}
+			guardCall.catch((err) => reject(err));
 		});
 	}
 	function beforeEach(guard) {
@@ -237,6 +270,7 @@ function createRouter(options) {
 			if (router$1.currentRoute.value.path === newPath) return;
 			const from = (0, vue.unref)(router$1.currentRoute);
 			const matched = router$1.routes.find((r) => r.path === newPath || r.aliasPath === newPath);
+			if (!matched) console.warn(`[router] 路由 '${newPath}' 未在路由表中定义，但页面已加载。请检查您的路由配置。`);
 			const to = {
 				path: newPath,
 				name: matched?.name,

package/dist/index.d.cts

@@ -43,7 +43,7 @@ type RouteLocationRaw = string | {
 interface RouterOptions {
   routes: RouteRecordRaw[];
 }
-type NavigationGuardNext = (to?: RouteLocationRaw | false | void) => void;
+type NavigationGuardNext = (to?: RouteLocationRaw | false | true | void) => void;
 type NavigationGuard = (to: RouteLocationNormalized, from: RouteLocationNormalized, next: NavigationGuardNext) => Promise<void | RouteLocationRaw | false | boolean> | void | RouteLocationRaw | false | boolean;
 type NavigationHookAfter = (to: RouteLocationNormalized, from: RouteLocationNormalized) => void;
 type NavType = 'push' | 'replace' | 'replaceAll' | 'pushTab' | 'back';

package/dist/index.d.mts

@@ -43,7 +43,7 @@ type RouteLocationRaw = string | {
 interface RouterOptions {
   routes: RouteRecordRaw[];
 }
-type NavigationGuardNext = (to?: RouteLocationRaw | false | void) => void;
+type NavigationGuardNext = (to?: RouteLocationRaw | false | true | void) => void;
 type NavigationGuard = (to: RouteLocationNormalized, from: RouteLocationNormalized, next: NavigationGuardNext) => Promise<void | RouteLocationRaw | false | boolean> | void | RouteLocationRaw | false | boolean;
 type NavigationHookAfter = (to: RouteLocationNormalized, from: RouteLocationNormalized) => void;
 type NavType = 'push' | 'replace' | 'replaceAll' | 'pushTab' | 'back';

package/dist/index.mjs

@@ -68,21 +68,16 @@ function createRouter(options) {
 		if (typeof to === "string") return resolvePath(to);
 		if (to.name) {
 			const route = routes.find((r) => r.name === to.name);
-			if (!route) {
-				console.warn(`[router] Route with name '${to.name}' not found`);
-				return {
-					...START_LOCATION_NORMALIZED,
-					path: "/"
-				};
-			}
+			if (!route) throw new Error(`您正在尝试访问的路由 '${to.name}' 未在路由表中定义。请检查您的路由配置。`);
 			const path = fillParams(route.path, to.params);
+			const finalQuery = to.params || {};
 			return {
 				path,
 				name: to.name,
 				params: to.params || {},
-				query: to.query || {},
+				query: finalQuery,
 				hash: to.hash || "",
-				fullPath: stringifyQuery(path, to.query || {}),
+				fullPath: stringifyQuery(path, finalQuery),
 				meta: route.meta || {}
 			};
 		}
@@ -92,6 +87,7 @@ function createRouter(options) {
 	function resolvePath(path, query) {
 		const normalizedPath = normalizeUrl(path.split("?")[0]);
 		const route = routes.find((r) => r.path === normalizedPath || r.aliasPath === normalizedPath);
+		if (!route) throw new Error(`您正在尝试访问的路由 '${normalizedPath}' 未在路由表中定义。请检查您的路由配置。`);
 		const finalQuery = {
 			...getUrlParams(path),
 			...query || {}
@@ -128,57 +124,82 @@ function createRouter(options) {
 		if (back$1 === void 0 || typeof back$1 === "number") uni.navigateBack({ delta: back$1 ?? 1 });
 		else uni.navigateBack(back$1);
 	}
-	async function navigate(to, type) {
+	async function navigate(to, type, skipGuards = false) {
 		const targetLocation = resolve(to);
 		const fromLocation = unref(currentRoute);
-		try {
+		if (!skipGuards) try {
 			await runGuardQueue(beforeGuards, targetLocation, fromLocation);
 		} catch (error) {
 			if (error && (error.message === "NavigationCancelled" || error.message === "NavigationRedirect")) {
-				if (error.message === "NavigationRedirect" && error.to) return navigate(error.to, type);
+				if (error.message === "NavigationRedirect" && error.to) return navigate(error.to, type, true);
 				return Promise.reject(error);
 			}
 			return Promise.reject(error);
 		}
 		const url = targetLocation.fullPath;
-		performUniNavigate(typeof to === "object" && to.navType || type || "push", url);
-		currentRoute.value = targetLocation;
-		afterGuards.forEach((guard) => guard(targetLocation, fromLocation));
-		return Promise.resolve();
+		const finalType = typeof to === "object" && to.navType || type || "push";
+		try {
+			await performUniNavigate(finalType, url);
+			currentRoute.value = targetLocation;
+			afterGuards.forEach((guard) => guard(targetLocation, fromLocation));
+			return Promise.resolve();
+		} catch (error) {
+			return Promise.reject(error);
+		}
 	}
 	function performUniNavigate(type, url) {
-		switch (type) {
-			case "push":
-				uni.navigateTo({ url });
-				break;
-			case "replace":
-				uni.redirectTo({ url });
-				break;
-			case "pushTab":
-				uni.switchTab({ url });
-				break;
-			case "replaceAll":
-				uni.reLaunch({ url });
-				break;
-			case "back":
-				uni.navigateBack({});
-				break;
-			default: uni.navigateTo({ url });
-		}
+		return new Promise((resolve$1, reject) => {
+			const success = () => resolve$1();
+			const fail = (error) => {
+				reject(/* @__PURE__ */ new Error(`Navigation failed: ${error.message || error.errMsg || "Unknown error"}`));
+			};
+			switch (type) {
+				case "push":
+					uni.navigateTo({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "replace":
+					uni.redirectTo({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "pushTab":
+					uni.switchTab({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "replaceAll":
+					uni.reLaunch({
+						url,
+						success,
+						fail
+					});
+					break;
+				case "back":
+					uni.navigateBack({
+						success,
+						fail
+					});
+					break;
+				default: uni.navigateTo({
+					url,
+					success,
+					fail
+				});
+			}
+		});
 	}
 	async function runGuardQueue(guards, to, from) {
 		for (const guard of guards) await new Promise((resolve$1, reject) => {
 			const next = (val) => {
-				if (val === false) reject(/* @__PURE__ */ new Error("NavigationCancelled"));
-				else if (val === void 0) resolve$1();
-				else {
-					const error = /* @__PURE__ */ new Error("NavigationRedirect");
-					error.to = val;
-					reject(error);
-				}
-			};
-			const res = guard(to, from, next);
-			if (res instanceof Promise) res.then((val) => {
+				next._called = true;
 				if (val === false) reject(/* @__PURE__ */ new Error("NavigationCancelled"));
 				else if (val === void 0 || val === true) resolve$1();
 				else {
@@ -186,14 +207,26 @@ function createRouter(options) {
 					error.to = val;
 					reject(error);
 				}
-			}).catch(reject);
-			else if (res !== void 0 && typeof res !== "function") if (res === false) reject(/* @__PURE__ */ new Error("NavigationCancelled"));
-			else if (res === true) resolve$1();
+			};
+			const guardReturn = guard(to, from, next);
+			let guardCall = Promise.resolve(guardReturn);
+			if (guard.length < 3) guardCall = guardCall.then(next);
 			else {
-				const error = /* @__PURE__ */ new Error("NavigationRedirect");
-				error.to = res;
-				reject(error);
+				const message = `The "next" callback was never called inside of ${guard.name ? `"${guard.name}"` : ""}:\n${guard.toString()}\n. If you are returning a value instead of calling "next", make sure to remove the "next" parameter from your function.`;
+				if (guardReturn !== null && typeof guardReturn === "object" && "then" in guardReturn) guardCall = guardCall.then((resolvedValue) => {
+					if (!next._called) {
+						console.warn(message);
+						return Promise.reject(/* @__PURE__ */ new Error("Invalid navigation guard"));
+					}
+					return resolvedValue;
+				});
+				else if (!next._called) {
+					console.warn(message);
+					reject(/* @__PURE__ */ new Error("Invalid navigation guard"));
+					return;
+				}
 			}
+			guardCall.catch((err) => reject(err));
 		});
 	}
 	function beforeEach(guard) {
@@ -237,6 +270,7 @@ function createRouter(options) {
 			if (router$1.currentRoute.value.path === newPath) return;
 			const from = unref(router$1.currentRoute);
 			const matched = router$1.routes.find((r) => r.path === newPath || r.aliasPath === newPath);
+			if (!matched) console.warn(`[router] 路由 '${newPath}' 未在路由表中定义，但页面已加载。请检查您的路由配置。`);
 			const to = {
 				path: newPath,
 				name: matched?.name,

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@wot-ui/router",
-  "version": "0.0.4",
+  "version": "0.0.19",
   "description": "轻量级 uni-app vue3 路由库",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wot-ui/my-uni.git",
+    "directory": "packages/router"
+  },
   "type": "module",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -15,16 +20,9 @@
   },
   "unpkg": "dist/index.global.js",
   "jsdelivr": "dist/index.global.js",
-  "packageManager": "pnpm@9.9.0",
   "files": [
     "dist"
   ],
-  "scripts": {
-    "clean": "rimraf dist",
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "lint": "eslint --fix --ext .json,.js,.ts src"
-  },
   "license": "MIT",
   "keywords": [
     "uni-app",
@@ -42,19 +40,34 @@
     "@types/node": "^20.16.2",
     "@typescript-eslint/eslint-plugin": "^5.54.1",
     "@typescript-eslint/parser": "^5.54.1",
+    "@vitejs/plugin-vue": "^6.0.3",
+    "@vitest/ui": "^4.0.16",
+    "@vue/test-utils": "^2.4.6",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^8.7.0",
     "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-n": "^15.0.0",
     "eslint-plugin-prettier": "^4.2.1",
     "git-cz": "^4.9.0",
+    "happy-dom": "^20.0.11",
     "husky": "^8.0.3",
+    "jsdom": "^27.3.0",
     "lint-staged": "^13.1.2",
     "prettier": "^2.8.4",
     "rimraf": "^4.4.0",
     "standard-version": "^9.5.0",
     "ts-jest": "^29.0.5",
     "tsdown": "^0.18.2",
-    "typescript": "~5.5.4"
+    "typescript": "~5.5.4",
+    "vitest": "^4.0.16"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "eslint --fix --ext .json,.js,.ts src",
+    "test": "vitest",
+    "test:ui": "vitest --ui",
+    "test:coverage": "vitest --coverage"
   }
-}
+}