@trackunit/filters-filter-bar 1.3.40 → 1.3.43

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-filter-bar",
-  "version": "1.3.40",
+  "version": "1.3.43",
   "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.28",
-    "@trackunit/react-core-hooks": "1.3.29",
-    "@trackunit/react-filter-components": "1.3.33",
-    "@trackunit/react-date-and-time-components": "1.3.30",
-    "@trackunit/shared-utils": "1.5.28",
-    "@trackunit/react-form-components": "1.3.33",
-    "@trackunit/react-core-contexts-api": "1.4.29",
-    "@trackunit/geo-json-utils": "1.3.29",
-    "@trackunit/i18n-library-translation": "1.3.29"
+    "@trackunit/react-components": "1.4.31",
+    "@trackunit/react-core-hooks": "1.3.31",
+    "@trackunit/react-filter-components": "1.3.36",
+    "@trackunit/react-date-and-time-components": "1.3.33",
+    "@trackunit/shared-utils": "1.5.30",
+    "@trackunit/react-form-components": "1.3.36",
+    "@trackunit/react-core-contexts-api": "1.4.31",
+    "@trackunit/geo-json-utils": "1.3.31",
+    "@trackunit/i18n-library-translation": "1.3.31"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/lib/components/FilterHeader.d.ts

@@ -25,12 +25,9 @@ interface FilterHeaderCommonProps extends CommonProps {
      */
     resetIndividualFilterToInitialState: (key: string) => void;
     /**
-     * A function to check if the filter has changed.
-     *
-     * @param {string} key - The key of the filter to check.
-     * @returns {boolean} - `true` if the filter has changed, `false` otherwise.
+     * A boolean value to check if the filter has changed.
      */
-    filterHasChanged(key: string): boolean;
+    filterHasChanges: boolean;
     /**
      * The children to render in the header of the filter.
      */
@@ -67,5 +64,5 @@ type FilterHeaderProps = FilterHeaderCommonProps & FilterHeaderWithSearchProps;
  *
  * @returns {ReactElement} - Returns the FilterHeader component.
  */
-export declare const FilterHeader: ({ filterKey, title, searchEnabled, searchProps, filterHasChanged, resetIndividualFilterToInitialState, onResetFilter, loading, children, className, dataTestId, }: FilterHeaderProps) => ReactElement;
+export declare const FilterHeader: ({ filterKey, title, searchEnabled, searchProps, filterHasChanges, resetIndividualFilterToInitialState, onResetFilter, loading, children, className, dataTestId, }: FilterHeaderProps) => ReactElement;
 export {};

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

@@ -1,2 +1,42 @@
-import { useFilterBar } from "./useFilterBar";
-export declare const mockFilterBar: ReturnType<typeof useFilterBar>;
+export declare const mockFilterBar: {
+    filterBarConfig: {
+        isFilterIncludedByKey: (args?: any) => any;
+        appliedFilterKeys: () => never[];
+        arrayIncludesValue: (args?: any) => any;
+        getFilterTitle: (args?: any) => any;
+        getFilterBarName: (args?: any) => any;
+        initialState: {
+            customerType: never[];
+        };
+        name: string;
+        objectArrayIncludesValue: (args?: any) => any;
+        resetFiltersToInitialState: (args?: any) => any;
+        resetIndividualFilterToInitialState: (args?: any) => any;
+        updateStarredFilters: (args?: any) => any;
+        setArrayObjectValue: (args?: any) => any;
+        setArrayValue: (args?: any) => any;
+        setBooleanValue: (args?: any) => any;
+        setArea: (args?: any) => any;
+        setDateRange: (args?: any) => any;
+        setMinMaxValue: (args?: any) => any;
+        setNumberValue: (args?: any) => any;
+        setStringValue: (args?: any) => any;
+        toggleArrayObjectValue: (args?: any) => any;
+        toggleArrayValue: (args?: any) => any;
+        values: {
+            customerType: never[];
+        };
+        starredFilterKeys: never[];
+        getValuesByKey: (args?: any) => any;
+        setters: {
+            setCriticality: (args?: any) => any;
+            setServicePlan: (args?: any) => any;
+        };
+        objectIncludesValue: (args?: any) => any;
+        setObjectValue: (args?: any) => any;
+        toggleObjectValue: (args?: any) => any;
+    };
+    filterBarDefinition: {};
+    name: string;
+    onValuesChange: (args?: any) => any;
+};

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

@@ -0,0 +1,15 @@
+import { FilterBarDefinition, FilterStateValues } from "../types/FilterTypes";
+export type FilterBarProps<TFilterBarDefinition extends FilterBarDefinition> = {
+    /**
+     * The name of the filter bar.
+     */
+    name: string;
+    /**
+     * An optional callback function that gets called when filter values change.
+     */
+    onValuesChange?: (values: FilterStateValues<TFilterBarDefinition>) => void;
+    /**
+     * The filters that should potentially be used in the filter bar
+     */
+    filterBarDefinition: TFilterBarDefinition;
+};

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

@@ -1,70 +1,15 @@
-import { AreaFilterGeoJsonGeometry, BooleanValue, DateRangeValue, FilterBarDefinition, FilterStateValues, FilterValueType, InitialState, MinMaxFilterValue, NumberValue, ValueName } from "../types/FilterTypes";
-export type FilterBarProps<TFilterBarDefinition extends FilterBarDefinition> = {
-    /**
-     * The name of the filter bar.
-     */
+import { FilterBarConfig, FilterBarDefinition, FilterMapActions, FilterMapGetter, FilterStateValues } from "../types/FilterTypes";
+import { FilterBarProps } from "./types";
+export interface FilterBarHook<TFilterBarDefinition extends FilterBarDefinition> {
+    filterBarConfig: FilterBarConfig<TFilterBarDefinition> & FilterMapActions & FilterMapGetter;
+    filterBarDefinition: TFilterBarDefinition;
     name: string;
-    /**
-     * An optional callback function that gets called when filter values change.
-     */
     onValuesChange?: (values: FilterStateValues<TFilterBarDefinition>) => void;
-    /**
-     * The filters that should potentially be used in the filter bar
-     */
-    filterBarDefinition: TFilterBarDefinition;
-    /**
-     * 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, loadAsync, initialState, }: FilterBarProps<TFilterBarDefinition>) => {
-    filterBarConfig: {
-        getFilterTitle: (key: string) => string;
-        getFilterBarName: () => string;
-        objectArrayIncludesValue: (key: string, value: string) => boolean;
-        objectIncludesValue: (key: string, value: string) => boolean;
-        getValuesByKey: (key: string) => FilterValueType;
-        arrayIncludesValue: (key: string, value: string | boolean) => boolean;
-        appliedFilterKeys: (keyof FilterBarDefinition)[];
-        filterHasChanged(key: string): boolean;
-        isFilterIncludedByKey(key: string): boolean;
-        updateStarredFilters: (filterkey: string) => void;
-        toggleArrayValue: (key: string, value: string) => void;
-        setStringValue: (key: string, value: string) => void;
-        setArrayValue: (key: string, value: string[]) => void;
-        setArea: (area: AreaFilterGeoJsonGeometry) => void;
-        setNumberValue: (key: string, value: NumberValue) => void;
-        setBooleanValue: (key: string, value: BooleanValue) => void;
-        setDateRange: (key: string, value: DateRangeValue) => void;
-        setMinMaxValue: (key: string, minMaxValue: MinMaxFilterValue) => void;
-        setArrayObjectValue: (key: string, value: ValueName[]) => void;
-        setObjectValue: (key: string, value: ValueName) => void;
-        toggleArrayObjectValue: (key: string, value: ValueName) => void;
-        toggleObjectValue: (key: string, value: ValueName) => void;
-        resetFiltersToInitialState: () => void;
-        resetIndividualFilterToInitialState: (key: string) => void;
-        name: string;
-        initialState: {
-            filtered: InitialState<TFilterBarDefinition>;
-            empty: InitialState<TFilterBarDefinition>;
-        };
-        starredFilterKeys: Extract<keyof TFilterBarDefinition, string>[];
-        values: FilterStateValues<TFilterBarDefinition>;
-        setters: import("../types/FilterTypes").FilterStateSetters<TFilterBarDefinition>;
-    };
-    filterBarDefinition: TFilterBarDefinition;
-    dataLoaded: <TFilterBarDefinitionExtended extends TFilterBarDefinition>(loadedFilterDefinitionsValues: TFilterBarDefinitionExtended) => void;
-};
+export declare const useFilterBar: <TFilterBarDefinition extends FilterBarDefinition>({ name, onValuesChange, filterBarDefinition, }: FilterBarProps<TFilterBarDefinition>) => FilterBarHook<TFilterBarDefinition>;

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

@@ -0,0 +1,13 @@
+import { FilterBarDefinition } from "../types/FilterTypes";
+import { FilterBarProps } from "./types";
+import { FilterBarHook } from "./useFilterBar";
+export interface FilterBarAsyncHook<TFilterBarDefinition extends FilterBarDefinition> extends FilterBarHook<TFilterBarDefinition> {
+    dataLoaded: (filterBarDefinition: TFilterBarDefinition) => void;
+}
+/**
+ * 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 useFilterBarAsync: <TFilterBarDefinition extends FilterBarDefinition>({ name, onValuesChange, filterBarDefinition, }: FilterBarProps<TFilterBarDefinition>) => FilterBarAsyncHook<TFilterBarDefinition>;

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

@@ -1,10 +1,10 @@
 import { ErrorHandlingContextValue } from "@trackunit/react-core-contexts-api";
 import { ZodTypeAny } from "zod";
-interface SearchParamAsFilterProps<T> {
+interface SearchParamAsFilterProps<TZodSchema> {
     searchParamName: string;
     filterName: string;
     search: Record<PropertyKey, unknown>;
-    zodSchema: T;
+    zodSchema: TZodSchema;
     errorHandler: ErrorHandlingContextValue;
 }
 /**
@@ -19,5 +19,5 @@ interface SearchParamAsFilterProps<T> {
  * @param {ErrorHandlingContextValue} errorHandler - Error handling context for capturing and reporting exceptions.
  * @returns {any} The parsed filter data if validation succeeds, otherwise `null`.
  */
-export declare const useSearchParamAsFilter: <T extends ZodTypeAny>({ searchParamName, filterName, search, zodSchema, errorHandler, }: SearchParamAsFilterProps<T>) => any;
+export declare const useSearchParamAsFilter: <TZodSchema extends ZodTypeAny>({ searchParamName, filterName, search, zodSchema, errorHandler, }: SearchParamAsFilterProps<TZodSchema>) => any;
 export {};

package/src/lib/hooks/utils/useFilterBarActions.d.ts

@@ -0,0 +1,20 @@
+import { Dispatch, SetStateAction } from "react";
+import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue, FilterMapActions, FilterMapGetter, InitialState } from "../../types/FilterTypes";
+/**
+ * Custom hook for managing a filter bar's actions  .
+ *
+ * @template TFilterBarDefinition - A generic type for the filter bar definition.
+ * @returns {object} An object containing filter bar configuration and actions.
+ */
+declare const useFilterBarActions: <TFilterBarDefinition extends FilterBarDefinition>({ name, filterBarConfig, filterBarDefinition, setFilterBarConfig, setValue, initialState, }: {
+    name: string;
+    filterBarConfig: FilterBarConfig<TFilterBarDefinition>;
+    filterBarDefinition: FilterBarDefinition;
+    setFilterBarConfig: Dispatch<SetStateAction<FilterBarConfig<TFilterBarDefinition>>>;
+    setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void;
+    initialState?: InitialState<TFilterBarDefinition>;
+}) => {
+    filterMapGetter: FilterMapGetter;
+    filterMapActions: FilterMapActions;
+};
+export default useFilterBarActions;

package/src/lib/hooks/utils/useFilterBarPersistence.d.ts

@@ -0,0 +1,17 @@
+import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue } from "../../types/FilterTypes";
+type FilterBarPersistenceProps<TFilterBarDefinition extends FilterBarDefinition> = {
+    name: string;
+    setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void;
+};
+/**
+ * Custom hook for managing the persistence of filter bar configurations.
+ *
+ * @template TFilterBarDefinition - The type of the filter bar definition.
+ * @param {FilterBarPersistenceProps<TFilterBarDefinition>} props - The props for the filter bar persistence.
+ * @returns { object } An object containing the loadData and saveData functions.
+ */
+export declare const useFilterBarPersistence: <TFilterBarDefinition extends FilterBarDefinition>({ name, setValue, }: FilterBarPersistenceProps<TFilterBarDefinition>) => {
+    loadData: <TFilterBarDefinitionExtended extends TFilterBarDefinition>(updatedFilterDefinitionsValues: TFilterBarDefinitionExtended[keyof TFilterBarDefinitionExtended][]) => FilterBarConfig<TFilterBarDefinition>;
+    saveData: (filterBarConfig: Partial<FilterBarConfig<TFilterBarDefinition>>) => void;
+};
+export {};

package/src/lib/hooks/utils/useGenericSetValue.d.ts

@@ -0,0 +1,11 @@
+import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue } from "../../types/FilterTypes";
+import { Dispatch, SetStateAction } from "react";
+/**
+ * Generic hook for setting the value of a filter bar.
+ *
+ * @template TFilterBarDefinition - The type of the filter bar definition.
+ * @returns {object} An object containing the setValue function.
+ */
+export declare const useGenericSetValue: <TFilterBarDefinition extends FilterBarDefinition>() => {
+    setValue: (setFilterBarConfig: Dispatch<SetStateAction<FilterBarConfig<TFilterBarDefinition>>>, key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void;
+};

package/src/lib/index.d.ts

@@ -2,6 +2,7 @@ export * from "./components";
 export * from "./FilterBar";
 export * from "./hooks/mockFilterBar";
 export * from "./hooks/useFilterBar";
+export * from "./hooks/useFilterBarAsync";
 export * from "./hooks/useSearchParamAsFilter";
 export * from "./types/FilterTypes";
 export * from "./utils/FilterEvents";

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

@@ -1,6 +1,5 @@
 import { ReactNode } from "react";
 import { z } from "zod";
-import { FilterBarProps } from "../hooks/useFilterBar";
 export type ValueName = {
     value: string;
     name: string;
@@ -17,11 +16,9 @@ export type MinMaxFilterValue = {
 };
 export declare const areaFilterGeoJsonGeometrySchema: z.ZodUnion<[z.ZodObject<{
     type: z.ZodLiteral<"Polygon">;
-    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">;
+    coordinates: z.ZodArray<z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber /**
+     * A function that determines if the filter should be displayed in the filter bar.
+     */], null>, "many">, [number, number][], [number, number][]>, "many">;
 }, "strict", z.ZodTypeAny, {
     type: "Polygon";
     coordinates: [number, number][][];
@@ -65,8 +62,7 @@ export type FilterMapGetter = {
     objectIncludesValue: (key: string, value: string) => boolean;
     getValuesByKey: (key: string) => FilterValueType;
     arrayIncludesValue: (key: string, value: string | boolean) => boolean;
-    readonly appliedFilterKeys: (keyof FilterBarDefinition)[];
-    filterHasChanged(key: string): boolean;
+    appliedFilterKeys: () => (keyof FilterBarDefinition)[];
     isFilterIncludedByKey(key: string): boolean;
 };
 export type FilterName = string;
@@ -229,12 +225,12 @@ export interface FilterState<T extends FilterBarDefinition> {
  */
 export interface FilterBarConfig<T extends FilterBarDefinition> extends FilterState<T> {
     name: string;
-    /**
-     * The initial state of the filters in this filter list.
-     */
-    initialState: NonNullable<FilterBarProps<T>["initialState"]>;
     /**
      * Filter names that should be starred for this filter list.
      */
     starredFilterKeys: ExtractFilterKeys<T>[];
+    /**
+     * The initial state of the filter bar - used to restore the filter bar to its initial state, and to validate if a filter has been changed from the initial state.
+     */
+    initialState: InitialState<T>;
 }

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

@@ -0,0 +1,5 @@
+import { FilterBarDefinition, FilterBarInferredValue, FilterDefinition, FilterStateSetters } from "../types/FilterTypes";
+/**
+ *
+ */
+export declare const createFilterSetters: <TFilterBarDefinition extends FilterBarDefinition>(mainFilters: FilterDefinition[], setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void) => FilterStateSetters<TFilterBarDefinition>;

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

@@ -0,0 +1,5 @@
+import { FilterDefinition } from "../types/FilterTypes";
+/**
+ *
+ */
+export declare const createFilterValues: (mainFilters: FilterDefinition[], useDefaultValues?: boolean) => {};

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

@@ -1,4 +1,3 @@
-import { FilterBarProps } from "../hooks/useFilterBar";
 import { FilterBarConfig, FilterBarDefinition, FilterBarInferredValue, FilterDefinition, ValueName } from "../types/FilterTypes";
 type InitialTypes = {
     Arg: "string";
@@ -43,5 +42,9 @@ 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: NonNullable<FilterBarProps<TFilterBarDefinition>["initialState"]> | {}, setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void) => FilterBarConfig<TFilterBarDefinition>;
+export declare const createInitialState: <TFilterBarDefinition extends FilterBarDefinition>({ name, mainFilters, setValue, }: {
+    name: string;
+    mainFilters: FilterDefinition[];
+    setValue: (key: string, callback: (prev: FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => FilterBarInferredValue<TFilterBarDefinition, never> | undefined) => void;
+}) => FilterBarConfig<TFilterBarDefinition>;
 export {};

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

@@ -42,4 +42,8 @@ export declare const isValueNameArray: (value: FilterDefinitionValue) => value i
  * @param {FilterDefinition[]} filterDefinitions - An array of filter definitions to validate against.
  * @returns {boolean} - Returns `true` if the filter configuration is valid, otherwise `false`.
  */
-export declare const validateFilter: <TFilterBarDefinition extends FilterBarDefinition>(filter: FilterBarConfig<TFilterBarDefinition> | undefined, filterDefinitions: FilterDefinition[]) => boolean;
+export declare const validateFilter: <TFilterBarDefinition extends FilterBarDefinition>({ values, starredFilterKeys, filterDefinitions, }: {
+    values: FilterBarConfig<TFilterBarDefinition>["values"];
+    starredFilterKeys: FilterBarConfig<TFilterBarDefinition>["starredFilterKeys"];
+    filterDefinitions: FilterDefinition[];
+}) => boolean;