From 501bce484ac24fb11ea65faa70c3ca42f22a3df7 Mon Sep 17 00:00:00 2001
From: axolotle <nchesnais@mailoo.org>
Date: Tue, 9 Jul 2024 17:05:32 +0200
Subject: [PATCH] feat: add useSearch composable to search in Array or
 AnyTreeNode

---
 app/src/components/globals/ViewSearch.vue | 53 +++++++++++------------
 app/src/composables/useSearch.ts          | 46 ++++++++++++++++++++
 app/src/helpers/data/tree.ts              |  4 ++
 3 files changed, 76 insertions(+), 27 deletions(-)
 create mode 100644 app/src/composables/useSearch.ts

diff --git a/app/src/components/globals/ViewSearch.vue b/app/src/components/globals/ViewSearch.vue
index a52aa1ad..1cebd5a3 100644
--- a/app/src/components/globals/ViewSearch.vue
+++ b/app/src/components/globals/ViewSearch.vue
@@ -1,18 +1,20 @@
-<script setup lang="ts" generic="T extends Obj">
-import type { Component } from 'vue'
+<script setup lang="ts" generic="T extends Obj | AnyTreeNode">
+import { computed, type Component } from 'vue'
+import { useI18n } from 'vue-i18n'
 
+import type { AnyTreeNode } from '@/helpers/data/tree'
 import type { Obj } from '@/types/commons'
 
 const props = withDefaults(
   defineProps<{
-    items: T[] | null
+    items?: T[] | null
     itemsName: string | null
-    filteredItems: T[] | null
-    search?: string
+    modelValue?: string
     skeleton?: string | Component
   }>(),
   {
-    search: undefined,
+    items: undefined,
+    modelValue: undefined,
     skeleton: 'ListGroupSkeleton',
   },
 )
@@ -27,9 +29,21 @@ const slots = defineSlots<{
   skeleton: any
 }>()
 
-const emit = defineEmits<{
-  'update:search': [value: string]
+defineEmits<{
+  'update:modelValue': [value: string]
 }>()
+
+const model = defineModel<string>()
+
+const { t } = useI18n()
+const noItemsMessage = computed(() => {
+  if (props.items) return
+  return t(
+    props.items === undefined ? 'items_verbose_count' : 'search.not_found',
+    { items: t('items.' + props.itemsName, 0) },
+    0,
+  )
+})
 </script>
 
 <template>
@@ -45,11 +59,8 @@ const emit = defineEmits<{
 
         <BFormInput
           id="top-bar-search"
-          :modelValue="search"
-          @update:modelValue="emit('update:search', $event)"
-          :placeholder="
-            $t('search.for', { items: $t('items.' + itemsName, 2) })
-          "
+          v-model="model"
+          :placeholder="t('search.for', { items: t('items.' + itemsName, 2) })"
           :disabled="!items"
         />
       </BInputGroup>
@@ -63,22 +74,10 @@ const emit = defineEmits<{
     </template>
 
     <template #default>
-      <BAlert
-        v-if="items === null || filteredItems === null"
-        :modelValue="true"
-        variant="warning"
-      >
+      <BAlert v-if="noItemsMessage" :model-value="true" variant="warning">
         <slot name="alert-message">
           <YIcon iname="exclamation-triangle" />
-          {{
-            $t(
-              items === null ? 'items_verbose_count' : 'search.not_found',
-              {
-                items: $t('items.' + itemsName, 0),
-              },
-              0,
-            )
-          }}
+          {{ noItemsMessage }}
         </slot>
       </BAlert>
 
diff --git a/app/src/composables/useSearch.ts b/app/src/composables/useSearch.ts
new file mode 100644
index 00000000..c701bb36
--- /dev/null
+++ b/app/src/composables/useSearch.ts
@@ -0,0 +1,46 @@
+import type { ComputedRef, MaybeRefOrGetter, Ref } from 'vue'
+import { computed, ref, toValue, watch } from 'vue'
+
+import type { AnyTreeNode, TreeRootNode } from '@/helpers/data/tree'
+
+export function useSearch<
+  T extends any[] | TreeRootNode,
+  V extends T extends (infer V)[] ? V : AnyTreeNode,
+>(
+  items: MaybeRefOrGetter<T | undefined> | ComputedRef<T | undefined>,
+  filterFn: (search: string, item: V, index: number, arr: T) => boolean,
+  {
+    externalSearch,
+    filterIfNoSearch = false,
+    filterAllFn,
+  }: {
+    filterAllFn?: (search: string, items: T) => boolean | undefined
+    filterIfNoSearch?: boolean
+    externalSearch?: MaybeRefOrGetter<string>
+  } = {},
+): [search: Ref<string>, filteredItems: ComputedRef<T | undefined | null>] {
+  const search = ref(toValue(externalSearch) ?? '')
+  watch(
+    () => toValue(externalSearch),
+    (s) => (search.value = s ?? ''),
+  )
+
+  const filteredItems = computed(() => {
+    const items_ = toValue(items)
+    const s = toValue(search.value).toLowerCase()
+    if (!items_) return undefined
+    if (filterAllFn) {
+      const returnAll = filterAllFn(s, items_)
+      if (returnAll !== undefined) {
+        return returnAll ? items_ : undefined
+      }
+    }
+    if (!s && !filterIfNoSearch) return items_
+    const filteredItems_ = items_.filter((...args) =>
+      filterFn(s, ...(args as [V, number, T])),
+    ) as T
+    return filteredItems_.length ? filteredItems_ : null
+  })
+
+  return [search, filteredItems]
+}
diff --git a/app/src/helpers/data/tree.ts b/app/src/helpers/data/tree.ts
index 52e5f4e2..8c503fc0 100644
--- a/app/src/helpers/data/tree.ts
+++ b/app/src/helpers/data/tree.ts
@@ -106,6 +106,10 @@ class TreeNode {
       }
     })
   }
+
+  get length(): number {
+    return this.children.length
+  }
 }
 
 export class TreeRootNode extends TreeNode {