@trackunit/filters-filter-bar 1.18.4 → 1.18.5

package/index.cjs.js

@@ -2516,6 +2516,41 @@ const useFilterBarAsync = ({ name, onValuesChange, filterBarDefinition, loadData
     }, [filterBarConfigMemoed, internalFilterBarDefinitions, dataLoaded, name, stableOnValuesChange]);
 };
 
+/**
+ * Converts a filter bar configuration to a link.
+ *
+ * @example
+ * ```ts
+ * const filterBarLinkConfig: FilterBarToLinkConfig = {
+ *   searchPropertyName: "assetFilters",
+ *   filterBar: "ASSETS",
+ * };
+ *
+ * const { getFilterBarLink } = useFilterBarsAsLink(filterBarLinkConfig);
+ *
+ * const link = getFilterBarLink({ ASSETS: { search: "excavator" } });
+ * ```
+ * @param filterBarLinkConfig - The filter bar configuration to convert to a link.
+ * @returns { UseFilterBarsAsLinkResult } An object with a `getFilterBarLink` function that takes a merged filter bar definitions and returns a link.
+ */
+const useFilterBarsAsLink = (filterBarLinkConfig) => {
+    const filterBarLinkConfigArray = react.useMemo(() => {
+        return Array.isArray(filterBarLinkConfig) ? filterBarLinkConfig : filterBarLinkConfig ? [filterBarLinkConfig] : [];
+    }, [filterBarLinkConfig]);
+    const { encode } = reactComponents.useCustomEncoding();
+    const getFilterBarLink = react.useCallback((mergedFilterBarDefinitions) => {
+        return filterBarLinkConfigArray
+            .map(config => {
+            const value = mergedFilterBarDefinitions[config.filterBar];
+            return `${config.searchPropertyName || "filter"}=${value ? encode(value) : ""}`;
+        })
+            .join("&");
+    }, [filterBarLinkConfigArray, encode]);
+    return react.useMemo(() => {
+        return { getFilterBarLink };
+    }, [getFilterBarLink]);
+};
+
 /**
  * Handles the application of a URL search parameter as a filter in the system.
  * The parameter is validated using the provided Zod schema.
@@ -2633,6 +2668,7 @@ exports.stringSchema = stringSchema;
 exports.toggleFilterValue = toggleFilterValue;
 exports.useFilterBar = useFilterBar;
 exports.useFilterBarAsync = useFilterBarAsync;
+exports.useFilterBarsAsLink = useFilterBarsAsLink;
 exports.useFiltersMenu = useFiltersMenu;
 exports.useSearchParamAsFilter = useSearchParamAsFilter;
 exports.validateFilter = validateFilter;

package/index.esm.js

@@ -2514,6 +2514,41 @@ const useFilterBarAsync = ({ name, onValuesChange, filterBarDefinition, loadData
     }, [filterBarConfigMemoed, internalFilterBarDefinitions, dataLoaded, name, stableOnValuesChange]);
 };
 
+/**
+ * Converts a filter bar configuration to a link.
+ *
+ * @example
+ * ```ts
+ * const filterBarLinkConfig: FilterBarToLinkConfig = {
+ *   searchPropertyName: "assetFilters",
+ *   filterBar: "ASSETS",
+ * };
+ *
+ * const { getFilterBarLink } = useFilterBarsAsLink(filterBarLinkConfig);
+ *
+ * const link = getFilterBarLink({ ASSETS: { search: "excavator" } });
+ * ```
+ * @param filterBarLinkConfig - The filter bar configuration to convert to a link.
+ * @returns { UseFilterBarsAsLinkResult } An object with a `getFilterBarLink` function that takes a merged filter bar definitions and returns a link.
+ */
+const useFilterBarsAsLink = (filterBarLinkConfig) => {
+    const filterBarLinkConfigArray = useMemo(() => {
+        return Array.isArray(filterBarLinkConfig) ? filterBarLinkConfig : filterBarLinkConfig ? [filterBarLinkConfig] : [];
+    }, [filterBarLinkConfig]);
+    const { encode } = useCustomEncoding();
+    const getFilterBarLink = useCallback((mergedFilterBarDefinitions) => {
+        return filterBarLinkConfigArray
+            .map(config => {
+            const value = mergedFilterBarDefinitions[config.filterBar];
+            return `${config.searchPropertyName || "filter"}=${value ? encode(value) : ""}`;
+        })
+            .join("&");
+    }, [filterBarLinkConfigArray, encode]);
+    return useMemo(() => {
+        return { getFilterBarLink };
+    }, [getFilterBarLink]);
+};
+
 /**
  * Handles the application of a URL search parameter as a filter in the system.
  * The parameter is validated using the provided Zod schema.
@@ -2590,4 +2625,4 @@ const mergeFilters = (filterBarDefinition, extraFilters) => {
  */
 setupLibraryTranslations();
 
