@trackunit/filters-filter-bar 1.0.64 → 1.0.68

package/index.cjs.js

@@ -1491,6 +1491,66 @@ const getKeysOfUnequalProperties = (obj1, obj2) => {
     }, []);
 };
 
+/**
+ * Handles the application of a URL search parameter as a filter in the system.
+ * The parameter is validated using the provided Zod schema.
+ *
+ * @template T - A Zod schema used for validation.
+ * @param {string} searchParamName - The name of the search parameter in the URL.
+ * @param {string} filterName - The name of the filter.
+ * @param {object} search - The current search state, provided by `useSearch` from @tanstack/react-router.
+ * @param {T} zodSchema - The Zod schema for validating the filter data.
+ * @param {ErrorHandlingContextValue} errorHandler - Error handling context for capturing and reporting exceptions.
+ * @returns {any} The parsed filter data if validation succeeds, otherwise `null`.
+ */
+const useSearchParamAsFilter = ({ searchParamName, filterName, search, zodSchema, errorHandler, }) => {
+    return react.useMemo(() => {
+        if (sharedUtils.objectKeys(search).includes(searchParamName)) {
+            const foundParam = search[searchParamName];
+            try {
+                let jsonParsed;
+                if (zodSchema._def.typeName === "ZodString") {
+                    jsonParsed = foundParam ? foundParam + "" : foundParam;
+                }
+                else {
+                    if (typeof search === "string" && typeof foundParam === "string") {
+                        jsonParsed = JSON.parse(foundParam);
+                    }
+                    else {
+                        jsonParsed = foundParam;
+                    }
+                }
+                const zodParsed = zodSchema.safeParse(jsonParsed);
+                if (zodParsed.success) {
+                    return zodParsed.data;
+                }
+                else {
+                    captureUrlParseException(errorHandler, {
+                        filterName,
+                        param: typeof foundParam === "string" ? foundParam : JSON.stringify(foundParam),
+                        jsonParsed: jsonParsed,
+                        zodParseError: zodParsed.error,
+                    });
+                }
+            }
+            catch (e) {
+                captureUrlParseException(errorHandler, {
+                    filterName,
+                    param: typeof foundParam === "string" ? foundParam : JSON.stringify(foundParam),
+                    jsonParsed: "parse json error",
+                    zodParseError: null,
+                });
+            }
+        }
+        return null;
+    }, [search, searchParamName, zodSchema, errorHandler, filterName]);
+};
+const captureUrlParseException = (errorHandler, { filterName, param, jsonParsed: parsed, }) => errorHandler.captureException(new Error(JSON.stringify({
+    info: `Received invalid values for ${filterName} from URL query params. Can't set ${filterName} filter with this. Please fix the URL query params (or schema).`,
+    param,
+    parsed,
+})));
+
 /**
  * Merges additional filters into an existing filter bar definition.
  *
@@ -1535,4 +1595,5 @@ exports.mergeFilters = mergeFilters;
 exports.mockFilterBar = mockFilterBar;
 exports.toggleFilterValue = toggleFilterValue;
 exports.useFilterBar = useFilterBar;
+exports.useSearchParamAsFilter = useSearchParamAsFilter;
 exports.validateFilter = validateFilter;

package/index.esm.js

@@ -8,7 +8,7 @@ import { capitalize } from 'string-ts';
 import { createEvent } from '@trackunit/react-core-contexts-api';
 import { Search, NumberField, RadioGroup, Toggle } from '@trackunit/react-form-components';
 import { DayRangePicker } from '@trackunit/react-date-and-time-components';
-import { nonNullable, capitalize as capitalize$1, objectValues, truthy } from '@trackunit/shared-utils';
+import { nonNullable, capitalize as capitalize$1, objectValues, truthy, objectKeys } from '@trackunit/shared-utils';
 import { twMerge } from 'tailwind-merge';
 import { dequal } from 'dequal';
 import isEqual from 'lodash/isEqual';
@@ -1489,6 +1489,66 @@ const getKeysOfUnequalProperties = (obj1, obj2) => {
     }, []);
 };
 
+/**
+ * Handles the application of a URL search parameter as a filter in the system.
+ * The parameter is validated using the provided Zod schema.
+ *
+ * @template T - A Zod schema used for validation.
+ * @param {string} searchParamName - The name of the search parameter in the URL.
+ * @param {string} filterName - The name of the filter.
+ * @param {object} search - The current search state, provided by `useSearch` from @tanstack/react-router.
+ * @param {T} zodSchema - The Zod schema for validating the filter data.
+ * @param {ErrorHandlingContextValue} errorHandler - Error handling context for capturing and reporting exceptions.
+ * @returns {any} The parsed filter data if validation succeeds, otherwise `null`.
+ */
+const useSearchParamAsFilter = ({ searchParamName, filterName, search, zodSchema, errorHandler, }) => {
+    return useMemo(() => {
+        if (objectKeys(search).includes(searchParamName)) {
+            const foundParam = search[searchParamName];
+            try {
+                let jsonParsed;
+                if (zodSchema._def.typeName === "ZodString") {
+                    jsonParsed = foundParam ? foundParam + "" : foundParam;
+                }
+                else {
+                    if (typeof search === "string" && typeof foundParam === "string") {
+                        jsonParsed = JSON.parse(foundParam);
+                    }
+                    else {
+                        jsonParsed = foundParam;
+                    }
+                }
+                const zodParsed = zodSchema.safeParse(jsonParsed);
+                if (zodParsed.success) {
+                    return zodParsed.data;
+                }
+                else {
+                    captureUrlParseException(errorHandler, {
+                        filterName,
+                        param: typeof foundParam === "string" ? foundParam : JSON.stringify(foundParam),
+                        jsonParsed: jsonParsed,
+                        zodParseError: zodParsed.error,
+                    });
+                }
+            }
+            catch (e) {
+                captureUrlParseException(errorHandler, {
+                    filterName,
+                    param: typeof foundParam === "string" ? foundParam : JSON.stringify(foundParam),
+                    jsonParsed: "parse json error",
+                    zodParseError: null,
+                });
+            }
+        }
+        return null;
+    }, [search, searchParamName, zodSchema, errorHandler, filterName]);
+};
+const captureUrlParseException = (errorHandler, { filterName, param, jsonParsed: parsed, }) => errorHandler.captureException(new Error(JSON.stringify({
+    info: `Received invalid values for ${filterName} from URL query params. Can't set ${filterName} filter with this. Please fix the URL query params (or schema).`,
+    param,
+    parsed,
+})));
+
 /**
  * Merges additional filters into an existing filter bar definition.
  *
@@ -1510,4 +1570,4 @@ const mergeFilters = (filterBarDefinition, extraFilters) => {
  */
 setupLibraryTranslations();
 
