@trackunit/react-core-contexts-test 1.3.70 → 1.3.73

package/index.cjs.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var jsxRuntime = require('react/jsx-runtime');
-var react$2 = require('@testing-library/react');
+var react$1 = 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$1 = require('@apollo/client/react');
+var React = require('react');
+var react = require('@apollo/client/react');
 var reactRouter = require('@tanstack/react-router');
 var graphql = require('graphql');
 
@@ -204,6 +204,13 @@ const mockOemBrandingContext = {
     getOemImage: doNothing,
 };
 
+const mockTimeRangeContext = {
+    timeRange: {
+        startMsInEpoch: 1,
+        endMsInEpoch: 2,
+    },
+};
+
 const mockToastContext = {
     addToast: doNothing,
     setIsManifestError: doNothing,
@@ -222,13 +229,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);
         }
@@ -239,7 +246,7 @@ const RerenderProvider = ({ children, counter }) => {
  * This hook is used to get the rerender counter.
  */
 const useRerenderCounter = () => {
-    return react.useContext(RerenderContext);
+    return React.useContext(RerenderContext);
 };
 
 /**
@@ -247,8 +254,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,
@@ -300,14 +307,14 @@ const TestRenderChildren = ({ addTestRootContainer, children }) => {
  * @returns {ReactElement} children component wrapped in a test root container
  */
 const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute, children, }) => {
-    const client = react$1.useApolloClient();
+    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 = 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 });
@@ -390,7 +397,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,
@@ -430,7 +437,7 @@ const flushPromises = (waitTimeInMS = 0) => {
  * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
  */
 const flushPromisesInAct = (waitTimeInMS = 0) => {
-    return react$2.act(() => {
+    return react$1.act(() => {
         return new Promise(resolve => {
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             if (global.ORG_setTimeout) {
@@ -457,6 +464,7 @@ class TrackunitProvidersMockBuilder {
     constructor() {
         this.selectedEnvironmentContext = mockEnvironmentContext;
         this.selectedModalDialogContext = mockModalDialogContext;
+        this.selectedTimeRangeContext = mockTimeRangeContext;
         this.selectedNavigationContext = mockNavigationContext;
         this.selectedTokenContext = { token: "fakeToken" };
         this.selectedApolloMocks = [];
@@ -534,6 +542,16 @@ class TrackunitProvidersMockBuilder {
         this.selectedEnvironmentContext = { ...mockEnvironmentContext, ...environmentContext };
         return this;
     }
+    /**
+     * Use this Time Range Context, used for myhome.
+     * Defaults to mockTimeRangeContext.
+     *
+     * @see mockTimeRangeContext
+     */
+    timeRange(timeRangeContext) {
+        this.selectedTimeRangeContext = { ...mockTimeRangeContext, ...timeRangeContext };
+        return this;
+    }
     /**
      * Use this Navigation Context.
      * Defaults to mockNavigationContext.
@@ -870,7 +888,7 @@ class TrackunitProvidersMockBuilder {
      * @param testChildren - the child element being tested.
      */
     getMockedCompositionRoot(testChildren) {
-        return (jsxRuntime.jsx(reactCoreHooks.ErrorHandlingContextProvider, { value: this.selectedErrorHandler, children: jsxRuntime.jsx(reactCoreHooks.CurrentUserProvider, { value: this.selectedCurrentUserContext, children: jsxRuntime.jsx(reactCoreHooks.AnalyticsContext.Provider, { value: this.selectedAnalyticsContext, children: jsxRuntime.jsx(reactCoreHooks.UserSubscriptionProvider, { value: this.selectedUserSubscriptionContext, children: jsxRuntime.jsx(reactCoreHooks.OemBrandingContextProvider, { value: this.selectedOemBrandingContext, children: jsxRuntime.jsx(reactCoreHooks.TokenProvider, { value: this.selectedTokenContext, children: jsxRuntime.jsx(reactCoreHooks.ToastProvider, { value: this.selectedToastContext, children: jsxRuntime.jsx(reactCoreHooks.ConfirmationDialogProvider, { value: this.selectedConfirmationDialogContext, children: jsxRuntime.jsx(reactCoreHooks.FilterBarProvider, { value: this.selectedFilterBarValues, children: jsxRuntime.jsx(reactCoreHooks.AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsxRuntime.jsx(ApolloMockedProviderWithError, { addTypename: false, mocks: this.selectedApolloMocks, children: jsxRuntime.jsx(reactCoreHooks.NavigationContextProvider, { value: this.selectedNavigationContext, children: jsxRuntime.jsx(reactCoreHooks.CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: jsxRuntime.jsx(reactCoreHooks.EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsxRuntime.jsx(reactCoreHooks.ModalDialogContextProvider, { value: this.selectedModalDialogContext, children: testChildren }) }) }) }) }) }) }) }) }) }) }) }) }) }) }));
+        return (jsxRuntime.jsx(reactCoreHooks.ErrorHandlingContextProvider, { value: this.selectedErrorHandler, children: jsxRuntime.jsx(reactCoreHooks.CurrentUserProvider, { value: this.selectedCurrentUserContext, children: jsxRuntime.jsx(reactCoreHooks.AnalyticsContext.Provider, { value: this.selectedAnalyticsContext, children: jsxRuntime.jsx(reactCoreHooks.UserSubscriptionProvider, { value: this.selectedUserSubscriptionContext, children: jsxRuntime.jsx(reactCoreHooks.OemBrandingContextProvider, { value: this.selectedOemBrandingContext, children: jsxRuntime.jsx(reactCoreHooks.TokenProvider, { value: this.selectedTokenContext, children: jsxRuntime.jsx(reactCoreHooks.ToastProvider, { value: this.selectedToastContext, children: jsxRuntime.jsx(reactCoreHooks.ConfirmationDialogProvider, { value: this.selectedConfirmationDialogContext, children: jsxRuntime.jsx(reactCoreHooks.FilterBarProvider, { value: this.selectedFilterBarValues, children: jsxRuntime.jsx(reactCoreHooks.AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsxRuntime.jsx(ApolloMockedProviderWithError, { addTypename: false, mocks: this.selectedApolloMocks, children: jsxRuntime.jsx(reactCoreHooks.NavigationContextProvider, { value: this.selectedNavigationContext, children: jsxRuntime.jsx(reactCoreHooks.CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: jsxRuntime.jsx(reactCoreHooks.EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsxRuntime.jsx(reactCoreHooks.ModalDialogContextProvider, { value: this.selectedModalDialogContext, children: jsxRuntime.jsx(reactCoreHooks.TimeRangeProvider, { value: this.selectedTimeRangeContext, children: testChildren }) }) }) }) }) }) }) }) }) }) }) }) }) }) }) }));
     }
     getMockedCompositionRootWithRouter(testChildren) {
         const childrenWithRouter = (jsxRuntime.jsx(RouterContainer, { addTestRootContainer: true, rootRoute: this.selectedRootRoute, selectedRouterProps: this.selectedRouterProps, children: testChildren }));
@@ -903,16 +921,16 @@ class TrackunitProvidersMockBuilder {
     async render(child) {
         this.validateSuppliedMocks();
         let mountedcomponent;
-        await react$2.act(async () => {
-            mountedcomponent = react$2.render(child, {
+        await react$1.act(async () => {
+            mountedcomponent = react$1.render(child, {
                 wrapper: ({ children }) => this.getMockedCompositionRootWithRouter(children),
             });
             await flushPromises();
         });
-        await react$2.act(async () => {
+        await react$1.act(async () => {
             await flushPromises();
         });
-        await react$2.act(async () => {
+        await react$1.act(async () => {
             await flushPromises();
         });
         // eslint-disable-next-line local-rules/no-typescript-assertion
@@ -941,8 +959,8 @@ const trackunitProviders = () => new TrackunitProvidersMockBuilder();
  * @returns {boolean} Returns true if it is the first render, false otherwise.
  */
 const useIsFirstRender = () => {
-    const [isFirstRender, setIsFirstRender] = react.useState(true);
-    react.useEffect(() => {
+    const [isFirstRender, setIsFirstRender] = React.useState(true);
+    React.useEffect(() => {
         setIsFirstRender(false);
     }, []);
     return isFirstRender;
@@ -960,8 +978,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;
@@ -980,7 +998,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(() => {
+    React.useEffect(() => {
         const changedProps = Object.entries(propsToWatch || {}).reduce((result, [key, value]) => {
             if (prevPropsRef.current && prevPropsRef.current[key] !== value) {
                 result[key + ""] = [prevPropsRef.current[key], value];
@@ -1032,8 +1050,8 @@ const Debugger = ({ id, logPropsChanges, stop, children, }) => {
         new Error().stack?.split("\n")[2]?.trim() ||
         "unknown-id";
     useDebugger(logPropsChanges || {}, id);
-    const uniqueIdRef = react.useRef(uniqueId);
-    react.useEffect(() => {
+    const uniqueIdRef = React.useRef(uniqueId);
+    React.useEffect(() => {
         const currentUniqueId = uniqueIdRef.current;
         // eslint-disable-next-line no-console
         console.log(`${currentUniqueId} Debugger is mounting`);

package/index.esm.js

@@ -1,6 +1,6 @@
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
 import { act, render } from '@testing-library/react';
-import { ErrorHandlingContextProvider, CurrentUserProvider, AnalyticsContext, UserSubscriptionProvider, OemBrandingContextProvider, TokenProvider, ToastProvider, ConfirmationDialogProvider, FilterBarProvider, AssetSortingProvider, NavigationContextProvider, CurrentUserPreferenceProvider, EnvironmentContextProvider, ModalDialogContextProvider } from '@trackunit/react-core-hooks';
+import { ErrorHandlingContextProvider, CurrentUserProvider, AnalyticsContext, UserSubscriptionProvider, OemBrandingContextProvider, TokenProvider, ToastProvider, ConfirmationDialogProvider, FilterBarProvider, AssetSortingProvider, NavigationContextProvider, CurrentUserPreferenceProvider, EnvironmentContextProvider, ModalDialogContextProvider, TimeRangeProvider } from '@trackunit/react-core-hooks';
 import omit from 'lodash/omit';
 import { ApolloLink } from '@apollo/client';
 import { loadDevMessages, loadErrorMessages } from '@apollo/client/dev';
@@ -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 { createContext, useState, useEffect, useContext, Children, isValidElement, createElement, useRef, useCallback, useMemo } from 'react';
+import React, { 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';
@@ -202,6 +202,13 @@ const mockOemBrandingContext = {
     getOemImage: doNothing,
 };
 
+const mockTimeRangeContext = {
+    timeRange: {
+        startMsInEpoch: 1,
+        endMsInEpoch: 2,
+    },
+};
+
 const mockToastContext = {
     addToast: doNothing,
     setIsManifestError: doNothing,
@@ -455,6 +462,7 @@ class TrackunitProvidersMockBuilder {
     constructor() {
         this.selectedEnvironmentContext = mockEnvironmentContext;
         this.selectedModalDialogContext = mockModalDialogContext;
+        this.selectedTimeRangeContext = mockTimeRangeContext;
         this.selectedNavigationContext = mockNavigationContext;
         this.selectedTokenContext = { token: "fakeToken" };
         this.selectedApolloMocks = [];
@@ -532,6 +540,16 @@ class TrackunitProvidersMockBuilder {
         this.selectedEnvironmentContext = { ...mockEnvironmentContext, ...environmentContext };
         return this;
     }
+    /**
+     * Use this Time Range Context, used for myhome.
+     * Defaults to mockTimeRangeContext.
+     *
+     * @see mockTimeRangeContext
+     */
+    timeRange(timeRangeContext) {
+        this.selectedTimeRangeContext = { ...mockTimeRangeContext, ...timeRangeContext };
+        return this;
+    }
     /**
      * Use this Navigation Context.
      * Defaults to mockNavigationContext.
@@ -868,7 +886,7 @@ class TrackunitProvidersMockBuilder {
      * @param testChildren - the child element being tested.
      */
     getMockedCompositionRoot(testChildren) {
-        return (jsx(ErrorHandlingContextProvider, { value: this.selectedErrorHandler, children: jsx(CurrentUserProvider, { value: this.selectedCurrentUserContext, children: jsx(AnalyticsContext.Provider, { value: this.selectedAnalyticsContext, children: jsx(UserSubscriptionProvider, { value: this.selectedUserSubscriptionContext, children: jsx(OemBrandingContextProvider, { value: this.selectedOemBrandingContext, children: jsx(TokenProvider, { value: this.selectedTokenContext, children: jsx(ToastProvider, { value: this.selectedToastContext, children: jsx(ConfirmationDialogProvider, { value: this.selectedConfirmationDialogContext, children: jsx(FilterBarProvider, { value: this.selectedFilterBarValues, children: jsx(AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsx(ApolloMockedProviderWithError, { addTypename: false, mocks: this.selectedApolloMocks, children: jsx(NavigationContextProvider, { value: this.selectedNavigationContext, children: jsx(CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: jsx(EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsx(ModalDialogContextProvider, { value: this.selectedModalDialogContext, children: testChildren }) }) }) }) }) }) }) }) }) }) }) }) }) }) }));
+        return (jsx(ErrorHandlingContextProvider, { value: this.selectedErrorHandler, children: jsx(CurrentUserProvider, { value: this.selectedCurrentUserContext, children: jsx(AnalyticsContext.Provider, { value: this.selectedAnalyticsContext, children: jsx(UserSubscriptionProvider, { value: this.selectedUserSubscriptionContext, children: jsx(OemBrandingContextProvider, { value: this.selectedOemBrandingContext, children: jsx(TokenProvider, { value: this.selectedTokenContext, children: jsx(ToastProvider, { value: this.selectedToastContext, children: jsx(ConfirmationDialogProvider, { value: this.selectedConfirmationDialogContext, children: jsx(FilterBarProvider, { value: this.selectedFilterBarValues, children: jsx(AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsx(ApolloMockedProviderWithError, { addTypename: false, mocks: this.selectedApolloMocks, children: jsx(NavigationContextProvider, { value: this.selectedNavigationContext, children: jsx(CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: jsx(EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsx(ModalDialogContextProvider, { value: this.selectedModalDialogContext, children: jsx(TimeRangeProvider, { value: this.selectedTimeRangeContext, children: testChildren }) }) }) }) }) }) }) }) }) }) }) }) }) }) }) }));
     }
     getMockedCompositionRootWithRouter(testChildren) {
         const childrenWithRouter = (jsx(RouterContainer, { addTestRootContainer: true, rootRoute: this.selectedRootRoute, selectedRouterProps: this.selectedRouterProps, children: testChildren }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "1.3.70",
+  "version": "1.3.73",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -13,9 +13,9 @@
     "lodash": "4.17.21",
     "graphql": "^16.10.0",
     "@tanstack/react-router": "1.47.1",
-    "@trackunit/react-core-contexts-api": "1.4.68",
-    "@trackunit/react-core-hooks": "1.3.70",
-    "@trackunit/shared-utils": "1.5.67"
+    "@trackunit/react-core-contexts-api": "1.4.70",
+    "@trackunit/react-core-hooks": "1.3.72",
+    "@trackunit/shared-utils": "1.5.68"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -1,7 +1,7 @@
 import { MockedResponse } from "@apollo/client/testing";
 import { AnyRoute } from "@tanstack/react-router";
 import { RenderResult } from "@testing-library/react";
-import { AssetSortingContextValue, ConfirmationDialogContextValue, CurrentUserContextInterface, ErrorHandlingContextValue, FilterBarContext, IAnalyticsContext, IEnvironmentContext, INavigationContext, IToastContext, ITokenContext, IUserPreferencesContext, IUserSubscriptionContext, ModalDialogContextValue, OemBrandingContext } from "@trackunit/react-core-contexts-api";
+import { AssetSortingContextValue, ConfirmationDialogContextValue, CurrentUserContextInterface, ErrorHandlingContextValue, FilterBarContext, IAnalyticsContext, IEnvironmentContext, INavigationContext, IToastContext, ITokenContext, IUserPreferencesContext, IUserSubscriptionContext, ModalDialogContextValue, OemBrandingContext, TimeRangeContext } from "@trackunit/react-core-contexts-api";
 import { ReactElement, ReactNode } from "react";
 import { MemoryRouterProps } from "./utils/routingUtils";
 /**
@@ -16,6 +16,7 @@ import { MemoryRouterProps } from "./utils/routingUtils";
 export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
     protected selectedEnvironmentContext: IEnvironmentContext;
     protected selectedModalDialogContext: ModalDialogContextValue;
+    protected selectedTimeRangeContext: TimeRangeContext;
     protected selectedNavigationContext: INavigationContext;
     protected selectedTokenContext: ITokenContext;
     protected selectedApolloMocks: MockedResponse[];
@@ -81,6 +82,13 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
      * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
     environment(environmentContext: Partial<IEnvironmentContext>): this;
+    /**
+     * Use this Time Range Context, used for myhome.
+     * Defaults to mockTimeRangeContext.
+     *
+     * @see mockTimeRangeContext
+     */
+    timeRange(timeRangeContext: Partial<TimeRangeContext>): this;
     /**
      * Use this Navigation Context.
      * Defaults to mockNavigationContext.

package/src/mocks/mockTimeRangeContext.d.ts

@@ -0,0 +1,2 @@
+import { TimeRangeContext } from "@trackunit/react-core-contexts-api";
+export declare const mockTimeRangeContext: TimeRangeContext;