@liteforge/router 0.1.0

package/dist/index.js

@@ -0,0 +1,44 @@
+// =============================================================================
+// Types
+// =============================================================================
+// =============================================================================
+// Route Matching
+// =============================================================================
+export { 
+// Path parsing utilities
+parsePath, parseQuery, stringifyQuery, createLocation, normalizePath, joinPaths, 
+// Route compilation
+compilePath, compileRoute, compileRoutes, 
+// Route matching
+matchRoute, matchRoutes, findRouteByName, generatePath, isPathActive, flattenRoutes, } from './route-matcher.js';
+// =============================================================================
+// History
+// =============================================================================
+export { createMemoryHistory, createBrowserHistory, createHashHistory, targetToHref, } from './history.js';
+// =============================================================================
+// Guards
+// =============================================================================
+export { defineGuard, GuardRegistry, runGuards, collectRouteGuards, normalizeGuardResult, 
+// Built-in guards
+createAuthGuard, createRoleGuard, createConfirmGuard, createGuestGuard, } from './guards.js';
+// =============================================================================
+// Middleware
+// =============================================================================
+export { defineMiddleware, composeMiddleware, runMiddleware, 
+// Built-in middleware
+createLoggerMiddleware, createScrollMiddleware, createTitleMiddleware, createAnalyticsMiddleware, createLoadingMiddleware, } from './middleware.js';
+// =============================================================================
+// Router
+// =============================================================================
+export { createRouter, setActiveRouter, getActiveRouter, getActiveRouterOrNull, } from './router.js';
+// =============================================================================
+// Components
+// =============================================================================
+export { RouterOutlet, Link, NavLink } from './components.js';
+// =============================================================================
+// Lazy Loading
+// =============================================================================
+export { lazy, prefetchAll, isLazyComponent, getLazyDelay, getLazyLoading, getLazyError, createPreloadOnHover, createPreloadOnVisible, 
+// Inline lazy support
+resolveModuleExport, isWrappedLazyComponent, detectInlineLazyImport, wrapInlineLazy, processRouteComponent, } from './lazy.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gFAAgF;AAChF,QAAQ;AACR,gFAAgF;AA4DhF,gFAAgF;AAChF,iBAAiB;AACjB,gFAAgF;AAEhF,OAAO;AACL,yBAAyB;AACzB,SAAS,EACT,UAAU,EACV,cAAc,EACd,cAAc,EACd,aAAa,EACb,SAAS;AAET,oBAAoB;AACpB,WAAW,EACX,YAAY,EACZ,aAAa;AAEb,iBAAiB;AACjB,UAAU,EACV,WAAW,EACX,eAAe,EACf,YAAY,EACZ,YAAY,EACZ,aAAa,GACd,MAAM,oBAAoB,CAAC;AAE5B,gFAAgF;AAChF,UAAU;AACV,gFAAgF;AAEhF,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,iBAAiB,EACjB,YAAY,GACb,MAAM,cAAc,CAAC;AAQtB,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF,OAAO,EACL,WAAW,EACX,aAAa,EACb,SAAS,EACT,kBAAkB,EAClB,oBAAoB;AAEpB,kBAAkB;AAClB,eAAe,EACf,eAAe,EACf,kBAAkB,EAClB,gBAAgB,GACjB,MAAM,aAAa,CAAC;AAErB,gFAAgF;AAChF,aAAa;AACb,gFAAgF;AAEhF,OAAO,EACL,gBAAgB,EAChB,iBAAiB,EACjB,aAAa;AAEb,sBAAsB;AACtB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,yBAAyB,EACzB,uBAAuB,GACxB,MAAM,iBAAiB,CAAC;AAEzB,gFAAgF;AAChF,SAAS;AACT,gFAAgF;AAEhF,OAAO,EACL,YAAY,EACZ,eAAe,EACf,eAAe,EACf,qBAAqB,GACtB,MAAM,aAAa,CAAC;AAIrB,gFAAgF;AAChF,aAAa;AACb,gFAAgF;AAEhF,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAI9D,gFAAgF;AAChF,eAAe;AACf,gFAAgF;AAEhF,OAAO,EACL,IAAI,EACJ,WAAW,EACX,eAAe,EACf,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,sBAAsB;AACtB,sBAAsB;AACtB,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,cAAc,EACd,qBAAqB,GACtB,MAAM,WAAW,CAAC"}

package/dist/lazy.d.ts

