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

package/lib/view/core.js

@@ -8,10 +8,10 @@ var core$2 = require('../sort/core.js');
 var cellType = require('../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;
@@ -21,10 +21,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 = core.getValidFilters(view.filters, columns);
@@ -32,10 +32,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 = core$1.getValidGroupbys(view.groupbys, columns);
@@ -43,32 +43,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 = core$2.getValidSorts(sorts, columns);
+  var validSorts = core$2.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/lib/view/formula.js

@@ -6,9 +6,9 @@ var cellType = require('../constants/cell-type.js');
 var formula = require('../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,
@@ -30,10 +30,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 [];
@@ -74,18 +74,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 = [];
@@ -98,12 +100,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];
@@ -111,9 +115,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;
@@ -134,9 +138,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/lib/view/group.js

@@ -3,10 +3,10 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 /**
- * 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/lib/view/summaries.js

@@ -4,29 +4,16 @@ 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 number$1 = require('../number.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, ... }, ... }
+ * 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) {
@@ -92,10 +79,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;
@@ -108,8 +95,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,
@@ -143,7 +130,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,
@@ -156,10 +143,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) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dtable-utils",
-  "version": "0.0.3-beta.1",
+  "version": "0.0.4-beta.1",
   "description": "dtable common utils",
   "main": "./lib/index.js",
   "module": "./es/index.js",

package/es/table/index.js

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

package/lib/table/index.js

@@ -1,18 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-/**
- * get table by id
- * @param {array} tables
- * @param {string} tableId
- * @returns table, object
- */
-var getTableById = function getTableById(tables, tableId) {
-  if (!Array.isArray(tables) || !tableId) return null;
-  return tables.find(function (table) {
-    return table._id === tableId;
-  });
-};
-
-exports.getTableById = getTableById;