@kitbag/router 0.5.0 → 0.5.2

package/dist/kitbag-router.d.ts

@@ -88,17 +88,6 @@ export declare type AfterRouteHookResponse<TRoutes extends Routes> = RouteHookSu
 
 declare type AllPropertiesAreOptional<T> = Record<string, unknown> extends T ? true : IsEmptyObject<OnlyRequiredProperties<T>>;
 
-declare type BaseRoute = {
-    key: string;
-    disabled: false;
-    path: {
-        params: Record<string, unknown>;
-    };
-    query: {
-        params: Record<string, unknown>;
-    };
-};
-
 /**
  * Represents a function called before a route change, potentially altering the routing operation.
  * @param to - {@link ResolvedRoute} The resolved route the router is navigating to.
@@ -156,7 +145,7 @@ export declare type ChildRouteProps = (WithComponent | WithComponents) & WithHoo
     meta?: RouteMeta;
 };
 
-declare type CombineName<TParentName extends string | undefined, TChildName extends string | undefined> = TParentName extends string ? TChildName extends string ? `${TParentName}.${TChildName}` : TParentName : TChildName extends string ? TChildName : '';
+declare type CombineName<TParentName extends string | undefined, TChildName extends string | undefined> = StringHasValue<TParentName> extends true ? StringHasValue<TChildName> extends true ? `${TParentName}.${TChildName}` : TParentName : StringHasValue<TChildName> extends true ? TChildName : '';
 
 declare type CombinePath<TParent extends Path, TChild extends Path> = ToPath<TParent> extends {
     path: infer TParentPath extends string;
@@ -164,7 +153,7 @@ declare type CombinePath<TParent extends Path, TChild extends Path> = ToPath<TPa
 } ? ToPath<TChild> extends {
     path: infer TChildPath extends string;
     params: infer TChildParams extends Record<string, unknown>;
-} ? MergeParams<TParentParams, TChildParams> extends PathParams<`${TParentPath}${TChildPath}`> ? Path<`${TParentPath}${TChildPath}`, MergeParams<TParentParams, TChildParams>> : Path<'', {}> : Path<'', {}> : Path<'', {}>;
+} ? MergeParams<RemoveLeadingQuestionMarkFromKeys<TParentParams>, RemoveLeadingQuestionMarkFromKeys<TChildParams>> extends PathParamsWithParamNameExtracted<`${TParentPath}${TChildPath}`> ? Path<`${TParentPath}${TChildPath}`, MergeParams<RemoveLeadingQuestionMarkFromKeys<TParentParams>, RemoveLeadingQuestionMarkFromKeys<TChildParams>>> : Path<'', {}> : Path<'', {}> : Path<'', {}>;
 
 declare type CombineQuery<TParent extends Query | undefined, TChild extends Query | undefined> = ToQuery<TParent> extends {
     query: infer TParentQuery extends string;
@@ -172,7 +161,7 @@ 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<CombineQueryString<TParentQuery, TChildQuery>> ? Query<CombineQueryString<TParentQuery, TChildQuery>, MergeParams<TParentParams, TChildParams>> : Query<'', {}> : Query<'', {}> : Query<'', {}>;
+} ? MergeParams<RemoveLeadingQuestionMarkFromKeys<TParentParams>, RemoveLeadingQuestionMarkFromKeys<TChildParams>> extends QueryParamsWithParamNameExtracted<CombineQueryString<TParentQuery, TChildQuery>> ? Query<CombineQueryString<TParentQuery, TChildQuery>, MergeParams<RemoveLeadingQuestionMarkFromKeys<TParentParams>, RemoveLeadingQuestionMarkFromKeys<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;
 
@@ -389,7 +378,9 @@ declare type ExtractRouteParamTypesWithoutLosingOptional<TRoute> = TRoute extend
 
 declare type Flatten<T extends any[]> = T extends [infer First, ...infer Rest] ? First extends unknown[] ? Flatten<[...First, ...Flatten<Rest>]> : [First, ...Flatten<Rest>] : [];
 
-declare type FlattenRoute<TRoute extends RouteProps | ExternalRouteProps, TKey extends string = string & TRoute['name'], THost extends string = TRoute extends {
+declare type FlattenRoute<TRoute extends RouteProps | ExternalRouteProps, TKey extends string = TRoute extends {
+    name: infer T extends string;
+} ? T : '', THost extends string = TRoute extends {
     host: infer T extends string;
 } ? T : '', TPath extends Path = ToPath<TRoute['path']>, TQuery extends Query = ToQuery<TRoute['query']>, TDisabled extends boolean = TRoute['disabled'] extends boolean ? TRoute['disabled'] : false, TChildren extends Route[] = ExtractRouteChildren<TRoute>> = [
 Route<TKey, THost, TPath, TQuery, TDisabled>,
@@ -459,10 +450,16 @@ export declare function isRoute<TRouteKey extends RegisteredRoutesKey>(route: un
 
 export declare function isRoute(route: unknown, routeKey?: string, options?: IsRouteOptions): boolean;
 
+declare type IsRouteDisabled<T extends Route> = T extends {
+    disabled: true;
+} ? true : false;
+
 declare type IsRouteOptions = {
     exact?: boolean;
 };
 
+declare type IsRouteUnnamed<T extends Route> = StringHasValue<T['key']> extends true ? false : true;
+
 export declare function isRouteWithComponent(value: RouteProps): value is RouteProps & WithComponent;
 
 export declare function isRouteWithComponent(value: Readonly<RouteProps>): value is Readonly<RouteProps & WithComponent>;
@@ -491,8 +488,6 @@ export declare type MergeParams<TAlpha extends Record<string, unknown>, TBeta ex
     [K in keyof TAlpha | keyof TBeta]: K extends keyof TAlpha & keyof TBeta ? never : K extends keyof TAlpha ? TAlpha[K] : K extends keyof TBeta ? TBeta[K] : never;
 };
 
-declare type NamedNotDisabled<T> = T extends BaseRoute ? T : never;
-
 /**
  * Registers a hook that is called after a route has been entered. Must be called during setup.
  * This allows performing actions right after the component becomes active, such as fetching data or setting up event listeners.
@@ -629,10 +624,6 @@ declare type Path<TPath extends string = string, TParams extends PathParamsWithP
  */
 export declare function path<TPath extends string, TParams extends PathParamsWithParamNameExtracted<TPath>>(path: TPath, params: Identity<TParams>): Path<TPath, TParams>;
 
