@trackunit/react-core-contexts-test 0.1.195 → 0.1.196

package/HookRenderer.cjs.js

@@ -13,6 +13,7 @@ require('@trackunit/react-core-contexts-api');
 require('@apollo/client/react');
 require('@tanstack/react-router');
 require('react');
+require('@trackunit/shared-utils');
 require('graphql');
 
 /**

package/HookRenderer.esm.js

@@ -11,6 +11,7 @@ import '@trackunit/react-core-contexts-api';
 import '@apollo/client/react';
 import '@tanstack/react-router';
 import 'react';
+import '@trackunit/shared-utils';
 import 'graphql';
 
 /**

package/index.cjs.js

@@ -14,6 +14,7 @@ require('@trackunit/react-core-contexts-api');
 require('@apollo/client/react');
 require('@tanstack/react-router');
 require('react');
+require('@trackunit/shared-utils');
 require('graphql');
 
 
@@ -34,4 +35,5 @@ exports.queryFor = index.queryFor;
 exports.queryForHook = index.queryForHook;
 exports.trackunitProviders = index.trackunitProviders;
 exports.useDebugger = index.useDebugger;
+exports.useIsFirstRender = index.useIsFirstRender;
 exports.validateIrisApp = index.validateIrisApp;

package/index.cjs2.js

@@ -11,6 +11,7 @@ var reactCoreContextsApi = require('@trackunit/react-core-contexts-api');
 var react = require('@apollo/client/react');
 var reactRouter = require('@tanstack/react-router');
 var React = require('react');
+var sharedUtils = require('@trackunit/shared-utils');
 var graphql = require('graphql');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
@@ -846,6 +847,19 @@ class TrackunitProvidersMockBuilder {
  */
 const trackunitProviders = () => new TrackunitProvidersMockBuilder();
 
+/**
+ * Differentiate between the first and subsequent renders.
+ *
+ * @returns {boolean} Returns true if it is the first render, false otherwise.
+ */
+const useIsFirstRender = () => {
+    const renderRef = React.useRef(true);
+    if (renderRef.current === true) {
+        renderRef.current = false;
+        return true;
+    }
+    return renderRef.current;
+};
 /**
  * Logs props that have changed.
  * Use this for debugging which props force a component to re-render.
@@ -876,18 +890,20 @@ const useDebugger = (propsToWatch, id) => {
         }
         return stackId || "unknown-id";
     }, [id]);
+    const isFirstRender = useIsFirstRender();
     // eslint-disable-next-line no-console
-    console.log("Rerender", uniqueId, window.location.pathname);
+    console.log(isFirstRender ? "First-render" : "Re-render", uniqueId, window.location.pathname);
     React.useEffect(() => {
+        // eslint-disable-next-line local-rules/prefer-custom-object-entries
         const changedProps = Object.entries(propsToWatch || {}).reduce((result, [key, value]) => {
             if (prevPropsRef.current && prevPropsRef.current[key] !== value) {
                 result[key + ""] = [prevPropsRef.current[key], value];
             }
             return result;
         }, {});
-        if (Object.keys(changedProps).length > 0) {
+        if (sharedUtils.objectKeys(changedProps).length > 0) {
             // eslint-disable-next-line no-console
-            Object.keys(changedProps).forEach(changedProp => {
+            sharedUtils.objectKeys(changedProps).forEach(changedProp => {
                 // eslint-disable-next-line no-console
                 console.log(`${uniqueId} changed property: ${changedProp}`);
                 // JSON stringify is used to avoid console.table from logging the object reference
@@ -896,12 +912,12 @@ const useDebugger = (propsToWatch, id) => {
                 const result1 = result[1];
                 result0 &&
                     typeof result0 === "object" &&
-                    Object.keys(result0).forEach(prop => {
+                    sharedUtils.objectKeys(result0).forEach(prop => {
                         result0[prop] = typeof result0[prop] === "object" ? JSON.stringify(result0[prop]) : result0[prop];
                     });
                 result1 &&
                     typeof result1 === "object" &&
-                    Object.keys(result1).forEach(prop => {
+                    sharedUtils.objectKeys(result1).forEach(prop => {
                         result1[prop] = typeof result1[prop] === "object" ? JSON.stringify(result1[prop]) : result1[prop];
                     });
                 // eslint-disable-next-line no-console
@@ -1103,4 +1119,5 @@ exports.queryFor = queryFor;
 exports.queryForHook = queryForHook;
 exports.trackunitProviders = trackunitProviders;
 exports.useDebugger = useDebugger;
+exports.useIsFirstRender = useIsFirstRender;
 exports.validateIrisApp = validateIrisApp;

package/index.esm.js

@@ -1,4 +1,4 @@
-export { D as Debugger, T as TrackunitProvidersMockBuilder, h as doNothing, f as flushPromises, j as flushPromisesInAct, m as mockAnalyticsContext, a as mockAssetSortingContext, b as mockCurrentUserContext, c as mockEnvironmentContext, d as mockOemBrandingContext, e as mockToastContext, g as mockUserSubscriptionContext, q as queryFor, i as queryForHook, t as trackunitProviders, u as useDebugger, 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 } from './index.esm2.js';
 import 'react/jsx-runtime';
 import '@testing-library/react';
 import '@trackunit/react-core-hooks';
@@ -10,4 +10,5 @@ import '@trackunit/react-core-contexts-api';
 import '@apollo/client/react';
 import '@tanstack/react-router';
 import 'react';
+import '@trackunit/shared-utils';
 import 'graphql';

package/index.esm2.js

@@ -9,6 +9,7 @@ import { AssetSortByProperty, SortOrder } from '@trackunit/react-core-contexts-a
 import { useApolloClient } from '@apollo/client/react';
 import { createMemoryHistory, createRootRoute, createRoute, createLazyRoute, createRouter, RouterProvider, Outlet } from '@tanstack/react-router';
 import React, { useMemo, useCallback, useRef, useEffect } from 'react';
+import { objectKeys } from '@trackunit/shared-utils';
 import { GraphQLError } from 'graphql';
 
 /******************************************************************************
@@ -839,6 +840,19 @@ class TrackunitProvidersMockBuilder {
  */
 const trackunitProviders = () => new TrackunitProvidersMockBuilder();
 
