From d019e327c1aebf69a5a1d45b42eb2aa4b4bd2ad9 Mon Sep 17 00:00:00 2001
From: andrewwallacespeckle
 <139135120+andrewwallacespeckle@users.noreply.github.com>
Date: Fri, 21 Jun 2024 15:46:50 +0100
Subject: [PATCH] feat(fe2): Improve property name display and search
 functionality in filtering (#2396)

* feat(fe2): Improve property name display and search functionality in filtering

* Improve Revit property handling and type safety

* Improve getPropertyName

* Revert "Improve getPropertyName"

This reverts commit 21aaabdd13294bdae7a678fc8fb5454b6b174703.
---
 .../components/viewer/explorer/Filters.vue    | 65 +++++++++++--------
 1 file changed, 37 insertions(+), 28 deletions(-)

diff --git a/packages/frontend-2/components/viewer/explorer/Filters.vue b/packages/frontend-2/components/viewer/explorer/Filters.vue
index 2c1cd40f7f..741610108d 100644
--- a/packages/frontend-2/components/viewer/explorer/Filters.vue
+++ b/packages/frontend-2/components/viewer/explorer/Filters.vue
@@ -70,7 +70,7 @@
                 refreshColorsIfSetOrActiveFilterIsNumeric()
             "
           >
-            {{ filter.key }}
+            {{ getPropertyName(filter.key) }}
           </button>
         </div>
         <div v-if="itemCount < relevantFiltersSearched.length" class="mb-2">
@@ -95,7 +95,7 @@
 <script setup lang="ts">
 import { ChevronDownIcon, ChevronUpIcon } from '@heroicons/vue/24/solid'
 import { ArrowPathIcon } from '@heroicons/vue/24/outline'
-import type { PropertyInfo, StringPropertyInfo } from '@speckle/viewer'
+import type { PropertyInfo } from '@speckle/viewer'
 import { useFilterUtilities } from '~~/lib/viewer/composables/ui'
 import { useMixpanel } from '~~/lib/core/composables/mp'
 import {
@@ -111,6 +111,8 @@ const {
   filters: { propertyFilter }
 } = useFilterUtilities()
 
+const revitPropertyRegex = /^parameters\./
+
 const showAllFilters = ref(false)
 
 const props = defineProps<{
@@ -142,7 +144,7 @@ const relevantFilters = computed(() => {
       return false
     }
     // handle revit params: the actual one single value we're interested is in paramters.HOST_BLA BLA_.value, the rest are not needed
-    if (f.key.startsWith('parameters')) {
+    if (isRevitProperty(f.key)) {
       if (f.key.endsWith('.value')) return true
       else return false
     }
@@ -178,11 +180,16 @@ const numericActiveFilter = computed(() =>
 const searchString = ref<string | undefined>(undefined)
 const relevantFiltersSearched = computed(() => {
   if (!searchString.value) return relevantFilters.value
+  const searchLower = searchString.value.toLowerCase()
   // eslint-disable-next-line vue/no-side-effects-in-computed-properties
   itemCount.value = 30 // nasty, but yolo - reset max limit on search change
-  return relevantFilters.value.filter((f) =>
-    f.key.toLowerCase().includes((searchString.value as string).toLowerCase())
-  )
+  return relevantFilters.value.filter((f) => {
+    const userFriendlyName = getPropertyName(f.key).toLowerCase()
+    return (
+      f.key.toLowerCase().includes(searchLower) ||
+      userFriendlyName.includes(searchLower)
+    )
+  })
 })
 
 const itemCount = ref(30)
@@ -192,28 +199,7 @@ const relevantFiltersLimited = computed(() => {
     .sort((a, b) => a.key.length - b.key.length)
 })
 
-// Too lazy to follow up in here for now, as i think we need a bit of a better strategy in connectors first :/
-const title = computed(() => {
-  const currentFilterKey = activeFilter.value?.key
-  if (!currentFilterKey) return 'Loading'
-
-  if (currentFilterKey === 'level.name') return 'Level Name'
-  if (currentFilterKey === 'speckle_type') return 'Object Type'
-
-  // Handle revit names :/
-  if (
-    currentFilterKey.startsWith('parameters.') &&
-    currentFilterKey.endsWith('.value')
-  ) {
-    return (
-      props.filters.find(
-        (f) => f.key === currentFilterKey.replace('.value', '.name')
-      ) as StringPropertyInfo
-    ).valueGroups[0].value
-  }
-
-  return currentFilterKey
-})
+const title = computed(() => getPropertyName(activeFilter.value?.key ?? ''))
 
 const colors = computed(() => !!propertyFilter.isApplied.value)
 
@@ -248,4 +234,27 @@ const refreshColorsIfSetOrActiveFilterIsNumeric = () => {
   // removePropertyFilter()
   applyPropertyFilter()
 }
+
+const isRevitProperty = (key: string): boolean => {
+  return revitPropertyRegex.test(key)
+}
+
+const getPropertyName = (key: string): string => {
+  if (!key) return 'Loading'
+
+  if (key === 'level.name') return 'Level Name'
+  if (key === 'speckle_type') return 'Object Type'
+
+  if (isRevitProperty(key) && key.endsWith('.value')) {
+    const correspondingProperty = props.filters.find(
+      (f) => f.key === key.replace('.value', '.name')
+    )
+    if (correspondingProperty && isStringPropertyInfo(correspondingProperty)) {
+      return correspondingProperty.valueGroups[0]?.value || key
+    }
+  }
+
+  // Return the key as is for non-Revit properties
+  return key
+}
 </script>