@trackunit/filters-filter-bar 1.3.17 → 1.3.19

package/index.cjs.js

@@ -14,7 +14,6 @@ var sharedUtils = require('@trackunit/shared-utils');
 var tailwindMerge = require('tailwind-merge');
 var dequal = require('dequal');
 var isEqual = require('lodash/isEqual');
-var reduce = require('lodash/reduce');
 var geoJsonUtils = require('@trackunit/geo-json-utils');
 var zod = require('zod');
 
@@ -892,7 +891,7 @@ const mockFilterBar = {
         arrayIncludesValue: doNothing,
         getFilterTitle: doNothing,
         getFilterBarName: doNothing,
-        initialState: { customerType: [] },
+        initialState: { filtered: { customerType: [] }, empty: { customerType: [] } },
         name: "test",
         objectArrayIncludesValue: doNothing,
         resetFiltersToInitialState: doNothing,
@@ -965,8 +964,11 @@ const createInitialState = (name, mainFilters, initialState, setValue) => {
         const type = curr.type;
         return {
             ...prev,
+            [key]: 
             // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-            [key]: initialState[key] ?? curr.defaultValue ?? getInitialValueFromType(type),
+            "filtered" in initialState && initialState.filtered[key]
+                ? initialState.filtered[key]
+                : (curr.defaultValue ?? getInitialValueFromType(type)),
         };
     }, {});
     const setters = mainFilters.reduce((prev, curr) => {
@@ -976,23 +978,13 @@ const createInitialState = (name, mainFilters, initialState, setValue) => {
             [`set${stringTs.capitalize(key)}`]: (callback) => setValue(key, callback),
         };
     }, {});
-    const updatedInitialState = mainFilters.reduce((prev, curr) => {
-        const key = curr.filterKey;
-        const type = curr.type;
-        return {
-            ...prev,
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-            [key]: initialState[key] ?? curr.defaultValue ?? getInitialValueFromType(type),
-        };
-    }, {});
-    const newFilter = {
+    return {
         name,
-        initialState: updatedInitialState,
+        initialState: { filtered: values, empty: "empty" in initialState ? initialState.empty : {} },
         starredFilterKeys: defaultStarredKeys,
         values,
         setters,
     };
-    return newFilter;
 };
 
 const areaFilterGeoJsonGeometrySchema = zod.z.union([geoJsonUtils.geoJsonPolygonSchema, geoJsonUtils.geoJsonMultiPolygonSchema]);
@@ -1115,7 +1107,7 @@ const validateFilter = (filter, filterDefinitions) => {
     });
     stateKeys.sort((a, b) => a.localeCompare(b));
     const filterKeysNotEqual = !isEqual(stateKeys, filterDefinitions.map(f => f.filterKey).sort((a, b) => a.localeCompare(b)));
-    return inBadState || filterKeysNotEqual ? false : true;
+    return !(inBadState || filterKeysNotEqual);
 };
 
 /**
@@ -1124,7 +1116,7 @@ const validateFilter = (filter, filterDefinitions) => {
  * @template TFilterBarDefinition - A generic type for the filter bar definition.
  * @returns {object} An object containing filter bar configuration and actions.
  */
