@revolist/revogrid 4.9.12 → 4.9.16

package/dist/cjs/{column.drag.plugin-e636b5af.js → column.drag.plugin-a5cc161a.js}

@@ -4,12 +4,12 @@
 'use strict';
 
 const index = require('./index-28b6fdfb.js');
+const column_service = require('./column.service-d45dbb3f.js');
 const rowHeaderUtils = require('./row-header-utils-22ffee54.js');
 const debounce = require('./debounce-cb5f4e35.js');
 const index$1 = require('./index-10d10c55.js');
-const column_service = require('./column.service-15c8352d.js');
 const filter_button = require('./filter.button-afb16244.js');
-const headerCellRenderer = require('./header-cell-renderer-375a879f.js');
+const headerCellRenderer = require('./header-cell-renderer-28f7f21d.js');
 
 /**
  * Storing pre-calculated
@@ -215,125 +215,6 @@ class BasePlugin {
     }
 }
 
-function getColumnType(rgCol) {
-    if (rgCol.pin) {
-        return rgCol.pin;
-    }
-    return 'rgCol';
-}
-function getColumnSizes(cols) {
-    const res = {};
-    for (const [i, c] of cols.entries()) {
-        if (c.size) {
-            res[i] = c.size;
-        }
-    }
-    return res;
-}
-/**
- * Check if column is grouping column
- */
-function isColGrouping(colData) {
-    return !!colData.children;
-}
-/**
- * This function is used to create a collection of columns.
- */
-function getColumns(columns, level = 0, types) {
-    const collection = {
-        // columns as they are in stores per type
-        columns: {
-            rgCol: [],
-            colPinStart: [],
-            colPinEnd: [],
-        },
-        // columns indexed by prop for quick access
-        columnByProp: {},
-        // column grouping
-        columnGrouping: {
-            rgCol: [],
-            colPinStart: [],
-            colPinEnd: [],
-        },
-        // max depth level for column grouping
-        maxLevel: level,
-        // sorting
-        sort: {},
-    };
-    return index.reduce_1(columns, (res, colData) => {
-        // Grouped column
-        if (isColGrouping(colData)) {
-            return gatherGroup(res, colData, getColumns(colData.children, level + 1, types), level);
-        }
-        // Regular column
-        const regularColumn = Object.assign(Object.assign({}, (colData.columnType && types && types[colData.columnType])), colData);
-        // Regular column, no Pin
-        if (!regularColumn.pin) {
-            res.columns.rgCol.push(regularColumn);
-            // Pin
-        }
-        else {
-            res.columns[regularColumn.pin].push(regularColumn);
-        }
-        if (regularColumn.order) {
-            res.sort[regularColumn.prop] = regularColumn;
-        }
-        // it's possible that some columns have same prop, but better to avoid it
-        if (!res.columnByProp[regularColumn.prop]) {
-            res.columnByProp[regularColumn.prop] = [];
-        }
-        res.columnByProp[regularColumn.prop].push(regularColumn);
-        // trigger setup hook if present
-        regularColumn.beforeSetup && regularColumn.beforeSetup(regularColumn);
-        return res;
-    }, collection);
-}
-function gatherGroup(res, colData, collection, level = 0) {
-    // group template
-    const group = Object.assign(Object.assign({}, colData), { level, ids: [] });
-    // check columns for update
-    for (let k in collection.columns) {
-        const key = k;
-        const resultItem = res.columns[key];
-        const collectionItem = collection.columns[key];
-        // if column data
-        if (index.isArray_1(resultItem) && index.isArray_1(collectionItem)) {
-            // fill columns
-            resultItem.push(...collectionItem);
-            // fill grouping
-            if (collectionItem.length) {
-                res.columnGrouping[key].push(Object.assign(Object.assign({}, group), { ids: collectionItem.map(item => item.prop) }));
-            }
-        }
-    }
-    // merge column groupings
-    for (let k in collection.columnGrouping) {
-        const key = k;
-        const collectionItem = collection.columnGrouping[key];
-        res.columnGrouping[key].push(...collectionItem);
-    }
-    res.maxLevel = Math.max(res.maxLevel, collection.maxLevel);
-    res.sort = Object.assign(Object.assign({}, res.sort), collection.sort);
-    return res;
-}
-function findColumn(columns, prop) {
-    for (const c of columns) {
-        if (isColGrouping(c)) {
-            const found = findColumn(c.children, prop);
-            if (found) {
-                return found;
-            }
-        }
-        else if (c.prop === prop) {
-            return c;
-        }
-    }
-    return undefined;
-}
-function getColumnByProp(columns, prop) {
-    return findColumn(columns, prop);
-}
-
 /**
  * Plugin module for revo-grid grid system
  * Add support for automatic column resize
@@ -376,7 +257,7 @@ class AutoSizeColumnPlugin extends BasePlugin {
             this.columnSet(columns);
         };
         const headerDblClick = ({ detail }) => {
-            const type = getColumnType(detail.column);
+            const type = column_service.getColumnType(detail.column);
             const size = this.getColumnSize(detail.index, type);
             if (size) {
                 this.providers.dimension.setCustomSizes(type, {
@@ -1112,23 +993,7 @@ const notContains = (value, extra) => {
 notContains.extra = 'input';
 contains.extra = 'input';
 
-const filterNames = {
-    none: 'None',
-    empty: 'Not set',
-    notEmpty: 'Set',
-    eq: 'Equal',
-    notEq: 'Not equal',
-    begins: 'Begins with',
-    contains: 'Contains',
-    notContains: 'Does not contain',
-    eqN: '=',
-    neqN: '!=',
-    gt: '>',
-    gte: '>=',
-    lt: '<',
-    lte: '<=',
-};
-const filterEntities = {
+const filterCoreFunctionsIndexedByType = {
     none: () => true,
     empty: notSet,
     notEmpty: set,
@@ -1148,7 +1013,37 @@ const filterTypes = {
     string: ['notEmpty', 'empty', 'eq', 'notEq', 'begins', 'contains', 'notContains'],
     number: ['notEmpty', 'empty', 'eqN', 'neqN', 'gt', 'gte', 'lt', 'lte'],
 };
+const filterNames = {
+    none: 'None',
+    empty: 'Not set',
+    notEmpty: 'Set',
+    eq: 'Equal',
+    notEq: 'Not equal',
+    begins: 'Begins with',
+    contains: 'Contains',
+    notContains: 'Does not contain',
+    eqN: '=',
+    neqN: '!=',
+    gt: '>',
+    gte: '>=',
+    lt: '<',
+    lte: '<=',
+};
 
+/**
+ * @typedef ColumnFilterConfig
+ * @type {object}
+ * @property {FilterCollection|undefined} collection - preserved filter data
+ * @property {string[]|undefined} include - filters to be included, if defined everything else out of scope will be ignored
+ * @property {Record<string, CustomFilter>|undefined} customFilters - hash map of {FilterType:CustomFilter}.
+ * @property {FilterLocalization|undefined} localization - translation for filter popup captions.
+ * @property {MultiFilterItem|undefined} multiFilterItems - data for multi filtering.
+ * @property {boolean|undefined} disableDynamicFiltering - disables dynamic filtering.
+ * A way to define your own filter types per column
+ */
+/**
+ * @internal
+ */
 const FILTER_TRIMMED_TYPE = 'filter';
 const FILTER_CONFIG_CHANGED_EVENT = 'filterconfigchanged';
 class FilterPlugin extends BasePlugin {
@@ -1158,14 +1053,13 @@ class FilterPlugin extends BasePlugin {
         this.revogrid = revogrid;
         this.filterCollection = {};
         this.multiFilterItems = {};
-        this.possibleFilters = Object.assign({}, filterTypes);
-        this.possibleFilterNames = Object.assign({}, filterNames);
-        this.possibleFilterEntities = Object.assign({}, filterEntities);
+        this.filterByType = Object.assign({}, filterTypes);
+        this.filterNameIndexByType = Object.assign({}, filterNames);
+        this.filterFunctionsIndexedByType = Object.assign({}, filterCoreFunctionsIndexedByType);
         this.filterProp = filter_button.FILTER_PROP;
         if (config) {
             this.initConfig(config);
         }
-        const headerclick = (e) => this.headerclick(e);
         const aftersourceset = async () => {
             const filterCollectionProps = Object.keys(this.filterCollection);
             if (filterCollectionProps.length > 0) {
@@ -1185,7 +1079,7 @@ class FilterPlugin extends BasePlugin {
             }
             await this.runFiltering();
         };
-        this.addEventListener('headerclick', headerclick);
+        this.addEventListener('headerclick', (e) => this.headerclick(e));
         this.addEventListener(FILTER_CONFIG_CHANGED_EVENT, ({ detail }) => {
             if (!detail) {
                 this.clearFiltering();
@@ -1198,27 +1092,29 @@ class FilterPlugin extends BasePlugin {
         });
         this.addEventListener('aftersourceset', aftersourceset);
         this.addEventListener('filter', ({ detail }) => this.onFilterChange(detail));
-        const existingNodes = this.revogrid.registerVNode.filter((n) => n.$tag$ !== 'revogr-filter-panel');
+        const existingNodes = this.revogrid.registerVNode.filter(n => n.$tag$ !== 'revogr-filter-panel');
         this.revogrid.registerVNode = [
             ...existingNodes,
-            index$1.h("revogr-filter-panel", { filterItems: this.multiFilterItems, filterNames: this.possibleFilterNames, filterEntities: this.possibleFilterEntities, filterCaptions: (_a = config === null || config === void 0 ? void 0 : config.localization) === null || _a === void 0 ? void 0 : _a.captions, onFilterChange: e => this.onFilterChange(e.detail), disableDynamicFiltering: config === null || config === void 0 ? void 0 : config.disableDynamicFiltering, ref: e => (this.pop = e) }),
+            index$1.h("revogr-filter-panel", { filterItems: this.multiFilterItems, filterNames: this.filterNameIndexByType, filterEntities: this.filterFunctionsIndexedByType, filterCaptions: (_a = config === null || config === void 0 ? void 0 : config.localization) === null || _a === void 0 ? void 0 : _a.captions, onFilterChange: e => this.onFilterChange(e.detail), disableDynamicFiltering: config === null || config === void 0 ? void 0 : config.disableDynamicFiltering, ref: e => (this.pop = e) }),
         ];
     }
     initConfig(config) {
         if (config.multiFilterItems) {
             this.multiFilterItems = Object.assign({}, config.multiFilterItems);
         }
+        // Add custom filters
         if (config.customFilters) {
-            for (let cType in config.customFilters) {
-                const cFilter = config.customFilters[cType];
-                if (!this.possibleFilters[cFilter.columnFilterType]) {
-                    this.possibleFilters[cFilter.columnFilterType] = [];
+            for (let customFilterType in config.customFilters) {
+                const cFilter = config.customFilters[customFilterType];
+                if (!this.filterByType[cFilter.columnFilterType]) {
+                    this.filterByType[cFilter.columnFilterType] = [];
                 }
-                this.possibleFilters[cFilter.columnFilterType].push(cType);
-                this.possibleFilterEntities[cType] = cFilter.func;
-                this.possibleFilterNames[cType] = cFilter.name;
+                this.filterByType[cFilter.columnFilterType].push(customFilterType);
+                this.filterFunctionsIndexedByType[customFilterType] = cFilter.func;
+                this.filterNameIndexByType[customFilterType] = cFilter.name;
             }
         }
+        // Add filterProp if provided in config
         if (config.filterProp) {
             this.filterProp = config.filterProp;
         }
@@ -1229,21 +1125,21 @@ class FilterPlugin extends BasePlugin {
         const cfgInlcude = config.include;
         if (cfgInlcude) {
             const filters = {};
-            for (let t in this.possibleFilters) {
+            for (let t in this.filterByType) {
                 // validate filters, if appropriate function present
-                const newTypes = this.possibleFilters[t].filter(f => cfgInlcude.indexOf(f) > -1);
+                const newTypes = this.filterByType[t].filter(f => cfgInlcude.indexOf(f) > -1);
                 if (newTypes.length) {
                     filters[t] = newTypes;
                 }
             }
             // if any valid filters provided show them
             if (Object.keys(filters).length > 0) {
-                this.possibleFilters = filters;
+                this.filterByType = filters;
             }
         }
         if (config.collection) {
             this.filterCollection = index.reduce_1(config.collection, (result, item, prop) => {
-                if (this.possibleFilterEntities[item.type]) {
+                if (this.filterFunctionsIndexedByType[item.type]) {
                     result[prop] = item;
                 }
                 else {
@@ -1255,8 +1151,8 @@ class FilterPlugin extends BasePlugin {
         if (config.localization) {
             if (config.localization.filterNames) {
                 Object.entries(config.localization.filterNames).forEach(([k, v]) => {
-                    if (this.possibleFilterNames[k] != void 0) {
-                        this.possibleFilterNames[k] = v;
+                    if (this.filterNameIndexByType[k] != void 0) {
+                        this.filterNameIndexByType[k] = v;
                     }
                 });
             }
@@ -1282,13 +1178,12 @@ class FilterPlugin extends BasePlugin {
         const gridPos = this.revogrid.getBoundingClientRect();
         const buttonPos = el.getBoundingClientRect();
         const prop = e.detail.prop;
-        this.pop.filterTypes = this.getColumnFilter(e.detail.filter);
-        this.pop.show(Object.assign(Object.assign({}, this.filterCollection[prop]), { x: buttonPos.x - gridPos.x, y: buttonPos.y - gridPos.y + buttonPos.height, autoCorrect: true, prop }));
+        this.pop.show(Object.assign(Object.assign({}, this.filterCollection[prop]), { x: buttonPos.x - gridPos.x, y: buttonPos.y - gridPos.y + buttonPos.height, autoCorrect: true, prop, filterTypes: this.getColumnFilter(e.detail.filter) }));
     }
     getColumnFilter(type) {
         let filterType = 'string';
         if (!type) {
-            return { [filterType]: this.possibleFilters[filterType] };
+            return { [filterType]: this.filterByType[filterType] };
         }
         // if custom column filter
         if (this.isValidType(type)) {
@@ -1298,44 +1193,59 @@ class FilterPlugin extends BasePlugin {
         else if (typeof type === 'object' && type.length) {
             return type.reduce((r, multiType) => {
                 if (this.isValidType(multiType)) {
-                    r[multiType] = this.possibleFilters[multiType];
+                    r[multiType] = this.filterByType[multiType];
                 }
                 return r;
             }, {});
         }
-        return { [filterType]: this.possibleFilters[filterType] };
+        return { [filterType]: this.filterByType[filterType] };
     }
     isValidType(type) {
-        return !!(typeof type === 'string' && this.possibleFilters[type]);
+        return !!(typeof type === 'string' && this.filterByType[type]);
     }
-    // called on internal component change
+    /**
+     * Called on internal component change
+     */
     async onFilterChange(filterItems) {
+        // store the filter items
         this.multiFilterItems = filterItems;
+        // run the filtering when the items change
         this.runFiltering();
     }
     /**
      * Triggers grid filtering
      */
-    async doFiltering(collection, items, columns, filterItems) {
+    async doFiltering(collection, source, columns, filterItems) {
         const columnsToUpdate = [];
+        /**
+         * Loop through the columns and update the columns that need to be updated with the `hasFilter` property.
+         */
+        const columnByProp = {};
         columns.forEach(rgCol => {
             const column = Object.assign({}, rgCol);
             const hasFilter = filterItems[column.prop];
+            columnByProp[column.prop] = column;
+            /**
+             * If the column has a filter and it's not already marked as filtered, update the column.
+             */
             if (column[this.filterProp] && !hasFilter) {
                 delete column[this.filterProp];
                 columnsToUpdate.push(column);
             }
+            /**
+             * If the column does not have a filter and it's marked as filtered, update the column.
+             */
             if (!column[this.filterProp] && hasFilter) {
                 columnsToUpdate.push(column);
                 column[this.filterProp] = true;
             }
         });
-        const itemsToFilter = this.getRowFilter(items, filterItems);
+        const itemsToTrim = this.getRowFilter(source, filterItems, columnByProp);
         // check is filter event prevented
         const { defaultPrevented, detail } = this.emit('beforefiltertrimmed', {
             collection,
-            itemsToFilter,
-            source: items,
+            itemsToFilter: itemsToTrim,
+            source,
             filterItems,
         });
         if (defaultPrevented) {
@@ -1347,7 +1257,7 @@ class FilterPlugin extends BasePlugin {
             return;
         }
         // applies the hasFilter to the columns to show filter icon
-        await this.revogrid.updateColumns(columnsToUpdate);
+        this.providers.column.updateColumns(columnsToUpdate);
         this.emit('afterfilterapply');
     }
     async clearFiltering() {
@@ -1363,7 +1273,7 @@ class FilterPlugin extends BasePlugin {
             if (this.multiFilterItems[prop].length > 0) {
                 const firstFilterItem = this.multiFilterItems[prop][0];
                 collection[prop] = {
-                    filter: filterEntities[firstFilterItem.type],
+                    filter: this.filterFunctionsIndexedByType[firstFilterItem.type],
                     type: firstFilterItem.type,
                     value: firstFilterItem.value,
                 };
@@ -1388,52 +1298,68 @@ class FilterPlugin extends BasePlugin {
             columns: await this.revogrid.getColumns(),
         };
     }
-    getRowFilter(rows, filterItems) {
+    /**
+     * Get trimmed rows based on filter
+     */
+    getRowFilter(rows, filterItems, columnByProp) {
         const propKeys = Object.keys(filterItems);
         const trimmed = {};
         let propFilterSatisfiedCount = 0;
         let lastFilterResults = [];
         // each rows
         rows.forEach((model, rowIndex) => {
-            // working on all props
+            // check filter by column properties
             for (const prop of propKeys) {
                 const propFilters = filterItems[prop];
+                // reset the count of satisfied filters
                 propFilterSatisfiedCount = 0;
+                // reset the array of last filter results
                 lastFilterResults = [];
                 // testing each filter for a prop
                 for (const [filterIndex, filterData] of propFilters.entries()) {
                     // the filter LogicFunction based on the type
-                    const filter = this.possibleFilterEntities[filterData.type];
+                    const filterFunc = this.filterFunctionsIndexedByType[filterData.type];
                     // THE MAGIC OF FILTERING IS HERE
+                    const column = columnByProp[prop];
+                    // If there is no column but user wants to filter by a property
+                    const value = column ? column_service.getCellDataParsed(model, columnByProp[prop]) : model[prop];
+                    // OR relation
                     if (filterData.relation === 'or') {
+                        // reset the array of last filter results
                         lastFilterResults = [];
-                        if (filter(model[prop], filterData.value)) {
+                        // if the filter is satisfied, continue to the next filter
+                        if (filterFunc(value, filterData.value)) {
                             continue;
                         }
+                        // if the filter is not satisfied, count it
                         propFilterSatisfiedCount++;
+                        // AND relation
                     }
                     else {
                         // 'and' relation will need to know the next filter
                         // so we save this current filter to include it in the next filter
-                        lastFilterResults.push(!filter(model[prop], filterData.value));
+                        lastFilterResults.push(!filterFunc(value, filterData.value));
                         // check first if we have a filter on the next index to pair it with this current filter
                         const nextFilterData = propFilters[filterIndex + 1];
                         // stop the sequence if there is no next filter or if the next filter is not an 'and' relation
                         if (!nextFilterData || nextFilterData.relation !== 'and') {
                             // let's just continue since for sure propFilterSatisfiedCount cannot be satisfied
                             if (lastFilterResults.indexOf(true) === -1) {
+                                // reset the array of last filter results
                                 lastFilterResults = [];
                                 continue;
                             }
                             // we need to add all of the lastFilterResults since we need to satisfy all
                             propFilterSatisfiedCount += lastFilterResults.length;
+                            // reset the array of last filter results
                             lastFilterResults = [];
                         }
                     }
                 } // end of propFilters forEach
                 // add to the list of removed/trimmed rows of filter condition is satisfied
-                if (propFilterSatisfiedCount === propFilters.length)
+                if (propFilterSatisfiedCount === propFilters.length) {
                     trimmed[rowIndex] = true;
+                }
             } // end of for-of propKeys
         });
         return trimmed;
@@ -1561,7 +1487,7 @@ class ColumnPlugin extends BasePlugin {
             return;
         }
         // no grouping drag and no row header column drag
-        if (isColGrouping(data) || data.providers.type === 'rowHeaders') {
+        if (column_service.isColGrouping(data) || data.providers.type === 'rowHeaders') {
             return;
         }
         const cols = this.getDimension(data.pin || 'rgCol');
@@ -1672,15 +1598,9 @@ exports.FILTER_TRIMMED_TYPE = FILTER_TRIMMED_TYPE;
 exports.FilterPlugin = FilterPlugin;
 exports.StretchColumn = StretchColumn;
 exports.columnTypes = columnTypes;
-exports.gatherGroup = gatherGroup;
-exports.getColumnByProp = getColumnByProp;
-exports.getColumnSizes = getColumnSizes;
-exports.getColumnType = getColumnType;
-exports.getColumns = getColumns;
 exports.getLeftRelative = getLeftRelative;
-exports.isColGrouping = isColGrouping;
 exports.isRowType = isRowType;
 exports.isStretchPlugin = isStretchPlugin;
 exports.rowTypes = rowTypes;
 
-//# sourceMappingURL=column.drag.plugin-e636b5af.js.map
+//# sourceMappingURL=column.drag.plugin-a5cc161a.js.map