vite-plugin-smart-prefetch 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,211 @@
+import { Plugin } from 'vite';
+
+/**
+ * Core type definitions for @farmart/vite-plugin-smart-prefetch
+ */
+interface PluginOptions {
+    /** Framework to use (currently only 'react' is supported) */
+    framework?: 'react' | 'vue' | 'svelte';
+    /** Prefetch strategy */
+    strategy?: PrefetchStrategy;
+    /** Google Analytics integration configuration */
+    analytics?: AnalyticsConfig;
+    /** Manual route prefetch rules (overrides ML predictions) */
+    manualRules?: ManualRules;
+    /** Cache configuration */
+    cache?: CacheConfig;
+    /** Advanced configuration options */
+    advanced?: AdvancedConfig;
+}
+type PrefetchStrategy = 'auto' | 'hover' | 'visible' | 'idle' | 'hybrid';
+interface AnalyticsConfig {
+    /** Analytics provider - only BigQuery is supported */
+    provider: 'bigquery';
+    /** BigQuery authentication credentials */
+    credentials: BigQueryCredentials;
+    /** Data collection settings */
+    dataRange?: DataRangeConfig;
+    /** Model training configuration */
+    model: ModelConfig;
+    /** Environment identifier */
+    environment: string;
+    /** Generate analytics dashboard HTML */
+    dashboard?: boolean;
+}
+interface BigQueryCredentials {
+    /** Google Cloud Project ID */
+    projectId: string;
+    /** BigQuery dataset ID (usually analytics_XXXXXXXX) */
+    datasetId: string;
+}
+interface DataRangeConfig {
+    /** Number of days to analyze (default: 30) */
+    days?: number;
+    /** Minimum sessions required for route to be included (default: 100) */
+    minSessions?: number;
+}
+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 ManualRules {
+    /** Map of source route to target routes to prefetch */
+    [sourceRoute: string]: string[];
+}
+interface CacheConfig {
+    /** Enable caching (default: true) */
+    enabled?: boolean;
+    /** Time-to-live in milliseconds (default: 24h) */
+    ttl?: number;
+    /** Cache directory path (default: node_modules/.cache/smart-prefetch) */
+    path?: string;
+}
+interface AdvancedConfig {
+    /** Custom route normalization function */
+    routeNormalization?: (path: string) => string;
+    /** Custom chunk matching function */
+    chunkMatching?: (route: string, manifest: ViteManifest) => string | null;
+    /** Routes to exclude from prefetching */
+    excludeRoutes?: string[];
+    /** Enable debug logging */
+    debug?: boolean;
+}
+interface NavigationData {
+    /** Source route */
+    from: string;
+    /** Destination route */
+    to: string;
+    /** Number of transitions observed */
+    count: number;
+}
+interface PrefetchModel {
+    /** Schema version */
+    version: string;
+    /** Timestamp when model was generated */
+    generatedAt: string;
+    /** Environment this model is for */
+    environment: string;
+    /** Data source metadata */
+    dataSource?: DataSourceMetadata;
+    /** Model configuration used */
+    config?: ModelConfig;
+    /** Route predictions */
+    routes: {
+        [sourceRoute: string]: RoutePrediction;
+    };
+}
+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 RoutePrediction {
+    /** Routes to prefetch from this source (default/common rules) */
+    prefetch: PrefetchTarget[];
+    /** Segment-specific prefetch rules */
+    segments?: SegmentPrefetchRules;
+    /** Additional metadata about this route */
+    metadata?: RouteMetadata;
+}
+interface SegmentPrefetchRules {
+    /** Prefetch rules by user segment (free, premium, enterprise, etc.) */
+    [segmentName: string]: PrefetchTarget[];
+}
+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;
+    /** 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;
+    };
+    /** Route predictions with chunk mappings */
+    routes: {
+        [sourceRoute: string]: {
+            /** Default/common prefetch rules (works for all users) */
+            prefetch: Array<PrefetchTarget & {
+                chunk: string;
+            }>;
+            /** Segment-specific rules (different per user segment) */
+            segments?: {
+                [segmentName: string]: Array<PrefetchTarget & {
+                    chunk: string;
+                }>;
+            };
+            /** Metadata about this route */
+            metadata?: RouteMetadata;
+        };
+    };
+    /** Quick lookup: route -> chunk file */
+    chunks: {
+        [route: string]: string;
+    };
+    /** Available segments (for client-side selection) */
+    segmentInfo?: {
+        available: string[];
+        description?: string;
+    };
+}
+interface ViteManifest {
+    [key: string]: {
+        file: string;
+        src?: string;
+        isEntry?: boolean;
+        imports?: string[];
+        dynamicImports?: string[];
+        css?: string[];
+        assets?: string[];
+    };
+}
+
+/**
+ * Main Vite Plugin
+ * Integrates all components and provides Vite hooks
+ */
+
+declare function smartPrefetch(options?: PluginOptions): Plugin;
+
+export { type AdvancedConfig, type AnalyticsConfig, type BigQueryCredentials, type CacheConfig, type DataRangeConfig, type ManualRules, type ModelConfig, type NavigationData, type PluginOptions, type PrefetchConfig, type PrefetchModel, type PrefetchStrategy, type PrefetchTarget, type ViteManifest, smartPrefetch };