-const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState, loadAsync, }) => {
+const useFilterBar = ({ name, onValuesChange, filterBarDefinition, loadAsync, initialState, }) => {
     const [internalFilterBarDefinitions, setInternalFilterBarDefinitions] = react.useState(filterBarDefinition);
     const { clientSideUserId } = reactCoreHooks.useCurrentUser();
     const setValue = react.useCallback((key, callback) => {
@@ -1145,14 +1137,11 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
         if (storedFilters && storedFilters !== "undefined") {
             const loadedFilterBarConfig = JSON.parse(storedFilters);
             if (validateFilter(loadedFilterBarConfig, updatedFilterDefinitionsValues)) {
-                initialFilterBarConfig = {
-                    ...loadedFilterBarConfig,
-                    initialState: initialState || loadedFilterBarConfig.initialState,
-                };
+                initialFilterBarConfig = createInitialState(loadedFilterBarConfig.name, updatedFilterDefinitionsValues, initialState || loadedFilterBarConfig.initialState, setValue);
             }
         }
         //WHY WE NEED THIS?
-        //For filters that are not visible and we want to set the default value to the initial state.
+        //For filters that are not visible, and we want to set the default value to the initial state.
         //To do this for a changing default value as in customers and sites we would need to recreate the initialFilterBarConfig every time the default value changes.
         //This mean that filterbars that have this functionality wouldn't be able to save the state of the filterbar.
         //Another option would be to create a new filterbar for each customer or site. This also has its drawbacks. Would raise it with the frontend community.
@@ -1221,26 +1210,35 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
             },
             get appliedFilterKeys() {
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const initialStateValues = filterBarConfig.initialState || {};
+                const initialStateFilteredValues = JSON.parse(JSON.stringify(filterBarConfig.initialState?.filtered || {}));
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const currentFilters = filterBarConfig.values || {};
-                // parse and stringify to remove empty references before comparing
-                // eslint-disable-next-line local-rules/no-typescript-assertion
-                const currentValuesWithoutEmptyRefs = JSON.parse(JSON.stringify(currentFilters));
-                // eslint-disable-next-line local-rules/no-typescript-assertion
-                const initialStateValuesWithoutEmptyRefs = JSON.parse(JSON.stringify(initialStateValues));
-                return getKeysOfUnequalProperties(currentValuesWithoutEmptyRefs, initialStateValuesWithoutEmptyRefs).map(key => key.toString() // TODO: FilterName type should be PropertyKey instead of string to avoid this .toString() bs but out-of-scope for this round of improvements
-                );
+                const initialStateEmptyValues = JSON.parse(JSON.stringify(filterBarConfig.initialState?.empty || {}));
+                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+                const currentFilters = JSON.parse(JSON.stringify(filterBarConfig.values || {}));
+                return sharedUtils.objectKeys(currentFilters)
+                    .filter(filterKey => {
+                    const isFilterValueEqualToInitialStateValue = dequal.dequal(currentFilters[filterKey], initialStateFilteredValues[filterKey]);
+                    const emptyStateValue = initialStateEmptyValues[filterKey];
+                    // If we passed an initialState's empty state, we have to compare whether this field is different
+                    // from the empty state. If the field is different from the empty state, it means that it is an active filter.
+                    if (emptyStateValue) {
+                        const isFilterValueEqualToEmptyStateValue = dequal.dequal(currentFilters[filterKey], emptyStateValue);
+                        return !isFilterValueEqualToEmptyStateValue;
+                    }
+                    // Otherwise, we need to check whether our filter's field value equals the initial state's field value
+                    // The initialState value is created based on the `initialState` passed to this hook, and some magic
+                    // done in the `createInitialState` function.
+                    return !isFilterValueEqualToInitialStateValue;
+                })
+                    .map(key => String(key));
             },
             filterHasChanged(key) {
+                const initialStateFilteredValue = JSON.parse(
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const initialStateValue = filterBarConfig.initialState[key] || {};
+                JSON.stringify(filterBarConfig.initialState?.filtered?.[key] || {}));
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const currentValue = filterBarConfig.values[key] || {};
-                // parse and stringify to remove empty references before comparing
-                const currentValueWithoutEmptyRefs = JSON.parse(JSON.stringify(currentValue));
-                const initialStateValueWithoutEmptyRefs = JSON.parse(JSON.stringify(initialStateValue));
-                return !dequal.dequal(currentValueWithoutEmptyRefs, initialStateValueWithoutEmptyRefs);
+                const currentFilter = JSON.parse(JSON.stringify(filterBarConfig.values[key] || {}));
+                return !dequal.dequal(currentFilter, initialStateFilteredValue);
             },
             objectArrayIncludesValue(key, value) {
                 const filter = filterBarConfig.values[key];
@@ -1251,7 +1249,13 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
                 return filter?.value === value || false;
             },
         };
-    }, [filterBarConfig.initialState, filterBarConfig.name, filterBarConfig.values, internalFilterBarDefinitions]);
+    }, [
+        filterBarConfig.initialState.empty,
+        filterBarConfig.initialState.filtered,
+        filterBarConfig.name,
+        filterBarConfig.values,
+        internalFilterBarDefinitions,
+    ]);
     const filterMapActions = react.useMemo(() => {
         // Reset an individual filter to its initial state
         const resetIndividualFilterToInitialState = (key) => {
@@ -1275,15 +1279,13 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
                             starredFilterKeys: prevState.starredFilterKeys.filter(obj => obj !== filterKey),
                         };
                     }
-                    else {
-                        return {
-                            ...prevState,
-                            starredFilterKeys: [
-                                ...prevState.starredFilterKeys,
-                                filterKey,
-                            ],
-                        };
-                    }
+                    return {
+                        ...prevState,
+                        starredFilterKeys: [
+                            ...prevState.starredFilterKeys,
+                            filterKey,
+                        ],
+                    };
                 });
                 resetIndividualFilterToInitialState(filterKey);
             },
