@kitbag/router 0.22.7 → 0.23.1

package/dist/main.d.ts

@@ -6,7 +6,9 @@ export * from './types/paramTypes';
 export * from './types/prefetch';
 export * from './types/props';
 export * from './types/querySource';
+export type { RouteRedirects } from './types/redirects';
 export * from './types/register';
+export type { Rejection, RejectionType, Rejections } from './types/rejection';
 export * from './types/resolved';
 export * from './types/route';
 export * from './types/router';
@@ -37,6 +39,7 @@ export { createRouterPlugin } from './services/createRouterPlugin';
 export { unionOf } from './services/unionOf';
 export { arrayOf } from './services/arrayOf';
 export { tupleOf } from './services/tupleOf';
+export { literal } from './services/literal';
 export { createParam } from './services/createParam';
 export { createRouter } from './services/createRouter';
 export { createUrl } from './services/createUrl';

package/dist/services/createRoute.d.ts

@@ -2,6 +2,7 @@ import { CreateRouteOptions, PropsGetter, CreateRouteProps, ToRoute, RouterViewP
 import { InternalRouteHooks } from '../types/hooks';
 import { ExtractRouteContext } from '../types/routeContext';
 import { RouteRedirects } from '../types/redirects';
+import { RouteSetTitle } from '../types/titles';
 type CreateRouteWithProps<TOptions extends CreateRouteOptions, TProps extends CreateRouteProps<TOptions>> = CreateRouteProps<TOptions> extends RouterViewPropsGetter<TOptions> ? [props?: RouterViewPropsGetter<TOptions>] : CreateRouteProps<TOptions> extends PropsGetter<TOptions> ? Partial<ReturnType<CreateRouteProps<TOptions>>> extends ReturnType<CreateRouteProps<TOptions>> ? [props?: TProps] : [props: TProps] : Partial<CreateRouteProps<TOptions>> extends CreateRouteProps<TOptions> ? [props?: TProps] : [props: TProps];
-export declare function createRoute<const TOptions extends CreateRouteOptions, const TProps extends CreateRouteProps<TOptions>>(options: TOptions, ...args: CreateRouteWithProps<TOptions, TProps>): ToRoute<TOptions, TProps> & InternalRouteHooks<ToRoute<TOptions>, ExtractRouteContext<TOptions>> & RouteRedirects<ToRoute<TOptions>>;
+export declare function createRoute<const TOptions extends CreateRouteOptions, const TProps extends CreateRouteProps<TOptions>>(options: TOptions, ...args: CreateRouteWithProps<TOptions, TProps>): ToRoute<TOptions, TProps> & InternalRouteHooks<ToRoute<TOptions>, ExtractRouteContext<TOptions>> & RouteRedirects<ToRoute<TOptions>> & RouteSetTitle<ToRoute<TOptions>>;
 export {};

package/dist/services/getMatchesForUrl.d.ts

@@ -1,7 +1,8 @@
 import { ResolvedRoute } from '../types/resolved';
 import { Routes } from '../types/route';
-import { RouterResolveOptions } from '../types/routerResolve';
 import { ParseUrlOptions } from '../types/url';
-type MatchOptions = RouterResolveOptions & ParseUrlOptions;
+type MatchOptions = {
+    state?: Partial<unknown>;
+} & ParseUrlOptions;
 export declare function getMatchForUrl(routes: Routes, url: string, options?: MatchOptions): ResolvedRoute | undefined;
 export {};

package/dist/services/literal.d.ts

@@ -0,0 +1,2 @@
+import { LiteralParam, ParamGetSet } from '../types/paramTypes';
+export declare function literal<T extends LiteralParam>(value: T): ParamGetSet<T>;

package/dist/services/queryParamFilter.d.ts

@@ -0,0 +1,2 @@
+import { QuerySource } from '../types/querySource';
+export declare function filterQueryParams(source: QuerySource, exclude: QuerySource): URLSearchParams;

package/dist/services/queryParamFilter.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/createRouteOptions.d.ts

@@ -1,6 +1,7 @@
 import { Component } from 'vue';
 import { CombineMeta } from '../services/combineMeta';
 import { CombineState } from '../services/combineState';
+import { WithHooks } from './hooks';
 import { Param } from './paramTypes';
 import { PrefetchConfig } from './prefetch';
 import { RouteMeta } from './register';
@@ -8,7 +9,7 @@ import { Route } from './route';
 import { ResolvedRoute } from './resolved';
 import { ComponentProps } from '../services/component';
 import { PropsCallbackContext } from './props';
-import { MaybePromise } from './utilities';
+import { Identity, MaybePromise } from './utilities';
 import { ToMeta } from './meta';
 import { ToState } from './state';
 import { ToName } from './name';
@@ -33,6 +34,14 @@ export declare function isWithParent<T extends Record<string, unknown>>(options:
 export type WithoutParent = {
     parent?: never;
 };
+/**
+ * This type is used to strip the component and components properties from the options object
+ * when creating a Route to simplify and minimize the output type.
+ */
+type WithoutComponents = {
+    component: never;
+    components: never;
+};
 export declare function isWithComponent<T extends Record<string, unknown>>(options: T): options is T & {
     component: Component;
 };
@@ -102,7 +111,7 @@ type RoutePropsRecord<TOptions extends CreateRouteOptions = CreateRouteOptions,
     [K in keyof TComponents as ComponentPropsAreOptional<TComponents[K]> extends false ? K : never]: PropsGetter<TOptions, TComponents[K]>;
 };
 export type CreateRouteProps<TOptions extends CreateRouteOptions = CreateRouteOptions> = TOptions['component'] extends Component ? PropsGetter<TOptions, TOptions['component']> : TOptions['components'] extends Record<string, Component> ? RoutePropsRecord<TOptions, TOptions['components']> : RouterViewPropsGetter<TOptions>;
-type ToMatch<TOptions extends CreateRouteOptions, TProps extends CreateRouteProps<TOptions> | undefined> = Omit<TOptions, 'props' | 'meta' | 'name'> & {
+type ToMatch<TOptions extends CreateRouteOptions, TProps> = Omit<TOptions, 'props' | 'meta' | 'name'> & {
     id: string;
     name: ToName<TOptions['name']>;
     props: TProps;
@@ -113,12 +122,12 @@ type ToMatch<TOptions extends CreateRouteOptions, TProps extends CreateRouteProp
 };
 type ToMatches<TOptions extends CreateRouteOptions, TProps extends CreateRouteProps<TOptions> | undefined> = TOptions extends {
     parent: infer TParent extends Route;
-} ? [...TParent['matches'], ToMatch<TOptions, TProps>] : [ToMatch<TOptions, TProps>];
+} ? [...TParent['matches'], ToMatch<TOptions, TProps>] : [ToMatch<Identity<TOptions & WithoutComponents>, TProps>];
 export type ToRoute<TOptions extends CreateRouteOptions, TProps extends CreateRouteProps<TOptions> | undefined = undefined> = CreateRouteOptions extends TOptions ? Route : TOptions extends {
     parent: infer TParent extends Route;
-} ? Route<ToName<TOptions['name']>, CombineUrl<TParent, ToUrl<TOptions>>, CombineMeta<ToMeta<TParent['meta']>, ToMeta<TOptions['meta']>>, CombineState<ToState<TParent['state']>, ToState<TOptions['state']>>, ToMatches<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>, [
+} ? Route<ToName<TOptions['name']>, CombineUrl<TParent, ToUrl<TOptions & WithoutComponents>>, CombineMeta<ToMeta<TParent['meta']>, ToMeta<TOptions['meta']>>, CombineState<ToState<TParent['state']>, ToState<TOptions['state']>>, ToMatches<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>, [
     ...ToRouteContext<TParent['context']>,
     ...ToRouteContext<TOptions['context']>
-]> : Route<ToName<TOptions['name']>, ToUrl<TOptions>, ToMeta<TOptions['meta']>, ToState<TOptions['state']>, ToMatches<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>, ToRouteContext<TOptions['context']>>;
-export declare function combineRoutes(parent: Route, child: Route): Route;
+]> : Route<ToName<TOptions['name']>, ToUrl<Identity<TOptions & WithoutComponents>>, ToMeta<TOptions['meta']>, ToState<TOptions['state']>, ToMatches<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>, ToRouteContext<TOptions['context']>>;
+export declare function combineRoutes(parent: Route, child: Route): Route & WithHooks;
 export {};

