@kitbag/router 0.14.1 → 0.15.0

package/dist/kitbag-router.d.ts

@@ -1,3 +1,4 @@
+import { App } from 'vue';
 import { AsyncComponentLoader } from 'vue';
 import { Component } from 'vue';
 import { ComponentOptionsMixin } from 'vue';
@@ -6,7 +7,6 @@ import { ComputedRef } from 'vue';
 import { DefineComponent } from 'vue';
 import { FunctionalComponent } from 'vue';
 import { MaybeRefOrGetter } from 'vue';
-import { Plugin as Plugin_2 } from 'vue';
 import { PublicProps } from 'vue';
 import { Ref } from 'vue';
 import { UnwrapRef } from 'vue';
@@ -586,7 +586,7 @@ declare type PathParamsWithParamNameExtracted<TPath extends string> = {
 /**
  * Determines what assets are prefetched. A boolean enables or disables all prefetching.
  */
-declare type PrefetchConfig = boolean | PrefetchStrategy | PrefetchConfigOptions;
+export declare type PrefetchConfig = boolean | PrefetchStrategy | PrefetchConfigOptions;
 
 declare type PrefetchConfigOptions = {
     /**
@@ -606,7 +606,7 @@ declare type PrefetchConfigOptions = {
  * eager: Fetched immediately
  * lazy: Fetched when visible
  */
-declare type PrefetchStrategy = 'eager' | 'lazy';
+export declare type PrefetchStrategy = 'eager' | 'lazy' | 'intent';
 
 /**
  * Context provided to props callback functions
@@ -649,7 +649,7 @@ declare type QueryParamsWithParamNameExtracted<T extends string> = {
     [K in keyof ExtractQueryParamsFromQueryString<T> as ExtractParamName<K>]?: Param;
 };
 
-declare type QuerySource = ConstructorParameters<typeof URLSearchParams>[0];
+export declare type QuerySource = ConstructorParameters<typeof URLSearchParams>[0];
 
 /**
  * Represents the state of currently registered router, and route meta. Used to provide correct type context for
@@ -671,7 +671,7 @@ export declare interface Register {
 /**
  * Represents the possible Rejections registered within {@link Register}
  */
-export declare type RegisteredRejectionType = Register extends {
+export declare type RegisteredRejectionType<T = Register> = T extends {
     router: Router<Routes, infer TOptions extends RouterOptions>;
 } ? keyof TOptions['rejections'] | BuiltInRejectionType : BuiltInRejectionType;
 
@@ -683,7 +683,7 @@ export declare type RegisteredRouteMap = RoutesMap<RegisteredRoutes>;
 /**
  * Represents the Router property within {@link Register}
  */
-export declare type RegisteredRouter = Register extends {
+export declare type RegisteredRouter<T = Register> = T extends {
     router: infer TRouter;
 } ? TRouter : Router;
 
@@ -710,7 +710,7 @@ export declare type RegisteredRouterRoute = RegisteredRouter['route'];
 /**
  * Represents the Router routes property within {@link Register}
  */
-export declare type RegisteredRoutes = Register extends {
+export declare type RegisteredRoutes<T = Register> = T extends {
     router: Router<infer TRoutes extends Routes>;
 } ? TRoutes : Route[];
 
@@ -860,13 +860,18 @@ export declare type RouteHookResponse = BeforeRouteHookResponse | AfterRouteHook
 /**
  * Represents additional metadata associated with a route, customizable via declaration merging.
  */
-export declare type RouteMeta = Register extends {
+export declare type RouteMeta<T = Register> = T extends {
     routeMeta: infer RouteMeta extends Record<string, unknown>;
 } ? RouteMeta : Record<string, unknown>;
 
 declare type RouteParamsByKey<TRoutes extends Routes, TKey extends string> = ExtractRouteParamTypesWithoutLosingOptional<RouteGetByKey<TRoutes, TKey>>;
 
-export declare type Router<TRoutes extends Routes = any, __TOptions extends RouterOptions = any> = Plugin_2 & {
+export declare type Router<TRoutes extends Routes = any, __TOptions extends RouterOptions = any> = {
+    /**
+     * Installs the router into a Vue application instance.
+     * @param app The Vue application instance to install the router into
+     */
+    install: (app: App) => void;
     /**
      * Manages the current route state.
      */
@@ -968,9 +973,9 @@ to: Url | ResolvedRoute | ToCallback;
 * Determines what assets are prefetched when router-link is rendered for this route. Overrides route level prefetch.
 */
 prefetch?: PrefetchConfig;
-} & RouterPushOptions> & Readonly<{}>, {
+} & RouterPushOptions & {}>, {
 prefetch: PrefetchConfig;
-}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, Readonly<{
+}, {}, {}, {}, string, ComponentProvideOptions, false, {}>, Readonly<{
     default?: (props: {
         route: ResolvedRoute | undefined;
         isMatch: boolean;
@@ -1027,8 +1032,8 @@ 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>;
+    (url: Url, 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>>];
@@ -1049,8 +1054,8 @@ 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>;
+    (url: Url, options?: RouterReplaceOptions): Promise<void>;
 };
 
 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>>];
@@ -1071,7 +1076,7 @@ declare type RouterResolveOptions<TState = unknown> = {
     state?: Partial<TState>;
 };
 
-declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
+export declare type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
     readonly id: TRoute['id'];
     readonly name: TRoute['name'];
     readonly matched: TRoute['matched'];
@@ -1099,7 +1104,7 @@ export declare const RouterView: __VLS_WithTemplateSlots<DefineComponent<    {
 name?: string;
 }, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{
 name?: string;
-}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}, any>, Readonly<{
+} & {}>, {}, {}, {}, {}, string, ComponentProvideOptions, false, {}>, Readonly<{
     default?: (props: {
         route: RouterRoute;
         component: Component;
@@ -1138,7 +1143,7 @@ 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;
+export 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;