@visns-studio/visns-components 6.6.4 → 6.15.0

package/src/components/auth/useOptionalRouter.js

@@ -0,0 +1,49 @@
+/**
+ * react-router, if there is one.
+ *
+ * The client auth screens were written for a React Router SPA and called
+ * `useNavigate()` / `useLocation()` directly. Both throw when no Router is
+ * above them, which made the screens unmountable in a Next.js App Router page —
+ * a framework that has no business standing up a react-router context just to
+ * render a login form.
+ *
+ * The hooks are still called unconditionally, in the same order, on every
+ * render; only their throw is swallowed. That is what keeps this legal under
+ * the rules of hooks: whether a Router is present is fixed for the lifetime of
+ * a mounted component, so the number of hooks React sees never changes between
+ * renders of the same component.
+ *
+ * Callers must treat both results as optional. A screen given `onNavigate` and
+ * an explicit challenge never touches either one.
+ */
+
+import { useLocation, useNavigate } from 'react-router-dom';
+
+/**
+ * `{navigate, location}`, with either or both `null` when there is no Router.
+ *
+ * `navigate` is null rather than a no-op so a caller can tell "no router" from
+ * "navigation did nothing" and fall back to its own mechanism.
+ */
+const useOptionalRouter = () => {
+    let navigate = null;
+    let location = null;
+
+    try {
+        navigate = useNavigate();
+    } catch (error) {
+        // No Router above us. Expected outside an SPA; never worth logging,
+        // since the screens have a callback-driven path for exactly this.
+        navigate = null;
+    }
+
+    try {
+        location = useLocation();
+    } catch (error) {
+        location = null;
+    }
+
+    return { navigate, location };
+};
+
+export default useOptionalRouter;