@virou/core 1.0.0 → 1.1.1

package/README.md

@@ -3,7 +3,7 @@
 <p>
   <a href="https://www.npmjs.com/package/@virou/core"><img src="https://img.shields.io/npm/v/@virou/core.svg?style=flat&colorA=18181B&colorB=39737d" alt="Version"></a>
   <a href="https://www.npmjs.com/package/@virou/core"><img src="https://img.shields.io/npm/dm/@virou/core.svg?style=flat&colorA=18181B&colorB=39737d" alt="Downloads"></a>
-  <a href="https://bundlephobia.com/package/@virou/core"><img src="https://img.shields.io/bundlephobia/min/@virou/core?style=flat&colorA=18181B&colorB=39737d" alt="Bundle Size"></a>
+  <a href="https://bundlephobia.com/package/@virou/core"><img src="https://img.shields.io/bundlephobia/min/@virou/core?style=flat&colorA=18181B&colorB=39737d" alt="Bundle Size"><a/>
   <a href="https://github.com/tankosinn/virou/tree/main/LICENSE"><img src="https://img.shields.io/github/license/tankosinn/virou.svg?style=flat&colorA=18181B&colorB=39737d" alt="License"></a>
 </p>
 
@@ -66,6 +66,8 @@ createApp(App)
   .mount('#app')
 ```
 
+> ⚠️ Virou doesn’t globally register any components (including `VRouterView`); it only adds a `$virou` global property to store router instances in a `Map<string, VRouterData>`, which are automatically removed when no longer in use.
+
 ### 🧩 Using with Nuxt
 
 Install Virou Nuxt module with your package manager:

package/dist/index.d.ts

@@ -0,0 +1,106 @@
+import { RouterContext } from "rou3";
+import * as vue0 from "vue";
+import { Component, DefineComponent, Plugin, PropType, Ref, ShallowRef, SlotsType, VNodeChild } from "vue";
+
+//#region src/types.d.ts
+type Lazy<T> = () => Promise<T>;
+type VRouteComponent = Component | DefineComponent;
+type VRouteLazyComponent = Lazy<VRouteComponent>;
+type VRouteRenderComponent = VRouteComponent | VRouteLazyComponent;
+type VRouteMeta = Record<PropertyKey, unknown>;
+interface VRouteRaw {
+  path: string;
+  component: VRouteRenderComponent;
+  meta?: VRouteMeta;
+  children?: VRouteRaw[];
+}
+type VRouteId = Readonly<[path: string, depth: number]>;
+interface VRouteMatchedData {
+  id: VRouteId;
+  meta?: VRouteMeta;
+}
+interface VRouteNormalized extends Omit<VRouteRaw, 'path' | 'children'> {
+  parentId?: VRouteId;
+}
+type VRoutesMap = Map<VRouteId, VRouteNormalized>;
+interface VRoute {
+  fullPath: string;
+  meta?: VRouteMeta;
+  params?: Record<string, string>;
+  path: string;
+  search: string;
+  hash: string;
+  _renderList: Component[] | null;
+}
+interface VRouterData {
+  context: RouterContext<VRouteMatchedData>;
+  routes: VRoutesMap;
+  activePath: Ref<string>;
+  route: ShallowRef<VRoute>;
+  _isGlobal: boolean;
+  _deps: number;
+  _dispose: () => void;
+}
+interface VRouterOptions {
+  initialPath?: string;
+  _isGlobal?: boolean;
+}
+interface VRouter {
+  route: VRouterData['route'];
+  router: {
+    addRoute: (route: VRouteRaw) => void;
+    replace: (path: string) => void;
+    _depthKey: symbol;
+  };
+}
+interface VirouPluginOptions {
+  routers?: Record<string, {
+    routes: VRouteRaw[];
+    options?: Omit<VRouterOptions, '_isGlobal'>;
+  }>;
+}
+//#endregion
+//#region src/component.d.ts
+declare const VRouterView: vue0.DefineComponent<vue0.ExtractPropTypes<{
+  routerKey: StringConstructor;
+  keepAlive: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  viewKey: {
+    type: PropType<string | ((route: VRoute, key: string) => string)>;
+  };
+}>, () => string | number | boolean | vue0.VNode<vue0.RendererNode, vue0.RendererElement, {
+  [key: string]: any;
+}> | vue0.VNodeArrayChildren | null, {}, {}, {}, vue0.ComponentOptionsMixin, vue0.ComponentOptionsMixin, {}, string, vue0.PublicProps, Readonly<vue0.ExtractPropTypes<{
+  routerKey: StringConstructor;
+  keepAlive: {
+    type: BooleanConstructor;
+    default: boolean;
+  };
+  viewKey: {
+    type: PropType<string | ((route: VRoute, key: string) => string)>;
+  };
+}>> & Readonly<{}>, {
+  keepAlive: boolean;
+}, SlotsType<{
+  default: (payload: {
+    Component: VNodeChild;
+    route: VRoute;
+  }) => VNodeChild;
+  fallback: (payload: {
+    route: VRoute;
+  }) => VNodeChild;
+}>, {}, {}, string, vue0.ComponentProvideOptions, true, {}, any>;
+//#endregion
+//#region src/plugin.d.ts
+declare const virou: Plugin<[VirouPluginOptions?]>;
+//#endregion
+//#region src/router.d.ts
+declare const virouSymbol: unique symbol;
+declare function createVRouter(routes: VRouteRaw[], options?: VRouterOptions): VRouterData;
+declare function useVRouter(routes?: VRouteRaw[], options?: VRouterOptions): VRouter;
+declare function useVRouter(key?: string, routes?: VRouteRaw[], options?: VRouterOptions): VRouter;
+//#endregion
+export { VRoute, VRouteComponent, VRouteId, VRouteLazyComponent, VRouteMatchedData, VRouteMeta, VRouteNormalized, VRouteRaw, VRouteRenderComponent, VRouter, VRouterData, VRouterOptions, VRouterView, VRoutesMap, VirouPluginOptions, createVRouter, useVRouter, virou, virouSymbol };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/component.ts","../src/plugin.ts","../src/router.ts"],"sourcesContent":[],"mappings":";;;;;KAGK,gBAAgB,QAAQ;KAEjB,eAAA,GAAkB,YAAY;KAC9B,mBAAA,GAAsB,KAAK;AAHlC,KAIO,qBAAA,GAAwB,eAJR,GAI0B,mBAJ1B;AAEhB,KAIA,UAAA,GAAa,MAJE,CAIK,WAJF,EAAY,OAAA,CAAA;AAC9B,UAKK,SAAA,CALc;EACnB,IAAA,EAAA,MAAA;EAEA,SAAA,EAIC,qBAJmB;EAEf,IAAA,CAAA,EAGR,UAHiB;EAEb,QAAA,CAAA,EAEA,SAFA,EAAA;;AAEA,KAGD,QAAA,GAAW,QAHV,CAAA,CAAA,IAAA,EAAA,MAAA,EAAA,KAAA,EAAA,MAAA,CAAA,CAAA;AAAS,UAKL,iBAAA,CALK;EAGV,EAAA,EAGN,QAHc;EAEH,IAAA,CAAA,EAER,UAFQ;AAKjB;AAA+C,UAA9B,gBAAA,SAAyB,IAAK,CAAA,SAAA,EAAA,MAAA,GAAA,UAAA,CAAA,CAAA;EAClC,QAAA,CAAA,EAAA,QAAA;;AADiC,KAIlC,UAAA,GAAa,GAJqB,CAIjB,QAJiB,EAIP,gBAJO,CAAA;AAIlC,UAEK,MAAA,CAFK;EAAO,QAAA,EAAA,MAAA;EAAU,IAAA,CAAA,EAI9B,UAJ8B;EAAd,MAAA,CAAA,EAKd,MALc,CAAA,MAAA,EAAA,MAAA,CAAA;EAAG,IAAA,EAAA,MAAA;EAEX,MAAA,EAAA,MAAM;EAEd,IAAA,EAAA,MAAA;EACE,WAAA,EAII,SAJJ,EAAA,GAAA,IAAA;;AAIa,UAGP,WAAA,CAHO;EAGP,OAAA,EACN,aADiB,CACH,iBADG,CAAA;EACH,MAAA,EACf,UADe;EAAd,UAAA,EAEG,GAFH,CAAA,MAAA,CAAA;EACD,KAAA,EAED,UAFC,CAEU,MAFV,CAAA;EACI,SAAA,EAAA,OAAA;EACM,KAAA,EAAA,MAAA;EAAX,QAAA,EAAA,GAAA,GAAA,IAAA;;AAMQ,UAAA,cAAA,CAAc;EAKd,WAAO,CAAA,EAAA,MAAA;EASP,SAAA,CAAA,EAAA,OAAA;;AAGE,UAZF,OAAA,CAYE;EAAL,KAAA,EAXL,WAWK,CAAA,OAAA,CAAA;EAFF,MAAA,EAAA;IAAM,QAAA,EAAA,CAAA,KAAA,EAPI,SAOJ,EAAA,GAAA,IAAA;;;;ACtDlB;UDqDiB,kBAAA;YACL;IChD0D,MAAA,EDiD1D,SCjD0D,EAAA;IAA3B,OAAA,CAAA,EDkD7B,IClD6B,CDkDxB,cClDwB,EAAA,WAAA,CAAA;EAAQ,CAAA,CAN3B;;;;cAAX,kBAAW,gBAM2B,IAAA,CAN3B;;;IDTnB,IAAI,oBAAY;IAET,OAAA,EAAA,OAAe;EACf,CAAA;EACA,OAAA,EAAA;IAEA,IAAA,ECS+B,QDTrB,CAAA,MAAU,GAAA,CAAA,CAAA,KAAA,ECSsC,MDT7C,EAAM,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA,CAAA,CAAA;EAEd,CAAA;CAEJ,CAAA,EAAA,GAAA,GAAA,MAAA,GAAA,MAAA,GAAA,OAAA,aAAA,CCDW,IAAA,CAAA,YAAA,wBDCX;EACJ,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,GAAA;CACI,CAAA,6BAAA,IAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,CAAA,CAAA,0DAAA,CAAA,CAAA,EAAA,MAAA,4BAAA,CCGsC,IAAA,CAAA,gBDHtC,CAAA;EAAS,SAAA,mBAAA;EAGV,SAAA,EAAQ;IAEH,IAAA,oBAAiB;IAKjB,OAAA,EAAA,OAAiB;EAAa,CAAA;EAClC,OAAA,EAAA;IAD6B,IAAA,ECPC,QDOD,CAAA,MAAA,GAAA,CAAA,CAAA,KAAA,ECP4B,MDO5B,EAAA,GAAA,EAAA,MAAA,EAAA,GAAA,MAAA,CAAA,CAAA;EAAI,CAAA;AAI9C,CAAA,CAAA,CAAA,WAAY,CAAA,CAAA,CAAU,CAAA,EAAA;EAAO,SAAA,EAAA,OAAA;CAAU,WAAA,CAAA;EAAd,OAAA,EAAA,CAAA,OAAA,EAAA;IAAG,SAAA,ECRQ,UDQR;IAEX,KAAM,ECVgC,MDUhC;EAEd,CAAA,EAAA,GCZ2D,UDY3D;EACE,QAAA,EAAA,CAAA,OAAA,EAAA;IAII,KAAA,EChBkB,MDgBlB;EAAS,CAAA,EAAA,GChBsB,UDgBtB;AAGxB,CAAA,CAAA,EAAiB,CAAA,CAAA,EAAA,CAAA,CAAA,EAAA,MAAW,gCAAA,IAAA,EAAA,CAAA,CAAA,EAAA,GAAA,CAAA;;;cErCf,OAAO,QAAQ;;;cCEf;iBAEG,aAAA,SAAsB,uBAAuB,iBAAiB;iBAuC9D,UAAA,UAAoB,uBAAuB,iBAAiB;iBAC5D,UAAA,wBAAkC,uBAAuB,iBAAiB"}

package/dist/index.js

@@ -0,0 +1,178 @@
+import { addRoute, createRouter, findRoute } from "rou3";
+import { KeepAlive, Suspense, defineAsyncComponent, defineComponent, getCurrentInstance, h, inject, onScopeDispose, provide, ref, shallowRef, useId, watchEffect } from "vue";
+import { joinURL, parseURL } from "ufo";
+
+//#region src/utils.ts
+const renderListCache = /* @__PURE__ */ new WeakMap();
+function normalizeComponent(component) {
+	if (typeof component === "function" && component.length === 0) return defineAsyncComponent(component);
+	return component;
+}
+function registerRoutes(ctx, routes, registry, parentId) {
+	for (const { path, meta, component, children } of routes) {
+		const fullPath = joinURL(parentId?.[0] ?? "/", path);
+		const depth = (parentId?.[1] ?? -1) + 1;
+		const id = Object.freeze([fullPath, depth]);
+		registry.set(id, {
+			meta,
+			component: normalizeComponent(component),
+			parentId
+		});
+		if (children && children.length) registerRoutes(ctx, children, registry, id);
+		addRoute(ctx, "GET", fullPath, {
+			id,
+			meta
+		});
+	}
+}
+function createRenderList(data, routes) {
+	let cacheForRoutes = renderListCache.get(routes);
+	if (!cacheForRoutes) {
+		cacheForRoutes = /* @__PURE__ */ new Map();
+		renderListCache.set(routes, cacheForRoutes);
+	}
+	const cached = cacheForRoutes.get(data.id);
+	if (cached) return cached;
+	const depth = data.id[1];
+	const list = Array.from({ length: depth });
+	let idx = depth;
+	let cursor = routes.get(data.id);
+	while (cursor) {
+		list[idx--] = cursor.component;
+		cursor = cursor.parentId !== void 0 ? routes.get(cursor.parentId) : void 0;
+	}
+	cacheForRoutes.set(data.id, list);
+	return list;
+}
+
+//#endregion
+//#region src/router.ts
+const virouSymbol = Symbol("virou");
+function createVRouter(routes, options) {
+	const context = createRouter();
+	const routeRegistry = /* @__PURE__ */ new Map();
+	registerRoutes(context, routes, routeRegistry);
+	const activePath = ref(options?.initialPath ?? "/");
+	const snapshot = () => {
+		const matchedRoute = findRoute(context, "GET", activePath.value);
+		const _renderList = matchedRoute ? createRenderList(matchedRoute.data, routeRegistry) : null;
+		const { pathname, hash, search } = parseURL(activePath.value);
+		return {
+			fullPath: activePath.value,
+			path: pathname,
+			search,
+			hash,
+			meta: matchedRoute?.data.meta,
+			params: matchedRoute?.params,
+			_renderList
+		};
+	};
+	const route = shallowRef(snapshot());
+	const unwatch = watchEffect(() => {
+		route.value = snapshot();
+	});
+	return {
+		context,
+		routes: routeRegistry,
+		activePath,
+		route,
+		_isGlobal: options?._isGlobal ?? false,
+		_deps: 0,
+		_dispose: unwatch
+	};
+}
+function useVRouter(...args) {
+	if (typeof args[0] !== "string") args.unshift(inject(virouSymbol, useId()));
+	const [key, routes = [], options = {}] = args;
+	if (!key || typeof key !== "string") throw new TypeError(`[virou] [useVRouter] key must be a string: ${key}`);
+	provide(virouSymbol, key);
+	const vm = getCurrentInstance();
+	if (!vm) throw new TypeError("[virou] [useVRouter] useVRouter must be called in setup()");
+	const virou$1 = vm.proxy?.$virou;
+	if (!virou$1) throw new Error("[virou] [useVRouter] virou plugin not installed");
+	if (routes.length) {
+		if (virou$1.get(key)) throw new Error(`[virou] [useVRouter] router with key "${key}" already exists`);
+		virou$1.set(key, createVRouter(routes, options));
+	}
+	const router = virou$1.get(key);
+	if (!router) throw new Error(`[virou] [useVRouter] router with key "${key}" not found`);
+	router._deps++;
+	onScopeDispose(() => {
+		router._deps--;
+		if (router._deps === 0 && !router._isGlobal) {
+			router._dispose();
+			virou$1.delete(key);
+		}
+	});
+	return {
+		route: router.route,
+		router: {
+			addRoute: (route) => {
+				registerRoutes(router.context, [route], router.routes);
+			},
+			replace: (path) => {
+				router.activePath.value = path;
+			},
+			_depthKey: Symbol.for(key)
+		}
+	};
+}
+
+//#endregion
+//#region src/component.ts
+const VRouterView = defineComponent({
+	name: "VRouterView",
+	inheritAttrs: false,
+	props: {
+		routerKey: String,
+		keepAlive: {
+			type: Boolean,
+			default: false
+		},
+		viewKey: { type: [String, Function] }
+	},
+	slots: Object,
+	setup(props, { slots, attrs }) {
+		const key = props.routerKey ?? inject(virouSymbol);
+		if (key === void 0) throw new Error("[virou] [VRouterView] routerKey is required");
+		const { route, router } = useVRouter(key);
+		const depth = inject(router._depthKey, 0);
+		provide(router._depthKey, depth + 1);
+		return () => {
+			const component = route.value._renderList?.[depth];
+			if (!component) return slots.default?.({
+				Component: null,
+				route: route.value
+			}) ?? null;
+			const vnodeKey = typeof props.viewKey === "function" ? props.viewKey(route.value, key) : props.viewKey ?? `${key}-${depth}-${route.value.path}`;
+			const suspenseVNode = h(Suspense, null, {
+				default: () => h(component, {
+					key: vnodeKey,
+					...attrs
+				}),
+				fallback: () => slots.fallback?.({ route: route.value }) ?? null
+			});
+			const vnode = props.keepAlive ? h(KeepAlive, null, { default: () => suspenseVNode }) : suspenseVNode;
+			return slots.default?.({
+				Component: vnode,
+				route: route.value
+			}) ?? vnode;
+		};
+	}
+});
+
+//#endregion
+//#region src/plugin.ts
+const virou = (app, options = {}) => {
+	const { routers } = options;
+	const map = /* @__PURE__ */ new Map();
+	app.config.globalProperties.$virou = map;
+	if (routers) for (const [key, router] of Object.entries(routers)) map.set(key, createVRouter(router.routes, {
+		...router.options,
+		_isGlobal: true
+	}));
+};
+
+//#endregion
+export { VRouterView, createVRouter, useVRouter, virou, virouSymbol };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["id: VRouteId","routeRegistry: VRoutesMap","virou","virou: Plugin<[VirouPluginOptions?]>"],"sources":["../src/utils.ts","../src/router.ts","../src/component.ts","../src/plugin.ts"],"sourcesContent":["import type { RouterContext } from 'rou3'\nimport type { Component } from 'vue'\nimport type { VRouteId, VRouteLazyComponent, VRouteMatchedData, VRouteRaw, VRouteRenderComponent, VRoutesMap } from './types'\nimport { addRoute } from 'rou3'\nimport { joinURL } from 'ufo'\nimport { defineAsyncComponent } from 'vue'\n\nconst renderListCache = new WeakMap<VRoutesMap, Map<VRouteId, Component[]>>()\n\nfunction normalizeComponent(component: VRouteRenderComponent): Component {\n  if (typeof component === 'function' && (component as VRouteLazyComponent).length === 0) {\n    return defineAsyncComponent(component as VRouteLazyComponent)\n  }\n  return component as Component\n}\n\nexport function registerRoutes(\n  ctx: RouterContext<VRouteMatchedData>,\n  routes: VRouteRaw[],\n  registry: VRoutesMap,\n  parentId?: VRouteId,\n): void {\n  for (const { path, meta, component, children } of routes) {\n    const fullPath = joinURL(parentId?.[0] ?? '/', path)\n    const depth = (parentId?.[1] ?? -1) + 1\n\n    const id: VRouteId = Object.freeze([fullPath, depth])\n\n    registry.set(id, {\n      meta,\n      component: normalizeComponent(component),\n      parentId,\n    })\n\n    if (children && children.length) {\n      registerRoutes(ctx, children, registry, id)\n    }\n\n    addRoute(ctx, 'GET', fullPath, { id, meta })\n  }\n}\n\nexport function createRenderList(\n  data: VRouteMatchedData,\n  routes: VRoutesMap,\n): VRouteRenderComponent[] {\n  let cacheForRoutes = renderListCache.get(routes)\n  if (!cacheForRoutes) {\n    cacheForRoutes = new Map<VRouteId, Component[]>()\n    renderListCache.set(routes, cacheForRoutes)\n  }\n\n  const cached = cacheForRoutes.get(data.id)\n  if (cached) {\n    return cached\n  }\n\n  const depth = data.id[1]\n  const list = Array.from<VRouteRenderComponent>({ length: depth })\n  let idx = depth\n  let cursor = routes.get(data.id)\n  while (cursor) {\n    list[idx--] = cursor.component\n    cursor = cursor.parentId !== undefined ? routes.get(cursor.parentId) : undefined\n  }\n\n  cacheForRoutes.set(data.id, list)\n  return list\n}\n","import type { VRoute, VRouteMatchedData, VRouter, VRouteRaw, VRouterData, VRouterOptions, VRoutesMap } from './types'\nimport { createRouter, findRoute } from 'rou3'\nimport { parseURL } from 'ufo'\nimport { getCurrentInstance, inject, onScopeDispose, provide, ref, shallowRef, useId, watchEffect } from 'vue'\nimport { createRenderList, registerRoutes } from './utils'\n\nexport const virouSymbol = Symbol('virou')\n\nexport function createVRouter(routes: VRouteRaw[], options?: VRouterOptions): VRouterData {\n  const context = createRouter<VRouteMatchedData>()\n  const routeRegistry: VRoutesMap = new Map()\n  registerRoutes(context, routes, routeRegistry)\n\n  const activePath = ref(options?.initialPath ?? '/')\n\n  const snapshot = (): VRoute => {\n    const matchedRoute = findRoute(context, 'GET', activePath.value)\n    const _renderList = matchedRoute ? createRenderList(matchedRoute.data, routeRegistry) : null\n    const { pathname, hash, search } = parseURL(activePath.value)\n    return {\n      fullPath: activePath.value,\n      path: pathname,\n      search,\n      hash,\n      meta: matchedRoute?.data.meta,\n      params: matchedRoute?.params,\n      _renderList,\n    }\n  }\n\n  const route = shallowRef<VRoute>(snapshot())\n\n  const unwatch = watchEffect(() => {\n    route.value = snapshot()\n  })\n\n  return {\n    context,\n    routes: routeRegistry,\n    activePath,\n    route,\n    _isGlobal: options?._isGlobal ?? false,\n    _deps: 0,\n    _dispose: unwatch,\n  }\n}\n\nexport function useVRouter(routes?: VRouteRaw[], options?: VRouterOptions): VRouter\nexport function useVRouter(key?: string, routes?: VRouteRaw[], options?: VRouterOptions): VRouter\nexport function useVRouter(...args: any[]): VRouter {\n  if (typeof args[0] !== 'string') {\n    args.unshift(inject<string>(virouSymbol, useId()))\n  }\n\n  const [key, routes = [], options = {}] = args as [string, VRouteRaw[], VRouterOptions]\n\n  if (!key || typeof key !== 'string') {\n    throw new TypeError(`[virou] [useVRouter] key must be a string: ${key}`)\n  }\n\n  provide(virouSymbol, key)\n\n  const vm = getCurrentInstance()\n  if (!vm) {\n    throw new TypeError('[virou] [useVRouter] useVRouter must be called in setup()')\n  }\n\n  const virou = vm.proxy?.$virou\n  if (!virou) {\n    throw new Error('[virou] [useVRouter] virou plugin not installed')\n  }\n\n  if (routes.length) {\n    if (virou.get(key)) {\n      throw new Error(`[virou] [useVRouter] router with key \"${key}\" already exists`)\n    }\n\n    virou.set(key, createVRouter(routes, options))\n  }\n\n  const router = virou.get(key)\n  if (!router) {\n    throw new Error(`[virou] [useVRouter] router with key \"${key}\" not found`)\n  }\n\n  router._deps++\n  onScopeDispose(() => {\n    router._deps--\n\n    if (router._deps === 0 && !router._isGlobal) {\n      router._dispose()\n      virou.delete(key)\n    }\n  })\n\n  return {\n    route: router.route,\n    router: {\n      addRoute: (route: VRouteRaw) => {\n        registerRoutes(router.context, [route], router.routes)\n      },\n      replace: (path: string) => {\n        router.activePath.value = path\n      },\n      _depthKey: Symbol.for(key),\n    },\n  }\n}\n","import type { PropType, SlotsType, VNodeChild } from 'vue'\nimport type { VRoute } from './types'\nimport {\n  defineComponent,\n  h,\n  inject,\n  KeepAlive,\n  provide,\n  Suspense,\n} from 'vue'\nimport { useVRouter, virouSymbol } from './router'\n\nexport const VRouterView = defineComponent({\n  name: 'VRouterView',\n  inheritAttrs: false,\n  props: {\n    routerKey: String,\n    keepAlive: { type: Boolean, default: false },\n    viewKey: { type: [String, Function] as PropType<string | ((route: VRoute, key: string) => string)> },\n  },\n  slots: Object as SlotsType<{\n    default: (payload: { Component: VNodeChild, route: VRoute }) => VNodeChild\n    fallback: (payload: { route: VRoute }) => VNodeChild\n  }>,\n  setup(props, { slots, attrs }) {\n    const key = props.routerKey ?? inject<string>(virouSymbol)\n    if (key === undefined) {\n      throw new Error('[virou] [VRouterView] routerKey is required')\n    }\n\n    const { route, router } = useVRouter(key)\n\n    const depth = inject<number>(router._depthKey, 0)\n    provide(router._depthKey, depth + 1)\n\n    return () => {\n      const component = route.value._renderList?.[depth]\n      if (!component) {\n        return slots.default?.({ Component: null, route: route.value }) ?? null\n      }\n\n      const vnodeKey = typeof props.viewKey === 'function'\n        ? props.viewKey(route.value, key)\n        : props.viewKey ?? `${key}-${depth}-${route.value.path}`\n\n      const suspenseVNode = h(\n        Suspense,\n        null,\n        {\n          default: () => h(component, { key: vnodeKey, ...attrs }),\n          fallback: () => slots.fallback?.({ route: route.value }) ?? null,\n        },\n      )\n\n      const vnode = props.keepAlive\n        ? h(KeepAlive, null, { default: () => suspenseVNode })\n        : suspenseVNode\n\n      return slots.default?.({ Component: vnode, route: route.value }) ?? vnode\n    }\n  },\n})\n","import type { Plugin } from 'vue'\nimport type { VirouPluginOptions, VRouterData } from './types'\nimport { createVRouter } from './router'\n\nexport const virou: Plugin<[VirouPluginOptions?]> = (app, options = {}) => {\n  const { routers } = options\n\n  const map = new Map<string, VRouterData>()\n  app.config.globalProperties.$virou = map\n\n  if (routers) {\n    for (const [key, router] of Object.entries(routers)) {\n      map.set(key, createVRouter(router.routes, { ...router.options, _isGlobal: true }))\n    }\n  }\n}\n"],"mappings":";;;;;AAOA,MAAM,kCAAkB,IAAI,SAAiD;AAE7E,SAAS,mBAAmB,WAA6C;AACvE,KAAI,OAAO,cAAc,cAAe,UAAkC,WAAW,EACnF,QAAO,qBAAqB,UAAiC;AAE/D,QAAO;;AAGT,SAAgB,eACd,KACA,QACA,UACA,UACM;AACN,MAAK,MAAM,EAAE,MAAM,MAAM,WAAW,cAAc,QAAQ;EACxD,MAAM,WAAW,QAAQ,WAAW,MAAM,KAAK,KAAK;EACpD,MAAM,SAAS,WAAW,MAAM,MAAM;EAEtC,MAAMA,KAAe,OAAO,OAAO,CAAC,UAAU,MAAM,CAAC;AAErD,WAAS,IAAI,IAAI;GACf;GACA,WAAW,mBAAmB,UAAU;GACxC;GACD,CAAC;AAEF,MAAI,YAAY,SAAS,OACvB,gBAAe,KAAK,UAAU,UAAU,GAAG;AAG7C,WAAS,KAAK,OAAO,UAAU;GAAE;GAAI;GAAM,CAAC;;;AAIhD,SAAgB,iBACd,MACA,QACyB;CACzB,IAAI,iBAAiB,gBAAgB,IAAI,OAAO;AAChD,KAAI,CAAC,gBAAgB;AACnB,mCAAiB,IAAI,KAA4B;AACjD,kBAAgB,IAAI,QAAQ,eAAe;;CAG7C,MAAM,SAAS,eAAe,IAAI,KAAK,GAAG;AAC1C,KAAI,OACF,QAAO;CAGT,MAAM,QAAQ,KAAK,GAAG;CACtB,MAAM,OAAO,MAAM,KAA4B,EAAE,QAAQ,OAAO,CAAC;CACjE,IAAI,MAAM;CACV,IAAI,SAAS,OAAO,IAAI,KAAK,GAAG;AAChC,QAAO,QAAQ;AACb,OAAK,SAAS,OAAO;AACrB,WAAS,OAAO,aAAa,SAAY,OAAO,IAAI,OAAO,SAAS,GAAG;;AAGzE,gBAAe,IAAI,KAAK,IAAI,KAAK;AACjC,QAAO;;;;;AC7DT,MAAa,cAAc,OAAO,QAAQ;AAE1C,SAAgB,cAAc,QAAqB,SAAuC;CACxF,MAAM,UAAU,cAAiC;CACjD,MAAMC,gCAA4B,IAAI,KAAK;AAC3C,gBAAe,SAAS,QAAQ,cAAc;CAE9C,MAAM,aAAa,IAAI,SAAS,eAAe,IAAI;CAEnD,MAAM,iBAAyB;EAC7B,MAAM,eAAe,UAAU,SAAS,OAAO,WAAW,MAAM;EAChE,MAAM,cAAc,eAAe,iBAAiB,aAAa,MAAM,cAAc,GAAG;EACxF,MAAM,EAAE,UAAU,MAAM,WAAW,SAAS,WAAW,MAAM;AAC7D,SAAO;GACL,UAAU,WAAW;GACrB,MAAM;GACN;GACA;GACA,MAAM,cAAc,KAAK;GACzB,QAAQ,cAAc;GACtB;GACD;;CAGH,MAAM,QAAQ,WAAmB,UAAU,CAAC;CAE5C,MAAM,UAAU,kBAAkB;AAChC,QAAM,QAAQ,UAAU;GACxB;AAEF,QAAO;EACL;EACA,QAAQ;EACR;EACA;EACA,WAAW,SAAS,aAAa;EACjC,OAAO;EACP,UAAU;EACX;;AAKH,SAAgB,WAAW,GAAG,MAAsB;AAClD,KAAI,OAAO,KAAK,OAAO,SACrB,MAAK,QAAQ,OAAe,aAAa,OAAO,CAAC,CAAC;CAGpD,MAAM,CAAC,KAAK,SAAS,EAAE,EAAE,UAAU,EAAE,IAAI;AAEzC,KAAI,CAAC,OAAO,OAAO,QAAQ,SACzB,OAAM,IAAI,UAAU,8CAA8C,MAAM;AAG1E,SAAQ,aAAa,IAAI;CAEzB,MAAM,KAAK,oBAAoB;AAC/B,KAAI,CAAC,GACH,OAAM,IAAI,UAAU,4DAA4D;CAGlF,MAAMC,UAAQ,GAAG,OAAO;AACxB,KAAI,CAACA,QACH,OAAM,IAAI,MAAM,kDAAkD;AAGpE,KAAI,OAAO,QAAQ;AACjB,MAAIA,QAAM,IAAI,IAAI,CAChB,OAAM,IAAI,MAAM,yCAAyC,IAAI,kBAAkB;AAGjF,UAAM,IAAI,KAAK,cAAc,QAAQ,QAAQ,CAAC;;CAGhD,MAAM,SAASA,QAAM,IAAI,IAAI;AAC7B,KAAI,CAAC,OACH,OAAM,IAAI,MAAM,yCAAyC,IAAI,aAAa;AAG5E,QAAO;AACP,sBAAqB;AACnB,SAAO;AAEP,MAAI,OAAO,UAAU,KAAK,CAAC,OAAO,WAAW;AAC3C,UAAO,UAAU;AACjB,WAAM,OAAO,IAAI;;GAEnB;AAEF,QAAO;EACL,OAAO,OAAO;EACd,QAAQ;GACN,WAAW,UAAqB;AAC9B,mBAAe,OAAO,SAAS,CAAC,MAAM,EAAE,OAAO,OAAO;;GAExD,UAAU,SAAiB;AACzB,WAAO,WAAW,QAAQ;;GAE5B,WAAW,OAAO,IAAI,IAAI;GAC3B;EACF;;;;;AC9FH,MAAa,cAAc,gBAAgB;CACzC,MAAM;CACN,cAAc;CACd,OAAO;EACL,WAAW;EACX,WAAW;GAAE,MAAM;GAAS,SAAS;GAAO;EAC5C,SAAS,EAAE,MAAM,CAAC,QAAQ,SAAS,EAAiE;EACrG;CACD,OAAO;CAIP,MAAM,OAAO,EAAE,OAAO,SAAS;EAC7B,MAAM,MAAM,MAAM,aAAa,OAAe,YAAY;AAC1D,MAAI,QAAQ,OACV,OAAM,IAAI,MAAM,8CAA8C;EAGhE,MAAM,EAAE,OAAO,WAAW,WAAW,IAAI;EAEzC,MAAM,QAAQ,OAAe,OAAO,WAAW,EAAE;AACjD,UAAQ,OAAO,WAAW,QAAQ,EAAE;AAEpC,eAAa;GACX,MAAM,YAAY,MAAM,MAAM,cAAc;AAC5C,OAAI,CAAC,UACH,QAAO,MAAM,UAAU;IAAE,WAAW;IAAM,OAAO,MAAM;IAAO,CAAC,IAAI;GAGrE,MAAM,WAAW,OAAO,MAAM,YAAY,aACtC,MAAM,QAAQ,MAAM,OAAO,IAAI,GAC/B,MAAM,WAAW,GAAG,IAAI,GAAG,MAAM,GAAG,MAAM,MAAM;GAEpD,MAAM,gBAAgB,EACpB,UACA,MACA;IACE,eAAe,EAAE,WAAW;KAAE,KAAK;KAAU,GAAG;KAAO,CAAC;IACxD,gBAAgB,MAAM,WAAW,EAAE,OAAO,MAAM,OAAO,CAAC,IAAI;IAC7D,CACF;GAED,MAAM,QAAQ,MAAM,YAChB,EAAE,WAAW,MAAM,EAAE,eAAe,eAAe,CAAC,GACpD;AAEJ,UAAO,MAAM,UAAU;IAAE,WAAW;IAAO,OAAO,MAAM;IAAO,CAAC,IAAI;;;CAGzE,CAAC;;;;ACzDF,MAAaC,SAAwC,KAAK,UAAU,EAAE,KAAK;CACzE,MAAM,EAAE,YAAY;CAEpB,MAAM,sBAAM,IAAI,KAA0B;AAC1C,KAAI,OAAO,iBAAiB,SAAS;AAErC,KAAI,QACF,MAAK,MAAM,CAAC,KAAK,WAAW,OAAO,QAAQ,QAAQ,CACjD,KAAI,IAAI,KAAK,cAAc,OAAO,QAAQ;EAAE,GAAG,OAAO;EAAS,WAAW;EAAM,CAAC,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@virou/core",
   "type": "module",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Virtual router with multiple instance support for Vue",
   "author": "Tankosin<https://github.com/tankosinn>",
   "license": "MIT",
