@oat-sa/tao-core-ui 1.64.2 → 1.65.0

package/dist/searchModal.js

@@ -75,15 +75,15 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
     var buffer = "", stack1, helper, options, functionType="function", escapeExpression=this.escapeExpression, helperMissing=helpers.helperMissing;
 
 
-    buffer += "<div class=\"search-modal section-container\">\r\n    <div class=\"clear content-wrapper content-panel\">\r\n        <div class=\"ui-container\">\r\n            <div class=\"filters-container\">\r\n                <div class=\"basic-search-container\">\r\n                    <div class=\"filter-container\">\r\n                        <span class=\"icon-find\"></span>\r\n                        <input class=\"generic-search-input\" type=\"text\" placeholder=\"";
+    buffer += "<div class=\"search-modal section-container\">\n    <div class=\"clear content-wrapper content-panel\">\n        <div class=\"ui-container\">\n            <div class=\"filters-container\">\n                <div class=\"basic-search-container\">\n                    <div class=\"filter-container\">\n                        <span class=\"icon-find\"></span>\n                        <input class=\"generic-search-input\" type=\"text\" placeholder=\"";
     if (helper = helpers.placeholder) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.placeholder); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\">\r\n                    </div>\r\n                    <div class=\"filter-container class-filter-container\">\r\n                        <span class=\"icon-folder\"></span>\r\n                        <span class=\"icon-down\"></span>\r\n                        <textarea class=\"class-filter\" cols=\"40\" rows=\"1\" readonly></textarea>\r\n                        <div class=\"class-tree\"></div>\r\n                    </div>\r\n                </div>\r\n            </div>\r\n            <div class=\"buttons-container\">\r\n                <button class=\"btn-clear btn-transparent small\">"
+      + "\">\n                    </div>\n                    <div class=\"filter-container class-filter-container\">\n                        <span class=\"icon-folder\"></span>\n                        <span class=\"icon-down\"></span>\n                        <textarea class=\"class-filter\" cols=\"40\" rows=\"1\" readonly></textarea>\n                        <div class=\"class-tree\"></div>\n                    </div>\n                </div>\n            </div>\n            <div class=\"buttons-container\">\n                <button class=\"btn-clear btn-transparent small\">"
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Clear", options) : helperMissing.call(depth0, "__", "Clear", options)))
-      + "</button>\r\n                <button class=\"btn-search btn-info small\">"
+      + "</button>\n                <button class=\"btn-search btn-info small\">"
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Search", options) : helperMissing.call(depth0, "__", "Search", options)))
-      + "</button>\r\n            </div>\r\n        </div>\r\n        <div class=\"content-container\">\r\n            <div class=\"content-toolbar\"></div>\r\n            <div class=\"content-area\"></div>\r\n        </div>\r\n    </div>\r\n</div>";
+      + "</button>\n            </div>\n        </div>\n        <div class=\"content-container\">\n            <div class=\"content-toolbar\"></div>\n            <div class=\"content-area\"></div>\n        </div>\n    </div>\n</div>";
     return buffer;
     });
   function layoutTpl(data, options, asString) {
@@ -117,15 +117,15 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
     var buffer = "", stack1, helper, functionType="function", escapeExpression=this.escapeExpression;
 
 
-    buffer += "<div class='no-datatable-container'>\r\n    <span class=\"no-datatable-icon ";
+    buffer += "<div class='no-datatable-container'>\n    <span class=\"no-datatable-icon ";
     if (helper = helpers.icon) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.icon); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\"></span>\r\n    <p class=\"no-datatable-message\">";
+      + "\"></span>\n    <p class=\"no-datatable-message\">";
     if (helper = helpers.message) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.message); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "</p>\r\n</div>";
+      + "</p>\n</div>";
     return buffer;
     });
   function infoMessageTpl(data, options, asString) {
@@ -153,24 +153,24 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
     return (asString || true) ? html : $(html);
   }
 
