vite-plugin-smart-prefetch 0.4.1 → 0.4.2

package/dist/react/index.d.cts

@@ -1,8 +1,88 @@
-import React from 'react';
-import { LinkProps } from 'react-router-dom';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 type PrefetchStrategy = 'auto' | 'hover' | 'visible' | 'idle' | 'hybrid';
+interface ModelConfig {
+    /** Model type */
+    type: 'probability' | 'ml' | 'hybrid';
+    /** Minimum probability threshold (0.0 - 1.0, default: 0.3) */
+    threshold: number;
+    /** Maximum routes to prefetch per page (default: 3) */
+    maxPrefetch: number;
+    /** How often to update the model */
+    updateInterval?: 'build' | 'daily' | 'weekly';
+}
+interface DataSourceMetadata {
+    /** Provider name */
+    provider: 'bigquery' | 'markov-chain' | 'manual' | string;
+    /** Date range analyzed */
+    dateRange: string;
+    /** Total sessions analyzed */
+    totalSessions: number;
+    /** Total unique routes found */
+    totalRoutes?: number;
+}
+interface PrefetchTarget {
+    /** Target route to prefetch */
+    route: string;
+    /** Probability of transition (0.0 - 1.0) */
+    probability: number;
+    /** Number of observed transitions */
+    count: number;
+    /** Chunk file to prefetch (set by config generator) */
+    chunk?: string;
+    /** Production chunk file path (for production builds) */
+    chunk_prod?: string;
+    /** Dependency chunks to prefetch (extracted from Vite manifest imports) */
+    imports?: string[];
+    /** Priority level */
+    priority: 'high' | 'medium' | 'low';
+    /** Whether this is a manual rule */
+    manual?: boolean;
+}
+interface RouteMetadata {
+    /** Total transitions from this route */
+    totalTransitions: number;
+    /** Most common destination */
+    topDestination: string;
+    /** Average time spent on page (seconds) */
+    averageTimeOnPage?: number;
+}
+interface PrefetchConfig {
+    /** Schema version */
+    version: string;
+    /** Generation timestamp */
+    generatedAt: string;
+    /** Environment */
+    environment: string;
+    /** Data source info */
+    dataSource: DataSourceMetadata;
+    /** Model info */
+    model: {
+        type: ModelConfig['type'];
+        threshold: number;
+        maxPrefetch: number;
+        accuracy?: number;
+    };
+    /** Global route patterns for dynamic route matching */
+    routePatterns?: Record<string, string[]>;
+    /** Route predictions with chunk mappings */
+    routes: {
+        [sourceRoute: string]: {
+            /** Route pattern variants (for matching dynamic routes like /order/:id) */
+            patterns?: string[];
+            /** Prefetch rules for this route */
+            prefetch: Array<PrefetchTarget & {
+                chunk: string;
+            }>;
+            /** Metadata about this route */
+            metadata?: RouteMetadata;
+        };
+    };
+    /** Quick lookup: route -> chunk file */
+    chunks: {
+        [route: string]: string;
+    };
+}
 
 /**
  * Prefetch Manager (Runtime)
@@ -15,7 +95,14 @@ declare class PrefetchManager {
     private strategy;
     private observer;
     private debug;
-    constructor(strategy?: PrefetchStrategy, debug?: boolean);
+    private currentLocation;
+    /**
+     * Constructor
+     * @param strategy Prefetch strategy: 'auto', 'hover', 'visible', 'idle', or 'hybrid'
+     * @param debug Enable debug logging
+     * @param initialLocation Optional initial location (pathname)
+     */
+    constructor(strategy?: PrefetchStrategy, debug?: boolean, initialLocation?: string);
     /**
      * Initialize the prefetch manager
      * Loads configuration and sets up observers
@@ -30,6 +117,27 @@ declare class PrefetchManager {
      *   matchRoutePattern('/admin/settings', '/admin/*') → true
      */
     private matchRoutePattern;
+    /**
+     * Update current location and trigger prefetch
+     * Call this whenever the application's location changes
+     *
+     * @param pathname The current pathname (can be from location.pathname, useLocation().pathname, etc.)
+     * @example
+     * ```tsx
+     * // In React Router DOM
+     * const location = useLocation();
+     * useEffect(() => {
+     *   manager.onLocationChange(location.pathname);
+     * }, [location.pathname]);
+     *
+     * // In TanStack Router
+     * const location = useLocation();
+     * useEffect(() => {
+     *   manager.onLocationChange(location.pathname);
+     * }, [location.pathname]);
+     * ```
+     */
+    onLocationChange(pathname: string): void;
     /**
      * Prefetch routes based on current route
      */
