@builttocreate/engine-utils 2.0.1 → 2.2.0-rc.1.0.0

package/dist/constants/DocumentTypes.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var types = {
+  document: 'document',
+  template: 'template',
+  version: 'version'
+};
+var _default = types;
+exports["default"] = _default;

package/dist/constants/FileViews.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = exports.FileViews = void 0;
+var FileViews = {
+  mobile: 'mobile'
+};
+exports.FileViews = FileViews;
+var _default = FileViews;
+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.getDefaultJoyDocPage = exports.getDefaultJoyDocFile = exports.getDefaultJoyDoc = exports.getCleanedJoyDocPages = exports.getCleanedJoyDoc = exports["default"] = void 0;
+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;
 
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 
@@ -17,6 +17,8 @@ var _PageLayoutModes = _interopRequireDefault(require("./constants/PageLayoutMod
 
 var _FieldPresentationModes = _interopRequireDefault(require("./constants/FieldPresentationModes"));
 
+var _DocumentTypes = _interopRequireDefault(require("./constants/DocumentTypes"));
+
 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; }
 
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
@@ -199,13 +201,334 @@ var getCleanedJoyDocPages = function getCleanedJoyDocPages(pages) {
     return [getDefaultJoyDocPage()];
   }
 };
+/**
+ * Get page order
+ *
+ * @param {Array} pages
+ * @param {Array} pageOrder
+ * @return {Array}
+ */
+
 
 exports.getCleanedJoyDocPages = getCleanedJoyDocPages;