-  /**
-   * Creates a searchModal instance
-   *
-   * @param {object} config
-   * @param {object} config.renderTo - DOM element where component will be rendered to
-   * @param {string} config.criterias - Search criteria to be set on component creation
-   * @param {boolean} config.searchOnInit - if init search must be triggered or not (stored results are used instead)
-   * @param {string} config.url - search endpoint to be set on datatable
-   * @param {string} config.rootClassUri - Uri for the root class of current context, required to init the class filter
-   * @param {bool} config.hideResourceSelector - if resourceSelector must be hidden
-   * @param {bool} config.hideCriteria - if the criteria must be hidden
-   * @param {string} config.placeholder - placeholder for input in template
-   * @param {string} config.classesUrl - the URL to the classes API (usually '/tao/RestResource/getAll')
-   * @param {string} config.classMappingUrl - the URL to the class mapping API (usually '/tao/ClassMetadata/getWithMapping')
-   * @param {string} config.statusUrl - the URL to the status API (usually '/tao/AdvancedSearch/status')
-   * @param {string} config.sortby - the default sorted column (usually 'label')
-   * @param {string} config.sortorder - the default sort order (usually 'asc')
-   * @returns {searchModal}
+  /**
+   * Creates a searchModal instance
+   *
+   * @param {object} config
+   * @param {object} config.renderTo - DOM element where component will be rendered to
+   * @param {string} config.criterias - Search criteria to be set on component creation
+   * @param {boolean} config.searchOnInit - if init search must be triggered or not (stored results are used instead)
+   * @param {string} config.url - search endpoint to be set on datatable
+   * @param {string} config.rootClassUri - Uri for the root class of current context, required to init the class filter
+   * @param {bool} config.hideResourceSelector - if resourceSelector must be hidden
+   * @param {bool} config.hideCriteria - if the criteria must be hidden
+   * @param {string} config.placeholder - placeholder for input in template
+   * @param {string} config.classesUrl - the URL to the classes API (usually '/tao/RestResource/getAll')
+   * @param {string} config.classMappingUrl - the URL to the class mapping API (usually '/tao/ClassMetadata/getWithMapping')
+   * @param {string} config.statusUrl - the URL to the status API (usually '/tao/AdvancedSearch/status')
+   * @param {string} config.sortby - the default sorted column (usually 'label')
+   * @param {string} config.sortorder - the default sort order (usually 'asc')
+   * @returns {searchModal}
    */
   function searchModalFactory(config) {
     // @TODO: The consumer must be responsible for supplying the routes. The component must not hardcode endpoints.
@@ -205,18 +205,18 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
 
     // Creates new component
     const instance = component({
-      /**
-       * Tells if the advanced search is enabled.
-       * @returns {boolean}
+      /**
+       * Tells if the advanced search is enabled.
+       * @returns {boolean}
        */
       isAdvancedSearchEnabled() {
         return advancedSearch && advancedSearch.isEnabled();
       }
     }, defaults).setTemplate(layoutTpl).on('selected-store-updated', recreateDatatable).on('render', renderModal).on('destroy', destroyModal);
 
-    /**
-     * Creates search modal, inits template selectors, inits search store, and once is created triggers initial search
-     * rootClassUri is sent to advancedSearch factory for disabling in whitelisted sections
+    /**
+     * Creates search modal, inits template selectors, inits search store, and once is created triggers initial search
+     * rootClassUri is sent to advancedSearch factory for disabling in whitelisted sections
      */
     function renderModal() {
       const promises = [];
@@ -237,8 +237,8 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       }).catch(e => instance.trigger('error', e));
     }
 
-    /**
-     * Removes search modal
+    /**
+     * Removes search modal
      */
     function destroyModal() {
       $container.removeClass('modal').modal('destroy');
@@ -249,8 +249,8 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       controls = {};
     }
 
-    /**
-     * Creates search modal
+    /**
+     * Creates search modal
      */
     function initModal() {
       $container = instance.getElement();
@@ -261,8 +261,8 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       }).focus();
     }
 
-    /**
-     * Inits class filter selector
+    /**
+     * Inits class filter selector
      */
     function initClassFilter() {
       return new Promise(resolve => {
@@ -294,9 +294,9 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
           }).catch(e => instance.trigger('error', e));
         });
 
