@trackunit/filters-filter-bar 2.6.2 → 2.6.3

package/index.cjs.js

@@ -1911,6 +1911,12 @@ const useFilterUrlSync = () => {
     }), [getFilterValuesFromUrl, getFilterValuesToUrl]);
 };
 
+const filterBarPersistedSchema = zod.z.object({
+    values: zod.z.record(zod.z.string(), zod.z.unknown()),
+});
+// A fresh object per call — callers (e.g. loadValues) mutate the returned `values` object
+// directly, so this must never be a shared reference reused across calls.
+const createDefaultFilterBarConfigPersisted = () => ({ values: {} });
 /**
  * Custom hook for managing the persistence of filter bar configurations.
  */
@@ -1929,13 +1935,17 @@ const useFilterBarPersistence = ({ name, setValue, refreshData, isDefaultValue,
         },
     });
     const storageKey = reactComponents.useStorageKey(`filter-${name}`, clientSideUserId);
-    const getFromLocalStorage = react.useCallback(() => {
-        // TODO: migrate to useLocalStorage hook — this file was exempted when the no-direct-storage-access rule was introduced
-        // eslint-disable-next-line no-restricted-globals
-        return localStorage.getItem(storageKey);
-    }, [storageKey]);
+    // Custom mode (inputLoadData/inputSaveData provided) must never touch localStorage at all —
+    // useLocalStorage's write-on-mount behavior would create an entry even if its setter is never
+    // called, so this reads/writes explicitly via the non-hook accessors instead, preserving the
+    // exact current imperative control flow (including custom mode's complete storage bypass).
+    const getFromLocalStorage = react.useCallback(() => sharedUtils.readLocalStorageValue({
+        key: storageKey,
+        defaultState: createDefaultFilterBarConfigPersisted(),
+        schema: filterBarPersistedSchema,
+    }), [storageKey]);
     const lastName = react.useRef(name);
