@builttocreate/engine-utils 2.6.0-beta.2 → 2.6.0-beta.21

package/dist/joyDocHelper.js

@@ -5,7 +5,9 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sortPages = exports.getPageOrder = exports.getDocumentFromTemplate = exports.getDefaultTemplate = exports.getDefaultJoyDocPage = exports.getDefaultJoyDocFile = exports.getDefaultJoyDoc = exports.getDefaultDocument = exports.getCleanedJoyDocPages = exports.getCleanedJoyDoc = 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.duplicateDocumentPage = exports.duplicate = exports["default"] = exports.cleanPageOrder = void 0;
+
+var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -21,6 +23,10 @@ var _DocumentTypes = _interopRequireDefault(require("./constants/DocumentTypes")
 
 var _FieldTypes = _interopRequireDefault(require("./constants/FieldTypes"));
 
+var _FieldDisplayTypes = _interopRequireDefault(require("./constants/FieldDisplayTypes"));
+
+var _FileViews = _interopRequireDefault(require("./constants/FileViews"));
+
 var _tableHelper = require("./tableHelper");
 
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -41,10 +47,11 @@ var getDefaultJoyDocPage = function getDefaultJoyDocPage() {
     width: 816,
     height: 1056,
     rowHeight: 8,
-    cols: 24,
+    cols: 8,
     fieldPositions: [],
     layout: _PageLayoutModes["default"].grid,
-    presentation: _FieldPresentationModes["default"].normal
+    presentation: _FieldPresentationModes["default"].normal,
+    padding: 24
   }, defaults);
 };
 /**
@@ -66,7 +73,10 @@ var getDefaultJoyDocFile = function getDefaultJoyDocFile() {
     _id: (0, _generateObjectId["default"])(),
     name: 'New File',
     pageOrder: [page._id],
-    pages: [page]
+    pages: [page],
+    styles: {
+      margin: 4
+    }
   }, defaults);
 };
 /**
@@ -606,8 +616,194 @@ var duplicateDocumentPage = function duplicateDocumentPage(doc, fileId, pageId)
     doc: nextDoc
   };
 };
+/**
+ * Generate the mobile view and add specific mobile view properties
+ *
+ * @param {Object} file //Full file object
+ * @returns {Object}
+ */
+
 
 exports.duplicateDocumentPage = duplicateDocumentPage;
