@builttocreate/engine-utils 2.6.0-beta.22 → 2.6.0-beta.24

package/dist/joyDocHelper.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sortPages = exports.sortFieldPositionsByXAndYCoordinates = exports.mergeAssoicatedFieldPositionsForMobileView = exports.getPageOrder = exports.getMobileViewFromFile = exports.getDocumentFromTemplate = exports.getDefaultTemplate = exports.getDefaultJoyDocPage = exports.getDefaultJoyDocFile = exports.getDefaultJoyDoc = exports.getDefaultDocument = exports.getCleanedJoyDocPages = exports.getCleanedJoyDoc = exports.generateMobileViewPageFieldPositions = exports.generateMobileViewPage = exports.generateMobileViewFile = exports.duplicateDocumentPage = exports.duplicate = exports["default"] = exports.cleanPageOrder = void 0;
+exports.sortPages = exports.sortFieldPositionsByXAndYCoordinates = exports.mergeAssoicatedFieldPositionsForMobileView = exports.getPageOrder = exports.getMobileViewFromFile = exports.getDocumentFromTemplate = exports.getDefaultTemplate = exports.getDefaultJoyDocPage = exports.getDefaultJoyDocFile = exports.getDefaultJoyDoc = exports.getDefaultDocument = exports.getCleanedJoyDocPages = exports.getCleanedJoyDoc = exports.generateMobileViewPageFieldPositions = exports.generateMobileViewPage = exports.generateMobileViewFile = exports.formatTableFieldPositions = exports.duplicateDocumentPage = exports.duplicate = exports["default"] = exports.cleanPageOrder = void 0;
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
@@ -805,8 +805,172 @@ var sortFieldPositionsByXAndYCoordinates = function sortFieldPositionsByXAndYCoo
   });
   return sortedFieldPositions;
 };
+/**
+ * Formats individual table cell field positions that have already been merged with their associated field.
+ * This additional information is added and used for rendering the fieldPositions on the form.
+ *
+ * For instance, adds properties like columnType, calculatedCellValue, options, etc.
+ *
+ * @param {Array} fieldPositions
+ * @returns {Array}
+ */
+
 
 exports.sortFieldPositionsByXAndYCoordinates = sortFieldPositionsByXAndYCoordinates;