-    const [initialStoredFilters] = react.useState(() => (!inputLoadData && getFromLocalStorage()) || "{}");
+    const [initialStoredFilters] = react.useState(() => !inputLoadData ? getFromLocalStorage() : null);
     const { getFilterValuesFromUrl, getFilterValuesToUrl } = useFilterUrlSync();
     const lastSavedStateRef = react.useRef(undefined);
     const saveData = react.useCallback((filterBarConfig, filterBarDefinitions) => {
@@ -1958,38 +1968,25 @@ const useFilterBarPersistence = ({ name, setValue, refreshData, isDefaultValue,
                 inputSaveData(newValues);
             }
             else {
-                // eslint-disable-next-line no-restricted-globals
-                localStorage.setItem(storageKey, reactComponents.storageSerializer.serialize(toPersist));
+                sharedUtils.writeLocalStorageValue({ key: storageKey, value: toPersist, schema: filterBarPersistedSchema });
                 const urlObject = getFilterValuesToUrl(newValues, sharedUtils.objectValues(filterBarDefinitions), false, isDefaultValue);
                 updateSearchParam(encode(urlObject));
             }
         }
     }, [storageKey, inputSaveData, getFilterValuesToUrl, updateSearchParam, encode, isDefaultValue]);
     const loadFromLocalStorage = react.useCallback(() => {
-        let storedFilters = null;
+        let stored;
         if (lastName.current !== name) {
-            // eslint-disable-next-line no-restricted-globals
-            storedFilters = localStorage.getItem(storageKey) || "{}";
+            stored = getFromLocalStorage();
             lastName.current = name;
         }
         else {
-            storedFilters = initialStoredFilters;
-        }
-        if (storedFilters && storedFilters !== "undefined") {
-            try {
-                const deserialized = reactComponents.storageSerializer.deserialize(storedFilters);
-                if (typeof deserialized === "object" && deserialized !== null && !Array.isArray(deserialized)) {
-                    const record = Object.fromEntries(Object.entries(deserialized));
-                    return record.values ?? {};
-                }
-                return {};
-            }
-            catch {
-                return {};
-            }
+            stored = initialStoredFilters ?? createDefaultFilterBarConfigPersisted();
         }
-        return {};
-    }, [storageKey, name, initialStoredFilters, lastName]);
+        // Callers (loadValues) mutate the returned object directly — return a fresh shallow copy
+        // each time so a mutation doesn't leak into the cached initialStoredFilters for next time.
+        return { ...stored.values };
+    }, [name, initialStoredFilters, getFromLocalStorage]);
     const loadFromSearchURL = react.useCallback(() => {
         if (searchValue !== undefined) {
             try {

package/index.esm.js

@@ -3,13 +3,13 @@ import { registerTranslations, useNamespaceTranslation } from '@trackunit/i18n-l
 import { useMemo, useState, useEffect, useCallback, Fragment as Fragment$1, useRef } from 'react';
 import { twMerge } from 'tailwind-merge';
 import { Filter, FilterBody, RadioFilterItem, CheckBoxFilterItem, FilterHeader as FilterHeader$1, FilterFooter } from '@trackunit/react-filter-components';
-import { Button, Icon, useList, List, Text, useTextSearch, cvaMenuList, cvaMenu, ZStack, IconButton, Badge, useViewportBreakpoints, MenuTree, Popover, PopoverTrigger, Tooltip, PopoverContent, useCustomEncoding, useSearchParamSync, useStorageKey, storageSerializer, useWatch } from '@trackunit/react-components';
+import { Button, Icon, useList, List, Text, useTextSearch, cvaMenuList, cvaMenu, ZStack, IconButton, Badge, useViewportBreakpoints, MenuTree, Popover, PopoverTrigger, Tooltip, PopoverContent, useCustomEncoding, useSearchParamSync, useStorageKey, useWatch } from '@trackunit/react-components';
 import { useAnalytics, useCurrentUser } from '@trackunit/react-core-hooks';
 import { capitalize } from 'string-ts';
 import { createEvent } from '@trackunit/iris-app-runtime-core-api';
 import { Search, NumberField, RadioGroup } from '@trackunit/react-form-components';
 import { DayRangePicker } from '@trackunit/react-date-and-time-components';
-import { nonNullable, capitalize as capitalize$1, objectValues, truthy, objectKeys } from '@trackunit/shared-utils';
+import { nonNullable, capitalize as capitalize$1, objectValues, truthy, objectKeys, readLocalStorageValue, writeLocalStorageValue } from '@trackunit/shared-utils';
 import { customFieldFilterKey } from '@trackunit/iris-app-api';
 import { cvaMerge } from '@trackunit/css-class-variance-utilities';
 import { dequal } from 'dequal';
@@ -1909,6 +1909,12 @@ const useFilterUrlSync = () => {
     }), [getFilterValuesFromUrl, getFilterValuesToUrl]);
 };
 
+const filterBarPersistedSchema = z.object({
+    values: z.record(z.string(), z.unknown()),
+});
+// A fresh object per call — callers (e.g. loadValues) mutate the returned `values` object
+// directly, so this must never be a shared reference reused across calls.
+const createDefaultFilterBarConfigPersisted = () => ({ values: {} });
 /**
  * Custom hook for managing the persistence of filter bar configurations.
  */
@@ -1927,13 +1933,17 @@ const useFilterBarPersistence = ({ name, setValue, refreshData, isDefaultValue,
         },
     });
     const storageKey = useStorageKey(`filter-${name}`, clientSideUserId);
-    const getFromLocalStorage = useCallback(() => {
-        // TODO: migrate to useLocalStorage hook — this file was exempted when the no-direct-storage-access rule was introduced
-        // eslint-disable-next-line no-restricted-globals
-        return localStorage.getItem(storageKey);
-    }, [storageKey]);
+    // Custom mode (inputLoadData/inputSaveData provided) must never touch localStorage at all —
+    // useLocalStorage's write-on-mount behavior would create an entry even if its setter is never
+    // called, so this reads/writes explicitly via the non-hook accessors instead, preserving the
+    // exact current imperative control flow (including custom mode's complete storage bypass).
+    const getFromLocalStorage = useCallback(() => readLocalStorageValue({
+        key: storageKey,
+        defaultState: createDefaultFilterBarConfigPersisted(),
+        schema: filterBarPersistedSchema,
+    }), [storageKey]);
     const lastName = useRef(name);
