@kitbag/router 0.22.6 → 0.23.0

package/dist/main.d.ts

@@ -37,6 +37,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/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/types/createRouteOptions.d.ts

@@ -8,7 +8,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 +33,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 +110,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 +121,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']>>;
+]> : 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;
 export {};

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/utilities/testHelpers.d.ts

@@ -2261,17 +2261,11 @@ export declare const routes: readonly [import('../main').ToUrl<{
 }], []>>, import('../main').ToUrl<{
     readonly name: "parentB";
     readonly path: "/parentB";
-    readonly component: {
-        template: string;
-    };
 }> & {
     id: string;
     matched: Omit<{
         readonly name: "parentB";
         readonly path: "/parentB";
-        readonly component: {
-            template: string;
-        };
     }, "meta" | "name" | "props"> & {
         id: string;
         name: "parentB";
@@ -2281,9 +2275,6 @@ export declare const routes: readonly [import('../main').ToUrl<{
     matches: [Omit<{
         readonly name: "parentB";
         readonly path: "/parentB";
-        readonly component: {
-            template: string;
-        };
     }, "meta" | "name" | "props"> & {
         id: string;
         name: "parentB";
@@ -2300,15 +2291,9 @@ export declare const routes: readonly [import('../main').ToUrl<{
 } & import('../main').InternalRouteHooks<import('../main').Route<"parentB", import('../main').ToUrl<{
     readonly name: "parentB";
     readonly path: "/parentB";
-    readonly component: {
-        template: string;
-    };
 }>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentB";
     readonly path: "/parentB";
-    readonly component: {
-        template: string;
-    };
 }, "meta" | "name" | "props"> & {
     id: string;
     name: "parentB";
@@ -2317,15 +2302,9 @@ export declare const routes: readonly [import('../main').ToUrl<{
 }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentB", import('../main').ToUrl<{
     readonly name: "parentB";
     readonly path: "/parentB";
-    readonly component: {
-        template: string;
-    };
 }>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentB";
     readonly path: "/parentB";
-    readonly component: {
-        template: string;
-    };
 }, "meta" | "name" | "props"> & {
     id: string;
     name: "parentB";
@@ -2334,17 +2313,11 @@ export declare const routes: readonly [import('../main').ToUrl<{
 }], []>>, import('../main').ToUrl<{
     readonly name: "parentC";
     readonly path: "/";
-    readonly component: {
-        template: string;
-    };
 }> & {
     id: string;
     matched: Omit<{
         readonly name: "parentC";
         readonly path: "/";
-        readonly component: {
-            template: string;
-        };
     }, "meta" | "name" | "props"> & {
         id: string;
         name: "parentC";
@@ -2354,9 +2327,6 @@ export declare const routes: readonly [import('../main').ToUrl<{
     matches: [Omit<{
         readonly name: "parentC";
         readonly path: "/";
-        readonly component: {
-            template: string;
-        };
     }, "meta" | "name" | "props"> & {
         id: string;
         name: "parentC";
@@ -2373,15 +2343,9 @@ export declare const routes: readonly [import('../main').ToUrl<{
 } & import('../main').InternalRouteHooks<import('../main').Route<"parentC", import('../main').ToUrl<{
     readonly name: "parentC";
     readonly path: "/";
-    readonly component: {
-        template: string;
-    };
 }>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentC";
     readonly path: "/";
-    readonly component: {
-        template: string;
-    };
 }, "meta" | "name" | "props"> & {
     id: string;
     name: "parentC";
@@ -2390,15 +2354,9 @@ export declare const routes: readonly [import('../main').ToUrl<{
 }], []>, []> & import('../types/redirects').RouteRedirects<import('../main').Route<"parentC", import('../main').ToUrl<{
     readonly name: "parentC";
     readonly path: "/";
-    readonly component: {
-        template: string;
-    };
 }>, Readonly<{}>, {}, [Omit<{
     readonly name: "parentC";
     readonly path: "/";
-    readonly component: {
-        template: string;
-    };
 }, "meta" | "name" | "props"> & {
     id: string;
     name: "parentC";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@kitbag/router",
   "private": false,
-  "version": "0.22.6",
+  "version": "0.23.0",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/kitbagjs/router/issues"
@@ -45,9 +45,9 @@
     "@kitbag/eslint-config": "1.0.2",
     "@vitejs/plugin-vue": "^6.0.4",
     "@vue/test-utils": "^2.4.6",
-    "eslint": "^10.0.0",
-    "globals": "^17.3.0",
-    "happy-dom": "^20.6.1",
+    "eslint": "^10.0.3",
+    "globals": "^17.4.0",
+    "happy-dom": "^20.7.0",
     "typedoc": "^0.28.17",
     "typedoc-plugin-markdown": "^4.10.0",
     "typedoc-vitepress-theme": "^1.1.2",
@@ -57,7 +57,7 @@
     "vite-plugin-dts": "^4.5.4",
     "vitepress": "^1.6.4",
     "vitest": "^4.0.18",
-    "vue-tsc": "^3.2.4",
+    "vue-tsc": "^3.2.5",
     "zod": "4.0.0"
   },
   "peerDependencies": {
@@ -71,6 +71,6 @@
   },
   "dependencies": {
     "@standard-schema/spec": "^1.0.0",
-    "@vue/devtools-api": "^8.0.6"
+    "@vue/devtools-api": "^8.0.7"
   }
 }