driftjs-router 0.0.15 → 0.0.17

package/dist/index.d.ts

@@ -0,0 +1,242 @@
+declare module 'driftjs-router' {
+  import type { Context } from 'driftjs-shared';
+  import type { CompiledModule } from 'driftjs-compiler';
+
+  export type RouteParams = Record<string, string | string[]>;
+  export type RouteQuery = Record<string, string | null | (string | null)[] | undefined>;
+
+  export interface ScrollPositionCoordinates {
+    left?: number | undefined;
+    top?: number | undefined;
+    behavior?: ScrollBehavior | undefined;
+  }
+
+  export interface ScrollPositionElement {
+    el: string | Element;
+    behavior?: ScrollBehavior | undefined;
+  }
+
+  export type ScrollPosition = ScrollPositionCoordinates | ScrollPositionElement;
+
+  export type RouterScrollBehavior = (
+    to: RouteLocationNormalized,
+    from: RouteLocationNormalized,
+    savedPosition: ScrollPositionCoordinates | null
+  ) => ScrollPosition | Promise<ScrollPosition> | false | void | null;
+
+  export type RouteComponent = any;
+
+  export interface RouteRecordRaw {
+    path: string;
+    name?: string | undefined;
+    component?: RouteComponent | undefined;
+    components?: Record<string, RouteComponent> | undefined;
+    redirect?: string | RouteLocationRaw | ((to: RouteLocation) => string | RouteLocationRaw) | undefined;
+    children?: RouteRecordRaw[] | undefined;
+    meta?: Record<string | number | symbol, any> | undefined;
+    beforeEnter?: NavigationGuard | NavigationGuard[] | undefined;
+    props?: boolean | Record<string, any> | ((route: RouteLocationNormalized) => Record<string, any>) | undefined;
+  }
+
+  export interface RouteRecordNormalized {
+    path: string;
+    name?: string | undefined;
+    components: Record<string, RouteComponent>;
+    children: RouteRecordNormalized[];
+    meta: Record<string | number | symbol, any>;
+    beforeEnter?: NavigationGuard[] | undefined;
+    props: Record<string, boolean | Record<string, any> | ((route: RouteLocationNormalized) => Record<string, any>)>;
+    parent?: RouteRecordNormalized | undefined;
+    regex: RegExp;
+    paramNames: string[];
+    score?: number | undefined;
+    redirect?: string | RouteLocationRaw | ((to: RouteLocation) => string | RouteLocationRaw) | undefined;
+  }
+
+  export type MatchedRoute = RouteRecordNormalized;
+
+  export interface RouteLocation {
+    path: string;
+    fullPath: string;
+    query: RouteQuery;
+    hash: string;
+    params: RouteParams;
+    name?: string | undefined;
+    matched: RouteRecordNormalized[];
+    meta: Record<string | number | symbol, any>;
+    redirectedFrom?: RouteLocation | undefined;
+  }
+
+  export interface RouteLocationNormalized extends RouteLocation {
+    href: string;
+  }
+
+  export interface RouteLocationOptions {
+    path?: string | undefined;
+    name?: string | undefined;
+    params?: RouteParams | undefined;
+    query?: RouteQuery | undefined;
+    hash?: string | undefined;
+    replace?: boolean | undefined;
+    state?: HistoryState | undefined;
+    force?: boolean | undefined;
+  }
+
+  export type RouteLocationRaw = string | RouteLocationOptions;
+
+  export type HistoryState = Record<string, any> | null;
+
+  export type NavigationDirection = 'forward' | 'back' | 'unknown';
+
+  export interface NavigationInformation {
+    direction: NavigationDirection;
+    delta: number;
+    type: 'pop' | 'push' | 'replace';
+  }
+
+  export type NavigationCallback = (to: string, from: string, information: NavigationInformation) => void;
+
+  export interface RouterHistory {
+    readonly base: string;
+    readonly location: string;
+    readonly state: HistoryState;
+    listen(callback: NavigationCallback): () => void;
+    push(to: string, data?: HistoryState): void;
+    replace(to: string, data?: HistoryState): void;
+    go(delta: number): void;
+    destroy(): void;
+  }
+
+  export type HistoryLocation = string;
+
+  export enum NavigationFailureType {
+    aborted = 4,
+    cancelled = 8,
+    duplicated = 16,
+  }
+
+  export interface NavigationFailure extends Error {
+    type: NavigationFailureType;
+    from: RouteLocationNormalized;
+    to: RouteLocationNormalized;
+  }
+
+  export type NavigationGuardReturn = void | boolean | string | RouteLocationRaw | Error;
+
+  export type NavigationGuard = (
+    to: RouteLocationNormalized,
+    from: RouteLocationNormalized
+  ) => NavigationGuardReturn | Promise<NavigationGuardReturn>;
+
+  export type NavigationHookAfter = (
+    to: RouteLocationNormalized,
+    from: RouteLocationNormalized,
+    failure?: NavigationFailure | void
+  ) => any;
+
+  export interface RouterOptions {
+    history: RouterHistory;
+    routes: readonly RouteRecordRaw[];
+    scrollBehavior?: RouterScrollBehavior | undefined;
+    linkActiveClass?: string | undefined;
+    linkExactActiveClass?: string | undefined;
+  }
+
+  export interface Router {
+    readonly currentRoute: RouteLocationNormalized;
+    readonly options: RouterOptions;
+    push(to: RouteLocationRaw): Promise<NavigationFailure | void | undefined>;
+    replace(to: RouteLocationRaw): Promise<NavigationFailure | void | undefined>;
+    go(delta: number): void;
+    back(): void;
+    forward(): void;
+    beforeEach(guard: NavigationGuard): () => void;
+    beforeResolve(guard: NavigationGuard): () => void;
+    afterEach(hook: NavigationHookAfter): () => void;
+    onError(handler: (error: any) => void): () => void;
+    isReady(): Promise<void>;
+    resolve(to: RouteLocationRaw, currentLocation?: RouteLocationNormalized): RouteLocationNormalized;
+    addRoute(parentOrRoute: string | RouteRecordRaw, route?: RouteRecordRaw): () => void;
+    removeRoute(name: string): void;
+    hasRoute(name: string): boolean;
+    getRoutes(): RouteRecordNormalized[];
+    subscribe(callback: (to: RouteLocationNormalized, from: RouteLocationNormalized) => void): () => void;
+    destroy(): void;
+  }
+
+  export interface RouterViewProps {
+    name?: string | undefined;
+    route?: RouteLocationNormalized | undefined;
+  }
+
+  export interface LinkProps {
+    to: RouteLocationRaw;
+    replace?: boolean | undefined;
+    activeClass?: string | undefined;
+    exactActiveClass?: string | undefined;
+    custom?: boolean | undefined;
+    target?: string | undefined;
+    rel?: string | undefined;
+    class?: string | undefined;
+  }
+
+  export interface PathTokens {
+    regex: RegExp;
+    paramNames: string[];
+    score: number;
+  }
+
+  export interface RouteMatcher {
+    resolve(to: RouteLocationRaw, currentLocation?: RouteLocationNormalized): RouteLocationNormalized;
+    addRoute(parentOrRoute: string | RouteRecordRaw, route?: RouteRecordRaw): () => void;
+    removeRoute(name: string): void;
+    hasRoute(name: string): boolean;
+    getRoutes(): RouteRecordNormalized[];
+  }
+
+  // History factories & helpers
+  export function createHistoryListeners(): {
+    readonly list: NavigationCallback[];
+    add(fn: NavigationCallback): () => void;
+    reset(): void;
+  };
+  export function extractHistoryState(rawState: any): HistoryState;
+  export function buildHistoryState(data: HistoryState | undefined, pos: number): Record<string, any>;
+  export function createWebHistory(base?: string): RouterHistory;
+  export function createWebHashHistory(base?: string): RouterHistory;
+  export function createMemoryHistory(initialLocation?: string, base?: string): RouterHistory;
+
+  // Path utilities
+  export function normalizePath(path: string): string;
+  export function normalizeBase(base?: string): string;
+  export function stripBase(pathname: string, base: string): string;
+  export function createHref(base: string, location: string): string;
+  export function formatHashHref(base: string, location: string): string;
+
+  // Matcher utilities
+  export function parseQuery(search: string): RouteQuery;
+  export function stringifyQuery(query: RouteQuery): string;
+  export function compilePathToRegex(path: string): PathTokens;
+  export function normalizeRouteRecord(
+    record: RouteRecordRaw,
+    parent?: RouteRecordNormalized
+  ): RouteRecordNormalized;
+  export function createMatcher(routes: readonly RouteRecordRaw[]): RouteMatcher;
+
+  // Router Contexts & Core API
+  export const RouterContext: Context<Router>;
+  export const RouteContext: Context<() => RouteLocationNormalized>;
+  export const RouterDepthContext: Context<number>;
+  export const START_LOCATION_NORMALIZED: RouteLocationNormalized;
+  export function createNavigationFailure(
+    type: NavigationFailureType,
+    to: RouteLocationNormalized,
+    from: RouteLocationNormalized
+  ): NavigationFailure;
+  export function isNavigationFailure(error: any, type?: NavigationFailureType): error is NavigationFailure;
+  export function createRouter(options: RouterOptions): Router;
+
+  // Native SFC Components
+  export const RouterView: CompiledModule;
+  export const Link: CompiledModule;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "driftjs-router",
-  "version": "0.0.15",
+  "version": "0.0.17",
   "description": "Client-side SPA router for DriftJS with history, hash, and memory drivers, dynamic route parameters, nested routes/outlets, scroll restoration, and navigation guards.",
   "keywords": [
     "driftjs",
@@ -18,10 +18,10 @@
   ],
   "main": "./dist/index-cjs.js",
   "module": "./dist/index-es.js",
-  "types": "./src/index.ts",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "types": "./src/index.ts",
+      "types": "./dist/index.d.ts",
       "import": "./dist/index-es.js",
       "require": "./dist/index-cjs.js",
       "default": "./dist/index-es.js"
@@ -29,16 +29,16 @@
   },
   "license": "MIT",
   "dependencies": {
-    "path-to-regexp": "^6.3.0",
-    "driftjs-dom": "0.0.15",
-    "driftjs-shared": "0.0.15"
+    "path-to-regexp": "8.4.2",
+    "driftjs-dom": "0.0.17",
+    "driftjs-shared": "0.0.17"
   },
   "devDependencies": {
-    "typescript": "^7.0.2",
-    "vite": "^8.1.5",
-    "vitest": "^4.1.10",
-    "driftjs-compiler": "0.0.15",
-    "driftjs-vite-plugin": "0.0.15"
+    "typescript": "7.0.2",
+    "vite": "8.3.1",
+    "vitest": "5.0.2",
+    "driftjs-compiler": "0.0.17",
+    "driftjs-vite-plugin": "0.0.17"
   },
   "scripts": {
     "build": "vite build",