@@ -0,0 +1,197 @@
+import type { RouteComponent, LazyComponent, LazyImportFn, RouteLazyConfig, LazyDefaults } from './types.js';
+/**
+ * Options for lazy component loading
+ */
+export interface LazyOptions {
+    /** Custom loading component shown while loading */
+    loading?: () => Node;
+    /** Custom error component shown on failure */
+    error?: (error: Error, retry: () => void) => Node;
+    /** Timeout in milliseconds before showing error (0 = no timeout) */
+    timeout?: number;
+    /**
+     * Delay in milliseconds before showing loading state (default: 200).
+     * If the component loads before this threshold, loading state is never shown.
+     * Set to 0 to show loading state immediately.
+     */
+    delay?: number;
+    /** Minimum time to show loading state (prevents flash) */
+    minLoadTime?: number;
+    /** Whether to prefetch the component immediately */
+    prefetch?: boolean;
+}
+/**
+ * Create a lazy-loaded component
+ *
+ * The returned function acts as a LazyComponent that can be used in route definitions.
+ * It provides caching, error handling, and prefetching capabilities.
+ *
+ * @example
+ * ```ts
+ * // Basic usage
+ * const LazyDashboard = lazy(() => import('./pages/Dashboard'));
+ *
+ * // With options
+ * const LazySettings = lazy(
+ *   () => import('./pages/Settings'),
+ *   {
+ *     loading: () => document.createTextNode('Loading settings...'),
+ *     timeout: 5000,
+ *   }
+ * );
+ *
+ * // In route definition
+ * const routes = [
+ *   { path: '/dashboard', component: LazyDashboard },
+ *   { path: '/settings', component: LazySettings },
+ * ];
+ *
+ * // Prefetch component
+ * LazyDashboard.prefetch();
+ * ```
+ */
+export declare function lazy(loader: () => Promise<{
+    default: RouteComponent;
+} | RouteComponent>, options?: LazyOptions): LazyComponent & {
+    prefetch: () => Promise<void>;
+    isLoaded: () => boolean;
+    getLoaded: () => RouteComponent | undefined;
+    reset: () => void;
+};
+/**
+ * Prefetch multiple lazy components
+ *
+ * @example
+ * ```ts
+ * // Prefetch all admin pages
+ * prefetchAll([LazyAdminDashboard, LazyAdminUsers, LazyAdminSettings]);
+ * ```
+ */
+export declare function prefetchAll(components: Array<LazyComponent & {
+    prefetch?: () => Promise<void>;
+}>): Promise<void>;
+/**
+ * Extended lazy component with utility methods
+ */
+export interface LazyComponentWithMethods {
+    /** Call the lazy loader to get the component */
+    (): Promise<{
+        default: RouteComponent;
+    } | RouteComponent>;
+    /** Prefetch the component */
+    prefetch: () => Promise<void>;
+    /** Check if the component is loaded */
+    isLoaded: () => boolean;
+    /** Get the loaded component synchronously (undefined if not loaded) */
+    getLoaded: () => RouteComponent | undefined;
+    /** Reset the lazy component state */
+    reset: () => void;
+    /** Internal: options passed to lazy() */
+    readonly __options?: LazyOptions;
+}
+/**
+ * Check if a component is a lazy component
+ */
+export declare function isLazyComponent(component: unknown): component is LazyComponentWithMethods;
+/**
+ * Get the delay option from a lazy component (default: 200ms)
+ */
+export declare function getLazyDelay(component: LazyComponentWithMethods): number;
+/**
+ * Get the loading component from a lazy component
+ */
+export declare function getLazyLoading(component: LazyComponentWithMethods): (() => Node) | undefined;
+/**
+ * Get the error component from a lazy component
+ */
+export declare function getLazyError(component: LazyComponentWithMethods): ((error: Error, retry: () => void) => Node) | undefined;
+/**
+ * Create a preload function that prefetches lazy components on link hover
+ *
+ * @example
+ * ```ts
+ * const preloadOnHover = createPreloadOnHover({
+ *   '/dashboard': LazyDashboard,
+ *   '/settings': LazySettings,
+ * });
+ *
+ * // Attach to link element
+ * linkElement.addEventListener('mouseenter', () => preloadOnHover('/dashboard'));
+ * ```
+ */
+export declare function createPreloadOnHover(componentMap: Record<string, LazyComponent & {
+    prefetch?: () => Promise<void>;
+}>): (path: string) => void;
+/**
+ * Create an intersection observer that prefetches lazy components when links enter viewport
+ *
+ * @example
+ * ```ts
+ * const observer = createPreloadOnVisible({
+ *   '/dashboard': LazyDashboard,
+ *   '/settings': LazySettings,
+ * });
+ *
+ * // Observe link elements
+ * document.querySelectorAll('a[href]').forEach(link => {
+ *   observer.observe(link, link.getAttribute('href')!);
+ * });
+ *
+ * // Cleanup when done
+ * observer.disconnect();
+ * ```
+ */
+export declare function createPreloadOnVisible(componentMap: Record<string, LazyComponent & {
+    prefetch?: () => Promise<void>;
+}>, options?: IntersectionObserverInit): {
+    observe: (element: Element, path: string) => void;
+    unobserve: (element: Element) => void;
+    disconnect: () => void;
+};
+/**
+ * Resolve the component export from a dynamically imported module.
+ *
+ * @param module - The imported module object
+ * @param exportName - Optional named export to use (default: 'default')
+ * @returns The resolved component function
+ * @throws Error if no component can be found in the module
+ *
+ * Resolution order:
+ * 1. If exportName is specified, use that export
+ * 2. If module has 'default' export, use that
+ * 3. Use the first function export found (convenience fallback)
+ */
+export declare function resolveModuleExport(module: Record<string, unknown>, exportName?: string): RouteComponent;
+/**
+ * Check if a component is a pre-wrapped lazy component (created with lazy()).
+ * This is the existing lazy() wrapper with prefetch/isLoaded/reset methods.
+ */
+export declare function isWrappedLazyComponent(component: unknown): component is LazyComponentWithMethods;
+export declare function detectInlineLazyImport(component: unknown): component is LazyImportFn;
+/**
+ * Wrap an inline lazy import with the lazy() function.
+ *
+ * This converts: `() => import('./Component.js')`
+ * Into a full lazy component with loading states, caching, etc.
+ *
+ * @param importFn - The inline import function
+ * @param exportName - Named export to use from the module
+ * @param routeLazyConfig - Per-route lazy config
+ * @param globalDefaults - Global lazy defaults from router options
+ */
+export declare function wrapInlineLazy(importFn: LazyImportFn, exportName: string | undefined, routeLazyConfig: RouteLazyConfig | undefined, globalDefaults: LazyDefaults | undefined): LazyComponent & LazyComponentWithMethods;
+/**
+ * Process a route component during compilation.
+ *
+ * - If it's a static component, return as-is
+ * - If it's already wrapped with lazy(), return as-is
+ * - If it's an inline lazy import, wrap it with lazy()
+ *
+ * @param component - The route component to process
+ * @param exportName - Named export to use (for inline lazy)
+ * @param routeLazyConfig - Per-route lazy config
+ * @param globalDefaults - Global lazy defaults
+ * @returns The processed component (either original or wrapped)
+ */
+export declare function processRouteComponent(component: RouteComponent | LazyComponent | LazyImportFn | undefined, exportName: string | undefined, routeLazyConfig: RouteLazyConfig | undefined, globalDefaults: LazyDefaults | undefined): RouteComponent | LazyComponent | undefined;
+//# sourceMappingURL=lazy.d.ts.map

