@kitbag/router 0.20.8 → 0.20.9

package/dist/main.d.ts

@@ -1,4 +1,6 @@
 import { withParams } from './services/withParams';
+import { RouterAssets } from './services/createRouterAssets';
+import { RegisteredRouter } from './types/register';
 export * from './types/createRouteOptions';
 export * from './types/hooks';
 export * from './types/paramTypes';
@@ -59,7 +61,7 @@ export declare const query: typeof withParams;
  * @returns {RouteHookRemove} A function that removes the added hook.
  * @group Hooks
  */
-export declare const onBeforeRouteLeave: import('./main').AddRouterBeforeRouteHook<any, string | number | symbol>;
+export declare const onBeforeRouteLeave: RouterAssets<RegisteredRouter>['onBeforeRouteLeave'];
 /**
  * Registers a hook that is called before a route is updated. Must be called from setup.
  * This is particularly useful for handling changes in route parameters or query while staying within the same component.
@@ -68,7 +70,7 @@ export declare const onBeforeRouteLeave: import('./main').AddRouterBeforeRouteHo
  * @returns {RouteHookRemove} A function that removes the added hook.
  * @group Hooks
  */
-export declare const onBeforeRouteUpdate: import('./main').AddRouterBeforeRouteHook<any, string | number | symbol>;
+export declare const onBeforeRouteUpdate: RouterAssets<RegisteredRouter>['onBeforeRouteUpdate'];
 /**
  * Registers a hook that is called after a route has been left. Must be called during setup.
  * This can be used for cleanup actions after the component is no longer active, ensuring proper resource management.
@@ -77,7 +79,7 @@ export declare const onBeforeRouteUpdate: import('./main').AddRouterBeforeRouteH
  * @returns {RouteHookRemove} A function that removes the added hook.
  * @group Hooks
  */
-export declare const onAfterRouteLeave: import('./main').AddRouterAfterRouteHook<any, string | number | symbol>;
+export declare const onAfterRouteLeave: RouterAssets<RegisteredRouter>['onAfterRouteLeave'];
 /**
  * Registers a hook that is called after a route has been updated. Must be called during setup.
  * This is ideal for responding to updates within the same route, such as parameter changes, without full component reloads.
@@ -86,7 +88,7 @@ export declare const onAfterRouteLeave: import('./main').AddRouterAfterRouteHook
  * @returns {RouteHookRemove} A function that removes the added hook.
  * @group Hooks
  */
-export declare const onAfterRouteUpdate: import('./main').AddRouterAfterRouteHook<any, string | number | symbol>;
+export declare const onAfterRouteUpdate: RouterAssets<RegisteredRouter>['onAfterRouteUpdate'];
 /**
  * A guard to verify if a route or unknown value matches a given route name.
  *
@@ -94,44 +96,7 @@ export declare const onAfterRouteUpdate: import('./main').AddRouterAfterRouteHoo
  * @returns True if the current route matches the given route name, false otherwise.
  * @group Type Guards
  */
-export declare const isRoute: {
-    (route: unknown): route is import('./main').RouterRoute;
-    <TRoute extends import('./main').RouterRoute<Readonly<{
-        id: any;
-        matched: any;
-        matches: any;
-        name: any;
-        query: URLSearchParams;
-        hash: string;
-        params: {
-            [x: string]: unknown;
-            [x: number]: unknown;
-            [x: symbol]: unknown;
-        };
-        state: import('./types/state').ExtractRouteStateParamsAsOptional<any>;
-        href: import('./main').Url;
-    }>>, TRouteName extends any>(route: TRoute, routeName: TRouteName, options: import('./guards/routes').IsRouteOptions & {
-        exact: true;
-    }): route is TRoute & {
-        name: TRouteName;
-    };
-    <TRoute extends import('./main').RouterRoute<Readonly<{
-        id: any;
-        matched: any;
-        matches: any;
-        name: any;
-        query: URLSearchParams;
-        hash: string;
-        params: {
-            [x: string]: unknown;
-            [x: number]: unknown;
-            [x: symbol]: unknown;
-        };
-        state: import('./types/state').ExtractRouteStateParamsAsOptional<any>;
-        href: import('./main').Url;
-    }>>, TRouteName extends TRoute["name"]>(route: TRoute, routeName: TRouteName, options?: import('./guards/routes').IsRouteOptions): route is TRoute extends import('./main').RouterRoute ? TRouteName extends TRoute["matches"][number]["name"] ? TRoute : never : never;
-    (route: unknown, routeName?: string, options?: import('./guards/routes').IsRouteOptions): boolean;
-};
+export declare const isRoute: RouterAssets<RegisteredRouter>['isRoute'];
 /**
  * A component to render the current route's component.
  *
@@ -139,17 +104,7 @@ export declare const isRoute: {
  * @returns The router view component.
  * @group Components
  */
