vue-multi-router 0.1.1 → 0.1.2

package/README.md

@@ -189,12 +189,16 @@ Composable for accessing multi-router outside a context.
 Composable for use inside a `MultiRouterContext`.
 
 **Returns:**
-- `router: ComputedRef<Router>` - Vue Router instance for this context
-- `route: ComputedRef<RouteLocationNormalized>` - Current route
+- `manager: useMultiRouter()` - MultiRouter manager instance
+- `contextKey: string` - This context's key
 - `isActive: ComputedRef<boolean>` - Whether this context is active
 - `isHistoryActive: ComputedRef<boolean>` - Whether this context controls browser URL
+- `activeContextKey: ComputedRef<string>` - Currently active context key
+- `activeHistoryContextKey: ComputedRef<string>` - Currently active history context key
+- `historyEnabled: ComputedRef<boolean>` - Whether history is enabled for this context
 - `activate(updateHistory?: boolean): void` - Activate this context
-- `contextKey: string` - This context's key
+- `setActive(contextKey: string, updateHistory?: boolean): void` - Activate a context
+- `hasContext(contextKey: string): boolean` - Check if context exists
 
 ## Examples
 

package/dist/index.d.ts

@@ -1,11 +1,10 @@
-import * as vue0 from "vue";
+import * as vue7 from "vue";
 import { App, InjectionKey, PropType } from "vue";
 import { Router, RouterHistory, RouterOptions } from "vue-router";
 
 //#region src/history/types.d.ts
 type HistoryLocation = string;
 type HistoryState = Record<string, any>;
