@trackunit/filters-filter-bar 0.1.19 → 0.1.20

package/index.cjs.js

@@ -15,6 +15,8 @@ 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');
 
 var defaultTranslations = {
 	"access.management.filter.operator.role.keyAdmin": "Key Admin",
@@ -1000,6 +1002,8 @@ const createInitialState = (name, mainFilters, initialState, setValue) => {
     return newFilter;
 };
 
+const areaFilterGeoJsonGeometrySchema = zod.z.union([geoJsonUtils.geoJsonPolygonSchema, geoJsonUtils.geoJsonMultiPolygonSchema]);
+
 const hasValue = (value) => {
     if (value === undefined || value === null) {
         return false;
@@ -1046,10 +1050,7 @@ const isDateRangeValue = (value) => {
 }
  */
 const isAreaFilterValue = (value) => {
-    // eslint-disable-next-line no-autofix/local-rules/prefer-custom-object-keys
-    return value
-        ? typeof value === "object" && Object.keys(value).includes("coordinates") && Object.keys(value).includes("type")
-        : false;
+    return areaFilterGeoJsonGeometrySchema.safeParse(value).success;
 };
 /**
  *
@@ -1512,6 +1513,7 @@ exports.FilterEvents = FilterEvents;
 exports.FilterHeader = FilterHeader;
 exports.FilterResults = FilterResults;
 exports.StarredFilters = StarredFilters;
+exports.areaFilterGeoJsonGeometrySchema = areaFilterGeoJsonGeometrySchema;
 exports.isAreaFilterValue = isAreaFilterValue;
 exports.isArrayFilterValue = isArrayFilterValue;
 exports.isBooleanValue = isBooleanValue;

package/index.esm.js

@@ -13,6 +13,8 @@ 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';
 
 var defaultTranslations = {
 	"access.management.filter.operator.role.keyAdmin": "Key Admin",
@@ -998,6 +1000,8 @@ const createInitialState = (name, mainFilters, initialState, setValue) => {
     return newFilter;
 };
 
+const areaFilterGeoJsonGeometrySchema = z.union([geoJsonPolygonSchema, geoJsonMultiPolygonSchema]);
+
 const hasValue = (value) => {
     if (value === undefined || value === null) {
         return false;
@@ -1044,10 +1048,7 @@ const isDateRangeValue = (value) => {
 }
  */
 const isAreaFilterValue = (value) => {
-    // eslint-disable-next-line no-autofix/local-rules/prefer-custom-object-keys
-    return value
-        ? typeof value === "object" && Object.keys(value).includes("coordinates") && Object.keys(value).includes("type")
-        : false;
+    return areaFilterGeoJsonGeometrySchema.safeParse(value).success;
 };
 /**
  *
@@ -1500,4 +1501,4 @@ const mergeFilters = (filterBarDefinition, extraFilters) => {
  */
 setupLibraryTranslations();
 
-export { DefaultCheckboxFilter, DefaultDateRangeFilter, DefaultMinMaxFilter, DefaultRadioFilter, DynamicFilterList, FilterBar, FilterEvents, FilterHeader, FilterResults, StarredFilters, 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, validateFilter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/filters-filter-bar",
-  "version": "0.1.19",
+  "version": "0.1.20",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -13,15 +13,16 @@
     "jest-fetch-mock": "^3.0.3",
     "tailwind-merge": "^2.0.0",
     "string-ts": "^2.0.0",
-    "@trackunit/react-components": "^0.5.41",
-    "@trackunit/react-core-hooks": "^0.2.272",
-    "@trackunit/react-filter-components": "^0.1.17",
-    "@trackunit/react-date-and-time-components": "^0.0.216",
+    "zod": "3.22.4",
+    "@trackunit/react-components": "^0.5.42",
+    "@trackunit/react-core-hooks": "^0.2.273",
+    "@trackunit/react-filter-components": "^0.1.18",
+    "@trackunit/react-date-and-time-components": "^0.0.217",
     "@trackunit/shared-utils": "^0.0.92",
-    "@trackunit/react-form-components": "^0.2.11",
-    "@trackunit/react-core-contexts-api": "^0.2.190",
-    "@trackunit/geo-json-utils": "^0.0.4",
-    "@trackunit/i18n-library-translation": "^0.0.230"
+    "@trackunit/react-form-components": "^0.2.12",
+    "@trackunit/react-core-contexts-api": "^0.2.191",
+    "@trackunit/geo-json-utils": "^0.0.5",
+    "@trackunit/i18n-library-translation": "^0.0.231"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

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

@@ -1,5 +1,4 @@
-import { GeoJsonPolygon } from "@trackunit/geo-json-utils";
-import { BooleanValue, DateRangeValue, FilterBarDefinition, FilterStateValues, FilterValueType, InitialState, MinMaxFilterValue, NumberValue, ValueName } from "../types/FilterTypes";
+import { AreaFilterGeoJsonGeometry, BooleanValue, DateRangeValue, FilterBarDefinition, FilterStateValues, FilterValueType, InitialState, MinMaxFilterValue, NumberValue, ValueName } from "../types/FilterTypes";
 export interface FilterBarProps<TFilterBarDefinition extends FilterBarDefinition> {
     /**
      * The name of the filter bar.
@@ -39,7 +38,7 @@ export declare const useFilterBar: <TFilterBarDefinition extends FilterBarDefini
         toggleArrayValue: (key: string, value: string) => void;
         setStringValue: (key: string, value: string) => void;
         setArrayValue: (key: string, value: string[]) => void;
-        setArea: (polygon: GeoJsonPolygon) => void;
+        setArea: (area: AreaFilterGeoJsonGeometry) => void;
         setNumberValue: (key: string, value: NumberValue) => void;
         setBooleanValue: (key: string, value: BooleanValue) => void;
         setDateRange: (key: string, value: DateRangeValue) => void;

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

@@ -1,5 +1,5 @@
-import { GeoJsonPolygon } from "@trackunit/geo-json-utils";
 import React from "react";
+import { z } from "zod";
 export type ValueName = {
     value: string;
     name: string;
@@ -14,14 +14,34 @@ export type MinMaxFilterValue = {
     min?: number;
     max?: number;
 };
-export type FilterValueType = string[] | ValueName[] | ValueName | MinMaxFilterValue | GeoJsonPolygon | string | number | BooleanValue | undefined;
+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">;
+}, "strict", z.ZodTypeAny, {
+    type: "Polygon";
+    coordinates: [number, number][][];
+}, {
+    type: "Polygon";
+    coordinates: [number, number][][];
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"MultiPolygon">;
+    coordinates: z.ZodArray<z.ZodArray<z.ZodEffects<z.ZodArray<z.ZodTuple<[z.ZodNumber, z.ZodNumber], null>, "many">, [number, number][], [number, number][]>, "many">, "many">;
+}, "strict", z.ZodTypeAny, {
+    type: "MultiPolygon";
+    coordinates: [number, number][][][];
+}, {
+    type: "MultiPolygon";
+    coordinates: [number, number][][][];
+}>]>;
+export type AreaFilterGeoJsonGeometry = z.infer<typeof areaFilterGeoJsonGeometrySchema>;
+export type FilterValueType = string[] | ValueName[] | ValueName | MinMaxFilterValue | AreaFilterGeoJsonGeometry | string | number | BooleanValue | undefined;
 export declare type FilterTypes = "boolean" | "string" | "number" | "dateRange" | "area" | "valueNameArray" | "valueName" | "stringArray" | "minMax";
 export type FilterMapActions = {
     updateStarredFilters: (filterkey: string) => void;
     toggleArrayValue: (key: string, value: string) => void;
     setStringValue: (key: string, value: string) => void;
     setArrayValue: (key: string, value: string[]) => void;
-    setArea: (polygon: GeoJsonPolygon) => void;
+    setArea: (area: AreaFilterGeoJsonGeometry) => void;
     setNumberValue: (key: string, value: NumberValue) => void;
     setBooleanValue: (key: string, value: BooleanValue) => void;
     setDateRange: (key: string, value: DateRangeValue) => void;
@@ -108,9 +128,9 @@ export interface NumberFilterDefinition extends AbstractFilterDefinition {
 }
 export interface AreaFilterDefinition extends AbstractFilterDefinition {
     type: "area";
-    defaultValue?: GeoJsonPolygon;
-    valueAsText?: (value: GeoJsonPolygon) => string;
-    component: (filterComponentProps: FilterViewProps<GeoJsonPolygon>) => React.ReactNode;
+    defaultValue?: AreaFilterGeoJsonGeometry;
+    valueAsText?: (value: AreaFilterGeoJsonGeometry) => string;
+    component: (filterComponentProps: FilterViewProps<AreaFilterGeoJsonGeometry>) => React.ReactNode;
 }
 export interface ValueNameArrayFilterDefinition extends AbstractFilterDefinition {
     type: "valueNameArray";
@@ -178,7 +198,7 @@ export type FiltersStoreInstance<T extends FilterBarDefinition> = Partial<Filter
 export interface FilterStateMap<T extends FilterBarDefinition> {
     filtersMap: Record<string, FilterBarConfig<T>>;
 }
-export type FilterBarInferredValue<T extends FilterBarDefinition, K extends keyof T> = T[K]["type"] extends infer Type ? Type extends "boolean" ? BooleanValue | undefined : Type extends "string" ? string | undefined : Type extends "number" ? number | undefined : Type extends "area" ? GeoJsonPolygon | undefined : Type extends "valueNameArray" ? ValueName[] | undefined : Type extends "valueName" ? ValueName | undefined : Type extends "stringArray" ? string[] | undefined : Type extends "minMax" ? MinMaxFilterValue | undefined : Type extends "dateRange" ? DateRangeValue | undefined : undefined : undefined;
+export type FilterBarInferredValue<T extends FilterBarDefinition, K extends keyof T> = T[K]["type"] extends infer Type ? Type extends "boolean" ? BooleanValue | undefined : Type extends "string" ? string | undefined : Type extends "number" ? number | undefined : Type extends "area" ? AreaFilterGeoJsonGeometry | undefined : Type extends "valueNameArray" ? ValueName[] | undefined : Type extends "valueName" ? ValueName | undefined : Type extends "stringArray" ? string[] | undefined : Type extends "minMax" ? MinMaxFilterValue | undefined : Type extends "dateRange" ? DateRangeValue | undefined : undefined : undefined;
 export type SetterKey<T extends string> = `set${Capitalize<T>}`;
 export type ReverseSetterKey<T extends string> = Uncapitalize<T extends `set${infer U}` ? U : never>;
 export type ExtractFilterKeys<T extends FilterBarDefinition> = Extract<keyof T, string>;

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

@@ -1,5 +1,4 @@
-import { GeoJsonPolygon } from "@trackunit/geo-json-utils";
-import { BooleanValue, DateRangeValue, FilterBarConfig, FilterBarDefinition, FilterDefinition, FilterDefinitionValue, MinMaxFilterValue, ValueName } from "../types/FilterTypes";
+import { AreaFilterGeoJsonGeometry, BooleanValue, DateRangeValue, FilterBarConfig, FilterBarDefinition, FilterDefinition, FilterDefinitionValue, MinMaxFilterValue, ValueName } from "../types/FilterTypes";
 /**
  *
  */
@@ -14,7 +13,7 @@ export declare const isDateRangeValue: (value: FilterDefinitionValue) => value i
     coordinates: [number, number][][];
 }
  */
-export declare const isAreaFilterValue: (value: FilterDefinitionValue) => value is GeoJsonPolygon;
+export declare const isAreaFilterValue: (value: FilterDefinitionValue) => value is AreaFilterGeoJsonGeometry;
 /**
  *
  */