-declare type PathParams<TPath extends string> = {
-    [K in keyof ExtractParamsFromPathString<TPath>]?: Param;
-};
-
 declare type PathParamsWithParamNameExtracted<TPath extends string> = {
     [K in keyof ExtractParamsFromPathString<TPath> as ExtractParamName<K>]?: Param;
 };
@@ -672,10 +663,6 @@ declare type Query<TQuery extends string = string, TQueryParams extends QueryPar
  */
 export declare function query<TQuery extends string, TParams extends QueryParamsWithParamNameExtracted<TQuery>>(query: TQuery, params: Identity<TParams>): Query<TQuery, TParams>;
 
-declare type QueryParams<T extends string> = {
-    [K in keyof ExtractQueryParamsFromQueryString<T>]?: Param;
-};
-
 declare type QueryParamsWithParamNameExtracted<T extends string> = {
     [K in keyof ExtractQueryParamsFromQueryString<T> as ExtractParamName<K>]?: Param;
 };
@@ -749,6 +736,12 @@ export declare type RegisteredRoutes = Register extends {
  */
 export declare type RegisteredRoutesKey = RoutesKey<RegisteredRoutes>;
 
+declare type RemoveLeadingQuestionMark<T extends PropertyKey> = T extends `?${infer TRest extends string}` ? TRest : T;
+
+declare type RemoveLeadingQuestionMarkFromKeys<T extends Record<string, unknown>> = {
+    [K in keyof T as RemoveLeadingQuestionMark<K>]: T[K];
+};
+
 /**
  * Represents a route that the router has matched to current browser location.
  * @template TRoute - Underlying Route that has been resolved.
@@ -891,6 +884,8 @@ declare type RouteHookSuccessResponse = {
     status: 'SUCCESS';
 };
 
+declare type RouteIsNamedAndNotDisabled<T extends Route> = IsRouteDisabled<T> extends true ? never : IsRouteUnnamed<T> extends true ? never : T;
+
 /**
  * Represents additional metadata associated with a route, customizable via declaration merging.
  * @example
@@ -1167,9 +1162,7 @@ export declare type Routes = Readonly<Route[]>;
 declare type RoutesKey<TRoutes extends Routes> = string & keyof RoutesMap<TRoutes>;
 
 declare type RoutesMap<TRoutes extends Routes = []> = {
-    [K in TRoutes[number] as NamedNotDisabled<K> extends {
-        key: string;
-    } ? NamedNotDisabled<K>['key'] : never]: NamedNotDisabled<K>;
+    [K in TRoutes[number] as RouteIsNamedAndNotDisabled<K>['key']]: RouteIsNamedAndNotDisabled<K>;
 };
 
 declare type RouteUpdate<TRoute extends ResolvedRoute = ResolvedRoute> = ResolvedRoute extends TRoute ? {
@@ -1180,7 +1173,7 @@ declare type RouteUpdate<TRoute extends ResolvedRoute = ResolvedRoute> = Resolve
     (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 StringHasValue<T> = string extends T ? true : '' extends T ? false : T extends string ? true : false;
 
 export declare function throwIfDuplicateParamsAreFound(routes: Route[]): void;