-export { DefaultCheckboxFilter, DefaultDateRangeFilter, DefaultMinMaxFilter, DefaultRadioFilter, DynamicFilterList, FilterBar, FilterEvents, FilterHeader, FilterResults, StarredFilters, areaFilterGeoJsonGeometrySchema, isAreaFilterValue, isArrayFilterValue, isBooleanValue, isDateRangeValue, isMinMaxFilterValue, isStringArrayFilterValue, isValueName, isValueNameArray, mergeFilters, mockFilterBar, toggleFilterValue, useFilterBar, validateFilter };
+export { DefaultCheckboxFilter, DefaultDateRangeFilter, DefaultMinMaxFilter, DefaultRadioFilter, DynamicFilterList, FilterBar, FilterEvents, FilterHeader, FilterResults, StarredFilters, areaFilterGeoJsonGeometrySchema, isAreaFilterValue, isArrayFilterValue, isBooleanValue, isDateRangeValue, isMinMaxFilterValue, isStringArrayFilterValue, isValueName, isValueNameArray, mergeFilters, mockFilterBar, toggleFilterValue, useFilterBar, useSearchParamAsFilter, validateFilter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-filter-bar",
-  "version": "1.0.64",
+  "version": "1.0.68",
   "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.1.43",
-    "@trackunit/react-core-hooks": "1.0.42",
-    "@trackunit/react-filter-components": "1.0.64",
-    "@trackunit/react-date-and-time-components": "1.0.62",
-    "@trackunit/shared-utils": "1.2.34",
-    "@trackunit/react-form-components": "1.0.62",
-    "@trackunit/react-core-contexts-api": "1.0.42",
-    "@trackunit/geo-json-utils": "1.0.38",
-    "@trackunit/i18n-library-translation": "1.0.46"
+    "@trackunit/react-components": "1.1.47",
+    "@trackunit/react-core-hooks": "1.0.45",
+    "@trackunit/react-filter-components": "1.0.68",
+    "@trackunit/react-date-and-time-components": "1.0.66",
+    "@trackunit/shared-utils": "1.2.37",
+    "@trackunit/react-form-components": "1.0.66",
+    "@trackunit/react-core-contexts-api": "1.0.45",
+    "@trackunit/geo-json-utils": "1.0.41",
+    "@trackunit/i18n-library-translation": "1.0.50"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

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

@@ -0,0 +1,23 @@
+import { ErrorHandlingContextValue } from "@trackunit/react-core-contexts-api";
+import { ZodTypeAny } from "zod";
+interface SearchParamAsFilterProps<T> {
+    searchParamName: string;
+    filterName: string;
+    search: Record<PropertyKey, unknown>;
+    zodSchema: T;
+    errorHandler: ErrorHandlingContextValue;
+}
+/**
+ * Handles the application of a URL search parameter as a filter in the system.
+ * The parameter is validated using the provided Zod schema.
+ *
+ * @template T - A Zod schema used for validation.
+ * @param {string} searchParamName - The name of the search parameter in the URL.
+ * @param {string} filterName - The name of the filter.
+ * @param {object} search - The current search state, provided by `useSearch` from @tanstack/react-router.
+ * @param {T} zodSchema - The Zod schema for validating the filter data.
+ * @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 {};

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/useSearchParamAsFilter";
 export * from "./types/FilterTypes";
 export * from "./utils/FilterEvents";
 export * from "./utils/mergeFilters";