@trackunit/react-core-contexts-test 0.1.228 → 0.1.229

package/HookRenderer.cjs.js

@@ -1,9 +1,9 @@
 'use strict';
 
 var index = require('./index.cjs2.js');
-var jsxRuntime = require('react/jsx-runtime');
 var react = require('@testing-library/react');
 var pure = require('@testing-library/react/pure');
+require('react/jsx-runtime');
 require('@trackunit/react-core-hooks');
 require('lodash/omit');
 require('@apollo/client');
@@ -28,7 +28,7 @@ const reactHooksRenderHook = (callback, getMockedCompositionRoot) => index.__awa
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const wrapper = ({ children }) => {
         // eslint-disable-next-line react/jsx-no-useless-fragment
-        return getMockedCompositionRoot(jsxRuntime.jsx(jsxRuntime.Fragment, { children: children }));
+        return getMockedCompositionRoot(children);
     };
     let renderedHook;
     // This is added here to make storybook work and to ensure the right act is loaded for hooks.

package/HookRenderer.esm.js

@@ -1,7 +1,7 @@
 import { _ as __awaiter, f as flushPromises } from './index.esm2.js';
-import { jsx, Fragment } from 'react/jsx-runtime';
 import { act } from '@testing-library/react';
 import { renderHook } from '@testing-library/react/pure';
+import 'react/jsx-runtime';
 import '@trackunit/react-core-hooks';
 import 'lodash/omit';
 import '@apollo/client';
