@builttocreate/engine-utils 2.6.0-beta.24 → 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);
@@ -985,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/package.json

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