@@ -1299,15 +1301,13 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
                             },
                         };
                     }
-                    else {
-                        return {
-                            ...prevState,
-                            values: {
-                                ...prevState.values,
-                                [key]: filterValue ? [...filterValue, value] : [value],
-                            },
-                        };
-                    }
+                    return {
+                        ...prevState,
+                        values: {
+                            ...prevState.values,
+                            [key]: filterValue ? [...filterValue, value] : [value],
+                        },
+                    };
                 });
             },
             setStringValue(key, value) {
@@ -1487,14 +1487,6 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
         };
     }, [filterBarConfig, filterMapActions, filterMapGetter, internalFilterBarDefinitions, dataLoaded]);
 };
-const getKeysOfUnequalProperties = (obj1, obj2) => {
-    return reduce(obj1, (result, value, key) => {
-        if (!isEqual(value, obj2[key])) {
-            result.push(key);
-        }
-        return result;
-    }, []);
-};
 
 /**
  * Handles the application of a URL search parameter as a filter in the system.

package/index.esm.js

@@ -12,7 +12,6 @@ import { nonNullable, capitalize as capitalize$1, objectValues, truthy, objectKe
 import { twMerge } from 'tailwind-merge';
 import { dequal } from 'dequal';
 import isEqual from 'lodash/isEqual';
-import reduce from 'lodash/reduce';
 import { geoJsonPolygonSchema, geoJsonMultiPolygonSchema } from '@trackunit/geo-json-utils';
 import { z } from 'zod';
 
@@ -890,7 +889,7 @@ const mockFilterBar = {
         arrayIncludesValue: doNothing,
         getFilterTitle: doNothing,
         getFilterBarName: doNothing,
-        initialState: { customerType: [] },
+        initialState: { filtered: { customerType: [] }, empty: { customerType: [] } },
         name: "test",
         objectArrayIncludesValue: doNothing,
         resetFiltersToInitialState: doNothing,
@@ -963,8 +962,11 @@ const createInitialState = (name, mainFilters, initialState, setValue) => {
         const type = curr.type;
         return {
             ...prev,
+            [key]: 
             // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-            [key]: initialState[key] ?? curr.defaultValue ?? getInitialValueFromType(type),
+            "filtered" in initialState && initialState.filtered[key]
+                ? initialState.filtered[key]
+                : (curr.defaultValue ?? getInitialValueFromType(type)),
         };
     }, {});
     const setters = mainFilters.reduce((prev, curr) => {
@@ -974,23 +976,13 @@ const createInitialState = (name, mainFilters, initialState, setValue) => {
             [`set${capitalize(key)}`]: (callback) => setValue(key, callback),
         };
     }, {});
-    const updatedInitialState = mainFilters.reduce((prev, curr) => {
-        const key = curr.filterKey;
-        const type = curr.type;
-        return {
-            ...prev,
-            // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-            [key]: initialState[key] ?? curr.defaultValue ?? getInitialValueFromType(type),
-        };
-    }, {});
-    const newFilter = {
+    return {
         name,
-        initialState: updatedInitialState,
+        initialState: { filtered: values, empty: "empty" in initialState ? initialState.empty : {} },
         starredFilterKeys: defaultStarredKeys,
         values,
         setters,
     };
-    return newFilter;
 };
 
 const areaFilterGeoJsonGeometrySchema = z.union([geoJsonPolygonSchema, geoJsonMultiPolygonSchema]);
@@ -1113,7 +1105,7 @@ const validateFilter = (filter, filterDefinitions) => {
     });
     stateKeys.sort((a, b) => a.localeCompare(b));
     const filterKeysNotEqual = !isEqual(stateKeys, filterDefinitions.map(f => f.filterKey).sort((a, b) => a.localeCompare(b)));
-    return inBadState || filterKeysNotEqual ? false : true;
+    return !(inBadState || filterKeysNotEqual);
 };
 
 /**
@@ -1122,7 +1114,7 @@ const validateFilter = (filter, filterDefinitions) => {
  * @template TFilterBarDefinition - A generic type for the filter bar definition.
  * @returns {object} An object containing filter bar configuration and actions.
  */