+
+var getMobileViewFromFile = function getMobileViewFromFile(file) {
+  var _file$views;
+
+  var mobileViewIndex = file !== null && file !== void 0 && file.views && (file === null || file === void 0 ? void 0 : (_file$views = file.views) === null || _file$views === void 0 ? void 0 : _file$views.length) > 0 ? file.views.findIndex(function (view) {
+    return view.type === _FileViews["default"].mobile;
+  }) : -1;
+
+  if (mobileViewIndex !== -1) {
+    /**
+     * Why do we do this? Early versions of alternative views did not contain pageOrder so
+     * we ensure it's populated here.
+     */
+    var mobileView = file.views[mobileViewIndex];
+    var mobileViewPageOrder = cleanPageOrder(getPageOrder(mobileView.pageOrder, mobileView.pages), mobileView.pages);
+    return _objectSpread(_objectSpread({}, mobileView), {}, {
+      pageOrder: mobileViewPageOrder
+    });
+  } else {
+    return generateMobileViewFile(file);
+  }
+};
+/**
+ * Generate the mobile view and add specific mobile view properties
+ *
+ * @param {Object} file //Full file object
+ * @returns {Object}
+ */
+
+
+exports.getMobileViewFromFile = getMobileViewFromFile;
+
+var generateMobileViewFile = function generateMobileViewFile(file) {
+  var pages = file.pages || [];
+  var pageOrder = cleanPageOrder(getPageOrder(file.pageOrder, file.pages), file.pages);
+  return {
+    _id: (0, _generateObjectId["default"])(),
+    type: _FileViews["default"].mobile,
+    pages: (0, _toConsumableArray2["default"])(pages).map(function (page) {
+      var _id = page._id,
+          name = page.name,
+          identifier = page.identifier,
+          fieldPositions = page.fieldPositions;
+      return generateMobileViewPage({
+        _id: _id,
+        identifier: identifier,
+        name: name,
+        fieldPositions: fieldPositions
+      });
+    }),
+    pageOrder: (0, _toConsumableArray2["default"])(pageOrder)
+  };
+};
+/**
+ * Apply the proper page defaults for a mobile view to existing page.
+ *
+ * @param {Object} page
+ * @returns {Objectg}
+ */
+
+
+exports.generateMobileViewFile = generateMobileViewFile;
+
+var generateMobileViewPage = function generateMobileViewPage(page) {
+  return _objectSpread(_objectSpread({}, page), {}, {
+    fieldPositions: page.fieldPositions ? generateMobileViewPageFieldPositions(page.fieldPositions, page.rowHeight) : [],
+    rowHeight: 1,
+    cols: 1,
+    padding: 12,
+    width: 816,
+    height: 1056,
+    layout: _PageLayoutModes["default"].grid,
+    presentation: _FieldPresentationModes["default"].normal
+  });
+};
+
+exports.generateMobileViewPage = generateMobileViewPage;
+
+var generateMobileViewPageFieldPositions = function generateMobileViewPageFieldPositions(fieldPositions, originalRowHeight) {
+  var mobileFieldPositions = [];
+  /**
+   * Step 1: Sort fieldPositions
+   */
+
+  var sortedFieldPositions = sortFieldPositionsByXAndYCoordinates(fieldPositions);
+  sortedFieldPositions.forEach(function (joySpecFieldPosition) {
+    var mobileFieldPositionData = _objectSpread(_objectSpread({}, joySpecFieldPosition), {}, {
+      displayType: _FieldDisplayTypes["default"].original,
+      height: joySpecFieldPosition.height * (originalRowHeight || 1),
+      width: 1,
+      x: 0
+    });
+    /**
+     * Step 1.2 Hide chart lines on mobile
+     */
+
+
+    if (joySpecFieldPosition.type === _FieldTypes["default"].chart) mobileFieldPositionData.primaryDisplayOnly = true;
+    mobileFieldPositions.push(mobileFieldPositionData);
+  });
+  return mergeAssoicatedFieldPositionsForMobileView(mobileFieldPositions);
+};
+/**
+ * Merge Field Positions assoicated with the same Field.
+ *
+ * Why do duplicate fields get created from fieldPositions
+ *
+ * The same field can get added twice because we may have multiple fieldPositions belonging
+ * to the same field. This can happen with dropdown, multiSelect, and table fields.
+ *
+ * Since the fields get generated by looping over the fieldPositions and not regular fields
+ * we may encounter the the same field multiple times because it has multiple fieldPositions.
+ *
+ * @param {Array} fields
+ * @returns {Array}
+ */
+
+
+exports.generateMobileViewPageFieldPositions = generateMobileViewPageFieldPositions;
+
+var mergeAssoicatedFieldPositionsForMobileView = function mergeAssoicatedFieldPositionsForMobileView(fieldPositions) {
+  var filteredFieldPositions = [];
+  fieldPositions === null || fieldPositions === void 0 ? void 0 : fieldPositions.forEach(function (fieldPosition) {
+    var fieldPositionIndex = filteredFieldPositions.findIndex(function (filtered) {
+      var _filtered$field, _fieldPosition$field;
+
+      return (filtered === null || filtered === void 0 ? void 0 : (_filtered$field = filtered.field) === null || _filtered$field === void 0 ? void 0 : _filtered$field.toString()) === (fieldPosition === null || fieldPosition === void 0 ? void 0 : (_fieldPosition$field = fieldPosition.field) === null || _fieldPosition$field === void 0 ? void 0 : _fieldPosition$field.toString());
+    }); //Only add field to the list if it hasn't already been added
+
+    if (fieldPositionIndex === -1) filteredFieldPositions.push(fieldPosition);
+  });
+  return filteredFieldPositions;
+};
+/**
+ * Sort fields by their y and x coordinates
+ *
+ * For example:
+ * [
+ *   { "y": 3, "x": 4 },
+ *   { "y": 3, "x": 1 },
+ *   { "y": 2, "x": 0 },
+ *   { "y": 1, "x": 5.22 },
+ *   { "y": 1, "x": 10 },
+ *   { "y": 1, "x": 0 },
+ * ]
+ * will become the following after sort
+ * [
+ *   { "y": 1, "x": 0 },
+ *   { "y": 1, "x": 5.22 },
+ *   { "y": 1, "x": 10 },
+ *   { "y": 2, "x": 0 },
+ *   { "y": 3, "x": 1 },
+ *   { "y": 3, "x": 4 }
+ * ];
+ *
+ * @param {Array} fieldPositions
+ * @returns {Array}
+ */
+
+
+exports.mergeAssoicatedFieldPositionsForMobileView = mergeAssoicatedFieldPositionsForMobileView;
+
+var sortFieldPositionsByXAndYCoordinates = function sortFieldPositionsByXAndYCoordinates(fieldPositions) {
+  var sortedFieldPositions = (0, _toConsumableArray2["default"])(fieldPositions);
+  sortedFieldPositions.sort(function (a, b) {
+    if (a.y === b.y) {
+      return a.x - b.x;
+    } else if (a.y > b.y) {
+      return 1;
+    } else if (a.y < b.y) {
+      return -1;
+    } else {
+      return 0;
+    }
+  });
+  return sortedFieldPositions;
+};
+
+exports.sortFieldPositionsByXAndYCoordinates = sortFieldPositionsByXAndYCoordinates;
 var _default = {
   getDefaultJoyDocPage: getDefaultJoyDocPage,
   getDefaultJoyDocFile: getDefaultJoyDocFile,
@@ -620,6 +816,11 @@ var _default = {
   duplicate: duplicate,
   duplicateDocumentPage: duplicateDocumentPage,
   getPageOrder: getPageOrder,
-  sortPages: sortPages
+  sortPages: sortPages,
+  sortFieldPositionsByXAndYCoordinates: sortFieldPositionsByXAndYCoordinates,
+  mergeAssoicatedFieldPositionsForMobileView: mergeAssoicatedFieldPositionsForMobileView,
+  generateMobileViewFile: generateMobileViewFile,
+  generateMobileViewPage: generateMobileViewPage,
+  generateMobileViewPageFieldPositions: generateMobileViewPageFieldPositions
 };
 exports["default"] = _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@builttocreate/engine-utils",
-  "version": "2.6.0-beta.2",
+  "version": "2.6.0-beta.21",
   "description": "Utility library for common logic shared across web and mobile",
   "main": "dist/index.js",
   "files": [
@@ -11,7 +11,7 @@
     "clean": "rm -rf dist",
     "build-src": "NODE_ENV=production babel src --out-dir dist --extensions '.js,.jsx' --ignore 'src/testUtils/*','src/**/*.stories.js','src/**/*.test.js','src/lib/**/*.test.js','src/**/__snapshots__','src/**/__mocks__'",
     "build": "npm run clean && npm run build-src",
-    "prepublish": "npm run build",
+    "prepare": "npm run build",
     "publish-beta": "npm publish --tag beta",
     "test": "jest",
     "test-watch": "jest --watch",
@@ -23,7 +23,7 @@
     "type": "git",
     "url": "git+https://github.com/zionlabs/engine-utils.git"
   },
-  "author": "Docspace Team",
+  "author": "Joyfill Team",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/zionlabs/engine-utils/issues"