@wroud/navigation
Version:
A flexible, pattern-matching navigation system for JavaScript applications with built-in routing, browser integration, and navigation state management
67 lines • 2.74 kB
TypeScript
/**
* Types for the Trie-based pattern matching system
*/
import type { RouteParams } from "../IRouteMatcher.js";
import type { IRouteState } from "../IRouteState.js";
/**
* Extracts parameter names from a pattern string using template literal types
*/
type Split<S extends string, D extends string> = S extends `${infer T}${D}${infer U}` ? [T, ...Split<U, D>] : [S];
type TrimSlashes<S extends string> = S extends `/${infer T}` ? T extends `${infer U}/` ? TrimSlashes<U> : T : S extends `${infer U}/` ? TrimSlashes<U> : S;
type GetParameterSegments<Pattern extends string> = Pattern extends "/" | "" ? [] : Extract<Split<TrimSlashes<Pattern>, "/">[number], `:${string}`>;
/**
* Extract route parameters from a pattern string.
* Returns a clean object type with parameter names as keys.
*
* @template Pattern - The URL pattern to extract parameters from
* @example
* type Params = ExtractRouteParams<"/user/:id">; // { id: string }
* type BlogParams = ExtractRouteParams<"/blog/:year/:month/:slug">; // { year: string, month: string, slug: string }
* type FileParams = ExtractRouteParams<"/files/:path*">; // { path: string[] }
*/
export type ExtractRouteParams<Pattern extends string> = Pattern extends "/" | "" ? {} : {
[K in GetParameterSegments<Pattern> as K extends `:${infer Name}*` ? Name : K extends `:${infer Name}` ? Name : never]: K extends `:${string}*` ? string[] : string;
};
/**
* Type-safe TriePatternMatching methods
*/
export interface TypedPatternMatcher {
/**
* Decode URL parameters based on a pattern
*/
decode<Pattern extends string>(pattern: Pattern, url: string): ExtractRouteParams<Pattern> | null;
/**
* Encode parameters into a URL based on a pattern
*/
encode<Pattern extends string>(pattern: Pattern, params: ExtractRouteParams<Pattern>): string;
/**
* Match a URL against the patterns in the trie
*/
match<Pattern extends string>(url: string): IPatternRouteState<Pattern> | null;
}
export interface IPatternRouteState<Pattern extends string> extends IRouteState {
id: Pattern;
params: ExtractRouteParams<this["id"]>;
}
/**
* Types of nodes in the trie structure
* - static: regular path segment that matches exactly (e.g., "user", "posts")
* - param: named parameter segment (e.g., ":id", ":action")
* - wildcard: captures multiple segments (e.g., ":path*")
*/
export type NodeType = "static" | "param" | "wildcard";
/**
* Result of a matching operation
*/
export interface MatchResult {
matched: boolean;
params: RouteParams;
}
/**
* Extended match result with the matched pattern
*/
export interface ExtendedMatchResult extends MatchResult {
pattern?: string;
}
export {};
//# sourceMappingURL=types.d.ts.map