@kitbag/router 0.11.2 → 0.11.4

package/dist/kitbag-router.d.ts

@@ -101,6 +101,8 @@ declare type AllPropertiesAreOptional<T> = Record<string, unknown> extends T ? t
 
 declare type AsNamedRoute<T extends Route> = IsRouteUnnamed<T> extends true ? never : T;
 
+export declare function asUrl(value: string): Url;
+
 /**
  * Represents a function called before a route change, potentially altering the routing operation.
  * @param to - {@link ResolvedRoute} The resolved route the router is navigating to.
@@ -367,14 +369,11 @@ declare type ExtractStateParams<TRoute> = TRoute extends {
 
 declare type Hash<THash extends string | undefined = string | undefined> = {
     value: THash;
-    hasValue: () => boolean;
-    toString: () => string;
 };
 
 declare type Host<THost extends string = string, TParams extends HostParamsWithParamNameExtracted<THost> = Record<string, Param | undefined>> = {
     value: THost;
     params: string extends THost ? Record<string, Param> : Identity<ExtractParamsFromHostString<THost, TParams>>;
-    toString: () => string;
 };
 
 declare type HostParamsWithParamNameExtracted<THost extends string> = {
@@ -513,7 +512,6 @@ declare type ParentQuery<TParent extends Route | undefined> = TParent extends Ro
 declare type Path<TPath extends string = string, TParams extends PathParamsWithParamNameExtracted<TPath> = Record<string, Param | undefined>> = {
     value: TPath;
     params: string extends TPath ? Record<string, Param> : Identity<ExtractParamsFromPathString<TPath, TParams>>;
-    toString: () => string;
 };
 
 /**
@@ -564,7 +562,6 @@ declare type PrefetchConfigOptions = {
 declare type Query<TQuery extends string = string, TQueryParams extends QueryParamsWithParamNameExtracted<TQuery> = Record<string, Param | undefined>> = {
     value: TQuery;
     params: string extends TQuery ? Record<string, Param> : Identity<ExtractQueryParamsFromQueryString<TQuery, TQueryParams>>;
-    toString: () => string;
 };
 
 /**
@@ -594,6 +591,8 @@ declare type QueryParamsWithParamNameExtracted<T extends string> = {
     [K in keyof ExtractQueryParamsFromQueryString<T> as ExtractParamName<K>]?: Param;
 };
 
+declare type QuerySource = ConstructorParameters<typeof URLSearchParams>[0];
+
 /**
  * Represents the state of currently registered router, and route meta. Used to provide correct type context for
  * components like `RouterLink`, as well as for composables like `useRouter`, `useRoute`, and hooks.
@@ -704,8 +703,17 @@ declare type ResolvedRoute<TRoute extends Route = Route> = Readonly<{
 }>;
 
 declare type ResolvedRouteQuery = {
-    get: (key: string) => string | null;
-    getAll: (key: string) => string[];
+    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'];
 };
 
 /**
@@ -1012,7 +1020,7 @@ declare type RouterPush<TRoutes extends Routes = any> = {
 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>>];
 
 declare type RouterPushOptions<TState = unknown> = {
-    query?: Record<string, string>;
+    query?: QuerySource;
     hash?: string;
     replace?: boolean;
     state?: Partial<TState>;
@@ -1035,34 +1043,35 @@ declare type RouterReplace<TRoutes extends Routes> = {
 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 RouterReplaceOptions<TState = unknown> = {
-    query?: Record<string, string>;
+    query?: QuerySource;
     hash?: string;
     state?: Partial<TState>;
 };
 
 declare type RouterResolve<TRoutes extends Routes> = {
-    <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterResolveArgs<TRoutes, TSource>): string;
-    (url: Url, options?: RouterResolveOptions): string;
+    <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterResolveArgs<TRoutes, TSource>): Url;
+    (url: Url, options?: RouterResolveOptions): Url;
 };
 
 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 RouterResolveOptions = {
-    query?: Record<string, string>;
+    query?: QuerySource;
     hash?: string;
 };
 
-declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = Readonly<{
-    id: TRoute['id'];
-    name: TRoute['name'];
-    matched: TRoute['matched'];
-    matches: TRoute['matches'];
-    state: TRoute['state'];
-    query: ResolvedRouteQuery;
-    hash: TRoute['hash'];
-    params: Writable<TRoute['params']>;
-    update: RouteUpdate<TRoute>;
-}>;
+declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
+    readonly id: TRoute['id'];
+    readonly name: TRoute['name'];
+    readonly matched: TRoute['matched'];
+    readonly matches: TRoute['matches'];
+    readonly state: TRoute['state'];
+    readonly hash: TRoute['hash'];
+    readonly params: Writable<TRoute['params']>;
+    readonly update: RouteUpdate<TRoute>;
+    get query(): ResolvedRouteQuery;
+    set query(value: QuerySource);
+};
 
 /**
  * This type is the same as `RouterRoute<ResolvedRoute<TRoutes[number]>>` while remaining distributive
@@ -1077,35 +1086,7 @@ name?: string | undefined;
 name?: string | undefined;
 }>>>, {}, {}>, Readonly<{
     default?: ((props: {
-        route: Readonly<{
-            id: string;
-            name: string;
-            matched: CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
-                id: string;
-                meta: Record<string, unknown>;
-            };
-            matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
-                id: string;
-                meta: Record<string, unknown>;
-            })[];
-            state: {
-                [x: string]: any;
-                [x: number]: any;
-            };
-            query: ResolvedRouteQuery;
-            hash: string | undefined;
-            params: Writable<    {
-            [x: string]: any;
-            [x: number]: any;
-            }>;
-            update: {
-                (paramName: string, paramValue: unknown, options?: RouterPushOptions | undefined): Promise<void>;
-                (params: Partial<{
-                    [x: string]: any;
-                    [x: number]: any;
-                }>, options?: RouterPushOptions | undefined): Promise<void>;
-            };
-        }>;
+        route: RouterRoute;
         component: Component;
         rejection: {
             type: "NotFound";
@@ -1116,35 +1097,7 @@ name?: string | undefined;
     }>) | undefined;
 }> & {
     default?: ((props: {
-        route: Readonly<{
-            id: string;
-            name: string;
-            matched: CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
-                id: string;
-                meta: Record<string, unknown>;
-            };
-            matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
-                id: string;
-                meta: Record<string, unknown>;
-            })[];
-            state: {
-                [x: string]: any;
-                [x: number]: any;
-            };
-            query: ResolvedRouteQuery;
-            hash: string | undefined;
-            params: Writable<    {
-            [x: string]: any;
-            [x: number]: any;
-            }>;
-            update: {
-                (paramName: string, paramValue: unknown, options?: RouterPushOptions | undefined): Promise<void>;
-                (params: Partial<{
-                    [x: string]: any;
-                    [x: number]: any;
-                }>, options?: RouterPushOptions | undefined): Promise<void>;
-            };
-        }>;
+        route: RouterRoute;
         component: Component;
         rejection: {
             type: "NotFound";
@@ -1178,7 +1131,7 @@ declare type RouteUpdate<TRoute extends ResolvedRoute = ResolvedRoute> = Resolve
 
 declare type StringHasValue<T> = string extends T ? true : '' extends T ? false : T extends string ? true : false;
 
-declare type ToCallback = (resolve: RegisteredRouter['resolve']) => string;
+declare type ToCallback = (resolve: RegisteredRouter['resolve']) => Url;
 
 declare type ToHash<T extends string | Hash | undefined> = T extends string ? Hash<T> : T extends undefined ? Hash<''> : unknown extends T ? Hash<''> : T;
 
@@ -1190,7 +1143,16 @@ declare type ToPath<T extends string | Path | undefined> = T extends string ? Pa
 
 declare type ToQuery<T extends string | Query | undefined> = T extends string ? Query<T, {}> : T extends undefined ? Query<'', {}> : unknown extends T ? Query<'', {}> : T;
 
-export declare type Url = `http://${string}` | `https://${string}` | `/${string}` | '/';
+export declare type Url = `http://${string}` | `https://${string}` | `/${string}`;
+
+export declare type UrlParts = {
+    protocol?: string;
+    host?: string;
+    pathname: string;
+    searchParams: URLSearchParams;
+    search: string;
+    hash: string;
+};
 
 export declare type UseLink = {
     /**