@kitbag/router 0.14.0 → 0.14.2

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)
  * ```
@@ -672,7 +672,7 @@ export declare interface Register {
  * Represents the possible Rejections registered within {@link Register}
  */
 export declare type RegisteredRejectionType = Register extends {
-    router: Router<Routes, infer TOptions extends RouterOptions>;
+    router: Router<infer __TRoutes extends Routes, infer TOptions extends RouterOptions>;
 } ? keyof TOptions['rejections'] | BuiltInRejectionType : BuiltInRejectionType;
 
 /**
@@ -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.
      */
@@ -769,20 +769,6 @@ export declare type ResolvedRoute<TRoute extends Route = Route> = Readonly<{
     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.
@@ -886,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.
      */
@@ -1037,6 +1027,7 @@ export declare type RouterOptions = {
 
 declare type RouterPush<TRoutes extends Routes = any> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterPushArgs<TRoutes, TSource>): Promise<void>;
+    (route: ResolvedRoute, options?: RouterPushOptions): Promise<void>;
     (url: Url, options?: RouterPushOptions): Promise<void>;
 };
 
@@ -1058,6 +1049,7 @@ declare type RouterRejection = Ref<null | {
 
 declare type RouterReplace<TRoutes extends Routes> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterReplaceArgs<TRoutes, TSource>): Promise<void>;
+    (route: ResolvedRoute, options?: RouterReplaceOptions): Promise<void>;
     (url: Url, options?: RouterReplaceOptions): Promise<void>;
 };
 
@@ -1069,10 +1061,7 @@ declare type RouterReplaceOptions<TState = unknown> = {
     state?: Partial<TState>;
 };
 
-declare type RouterResolve<TRoutes extends Routes> = {
-    <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterResolveArgs<TRoutes, TSource>): ResolvedRoute | undefined;
-    (url: Url, options?: RouterResolveOptions): ResolvedRoute | undefined;
-};
+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>> = AllPropertiesAreOptional<RouteParamsByKey<TRoutes, TSource>> extends true ? [params?: RouteParamsByKey<TRoutes, TSource>, options?: RouterResolveOptions<RouteStateByName<TRoutes, TSource>>] : [params: RouteParamsByKey<TRoutes, TSource>, options?: RouterResolveOptions<RouteStateByName<TRoutes, TSource>>];
 
@@ -1092,7 +1081,7 @@ declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
     readonly href: TRoute['href'];
     params: TRoute['params'];
     state: TRoute['state'];
-    get query(): ResolvedRouteQuery;
+    get query(): URLSearchParams;
     set query(value: QuerySource);
 };
 
@@ -1167,7 +1156,7 @@ export declare type UrlParts = {
     protocol?: string;
     host?: string;
     pathname: string;
-    searchParams: URLSearchParams;
+    searchParams: QuerySource;
     search: string;
     hash: string;
 };
@@ -1228,7 +1217,7 @@ export declare function useLink(source: MaybeRefOrGetter<string | ResolvedRoute
 
 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;
 };