appbaseio/reactivesearch

View on GitHub
packages/vue/src/components/list/MultiList.jsx

Summary

Maintainability
F
1 wk
Test Coverage
import { Actions, helper } from '@appbaseio/reactivecore';
import VueTypes from 'vue-types';
import Title from '../../styles/Title';
import Input from '../../styles/Input';
import Container from '../../styles/Container';
import { connect } from '../../utils/index';
import types from '../../utils/vueTypes';
import { UL, Checkbox } from '../../styles/FormControlList';

const {
    addComponent,
    removeComponent,
    watchComponent,
    updateQuery,
    setQueryOptions,
    setQueryListener
} = Actions;
const {
    isEqual,
    getQueryOptions,
    pushToAndClause,
    checkValueChange,
    getAggsOrder,
    getClassName
} = helper;

const MultiList = {
    name: 'MultiList',
    props: {
        defaultSelected: types.stringArray,
        queryFormat: VueTypes.oneOf(['and', 'or']).def('or'),
        showCheckbox: VueTypes.bool.def(true),
        beforeValueChange: types.func,
        className: types.string.def(''),
        componentId: types.stringRequired,
        customQuery: types.func,
        dataField: types.stringRequired,
        filterLabel: types.string,
        innerClass: types.style,
        placeholder: VueTypes.string.def('Search'),
        react: types.react,
        renderListItem: types.func,
        transformData: types.func,
        selectAllLabel: types.string,
        showCount: VueTypes.bool.def(true),
        showFilter: VueTypes.bool.def(true),
        showSearch: VueTypes.bool.def(true),
        size: VueTypes.number.def(100),
        sortBy: VueTypes.oneOf(['asc', 'desc', 'count']).def('count'),
        title: types.title,
        URLParams: VueTypes.bool.def(false),
        showMissing: VueTypes.bool.def(false),
        missingLabel: VueTypes.string.def('N/A')
    },
    data() {
        const props = this.$props;
        this.__state = {
            currentValue: {},
            modifiedOptions:
                props.options && props.options[props.dataField]
                    ? props.options[props.dataField].buckets
                    : [],
            searchTerm: ''
        };
        this.locked = false;
        this.internalComponent = `${props.componentId}__internal`;
        return this.__state;
    },
    created() {
        const onQueryChange = (...args) => {
            this.$emit('queryChange', ...args);
        };
        this.setQueryListener(this.$props.componentId, onQueryChange, null);
    },
    beforeMount() {
        this.addComponent(this.internalComponent);
        this.addComponent(this.$props.componentId);
        this.updateQueryHandlerOptions(this.$props);
        this.setReact(this.$props);

        if (this.selectedValue) {
            this.setValue(this.selectedValue);
        } else if (this.$props.defaultSelected) {
            this.setValue(this.$props.defaultSelected);
        }
    },
    beforeDestroy() {
        this.removeComponent(this.$props.componentId);
        this.removeComponent(this.internalComponent);
    },
    watch: {
        react() {
            this.setReact(this.$props);
        },
        options(newVal) {
            this.modifiedOptions = newVal[this.$props.dataField]
                ? newVal[this.$props.dataField].buckets
                : [];
        },
        size() {
            this.updateQueryHandlerOptions(this.$props);
        },
        sortBy() {
            this.updateQueryHandlerOptions(this.$props);
        },
        dataField() {
            this.updateQueryHandlerOptions(this.$props);
            this.updateQueryHandler(this.$data.currentValue, this.$props);
        },
        defaultSelected(newVal, oldVal) {
            if (!isEqual(oldVal, newVal)) {
                this.setValue(newVal, true);
            }
        },
        selectedValue(newVal) {
            let selectedValue = Object.keys(this.$data.currentValue);

            if (this.$props.selectAllLabel) {
                selectedValue = selectedValue.filter(
                    val => val !== this.$props.selectAllLabel
                );

                if (this.$data.currentValue[this.$props.selectAllLabel]) {
                    selectedValue = [this.$props.selectAllLabel];
                }
            }
            if (!isEqual(selectedValue, newVal)) {
                this.setValue(newVal || [], true);
            }
        }
    },
    render() {
        const { selectAllLabel, renderListItem } = this.$props;

        const renderListItemCalc
            = this.$scopedSlots.renderListItem || renderListItem;
        if (this.modifiedOptions.length === 0) {
            return null;
        }

        let itemsToRender = this.$data.modifiedOptions;

        if (this.$props.transformData) {
            itemsToRender = this.$props.transformData(itemsToRender);
        }

        return (
            <Container class={this.$props.className}>
                {this.$props.title && (
                    <Title class={getClassName(this.$props.innerClass, 'title')}>
                        {this.$props.title}
                    </Title>
                )}
                {this.renderSearch()}
                <UL class={getClassName(this.$props.innerClass, 'list')}>
                    {selectAllLabel ? (
                        <li
                            key={selectAllLabel}
                            class={`${this.currentValue[selectAllLabel] ? 'active' : ''}`}
                        >
                            <Checkbox
                                type="checkbox"
                                class={getClassName(this.$props.innerClass, 'checkbox')}
                                id={`${this.$props.componentId}-${selectAllLabel}`}
                                name={selectAllLabel}
                                value={selectAllLabel}
                                onClick={this.handleClick}
                                {...{
                                    domProps: {
                                        checked: !!this.currentValue[selectAllLabel]
                                    }
                                }}
                                show={this.$props.showCheckbox}
                            />
                            <label
                                class={getClassName(this.$props.innerClass, 'label')}
                                for={`${this.$props.componentId}-${selectAllLabel}`}
                            >
                                {selectAllLabel}
                            </label>
                        </li>
                    ) : null}
                    {itemsToRender
                        .filter(item => {
                            if (String(item.key).length) {
                                if (this.$props.showSearch && this.$data.searchTerm) {
                                    return String(item.key)
                                        .toLowerCase()
                                        .includes(this.$data.searchTerm.toLowerCase());
                                }

                                return true;
                            }

                            return false;
                        })
                        .map(item => (
                            <li
                                key={item.key}
                                class={`${this.$data.currentValue[item.key] ? 'active' : ''}`}
                            >
                                <Checkbox
                                    type="checkbox"
                                    class={getClassName(this.$props.innerClass, 'checkbox')}
                                    id={`${this.$props.componentId}-${item.key}`}
                                    name={this.$props.componentId}
                                    value={item.key}
                                    onClick={this.handleClick}
                                    show={this.$props.showCheckbox}
                                    {...{
                                        domProps: {
                                            checked: !!this.$data.currentValue[item.key]
                                        }
                                    }}
                                />
                                <label
                                    class={getClassName(this.$props.innerClass, 'label')}
                                    for={`${this.$props.componentId}-${item.key}`}
                                >
                                    {renderListItemCalc ? (
                                        renderListItemCalc({
                                            label: item.key,
                                            count: item.doc_count
                                        })
                                    ) : (
                                        <span>
                                            {item.key}
                                            {this.$props.showCount && (
                                                <span
                                                    class={getClassName(this.$props.innerClass, 'count')}
                                                >
                                                    &nbsp;(
                                                    {item.doc_count})
                                                </span>
                                            )}
                                        </span>
                                    )}
                                </label>
                            </li>
                        ))}
                </UL>
            </Container>
        );
    },

    methods: {
        setReact(props) {
            const { react } = props;

            if (react) {
                const newReact = pushToAndClause(react, this.internalComponent);
                this.watchComponent(props.componentId, newReact);
            } else {
                this.watchComponent(props.componentId, {
                    and: this.internalComponent
                });
            }
        },
        setValue(value, isDefaultValue = false, props = this.$props) {
            // ignore state updates when component is locked
            if (props.beforeValueChange && this.locked) {
                return;
            }

            this.locked = true;
            const { selectAllLabel } = this.$props;
            let { currentValue } = this.$data;
            let finalValues = null;
            if (
                selectAllLabel
                && ((Array.isArray(value) && value.includes(selectAllLabel))
                    || (typeof value === 'string' && value === selectAllLabel))
            ) {
                if (currentValue[selectAllLabel]) {
                    currentValue = {};
                    finalValues = [];
                } else {
                    this.$data.modifiedOptions.forEach(item => {
                        currentValue[item.key] = true;
                    });
                    currentValue[selectAllLabel] = true;
                    finalValues = [selectAllLabel];
                }
            } else if (isDefaultValue) {
                finalValues = value;
                currentValue = {};

                if (value) {
                    value.forEach(item => {
                        currentValue[item] = true;
                    });
                }

                if (selectAllLabel && selectAllLabel in currentValue) {
                    const { [selectAllLabel]: del, ...obj } = currentValue;
                    currentValue = {
                        ...obj
                    };
                }
            } else {
                if (currentValue[value]) {
                    const { [value]: del, ...rest } = currentValue;
                    currentValue = {
                        ...rest
                    };
                } else {
                    currentValue[value] = true;
                }
                if (selectAllLabel && selectAllLabel in currentValue) {
                    const { [selectAllLabel]: del, ...obj } = currentValue;
                    currentValue = {
                        ...obj
                    };
                }

                finalValues = Object.keys(currentValue);
            }

            const performUpdate = () => {
                this.currentValue = Object.assign({}, currentValue);
                this.updateQueryHandler(finalValues, props);
                this.locked = false;
                this.$emit('valueChange', finalValues);
            };
            checkValueChange(
                props.componentId,
                finalValues,
                props.beforeValueChange,
                performUpdate
            );
        },

        updateQueryHandler(value, props) {
            const query = props.customQuery || MultiList.defaultQuery;
            this.updateQuery({
                componentId: props.componentId,
                query: query(value, props),
                value,
                label: props.filterLabel,
                showFilter: props.showFilter,
                URLParams: props.URLParams,
                componentType: 'MULTILIST'
            });
        },

        generateQueryOptions(props) {
            const queryOptions = getQueryOptions(props);
            queryOptions.size = 0;
            queryOptions.aggs = {
                [props.dataField]: {
                    terms: {
                        field: props.dataField,
                        size: props.size,
                        order: getAggsOrder(props.sortBy || 'count'),
                        ...(props.showMissing
                            ? {
                                missing: props.missingLabel
                              }
                            : {})
                    }
                }
            };
            return queryOptions;
        },

        updateQueryHandlerOptions(props) {
            const queryOptions = MultiList.generateQueryOptions(props);
            this.setQueryOptions(this.internalComponent, queryOptions);
        },

        handleInputChange(e) {
            const { value } = e.target;
            this.searchTerm = value;
        },

        renderSearch() {
            if (this.$props.showSearch) {
                return (
                    <Input
                        class={getClassName(this.$props.innerClass, 'input') || ''}
                        onInput={this.handleInputChange}
                        value={this.$data.searchTerm}
                        placeholder={this.$props.placeholder}
                        style={{
                            margin: '0 0 8px'
                        }}
                        themePreset={this.$props.themePreset}
                    />
                );
            }

            return null;
        },

        handleClick(e) {
            this.setValue(e.target.value);
        }
    }
};
MultiList.defaultQuery = (value, props) => {
    let query = null;
    const type = props.queryFormat === 'or' ? 'terms' : 'term';

    if (!Array.isArray(value) || value.length === 0) {
        return null;
    }

    if (props.selectAllLabel && value.includes(props.selectAllLabel)) {
        if (props.showMissing) {
            query = { match_all: {} };
        } else {
            query = {
                exists: {
                    field: props.dataField
                }
            };
        }
    } else if (value) {
        let listQuery;
        if (props.queryFormat === 'or') {
            if (props.showMissing) {
                const hasMissingTerm = value.includes(props.missingLabel);
                let should = [
                    {
                        [type]: {
                            [props.dataField]: value.filter(
                                item => item !== props.missingLabel
                            )
                        }
                    }
                ];
                if (hasMissingTerm) {
                    should = should.concat({
                        bool: {
                            must_not: {
                                exists: { field: props.dataField }
                            }
                        }
                    });
                }
                listQuery = {
                    bool: {
                        should
                    }
                };
            } else {
                listQuery = {
                    [type]: {
                        [props.dataField]: value
                    }
                };
            }
        } else {
            // adds a sub-query with must as an array of objects for each term/value
            const queryArray = value.map(item => ({
                [type]: {
                    [props.dataField]: item
                }
            }));
            listQuery = {
                bool: {
                    must: queryArray
                }
            };
        }

        query = value.length ? listQuery : null;
    }
    return query;
};
MultiList.generateQueryOptions = props => {
    const queryOptions = getQueryOptions(props);
    queryOptions.size = 0;
    queryOptions.aggs = {
        [props.dataField]: {
            terms: {
                field: props.dataField,
                size: props.size,
                order: getAggsOrder(props.sortBy || 'count'),
                ...(props.showMissing ? { missing: props.missingLabel } : {})
            }
        }
    };

    return queryOptions;
};
const mapStateToProps = (state, props) => ({
    options: state.aggregations[props.componentId],
    selectedValue:
        (state.selectedValues[props.componentId]
            && state.selectedValues[props.componentId].value)
        || null,
    themePreset: state.config.themePreset
});

const mapDispatchtoProps = {
    addComponent,
    removeComponent,
    setQueryOptions,
    setQueryListener,
    updateQuery,
    watchComponent
};

const ListConnected = connect(
    mapStateToProps,
    mapDispatchtoProps
)(MultiList);

MultiList.install = function(Vue) {
    Vue.component(MultiList.name, ListConnected);
};
export default MultiList;