@builttocreate/engine-utils 1.24.0 → 2.0.0

package/dist/fieldHelper.js

@@ -7,10 +7,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.handleMultiSelectOptionToggle = exports.getTemplateWithLookups = exports.getMultiSelectFieldValue = exports.getImportFieldValues = exports.getDefaultOption = exports.getDefaultFieldValuesFromTemplate = exports.getChartFieldValue = exports["default"] = void 0;
 
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
 
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
 var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
 var _FieldTypes = _interopRequireDefault(require("./constants/FieldTypes"));
@@ -45,25 +45,6 @@ var getChartFieldValue = function getChartFieldValue(value) {
 
   return (0, _toConsumableArray2["default"])(parsedData);
 };
-/**
- * Get multiselect field value
- *
- * @param (String|Array) value
- * @return Array
- */
-
-
-exports.getChartFieldValue = getChartFieldValue;
-
-var getMultiSelectFieldValue = function getMultiSelectFieldValue(value) {
-  if (value && typeof value === 'string') {
-    return value.replace(/\s/g, '').split(',');
-  } else if (value && (0, _typeof2["default"])(value) === 'object') {
-    return (0, _toConsumableArray2["default"])(value);
-  } else {
-    return [];
-  }
-};
 /**
  * Get default option
  *
@@ -74,7 +55,7 @@ var getMultiSelectFieldValue = function getMultiSelectFieldValue(value) {
  */
 
 
