@trackunit/react-core-contexts-test 0.1.125 → 0.1.126

package/index.cjs2.js

@@ -43382,6 +43382,21 @@ const mockEnvironmentContext = {
     hubspotRequestAppAccessFormId: "",
 };
 
+const mockNavigationContext = {
+    gotoAssetHome: (assetId, options) => {
+        return Promise.resolve(true);
+    },
+    gotoSiteHome: (siteId, options) => {
+        return Promise.resolve(true);
+    },
+    gotoAppLibrary: (irisAppId) => {
+        return Promise.resolve(true);
+    },
+    gotoFleetApp: (options) => {
+        return Promise.resolve(true);
+    },
+};
+
 const mockOemBrandingContext = {
     getAllBrandingDetails: doNothing,
     getOemBranding: doNothing,
@@ -43458,6 +43473,7 @@ const flushPromisesInAct = (waitTimeInMS = 0) => {
 class TrackunitProvidersMockBuilder {
     constructor() {
         this.selectedEnvironmentContext = mockEnvironmentContext;
+        this.selectedNavigationContext = mockNavigationContext;
         this.selectedTokenContext = { token: "fakeToken" };
         this.selectedApolloMocks = [];
         this.selectedRouterProps = {};
@@ -43528,6 +43544,22 @@ class TrackunitProvidersMockBuilder {
         this.selectedEnvironmentContext = Object.assign(Object.assign({}, mockEnvironmentContext), environmentContext);
         return this;
     }
+    /**
+     * Use this Navigation Context.
+     * Defaults to mockNavigationContext.
+     *
+     * @see mockNavigationContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().navigation(yourPartialNavigationMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     */
+    navigation(navigationContext) {
+        this.selectedNavigationContext = Object.assign(Object.assign({}, mockNavigationContext), navigationContext);
+        return this;
+    }
     /**
      * Use this to pass in a differerent current user.
      * Defaults to mockCurrentUserContext.
@@ -43845,10 +43877,10 @@ class TrackunitProvidersMockBuilder {
      * @param addTestRootContainer - if you want to add a root container to the test.
      */
     getMockedCompositionRoot(testChildren, addTestRootContainer = true) {
-        return (jsxRuntime.jsx(reactCoreHooks.EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsxRuntime.jsx(reactRouterDom.MemoryRouter, Object.assign({}, this.selectedRouterProps, { 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.GlobalSelectionProvider, { value: this.selectedGlobalSelection, children: jsxRuntime.jsx(reactCoreHooks.FilterBarProvider, { value: { filterBarValues: this.selectedFilterBarValues }, children: jsxRuntime.jsx(reactCoreHooks.AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsxRuntime.jsx(ApolloMockedProviderWithError, { mocks: this.selectedApolloMocks, addTypename: false, children: jsxRuntime.jsx(reactCoreHooks.CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: addTestRootContainer ? (jsxRuntime.jsx("div", { style: {
-                                                                    "--tw-scale-x": "0.99",
-                                                                    "--tw-scale-y": "0.99",
-                                                                }, className: "inline-block h-[1000px] w-[1024px]", "data-testid": "testRoot", children: testChildren })) : (jsxRuntime.jsx("div", { children: testChildren })) }) }) }) }) }) }) }) }) }) }) }) })) }));
+        return (jsxRuntime.jsx(reactCoreHooks.EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsxRuntime.jsx(reactRouterDom.MemoryRouter, Object.assign({}, this.selectedRouterProps, { 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.GlobalSelectionProvider, { value: this.selectedGlobalSelection, children: jsxRuntime.jsx(reactCoreHooks.FilterBarProvider, { value: { filterBarValues: this.selectedFilterBarValues }, children: jsxRuntime.jsx(reactCoreHooks.AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsxRuntime.jsx(ApolloMockedProviderWithError, { mocks: this.selectedApolloMocks, addTypename: false, children: jsxRuntime.jsx(reactCoreHooks.NavigationContextProvider, { value: this.selectedNavigationContext, children: jsxRuntime.jsx(reactCoreHooks.CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: addTestRootContainer ? (jsxRuntime.jsx("div", { style: {
+                                                                        "--tw-scale-x": "0.99",
+                                                                        "--tw-scale-y": "0.99",
+                                                                    }, className: "inline-block h-[1000px] w-[1024px]", "data-testid": "testRoot", children: testChildren })) : (jsxRuntime.jsx("div", { children: testChildren })) }) }) }) }) }) }) }) }) }) }) }) }) })) }));
     }
     /**
      * This will return the mocked composition root.

package/index.esm2.js

@@ -5,7 +5,7 @@ import React__default, { useRef, useMemo, useEffect } from 'react';
 import ReactDOM from 'react-dom';
 import * as ReactDOMClient from 'react-dom/client';
 import require$$0 from 'util';
-import { EnvironmentContextProvider, CurrentUserProvider, AnalyticsContext, UserSubscriptionProvider, OemBrandingContextProvider, TokenProvider, ToastProvider, GlobalSelectionProvider, FilterBarProvider, AssetSortingProvider, CurrentUserPreferenceProvider } from '@trackunit/react-core-hooks';
+import { EnvironmentContextProvider, CurrentUserProvider, AnalyticsContext, UserSubscriptionProvider, OemBrandingContextProvider, TokenProvider, ToastProvider, GlobalSelectionProvider, FilterBarProvider, AssetSortingProvider, NavigationContextProvider, CurrentUserPreferenceProvider } from '@trackunit/react-core-hooks';
 import { MemoryRouter } from 'react-router-dom';
 import { AssetSortByProperty, SortOrder } from '@trackunit/react-core-contexts-api';
 
@@ -43354,6 +43354,21 @@ const mockEnvironmentContext = {
     hubspotRequestAppAccessFormId: "",
 };
 
+const mockNavigationContext = {
+    gotoAssetHome: (assetId, options) => {
+        return Promise.resolve(true);
+    },
+    gotoSiteHome: (siteId, options) => {
+        return Promise.resolve(true);
+    },
+    gotoAppLibrary: (irisAppId) => {
+        return Promise.resolve(true);
+    },
+    gotoFleetApp: (options) => {
+        return Promise.resolve(true);
+    },
+};
+
 const mockOemBrandingContext = {
     getAllBrandingDetails: doNothing,
     getOemBranding: doNothing,
@@ -43430,6 +43445,7 @@ const flushPromisesInAct = (waitTimeInMS = 0) => {
 class TrackunitProvidersMockBuilder {
     constructor() {
         this.selectedEnvironmentContext = mockEnvironmentContext;
+        this.selectedNavigationContext = mockNavigationContext;
         this.selectedTokenContext = { token: "fakeToken" };
         this.selectedApolloMocks = [];
         this.selectedRouterProps = {};
@@ -43500,6 +43516,22 @@ class TrackunitProvidersMockBuilder {
         this.selectedEnvironmentContext = Object.assign(Object.assign({}, mockEnvironmentContext), environmentContext);
         return this;
     }
+    /**
+     * Use this Navigation Context.
+     * Defaults to mockNavigationContext.
+     *
+     * @see mockNavigationContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().navigation(yourPartialNavigationMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     */
+    navigation(navigationContext) {
+        this.selectedNavigationContext = Object.assign(Object.assign({}, mockNavigationContext), navigationContext);
+        return this;
+    }
     /**
      * Use this to pass in a differerent current user.
      * Defaults to mockCurrentUserContext.
@@ -43817,10 +43849,10 @@ class TrackunitProvidersMockBuilder {
      * @param addTestRootContainer - if you want to add a root container to the test.
      */
     getMockedCompositionRoot(testChildren, addTestRootContainer = true) {
-        return (jsx(EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsx(MemoryRouter, Object.assign({}, this.selectedRouterProps, { 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(GlobalSelectionProvider, { value: this.selectedGlobalSelection, children: jsx(FilterBarProvider, { value: { filterBarValues: this.selectedFilterBarValues }, children: jsx(AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsx(ApolloMockedProviderWithError, { mocks: this.selectedApolloMocks, addTypename: false, children: jsx(CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: addTestRootContainer ? (jsx("div", { style: {
-                                                                    "--tw-scale-x": "0.99",
-                                                                    "--tw-scale-y": "0.99",
-                                                                }, className: "inline-block h-[1000px] w-[1024px]", "data-testid": "testRoot", children: testChildren })) : (jsx("div", { children: testChildren })) }) }) }) }) }) }) }) }) }) }) }) })) }));
+        return (jsx(EnvironmentContextProvider, { value: this.selectedEnvironmentContext, children: jsx(MemoryRouter, Object.assign({}, this.selectedRouterProps, { 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(GlobalSelectionProvider, { value: this.selectedGlobalSelection, children: jsx(FilterBarProvider, { value: { filterBarValues: this.selectedFilterBarValues }, children: jsx(AssetSortingProvider, { value: this.selectedAssetSortingContext, children: jsx(ApolloMockedProviderWithError, { mocks: this.selectedApolloMocks, addTypename: false, children: jsx(NavigationContextProvider, { value: this.selectedNavigationContext, children: jsx(CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: addTestRootContainer ? (jsx("div", { style: {
+                                                                        "--tw-scale-x": "0.99",
+                                                                        "--tw-scale-y": "0.99",
+                                                                    }, className: "inline-block h-[1000px] w-[1024px]", "data-testid": "testRoot", children: testChildren })) : (jsx("div", { children: testChildren })) }) }) }) }) }) }) }) }) }) }) }) }) })) }));
     }
     /**
      * This will return the mocked composition root.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.125",
+  "version": "0.1.126",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,8 +10,8 @@
   "main": "./index.cjs.js",
   "dependencies": {
     "@apollo/client": "3.7.10",
-    "@trackunit/react-core-contexts-api": "0.2.68",
-    "@trackunit/react-core-hooks": "0.2.110",
+    "@trackunit/react-core-contexts-api": "0.2.69",
+    "@trackunit/react-core-hooks": "0.2.111",
     "graphql": "15.8.0",
     "lodash": "4.17.21",
     "react": "18.2.0",

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -1,6 +1,6 @@
 import { MockedResponse } from "@apollo/client/testing";
 import { RenderResult } from "@testing-library/react";
-import { FilterBarValues, IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, IOemBrandingContext, IToastContext, ITokenContext, IUserPreferencesContext, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
+import { FilterBarValues, IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, INavigationContext, IOemBrandingContext, IToastContext, ITokenContext, IUserPreferencesContext, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
 import { MemoryRouterProps } from "react-router-dom";
 /**
@@ -14,6 +14,7 @@ import { MemoryRouterProps } from "react-router-dom";
  */
 export declare class TrackunitProvidersMockBuilder {
     protected selectedEnvironmentContext: IEnvironmentContext;
+    protected selectedNavigationContext: INavigationContext;
     protected selectedTokenContext: ITokenContext;
     protected selectedApolloMocks: MockedResponse[];
     protected selectedRouterProps: MemoryRouterProps;
@@ -76,6 +77,19 @@ export declare class TrackunitProvidersMockBuilder {
      * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
     environment(environmentContext: Partial<IEnvironmentContext>): this;
+    /**
+     * Use this Navigation Context.
+     * Defaults to mockNavigationContext.
+     *
+     * @see mockNavigationContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().navigation(yourPartialNavigationMock).render(<YourTestComponent data-testid="yourTestId" />);
+     *   expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     */
+    navigation(navigationContext: Partial<INavigationContext>): this;
     /**
      * Use this to pass in a differerent current user.
      * Defaults to mockCurrentUserContext.

package/src/mocks/mockNavigationContext.d.ts

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