@sigx/router 0.1.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Andreas Ekdahl
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/Link.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Link component - declarative navigation
+ *
+ * @example
+ * ```tsx
+ * <Link to="/about">About</Link>
+ *
+ * <Link to={{ path: '/blog', query: { page: '2' } }}>Blog</Link>
+ *
+ * <Link to="/contact" replace>Contact</Link>
+ * ```
+ */
+import { type DefineProp, type DefineEvent, type DefineSlot } from 'sigx';
+import type { RouteLocationRaw } from './types.js';
+type LinkProps = DefineProp<'to', RouteLocationRaw, true> & DefineProp<'replace', boolean> & DefineProp<'activeClass', string> & DefineProp<'exactActiveClass', string> & DefineProp<'ariaCurrentValue', 'page' | 'step' | 'location' | 'date' | 'time' | 'true' | 'false'> & DefineEvent<'click', MouseEvent> & DefineSlot<'default'>;
+export declare const Link: import("@sigx/runtime-core").ComponentFactory<LinkProps, void, {
+    default: () => import("@sigx/runtime-core").JSXElement | import("@sigx/runtime-core").JSXElement[] | null;
+}>;
+/**
+ * Alias for Link component
+ */
+export declare const RouterLink: import("@sigx/runtime-core").ComponentFactory<LinkProps, void, {
+    default: () => import("@sigx/runtime-core").JSXElement | import("@sigx/runtime-core").JSXElement[] | null;
+}>;
+export {};
+//# sourceMappingURL=Link.d.ts.map

package/dist/Link.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Link.d.ts","sourceRoot":"","sources":["../src/Link.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAa,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,MAAM,CAAC;AAErF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAEnD,KAAK,SAAS,GACR,UAAU,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,GACxC,UAAU,CAAC,SAAS,EAAE,OAAO,CAAC,GAC9B,UAAU,CAAC,aAAa,EAAE,MAAM,CAAC,GACjC,UAAU,CAAC,kBAAkB,EAAE,MAAM,CAAC,GACtC,UAAU,CAAC,kBAAkB,EAAE,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,GACjG,WAAW,CAAC,OAAO,EAAE,UAAU,CAAC,GAChC,UAAU,CAAC,SAAS,CAAC,CAAC;AAE5B,eAAO,MAAM,IAAI;;EAmEG,CAAC;AAErB;;GAEG;AACH,eAAO,MAAM,UAAU;;EAAO,CAAC"}

package/dist/RouterView.d.ts

@@ -0,0 +1,19 @@
+/**
+ * RouterView component - renders the matched route component
+ *
+ * @example
+ * ```tsx
+ * <RouterView />
+ *
+ * // With named views (for nested routes)
+ * <RouterView name="sidebar" />
+ *
+ * // With page props (from SSG getStaticProps)
+ * <RouterView pageProps={{ posts: [...] }} />
+ * ```
+ */
+import { type DefineProp, type ComponentFactory } from 'sigx';
+type RouterViewProps = DefineProp<'name', string> & DefineProp<'pageProps', Record<string, unknown>>;
+export declare const RouterView: ComponentFactory<RouterViewProps, void, {}>;
+export {};
+//# sourceMappingURL=RouterView.d.ts.map

package/dist/RouterView.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RouterView.d.ts","sourceRoot":"","sources":["../src/RouterView.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAa,KAAK,UAAU,EAAE,KAAK,gBAAgB,EAAmC,MAAM,MAAM,CAAC;AAG1G,KAAK,eAAe,GAAG,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,UAAU,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;AAerG,eAAO,MAAM,UAAU,6CAuDG,CAAC"}

package/dist/history/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * History implementations for @sigx/router
+ */
+export { createWebHistory, type BrowserHistoryOptions } from './web.js';
+export { createMemoryHistory, type MemoryHistoryOptions } from './memory.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/history/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/history/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,KAAK,oBAAoB,EAAE,MAAM,aAAa,CAAC"}

package/dist/history/memory.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Memory history implementation for SSR
+ *
+ * This history doesn't interact with the browser History API,
+ * making it suitable for server-side rendering.
+ */
+import type { RouterHistory } from '../types.js';
+export interface MemoryHistoryOptions {
+    /** Base path for the application */
+    base?: string;
+    /** Initial location */
+    initialLocation?: string;
+}
+/**
+ * Create a memory history instance for SSR
+ *
+ * @example
+ * ```ts
+ * // Server-side
+ * const history = createMemoryHistory({ initialLocation: req.url });
+ * const router = createRouter({ routes, history });
+ * ```
+ */
+export declare function createMemoryHistory(options?: MemoryHistoryOptions): RouterHistory;
+//# sourceMappingURL=memory.d.ts.map