-const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState, loadAsync, }) => {
+const useFilterBar = ({ name, onValuesChange, filterBarDefinition, loadAsync, initialState, }) => {
     const [internalFilterBarDefinitions, setInternalFilterBarDefinitions] = useState(filterBarDefinition);
     const { clientSideUserId } = useCurrentUser();
     const setValue = useCallback((key, callback) => {
@@ -1143,14 +1135,11 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
         if (storedFilters && storedFilters !== "undefined") {
             const loadedFilterBarConfig = JSON.parse(storedFilters);
             if (validateFilter(loadedFilterBarConfig, updatedFilterDefinitionsValues)) {
-                initialFilterBarConfig = {
-                    ...loadedFilterBarConfig,
-                    initialState: initialState || loadedFilterBarConfig.initialState,
-                };
+                initialFilterBarConfig = createInitialState(loadedFilterBarConfig.name, updatedFilterDefinitionsValues, initialState || loadedFilterBarConfig.initialState, setValue);
             }
         }
         //WHY WE NEED THIS?
-        //For filters that are not visible and we want to set the default value to the initial state.
+        //For filters that are not visible, and we want to set the default value to the initial state.
         //To do this for a changing default value as in customers and sites we would need to recreate the initialFilterBarConfig every time the default value changes.
         //This mean that filterbars that have this functionality wouldn't be able to save the state of the filterbar.
         //Another option would be to create a new filterbar for each customer or site. This also has its drawbacks. Would raise it with the frontend community.
@@ -1219,26 +1208,35 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
             },
             get appliedFilterKeys() {
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const initialStateValues = filterBarConfig.initialState || {};
+                const initialStateFilteredValues = JSON.parse(JSON.stringify(filterBarConfig.initialState?.filtered || {}));
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const currentFilters = filterBarConfig.values || {};
-                // parse and stringify to remove empty references before comparing
-                // eslint-disable-next-line local-rules/no-typescript-assertion
-                const currentValuesWithoutEmptyRefs = JSON.parse(JSON.stringify(currentFilters));
-                // eslint-disable-next-line local-rules/no-typescript-assertion
-                const initialStateValuesWithoutEmptyRefs = JSON.parse(JSON.stringify(initialStateValues));
-                return getKeysOfUnequalProperties(currentValuesWithoutEmptyRefs, initialStateValuesWithoutEmptyRefs).map(key => key.toString() // TODO: FilterName type should be PropertyKey instead of string to avoid this .toString() bs but out-of-scope for this round of improvements
-                );
+                const initialStateEmptyValues = JSON.parse(JSON.stringify(filterBarConfig.initialState?.empty || {}));
+                // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+                const currentFilters = JSON.parse(JSON.stringify(filterBarConfig.values || {}));
+                return objectKeys(currentFilters)
+                    .filter(filterKey => {
+                    const isFilterValueEqualToInitialStateValue = dequal(currentFilters[filterKey], initialStateFilteredValues[filterKey]);
+                    const emptyStateValue = initialStateEmptyValues[filterKey];
+                    // If we passed an initialState's empty state, we have to compare whether this field is different
+                    // from the empty state. If the field is different from the empty state, it means that it is an active filter.
+                    if (emptyStateValue) {
+                        const isFilterValueEqualToEmptyStateValue = dequal(currentFilters[filterKey], emptyStateValue);
+                        return !isFilterValueEqualToEmptyStateValue;
+                    }
+                    // Otherwise, we need to check whether our filter's field value equals the initial state's field value
+                    // The initialState value is created based on the `initialState` passed to this hook, and some magic
+                    // done in the `createInitialState` function.
+                    return !isFilterValueEqualToInitialStateValue;
+                })
+                    .map(key => String(key));
             },
             filterHasChanged(key) {
+                const initialStateFilteredValue = JSON.parse(
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const initialStateValue = filterBarConfig.initialState[key] || {};
+                JSON.stringify(filterBarConfig.initialState?.filtered?.[key] || {}));
                 // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
-                const currentValue = filterBarConfig.values[key] || {};
-                // parse and stringify to remove empty references before comparing
-                const currentValueWithoutEmptyRefs = JSON.parse(JSON.stringify(currentValue));
-                const initialStateValueWithoutEmptyRefs = JSON.parse(JSON.stringify(initialStateValue));
-                return !dequal(currentValueWithoutEmptyRefs, initialStateValueWithoutEmptyRefs);
+                const currentFilter = JSON.parse(JSON.stringify(filterBarConfig.values[key] || {}));
+                return !dequal(currentFilter, initialStateFilteredValue);
             },
             objectArrayIncludesValue(key, value) {
                 const filter = filterBarConfig.values[key];
@@ -1249,7 +1247,13 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
                 return filter?.value === value || false;
             },
         };
-    }, [filterBarConfig.initialState, filterBarConfig.name, filterBarConfig.values, internalFilterBarDefinitions]);
+    }, [
+        filterBarConfig.initialState.empty,
+        filterBarConfig.initialState.filtered,
+        filterBarConfig.name,
+        filterBarConfig.values,
+        internalFilterBarDefinitions,
+    ]);
     const filterMapActions = useMemo(() => {
         // Reset an individual filter to its initial state
         const resetIndividualFilterToInitialState = (key) => {
@@ -1273,15 +1277,13 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
                             starredFilterKeys: prevState.starredFilterKeys.filter(obj => obj !== filterKey),
                         };
                     }
-                    else {
-                        return {
-                            ...prevState,
-                            starredFilterKeys: [
-                                ...prevState.starredFilterKeys,
-                                filterKey,
-                            ],
-                        };
-                    }
+                    return {
+                        ...prevState,
+                        starredFilterKeys: [
+                            ...prevState.starredFilterKeys,
+                            filterKey,
+                        ],
+                    };
                 });
                 resetIndividualFilterToInitialState(filterKey);
             },
