@trackunit/react-core-contexts-test 0.1.232 → 0.1.235

package/index.cjs.js

@@ -37,3 +37,4 @@ exports.trackunitProviders = index.trackunitProviders;
 exports.useDebugger = index.useDebugger;
 exports.useIsFirstRender = index.useIsFirstRender;
 exports.validateIrisApp = index.validateIrisApp;
+exports.waitForRenderTanstackRouterQuirk = index.waitForRenderTanstackRouterQuirk;

package/index.cjs2.js

@@ -180,7 +180,7 @@ const mockEnvironmentContext = {
     buildDate: "",
     irisAppSdkServerUrl: "",
     publicUrl: "",
-    isDev: true,
+    isFeatureBranch: false,
     environment: "dev",
     sentryDsn: "",
     sessionId: "",
@@ -348,7 +348,11 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                             route.options.component = entry.component;
                         }
                         else {
-                            route.options.component = () => (jsxRuntime.jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() }));
+                            route.update({
+                                component: () => {
+                                    return (jsxRuntime.jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() }));
+                                },
+                            });
                         }
                     }
                 });
@@ -362,7 +366,9 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                     const childRoute = reactRouter.createRoute({
                         path: "/",
                         getParentRoute: () => localRootRoute,
-                        component: () => (jsxRuntime.jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() })),
+                        component: () => {
+                            return (jsxRuntime.jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() }));
+                        },
                     });
                     localRootRoute.addChildren([childRoute]);
                 }
@@ -390,7 +396,7 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
     }, [rootRoute]);
     const context = React.useMemo(() => (Object.assign({ hasAccessTo: () => __awaiter(void 0, void 0, void 0, function* () { return true; }), isAuthenticated: true, client, defaultUserRoute: "/" }, ((selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context) || {}))), [client, selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context]);
     const ErrorComponent = ({ error }) => {
-        return jsxRuntime.jsxs(jsxRuntime.Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error && error instanceof Error ? error.message : error] });
+        return jsxRuntime.jsxs(jsxRuntime.Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error instanceof Error ? error.message : error] });
     };
     return jsxRuntime.jsx(reactRouter.RouterProvider, { context: context, defaultErrorComponent: ErrorComponent, router: router });
 };
@@ -435,6 +441,18 @@ const flushPromisesInAct = (waitTimeInMS = 0) => {
         });
     });
 };