+
+var formatTableFieldPositions = function formatTableFieldPositions(fieldPositions) {
+  /**
+   * We only want to generate the table value calculated lookup for each table field once.
+   * We use these lookups because multiple table fieldPositions belonging to the same table
+   * field will all use the same table value calculated lookup.
+   */
+  var tableFieldLookup = {};
+  var nextFieldPositions = [];
+  (0, _toConsumableArray2["default"])(fieldPositions).forEach(function (fieldPosition) {
+    var nextFieldPosition = _objectSpread({}, fieldPosition);
+
+    if (fieldPosition.type === _FieldTypes["default"].table) {
+      var field = fieldPosition.field,
+          column = fieldPosition.column,
+          rowIndex = fieldPosition.rowIndex,
+          tableColumns = fieldPosition.tableColumns,
+          value = fieldPosition.value,
+          rowOrder = fieldPosition.rowOrder,
+          tableColumnOrder = fieldPosition.tableColumnOrder;
+      /**
+       * Step 1: Generate rows, rowOrder, tableColumns, etc. lookups for associated field. We only have to
+       * do this once per-field. This increases performance if there are multiple form positions associated
+       * with the same form.
+       */
+
+      if (!tableFieldLookup[field]) {
+        /**
+         * Step 1.1 Handle rows
+         */
+        var nextRows = (0, _tableHelper.getRows)(value);
+        var nextRowOrder = (0, _tableHelper.getCleanedRowOrder)(rowOrder, nextRows);
+        var nextSortedRows = (0, _tableHelper.sortRows)(nextRows, nextRowOrder);
+        /**
+         * Step 1.2 Handle columns
+         */
+
+        var nextTableColumnOrder = (0, _tableHelper.getCleanedColumnOrder)(tableColumnOrder, tableColumns);
+        var nextSortedTableColumns = (0, _tableHelper.sortColumns)(tableColumns, nextTableColumnOrder);
+        var nextTableColumns = (0, _tableHelper.getColumns)(nextSortedTableColumns);
+        var nextTableColumnLookup = {};
+        nextTableColumns.forEach(function (column) {
+          return nextTableColumnLookup[column._id] = column;
+        });
+        /**
+         * Step 1.3 Handle cell calculations
+         */
+
+        var calculatedValue = (0, _tableHelper.generateTableLookup)(nextSortedRows, nextSortedTableColumns);
+        tableFieldLookup[field] = {
+          value: nextSortedRows,
+          rowOrder: nextRowOrder,
+          tableColumns: nextTableColumns,
+          tableColumnOrder: nextTableColumnOrder,
+          tableColumnLookup: nextTableColumnLookup,
+          calculatedValue: calculatedValue
+        };
+      }
+      /**
+       * Ensure each table field has a properly formatted properties
+       */
+
+
+      nextFieldPosition.value = tableFieldLookup[field].value;
+      nextFieldPosition.rowOrder = tableFieldLookup[field].rowOrder;
+      nextFieldPosition.tableColumns = tableFieldLookup[field].tableColumns;
+      nextFieldPosition.tableColumnOrder = tableFieldLookup[field].tableColumnOrder;
+      /**
+       * Add calculated value lookup. For instance, { A1: '', B1: '', C1: '', ... }
+       */
+
+      nextFieldPosition.calculatedValue = tableFieldLookup[field].calculatedValue;
+      /**
+       * Individual Table Cell vs Entire Table
+       *
+       * Only add cellValue, calculatedCellValue, columnType, and column options to
+       * individually mapped table cell fieldPositions. Regular table fields (entire table)
+       * just simply use the fieldPositions.value parameter so we don't need the calculated
+       * values, etc.
+       *
+       * We determine an individual table cell fieldPosition vs an entire table
+       * fieldPosition by checking for column and rowIndex. Individual cells have
+       * column and rowIndex but regular tables do not.
+       *
+       * Note:
+       * rowIndex + 1 is used while calculating cell value since column operands
+       * start from 1 instead of zero in the table lookups
+       * (ie: [A1:{}, B1:{}] instead of [A0:{}, B0:{}])
+       *
+       * If tableRowIndex associated with a cell doesn't have a table row associated
+       * with it (ie rows[rowIndex] is undefined) it means that particular row is deleted
+       */
+
+      if (tableFieldLookup[field] && column && typeof rowIndex === 'number') {
+        var _tableFieldLookup$fie;
+
+        /**
+         * What is the difference between rowIndex and targetRowIndex?
+         *
+         * - The rowIndex on the fieldPosition is the saved index of where the rowId lives inside of the rowOrder.
+         * - The targetRowIndex is the actual index of the row object inside the value (array of row data) of the field.
+         *
+         * We use the fieldPosition.rowIndex to get the rowId from the rowOrder. Then we use the rowId to locate
+         * the assoicated row object data in the value property. The rowOrder and value (rows) do not follow the same
+         * order. The rowOrder is updated when users insert rows, move rows up or down, etc. it manages where rows
+         * are at in the list and how they should be rendered. This is why the rowIndex uses the rowOrder.
+         */
+        var targetColumn = tableFieldLookup[field].tableColumnLookup[column];
+        var targetRowId = tableFieldLookup[field].rowOrder[rowIndex];
+        var targetRowIndex = tableFieldLookup[field].value.findIndex(function (row) {
+          return (row === null || row === void 0 ? void 0 : row._id) === targetRowId;
+        });
+        /**
+         * Add proper rowId to the field position so that it can be used
+         * inside the element for change handlers;
+         */
+
+        nextFieldPosition.rowId = targetRowId;
+        /**
+         * If rows[rowIndex] is undefined, it means the row that was present
+         * at the particular rowIndex was deleted
+        */
+
+        nextFieldPosition.cellValue = ((_tableFieldLookup$fie = tableFieldLookup[field].value[targetRowIndex]) === null || _tableFieldLookup$fie === void 0 ? void 0 : _tableFieldLookup$fie.cells[column]) || '';
+        /**
+         * Skip any individual field position that is associated with a deleted column.
+         * targetColumn will appear as undefined if a column is deleted
+         */
+
+        if (targetColumn) {
+          nextFieldPosition.calculatedCellValue = tableFieldLookup[field].calculatedValue["".concat(targetColumn.operand).concat(targetRowIndex + 1)];
+          nextFieldPosition.columnType = targetColumn.type;
+          nextFieldPosition.options = targetColumn.options;
+          nextFieldPosition.columnIdentifier = targetColumn.identifier;
+          /**
+           * IMPORTANT NOTE: We only add individual table cell field position into
+           * the fieldPosition list if the associated column is not deleted.
+           */
+
+          nextFieldPositions.push(nextFieldPosition);
+        }
+      } else {
+        //Push table fields with original display type
+        nextFieldPositions.push(nextFieldPosition);
+      }
+    } else {
+      //Push other fields
+      nextFieldPositions.push(nextFieldPosition);
+    }
+  });
+  return nextFieldPositions;
+};
+
+exports.formatTableFieldPositions = formatTableFieldPositions;
 var _default = {
   getDefaultJoyDocPage: getDefaultJoyDocPage,
   getDefaultJoyDocFile: getDefaultJoyDocFile,
@@ -824,6 +988,7 @@ var _default = {
   mergeAssoicatedFieldPositionsForMobileView: mergeAssoicatedFieldPositionsForMobileView,
   generateMobileViewFile: generateMobileViewFile,
   generateMobileViewPage: generateMobileViewPage,
-  generateMobileViewPageFieldPositions: generateMobileViewPageFieldPositions
+  generateMobileViewPageFieldPositions: generateMobileViewPageFieldPositions,
+  formatTableFieldPositions: formatTableFieldPositions
 };
 exports["default"] = _default;

package/dist/tableHelper.js

@@ -7,7 +7,7 @@ var _typeof3 = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.validFormulaString = exports.spreadOperandRange = exports.sortRows = exports.sortColumns = exports.resolveOperandValue = exports.hasOperandRange = exports.hasCircularOperandReference = exports.handleTableCellChange = exports.handleMoveTableRowUp = exports.handleMoveTableRowDown = exports.handleMoveColumnRight = exports.handleMoveColumnLeft = exports.handleInsertTableRow = exports.handleDuplicateTableRow = exports.handleCreateTableRow = exports.getTemplateColumnOperandLookup = exports.getTargetColumnWithOperand = exports.getTableRowLookupWithPopulatedDropdownCells = exports.getTableFieldRowOrder = exports.getTableFieldLookupKey = exports.getRows = exports.getRowOrder = exports.getRowMap = exports.getRowIndexLookup = exports.getInputGroupRowLookupWithPopulatedDropdownCells = exports.getIndexesFromTableCellOperand = exports.getFormulaResult = exports.getFilteredRowOrder = exports.getDefaultTextColumn = exports.getDefaultRow = exports.getDefaultImageColumn = exports.getDefaultDropdownColumn = exports.getDefaultColumnOption = exports.getColumns = exports.getColumnOrder = exports.getColumnOperand = exports.getCleanedRowOrder = exports.getCellOperand = exports.generateTableLookupForRows = exports.generateTableLookup = exports.generateTableFieldLookups = exports.generateRowTableLookup = exports.generateInputGroupFields = exports["default"] = void 0;
+exports.validFormulaString = exports.spreadOperandRange = exports.sortRows = exports.sortColumns = exports.resolveOperandValue = exports.hasOperandRange = exports.hasCircularOperandReference = exports.handleTableCellChange = exports.handleMoveTableRowUp = exports.handleMoveTableRowDown = exports.handleMoveColumnRight = exports.handleMoveColumnLeft = exports.handleInsertTableRow = exports.handleDuplicateTableRow = exports.handleCreateTableRow = exports.getTemplateColumnOperandLookup = exports.getTargetColumnWithOperand = exports.getTableRowLookupWithPopulatedDropdownCells = exports.getTableFieldRowOrder = exports.getTableFieldLookupKey = exports.getRows = exports.getRowOrder = exports.getRowMap = exports.getRowIndexLookup = exports.getInputGroupRowLookupWithPopulatedDropdownCells = exports.getIndexesFromTableCellOperand = exports.getFormulaResult = exports.getFilteredRowOrder = exports.getDefaultTextColumn = exports.getDefaultRow = exports.getDefaultImageColumn = exports.getDefaultDropdownColumn = exports.getDefaultColumnOption = exports.getColumns = exports.getColumnOrder = exports.getColumnOperand = exports.getCleanedRowOrder = exports.getCleanedColumnOrder = exports.getCellOperand = exports.generateTableLookupForRows = exports.generateTableLookup = exports.generateTableFieldLookups = exports.generateRowTableLookup = exports.generateInputGroupFields = exports["default"] = void 0;
 
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
@@ -386,12 +386,60 @@ var getColumnOrder = function getColumnOrder(columnOrder, columns) {
     return column._id;
   });
 };
