@kitbag/router 0.0.2 → 0.0.3

package/README.md

@@ -3,8 +3,7 @@
 A simple and versatile mapping utility for Typescript.
 
 [![Npm Version](https://img.shields.io/npm/v/@kitbag/router.svg)](https://www.npmjs.org/package/kitbag/router)
-[![Zip Size](https://img.badgesize.io/https:/unpkg.com/@kitbag/router/dist/kitbag-router?compression=gzip)](https:/unpkg.com/@kitbag/router/dist/kitbag-router)
-[![Netlify Status](https://api.netlify.com/api/v1/badges/d6033c76-88c3-4963-b24f-7a0bda20f271/deploy-status)](https://app.netlify.com/sites/kitbag-router/deploys)
+[![Netlify Status](https://api.netlify.com/api/v1/badges/c12f79b8-49f9-4529-bc23-f8ffca8919a3/deploy-status)](https://app.netlify.com/sites/kitbag-router/deploys)
 
 Get started with the [documentation](https://kitbag-router.netlify.app/)
 

package/dist/kitbag-router.d.ts

@@ -74,15 +74,23 @@ export declare type AfterRouteHookResponse<TRoutes extends Routes> = RouteHookSu
 declare type AllPropertiesAreOptional<T> = Record<string, unknown> extends T ? true : IsEmptyObject<OnlyRequiredProperties<T>>;
 
 declare type BaseResolvedRoute = Route & {
-    pathParams: Record<string, unknown>;
-    queryParams: Record<string, unknown>;
+    path: {
+        params: Record<string, unknown>;
+    };
+    query: {
+        params: Record<string, unknown>;
+    };
 };
 
 declare type BaseRoute = {
     key: string;
     disabled: false;
-    pathParams: Record<string, unknown>;
-    queryParams: Record<string, unknown>;
+    path: {
+        params: Record<string, unknown>;
+    };
+    query: {
+        params: Record<string, unknown>;
+    };
 };
 
 /**
@@ -144,7 +152,9 @@ declare type CombineQuery<TParent extends Query | undefined, TChild extends Quer
 } ? ToQuery<TChild> extends {
     query: infer TChildQuery extends string;
     params: infer TChildParams extends Record<string, unknown>;
-} ? MergeParams<TParentParams, TChildParams> extends QueryParams<`${TParentQuery}${TChildQuery}`> ? Query<`${TParentQuery}${TChildQuery}`, MergeParams<TParentParams, TChildParams>> : Query<'', {}> : Query<'', {}> : Query<'', {}>;
+} ? MergeParams<TParentParams, TChildParams> extends QueryParams<CombineQueryString<TParentQuery, TChildQuery>> ? Query<CombineQueryString<TParentQuery, TChildQuery>, MergeParams<TParentParams, TChildParams>> : Query<'', {}> : Query<'', {}> : Query<'', {}>;
+
+declare type CombineQueryString<TParent extends string | undefined, TChild extends string | undefined> = StringHasValue<TParent> extends true ? StringHasValue<TChild> extends true ? `${TParent}&${TChild}` : TParent : TChild;
 
 /**
  * Creates a router instance for a Vue application, equipped with methods for route handling, lifecycle hooks, and state management.
@@ -172,7 +182,7 @@ declare type CombineQuery<TParent extends Query | undefined, TChild extends Quer
 export declare function createRouter<const T extends Routes>(routes: T, options?: RouterOptions): Router<T>;
 
 /**
- * Creates an array of Route instances from a defined set of route properties, handling hierarchical route combinations.
+ * Creates an array of routes from a defined set of route properties, handling hierarchical route combinations.
  * This function also validates for duplicate parameter keys across the combined routes.
  *
  * @param routesProps - An array of route properties used to configure and create routes.
@@ -244,11 +254,19 @@ declare type ExtractRouteChildren<TRoute extends RouteProps> = TRoute extends Pa
  * @returns A record of parameter names to their respective types, extracted and merged from both path and query parameters.
  */
 export declare type ExtractRouteParamTypes<TRoute extends {
-    pathParams: Record<string, unknown>;
-    queryParams: Record<string, unknown>;
+    path: {
+        params: Record<string, unknown>;
+    };
+    query: {
+        params: Record<string, unknown>;
+    };
 }> = TRoute extends {
-    pathParams: infer PathParams extends Record<string, Param | undefined>;
-    queryParams: infer QueryParams extends Record<string, Param | undefined>;
+    path: {
+        params: infer PathParams extends Record<string, Param | undefined>;
+    };
+    query: {
+        params: infer QueryParams extends Record<string, Param | undefined>;
+    };
 } ? ExtractParamTypes<MergeParams<PathParams, QueryParams>> : Record<string, unknown>;
 
 declare type Flatten<T extends any[]> = T extends [infer First, ...infer Rest] ? First extends unknown[] ? Flatten<[...First, ...Flatten<Rest>]> : [First, ...Flatten<Rest>] : [];
@@ -357,22 +375,22 @@ declare type OnlyRequiredProperties<T> = {
     [K in keyof T as Extract<T[K], undefined> extends never ? K : never]: T[K];
 };
 
-declare type Param = ParamGetter | ParamGetSet | RegExp | BooleanConstructor | NumberConstructor | StringConstructor;
+export declare type Param = ParamGetter | ParamGetSet | RegExp | BooleanConstructor | NumberConstructor | StringConstructor;
 
 declare type ParamEnd = '/';
 
-declare type ParamExtras = {
+export declare type ParamExtras = {
     invalid: (message?: string) => never;
 };
 
-declare type ParamGetSet<T = any> = {
+export declare type ParamGetSet<T = any> = {
     get: ParamGetter<T>;
     set: ParamSetter<T>;
 };
 
-declare type ParamGetter<T = any> = (value: string, extras: ParamExtras) => T;
+export declare type ParamGetter<T = any> = (value: string, extras: ParamExtras) => T;
 
-declare type ParamSetter<T = any> = (value: T, extras: ParamExtras) => string;
+export declare type ParamSetter<T = any> = (value: T, extras: ParamExtras) => string;
 
 /**
  * Represents properties common to parent routes in a route configuration, including hooks, path, and optional query parameters.
@@ -563,17 +581,6 @@ export declare type Route<TKey extends string | undefined = any, TPath extends s
      * Represents the structured query of the route, including query params.
      */
     query: ToQuery<TQuery>;
-    /**
-     * Extracted path params based on the route's path type.
-     */
-    pathParams: ToPath<TPath>['params'];
-    /**
-     * Extracted query params based on the route's query type.
-     */
-    queryParams: ToQuery<TQuery>['params'];
-    /**
-     * Represents the depth of the route in the route hierarchy.
-     */
     depth: number;
     /**
      * Indicates if the route is disabled.
@@ -786,7 +793,7 @@ to: Url | ToCallback;
 }>;
 
 /**
- * Represents an error thrown when an attempt is made to use routing functionality before the router has been installed.
+ * An error thrown when an attempt is made to use routing functionality before the router has been installed.
  */
 export declare class RouterNotInstalledError extends Error {
     constructor();
@@ -890,6 +897,8 @@ declare type RouteUpdate<TRoute extends ResolvedRoute = ResolvedRoute> = {
     (params: Partial<TRoute['params']>, options?: RouterPushOptions): Promise<void>;
 };
 
+declare type StringHasValue<T extends string | undefined> = T extends undefined ? false : '' extends T ? false : true;
+
 declare type ToCallback = (resolve: RegisteredRouter['resolve']) => string;
 
 declare type ToPath<T extends string | Path> = T extends string ? Path<T, {}> : T;
@@ -927,7 +936,7 @@ export declare function useRoute<TRouteKey extends string & keyof RegisteredRout
 export declare function useRoute(): RouterRoute;
 
 /**
- * Represents an error thrown when there is a mismatch between an expected route and the one actually used.
+ * An error thrown when there is a mismatch between an expected route and the one actually used.
  */
 export declare class UseRouteInvalidError extends Error {
     /**