package/dist/types/hooks.d.ts

@@ -10,6 +10,21 @@ import { RouteContext, RouteContextToRejection, RouteContextToRoute } from './ro
 import { RouterAbort } from './routerAbort';
 import { CallbackContextAbort, CallbackContextPush, CallbackContextReject, CallbackContextSuccess } from './callbackContext';
 import { RouteUpdate } from './routeUpdate';
+/**
+ * The stores for routes including ancestors.
+ * Order of routes will be from greatest ancestor to narrowest matched.
+ * @internal
+ */
+export type WithHooks = {
+    hooks: Hooks[];
+};
+/**
+ * Type guard to assert that a route has hooks.
+ * @internal
+ */
+export declare function isWithHooks<T extends Record<string, unknown>>(route: T): route is T & WithHooks;
+export declare function getHooks(route: Record<string, unknown> | undefined | null): Hooks[];
+export declare function combineHooks(parent: Route, child: Route): Hooks[];
 export type InternalRouteHooks<TRoute extends Route = Route, TContext extends RouteContext[] = []> = {
     /**
      * Registers a route hook to be called before the route is entered.

package/dist/types/params.d.ts

@@ -33,7 +33,7 @@ export type ExtractParamName<TParam extends PropertyKey> = TParam extends string
  * @template TParam - The parameter type.
  * @returns The extracted type, or 'string' as a fallback.
  */
-export type ExtractParamType<TParam extends Param> = Param extends TParam ? unknown : TParam extends ParamGetSet<infer Type> ? Type : TParam extends ParamGetter ? ReturnType<TParam> : TParam extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TParam> : TParam extends LiteralParam ? TParam : string;
+export type ExtractParamType<TParam extends Param> = Param extends TParam ? unknown : TParam extends ParamGetSet<infer Type> ? Type : TParam extends DateConstructor ? Date : TParam extends JSON ? unknown : TParam extends ParamGetter ? ReturnType<TParam> : TParam extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<TParam> : TParam extends LiteralParam ? TParam : string;
 export type ParamIsOptional<TParam extends string> = TParam extends `?${string}` ? true : false;
 export type ParamIsGreedy<TParam extends string> = TParam extends `${string}*` ? true : false;
 export type ParamIsOptionalOrHasDefault<TParamName extends string, TParam extends Param | undefined> = ParamIsOptional<TParamName> extends true ? true : TParam extends Required<ParamGetSet> ? true : false;

package/dist/types/resolved.d.ts

@@ -1,4 +1,3 @@
-import { Hooks } from '../models/hooks';
 import { Route, Routes } from './route';
 import { ExtractRouteStateParamsAsOptional } from './state';
 import { UrlString } from './urlString';
@@ -45,12 +44,6 @@ export type ResolvedRoute<TRoute extends Route = Route> = Readonly<{
      * Hash value of the route.
      */
     hash: string;
-    /**
-     * The stores for routes including ancestors.
-     * Order of routes will be from greatest ancestor to narrowest matched.
-     * @internal
-     */
-    hooks: Hooks[];
 }>;
 /**
  * This type is the same as `ResolvedRoute<TRoutes[number]>` while remaining distributive

package/dist/types/route.d.ts

@@ -3,7 +3,6 @@ import { PrefetchConfig } from './prefetch';
 import { RouteMeta } from './register';
 import { LastInArray } from './utilities';
 import { CreateRouteOptions } from './createRouteOptions';
-import { Hooks } from '../models/hooks';
 import { RouteContext } from './routeContext';
 import { Url } from './url';
 /**
@@ -57,12 +56,6 @@ export type Route<TName extends string = string, TUrl extends Url = Url, TMeta e
      * Related routes and rejections for the route. The context is exposed to the hooks and props callback functions for this route.
      */
     context: TContext;
-    /**
-     * The stores for routes including ancestors.
-     * Order of routes will be from greatest ancestor to narrowest matched.
-     * @internal
-     */
-    hooks: Hooks[];
     /**
     * A value that represents how many parents a route has. Used for route matching
     * @internal

package/dist/types/routerRoute.d.ts

@@ -19,11 +19,6 @@ export type RouterRoute<TRoute extends ResolvedRoute = ResolvedRoute> = {
      * Order of routes will be from greatest ancestor to narrowest matched.
      */
     readonly matches: TRoute['matches'];
-    /**
-     * The stores for routes including ancestors.
-     * @internal
-     */
-    readonly hooks: TRoute['hooks'];
     /**
      * Hash value of the route.
      */

package/dist/types/titles.browser.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/titles.d.ts

@@ -0,0 +1,26 @@
+import { ResolvedRoute, ResolvedRouteUnion } from './resolved';
+import { Route } from './route';
+import { MaybePromise } from './utilities';
+export type SetTitleContext = {
+    from: ResolvedRoute;
+    getParentTitle: () => Promise<string | undefined>;
+};
+export type SetTitleCallback<TRoute extends Route = Route> = (to: ResolvedRouteUnion<TRoute>, context: SetTitleContext) => MaybePromise<string>;
+export type GetTitle<TRoute extends Route = Route> = (to: ResolvedRouteUnion<TRoute>) => Promise<string | undefined>;
+export type SetTitle<TRoute extends Route = Route> = (callback: SetTitleCallback<TRoute>) => void;
+export type RouteSetTitle<TRoute extends Route = Route> = {
+    /**
+     * Adds a callback to set the document title for the route.
+     */
+    setTitle: SetTitle<TRoute>;
+};
+export type RouteGetTitle<TRoute extends Route = Route> = {
+    /**
+     * @internal
+     * Gets the title for the route.
+     */
+    getTitle: GetTitle<TRoute>;
+};
+export declare function isRouteWithTitleSetter<T extends Route | ResolvedRoute>(route: T): route is T & RouteSetTitle;
+export declare function isRouteWithTitleGetter<T extends Route | ResolvedRoute>(route: T): route is T & RouteGetTitle;
+export declare function createRouteTitle(parent: Route | undefined): RouteGetTitle & RouteSetTitle;

package/dist/utilities/setDocumentTitle.d.ts

@@ -0,0 +1,2 @@
+import { ResolvedRoute } from '../types/resolved';
+export declare function setDocumentTitle(to: ResolvedRoute): void;