-export declare const RouterView: import('vue').DefineSetupFnComponent<import('./components/routerView').RouterViewProps, import('vue').EmitsOptions, import('vue').SlotsType<{
-    default?: (props: {
-        route: import('./main').RouterRoute;
-        component: import('vue').Component;
-        rejection: import('vue').UnwrapRef<import('./services/createRouterReject').RouterRejection>;
-    }) => import('vue').VNode;
-}>, import('./components/routerView').RouterViewProps & ({
-    [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;
-} | {
-    [x: `on${Capitalize<string>}`]: ((...args: never) => any) | undefined;
-}), import('vue').PublicProps>;
+export declare const RouterView: RouterAssets<RegisteredRouter>['RouterView'];
 /**
  * A component to render a link to a route or any url.
  *
@@ -157,35 +112,7 @@ export declare const RouterView: import('vue').DefineSetupFnComponent<import('./
  * @returns The router link component.
  * @group Components
  */
-export declare const RouterLink: import('vue').DefineSetupFnComponent<import('./main').RouterLinkProps<import('./main').Router>, import('vue').EmitsOptions, import('vue').SlotsType<{
-    default?: (props: {
-        route: import('./main').ResolvedRoute | undefined;
-        isMatch: boolean;
-        isExactMatch: boolean;
-        isActive: boolean;
-        isExactActive: boolean;
-        isExternal: boolean;
-    }) => import('vue').VNode[];
-}>, import('./main').RouterPushOptions & ({
-    to: import('./main').Url | Readonly<{
-        id: string;
-        matched: import('./main').CreatedRouteOptions;
-        matches: import('./main').CreatedRouteOptions[];
-        name: string;
-        query: URLSearchParams;
-        hash: string;
-        params: {
-            [x: string]: unknown;
-        };
-        state: import('./types/state').ExtractRouteStateParamsAsOptional<Record<string, import('./main').Param>>;
-        href: import('./main').Url;
-    }> | import('./main').ToCallback<import('./main').Router>;
-    prefetch?: import('./main').PrefetchConfig;
-} & ({
-    [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;
-} | {
-    [x: `on${Capitalize<string>}`]: ((...args: never) => any) | undefined;
-})), import('vue').PublicProps>;
+export declare const RouterLink: RouterAssets<RegisteredRouter>['RouterLink'];
 /**
  * A composition to access the current route or verify a specific route name within a Vue component.
  * This function provides two overloads:
@@ -201,59 +128,7 @@ export declare const RouterLink: import('vue').DefineSetupFnComponent<import('./
  * @throws {UseRouteInvalidError} Throws an error if the provided route name is not valid or does not match the current route.
  * @group Compositions
  */
-export declare const useRoute: {
-    (): import('./main').RouterRoute<Readonly<{
-        id: any;
-        matched: any;
-        matches: any;
-        name: any;
-        query: URLSearchParams;
-        hash: string;
-        params: {
-            [x: string]: unknown;
-            [x: number]: unknown;
-            [x: symbol]: unknown;
-        };
-        state: import('./types/state').ExtractRouteStateParamsAsOptional<any>;
-        href: import('./main').Url;
-    }>>;
-    <TRouteName extends any>(routeName: TRouteName, options: import('./guards/routes').IsRouteOptions & {
-        exact: true;
-    }): import('./main').RouterRoute<Readonly<{
-        id: any;
-        matched: any;
-        matches: any;
-        name: any;
-        query: URLSearchParams;
-        hash: string;
-        params: {
-            [x: string]: unknown;
-            [x: number]: unknown;
-            [x: symbol]: unknown;
-        };
-        state: import('./types/state').ExtractRouteStateParamsAsOptional<any>;
-        href: import('./main').Url;
-    }>> & {
-        name: TRouteName;
-    };
-    <TRouteName extends any>(routeName: TRouteName, options?: import('./guards/routes').IsRouteOptions): import('./main').RouterRoute<Readonly<{
-        id: any;
-        matched: any;
-        matches: any;
-        name: any;
-        query: URLSearchParams;
-        hash: string;
-        params: {
-            [x: string]: unknown;
-            [x: number]: unknown;
-            [x: symbol]: unknown;
-        };
-        state: import('./types/state').ExtractRouteStateParamsAsOptional<any>;
-        href: import('./main').Url;
-    }>> & {
-        name: `${TRouteName}${string}`;
-    };
-};
+export declare const useRoute: RouterAssets<RegisteredRouter>['useRoute'];
 /**
  * A composition to access the installed router instance within a Vue component.
  *
@@ -262,17 +137,14 @@ export declare const useRoute: {
  *         ensuring the component does not operate without routing functionality.
  * @group Compositions
  */
-export declare const useRouter: () => import('./main').Router;
+export declare const useRouter: RouterAssets<RegisteredRouter>['useRouter'];
 /**
  * A composition to access a specific query value from the current route.
  *
  * @returns The query value from the router.
  * @group Compositions
  */
-export declare const useQueryValue: {
-    (key: import('vue').MaybeRefOrGetter<string>): import('./compositions/useQueryValue').UseQueryValue<string>;
-    <TParam extends import('./main').Param>(key: import('vue').MaybeRefOrGetter<string>, param: TParam): import('./compositions/useQueryValue').UseQueryValue<import('./types/params').ExtractParamType<TParam>>;
-};
+export declare const useQueryValue: RouterAssets<RegisteredRouter>['useQueryValue'];
 /**
  * A composition to export much of the functionality that drives RouterLink component.
  * Also exports some useful context about routes relationship to current URL and convenience methods
@@ -284,16 +156,7 @@ export declare const useQueryValue: {
  * @returns {UseLink} Reactive context values for as well as navigation methods.
  * @group Compositions
  */
-export declare const useLink: {
-    <TRouteKey extends any>(name: import('vue').MaybeRefOrGetter<TRouteKey>, params?: import('vue').MaybeRefOrGetter<Record<string, unknown> | {
-        [x: string]: unknown;
-        [x: number]: unknown;
-        [x: symbol]: unknown;
-    }> | undefined, options?: import('vue').MaybeRefOrGetter<import('./main').UseLinkOptions> | undefined): import('./main').UseLink;
-    (url: import('vue').MaybeRefOrGetter<import('./main').Url>, options?: import('vue').MaybeRefOrGetter<import('./main').UseLinkOptions>): import('./main').UseLink;
-    (resolvedRoute: import('vue').MaybeRefOrGetter<import('./main').ResolvedRoute | undefined>, options?: import('vue').MaybeRefOrGetter<import('./main').UseLinkOptions>): import('./main').UseLink;
-    (source: import('vue').MaybeRefOrGetter<string | import('./main').ResolvedRoute | undefined>, paramsOrOptions?: import('vue').MaybeRefOrGetter<Record<PropertyKey, unknown> | import('./main').UseLinkOptions>, maybeOptions?: import('vue').MaybeRefOrGetter<import('./main').UseLinkOptions>): import('./main').UseLink;
-};
+export declare const useLink: RouterAssets<RegisteredRouter>['useLink'];
 declare module 'vue' {
     interface GlobalComponents {
         RouterView: typeof RouterView;

package/dist/services/createRouterAssets.d.ts

@@ -7,7 +7,7 @@ import { createUseRouter } from '../compositions/useRouter';
 import { createUseQueryValue } from '../compositions/useQueryValue';
 import { createUseLink } from '../compositions/useLink';
 import { createIsRoute } from '../guards/routes';
-type RouterAssets<TRouter extends Router> = {
+export type RouterAssets<TRouter extends Router> = {
     /**
      * Registers a hook that is called before a route is left. Must be called from setup.
      * This is useful for performing actions or cleanups before navigating away from a route component.
@@ -115,4 +115,3 @@ type RouterAssets<TRouter extends Router> = {
 };
 export declare function createRouterAssets<TRouter extends Router>(router: TRouter): RouterAssets<TRouter>;
 export declare function createRouterAssets<TRouter extends Router>(routerKey: InjectionKey<TRouter>): RouterAssets<TRouter>;
-export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kitbag/router",
   "private": false,
-  "version": "0.20.8",
+  "version": "0.20.9",
   "bugs": {
     "url": "https://github.com/kitbagjs/router/issues"
   },
@@ -17,7 +17,7 @@
   "scripts": {
     "build": "vite build",
     "build:watch": "vite build --watch --minify=false",
-    "test": "vitest --typecheck",
+    "test": "vitest",
     "lint": "eslint ./src",
     "lint:fix": "eslint ./src --fix",
     "types": "vue-tsc --noEmit",