router-kit 0.1.7 → 0.2.1

package/dist/context/RouterProvider.d.ts

@@ -1,2 +1,5 @@
-declare const RouterProvider: () => import("react/jsx-runtime").JSX.Element;
+import type { Route } from "../types";
+declare const RouterProvider: ({ routes }: {
+    routes: Route[];
+}) => import("react/jsx-runtime").JSX.Element;
 export default RouterProvider;

package/dist/context/RouterProvider.js

@@ -1,10 +1,9 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useEffect, useState } from "react";
 import join from "url-join";
-import { routes } from "../core/createRouter";
 import Page404 from "../pages/404";
 import RouterContext from "./RouterContext";
-const RouterProvider = () => {
+const RouterProvider = ({ routes }) => {
     const [path, setPath] = useState(window.location.pathname);
     let fullPathWithParams = "";
     const pathValidation = (routeFullPath, currentPath) => {

package/dist/core/createRouter.d.ts

@@ -1,4 +1,3 @@
 import type { Route } from "../types";
 declare function createRouter(inputRoutes: Route[]): Route[];
-export declare const routes: Route[];
 export default createRouter;

package/dist/core/createRouter.js

@@ -1,5 +1,5 @@
 function normalizeRoutes(inputRoutes) {
-    const normalizedRoutes = inputRoutes.map((route) => {
+    return inputRoutes.map((route) => {
         var _a, _b;
         const normalizedPath = ((_a = route.path) === null || _a === void 0 ? void 0 : _a.startsWith("/"))
             ? route.path.replace(/^\/+/, "")
@@ -13,13 +13,8 @@ function normalizeRoutes(inputRoutes) {
         }
         return normalized;
     });
-    routes.length = 0;
-    routes.push(...normalizedRoutes);
-    return routes;
 }
 function createRouter(inputRoutes) {
-    // normalize and mutate the exported `routes` array in-place
     return normalizeRoutes(inputRoutes);
 }
-export const routes = [];
 export default createRouter;

package/dist/hooks/useRouter.js

@@ -1,8 +1,40 @@
+/*
+  Router-Kit — Common hooks and components (reference)
+
+  Hooks:
+    - useRouter        : access router context and helpers
+    - useLocation      : current location (pathname, search, hash)
+    - useNavigate      : imperative navigation function
+    - useParams        : route params for the current route
+    - useSearchParams  : read/update URL query params
+    - useRouteMatch    : match the current location against a pattern
+    - useBlocker/usePrompt : block navigation with a confirmation
+
+  Components / APIs:
+    - createRouter     : factory to create a router instance and Provider
+    - RouterProvider   : provider component returned by createRouter()
+    - Routes           : route collection wrapper
+    - Route            : single route declaration
+    - Link             : declarative link component
+    - NavLink          : link with active styling
+    - Outlet           : render child route content
+    - Redirect         : declarative redirect helper (if provided)
+
+  Note: Exact names may vary between versions — update this list to match your installed Router-Kit exports.
+*/
 import { useContext } from "react";
 import RouterContext from "../context/RouterContext";
 export function useRouter() {
     const ctx = useContext(RouterContext);
-    if (!ctx)
-        throw new Error("useRouter must be used within a RouterProvider");
+    if (!ctx) {
+        const message = "Common hooks and components must be used within the RouterProvider returned by createRouter(). Wrap your app with the RouterProvider.";
+        if (typeof window !== "undefined" && window.console && console.error) {
+            console.error("%cRouterKit%c " + message, "color: #fff; background: #d9534f; font-weight: 700; padding: 2px 6px; border-radius: 3px;", "color: #d9534f;");
+        }
+        else {
+            console.error("RouterKit: " + message);
+        }
+        throw new Error("RouterKit: " + message);
+    }
     return ctx;
 }

package/package.json

@@ -5,7 +5,7 @@
     "email": "mohammed.bencheikh.dev@gmail.com",
     "url": "https://mohammedbencheikh.com/"
   },
-  "version": "0.1.7",
+  "version": "0.2.1",
   "description": "A small React routing provider library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",