@trackunit/react-core-contexts-test 1.19.9 → 1.20.0

package/index2.cjs.js

@@ -13716,6 +13716,8 @@ const TestErrorComponent = ({ error }) => {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
+ * History defaults to `createMemoryHistory()` (no blocking). See {@link MemoryRouterProps.history}.
+ *
  * @param props - The component props.
  * @param props.addTestRootContainer - Boolean to add test root container.
  * @param props.selectedRouterProps - Selected router props.
@@ -13725,11 +13727,30 @@ const TestErrorComponent = ({ error }) => {
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
     const client = react.useApolloClient();
-    const memoryHistory = React.useRef(reactRouter.createMemoryHistory({
-        initialEntries: selectedRouterProps?.initialEntries
-            ? [...selectedRouterProps.initialEntries].reverse().map(entry => entry.path)
-            : ["/"],
-    }));
+    const historyOverride = selectedRouterProps?.history;
+    // Seed the override's start path, like `initialEntries` does for memory history. Runs once
+    // per mount, during render, so the router memo below snapshots it — an effect runs too late.
+    const hasSeededStartPath = React.useRef(false);
+    if (historyOverride && typeof window !== "undefined" && !hasSeededStartPath.current) {
+        const startPath = selectedRouterProps.initialEntries?.[0]?.path ?? "/";
+        window.history.replaceState({ __TSR_index: 0, key: "test-start" }, "", startPath);
+        hasSeededStartPath.current = true;
+    }
+    // Destroy the override once on unmount so its pushState/replaceState patches do not leak.
+    // A ref keeps this effect from re-running when the prop identity changes.
+    const historyOverrideRef = React.useRef(historyOverride);
+    React.useEffect(() => {
+        const override = historyOverrideRef.current;
+        return () => {
+            override?.destroy();
+        };
+    }, []);
+    const memoryHistory = React.useRef(historyOverride ??
+        reactRouter.createMemoryHistory({
+            initialEntries: selectedRouterProps?.initialEntries
+                ? [...selectedRouterProps.initialEntries].reverse().map(entry => entry.path)
+                : ["/"],
+        }));
     const addTestRootContainerRef = React.useRef(addTestRootContainer);
     React.useEffect(() => {
         addTestRootContainerRef.current = addTestRootContainer;

package/index2.esm.js

@@ -13694,6 +13694,8 @@ const TestErrorComponent = ({ error }) => {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
+ * History defaults to `createMemoryHistory()` (no blocking). See {@link MemoryRouterProps.history}.
+ *
  * @param props - The component props.
  * @param props.addTestRootContainer - Boolean to add test root container.
  * @param props.selectedRouterProps - Selected router props.
@@ -13703,11 +13705,30 @@ const TestErrorComponent = ({ error }) => {
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
     const client = useApolloClient();
-    const memoryHistory = useRef(createMemoryHistory({
-        initialEntries: selectedRouterProps?.initialEntries
-            ? [...selectedRouterProps.initialEntries].reverse().map(entry => entry.path)
-            : ["/"],
-    }));
+    const historyOverride = selectedRouterProps?.history;
+    // Seed the override's start path, like `initialEntries` does for memory history. Runs once
+    // per mount, during render, so the router memo below snapshots it — an effect runs too late.
+    const hasSeededStartPath = useRef(false);
+    if (historyOverride && typeof window !== "undefined" && !hasSeededStartPath.current) {
+        const startPath = selectedRouterProps.initialEntries?.[0]?.path ?? "/";
+        window.history.replaceState({ __TSR_index: 0, key: "test-start" }, "", startPath);
+        hasSeededStartPath.current = true;
+    }
+    // Destroy the override once on unmount so its pushState/replaceState patches do not leak.
+    // A ref keeps this effect from re-running when the prop identity changes.
+    const historyOverrideRef = useRef(historyOverride);
+    useEffect(() => {
+        const override = historyOverrideRef.current;
+        return () => {
+            override?.destroy();
+        };
+    }, []);
+    const memoryHistory = useRef(historyOverride ??
+        createMemoryHistory({
+            initialEntries: selectedRouterProps?.initialEntries
+                ? [...selectedRouterProps.initialEntries].reverse().map(entry => entry.path)
+                : ["/"],
+        }));
     const addTestRootContainerRef = useRef(addTestRootContainer);
     useEffect(() => {
         addTestRootContainerRef.current = addTestRootContainer;

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "1.19.9",
+  "version": "1.20.0",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
     "node": ">=24.x"
   },
   "dependencies": {
-    "@trackunit/shared-utils": "1.16.57",
+    "@trackunit/shared-utils": "1.17.0",
     "@tanstack/router-core": "1.114.29",
-    "@trackunit/iris-app-runtime-core-api": "1.18.9",
-    "@trackunit/react-core-contexts-api": "1.19.9",
+    "@trackunit/iris-app-runtime-core-api": "1.19.0",
+    "@trackunit/react-core-contexts-api": "1.20.0",
     "es-toolkit": "^1.39.10"
   },
   "peerDependencies": {

package/src/utils/RouterContainer.d.ts

@@ -1,4 +1,4 @@
-import { AnyRoute, RegisteredRouter, RouteIds } from "@tanstack/react-router";
+import { AnyRoute, RegisteredRouter, RouteIds, RouterHistory } from "@tanstack/react-router";
 import { ReactElement, ReactNode } from "react";
 export type MemoryRouterProps<TRouterTree extends AnyRoute = RegisteredRouter["routeTree"]> = {
     routeTree?: TRouterTree;
@@ -9,6 +9,24 @@ export type MemoryRouterProps<TRouterTree extends AnyRoute = RegisteredRouter["r
         beforeLoad?: () => void;
     }>;
     context?: Record<string, unknown>;
+    /**
+     * Override the router history. Defaults to `createMemoryHistory()`, which never wires
+     * blockers, so `useBlocker` / `onBeforeClose` guards are no-ops. Pass
+     * `createBrowserHistory()` to assert a blocked navigation stays blocked.
+     *
+     * When set, the harness starts it at the first `initialEntries` path (or `/`) and calls
+     * `history.destroy()` on unmount. No extra per-test cleanup is needed.
+     *
+     * @example
+     * ```ts
+     * import { createBrowserHistory } from "@tanstack/react-router";
+     *
+     * await trackunitProviders()
+     *   .routerProps({ history: createBrowserHistory() })
+     *   .render(<ComponentThatBlocksNavigation />);
+     * ```
+     */
+    history?: RouterHistory;
 };
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container
@@ -26,6 +44,8 @@ export interface RouterContainerProps<TRoute extends AnyRoute = AnyRoute> {
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
  *
+ * History defaults to `createMemoryHistory()` (no blocking). See {@link MemoryRouterProps.history}.
+ *
  * @param props - The component props.
  * @param props.addTestRootContainer - Boolean to add test root container.
  * @param props.selectedRouterProps - Selected router props.

package/migrations/entry.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"entry.js","sourceRoot":"","sources":["../../../../../libs/react/core-contexts-test/migrations/entry.ts"],"names":[],"mappings":"","sourcesContent":["export {};\n"]}