@builttocreate/engine-utils 1.7.1 → 1.8.1-rc.1.0.0

package/dist/activityHelper.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = exports.getFormattedActivity = void 0;
+exports["default"] = exports.addDocumentDataToActivities = exports.getFormattedActivity = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -65,9 +65,93 @@ var getFormattedActivity = function getFormattedActivity(comments, deficiencies,
   });
   return activity;
 };
+/**
+ *
+ * Template should be a template that is using the new getTemplateWithLookups
+ */
+
 
 exports.getFormattedActivity = getFormattedActivity;
+
+var addDocumentDataToActivities = function addDocumentDataToActivities(activities, doc, template) {
+  var fieldLookup = template && template.fieldLookup ? template.fieldLookup : null;
+  var fieldValues = doc && doc.fields ? doc.fields : null;
+  if (!activities || activities.length < 1 || !fieldLookup || !fieldValues) return activities;
+  var fieldRowLookups = {};
+  var fieldRowIndexLookups = {};
+  var nextActivities = [];
+  activities.forEach(function (activity) {
+    var nextActivity = _objectSpread({}, activity);
+
+    if (activity.document && activity.document._id && activity.document.field) {
+      var docFieldValue = fieldValues[activity.document.field];
+      var templateField = templateFieldLookup[activity.document.field];
+      var templateFieldColumn = templateFieldLookup.tableColumnLookup[activity.document.column];
+      nextActivity.document.title = templateField.title;
+      nextActivity.document.type = templateField.type;
+      nextActivity.document.columns = templateField.tableColumns;
+
+      if (docFieldValue && templateField.type === FieldTypes.table) {
+        /**
+         * Table Step 1: create an easy way to lookup a row with the dropdown cells populated.
+         *
+         * We only need to generate the row lookup once per field to help increase performance,
+         * just incase we have other deficiencies that reference the same table field.
+         */
+        if (!fieldRowsLookup[templateField._id]) {
+          fieldRowsLookup[templateField._id] = getRowLookupWithPopulatedDropdownCells(docFieldValue);
+        }
+        /**
+         * Table Step 2: create an easy way to lookup a row index so we can use it in our row 
+         * display component. 
+         *
+         * We only need to generate the row index lookup once per field to help increase performance,
+         * just incase we have other deficiencies that reference the same table field.
+         */
+
+
+        if (!fieldRowIndexLookup[templateField._id]) {
+          fieldRowIndexLookup[templateField._id] = getRowIndexLookup(templateField._id, template.fieldSettings, docFieldValue);
+        }
+
+        ;
+        /**
+         * Table Step 3: Add row and rowIndex to the activity.document object for easy reference.
+         *
+         * nextActivity.document.value will now contain the single row object with all cell values populated ready to be displayed
+         */
+
+        nextActivity.document.value = fieldRowsLookup[activity.document.field][activity.document.row];
+        nextActivity.document.rowIndex = fieldRowIndexLookup[activity.document.field][activity.document.row];
+      } else if (docFieldValue && templateField.type === FieldTypes.inputGroup) {
+        /**
+         * Input Group Step 1: create an easy way to lookup a row with the dropdown cells populated.
+         *
+         * We only need to generate the row lookup once per field (since input groups are just rows) 
+         * to help increase performance, just incase we have other deficiencies that reference the same table field.
+         */
+        if (fieldRowsLookup[templateField._id]) fieldRowsLookup[templateField._id] = getRowLookupWithPopulatedDropdownCells(docFieldValue);
+        /**
+         * Input Group Step 2: Add invidual row.cell value. We only add the invidual cell value and not the 
+         * whole row because input group display components are treated like regular field and not like table rows.
+         */
+
+        nextActivity.document.value = fieldRowsLookup[activity.document.field][activity.document.row].cells[templateFieldColumn._id];
+      } //This should handle adding the display value for selection and regular input fields
+      else {
+          var option = templateField.optionsLookup[docFieldValue];
+          nextActivity.document.value = option && option.value ? option.value : docFieldValue;
+        }
+    }
+
+    nextActivities.push(nextActivity);
+  });
+  return nextActivities;
+};
+
+exports.addDocumentDataToActivities = addDocumentDataToActivities;
 var _default = {
-  getFormattedActivity: getFormattedActivity
+  getFormattedActivity: getFormattedActivity,
+  addDocumentDataToDeficiencyActivities: addDocumentDataToDeficiencyActivities
 };
 exports["default"] = _default;

