// Copyright (C) 2012-2024 Zammad Foundation, https://zammad-foundation.org/ import { computed, ref, type Ref, watch } from 'vue' import { i18n } from '#shared/i18n.ts' import { cloneDeep, keyBy } from 'lodash-es' import type { AutoCompleteOption } from '#shared/components/Form/fields/FieldAutocomplete/types' import type { FormFieldContext } from '#shared/components/Form/types/field.ts' import useValue from '#shared/components/Form/composables/useValue.ts' import type { SelectOption, SelectValue, } from '#shared/components/CommonSelect/types.ts' import type { SelectOptionSorting } from '#shared/components/Form/fields/FieldSelect/types.ts' import type { FlatSelectOption } from '#shared/components/Form/fields/FieldTreeSelect/types.ts' type AllowedSelectValue = SelectValue | Record const useSelectOptions = < T extends SelectOption[] | FlatSelectOption[] | AutoCompleteOption[], >( options: Ref, context: Ref< FormFieldContext<{ historicalOptions?: Record multiple?: boolean noOptionsLabelTranslation?: boolean rejectNonExistentValues?: boolean sorting?: SelectOptionSorting complexValue?: boolean }> >, ) => { const dialog = ref() const { currentValue, hasValue, valueContainer, clearValue } = useValue(context) const appendedOptions = ref([] as unknown as T) as Ref const availableOptions = computed(() => [ ...(options.value || []), ...appendedOptions.value, ]) const hasStatusProperty = computed(() => availableOptions.value?.some( (option) => (option as SelectOption | FlatSelectOption).status, ), ) const translatedOptions = computed(() => { if (!availableOptions.value) return [] const { noOptionsLabelTranslation } = context.value return availableOptions.value.map((option) => { const label = noOptionsLabelTranslation ? option.label : i18n.t(option.label, ...(option.labelPlaceholder || [])) const variant = option as AutoCompleteOption const heading = noOptionsLabelTranslation ? variant.heading : i18n.t(variant.heading, ...(variant.headingPlaceholder || [])) return { ...option, label, heading, } }) }) const optionValueLookup = computed(() => keyBy(translatedOptions.value, 'value'), ) const sortedOptions = computed(() => { const { sorting } = context.value if (!sorting) return translatedOptions.value if (sorting !== 'label' && sorting !== 'value') { console.warn(`Unsupported sorting option "${sorting}"`) return translatedOptions.value } return [...translatedOptions.value]?.sort((a, b) => { const aLabelOrValue = a[sorting] || a.value const bLabelOrValue = b[sorting] || a.value return String(aLabelOrValue).localeCompare(String(bLabelOrValue)) }) }) const getSelectedOption = (selectedValue: AllowedSelectValue): T[number] => { if (typeof selectedValue === 'object' && selectedValue !== null) return selectedValue as unknown as T[number] const key = selectedValue.toString() return optionValueLookup.value[key] } const getSelectedOptionIcon = (selectedValue: AllowedSelectValue) => { const option = getSelectedOption(selectedValue) return option?.icon as string } const getSelectedOptionValue = (selectedValue: AllowedSelectValue) => { if (typeof selectedValue !== 'object') return selectedValue const option = getSelectedOption(selectedValue) return option?.value } const getSelectedOptionLabel = (selectedValue: AllowedSelectValue) => { const option = getSelectedOption(selectedValue) return option?.label } const getSelectedOptionStatus = (selectedValue: AllowedSelectValue) => { const option = getSelectedOption(selectedValue) as | SelectOption | FlatSelectOption return option?.status } const getSelectedOptionParents = ( selectedValue: string | number, ): SelectValue[] => (optionValueLookup.value[selectedValue] && (optionValueLookup.value[selectedValue] as FlatSelectOption).parents) || [] const getSelectedOptionFullPath = (selectedValue: string | number) => getSelectedOptionParents(selectedValue) .map((parentValue) => `${getSelectedOptionLabel(parentValue)} \u203A `) .join('') + (getSelectedOptionLabel(selectedValue) || i18n.t('%s (unknown)', selectedValue.toString())) const valueBuilder = (option: SelectOption): AllowedSelectValue => { return context.value.complexValue ? { value: option.value, label: option.label } : option.value } const selectOption = (option: T extends Array ? V : never) => { if (!context.value.multiple) { context.value.node.input(valueBuilder(option)) return } const selectedValues = cloneDeep(currentValue.value) || [] const optionIndex = selectedValues.indexOf(option.value) if (optionIndex !== -1) selectedValues.splice(optionIndex, 1) else selectedValues.push(valueBuilder(option)) selectedValues.sort( (a: string | number, b: string | number) => sortedOptions.value.findIndex((option) => option.value === a) - sortedOptions.value.findIndex((option) => option.value === b), ) context.value.node.input(selectedValues) } const getDialogFocusTargets = (optionsOnly?: boolean): HTMLElement[] => { const containerElement = dialog.value?.parentElement if (!containerElement) return [] const targetElements = Array.from( containerElement.querySelectorAll('[tabindex="0"]'), ) if (!targetElements) return [] if (optionsOnly) return targetElements.filter( (targetElement) => targetElement.attributes.getNamedItem('role')?.value === 'option', ) return targetElements } const handleValuesForNonExistingOrDisabledOptions = ( rejectNonExistentValues?: boolean, ) => { if (!hasValue.value || context.value.pendingValueUpdate) return const localRejectNonExistentValues = rejectNonExistentValues ?? true if (context.value.multiple) { const availableValues = currentValue.value.filter( (selectValue: string | number) => { const selectValueOption = optionValueLookup.value[selectValue] return ( (localRejectNonExistentValues && typeof selectValueOption !== 'undefined' && selectValueOption?.disabled !== true) || (!localRejectNonExistentValues && selectValueOption?.disabled !== true) ) }, ) as SelectValue[] if (availableValues.length !== currentValue.value.length) { context.value.node.input(availableValues, false) } return } const currentValueOption = optionValueLookup.value[currentValue.value] if ( (localRejectNonExistentValues && typeof currentValueOption === 'undefined') || currentValueOption?.disabled ) clearValue(false) } // Setup a mechanism to handle missing and disabled options, including: // - appending historical options for current values // - clearing value in case options are missing const setupMissingOrDisabledOptionHandling = () => { const { historicalOptions } = context.value // When we are in a "create" form situation and no 'rejectNonExistentValues' flag // is given, it should be activated. if (context.value.rejectNonExistentValues === undefined) { const rootNode = context.value.node.at('$root') context.value.rejectNonExistentValues = rootNode && rootNode.name !== context.value.node.name && !rootNode.context?.initialEntityObject } // Remember current optionValueLookup in node context. context.value.optionValueLookup = optionValueLookup // TODO: Workaround for empty string, because currently the "nulloption" exists also for multiselect fields (#4513). if (context.value.multiple) { watch( () => hasValue.value && valueContainer.value.includes('') && context.value.clearable && !options.value.some((option) => option.value === ''), () => { const emptyOption: SelectOption = { value: '', label: '-', } ;(appendedOptions.value as SelectOption[]).unshift(emptyOption) }, ) } // Append historical options to the list of available options, if: // - non-existent values are not supposed to be rejected // - we have a current value // - we have a list of historical options if ( !context.value.rejectNonExistentValues && hasValue.value && historicalOptions ) { appendedOptions.value = valueContainer.value.reduce( (accumulator: SelectOption[], value: SelectValue) => { const label = historicalOptions[value.toString()] // Make sure the options are not duplicated! if ( label && !options.value.some((option) => option.value === value) ) { accumulator.push({ value, label }) } // TODO: Workaround, because currently the "nulloption" exists also for multiselect fields (#4513). else if ( context.value.multiple && !label && value === '' && !options.value.some((option) => option.value === value) ) { accumulator.unshift({ value, label: '-' }) } return accumulator }, [], ) } // Reject non-existent or disabled option values during the initialization phase (note that // the non-existent values behavior is controlled by a dedicated flag). handleValuesForNonExistingOrDisabledOptions( context.value.rejectNonExistentValues, ) // Set up a watcher that clears a missing option value or disabled options on subsequent mutations // of the options prop (in this case, the dedicated "rejectNonExistentValues" flag is ignored). watch(options, () => handleValuesForNonExistingOrDisabledOptions()) } return { dialog, hasStatusProperty, translatedOptions, optionValueLookup, sortedOptions, getSelectedOption, getSelectedOptionValue, getSelectedOptionIcon, getSelectedOptionLabel, getSelectedOptionStatus, getSelectedOptionParents, getSelectedOptionFullPath, selectOption, getDialogFocusTargets, setupMissingOrDisabledOptionHandling, appendedOptions, } } export default useSelectOptions