@builttocreate/engine-utils 2.6.0-beta.23 → 2.6.0-beta.25

package/dist/constants/PageTypes.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+/**
+ * Page Types
+ */
+var PageTypes = {
+  desktop: 'desktop',
+  mobile: 'mobile',
+  pdf: 'pdf'
+};
+var _default = PageTypes;
+exports["default"] = _default;

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.formatTableFieldPositions = exports.duplicateDocumentPage = exports.duplicate = exports["default"] = exports.cleanPageOrder = void 0;
+exports.sortPages = exports.sortFieldPositionsByXAndYCoordinates = exports.mergeAssoicatedFieldPositionsForMobilePage = exports.getPageOrder = exports.getMobileViewFromFile = exports.getDocumentFromTemplate = exports.getDefaultTemplate = exports.getDefaultJoyDocPage = exports.getDefaultJoyDocFile = exports.getDefaultJoyDoc = exports.getDefaultDocument = exports.getCleanedJoyDocPages = exports.getCleanedJoyDoc = exports.generatePDFPageFieldPositions = exports.generatePDFPage = exports.generateMobileViewFromFile = exports.generateMobilePageFieldPositions = exports.generateMobilePage = exports.formatTableFieldPositions = exports.duplicateDocumentPage = exports.duplicate = exports["default"] = exports.cleanPageOrder = void 0;
 
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
@@ -21,6 +21,8 @@ var _FieldPresentationModes = _interopRequireDefault(require("./constants/FieldP
 
 var _DocumentTypes = _interopRequireDefault(require("./constants/DocumentTypes"));
 
+var _PageTypes = _interopRequireDefault(require("./constants/PageTypes"));
+
 var _FieldTypes = _interopRequireDefault(require("./constants/FieldTypes"));
 
 var _FieldDisplayTypes = _interopRequireDefault(require("./constants/FieldDisplayTypes"));
@@ -646,11 +648,11 @@ var getMobileViewFromFile = function getMobileViewFromFile(file) {
       pageOrder: mobileViewPageOrder
     });
   } else {
-    return generateMobileViewFile(file);
+    return generateMobileViewFromFile(file);
   }
 };
 /**
- * Generate the mobile view and add specific mobile view properties
+ * Generates the alternative mobile view from the default file view.
  *
  * @param {Object} file //Full file object
  * @returns {Object}
@@ -659,7 +661,7 @@ var getMobileViewFromFile = function getMobileViewFromFile(file) {
 
 exports.getMobileViewFromFile = getMobileViewFromFile;
 
-var generateMobileViewFile = function generateMobileViewFile(file) {
+var generateMobileViewFromFile = function generateMobileViewFromFile(file) {
   var pages = file.pages || [];
   var pageOrder = cleanPageOrder(getPageOrder(file.pageOrder, file.pages), file.pages);
   return {
@@ -670,7 +672,7 @@ var generateMobileViewFile = function generateMobileViewFile(file) {
           name = page.name,
           identifier = page.identifier,
           fieldPositions = page.fieldPositions;
-      return generateMobileViewPage({
+      return generateMobilePage({
         _id: _id,
         identifier: identifier,
         name: name,
@@ -681,18 +683,19 @@ var generateMobileViewFile = function generateMobileViewFile(file) {
   };
 };
 /**
- * Apply the proper page defaults for a mobile view to existing page.
+ * Apply the pr
  *
  * @param {Object} page
  * @returns {Objectg}
  */
 
 
-exports.generateMobileViewFile = generateMobileViewFile;
+exports.generateMobileViewFromFile = generateMobileViewFromFile;
 
