dtable-utils 0.0.3 → 0.0.4-beta.1

package/es/color/row-color.js

@@ -0,0 +1,289 @@
+import _defineProperty from '@babel/runtime/helpers/defineProperty';
+import { getTableColumnByKey } from '../table/column.js';
+import { getRowsByIds } from '../table/row.js';
+import { isTableRows } from '../row/core.js';
+import { getColumnOptions } from '../column/option.js';
+import { getGeolocationDisplayString } from '../cell-value-get/geolocation.js';
+import { ValidateFilter } from '../validate/filter.js';
+import { deleteInvalidFilter, getFormattedFilters } from '../filter/core.js';
+import { filterRow } from '../filter/filter-row.js';
+import { ROW_COLOR_TYPE, ROW_COLOR_FOR_DUPLICATE_VALUES, SUPPORT_CHECKING_DUPLICATE_COLUMNS_TYPES } from '../constants/row-color.js';
+import { CellType } from '../constants/cell-type.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 isValidRowColorRule = function isValidRowColorRule(rule, columns) {
+  var filters = rule.filters;
+  if (!filters || filters.length === 0) return false;
+  return filters.some(function (filter) {
+    return !ValidateFilter.validate(filter, columns).error_message;
+  });
+};
+var getValidRowColorRules = function getValidRowColorRules(colorRules, columns) {
+  return colorRules.filter(function (colorRule) {
+    return isValidRowColorRule(colorRule, columns);
+  });
+};
+var getOptionIdMap = function getOptionIdMap(options) {
+  if (!Array.isArray(options) || options.length === 0) return {};
+  var optionsMap = {};
+  options.forEach(function (option) {
+    optionsMap[option.id] = true;
+  });
+  return optionsMap;
+};
+var getFormattedDuplicateColumns = function getFormattedDuplicateColumns(columns, duplicateColumnKeys, _ref) {
+  var collaborators = _ref.collaborators;
+  var formattedColumns = [];
+  var _loop = function _loop() {
+    var key = duplicateColumnKeys[i];
+    var currColumn = columns.find(function (column) {
+      return column.key === key;
+    });
+    if (!currColumn) return "continue";
+    var type = currColumn.type,
+      data = currColumn.data;
+    var formattedColumnData = data;
+    if (!SUPPORT_CHECKING_DUPLICATE_COLUMNS_TYPES.includes(type)) return "continue";
+    if (type === CellType.SINGLE_SELECT || type === CellType.MULTIPLE_SELECT) {
+      var options = getColumnOptions(currColumn);
+      formattedColumnData = getOptionIdMap(options);
+    } else if (type === CellType.COLLABORATOR) {
+      var optionsMap = {};
+      if (Array.isArray(collaborators)) {
+        collaborators.forEach(function (collaborator) {
+          optionsMap[collaborator.email] = true;
+        });
+      }
+      formattedColumnData = optionsMap;
+    }
+    formattedColumns.push({
+      key: key,
+      type: type,
+      data: formattedColumnData
+    });
+  };
+  for (var i = 0; i < duplicateColumnKeys.length; i++) {
+    var _ret = _loop();
+    if (_ret === "continue") continue;
+  }
+  return formattedColumns;
+};
+var getDuplicateRowValue = function getDuplicateRowValue(row, columns, formulaRow) {
+  if (!row) return '';
+  var rowValue = columns.map(function (column) {
+    var type = column.type,
+      data = column.data,
+      key = column.key;
+    var cellValue = row[key];
+    switch (type) {
+      case CellType.SINGLE_SELECT:
+        {
+          return data[cellValue] ? cellValue : '';
+        }
+      case CellType.MULTIPLE_SELECT:
+      case CellType.COLLABORATOR:
+        {
+          if (!Array.isArray(cellValue) || cellValue.length === 0) return '';
+          return cellValue.filter(function (item) {
+            return data[item];
+          }).sort().join('');
+        }
+      case CellType.GEOLOCATION:
+        {
+          if (!cellValue) return '';
+          return getGeolocationDisplayString(cellValue, data) || '';
+        }
+      case CellType.NUMBER:
+        {
+          if (!cellValue && cellValue !== 0) return '';
+          return cellValue;
+        }
+      case CellType.FORMULA:
+        {
+          if (!formulaRow) return '';
+          cellValue = formulaRow[key];
+          return cellValue;
+        }
+      default:
+        {
+          return cellValue || '';
+        }
+    }
+  }).join('_seatable_join_key_');
+  if (!rowValue) return '';
+  if (typeof ''.replaceAll !== 'function') {
+    // eslint-disable-next-line
+    String.prototype.replaceAll = function (s1, s2) {
+      return this.replace(new RegExp(s1, 'gm'), s2);
+    };
+  }
+  if (!rowValue.replaceAll('_seatable_join_key_', '')) return '';
+  return rowValue;
+};
+var getRowsColorBySingleSelectColumn = function getRowsColorBySingleSelectColumn(rows, columnKey, table) {
+  var colors = {};
+  var column = getTableColumnByKey(table, columnKey);
+  var options = getColumnOptions(column);
+  if (!Array.isArray(options) || options.length === 0) return {};
+  var option_id_color_map = {};
+  options.forEach(function (option) {
+    option_id_color_map[option.id] = option.color;
+  });
+  rows.forEach(function (row) {
+    var optionId = row[columnKey];
+    var color = optionId ? option_id_color_map[optionId] : '';
+    if (color) {
+      colors[row._id] = color;
+    }
+  });
+  return colors;
+};
+var getRowsColorByRules = function getRowsColorByRules(rows, view, table) {
+  var _ref2 = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {},
+    username = _ref2.username,
+    userId = _ref2.userId;
+  var formula_rows = view.formula_rows,
+    colorbys = view.colorbys;
+  var _ref3 = colorbys || {},
+    type = _ref3.type,
+    color_by_rules = _ref3.color_by_rules;
+  if (type !== ROW_COLOR_TYPE.BY_RULES) return {};
+  var columns = table.columns;
+  var validColorRules = getValidRowColorRules(color_by_rules, columns);
+  var colorRulesLen = validColorRules.length;
+  var colors = {};
+  if (colorRulesLen === 0) return {};
+  validColorRules = validColorRules.map(function (colorRule) {
+    var filters = colorRule.filters;
+    var validFilters;
+    try {
+      validFilters = deleteInvalidFilter(filters, columns);
+    } catch (err) {
+      validFilters = [];
+    }
+    validFilters = getFormattedFilters(validFilters);
+    return _objectSpread(_objectSpread({}, colorRule), {}, {
+      filters: validFilters
+    });
+  });
+  rows.forEach(function (row) {
+    var rowId = row._id;
+    var formulaRow = formula_rows && formula_rows[rowId] || {};
+    for (var i = 0; i < colorRulesLen; i++) {
+      var colorRule = validColorRules[i];
+      var color = colorRule.color,
+        filter_conjunction = colorRule.filter_conjunction,
+        filters = colorRule.filters;
+      if (filterRow(row, filter_conjunction, filters, {
+        formulaRow: formulaRow,
+        username: username,
+        userId: userId
+      })) {
+        colors[rowId] = color;
+        break;
+      }
+    }
+  });
+  return colors;
+};
+var getRowsColorByDuplicateValues = function getRowsColorByDuplicateValues(rows, view, table, _ref4) {
+  var collaborators = _ref4.collaborators;
+  var colorbys = view.colorbys,
+    formula_rows = view.formula_rows;
+  var color_by_duplicate_column_keys = colorbys.color_by_duplicate_column_keys;
+  if (!Array.isArray(color_by_duplicate_column_keys) || color_by_duplicate_column_keys.length === 0) return {};
+  var columns = table.columns;
+  var formattedColumns = getFormattedDuplicateColumns(columns, color_by_duplicate_column_keys, {
+    collaborators: collaborators
+  });
+  if (formattedColumns.length === 0) return {};
+  var colors = {};
+  var duplicate_rows_ids_map = {}; // row value: [ row_id ]
+  for (var i = 0; i < rows.length; i++) {
+    var row = rows[i];
+    var rowId = row._id;
+    var formulaRow = formula_rows && formula_rows[rowId];
+    var rowValue = getDuplicateRowValue(row, formattedColumns, formulaRow);
+    if (!rowValue) continue;
+    var validRowIds = duplicate_rows_ids_map[rowValue];
+    if (validRowIds && validRowIds.length > 0) {
+      colors[rowId] = ROW_COLOR_FOR_DUPLICATE_VALUES;
+      validRowIds.push(rowId);
+      var firstDuplicateRowId = validRowIds[0];
+      if (!colors[firstDuplicateRowId]) {
+        colors[firstDuplicateRowId] = ROW_COLOR_FOR_DUPLICATE_VALUES;
+      }
+    } else {
+      duplicate_rows_ids_map[rowValue] = [rowId];
+    }
+  }
+  return {
+    colors: colors,
+    duplicate_rows_ids_map: duplicate_rows_ids_map
+  };
+};
+
+/**
+ * Calculate rows color.
+ * @param {array} rows
+ * @param {object} view
+ * @param {object} table e.g. { id_row_map, ... }
+ * @param {object} value e.g. { tables, collaborators, ... }
+ * @param {string} username
+ * @param {userId} username
+ * @returns rows color, object
+ */
+var getRowsColor = function getRowsColor(rows, view, table, value) {
+  var _ref5 = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {},
+    username = _ref5.username,
+    userId = _ref5.userId;
+  var colorbys = view.colorbys;
+  if (!colorbys) return {};
+  var tableRows = isTableRows(rows) ? rows : getRowsByIds(table, rows);
+  if (tableRows.length === 0) return {};
+  var type = colorbys.type,
+    color_by_column = colorbys.color_by_column;
+  switch (type) {
+    case ROW_COLOR_TYPE.BY_COLUMN:
+      {
+        return {
+          colors: getRowsColorBySingleSelectColumn(tableRows, color_by_column, table)
+        };
+      }
+    case ROW_COLOR_TYPE.BY_RULES:
+      {
+        return {
+          colors: getRowsColorByRules(tableRows, view, table, {
+            username: username,
+            userId: userId
+          })
+        };
+      }
+    case ROW_COLOR_TYPE.BY_DUPLICATE_VALUES:
+      {
+        var _ref6 = value || {},
+          _ref6$collaborators = _ref6.collaborators,
+          collaborators = _ref6$collaborators === void 0 ? [] : _ref6$collaborators;
+        return getRowsColorByDuplicateValues(tableRows, view, table, {
+          collaborators: collaborators
+        });
+      }
+    default:
+      {
+        return {};
+      }
+  }
+};
+var RowColorUtils = {
+  isValidRowColorRule: isValidRowColorRule,
+  getValidRowColorRules: getValidRowColorRules,
+  getRowsColor: getRowsColor,
+  getFormattedDuplicateColumns: getFormattedDuplicateColumns,
+  getDuplicateRowValue: getDuplicateRowValue,
+  getRowsColorBySingleSelectColumn: getRowsColorBySingleSelectColumn,
+  getRowsColorByRules: getRowsColorByRules,
+  getRowsColorByDuplicateValues: getRowsColorByDuplicateValues
+};
+
+export { RowColorUtils as default };