package/dist/changedKeys.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+/**
+ * See what keys have changed between two objects.
+ *
+ * Used primarily right now to compare what props have changed for
+ * a react component.
+ *
+ * @param {Object} o1
+ * @param {Object} o2
+ *
+ * @returns {Array}
+ */
+var changedKeys = function changedKeys() {
+  var o1 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  var o2 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var o1Keys = Object.keys(o1);
+  var o2Keys = Object.keys(o2);
+  var keys = [];
+  o1Keys.forEach(function (key) {
+    if (keys.indexOf(key) === -1) keys.push(key);
+  });
+  o2Keys.forEach(function (key) {
+    if (keys.indexOf(key) === -1) keys.push(key);
+  });
+  return keys.filter(function (key) {
+    return o1[key] !== o2[key];
+  });
+};
+
+var _default = changedKeys;
+exports["default"] = _default;

package/dist/fieldHelper.js

@@ -5,7 +5,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = exports.getImportFieldValues = exports.getDefaultFieldValuesFromTemplate = exports.getMultiSelectFieldValue = exports.getChartFieldValue = void 0;
+exports["default"] = exports.getTemplateWithLookups = exports.getImportFieldValues = exports.getDefaultFieldValuesFromTemplate = exports.getMultiSelectFieldValue = exports.getChartFieldValue = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -177,8 +177,51 @@ var getImportFieldValues = function getImportFieldValues(template, importSource,
   });
   return fields;
 };
+/**
+ *  Generate options and table column lookups for template fields
+ * @param {} template 
+ * @returns 
+ */
+
 
 exports.getImportFieldValues = getImportFieldValues;
