@kitbag/router 0.10.0 → 0.11.0

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;
 };
 
@@ -556,6 +558,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 +672,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.
      */
@@ -708,6 +719,10 @@ declare type ResolvedRouteQuery = {
  * @template TQuery - The type or structure of the query parameters associated with the route.
  */
 export declare type Route<TName extends string = string, THost extends Host = Host, TPath extends Path = Path, TQuery extends Query = Query, THash extends Hash = Hash, TMeta extends RouteMeta = RouteMeta, TState extends Record<string, Param> = Record<string, Param>> = {
+    /**
+     * Unique identifier for the route, generated by router.
+     */
+    id: string;
     /**
      * The specific route properties that were matched in the current route.
      */
@@ -718,7 +733,7 @@ export declare type Route<TName extends string = string, THost extends Host = Ho
      */
     matches: CreateRouteOptionsMatched[];
     /**
-     * Unique identifier for the route. Name is used for routing and for matching.
+     * Identifier for the route as defined by user. Name must be unique among named routes. Name is used for routing and for matching.
      */
     name: TName;
     /**
@@ -897,10 +912,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
      */
@@ -909,6 +920,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> = {
@@ -1042,6 +1057,7 @@ declare type RouterResolveOptions = {
 };
 
 declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = Readonly<{
+    id: TRoute['id'];
     name: TRoute['name'];
     matched: TRoute['matched'];
     matches: TRoute['matches'];
@@ -1066,11 +1082,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) & {
+                id: string;
                 meta: Record<string, unknown>;
             };
             matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithoutComponents | WithComponent | WithComponents) & (WithoutParent | WithParent) & (WithoutState | WithState) & {
+                id: string;
                 meta: Record<string, unknown>;
             })[];
             state: {
@@ -1102,11 +1121,14 @@ name?: string | undefined;
 }> & {
     default?: ((props: {
         route: Readonly<{
+            id: string;
             name: string;
             matched: CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithoutComponents | WithComponent | WithComponents) & (WithoutParent | WithParent) & (WithoutState | WithState) & {
+                id: string;
                 meta: Record<string, unknown>;
             };
             matches: (CreateRouteOptions & WithHooks & (WithHost | WithoutHost) & (WithoutComponents | WithComponent | WithComponents) & (WithoutParent | WithParent) & (WithoutState | WithState) & {
+                id: string;
                 meta: Record<string, unknown>;
             })[];
             state: {
@@ -1178,19 +1200,23 @@ 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.
      */