@trackunit/react-core-contexts-test 0.1.110 → 0.1.111

package/index.cjs2.js

@@ -43479,6 +43479,20 @@ function ApolloMockedProviderWithError(props) {
     return (jsxRuntime.jsx(MockedProvider, Object.assign({}, otherProps, { link: link, defaultOptions: Object.assign(Object.assign({}, defaultOptions), { watchQuery: { fetchPolicy: "no-cache" } }) })));
 }
 
+/**
+ * Mocks the current user context
+ *
+ * @returns {IUserPreferencesContext} - Returns the mocked current user context
+ */
+const mockCurrentUserPreferenceContext = {
+    language: "en",
+    setLanguage: doNothing,
+    timeZonePreference: "LOCAL_TIME_ZONE",
+    setTimeZonePreference: doNothing,
+    systemOfMeasurement: "SI",
+    setSystemOfMeasurement: doNothing,
+};
+
 /**
  * Flushes all promises in the queue.
  * This is useful when testing async code.
@@ -43539,6 +43553,7 @@ class TrackunitProvidersMockBuilder {
         this.selectedGlobalSelection = { selection: null };
         this.selectedAssetSortingContext = mockAssetSortingContext;
         this.selectedCurrentUserContext = mockCurrentUserContext;
+        this.selectedCurrentUserPreferenceContext = mockCurrentUserPreferenceContext;
         this.selectedAnalyticsContext = mockAnalyticsContext;
         this.selectedOemBrandingContext = mockOemBrandingContext;
         this.selectedUserSubscriptionContext = mockUserSubscriptionContext;
@@ -43628,6 +43643,33 @@ class TrackunitProvidersMockBuilder {
         this.selectedCurrentUserContext = Object.assign(Object.assign({}, mockCurrentUserContext), currentUserContext);
         return this;
     }
+    /**
+     * Use this to pass in a differerent current user preference.
+     * Defaults to mockCurrentUserPreferenceContext.
+     *
+     * This context is used by the useCurrentUserPreference hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockCurrentUserPreferenceContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().currentUserPreference(yourPartialCurrentUserPreferenceMock).render(<YourTestComponent data-testid="yourTestId" />);
+     * expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     * const { result } = await trackunitProviders().currentUserPreference(yourPartialCurrentUserPreferenceMock).renderHook(() => useYourTestHook());
+     * expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    currentUserPreference(currentUserPreferenceContext) {
+        this.selectedCurrentUserPreferenceContext = Object.assign(Object.assign({}, mockCurrentUserPreferenceContext), currentUserPreferenceContext);
+        return this;
+    }
     /**
      * Use this to pass in a differerent filter bar values when working with pages with filterbar.
      * Defaults to { filterBarValues: {} }.
@@ -43891,10 +43933,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: addTestRootContainer ? (jsxRuntime.jsx("div", { style: {
-                                                                "--tw-scale-x": "0.99",
-                                                                "--tw-scale-y": "0.99",
-                                                            }, className: "w-[1024px] h-[1000px] inline-block", "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.CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: addTestRootContainer ? (jsxRuntime.jsx("div", { style: {
+                                                                    "--tw-scale-x": "0.99",
+                                                                    "--tw-scale-y": "0.99",
+                                                                }, className: "w-[1024px] h-[1000px] inline-block", "data-testid": "testRoot", children: testChildren })) : (jsxRuntime.jsx("div", { children: testChildren })) }) }) }) }) }) }) }) }) }) }) }) })) }));
     }
     /**
      * This will return the mocked composition root.

package/index.esm2.js

@@ -6,7 +6,7 @@ import * as testUtils from 'react-dom/test-utils';
 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 } from '@trackunit/react-core-hooks';
+import { EnvironmentContextProvider, CurrentUserProvider, AnalyticsContext, UserSubscriptionProvider, OemBrandingContextProvider, TokenProvider, ToastProvider, GlobalSelectionProvider, FilterBarProvider, AssetSortingProvider, CurrentUserPreferenceProvider } from '@trackunit/react-core-hooks';
 import { MemoryRouter } from 'react-router-dom';
 
 function _mergeNamespaces(n, m) {
@@ -43451,6 +43451,20 @@ function ApolloMockedProviderWithError(props) {
     return (jsx(MockedProvider, Object.assign({}, otherProps, { link: link, defaultOptions: Object.assign(Object.assign({}, defaultOptions), { watchQuery: { fetchPolicy: "no-cache" } }) })));
 }
 
+/**
+ * Mocks the current user context
+ *
+ * @returns {IUserPreferencesContext} - Returns the mocked current user context
+ */
+const mockCurrentUserPreferenceContext = {
+    language: "en",
+    setLanguage: doNothing,
+    timeZonePreference: "LOCAL_TIME_ZONE",
+    setTimeZonePreference: doNothing,
+    systemOfMeasurement: "SI",
+    setSystemOfMeasurement: doNothing,
+};
+
 /**
  * Flushes all promises in the queue.
  * This is useful when testing async code.
@@ -43511,6 +43525,7 @@ class TrackunitProvidersMockBuilder {
         this.selectedGlobalSelection = { selection: null };
         this.selectedAssetSortingContext = mockAssetSortingContext;
         this.selectedCurrentUserContext = mockCurrentUserContext;
+        this.selectedCurrentUserPreferenceContext = mockCurrentUserPreferenceContext;
         this.selectedAnalyticsContext = mockAnalyticsContext;
         this.selectedOemBrandingContext = mockOemBrandingContext;
         this.selectedUserSubscriptionContext = mockUserSubscriptionContext;
@@ -43600,6 +43615,33 @@ class TrackunitProvidersMockBuilder {
         this.selectedCurrentUserContext = Object.assign(Object.assign({}, mockCurrentUserContext), currentUserContext);
         return this;
     }
+    /**
+     * Use this to pass in a differerent current user preference.
+     * Defaults to mockCurrentUserPreferenceContext.
+     *
+     * This context is used by the useCurrentUserPreference hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockCurrentUserPreferenceContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().currentUserPreference(yourPartialCurrentUserPreferenceMock).render(<YourTestComponent data-testid="yourTestId" />);
+     * expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     * const { result } = await trackunitProviders().currentUserPreference(yourPartialCurrentUserPreferenceMock).renderHook(() => useYourTestHook());
+     * expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    currentUserPreference(currentUserPreferenceContext) {
+        this.selectedCurrentUserPreferenceContext = Object.assign(Object.assign({}, mockCurrentUserPreferenceContext), currentUserPreferenceContext);
+        return this;
+    }
     /**
      * Use this to pass in a differerent filter bar values when working with pages with filterbar.
      * Defaults to { filterBarValues: {} }.
@@ -43863,10 +43905,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: addTestRootContainer ? (jsx("div", { style: {
-                                                                "--tw-scale-x": "0.99",
-                                                                "--tw-scale-y": "0.99",
-                                                            }, className: "w-[1024px] h-[1000px] inline-block", "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(CurrentUserPreferenceProvider, { value: this.selectedCurrentUserPreferenceContext, children: addTestRootContainer ? (jsx("div", { style: {
+                                                                    "--tw-scale-x": "0.99",
+                                                                    "--tw-scale-y": "0.99",
+                                                                }, className: "w-[1024px] h-[1000px] inline-block", "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.110",
+  "version": "0.1.111",
   "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.58",
-    "@trackunit/react-core-hooks": "0.2.96",
+    "@trackunit/react-core-contexts-api": "0.2.59",
+    "@trackunit/react-core-hooks": "0.2.97",
     "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, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
+import { FilterBarValues, IAnalyticsContext, IAssetSortingContext, ICurrentUserContext, IEnvironmentContext, IGlobalSelectionContext, IOemBrandingContext, IToastContext, ITokenContext, IUserPreferencesContext, IUserSubscriptionContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
 import { MemoryRouterProps } from "react-router-dom";
 /**
@@ -21,6 +21,7 @@ export declare class TrackunitProvidersMockBuilder {
     protected selectedGlobalSelection: IGlobalSelectionContext;
     protected selectedAssetSortingContext: IAssetSortingContext;
     protected selectedCurrentUserContext: ICurrentUserContext;
+    protected selectedCurrentUserPreferenceContext: IUserPreferencesContext;
     protected selectedAnalyticsContext: IAnalyticsContext<{}>;
     protected selectedOemBrandingContext: IOemBrandingContext;
     protected selectedUserSubscriptionContext: IUserSubscriptionContext;
@@ -99,6 +100,30 @@ export declare class TrackunitProvidersMockBuilder {
      * @returns { TrackunitProvidersMockBuilder } - The builder.
      */
     currentUser(currentUserContext: Partial<ICurrentUserContext>): this;
