@kitbag/router 0.13.4 → 0.14.0

package/dist/kitbag-router.d.ts

@@ -763,6 +763,10 @@ export declare type ResolvedRoute<TRoute extends Route = Route> = Readonly<{
      * Type for additional data intended to be stored in history state.
      */
     state: ExtractRouteStateParamsAsOptional<TRoute['state']>;
+    /**
+     * String value of the resolved URL.
+     */
+    href: Url;
 }>;
 
 declare type ResolvedRouteQuery = {
@@ -893,10 +897,6 @@ export declare type Router<TRoutes extends Routes = any, __TOptions extends Rout
      * Replaces the current entry in the history stack with a new one.
      */
     replace: RouterReplace<TRoutes>;
-    /**
-     * Finds a route object based on the provided lookup parameters.
-     */
-    find: RouterFind<TRoutes>;
     /**
      * Handles route rejection based on a specified rejection type.
      */
@@ -955,13 +955,6 @@ export declare type Router<TRoutes extends Routes = any, __TOptions extends Rout
     start: () => Promise<void>;
 };
 
-declare type RouterFind<TRoutes extends Routes> = {
-    <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterFindArgs<TRoutes, TSource>): ResolvedRoute | undefined;
-    (url: Url): ResolvedRoute | undefined;
-};
-
-declare type RouterFindArgs<TRoutes extends Routes, TSource extends RoutesName<TRoutes>, TParams = RouteParamsByKey<TRoutes, TSource>> = AllPropertiesAreOptional<TParams> extends true ? [params?: TParams] : [params: TParams];
-
 declare type RouterHistoryMode = 'auto' | 'browser' | 'memory' | 'hash';
 
 /**
@@ -971,7 +964,7 @@ export declare const RouterLink: __VLS_WithTemplateSlots_2<DefineComponent<    {
 /**
 * The url string to navigate to or a callback that returns a url string
 */
-to: Url | ((resolve: RegisteredRouter["resolve"]) => Url);
+to: Url | ResolvedRoute | ToCallback;
 /**
 * Determines what assets are prefetched when router-link is rendered for this route. Overrides route level prefetch.
 */
@@ -980,7 +973,7 @@ prefetch?: PrefetchConfig;
 /**
 * The url string to navigate to or a callback that returns a url string
 */
-to: Url | ((resolve: RegisteredRouter["resolve"]) => Url);
+to: Url | ResolvedRoute | ToCallback;
 /**
 * Determines what assets are prefetched when router-link is rendered for this route. Overrides route level prefetch.
 */