@@ -26,7 +26,7 @@ const reactHooksRenderHook = (callback, getMockedCompositionRoot) => __awaiter(v
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const wrapper = ({ children }) => {
         // eslint-disable-next-line react/jsx-no-useless-fragment
-        return getMockedCompositionRoot(jsx(Fragment, { children: children }));
+        return getMockedCompositionRoot(children);
     };
     let renderedHook;
     // This is added here to make storybook work and to ensure the right act is loaded for hooks.

package/index.cjs2.js

@@ -72,9 +72,8 @@ const defaultOptions = {
 /**
  * This is a wrapper around the MockedProvider that logs errors to the console.
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ApolloMockedProviderWithError(props) {
-    const isDebugging = process ? !!process.env.VSCODE_INSPECTOR_OPTIONS || !!process.env.DEBUG : false;
+    const isDebugging = !!process.env.VSCODE_INSPECTOR_OPTIONS || !!process.env.DEBUG;
     const { mocks } = props, otherProps = __rest(props, ["mocks"]);
     const mockLink = new testing.MockLink(mocks, false, { showWarnings: props.forceDebugging || isDebugging });
     const errorLoggingLink = error.onError(({ graphQLErrors, networkError }) => {
@@ -87,11 +86,9 @@ function ApolloMockedProviderWithError(props) {
                 }
             });
         }
-        if (networkError) {
-            if (props.forceDebugging || isDebugging) {
-                // eslint-disable-next-line no-console
-                console.log(`[Network error]: ${networkError}`);
-            }
+        if (networkError && (props.forceDebugging || isDebugging)) {
+            // eslint-disable-next-line no-console
+            console.log(`[Network error]: ${networkError}`);
         }
     });
     const link = client.ApolloLink.from([errorLoggingLink, mockLink]);
@@ -302,32 +299,34 @@ const TestRenderChildren = ({ addTestRootContainer, children }) => {
  * @param selectedRouterProps selected router props
  * @param rootRoute root route
  * @param children children to be wrapped
- * @returns React.ReactElement
+ * @returns {React.ReactElement} children component wrapped in a test root container
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
     var _a, _b;
     const client = react.useApolloClient();
     // The current version of createMemoryHistory seem to have issues when NOT ending on / so adding a # will not effect what url is rendered but it seems to work
-    const memoryHistory = reactRouter.createMemoryHistory({
+    const memoryHistory = React.useRef(reactRouter.createMemoryHistory({
         initialEntries: (_b = (_a = selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.initialEntries) === null || _a === void 0 ? void 0 : _a.map(entry => entry.path + "#")) !== null && _b !== void 0 ? _b : ["/#"],
         initialIndex: 0,
-    });
+    }));
     const getChildren = React.useCallback(() => children, [children]);
     const router = React.useMemo(() => {
         var _a, _b;
-        if (!rootRoute) {
-            rootRoute = reactRouter.createRootRoute({ component: RootRouteDebugger });
+        let localRootRoute = rootRoute;
+        if (!localRootRoute) {
+            const route = reactRouter.createRootRoute({ component: RootRouteDebugger });
             const childRoute = reactRouter.createRoute({
                 path: "/",
-                getParentRoute: () => rootRoute,
+                getParentRoute: () => route,
                 component: () => {
                     return jsxRuntime.jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() });
                 },
             });
-            rootRoute.addChildren([childRoute]);
+            route.addChildren([childRoute]);
+            localRootRoute = route;
         }
         else {
-            const pathsToRoute = buildFlatRouteMap([rootRoute]);
+            const pathsToRoute = buildFlatRouteMap([localRootRoute]);
             sharedUtils.objectValues(pathsToRoute).forEach(route => {
                 route.options.component = RootRouteDebugger;
                 route.lazyFn = undefined;
@@ -362,16 +361,16 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                 else {
                     const childRoute = reactRouter.createRoute({
                         path: "/",
-                        getParentRoute: () => rootRoute,
+                        getParentRoute: () => localRootRoute,
                         component: () => (jsxRuntime.jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() })),
                     });
-                    rootRoute.addChildren([childRoute]);
+                    localRootRoute.addChildren([childRoute]);
                 }
             }
         }
         return reactRouter.createRouter({
-            routeTree: rootRoute,
-            history: memoryHistory,
+            routeTree: localRootRoute,
+            history: memoryHistory.current,
             context: {
                 hasAccessTo: () => __awaiter(void 0, void 0, void 0, function* () {
                     return true;
@@ -384,10 +383,14 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                 isAuthenticated: true,
             },
         });
+        // Skipping this rule for now.
+        // Explicit calls to rerender() will create a new router as `children` is changed.
+        // This causes unexpected state updates in Tanstack router which make the test fail
+        // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [rootRoute]);
     const context = React.useMemo(() => (Object.assign({ hasAccessTo: () => __awaiter(void 0, void 0, void 0, function* () { return true; }), isAuthenticated: true, client, defaultUserRoute: "/" }, ((selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context) || {}))), [client, selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context]);
-    const ErrorComponent = ({ error, info }) => {
-        return jsxRuntime.jsxs(jsxRuntime.Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error === null || error === void 0 ? void 0 : error.message] });
+    const ErrorComponent = ({ error }) => {
+        return jsxRuntime.jsxs(jsxRuntime.Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error && error instanceof Error ? error.message : error] });
     };
     return jsxRuntime.jsx(reactRouter.RouterProvider, { context: context, defaultErrorComponent: ErrorComponent, router: router });
 };
@@ -638,7 +641,7 @@ class TrackunitProvidersMockBuilder {
     userSubscription(userSubscription) {
         var _a;
         //TODO DONT SUPPORT THE WIERD WAY OF PASSING FEATURES
-        const featuresConverted = ((_a = userSubscription === null || userSubscription === void 0 ? void 0 : userSubscription.features) === null || _a === void 0 ? void 0 : _a.map(f => {
+        const featuresConverted = ((_a = userSubscription.features) === null || _a === void 0 ? void 0 : _a.map(f => {
             if (typeof f === "string") {
                 return { id: f, name: f };
             }
@@ -823,9 +826,9 @@ class TrackunitProvidersMockBuilder {
     }
     /**
      * Validate the mocks that has been supplied to make sure they make sense.
-     * Note: This function is overriden in builders extending this one.
+     * Note: This function is overridden in builders extending this one.
      *
-     * @returns {boolean} true or throws error if any invalid mocks
+     * @returns {boolean} true or throws error if any invalid mocks
      */
     validateSuppliedMocks() {
         return true;

package/index.esm2.js

@@ -9,7 +9,7 @@ import { AssetSortByProperty, SortOrder } from '@trackunit/react-core-contexts-a
 import { useApolloClient } from '@apollo/client/react';
 import { createMemoryHistory, createRootRoute, createRoute, createRouter, RouterProvider, Outlet } from '@tanstack/react-router';
 import { objectValues, objectKeys } from '@trackunit/shared-utils';
-import React, { useCallback, useMemo, useRef, useEffect } from 'react';
+import React, { useRef, useCallback, useMemo, useEffect } from 'react';
 import { GraphQLError } from 'graphql';
 
 /******************************************************************************
@@ -65,9 +65,8 @@ const defaultOptions = {
 /**
  * This is a wrapper around the MockedProvider that logs errors to the console.
  */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
 function ApolloMockedProviderWithError(props) {
-    const isDebugging = process ? !!process.env.VSCODE_INSPECTOR_OPTIONS || !!process.env.DEBUG : false;
+    const isDebugging = !!process.env.VSCODE_INSPECTOR_OPTIONS || !!process.env.DEBUG;
     const { mocks } = props, otherProps = __rest(props, ["mocks"]);
     const mockLink = new MockLink(mocks, false, { showWarnings: props.forceDebugging || isDebugging });
     const errorLoggingLink = onError(({ graphQLErrors, networkError }) => {
@@ -80,11 +79,9 @@ function ApolloMockedProviderWithError(props) {
                 }
             });
         }
-        if (networkError) {
-            if (props.forceDebugging || isDebugging) {
-                // eslint-disable-next-line no-console
-                console.log(`[Network error]: ${networkError}`);
-            }
+        if (networkError && (props.forceDebugging || isDebugging)) {
+            // eslint-disable-next-line no-console
+            console.log(`[Network error]: ${networkError}`);
         }
     });
     const link = ApolloLink.from([errorLoggingLink, mockLink]);
@@ -295,32 +292,34 @@ const TestRenderChildren = ({ addTestRootContainer, children }) => {
  * @param selectedRouterProps selected router props
  * @param rootRoute root route
  * @param children children to be wrapped
- * @returns React.ReactElement
+ * @returns {React.ReactElement} children component wrapped in a test root container
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
     var _a, _b;
     const client = useApolloClient();
     // The current version of createMemoryHistory seem to have issues when NOT ending on / so adding a # will not effect what url is rendered but it seems to work
-    const memoryHistory = createMemoryHistory({
+    const memoryHistory = useRef(createMemoryHistory({
         initialEntries: (_b = (_a = selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.initialEntries) === null || _a === void 0 ? void 0 : _a.map(entry => entry.path + "#")) !== null && _b !== void 0 ? _b : ["/#"],
         initialIndex: 0,
-    });
+    }));
     const getChildren = useCallback(() => children, [children]);
     const router = useMemo(() => {
         var _a, _b;
-        if (!rootRoute) {
-            rootRoute = createRootRoute({ component: RootRouteDebugger });
+        let localRootRoute = rootRoute;
+        if (!localRootRoute) {
+            const route = createRootRoute({ component: RootRouteDebugger });
             const childRoute = createRoute({
                 path: "/",
-                getParentRoute: () => rootRoute,
+                getParentRoute: () => route,
                 component: () => {
                     return jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() });
                 },
             });
-            rootRoute.addChildren([childRoute]);
+            route.addChildren([childRoute]);
+            localRootRoute = route;
         }
         else {
-            const pathsToRoute = buildFlatRouteMap([rootRoute]);
+            const pathsToRoute = buildFlatRouteMap([localRootRoute]);
             objectValues(pathsToRoute).forEach(route => {
                 route.options.component = RootRouteDebugger;
                 route.lazyFn = undefined;
@@ -355,16 +354,16 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                 else {
                     const childRoute = createRoute({
                         path: "/",
-                        getParentRoute: () => rootRoute,
+                        getParentRoute: () => localRootRoute,
                         component: () => (jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() })),
                     });
-                    rootRoute.addChildren([childRoute]);
+                    localRootRoute.addChildren([childRoute]);
                 }
             }
         }
         return createRouter({
-            routeTree: rootRoute,
-            history: memoryHistory,
+            routeTree: localRootRoute,
+            history: memoryHistory.current,
             context: {
                 hasAccessTo: () => __awaiter(void 0, void 0, void 0, function* () {
                     return true;
@@ -377,10 +376,14 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                 isAuthenticated: true,
             },
         });
+        // Skipping this rule for now.
+        // Explicit calls to rerender() will create a new router as `children` is changed.
+        // This causes unexpected state updates in Tanstack router which make the test fail
+        // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [rootRoute]);
     const context = useMemo(() => (Object.assign({ hasAccessTo: () => __awaiter(void 0, void 0, void 0, function* () { return true; }), isAuthenticated: true, client, defaultUserRoute: "/" }, ((selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context) || {}))), [client, selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context]);
-    const ErrorComponent = ({ error, info }) => {
-        return jsxs(Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error === null || error === void 0 ? void 0 : error.message] });
+    const ErrorComponent = ({ error }) => {
+        return jsxs(Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error && error instanceof Error ? error.message : error] });
     };
     return jsx(RouterProvider, { context: context, defaultErrorComponent: ErrorComponent, router: router });
 };
@@ -631,7 +634,7 @@ class TrackunitProvidersMockBuilder {
     userSubscription(userSubscription) {
         var _a;
         //TODO DONT SUPPORT THE WIERD WAY OF PASSING FEATURES
-        const featuresConverted = ((_a = userSubscription === null || userSubscription === void 0 ? void 0 : userSubscription.features) === null || _a === void 0 ? void 0 : _a.map(f => {
+        const featuresConverted = ((_a = userSubscription.features) === null || _a === void 0 ? void 0 : _a.map(f => {
             if (typeof f === "string") {
                 return { id: f, name: f };
             }
@@ -816,9 +819,9 @@ class TrackunitProvidersMockBuilder {
     }
     /**
      * Validate the mocks that has been supplied to make sure they make sense.
-     * Note: This function is overriden in builders extending this one.
+     * Note: This function is overridden in builders extending this one.
      *
-     * @returns {boolean} true or throws error if any invalid mocks
+     * @returns {boolean} true or throws error if any invalid mocks
      */
     validateSuppliedMocks() {
         return true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.228",
+  "version": "0.1.229",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/ApolloMockedProviderWithError.d.ts

@@ -1,5 +1,10 @@
 /// <reference types="react" />
+import { MockLink } from "@apollo/client/testing";
 /**
  * This is a wrapper around the MockedProvider that logs errors to the console.
  */
-export declare function ApolloMockedProviderWithError(props: any): JSX.Element;
+export declare function ApolloMockedProviderWithError(props: {
+    mocks: ConstructorParameters<typeof MockLink>[0];
+    forceDebugging?: boolean;
+    [k: string]: unknown;
+}): JSX.Element;

package/src/HookRenderer.d.ts

@@ -8,4 +8,4 @@ import * as React from "react";
  * @param getMockedCompositionRoot A function that will return the mocked composition root.
  * @returns { Promise<RenderHookResult> } The rendered hook.
  */
-export declare const reactHooksRenderHook: <TProps, TResult>(callback: (props: TProps) => TResult, getMockedCompositionRoot: (children: React.ReactElement) => React.ReactElement) => Promise<RenderHookResult<TResult, TProps>>;
+export declare const reactHooksRenderHook: <TProps, TResult>(callback: (props: TProps) => TResult, getMockedCompositionRoot: (children: React.ReactNode) => React.ReactElement) => Promise<RenderHookResult<TResult, TProps>>;

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -1,17 +1,9 @@
 import { MockedResponse } from "@apollo/client/testing";
-import { AnyRoute, RegisteredRouter, RouteIds } from "@tanstack/react-router";
+import { AnyRoute } from "@tanstack/react-router";
 import { RenderResult } from "@testing-library/react";
 import { AssetSortingContextValue, ConfirmationDialogContextValue, FilterBarValues, IAnalyticsContext, ICurrentUserContext, IEnvironmentContext, INavigationContext, IOemBrandingContext, IToastContext, ITokenContext, IUserPreferencesContext, IUserSubscriptionContext, ModalDialogContextValue } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
-export type MemoryRouterProps<T extends AnyRoute> = {
-    routeTree?: T;
-    initialEntries?: {
-        route: RouteIds<RegisteredRouter["routeTree"]>;
-        path: string;
-        component?: () => JSX.Element | null;
-    }[];
-    context?: Record<string, unknown>;
-};
+import { MemoryRouterProps } from "./utils/routingUtils";
 /**
  * This builder allows you to enable trackunit providers using the builder pattern, and then call 1 of either:
  * For React Components:
@@ -34,7 +26,7 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
     protected selectedAssetSortingContext: AssetSortingContextValue;
     protected selectedCurrentUserContext: ICurrentUserContext;
     protected selectedCurrentUserPreferenceContext: IUserPreferencesContext;
-    protected selectedAnalyticsContext: IAnalyticsContext<{}>;
+    protected selectedAnalyticsContext: IAnalyticsContext<Record<string, never>>;
     protected selectedOemBrandingContext: IOemBrandingContext;
     protected selectedUserSubscriptionContext: IUserSubscriptionContext;
     protected selectedFilterBarValues: FilterBarValues;
@@ -349,9 +341,9 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
     apollo(apolloMocks?: MockedResponse[]): this;
     /**
      * Validate the mocks that has been supplied to make sure they make sense.
-     * Note: This function is overriden in builders extending this one.
+     * Note: This function is overridden in builders extending this one.
      *
-     * @returns {boolean} true or throws error if any invalid mocks
+     * @returns {boolean} true or throws error if any invalid mocks
      */
     protected validateSuppliedMocks(): true | never;
     protected rootRoute(rootRoute: AnyRoute | null): this;
@@ -365,7 +357,7 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
     /**
      * This will return the mocked composition root.
      */
-    renderHook<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: React.ReactElement) => React.ReactElement): Promise<import("@testing-library/react").RenderHookResult<TResult, TProps>>;
+    renderHook<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: React.ReactNode) => React.ReactElement): Promise<import("@testing-library/react").RenderHookResult<TResult, TProps>>;
     /**
      * This will use react-testing-library.render the child in the correct mocked hierarchy of context providers.
      *

package/src/debugger.d.ts

@@ -34,6 +34,6 @@ export declare const Debugger: ({ id, logPropsChanges, stop, children, }: {
     children: React.ReactNode;
     id?: string;
     stop?: boolean;
-    logPropsChanges?: {};
+    logPropsChanges?: Record<string, unknown>;
 }) => JSX.Element;
 export {};

package/src/mocks/mockAnalyticsContext.d.ts

@@ -1,2 +1,2 @@
 import { IAnalyticsContext } from "@trackunit/react-core-contexts-api";
-export declare const mockAnalyticsContext: IAnalyticsContext<{}>;
+export declare const mockAnalyticsContext: IAnalyticsContext<Record<string, never>>;

package/src/utils/routingUtils.d.ts

@@ -1,6 +1,14 @@
-import { AnyRoute } from "@tanstack/react-router";
+import { AnyRoute, RegisteredRouter, RouteIds } from "@tanstack/react-router";
 import React from "react";
-import { MemoryRouterProps } from "../TrackunitProvidersMockBuilder";
+export type MemoryRouterProps<T extends AnyRoute> = {
+    routeTree?: T;
+    initialEntries?: {
+        route: RouteIds<RegisteredRouter["routeTree"]>;
+        path: string;
+        component?: () => JSX.Element | null;
+    }[];
+    context?: Record<string, unknown>;
+};
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container
  */
@@ -33,6 +41,6 @@ export interface RouterContainerProps<T extends AnyRoute = AnyRoute> {
  * @param selectedRouterProps selected router props
  * @param rootRoute root route
  * @param children children to be wrapped
- * @returns React.ReactElement
+ * @returns {React.ReactElement} children component wrapped in a test root container
  */
 export declare const RouterContainer: ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }: RouterContainerProps) => React.ReactElement;