@kitbag/router 0.7.2 → 0.8.1

package/dist/kitbag-router.d.ts

@@ -18,6 +18,10 @@ declare type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
 
 declare type __VLS_NonUndefinedable_2<T> = T extends undefined ? never : T;
 
+declare type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+
 declare type __VLS_TypePropsToRuntimeProps<T> = {
     [K in keyof T]-?: {} extends Pick<T, K> ? {
         type: PropType<__VLS_NonUndefinedable<T[K]>>;
@@ -36,6 +40,12 @@ declare type __VLS_TypePropsToRuntimeProps_2<T> = {
     };
 };
 
+declare type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+
 declare type __VLS_WithTemplateSlots<T, S> = T & {
     new (): {
         $slots: S;
@@ -208,6 +218,10 @@ export declare type CreateRouteOptions<TName extends string | undefined = string
      * Represents additional metadata associated with a route, customizable via declaration merging.
      */
     meta?: TMeta;
+    /**
+     * Determines what assets are prefetched when router-link is rendered for this route. Overrides router level prefetch.
+     */
+    prefetch?: PrefetchConfig;
 };
 
 /**
@@ -240,9 +254,9 @@ declare type CreateRouteOptionsMatched = CreateRouteOptions & WithHooks & (WithH
  * const router = createRouter(routes)
  * ```
  */
-export declare function createRouter<const T extends Routes>(routes: T, options?: RouterOptions): Router<T>;
+export declare function createRouter<const TRoutes extends Routes, const TOptions extends RouterOptions>(routes: TRoutes, options?: TOptions): Router<TRoutes, TOptions>;
 
-export declare function createRouter<const T extends Routes>(arrayOfRoutes: T[], options?: RouterOptions): Router<T>;
+export declare function createRouter<const TRoutes extends Routes, const TOptions extends RouterOptions>(arrayOfRoutes: TRoutes[], options?: TOptions): Router<TRoutes, TOptions>;
 
 /**
  * An error thrown when duplicate parameters are detected in a route.
@@ -515,6 +529,19 @@ declare type PathParamsWithParamNameExtracted<TPath extends string> = {
     [K in keyof ExtractParamsFromPathString<TPath> as ExtractParamName<K>]?: Param;
 };
 
+/**
+ * Determines what assets are prefetched. A boolean enables or disables all prefetching.
+ */
+declare type PrefetchConfig = boolean | PrefetchConfigOptions;
+
+declare type PrefetchConfigOptions = {
+    /**
+     * When true any component that is wrapped in vue's defineAsyncComponent will be prefetched
+     * @default true
+     */
+    components?: boolean;
+};
+
 declare type Query<TQuery extends string = string, TQueryParams extends QueryParamsWithParamNameExtracted<TQuery> = Record<string, Param | undefined>> = {
     query: TQuery;
     params: string extends TQuery ? Record<string, Param> : Identity<ExtractQueryParamsFromQueryString<TQuery, TQueryParams>>;
@@ -549,7 +576,7 @@ declare type QueryParamsWithParamNameExtracted<T extends string> = {
 };
 
 /**
- * Represents the state of currently registered router, rejections, and route meta. Used to provide correct type context for
+ * 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.
  *
  * @example
@@ -557,7 +584,6 @@ declare type QueryParamsWithParamNameExtracted<T extends string> = {
  * declare module '@kitbag/router' {
  *   interface Register {
  *     router: typeof router
- *     rejections: ["NotAuthorized"],
  *     routeMeta: { public?: boolean }
  *   }
  * }
@@ -570,8 +596,8 @@ export declare interface Register {
  * Represents the possible Rejections registered within {@link Register}
  */
 export declare type RegisteredRejectionType = Register extends {
-    rejections: infer TRejections extends string[];
-} ? TRejections[number] : never;
+    router: Router<Routes, infer TOptions extends RouterOptions>;
+} ? keyof TOptions['rejections'] | BuiltInRejectionType : BuiltInRejectionType;
 
 /**
  * Represents the a map of all possible route names with corresponding Route registered within {@link Register}
@@ -695,7 +721,11 @@ export declare type Route<TName extends string = string, THost extends Host = Ho
      * Represents the schema of the route state, combined with any parents.
      */
     state: TState;
-    depth: number;
+    /**
+     * Determines what assets are prefetched when router-link is rendered for this route. Overrides router level prefetch.
+     */
+    prefetch?: PrefetchConfig;
+    /* Excluded from this release type: depth */
 };
 
 declare type RouteGetByKey<TRoutes extends Routes, TKey extends RoutesName<TRoutes>> = RoutesMap<TRoutes>[TKey];
@@ -746,7 +776,7 @@ declare type RouteHookPushResponse<T extends Routes> = {
  */
 declare type RouteHookRejectResponse = {
     status: 'REJECT';
-    type: RouterRejectionType;
+    type: RegisteredRejectionType;
 };
 
 /**
@@ -778,7 +808,7 @@ declare type RouteParams<TPath extends string | Path | undefined, TQuery extends
 
 declare type RouteParamsByKey<TRoutes extends Routes, TKey extends string> = ExtractRouteParamTypesWithoutLosingOptional<RouteGetByKey<TRoutes, TKey>>;
 
-export declare type Router<TRoutes extends Routes = any> = Plugin_2 & {
+export declare type Router<TRoutes extends Routes = any, __TOptions extends RouterOptions = any> = Plugin_2 & {
     /**
      * Manages the current route state.
      */
@@ -851,6 +881,10 @@ export declare type Router<TRoutes extends Routes = any> = Plugin_2 & {
      * Given a URL, returns true if host does not match host stored on router instance
      */
     isExternal: (url: string) => boolean;
+    /**
+     * Determines what assets are prefetched.
+     */
+    prefetch?: PrefetchConfig;
 };
 
 declare type RouterFind<TRoutes extends Routes> = {
@@ -864,11 +898,13 @@ declare type RouterHistoryMode = 'auto' | 'browser' | 'memory' | 'hash';
 
 export declare const routerInjectionKey: InjectionKey<RegisteredRouter>;
 
-export declare const RouterLink: __VLS_WithTemplateSlots_2<DefineComponent<__VLS_TypePropsToRuntimeProps_2<{
-to: Url | ToCallback;
-} & RouterPushOptions>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_TypePropsToRuntimeProps_2<{
-to: Url | ToCallback;
-} & RouterPushOptions>>>, {}, {}>, Readonly<{
+export declare const RouterLink: __VLS_WithTemplateSlots_2<DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps_2<RouterLinkProps & RouterPushOptions>, {
+prefetch: undefined;
+}>, {}, unknown, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps_2<RouterLinkProps & RouterPushOptions>, {
+prefetch: undefined;
+}>>>, {
+prefetch: PrefetchConfig;
+}, {}>, Readonly<{
     default?: ((props: {
         resolved: string;
         isMatch: boolean;
@@ -884,6 +920,17 @@ to: Url | ToCallback;
     }) => unknown) | undefined;
 }>;
 
+declare type RouterLinkProps = {
+    /**
+     * The url string to navigate to or a callback that returns a url string
+     */
+    to: Url | ToCallback;
+    /**
+     * Determines what assets are prefetched when router-link is rendered for this route. Overrides route level prefetch.
+     */
+    prefetch?: PrefetchConfig;
+};
+
 /**
  * An error thrown when an attempt is made to use routing functionality before the router has been installed.
  */
@@ -912,7 +959,15 @@ export declare type RouterOptions = {
      * For example having `base` of `/foo` would assume all routes should start with `your.domain.com/foo`.
      */
     base?: string;
-} & RouterRejectionComponents;
+    /**
+     * Determines what assets are prefetched when router-link is rendered for a specific route
+     */
+    prefetch?: PrefetchConfig;
+    /**
+     * Components assigned to each type of rejection your router supports.
+     */
+    rejections?: Partial<Record<string, Component>>;
+};
 
 declare type RouterPush<TRoutes extends Routes = any> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterPushArgs<TRoutes, TSource>): Promise<void>;
@@ -927,21 +982,15 @@ declare type RouterPushOptions<TState = unknown> = {
     state?: Partial<TState>;
 };
 
-export declare type RouterReject = (type: RouterRejectionType) => void;
+export declare type RouterReject = (type: RegisteredRejectionType) => void;
 
 declare type RouterRejection = Ref<null | {
-    type: RouterRejectionType;
+    type: RegisteredRejectionType;
     component: Component;
 }>;
 
-declare type RouterRejectionComponents = {
-    rejections?: Partial<Record<RouterRejectionType, Component>>;
-};
-
 export declare const routerRejectionKey: InjectionKey<RouterRejection>;
 
-declare type RouterRejectionType = BuiltInRejectionType | RegisteredRejectionType;
-
 declare type RouterReplace<TRoutes extends Routes> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterReplaceArgs<TRoutes, TSource>): Promise<void>;
     (url: Url, options?: RouterReplaceOptions): Promise<void>;
@@ -1133,9 +1182,13 @@ export declare type UseLink = {
  */
 export declare function useLink<TRouteKey extends RegisteredRoutesName>(name: MaybeRefOrGetter<TRouteKey>, ...args: UseLinkArgs<TRouteKey>): UseLink;
 
-export declare function useLink(url: MaybeRefOrGetter<Url>): UseLink;
+export declare function useLink(url: MaybeRefOrGetter<Url>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
 
-declare type UseLinkArgs<TSource extends RegisteredRoutesName, TParams = RouteParamsByKey<RegisteredRoutes, TSource>> = AllPropertiesAreOptional<TParams> extends true ? [params?: MaybeRefOrGetter<TParams>, options?: MaybeRefOrGetter<RouterResolveOptions>] : [params: MaybeRefOrGetter<TParams>, options?: MaybeRefOrGetter<RouterResolveOptions>];
+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 & {
+    prefetch?: PrefetchConfig;
+};
 
 /**
  * A composition to access the router's rejection state.