@@ -1297,15 +1299,13 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
                             },
                         };
                     }
-                    else {
-                        return {
-                            ...prevState,
-                            values: {
-                                ...prevState.values,
-                                [key]: filterValue ? [...filterValue, value] : [value],
-                            },
-                        };
-                    }
+                    return {
+                        ...prevState,
+                        values: {
+                            ...prevState.values,
+                            [key]: filterValue ? [...filterValue, value] : [value],
+                        },
+                    };
                 });
             },
             setStringValue(key, value) {
@@ -1485,14 +1485,6 @@ const useFilterBar = ({ name, onValuesChange, filterBarDefinition, initialState,
         };
     }, [filterBarConfig, filterMapActions, filterMapGetter, internalFilterBarDefinitions, dataLoaded]);
 };
-const getKeysOfUnequalProperties = (obj1, obj2) => {
-    return reduce(obj1, (result, value, key) => {
-        if (!isEqual(value, obj2[key])) {
-            result.push(key);
-        }
-        return result;
-    }, []);
-};
 
 /**
  * Handles the application of a URL search parameter as a filter in the system.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-filter-bar",
-  "version": "1.3.17",
+  "version": "1.3.19",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -14,15 +14,15 @@
     "tailwind-merge": "^2.0.0",
     "string-ts": "^2.0.0",
     "zod": "3.22.4",
-    "@trackunit/react-components": "1.4.13",
-    "@trackunit/react-core-hooks": "1.3.14",
-    "@trackunit/react-filter-components": "1.3.14",
-    "@trackunit/react-date-and-time-components": "1.3.14",
-    "@trackunit/shared-utils": "1.5.13",
-    "@trackunit/react-form-components": "1.3.14",
-    "@trackunit/react-core-contexts-api": "1.4.14",
-    "@trackunit/geo-json-utils": "1.3.14",
-    "@trackunit/i18n-library-translation": "1.3.14"
+    "@trackunit/react-components": "1.4.14",
+    "@trackunit/react-core-hooks": "1.3.15",
+    "@trackunit/react-filter-components": "1.3.15",
+    "@trackunit/react-date-and-time-components": "1.3.15",
+    "@trackunit/shared-utils": "1.5.14",
+    "@trackunit/react-form-components": "1.3.15",
+    "@trackunit/react-core-contexts-api": "1.4.15",
+    "@trackunit/geo-json-utils": "1.3.15",
+    "@trackunit/i18n-library-translation": "1.3.15"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/lib/hooks/useFilterBar.d.ts

@@ -1,5 +1,5 @@
 import { AreaFilterGeoJsonGeometry, BooleanValue, DateRangeValue, FilterBarDefinition, FilterStateValues, FilterValueType, InitialState, MinMaxFilterValue, NumberValue, ValueName } from "../types/FilterTypes";
-export interface FilterBarProps<TFilterBarDefinition extends FilterBarDefinition> {
+export type FilterBarProps<TFilterBarDefinition extends FilterBarDefinition> = {
     /**
      * The name of the filter bar.
      */
@@ -8,10 +8,6 @@ export interface FilterBarProps<TFilterBarDefinition extends FilterBarDefinition
      * An optional callback function that gets called when filter values change.
      */
     onValuesChange?: (values: FilterStateValues<TFilterBarDefinition>) => void;
