@trackunit/react-core-contexts-test 1.0.7 → 1.0.9

package/HookRenderer.cjs.js

@@ -25,14 +25,11 @@ require('graphql');
  * @returns { Promise<RenderHookResult> } The rendered hook.
  */
 const reactHooksRenderHook = async (callback, getMockedCompositionRoot) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const wrapper = ({ children }) => {
-        // eslint-disable-next-line react/jsx-no-useless-fragment
         return getMockedCompositionRoot(children);
     };
     let renderedHook;
     // This is added here to make storybook work and to ensure the right act is loaded for hooks.
-    // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
     await react.act(async () => {
         renderedHook = await react.renderHook(callback, { wrapper });
     });

package/HookRenderer.esm.js

@@ -23,14 +23,11 @@ import 'graphql';
  * @returns { Promise<RenderHookResult> } The rendered hook.
  */
 const reactHooksRenderHook = async (callback, getMockedCompositionRoot) => {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const wrapper = ({ children }) => {
-        // eslint-disable-next-line react/jsx-no-useless-fragment
         return getMockedCompositionRoot(children);
     };
     let renderedHook;
     // This is added here to make storybook work and to ensure the right act is loaded for hooks.
-    // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
     await act(async () => {
         renderedHook = await renderHook(callback, { wrapper });
     });

package/index.cjs.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var jsxRuntime = require('react/jsx-runtime');
-var react$1 = require('@testing-library/react');
+var react$2 = require('@testing-library/react');
 var reactCoreHooks = require('@trackunit/react-core-hooks');
 var omit = require('lodash/omit');
 var client = require('@apollo/client');
@@ -10,8 +10,8 @@ var error = require('@apollo/client/link/error');
 var testing = require('@apollo/client/testing');
 var reactCoreContextsApi = require('@trackunit/react-core-contexts-api');
 var sharedUtils = require('@trackunit/shared-utils');
-var React = require('react');
-var react = require('@apollo/client/react');
+var react = require('react');
+var react$1 = require('@apollo/client/react');
 var reactRouter = require('@tanstack/react-router');
 var graphql = require('graphql');
 
@@ -34,7 +34,6 @@ function ApolloMockedProviderWithError(props) {
     const mockLink = new testing.MockLink(mocks, false, { showWarnings: isDebugging });
     const errorLoggingLink = error.onError(({ graphQLErrors, networkError }) => {
         if (graphQLErrors) {
-            // eslint-disable-next-line array-callback-return
             graphQLErrors.map(({ message, locations, path }) => {
                 if (isDebugging) {
                     // eslint-disable-next-line no-console
@@ -223,13 +222,13 @@ const mockUserSubscriptionContext = {
     packageType: "EXPAND_FLEET_OWNER",
 };
 
-const RerenderContext = React.createContext({ rerenderCounter: 0, setRerenderCounter: (value) => { } });
+const RerenderContext = react.createContext({ rerenderCounter: 0, setRerenderCounter: (value) => { } });
 /**
  * This provider is used to force re-renders in the test environment, since tanstack router does not support re-render.
  */
 const RerenderProvider = ({ children, counter }) => {
-    const [rerenderCounter, setRerenderCounter] = React.useState(0);
-    React.useEffect(() => {
+    const [rerenderCounter, setRerenderCounter] = react.useState(0);
+    react.useEffect(() => {
         if (counter && rerenderCounter !== counter && rerenderCounter !== 0) {
             setRerenderCounter(counter);
         }
@@ -240,7 +239,7 @@ const RerenderProvider = ({ children, counter }) => {
  * This hook is used to get the rerender counter.
  */
 const useRerenderCounter = () => {
-    return React.useContext(RerenderContext);
+    return react.useContext(RerenderContext);
 };
 
 /**
@@ -248,8 +247,8 @@ const useRerenderCounter = () => {
  */
 const RerenderComponent = ({ children }) => {
     const { rerenderCounter } = useRerenderCounter();
-    return (jsxRuntime.jsx("div", { "data-rerender-counter": `rerender-${rerenderCounter}`, children: React.Children.map(children, child => React.isValidElement(child)
-            ? React.createElement(child.type, {
+    return (jsxRuntime.jsx("div", { "data-rerender-counter": `rerender-${rerenderCounter}`, children: react.Children.map(children, child => react.isValidElement(child)
+            ? react.createElement(child.type, {
                 ...child.props,
                 key: child.key,
                 "data-rerender-counter": rerenderCounter,
@@ -298,17 +297,17 @@ const TestRenderChildren = ({ addTestRootContainer, children }) => {
  * @param selectedRouterProps selected router props
  * @param rootRoute root route
  * @param children children to be wrapped
- * @returns {React.ReactElement} children component wrapped in a test root container
+ * @returns {ReactElement} children component wrapped in a test root container
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
-    const client = react.useApolloClient();
+    const client = react$1.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 = React.useRef(reactRouter.createMemoryHistory({
+    const memoryHistory = react.useRef(reactRouter.createMemoryHistory({
         initialEntries: selectedRouterProps?.initialEntries?.map(entry => entry.path + "#") ?? ["/#"],
         initialIndex: 0,
     }));
-    const getChildren = React.useCallback(() => children, [children]);
-    const router = React.useMemo(() => {
+    const getChildren = react.useCallback(() => children, [children]);
+    const router = react.useMemo(() => {
         let localRootRoute = rootRoute;
         if (!localRootRoute) {
             const route = reactRouter.createRootRoute({ component: RootRouteDebugger });
@@ -391,7 +390,7 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
         // 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(() => ({
+    const context = react.useMemo(() => ({
         hasAccessTo: async () => true,
         isAuthenticated: true,
         client,
@@ -431,7 +430,7 @@ const flushPromises = (waitTimeInMS = 0) => {
  * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
  */
 const flushPromisesInAct = (waitTimeInMS = 0) => {
-    return react$1.act(() => {
+    return react$2.act(() => {
         return new Promise(resolve => {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             if (global.ORG_setTimeout) {
@@ -899,16 +898,16 @@ class TrackunitProvidersMockBuilder {
     async render(child) {
         this.validateSuppliedMocks();
         let mountedcomponent;
-        await react$1.act(async () => {
-            mountedcomponent = react$1.render(child, {
+        await react$2.act(async () => {
+            mountedcomponent = react$2.render(child, {
                 wrapper: ({ children }) => this.getMockedCompositionRootWithRouter(children),
             });
             await flushPromises();
         });
-        await react$1.act(async () => {
+        await react$2.act(async () => {
             await flushPromises();
         });
-        await react$1.act(async () => {
+        await react$2.act(async () => {
             await flushPromises();
         });
         // eslint-disable-next-line local-rules/no-typescript-assertion
@@ -932,7 +931,7 @@ const trackunitProviders = () => new TrackunitProvidersMockBuilder();
  * @returns {boolean} Returns true if it is the first render, false otherwise.
  */
 const useIsFirstRender = () => {
-    const renderRef = React.useRef(true);
+    const renderRef = react.useRef(true);
     if (renderRef.current === true) {
         renderRef.current = false;
         return true;
@@ -952,8 +951,8 @@ const useIsFirstRender = () => {
  * useDebugger(propsToWatch);
  */
 const useDebugger = (propsToWatch, id) => {
-    const prevPropsRef = React.useRef(propsToWatch);
-    const uniqueId = React.useMemo(() => {
+    const prevPropsRef = react.useRef(propsToWatch);
+    const uniqueId = react.useMemo(() => {
         // eslint-disable-next-line local-rules/no-typescript-assertion
         let stackId = id || (propsToWatch && propsToWatch.id);
         const stack = new Error().stack;
@@ -972,8 +971,7 @@ const useDebugger = (propsToWatch, id) => {
     const isFirstRender = useIsFirstRender();
     // eslint-disable-next-line no-console
     console.log(isFirstRender ? "First-render" : "Re-render", uniqueId, window.location.pathname);
-    React.useEffect(() => {
-        // eslint-disable-next-line local-rules/prefer-custom-object-entries
+    react.useEffect(() => {
         const changedProps = Object.entries(propsToWatch || {}).reduce((result, [key, value]) => {
             if (prevPropsRef.current && prevPropsRef.current[key] !== value) {
                 result[key + ""] = [prevPropsRef.current[key], value];
@@ -981,7 +979,6 @@ const useDebugger = (propsToWatch, id) => {
             return result;
         }, {});
         if (sharedUtils.objectKeys(changedProps).length > 0) {
-            // eslint-disable-next-line no-console
             sharedUtils.objectKeys(changedProps).forEach(changedProp => {
                 // eslint-disable-next-line no-console
                 console.log(`${uniqueId} changed property: ${changedProp}`);
@@ -1026,7 +1023,7 @@ const Debugger = ({ id, logPropsChanges, stop, children, }) => {
         new Error().stack?.split("\n")[2]?.trim() ||
         "unknown-id";
     useDebugger(logPropsChanges || {}, id);
-    React.useEffect(() => {
+    react.useEffect(() => {
         // eslint-disable-next-line no-console
         console.log(`${uniqueId} Debugger is mounting`);
         return () => {

package/index.esm.js

@@ -8,7 +8,7 @@ import { onError } from '@apollo/client/link/error';
 import { MockLink, MockedProvider } from '@apollo/client/testing';
 import { AssetSortByProperty, SortOrder } from '@trackunit/react-core-contexts-api';
 import { doNothing as doNothing$1, objectValues, objectKeys } from '@trackunit/shared-utils';
-import React, { createContext, useState, useEffect, useContext, useRef, useCallback, useMemo } from 'react';
+import { createContext, useState, useEffect, useContext, Children, isValidElement, createElement, useRef, useCallback, useMemo } from 'react';
 import { useApolloClient } from '@apollo/client/react';
 import { createMemoryHistory, createRootRoute, createRoute, createRouter, RouterProvider, Outlet } from '@tanstack/react-router';
 import { GraphQLError } from 'graphql';
@@ -32,7 +32,6 @@ function ApolloMockedProviderWithError(props) {
     const mockLink = new MockLink(mocks, false, { showWarnings: isDebugging });
     const errorLoggingLink = onError(({ graphQLErrors, networkError }) => {
         if (graphQLErrors) {
-            // eslint-disable-next-line array-callback-return
             graphQLErrors.map(({ message, locations, path }) => {
                 if (isDebugging) {
                     // eslint-disable-next-line no-console
@@ -246,8 +245,8 @@ const useRerenderCounter = () => {
  */
 const RerenderComponent = ({ children }) => {
     const { rerenderCounter } = useRerenderCounter();
-    return (jsx("div", { "data-rerender-counter": `rerender-${rerenderCounter}`, children: React.Children.map(children, child => React.isValidElement(child)
-            ? React.createElement(child.type, {
+    return (jsx("div", { "data-rerender-counter": `rerender-${rerenderCounter}`, children: Children.map(children, child => isValidElement(child)
+            ? createElement(child.type, {
                 ...child.props,
                 key: child.key,
                 "data-rerender-counter": rerenderCounter,
@@ -296,7 +295,7 @@ const TestRenderChildren = ({ addTestRootContainer, children }) => {
  * @param selectedRouterProps selected router props
  * @param rootRoute root route
  * @param children children to be wrapped
- * @returns {React.ReactElement} children component wrapped in a test root container
+ * @returns {ReactElement} children component wrapped in a test root container
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
     const client = useApolloClient();
@@ -971,7 +970,6 @@ const useDebugger = (propsToWatch, id) => {
     // eslint-disable-next-line no-console
     console.log(isFirstRender ? "First-render" : "Re-render", uniqueId, window.location.pathname);
     useEffect(() => {
-        // eslint-disable-next-line local-rules/prefer-custom-object-entries
         const changedProps = Object.entries(propsToWatch || {}).reduce((result, [key, value]) => {
             if (prevPropsRef.current && prevPropsRef.current[key] !== value) {
                 result[key + ""] = [prevPropsRef.current[key], value];
@@ -979,7 +977,6 @@ const useDebugger = (propsToWatch, id) => {
             return result;
         }, {});
         if (objectKeys(changedProps).length > 0) {
-            // eslint-disable-next-line no-console
             objectKeys(changedProps).forEach(changedProp => {
                 // eslint-disable-next-line no-console
                 console.log(`${uniqueId} changed property: ${changedProp}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -13,9 +13,9 @@
     "lodash": "4.17.21",
     "graphql": "^16.9.0",
     "@tanstack/react-router": "1.47.1",
-    "@trackunit/react-core-contexts-api": "^1.0.7",
-    "@trackunit/react-core-hooks": "^1.0.7",
-    "@trackunit/shared-utils": "^1.1.1"
+    "@trackunit/react-core-contexts-api": "1.0.9",
+    "@trackunit/react-core-hooks": "1.0.9",
+    "@trackunit/shared-utils": "1.2.1"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/HookRenderer.d.ts

@@ -1,5 +1,5 @@
 import { RenderHookResult } from "@testing-library/react";
-import * as React from "react";
+import { ReactElement, ReactNode } from "react";
 /**
  * This is a wrapper around the react testing library renderHook function.
  * It will make sure that the act function is called and that the promises are flushed.
@@ -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.ReactNode) => React.ReactElement) => Promise<RenderHookResult<TResult, TProps>>;
+export declare const reactHooksRenderHook: <TProps, TResult>(callback: (props: TProps) => TResult, getMockedCompositionRoot: (children: ReactNode) => ReactElement) => Promise<RenderHookResult<TResult, TProps>>;

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -2,7 +2,7 @@ import { MockedResponse } from "@apollo/client/testing";
 import { AnyRoute } from "@tanstack/react-router";
 import { RenderResult } from "@testing-library/react";
 import { AssetSortingContextValue, ConfirmationDialogContextValue, ErrorHandlingContextValue, FilterBarValues, IAnalyticsContext, ICurrentUserContext, IEnvironmentContext, INavigationContext, OemBrandingContext, IToastContext, ITokenContext, IUserPreferencesContext, IUserSubscriptionContext, ModalDialogContextValue } from "@trackunit/react-core-contexts-api";
-import * as React from "react";
+import { ReactElement, ReactNode } from "react";
 import { MemoryRouterProps } from "./utils/routingUtils";
 /**
  * This builder allows you to enable trackunit providers using the builder pattern, and then call 1 of either:
@@ -357,12 +357,12 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
      *
      * @param testChildren - the child element being tested.
      */
-    protected getMockedCompositionRoot(testChildren: React.ReactNode): import("react/jsx-runtime").JSX.Element;
-    protected getMockedCompositionRootWithRouter(testChildren: React.ReactNode): import("react/jsx-runtime").JSX.Element;
+    protected getMockedCompositionRoot(testChildren: ReactNode): import("react/jsx-runtime").JSX.Element;
+    protected getMockedCompositionRootWithRouter(testChildren: ReactNode): import("react/jsx-runtime").JSX.Element;
     /**
      * This will return the mocked composition root.
      */
-    renderHook<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: React.ReactNode) => React.ReactElement): Promise<{
+    renderHook<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: ReactNode) => ReactElement): Promise<{
         rerender: (props?: TProps) => Promise<void>;
         result: {
             current: TResult;
@@ -375,11 +375,11 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
      * @see https://testing-library.com/docs/react-testing-library/api#render
      * @param child - the child element being tested.
      */
-    render(child: React.ReactElement): Promise<RenderResult>;
+    render(child: ReactElement): Promise<RenderResult>;
     /**
      *  This will return the children in the correct mocked hierarchy of context providers.
      */
-    storybook(child: React.ReactNode): import("react/jsx-runtime").JSX.Element;
+    storybook(child: ReactNode): import("react/jsx-runtime").JSX.Element;
 }
 /**
  * This is the default mock builder for the TrackunitProviders.

package/src/debugger.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
+import { ReactNode } from "react";
 type PropsToWatch<P> = P extends object ? P : never;
 /**
  * Differentiate between the first and subsequent renders.
@@ -31,7 +31,7 @@ export declare const useDebugger: <P extends object>(propsToWatch: PropsToWatch<
  * @param children the children to render
  */
 export declare const Debugger: ({ id, logPropsChanges, stop, children, }: {
-    children?: React.ReactNode;
+    children?: ReactNode;
     id?: string;
     stop?: boolean;
     logPropsChanges?: Record<string, unknown>;

package/src/rerenderProvider/RerenderComponent.d.ts

@@ -1,7 +1,7 @@
-import React from "react";
+import { ReactNode } from "react";
 /**
  * This component is used to force re-renders in the test environment, since tanstack router does not support re-render.
  */
 export declare const RerenderComponent: ({ children }: {
-    children: React.ReactNode;
+    children: ReactNode;
 }) => import("react/jsx-runtime").JSX.Element;

package/src/utils/routingUtils.d.ts

@@ -1,5 +1,5 @@
 import { AnyRoute, RegisteredRouter, RouteIds } from "@tanstack/react-router";
-import React from "react";
+import { ReactElement, ReactNode } from "react";
 export type MemoryRouterProps<T extends AnyRoute> = {
     routeTree?: T;
     initialEntries?: {
@@ -18,7 +18,7 @@ export declare const RootRouteDebugger: () => import("react/jsx-runtime").JSX.El
  */
 export interface TestRenderChildrenProps {
     addTestRootContainer: boolean;
-    children: React.ReactNode;
+    children: ReactNode;
 }
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
@@ -32,7 +32,7 @@ export interface RouterContainerProps<T extends AnyRoute = AnyRoute> {
     addTestRootContainer: boolean;
     rootRoute?: T | null;
     selectedRouterProps: MemoryRouterProps<T> | null;
-    children: React.ReactNode;
+    children: ReactNode;
 }
 /**
  * This component is used to wrap the children of the RouterContainer to add a test root container.
@@ -41,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} children component wrapped in a test root container
+ * @returns {ReactElement} children component wrapped in a test root container
  */
-export declare const RouterContainer: ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }: RouterContainerProps) => React.ReactElement;
+export declare const RouterContainer: ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }: RouterContainerProps) => ReactElement;