-        /*
-         * the first time selector opions are updated the root class is selected. Promise is
-         * resolved so init process continues only when class input value has been set
+        /*
+         * the first time selector opions are updated the root class is selected. Promise is
+         * resolved so init process continues only when class input value has been set
          */
         resourceSelector.on('update', () => {
           resourceSelector.off('update');
@@ -306,10 +306,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
 
         // then new class is selected, set its label into class filter input and hide filter container, then request class properties
         resourceSelector.on('change', selectedValue => {
-          /*
-           * on searchModal init we set manually the selector to the provided config.rootClassUri. When a selector
-           * is set manually Selector component execs @clearSelection which triggers a change event
-           * with an empty object as param. We catch this undesired behaviour here
+          /*
+           * on searchModal init we set manually the selector to the provided config.rootClassUri. When a selector
+           * is set manually Selector component execs @clearSelection which triggers a change event
+           * with an empty object as param. We catch this undesired behaviour here
            */
           if (_.isEmpty(selectedValue)) {
             return;
@@ -330,10 +330,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     }
 
-    /**
-     * Loops through each class in received class tree and sets access mode to 'denied' on private classes
-     * so are disabled on class tree
-     * @param {object} classTree - class tree received by server, containing resources (classes) and permissions
+    /**
+     * Loops through each class in received class tree and sets access mode to 'denied' on private classes
+     * so are disabled on class tree
+     * @param {object} classTree - class tree received by server, containing resources (classes) and permissions
      */
     function manageClassTreePermissions(classTree) {
       const disableBlockedClasses = function (resources) {
@@ -350,9 +350,9 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       disableBlockedClasses(classTree.resources);
     }
 
-    /**
-     * Inits template selectors, buttons behaviour, scroll animation,
-     * and sets initial search query on search input
+    /**
+     * Inits template selectors, buttons behaviour, scroll animation,
+     * and sets initial search query on search input
      */
     function initUiSelectors() {
       controls = {
@@ -373,17 +373,17 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       controls.$searchInput.val(instance.config.criterias && instance.config.criterias.search ? instance.config.criterias.search : '');
     }
 
-    /**
-     * Sets required listeners to properly manage resourceSelector visualization
+    /**
+     * Sets required listeners to properly manage resourceSelector visualization
      */
     function setResourceSelectorUIBehaviour() {
       $container.on('mousedown', () => {
         controls.$classTreeContainer.hide();
       });
 
-      /**
-       * Pressing space, enter, esc, backspace
-       * on class filter input will toggle resource selector
+      /**
+       * Pressing space, enter, esc, backspace
+       * on class filter input will toggle resource selector
        */
       const shortcuts = shortcutRegistry(controls.$classFilterInput);
       shortcuts.add('enter', () => controls.$classTreeContainer.show());
@@ -393,17 +393,17 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
         propagate: false
       });
 
-      /**
-       * clicking on class filter container will toggle resource selector
+      /**
+       * clicking on class filter container will toggle resource selector
        */
       controls.$classFilterContainer.on('click', () => {
         controls.$classTreeContainer.toggle();
       });
 
-      /**
-       * clicking on class filter container will
-       * stopPropagation to prevent be closed
-       * by searchModal.mouseDown listener
+      /**
+       * clicking on class filter container will
+       * stopPropagation to prevent be closed
+       * by searchModal.mouseDown listener
        */
       controls.$classFilterContainer.on('mousedown', e => {
         e.stopPropagation();
@@ -415,20 +415,20 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     }
 
-    /**
-     * Loads search store so it is accessible in the component
-     * @returns {Promise}
+    /**
+     * Loads search store so it is accessible in the component
+     * @returns {Promise}
      */
     function initStores() {
       return Promise.all([store('search').then(updatedStore => searchStore = updatedStore), store('selectedColumns').then(updatedStore => selectedColumnsStore = updatedStore)]).catch(e => instance.trigger('error', e));
     }
 
-    /**
-     * Performs a search query
-     * @param query - The searched terms
-     * @param classFilterUri - The URI of the node class
-     * @param [params] - Additional parameters
-     * @returns {Promise}
+    /**
+     * Performs a search query
+     * @param query - The searched terms
+     * @param classFilterUri - The URI of the node class
+     * @param [params] - Additional parameters
+     * @returns {Promise}
      */
     const searchQuery = function (query, classFilterUri) {
       let params = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -446,11 +446,11 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     };
 
-    /**
-     * Performs the search query, preventing to send too many requests
-     * @param query - The searched terms
-     * @param classFilterUri - The URI of the node class
-     * @param [params] - Additional parameters
+    /**
+     * Performs the search query, preventing to send too many requests
+     * @param query - The searched terms
+     * @param classFilterUri - The URI of the node class
+     * @param [params] - Additional parameters
      */
     const searchHandler = function (query, classFilterUri) {
       let params = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -460,22 +460,22 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       }
     };
 
-    /**
-     * Request search results and manages its results
+    /**
+     * Request search results and manages its results
      */
     function search() {
       searchHandler(buildComplexQuery(), getClassFilterUri());
     }
 
-    /**
-     * Returns selected class filter of rootClassUri
+    /**
+     * Returns selected class filter of rootClassUri
      */
     function getClassFilterUri() {
       return isResourceSelector ? controls.$classFilterInput.data('uri').trim() : rootClassUri;
     }
 
-    /**
-     * build final complex query appending every filter
+    /**
+     * build final complex query appending every filter
      */
     function buildComplexQuery() {
       let query = controls.$searchInput.val().trim();
@@ -483,10 +483,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       return query;
     }
 
-    /*
-     * If search on init is not required, extends data with stored dataset
-     * @param {object} data - search configuration including model and endpoint for datatable
-     * @returns {Promise}
+    /*
+     * If search on init is not required, extends data with stored dataset
+     * @param {object} data - search configuration including model and endpoint for datatable
+     * @returns {Promise}
      */
     function appendDefaultDatasetToDatatable(data) {
       return new Promise(function (resolve, reject) {
@@ -508,10 +508,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     }
 
-    /**
-     * Replaces empty value by a placeholder.
-     * @param value
-     * @returns {string|*}
+    /**
+     * Replaces empty value by a placeholder.
+     * @param value
+     * @returns {string|*}
      */
     const emptyValueTransform = value => {
       let testedValue = value;
@@ -524,10 +524,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       return testedValue === '' || testedValue === null || typeof testedValue === 'undefined' ? '-' : value;
     };
 
-    /**
-     * Refines the columns to be compatible with the datatable model
-     * @param {object[]} columns
-     * @returns {object[]}
+    /**
+     * Refines the columns to be compatible with the datatable model
+     * @param {object[]} columns
+     * @returns {object[]}
      */
     function columnsToModel(columns) {
       if (!Array.isArray(columns)) {
@@ -561,10 +561,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     }
 
-    /**
-     * Refines the data model for the datatable
-     * @param {object} data - search configuration including model and endpoint for datatable
-     * @returns {object} The data configuration refined with the data model for the datatrable
+    /**
+     * Refines the data model for the datatable
+     * @param {object} data - search configuration including model and endpoint for datatable
+     * @returns {object} The data configuration refined with the data model for the datatrable
      */
     function buildDataModel(data) {
       //save availableColumns to memory
@@ -607,10 +607,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       return data;
     }
 
-    /**
-     * Filters datatble model based on stored selected columns
-     * @param {Object} data data containing available columns and model for datatable
-     * @returns {Promise} promise which resolves with filtered data.model
+    /**
+     * Filters datatble model based on stored selected columns
+     * @param {Object} data data containing available columns and model for datatable
+     * @returns {Promise} promise which resolves with filtered data.model
      */
     function filterSelectedColumns(data) {
       return selectedColumnsStore.getItem(rootClassUri).then(storedSelectedColumnIds => {
@@ -637,9 +637,9 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     }
 
-    /**
-     * Creates a datatable with search results
-     * @param {object} data - search configuration including model and endpoint for datatable
+    /**
+     * Creates a datatable with search results
+     * @param {object} data - search configuration including model and endpoint for datatable
      */
     function buildSearchResultsDatatable(data) {
       // Note: the table container needs to be recreated because datatable is storing data in it.
@@ -685,9 +685,9 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       return _.cloneDeep($tableContainer.data('ui.datatable') || {});
     }
 
-    /**
-     * Filters data from cache by selected and recreates datatable
-     * @params {object} options - Additional options to be given to the datatable
+    /**
+     * Filters data from cache by selected and recreates datatable
+     * @params {object} options - Additional options to be given to the datatable
      */
     function recreateDatatable() {
       let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
@@ -695,10 +695,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       filterSelectedColumns(data).then(buildSearchResultsDatatable);
     }
 
-    /**
-     * Triggered on load.datatable event, it updates searchStore and manages possible exceptions
-     * @param {object} e - load.datatable event
-     * @param {object} dataset - datatable dataset
+    /**
+     * Triggered on load.datatable event, it updates searchStore and manages possible exceptions
+     * @param {object} e - load.datatable event
+     * @param {object} dataset - datatable dataset
      */
     function searchResultsLoaded(e, dataset) {
       const $contentToolbar = controls.$contentToolbar.empty();
@@ -731,8 +731,8 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     }
 
-    /**
-     * Handler for manage columns button click
+    /**
+     * Handler for manage columns button click
      */
     function handleManageColumnsBtnClick() {
       const selected = selectedColumns;
@@ -784,11 +784,11 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       }
     }
 
-    /**
-     * Updates searchStore. If action is 'clear', searchStore is claread. If not, received
-     * data is assigned to searchStore. Once all actions have been done,
-     * store-updated event is triggered
-     * @param {object} data - data to store
+    /**
+     * Updates searchStore. If action is 'clear', searchStore is claread. If not, received
+     * data is assigned to searchStore. Once all actions have been done,
+     * store-updated event is triggered
+     * @param {object} data - data to store
      */
     function updateSearchStore(data) {
       const promises = [];
@@ -803,14 +803,14 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       Promise.all(promises).then(() => instance.trigger('store-updated')).catch(e => instance.trigger('error', e));
     }
 
-    /**
-     *
-     * @param {object} update - The changed configuration
-     * @param {Array<string>} update.selection - array of column ids to display
-     * @param {string} update.sortby - The sorted column
-     * @param {string} update.sortorder - The sort order
-     * @param {number} update.page - The current page
-     * @returns
+    /**
+     *
+     * @param {object} update - The changed configuration
+     * @param {Array<string>} update.selection - array of column ids to display
+     * @param {string} update.sortby - The sorted column
+     * @param {string} update.sortorder - The sort order
+     * @param {number} update.page - The current page
+     * @returns
      */
     function updateSelectedStore() {
       let {
@@ -829,10 +829,10 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       })).catch(e => instance.trigger('error', e));
     }
 
-    /**
-     * Clear search input, criteria and results from both, view and store.
-     * Also sets every criterion on criteriaState to unredered and
-     * undefined value
+    /**
+     * Clear search input, criteria and results from both, view and store.
+     * Also sets every criterion on criteriaState to unredered and
+     * undefined value
      */
     function clear() {
       controls.$searchInput.val('');
@@ -844,9 +844,9 @@ define(['jquery', 'lodash', 'i18n', 'context', 'handlebars', 'lib/handlebars/hel
       });
     }
 
-    /**
-     * Removes datatable container and displays a message instead
-     * @param {string} reason - reason why datatable is not rendered, to display appropiate message
+    /**
+     * Removes datatable container and displays a message instead
+     * @param {string} reason - reason why datatable is not rendered, to display appropiate message
      */
     function replaceSearchResultsDatatableWithMessage(reason) {
       let message = '';

package/dist/selecter.js

@@ -2,12 +2,12 @@ define(['jquery', 'select2'], function ($, select2) { 'use strict';
 
     $ = $ && Object.prototype.hasOwnProperty.call($, 'default') ? $['default'] : $;
 
-    /**
-     * Look up for element in the container that will be used as select2 widgets
-     *
-     * @public
-     * @example define(['ui/selecter'], function(selecter){ selecter($('rootContainer')); });
-     * @param {jQueryElement} $container - the root context to lookup inside
+    /**
+     * Look up for element in the container that will be used as select2 widgets
+     *
+     * @public
+     * @example define(['ui/selecter'], function(selecter){ selecter($('rootContainer')); });
+     * @param {jQueryElement} $container - the root context to lookup inside
      */
     function lookupSelecter($container) {
       $('select.select2', $container).each(function () {