+/**
+ * This is a temp hack to work around a Tanstack Router quirk.
+ * This will wait for the render to finish before resolving the promise.
+ *
+ * @param rerender - The rerender function.
+ */
+const waitForRenderTanstackRouterQuirk = (rerender) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield react$1.act(() => __awaiter(void 0, void 0, void 0, function* () {
+        rerender();
+        yield flushPromises();
+    }));
+});
 
 /**
  * This builder allows you to enable trackunit providers using the builder pattern, and then call 1 of either:
@@ -923,7 +941,8 @@ const useDebugger = (propsToWatch, id) => {
     const prevPropsRef = React.useRef(propsToWatch);
     const uniqueId = React.useMemo(() => {
         var _a;
-        let stackId = id;
+        // eslint-disable-next-line local-rules/no-typescript-assertion
+        let stackId = id || (propsToWatch && propsToWatch.id);
         const stack = new Error().stack;
         if (!stackId && stack) {
             const stackLines = stack.split("\n");
@@ -936,7 +955,7 @@ const useDebugger = (propsToWatch, id) => {
             }
         }
         return stackId || "unknown-id";
-    }, [id]);
+    }, [id, propsToWatch]);
     const isFirstRender = useIsFirstRender();
     // eslint-disable-next-line no-console
     console.log(isFirstRender ? "First-render" : "Re-render", uniqueId, window.location.pathname);
@@ -996,8 +1015,6 @@ const Debugger = ({ id, logPropsChanges, stop, children, }) => {
         ((_g = (_f = new Error().stack) === null || _f === void 0 ? void 0 : _f.split("\n")[2]) === null || _g === void 0 ? void 0 : _g.trim()) ||
         "unknown-id";
     useDebugger(logPropsChanges || {}, id);
-    // eslint-disable-next-line no-console
-    console.log(`${uniqueId} Debugger is rendering`);
     React.useEffect(() => {
         // eslint-disable-next-line no-console
         console.log(`${uniqueId} Debugger is mounting`);
@@ -1168,3 +1185,4 @@ exports.trackunitProviders = trackunitProviders;
 exports.useDebugger = useDebugger;
 exports.useIsFirstRender = useIsFirstRender;
 exports.validateIrisApp = validateIrisApp;
+exports.waitForRenderTanstackRouterQuirk = waitForRenderTanstackRouterQuirk;

package/index.esm.js

@@ -1,4 +1,4 @@
-export { D as Debugger, T as TrackunitProvidersMockBuilder, i as doNothing, f as flushPromises, k as flushPromisesInAct, m as mockAnalyticsContext, b as mockAssetSortingContext, c as mockCurrentUserContext, d as mockEnvironmentContext, e as mockOemBrandingContext, g as mockToastContext, h as mockUserSubscriptionContext, q as queryFor, j as queryForHook, t as trackunitProviders, a as useDebugger, u as useIsFirstRender, v as validateIrisApp } from './index.esm2.js';
+export { D as Debugger, T as TrackunitProvidersMockBuilder, i as doNothing, f as flushPromises, k as flushPromisesInAct, m as mockAnalyticsContext, b as mockAssetSortingContext, c as mockCurrentUserContext, d as mockEnvironmentContext, e as mockOemBrandingContext, g as mockToastContext, h as mockUserSubscriptionContext, q as queryFor, j as queryForHook, t as trackunitProviders, a as useDebugger, u as useIsFirstRender, v as validateIrisApp, w as waitForRenderTanstackRouterQuirk } from './index.esm2.js';
 import 'react/jsx-runtime';
 import '@testing-library/react';
 import '@trackunit/react-core-hooks';

package/index.esm2.js

@@ -173,7 +173,7 @@ const mockEnvironmentContext = {
     buildDate: "",
     irisAppSdkServerUrl: "",
     publicUrl: "",
-    isDev: true,
+    isFeatureBranch: false,
     environment: "dev",
     sentryDsn: "",
     sessionId: "",
@@ -341,7 +341,11 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                             route.options.component = entry.component;
                         }
                         else {
-                            route.options.component = () => (jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() }));
+                            route.update({
+                                component: () => {
+                                    return (jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() }));
+                                },
+                            });
                         }
                     }
                 });
@@ -355,7 +359,9 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
                     const childRoute = createRoute({
                         path: "/",
                         getParentRoute: () => localRootRoute,
-                        component: () => (jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() })),
+                        component: () => {
+                            return (jsx(TestRenderChildren, { addTestRootContainer: addTestRootContainer, children: getChildren() }));
+                        },
                     });
                     localRootRoute.addChildren([childRoute]);
                 }
@@ -383,7 +389,7 @@ const RouterContainer = ({ addTestRootContainer, selectedRouterProps, rootRoute,
     }, [rootRoute]);
     const context = useMemo(() => (Object.assign({ hasAccessTo: () => __awaiter(void 0, void 0, void 0, function* () { return true; }), isAuthenticated: true, client, defaultUserRoute: "/" }, ((selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context) || {}))), [client, selectedRouterProps === null || selectedRouterProps === void 0 ? void 0 : selectedRouterProps.context]);
     const ErrorComponent = ({ error }) => {
-        return jsxs(Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error && error instanceof Error ? error.message : error] });
+        return jsxs(Fragment, { children: ["UNCAUGHT ERROR IN TEST: ", error instanceof Error ? error.message : error] });
     };
     return jsx(RouterProvider, { context: context, defaultErrorComponent: ErrorComponent, router: router });
 };
@@ -428,6 +434,18 @@ const flushPromisesInAct = (waitTimeInMS = 0) => {
         });
     });
 };
+/**
+ * This is a temp hack to work around a Tanstack Router quirk.
+ * This will wait for the render to finish before resolving the promise.
+ *
+ * @param rerender - The rerender function.
+ */
+const waitForRenderTanstackRouterQuirk = (rerender) => __awaiter(void 0, void 0, void 0, function* () {
+    return yield act(() => __awaiter(void 0, void 0, void 0, function* () {
+        rerender();
+        yield flushPromises();
+    }));
+});
 
 /**
  * This builder allows you to enable trackunit providers using the builder pattern, and then call 1 of either:
@@ -916,7 +934,8 @@ const useDebugger = (propsToWatch, id) => {
     const prevPropsRef = useRef(propsToWatch);
     const uniqueId = useMemo(() => {
         var _a;
-        let stackId = id;
+        // eslint-disable-next-line local-rules/no-typescript-assertion
+        let stackId = id || (propsToWatch && propsToWatch.id);
         const stack = new Error().stack;
         if (!stackId && stack) {
             const stackLines = stack.split("\n");
@@ -929,7 +948,7 @@ const useDebugger = (propsToWatch, id) => {
             }
         }
         return stackId || "unknown-id";
-    }, [id]);
+    }, [id, propsToWatch]);
     const isFirstRender = useIsFirstRender();
     // eslint-disable-next-line no-console
     console.log(isFirstRender ? "First-render" : "Re-render", uniqueId, window.location.pathname);
@@ -989,8 +1008,6 @@ const Debugger = ({ id, logPropsChanges, stop, children, }) => {
         ((_g = (_f = new Error().stack) === null || _f === void 0 ? void 0 : _f.split("\n")[2]) === null || _g === void 0 ? void 0 : _g.trim()) ||
         "unknown-id";
     useDebugger(logPropsChanges || {}, id);
-    // eslint-disable-next-line no-console
-    console.log(`${uniqueId} Debugger is rendering`);
     useEffect(() => {
         // eslint-disable-next-line no-console
         console.log(`${uniqueId} Debugger is mounting`);
@@ -1142,4 +1159,4 @@ const validateIrisApp = (irisApp) => __awaiter(void 0, void 0, void 0, function*
     return null;
 });
 
-export { Debugger as D, TrackunitProvidersMockBuilder as T, __awaiter as _, useDebugger as a, mockAssetSortingContext as b, mockCurrentUserContext as c, mockEnvironmentContext as d, mockOemBrandingContext as e, flushPromises as f, mockToastContext as g, mockUserSubscriptionContext as h, doNothing as i, queryForHook as j, flushPromisesInAct as k, mockAnalyticsContext as m, queryFor as q, trackunitProviders as t, useIsFirstRender as u, validateIrisApp as v };
+export { Debugger as D, TrackunitProvidersMockBuilder as T, __awaiter as _, useDebugger as a, mockAssetSortingContext as b, mockCurrentUserContext as c, mockEnvironmentContext as d, mockOemBrandingContext as e, flushPromises as f, mockToastContext as g, mockUserSubscriptionContext as h, doNothing as i, queryForHook as j, flushPromisesInAct as k, mockAnalyticsContext as m, queryFor as q, trackunitProviders as t, useIsFirstRender as u, validateIrisApp as v, waitForRenderTanstackRouterQuirk as w };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-contexts-test",
-  "version": "0.1.232",
+  "version": "0.1.235",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -14,7 +14,7 @@
     "@trackunit/react-core-hooks": "*",
     "lodash": "4.17.21",
     "graphql": "^15.8.0",
-    "@tanstack/react-router": "1.31.6",
+    "@tanstack/react-router": "1.40.0",
     "@trackunit/shared-utils": "*"
   },
   "module": "./index.esm.js",

package/src/utils/wait.d.ts

@@ -14,3 +14,10 @@ export declare const flushPromises: (waitTimeInMS?: number) => Promise<unknown>;
  * @returns {Promise<void>} - Returns a promise that resolves after the wait time.
  */
 export declare const flushPromisesInAct: (waitTimeInMS?: number) => Promise<unknown>;
+/**
+ * This is a temp hack to work around a Tanstack Router quirk.
+ * This will wait for the render to finish before resolving the promise.
+ *
+ * @param rerender - The rerender function.
+ */
+export declare const waitForRenderTanstackRouterQuirk: (rerender: () => void) => Promise<void>;