@oat-sa/tao-core-ui 1.60.2 → 1.62.0

package/src/searchModal/advancedSearch.js

@@ -1,601 +1,638 @@
-/**
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; under version 2
- * of the License (non-upgradable).
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
- *
- * Copyright (c) 2021 (original work) Open Assessment Technologies SA ;
- */
-
-import $ from 'jquery';
-import _ from 'lodash';
-import advancedSearchTpl from 'ui/searchModal/tpl/advanced-search';
-import textCriterionTpl from 'ui/searchModal/tpl/text-criterion';
-import invalidCriteriaWarningTpl from 'ui/searchModal/tpl/invalid-criteria-warning';
-import listCheckboxCriterionTpl from 'ui/searchModal/tpl/list-checkbox-criterion';
-import listSelectCriterionTpl from 'ui/searchModal/tpl/list-select-criterion';
-import 'ui/searchModal/css/advancedSearch.css';
-import component from 'ui/component';
-import 'ui/modal';
-import 'ui/datatable';
-import 'select2';
-import urlUtil from 'util/url';
-import request from 'core/dataProvider/request';
-
-/**
- * Creates advanced search component
- *
- * @param {object} config
- * @param {object} config.renderTo - DOM element where component will be rendered to
- * @param {string} config.advancedCriteria - advanced criteria to be set on component creation
- * @param {string} config.rootClassUri - rootClassUri to check for whitelist sections
- * @returns {advancedSearch}
- */
-export default function advancedSearchFactory(config) {
-    // Private properties to be easily accessible by instance methods
-    let $container = null;
-    let $addCriteria = null;
-    let $addCriteriaInput = null;
-    let $criteriaSelect = null;
-    let $advancedCriteriaContainer = null;
-    let criteriaState = null;
-    let criteriaMapping = {};
-    const criteriaTypes = {
-        text: 'text',
-        list: 'list'
-    };
-
-    let isAdvancedSearchStatusEnabled;
-    let isCriteriaListUpdated = false;
-
-    // Creates new component
-    const instance = component({
-        /**
-         * Request metadata (criteria) for the given uri
-         * @param {string} classUri - url to make the reques to
-         * @returns {Promise} - Request promise
-         */
-        updateCriteria: function (route) {
-            if (!isAdvancedSearchStatusEnabled) {
-                return Promise.resolve();
-            }
-
-            const $criteriaIcon = $('.add-criteria-container a span').eq(0);
-            $criteriaIcon.toggleClass('icon-add').toggleClass('icon-loop');
-            return request(route)
-                .then(response => {
-                    criteriaMapping = response.criteriaMapping || {};
-                    const classTree = response.classDefinition ? response.classDefinition : response;
-                    const criteria = formatCriteria(classTree);
-                    updateCriteria(criteria);
-                    isCriteriaListUpdated = true;
-                    $criteriaIcon.toggleClass('icon-add').toggleClass('icon-loop');
-                })
-                .catch(e => instance.trigger('error', e));
-        },
-        /**
-         * Access to component state
-         * @returns {Object} - criteria state
-         */
-        getState: function () {
-            return criteriaState;
-        },
-        /**
-         * Removes every rendered criterion, updates criteria state accordingly
-         * and removes classes applied to scrollable list of criteria
-         */
-        clear: function () {
-            $advancedCriteriaContainer.removeClass(['scrollable', 'scroll-separator-top', 'scroll-separator-bottom']);
-            $advancedCriteriaContainer.empty();
-            _.forEach(criteriaState, criterion => {
-                criterion.rendered = false;
-                criterion.value = null;
-            });
-        },
-        /**
-         * Builds substring of search query with the advanced criteria conditions
-         */
-        getAdvancedCriteriaQuery: function (hasSearchInput) {
-            const advancedSearchCriteria = _.filter(criteriaState, criterion => criterion.rendered === true);
-            let query = '';
-
-            advancedSearchCriteria.forEach(renderedCriterion => {
-                const queryParam = renderedCriterion.propertyUri;
-                if ((hasSearchInput || query.trim().length !== 0) && renderedCriterion.value) {
-                    query += ' AND ';
-                }
-                if (renderedCriterion.type === criteriaTypes.text) {
-                    if (renderedCriterion.value && renderedCriterion.value.trim() !== '') {
-                        query += `${queryParam}:${renderedCriterion.value.trim()}`;
-                    }
-                } else if (renderedCriterion.type === criteriaTypes.list) {
-                    if (renderedCriterion.value && renderedCriterion.value.length > 0) {
-                        /* Temp replaced OR with AND. See ADF-7 for details */
-                        query += `${queryParam}:${renderedCriterion.value.join(' AND ')}`;
-                    }
-                }
-            });
-
-            return query;
-        }
-    })
-        .setTemplate(advancedSearchTpl)
-        .on('render', () => {
-            initUiSelectors();
-            initAddCriteriaSelector()
-                .then(() => {
-                    initCriteriaState();
-                    instance.trigger('ready');
-                })
-                .catch(e => instance.trigger('error', e));
-        });
-
-    /**
-     * Inits template selectors and scroll animation
-     */
-    function initUiSelectors() {
-        $container = instance.getElement();
-        $addCriteria = $('.add-criteria-container', $container);
-        $addCriteria.addClass('disabled');
-        $addCriteriaInput = $('.add-criteria-container a', $container);
-        $criteriaSelect = $('.add-criteria-container select', $container);
-        $advancedCriteriaContainer = $('.advanced-criteria-container', $container);
-
-        $advancedCriteriaContainer.on('scroll', _.throttle(animateScroll, 100));
-    }
-
-    /**
-     * Lookup for characters in text to highlight
-     * @param {String} text - text to lookup
-     * @param {String} highlight - character(s) to be highlighted
-     * @param {regExp|String} match - match to be applied in the text
-     * @returns {String} - highlighted text
-     */
-    function highlightCharacter(text, highlight, match) {
-        return text.replace(match, `<b>${highlight}</b>`);
-    }
-
-    /**
-     * Inits select2 on criteria select and its UX logic
-     */
-    function initAddCriteriaSelector() {
-        const route = urlUtil.route('status', 'AdvancedSearch', 'tao');
-        return request(route)
-            .then(function (response) {
-                if (!response.enabled || (response.whitelist && response.whitelist.includes(config.rootClassUri))) {
-                    isAdvancedSearchStatusEnabled = false;
-                    return;
-                }
-                isAdvancedSearchStatusEnabled = true;
-                $addCriteria.removeClass('disabled');
-                $criteriaSelect.select2({
-                    containerCssClass: 'criteria-select2',
-                    dropdownCssClass: 'criteria-dropdown-select2',
-                    sortResults: results => _.sortBy(results, ['text']),
-                    escapeMarkup: function(markup) {
-                        return markup;
-                    },
-                    formatResult: function formatResult(result, container, query) {
-                        const label = result.element[0].getAttribute('label');
-                        const sublabel = result.element[0].getAttribute('sublabel');
-                        const match = new RegExp(query.term, 'ig');
-                        let template = highlightCharacter(label, query.term, match);
-
-                        // Add sublabel
-                        if(sublabel && sublabel.length) {
-                            template = template + `<span class="class-path"> / ${highlightCharacter(sublabel, query.term, match)}</span>`;
-                        }
-
-                        return template;
-                    }
-                });
-
-                // open dropdown when user clicks on add criteria input
-                $addCriteriaInput.on('click', () => {
-                    if (isCriteriaListUpdated) {
-                        $criteriaSelect.select2('open');
-                        // if dropdown is opened above addCriteria input, top property is slightly decreased to avoid overlapping with addCriteria icon
-                        if ($('.criteria-dropdown-select2').hasClass('select2-drop-above')) {
-                            $('.criteria-dropdown-select2').css(
-                                'top',
-                                $('.criteria-dropdown-select2').css('top').split('px')[0] - 10 + 'px'
-                            );
-                        }
-                    }
-                });
-
-                // when a criterion is selected add it to criteria container, remove it from dropdown options and reset select
-                $criteriaSelect.on('change', () => {
-                    const criterionToAdd = $criteriaSelect.children('option:selected').val();
-                    addNewCriterion(criterionToAdd);
-                    $criteriaSelect.children('option:selected').remove();
-                    $criteriaSelect.select2('val', '');
-                });
-            })
-            .catch(function (e) {
-                return instance.trigger('error', e);
-            });
-    }
-
-    /**
-     * inits criteriaState loading it from the store (if present) or empty object.
-     * If there is a stored criteriaState, those criteria that were rendered
-     * but with null value are updated to not being rendered
-     */
-    function initCriteriaState() {
-        if (instance.config.advancedCriteria) {
-            _.forEach(instance.config.advancedCriteria, criterion => {
-                if (criterion.rendered === true && criterion.value === null) {
-                    criterion.rendered = false;
-                }
-            });
-        }
-        criteriaState = instance.config.advancedCriteria || {};
-    }
-
-    /**
-     * Styles scrolling on $advancedCriteriaContainer
-     */
-    function animateScroll() {
-        const scrollPercentage =
-            $advancedCriteriaContainer.get(0).scrollTop /
-            ($advancedCriteriaContainer.get(0).scrollHeight - $advancedCriteriaContainer.get(0).clientHeight);
-        if (scrollPercentage > 0.1) {
-            $advancedCriteriaContainer.addClass('scroll-separator-top');
-        } else {
-            $advancedCriteriaContainer.removeClass('scroll-separator-top');
-        }
-        if (scrollPercentage < 0.9) {
-            $advancedCriteriaContainer.addClass('scroll-separator-bottom');
-        } else {
-            $advancedCriteriaContainer.removeClass('scroll-separator-bottom');
-        }
-    }
-
-    /**
-     * Renders new criterion to criteria container so it can be used on advanced search filtering
-     * @param {string} criterionToAdd - new criterion to be added
-     */
-    function addNewCriterion(criterionToAdd) {
-        // remove deprecated warning message
-        $('.invalid-criteria-warning-container').remove();
-
-        // render new criterion
-        const criterion = criteriaState[criterionToAdd];
-        const $criterionContainer = renderCriterion(criterion);
-
-        // set logic to remove criterion
-        $('.icon-result-nok', $criterionContainer).on('click', { criterion }, removeCriterion);
-
-        // set initial value and manage value changes
-        bindCriterionValue(criterion, $criterionContainer);
-
-        // update styles if scroll is enabled
-        if ($advancedCriteriaContainer.get(0).scrollHeight > $advancedCriteriaContainer.outerHeight()) {
-            $advancedCriteriaContainer.addClass('scrollable');
-        }
-
-        criterion.rendered = true;
-    }
-
-    /**
-     * Renders the new criterion selecting the appropiate handlebars template and prepending to advanced criteria container.
-     * If criterion is of type list with a uri endpoint to request the options, select2 is also init
-     * @param {object} criterion - criterion to render
-     * @returns - the rendered container
-     */
-    function renderCriterion(criterion) {
-        let templateToUse = null;
-        if (criterion.type === criteriaTypes.text) {
-            templateToUse = textCriterionTpl;
-        } else if (criterion.type === criteriaTypes.list && criterion.uri) {
-            templateToUse = listSelectCriterionTpl;
-        } else {
-            templateToUse = listCheckboxCriterionTpl;
-        }
-
-        $advancedCriteriaContainer.append(templateToUse({ criterion }));
-
-        const $criterionContainer = $(`.${criterion.id}-filter`, $container);
-        const valueMapping = criteriaMapping[criterion.type];
-
-        /**
-         * On criterion of type list with a uri endpoint to retrieve options, template includes a select
-         * that is managed with select2, so we init it here
-         */
-        if (criterion.type === criteriaTypes.list && criterion.uri) {
-            $(`input[name=${criterion.id}-select]`, $criterionContainer).select2({
-                multiple: true,
-                ajax: {
-                    url: criterion.uri,
-                    dataType: 'json',
-                    data: function (term) {
-                        return {
-                            subject: term
-                        };
-                    },
-                    results: (response) => ({
-                        results: response.data.map(option => ({ id: valueMapping === 'uri' ? option.uri : option.label, text: option.label }))
-                    })
-                },
-                initSelection: function (element, callback) {
-                    const data = [];
-                    $(element.val().split(',')).each(function () {
-                        data.push({ id: this, text: this });
-                    });
-                    callback(data);
-                }
-            });
-        }
-
-        return $criterionContainer;
-    }
-
-    /**
-     * Fetches initial criterion label from api in case the value mapping is uri
-     * @param {object} criterion - criterion to be managed
-     */
-    function getInitialCriterionLabel(criterion) {
-        const valueMapping = criteriaMapping[criterion.type];
-        if (valueMapping !== 'uri' || !criterion.value) {
-            return Promise.resolve({
-                id: criterion.value,
-                text: criterion.value
-            });
-        }
-        return $.ajax({
-            type: 'GET',
-            url: criterion.uri,
-            dataType: 'json',
-        }).then(({ data }) => {
-            if (Array.isArray(criterion.value)) {
-                return criterion.value.map(v => ({
-                    id: v,
-                    text: (data.find(d => d.uri === v) || {}).label
-                }));
-            }
-            let c = (data.find(d => d.uri === criterion.value) || {});
-            return {
-                text: c.label,
-                id: criterion.value,
-            };
-        });
-    }
-
-    /**
-     * Sets initial value for rendered criterion and sets binding between view and state
-     * @param {object} criterion - criterion to be managed
-     * @param {object} $criterionContainer - rendered criterion
-     */
-    function bindCriterionValue(criterion, $criterionContainer) {
-        getInitialCriterionLabel(criterion).then(initialCriterion => {
-            if (criterion.type === criteriaTypes.text) {
-                // set initial value
-                $('input', $criterionContainer).val(criterion.value);
-                // set event to bind input value to critariaState
-                $('input', $criterionContainer).on('change', function () {
-                    criterion.value = $(this).val() || null;
-                });
-            } else if (criterion.type === criteriaTypes.list && criterion.uri) {
-                // set initial value
-                if (criterion.value) {
-                    $(`input[name=${criterion.id}-select]`, $criterionContainer).select2('data', initialCriterion);
-                }
-                // set event to bind input value to critariaState
-                $(`input[name=${criterion.id}-select]`, $criterionContainer).on('change', event => {
-                    criterion.value = event.val;
-                });
-            } else {
-                // set initial value
-                if (criterion.value) {
-                    criterion.value.forEach(selectedValue => {
-                        $(`input[value=${selectedValue}]`, $criterionContainer).prop('checked', true);
-                    });
-                }
-                // set event to bind input value to critariaState
-                $('input[type="checkbox"]', $criterionContainer).on('change', function () {
-                    criterion.value = $(this)
-                        .closest('.filter-container')
-                        .find('input[type=checkbox]:checked')
-                        .get()
-                        .map(element => element.value);
-                });
-            }
-        });
-    }
-
-    /**
-     * Removes a criterion from advanced criteria container when user clicks on the criterion close icon.
-     * It also adds the option element to criteria select so removed criterion can be rendered again
-     * @param {object} event - click event triggered on closing icon
-     */
-    function removeCriterion(event) {
-        const criterion = event.data.criterion;
-        const newOption = createCriteriaOption(criterion);
-        const criterionKey = getCriterionStateId(criterion);
-
-        // remove criterion and append new criterion to select options
-        $(this).parent().remove();
-        $criteriaSelect.append(newOption);
-
-        // reset criterion values on criteriaState
-        criteriaState[criterionKey].rendered = false;
-        criteriaState[criterionKey].value = null;
-
-        // check if advanced criteria container is no longer scrollable
-        if ($advancedCriteriaContainer.get(0).scrollHeight <= $advancedCriteriaContainer.outerHeight()) {
-            $advancedCriteriaContainer.removeClass('scrollable');
-        }
-    }
-
-    /**
-     * Parses received criteria from BE to the data structure required for criteria selector. To do so,
-     * appends every criterion into criteria array and then returns a duplicate-free version of it
-     * considering label property as uniqueness criterion
-     * @param {Array} classes - array of classes with the metadata (aka criteria) for each one of them
-     * @returns {Array} - criteria array
-     */
-    function formatCriteria(classTree) {
-        let criteria = [];
-
-        _.forEach(classTree, classInstance => {
-            criteria.push(...classInstance.metadata);
-        });
-
-        // extends each criterion with an id that can be use as a valid css class
-        _.forEach(criteria, criterion => {
-            criterion.label = getCriterionLabel(criterion);
-            criterion.id = criterion.propertyUri.replace(/^[^a-zA-Z]*|[^a-zA-Z0-9]*/g, '');
-        });
-
-        return criteria;
-    }
-
-    /**
-     * Manages the new set of available criteria. To do so, removes warning container and every
-     * selectable criterion. Then removes from criteriaState and view every deprecated criterion,
-     * updates criteriaState with the new available criteria set, and renders new warning
-     * message if required
-     * @param {array} criteria - array of class properties
-     */
-    function updateCriteria(criteria) {
-        $('.invalid-criteria-warning-container').remove();
-        $criteriaSelect.find('option:not(:first-child)').remove();
-        const invalidCriteria = deleteDeprecatedCriteria(criteria);
-        extendCriteria(criteria);
-        renderWarningMessage(invalidCriteria);
-    }
-
-    /**
-     * If there is any invalid criterion, renders an explanatory warning message
-     * @param {array} invalidCriteria - array of string containing the label of every invalid criterion (those that were rendered but are no longer available)
-     */
-    function renderWarningMessage(invalidCriteria) {
-        if (invalidCriteria.length > 0) {
-            const invalidCriteriaWarning = invalidCriteriaWarningTpl({ invalidCriteria });
-            $advancedCriteriaContainer.prepend(invalidCriteriaWarning);
-            $('.invalid-criteria-warning-container .select2-search-choice-close', $advancedCriteriaContainer).on(
-                'click',
-                function () {
-                    $(this).parent().remove();
-                }
-            );
-        }
-    }
-
-    /**
-     * Loops through current criteriaState so every criterion that is no longer available in the new
-     * available criteria set is removed from criteriaState and from view, in case it had been
-     * rendered. In that case it is also pushed into invalidCriteria array to be latter
-     * included in the warning message
-     * @param {array} criteria - array containing new set of criteria for current class
-     * @returns {array} - array of strings with each deprecated criterion that was being displayed
-     */
-    function deleteDeprecatedCriteria(criteria) {
-        const invalidCriteria = [];
-
-        _.forEach(criteriaState, oldCriterion => {
-            const deprecatedCriterion = !criteria.find(newCriterion => newCriterion.label === oldCriterion.label);
-            const oldCriterionKey = getCriterionStateId(oldCriterion);
-
-            if (deprecatedCriterion) {
-                if (criteriaState[oldCriterionKey].rendered) {
-                    $advancedCriteriaContainer.find(`.${oldCriterion.id}-filter`).remove();
-                    invalidCriteria.push(oldCriterion.label);
-                }
-                delete criteriaState[oldCriterionKey];
-            }
-        });
-
-        return invalidCriteria;
-    }
-
-    /**
-     * Loops through new criteria set and checks if each new criterion was already present or not on criteriaState
-     * and updates view and selectable criteria list accordingly
-     * @param {array} criteria - array containing new set of criteria for current class
-     */
-    function extendCriteria(criteria) {
-        criteria.forEach(criterion => {
-            let createOption = true;
-            const criteriaStateId = getCriterionStateId(criterion);
-
-            // if new criterion was already on criteriaState and had to be rendered, we avoid creating an option for it and render it if it was not
-            if (criteriaState[criteriaStateId] && criteriaState[criteriaStateId].rendered === true) {
-                createOption = false;
-
-                if ($advancedCriteriaContainer.find(`.${criterion.id}-filter`).length === 0) {
-                    addNewCriterion(criteriaStateId);
-                }
-            } else {
-                // if new criterion was not on criteriaState we add it
-                criteriaState[criteriaStateId] = criterion;
-                criteriaState[criteriaStateId].rendered = false;
-                criteriaState[criteriaStateId].value = null;
-            }
-
-            // create new option element to criteria select
-            if (createOption) {
-                $criteriaSelect.append(createCriteriaOption(criterion));
-            }
-        });
-    }
-
-    /**
-     * Creates a new option element
-     * with attributes to use in select2 markup
-     * @param {Object} criterion
-     * @returns {HTMLOptionElement} Single option criteria
-     */
-    function createCriteriaOption(criterion) {
-        let label = criterion.label;
-        let sublabel = '';
-        let option;
-        let optionText = label;
-
-        if (criterion.isDuplicated) {
-            sublabel = criterion.class.label;
-            optionText = `${label} (${criterion.alias}) /`;
-        }
-
-        option = new Option(
-            label,
-            getCriterionStateId(criterion),
-            false,
-            false
-        );
-
-        option.setAttribute('label', optionText);
-        option.setAttribute('sublabel', sublabel);
-
-        return option;
-    }
-
-    /**
-     * @param {Object} criterion
-     * @returns String
-     */
-    function getCriterionStateId(criterion) {
-        return criterion.propertyUri;
-    }
-
-    /**
-     * @param {Object} criterion
-     * @returns String
-     */
-    function getCriterionLabel(criterion) {
-        return criterion.label;
-    }
-
-    // return initialized instance of searchModal
-    return instance.init(config);
-}
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2021 (original work) Open Assessment Technologies SA ;
+ */
+
+import $ from 'jquery';
+import _ from 'lodash';
+import advancedSearchTpl from 'ui/searchModal/tpl/advanced-search';
+import textCriterionTpl from 'ui/searchModal/tpl/text-criterion';
+import invalidCriteriaWarningTpl from 'ui/searchModal/tpl/invalid-criteria-warning';
+import listCheckboxCriterionTpl from 'ui/searchModal/tpl/list-checkbox-criterion';
+import listSelectCriterionTpl from 'ui/searchModal/tpl/list-select-criterion';
+import highlightedTextTpl from 'ui/searchModal/tpl/highlighted-text';
+import classLabelTpl from 'ui/searchModal/tpl/criteria-class-label';
+import aliasTpl from 'ui/searchModal/tpl/criteria-alias';
+import labelTpl from 'ui/searchModal/tpl/criteria-label';
+import 'ui/searchModal/css/advancedSearch.css';
+import component from 'ui/component';
+import 'ui/modal';
+import 'ui/datatable';
+import 'select2';
+import request from 'core/dataProvider/request';
+
+/**
+ * Sort an array by a particular property.
+ * @param {Array} iter - The array to sort.
+ * @param {string} prop - The name of the sorting property.
+ * @returns {Array} - Returns a sorted copy of the array.
+ * @private
+ */
+function sortBy(iter, prop) {
+    return Array.from(iter).sort((a, b) => {
+        const textA = (a && a[prop]) || '';
+        const textB = (b && b[prop]) || '';
+        return textA.localeCompare(textB);
+    });
+}
+
+/**
+ * Creates advanced search component
+ *
+ * @param {object} config
+ * @param {object} config.renderTo - DOM element where component will be rendered to
+ * @param {string} config.advancedCriteria - advanced criteria to be set on component creation
+ * @param {bool} config.hideCriteria - if the criteria must be hidden
+ * @param {string} config.rootClassUri - rootClassUri to check for whitelist sections
+ * @param {string} config.statusUrl - the URL to the status API (usually '/tao/AdvancedSearch/status')
+ * @returns {advancedSearch}
+ */
+export default function advancedSearchFactory(config) {
+    // Private properties to be easily accessible by instance methods
+    let $container = null;
+    let $addCriteria = null;
+    let $addCriteriaInput = null;
+    let $criteriaSelect = null;
+    let $advancedCriteriaContainer = null;
+    let criteriaState = null;
+    let criteriaMapping = {};
+    const criteriaTypes = {
+        text: 'text',
+        list: 'list'
+    };
+
+    let isAdvancedSearchStatusEnabled;
+    let isCriteriaListUpdated = false;
+
+    // Creates new component
+    const instance = component({
+        /**
+         * Tells if the advanced search is enabled.
+         * @returns {boolean}
+         */
+        isEnabled() {
+            return !!isAdvancedSearchStatusEnabled;
+        },
+
+        /**
+         * Request metadata (criteria) for the given uri
+         * @param {string} classUri - url to make the reques to
+         * @returns {Promise} - Request promise
+         */
+        updateCriteria(route) {
+            if (!isAdvancedSearchStatusEnabled) {
+                return Promise.resolve();
+            }
+
+            const $criteriaIcon = $('.add-criteria-container a span').eq(0);
+            $criteriaIcon.toggleClass('icon-add').toggleClass('icon-loop');
+            return request(route)
+                .then(response => {
+                    criteriaMapping = response.criteriaMapping || {};
+                    const classTree = response.classDefinition ? response.classDefinition : response;
+                    const criteria = formatCriteria(classTree);
+                    updateCriteria(criteria);
+                    isCriteriaListUpdated = true;
+                    $criteriaIcon.toggleClass('icon-add').toggleClass('icon-loop');
+                })
+                .catch(e => instance.trigger('error', e));
+        },
+        /**
+         * Access to component state
+         * @returns {Object} - criteria state
+         */
+        getState() {
+            return criteriaState;
+        },
+        /**
+         * Removes every rendered criterion, updates criteria state accordingly
+         * and removes classes applied to scrollable list of criteria
+         */
+        clear() {
+            $advancedCriteriaContainer.removeClass(['scrollable', 'scroll-separator-top', 'scroll-separator-bottom']);
+            $advancedCriteriaContainer.empty();
+            _.forEach(criteriaState, criterion => {
+                criterion.rendered = false;
+                criterion.value = null;
+            });
+        },
+        /**
+         * Builds substring of search query with the advanced criteria conditions
+         */
+        getAdvancedCriteriaQuery(hasSearchInput) {
+            const advancedSearchCriteria = _.filter(criteriaState, criterion => criterion.rendered === true);
+            let query = '';
+
+            advancedSearchCriteria.forEach(renderedCriterion => {
+                const queryParam = renderedCriterion.propertyUri;
+                if ((hasSearchInput || query.trim().length !== 0) && renderedCriterion.value) {
+                    query += ' AND ';
+                }
+                if (renderedCriterion.type === criteriaTypes.text) {
+                    if (renderedCriterion.value && renderedCriterion.value.trim() !== '') {
+                        query += `${queryParam}:${renderedCriterion.value.trim()}`;
+                    }
+                } else if (renderedCriterion.type === criteriaTypes.list) {
+                    if (renderedCriterion.value && renderedCriterion.value.length > 0) {
+                        /* Temp replaced OR with AND. See ADF-7 for details */
+                        query += `${queryParam}:${renderedCriterion.value.join(' AND ')}`;
+                    }
+                }
+            });
+
+            return query;
+        }
+    })
+        .setTemplate(advancedSearchTpl)
+        .on('render', () => {
+            initUiSelectors();
+            initAddCriteriaSelector()
+                .then(() => {
+                    initCriteriaState();
+                    instance.trigger('ready');
+                })
+                .catch(e => instance.trigger('error', e));
+        });
+
+    /**
+     * Inits template selectors and scroll animation
+     */
+    function initUiSelectors() {
+        $container = instance.getElement();
+        $addCriteria = $('.add-criteria-container', $container);
+        $addCriteria.addClass('disabled');
+        $addCriteriaInput = $('.add-criteria-container a', $container);
+        $criteriaSelect = $('.add-criteria-container select', $container);
+        $advancedCriteriaContainer = $('.advanced-criteria-container', $container);
+
+        $advancedCriteriaContainer.on('scroll', _.throttle(animateScroll, 100));
+    }
+
+    /**
+     * Lookup for characters in text to highlight
+     * @param {String} text - text to lookup
+     * @param {String} searchString - match to be applied in the text
+     * @returns {String} - highlighted text
+     */
+    function highlightCharacter(text, searchString) {
+        if (!searchString) {
+            return text;
+        }
+        const reg = new RegExp(searchString, 'gi');
+        return text.replace(reg, str => highlightedTextTpl({ text: str }));
+    }
+
+    /**
+     * Inits select2 on criteria select and its UX logic
+     */
+    function initAddCriteriaSelector() {
+        return request(instance.config.statusUrl)
+            .then(function (response) {
+                if (
+                    config.hideCriteria ||
+                    !response.enabled ||
+                    (response.whitelist && response.whitelist.includes(config.rootClassUri))
+                ) {
+                    isAdvancedSearchStatusEnabled = false;
+                    return;
+                }
+                isAdvancedSearchStatusEnabled = true;
+                $addCriteria.removeClass('disabled');
+                $criteriaSelect.select2({
+                    containerCssClass: 'criteria-select2',
+                    dropdownCssClass: 'criteria-dropdown-select2',
+                    sortResults: results => sortBy(results, 'text'),
+                    escapeMarkup: function (markup) {
+                        return markup;
+                    },
+                    formatResult: function formatResult(result, container, query) {
+                        const label = result.element[0].getAttribute('label');
+                        const alias = result.element[0].getAttribute('alias');
+                        const classLabel = result.element[0].getAttribute('class-label');
+
+                        let html = labelTpl({ text: highlightCharacter(label, query.term) });
+
+                        if (alias) {
+                            html += aliasTpl({ text: alias });
+                        }
+
+                        if (classLabel) {
+                            html += classLabelTpl({ text: classLabel });
+                        }
+
+                        return html;
+                    }
+                });
+
+                // open dropdown when user clicks on add criteria input
+                $addCriteriaInput.on('click', () => {
+                    if (isCriteriaListUpdated) {
+                        $criteriaSelect.select2('open');
+                        // if dropdown is opened above addCriteria input, top property is slightly decreased to avoid overlapping with addCriteria icon
+                        if ($('.criteria-dropdown-select2').hasClass('select2-drop-above')) {
+                            $('.criteria-dropdown-select2').css(
+                                'top',
+                                $('.criteria-dropdown-select2').css('top').split('px')[0] - 10 + 'px'
+                            );
+                        }
+                    }
+                });
+
+                // when a criterion is selected add it to criteria container, remove it from dropdown options and reset select
+                $criteriaSelect.on('change', () => {
+                    const criterionToAdd = $criteriaSelect.children('option:selected').val();
+                    addNewCriterion(criterionToAdd);
+                    $criteriaSelect.children('option:selected').remove();
+                    $criteriaSelect.select2('val', '');
+                });
+            })
+            .catch(function (e) {
+                return instance.trigger('error', e);
+            });
+    }
+
+    /**
+     * inits criteriaState loading it from the store (if present) or empty object.
+     * If there is a stored criteriaState, those criteria that were rendered
+     * but with null value are updated to not being rendered
+     */
+    function initCriteriaState() {
+        if (instance.config.advancedCriteria) {
+            _.forEach(instance.config.advancedCriteria, criterion => {
+                if (criterion.rendered === true && criterion.value === null) {
+                    criterion.rendered = false;
+                }
+            });
+        }
+        criteriaState = instance.config.advancedCriteria || {};
+    }
+
+    /**
+     * Styles scrolling on $advancedCriteriaContainer
+     */
+    function animateScroll() {
+        const scrollPercentage =
+            $advancedCriteriaContainer.get(0).scrollTop /
+            ($advancedCriteriaContainer.get(0).scrollHeight - $advancedCriteriaContainer.get(0).clientHeight);
+        if (scrollPercentage > 0.1) {
+            $advancedCriteriaContainer.addClass('scroll-separator-top');
+        } else {
+            $advancedCriteriaContainer.removeClass('scroll-separator-top');
+        }
+        if (scrollPercentage < 0.9) {
+            $advancedCriteriaContainer.addClass('scroll-separator-bottom');
+        } else {
+            $advancedCriteriaContainer.removeClass('scroll-separator-bottom');
+        }
+    }
+
+    /**
+     * Renders new criterion to criteria container so it can be used on advanced search filtering
+     * @param {string} criterionToAdd - new criterion to be added
+     */
+    function addNewCriterion(criterionToAdd) {
+        // remove deprecated warning message
+        $('.invalid-criteria-warning-container').remove();
+
+        // render new criterion
+        const criterion = criteriaState[criterionToAdd];
+        const $criterionContainer = renderCriterion(criterion);
+
+        // set logic to remove criterion
+        $('.icon-result-nok', $criterionContainer).on('click', { criterion }, removeCriterion);
+
+        // set initial value and manage value changes
+        bindCriterionValue(criterion, $criterionContainer);
+
+        // update styles if scroll is enabled
+        if ($advancedCriteriaContainer.get(0).scrollHeight > $advancedCriteriaContainer.outerHeight()) {
+            $advancedCriteriaContainer.addClass('scrollable');
+        }
+
+        criterion.rendered = true;
+    }
+
+    /**
+     * Renders the new criterion selecting the appropiate handlebars template and prepending to advanced criteria container.
+     * If criterion is of type list with a uri endpoint to request the options, select2 is also init
+     * @param {object} criterion - criterion to render
+     * @returns - the rendered container
+     */
+    function renderCriterion(criterion) {
+        let templateToUse = null;
+        if (criterion.type === criteriaTypes.text) {
+            templateToUse = textCriterionTpl;
+        } else if (criterion.type === criteriaTypes.list && criterion.uri) {
+            templateToUse = listSelectCriterionTpl;
+        } else {
+            templateToUse = listCheckboxCriterionTpl;
+        }
+
+        $advancedCriteriaContainer.append(templateToUse({ criterion }));
+
+        const $criterionContainer = $(`.${criterion.id}-filter`, $container);
+        const valueMapping = criteriaMapping[criterion.type];
+
+        /**
+         * On criterion of type list with a uri endpoint to retrieve options, template includes a select
+         * that is managed with select2, so we init it here
+         */
+        if (criterion.type === criteriaTypes.list && criterion.uri) {
+            $(`input[name=${criterion.id}-select]`, $criterionContainer).select2({
+                multiple: true,
+                ajax: {
+                    url: criterion.uri,
+                    dataType: 'json',
+                    data: function (term) {
+                        return {
+                            subject: term
+                        };
+                    },
+                    results: response => ({
+                        results: response.data.map(option => ({
+                            id: valueMapping === 'uri' ? option.uri : option.label,
+                            text: option.label
+                        }))
+                    })
+                },
+                initSelection: function (element, callback) {
+                    const data = [];
+                    $(element.val().split(',')).each(function () {
+                        data.push({ id: this, text: this });
+                    });
+                    callback(data);
+                }
+            });
+        }
+
+        return $criterionContainer;
+    }
+
+    /**
+     * Fetches initial criterion label from api in case the value mapping is uri
+     * @param {object} criterion - criterion to be managed
+     */
+    function getInitialCriterionLabel(criterion) {
+        const valueMapping = criteriaMapping[criterion.type];
+        if (valueMapping !== 'uri' || !criterion.value) {
+            return Promise.resolve({
+                id: criterion.value,
+                text: criterion.value
+            });
+        }
+        return $.ajax({
+            type: 'GET',
+            url: criterion.uri,
+            dataType: 'json'
+        }).then(({ data }) => {
+            if (Array.isArray(criterion.value)) {
+                return criterion.value.map(v => ({
+                    id: v,
+                    text: (data.find(d => d.uri === v) || {}).label
+                }));
+            }
+            let c = data.find(d => d.uri === criterion.value) || {};
+            return {
+                text: c.label,
+                id: criterion.value
+            };
+        });
+    }
+
+    /**
+     * Sets initial value for rendered criterion and sets binding between view and state
+     * @param {object} criterion - criterion to be managed
+     * @param {object} $criterionContainer - rendered criterion
+     */
+    function bindCriterionValue(criterion, $criterionContainer) {
+        getInitialCriterionLabel(criterion).then(initialCriterion => {
+            if (criterion.type === criteriaTypes.text) {
+                // set initial value
+                $('input', $criterionContainer).val(criterion.value);
+                // set event to bind input value to critariaState
+                $('input', $criterionContainer).on('change', function () {
+                    criterion.value = $(this).val() || null;
+                });
+            } else if (criterion.type === criteriaTypes.list && criterion.uri) {
+                // set initial value
+                if (criterion.value) {
+                    $(`input[name=${criterion.id}-select]`, $criterionContainer).select2('data', initialCriterion);
+                }
+                // set event to bind input value to critariaState
+                $(`input[name=${criterion.id}-select]`, $criterionContainer).on('change', event => {
+                    criterion.value = event.val;
+                });
+            } else {
+                // set initial value
+                if (criterion.value) {
+                    criterion.value.forEach(selectedValue => {
+                        $(`input[value=${selectedValue}]`, $criterionContainer).prop('checked', true);
+                    });
+                }
+                // set event to bind input value to critariaState
+                $('input[type="checkbox"]', $criterionContainer).on('change', function () {
+                    criterion.value = $(this)
+                        .closest('.filter-container')
+                        .find('input[type=checkbox]:checked')
+                        .get()
+                        .map(element => element.value);
+                });
+            }
+        });
+    }
+
+    /**
+     * Removes a criterion from advanced criteria container when user clicks on the criterion close icon.
+     * It also adds the option element to criteria select so removed criterion can be rendered again
+     * @param {object} event - click event triggered on closing icon
+     */
+    function removeCriterion(event) {
+        const criterion = event.data.criterion;
+        const newOption = createCriteriaOption(criterion);
+        const criterionKey = getCriterionStateId(criterion);
+
+        // remove criterion and append new criterion to select options
+        $(this).parent().remove();
+        $criteriaSelect.append(newOption);
+
+        // reset criterion values on criteriaState
+        criteriaState[criterionKey].rendered = false;
+        criteriaState[criterionKey].value = null;
+
+        // check if advanced criteria container is no longer scrollable
+        if ($advancedCriteriaContainer.get(0).scrollHeight <= $advancedCriteriaContainer.outerHeight()) {
+            $advancedCriteriaContainer.removeClass('scrollable');
+        }
+    }
+
+    /**
+     * Parses received criteria from BE to the data structure required for criteria selector. To do so,
+     * appends every criterion into criteria array and then returns a duplicate-free version of it
+     * considering label property as uniqueness criterion
+     * @param {Array} classes - array of classes with the metadata (aka criteria) for each one of them
+     * @returns {Array} - criteria array
+     */
+    function formatCriteria(classTree) {
+        let criteria = [];
+
+        _.forEach(classTree, classInstance => {
+            criteria.push(...classInstance.metadata);
+        });
+
+        // extends each criterion with an id that can be use as a valid css class
+        _.forEach(criteria, criterion => {
+            criterion.label = getCriterionLabel(criterion);
+            criterion.id = criterion.propertyUri.replace(/^[^a-zA-Z]*|[^a-zA-Z0-9]*/g, '');
+        });
+
+        return criteria;
+    }
+
+    /**
+     * Manages the new set of available criteria. To do so, removes warning container and every
+     * selectable criterion. Then removes from criteriaState and view every deprecated criterion,
+     * updates criteriaState with the new available criteria set, and renders new warning
+     * message if required
+     * @param {array} criteria - array of class properties
+     */
+    function updateCriteria(criteria) {
+        $('.invalid-criteria-warning-container').remove();
+        $criteriaSelect.find('option:not(:first-child)').remove();
+        const invalidCriteria = deleteDeprecatedCriteria(criteria);
+        extendCriteria(criteria);
+        renderWarningMessage(invalidCriteria);
+    }
+
+    /**
+     * If there is any invalid criterion, renders an explanatory warning message
+     * @param {array} invalidCriteria - array of string containing the label of every invalid criterion (those that were rendered but are no longer available)
+     */
+    function renderWarningMessage(invalidCriteria) {
+        if (invalidCriteria.length > 0) {
+            const invalidCriteriaWarning = invalidCriteriaWarningTpl({ invalidCriteria });
+            $advancedCriteriaContainer.prepend(invalidCriteriaWarning);
+            $('.invalid-criteria-warning-container .select2-search-choice-close', $advancedCriteriaContainer).on(
+                'click',
+                function () {
+                    $(this).parent().remove();
+                }
+            );
+        }
+    }
+
+    /**
+     * Loops through current criteriaState so every criterion that is no longer available in the new
+     * available criteria set is removed from criteriaState and from view, in case it had been
+     * rendered. In that case it is also pushed into invalidCriteria array to be latter
+     * included in the warning message
+     * @param {array} criteria - array containing new set of criteria for current class
+     * @returns {array} - array of strings with each deprecated criterion that was being displayed
+     */
+    function deleteDeprecatedCriteria(criteria) {
+        const invalidCriteria = [];
+
+        _.forEach(criteriaState, oldCriterion => {
+            const deprecatedCriterion = !criteria.find(newCriterion => newCriterion.label === oldCriterion.label);
+            const oldCriterionKey = getCriterionStateId(oldCriterion);
+
+            if (deprecatedCriterion) {
+                if (criteriaState[oldCriterionKey].rendered) {
+                    $advancedCriteriaContainer.find(`.${oldCriterion.id}-filter`).remove();
+                    invalidCriteria.push(oldCriterion.label);
+                }
+                delete criteriaState[oldCriterionKey];
+            }
+        });
+
+        return invalidCriteria;
+    }
+
+    /**
+     * Loops through new criteria set and checks if each new criterion was already present or not on criteriaState
+     * and updates view and selectable criteria list accordingly
+     * @param {array} criteria - array containing new set of criteria for current class
+     */
+    function extendCriteria(criteria) {
+        criteria.forEach(criterion => {
+            let createOption = true;
+            const criteriaStateId = getCriterionStateId(criterion);
+
+            // if new criterion was already on criteriaState and had to be rendered, we avoid creating an option for it and render it if it was not
+            if (criteriaState[criteriaStateId] && criteriaState[criteriaStateId].rendered === true) {
+                createOption = false;
+
+                if ($advancedCriteriaContainer.find(`.${criterion.id}-filter`).length === 0) {
+                    addNewCriterion(criteriaStateId);
+                }
+            } else {
+                // if new criterion was not on criteriaState we add it
+                criteriaState[criteriaStateId] = criterion;
+                criteriaState[criteriaStateId].rendered = false;
+                criteriaState[criteriaStateId].value = null;
+            }
+
+            // create new option element to criteria select
+            if (createOption) {
+                $criteriaSelect.append(createCriteriaOption(criterion));
+            }
+        });
+    }
+
+    /**
+     * Creates a new option element
+     * with attributes to use in select2 markup
+     * @param {Object} criterion
+     * @returns {HTMLOptionElement} Single option criteria
+     */
+    function createCriteriaOption(criterion) {
+        const label = criterion.label;
+        let classLabel = '';
+        let alias = '';
+        let option;
+
+        if (criterion.isDuplicated) {
+            classLabel = criterion.class.label || '';
+            alias = criterion.alias || '';
+        }
+
+        option = new Option(label, getCriterionStateId(criterion), false, false);
+
+        option.setAttribute('label', label);
+        option.setAttribute('alias', alias);
+        option.setAttribute('class-label', classLabel);
+
+        return option;
+    }
+
+    /**
+     * @param {Object} criterion
+     * @returns String
+     */
+    function getCriterionStateId(criterion) {
+        return criterion.propertyUri;
+    }
+
+    /**
+     * @param {Object} criterion
+     * @returns String
+     */
+    function getCriterionLabel(criterion) {
+        return criterion.label;
+    }
+
+    // return initialized instance of searchModal
+    return instance.init(config);
+}