+    /**
+     * Use this to pass in a differerent current user preference.
+     * Defaults to mockCurrentUserPreferenceContext.
+     *
+     * This context is used by the useCurrentUserPreference hook from lib "@trackunit/react-core-hooks"
+     *
+     * @see mockCurrentUserPreferenceContext
+     * @example
+     * ...
+     * it("should allow render", async () => {
+     *   await trackunitProviders().currentUserPreference(yourPartialCurrentUserPreferenceMock).render(<YourTestComponent data-testid="yourTestId" />);
+     * expect(screen.getByTestId("yourTestId")).toBeInTheDocument();
+     * });
+     * ...
+     * @example
+     * ...
+     * it("should allow renderHook", async () => {
+     * const { result } = await trackunitProviders().currentUserPreference(yourPartialCurrentUserPreferenceMock).renderHook(() => useYourTestHook());
+     * expect(result.current).toEqual(anything());
+     * });
+     * ...
+     * @returns { TrackunitProvidersMockBuilder } - The builder.
+     */
+    currentUserPreference(currentUserPreferenceContext: Partial<IUserPreferencesContext>): this;
     /**
      * Use this to pass in a differerent filter bar values when working with pages with filterbar.
      * Defaults to { filterBarValues: {} }.

package/src/mocks/mockCurrentUserPreferenceContext.d.ts

@@ -0,0 +1,7 @@
+import { IUserPreferencesContext } from "@trackunit/react-core-contexts-api";
+/**
+ * Mocks the current user context
+ *
+ * @returns {IUserPreferencesContext} - Returns the mocked current user context
+ */
+export declare const mockCurrentUserPreferenceContext: IUserPreferencesContext;