@cosmotech/core 1.7.1 → 1.9.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## **1.9.0** <sub><sup>2022-07-22 (aedf63f...3ee8718)</sup></sub>
+
+### Features
+
+- implement scenarioIsValid function ([06d23d8](https://github.com/Cosmo-Tech/webapp-component-core/commit/06d23d8))
+
+### Bug Fixes
+
+- fix error during parsing of CSV strings when columns list is undefined ([a72b5b5](https://github.com/Cosmo-Tech/webapp-component-core/commit/a72b5b5))
+
+## **1.8.0** <sub><sup>2022-05-09 (5d61a0e...5317d94)</sup></sub>
+
+### Features
+
+- support empty fields in table component ([5d61a0e](https://github.com/Cosmo-Tech/webapp-component-core/commit/5d61a0e))
+
+## **1.7.2** <sub><sup>2022-04-29</sup></sub>
+
+- update dependencies
+- remove unnecessary dependencies @babel/cli, @babel/preset-react and typescript
+
 ## **1.7.1** <sub><sup>2022-04-04</sup></sub>
 
 - update dependencies

package/dist/index.cjs.js

@@ -20042,7 +20042,7 @@ var _castCellValueToStr = cellValue => {
 };
 
 var read = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator(function* (fileBlob, forceStr) {
+  var _ref = _asyncToGenerator(function* (fileBlob, forceStr, emptyCols) {
     var data;
 
     try {
@@ -20050,7 +20050,10 @@ var read = /*#__PURE__*/function () {
       var workbook = readSync(buffer);
       var worksheetName = workbook.SheetNames[0];
       var worksheet = workbook.Sheets[worksheetName];
-      data = utils.sheet_to_json(worksheet, {
+      data = utils.sheet_to_json(worksheet, emptyCols ? {
+        header: 1,
+        defval: ''
+      } : {
         header: 1
       });
     } catch (err) {
@@ -20066,7 +20069,7 @@ var read = /*#__PURE__*/function () {
     return data;
   });
 
-  return function read(_x, _x2) {
+  return function read(_x, _x2, _x3) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -31952,7 +31955,13 @@ var isString = data => {
   return typeof data === 'string';
 };
 
-var isValid = (dataStr, type, options) => {
+var isValid = function isValid(dataStr, type, options) {
+  var canBeEmpty = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+
+  if (canBeEmpty && dataStr === '') {
+    return true;
+  }
+
   switch (type) {
     case 'bool':
       return isBool(dataStr);
@@ -32013,9 +32022,9 @@ class Error$1 {
 }
 
 var _buildColumnsCountError = (missingColsCount, rowIndex, expectedColsCount, colsCount, expectedColsName, row) => {
-  var errorSummary = "Missing column".concat(missingColsCount > 1 ? 's' : '');
+  var errorSummary = "Missing field".concat(missingColsCount > 1 ? 's' : '');
   var errorLoc = "Line ".concat(rowIndex);
-  var errorContext = "".concat(errorSummary, " (").concat(errorLoc, ") : ").concat(expectedColsCount, " columns expected, ") + "but only ".concat(colsCount, " column").concat(colsCount > 1 ? 's' : '', " found\n") + "Expected data format : \"".concat(expectedColsName, "\"\n") + "Incorrect Row : \"".concat(row, "\"");
+  var errorContext = "".concat(errorSummary, " (").concat(errorLoc, ") : ").concat(expectedColsCount, " fields expected, ") + "but only ".concat(colsCount, " field").concat(colsCount > 1 ? 's' : '', " found\n") + "Expected data format : \"".concat(expectedColsName, "\"\n") + "Incorrect Row : \"".concat(row, "\"");
   return new Error$1(errorSummary, errorLoc, errorContext);
 };
 
@@ -32039,7 +32048,7 @@ var DEFAULT_CSV_EXPORT_OPTIONS = {
 };
 
 var _forgeColumnsCountError = (row, rowIndex, expectedCols) => {
-  var colsCount = row.length;
+  var colsCount = Object.values(row).filter(el => el !== undefined).length;
   var expectedColsCount = expectedCols.length;
   var expectedColsName = expectedCols.map(col => col.field).join();
   var missingColsCount = expectedColsCount - colsCount;
@@ -32085,7 +32094,7 @@ var _validateFormat = (rows, hasHeader, cols, options) => {
   var _loop = function _loop(rowIndex) {
     var row = rows[rowIndex];
 
-    if (row.length < knownColsCount) {
+    if (row.length < knownColsCount || row.includes(undefined)) {
       errors.push(_forgeColumnsCountError(rows[rowIndex], rowIndex, colsData));
     }
 
@@ -32093,8 +32102,8 @@ var _validateFormat = (rows, hasHeader, cols, options) => {
       if (colIndex < knownColsCount) {
         var colType = colsData[colIndex].type;
 
-        if (colType) {
-          var _colsData$colIndex, _colsData$colIndex2, _colsData$colIndex2$c;
+        if (colType && rowCell !== undefined) {
+          var _colsData$colIndex, _colsData$colIndex2, _colsData$colIndex2$c, _colsData$colIndex$ce, _colsData$colIndex$ce2;
 
           var enumValues = ((_colsData$colIndex = colsData[colIndex]) === null || _colsData$colIndex === void 0 ? void 0 : _colsData$colIndex.enumValues) || ((_colsData$colIndex2 = colsData[colIndex]) === null || _colsData$colIndex2 === void 0 ? void 0 : (_colsData$colIndex2$c = _colsData$colIndex2.cellEditorParams) === null || _colsData$colIndex2$c === void 0 ? void 0 : _colsData$colIndex2$c.enumValues);
 
@@ -32102,7 +32111,9 @@ var _validateFormat = (rows, hasHeader, cols, options) => {
             enumValues: enumValues
           });
 
-          if (!ValidationUtils.isValid(rowCell, colType, colOptions)) {
+          var acceptsEmptyFields = (_colsData$colIndex$ce = (_colsData$colIndex$ce2 = colsData[colIndex].cellEditorParams) === null || _colsData$colIndex$ce2 === void 0 ? void 0 : _colsData$colIndex$ce2.acceptsEmptyFields) !== null && _colsData$colIndex$ce !== void 0 ? _colsData$colIndex$ce : false;
+
+          if (!ValidationUtils.isValid(rowCell, colType, colOptions, acceptsEmptyFields)) {
             errors.push(_forgeTypeError(rowCell, rowIndex, colType, colOptions, colsData, colIndex));
           }
         }
@@ -32125,8 +32136,6 @@ var _reformatBoolValue = csvCellValue => {
   } else if (['1', 'true', 'yes'].includes(csvCellValue)) {
     return 'true';
   }
-
-  return null;
 };
 
 var _reformatValue = (csvCellValue, colTypes) => {
@@ -32141,6 +32150,22 @@ var _buildCols = header => header.map(col => ({
   field: col
 }));
 
+var _calculateEmptyCols = cols => {
+  if (cols === undefined) {
+    return [];
+  }
+
+  return cols.map((_, index) => index).filter(colIndex => {
+    var _cols$colIndex$cellEd;
+
+    return (_cols$colIndex$cellEd = cols[colIndex].cellEditorParams) === null || _cols$colIndex$cellEd === void 0 ? void 0 : _cols$colIndex$cellEd.acceptsEmptyFields;
+  });
+};
+
+var _processTableToTransformNonAcceptableEmptyCols = (lines, emptyCols) => {
+  return lines.map(line => line.map((cell, index) => cell === '' && !emptyCols.includes(index) ? undefined : cell));
+};
+
 var _buildRows = (rows, hasHeader, cols) => {
   var formattedData = [];
   var startIndex = hasHeader ? 1 : 0;
@@ -32180,8 +32205,10 @@ var fromCSV = function fromCSV(dataStr) {
   var rows = [];
   var csvLines;
 
+  var emptyCols = _calculateEmptyCols(cols);
+
   try {
-    csvLines = CSVUtils.read(dataStr);
+    csvLines = _processTableToTransformNonAcceptableEmptyCols(CSVUtils.read(dataStr), emptyCols);
   } catch (err) {
     return {
       error: [err]
@@ -32270,8 +32297,11 @@ var fromXLSX = /*#__PURE__*/function () {
     var rows = [];
     var xlsxLines;
 
+    var emptyCols = _calculateEmptyCols(cols);
+
     try {
-      xlsxLines = yield XLSXUtils.read(fileBlob, true);
+      xlsxLines = yield XLSXUtils.read(fileBlob, true, emptyCols.length > 0);
+      if (emptyCols.length > 0) xlsxLines = _processTableToTransformNonAcceptableEmptyCols(xlsxLines, emptyCols);
     } catch (err) {
       return {
         error: [new Error$1((err === null || err === void 0 ? void 0 : err.message) || err, fileBlob.name, (err === null || err === void 0 ? void 0 : err.stack) || null)]
@@ -32689,6 +32719,10 @@ var DatasetUtils = {
 
 // Copyright (c) Cosmo Tech.
 // Licensed under the MIT license.
+var NAME_VALIDATOR = /^[a-zA-Z0-9][\w\s.-]*$/;
+
+// Copyright (c) Cosmo Tech.
+
 var scenarioExistsInList = (scenarioName, scenarioList) => {
   scenarioName = scenarioName.trim();
   return scenarioList.find(scenario => scenario.name.trim() === scenarioName) !== undefined;
@@ -32708,6 +32742,22 @@ var scenarioExistsInTree = (scenarioName, scenarioTree) => {
   return treeSearch(scenarioTree);
 };
 
+var scenarioNameIsValid = (scenarioName, scenarioList) => {
+  scenarioName = scenarioName.trimEnd();
+
+  if (scenarioName.length === 0) {
+    return 'emptyScenarioName';
+  } else {
+    if (scenarioName.match(NAME_VALIDATOR) === null) {
+      return 'forbiddenCharsInScenarioName';
+    } else if (scenarioExistsInList(scenarioName, scenarioList)) {
+      return 'existingScenarioName';
+    }
+  }
+
+  return null;
+};
+
 var getScenarioTree = (scenarioList, compareFn) => {
   var scenarioTree = []; // Sort scenario list based on optional user-defined function
 
@@ -32751,6 +32801,7 @@ function countScenariosInTree(treeData) {
 var ScenarioUtils = {
   scenarioExistsInList,
   scenarioExistsInTree,
+  scenarioNameIsValid,
   getScenarioTree,
   countScenariosInTree
 };

package/dist/index.esm.js

@@ -20034,7 +20034,7 @@ var _castCellValueToStr = cellValue => {
 };
 
 var read = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator(function* (fileBlob, forceStr) {
+  var _ref = _asyncToGenerator(function* (fileBlob, forceStr, emptyCols) {
     var data;
 
     try {
@@ -20042,7 +20042,10 @@ var read = /*#__PURE__*/function () {
       var workbook = readSync(buffer);
       var worksheetName = workbook.SheetNames[0];
       var worksheet = workbook.Sheets[worksheetName];
-      data = utils.sheet_to_json(worksheet, {
+      data = utils.sheet_to_json(worksheet, emptyCols ? {
+        header: 1,
+        defval: ''
+      } : {
         header: 1
       });
     } catch (err) {
@@ -20058,7 +20061,7 @@ var read = /*#__PURE__*/function () {
     return data;
   });
 
-  return function read(_x, _x2) {
+  return function read(_x, _x2, _x3) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -31944,7 +31947,13 @@ var isString = data => {
   return typeof data === 'string';
 };
 
-var isValid = (dataStr, type, options) => {
+var isValid = function isValid(dataStr, type, options) {
+  var canBeEmpty = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+
+  if (canBeEmpty && dataStr === '') {
+    return true;
+  }
+
   switch (type) {
     case 'bool':
       return isBool(dataStr);
@@ -32005,9 +32014,9 @@ class Error$1 {
 }
 
 var _buildColumnsCountError = (missingColsCount, rowIndex, expectedColsCount, colsCount, expectedColsName, row) => {
-  var errorSummary = "Missing column".concat(missingColsCount > 1 ? 's' : '');
+  var errorSummary = "Missing field".concat(missingColsCount > 1 ? 's' : '');
   var errorLoc = "Line ".concat(rowIndex);
-  var errorContext = "".concat(errorSummary, " (").concat(errorLoc, ") : ").concat(expectedColsCount, " columns expected, ") + "but only ".concat(colsCount, " column").concat(colsCount > 1 ? 's' : '', " found\n") + "Expected data format : \"".concat(expectedColsName, "\"\n") + "Incorrect Row : \"".concat(row, "\"");
+  var errorContext = "".concat(errorSummary, " (").concat(errorLoc, ") : ").concat(expectedColsCount, " fields expected, ") + "but only ".concat(colsCount, " field").concat(colsCount > 1 ? 's' : '', " found\n") + "Expected data format : \"".concat(expectedColsName, "\"\n") + "Incorrect Row : \"".concat(row, "\"");
   return new Error$1(errorSummary, errorLoc, errorContext);
 };
 
@@ -32031,7 +32040,7 @@ var DEFAULT_CSV_EXPORT_OPTIONS = {
 };
 
 var _forgeColumnsCountError = (row, rowIndex, expectedCols) => {
-  var colsCount = row.length;
+  var colsCount = Object.values(row).filter(el => el !== undefined).length;
   var expectedColsCount = expectedCols.length;
   var expectedColsName = expectedCols.map(col => col.field).join();
   var missingColsCount = expectedColsCount - colsCount;
@@ -32077,7 +32086,7 @@ var _validateFormat = (rows, hasHeader, cols, options) => {
   var _loop = function _loop(rowIndex) {
     var row = rows[rowIndex];
 
-    if (row.length < knownColsCount) {
+    if (row.length < knownColsCount || row.includes(undefined)) {
       errors.push(_forgeColumnsCountError(rows[rowIndex], rowIndex, colsData));
     }
 
@@ -32085,8 +32094,8 @@ var _validateFormat = (rows, hasHeader, cols, options) => {
       if (colIndex < knownColsCount) {
         var colType = colsData[colIndex].type;
 
-        if (colType) {
-          var _colsData$colIndex, _colsData$colIndex2, _colsData$colIndex2$c;
+        if (colType && rowCell !== undefined) {
+          var _colsData$colIndex, _colsData$colIndex2, _colsData$colIndex2$c, _colsData$colIndex$ce, _colsData$colIndex$ce2;
 
           var enumValues = ((_colsData$colIndex = colsData[colIndex]) === null || _colsData$colIndex === void 0 ? void 0 : _colsData$colIndex.enumValues) || ((_colsData$colIndex2 = colsData[colIndex]) === null || _colsData$colIndex2 === void 0 ? void 0 : (_colsData$colIndex2$c = _colsData$colIndex2.cellEditorParams) === null || _colsData$colIndex2$c === void 0 ? void 0 : _colsData$colIndex2$c.enumValues);
 
@@ -32094,7 +32103,9 @@ var _validateFormat = (rows, hasHeader, cols, options) => {
             enumValues: enumValues
           });
 
-          if (!ValidationUtils.isValid(rowCell, colType, colOptions)) {
+          var acceptsEmptyFields = (_colsData$colIndex$ce = (_colsData$colIndex$ce2 = colsData[colIndex].cellEditorParams) === null || _colsData$colIndex$ce2 === void 0 ? void 0 : _colsData$colIndex$ce2.acceptsEmptyFields) !== null && _colsData$colIndex$ce !== void 0 ? _colsData$colIndex$ce : false;
+
+          if (!ValidationUtils.isValid(rowCell, colType, colOptions, acceptsEmptyFields)) {
             errors.push(_forgeTypeError(rowCell, rowIndex, colType, colOptions, colsData, colIndex));
           }
         }
@@ -32117,8 +32128,6 @@ var _reformatBoolValue = csvCellValue => {
   } else if (['1', 'true', 'yes'].includes(csvCellValue)) {
     return 'true';
   }
-
-  return null;
 };
 
 var _reformatValue = (csvCellValue, colTypes) => {
@@ -32133,6 +32142,22 @@ var _buildCols = header => header.map(col => ({
   field: col
 }));
 
+var _calculateEmptyCols = cols => {
+  if (cols === undefined) {
+    return [];
+  }
+
+  return cols.map((_, index) => index).filter(colIndex => {
+    var _cols$colIndex$cellEd;
+
+    return (_cols$colIndex$cellEd = cols[colIndex].cellEditorParams) === null || _cols$colIndex$cellEd === void 0 ? void 0 : _cols$colIndex$cellEd.acceptsEmptyFields;
+  });
+};
+
+var _processTableToTransformNonAcceptableEmptyCols = (lines, emptyCols) => {
+  return lines.map(line => line.map((cell, index) => cell === '' && !emptyCols.includes(index) ? undefined : cell));
+};
+
 var _buildRows = (rows, hasHeader, cols) => {
   var formattedData = [];
   var startIndex = hasHeader ? 1 : 0;
@@ -32172,8 +32197,10 @@ var fromCSV = function fromCSV(dataStr) {
   var rows = [];
   var csvLines;
 
+  var emptyCols = _calculateEmptyCols(cols);
+
   try {
-    csvLines = CSVUtils.read(dataStr);
+    csvLines = _processTableToTransformNonAcceptableEmptyCols(CSVUtils.read(dataStr), emptyCols);
   } catch (err) {
     return {
       error: [err]
@@ -32262,8 +32289,11 @@ var fromXLSX = /*#__PURE__*/function () {
     var rows = [];
     var xlsxLines;
 
+    var emptyCols = _calculateEmptyCols(cols);
+
     try {
-      xlsxLines = yield XLSXUtils.read(fileBlob, true);
+      xlsxLines = yield XLSXUtils.read(fileBlob, true, emptyCols.length > 0);
+      if (emptyCols.length > 0) xlsxLines = _processTableToTransformNonAcceptableEmptyCols(xlsxLines, emptyCols);
     } catch (err) {
       return {
         error: [new Error$1((err === null || err === void 0 ? void 0 : err.message) || err, fileBlob.name, (err === null || err === void 0 ? void 0 : err.stack) || null)]
@@ -32681,6 +32711,10 @@ var DatasetUtils = {
 
 // Copyright (c) Cosmo Tech.
 // Licensed under the MIT license.
+var NAME_VALIDATOR = /^[a-zA-Z0-9][\w\s.-]*$/;
+
+// Copyright (c) Cosmo Tech.
+
 var scenarioExistsInList = (scenarioName, scenarioList) => {
   scenarioName = scenarioName.trim();
   return scenarioList.find(scenario => scenario.name.trim() === scenarioName) !== undefined;
@@ -32700,6 +32734,22 @@ var scenarioExistsInTree = (scenarioName, scenarioTree) => {
   return treeSearch(scenarioTree);
 };
 
+var scenarioNameIsValid = (scenarioName, scenarioList) => {
+  scenarioName = scenarioName.trimEnd();
+
+  if (scenarioName.length === 0) {
+    return 'emptyScenarioName';
+  } else {
+    if (scenarioName.match(NAME_VALIDATOR) === null) {
+      return 'forbiddenCharsInScenarioName';
+    } else if (scenarioExistsInList(scenarioName, scenarioList)) {
+      return 'existingScenarioName';
+    }
+  }
+
+  return null;
+};
+
 var getScenarioTree = (scenarioList, compareFn) => {
   var scenarioTree = []; // Sort scenario list based on optional user-defined function
 
@@ -32743,6 +32793,7 @@ function countScenariosInTree(treeData) {
 var ScenarioUtils = {
   scenarioExistsInList,
   scenarioExistsInTree,
+  scenarioNameIsValid,
   getScenarioTree,
   countScenariosInTree
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cosmotech/core",
   "private": false,
-  "version": "1.7.1",
+  "version": "1.9.0",
   "description": "",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
@@ -11,12 +11,6 @@
     "test": "jest --watchAll=false",
     "prettier": "npx prettier -w"
   },
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Cosmo-Tech/webapp-component-core.git"
@@ -31,10 +25,8 @@
     "fs": false
   },
   "devDependencies": {
-    "@babel/cli": "^7.14.3",
     "@babel/core": "^7.14.3",
     "@babel/preset-env": "^7.14.2",
-    "@babel/preset-react": "^7.12.10",
     "@rollup/plugin-babel": "^5.2.2",
     "@rollup/plugin-commonjs": "^21.0.0",
     "@rollup/plugin-image": "^2.0.5",
@@ -53,8 +45,7 @@
     "rollup": "^2.49.0",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-postcss": "^4.0.0",
-    "rollup-plugin-visualizer": "^5.5.0",
-    "typescript": "^4.4.4"
+    "rollup-plugin-visualizer": "^5.5.0"
   },
   "dependencies": {
     "csv-string": "^4.0.1",