@@ -22,9 +22,11 @@
   ],
   "sideEffects": false,
   "exports": {
-    "types": "./dist/index.d.mts",
-    "default": "./dist/index.mjs"
+    "types": "./dist/index.d.ts",
+    "default": "./dist/index.js"
   },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist"
   ],
@@ -32,13 +34,10 @@
     "vue": "^3.5.0"
   },
   "dependencies": {
-    "rou3": "^0.6.1",
+    "rou3": "^0.7.11",
     "ufo": "^1.6.1"
   },
-  "devDependencies": {
-    "unbuild": "3.5.0"
-  },
   "scripts": {
-    "build": "unbuild"
+    "build": "pnpm -w tsdown -F @virou/core"
   }
 }

package/dist/index.d.mts

@@ -1,107 +0,0 @@
-import { RouterContext } from 'rou3';
-import * as vue from 'vue';
-import { Component, DefineComponent, Ref, ShallowRef, PropType, SlotsType, VNodeChild, Plugin } from 'vue';
-
-type Lazy<T> = () => Promise<T>;
-type VRouteComponent = Component | DefineComponent;
-type VRouteLazyComponent = Lazy<VRouteComponent>;
-type VRouteRenderComponent = VRouteComponent | VRouteLazyComponent;
-type VRouteMeta = Record<PropertyKey, unknown>;
-interface VRouteRaw {
-    path: string;
-    component: VRouteRenderComponent;
-    meta?: VRouteMeta;
-    children?: VRouteRaw[];
-}
-type VRouteId = Readonly<[path: string, depth: number]>;
-interface VRouteMatchedData {
-    id: VRouteId;
-    meta?: VRouteMeta;
-}
-interface VRouteNormalized extends Omit<VRouteRaw, 'path' | 'children'> {
-    parentId?: VRouteId;
-}
-type VRoutesMap = Map<VRouteId, VRouteNormalized>;
-interface VRoute {
-    fullPath: string;
-    meta?: VRouteMeta;
-    params?: Record<string, string>;
-    path: string;
-    search: string;
-    hash: string;
-    _renderList: Component[] | null;
-}
-interface VRouterData {
-    context: RouterContext<VRouteMatchedData>;
-    routes: VRoutesMap;
-    activePath: Ref<string>;
-    route: ShallowRef<VRoute>;
-    _isGlobal: boolean;
-    _deps: number;
-    _dispose: () => void;
-}
-interface VRouterOptions {
-    initialPath?: string;
-    _isGlobal?: boolean;
-}
-interface VRouter {
-    route: VRouterData['route'];
-    router: {
-        addRoute: (route: VRouteRaw) => void;
-        replace: (path: string) => void;
-        _depthKey: symbol;
-    };
-}
-interface VirouPluginOptions {
-    routers?: Record<string, {
-        routes: VRouteRaw[];
-        options?: Omit<VRouterOptions, '_isGlobal'>;
-    }>;
-}
-
-declare module 'vue' {
-  interface ComponentCustomProperties {
-    $virou: Map<string, VRouterData>
-  }
-}
-
-declare const VRouterView: vue.DefineComponent<vue.ExtractPropTypes<{
-    routerKey: StringConstructor;
-    keepAlive: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    viewKey: {
-        type: PropType<string | ((route: VRoute, key: string) => string)>;
-    };
-}>, () => string | number | boolean | vue.VNode<vue.RendererNode, vue.RendererElement, {
-    [key: string]: any;
-}> | vue.VNodeArrayChildren | null, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
-    routerKey: StringConstructor;
-    keepAlive: {
-        type: BooleanConstructor;
-        default: boolean;
-    };
-    viewKey: {
-        type: PropType<string | ((route: VRoute, key: string) => string)>;
-    };
-}>> & Readonly<{}>, {
-    keepAlive: boolean;
-}, SlotsType<{
-    default: (payload: {
-        Component: VNodeChild;
-        route: VRoute;
-    }) => VNodeChild;
-    fallback: (payload: {
-        route: VRoute;
-    }) => VNodeChild;
-}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
-
-declare const virou: Plugin<[VirouPluginOptions?]>;
-
-declare const virouSymbol: unique symbol;
-declare function createVRouter(routes: VRouteRaw[], options?: VRouterOptions): VRouterData;
-declare function useVRouter(routes?: VRouteRaw[], options?: VRouterOptions): VRouter;
-declare function useVRouter(key?: string, routes?: VRouteRaw[], options?: VRouterOptions): VRouter;
-
-export { type VRoute, type VRouteComponent, type VRouteId, type VRouteLazyComponent, type VRouteMatchedData, type VRouteMeta, type VRouteNormalized, type VRouteRaw, type VRouteRenderComponent, type VRouter, type VRouterData, type VRouterOptions, VRouterView, type VRoutesMap, type VirouPluginOptions, createVRouter, useVRouter, virou, virouSymbol };

