@kitbag/router 0.20.6 → 0.20.8

package/dist/types/useLink.d.ts

@@ -0,0 +1,51 @@
+import { ComputedRef, Ref } from 'vue';
+import { PrefetchConfig } from './prefetch';
+import { ResolvedRoute } from './resolved';
+import { RouterPushOptions } from './routerPush';
+import { RouterReplaceOptions } from './routerReplace';
+import { Url } from './url';
+export type UseLink = {
+    /**
+     * A template ref to bind to the dom for automatic prefetching
+     */
+    element: Ref<HTMLElement | undefined>;
+    /**
+     * ResolvedRoute if matched. Same value as `router.find`
+     */
+    route: ComputedRef<ResolvedRoute | undefined>;
+    /**
+     * Resolved URL with params interpolated and query applied. Same value as `router.resolve`.
+     */
+    href: ComputedRef<Url | undefined>;
+    /**
+     * True if route matches current URL or is ancestor of route that matches current URL
+     */
+    isMatch: ComputedRef<boolean>;
+    /**
+     * True if route matches current URL. Route is the same as what's currently stored at `router.route`.
+     */
+    isExactMatch: ComputedRef<boolean>;
+    /**
+     * True if route matches current URL, or is a parent route that matches the parent of the current URL.
+     */
+    isActive: ComputedRef<boolean>;
+    /**
+     * True if route matches current URL exactly.
+     */
+    isExactActive: ComputedRef<boolean>;
+    /**
+     *
+     */
+    isExternal: ComputedRef<boolean>;
+    /**
+     * Convenience method for executing `router.push` with route context passed in.
+     */
+    push: (options?: RouterPushOptions) => Promise<void>;
+    /**
+     * Convenience method for executing `router.replace` with route context passed in.
+     */
+    replace: (options?: RouterReplaceOptions) => Promise<void>;
+};
+export type UseLinkOptions = RouterPushOptions & {
+    prefetch?: PrefetchConfig;
+};

package/dist/types/utilities.d.ts

@@ -0,0 +1,22 @@
+export type Identity<T> = T extends object ? {} & {
+    [P in keyof T as T[P] extends never ? never : P]: T[P];
+} : T;
+type IsEmptyObject<T> = T extends Record<string, never> ? (keyof T extends never ? true : false) : false;
+export type MaybeArray<T> = T | T[];
+export type LastInArray<T, TFallback = never> = T extends [...any[], infer Last] ? Last : TFallback;
+export type MaybePromise<T> = T | Promise<T>;
+type OnlyRequiredProperties<T> = {
+    [K in keyof T as Extract<T[K], undefined> extends never ? K : never]: T[K];
+};
+export type AllPropertiesAreOptional<T> = Record<string, unknown> extends T ? true : IsEmptyObject<OnlyRequiredProperties<T>>;
+/**
+ * Converts a type to a string if it is a string, otherwise returns never.
+ * Specifically useful when using keyof T to produce a union of strings
+ * rather than string | number | symbol.
+ */
+export type AsString<T> = T extends string ? T : never;
+/**
+ * Extracts the keys of a union type.
+ */
+export type KeysOfUnion<T> = T extends T ? keyof T : never;
+export {};

package/dist/utilities/array.d.ts

@@ -0,0 +1,2 @@
+export declare function asArray<T>(value: Readonly<T | T[]>): T[];
+export declare function getCount<T>(array: T[], item: T): number;

package/dist/utilities/checkDuplicateKeys.d.ts

@@ -0,0 +1 @@
+export declare function checkDuplicateParams(...withParams: (Record<string, unknown> | string[])[]): void;

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

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

package/dist/utilities/checkDuplicateNames.d.ts

@@ -0,0 +1,2 @@
+import { Routes } from '../types/route';
+export declare function checkDuplicateNames(routes: Routes): void;

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

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

package/dist/utilities/components.d.ts

@@ -0,0 +1,6 @@
+import { Component } from 'vue';
+type ComponentWithAsyncLoader = Component & {
+    __asyncLoader: () => void;
+};
+export declare function isAsyncComponent(component: Component): component is ComponentWithAsyncLoader;
+export {};

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

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

package/dist/utilities/guards.d.ts

