chore: react router declaration merging

Author: bartstc

src/lib/router/index.ts

@@ -25,10 +25,7 @@ export {
 export { useRouteError } from "./useRouteError";
 export { handleLazyImportError } from "./handleLazyImportError";
 
-type StateCandidate = { from: string } | Record<string, unknown>;
-
-export const useLocationState = () =>
-  (useLocation().state as StateCandidate) ?? {};
+export const useLocationState = () => useLocation().state ?? {};
 
 export const generatePath = (
   path: string,

src/typings/react-router-config.d.ts

@@ -0,0 +1,29 @@
+// eslint-disable-next-line no-restricted-imports
+import type {
+  NavigateOptions as RRNavigateOptions,
+  Location as RRLocation,
+  To,
+} from "react-router";
+
+declare module "react-router" {
+  interface NavigateState {
+    from?: string;
+    [key: string]: unknown;
+  }
+
+  interface LocationWithState extends Omit<RRLocation, "state"> {
+    state?: NavigateState;
+  }
+
+  interface NavigateOptions extends Omit<RRNavigateOptions, "state"> {
+    state?: NavigateState;
+  }
+
+  interface NavigateFunction {
+    (to: To, options?: NavigateOptions): void | Promise<void>;
+    (delta: number): void | Promise<void>;
+  }
+
+  function useLocation(): LocationWithState;
+  function useNavigate(): NavigateFunction;
+}