@oiij/auto-router 0.0.2 → 0.0.3

package/dist/index.d.mts

@@ -1,6 +1,8 @@
 import { AutoRouterInstance } from "./setup-auto-router.mjs";
+import * as vue0 from "vue";
 import { App } from "vue";
-import { RouteRecordRaw } from "vue-router";
+import * as vue_router0 from "vue-router";
+import { RouteRecordRaw, Router } from "vue-router";
 
 //#region src/index.d.ts
 /**
@@ -23,23 +25,34 @@ declare function useAutoRouter(): AutoRouterInstance;
  *
  * 必须在 Vue Router 之后安装
  *
+ * @param router Vue Router 实例
+ * @param routes 路由配置数组
  * @returns Vue 插件对象
  *
  * @example
  * ```ts
  * import { createApp } from 'vue'
  * import { createRouter } from 'vue-router'
+ * import { routes } from 'vue-router/auto-routes'
+
  * import { createAutoRouter } from '@oiij/auto-router'
  *
  * const app = createApp(App)
  * const router = createRouter({ ... })
  *
  * app.use(router)
- * app.use(createAutoRouter())
+ * app.use(createAutoRouter(router, routes))
  * app.mount('#app')
  * ```
  */
-declare function createAutoRouter(routes: readonly RouteRecordRaw[]): {
+declare function createAutoRouter(router: Router, routes: readonly RouteRecordRaw[]): {
+  loading: vue0.ComputedRef<boolean>;
+  routesRaw: readonly RouteRecordRaw[];
+  routes: RouteRecordRaw[];
+  flattenRoutes: RouteRecordRaw[];
+  keepAlivePath: vue0.ComputedRef<string[]>;
+  currentRoute: vue0.ComputedRef<vue_router0.RouteLocationNormalizedLoaded>;
+  currentRoutePath: vue0.ComputedRef<string>;
   install(app: App): void;
 };
 //#endregion

package/dist/index.mjs

@@ -27,29 +27,35 @@ function useAutoRouter() {
 *
 * 必须在 Vue Router 之后安装
 *
+* @param router Vue Router 实例
+* @param routes 路由配置数组
 * @returns Vue 插件对象
 *
 * @example
 * ```ts
 * import { createApp } from 'vue'
 * import { createRouter } from 'vue-router'
+* import { routes } from 'vue-router/auto-routes'
+
 * import { createAutoRouter } from '@oiij/auto-router'
 *
 * const app = createApp(App)
 * const router = createRouter({ ... })
 *
 * app.use(router)
-* app.use(createAutoRouter())
+* app.use(createAutoRouter(router, routes))
 * app.mount('#app')
 * ```
 */
-function createAutoRouter(routes) {
-	return { install(app) {
-		const router = app.config.globalProperties.$router;
-		if (!router) throw new Error("Router instance is not found on this Vue app. This plugin should be installed after Vue Router.");
-		const autoRouter = setupAutoRouter(router, routes);
-		app.provide(__INJECTION_KEY__, autoRouter);
-	} };
+function createAutoRouter(router, routes) {
+	const autoRouter = setupAutoRouter(router, routes);
+	return {
+		install(app) {
+			app.config.globalProperties.$autoRouter = autoRouter;
+			app.provide(__INJECTION_KEY__, autoRouter);
+		},
+		...autoRouter
+	};
 }
 
 //#endregion

package/dist/setup-auto-router.d.mts

@@ -1,5 +1,5 @@
 import { ComputedRef } from "vue";
-import { RouteLocationNormalizedLoaded, RouteRecordRaw } from "vue-router";
+import { RouteLocationNormalizedLoaded, RouteRecordRaw, Router } from "vue-router";
 
 //#region src/setup-auto-router.d.ts
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oiij/auto-router",
   "type": "module",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Vue Router utilities and composables for Vue 3",
   "author": "oiij",
   "license": "MIT",