@trackunit/react-core-contexts-test 1.7.25 → 1.7.27

package/index.cjs.js

@@ -95,6 +95,18 @@ const mockEnvironmentContext = {
     reportAccessClientId: "",
 };
 
+/**
+ * This is a mock for the FilterBarContext.
+ *
+ * @returns { FilterBarContext }- mock for the FilterBarContext
+ */
+const mockFilterBarContext = {
+    assetsFilterBarValues: {},
+    customersFilterBarValues: {},
+    sitesFilterBarValues: {},
+    isLoading: false,
+};
+
 const mockOemBrandingContext = {
     getAllBrandingDetails: doNothing,
     getOemBranding: async () => null,
@@ -508,12 +520,7 @@ class TrackunitProvidersMockBuilder {
         this.selectedAnalyticsContext = mockAnalyticsContext;
         this.selectedOemBrandingContext = mockOemBrandingContext;
         this.selectedUserSubscriptionContext = mockUserSubscriptionContext;
-        this.selectedFilterBarValues = {
-            assetsFilterBarValues: {},
-            customersFilterBarValues: {},
-            sitesFilterBarValues: {},
-            isLoading: false,
-        };
+        this.selectedFilterBarValues = mockFilterBarContext;
     }
     /**
      * Use this Analytics Context.
@@ -974,6 +981,41 @@ class TrackunitProvidersMockBuilder {
         });
         return mountedcomponent;
     }
+    /**
+     * Test that a hook can handle rerenders with the same props and returns a stable result.
+     * This is useful for testing that hooks properly memoize their results.
+     * Returns true if the hook result is referentially stable after rerender.
+     * Uses Object.is() for comparison to match Jest's toBe() behavior exactly.
+     *
+     * **Requirements:**
+     * - The hook must return a non-null, non-undefined value
+     * - If the hook returns null or undefined, the test will throw an error
+     * - This ensures the test is actually verifying stability of a meaningful result
+     *
+     * @example
+     * ```ts
+     * expect(await trackunitProviders().verifyHookStability(() =>
+     *   useAssetMetadataChartData({
+     *     filters: {},
+     *     selectedChartOption: "metadataCompleteness",
+     *   })
+     * )).toBe(true);
+     * ```
+     * @param callback - The hook to test
+     * @param parentElement - Optional parent element wrapper
+     * @throws Error if the hook result is undefined or null (to ensure meaningful stability testing)
+     * @returns true if the result is referentially stable after rerender (using Object.is()), false otherwise
+     */
+    async verifyHookStability(callback, parentElement) {
+        const { result, rerender } = await this.renderHook(callback, parentElement);
+        const initial = result.current;
+        await rerender();
+        const updated = result.current;
+        if (updated === undefined || updated === null) {
+            throw new Error("Updated result is undefined or null, so the test is not testing anything");
+        }
+        return Object.is(updated, initial);
+    }
     /**
      *  This will return the children in the correct mocked hierarchy of context providers.
      */
@@ -1266,6 +1308,7 @@ exports.mockAnalyticsContext = mockAnalyticsContext;
 exports.mockAssetSortingContext = mockAssetSortingContext;
 exports.mockCurrentUserContext = mockCurrentUserContext;
 exports.mockEnvironmentContext = mockEnvironmentContext;
+exports.mockFilterBarContext = mockFilterBarContext;
 exports.mockOemBrandingContext = mockOemBrandingContext;
 exports.mockToastContext = mockToastContext;
 exports.mockUserSubscriptionContext = mockUserSubscriptionContext;

package/index.esm.js

@@ -93,6 +93,18 @@ const mockEnvironmentContext = {
     reportAccessClientId: "",
 };
 
+/**
+ * This is a mock for the FilterBarContext.
+ *
+ * @returns { FilterBarContext }- mock for the FilterBarContext
+ */
+const mockFilterBarContext = {
+    assetsFilterBarValues: {},
+    customersFilterBarValues: {},
+    sitesFilterBarValues: {},
+    isLoading: false,
+};
+
 const mockOemBrandingContext = {
     getAllBrandingDetails: doNothing,
     getOemBranding: async () => null,
@@ -506,12 +518,7 @@ class TrackunitProvidersMockBuilder {
         this.selectedAnalyticsContext = mockAnalyticsContext;
         this.selectedOemBrandingContext = mockOemBrandingContext;
         this.selectedUserSubscriptionContext = mockUserSubscriptionContext;
-        this.selectedFilterBarValues = {
-            assetsFilterBarValues: {},
-            customersFilterBarValues: {},
-            sitesFilterBarValues: {},
-            isLoading: false,
-        };
+        this.selectedFilterBarValues = mockFilterBarContext;
     }
     /**
      * Use this Analytics Context.
@@ -972,6 +979,41 @@ class TrackunitProvidersMockBuilder {
         });
         return mountedcomponent;
     }
+    /**
+     * Test that a hook can handle rerenders with the same props and returns a stable result.
+     * This is useful for testing that hooks properly memoize their results.
+     * Returns true if the hook result is referentially stable after rerender.
+     * Uses Object.is() for comparison to match Jest's toBe() behavior exactly.
+     *
+     * **Requirements:**
+     * - The hook must return a non-null, non-undefined value
+     * - If the hook returns null or undefined, the test will throw an error
+     * - This ensures the test is actually verifying stability of a meaningful result
+     *
+     * @example
+     * ```ts
+     * expect(await trackunitProviders().verifyHookStability(() =>
+     *   useAssetMetadataChartData({
+     *     filters: {},
+     *     selectedChartOption: "metadataCompleteness",
+     *   })
+     * )).toBe(true);
+     * ```
+     * @param callback - The hook to test
+     * @param parentElement - Optional parent element wrapper
+     * @throws Error if the hook result is undefined or null (to ensure meaningful stability testing)
+     * @returns true if the result is referentially stable after rerender (using Object.is()), false otherwise
+     */
+    async verifyHookStability(callback, parentElement) {
+        const { result, rerender } = await this.renderHook(callback, parentElement);
+        const initial = result.current;
+        await rerender();
+        const updated = result.current;
+        if (updated === undefined || updated === null) {
+            throw new Error("Updated result is undefined or null, so the test is not testing anything");
+        }
+        return Object.is(updated, initial);
+    }
     /**
      *  This will return the children in the correct mocked hierarchy of context providers.
      */
@@ -1255,4 +1297,4 @@ const validateIrisApp = async (irisApp) => {
     return null;
 };
 
-export { Debugger, TrackunitProvidersMockBuilder, doNothing, flushPromises, flushPromisesInAct, mockAnalyticsContext, mockAssetSortingContext, mockCurrentUserContext, mockEnvironmentContext, mockOemBrandingContext, mockToastContext, mockUserSubscriptionContext, queryFor, queryForHook, trackunitProviders, useDebugger, validateIrisApp };
+export { Debugger, TrackunitProvidersMockBuilder, doNothing, flushPromises, flushPromisesInAct, mockAnalyticsContext, mockAssetSortingContext, mockCurrentUserContext, mockEnvironmentContext, mockFilterBarContext, mockOemBrandingContext, mockToastContext, mockUserSubscriptionContext, queryFor, queryForHook, trackunitProviders, useDebugger, validateIrisApp };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "1.7.25",
+  "version": "1.7.27",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -11,10 +11,10 @@
     "@testing-library/react": "16.2.0",
     "react": "19.0.0",
     "graphql": "^16.10.0",
-    "@trackunit/react-core-contexts-api": "1.8.24",
-    "@trackunit/react-core-hooks": "1.7.25",
-    "@trackunit/shared-utils": "1.9.22",
-    "@trackunit/react-test-setup": "1.4.22",
+    "@trackunit/react-core-contexts-api": "1.8.25",
+    "@trackunit/react-core-hooks": "1.7.27",
+    "@trackunit/shared-utils": "1.9.23",
+    "@trackunit/react-test-setup": "1.4.23",
     "@tanstack/react-router": "1.114.29",
     "@tanstack/router-core": "1.114.29",
     "es-toolkit": "^1.39.10"

package/src/TrackunitProvidersMockBuilder.d.ts

@@ -392,6 +392,32 @@ export declare class TrackunitProvidersMockBuilder<T extends AnyRoute> {
      * @param child - the child element being tested.
      */
     render(child: ReactElement): Promise<RenderResult>;
+    /**
+     * Test that a hook can handle rerenders with the same props and returns a stable result.
+     * This is useful for testing that hooks properly memoize their results.
+     * Returns true if the hook result is referentially stable after rerender.
+     * Uses Object.is() for comparison to match Jest's toBe() behavior exactly.
+     *
+     * **Requirements:**
+     * - The hook must return a non-null, non-undefined value
+     * - If the hook returns null or undefined, the test will throw an error
+     * - This ensures the test is actually verifying stability of a meaningful result
+     *
+     * @example
+     * ```ts
+     * expect(await trackunitProviders().verifyHookStability(() =>
+     *   useAssetMetadataChartData({
+     *     filters: {},
+     *     selectedChartOption: "metadataCompleteness",
+     *   })
+     * )).toBe(true);
+     * ```
+     * @param callback - The hook to test
+     * @param parentElement - Optional parent element wrapper
+     * @throws Error if the hook result is undefined or null (to ensure meaningful stability testing)
+     * @returns true if the result is referentially stable after rerender (using Object.is()), false otherwise
+     */
+    verifyHookStability<TProps, TResult>(callback: (props: TProps) => TResult, parentElement?: (children: ReactNode) => ReactElement): Promise<boolean>;
     /**
      *  This will return the children in the correct mocked hierarchy of context providers.
      */

package/src/index.d.ts

@@ -2,6 +2,7 @@ export * from "./mocks/mockAnalyticsContext";
 export * from "./mocks/mockAssetSortingContext";
 export * from "./mocks/mockCurrentUserContext";
 export * from "./mocks/mockEnvironmentContext";
+export * from "./mocks/mockFilterBarContext";
 export * from "./mocks/mockOemBrandingContext";
 export * from "./mocks/mockToastContext";
 export * from "./mocks/mockUserSubscriptionContext";

package/src/mocks/mockFilterBarContext.d.ts

@@ -0,0 +1,7 @@
+import { FilterBarContext } from "@trackunit/react-core-contexts-api";
+/**
+ * This is a mock for the FilterBarContext.
+ *
+ * @returns { FilterBarContext }- mock for the FilterBarContext
+ */
+export declare const mockFilterBarContext: FilterBarContext;