-    const [initialStoredFilters] = useState(() => (!inputLoadData && getFromLocalStorage()) || "{}");
+    const [initialStoredFilters] = useState(() => !inputLoadData ? getFromLocalStorage() : null);
     const { getFilterValuesFromUrl, getFilterValuesToUrl } = useFilterUrlSync();
     const lastSavedStateRef = useRef(undefined);
     const saveData = useCallback((filterBarConfig, filterBarDefinitions) => {
@@ -1956,38 +1966,25 @@ const useFilterBarPersistence = ({ name, setValue, refreshData, isDefaultValue,
                 inputSaveData(newValues);
             }
             else {
-                // eslint-disable-next-line no-restricted-globals
-                localStorage.setItem(storageKey, storageSerializer.serialize(toPersist));
+                writeLocalStorageValue({ key: storageKey, value: toPersist, schema: filterBarPersistedSchema });
                 const urlObject = getFilterValuesToUrl(newValues, objectValues(filterBarDefinitions), false, isDefaultValue);
                 updateSearchParam(encode(urlObject));
             }
         }
     }, [storageKey, inputSaveData, getFilterValuesToUrl, updateSearchParam, encode, isDefaultValue]);
     const loadFromLocalStorage = useCallback(() => {
-        let storedFilters = null;
+        let stored;
         if (lastName.current !== name) {
-            // eslint-disable-next-line no-restricted-globals
-            storedFilters = localStorage.getItem(storageKey) || "{}";
+            stored = getFromLocalStorage();
             lastName.current = name;
         }
         else {
-            storedFilters = initialStoredFilters;
-        }
-        if (storedFilters && storedFilters !== "undefined") {
-            try {
-                const deserialized = storageSerializer.deserialize(storedFilters);
-                if (typeof deserialized === "object" && deserialized !== null && !Array.isArray(deserialized)) {
-                    const record = Object.fromEntries(Object.entries(deserialized));
-                    return record.values ?? {};
-                }
-                return {};
-            }
-            catch {
-                return {};
-            }
+            stored = initialStoredFilters ?? createDefaultFilterBarConfigPersisted();
         }
-        return {};
-    }, [storageKey, name, initialStoredFilters, lastName]);
+        // Callers (loadValues) mutate the returned object directly — return a fresh shallow copy
+        // each time so a mutation doesn't leak into the cached initialStoredFilters for next time.
+        return { ...stored.values };
+    }, [name, initialStoredFilters, getFromLocalStorage]);
     const loadFromSearchURL = useCallback(() => {
         if (searchValue !== undefined) {
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-filter-bar",
-  "version": "2.6.2",
+  "version": "2.6.3",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -12,16 +12,16 @@
     "string-ts": "^2.0.0",
     "zod": "^3.25.76",
     "@trackunit/iris-app-api": "2.4.5",
-    "@trackunit/react-core-hooks": "1.21.8",
-    "@trackunit/react-filter-components": "2.6.2",
-    "@trackunit/react-date-and-time-components": "2.6.2",
-    "@trackunit/shared-utils": "1.16.15",
-    "@trackunit/react-form-components": "2.6.2",
-    "@trackunit/iris-app-runtime-core-api": "1.17.15",
+    "@trackunit/react-core-hooks": "1.21.9",
+    "@trackunit/react-filter-components": "2.6.3",
+    "@trackunit/react-date-and-time-components": "2.6.3",
+    "@trackunit/shared-utils": "1.16.16",
+    "@trackunit/react-form-components": "2.6.3",
+    "@trackunit/iris-app-runtime-core-api": "1.17.16",
     "@trackunit/geo-json-utils": "1.15.13",
-    "@trackunit/i18n-library-translation": "2.4.8",
+    "@trackunit/i18n-library-translation": "2.4.9",
     "@trackunit/css-class-variance-utilities": "1.14.13",
-    "@trackunit/react-components": "2.9.2"
+    "@trackunit/react-components": "2.9.3"
   },
   "peerDependencies": {
     "@apollo/client": "^3.13.8",