@trackunit/react-core-hooks 1.7.51 → 1.7.52

package/index.cjs.js

@@ -412,8 +412,9 @@ const useImageUploader = () => {
  */
 const useFeatureBranchQueryString = () => {
     const { publicUrl, buildVersion, isFeatureBranch } = useEnvironment();
-    const featureBranchQueryParam = react.useMemo(() => (!publicUrl || !isFeatureBranch ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`), [publicUrl, buildVersion, isFeatureBranch]);
-    return { featureBranchQueryParam };
+    return react.useMemo(() => ({
+        featureBranchQueryParam: !publicUrl || !isFeatureBranch ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`,
+    }), [publicUrl, buildVersion, isFeatureBranch]);
 };
 
 const IRIS_APP_ASSET_PATH = "assets/";
@@ -1198,20 +1199,29 @@ const UNINITIALIZED = Symbol("UNINITIALIZED");
  * @param props.value - The value to watch for changes
  * @param props.onChange - Function to call when the value changes
  * @param props.immediate - Whether to run the callback immediately on mount (default: false)
+ * @param props.skip - Whether to skip watching for changes (default: false)
  */
-const useWatch = ({ value, onChange, immediate = false }) => {
+const useWatch = ({ value, onChange, immediate = false, skip = false }) => {
     const prevValue = react.useRef(UNINITIALIZED);
+    const onChangeRef = react.useRef(onChange);
+    // Update the ref whenever onChange changes
     react.useEffect(() => {
+        onChangeRef.current = onChange;
+    }, [onChange]);
+    react.useEffect(() => {
+        if (skip) {
+            return;
+        }
         const prev = prevValue.current;
         const hasChanged = prev === UNINITIALIZED ? false : !esToolkit.isEqual(value, prev);
         if (immediate && prev === UNINITIALIZED) {
-            onChange(value, null);
+            onChangeRef.current(value, null);
         }
         else if (hasChanged && prev !== UNINITIALIZED) {
-            onChange(value, prev);
+            onChangeRef.current(value, prev);
         }
         prevValue.current = value;
-    }, [value, onChange, immediate]);
+    }, [value, immediate, skip]);
 };
 
 const WidgetConfigContext = react.createContext(null);

package/index.esm.js

@@ -410,8 +410,9 @@ const useImageUploader = () => {
  */
 const useFeatureBranchQueryString = () => {
     const { publicUrl, buildVersion, isFeatureBranch } = useEnvironment();
-    const featureBranchQueryParam = useMemo(() => (!publicUrl || !isFeatureBranch ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`), [publicUrl, buildVersion, isFeatureBranch]);
-    return { featureBranchQueryParam };
+    return useMemo(() => ({
+        featureBranchQueryParam: !publicUrl || !isFeatureBranch ? "" : `?fb_url=${encodeURIComponent(publicUrl)}&fb_version=${buildVersion}`,
+    }), [publicUrl, buildVersion, isFeatureBranch]);
 };
 
 const IRIS_APP_ASSET_PATH = "assets/";
@@ -1196,20 +1197,29 @@ const UNINITIALIZED = Symbol("UNINITIALIZED");
  * @param props.value - The value to watch for changes
  * @param props.onChange - Function to call when the value changes
  * @param props.immediate - Whether to run the callback immediately on mount (default: false)
+ * @param props.skip - Whether to skip watching for changes (default: false)
  */
-const useWatch = ({ value, onChange, immediate = false }) => {
+const useWatch = ({ value, onChange, immediate = false, skip = false }) => {
     const prevValue = useRef(UNINITIALIZED);
+    const onChangeRef = useRef(onChange);
+    // Update the ref whenever onChange changes
     useEffect(() => {
+        onChangeRef.current = onChange;
+    }, [onChange]);
+    useEffect(() => {
+        if (skip) {
+            return;
+        }
         const prev = prevValue.current;
         const hasChanged = prev === UNINITIALIZED ? false : !isEqual(value, prev);
         if (immediate && prev === UNINITIALIZED) {
-            onChange(value, null);
+            onChangeRef.current(value, null);
         }
         else if (hasChanged && prev !== UNINITIALIZED) {
-            onChange(value, prev);
+            onChangeRef.current(value, prev);
         }
         prevValue.current = value;
-    }, [value, onChange, immediate]);
+    }, [value, immediate, skip]);
 };
 
 const WidgetConfigContext = createContext(null);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.7.51",
+  "version": "1.7.52",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/useFeatureBranchQueryString.d.ts

@@ -1,6 +1,8 @@
+type FeatureBranchQueryString = `?fb_url=${string}&fb_version=${string}`;
 /**
  * Returns the query string to be appended to the URL when the app is served from a Feature Branch.
  */
 export declare const useFeatureBranchQueryString: () => {
-    featureBranchQueryParam: string;
+    featureBranchQueryParam: "" | FeatureBranchQueryString;
 };
+export {};

package/src/useWatch.d.ts

@@ -1,5 +1,6 @@
 interface UseWatchOptions {
     immediate?: boolean;
+    skip?: boolean;
 }
 interface UseWatchProps<TValue> extends UseWatchOptions {
     value: TValue;
@@ -13,6 +14,7 @@ interface UseWatchProps<TValue> extends UseWatchOptions {
  * @param props.value - The value to watch for changes
  * @param props.onChange - Function to call when the value changes
  * @param props.immediate - Whether to run the callback immediately on mount (default: false)
+ * @param props.skip - Whether to skip watching for changes (default: false)
  */
-export declare const useWatch: <TValue>({ value, onChange, immediate }: UseWatchProps<TValue>) => void;
+export declare const useWatch: <TValue>({ value, onChange, immediate, skip }: UseWatchProps<TValue>) => void;
 export {};