@kitbag/router 0.21.0 → 0.22.0

package/README.md

@@ -7,6 +7,15 @@ Type safe router for Vue.js
 [![Discord chat][discord-badge]][discord-url]
 [![Open in StackBlitz][stackblitz-badge]][stackblitz-url]
 
+[npm-badge]: https://img.shields.io/npm/v/@kitbag/router.svg
+[npm-url]: https://www.npmjs.org/package/@kitbag/router
+[netlify-badge]: https://api.netlify.com/api/v1/badges/c12f79b8-49f9-4529-bc23-f8ffca8919a3/deploy-status
+[netlify-url]: https://app.netlify.com/sites/kitbag-router/deploys
+[discord-badge]: https://img.shields.io/discord/1079625926024900739?logo=discord&label=Discord
+[discord-url]: https://discord.gg/zw7dpcc5HV
+[stackblitz-badge]: https://developer.stackblitz.com/img/open_in_stackblitz_small.svg
+[stackblitz-url]: https://stackblitz.com/~/github.com/kitbagjs/router-preview
+
 <img src="https://kitbag.dev/kitbag-logo.svg" width="20%" />
 
 ## Getting Started

package/dist/components/routerLink.d.ts

@@ -1,4 +1,4 @@
-import { Url } from '../types/url';
+import { UrlString } from '../types/urlString';
 import { ResolvedRoute } from '../types/resolved';
 import { EmitsOptions, InjectionKey, SlotsType, VNode } from 'vue';
 import { Router } from '../types/router';
@@ -25,9 +25,9 @@ export declare function createRouterLink<TRouter extends Router>(routerKey: Inje
             [x: string]: unknown;
         };
         state: import('../types/state').ExtractRouteStateParamsAsOptional<Record<string, import('../main').Param>>;
-        href: Url;
+        href: UrlString;
         hooks: import('../models/hooks').Hooks[];
-    }> | Url | ToCallback<TRouter>;
+    }> | UrlString | ToCallback<TRouter>;
     prefetch?: import('../main').PrefetchConfig;
 } & ({
     [x: `on${Capitalize<string>}`]: ((...args: any[]) => any) | undefined;

package/dist/compositions/useLink.d.ts

@@ -1,14 +1,14 @@
 import { InjectionKey, MaybeRefOrGetter } from 'vue';
 import { ResolvedRoute } from '../types/resolved';
 import { RouteParamsByKey } from '../types/routeWithParams';
-import { Url } from '../types/url';
+import { UrlString } from '../types/urlString';
 import { AllPropertiesAreOptional } from '../types/utilities';
 import { Router, RouterRouteName, RouterRoutes } from '../types/router';
 import { UseLink, UseLinkOptions } from '../types/useLink';
 type UseLinkArgs<TRouter extends Router, TSource extends RouterRouteName<TRouter>, TParams = RouteParamsByKey<RouterRoutes<TRouter>, TSource>> = AllPropertiesAreOptional<TParams> extends true ? [params?: MaybeRefOrGetter<TParams>, options?: MaybeRefOrGetter<UseLinkOptions>] : [params: MaybeRefOrGetter<TParams>, options?: MaybeRefOrGetter<UseLinkOptions>];
 type UseLinkFunction<TRouter extends Router> = {
     <TRouteKey extends RouterRouteName<TRouter>>(name: MaybeRefOrGetter<TRouteKey>, ...args: UseLinkArgs<TRouter, TRouteKey>): UseLink;
-    (url: MaybeRefOrGetter<Url>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
+    (url: MaybeRefOrGetter<UrlString>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
     (resolvedRoute: MaybeRefOrGetter<ResolvedRoute | undefined>, options?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
     (source: MaybeRefOrGetter<string | ResolvedRoute | undefined>, paramsOrOptions?: MaybeRefOrGetter<Record<PropertyKey, unknown> | UseLinkOptions>, maybeOptions?: MaybeRefOrGetter<UseLinkOptions>): UseLink;
 };

package/dist/devtools/createRouterDevtools.d.ts

@@ -0,0 +1,13 @@
+import { App } from 'vue';
+import { Router } from '../types/router';
+import { Routes } from '../types/route';
+type RouterDevtoolsProps = {
+    router: Router;
+    app: App;
+    routes: Routes;
+};
+/**
+ * Sets up Vue DevTools integration for Kitbag Router.
+ */
+export declare function setupRouterDevtools({ router, app, routes }: RouterDevtoolsProps): void;
+export {};

package/dist/devtools/filters.d.ts

@@ -0,0 +1,12 @@
+import { Route } from '../types/route';
+import { InspectorTreePayload } from './types';
+type RouteFilterOptions = {
+    route: Route;
+    payload: InspectorTreePayload;
+};
+type RouteFilter = (options: RouteFilterOptions) => boolean;
+/**
+ * Checks if a route should be shown based on multiple filters.
+ */
+export declare const shouldShowRoute: RouteFilter;
+export {};

package/dist/devtools/getDevtoolsLabel.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Generates a DevTools label with optional router instance ID.
+ * If the router ID is greater than 1, appends the ID to the label.
+ *
+ * @param label - Base label for the DevTools element
+ * @param routerId - Router instance ID (string from createUniqueIdSequence)
+ * @returns Label with ID appended if routerId > '1'
+ *
+ * @example
+ * getDevtoolsLabel('Routes', '1') // 'Routes'
+ * getDevtoolsLabel('Routes', '2') // 'Routes 2'
+ */
+export declare function getDevtoolsLabel(label: string, routerId: string): string;

package/dist/devtools/types.d.ts

@@ -0,0 +1,10 @@
+import { setupDevtoolsPlugin } from '@vue/devtools-api';
+type ExtractAPIFromCallback = Parameters<Parameters<typeof setupDevtoolsPlugin>[1]>[0];
+type ExtractInspectorTreeHandler = Parameters<ExtractAPIFromCallback['on']['getInspectorTree']>[0];
+type ExtractInspectorStateHandler = Parameters<ExtractAPIFromCallback['on']['getInspectorState']>[0];
+type ExtractInspectorStatePayload = Parameters<ExtractInspectorStateHandler>[0];
+type InspectorTreePayload = Parameters<ExtractInspectorTreeHandler>[0];
+type CustomInspectorNode = InspectorTreePayload['rootNodes'][number];
+type InspectorNodeTag = NonNullable<CustomInspectorNode['tags']>[number];
+type CustomInspectorState = ExtractInspectorStatePayload['state'];
+export type { CustomInspectorNode, InspectorTreePayload, InspectorNodeTag, CustomInspectorState };

package/dist/errors/invalidRouteRedirectError.d.ts

@@ -0,0 +1,11 @@
+/**
+ * An error thrown when a route does not support redirects.
+ * @group Errors
+ */
+export declare class InvalidRouteRedirectError extends Error {
+    /**
+     * Constructs a new InvalidRouteRedirectError instance with a message indicating the problematic route redirect.
+     * @param routeName - The name of the route that does not support redirects.
+     */
+    constructor(routeName: string);
+}

package/dist/errors/multipleRouteRedirectsError.d.ts

@@ -0,0 +1,13 @@
+/**
+ * An error thrown when duplicate parameters are detected in a route.
+ * Param names must be unique. This includes params defined in a path
+ * parent and params defined in the query.
+ * @group Errors
+ */
+export declare class MultipleRouteRedirectsError extends Error {
+    /**
+     * Constructs a new MultipleRouteRedirectsError instance with a message indicating the problematic route redirect.
+     * @param routeName - The name of the route that has multiple redirects.
+     */
+    constructor(routeName: string);
+}