@iebh/polyglot 4.5.0 → 4.5.1

package/lib/index.js

@@ -3,12 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-Object.defineProperty(exports, "parse", {
-  enumerable: true,
-  get: function get() {
-    return _parse.parse;
-  }
-});
+exports["default"] = void 0;
 Object.defineProperty(exports, "fieldCodesObject", {
   enumerable: true,
   get: function get() {
@@ -21,24 +16,20 @@ Object.defineProperty(exports, "global", {
     return _global["default"];
   }
 });
-exports["default"] = void 0;
-
+Object.defineProperty(exports, "parse", {
+  enumerable: true,
+  get: function get() {
+    return _parse.parse;
+  }
+});
 var _parse = require("./modules/parse.js");
-
 var _engines = _interopRequireDefault(require("./modules/engines.js"));
-
 var _lodash = _interopRequireDefault(require("lodash"));
-
 var _generic = _interopRequireDefault(require("./modules/engines/generic.js"));
-
 var _fieldCodesObject = _interopRequireDefault(require("./data/fieldCodesObject.js"));
-
 var _global = _interopRequireDefault(require("./modules/global.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
 var polyglot;
-
 var _default = polyglot = {
   /**
   * Translate the given query using the given engine ID
@@ -53,7 +44,6 @@ var _default = polyglot = {
     var tree = (0, _parse.parse)(query, options);
     return polyglot.postProcess(_generic["default"].compile(_lodash["default"].cloneDeep(tree), options, engine), options);
   },
-
   /**
   * Translate the given query using all the supported engines
   * Calling this function instead of individual 'translate()' calls is much more efficient as the tree needs to be compiled only once
@@ -72,7 +62,6 @@ var _default = polyglot = {
     output['lexicalTreeJSON'] = _engines["default"].lexicalTreeJSON.compile(tree, options), options;
     return output;
   },
-
   /**
   * Pre-proess the compile tree before it gets handed to each engines compile function
   * @param {Object} tree The tree to compile
@@ -81,12 +70,12 @@ var _default = polyglot = {
   * @see parse()
   */
   preProcess: function preProcess(tree, options) {
-    var settings = _lodash["default"].defaults(options, {}); // NOTE: THIS FUNCTION IS CURRENTLY ONLY A STUB
+    var settings = _lodash["default"].defaults(options, {});
 
+    // NOTE: THIS FUNCTION IS CURRENTLY ONLY A STUB
 
     return tree;
   },
-
   /**
   * Post process the data from an engine
   * This function applies the following behaviours:
@@ -108,16 +97,13 @@ var _default = polyglot = {
       trim: false,
       transposeLines: true
     });
-
     if (settings.forceString && !_lodash["default"].isString(text)) text = JSON.stringify(text, null, '\t');
-
     if (settings.highlighting) {
       // Highlight logical operators purple
       text = text.replace(/(\sOR\s|\sAND\s|\sNOT\s)/g, function (a, b) {
         return "<font color=\"purple\">".concat(b, "</font>");
       });
     }
-
     if (settings.html) {
       text = text.replace(/\n/g, '<br/>').replace(/\t/g, '<span class="tab"></span>');
     } else if (_lodash["default"].isString(text)) {
@@ -126,13 +112,10 @@ var _default = polyglot = {
         text = text.replace(/<(.+)(\s.*)>(.*)<\/\1>/g, '$3');
       }
     }
-
     if (settings.trim) {
       text = text.replace(/^\s+/gm, '').replace(/\s+$/gm, '');
     }
-
     return text;
   }
 };
-
 exports["default"] = _default;

package/lib/modules/engines/generic.js

@@ -4,39 +4,26 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 var _tools = _interopRequireDefault(require("../tools.js"));
-
 var _global = _interopRequireDefault(require("../global.js"));
-
 var _lodash = _interopRequireDefault(require("lodash"));
-
 var _fieldCodesObject = _interopRequireDefault(require("../../data/fieldCodesObject.js"));
-
 var _meshObject = _interopRequireDefault(require("../../data/meshObject.js"));
-
 var _meshTranslationsObject = _interopRequireDefault(require("../../data/meshTranslationsObject.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
+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) { _defineProperty(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; }
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
 // Function to fix cinahl exploded mesh (move + sign back before ")
 function fixCinahl(content) {
   content = content.replace(/"\+/, '+"');
   content = content.replace(/"<\/font><font color="blue">\+/, '+"</font><font color="blue">');
   return content;
 }
-
 var _default = {
   id: 'generic',
   title: 'generic',
   aliases: ['generic', 'g'],
-
   /**
   * Compile a tree structure to PubMed output
   * @param {array} tree The parsed tree to process
@@ -49,16 +36,13 @@ var _default = {
       replaceWildcards: true,
       testing: false
     });
-
     var compileWalker = function compileWalker(tree) {
       return tree.map(function (branch, branchIndex) {
         var buffer = '';
-
         switch (branch.type) {
           case 'line':
             buffer += compileWalker(branch.nodes);
             break;
-
           case 'group':
             if (branch.field) {
               if (engine === "Ovid MEDLINE" || engine === "Scopus (advanced search)" || engine === "Embase (Elsevier)" || engine === "WoS Advanced") {
@@ -76,20 +60,17 @@ var _default = {
                       // Empty string
                       return el;
                     }
-                  }).join(""); // Fix to move '+' back one space when quoting
-
+                  }).join("");
+                  // Fix to move '+' back one space when quoting
                   if (engine === "CINAHL (Ebsco)") {
                     content = fixCinahl(content);
                   }
-
                   buffer += comment && settings.highlighting ? _tools["default"].createTooltip(content, comment) : content;
                 } else {
                   var translateObject = _fieldCodesObject["default"][engine] ? _fieldCodesObject["default"][engine][branch.field] : null;
-
                   if (translateObject) {
                     var _termArray = translateObject.terms;
                     var _comment = translateObject.comment;
-
                     var _content = _termArray.map(function (el) {
                       if (el && el.toLowerCase() !== "test") {
                         return settings.highlighting ? "<font color=\"LightSeaGreen\">".concat(el, "</font>") : el;
@@ -100,7 +81,6 @@ var _default = {
                         return el;
                       }
                     }).join("");
-
                     buffer += _comment && settings.highlighting ? _tools["default"].createTooltip(_content, _comment) : _content;
                   }
                 }
@@ -113,7 +93,6 @@ var _default = {
                   if (isMesh) {
                     b.type = 'mesh';
                   }
-
                   b.field = branch.field;
                 });
                 branch.nodes = _tools["default"].visit(branch.nodes, ['group'], function (b) {
@@ -124,14 +103,11 @@ var _default = {
             } else {
               buffer += '(' + compileWalker(branch.nodes) + ')';
             }
-
             break;
-
           case 'ref':
             if (settings.transposeLines) {
               // Expand each line to show full query
               var node;
-
               for (node in branch.nodes) {
                 if (node == 0) {
                   // First line is printed as is wrapped in brackets
@@ -156,17 +132,13 @@ var _default = {
                 buffer += _tools["default"].printNumber(engine, branch.ref);
               }
             }
-
             break;
-
           case 'phrase':
             if (branch.field) {
               var translateObject = _fieldCodesObject["default"][engine] ? _fieldCodesObject["default"][engine][branch.field] : null;
-
               if (translateObject) {
                 var _termArray2 = translateObject.terms;
                 var _comment2 = translateObject.comment;
-
                 var _content2 = _termArray2.map(function (el) {
                   if (el && el.toLowerCase() !== "test") {
                     return settings.highlighting ? "<font color=\"LightSeaGreen\">".concat(el, "</font>") : el;
@@ -177,7 +149,6 @@ var _default = {
                     return el;
                   }
                 }).join("");
-
                 buffer += _comment2 && settings.highlighting ? _tools["default"].createTooltip(_content2, _comment2) : _content2;
               } else {
                 buffer += _tools["default"].createTooltip('<font color="#ff6161">' + _tools["default"].quotePhrase(branch, engine, _objectSpread(_objectSpread({}, settings), {}, {
@@ -189,70 +160,56 @@ var _default = {
               if (_global["default"].variables.no_field_tag.indexOf(branch.offset + branch.content.length) === -1) {
                 _global["default"].variables.no_field_tag.push(branch.offset + branch.content.length);
               }
-
               if (settings.highlighting) {
                 buffer += _tools["default"].createPopover(_tools["default"].quotePhrase(branch, engine, settings), branch.offset + branch.content.length);
               } else {
                 buffer += _tools["default"].quotePhrase(branch, engine, settings);
               }
             }
-
             break;
-
           case 'mesh':
             var translateObject = _meshObject["default"][engine] ? _meshObject["default"][engine][branch.field] : null;
-
             if (translateObject) {
               var _termArray3 = translateObject.terms;
               var _comment3 = translateObject.comment;
               var containsHeading = false;
-
               var content = _termArray3.map(function (el) {
                 if (el && el.toLowerCase() !== "test") {
                   // If heading already exists dont add second / at end (for ovid)
                   if (containsHeading && el == "/") {
                     return "";
                   }
-
                   return settings.highlighting ? "<font color=\"blue\">".concat(el, "</font>") : el;
                 } else if (el && el.toLowerCase() === "test") {
                   // Perform logic for the phrase in the mesh
-                  var phrase = _tools["default"].quotePhrase(branch, engine, settings); // If a subheading exists (e.g. psoriasis/dt)
-
-
+                  var phrase = _tools["default"].quotePhrase(branch, engine, settings);
+                  // If a subheading exists (e.g. psoriasis/dt)
                   if (branch.heading) {
                     containsHeading = true;
                     phrase += settings.highlighting ? _tools["default"].createTooltip("/" + branch.heading, "Subheading may need to be manually translated", "red-underline") : "/" + branch.heading;
                   }
-
                   return phrase;
                 } else {
                   // Empty string
                   return el;
                 }
-              }).join(""); // Fix to move '+' back one space when quoting
-
-
+              }).join("");
+              // Fix to move '+' back one space when quoting
               if (engine == "CINAHL (Ebsco)") {
                 content = fixCinahl(content);
               }
-
               buffer += _comment3 && settings.highlighting ? _tools["default"].createTooltip(content, _comment3) : content;
             } else {
               buffer += _tools["default"].createTooltip('<font color="#ff6161">' + _tools["default"].quotePhrase(branch, engine, _objectSpread(_objectSpread({}, settings), {}, {
                 highlighting: false
               })) + '</font>', "No mesh tag found for engine");
             }
-
             break;
-
           case 'meshTranslation':
             var translateObject = _meshTranslationsObject["default"][engine] ? _meshTranslationsObject["default"][engine][branch.field] : null;
-
             if (translateObject) {
               var _termArray4 = translateObject.terms;
               var _comment4 = translateObject.comment;
-
               var _content3 = _termArray4.map(function (el) {
                 if (el && el.toLowerCase() !== "test") {
                   return settings.highlighting ? "<font color=\"purple\">".concat(el, "</font>") : el;
@@ -261,28 +218,23 @@ var _default = {
                   return el;
                 }
               }).join("");
-
               buffer += _comment4 && settings.highlighting ? _tools["default"].createTooltip(_content3, _comment4) : _content3;
             } else {
               buffer += _tools["default"].createTooltip('<font color="#ff6161">' + _tools["default"].quotePhrase(branch, engine, _objectSpread(_objectSpread({}, settings), {}, {
                 highlighting: false
               })) + '</font>', "No mesh tag found for engine");
             }
-
             break;
-
           case 'joinNear':
             switch (engine) {
               case 'PubMed full':
               case 'PubMed abbreviation':
                 buffer += 'AND';
                 break;
-
               case 'Ovid MEDLINE':
               case 'PsycInfo (Ovid)':
                 buffer += "ADJ".concat(branch.proximity);
                 break;
-
               case 'Cochrane Library':
               case 'Embase (Elsevier)':
               case 'Web of Science':
@@ -290,103 +242,84 @@ var _default = {
               case 'ProQuest Health and Medical':
                 buffer += "NEAR/".concat(branch.proximity);
                 break;
-
               case 'CINAHL (Ebsco)':
                 buffer += "N".concat(branch.proximity);
                 break;
-
               case 'Scopus (basic search)':
               case 'Scopus (advanced search)':
                 buffer += "W/".concat(branch.proximity);
                 break;
-
               case 'SPORTDiscus':
                 buffer += "N".concat(branch.proximity);
                 break;
             }
-
             break;
-
           case 'joinNext':
             switch (engine) {
               case 'PubMed full':
               case 'PubMed abbreviation':
                 buffer += 'AND';
                 break;
-
               case 'Ovid MEDLINE':
               case 'PsycInfo (Ovid)':
                 buffer += 'ADJ';
                 break;
-
               case 'Cochrane Library':
                 buffer += 'NEXT';
                 break;
-
               case 'Embase (Elsevier)':
                 buffer += 'NEXT/1';
                 break;
-
               case 'Web of Science':
               case 'WoS Advanced':
                 buffer += 'NEAR/0';
                 break;
-
               case 'CINAHL (Ebsco)':
                 buffer += 'W1';
                 break;
-
               case 'Scopus (basic search)':
               case 'Scopus (advanced search)':
                 buffer += 'W/1';
                 break;
-
               case 'SPORTDiscus':
                 buffer += 'W1';
                 break;
-
               case 'ProQuest Health and Medical':
                 buffer += 'PRE/0';
             }
-
             break;
-
           case 'joinAnd':
             buffer += 'AND';
             break;
-
           case 'joinOr':
             buffer += 'OR';
             break;
-
           case 'joinNot':
             buffer += 'NOT';
             break;
-
           case 'raw':
             buffer += branch.content;
             break;
-
           case 'template':
             buffer += _tools["default"].resolveTemplate(branch.content, engine);
             break;
-
           case 'comment':
             // Do nothing
             break;
-
           default:
             throw new Error('Unsupported object tree type: ' + branch.type);
         }
-
-        return buffer // Add spacing provided... its not a raw buffer or the last entity within the structure
-        + (branch.type == 'raw' || // Its not a raw node
-        branch.type == 'line' || // Its not a line node
-        branchIndex == tree.length - 1 || // Its not the last item in the sequence
+        return buffer
+        // Add spacing provided... its not a raw buffer or the last entity within the structure
+        + (branch.type == 'raw' ||
+        // Its not a raw node
+        branch.type == 'line' ||
+        // Its not a line node
+        branchIndex == tree.length - 1 ||
+        // Its not the last item in the sequence
         branchIndex < tree.length - 1 && tree[branchIndex + 1] && tree[branchIndex + 1].type && tree[branchIndex + 1].type == 'raw' ? '' : ' ');
       }).join('');
     };
-
     return compileWalker(tree);
   },
   open: function open(query) {

package/lib/modules/engines.js

@@ -4,7 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-
 /**
 * Collection of supported engines
 * Each engine should specify:
@@ -15,8 +14,7 @@ exports["default"] = void 0;
 *	debugging - optional boolean specifying that the engine is for debugging purposes only
 *
 * @var {array}
-*/
-var _default = {
+*/var _default = {
   // Lexical tree (JSON) {{{
   lexicalTreeJSON: {
     id: 'lexicalTreeJSON',
@@ -34,10 +32,11 @@ var _default = {
     compile: function compile(tree, options) {
       return tree;
     }
-  } // }}}
+  }
+  // }}}
+
   // MongoDB {{{
   // mongodb: mongodbImport,
   // }}}
-
 };
 exports["default"] = _default;

package/lib/modules/global.js

@@ -33,7 +33,6 @@ var _default = {
   },
   variables: {
     no_field_tag: [] // Stores offsets for phrases with no field tags (for replacement)
-
   },
 
   /**