-    /**
-     * An optional initial state for the filter bar.
-     */
-    initialState?: InitialState<TFilterBarDefinition>;
     /**
      * The filters that should potentially be used in the filter bar
      */
@@ -20,14 +16,21 @@ export interface FilterBarProps<TFilterBarDefinition extends FilterBarDefinition
      * Whether the filter bar should be loaded asynchronously
      */
     loadAsync?: boolean;
-}
+    /**
+     * An initial state for the filter bar.
+     */
+    initialState?: {
+        filtered: InitialState<TFilterBarDefinition>;
+        empty: InitialState<TFilterBarDefinition>;
+    };
+};
 /**
  * Custom hook for managing a filter bar's state and actions.
  *
  * @template TFilterBarDefinition - A generic type for the filter bar definition.
  * @returns {object} An object containing filter bar configuration and actions.
  */
-export declare const useFilterBar: <TFilterBarDefinition extends FilterBarDefinition>({ name, onValuesChange, filterBarDefinition, initialState, loadAsync, }: FilterBarProps<TFilterBarDefinition>) => {
+export declare const useFilterBar: <TFilterBarDefinition extends FilterBarDefinition>({ name, onValuesChange, filterBarDefinition, loadAsync, initialState, }: FilterBarProps<TFilterBarDefinition>) => {
     filterBarConfig: {
         getFilterTitle: (key: string) => string;
         getFilterBarName: () => string;
@@ -54,7 +57,10 @@ export declare const useFilterBar: <TFilterBarDefinition extends FilterBarDefini
         resetFiltersToInitialState: () => void;
         resetIndividualFilterToInitialState: (key: string) => void;
         name: string;
-        initialState: InitialState<TFilterBarDefinition>;
+        initialState: {
+            filtered: InitialState<TFilterBarDefinition>;
+            empty: InitialState<TFilterBarDefinition>;
+        };
         starredFilterKeys: Extract<keyof TFilterBarDefinition, string>[];
         values: FilterStateValues<TFilterBarDefinition>;
         setters: import("../types/FilterTypes").FilterStateSetters<TFilterBarDefinition>;

package/src/lib/types/FilterTypes.d.ts

@@ -1,5 +1,6 @@
 import { ReactNode } from "react";
 import { z } from "zod";
+import { FilterBarProps } from "../hooks/useFilterBar";
 export type ValueName = {
     value: string;
     name: string;
@@ -16,7 +17,11 @@ export type MinMaxFilterValue = {
 };
 export declare const areaFilterGeoJsonGeometrySchema: z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"Polygon">;
-    coordinates: z.ZodArray<z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">;
+    coordinates: z.ZodArray<z.ZodEffects<z.
+    /**
+     * A function that determines if the filter should be displayed in the starred filter menu.
+     */
+    ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">;
 }, "strict", z.ZodTypeAny, {
     type: "Polygon";
     coordinates: [number, number][][];
@@ -227,7 +232,7 @@ export interface FilterBarConfig<T extends FilterBarDefinition> extends FilterSt
     /**
      * The initial state of the filters in this filter list.
      */
-    initialState: InitialState<T>;
+    initialState: NonNullable<FilterBarProps<T>["initialState"]>;
     /**
      * Filter names that should be starred for this filter list.
      */

package/src/lib/utils/createInitialState.d.ts

@@ -1,4 +1,5 @@
-import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue, FilterDefinition, InitialState, ValueName } from "../types/FilterTypes";
+import { FilterBarProps } from "../hooks/useFilterBar";
+import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue, FilterDefinition, ValueName } from "../types/FilterTypes";
 type InitialTypes = {
     Arg: "string";
     Init: "";
@@ -42,5 +43,5 @@ export declare const getInitialValueFromType: <TInitialType extends InitialTypes
  * @template TFilterBarDefinition - The type representing the filter bar definition.
  * @returns {FilterBarConfig<TFilterBarDefinition>} - Returns an initial filter bar configuration object.
  */
-export declare const createInitialState: <TFilterBarDefinition extends FilterBarDefinition>(name: string, mainFilters: FilterDefinition[], initialState: InitialState<TFilterBarDefinition>, setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void) => FilterBarConfig<TFilterBarDefinition>;
+export declare const createInitialState: <TFilterBarDefinition extends FilterBarDefinition>(name: string, mainFilters: FilterDefinition[], initialState: NonNullable<FilterBarProps<TFilterBarDefinition>["initialState"]> | {}, setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void) => FilterBarConfig<TFilterBarDefinition>;
 export {};