@@ -0,0 +1,5 @@
+export declare function isDefined<T>(value: T | undefined): value is T;
+export declare function isRecord(value: unknown): value is Record<PropertyKey, unknown>;
+export declare function hasProperty<TSource extends Record<PropertyKey, unknown>, TProperty extends PropertyKey, TType extends () => unknown>(value: TSource, key: TProperty, type?: TType): value is TSource & Record<TProperty, ReturnType<TType>>;
+export declare function stringHasValue(value: string | undefined): value is string;
+export type StringHasValue<T> = string extends T ? true : '' extends T ? false : T extends string ? true : false;

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

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

package/dist/utilities/index.d.ts

@@ -0,0 +1,6 @@
+export * from './array';
+export * from './checkDuplicateKeys';
+export * from './guards';
+export * from './isBrowser';
+export * from './makeOptional';
+export * from './testHelpers';

package/dist/utilities/isBrowser.browser.spec.d.ts

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

package/dist/utilities/isBrowser.d.ts

@@ -0,0 +1 @@
+export declare function isBrowser(): boolean;

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

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

package/dist/utilities/makeOptional.d.ts

@@ -0,0 +1,9 @@
+type WithOptionalProperties<T> = {
+    [P in keyof T]-?: undefined extends T[P] ? P : never;
+}[keyof T];
+export type MakeOptional<T> = {
+    [P in WithOptionalProperties<T>]?: T[P];
+} & {
+    [P in Exclude<keyof T, WithOptionalProperties<T>>]: T[P];
+};
+export {};

package/dist/utilities/prefetch.d.ts

@@ -0,0 +1,4 @@
+import { PrefetchConfig, PrefetchConfigOptions, PrefetchConfigs, PrefetchStrategy } from '../types/prefetch';
+export declare const DEFAULT_PREFETCH_STRATEGY: PrefetchStrategy;
+export declare function getPrefetchOption({ routerPrefetch, routePrefetch, linkPrefetch }: PrefetchConfigs, setting: keyof PrefetchConfigOptions): false | PrefetchStrategy;
+export declare function getPrefetchConfigValue(prefetch: PrefetchConfig | undefined, setting: keyof PrefetchConfigOptions): boolean | PrefetchStrategy | undefined;

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

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

package/dist/utilities/promises.d.ts

@@ -0,0 +1 @@
+export declare function isPromise(value: unknown): value is Promise<unknown>;

package/dist/utilities/props.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Takes a props callback and returns a value
+ * For sync props, this will return the props value or an error.
+ * For async props, this will return a promise that resolves to the props value or an error.
+ */
+export declare function getPropsValue(callback: () => unknown): unknown;

package/dist/utilities/testHelpers.d.ts

