Add extension point for extra filters with support for basic search c…

ui-frontend/packages/catalog-ui-search/src/main/webapp/component/filter-builder/filter-leaf.spec.tsx

@@ -11,6 +11,7 @@ import user from '../singletons/user-instance'
 import { StartupDataStore } from '../../js/model/Startup/startup'
 import { BasicDataTypePropertyName } from './reserved.properties'
 import { render } from '@testing-library/react'
+import Extensions from '../../extension-points'
 
 // trim whitespace, lowercase
 function customNormalizer(text: string) {
@@ -108,6 +109,7 @@ function addTestDefs() {
         isInjected: false,
         hidden: true,
       },
+      ...Extensions.extraFilters?.typeDefinitions
     },
   })
 }

ui-frontend/packages/catalog-ui-search/src/main/webapp/component/query-basic/query-basic.view.tsx

@@ -43,6 +43,8 @@ import { StartupDataStore } from '../../js/model/Startup/startup'
 import { useMetacardDefinitions } from '../../js/model/Startup/metacard-definitions.hooks'
 import { ReservedBasicDatatype } from '../reserved-basic-datatype/reserved.basic-datatype'
 import { BasicDataTypePropertyName } from '../filter-builder/reserved.properties'
+import Extensions from '../../extension-points'
+
 function isNested(filter: any) {
   let nested = false
   filter.filters.forEach((subfilter: any) => {
@@ -60,7 +62,7 @@ function isAnyDate(filter: any) {
     return (
       StartupDataStore.MetacardDefinitions.getAttributeMap()[
         stripQuotes(filter.property)
-      ].type === 'DATE'
+      ]?.type === 'DATE'
     )
   }
   let typesFound = {} as any
@@ -137,6 +139,7 @@ export function translateFilterToBasicMap(filter: FilterBuilderClass) {
       value: new BasicDatatypeFilter({
         value: [],
       }),
+    ...Extensions.extraFilters?.extraPropertyValueMaps
     },
   } as PropertyValueMapType
   let downConversion = false
@@ -153,6 +156,9 @@ export function translateFilterToBasicMap(filter: FilterBuilderClass) {
       ) {
         propertyValueMap[BasicDataTypePropertyName].on = true
         propertyValueMap[BasicDataTypePropertyName].value = subfilter
+      } else if (Extensions.extraFilters?.isExtraFilterClass(subfilter))
+      {
+        Extensions.extraFilters.translateExtraFilterToBasicMap(propertyValueMap, subfilter)
       } else if (!isFilterBuilderClass(subfilter)) {
         if (['anyDate', 'anyText', 'anyGeo'].includes(subfilter.property)) {
           propertyValueMap[CQLUtils.getProperty(subfilter)] =
@@ -205,7 +211,7 @@ type QueryBasicProps = {
   errorListener?: (validationResults: {
     [key: string]: ValidationResult | undefined
   }) => void
-  Extensions?: React.FunctionComponent
+  QueryBasicPropsExtensions?: React.FunctionComponent
 }
 export const constructFilterFromBasicFilter = ({
   basicFilter,
@@ -254,6 +260,7 @@ export const constructFilterFromBasicFilter = ({
       })
     )
   }
+  Extensions.extraFilters?.constructExtraFilters(basicFilter, filters)
   return new FilterBuilderClass({
     type: 'AND',
     filters,
@@ -283,7 +290,7 @@ const useBasicFilterFromModel = ({ model }: QueryBasicProps) => {
   return basicFilter
 }
 
-const QueryBasic = ({ model, errorListener, Extensions }: QueryBasicProps) => {
+const QueryBasic = ({ model, errorListener, QueryBasicPropsExtensions }: QueryBasicProps) => {
   const MetacardDefinitions = useMetacardDefinitions()
   const inputRef = React.useRef<HTMLDivElement | null>(null)
   const basicFilter = useBasicFilterFromModel({ model })
@@ -464,11 +471,17 @@ const QueryBasic = ({ model, errorListener, Extensions }: QueryBasicProps) => {
             </Grid>
           ) : null}
         </div>
+        {Extensions.extraFilters?.queryBasicCheckboxFilters && (
+          <Extensions.extraFilters.queryBasicCheckboxFilters
+            model
+            basicFilter
+            />
+        )}
         <div className="py-2 w-full">
           <Swath className="w-full h-1" />
         </div>
         <div className="basic-settings">
-          <QuerySettings model={model} Extensions={Extensions} />
+          <QuerySettings model={model} Extensions={QueryBasicPropsExtensions} />
         </div>
       </div>
     </>

ui-frontend/packages/catalog-ui-search/src/main/webapp/extension-points/extension-points.tsx

@@ -18,12 +18,14 @@ import { providers, Props as ProviderProps } from './providers'
 import metacardInteractions from './metacard-interactions'
 import { LazyQueryResult } from '../js/model/LazyQueryResult/LazyQueryResult'
 import { MetacardAttribute, ResultType } from '../js/model/Types'
-import { ValueTypes } from '../component/filter-builder/filter.structure'
+import { CQLStandardFilterBuilderClass, FilterBuilderClass, FilterClass, ValueTypes } from '../component/filter-builder/filter.structure'
 import { Suggestion } from '../react-component/location/gazetteer'
 import { MetacardInteractionProps } from '../react-component/metacard-interactions'
 import { PermissiveComponentType } from '../typescript'
 import { InputsType } from '../react-component/location/location'
 import { CustomHover } from '../component/visualization/histogram/add-on-helpers'
+import { AttributeMapType } from '../js/model/Startup/startup.types'
+import { Attribute } from '../react-component/filter/filterHelper'
 
 type EditorProps = {
   result: LazyQueryResult
@@ -115,6 +117,24 @@ export type ExtensionPointsType = {
   }) => React.ReactNode | null
   extraSidebarButtons?: PermissiveComponentType
   includeNavigationButtons?: boolean
+  extraFilters?: {
+    filterTypesHandler: (cqlAst: FilterBuilderClass | FilterClass | CQLStandardFilterBuilderClass) => CQLStandardFilterBuilderClass | FilterClass | null
+    isExtraFilterClass: (subfilter: any) => boolean
+    translateExtraFilterToBasicMap: (propertyFilterMap: any, subfilter: any) => null
+    constructExtraFilters: (basicfilter: any, filters: any[]) => null
+    typeDefinitions: AttributeMapType
+    filterPropertyNames: string[]
+    getFilterInput: (property: string) => React.ReactNode | null
+    attributes: Attribute[]
+    queryBasicCheckboxFilters?: ({
+      model,
+      basicFilter
+    } : {
+      model: any
+      basicFilter: any
+    }) => React.ReactNode | null
+    extraPropertyValueMaps?: any[]
+  }
 }
 
 const ExtensionPoints: ExtensionPointsType = {
@@ -146,6 +166,7 @@ const ExtensionPoints: ExtensionPointsType = {
   timelineItemAddOn: () => null,
   extraSidebarButtons: () => null,
   includeNavigationButtons: false,
+  extraFilters: undefined
 }
 
 export default ExtensionPoints

ui-frontend/packages/catalog-ui-search/src/main/webapp/js/cql.tsx

@@ -38,6 +38,7 @@ import CQLUtils from './CQLUtils'
 import _cloneDeep from 'lodash/cloneDeep'
 import wkx from 'wkx'
 import { StartupDataStore } from './model/Startup/startup'
+import Extensions from '../extension-points'
 
 const getPointRadiusFilter = (
   point: [number, number],
@@ -935,6 +936,7 @@ function getDataTypesConfigurationUsingStartupStore() {
 function handleAllFilterTypes(
   cqlAst: FilterBuilderClass | FilterClass | CQLStandardFilterBuilderClass
 ): CQLStandardFilterBuilderClass | FilterClass {
+  let extraFilterClass : CQLStandardFilterBuilderClass | FilterClass | null;
   if (isCQLStandardFilterBuilderClass(cqlAst) || isFilterBuilderClass(cqlAst)) {
     return new CQLStandardFilterBuilderClass({
       type: cqlAst.type,
@@ -969,6 +971,8 @@ function handleAllFilterTypes(
         }),
       ],
     })
+  }  else if ( Extensions.extraFilters && (extraFilterClass = Extensions.extraFilters.filterTypesHandler(cqlAst))) {
+    return extraFilterClass
   } else if (isResourceSizeFilterClass(cqlAst)) {
     const bytesValue = convertResourceSizeFilterClassValueToBytes(cqlAst)
     return new FilterClass({

ui-frontend/packages/catalog-ui-search/src/main/webapp/js/model/Startup/metacard-definitions.tsx

@@ -10,6 +10,7 @@ import {
   SearchResultMetacardDefinitionType,
   StartupPayloadType,
 } from './startup.types'
+import Extensions from '../../../extension-points'
 
 function sortMetacardTypes(metacardTypes: AttributeMapType = {}) {
   return Object.values(metacardTypes).sort((a, b) => {
@@ -189,7 +190,7 @@ class MetacardDefinitions extends Subscribable<{
     return this.attributeMap?.[attributeName]?.enumerations || []
   }
   getSearchOnlyAttributes = () => {
-    return ['anyText', 'anyGeo', 'anyDate', BasicDataTypePropertyName]
+    return ['anyText', 'anyGeo', 'anyDate', BasicDataTypePropertyName, ...(Extensions.extraFilters?.filterPropertyNames ?? [])]
   }
   getSortedAttributes = () => {
     return this.sortedAttributes || []

ui-frontend/packages/catalog-ui-search/src/main/webapp/react-component/filter/filter-comparator/filter-comparator.tsx

@@ -20,6 +20,7 @@ import {
   isBasicDatatypeClass,
 } from '../../../component/filter-builder/filter.structure'
 import { useComparatorsForAttribute } from './comparatorUtils'
+import Extensions from '../../../extension-points'
 
 type Props = {
   filter: FilterClass
@@ -42,7 +43,7 @@ const FilterComparator = ({ filter, setFilter, textFieldProps }: Props) => {
     }
   }, [filter, setFilter, comparators])
 
-  if (isBasicDatatypeClass(filter)) {
+  if (isBasicDatatypeClass(filter) || Extensions.extraFilters?.isExtraFilterClass(filter)) {
     return null
   }
 

ui-frontend/packages/catalog-ui-search/src/main/webapp/react-component/filter/filter-input/filter-input.tsx

@@ -41,6 +41,8 @@ import { BasicDataTypePropertyName } from '../../../component/filter-builder/res
 import { ResourceSizeField } from '../../../component/fields/resource-size'
 import { ResourceSizeRangeField } from '../../../component/fields/resource-size-range'
 import { useConfiguration } from '../../../js/model/Startup/configuration.hooks'
+import Extensions from '../../../extension-points'
+
 export type Props = {
   filter: FilterClass
   setFilter: (filter: FilterClass) => void
@@ -113,6 +115,10 @@ const FilterInput = ({
     )
   }
 
+  if (filter.property in (Extensions.extraFilters?.filterPropertyNames ?? [])) {
+    return (Extensions.extraFilters?.getFilterInput(filter.property))
+  }
+
   if (resourceSizeIdentifiers.includes(filter.property)) {
     switch (filter.type) {
       case 'BETWEEN':

ui-frontend/packages/catalog-ui-search/src/main/webapp/react-component/filter/filterHelper.tsx

@@ -19,6 +19,8 @@ import {
   AttributeMapType,
   AttributeTypes,
 } from '../../js/model/Startup/startup.types'
+import Extensions from '../../extension-points'
+
 export type Attribute = {
   label: string
   value: string
@@ -69,7 +71,7 @@ export const getGroupedFilteredAttributes = (): {
   const groupedFilteredAttributes = validCommonAttributes
     .concat([
       toAttribute(basicDataTypeAttributeDefinition, 'Special Attributes'),
-    ])
+    ]).concat((Extensions.extraFilters?.attributes ?? []))
     .concat(getFilteredAttributeList('All Attributes'))
   const groups =
     validCommonAttributes.length > 0