+/**
+ * This method removes the columnIds of the deleted columns (or) any duplicate columnIds
+ * from the tableColumnOrder there by returning a cleaned tableColumnOrder
+ *
+ * @param {*} tableColumnOrder
+ * @param {*} tableColumns
+ *
+ * @returns {Array}
+**/
+
+
+exports.getColumnOrder = getColumnOrder;
+
+var getCleanedColumnOrder = function getCleanedColumnOrder(columnOrder, columns) {
+  var nextColumnOrder = [];
+  /**
+   * Step 1: Handle generating or retrieving proper column order.
+   */
+
+  if (columnOrder && columnOrder.length > 0) {
+    nextColumnOrder = columnOrder;
+  } else if (columns && columns.length > 0) {
+    columns.forEach(function (column) {
+      if (!column.deleted) nextColumnOrder.push(column._id);
+    });
+  }
+  /**
+   * Step 2: Remove column Ids from columnOrder for columns that no longer exist or have been deleted
+   */
+
+
+  var columnLookup = {};
+  columns.forEach(function (column) {
+    return columnLookup[column._id] = column && !column.deleted;
+  });
+  nextColumnOrder = nextColumnOrder.filter(function (columnId) {
+    return columnLookup[columnId];
+  });
+  /**
+   * Step 3: Remove any duplicate column Id references in the column order.
+   */
+
+  var filteredNextColumnOrder = [];
+  nextColumnOrder.forEach(function (columnId) {
+    if (columnId && filteredNextColumnOrder.indexOf(columnId) === -1) filteredNextColumnOrder.push(columnId);
+  });
+  return filteredNextColumnOrder;
+};
 /**
  * Get table columns with added operands. Operands are the A, B, C, etc.
  */
 
 
-exports.getColumnOrder = getColumnOrder;
+exports.getCleanedColumnOrder = getCleanedColumnOrder;
 
 var getColumns = function getColumns(columns) {
   var parsedColumns = columns;
@@ -698,7 +746,9 @@ var generateTableLookup = function generateTableLookup(rows, columns) {
       if (!column.operand) return;
       var cellKey = "".concat(column.operand).concat(rowIndex + 1);
       var cellRawValue = row.cells[column._id] ? row.cells[column._id] : undefined;
-      var cellValue = cellRawValue && typeof cellRawValue === 'string' ? cellRawValue.trim() : undefined;
+      var cellValue;
+      if (cellRawValue && typeof cellRawValue === 'string') cellValue = cellRawValue.trim();
+      if (cellRawValue && typeof cellRawValue === 'number') cellValue = cellRawValue.toString();
       var formulaCell = cellValue !== undefined && cellValue.charAt(0) === '=';
       var containsOperands = cellValue !== undefined && cellValue.match(/[A-Z]([0-9]{1,10})/gi);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builttocreate/engine-utils",
-  "version": "2.6.0-beta.22",
+  "version": "2.6.0-beta.24",
   "description": "Utility library for common logic shared across web and mobile",
   "main": "dist/index.js",
   "files": [