@@ -0,0 +1,144 @@
+import { ResolvedRoute } from '../types/resolved';
+export declare const random: {
+    number(options?: {
+        min?: number;
+        max?: number;
+    }): number;
+};
+export declare function getError(callback: () => any): unknown;
+export declare const component: {
+    template: string;
+};
+export declare const routes: readonly [import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "props"> & {
+    id: string;
+    props: undefined;
+}]>, import('../main').Route<"parentA.childA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]", {
+    paramA: StringConstructor;
+} & {
+    paramB: StringConstructor;
+}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "props"> & {
+    id: string;
+    props: undefined;
+}, Omit<{
+    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "props"> & {
+        id: string;
+        props: undefined;
+    }]>;
+    readonly name: "parentA.childA";
+    readonly path: "/childA/[?paramB]";
+}, "props"> & {
+    id: string;
+    props: undefined;
+}]>, import('../main').Route<"parentA.childB", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childB/[paramD]", {
+    paramA: StringConstructor;
+} & {
+    paramD: StringConstructor;
+}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "props"> & {
+    id: string;
+    props: undefined;
+}, Omit<{
+    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "props"> & {
+        id: string;
+        props: undefined;
+    }]>;
+    readonly name: "parentA.childB";
+    readonly path: "/childB/[paramD]";
+    readonly component: {
+        template: string;
+    };
+}, "props"> & {
+    id: string;
+    props: undefined;
+}]>, import('../main').Route<"parentA.childA.grandChildA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]/[paramC]", {
+    paramA: StringConstructor;
+    paramB: StringConstructor;
+} & {
+    paramC: StringConstructor;
+}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly name: "parentA";
+    readonly path: "/parentA/[paramA]";
+}, "props"> & {
+    id: string;
+    props: undefined;
+}, Omit<{
+    readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "props"> & {
+        id: string;
+        props: undefined;
+    }]>;
+    readonly name: "parentA.childA";
+    readonly path: "/childA/[?paramB]";
+}, "props"> & {
+    id: string;
+    props: undefined;
+}, Omit<{
+    readonly parent: import('../main').Route<"parentA.childA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]/childA/[?paramB]", {
+        paramA: StringConstructor;
+    } & {
+        paramB: StringConstructor;
+    }>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+        readonly name: "parentA";
+        readonly path: "/parentA/[paramA]";
+    }, "props"> & {
+        id: string;
+        props: undefined;
+    }, Omit<{
+        readonly parent: import('../main').Route<"parentA", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentA/[paramA]", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+            readonly name: "parentA";
+            readonly path: "/parentA/[paramA]";
+        }, "props"> & {
+            id: string;
+            props: undefined;
+        }]>;
+        readonly name: "parentA.childA";
+        readonly path: "/childA/[?paramB]";
+    }, "props"> & {
+        id: string;
+        props: undefined;
+    }]>;
+    readonly name: "parentA.childA.grandChildA";
+    readonly path: "/[paramC]";
+    readonly component: {
+        template: string;
+    };
+}, "props"> & {
+    id: string;
+    props: undefined;
+}]>, import('../main').Route<"parentB", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/parentB", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly name: "parentB";
+    readonly path: "/parentB";
+    readonly component: {
+        template: string;
+    };
+}, "props"> & {
+    id: string;
+    props: undefined;
+}]>, import('../main').Route<"parentC", import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"/", {}>, import('../services/withParams').WithParams<"", {}>, import('../services/withParams').WithParams<"", {}>, {}, {}, [Omit<{
+    readonly name: "parentC";
+    readonly path: "/";
+    readonly component: {
+        template: string;
+    };
+}, "props"> & {
+    id: string;
+    props: undefined;
+}]>];
+export declare function mockRoute(name: string): ResolvedRoute['matched'];
+export declare function mockResolvedRoute(matched: ResolvedRoute['matched'], matches: ResolvedRoute['matched'][]): ResolvedRoute;

package/dist/utilities/urlSearchParams.d.ts

@@ -0,0 +1,2 @@
+import { QuerySource } from '../types/querySource';
+export declare function combineUrlSearchParams(...paramGroups: (URLSearchParams | QuerySource)[]): URLSearchParams;

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

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kitbag/router",
   "private": false,
-  "version": "0.20.6",
+  "version": "0.20.8",
   "bugs": {
     "url": "https://github.com/kitbagjs/router/issues"
   },
@@ -41,21 +41,21 @@
   },
   "devDependencies": {
     "@kitbag/eslint-config": "1.0.2",
-    "@vitejs/plugin-vue": "^5.2.4",
+    "@vitejs/plugin-vue": "^6.0.1",
     "@vue/test-utils": "^2.4.6",
-    "eslint": "^9.29.0",
-    "globals": "^16.2.0",
-    "happy-dom": "^18.0.1",
-    "typedoc": "^0.28.5",
-    "typedoc-plugin-markdown": "^4.6.4",
+    "eslint": "^9.39.1",
+    "globals": "^16.5.0",
+    "happy-dom": "^20.0.8",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typedoc-vitepress-theme": "^1.1.2",
-    "typescript": "^5.8.3",
+    "typescript": "^5.9.3",
     "valibot": "^1.0.0",
-    "vite": "^6.3.5",
+    "vite": "^7.1.12",
     "vite-plugin-dts": "^4.5.4",
-    "vitepress": "^1.6.3",
-    "vitest": "^3.2.4",
-    "vue-tsc": "^2.2.10"
+    "vitepress": "^1.6.4",
+    "vitest": "^4.0.4",
+    "vue-tsc": "^3.1.2"
   },
   "peerDependencies": {
     "vue": "^3.5.0",