refactor: add type for the filter store and add correct types for the filter store

https://web.tracklify.com/project/2b7ZVgE5/AdminForth/1386/oAmK1XLD/filters-from-the-fil-plugin-ap

Author: yaroslav8765

adminforth/spa/src/spa_types/core.ts

@@ -1,4 +1,6 @@
 import type { AdminForthResource, AdminForthResourceColumn } from '../types/Back.js';
+import type { FilterParams } from '@/types/Common';
+import type { Ref, ComputedRef } from 'vue';
 
 export type resourceById = {
     [key: string]: AdminForthResource;
@@ -61,3 +63,27 @@ export type AllowedActions = {
     delete: boolean,
 }
 
+
+export type sortType = {
+  field: string, 
+  direction: 'ask' | 'desc'
+} | null;
+
+export type AdminforthFilterStore = {
+  filters: Ref<FilterParams[]>,
+
+  setSort: (sort: sortType) => void,
+  getSort: () => sortType,
+
+  setFilter: (filters: FilterParams) => void,
+  setFilters: (filters: FilterParams[]) => void,
+
+  getFilters: () => FilterParams[],
+
+  clearFilter: (fieldName: string) => void,
+  clearFilters: () => void,
+
+  shouldFilterBeHidden: (fieldName: string) => boolean,
+
+  visibleFiltersCount: ComputedRef<number>,
+}

adminforth/spa/src/stores/filters.ts

@@ -1,40 +1,42 @@
 import { ref, computed, type Ref } from 'vue';
 import { defineStore } from 'pinia';
 import { useCoreStore } from './core';
+import type { FilterParams } from '@/types/Common';
+import type { AdminforthFilterStore, sortType } from '../spa_types/core';
 
 export const useFiltersStore = defineStore('filters', () => {
-    const filters: Ref<any[]> = ref([]);
-    const sort: Ref<any> = ref({});
+    const filters: Ref<FilterParams[]> = ref([]);
+    const sort: Ref<sortType> = ref(null);
     const coreStore = useCoreStore();
 
-    const setSort = (s: any) => {
+    const setSort = (s: sortType): void => {
         sort.value = s;
     }
-    const getSort = () => {
+    const getSort = (): sortType => {
         return sort.value;
     }
-    const setFilter = (filter: any) => {
+    const setFilter = (filter: FilterParams) => {
         const index = filters.value.findIndex(f => f.field === filter.field);
-        if (filters.value[index] && filters.value[index].operator === filter.value.operator) {
+        if (filters.value[index] && filters.value[index].operator === filter.operator) {
             filters.value[index] = filter;
             return;
         }
         filters.value.push(filter);
     }
-    const setFilters = (f: any) => {
+    const setFilters = (f: FilterParams[]) => {
         filters.value = f;
     }
-    const getFilters = () => {
+    const getFilters = (): FilterParams[] => {
         return filters.value;
     }
-    const clearFilter = (fieldName: string) => {
+    const clearFilter = (fieldName: string): void => {
         filters.value = filters.value.filter(f => f.field !== fieldName);
     }
-    const clearFilters = () => {
+    const clearFilters = (): void => {
         filters.value = [];
     }
 
-    const shouldFilterBeHidden = (fieldName: string) => {
+    const shouldFilterBeHidden = (fieldName: string): boolean => {
         if (coreStore.resource?.columns) {
             const column = coreStore.resource.columns.find((col: any) => col.name === fieldName);
             if (column?.showIn?.filter !== true) {
@@ -48,7 +50,7 @@ export const useFiltersStore = defineStore('filters', () => {
         return filters.value.filter(f => !shouldFilterBeHidden(f.field)).length;
     });
 
-    return {
+    const store = {
         setFilter, 
         getFilters, 
         clearFilters, 
@@ -60,4 +62,6 @@ export const useFiltersStore = defineStore('filters', () => {
         shouldFilterBeHidden,
         clearFilter
     }
+
+    return store as AdminforthFilterStore;
 })

adminforth/spa/src/views/ListView.vue

@@ -240,7 +240,7 @@ import { useRoute } from 'vue-router';
 import { getCustomComponent, initThreeDotsDropdown, getList, startBulkAction } from '@/utils';
 import ThreeDotsMenu from '@/components/ThreeDotsMenu.vue';
 import { Tooltip } from '@/afcl'
-import type { AdminForthComponentDeclaration, AdminForthComponentDeclarationFull } from '@/types/Common';
+import type { AdminForthComponentDeclaration, AdminForthComponentDeclarationFull, AdminForthFilterOperators } from '@/types/Common';
 
 
 import {
@@ -420,7 +420,7 @@ async function init() {
     const [_, field, operator] = k.split('__');
     return {
       field,
-      operator,
+      operator: operator as AdminForthFilterOperators,
       value: JSON.parse((route.query[k] as string))
     }
   });