+/**
+ * Differentiate between the first and subsequent renders.
+ *
+ * @returns {boolean} Returns true if it is the first render, false otherwise.
+ */
+const useIsFirstRender = () => {
+    const renderRef = useRef(true);
+    if (renderRef.current === true) {
+        renderRef.current = false;
+        return true;
+    }
+    return renderRef.current;
+};
 /**
  * Logs props that have changed.
  * Use this for debugging which props force a component to re-render.
@@ -869,18 +883,20 @@ const useDebugger = (propsToWatch, id) => {
         }
         return stackId || "unknown-id";
     }, [id]);
+    const isFirstRender = useIsFirstRender();
     // eslint-disable-next-line no-console
-    console.log("Rerender", uniqueId, window.location.pathname);
+    console.log(isFirstRender ? "First-render" : "Re-render", uniqueId, window.location.pathname);
     useEffect(() => {
+        // eslint-disable-next-line local-rules/prefer-custom-object-entries
         const changedProps = Object.entries(propsToWatch || {}).reduce((result, [key, value]) => {
             if (prevPropsRef.current && prevPropsRef.current[key] !== value) {
                 result[key + ""] = [prevPropsRef.current[key], value];
             }
             return result;
         }, {});
-        if (Object.keys(changedProps).length > 0) {
+        if (objectKeys(changedProps).length > 0) {
             // eslint-disable-next-line no-console
-            Object.keys(changedProps).forEach(changedProp => {
+            objectKeys(changedProps).forEach(changedProp => {
                 // eslint-disable-next-line no-console
                 console.log(`${uniqueId} changed property: ${changedProp}`);
                 // JSON stringify is used to avoid console.table from logging the object reference
@@ -889,12 +905,12 @@ const useDebugger = (propsToWatch, id) => {
                 const result1 = result[1];
                 result0 &&
                     typeof result0 === "object" &&
-                    Object.keys(result0).forEach(prop => {
+                    objectKeys(result0).forEach(prop => {
                         result0[prop] = typeof result0[prop] === "object" ? JSON.stringify(result0[prop]) : result0[prop];
                     });
                 result1 &&
                     typeof result1 === "object" &&
-                    Object.keys(result1).forEach(prop => {
+                    objectKeys(result1).forEach(prop => {
                         result1[prop] = typeof result1[prop] === "object" ? JSON.stringify(result1[prop]) : result1[prop];
                     });
                 // eslint-disable-next-line no-console
@@ -1079,4 +1095,4 @@ const validateIrisApp = (irisApp) => __awaiter(void 0, void 0, void 0, function*
     return null;
 });
 
-export { Debugger as D, TrackunitProvidersMockBuilder as T, __awaiter as _, mockAssetSortingContext as a, mockCurrentUserContext as b, mockEnvironmentContext as c, mockOemBrandingContext as d, mockToastContext as e, flushPromises as f, mockUserSubscriptionContext as g, doNothing as h, queryForHook as i, flushPromisesInAct as j, mockAnalyticsContext as m, queryFor as q, trackunitProviders as t, useDebugger 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 };

package/package.json

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

package/src/debugger.d.ts

@@ -1,5 +1,11 @@
 import React from "react";
 type PropsToWatch<P> = P extends object ? P : never;
+/**
+ * Differentiate between the first and subsequent renders.
+ *
+ * @returns {boolean} Returns true if it is the first render, false otherwise.
+ */
+export declare const useIsFirstRender: () => boolean;
 /**
  * Logs props that have changed.
  * Use this for debugging which props force a component to re-render.