+
+var getTemplateWithLookups = function getTemplateWithLookups(template) {
+  var nextTemplate = _objectSpread({}, template);
+
+  nextTemplate.fields = template.fields.map(function (field) {
+    var nextField = _objectSpread({}, field);
+
+    if (nextField.options) {
+      nextField.optionsLookup = {};
+      nextField.options.forEach(function (option) {
+        return nextField.optionsLookup[option._id] = option;
+      });
+    }
+
+    if (nextField.tableColumns) {
+      nextField.tableColumnsLookup = {};
+      nextField.tableColumns.forEach(function (column) {
+        var nextColumn = _objectSpread(_objectSpread({}, column), {}, {
+          optionsLookup: {}
+        });
+
+        if (nextColumn.options) {
+          nextColumn.options.forEach(function (option) {
+            return nextColumn.optionsLookup[option._id] = option;
+          });
+        }
+
+        nextField.tableColumnsLookup[nextColumn._id] = nextColumn;
+      });
+    }
+
+    return nextField;
+  });
+  return nextTemplate;
+};
+
+exports.getTemplateWithLookups = getTemplateWithLookups;
 var _default = {
   getChartFieldValue: getChartFieldValue,
   getMultiSelectFieldValue: getMultiSelectFieldValue,

package/dist/index.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
 
 Object.defineProperty(exports, "__esModule", {
@@ -17,6 +19,12 @@ Object.defineProperty(exports, "CALL_API", {
     return _reduxApiMiddleware.CALL_API;
   }
 });
+Object.defineProperty(exports, "changedKeys", {
+  enumerable: true,
+  get: function get() {
+    return _changedKeys["default"];
+  }
+});
 exports.paginationHelper = exports.fileHelper = exports.activityHelper = exports.fieldHelper = exports.chartHelper = exports.tableHelper = exports["default"] = void 0;
 
 var tableHelper = _interopRequireWildcard(require("./tableHelper"));
@@ -44,6 +52,9 @@ var _reduxApiMiddleware = _interopRequireWildcard(require("./reduxApiMiddleware"
 var paginationHelper = _interopRequireWildcard(require("./paginationHelper"));
 
 exports.paginationHelper = paginationHelper;
+
+var _changedKeys = _interopRequireDefault(require("./changedKeys"));
+
 var _default = {
   fileHelper: fileHelper,
   tableHelper: tableHelper,
@@ -52,6 +63,7 @@ var _default = {
   activityHelper: activityHelper,
   reduxApiMiddleware: _reduxApiMiddleware["default"],
   CALL_API: _reduxApiMiddleware.CALL_API,
-  paginationHelper: paginationHelper
+  paginationHelper: paginationHelper,
+  changedKeys: _changedKeys["default"]
 };
 exports["default"] = _default;

package/dist/tableHelper.js

@@ -7,7 +7,7 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = exports.handleMoveTableRowDown = exports.handleMoveTableRowUp = exports.handleDuplicateTableRow = exports.handleCreateTableRow = exports.handleInsertTableRow = exports.handleTableCellChange = exports.generateInputGroupFields = exports.spreadOperandRange = exports.validFormulaString = exports.hasOperandRange = exports.hasCircularOperandReference = exports.resolveOperandValue = exports.getFormulaResult = exports.generateTableLookup = exports.generateTableLookupForRows = exports.generateTableFieldLookups = exports.generateRowTableLookup = exports.getCellOperand = exports.getTemplateColumnOperandLookup = exports.getIndexesFromTableCellOperand = exports.getColumnOperand = exports.getColumns = exports.getTableFieldRowOrder = exports.getRowMap = exports.getFilteredRowOrder = exports.sortRows = exports.getRows = exports.getDefaultRow = exports.getTableFieldLookupKey = void 0;
+exports["default"] = exports.handleMoveTableRowDown = exports.handleMoveTableRowUp = exports.handleDuplicateTableRow = exports.handleCreateTableRow = exports.handleInsertTableRow = exports.handleTableCellChange = exports.getRowIndexLookup = exports.getRowLookupWithPopulatedDropdownCells = exports.generateInputGroupFields = exports.spreadOperandRange = exports.validFormulaString = exports.hasOperandRange = exports.hasCircularOperandReference = exports.resolveOperandValue = exports.getFormulaResult = exports.generateTableLookup = exports.generateTableLookupForRows = exports.generateTableFieldLookups = exports.generateRowTableLookup = exports.getCellOperand = exports.getTemplateColumnOperandLookup = exports.getIndexesFromTableCellOperand = exports.getColumnOperand = exports.getColumns = exports.getTableFieldRowOrder = exports.getRowMap = exports.getFilteredRowOrder = exports.sortRows = exports.getRows = exports.getDefaultRow = exports.getTableFieldLookupKey = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -712,6 +712,55 @@ var generateInputGroupFields = function generateInputGroupFields(field, columns)
   });
   return tableReferences;
 };
+/**
+ * Populate row cells with dropdown display values:
+ * @param {*} columns 
+ * @param {*} rows 
+ * @returns 
+ */
+//Columns should have the options lookup already populated
+
+
+exports.generateInputGroupFields = generateInputGroupFields;
+
+var getRowLookupWithPopulatedDropdownCells = function getRowLookupWithPopulatedDropdownCells(columns, rows) {
+  var rowsLookup = {};
+  var validRows = getRows(rows);
+  validRows.forEach(function (row) {
+    var nextRow = _objectSpread(_objectSpread({}, row), {}, {
+      cells: _objectSpread({}, row.cells)
+    });
+
+    columns.forEach(function (column) {
+      var optionId = nextRow.cells[columnId];
+
+      if (cellValue && column.type === _FieldTableColumnTypes["default"].dropdown) {
+        nextRow.cells[columnId] = column.optionsLookup[optionId] ? column.optionsLookup[optionId].value : optionId;
+      }
+    });
+    rowsLookup[nextRow._id] = nextRow;
+  });
+  return rowsLookup;
+};
+/**
+ * Generate row index lookup:
+ * @param {*} fieldId 
+ * @param {*} fieldSettings 
+ * @param {*} rows 
+ * @returns 
+ */
+
+
+exports.getRowLookupWithPopulatedDropdownCells = getRowLookupWithPopulatedDropdownCells;
+
+var getRowIndexLookup = function getRowIndexLookup(fieldId, fieldSettings, rows) {
+  var rowOrder = getTableFieldRowOrder(fieldId, fieldSettings, rows);
+  var rowIndexLookup = {};
+  rowOrder.forEach(function (rowId, index) {
+    rowIndexLookup[rowId] = index;
+  });
+  return rowIndexLookup;
+};
 /**
  * Handle Table Cell Change
  *
@@ -723,7 +772,7 @@ var generateInputGroupFields = function generateInputGroupFields(field, columns)
  */
 
 
-exports.generateInputGroupFields = generateInputGroupFields;
+exports.getRowIndexLookup = getRowIndexLookup;
 
 var handleTableCellChange = function handleTableCellChange(rows, rowId, columnId, val, callback) {
   var targetRowIndex = rows.findIndex(function (row) {
@@ -858,6 +907,8 @@ var _default = {
   spreadOperandRange: spreadOperandRange,
   getTableFieldLookupKey: getTableFieldLookupKey,
   getTableFieldRowOrder: getTableFieldRowOrder,
+  getRowLookupWithPopulatedDropdownCells: getRowLookupWithPopulatedDropdownCells,
+  getRowIndexLookup: getRowIndexLookup,
   handleTableCellChange: handleTableCellChange,
   handleInsertTableRow: handleInsertTableRow,
   handleCreateTableRow: handleCreateTableRow,

package/package.json

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