package/dist/history/memory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/history/memory.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,aAAa,CAAC;AAE/D,MAAM,WAAW,oBAAoB;IACjC,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uBAAuB;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC5B;AAOD;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,oBAAyB,GAAG,aAAa,CA+FrF"}

package/dist/history/web.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Browser history implementation using the History API
+ *
+ * This is the default history for client-side navigation.
+ */
+import type { RouterHistory } from '../types.js';
+export interface BrowserHistoryOptions {
+    /** Base path for the application */
+    base?: string;
+}
+/**
+ * Create a browser history instance that uses the HTML5 History API
+ */
+export declare function createWebHistory(options?: BrowserHistoryOptions): RouterHistory;
+//# sourceMappingURL=web.d.ts.map

package/dist/history/web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web.d.ts","sourceRoot":"","sources":["../../src/history/web.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAgB,MAAM,aAAa,CAAC;AAE/D,MAAM,WAAW,qBAAqB;IAClC,oCAAoC;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,GAAE,qBAA0B,GAAG,aAAa,CAwGnF"}

package/dist/hooks.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Router hooks for @sigx/router
+ *
+ * These hooks provide access to router state and navigation within components.
+ */
+import type { RouteLocation, RouteParams, RouteQuery } from './types.js';
+import { useRouter, useRoute } from './router.js';
+export { useRouter, useRoute };
+/**
+ * Get route parameters (reactive)
+ *
+ * @example
+ * ```tsx
+ * const params = useParams();
+ * console.log(params.id);
+ * ```
+ */
+export declare function useParams(): RouteParams;
+/**
+ * Get query parameters (reactive)
+ *
+ * @example
+ * ```tsx
+ * const query = useQuery();
+ * console.log(query.search);
+ * ```
+ */
+export declare function useQuery(): RouteQuery;
+/**
+ * Get a navigate function for programmatic navigation
+ *
+ * @example
+ * ```tsx
+ * const navigate = useNavigate();
+ * navigate('/about');
+ * navigate({ path: '/blog', query: { page: '2' } });
+ * ```
+ */
+export declare function useNavigate(): (to: import("./types.js").RouteLocationRaw) => Promise<RouteLocation | void>;
+/**
+ * Guard type for route enter
+ */
+type RouteEnterGuard = (to: RouteLocation, from: RouteLocation | null, next: (to?: string | false | RouteLocation) => void) => void;
+/**
+ * Guard type for route leave
+ */
+type RouteLeaveGuard = (to: RouteLocation, from: RouteLocation, next: (to?: string | false | RouteLocation) => void) => void;
+/**
+ * Register a navigation guard that runs before leaving the current route
+ *
+ * @example
+ * ```tsx
+ * onBeforeRouteLeave((to, from, next) => {
+ *     if (hasUnsavedChanges) {
+ *         const answer = confirm('You have unsaved changes. Leave anyway?');
+ *         if (!answer) {
+ *             next(false);
+ *             return;
+ *         }
+ *     }
+ *     next();
+ * });
+ * ```
+ */
+export declare function onBeforeRouteLeave(guard: RouteLeaveGuard): void;
+/**
+ * Register a navigation guard that runs when entering the current route
+ *
+ * @example
+ * ```tsx
+ * onBeforeRouteUpdate((to, from, next) => {
+ *     // Called when route params change but component is reused
+ *     next();
+ * });
+ * ```
+ */
+export declare function onBeforeRouteUpdate(guard: RouteEnterGuard): void;
+//# sourceMappingURL=hooks.d.ts.map