@@ -989,14 +982,14 @@ prefetch?: PrefetchConfig;
 prefetch: PrefetchConfig;
 }, {}, {}, {}, string, ComponentProvideOptions, false, {}>, Readonly<{
     default?: (props: {
-        resolved: string;
+        route: ResolvedRoute | undefined;
         isMatch: boolean;
         isExactMatch: boolean;
         isExternal: boolean;
     }) => unknown;
 }> & {
     default?: (props: {
-        resolved: string;
+        route: ResolvedRoute | undefined;
         isMatch: boolean;
         isExactMatch: boolean;
         isExternal: boolean;
@@ -1068,7 +1061,7 @@ declare type RouterReplace<TRoutes extends Routes> = {
     (url: Url, options?: RouterReplaceOptions): Promise<void>;
 };
 
-declare type RouterReplaceArgs<TRoutes extends Routes, TSource extends RoutesName<TRoutes>, TParams = RouteParamsByKey<TRoutes, TSource>> = AllPropertiesAreOptional<TParams> extends true ? [params?: TParams, options?: RouterReplaceOptions<RouteStateByName<TRoutes, TSource>>] : [params: TParams, options?: RouterReplaceOptions<RouteStateByName<TRoutes, TSource>>];
+declare type RouterReplaceArgs<TRoutes extends Routes, TSource extends RoutesName<TRoutes>> = AllPropertiesAreOptional<RouteParamsByKey<TRoutes, TSource>> extends true ? [params?: RouteParamsByKey<TRoutes, TSource>, options?: RouterReplaceOptions<RouteStateByName<TRoutes, TSource>>] : [params: RouteParamsByKey<TRoutes, TSource>, options?: RouterReplaceOptions<RouteStateByName<TRoutes, TSource>>];
 
 declare type RouterReplaceOptions<TState = unknown> = {
     query?: QuerySource;
@@ -1077,15 +1070,16 @@ declare type RouterReplaceOptions<TState = unknown> = {
 };
 
 declare type RouterResolve<TRoutes extends Routes> = {
-    <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterResolveArgs<TRoutes, TSource>): Url;
-    (url: Url, options?: RouterResolveOptions): Url;
+    <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterResolveArgs<TRoutes, TSource>): ResolvedRoute | undefined;
+    (url: Url, options?: RouterResolveOptions): ResolvedRoute | undefined;
 };
 
-declare type RouterResolveArgs<TRoutes extends Routes, TSource extends RoutesName<TRoutes>, TParams = RouteParamsByKey<TRoutes, TSource>> = AllPropertiesAreOptional<TParams> extends true ? [params?: TParams, options?: RouterResolveOptions] : [params: TParams, options?: RouterResolveOptions];
+declare type RouterResolveArgs<TRoutes extends Routes, TSource extends RoutesName<TRoutes>> = AllPropertiesAreOptional<RouteParamsByKey<TRoutes, TSource>> extends true ? [params?: RouteParamsByKey<TRoutes, TSource>, options?: RouterResolveOptions<RouteStateByName<TRoutes, TSource>>] : [params: RouteParamsByKey<TRoutes, TSource>, options?: RouterResolveOptions<RouteStateByName<TRoutes, TSource>>];
 
-declare type RouterResolveOptions = {
+declare type RouterResolveOptions<TState = unknown> = {
     query?: QuerySource;
     hash?: string;
+    state?: Partial<TState>;
 };
 
 declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
@@ -1095,6 +1089,7 @@ declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
     readonly matches: TRoute['matches'];
     readonly hash: TRoute['hash'];
     readonly update: RouteUpdate<TRoute>;
+    readonly href: TRoute['href'];
     params: TRoute['params'];
     state: TRoute['state'];
     get query(): ResolvedRouteQuery;
@@ -1154,6 +1149,8 @@ declare type RouteWithMatch<TRoute extends RouterRoute, TRouteName extends TRout
 
 declare type StringHasValue<T> = string extends T ? true : '' extends T ? false : T extends string ? true : false;
 
+declare type ToCallback = (resolve: RegisteredRouter['resolve']) => ResolvedRoute | Url | undefined;
+
 declare type ToHash<T extends string | Hash | undefined> = T extends string ? Hash<T> : T extends undefined ? Hash<''> : unknown extends T ? Hash<''> : T;
 
 declare type ToHost<T extends string | Host | undefined> = T extends string ? Host<T, {}> : T extends undefined ? Host<'', {}> : unknown extends T ? Host<'', {}> : T;
@@ -1187,7 +1184,7 @@ export declare type UseLink = {
     /**
      * Resolved URL with params interpolated and query applied. Same value as `router.resolve`.
      */
-    href: ComputedRef<string>;
+    href: ComputedRef<Url | undefined>;
     /**
      * True if route matches current URL or is ancestor of route that matches current URL
      */
@@ -1225,6 +1222,10 @@ export declare function useLink<TRouteKey extends RegisteredRoutesName>(name: Ma
 
 export declare function useLink(url: MaybeRefOrGetter<Url>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
 
+export declare function useLink(resolvedRoute: MaybeRefOrGetter<ResolvedRoute | undefined>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
+
+export declare function useLink(source: MaybeRefOrGetter<string | ResolvedRoute | undefined>, paramsOrOptions?: MaybeRefOrGetter<Record<PropertyKey, unknown> | UseLinkOptions>, maybeOptions?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
+
 declare type UseLinkArgs<TSource extends RegisteredRoutesName, TParams = RouteParamsByKey<RegisteredRoutes, TSource>> = AllPropertiesAreOptional<TParams> extends true ? [params?: MaybeRefOrGetter<TParams>, options?: MaybeRefOrGetter<UseLinkOptions>] : [params: MaybeRefOrGetter<TParams>, options?: MaybeRefOrGetter<UseLinkOptions>];
 
 export declare type UseLinkOptions = RouterResolveOptions & {