-exports.getMultiSelectFieldValue = getMultiSelectFieldValue;
+exports.getChartFieldValue = getChartFieldValue;
 
 var getDefaultOption = function getDefaultOption(value) {
   return {
@@ -83,6 +64,25 @@ var getDefaultOption = function getDefaultOption(value) {
     deleted: false
   };
 };
+/**
+ * Get multiselect field value
+ *
+ * @param (String|Array) value
+ * @return Array
+ */
+
+
+exports.getDefaultOption = getDefaultOption;
+
+var getMultiSelectFieldValue = function getMultiSelectFieldValue(value) {
+  if (value && typeof value === 'string') {
+    return value.replace(/\s/g, '').split(','); //Legacy (document v1) support for multiSelect value
+  } else if (value && Array.isArray(value)) {
+    return (0, _toConsumableArray2["default"])(value);
+  } else {
+    return [];
+  }
+};
 /**
  * Update the selected options.
  *
@@ -92,7 +92,7 @@ var getDefaultOption = function getDefaultOption(value) {
  */
 
 
-exports.getDefaultOption = getDefaultOption;
+exports.getMultiSelectFieldValue = getMultiSelectFieldValue;
 
 var handleMultiSelectOptionToggle = function handleMultiSelectOptionToggle(multi) {
   var selectedOptions = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
@@ -100,19 +100,22 @@ var handleMultiSelectOptionToggle = function handleMultiSelectOptionToggle(multi
   var nextSelection = (0, _toConsumableArray2["default"])(selectedOptions);
   var optionIndex = nextSelection.indexOf(optionId);
 
-  if (optionIndex !== -1) {
-    nextSelection.splice(optionIndex, 1);
-  } else if (multi) {
-    nextSelection.push(optionId);
-  } else {
-    nextSelection = [optionId];
-  }
-
   if (multi) {
-    return nextSelection;
+    if (optionIndex !== -1) {
+      nextSelection.splice(optionIndex, 1);
+    } else if (multi) {
+      nextSelection.push(optionId);
+    }
   } else {
-    return nextSelection[0] || '';
+    //Not multi
+    if (optionIndex !== -1) {
+      nextSelection = [];
+    } else {
+      nextSelection = [optionId];
+    }
   }
+
+  return nextSelection;
 };
 /**
  * Get default field values from template

package/dist/joyDocHelper.js

@@ -5,12 +5,14 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getDefaultJoyDocPage = exports.getDefaultJoyDocFile = exports.getDefaultJoyDoc = exports["default"] = void 0;
+exports.getDefaultJoyDocPage = exports.getDefaultJoyDocFile = exports.getDefaultJoyDoc = exports.getCleanedJoyDocPages = exports.getCleanedJoyDoc = exports["default"] = void 0;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
 var _generateObjectId = _interopRequireDefault(require("./generateObjectId"));
 
+var _validateObjectId = _interopRequireDefault(require("./validateObjectId"));
+
 var _PageLayoutModes = _interopRequireDefault(require("./constants/PageLayoutModes"));
 
 var _FieldPresentationModes = _interopRequireDefault(require("./constants/FieldPresentationModes"));
@@ -34,7 +36,7 @@ var getDefaultJoyDocPage = function getDefaultJoyDocPage() {
     height: 1056,
     rowHeight: 8,
     cols: 24,
-    fields: [],
+    fieldPositions: [],
     layout: _PageLayoutModes["default"].grid,
     presentation: _FieldPresentationModes["default"].normal
   }, defaults);
@@ -81,14 +83,129 @@ var getDefaultJoyDoc = function getDefaultJoyDoc() {
     _id: id,
     identifier: "doc_".concat(id),
     name: 'New Doc',
-    files: [getDefaultJoyDocFile(fileDefaults, pageDefaults)]
+    files: [getDefaultJoyDocFile(fileDefaults, pageDefaults)],
+    fields: []
   }, defaults);
 };
+/**
+ * Get Clean JoyDoc Format
+ *
+ * Solves Issue: https://app.zenhub.com/workspaces/joyfill-platform-5f07262b507391001f56c7f9/issues/gh/zionlabs/issues/2105
+ *
+ * This selector ensures a couple of things:
+ * 1. Valid file inside the document.
+ * 2. Valid page inside document file.
+ * 3. All _id's (page, file, page, fieldPosition, field) are in a valid format
+ *
+ * @param {Object} doc
+ * @returns {Object}
+ */
+
 
 exports.getDefaultJoyDoc = getDefaultJoyDoc;
+
+var getCleanedJoyDoc = function getCleanedJoyDoc(doc) {
+  if (!doc) return getDefaultJoyDoc();
+
+  var nextDoc = _objectSpread({}, doc);
+  /**
+   * Step 1.1: Replace doc._id if it is not valid
+   */
+
+
+  if (nextDoc._id && !(0, _validateObjectId["default"])(nextDoc._id)) nextDoc._id = (0, _generateObjectId["default"])();
+
+  if (nextDoc.files && nextDoc.files.length > 0) {
+    nextDoc.files = nextDoc.files.map(function (file) {
+      var _nextFile$views;
+
+      var nextFile = _objectSpread({}, file);
+      /**
+      * Step 1.2: Replace files[x]._id if it is not valid
+      */
+
+
+      if (nextFile._id && !(0, _validateObjectId["default"])(nextFile._id)) nextFile._id = (0, _generateObjectId["default"])();
+      /**
+      * Step 1.3: Replace page ids and field ids if they are not valid
+      */
+
+      nextFile.pages = getCleanedJoyDocPages(nextFile.pages);
+      /**
+      * Step 1.4: Replace view page ids and field ids if they are not valid
+      */
+
+      if ((nextFile === null || nextFile === void 0 ? void 0 : (_nextFile$views = nextFile.views) === null || _nextFile$views === void 0 ? void 0 : _nextFile$views.length) > 0) {
+        nextFile.views = nextFile.views.map(function (view) {
+          var nextView = _objectSpread({}, view);
+
+          nextView.pages = getCleanedJoyDocPages(nextView.pages);
+          return nextView;
+        });
+      }
+
+      return nextFile;
+    });
+  } else {
+    nextDoc.files = [getDefaultJoyDocFile()];
+  }
+
+  return nextDoc;
+};
+/**
+ * Get Cleaned JoyDoc Pages
+ *
+ * Solves Issue: https://app.zenhub.com/workspaces/joyfill-platform-5f07262b507391001f56c7f9/issues/gh/zionlabs/issues/2105
+ *
+ * This selector ensures a couple of things:
+ * 1. Valid page inside document file.pages array.
+ * 2. All id's in pages and fieldPositions are valid format
+ *
+ * @param {Object} doc
+ * @returns {Object}
+ */
+
+
+exports.getCleanedJoyDoc = getCleanedJoyDoc;
+
+var getCleanedJoyDocPages = function getCleanedJoyDocPages(pages) {
+  if ((pages === null || pages === void 0 ? void 0 : pages.length) > 0) {
+    return pages.map(function (page) {
+      /**
+      * Step 1: Replace pages[x]._id if it is not valid
+      */
+      var nextPage = _objectSpread({}, page);
+
+      if (nextPage._id && !(0, _validateObjectId["default"])(nextPage._id)) nextPage._id = (0, _generateObjectId["default"])();
+
+      if (nextPage.fieldPositions && nextPage.fieldPositions.length > 0) {
+        nextPage.fieldPositions = nextPage.fieldPositions.map(function (fieldPosition) {
+          /**
+          * Step 1.2: Replace fieldPosition _id and field reference if they are not valid
+          */
+          var nextFieldPosition = _objectSpread({}, fieldPosition);
+
+          if (nextFieldPosition._id && !(0, _validateObjectId["default"])(nextFieldPosition._id)) nextFieldPosition._id = (0, _generateObjectId["default"])();
+          if (nextFieldPosition.field && !(0, _validateObjectId["default"])(nextFieldPosition.field)) nextFieldPosition.field = (0, _generateObjectId["default"])();
+          return nextFieldPosition;
+        });
+      } else {
+        nextPage.fieldPositions = [];
+      }
+
+      return nextPage;
+    });
+  } else {
+    return [getDefaultJoyDocPage()];
+  }
+};
+
+exports.getCleanedJoyDocPages = getCleanedJoyDocPages;
 var _default = {
   getDefaultJoyDocPage: getDefaultJoyDocPage,
   getDefaultJoyDocFile: getDefaultJoyDocFile,
-  getDefaultJoyDoc: getDefaultJoyDoc
+  getDefaultJoyDoc: getDefaultJoyDoc,
+  getCleanedJoyDoc: getCleanedJoyDoc,
+  getCleanedJoyDocPages: getCleanedJoyDocPages
 };
 exports["default"] = _default;

package/package.json

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