+
+var getPageOrder = function getPageOrder(pageOrder, pages) {
+  return pageOrder || pages.map(function (page) {
+    return page._id;
+  });
+};
+/**
+  *
+  * Clean pageOrder
+  *
+  * 1. Remove any pageIds associated with a missing page.
+  * 2. Remove any underfined or invalid pageIds
+  * 3. Remove any duplicate pageIds
+  *
+  * @param {Array} pageOrder //[string, string, ...]
+  * @param {Array} pages //[object, object, ...]
+  * @returns {Array}
+*/
+
+
+exports.getPageOrder = getPageOrder;
+
+var cleanPageOrder = function cleanPageOrder(pageOrder, pages) {
+  var pageLookup = {};
+  pages.forEach(function (page) {
+    return pageLookup[page._id] = page && !page.deleted;
+  });
+  return pageOrder.filter(function (pageId, index) {
+    return pageLookup[pageId] && pageId && pageOrder.indexOf(pageId) === index;
+  });
+};
+/**
+ * Sort pages based on pageOrder
+ */
+
+
+exports.cleanPageOrder = cleanPageOrder;
+
+var sortPages = function sortPages(pages, pageOrder) {
+  if (!pageOrder) return pages;
+  var pageLookup = {};
+  pages.forEach(function (page) {
+    pageLookup[page._id] = page;
+  });
+  var sortedPages = [];
+  pageOrder.forEach(function (pageId) {
+    if (pageLookup[pageId]) sortedPages.push(pageLookup[pageId]);
+  });
+  return sortedPages;
+};
+/**
+ * Get a properly formatted Document JoyDoc
+ *
+ * @returns {Object}
+ */
+
+
+exports.sortPages = sortPages;
+
+var getDefaultDocument = function getDefaultDocument() {
+  var type = _DocumentTypes["default"].document;
+
+  var _id = (0, _generateObjectId["default"])();
+
+  var identifier = "doc_".concat(_id);
+  var name = 'New Doc';
+  return getDefaultJoyDoc({
+    type: type,
+    _id: _id,
+    identifier: identifier,
+    name: name
+  });
+};
+/**
+ * Get a properly formatted Template JoyDoc
+ *
+ * @returns {Object}
+ */
+
+
+exports.getDefaultDocument = getDefaultDocument;
+
+var getDefaultTemplate = function getDefaultTemplate() {
+  var type = _DocumentTypes["default"].template;
+
+  var _id = (0, _generateObjectId["default"])();
+
+  var identifier = "template_".concat(_id);
+  var name = 'New Template';
+  return getDefaultJoyDoc({
+    type: type,
+    _id: _id,
+    identifier: identifier,
+    name: name
+  });
+};
+/**
+ * Get a properly formatted duplicate of a Template or Document
+ *
+ * @returns {Object}
+ */
+
+
+exports.getDefaultTemplate = getDefaultTemplate;
+
+var duplicate = function duplicate(original, defaults) {
+  //Remove all references to original template object
+  var origin = JSON.parse(JSON.stringify(original));
+
+  var _id = (0, _generateObjectId["default"])();
+
+  var identifier = origin.type === _DocumentTypes["default"].template ? "template_".concat(_id) : "doc_".concat(_id);
+  return _objectSpread(_objectSpread({}, origin), {}, {
+    _id: _id,
+    identifier: identifier,
+    createdOn: new Date().getTime(),
+    source: origin.identifier
+  }, defaults);
+};
+/**
+ * Get a properly formatted Document JoyDoc from Template JoyDoc
+ *
+ * @param {Object} template
+ * @returns {Object}
+ */
+
+
+exports.duplicate = duplicate;
+
+var getDocumentFromTemplate = function getDocumentFromTemplate(template) {
+  var _id = (0, _generateObjectId["default"])();
+
+  var identifier = "doc_".concat(_id); //Remove all references to original template object
+
+  var temp = JSON.parse(JSON.stringify(template));
+  return {
+    _id: _id,
+    identifier: identifier,
+    type: _DocumentTypes["default"].document,
+    name: temp.name,
+    template: temp.identifier,
+    source: temp.identifier,
+    files: temp.files,
+    fields: temp.fields
+  };
+};
+/**
+ * Handle Page Duplication for JoyDoc
+ *
+ * @param {Object} doc //Full JoyDoc Payload for Template or Document
+ * @param {String} fileId //File ID that contains the page we are duplicating
+ * @param {String} pageId
+ * @param {Object} pageDefaults
+ * @returns {Object}
+ */
+
+
+exports.getDocumentFromTemplate = getDocumentFromTemplate;
+
+var duplicateDocumentPage = function duplicateDocumentPage(doc, fileId, pageId) {
+  var _nextDoc$fields;
+
+  var pageDefaults = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+  var changelogInfo = {
+    primaryPages: {
+      targetIndex: 0,
+      page: null
+    },
+    viewPages: [],
+    fields: []
+  };
+  var nextDoc = JSON.parse(JSON.stringify(doc));
+  var fileIndex = nextDoc.files.findIndex(function (file) {
+    return file._id === fileId;
+  });
+  var newPageId = (0, _generateObjectId["default"])();
+  var fieldLookup = {};
+  (_nextDoc$fields = nextDoc.fields) === null || _nextDoc$fields === void 0 ? void 0 : _nextDoc$fields.forEach(function (field) {
+    if (field.file === fileId) fieldLookup[field._id] = field;
+  });
+  var newFieldsLookupByOldId = {};
+
+  var duplicateFieldForFieldPosition = function duplicateFieldForFieldPosition(field) {
+    /**
+     * Why do we check if a new field has already been created?
+     *
+     * That is because multiple field positions can be associated with the same
+     * field. If a field has already been created by a previous field position
+     * that is linked to the same field as the current target then just return
+     * the existing newly created field.
+     */
+    if (newFieldsLookupByOldId[field._id]) return newFieldsLookupByOldId[field._id];
+
+    var duplicateField = _objectSpread(_objectSpread({}, field), {}, {
+      _id: (0, _generateObjectId["default"])()
+    });
+
+    nextDoc.fields.push(duplicateField);
+    changelogInfo.fields.push(duplicateField);
+    /**
+     * Add to lookup so it can be used with other associated field positions
+     */
+
+    newFieldsLookupByOldId[field._id] = duplicateField;
+    return duplicateField;
+  };
+  /**
+   * Step 1: Update Primary View Page Order
+   *
+   * IMPORTANT NOTE: Page order update must go before page object creation.
+   */
+
+
+  var pageOrder = getPageOrder(nextDoc.files[fileIndex].pageOrder, nextDoc.files[fileIndex].pages);
+  var primaryPageOrderIndex = pageOrder.findIndex(function (id) {
+    return id === pageId;
+  });
+  var primaryPageOrderTargetIndex = primaryPageOrderIndex + 1;
+  nextDoc.files[fileIndex].pageOrder = pageOrder;
+  nextDoc.files[fileIndex].pageOrder.splice(primaryPageOrderTargetIndex, 0, newPageId);
+  /**
+   * Step 2: Generate Primary View Page
+   */
+
+  var primaryPageIndex = nextDoc.files[fileIndex].pages.findIndex(function (page) {
+    return page._id === pageId;
+  });
+  var newPrimaryPage = primaryPageIndex === -1 ? null : _objectSpread(_objectSpread({}, nextDoc.files[fileIndex].pages[primaryPageIndex]), {}, {
+    _id: newPageId,
+    fieldPositions: []
+  }, pageDefaults);
+  nextDoc.files[fileIndex].pages[primaryPageIndex].fieldPositions.forEach(function (fieldPosition) {
+    var newField = duplicateFieldForFieldPosition(fieldLookup[fieldPosition.field]);
+    newPrimaryPage.fieldPositions.push(_objectSpread(_objectSpread({}, fieldPosition), {}, {
+      field: newField._id
+    }));
+  });
+  nextDoc.files[fileIndex].pages.splice(primaryPageIndex + 1, 0, newPrimaryPage);
+  /**
+   * Step 3: Update Primary Page Changelog
+   */
+
+  changelogInfo.primaryPages.targetIndex = primaryPageOrderTargetIndex;
+  changelogInfo.primaryPages.page = newPrimaryPage;
+  /**
+   * Step 4: Update Views
+   */
+
+  if (nextDoc.files[fileIndex].views && nextDoc.files[fileIndex].views.length > 0) {
+    nextDoc.files[fileIndex].views = nextDoc.files[fileIndex].views.map(function (view) {
+      var nextView = _objectSpread({}, view);
+
+      var viewPageIndex = nextView.pages.findIndex(function (page) {
+        return page._id === pageId;
+      });
+      if (viewPageIndex === -1) return view;
+      /**
+       * Step 4.1 Update View Page Order.
+       *
+       * IMPORTANT NOTE: Page order update must go before page object creation.
+       */
+
+      var nextViewPageOrder = getPageOrder(nextView.pageOrder, nextView.pages);
+      var nextViewPageOrderIndex = nextViewPageOrder.findIndex(function (id) {
+        return id === pageId;
+      });
+      var nextViewTargetPageOrderIndex = nextViewPageOrderIndex + 1;
+      nextView.pageOrder = nextViewPageOrder;
+      nextView.pageOrder.splice(nextViewTargetPageOrderIndex, 0, newPageId);
+      /**
+       * Step 4.2 Update View Pages
+       */
+
+      var newViewPage = _objectSpread(_objectSpread({}, nextView.pages[viewPageIndex]), {}, {
+        _id: newPageId,
+        fieldPositions: []
+      }, pageDefaults);
+
+      nextView.pages[viewPageIndex].fieldPositions.forEach(function (fieldPosition) {
+        var newField = duplicateFieldForFieldPosition(fieldLookup[fieldPosition.field]);
+        newViewPage.fieldPositions.push(_objectSpread(_objectSpread({}, fieldPosition), {}, {
+          field: newField._id
+        }));
+      });
+      nextView.pages.splice(viewPageIndex + 1, 0, newViewPage);
+      /**
+       * Step 4.3 Add View Page Changelog Info
+       */
+
+      changelogInfo.viewPages.push({
+        viewId: view._id,
+        view: view.type,
+        targetIndex: nextViewTargetPageOrderIndex,
+        page: newViewPage
+      });
+      return nextView;
+    });
+  }
+
+  return {
+    changelogInfo: changelogInfo,
+    doc: nextDoc
+  };
+};
+
+exports.duplicateDocumentPage = duplicateDocumentPage;
 var _default = {
   getDefaultJoyDocPage: getDefaultJoyDocPage,
   getDefaultJoyDocFile: getDefaultJoyDocFile,
   getDefaultJoyDoc: getDefaultJoyDoc,
   getCleanedJoyDoc: getCleanedJoyDoc,
-  getCleanedJoyDocPages: getCleanedJoyDocPages
+  getCleanedJoyDocPages: getCleanedJoyDocPages,
+  getDefaultDocument: getDefaultDocument,
+  getDefaultTemplate: getDefaultTemplate,
+  getDocumentFromTemplate: getDocumentFromTemplate,
+  duplicate: duplicate,
+  duplicateDocumentPage: duplicateDocumentPage,
+  getPageOrder: getPageOrder,
+  sortPages: sortPages
 };
 exports["default"] = _default;

package/dist/tableHelper.js

@@ -655,7 +655,7 @@ var generateTableLookup = function generateTableLookup(rows, columns) {
 
       if (cellValue && column.type === _FieldTableColumnTypes["default"].dropdown) {
         tableLookup[cellKey] = columnOptionsLookup[column._id][cellValue];
-      } else if (cellValue && column.type === _FieldTableColumnTypes["default"].image) {
+      } else if ((cellValue || cellRawValue) && column.type === _FieldTableColumnTypes["default"].image) {
         tableLookup[cellKey] = cellRawValue;
       } else if (cellValue && formulaCell && containsOperands) {
         formulaCells.push(cellKey);

package/package.json

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