package/dist/hooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,KAAK,EAAU,aAAa,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGlD,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AAE/B;;;;;;;;GAQG;AACH,wBAAgB,SAAS,IAAI,WAAW,CAGvC;AAED;;;;;;;;GAQG;AACH,wBAAgB,QAAQ,IAAI,UAAU,CAGrC;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,iFAG1B;AAED;;GAEG;AACH,KAAK,eAAe,GAAG,CACnB,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,aAAa,GAAG,IAAI,EAC1B,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,aAAa,KAAK,IAAI,KAClD,IAAI,CAAC;AAEV;;GAEG;AACH,KAAK,eAAe,GAAG,CACnB,EAAE,EAAE,aAAa,EACjB,IAAI,EAAE,aAAa,EACnB,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,aAAa,KAAK,IAAI,KAClD,IAAI,CAAC;AAEV;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI,CAoC/D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,eAAe,GAAG,IAAI,CAkChE"}

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+/**
+ * @sigx/router
+ *
+ * A robust router for SignalX with SSR support, hooks, and plugin architecture.
+ *
+ * ## Features
+ * - 🔌 **Pluggable History** - Use browser history for SPA, memory history for SSR
+ * - 🪝 **Hooks** - useRouter, useRoute, useParams, useNavigate
+ * - 🛡️ **Navigation Guards** - beforeEach, beforeResolve, afterEach
+ * - 🎯 **Route Matching** - Path patterns with params (e.g., `/blog/:slug`)
+ * - 🎭 **Pattern Matching** - Declarative `router.match()` for type-safe routing
+ * - 📦 **Components** - RouterView, Link for declarative routing
+ *
+ * ## Quick Start
+ *
+ * ```tsx
+ * import { defineApp } from '@sigx/runtime-core';
+ * import { createRouter, createWebHistory, RouterView, Link } from '@sigx/router';
+ *
+ * const router = createRouter({
+ *     history: createWebHistory(),
+ *     routes: [
+ *         { path: '/', name: 'home', component: Home },
+ *         { path: '/about', name: 'about', component: About },
+ *         { path: '/blog/:slug', name: 'blog-post', component: BlogPost }
+ *     ]
+ * });
+ *
+ * const App = component(() => {
+ *     return () => (
+ *         <div>
+ *             <nav>
+ *                 <Link to="/">Home</Link>
+ *                 <Link to="/about">About</Link>
+ *             </nav>
+ *             <RouterView />
+ *         </div>
+ *     );
+ * });
+ *
+ * const app = defineApp(<App />);
+ * app.use(router);
+ * app.mount('#app');
+ * ```
+ *
+ * ## Pattern Matching
+ *
+ * Use `router.match()` for declarative, type-safe route rendering:
+ *
+ * ```tsx
+ * const App = component(() => {
+ *     const router = useRouter();
+ *
+ *     return () => router.match({
+ *         home: () => <HomePage />,
+ *         about: () => <AboutPage />,
+ *         'blog-post': ({ slug }) => <BlogPost slug={slug} />,
+ *         _: () => <NotFound />  // Fallback for unmatched routes
+ *     });
+ * });
+ * ```
+ *
+ * ## SSR Usage
+ *
+ * ```tsx
+ * import { createRouter, createMemoryHistory } from '@sigx/router';
+ *
+ * // Server-side
+ * const router = createRouter({
+ *     history: createMemoryHistory({ initialLocation: req.url }),
+ *     routes
+ * });
+ *
+ * const html = await renderToString(<App />, { router });
+ * ```
+ *
+ * @module
+ */
+export type { Router, RouterOptions, RouterHistory, RouteLocation, RouteLocationRaw, RouteRecordRaw, RouteParams, RouteQuery, RouteMeta, MatchedRouteRecord, NavigationGuard, NavigationHookAfter, HistoryState, RouteMatchPatterns } from './types.js';
+export { createRouter, useRouter, useRoute } from './router.js';
+export { createWebHistory, type BrowserHistoryOptions } from './history/web.js';
+export { createMemoryHistory, type MemoryHistoryOptions } from './history/memory.js';
+export { useParams, useQuery, useNavigate, onBeforeRouteLeave, onBeforeRouteUpdate } from './hooks.js';
+export { RouterView } from './RouterView.js';
+export { Link, RouterLink } from './Link.js';
+export { createRouterPlugin, type RouterPluginOptions } from './plugin.js';
+export { parseQuery, stringifyQuery, parseURL, buildPath } from './matcher.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6EG;AAGH,YAAY,EACR,MAAM,EACN,aAAa,EACb,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,UAAU,EACV,SAAS,EACT,kBAAkB,EAClB,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,kBAAkB,EACrB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,YAAY,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGhE,OAAO,EAAE,gBAAgB,EAAE,KAAK,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAChF,OAAO,EAAE,mBAAmB,EAAE,KAAK,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAGrF,OAAO,EACH,SAAS,EACT,QAAQ,EACR,WAAW,EACX,kBAAkB,EAClB,mBAAmB,EACtB,MAAM,YAAY,CAAC;AAGpB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAG7C,OAAO,EAAE,kBAAkB,EAAE,KAAK,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAG3E,OAAO,EACH,UAAU,EACV,cAAc,EACd,QAAQ,EACR,SAAS,EACZ,MAAM,cAAc,CAAC"}