-type HistoryBuilder = () => RouterHistory;
 declare enum NavigationType {
   pop = "pop",
   push = "push",
@@ -103,7 +102,7 @@ interface MultiRouterHistoryManagerOptions {
   onContextActivate?: (contextKey: string) => void;
 }
 declare class MultiRouterHistoryManager {
-  private baseHistory;
+  private history;
   private stacks;
   private activeHistoryContextKey;
   private historyContextStack;
@@ -111,7 +110,7 @@ declare class MultiRouterHistoryManager {
   private baseHistoryCleanup;
   private contextSwitchMode;
   private onContextActivate?;
-  constructor(historyBuilder: HistoryBuilder, options?: MultiRouterHistoryManagerOptions);
+  constructor(history: RouterHistory, options?: MultiRouterHistoryManagerOptions);
   private restoreContextStacks;
   get base(): string;
   get location(): HistoryLocation;
@@ -166,8 +165,7 @@ type MultiRouterInterface = {
   getByContextName: (name: string) => Router;
   install: (app: App) => void;
 };
-type CustomRouterOptions = Omit<RouterOptions, 'history'> & {
-  history: () => RouterHistory;
+type CustomRouterOptions = RouterOptions & {
   historyOptions?: MultiRouterHistoryManagerOptions;
 };
 declare function createMultiRouter(options: CustomRouterOptions): MultiRouterInterface;
@@ -177,7 +175,7 @@ declare function onMultiRouterContextActivate(callback: (name: string) => void):
 //#endregion
 //#region src/components/MultiRouterContext.vue.d.ts
 declare const _default: typeof __VLS_export$1;
-declare const __VLS_export$1: vue0.DefineComponent<vue0.ExtractPropTypes<{
+declare const __VLS_export$1: vue7.DefineComponent<vue7.ExtractPropTypes<{
   type: {
     type: StringConstructor;
     required: true;
@@ -230,9 +228,9 @@ declare const __VLS_export$1: vue0.DefineComponent<vue0.ExtractPropTypes<{
     type: PropType<string | null>;
     default: null;
   };
-}>, () => vue0.VNode<vue0.RendererNode, vue0.RendererElement, {
+}>, () => vue7.VNode<vue7.RendererNode, vue7.RendererElement, {
   [key: string]: any;
-}>, {}, {}, {}, vue0.ComponentOptionsMixin, vue0.ComponentOptionsMixin, {}, string, vue0.PublicProps, Readonly<vue0.ExtractPropTypes<{
+}>, {}, {}, {}, vue7.ComponentOptionsMixin, vue7.ComponentOptionsMixin, {}, string, vue7.PublicProps, Readonly<vue7.ExtractPropTypes<{
   type: {
     type: StringConstructor;
     required: true;
@@ -290,11 +288,11 @@ declare const __VLS_export$1: vue0.DefineComponent<vue0.ExtractPropTypes<{
   default: boolean;
   activator: boolean;
   preventClass: string | null;
-}, {}, {}, {}, string, vue0.ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, string, vue7.ComponentProvideOptions, true, {}, any>;
 //#endregion
 //#region src/components/MultiRouterContextActivator.vue.d.ts
 declare const _default$1: typeof __VLS_export;
-declare const __VLS_export: vue0.DefineComponent<vue0.ExtractPropTypes<{
+declare const __VLS_export: vue7.DefineComponent<vue7.ExtractPropTypes<{
   as: {
     type: PropType<string | null>;
     default: null;
@@ -304,11 +302,11 @@ declare const __VLS_export: vue0.DefineComponent<vue0.ExtractPropTypes<{
     default: null;
     required: false;
   };
-}>, (() => vue0.VNode<vue0.RendererNode, vue0.RendererElement, {
+}>, (() => vue7.VNode<vue7.RendererNode, vue7.RendererElement, {
   [key: string]: any;
-}>[] | undefined) | (() => vue0.VNode<vue0.RendererNode, vue0.RendererElement, {
+}>[] | undefined) | (() => vue7.VNode<vue7.RendererNode, vue7.RendererElement, {
   [key: string]: any;
-}>), {}, {}, {}, vue0.ComponentOptionsMixin, vue0.ComponentOptionsMixin, {}, string, vue0.PublicProps, Readonly<vue0.ExtractPropTypes<{
+}>), {}, {}, {}, vue7.ComponentOptionsMixin, vue7.ComponentOptionsMixin, {}, string, vue7.PublicProps, Readonly<vue7.ExtractPropTypes<{
   as: {
     type: PropType<string | null>;
     default: null;
@@ -321,7 +319,7 @@ declare const __VLS_export: vue0.DefineComponent<vue0.ExtractPropTypes<{
 }>> & Readonly<{}>, {
   preventClass: string | null;
   as: string | null;
-}, {}, {}, {}, string, vue0.ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, string, vue7.ComponentProvideOptions, true, {}, any>;
 //#endregion
 //#region src/contextManager.d.ts
 type ContextInterface = {
@@ -333,12 +331,12 @@ type ContextInterface = {
 };
 interface ActiveContextInterface {
   key: string;
-  context: ContextInterface;
+  data: ContextInterface;
 }
 type ContextInitListener = (key: string) => void;
 type MakeRouterFn = (contextKey: string, history: RouterHistory) => Router;
 type HistoryManagerOptions = {
-  historyBuilder: HistoryBuilder;
+  history: RouterHistory;
 } & MultiRouterHistoryManagerOptions;
 declare class MultiRouterManagerInstance {
   private makeRouter;
@@ -351,9 +349,9 @@ declare class MultiRouterManagerInstance {
   constructor(app: App, historyManagerOptions: HistoryManagerOptions, makeRouter: MakeRouterFn);
   getHistoryManager(): MultiRouterHistoryManager;
   getActiveContext(): ActiveContextInterface | undefined;
-  getActiveContextRef(): vue0.ShallowRef<ActiveContextInterface | undefined, ActiveContextInterface | undefined>;
+  getActiveContextRef(): vue7.ShallowRef<ActiveContextInterface | undefined, ActiveContextInterface | undefined>;
   getActiveHistoryContext(): ActiveContextInterface | undefined;
-  getActiveHistoryContextRef(): vue0.ShallowRef<ActiveContextInterface | undefined, ActiveContextInterface | undefined>;
+  getActiveHistoryContextRef(): vue7.ShallowRef<ActiveContextInterface | undefined, ActiveContextInterface | undefined>;
   setActive(key: string, updateHistory: boolean): boolean;
   clearHistoryContext(key: string): void;
   markAsStarted(): void;
@@ -383,8 +381,9 @@ declare class MultiRouterManagerInstance {
  */
 declare function useMultiRouter(): {
   manager: MultiRouterManagerInstance;
-  activeContextKey: vue0.ComputedRef<string | undefined>;
-  activeHistoryContextKey: vue0.ComputedRef<string | undefined>;
+  activeContext: vue7.ComputedRef<ActiveContextInterface | undefined>;
+  activeContextKey: vue7.ComputedRef<string | undefined>;
+  activeHistoryContextKey: vue7.ComputedRef<string | undefined>;
   setActive: (contextKey: string, updateHistory?: boolean) => void;
   hasContext: (contextKey: string) => boolean;
 };
@@ -393,11 +392,11 @@ declare function useMultiRouter(): {
 declare function useMultiRouterContext(): {
   manager: MultiRouterManagerInstance;
   contextKey: string;
-  isActive: vue0.ComputedRef<boolean>;
-  isHistoryActive: vue0.ComputedRef<boolean>;
-  activeContextKey: vue0.ComputedRef<string | undefined>;
-  activeHistoryContextKey: vue0.ComputedRef<string | undefined>;
-  historyEnabled: vue0.ComputedRef<boolean>;
+  isActive: vue7.ComputedRef<boolean>;
+  isHistoryActive: vue7.ComputedRef<boolean>;
+  activeContextKey: vue7.ComputedRef<string | undefined>;
+  activeHistoryContextKey: vue7.ComputedRef<string | undefined>;
+  historyEnabled: vue7.ComputedRef<boolean>;
   activate: (updateHistory?: boolean) => void;
   setActive: (contextKey: string, updateHistory?: boolean) => void;
   hasContext: (contextKey: string) => boolean;
@@ -407,4 +406,4 @@ declare function useMultiRouterContext(): {
 declare const multiRouterContextManagerKey: InjectionKey<MultiRouterManagerInstance>;
 declare const multiRouterContextKey: InjectionKey<string>;
 //#endregion
-export { type ContextSwitchMode, type HistoryBuilder, type HistoryLocation, type HistoryState, _default as MultiRouterContext, _default$1 as MultiRouterContextActivator, type MultiRouterHistoryManagerOptions, type NavigationCallback, type NavigationInformation, type VirtualStack, createMultiRouter, multiRouterContextKey, multiRouterContextManagerKey, onMultiRouterContextActivate, useMultiRouter, useMultiRouterContext };
+export { type ContextSwitchMode, type HistoryLocation, type HistoryState, _default as MultiRouterContext, _default$1 as MultiRouterContextActivator, type MultiRouterHistoryManagerOptions, type NavigationCallback, type NavigationInformation, type VirtualStack, createMultiRouter, multiRouterContextKey, multiRouterContextManagerKey, onMultiRouterContextActivate, useMultiRouter, useMultiRouterContext };

package/dist/index.js

@@ -372,7 +372,7 @@ var ContextHistoryProxy = class {
 const CONTEXT_KEY_STATE = "__multiRouterContext";
 const STACK_INDEX_STATE = "__multiRouterStackIndex";
 var MultiRouterHistoryManager = class {
-	baseHistory;
+	history;
 	stacks;
 	activeHistoryContextKey = null;
 	historyContextStack = [];
@@ -380,12 +380,12 @@ var MultiRouterHistoryManager = class {
 	baseHistoryCleanup = null;
 	contextSwitchMode;
 	onContextActivate;
-	constructor(historyBuilder, options) {
-		this.baseHistory = historyBuilder();
+	constructor(history, options) {
+		this.history = history;
 		this.stacks = new VirtualStackManager(options?.storageAdapter);
 		this.contextSwitchMode = options?.contextSwitchMode ?? "replace";
 		this.onContextActivate = options?.onContextActivate;
-		this.baseHistoryCleanup = this.baseHistory.listen(this.handlePopState.bind(this));
+		this.baseHistoryCleanup = this.history.listen(this.handlePopState.bind(this));
 		this.restoreContextStacks();
 	}
 	restoreContextStacks() {
@@ -397,13 +397,13 @@ var MultiRouterHistoryManager = class {
 		});
 	}
 	get base() {
-		return this.baseHistory.base;
+		return this.history.base;
 	}
 	get location() {
-		return this.baseHistory.location;
+		return this.history.location;
 	}
 	get state() {
-		return this.baseHistory.state;
+		return this.history.state;
 	}
 	createContextHistory(contextKey, options) {
 		if (this.stacks.has(contextKey)) return new ContextHistoryProxy(contextKey, this);
@@ -418,19 +418,19 @@ var MultiRouterHistoryManager = class {
 				let virtualStack;
 				if (restoredStack) {
 					if (isLastActive && historyEnabled) {
-						const browserUrl = this.baseHistory.location;
+						const browserUrl = this.history.location;
 						restoredStack.entries[restoredStack.position] = {
 							location: browserUrl,
-							state: this.baseHistory.state ?? {}
+							state: this.history.state ?? {}
 						};
 					}
 					virtualStack = restoredStack;
 				} else if (isLastActive && historyEnabled) {
-					const browserUrl = this.baseHistory.location;
+					const browserUrl = this.history.location;
 					virtualStack = this.createInitialVirtualStack(browserUrl);
 				} else if (initialLocation) virtualStack = this.createInitialVirtualStack(initialLocation);
 				else {
-					const browserUrl = this.baseHistory.location;
+					const browserUrl = this.history.location;
 					virtualStack = this.createInitialVirtualStack(browserUrl);
 				}
 				return this.finalizeContextCreation(contextKey, virtualStack, isLastActive, historyEnabled);
@@ -557,13 +557,13 @@ var MultiRouterHistoryManager = class {
 			[CONTEXT_KEY_STATE]: contextKey,
 			[STACK_INDEX_STATE]: context.virtualStack.position
 		};
-		if (this.contextSwitchMode === "push") if (entry.location !== this.baseHistory.location) this.baseHistory.push(entry.location, state);
-		else this.baseHistory.replace(entry.location, state);
-		else this.baseHistory.replace(entry.location, state);
+		if (this.contextSwitchMode === "push") if (entry.location !== this.history.location) this.history.push(entry.location, state);
+		else this.history.replace(entry.location, state);
+		else this.history.replace(entry.location, state);
 	}
 	handlePopState(to, from, info) {
-		const stateContextKey = this.baseHistory.state?.[CONTEXT_KEY_STATE];
-		const stateStackIndex = this.baseHistory.state?.[STACK_INDEX_STATE];
+		const stateContextKey = this.history.state?.[CONTEXT_KEY_STATE];
+		const stateStackIndex = this.history.state?.[STACK_INDEX_STATE];
 		let ownerContextKey = null;
 		let targetStackIndex = null;
 		if (stateContextKey && this.stacks.has(stateContextKey)) {
@@ -588,7 +588,7 @@ var MultiRouterHistoryManager = class {
 	push(contextKey, to, data) {
 		const stackIndex = this.stacks.push(contextKey, to, data ?? {});
 		const historyEnabled = this.stacks.isHistoryEnabled(contextKey);
-		if (this.activeHistoryContextKey === contextKey && historyEnabled) this.baseHistory.push(to, {
+		if (this.activeHistoryContextKey === contextKey && historyEnabled) this.history.push(to, {
 			...data,
 			[CONTEXT_KEY_STATE]: contextKey,
 			[STACK_INDEX_STATE]: stackIndex
@@ -597,7 +597,7 @@ var MultiRouterHistoryManager = class {
 	replace(contextKey, to, data) {
 		const stackIndex = this.stacks.replace(contextKey, to, data ?? {});
 		const historyEnabled = this.stacks.isHistoryEnabled(contextKey);
-		if (this.activeHistoryContextKey === contextKey && historyEnabled) this.baseHistory.replace(to, {
+		if (this.activeHistoryContextKey === contextKey && historyEnabled) this.history.replace(to, {
 			...data,
 			[CONTEXT_KEY_STATE]: contextKey,
 			[STACK_INDEX_STATE]: stackIndex
@@ -605,7 +605,7 @@ var MultiRouterHistoryManager = class {
 	}
 	go(contextKey, delta, triggerListeners = true) {
 		if (!this.stacks.has(contextKey)) throw new Error(`[MultiRouterHistory] Context "${contextKey}" not registered`);
-		if (this.activeHistoryContextKey === contextKey) this.baseHistory.go(delta, triggerListeners);
+		if (this.activeHistoryContextKey === contextKey) this.history.go(delta, triggerListeners);
 		else {
 			const result = this.stacks.navigate(contextKey, delta);
 			if (result && triggerListeners) this.stacks.notifyListeners(contextKey, result.to, result.from, {
@@ -619,13 +619,13 @@ var MultiRouterHistoryManager = class {
 		return this.stacks.addListener(contextKey, callback);
 	}
 	getContextLocation(contextKey) {
-		return this.stacks.getLocation(contextKey, this.baseHistory.location);
+		return this.stacks.getLocation(contextKey, this.history.location);
 	}
 	getContextState(contextKey) {
 		return this.stacks.getState(contextKey);
 	}
 	createHref(location) {
-		return this.baseHistory.createHref(location);
+		return this.history.createHref(location);
 	}
 	destroy() {
 		if (this.baseHistoryCleanup) {
@@ -633,7 +633,7 @@ var MultiRouterHistoryManager = class {
 			this.baseHistoryCleanup = null;
 		}
 		this.stacks.clear();
-		this.baseHistory.destroy();
+		this.history.destroy();
 	}
 	getLastActiveContextKey() {
 		return this.stacks.getStoredActiveContext();
@@ -645,15 +645,15 @@ var MultiRouterHistoryManager = class {
 var MultiRouterManagerInstance = class {
 	constructor(app, historyManagerOptions, makeRouter) {
 		this.makeRouter = makeRouter;
-		const { historyBuilder, ...historyOptions } = historyManagerOptions;
-		this.historyManager = new MultiRouterHistoryManager(historyBuilder, {
+		const { history, ...historyOptions } = historyManagerOptions;
+		this.historyManager = new MultiRouterHistoryManager(history, {
 			...historyOptions,
 			onContextActivate: (contextKey) => {
 				this.setActive(contextKey, false);
 				const context = this.registered.get(contextKey);
 				if (context?.historyEnabled && this.activeHistoryContext.value?.key !== contextKey) this.activeHistoryContext.value = {
 					key: contextKey,
-					context
+					data: context
 				};
 			}
 		});
@@ -688,7 +688,7 @@ var MultiRouterManagerInstance = class {
 			this.historyManager.removeFromContextStack(key);
 			this.activeContext.value = {
 				key,
-				context: item
+				data: item
 			};
 			modified = true;
 		}
@@ -710,7 +710,7 @@ var MultiRouterManagerInstance = class {
 				const newContext = this.registered.get(newActiveKey);
 				if (newContext) this.activeHistoryContext.value = {
 					key: newActiveKey,
-					context: newContext
+					data: newContext
 				};
 			} else this.activeHistoryContext.value = void 0;
 		}
@@ -746,7 +746,7 @@ var MultiRouterManagerInstance = class {
 				mapMaybePromise(this.historyManager.tryRestoreActiveHistoryContext(key), (restored) => {
 					if (restored && !this.activeHistoryContext.value) this.activeHistoryContext.value = {
 						key,
-						context: this.registered.get(key)
+						data: this.registered.get(key)
 					};
 				});
 				mapMaybePromise(this.historyManager.getLastActiveContextKey(), (resolvedLastActiveKey) => {
@@ -793,7 +793,7 @@ var MultiRouterManagerInstance = class {
 			if (previousContext) {
 				this.activeContext.value = {
 					key: previousKey,
-					context: previousContext
+					data: previousContext
 				};
 				this.historyManager.saveActiveContext(previousKey);
 				return;
@@ -932,7 +932,7 @@ function createMultiRouter(options) {
 				return router;
 			};
 			contextManager = new MultiRouterManagerInstance(app, {
-				historyBuilder: options.history,
+				history: options.history,
 				...options.historyOptions
 			}, makeRouter);
 			app.provide(multiRouterContextManagerKey, contextManager);
@@ -948,6 +948,7 @@ function useMultiRouter() {
 	const manager = inject(multiRouterContextManagerKey);
 	if (!manager) throw new Error("[useMultiRouter] Must be used within MultiRouterContextProvider");
 	const activeContextKey = computed(() => manager.getActiveContextRef().value?.key);
+	const activeContext = computed(() => manager.getActiveContextRef().value);
 	const activeHistoryContextKey = computed(() => manager.getActiveHistoryContextRef().value?.key);
 	const setActive = (contextKey, updateHistory = true) => {
 		manager.setActive(contextKey, updateHistory);
@@ -957,6 +958,7 @@ function useMultiRouter() {
 	};
 	return {
 		manager,
+		activeContext,
 		activeContextKey,
 		activeHistoryContextKey,
 		setActive,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vue-multi-router",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Vue 3 multi router",
   "author": "",
   "license": "MIT",
@@ -31,14 +31,17 @@
     "dev": "tsdown --watch",
     "check": "npm run ts:check && npm run lint:check && npm run format:check && npm run dependency-cruiser:check",
     "ts:check": "vue-tsc --noEmit",
-    "format": "prettier --write src/ playground/src",
-    "format:check": "prettier --check src/ playground/src",
+    "format": "prettier --write src/ playground/src docs/.vitepress/theme",
+    "format:check": "prettier --check src/ playground/src docs/.vitepress/config.ts docs/.vitepress/theme",
     "lint": "eslint . --fix",
     "lint:check": "eslint .",
-    "dependency-cruiser:check": "depcruise --config .dependency-cruiser.cjs src playground/src",
+    "dependency-cruiser:check": "depcruise --config .dependency-cruiser.cjs src playground/src docs/.vitepress/config.ts docs/.vitepress/theme",
     "play": "vite --port 5174",
     "build:playground": "vite build",
     "preview:playground": "vite preview --outDir playground/dist",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs",
     "test": "vitest run",
     "release": "bumpp && npm publish",
     "prepublishOnly": "npm run check && npm run test && npm run build"
@@ -48,6 +51,7 @@
     "vue-router": "^4.0.0"
   },
   "devDependencies": {
+    "vitepress": "^1.6.3",
     "@tailwindcss/vite": "^4.1.18",
     "@types/lodash": "^4.17.21",
     "@types/node": "^25.0.3",