clear-react-router 1.0.3 → 1.0.6

package/README.md

@@ -1,3 +1,5 @@
+[![npm version](https://badge.fury.io/js/clear-react-router.svg)](https://www.npmjs.com/package/clear-react-router)
+
 A lightweight, type-safe routing library for React applications with nested routes, data loading, navigation blocking, and prefetching.
 
 ## Features
@@ -14,6 +16,23 @@ A lightweight, type-safe routing library for React applications with nested rout
 
 ## API
 
+### `createRouter(routes)`
+
+Normalizes route configuration. Handles wildcard `*` routes, extracts dynamic params, builds nested paths.
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `path` | `string` | Route path, e.g., `/user/:userId` |
+| `element` | `ReactElement \| () => ReactElement \| LazyComponent` | Component to render |
+| `loader` | `() => Promise<unknown>` | Fetch data |
+| `beforeLoad` | `(context) => Promise<void>` | Auth checks, redirects |
+| `afterLoad` | `(context) => Promise<void>` | Analytics, side effects |
+| `fallback` | `ReactElement \| () => ReactElement` | Loading fallback (for lazy loading) |
+| `loaderFallback` | `ReactElement \| () => ReactElement` | Loading fallback (for loader) |
+| `errorElement` | `ReactElement \| () => ReactElement` | Error fallback |
+| `staleTime` | `number` | Cache duration in ms for loader data |
+| `children` | `RouteItem[]` | Nested routes |
+
 ### `Router`
 
 Main component that renders the application based on current URL.
@@ -23,19 +42,6 @@ Main component that renders the application based on current URL.
 | `routeList` | `RouteItem[]` | Array of route configurations |
 | `context` | `object` | Optional initial context (user, theme, etc.) |
 
-### `createRouter(routes)`
-
-Normalizes route configuration. Handles wildcard `*` routes, extracts dynamic params, builds nested paths.
-
-### `redirect(url, search?)`
-
-Redirects from `beforeLoad`.
-```
-beforeLoad: context => {
-					if (!context.isAuthorized) return redirect('/');
-				}
-```
-
 ### `Link`
 
 Component for client-side navigation with prefetch support.
@@ -46,6 +52,15 @@ Component for client-side navigation with prefetch support.
 | `prefetch` | `boolean` | `true` |
 | `children` | `ReactElement` | required |
 
+### `redirect(url, search?)`
+
+Redirects from `beforeLoad`.
+```
+beforeLoad: context => {
+	if (!context.isAuthorized) return redirect('/');
+}
+```
+
 ## Hooks
 
 ### `useNavigate()`
@@ -120,7 +135,7 @@ Executes a callback when the page is about to be closed or reloaded. Perfect for
 
 | Parameter | Type | Description |
 |-----------|------|-------------|
-| `callback` | `() => void | undefined` | Function to execute before page unload (e.g., auto-save) |
+| `callback` | `() => void \| undefined` | Function to execute before page unload (e.g., auto-save) |
 
 **Note:** This hook does not show a browser confirmation dialog. It silently executes the callback, allowing you to save user data in the background before the page closes.
 
@@ -133,22 +148,6 @@ const onSave = useCallback(() => {
 // Auto-save when user tries to close/reload the page
 useBeforeUnload(text ? onSave : undefined);
 ```
-## Route Configuration
-
-### `RouteItem`
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `path` | `string` | Route path, e.g., `/user/:userId` |
-| `element` | `ReactElement \| () => ReactElement \| LazyComponent` | Component to render |
-| `loader` | `() => Promise<unknown>` | Fetch data |
-| `beforeLoad` | `(context) => Promise<void>` | Auth checks, redirects |
-| `afterLoad` | `(context) => Promise<void>` | Analytics, side effects |
-| `fallback` | `ReactElement \| () => ReactElement` | Loading fallback (for lazy loading) |
-| `loaderFallback` | `ReactElement \| () => ReactElement` | Loading fallback (for loader) |
-| `errorElement` | `ReactElement \| () => ReactElement` | Error fallback |
-| `staleTime` | `number` | Cache duration in ms for loader data |
-| `children` | `RouteItem[]` | Nested routes |
 
 ## Lazy Loading
 

package/dist/components/Link.d.ts

@@ -1,4 +1,4 @@
-import { ReactElement, MouseEvent, CSSProperties } from 'react';
+import { type ReactElement, type MouseEvent, type CSSProperties } from 'react';
 type LinkProps = {
     to: string;
     children: ReactElement<{

package/dist/components/Router.d.ts

@@ -1,4 +1,4 @@
-import { RouteItem } from '../types/global.ts';
+import type { RouteItem } from '../types/global.ts';
 type RouterProps = {
     routeList: RouteItem[];
     context?: Record<string, unknown>;

package/dist/context/RouterContext.d.ts

@@ -1,4 +1,4 @@
-import { BlockerState, Location, UpdateBlockedRouteProps } from '../types/global.ts';
+import type { BlockerState, Location, UpdateBlockedRouteProps } from '../types/global';
 export type NavigationContextValue = {
     location: Location;
     params: Record<string, string>;
@@ -11,9 +11,9 @@ export type ActionsContextValue = {
     setContext(arg: object): void;
 };
 export type DataContextValue = {
-    loaderCache: Record<string, unknown>;
+    loaderCache: unknown;
     context: Record<string, unknown>;
 };
-export declare const ActionsContext: import('react').Context<ActionsContextValue>;
-export declare const DataContext: import('react').Context<DataContextValue>;
-export declare const NavigationContext: import('react').Context<NavigationContextValue>;
+export declare const ActionsContext: import("react").Context<ActionsContextValue>;
+export declare const DataContext: import("react").Context<DataContextValue>;
+export declare const NavigationContext: import("react").Context<NavigationContextValue>;

package/dist/hooks/useBlocker.d.ts

@@ -1,4 +1,4 @@
-import { BlockerState } from '../types/global.ts';
+import type { BlockerState } from '../types/global.ts';
 type UseBlockerReturnValue = {
     state: BlockerState;
     process(): void;

package/dist/hooks/useHandleNavigation.d.ts

@@ -1,4 +1,4 @@
-import { BlockerState, Location, RouteItem, UpdateBlockedRouteProps } from '../types/global.ts';
+import type { BlockerState, Location, RouteItem, UpdateBlockedRouteProps } from '../types/global.ts';
 type UseHandleNavigation = {
     routeList: RouteItem[];
     setLocation: (arg: Location) => void;

package/dist/hooks/useLatest.d.ts

@@ -1 +1 @@
-export declare const useLatest: <T>(value: T) => import('react').RefObject<T>;
+export declare const useLatest: <T>(value: T) => import("react").RefObject<T>;

package/dist/hooks/useLoader.d.ts

@@ -1,8 +1,8 @@
-import { RouteItem } from '../types/global.ts';
+import type { RouteItem } from '../types/global.ts';
 export declare const useLoader: (routeList: RouteItem[]) => {
-    loaderCache: Record<string, unknown>;
+    loaderCache: unknown;
     loaderError: boolean;
     prefetchLoader: (pathname: string) => Promise<void>;
     revalidateCache: (routeItem?: RouteItem) => Promise<void>;
-    isLoadingMap: Record<string, boolean>;
+    isLoading: boolean;
 };

package/dist/hooks/useLocation.d.ts

@@ -1 +1 @@
-export declare const useLocation: () => import('..').Location;
+export declare const useLocation: () => import("../types/global").Location;

package/dist/hooks/useNavigate.d.ts

@@ -1,2 +1,2 @@
-import { Location } from '../types/global.ts';
+import type { Location } from '../types/global.ts';
 export declare const useNavigate: () => (arg: Location | -1) => Promise<void>;

package/dist/hooks/useServiceContext.d.ts

@@ -1,3 +1,3 @@
-export declare const useNavigationState: () => import('../context/RouterContext').NavigationContextValue;
-export declare const useRouterActions: () => import('../context/RouterContext').ActionsContextValue;
-export declare const useRouterData: () => import('../context/RouterContext').DataContextValue;
+export declare const useNavigationState: () => import("../context/RouterContext").NavigationContextValue;
+export declare const useRouterActions: () => import("../context/RouterContext").ActionsContextValue;
+export declare const useRouterData: () => import("../context/RouterContext").DataContextValue;

package/dist/index.d.ts

@@ -7,6 +7,5 @@ export { useLoaderState } from './hooks/useLoaderState';
 export { useBlocker } from './hooks/useBlocker';
 export { useBeforeUnload } from './hooks/useBeforeUnload';
 export { useRouterContext } from './hooks/useRouterContext';
-export { createRouter, parseWindowLocation, comparePaths } from './utils/utils';
+export { createRouter } from './utils/utils';
 export { redirect } from './utils/redirect';
-export type { ClientRouteItem, RouteItem, Location, BlockerState } from './types/global';