-export { AppliedFiltersRenderer, DefaultCheckboxFilter, DefaultDateRangeFilter, DefaultMinMaxFilter, DefaultRadioFilter, DynamicFilterList, FilterBar, FilterButtonTooltipLabel, FilterComponent, FilterEvents, FilterHeader, FilterResults, FilterTableComponent, FiltersMenu, FiltersMenuContent, FiltersRenderer, GroupedFiltersList, HierarchicalCheckboxFilter, MultipleFilterTooltipLabel, ResetFiltersButton, TooltipLabel, areaFilterGeoJsonGeometrySchema, booleanSchema, dateRangeSchema, isAreaFilterValue, isArrayFilterValue, isBooleanValue, isDateRangeValue, isMinMaxFilterValue, isStringArrayFilterValue, isValueName, isValueNameArray, mergeFilters, minMaxFilterSchema, mockFilterBar, numberSchema, stringArraySchema, stringSchema, toggleFilterValue, useFilterBar, useFilterBarAsync, useFiltersMenu, useSearchParamAsFilter, validateFilter, valueNameArraySchema, valueNameSchema };
+export { AppliedFiltersRenderer, DefaultCheckboxFilter, DefaultDateRangeFilter, DefaultMinMaxFilter, DefaultRadioFilter, DynamicFilterList, FilterBar, FilterButtonTooltipLabel, FilterComponent, FilterEvents, FilterHeader, FilterResults, FilterTableComponent, FiltersMenu, FiltersMenuContent, FiltersRenderer, GroupedFiltersList, HierarchicalCheckboxFilter, MultipleFilterTooltipLabel, ResetFiltersButton, TooltipLabel, areaFilterGeoJsonGeometrySchema, booleanSchema, dateRangeSchema, isAreaFilterValue, isArrayFilterValue, isBooleanValue, isDateRangeValue, isMinMaxFilterValue, isStringArrayFilterValue, isValueName, isValueNameArray, mergeFilters, minMaxFilterSchema, mockFilterBar, numberSchema, stringArraySchema, stringSchema, toggleFilterValue, useFilterBar, useFilterBarAsync, useFilterBarsAsLink, useFiltersMenu, useSearchParamAsFilter, validateFilter, valueNameArraySchema, valueNameSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-filter-bar",
-  "version": "1.18.4",
+  "version": "1.18.5",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -11,17 +11,17 @@
     "tailwind-merge": "^2.0.0",
     "string-ts": "^2.0.0",
     "zod": "^3.23.8",
-    "@trackunit/iris-app-api": "1.15.8",
+    "@trackunit/iris-app-api": "1.15.9",
     "@trackunit/react-core-hooks": "1.14.2",
-    "@trackunit/react-filter-components": "1.17.3",
-    "@trackunit/react-date-and-time-components": "1.20.3",
+    "@trackunit/react-filter-components": "1.17.4",
+    "@trackunit/react-date-and-time-components": "1.20.4",
     "@trackunit/shared-utils": "1.13.77",
-    "@trackunit/react-form-components": "1.18.2",
+    "@trackunit/react-form-components": "1.18.3",
     "@trackunit/iris-app-runtime-core-api": "1.13.2",
     "@trackunit/geo-json-utils": "1.11.78",
-    "@trackunit/i18n-library-translation": "1.15.2",
+    "@trackunit/i18n-library-translation": "1.15.3",
     "@trackunit/css-class-variance-utilities": "1.11.77",
-    "@trackunit/react-components": "1.20.2"
+    "@trackunit/react-components": "1.20.3"
   },
   "peerDependencies": {
     "react": "^19.0.0",

package/src/index.d.ts

@@ -23,6 +23,7 @@ export * from "./lib/hooks/mockFilterBar";
 export * from "./lib/hooks/types";
 export * from "./lib/hooks/useFilterBar";
 export * from "./lib/hooks/useFilterBarAsync";
+export * from "./lib/hooks/useFilterBarsAsLink";
 export * from "./lib/hooks/useFiltersMenu";
 export * from "./lib/hooks/useSearchParamAsFilter";
 export * from "./lib/types/FilterTypes";

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

@@ -0,0 +1,37 @@
+import { AssetFilterKeysWithCustomFields, CustomerFilterKeysWithCustomFields, FilterBarToLinkConfig, SiteFilterKeysWithCustomFields } from "@trackunit/iris-app-api";
+export type FiltersConfigValues = {
+    ASSETS?: Partial<Record<AssetFilterKeysWithCustomFields[number], unknown>>;
+    SITES?: Partial<Record<SiteFilterKeysWithCustomFields[number], unknown>>;
+    CUSTOMERS?: Partial<Record<CustomerFilterKeysWithCustomFields[number], unknown>>;
+    TIME_RANGE?: Record<string, unknown> | null;
+};
+/**
+ * The result of the useFilterBarsAsLink hook.
+ */
+export interface UseFilterBarsAsLinkResult {
+    /**
+     * Gets the filter bar link.
+     *
+     * @param mergedFilterBarDefinitions - The merged filter bar definitions.
+     * @returns The filter bar link.
+     */
+    getFilterBarLink: (mergedFilterBarDefinitions: FiltersConfigValues) => string;
+}
+/**
+ * Converts a filter bar configuration to a link.
+ *
+ * @example
+ * ```ts
+ * const filterBarLinkConfig: FilterBarToLinkConfig = {
+ *   searchPropertyName: "assetFilters",
+ *   filterBar: "ASSETS",
+ * };
+ *
+ * const { getFilterBarLink } = useFilterBarsAsLink(filterBarLinkConfig);
+ *
+ * const link = getFilterBarLink({ ASSETS: { search: "excavator" } });
+ * ```
+ * @param filterBarLinkConfig - The filter bar configuration to convert to a link.
+ * @returns { UseFilterBarsAsLinkResult } An object with a `getFilterBarLink` function that takes a merged filter bar definitions and returns a link.
+ */
+export declare const useFilterBarsAsLink: (filterBarLinkConfig: FilterBarToLinkConfig | Array<FilterBarToLinkConfig> | null) => UseFilterBarsAsLinkResult;