package/es/column/{common.js → core.js}

@@ -3,7 +3,7 @@ import { FORMULA_COLUMN_TYPES_MAP, FORMULA_RESULT_TYPE } from '../constants/form
 
 /**
  * Get column type.
- * @param {object} column { type: 'xxx', ... }
+ * @param {object} column { type, ... }
  * @returns column type
  */
 var getColumnType = function getColumnType(column) {
@@ -26,16 +26,4 @@ var getColumnType = function getColumnType(column) {
   return type;
 };
 
-/**
- * Get options from single-select/multiple-select column.
- * @param {object} column e.g. { type, data: { options: [] } }
- * @returns options, array
- */
-var getColumnOptions = function getColumnOptions(column) {
-  if (!column || !column.data || !Array.isArray(column.data.options)) {
-    return [];
-  }
-  return column.data.options;
-};
-
-export { getColumnOptions, getColumnType };
+export { getColumnType };

package/es/column/date.js

@@ -1,4 +1,4 @@
-import { getColumnType } from './common.js';
+import { getColumnType } from './core.js';
 import { DATE_COLUMN_OPTIONS } from '../constants/column.js';
 
 /**

package/es/column/number.js

@@ -1,4 +1,4 @@
-import { getColumnType } from './common.js';
+import { getColumnType } from './core.js';
 import { CellType } from '../constants/cell-type.js';
 import { NUMERIC_COLUMNS_TYPES } from '../constants/column.js';
 

package/es/column/option.js

@@ -0,0 +1,145 @@
+import { SELECT_OPTION_COLORS } from '../constants/select-option.js';
+
+/**
+ * Get options from single-select/multiple-select column.
+ * @param {object} column e.g. { type, data: { options: [] } }
+ * @returns options, array
+ */
+var getColumnOptions = function getColumnOptions(column) {
+  if (!column || !column.data || !Array.isArray(column.data.options)) {
+    return [];
+  }
+  return column.data.options;
+};
+
+/**
+ * generate unique option id
+ * @param {array} options e.g. [{ id, ... }, ...]
+ * @returns generated option id, string
+ */
+var generateOptionID = function generateOptionID(options) {
+  if (options.length === 1) return String(Math.floor(Math.random() * Math.pow(10, 6)));
+  var optionID;
+  var isIDUnique = false;
+  while (!isIDUnique) {
+    optionID = String(Math.floor(Math.random() * Math.pow(10, 6)));
+
+    // eslint-disable-next-line
+    isIDUnique = options.every(function (option) {
+      return option.id !== optionID;
+    });
+    if (isIDUnique) {
+      break;
+    }
+  }
+  return optionID;
+};
+var getRandomOptionColor = function getRandomOptionColor(options) {
+  var defaultOptions = SELECT_OPTION_COLORS.slice(12, 24);
+  var colorIdx = Math.floor(Math.random() * defaultOptions.length);
+  if (!Array.isArray(options) || options.length === 0) {
+    return defaultOptions[colorIdx];
+  }
+
+  // Avoid using the same color for adjacent labels
+  var adjacentOptions = options.slice(-(defaultOptions.length - 1));
+  var adjacentOptionsColorIdxArr = [];
+  var selectOptionColorObj = {};
+  defaultOptions.forEach(function (colorItem, index) {
+    selectOptionColorObj[colorItem.COLOR] = index;
+  });
+  adjacentOptions.forEach(function (option) {
+    var optionColorIdx = selectOptionColorObj[option.color];
+    adjacentOptionsColorIdxArr.push(optionColorIdx);
+  });
+
+  // eslint-disable-next-line
+  while (adjacentOptionsColorIdxArr.indexOf(colorIdx) != -1) {
+    colorIdx = Math.floor(Math.random() * defaultOptions.length);
+  }
+  return defaultOptions[colorIdx] || defaultOptions[0];
+};
+
+/**
+ * generate option
+ * @param {array} options e.g. [{ id, ... }, ...]
+ * @param {string} optionName
+ * @param {string} optionColor used to find system support color options. The new color option will be generated if not found by "optionColor" or not supported
+ * @returns generated option, object
+ */
+var createOption = function createOption(options, optionName) {
+  var optionColor = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
+  var id = generateOptionID(options);
+  var colors = optionColor && SELECT_OPTION_COLORS.find(function (systemColor) {
+    return systemColor.COLOR === optionColor;
+  });
+  if (!colors) {
+    colors = getRandomOptionColor(options);
+  }
+  return {
+    id: id,
+    name: optionName,
+    color: colors.COLOR,
+    textColor: colors.TEXT_COLOR
+  };
+};
+
+/**
+ * Generate cell option by name.
+ * Return the option id if exist, otherwise generate a new option
+ * @param {array} options e.g. [{ id, ... }, ...]
+ * @param {string} optionName used as the option name
+ * @returns option id and option, object
+ */
+var generatorCellOption = function generatorCellOption(options, optionName) {
+  var existOption = options.find(function (option) {
+    return option.name === optionName;
+  });
+  if (existOption) {
+    return {
+      selectedOptionId: existOption.id
+    };
+  }
+  var newOption = createOption(options, optionName) || {};
+  return {
+    cellOption: newOption,
+    selectedOptionId: newOption.id
+  };
+};
+
+/**
+ * Generate cell options by names.
+ * Return the options ids if exist, otherwise generate new options
+ * @param {array} options e.g. [{ id, ... }, ...]
+ * @param {array} optionNames used as the options names
+ * @returns options ids and options, object
+ */
+var generatorCellOptions = function generatorCellOptions(options, optionNames) {
+  var cellOptions = [];
+  var selectedOptionIds = [];
+  optionNames.forEach(function (optionName) {
+    var existingOption = options.find(function (option) {
+      return option.name === optionName;
+    });
+    if (existingOption) {
+      selectedOptionIds.push(existingOption.id);
+    } else {
+      var cellOption = createOption(options, optionName);
+      if (cellOption) {
+        cellOptions.push(cellOption);
+        selectedOptionIds.push(cellOption.id);
+      }
+    }
+  });
+  if (cellOptions.length === 0) {
+    return {
+      selectedOptionIds: selectedOptionIds
+    };
+  }
+  return {
+    cellOptions: cellOptions,
+    selectedOptionIds: selectedOptionIds
+  };
+};
+
+export { createOption, generateOptionID, generatorCellOption, generatorCellOptions, getColumnOptions };

package/es/common.js

@@ -1,3 +1,5 @@
+import _typeof from '@babel/runtime/helpers/typeof';
+
 /**
  * Generate a random string of specified length.
  * @param {number} keyLength
@@ -12,15 +14,33 @@ var generatorBase64Code = function generatorBase64Code() {
   }
   return key;
 };
-var isNumber = function isNumber(num) {
-  return (num || num === 0) && Object.prototype.toString.call(num) === '[object Number]';
+
+/**
+ * Check whether the given value is empty
+ * @param {any} val
+ * @returns bool
+ */
+var isEmpty = function isEmpty(val) {
+  if (val === null || val === undefined) return true;
+  if (val.length !== undefined) return val.length === 0;
+  if (val instanceof Date) return false;
+  if (_typeof(val) === 'object') return Object.keys(val).length === 0;
+  return false;
 };
+
+/**
+ * Check whether the object is empty.
+ * The true will be returned if the "obj" is invalid.
+ * @param {object} obj
+ * @returns bool
+ */
 var isEmptyObject = function isEmptyObject(obj) {
   var name;
+  // eslint-disable-next-line
   for (name in obj) {
     return false;
   }
   return true;
 };
 
-export { generatorBase64Code, isEmptyObject, isNumber };
+export { generatorBase64Code, isEmpty, isEmptyObject };

package/es/constants/color.js

@@ -0,0 +1,16 @@
+var COLOR_GRADATION_OPTIONS = {
+  color_gradation_1: ['#FFFFFF', '#CAE9FF', '#9AC5FF', '#7DAAFF', '#5C90F9'],
+  color_gradation_2: ['#5C90F9', '#7DAAFF', '#9AC5FF', '#CAE9FF', '#FFFFFF'],
+  color_gradation_3: ['#FFFFFF', '#AAF7D2', '#74E6B6', '#42C090', '#17A675'],
+  color_gradation_4: ['#17A675', '#42C090', '#74E6B6', '#AAF7D2', '#FFFFFF'],
+  color_gradation_5: ['#FFFFFF', '#EBE2F1', '#D4C4E2', '#BFA8D4', '#A989C5'],
+  color_gradation_6: ['#A989C5', '#BFA8D4', '#D4C4E2', '#EBE2F1', '#FFFFFF'],
+  color_gradation_7: ['#FFFFFF', '#FBE2E1', '#F7C6C6', '#F3A9A9', '#F17F7E'],
+  color_gradation_8: ['#F17F7E', '#F3A9A9', '#F7C6C6', '#FBE2E1', '#FFFFFF'],
+  color_gradation_9: ['#FFFFFF', '#FFF2D4', '#FFE9B8', '#FFDD95', '#FFD470'],
+  color_gradation_10: ['#FFD470', '#FFDD95', '#FFE9B8', '#FFF2D4', '#FFFFFF'],
+  color_gradation_11: ['#FFFFFF', '#FEE6CE', '#FDD1A2', '#FDAD6B', '#FD8D3D'],
+  color_gradation_12: ['#FD8D3D', '#FDAD6B', '#FDD1A2', '#FEE6CE', '#FFFFFF']
+};
+
+export { COLOR_GRADATION_OPTIONS };

package/es/constants/column-permission.js

@@ -0,0 +1,7 @@
+var COLUMN_PERMISSION_TYPE = {
+  NONE: 'none',
+  ADMINS: 'admins',
+  SPECIFIC_USERS: 'specific_users'
+};
+
+export { COLUMN_PERMISSION_TYPE };