-var generateMobileViewPage = function generateMobileViewPage(page) {
+var generateMobilePage = function generateMobilePage(page) {
   return _objectSpread(_objectSpread({}, page), {}, {
-    fieldPositions: page.fieldPositions ? generateMobileViewPageFieldPositions(page.fieldPositions, page.rowHeight) : [],
+    fieldPositions: page.fieldPositions ? generateMobilePageFieldPositions(page.fieldPositions, page.rowHeight) : [],
+    type: _PageTypes["default"].mobile,
     rowHeight: 1,
     cols: 1,
     padding: 12,
@@ -703,9 +706,9 @@ var generateMobileViewPage = function generateMobileViewPage(page) {
   });
 };
 
-exports.generateMobileViewPage = generateMobileViewPage;
+exports.generateMobilePage = generateMobilePage;
 
-var generateMobileViewPageFieldPositions = function generateMobileViewPageFieldPositions(fieldPositions, originalRowHeight) {
+var generateMobilePageFieldPositions = function generateMobilePageFieldPositions(fieldPositions, originalRowHeight) {
   var mobileFieldPositions = [];
   /**
    * Step 1: Sort fieldPositions
@@ -728,7 +731,7 @@ var generateMobileViewPageFieldPositions = function generateMobileViewPageFieldP
     if (joySpecFieldPosition.type === _FieldTypes["default"].chart) mobileFieldPositionData.primaryDisplayOnly = true;
     mobileFieldPositions.push(mobileFieldPositionData);
   });
-  return mergeAssoicatedFieldPositionsForMobileView(mobileFieldPositions);
+  return mergeAssoicatedFieldPositionsForMobilePage(mobileFieldPositions);
 };
 /**
  * Merge Field Positions assoicated with the same Field.
@@ -746,9 +749,9 @@ var generateMobileViewPageFieldPositions = function generateMobileViewPageFieldP
  */
 
 
-exports.generateMobileViewPageFieldPositions = generateMobileViewPageFieldPositions;
+exports.generateMobilePageFieldPositions = generateMobilePageFieldPositions;
 
-var mergeAssoicatedFieldPositionsForMobileView = function mergeAssoicatedFieldPositionsForMobileView(fieldPositions) {
+var mergeAssoicatedFieldPositionsForMobilePage = function mergeAssoicatedFieldPositionsForMobilePage(fieldPositions) {
   var filteredFieldPositions = [];
   fieldPositions === null || fieldPositions === void 0 ? void 0 : fieldPositions.forEach(function (fieldPosition) {
     var fieldPositionIndex = filteredFieldPositions.findIndex(function (filtered) {
@@ -761,6 +764,52 @@ var mergeAssoicatedFieldPositionsForMobileView = function mergeAssoicatedFieldPo
   });
   return filteredFieldPositions;
 };
+/**
+ * Generate a page that targets the PDF page type
+ *
+ * @param {Object} page
+ * @returns {Objectg}
+ */
+
+
+exports.mergeAssoicatedFieldPositionsForMobilePage = mergeAssoicatedFieldPositionsForMobilePage;
+
+var generatePDFPage = function generatePDFPage(page) {
+  return _objectSpread(_objectSpread({}, page), {}, {
+    fieldPositions: page.fieldPositions ? generatePDFPageFieldPositions(page.fieldPositions) : [],
+    type: _PageTypes["default"].pdf,
+    width: 816,
+    height: 1056,
+    rowHeight: 1,
+    cols: 816,
+    layout: _PageLayoutModes["default"]["float"],
+    presentation: _FieldPresentationModes["default"].transparent,
+    padding: 0,
+    margin: 0,
+    borderWidth: 0
+  });
+};
+/**
+ * Generate a field positions for the PDF page type
+ *
+ * @param {Array} fieldPositions
+ * @returns {Array}
+ */
+
+
+exports.generatePDFPage = generatePDFPage;
+
+var generatePDFPageFieldPositions = function generatePDFPageFieldPositions(fieldPositions) {
+  return fieldPositions.map(function (joySpecFieldPosition) {
+    return _objectSpread(_objectSpread({}, joySpecFieldPosition), {}, {
+      titleDisplay: _FormStyleOptions["default"].displayNone,
+      padding: 0,
+      margin: 0,
+      borderRadius: 0,
+      borderWidth: 1
+    });
+  });
+};
 /**
  * Sort fields by their y and x coordinates
  *
@@ -788,7 +837,7 @@ var mergeAssoicatedFieldPositionsForMobileView = function mergeAssoicatedFieldPo
  */
 
 
-exports.mergeAssoicatedFieldPositionsForMobileView = mergeAssoicatedFieldPositionsForMobileView;
+exports.generatePDFPageFieldPositions = generatePDFPageFieldPositions;
 
 var sortFieldPositionsByXAndYCoordinates = function sortFieldPositionsByXAndYCoordinates(fieldPositions) {
   var sortedFieldPositions = (0, _toConsumableArray2["default"])(fieldPositions);
@@ -824,8 +873,7 @@ var formatTableFieldPositions = function formatTableFieldPositions(fieldPosition
    * We use these lookups because multiple table fieldPositions belonging to the same table
    * field will all use the same table value calculated lookup.
    */
-  var tableFieldLookups = {};
-  var tableFieldColumnLookups = {};
+  var tableFieldLookup = {};
   var nextFieldPositions = [];
   (0, _toConsumableArray2["default"])(fieldPositions).forEach(function (fieldPosition) {
     var nextFieldPosition = _objectSpread({}, fieldPosition);
@@ -839,37 +887,57 @@ var formatTableFieldPositions = function formatTableFieldPositions(fieldPosition
           rowOrder = fieldPosition.rowOrder,
           tableColumnOrder = fieldPosition.tableColumnOrder;
       /**
-       * Value will include deleted rows as well. We are removing the deleted rows
-       * since we want to compute the cellValue and calculatedCellValue only
-       * with undeleted table rows
+       * 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.
        */
 
-      var rows = (0, _tableHelper.getRows)(value);
-      var nextRowOrder = (0, _tableHelper.getRowOrder)(rowOrder, value);
+      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
+         */
 
-      if (!tableFieldColumnLookups[field]) {
-        var fieldColumnLookup = {};
-        (0, _tableHelper.getColumns)((0, _tableHelper.sortColumns)(tableColumns, tableColumnOrder)).forEach(function (column) {
-          return fieldColumnLookup[column._id] = column;
+        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;
         });
-        tableFieldColumnLookups[field] = fieldColumnLookup;
-      }
+        /**
+         * Step 1.3 Handle cell calculations
+         */
 
-      if (!tableFieldLookups[field]) {
-        var fieldTableLookup = (0, _tableHelper.generateTableLookup)(rows, (0, _tableHelper.sortColumns)(tableColumns, tableColumnOrder));
-        tableFieldLookups[field] = fieldTableLookup;
+        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 rowOrder
+       * Ensure each table field has a properly formatted properties
        */
 
 
-      if (!nextFieldPosition.rowOrder) nextFieldPosition.rowOrder = nextRowOrder;
+      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: '', ... }
        */
 
-      if (!nextFieldPosition.calculatedValue) nextFieldPosition.calculatedValue = tableFieldLookups[field];
+      nextFieldPosition.calculatedValue = tableFieldLookup[field].calculatedValue;
       /**
        * Individual Table Cell vs Entire Table
        *
@@ -891,8 +959,8 @@ var formatTableFieldPositions = function formatTableFieldPositions(fieldPosition
        * with it (ie rows[rowIndex] is undefined) it means that particular row is deleted
        */
 
-      if (tableFieldLookups[field] && column && typeof rowIndex === 'number') {
-        var _rows$targetRowIndex;
+      if (tableFieldLookup[field] && column && typeof rowIndex === 'number') {
+        var _tableFieldLookup$fie;
 
         /**
          * What is the difference between rowIndex and targetRowIndex?
@@ -905,10 +973,10 @@ var formatTableFieldPositions = function formatTableFieldPositions(fieldPosition
          * 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 = tableFieldColumnLookups[field][column];
-        var targetRowId = nextRowOrder[rowIndex];
-        var targetRowIndex = rows.findIndex(function (row) {
-          return row._id === targetRowId;
+        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
@@ -921,10 +989,14 @@ var formatTableFieldPositions = function formatTableFieldPositions(fieldPosition
          * at the particular rowIndex was deleted
         */
 
-        nextFieldPosition.cellValue = ((_rows$targetRowIndex = rows[targetRowIndex]) === null || _rows$targetRowIndex === void 0 ? void 0 : _rows$targetRowIndex.cells[column]) || ''; //targetColumn will appear as undefined if a column is 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 = tableFieldLookups[field]["".concat(targetColumn.operand).concat(targetRowIndex + 1)];
+          nextFieldPosition.calculatedCellValue = tableFieldLookup[field].calculatedValue["".concat(targetColumn.operand).concat(targetRowIndex + 1)];
           nextFieldPosition.columnType = targetColumn.type;
           nextFieldPosition.options = targetColumn.options;
           nextFieldPosition.columnIdentifier = targetColumn.identifier;
@@ -962,10 +1034,12 @@ var _default = {
   getPageOrder: getPageOrder,
   sortPages: sortPages,
   sortFieldPositionsByXAndYCoordinates: sortFieldPositionsByXAndYCoordinates,
-  mergeAssoicatedFieldPositionsForMobileView: mergeAssoicatedFieldPositionsForMobileView,
-  generateMobileViewFile: generateMobileViewFile,
-  generateMobileViewPage: generateMobileViewPage,
-  generateMobileViewPageFieldPositions: generateMobileViewPageFieldPositions,
+  mergeAssoicatedFieldPositionsForMobilePage: mergeAssoicatedFieldPositionsForMobilePage,
+  generateMobileViewFromFile: generateMobileViewFromFile,
+  generateMobilePage: generateMobilePage,
+  generateMobilePageFieldPositions: generateMobilePageFieldPositions,
+  generatePDFPage: generatePDFPage,
+  generatePDFPageFieldPositions: generatePDFPageFieldPositions,
   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;

package/package.json

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