@kitbag/router 0.20.12 → 0.22.0

package/dist/types/routerLink.d.ts

@@ -1,14 +1,14 @@
 import { PrefetchConfig } from './prefetch';
-import { Url } from './url';
+import { UrlString } from './urlString';
 import { ResolvedRoute } from './resolved';
 import { Router } from './router';
 import { RouterPushOptions } from './routerPush';
-export type ToCallback<TRouter extends Router> = (resolve: TRouter['resolve']) => ResolvedRoute | Url | undefined;
+export type ToCallback<TRouter extends Router> = (resolve: TRouter['resolve']) => ResolvedRoute | UrlString | undefined;
 export type RouterLinkProps<TRouter extends Router> = RouterPushOptions & {
     /**
      * The url string to navigate to or a callback that returns a url string
      */
-    to: Url | ResolvedRoute | ToCallback<TRouter>;
+    to: UrlString | ResolvedRoute | ToCallback<TRouter>;
     /**
      * Determines what assets are prefetched when router-link is rendered for this route. Overrides route level prefetch.
      */

package/dist/types/routerPlugin.d.ts

@@ -1,43 +1,19 @@
-import { BeforeRouteHook, AfterRouteHook, RouteHookRemove } from './hooks';
+import { HookRemove } from './hooks';
 import { Routes } from './route';
-import { MaybeArray, MaybePromise } from './utilities';
-import { Rejection } from './rejection';
-import { RouterRouteHooks } from '../models/RouterRouteHooks';
+import { Rejections } from './rejection';
+import { Hooks } from '../models/hooks';
 import { ResolvedRoute } from './resolved';
 import { RouterReject } from './routerReject';
 import { RouterPush } from './routerPush';
 import { RouterReplace } from './routerReplace';
 import { CallbackContextAbort } from '../services/createRouterCallbackContext';
+import { MaybePromise } from './utilities';
 export type EmptyRouterPlugin = RouterPlugin<[], []>;
-export type CreateRouterPluginOptions<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = {
+export type CreateRouterPluginOptions<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = {
     routes?: TRoutes;
     rejections?: TRejections;
-    /**
-     * @deprecated use plugin.onBeforeRouteEnter instead
-     */
-    onBeforeRouteEnter?: MaybeArray<BeforeRouteHook>;
-    /**
-     * @deprecated use plugin.onAfterRouteEnter instead
-     */
-    onAfterRouteEnter?: MaybeArray<AfterRouteHook>;
-    /**
-     * @deprecated use plugin.onBeforeRouteUpdate instead
-     */
-    onBeforeRouteUpdate?: MaybeArray<BeforeRouteHook>;
-    /**
-     * @deprecated use plugin.onAfterRouteUpdate instead
-     */
-    onAfterRouteUpdate?: MaybeArray<AfterRouteHook>;
-    /**
-     * @deprecated use plugin.onBeforeRouteLeave instead
-     */
-    onBeforeRouteLeave?: MaybeArray<BeforeRouteHook>;
-    /**
-     * @deprecated use plugin.onAfterRouteLeave instead
-     */
-    onAfterRouteLeave?: MaybeArray<AfterRouteHook>;
 };
-export type RouterPlugin<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = {
+export type RouterPlugin<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = {
     /**
      * The routes supplied by the plugin.
      * @internal
@@ -52,26 +28,26 @@ export type RouterPlugin<TRoutes extends Routes = Routes, TRejections extends Re
      * The hooks supplied by the plugin.
      * @internal
      */
-    hooks: RouterRouteHooks;
+    hooks: Hooks;
 };
-type PluginBeforeRouteHookContext<TRoutes extends Routes, TRejections extends Rejection[]> = {
+type PluginBeforeRouteHookContext<TRoutes extends Routes, TRejections extends Rejections> = {
     from: ResolvedRoute | null;
     reject: RouterReject<TRejections>;
     push: RouterPush<TRoutes>;
     replace: RouterReplace<TRoutes>;
     abort: CallbackContextAbort;
 };
-type PluginAfterRouteHookContext<TRoutes extends Routes, TRejections extends Rejection[]> = {
+type PluginAfterRouteHookContext<TRoutes extends Routes, TRejections extends Rejections> = {
     from: ResolvedRoute | null;
     reject: RouterReject<TRejections>;
     push: RouterPush<TRoutes>;
     replace: RouterReplace<TRoutes>;
 };
-export type PluginBeforeRouteHook<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = (to: ResolvedRoute, context: PluginBeforeRouteHookContext<TRoutes, TRejections>) => MaybePromise<void>;
-export type PluginAfterRouteHook<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = (to: ResolvedRoute, context: PluginAfterRouteHookContext<TRoutes, TRejections>) => MaybePromise<void>;
-type AddPluginBeforeRouteHook<TRoutes extends Routes, TRejections extends Rejection[]> = (hook: PluginBeforeRouteHook<TRoutes, TRejections>) => RouteHookRemove;
-type AddPluginAfterRouteHook<TRoutes extends Routes, TRejections extends Rejection[]> = (hook: PluginAfterRouteHook<TRoutes, TRejections>) => RouteHookRemove;
-export type PluginErrorHookContext<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = {
+export type PluginBeforeRouteHook<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = (to: ResolvedRoute, context: PluginBeforeRouteHookContext<TRoutes, TRejections>) => MaybePromise<void>;
+export type PluginAfterRouteHook<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = (to: ResolvedRoute, context: PluginAfterRouteHookContext<TRoutes, TRejections>) => MaybePromise<void>;
+type AddPluginBeforeRouteHook<TRoutes extends Routes, TRejections extends Rejections> = (hook: PluginBeforeRouteHook<TRoutes, TRejections>) => HookRemove;
+type AddPluginAfterRouteHook<TRoutes extends Routes, TRejections extends Rejections> = (hook: PluginAfterRouteHook<TRoutes, TRejections>) => HookRemove;
+export type PluginErrorHookContext<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = {
     to: ResolvedRoute;
     from: ResolvedRoute | null;
     source: 'props' | 'hook' | 'component';
@@ -79,9 +55,9 @@ export type PluginErrorHookContext<TRoutes extends Routes = Routes, TRejections
     push: RouterPush<TRoutes>;
     replace: RouterReplace<TRoutes>;
 };
-export type PluginErrorHook<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = (error: unknown, context: PluginErrorHookContext<TRoutes, TRejections>) => void;
-export type AddPluginErrorHook<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = (hook: PluginErrorHook<TRoutes, TRejections>) => RouteHookRemove;
-export type PluginRouteHooks<TRoutes extends Routes = Routes, TRejections extends Rejection[] = Rejection[]> = {
+export type PluginErrorHook<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = (error: unknown, context: PluginErrorHookContext<TRoutes, TRejections>) => void;
+export type AddPluginErrorHook<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = (hook: PluginErrorHook<TRoutes, TRejections>) => HookRemove;
+export type PluginRouteHooks<TRoutes extends Routes = Routes, TRejections extends Rejections = Rejections> = {
     /**
      * Registers a global hook to be called before a route is entered.
      */

package/dist/types/routerPush.d.ts

@@ -2,7 +2,7 @@ import { Routes } from './route';
 import { RoutesName } from './routesMap';
 import { RouteParamsByKey } from './routeWithParams';
 import { RouteStateByName } from './state';
-import { Url } from './url';
+import { UrlString } from './urlString';
 import { AllPropertiesAreOptional } from './utilities';
 import { QuerySource } from './querySource';
 import { ResolvedRoute } from './resolved';
@@ -28,6 +28,6 @@ type RouterPushArgs<TRoutes extends Routes, TSource extends RoutesName<TRoutes>>
 export type RouterPush<TRoutes extends Routes = any> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterPushArgs<TRoutes, TSource>): Promise<void>;
     (route: ResolvedRoute, options?: RouterPushOptions): Promise<void>;
-    (url: Url, options?: RouterPushOptions): Promise<void>;
+    (url: UrlString, options?: RouterPushOptions): Promise<void>;
 };
 export {};

package/dist/types/routerReject.d.ts

@@ -1,3 +1,3 @@
 import { BuiltInRejectionType } from '../services/createRouterReject';
-import { Rejection, RejectionType } from './rejection';
-export type RouterReject<TRejections extends Rejection[] | undefined> = <TSource extends (RejectionType<TRejections> | BuiltInRejectionType)>(type: TSource) => void;
+import { Rejections, RejectionType } from './rejection';
+export type RouterReject<TRejections extends Rejections | undefined> = <TSource extends (RejectionType<TRejections> | BuiltInRejectionType)>(type: TSource) => void;

package/dist/types/routerReplace.d.ts

@@ -2,7 +2,7 @@ import { Routes } from './route';
 import { RoutesName } from './routesMap';
 import { RouteParamsByKey } from './routeWithParams';
 import { RouteStateByName } from './state';
-import { Url } from './url';
+import { UrlString } from './urlString';
 import { AllPropertiesAreOptional } from './utilities';
 import { QuerySource } from './querySource';
 import { ResolvedRoute } from './resolved';
@@ -15,6 +15,6 @@ type RouterReplaceArgs<TRoutes extends Routes, TSource extends RoutesName<TRoute
 export type RouterReplace<TRoutes extends Routes> = {
     <TSource extends RoutesName<TRoutes>>(name: TSource, ...args: RouterReplaceArgs<TRoutes, TSource>): Promise<void>;
     (route: ResolvedRoute, options?: RouterReplaceOptions): Promise<void>;
-    (url: Url, options?: RouterReplaceOptions): Promise<void>;
+    (url: UrlString, options?: RouterReplaceOptions): Promise<void>;
 };
 export {};

package/dist/types/{url.d.ts → urlString.d.ts}

@@ -1,5 +1,5 @@
 import { QuerySource } from './querySource';
-export type Url = `http://${string}` | `https://${string}` | `/${string}`;
+export type UrlString = `http://${string}` | `https://${string}` | `/${string}`;
 export type UrlParts = {
     protocol?: string;
     host?: string;
@@ -14,10 +14,10 @@ export type UrlParts = {
  * @returns `true` if the value is a valid URL, otherwise `false`.
  * @group Type Guards
  */
-export declare function isUrl(value: unknown): value is Url;
+export declare function isUrlString(value: unknown): value is UrlString;
 /**
  * Converts a string to a valid URL.
  * @param value - The string to convert.
  * @returns The valid URL.
  */
-export declare function asUrl(value: string): Url;
+export declare function asUrlString(value: string): UrlString;

package/dist/types/useLink.d.ts

@@ -3,7 +3,7 @@ import { PrefetchConfig } from './prefetch';
 import { ResolvedRoute } from './resolved';
 import { RouterPushOptions } from './routerPush';
 import { RouterReplaceOptions } from './routerReplace';
-import { Url } from './url';
+import { UrlString } from './urlString';
 export type UseLink = {
     /**
      * A template ref to bind to the dom for automatic prefetching
@@ -16,7 +16,7 @@ export type UseLink = {
     /**
      * Resolved URL with params interpolated and query applied. Same value as `router.resolve`.
      */
-    href: ComputedRef<Url | undefined>;
+    href: ComputedRef<UrlString | undefined>;
     /**
      * True if route matches current URL or is ancestor of route that matches current URL
      */

package/dist/utilities/checkDuplicateParams.spec.d.ts

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

package/dist/utilities/index.d.ts

@@ -1,5 +1,5 @@
 export * from './array';
-export * from './checkDuplicateKeys';
+export * from './checkDuplicateParams';
 export * from './guards';
 export * from './isBrowser';
 export * from './makeOptional';

package/dist/utilities/isNamedRoute.d.ts

@@ -0,0 +1,4 @@
+import { Route } from '../types/route';
+export declare function isNamedRoute(route: Route): route is Route & {
+    name: string;
+};