|
| 1 | +import {useMemo} from 'react'; |
| 2 | +import type {OnyxCollection} from 'react-native-onyx'; |
| 3 | +import {mergeCardListWithWorkspaceFeeds} from '@libs/CardUtils'; |
| 4 | +import {getAllTaxRates, getTagNamesFromTagsLists, isPolicyFeatureEnabled} from '@libs/PolicyUtils'; |
| 5 | +import {getAllPolicyValues} from '@libs/SearchQueryUtils'; |
| 6 | +import CONST from '@src/CONST'; |
| 7 | +import ONYXKEYS from '@src/ONYXKEYS'; |
| 8 | +import type {SearchAdvancedFiltersForm} from '@src/types/form'; |
| 9 | +import type {Policy, PolicyCategories, PolicyTagLists} from '@src/types/onyx'; |
| 10 | +import type {PolicyFeatureName} from '@src/types/onyx/Policy'; |
| 11 | +import {getEmptyObject, isEmptyObject} from '@src/types/utils/EmptyObject'; |
| 12 | +import useLocalize from './useLocalize'; |
| 13 | +import useOnyx from './useOnyx'; |
| 14 | +import useWorkspaceList from './useWorkspaceList'; |
| 15 | + |
| 16 | +/** |
| 17 | + * typeFiltersKeys is stored as an object keyed by the different search types. |
| 18 | + * Each value is then an array of arrays where each inner array is a separate section in the UI. |
| 19 | + */ |
| 20 | +const typeFiltersKeys = { |
| 21 | + [CONST.SEARCH.DATA_TYPES.EXPENSE]: [ |
| 22 | + [ |
| 23 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE, |
| 24 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM, |
| 25 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TO, |
| 26 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD, |
| 27 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS, |
| 28 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID, |
| 29 | + CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY, |
| 30 | + ], |
| 31 | + [ |
| 32 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPENSE_TYPE, |
| 33 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.MERCHANT, |
| 34 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE, |
| 35 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT, |
| 36 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CURRENCY, |
| 37 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY, |
| 38 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG, |
| 39 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION, |
| 40 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID, |
| 41 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED, |
| 42 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE, |
| 43 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.REIMBURSABLE, |
| 44 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.BILLABLE, |
| 45 | + ], |
| 46 | + [ |
| 47 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_ID, |
| 48 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.SUBMITTED, |
| 49 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.APPROVED, |
| 50 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID, |
| 51 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPORTED, |
| 52 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWAL_TYPE, |
| 53 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWN, |
| 54 | + ], |
| 55 | + ], |
| 56 | + [CONST.SEARCH.DATA_TYPES.INVOICE]: [ |
| 57 | + [ |
| 58 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE, |
| 59 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM, |
| 60 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TO, |
| 61 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD, |
| 62 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS, |
| 63 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID, |
| 64 | + ], |
| 65 | + [ |
| 66 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.MERCHANT, |
| 67 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE, |
| 68 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT, |
| 69 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CURRENCY, |
| 70 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY, |
| 71 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG, |
| 72 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION, |
| 73 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID, |
| 74 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED, |
| 75 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE, |
| 76 | + ], |
| 77 | + [ |
| 78 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_ID, |
| 79 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.SUBMITTED, |
| 80 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.APPROVED, |
| 81 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID, |
| 82 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPORTED, |
| 83 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWAL_TYPE, |
| 84 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.WITHDRAWN, |
| 85 | + ], |
| 86 | + ], |
| 87 | + [CONST.SEARCH.DATA_TYPES.TRIP]: [ |
| 88 | + [ |
| 89 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE, |
| 90 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM, |
| 91 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TO, |
| 92 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD, |
| 93 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS, |
| 94 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID, |
| 95 | + CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY, |
| 96 | + ], |
| 97 | + [ |
| 98 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.MERCHANT, |
| 99 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE, |
| 100 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.AMOUNT, |
| 101 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CURRENCY, |
| 102 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY, |
| 103 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG, |
| 104 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION, |
| 105 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID, |
| 106 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED, |
| 107 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE, |
| 108 | + ], |
| 109 | + [ |
| 110 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.REPORT_ID, |
| 111 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.SUBMITTED, |
| 112 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.APPROVED, |
| 113 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID, |
| 114 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.EXPORTED, |
| 115 | + ], |
| 116 | + ], |
| 117 | + [CONST.SEARCH.DATA_TYPES.CHAT]: [ |
| 118 | + [ |
| 119 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE, |
| 120 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM, |
| 121 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TO, |
| 122 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.IN, |
| 123 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.KEYWORD, |
| 124 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS, |
| 125 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID, |
| 126 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE, |
| 127 | + ], |
| 128 | + ], |
| 129 | + [CONST.SEARCH.DATA_TYPES.TASK]: [ |
| 130 | + [ |
| 131 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TYPE, |
| 132 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.TITLE, |
| 133 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DESCRIPTION, |
| 134 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.IN, |
| 135 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.FROM, |
| 136 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.ASSIGNEE, |
| 137 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.STATUS, |
| 138 | + CONST.SEARCH.SYNTAX_FILTER_KEYS.DATE, |
| 139 | + ], |
| 140 | + ], |
| 141 | +}; |
| 142 | + |
| 143 | +function shouldDisplayFilter(numberOfFilters: number, isFeatureEnabled: boolean, singlePolicyCondition = false): boolean { |
| 144 | + return (numberOfFilters !== 0 || singlePolicyCondition) && isFeatureEnabled; |
| 145 | +} |
| 146 | + |
| 147 | +function isFeatureEnabledInPolicies(policies: OnyxCollection<Policy>, featureName: PolicyFeatureName) { |
| 148 | + if (isEmptyObject(policies)) { |
| 149 | + return false; |
| 150 | + } |
| 151 | + return Object.values(policies).some((policy) => isPolicyFeatureEnabled(policy, featureName)); |
| 152 | +} |
| 153 | + |
| 154 | +function useAdvancedSearchFilters() { |
| 155 | + const {localeCompare} = useLocalize(); |
| 156 | + const [searchAdvancedFilters = getEmptyObject<SearchAdvancedFiltersForm>()] = useOnyx(ONYXKEYS.FORMS.SEARCH_ADVANCED_FILTERS_FORM, {canBeMissing: true}); |
| 157 | + const policyID = searchAdvancedFilters.policyID; |
| 158 | + const groupBy = searchAdvancedFilters.groupBy; |
| 159 | + const [userCardList] = useOnyx(ONYXKEYS.CARD_LIST, {canBeMissing: false}); |
| 160 | + const [workspaceCardFeeds] = useOnyx(ONYXKEYS.COLLECTION.WORKSPACE_CARDS_LIST, {canBeMissing: false}); |
| 161 | + const allCards = useMemo(() => mergeCardListWithWorkspaceFeeds(workspaceCardFeeds ?? CONST.EMPTY_OBJECT, userCardList, true), [userCardList, workspaceCardFeeds]); |
| 162 | + const taxRates = getAllTaxRates(); |
| 163 | + |
| 164 | + const [policies = getEmptyObject<NonNullable<OnyxCollection<Policy>>>()] = useOnyx(ONYXKEYS.COLLECTION.POLICY, {canBeMissing: false}); |
| 165 | + const [allPolicyCategories = getEmptyObject<NonNullable<OnyxCollection<PolicyCategories>>>()] = useOnyx(ONYXKEYS.COLLECTION.POLICY_CATEGORIES, { |
| 166 | + canBeMissing: false, |
| 167 | + selector: (policyCategories) => |
| 168 | + Object.fromEntries( |
| 169 | + Object.entries(policyCategories ?? {}).filter(([, categories]) => { |
| 170 | + const availableCategories = Object.values(categories ?? {}).filter((category) => category.pendingAction !== CONST.RED_BRICK_ROAD_PENDING_ACTION.DELETE); |
| 171 | + return availableCategories.length > 0; |
| 172 | + }), |
| 173 | + ), |
| 174 | + }); |
| 175 | + const selectedPolicyCategories = getAllPolicyValues(policyID, ONYXKEYS.COLLECTION.POLICY_CATEGORIES, allPolicyCategories); |
| 176 | + const [allPolicyTagLists = getEmptyObject<NonNullable<OnyxCollection<PolicyTagLists>>>()] = useOnyx(ONYXKEYS.COLLECTION.POLICY_TAGS, {canBeMissing: false}); |
| 177 | + const selectedPolicyTagLists = getAllPolicyValues(policyID, ONYXKEYS.COLLECTION.POLICY_TAGS, allPolicyTagLists); |
| 178 | + const tagListsUnpacked = Object.values(allPolicyTagLists ?? {}) |
| 179 | + .filter((item): item is NonNullable<PolicyTagLists> => !!item) |
| 180 | + .map(getTagNamesFromTagsLists) |
| 181 | + .flat(); |
| 182 | + |
| 183 | + const [currentUserLogin] = useOnyx(ONYXKEYS.SESSION, {canBeMissing: false, selector: (session) => session?.email}); |
| 184 | + |
| 185 | + const {sections: workspaces} = useWorkspaceList({ |
| 186 | + policies, |
| 187 | + currentUserLogin, |
| 188 | + shouldShowPendingDeletePolicy: false, |
| 189 | + selectedPolicyIDs: undefined, |
| 190 | + searchTerm: '', |
| 191 | + localeCompare, |
| 192 | + }); |
| 193 | + |
| 194 | + // When looking if a user has any categories to display, we want to ignore the policies that are of type PERSONAL |
| 195 | + const nonPersonalPolicyCategoryIds = Object.values(policies) |
| 196 | + .filter((policy): policy is NonNullable<Policy> => !!(policy && policy.type !== CONST.POLICY.TYPE.PERSONAL)) |
| 197 | + .map((policy) => `${ONYXKEYS.COLLECTION.POLICY_CATEGORIES}${policy.id}`); |
| 198 | + const nonPersonalPolicyCategoryCount = Object.keys(allPolicyCategories).filter((policyCategoryId) => nonPersonalPolicyCategoryIds.includes(policyCategoryId)).length; |
| 199 | + |
| 200 | + const areCategoriesEnabled = isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_CATEGORIES_ENABLED); |
| 201 | + const areTagsEnabled = isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_TAGS_ENABLED); |
| 202 | + const areCardsEnabled = |
| 203 | + isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_COMPANY_CARDS_ENABLED) || |
| 204 | + isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_EXPENSIFY_CARDS_ENABLED); |
| 205 | + const areTaxEnabled = isFeatureEnabledInPolicies(policies, CONST.POLICY.MORE_FEATURES.ARE_TAXES_ENABLED); |
| 206 | + const shouldDisplayCategoryFilter = shouldDisplayFilter(nonPersonalPolicyCategoryCount, areCategoriesEnabled, !!selectedPolicyCategories); |
| 207 | + const shouldDisplayTagFilter = shouldDisplayFilter(tagListsUnpacked.length, areTagsEnabled, !!selectedPolicyTagLists); |
| 208 | + const shouldDisplayCardFilter = shouldDisplayFilter(Object.keys(allCards).length, areCardsEnabled); |
| 209 | + const shouldDisplayTaxFilter = shouldDisplayFilter(Object.keys(taxRates).length, areTaxEnabled); |
| 210 | + const shouldDisplayWorkspaceFilter = workspaces.some((section) => section.data.length !== 0); |
| 211 | + const shouldDisplayGroupByFilter = groupBy === CONST.SEARCH.GROUP_BY.FROM || groupBy === CONST.SEARCH.GROUP_BY.CARD; |
| 212 | + |
| 213 | + let currentType = searchAdvancedFilters?.type ?? CONST.SEARCH.DATA_TYPES.EXPENSE; |
| 214 | + |
| 215 | + if (!Object.keys(typeFiltersKeys).includes(currentType)) { |
| 216 | + currentType = CONST.SEARCH.DATA_TYPES.EXPENSE; |
| 217 | + } |
| 218 | + |
| 219 | + return { |
| 220 | + currentType, |
| 221 | + typeFiltersKeys: typeFiltersKeys[currentType] |
| 222 | + .map((section) => |
| 223 | + section |
| 224 | + .map((key) => { |
| 225 | + if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.CATEGORY && !shouldDisplayCategoryFilter) { |
| 226 | + return; |
| 227 | + } |
| 228 | + if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.TAG && !shouldDisplayTagFilter) { |
| 229 | + return; |
| 230 | + } |
| 231 | + if ((key === CONST.SEARCH.SYNTAX_FILTER_KEYS.CARD_ID || CONST.SEARCH.SYNTAX_FILTER_KEYS.POSTED) && !shouldDisplayCardFilter) { |
| 232 | + return; |
| 233 | + } |
| 234 | + if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.TAX_RATE && !shouldDisplayTaxFilter) { |
| 235 | + return; |
| 236 | + } |
| 237 | + if (key === CONST.SEARCH.SYNTAX_FILTER_KEYS.POLICY_ID && !shouldDisplayWorkspaceFilter) { |
| 238 | + return; |
| 239 | + } |
| 240 | + if (key === CONST.SEARCH.SYNTAX_ROOT_KEYS.GROUP_BY && !shouldDisplayGroupByFilter) { |
| 241 | + return; |
| 242 | + } |
| 243 | + return key; |
| 244 | + }) |
| 245 | + .filter((filter): filter is NonNullable<typeof filter> => !!filter), |
| 246 | + ) |
| 247 | + .filter((section) => !!section.length), |
| 248 | + }; |
| 249 | +} |
| 250 | + |
| 251 | +export default useAdvancedSearchFilters; |
0 commit comments