@kitbag/router 0.13.4 → 0.14.1

package/dist/kitbag-router.d.ts

@@ -253,7 +253,7 @@ declare type CreateRouteOptionsMatched<TName extends string | undefined = string
  * export const routes = [
  *   createRoute({ name: 'home', path: '/', component: Home }),
  *   createRoute({ name: 'path', path: '/about', component: About }),
- * ]
+ * ] as const
  *
  * const router = createRouter(routes)
  * ```
@@ -750,11 +750,11 @@ export declare type ResolvedRoute<TRoute extends Route = Route> = Readonly<{
     /**
      * Accessor for query string values from user in the current browser location.
      */
-    query: ResolvedRouteQuery;
+    query: URLSearchParams;
     /**
      * Hash value of the route.
      */
-    hash?: string;
+    hash: string;
     /**
      * Key value pair for route params, values will be the user provided value from current browser location.
      */
@@ -763,22 +763,12 @@ 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 = {
-    append: URLSearchParams['append'];
-    delete: URLSearchParams['delete'];
-    entries: URLSearchParams['entries'];
-    forEach: URLSearchParams['forEach'];
-    get: URLSearchParams['get'];
-    getAll: URLSearchParams['getAll'];
-    has: URLSearchParams['has'];
-    keys: URLSearchParams['keys'];
-    set: URLSearchParams['set'];
-    toString: URLSearchParams['toString'];
-    values: URLSearchParams['values'];
-};
-
 /**
  * Represents the structure of a route within the application. Return value of `createRoute`
  * @template TName - Represents the unique name identifying the route, typically a string.
@@ -882,9 +872,13 @@ export declare type Router<TRoutes extends Routes = any, __TOptions extends Rout
      */
     route: RouterRoutes<TRoutes>;
     /**
-     * Resolves a URL to a route object.
+     * Creates a ResolvedRoute record for a given route name and params.
      */
     resolve: RouterResolve<TRoutes>;
+    /**
+     * Creates a ResolvedRoute record for a given URL.
+     */
+    find: (url: string, options?: RouterResolveOptions) => ResolvedRoute | undefined;
     /**
      * Navigates to a specified path or route object in the history stack, adding a new entry.
      */
@@ -893,10 +887,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 +945,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 +954,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,23 +963,23 @@ 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.
 */
 prefetch?: PrefetchConfig;
-} & RouterPushOptions & {}>, {
+} & RouterPushOptions> & Readonly<{}>, {
 prefetch: PrefetchConfig;
-}, {}, {}, {}, string, ComponentProvideOptions, false, {}>, Readonly<{
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, 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;
@@ -1045,6 +1028,7 @@ export declare type RouterOptions = {
 declare type RouterPush<TRoutes extends Routes = any> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterPushArgs<TRoutes, TSource>): Promise<void>;
     (url: Url, options?: RouterPushOptions): Promise<void>;
+    (route: ResolvedRoute, options?: RouterPushOptions): Promise<void>;
 };
 
 declare type RouterPushArgs<TRoutes extends Routes, TSource extends RoutesName<TRoutes>> = AllPropertiesAreOptional<RouteParamsByKey<TRoutes, TSource>> extends true ? [params?: RouteParamsByKey<TRoutes, TSource>, options?: RouterPushOptions<RouteStateByName<TRoutes, TSource>>] : [params: RouteParamsByKey<TRoutes, TSource>, options?: RouterPushOptions<RouteStateByName<TRoutes, TSource>>];
@@ -1066,9 +1050,10 @@ declare type RouterRejection = Ref<null | {
 declare type RouterReplace<TRoutes extends Routes> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterReplaceArgs<TRoutes, TSource>): Promise<void>;
     (url: Url, options?: RouterReplaceOptions): Promise<void>;
+    (route: ResolvedRoute, 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;
@@ -1076,16 +1061,14 @@ declare type RouterReplaceOptions<TState = unknown> = {
     state?: Partial<TState>;
 };
 
-declare type RouterResolve<TRoutes extends Routes> = {
-    <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterResolveArgs<TRoutes, TSource>): Url;
-    (url: Url, options?: RouterResolveOptions): Url;
-};
+declare type RouterResolve<TRoutes extends Routes> = <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterResolveArgs<TRoutes, TSource>) => ResolvedRoute;
 
-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,9 +1078,10 @@ 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;
+    get query(): URLSearchParams;
     set query(value: QuerySource);
 };
 
@@ -1115,7 +1099,7 @@ export declare const RouterView: __VLS_WithTemplateSlots<DefineComponent<    {
 name?: string;
 }, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{
 name?: string;
-} & {}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}>, Readonly<{
+}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, Readonly<{
     default?: (props: {
         route: RouterRoute;
         component: Component;
@@ -1154,6 +1138,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;
@@ -1170,7 +1156,7 @@ export declare type UrlParts = {
     protocol?: string;
     host?: string;
     pathname: string;
-    searchParams: URLSearchParams;
+    searchParams: QuerySource;
     search: string;
     hash: string;
 };
@@ -1187,7 +1173,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,9 +1211,13 @@ 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 & {
+export declare type UseLinkOptions = RouterPushOptions & {
     prefetch?: PrefetchConfig;
 };