@kitbag/router 0.10.1 → 0.11.1

package/dist/kitbag-router.d.ts

@@ -1,6 +1,7 @@
 import { AsyncComponentLoader } from 'vue';
 import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
+import { ComputedRef } from 'vue';
 import { DefineComponent } from 'vue';
 import { ExtractPropTypes } from 'vue';
 import { FunctionalComponent } from 'vue';
@@ -238,6 +239,7 @@ export declare type CreateRouteOptions<TName extends string | undefined = string
  * The Route properties originally provided to `createRoute`. The only change is normalizing meta to always default to an empty object.
  */
 declare type CreateRouteOptionsMatched = CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
+    id: string;
     meta: RouteMeta;
 };
 
@@ -288,13 +290,9 @@ export declare class DuplicateParamsError extends Error {
  */
 declare type ExtractParamName<TParam extends PropertyKey> = TParam extends `?${infer Param}` ? Param extends '' ? never : Param : TParam extends '' ? never : TParam;
 
-declare type ExtractParamsFromHostString<THost extends string, TParams extends Record<string, Param | undefined> = Record<never, never>> = THost extends `${string}${ParamStart}${infer Param}${ParamEnd}${infer Rest}` ? {
-    [P in Param]: ExtractPathParamType<Param, TParams>;
-} & ExtractParamsFromHostString<Rest, TParams> : Record<never, never>;
+declare type ExtractParamsFromHostString<THost extends string, TParams extends Record<string, Param | undefined> = Record<never, never>> = THost extends `${string}${ParamStart}${infer Param}${ParamEnd}${infer Rest}` ? Record<Param, ExtractPathParamType<Param, TParams>> & ExtractParamsFromHostString<Rest, TParams> : Record<never, never>;
 
-declare type ExtractParamsFromPathString<TPath extends string, TParams extends Record<string, Param | undefined> = Record<never, never>> = TPath extends `${string}${ParamStart}${infer Param}${ParamEnd}${infer Rest}` ? {
-    [P in Param]: ExtractPathParamType<Param, TParams>;
-} & ExtractParamsFromPathString<Rest, TParams> : Record<never, never>;
+declare type ExtractParamsFromPathString<TPath extends string, TParams extends Record<string, Param | undefined> = Record<never, never>> = TPath extends `${string}${ParamStart}${infer Param}${ParamEnd}${infer Rest}` ? Record<Param, ExtractPathParamType<Param, TParams>> & ExtractParamsFromPathString<Rest, TParams> : Record<never, never>;
 
 /**
  * Extracts the actual type from a parameter type, handling getters, setters, and potential undefined values.
@@ -327,9 +325,7 @@ declare type ExtractParamTypeWithoutLosingOptional<TParam extends Param, TParamK
  */
 declare type ExtractPathParamType<TParam extends string, TParams extends Record<string, Param | undefined>> = TParam extends `?${infer OptionalParam}` ? OptionalParam extends keyof TParams ? TParams[OptionalParam] : StringConstructor : TParam extends keyof TParams ? TParams[TParam] : StringConstructor;
 
-declare type ExtractQueryParamsFromQueryString<TQuery extends string, TParams extends Record<string, Param | undefined> = Record<never, never>> = TQuery extends `${string}=${ParamStart}${infer Param}${ParamEnd}${infer Rest}` ? {
-    [P in Param]: ExtractPathParamType<Param, TParams>;
-} & ExtractQueryParamsFromQueryString<Rest, TParams> : Record<never, never>;
+declare type ExtractQueryParamsFromQueryString<TQuery extends string, TParams extends Record<string, Param | undefined> = Record<never, never>> = TQuery extends `${string}=${ParamStart}${infer Param}${ParamEnd}${infer Rest}` ? Record<Param, ExtractPathParamType<Param, TParams>> & ExtractQueryParamsFromQueryString<Rest, TParams> : Record<never, never>;
 
 /**
  * Extracts combined types of path and query parameters for a given route, creating a unified parameter object.
@@ -423,6 +419,8 @@ declare type IsRouteOptions = {
 
 declare type IsRouteUnnamed<T extends Route> = StringHasValue<T['name']> extends true ? false : true;
 
+export declare function isUrl(value: unknown): value is Url;
+
 declare type MakeOptional<T> = {
     [P in WithOptionalProperties<T>]?: T[P];
 } & {
@@ -556,6 +554,11 @@ declare type PrefetchConfigOptions = {
      * @default true
      */
     components?: boolean;
+    /**
+     * When true any props for routes will be prefetched
+     * @default false
+     */
+    props?: boolean;
 };
 
 declare type Query<TQuery extends string = string, TQueryParams extends QueryParamsWithParamNameExtracted<TQuery> = Record<string, Param | undefined>> = {
@@ -665,6 +668,10 @@ declare type RemoveLeadingQuestionMarkFromKeys<T extends Record<string, unknown>
  * @template TRoute - Underlying Route that has been resolved.
  */
 declare type ResolvedRoute<TRoute extends Route = Route> = Readonly<{
+    /**
+     * Unique identifier for the route, generated by router.
+     */
+    id: TRoute['id'];
     /**
      * The specific route properties that were matched in the current route.
      */
@@ -901,10 +908,6 @@ export declare type Router<TRoutes extends Routes = any, __TOptions extends Rout
      * Registers a hook to be called after a route is updated.
      */
     onAfterRouteUpdate: AddAfterRouteHook;
-    /**
-     * A promise that resolves when the router is fully initialized.
-     */
-    initialized: Promise<void>;
     /**
      * Given a URL, returns true if host does not match host stored on router instance
      */
@@ -913,6 +916,10 @@ export declare type Router<TRoutes extends Routes = any, __TOptions extends Rout
      * Determines what assets are prefetched.
      */
     prefetch?: PrefetchConfig;
+    /**
+     * Initializes the router based on the initial route. Automatically called when the router is installed. Calling this more than once has no effect.
+     */
+    start: () => Promise<void>;
 };
 
 declare type RouterFind<TRoutes extends Routes> = {
@@ -1046,6 +1053,7 @@ declare type RouterResolveOptions = {
 };
 
 declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = Readonly<{
+    id: TRoute['id'];
     name: TRoute['name'];
     matched: TRoute['matched'];
     matches: TRoute['matches'];
@@ -1070,11 +1078,14 @@ name?: string | undefined;
 }>>>, {}, {}>, Readonly<{
     default?: ((props: {
         route: Readonly<{
+            id: string;
             name: string;
-            matched: CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithoutComponents | WithComponent | WithComponents) & (WithoutParent | WithParent) & (WithoutState | WithState) & {
+            matched: CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
+                id: string;
                 meta: Record<string, unknown>;
             };
-            matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithoutComponents | WithComponent | WithComponents) & (WithoutParent | WithParent) & (WithoutState | WithState) & {
+            matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
+                id: string;
                 meta: Record<string, unknown>;
             })[];
             state: {
@@ -1106,11 +1117,14 @@ name?: string | undefined;
 }> & {
     default?: ((props: {
         route: Readonly<{
+            id: string;
             name: string;
-            matched: CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithoutComponents | WithComponent | WithComponents) & (WithoutParent | WithParent) & (WithoutState | WithState) & {
+            matched: CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
+                id: string;
                 meta: Record<string, unknown>;
             };
-            matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithoutComponents | WithComponent | WithComponents) & (WithoutParent | WithParent) & (WithoutState | WithState) & {
+            matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithComponent | WithComponents | WithoutComponents) & (WithParent | WithoutParent) & (WithState | WithoutState) & {
+                id: string;
                 meta: Record<string, unknown>;
             })[];
             state: {
@@ -1144,7 +1158,7 @@ name?: string | undefined;
 /**
  * Represents an immutable array of Route instances. Return value of `createRoute`, expected param for `createRouter`.
  */
-export declare type Routes = Readonly<Route[]>;
+export declare type Routes = readonly Route[];
 
 declare type RoutesMap<TRoutes extends Routes = []> = {
     [K in TRoutes[number] as AsNamedRoute<K>['name']]: AsNamedRoute<K>;
@@ -1176,25 +1190,29 @@ 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;
 
-declare type Url = `http://${string}` | `https://${string}` | `/${string}` | '/';
+export declare type Url = `http://${string}` | `https://${string}` | `/${string}` | '/';
 
 export declare type UseLink = {
     /**
      * ResolvedRoute if matched. Same value as `router.find`
      */
-    route: Ref<ResolvedRoute | undefined>;
+    route: ComputedRef<ResolvedRoute | undefined>;
     /**
      * Resolved URL with params interpolated and query applied. Same value as `router.resolve`.
      */
-    href: Ref<string>;
+    href: ComputedRef<string>;
     /**
      * True if route matches current URL or is ancestor of route that matches current URL
      */
-    isMatch: Ref<boolean>;
+    isMatch: ComputedRef<boolean>;
     /**
      * True if route matches current URL. Route is the same as what's currently stored at `router.route`.
      */
-    isExactMatch: Ref<boolean>;
+    isExactMatch: ComputedRef<boolean>;
+    /**
+     *
+     */
+    isExternal: ComputedRef<boolean>;
     /**
      * Convenience method for executing `router.push` with route context passed in.
      */