@kitbag/router 0.24.1 → 0.24.3

package/dist/{services → src/services}/createRejection.d.ts

@@ -1,7 +1,8 @@
 import { RejectionHooks } from '../types/hooks';
 import { Rejection } from '../types/rejection';
 import { Component } from 'vue';
+import { RouteSetTitle } from '../types/routeTitle';
 export declare function createRejection<TType extends string>(options: {
     type: TType;
     component?: Component;
-}): Rejection<TType> & RejectionHooks<TType>;
+}): Rejection<TType> & RejectionHooks<TType> & RouteSetTitle;

package/dist/{services → src/services}/createRoute.d.ts

@@ -2,7 +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';
+import { RouteSetTitle } from '../types/routeTitle';
 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>> & RouteSetTitle<ToRoute<TOptions>>;
 export {};

package/dist/{types → src/types}/createRouteOptions.d.ts

@@ -100,6 +100,10 @@ export type CreateRouteOptions<TName extends string | undefined = string | undef
      * Related routes and rejections for the route. The context is exposed to the hooks and props callback functions for this route.
      */
     context?: RouteContext[];
+    /**
+     * When true, the route will be hoisted to the top of the route tree. The route will continue to inherit meta, state, hooks, matches, and context from it's parent, but not the "url" properties.
+     */
+    hoist?: boolean;
 };
 export type PropsGetter<TOptions extends CreateRouteOptions = CreateRouteOptions, TComponent extends Component = Component> = (route: ResolvedRoute<ToRoute<TOptions>>, context: PropsCallbackContext<ToRoute<TOptions>, TOptions>) => MaybePromise<ComponentProps<TComponent>>;
 export type RouterViewPropsGetter<TOptions extends CreateRouteOptions = CreateRouteOptions> = (route: ResolvedRoute<ToRoute<TOptions>>, context: PropsCallbackContext<ToRoute<TOptions>, TOptions>) => MaybePromise<RouterViewProps & Record<string, unknown>>;
@@ -124,7 +128,7 @@ type ToMatches<TOptions extends CreateRouteOptions, TProps extends CreateRoutePr
 } ? [...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 & WithoutComponents>>, 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']>, TOptions['hoist'] extends true ? ToUrl<TOptions & WithoutComponents> : 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<Identity<TOptions & WithoutComponents>>, ToMeta<TOptions['meta']>, ToState<TOptions['state']>, ToMatches<TOptions, CreateRouteProps<TOptions> extends TProps ? undefined : TProps>, ToRouteContext<TOptions['context']>>;

package/dist/{types → src/types}/rejection.d.ts

@@ -1,5 +1,5 @@
-import { Component, Ref } from 'vue';
-import { ResolvedRoute } from './resolved';
+import { Ref } from 'vue';
+import { Route } from './route';
 import { Router } from './router';
 import { RouterReject } from './routerReject';
 import { Hooks } from '../models/hooks';
@@ -11,7 +11,7 @@ export declare const IS_REJECTION_SYMBOL: unique symbol;
 export declare function isRejection(value: unknown): value is Rejection & RejectionInternal;
 export type RejectionInternal = {
     [IS_REJECTION_SYMBOL]: true;
-    route: ResolvedRoute;
+    route: Route;
     hooks: Hooks[];
 };
 /**
@@ -23,10 +23,6 @@ export type Rejection<TType extends string = string> = {
      * The type of rejection.
      */
     type: TType;
-    /**
-     * The component to render when the rejection occurs.
-     */
-    component: Component;
 };
 export type RejectionType<TRejections extends Rejections | undefined> = unknown extends TRejections ? never : Rejections extends TRejections ? string : undefined extends TRejections ? string : TRejections extends Rejections ? TRejections[number]['type'] : never;
 export type ExtractRejections<T> = T extends {

package/dist/{types → src/types}/route.d.ts

@@ -5,7 +5,7 @@ import { LastInArray } from './utilities';
 import { CreateRouteOptions } from './createRouteOptions';
 import { RouteContext } from './routeContext';
 import { Url } from './url';
-import { GetTitle } from './titles';
+import { GetRouteTitle } from './routeTitle';
 import { Hooks } from '../models/hooks';
 import { RouteRedirect } from './redirects';
 export declare const IS_ROUTE_SYMBOL: unique symbol;
@@ -15,7 +15,7 @@ export type RouteInternal = {
     depth: number;
     hooks: Hooks[];
     redirect: RouteRedirect;
-    getTitle: GetTitle;
+    getTitle: GetRouteTitle;
 };
 /**
  * Represents an immutable array of Route instances. Return value of `createRoute`, expected param for `createRouter`.

package/dist/src/types/routeTitle.d.ts

@@ -0,0 +1,22 @@
+import { ResolvedRoute, ResolvedRouteUnion } from './resolved';
+import { Route } from './route';
+import { MaybePromise } from './utilities';
+export type SetRouteTitleContext = {
+    from: ResolvedRoute;
+    getParentTitle: () => Promise<string | undefined>;
+};
+export type SetRouteTitleCallback<TRoute extends Route = Route> = (to: ResolvedRouteUnion<TRoute>, context: SetRouteTitleContext) => MaybePromise<string>;
+export type GetRouteTitle<TRoute extends Route = Route> = (to: ResolvedRouteUnion<TRoute>) => Promise<string | undefined>;
+export type SetRouteTitle<TRoute extends Route = Route> = (callback: SetRouteTitleCallback<TRoute>) => void;
+export type RouteSetTitle<TRoute extends Route = Route> = {
+    /**
+     * Adds a callback to set the document title for the route.
+     */
+    setTitle: SetRouteTitle<TRoute>;
+};
+type CreateRouteTitle = {
+    setTitle: SetRouteTitle;
+    getTitle: GetRouteTitle;
+};
+export declare function createRouteTitle(parent?: Route): CreateRouteTitle;
+export {};

package/dist/src/utilities/setDocumentTitle.d.ts

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