package/dist/index.mjs

@@ -1,182 +0,0 @@
-import { defineAsyncComponent, ref, shallowRef, watchEffect, inject, useId, provide, getCurrentInstance, onScopeDispose, defineComponent, h, Suspense, KeepAlive } from 'vue';
-import { addRoute, createRouter, findRoute } from 'rou3';
-import { joinURL, parseURL } from 'ufo';
-
-const renderListCache = /* @__PURE__ */ new WeakMap();
-function normalizeComponent(component) {
-  if (typeof component === "function" && component.length === 0) {
-    return defineAsyncComponent(component);
-  }
-  return component;
-}
-function registerRoutes(ctx, routes, registry, parentId) {
-  for (const { path, meta, component, children } of routes) {
-    const fullPath = joinURL(parentId?.[0] ?? "/", path);
-    const depth = (parentId?.[1] ?? -1) + 1;
-    const id = Object.freeze([fullPath, depth]);
-    registry.set(id, {
-      meta,
-      component: normalizeComponent(component),
-      parentId
-    });
-    if (children && children.length) {
-      registerRoutes(ctx, children, registry, id);
-    }
-    addRoute(ctx, "GET", fullPath, { id, meta });
-  }
-}
-function createRenderList(data, routes) {
-  let cacheForRoutes = renderListCache.get(routes);
-  if (!cacheForRoutes) {
-    cacheForRoutes = /* @__PURE__ */ new Map();
-    renderListCache.set(routes, cacheForRoutes);
-  }
-  const cached = cacheForRoutes.get(data.id);
-  if (cached) {
-    return cached;
-  }
-  const depth = data.id[1];
-  const list = Array.from({ length: depth });
-  let idx = depth;
-  let cursor = routes.get(data.id);
-  while (cursor) {
-    list[idx--] = cursor.component;
-    cursor = cursor.parentId !== void 0 ? routes.get(cursor.parentId) : void 0;
-  }
-  cacheForRoutes.set(data.id, list);
-  return list;
-}
-
-const virouSymbol = Symbol("virou");
-function createVRouter(routes, options) {
-  const context = createRouter();
-  const routeRegistry = /* @__PURE__ */ new Map();
-  registerRoutes(context, routes, routeRegistry);
-  const activePath = ref(options?.initialPath ?? "/");
-  const snapshot = () => {
-    const matchedRoute = findRoute(context, "GET", activePath.value);
-    const _renderList = matchedRoute ? createRenderList(matchedRoute.data, routeRegistry) : null;
-    const { pathname, hash, search } = parseURL(activePath.value);
-    return {
-      fullPath: activePath.value,
-      path: pathname,
-      search,
-      hash,
-      meta: matchedRoute?.data.meta,
-      params: matchedRoute?.params,
-      _renderList
-    };
-  };
-  const route = shallowRef(snapshot());
-  const unwatch = watchEffect(() => {
-    route.value = snapshot();
-  });
-  return {
-    context,
-    routes: routeRegistry,
-    activePath,
-    route,
-    _isGlobal: options?._isGlobal ?? false,
-    _deps: 0,
-    _dispose: unwatch
-  };
-}
-function useVRouter(...args) {
-  if (typeof args[0] !== "string") {
-    args.unshift(inject(virouSymbol, useId()));
-  }
-  const [key, routes = [], options = {}] = args;
-  if (!key || typeof key !== "string") {
-    throw new TypeError(`[virou] [useVRouter] key must be a string: ${key}`);
-  }
-  provide(virouSymbol, key);
-  const vm = getCurrentInstance();
-  if (!vm) {
-    throw new TypeError("[virou] [useVRouter] useVRouter must be called in setup()");
-  }
-  const virou = vm.proxy?.$virou;
-  if (!virou) {
-    throw new Error("[virou] [useVRouter] virou plugin not installed");
-  }
-  if (routes.length) {
-    if (virou.get(key)) {
-      throw new Error(`[virou] [useVRouter] router with key "${key}" already exists`);
-    }
-    virou.set(key, createVRouter(routes, options));
-  }
-  const router = virou.get(key);
-  if (!router) {
-    throw new Error(`[virou] [useVRouter] router with key "${key}" not found`);
-  }
-  router._deps++;
-  onScopeDispose(() => {
-    router._deps--;
-    if (router._deps === 0 && !router._isGlobal) {
-      router._dispose();
-      virou.delete(key);
-    }
-  });
-  return {
-    route: router.route,
-    router: {
-      addRoute: (route) => {
-        registerRoutes(router.context, [route], router.routes);
-      },
-      replace: (path) => {
-        router.activePath.value = path;
-      },
-      _depthKey: Symbol.for(key)
-    }
-  };
-}
-
-const VRouterView = defineComponent({
-  name: "VRouterView",
-  inheritAttrs: false,
-  props: {
-    routerKey: String,
-    keepAlive: { type: Boolean, default: false },
-    viewKey: { type: [String, Function] }
-  },
-  slots: Object,
-  setup(props, { slots, attrs }) {
-    const key = props.routerKey ?? inject(virouSymbol);
-    if (key === void 0) {
-      throw new Error("[virou] [VRouterView] routerKey is required");
-    }
-    const { route, router } = useVRouter(key);
-    const depth = inject(router._depthKey, 0);
-    provide(router._depthKey, depth + 1);
-    return () => {
-      const component = route.value._renderList?.[depth];
-      if (!component) {
-        return slots.default?.({ Component: null, route: route.value }) ?? null;
-      }
-      const vnodeKey = typeof props.viewKey === "function" ? props.viewKey(route.value, key) : props.viewKey ?? `${key}-${depth}-${route.value.path}`;
-      const suspenseVNode = h(
-        Suspense,
-        null,
-        {
-          default: () => h(component, { key: vnodeKey, ...attrs }),
-          fallback: () => slots.fallback?.({ route: route.value }) ?? null
-        }
-      );
-      const vnode = props.keepAlive ? h(KeepAlive, null, { default: () => suspenseVNode }) : suspenseVNode;
-      return slots.default?.({ Component: vnode, route: route.value }) ?? vnode;
-    };
-  }
-});
-
-const virou = (app, options = {}) => {
-  const { routers } = options;
-  const map = /* @__PURE__ */ new Map();
-  app.config.globalProperties.$virou = map;
-  app.component("VRouterView", VRouterView);
-  if (routers) {
-    for (const [key, router] of Object.entries(routers)) {
-      map.set(key, createVRouter(router.routes, { ...router.options, _isGlobal: true }));
-    }
-  }
-};
-
-export { VRouterView, createVRouter, useVRouter, virou, virouSymbol };