dtable-utils 0.0.3-beta.1 → 0.0.4-beta.1

package/es/sort/sort-column/number.js

@@ -1,15 +1,22 @@
 import { SORT_TYPE } from '../../constants/sort.js';
 
-var sortNumber = function sortNumber(currNum, nextNum, sortType) {
-  var emptyCurrNum = !currNum && currNum !== 0;
-  var emptyNextNum = !nextNum && nextNum !== 0;
-  if (emptyCurrNum && emptyNextNum) return 0;
-  if (emptyCurrNum) return 1;
-  if (emptyNextNum) return -1;
-  if (currNum > nextNum) {
+/**
+ * Sort number
+ * @param {number} leftNumber
+ * @param {number} rightNumber
+ * @param {string} sortType e.g. 'up' | 'down'
+ * @returns number
+ */
+var sortNumber = function sortNumber(leftNumber, rightNumber, sortType) {
+  var emptyLeftNumber = !leftNumber && leftNumber !== 0;
+  var emptyRightNumber = !rightNumber && rightNumber !== 0;
+  if (emptyLeftNumber && emptyRightNumber) return 0;
+  if (emptyLeftNumber) return 1;
+  if (emptyRightNumber) return -1;
+  if (leftNumber > rightNumber) {
     return sortType === SORT_TYPE.UP ? 1 : -1;
   }
-  if (currNum < nextNum) {
+  if (leftNumber < rightNumber) {
     return sortType === SORT_TYPE.UP ? -1 : 1;
   }
   return 0;

package/es/sort/sort-column/single-select.js

@@ -1,15 +1,23 @@
 import { SORT_TYPE } from '../../constants/sort.js';
 
-var sortSingleSelect = function sortSingleSelect(currCellVal, nextCellVal, _ref) {
+/**
+ * Sort single-select
+ * @param {string} leftOptionId the id of option
+ * @param {string} rightOptionId
+ * @param {string} sort_type e.g. 'up' | 'down'
+ * @param {object} option_id_index_map e.g. { [option.id]: 0, ... }
+ * @returns number
+ */
+var sortSingleSelect = function sortSingleSelect(leftOptionId, rightOptionId, _ref) {
   var sort_type = _ref.sort_type,
     option_id_index_map = _ref.option_id_index_map;
-  var currentOptionIdIndex = option_id_index_map[currCellVal];
-  var nextOptionIdIndex = option_id_index_map[nextCellVal];
-  var emptyCurrCellVal = !currentOptionIdIndex && currentOptionIdIndex !== 0;
-  var emptyNextCellVal = !nextOptionIdIndex && nextOptionIdIndex !== 0;
-  if (emptyCurrCellVal && emptyNextCellVal) return 0;
-  if (emptyCurrCellVal) return 1;
-  if (emptyNextCellVal) return -1;
+  var currentOptionIdIndex = option_id_index_map[leftOptionId];
+  var nextOptionIdIndex = option_id_index_map[rightOptionId];
+  var emptyLeftOptionId = !currentOptionIdIndex && currentOptionIdIndex !== 0;
+  var emptyRightOptionId = !nextOptionIdIndex && nextOptionIdIndex !== 0;
+  if (emptyLeftOptionId && emptyRightOptionId) return 0;
+  if (emptyLeftOptionId) return 1;
+  if (emptyRightOptionId) return -1;
   if (currentOptionIdIndex > nextOptionIdIndex) {
     return sort_type === SORT_TYPE.UP ? 1 : -1;
   }

package/es/sort/sort-column/text.js

@@ -1,6 +1,12 @@
 import { REG_STRING_NUMBER_PARTS, REG_NUMBER_DIGIT } from '../../constants/reg.js';
 import { SORT_TYPE } from '../../constants/sort.js';
 
+/**
+ * Compare strings
+ * @param {string} leftString
+ * @param {string} rightString
+ * @returns number
+ */
 var compareString = function compareString(leftString, rightString) {
   if (!leftString && !rightString) return 0;
   if (!leftString) return -1;
@@ -19,8 +25,8 @@ var compareString = function compareString(leftString, rightString) {
     rightStringPart = rightStringParts[i];
     isDigitPart = REG_NUMBER_DIGIT.test(leftStringPart) && REG_NUMBER_DIGIT.test(rightStringPart);
     if (isDigitPart) {
-      leftStringPart = parseInt(leftStringPart, 10);
-      rightStringPart = parseInt(rightStringPart, 10);
+      leftStringPart = parseInt(leftStringPart);
+      rightStringPart = parseInt(rightStringPart);
       if (leftStringPart > rightStringPart) {
         return 1;
       }
@@ -34,14 +40,22 @@ var compareString = function compareString(leftString, rightString) {
   }
   return leftString.localeCompare(rightString);
 };
-var sortText = function sortText(currCellVal, nextCellVal, sortType) {
-  var emptyCurrCellVal = !currCellVal;
-  var emptyNextCellVal = !nextCellVal;
-  if (emptyCurrCellVal && emptyNextCellVal) return 0;
-  if (emptyCurrCellVal) return 1;
-  if (emptyNextCellVal) return -1;
-  if (nextCellVal === currCellVal) return 0;
-  return sortType === SORT_TYPE.UP ? compareString(currCellVal, nextCellVal) : -1 * compareString(currCellVal, nextCellVal);
+
+/**
+ * Sort text
+ * @param {string} leftText
+ * @param {string} rightText
+ * @param {string} sortType e.g. 'up' | 'down
+ * @returns number
+ */
+var sortText = function sortText(leftText, rightText, sortType) {
+  var emptyLeftText = !leftText;
+  var emptyRightText = !rightText;
+  if (emptyLeftText && emptyRightText) return 0;
+  if (emptyLeftText) return 1;
+  if (emptyRightText) return -1;
+  if (rightText === leftText) return 0;
+  return sortType === SORT_TYPE.UP ? compareString(leftText, rightText) : -1 * compareString(leftText, rightText);
 };
 
 export { compareString, sortText };

package/es/sort/sort-row.js

@@ -1,5 +1,4 @@
-import _defineProperty from '@babel/runtime/helpers/defineProperty';
-import { getValidSorts } from './core.js';
+import { deleteInvalidSort } from './core.js';
 import { sortCheckbox } from './sort-column/checkbox.js';
 import { sortCollaborator } from './sort-column/collaborator.js';
 import { sortDate } from './sort-column/date.js';
@@ -14,45 +13,20 @@ import { sortFormula } from './sort-column/formula.js';
 import { sortLink } from './sort-column/link.js';
 import { sortMultipleSelect } from './sort-column/multiple-select.js';
 import { sortSingleSelect } from './sort-column/single-select.js';
-import { getColumnOptions } from '../column/option.js';
 import { NUMBER_SORTER_COLUMN_TYPES } from '../constants/sort.js';
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
-var deleteInvalidSort = function deleteInvalidSort(sorts, columns) {
-  var validSorts = getValidSorts(sorts, columns);
-  var cleanSorts = [];
-  validSorts.forEach(function (sort) {
-    var column_key = sort.column_key;
-    var sortColumn = columns.find(function (column) {
-      return column.key === column_key;
-    });
-    var columnType = sortColumn.type;
-    var newSort = _objectSpread(_objectSpread({}, sort), {}, {
-      column: sortColumn
-    });
-    switch (columnType) {
-      case CellType.SINGLE_SELECT:
-      case CellType.MULTIPLE_SELECT:
-        {
-          var options = getColumnOptions(sortColumn);
-          var option_id_index_map = {};
-          options.forEach(function (option, index) {
-            option_id_index_map[option.id] = index;
-          });
-          newSort.option_id_index_map = option_id_index_map;
-          break;
-        }
-    }
-    cleanSorts.push(newSort);
-  });
-  return cleanSorts;
-};
-var sortRowsWithMultiSorts = function sortRowsWithMultiSorts(sortRows, sorts, _ref) {
+/**
+ * Sort rows with multiple sorts
+ * @param {array} tableRows e.g. [{ _id, [column.key]: '', ...}, ...]
+ * @param {array} sorts e.g. [{ column_key, sort_type, column, ... }, ...]
+ * @param {object} formulaRows computed value of formula, link-formula, link etc.
+ * @param {object} value e.g. { collaborators, ... }
+ */
+var sortRowsWithMultiSorts = function sortRowsWithMultiSorts(tableRows, sorts, _ref) {
   var _ref$formulaRows = _ref.formulaRows,
     formulaRows = _ref$formulaRows === void 0 ? {} : _ref$formulaRows,
     value = _ref.value;
-  sortRows.sort(function (currentRow, nextRow) {
+  tableRows.sort(function (currentRow, nextRow) {
     var initValue = 0;
     sorts.forEach(function (sort) {
       var column_key = sort.column_key,
@@ -106,11 +80,21 @@ var sortRowsWithMultiSorts = function sortRowsWithMultiSorts(sortRows, sorts, _r
     return initValue;
   });
 };
+
+/**
+ * Get sorted rows ids from table rows with multiple sorts
+ * @param {array} sorts e.g. [{ column_key, sort_type, column, ... }, ...]
+ * @param {array} rows e.g. [{ _id, [column.key]: '', ...}, ...]
+ * @param {array} columns e.g. [{ key, type, ... }, ...]
+ * @param {object} formulaRows computed value of formula, link-formula, link etc.
+ * @param {object} value e.g. { collaborators, ... }
+ * @returns sorted rows ids, array
+ */
 var sortTableRows = function sortTableRows(sorts, rows, columns) {
   var _ref2 = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {},
     formulaRows = _ref2.formulaRows,
     value = _ref2.value;
-  if (!Array.isArray(rows)) return [];
+  if (!Array.isArray(rows) || rows.length === 0) return [];
   var sortRows = rows.slice(0);
   var validSorts = deleteInvalidSort(sorts, columns);
   var normalizedFormulaRows = formulaRows || {};
@@ -123,4 +107,4 @@ var sortTableRows = function sortTableRows(sorts, rows, columns) {
   });
 };
 
-export { deleteInvalidSort, sortRowsWithMultiSorts, sortTableRows };
+export { sortRowsWithMultiSorts, sortTableRows };

package/es/table/column.js

@@ -1,5 +1,5 @@
 /**
- * get column by key from table
+ * Get column by key from table
  * @param {object} table
  * @param {string} columnKey
  * @returns column, object
@@ -12,7 +12,7 @@ var getTableColumnByKey = function getTableColumnByKey(table, columnKey) {
 };
 
 /**
- * get column by name from table
+ * Get table column by name
  * @param {object} table
  * @param {string} columnName
  * @returns column, object

package/es/table/core.js

@@ -1,8 +1,8 @@
 /**
- * get table by id
+ * Get table by id
  * @param {array} tables
  * @param {string} tableId
- * @returns object
+ * @returns table, object
  */
 var getTableById = function getTableById(tables, tableId) {
   if (!Array.isArray(tables) || !tableId) return null;

package/es/table/row.js

@@ -1,8 +1,8 @@
 /**
- * get row by id from table
+ * Get table row by id
  * @param {object} table
  * @param {string} rowId the id of row
- * @returns object
+ * @returns row, object
  */
 var getRowById = function getRowById(table, rowId) {
   if (!table || !table.id_row_map || !rowId) return null;
@@ -10,10 +10,10 @@ var getRowById = function getRowById(table, rowId) {
 };
 
 /**
- * get rows by ids from table
+ * Get table rows by ids
  * @param {object} table { id_row_map, ... }
  * @param {array} rowsIds [ row._id, ... ]
- * @returns array, rows: [ row, ... ]
+ * @returns rows, array
  */
 var getRowsByIds = function getRowsByIds(table, rowsIds) {
   if (!table || !table.id_row_map || !Array.isArray(rowsIds)) return [];

package/es/view/core.js

@@ -4,10 +4,10 @@ import { getValidSorts } from '../sort/core.js';
 import { CellType } from '../constants/cell-type.js';
 
 /**
- * get view by id
- * @param {array} views { _id: '', ... }
+ * Get view by id
+ * @param {array} views e.g. [{ _id, ... }, ...]
  * @param {string} viewId
- * @returns object
+ * @returns view, object
  */
 var getViewById = function getViewById(views, viewId) {
   if (!Array.isArray(views) || !viewId) return null;
@@ -17,10 +17,10 @@ var getViewById = function getViewById(views, viewId) {
 };
 
 /**
- * check whether the view contains filters
- * @param {object} view { filters: [], ... }
+ * Check whether the view contains filters
+ * @param {object} view e.g. { filters, ... }
  * @param {array} columns
- * @returns boolean
+ * @returns bool
  */
 var isFilterView = function isFilterView(view, columns) {
   var validFilters = getValidFilters(view.filters, columns);
@@ -28,10 +28,10 @@ var isFilterView = function isFilterView(view, columns) {
 };
 
 /**
- * check whether the view contains groupbys
- * @param {object} view { groupbys: [], ... }
+ * Check whether the view contains groupbys
+ * @param {object} view e.g. { groupbys, ... }
  * @param {array} columns
- * @returns boolean
+ * @returns bool
  */
 var isGroupView = function isGroupView(view, columns) {
   var validGroupbys = getValidGroupbys(view.groupbys, columns);
@@ -39,32 +39,31 @@ var isGroupView = function isGroupView(view, columns) {
 };
 
 /**
- * check whether the view contains sorts
- * @param {object} view { sorts: [], ... }
+ * Check whether the view contains sorts
+ * @param {object} view e.g. { sorts, ... }
  * @param {array} columns
- * @returns boolean
+ * @returns bool
  */
 var isSortView = function isSortView(view, columns) {
-  var sorts = view.sorts;
-  var validSorts = getValidSorts(sorts, columns);
+  var validSorts = getValidSorts(view.sorts, columns);
   return validSorts.length > 0;
 };
 
 /**
- * check is default view which no contains filters, sorts, groupbys etc.
- * @param {object} view { sorts: [], ... }
+ * Check is default view which no contains filters, sorts, groupbys etc.
+ * @param {object} view e.g. { filters, groupbys, sorts, ... }
  * @param {array} columns
- * @returns boolean
+ * @returns bool
  */
 var isDefaultView = function isDefaultView(view, columns) {
   return !isFilterView(view, columns) && !isSortView(view, columns) && !isGroupView(view, columns);
 };
 
 /**
- * get link columns which used either in filters, groupbys, sorts etc.
- * @param {object} view { filters, groupbys, sorts, ... }
- * @param {object} table
- * @returns array, link columns
+ * Get link columns which used either in filters, groupbys, sorts etc.
+ * @param {object} view e.g. { filters, groupbys, sorts, ... }
+ * @param {object} table e.g. { columns, ... }
+ * @returns link columns, array
  */
 var getLinkColumnsUsedInFilters = function getLinkColumnsUsedInFilters(view, table) {
   var filters = view.filters,

package/es/view/formula.js

@@ -2,9 +2,9 @@ import { CellType } from '../constants/cell-type.js';
 import { FORMULA_COLUMN_TYPES_MAP } from '../constants/formula.js';
 
 /**
- * transform the formats of link column to link-formula's
- * @param {object} linkColumn { key, data: { display_column_key, ... }, ... }
- * @returns object
+ * Transform the formats of link column to link-formula's
+ * @param {object} linkColumn e.g. { key, data: { display_column_key, ... }, ... }
+ * @returns converted link column, object
  */
 var transLink2LinkFormula = function transLink2LinkFormula(linkColumn) {
   var key = linkColumn.key,
@@ -26,10 +26,10 @@ var transLink2LinkFormula = function transLink2LinkFormula(linkColumn) {
 };
 
 /**
- * get sorted formula columns
- * @param {array} formulaColumns
- * @param {object} table
- * @returns array
+ * Get sorted formula columns
+ * @param {array} formulaColumns the formula columns waiting to sort
+ * @param {object} table e.g. { columns, ... }
+ * @returns sorted formula columns, array
  */
 var getSortedFormulaColumns = function getSortedFormulaColumns(formulaColumns, table) {
   if (!Array.isArray(formulaColumns) || !table || !Array.isArray(table.columns)) return [];
@@ -70,18 +70,20 @@ var getSortedFormulaColumns = function getSortedFormulaColumns(formulaColumns, t
     var data = formulaColumn.data;
     var operated_columns = data.operated_columns;
     keyInDegreeMap[formulaColumnKey] = 0;
-    Array.isArray(operated_columns) && operated_columns.forEach(function (dependColumnKey) {
-      var dependColumn = keyColumnMap[dependColumnKey];
-      if (!dependColumn) {
-        return;
-      }
-      keyInDegreeMap[formulaColumnKey]++;
-      if (keyEdgesMap[dependColumnKey]) {
-        keyEdgesMap[dependColumnKey].push(formulaColumnKey);
-      } else {
-        keyEdgesMap[dependColumnKey] = [formulaColumnKey];
-      }
-    });
+    if (Array.isArray(operated_columns)) {
+      operated_columns.forEach(function (dependColumnKey) {
+        var dependColumn = keyColumnMap[dependColumnKey];
+        if (!dependColumn) {
+          return;
+        }
+        keyInDegreeMap[formulaColumnKey] += 1;
+        if (keyEdgesMap[dependColumnKey]) {
+          keyEdgesMap[dependColumnKey].push(formulaColumnKey);
+        } else {
+          keyEdgesMap[dependColumnKey] = [formulaColumnKey];
+        }
+      });
+    }
   });
   var sortedList = [];
   var waitingQueue = [];
@@ -94,12 +96,14 @@ var getSortedFormulaColumns = function getSortedFormulaColumns(formulaColumns, t
     var columnKey = waitingQueue.shift();
     var edges = keyEdgesMap[columnKey];
     sortedList.push(columnKey);
-    Array.isArray(edges) && edges.forEach(function (edge) {
-      keyInDegreeMap[edge]--;
-      if (keyInDegreeMap[edge] === 0) {
-        waitingQueue.push(edge);
-      }
-    });
+    if (Array.isArray(edges)) {
+      edges.forEach(function (edge) {
+        keyInDegreeMap[edge] -= 1;
+        if (keyInDegreeMap[edge] === 0) {
+          waitingQueue.push(edge);
+        }
+      });
+    }
   }
   return sortedList.map(function (columnKey) {
     return keyColumnMap[columnKey];
@@ -107,9 +111,9 @@ var getSortedFormulaColumns = function getSortedFormulaColumns(formulaColumns, t
 };
 
 /**
- * get formula columns and link columns from table
- * @param {object} table { columns: [], ... }
- * @returns array
+ * Get table formula columns and link columns
+ * @param {object} table e.g. { columns, ... }
+ * @returns formula and link columns, array
  */
 var getFormulaColumnsContainLinks = function getFormulaColumnsContainLinks(table) {
   var columns = table.columns;
@@ -130,9 +134,9 @@ var getFormulaColumnsContainLinks = function getFormulaColumnsContainLinks(table
 };
 
 /**
- * get sorted formula columns and link columns from table
- * @param {object} table { columns: [], ... }
- * @returns array
+ * Get sorted formula and link columns from table
+ * @param {object} table e.g. { columns, ... }
+ * @returns sorted formula and link columns, array
  */
 var getSortedFormulaColumnsContainLinks = function getSortedFormulaColumnsContainLinks(table) {
   var formulaColumns = getFormulaColumnsContainLinks(table);

package/es/view/group.js

@@ -1,8 +1,8 @@
 /**
- * get group by paths.
- * @param {array} paths e.g. [0, 1, 2]
- * @param {array} groups
- * @returns object
+ * Get group by paths
+ * @param {array} paths e.g. [ 0, 1, 2 ]
+ * @param {array} groups grouped rows
+ * @returns group, object
  */
 var getGroupByPath = function getGroupByPath(paths, groups) {
   if (!Array.isArray(paths) || !Array.isArray(groups)) {

package/es/view/summaries.js

@@ -1,28 +1,15 @@
 import { getRowsByIds } from '../table/row.js';
 import { isTableRows } from '../row/core.js';
-import '@babel/runtime/helpers/defineProperty';
-import '../constants/group.js';
-import '../validate/filter.js';
-import '../filter/core.js';
-import '@babel/runtime/helpers/toConsumableArray';
-import '../constants/filter/filter-column-options.js';
-import '../constants/filter/filter-modifier.js';
-import '../constants/filter/filter-predicate.js';
-import '../constants/filter/filter-is-within.js';
-import '../date.js';
-import { isNumber } from '../number.js';
-import '../cell-value-get/cell-value.js';
 import { isNumericColumn } from '../column/number.js';
-import '../constants/column.js';
+import { isNumber } from '../number.js';
 import { FORMULA_COLUMN_TYPES_MAP } from '../constants/formula.js';
-import '../constants/row-color.js';
 
 /**
- * calculate summaries of numeric columns from table
- * @param {object} table
- * @param {array} rows table's rows or rows ids
- * @param {object} formulaRows support numeric formula columns
- * @returns object, { [column.key]: { sum, average, median, max, min, ... }, ... }
+ * Calculate summaries of table numeric columns
+ * @param {object} table e.g. { columns, ... }
+ * @param {array} rows e.g. table rows: [{ _id, ...}, ...] | view rows: [ row._id, ... ]
+ * @param {object} formulaRows for numeric formula columns
+ * @returns summaries: { [column.key]: { sum, average, median, max, min, ... }, ... }, object
  */
 var getSummaries = function getSummaries(table, rows, formulaRows) {
   var numericColumns = table.columns.filter(function (column) {
@@ -88,10 +75,10 @@ var getSummaries = function getSummaries(table, rows, formulaRows) {
 };
 
 /**
- * calculate sub-group's summaries of numeric columns
- * @param {array} subgroups { summaries, ... }
+ * Calculate group summaries by subgroup
+ * @param {array} subgroups e.g. [{ summaries, ... }, ...]
  * @param {array} numericColumns
- * @returns object, { [column.key]: { sum, average, median, max, min, ... } }
+ * @returns summaries: { [column.key]: { sum, average, median, max, min, ... }, ... }, object
  */
 var getSummariesWithSubgroups = function getSummariesWithSubgroups(subgroups, numericColumns) {
   var subgroupsLen = subgroups.length;
@@ -104,8 +91,8 @@ var getSummariesWithSubgroups = function getSummariesWithSubgroups(subgroups, nu
     var max;
     var min;
     subgroups.forEach(function (subgroup) {
-      var summaries = subgroup.summaries;
-      var summary = summaries[column.key];
+      var subSummaries = subgroup.summaries;
+      var summary = subSummaries[column.key];
       var subgroupSum = summary.sum,
         subgroupAverage = summary.average,
         subgroupMedian = summary.median,
@@ -139,7 +126,7 @@ var getSummariesWithSubgroups = function getSummariesWithSubgroups(subgroups, nu
         median = medianArr[parseInt(medianArr.length / 2)];
       }
     }
-    average = average / subgroupsLen;
+    average /= subgroupsLen;
     summaries[column.key] = {
       sum: sum,
       average: average,
@@ -152,10 +139,11 @@ var getSummariesWithSubgroups = function getSummariesWithSubgroups(subgroups, nu
 };
 
 /**
- * calculate group's summaries of numeric columns from table
- * @param {array} groups { subgroups, row_ids, ... }
- * @param {object} table
- * @param {object} formulaRows support numeric formula columns
+ * Calculate group summaries
+ * @param {array} groups e.g. [{ subgroups, row_ids, ... }, ...]
+ * @param {object} table e.g. { columns, ... }
+ * @param {object} formulaRows for numeric formula columns
+ * @returns void
  */
 var updateGroupSummaries = function updateGroupSummaries(groups, table, formulaRows) {
   var numericColumns = table.columns.filter(function (column) {