@trackunit/react-core-contexts-test 1.9.12 → 1.9.15

package/index.cjs2.js

@@ -14125,31 +14125,15 @@ class TrackunitProvidersMockBuilder {
         this.selectedTokenContext = { token };
         return this;
     }
+    // Implementation
     /**
-     * Use this Router Props with the given mocks.
-     *
-     * This is used to provide a MemoryRouter from lib "@tanstack/react-router"
-     *
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().routerProps(yourRouterPropsMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().routerProps(yourRouterPropsMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
      * @param routerProps - The router props to use.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     * @returns  { TrackunitProvidersMockBuilder } - The builder instance for chaining.
      */
     routerProps(routerProps) {
         this.selectedRouterProps = routerProps;
-        return this.rootRoute(routerProps.routeTree ? routerProps.routeTree : this.selectedRootRoute);
+        this.rootRoute(routerProps.routeTree ? routerProps.routeTree : this.selectedRootRoute);
+        return this;
     }
     /**
      * Use this Manager Apollo Context Provider with the given mocks.

package/index.esm2.js

@@ -14103,31 +14103,15 @@ class TrackunitProvidersMockBuilder {
         this.selectedTokenContext = { token };
         return this;
     }
+    // Implementation
     /**
-     * Use this Router Props with the given mocks.
-     *
-     * This is used to provide a MemoryRouter from lib "@tanstack/react-router"
-     *
-     * @example
-     * ...
-     * it("should allow render", async () => {
-     *   await trackunitProviders().routerProps(yourRouterPropsMock).render(<YourTestComponent data-testid="yourTestId" />);
-     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
-     * });
-     * ...
-     * @example
-     * ...
-     * it("should allow renderHook", async () => {
-     *   const { result } = await trackunitProviders().routerProps(yourRouterPropsMock).renderHook(() => useYourTestHook());
-     *   expect(result.current).toEqual(anything());
-     * });
-     * ...
      * @param routerProps - The router props to use.
-     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     * @returns  { TrackunitProvidersMockBuilder } - The builder instance for chaining.
      */
     routerProps(routerProps) {
         this.selectedRouterProps = routerProps;
-        return this.rootRoute(routerProps.routeTree ? routerProps.routeTree : this.selectedRootRoute);
+        this.rootRoute(routerProps.routeTree ? routerProps.routeTree : this.selectedRootRoute);
+        return this;
     }
     /**
      * Use this Manager Apollo Context Provider with the given mocks.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "1.9.12",
+  "version": "1.9.15",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,11 +10,11 @@
     "@apollo/client": "3.13.8",
     "react": "19.0.0",
     "@tanstack/react-router": "1.114.29",
-    "@trackunit/shared-utils": "1.11.9",
+    "@trackunit/shared-utils": "1.11.12",
     "graphql": "^16.10.0",
     "@tanstack/router-core": "1.114.29",
-    "@trackunit/iris-app-runtime-core-api": "1.9.12",
-    "@trackunit/react-core-contexts-api": "1.10.12",
+    "@trackunit/iris-app-runtime-core-api": "1.9.15",
+    "@trackunit/react-core-contexts-api": "1.10.15",
     "es-toolkit": "^1.39.10"
   },
   "module": "./index.esm.js",

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -1,5 +1,5 @@
 import { MockedResponse } from "@apollo/client/testing";
-import { AnyRoute } from "@tanstack/react-router";
+import { AnyRoute, RegisteredRouter } from "@tanstack/react-router";
 import { RenderResult } from "@testing-library/react";
 import { AnalyticsRuntimeApiSync, AssetSortingState, ConfirmationDialogRuntimeApi, CurrentUserPreferenceState, CurrentUserState, EnvironmentState, ErrorHandlingContextValue, FilterBarContext, ITokenContext, ModalDialogRuntimeApi, NavigationRuntimeApi, OemBrandingRuntimeApi, TimeRangeContext, UserSubscription, WidgetConfigContext } from "@trackunit/iris-app-runtime-core-api";
 import { ExportDataContextState, IToastContext } from "@trackunit/react-core-contexts-api";
@@ -14,7 +14,7 @@ import { MemoryRouterProps } from "./utils/routingUtils";
  * For Storybook:
  * - storybook
  */
-export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
+export declare class TrackunitProvidersMockBuilder<TRouterTree extends AnyRoute> {
     protected selectedEnvironmentContext: EnvironmentState;
     protected selectedModalDialogContext: ModalDialogRuntimeApi;
     protected selectedTimeRangeContext: TimeRangeContext;
@@ -22,7 +22,7 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
     protected selectedNavigationContext: NavigationRuntimeApi;
     protected selectedTokenContext: ITokenContext;
     protected selectedApolloMocks: Array<MockedResponse>;
-    protected selectedRouterProps: MemoryRouterProps<T> | null;
+    protected selectedRouterProps: MemoryRouterProps<TRouterTree> | null;
     protected selectedRootRoute: AnyRoute | null;
     protected selectedToastContext: IToastContext;
     protected selectedErrorHandler: ErrorHandlingContextValue;
@@ -354,7 +354,16 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
      * @param routerProps - The router props to use.
      * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
-    routerProps(routerProps: MemoryRouterProps<T>): this;
+    routerProps<TRoute extends AnyRoute>(routerProps: MemoryRouterProps<TRoute> & {
+        routeTree: TRoute;
+    }): this;
+    /**
+     * @param routerProps - The router props to use.
+     * @returns The builder instance for chaining.
+     */
+    routerProps(routerProps: Omit<MemoryRouterProps<RegisteredRouter["routeTree"]>, "routeTree"> & {
+        routeTree?: undefined;
+    }): this;
     /**
      * Use this Manager Apollo Context Provider with the given mocks.
      *

package/src/utils/routingUtils.d.ts

@@ -1,9 +1,9 @@
 import { AnyRoute, RegisteredRouter, RouteIds } from "@tanstack/react-router";
 import { ReactElement, ReactNode } from "react";
-export type MemoryRouterProps<T extends AnyRoute> = {
-    routeTree?: T;
+export type MemoryRouterProps<TRouterTree extends AnyRoute = RegisteredRouter["routeTree"]> = {
+    routeTree?: TRouterTree;
     initialEntries?: Array<{
-        route: RouteIds<RegisteredRouter["routeTree"]>;
+        route: RouteIds<TRouterTree>;
         path: string;
         component?: () => ReactElement | null;
         beforeLoad?: () => void;