package/dist/lazy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lazy.d.ts","sourceRoot":"","sources":["../src/lazy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,aAAa,EACb,YAAY,EACZ,eAAe,EACf,YAAY,EACb,MAAM,YAAY,CAAC;AAMpB;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,mDAAmD;IACnD,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,8CAA8C;IAC9C,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IAClD,oEAAoE;IACpE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAWD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,IAAI,CAClB,MAAM,EAAE,MAAM,OAAO,CAAC;IAAE,OAAO,EAAE,cAAc,CAAA;CAAE,GAAG,cAAc,CAAC,EACnE,OAAO,GAAE,WAAgB,GACxB,aAAa,GAAG;IACjB,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB,SAAS,EAAE,MAAM,cAAc,GAAG,SAAS,CAAC;IAC5C,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB,CAyIA;AAMD;;;;;;;;GAQG;AACH,wBAAsB,WAAW,CAC/B,UAAU,EAAE,KAAK,CAAC,aAAa,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC,GACpE,OAAO,CAAC,IAAI,CAAC,CAUf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,gDAAgD;IAChD,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,cAAc,CAAA;KAAE,GAAG,cAAc,CAAC,CAAC;IAC1D,6BAA6B;IAC7B,QAAQ,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,uCAAuC;IACvC,QAAQ,EAAE,MAAM,OAAO,CAAC;IACxB,uEAAuE;IACvE,SAAS,EAAE,MAAM,cAAc,GAAG,SAAS,CAAC;IAC5C,qCAAqC;IACrC,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,yCAAyC;IACzC,QAAQ,CAAC,SAAS,CAAC,EAAE,WAAW,CAAC;CAClC;AAED;;GAEG;AACH,wBAAgB,eAAe,CAC7B,SAAS,EAAE,OAAO,GACjB,SAAS,IAAI,wBAAwB,CAOvC;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,MAAM,CAGxE;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,wBAAwB,GAAG,CAAC,MAAM,IAAI,CAAC,GAAG,SAAS,CAE5F;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,SAAS,EAAE,wBAAwB,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC,GAAG,SAAS,CAEzH;AAMD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAClC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC,GAC/E,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAkBxB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,sBAAsB,CACpC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG;IAAE,QAAQ,CAAC,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC,EAChF,OAAO,GAAE,wBAA6B,GACrC;IACD,OAAO,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAClD,SAAS,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAC;IACtC,UAAU,EAAE,MAAM,IAAI,CAAC;CACxB,CAgDA;AAaD;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,UAAU,CAAC,EAAE,MAAM,GAClB,cAAc,CA8BhB;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,OAAO,GACjB,SAAS,IAAI,wBAAwB,CAOvC;AAeD,wBAAgB,sBAAsB,CACpC,SAAS,EAAE,OAAO,GACjB,SAAS,IAAI,YAAY,CA0B3B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,YAAY,EACtB,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,cAAc,EAAE,YAAY,GAAG,SAAS,GACvC,aAAa,GAAG,wBAAwB,CA0C1C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,cAAc,GAAG,aAAa,GAAG,YAAY,GAAG,SAAS,EACpE,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,eAAe,EAAE,eAAe,GAAG,SAAS,EAC5C,cAAc,EAAE,YAAY,GAAG,SAAS,GACvC,cAAc,GAAG,aAAa,GAAG,SAAS,CAiB5C"}