@builttocreate/engine-utils 2.10.0 → 2.10.1-beta.1286

package/README.md

@@ -1,6 +1,6 @@
-# engine-utils
-
-Node: v18
-Package Manager: NPM
-
-Utility library for common logic shared across web and mobile
+# engine-utils
+
+Node: v18
+Package Manager: NPM
+
+Utility library for common logic shared across web and mobile

package/dist/activityHelper.js

@@ -57,9 +57,9 @@ var getFormattedActivity = exports.getFormattedActivity = function getFormattedA
   return activity;
 };
 
-/**
- *
- * Template should be a template that is using the new getTemplateWithLookups
+/**
+ *
+ * Template should be a template that is using the new getTemplateWithLookups
  */
 var addDocumentDataToActivities = exports.addDocumentDataToActivities = function addDocumentDataToActivities(activities, doc, template) {
   var templateFieldLookup = {};
@@ -83,38 +83,38 @@ var addDocumentDataToActivities = exports.addDocumentDataToActivities = function
       nextActivity.document.type = templateField.type;
       nextActivity.document.columns = templateField.tableColumns;
       if (docFieldValue && templateField.type === _FieldTypes["default"].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.
+        /**
+         * 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.
          */
 
-        /**
-         * Removing deleted rows from doc field value
-         * Added as a fix for table bug that did not display proper output for formula cells
-         *  as rowIndex was messy
+        /**
+         * Removing deleted rows from doc field value
+         * Added as a fix for table bug that did not display proper output for formula cells
+         *  as rowIndex was messy
          */
         var nextDocFieldValue = (0, _tableHelper.getRows)(docFieldValue);
         if (!fieldRowsLookup[templateField._id]) {
           fieldRowsLookup[templateField._id] = (0, _tableHelper.getTableRowLookupWithPopulatedDropdownCells)(templateField.tableColumns, nextDocFieldValue);
         }
 
-        /**
-         * 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.
+        /**
+         * 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] = (0, _tableHelper.getRowIndexLookup)(templateField._id, 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
+        /**
+         * 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
          */
 
         if (fieldRowsLookup[activity.document.field] && fieldRowIndexLookup[activity.document.field]) {
@@ -122,17 +122,17 @@ var addDocumentDataToActivities = exports.addDocumentDataToActivities = function
           nextActivity.document.rowIndex = fieldRowIndexLookup[activity.document.field][activity.document.row];
         }
       } else if (docFieldValue && templateField.type === _FieldTypes["default"].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.
+        /**
+         * 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] = (0, _tableHelper.getInputGroupRowLookupWithPopulatedDropdownCells)(templateField.tableColumns, 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.
+        /**
+         * 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.
          */
 
         if (fieldRowsLookup[activity.document.field] && fieldRowsLookup[activity.document.field][activity.document.row] && fieldRowsLookup[activity.document.field][activity.document.row].cells[activity.document.column]) {

package/dist/changedKeys.js

@@ -4,16 +4,16 @@ 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}
+/**
+ * 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] : {};

package/dist/chartHelper.js

@@ -7,11 +7,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.getDefaultLinePoint = exports.getDefaultLine = exports["default"] = void 0;
 var _generateObjectId = _interopRequireDefault(require("./generateObjectId"));
 var getDefaultLine = exports.getDefaultLine = function getDefaultLine() {
-  /**
-  * Why do we add more than 1 points by default to the new line?
-  *
-  * There is bug with victory-native that will throw an error if
-  * there aren't two data points in the array.
+  /**
+  * Why do we add more than 1 points by default to the new line?
+  *
+  * There is bug with victory-native that will throw an error if
+  * there aren't two data points in the array.
   */
   return {
     _id: (0, _generateObjectId["default"])(),

package/dist/constants/FieldDisplayTypes.js

@@ -4,20 +4,20 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-/**
- * Are we displaying the entire original field
- *
- * For instance, if displayType is original for a table field then we are
- * displaying the entire component. If it is text,
- * circle, square, etc. then that means we are
- * only displaying an invidiual mapped cell from
- * the table or input group. Same is true for dropdown and multi-select fields.
+/**
+ * Are we displaying the entire original field
+ *
+ * For instance, if displayType is original for a table field then we are
+ * displaying the entire component. If it is text,
+ * circle, square, etc. then that means we are
+ * only displaying an invidiual mapped cell from
+ * the table or input group. Same is true for dropdown and multi-select fields.
  */
 var original = 'original';
 
-/**
- * Meant to be used as original display type but horizontal.
- * Primarily used for multi-select field right now.
+/**
+ * Meant to be used as original display type but horizontal.
+ * Primarily used for multi-select field right now.
  */
 var horizontal = 'horizontal';
 

package/dist/constants/FieldPresentationModes.js

@@ -4,11 +4,11 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.transparent = exports.normal = exports["default"] = void 0;
-/**
- * Page field style modes
- *
- * Used to to determine how a field
- * should be presented on the form.
+/**
+ * Page field style modes
+ *
+ * Used to to determine how a field
+ * should be presented on the form.
  */
 var normal = exports.normal = 'normal';
 var transparent = exports.transparent = 'transparent';

package/dist/constants/PageLayoutModes.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-/**
- * Page layout modes
+/**
+ * Page layout modes
  */
 var grid = 'grid';
 var _float = 'float';

package/dist/constants/PageTypes.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-/**
- * Page Types
+/**
+ * Page Types
  */
 var PageTypes = {
   desktop: 'desktop',

package/dist/constants/Roles.js

@@ -4,13 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-/**
- * Role Types:
- *
- * admin - They can do everything
- * contributor - They can do everything, except modify users or templates
- * readyOnly - They can see all but can't do anything.
- * restricted - They can only see the stuff they authored. They don't have access to any other users stuff.
+/**
+ * Role Types:
+ *
+ * admin - They can do everything
+ * contributor - They can do everything, except modify users or templates
+ * readyOnly - They can see all but can't do anything.
+ * restricted - They can only see the stuff they authored. They don't have access to any other users stuff.
  */
 var roles = {
   admin: {

package/dist/fieldHelper.js

@@ -14,10 +14,10 @@ var _generateObjectId = _interopRequireDefault(require("./generateObjectId"));
 var _FieldTypes = _interopRequireDefault(require("./constants/FieldTypes"));
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2["default"])(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-/**
- * Get chart field line data
- *
- * @param (String|Object) value
+/**
+ * Get chart field line data
+ *
+ * @param (String|Object) value
  */
 var getChartFieldValue = exports.getChartFieldValue = function getChartFieldValue(value) {
   var parsedData = value || [];
@@ -32,13 +32,13 @@ var getChartFieldValue = exports.getChartFieldValue = function getChartFieldValu
   return (0, _toConsumableArray2["default"])(parsedData);
 };
 
-/**
- * Get default option
- *
- * These options are primarily used by dropdown and selection fields
- *
- * @param {String} value
- * @return {Object}
+/**
+ * Get default option
+ *
+ * These options are primarily used by dropdown and selection fields
+ *
+ * @param {String} value
+ * @return {Object}
  */
 var getDefaultOption = exports.getDefaultOption = function getDefaultOption(value) {
   return {
@@ -48,11 +48,11 @@ var getDefaultOption = exports.getDefaultOption = function getDefaultOption(valu
   };
 };
 
-/**
- * Get multiselect field value
- *
- * @param (String|Array) value
- * @return Array
+/**
+ * Get multiselect field value
+ *
+ * @param (String|Array) value
+ * @return Array
  */
 var getMultiSelectFieldValue = exports.getMultiSelectFieldValue = function getMultiSelectFieldValue(value) {
   if (value && typeof value === 'string') {
@@ -64,12 +64,12 @@ var getMultiSelectFieldValue = exports.getMultiSelectFieldValue = function getMu
   }
 };
 
-/**
- * Update the selected options.
- *
- * @param (Bool) multi
- * @param (Array) selectedOptions //[optionId, optionId, ...]
- * @param (String) optionId //Option that is being toggled
+/**
+ * Update the selected options.
+ *
+ * @param (Bool) multi
+ * @param (Array) selectedOptions //[optionId, optionId, ...]
+ * @param (String) optionId //Option that is being toggled
  */
 var handleMultiSelectOptionToggle = exports.handleMultiSelectOptionToggle = function handleMultiSelectOptionToggle(multi) {
   var selectedOptions = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
@@ -93,11 +93,11 @@ var handleMultiSelectOptionToggle = exports.handleMultiSelectOptionToggle = func
   return nextSelection;
 };
 
-/**
- * Get default field values from template
- *
- * @param {Object} template
- * @param {String} defaultUserId
+/**
+ * Get default field values from template
+ *
+ * @param {Object} template
+ * @param {String} defaultUserId
  */
 var getDefaultFieldValuesFromTemplate = exports.getDefaultFieldValuesFromTemplate = function getDefaultFieldValuesFromTemplate(template, defaultUserId) {
   var fields = {};
@@ -134,12 +134,12 @@ var getDefaultFieldValuesFromTemplate = exports.getDefaultFieldValuesFromTemplat
   return fields;
 };
 
-/**
- * Get import field values from source document for target document
- *
- * @param {Object} template
- * @param {Object} importSource //Document source you're importing
- * @param {Object} importTarget //Document that is having it's fields overwritten by import source
+/**
+ * Get import field values from source document for target document
+ *
+ * @param {Object} template
+ * @param {Object} importSource //Document source you're importing
+ * @param {Object} importTarget //Document that is having it's fields overwritten by import source
  */
 var getImportFieldValues = exports.getImportFieldValues = function getImportFieldValues(template, importSource, importTarget) {
   var fields = {};
@@ -160,20 +160,20 @@ var getImportFieldValues = exports.getImportFieldValues = function getImportFiel
           cells: {}
         });
         field.tableColumns.forEach(function (column) {
-          /**
-           * Option 1: Add cell value from source document
+          /**
+           * Option 1: Add cell value from source document
            */
           if (!column.blockImport) {
             newRow.cells[column._id] = row.cells[column._id] || '';
           }
-          /**
-           * Option 2: If column has block import enabled then maintain any values
-           * already set in the importTarget document.
+          /**
+           * Option 2: If column has block import enabled then maintain any values
+           * already set in the importTarget document.
            */else if (column.blockImport && currentDocRows[i] && currentDocRows[i].cells[column._id]) {
             newRow.cells[column._id] = currentDocRows[i].cells[column._id];
           }
-          /**
-           * Option 3: If column has block import enabled then add default column value
+          /**
+           * Option 3: If column has block import enabled then add default column value
            */else if (column.blockImport && column.value) {
             newRow.cells[column._id] = column.value;
           }
@@ -192,12 +192,12 @@ var getImportFieldValues = exports.getImportFieldValues = function getImportFiel
   return fields;
 };
 
-/**
- *  Generate optionsLookup  and fieldLookup for template fields
- * Note: Options lookup will be used by dropdown, mutliSelect, table and inputGroup fields
- * to display value in dropdowns
- * @param {} template
- * @returns template
+/**
+ *  Generate optionsLookup  and fieldLookup for template fields
+ * Note: Options lookup will be used by dropdown, mutliSelect, table and inputGroup fields
+ * to display value in dropdowns
+ * @param {} template
+ * @returns template
  */
 
 var getTemplateWithLookups = exports.getTemplateWithLookups = function getTemplateWithLookups(template) {
@@ -232,11 +232,11 @@ var getTemplateWithLookups = exports.getTemplateWithLookups = function getTempla
   return nextTemplate;
 };
 
-/**
- * This method checks if the field passed via input is empty by checking
- * the field.value.
- * @param {*} fieldProps
- * @returns
+/**
+ * This method checks if the field passed via input is empty by checking
+ * the field.value.
+ * @param {*} fieldProps
+ * @returns
  */
 
 var isFieldEmpty = exports.isFieldEmpty = function isFieldEmpty(fieldType, fieldValue, fieldOptions) {
@@ -273,18 +273,18 @@ var isFieldEmpty = exports.isFieldEmpty = function isFieldEmpty(fieldType, field
   return isEmpty;
 };
 
-/**
- * This function checks whether an option associated with multiselect or dropdown
- * field is deleted.
- * @param {*} value // value
- * @param {*} options
+/**
+ * This function checks whether an option associated with multiselect or dropdown
+ * field is deleted.
+ * @param {*} value // value
+ * @param {*} options
  */
 var isTargetOptionDeleted = exports.isTargetOptionDeleted = function isTargetOptionDeleted(value, options) {
-  /***
-   * We are converting the value that is passed in to array since
-   * this method is used by dropdown field and multiSelect field
-   * Dropdown passes the value as a string  whereas mutliselect passes
-   * the value as an array
+  /***
+   * We are converting the value that is passed in to array since
+   * this method is used by dropdown field and multiSelect field
+   * Dropdown passes the value as a string  whereas mutliselect passes
+   * the value as an array
    */
   var nextValue = Array.isArray(value) ? value : [value];
   if (!nextValue || nextValue.length === 0) return true;

package/dist/index.js

@@ -66,7 +66,8 @@ var _changedKeys = _interopRequireDefault(require("./changedKeys"));
 var _Roles = _interopRequireDefault(require("./constants/Roles"));
 var _generateObjectId = _interopRequireDefault(require("./generateObjectId"));
 var _validateObjectId = _interopRequireDefault(require("./validateObjectId"));
-function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { "default": e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) { if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } } return n["default"] = e, t && t.set(e, n), n; }
 var _default = exports["default"] = {
   fileHelper: fileHelper,
   tableHelper: tableHelper,