dtable-utils 0.0.2 → 0.0.3-beta.1

package/lib/view/summaries.js

@@ -0,0 +1,185 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var row = require('../table/row.js');
+var core = require('../row/core.js');
+require('@babel/runtime/helpers/defineProperty');
+require('../constants/group.js');
+require('../validate/filter.js');
+require('../filter/core.js');
+require('@babel/runtime/helpers/toConsumableArray');
+require('../constants/filter/filter-column-options.js');
+require('../constants/filter/filter-modifier.js');
+require('../constants/filter/filter-predicate.js');
+require('../constants/filter/filter-is-within.js');
+require('../date.js');
+var number$1 = require('../number.js');
+require('../cell-value-get/cell-value.js');
+var number = require('../column/number.js');
+require('../constants/column.js');
+var formula = require('../constants/formula.js');
+require('../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, ... }, ... }
+ */
+var getSummaries = function getSummaries(table, rows, formulaRows) {
+  var numericColumns = table.columns.filter(function (column) {
+    return number.isNumericColumn(column);
+  });
+  if (numericColumns.length === 0) {
+    return {};
+  }
+  var summaryRows = core.isTableRows(rows) ? rows : row.getRowsByIds(table, rows);
+  var summaries = {};
+  numericColumns.forEach(function (column) {
+    var type = column.type,
+      key = column.key;
+    var validNumbersCount = 0;
+    var medianArr = [];
+    var sum = 0;
+    var min;
+    var max;
+    var median;
+    summaryRows.forEach(function (row) {
+      var cellValue = row[key];
+      if (formula.FORMULA_COLUMN_TYPES_MAP[type]) {
+        var formulaRow = formulaRows && formulaRows[row._id];
+        cellValue = formulaRow && formulaRow[key];
+        if (Array.isArray(cellValue) && cellValue.length === 1) {
+          cellValue = cellValue[0];
+        }
+      }
+      if (number$1.isNumber(cellValue)) {
+        medianArr.push(cellValue);
+        validNumbersCount += 1;
+        sum += cellValue;
+        if (min === undefined) {
+          min = cellValue;
+        } else {
+          min = cellValue < min ? cellValue : min;
+        }
+        if (max === undefined) {
+          max = cellValue;
+        } else {
+          max = cellValue > max ? cellValue : max;
+        }
+      }
+    });
+    if (validNumbersCount > 0) {
+      medianArr.sort();
+      if (medianArr.length % 2 === 0) {
+        median = (medianArr[medianArr.length / 2 - 1] + medianArr[medianArr.length / 2]) / 2;
+      } else {
+        median = medianArr[parseInt(medianArr.length / 2)];
+      }
+    }
+    var average = validNumbersCount === 0 ? 0 : sum / validNumbersCount;
+    summaries[key] = {
+      sum: sum,
+      average: average,
+      median: median,
+      max: max,
+      min: min
+    };
+  });
+  return summaries;
+};
+
+/**
+ * calculate sub-group's summaries of numeric columns
+ * @param {array} subgroups { summaries, ... }
+ * @param {array} numericColumns
+ * @returns object, { [column.key]: { sum, average, median, max, min, ... } }
+ */
+var getSummariesWithSubgroups = function getSummariesWithSubgroups(subgroups, numericColumns) {
+  var subgroupsLen = subgroups.length;
+  var summaries = {};
+  numericColumns.forEach(function (column) {
+    var medianArr = [];
+    var sum = 0;
+    var average = 0;
+    var median;
+    var max;
+    var min;
+    subgroups.forEach(function (subgroup) {
+      var summaries = subgroup.summaries;
+      var summary = summaries[column.key];
+      var subgroupSum = summary.sum,
+        subgroupAverage = summary.average,
+        subgroupMedian = summary.median,
+        subgroupMax = summary.max,
+        subgroupMin = summary.min;
+      sum += subgroupSum || 0;
+      average += subgroupAverage || 0;
+      if (number$1.isNumber(subgroupMedian)) {
+        medianArr.push(subgroupMedian);
+      }
+      if (number$1.isNumber(subgroupMax)) {
+        if (max === undefined) {
+          max = subgroupMax;
+        } else {
+          max = subgroupMax > max ? subgroupMax : max;
+        }
+      }
+      if (number$1.isNumber(subgroupMin)) {
+        if (min === undefined) {
+          min = subgroupMin;
+        } else {
+          min = subgroupMin < min ? subgroupMin : min;
+        }
+      }
+    });
+    if (medianArr.length > 0) {
+      medianArr.sort();
+      if (medianArr.length % 2 === 0) {
+        median = (medianArr[medianArr.length / 2 - 1] + medianArr[medianArr.length / 2]) / 2;
+      } else {
+        median = medianArr[parseInt(medianArr.length / 2)];
+      }
+    }
+    average = average / subgroupsLen;
+    summaries[column.key] = {
+      sum: sum,
+      average: average,
+      median: median,
+      max: max,
+      min: min
+    };
+  });
+  return summaries;
+};
+
+/**
+ * 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
+ */
+var updateGroupSummaries = function updateGroupSummaries(groups, table, formulaRows) {
+  var numericColumns = table.columns.filter(function (column) {
+    return number.isNumericColumn(column);
+  });
+  if (!Array.isArray(groups) || numericColumns.length === 0) {
+    return;
+  }
+  groups.forEach(function (group) {
+    var subgroups = group.subgroups,
+      row_ids = group.row_ids;
+    if (Array.isArray(subgroups) && subgroups.length > 0) {
+      updateGroupSummaries(subgroups, table, formulaRows);
+      group.summaries = getSummariesWithSubgroups(subgroups, numericColumns);
+    } else if (row_ids) {
+      group.summaries = getSummaries(table, row_ids, formulaRows);
+    }
+  });
+};
+
+exports.getSummaries = getSummaries;
+exports.getSummariesWithSubgroups = getSummariesWithSubgroups;
+exports.updateGroupSummaries = updateGroupSummaries;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "dtable-utils",
-  "version": "0.0.2",
+  "version": "0.0.3-beta.1",
   "description": "dtable common utils",
   "main": "./lib/index.js",
   "module": "./es/index.js",
   "private": false,
   "scripts": {
     "test": "jest -c --watchAll",
+    "test-cov": "jest --coverage --watchAll",
     "eslint": "eslint ./src/**",
     "build": "rm -rf dist lib es && rollup -c",
     "prepublishOnly": "npm run build"
@@ -23,7 +24,8 @@
     "package.json"
   ],
   "dependencies": {
-    "dayjs": "1.10.7"
+    "dayjs": "1.10.7",
+    "deep-copy": "^1.4.2"
   },
   "devDependencies": {
     "@babel/core": "^7.22.5",