@@ -105,117 +213,6 @@ declare class PrefetchManager {
     logPrefetchSummary(): void;
 }
 
-/**
- * React Hook for Smart Prefetch
- * Automatically prefetches routes based on navigation
- */
-
-/**
- * React hook to enable smart prefetching
- * Call this once in your root App component
- *
- * @example
- * ```tsx
- * function App() {
- *   usePrefetch();
- *   return <Routes>...</Routes>;
- * }
- * ```
- */
-declare function usePrefetch(): PrefetchManager | null;
-/**
- * Get the prefetch manager instance
- * Useful for manual prefetch control
- */
-declare function getPrefetchManager(): PrefetchManager | null;
-
-/**
- * TanStack Router Hook for Smart Prefetch
- * Automatically prefetches routes based on navigation
- *
- * @example
- * ```tsx
- * import { usePrefetchTanStack } from 'vite-plugin-smart-prefetch/react';
- *
- * export function RootLayout() {
- *   usePrefetchTanStack();
- *   return <Outlet />;
- * }
- * ```
- */
-
-/**
- * React hook to enable smart prefetching with TanStack Router
- * Call this once in your root layout component
- *
- * Supports dynamic routes with patterns:
- * - Static routes: /dashboard, /orders
- * - Dynamic routes: /orders/:id, /users/$userId
- *
- * @example
- * ```tsx
- * function RootLayout() {
- *   usePrefetchTanStack();
- *   return <Outlet />;
- * }
- * ```
- */
-declare function usePrefetchTanStack(): PrefetchManager | null;
-/**
- * Get the prefetch manager instance
- * Useful for manual prefetch control
- *
- * @example
- * ```tsx
- * const manager = getPrefetchManager();
- * manager?.setSegment('premium');
- * ```
- */
-declare function getPrefetchManagerTanStack(): PrefetchManager | null;
-/**
- * Advanced: Use route pattern matching directly
- * Useful if you need to manually check pattern matching logic
- *
- * @example
- * ```tsx
- * const matchesPattern = matchPrefetchPattern('/orders/123', '/orders/:id');
- * ```
- */
-declare function matchPrefetchPattern(pathname: string, pattern: string): boolean;
-
-/**
- * Enhanced Link Component with Prefetch Support
- * Extends React Router Link with smart prefetching
- */
-
-interface PrefetchLinkProps extends Omit<LinkProps, 'prefetch'> {
-    /**
-     * Prefetch behavior
-     * - 'hover': Prefetch on mouse enter
-     * - 'visible': Prefetch when link becomes visible
-     * - 'manual': No automatic prefetch (use onClick)
-     * - undefined: Use default strategy from config
-     */
-    prefetch?: 'hover' | 'visible' | 'manual';
-}
-/**
- * Enhanced Link component with prefetching
- *
- * @example
- * ```tsx
- * // Prefetch on hover
- * <PrefetchLink to="/orders" prefetch="hover">
- *   View Orders
- * </PrefetchLink>
- *
- * // Prefetch when visible
- * <PrefetchLink to="/dispatch-order" prefetch="visible">
- *   Create Dispatch
- * </PrefetchLink>
- * ```
- */
-declare const PrefetchLink: React.ForwardRefExoticComponent<PrefetchLinkProps & React.RefAttributes<HTMLAnchorElement>>;
-
 interface PrefetchDebugPanelProps {
     manager: PrefetchManager | null;
     position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
@@ -223,4 +220,4 @@ interface PrefetchDebugPanelProps {
 }
 declare function PrefetchDebugPanel({ manager, position, defaultOpen, }: PrefetchDebugPanelProps): react_jsx_runtime.JSX.Element | null;
 
-export { PrefetchDebugPanel, type PrefetchDebugPanelProps, PrefetchLink, type PrefetchLinkProps, getPrefetchManager, getPrefetchManagerTanStack, matchPrefetchPattern, usePrefetch, usePrefetchTanStack };
+export { type PrefetchConfig, PrefetchDebugPanel, type PrefetchDebugPanelProps, PrefetchManager, type PrefetchStrategy, type PrefetchTarget };

package/dist/react/index.d.ts

@@ -1,8 +1,88 @@
-import React from 'react';
-import { LinkProps } from 'react-router-dom';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 
 type PrefetchStrategy = 'auto' | 'hover' | 'visible' | 'idle' | 'hybrid';
+interface ModelConfig {
+    /** Model type */
+    type: 'probability' | 'ml' | 'hybrid';
+    /** Minimum probability threshold (0.0 - 1.0, default: 0.3) */
+    threshold: number;
+    /** Maximum routes to prefetch per page (default: 3) */
+    maxPrefetch: number;
+    /** How often to update the model */
+    updateInterval?: 'build' | 'daily' | 'weekly';
+}
+interface DataSourceMetadata {
+    /** Provider name */
+    provider: 'bigquery' | 'markov-chain' | 'manual' | string;
+    /** Date range analyzed */
+    dateRange: string;
+    /** Total sessions analyzed */
+    totalSessions: number;
+    /** Total unique routes found */
+    totalRoutes?: number;
+}
+interface PrefetchTarget {
+    /** Target route to prefetch */
+    route: string;
+    /** Probability of transition (0.0 - 1.0) */
+    probability: number;
+    /** Number of observed transitions */
+    count: number;
+    /** Chunk file to prefetch (set by config generator) */
+    chunk?: string;
+    /** Production chunk file path (for production builds) */
+    chunk_prod?: string;
+    /** Dependency chunks to prefetch (extracted from Vite manifest imports) */
+    imports?: string[];
+    /** Priority level */
+    priority: 'high' | 'medium' | 'low';
+    /** Whether this is a manual rule */
+    manual?: boolean;
+}
+interface RouteMetadata {
+    /** Total transitions from this route */
+    totalTransitions: number;
+    /** Most common destination */
+    topDestination: string;
+    /** Average time spent on page (seconds) */
+    averageTimeOnPage?: number;
+}
+interface PrefetchConfig {
+    /** Schema version */
+    version: string;
+    /** Generation timestamp */
+    generatedAt: string;
+    /** Environment */
+    environment: string;
+    /** Data source info */
+    dataSource: DataSourceMetadata;
+    /** Model info */
+    model: {
+        type: ModelConfig['type'];
+        threshold: number;
+        maxPrefetch: number;
+        accuracy?: number;
+    };
+    /** Global route patterns for dynamic route matching */
+    routePatterns?: Record<string, string[]>;
+    /** Route predictions with chunk mappings */
+    routes: {
+        [sourceRoute: string]: {
+            /** Route pattern variants (for matching dynamic routes like /order/:id) */
+            patterns?: string[];
+            /** Prefetch rules for this route */
+            prefetch: Array<PrefetchTarget & {
+                chunk: string;
+            }>;
+            /** Metadata about this route */
+            metadata?: RouteMetadata;
+        };
+    };
+    /** Quick lookup: route -> chunk file */
+    chunks: {
+        [route: string]: string;
+    };
+}
 
 /**
  * Prefetch Manager (Runtime)
@@ -15,7 +95,14 @@ declare class PrefetchManager {
     private strategy;
     private observer;
     private debug;
-    constructor(strategy?: PrefetchStrategy, debug?: boolean);
+    private currentLocation;
+    /**
+     * Constructor
+     * @param strategy Prefetch strategy: 'auto', 'hover', 'visible', 'idle', or 'hybrid'
+     * @param debug Enable debug logging
+     * @param initialLocation Optional initial location (pathname)
+     */
+    constructor(strategy?: PrefetchStrategy, debug?: boolean, initialLocation?: string);
     /**
      * Initialize the prefetch manager
      * Loads configuration and sets up observers
@@ -30,6 +117,27 @@ declare class PrefetchManager {
      *   matchRoutePattern('/admin/settings', '/admin/*') → true
      */
     private matchRoutePattern;
+    /**
+     * Update current location and trigger prefetch
+     * Call this whenever the application's location changes
+     *
+     * @param pathname The current pathname (can be from location.pathname, useLocation().pathname, etc.)
+     * @example
+     * ```tsx
+     * // In React Router DOM
+     * const location = useLocation();
+     * useEffect(() => {
+     *   manager.onLocationChange(location.pathname);
+     * }, [location.pathname]);
+     *
+     * // In TanStack Router
+     * const location = useLocation();
+     * useEffect(() => {
+     *   manager.onLocationChange(location.pathname);
+     * }, [location.pathname]);
+     * ```
+     */
+    onLocationChange(pathname: string): void;
     /**
      * Prefetch routes based on current route
      */
@@ -105,117 +213,6 @@ declare class PrefetchManager {
     logPrefetchSummary(): void;
 }
 
-/**
- * React Hook for Smart Prefetch
- * Automatically prefetches routes based on navigation
- */
-
-/**
- * React hook to enable smart prefetching
- * Call this once in your root App component
- *
- * @example
- * ```tsx
- * function App() {
- *   usePrefetch();
- *   return <Routes>...</Routes>;
- * }
- * ```
- */
-declare function usePrefetch(): PrefetchManager | null;
-/**
- * Get the prefetch manager instance
- * Useful for manual prefetch control
- */
-declare function getPrefetchManager(): PrefetchManager | null;
-
-/**
- * TanStack Router Hook for Smart Prefetch
- * Automatically prefetches routes based on navigation
- *
- * @example
- * ```tsx
- * import { usePrefetchTanStack } from 'vite-plugin-smart-prefetch/react';
- *
- * export function RootLayout() {
- *   usePrefetchTanStack();
- *   return <Outlet />;
- * }
- * ```
- */
-
-/**
- * React hook to enable smart prefetching with TanStack Router
- * Call this once in your root layout component
- *
- * Supports dynamic routes with patterns:
- * - Static routes: /dashboard, /orders
- * - Dynamic routes: /orders/:id, /users/$userId
- *
- * @example
- * ```tsx
- * function RootLayout() {
- *   usePrefetchTanStack();
- *   return <Outlet />;
- * }
- * ```
- */
-declare function usePrefetchTanStack(): PrefetchManager | null;
-/**
- * Get the prefetch manager instance
- * Useful for manual prefetch control
- *
- * @example
- * ```tsx
- * const manager = getPrefetchManager();
- * manager?.setSegment('premium');
- * ```
- */
-declare function getPrefetchManagerTanStack(): PrefetchManager | null;
-/**
- * Advanced: Use route pattern matching directly
- * Useful if you need to manually check pattern matching logic
- *
- * @example
- * ```tsx
- * const matchesPattern = matchPrefetchPattern('/orders/123', '/orders/:id');
- * ```
- */
-declare function matchPrefetchPattern(pathname: string, pattern: string): boolean;
-
-/**
- * Enhanced Link Component with Prefetch Support
- * Extends React Router Link with smart prefetching
- */
-
-interface PrefetchLinkProps extends Omit<LinkProps, 'prefetch'> {
-    /**
-     * Prefetch behavior
-     * - 'hover': Prefetch on mouse enter
-     * - 'visible': Prefetch when link becomes visible
-     * - 'manual': No automatic prefetch (use onClick)
-     * - undefined: Use default strategy from config
-     */
-    prefetch?: 'hover' | 'visible' | 'manual';
-}
-/**
- * Enhanced Link component with prefetching
- *
- * @example
- * ```tsx
- * // Prefetch on hover
- * <PrefetchLink to="/orders" prefetch="hover">
- *   View Orders
- * </PrefetchLink>
- *
- * // Prefetch when visible
- * <PrefetchLink to="/dispatch-order" prefetch="visible">
- *   Create Dispatch
- * </PrefetchLink>
- * ```
- */
-declare const PrefetchLink: React.ForwardRefExoticComponent<PrefetchLinkProps & React.RefAttributes<HTMLAnchorElement>>;
-
 interface PrefetchDebugPanelProps {
     manager: PrefetchManager | null;
     position?: 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right';
@@ -223,4 +220,4 @@ interface PrefetchDebugPanelProps {
 }
 declare function PrefetchDebugPanel({ manager, position, defaultOpen, }: PrefetchDebugPanelProps): react_jsx_runtime.JSX.Element | null;
 
-export { PrefetchDebugPanel, type PrefetchDebugPanelProps, PrefetchLink, type PrefetchLinkProps, getPrefetchManager, getPrefetchManagerTanStack, matchPrefetchPattern, usePrefetch, usePrefetchTanStack };
+export { type PrefetchConfig, PrefetchDebugPanel, type PrefetchDebugPanelProps, PrefetchManager, type PrefetchStrategy, type PrefetchTarget };