@oat-sa/tao-core-ui 1.60.2 → 1.62.0

package/dist/documentViewer/providers/pdfViewer/pdfjs/searchEngine.js

@@ -1,612 +1,562 @@
 define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Handlebars, __, DOMPurify) { 'use strict';
 
-  _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
-  Handlebars = Handlebars && Object.prototype.hasOwnProperty.call(Handlebars, 'default') ? Handlebars['default'] : Handlebars;
-  __ = __ && Object.prototype.hasOwnProperty.call(__, 'default') ? __['default'] : __;
-  DOMPurify = DOMPurify && Object.prototype.hasOwnProperty.call(DOMPurify, 'default') ? DOMPurify['default'] : DOMPurify;
-
-  function _typeof(obj) {
-    "@babel/helpers - typeof";
-
-    return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
-      return typeof obj;
-    } : function (obj) {
-      return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
-    }, _typeof(obj);
-  }
-
-  function Helpers0 (hb) {
-    //register a i18n helper
-    hb.registerHelper('__', function (key) {
-      return __(key);
-    });
-    /**
-     * Register dompurify helper
-     *
-     * https://github.com/cure53/DOMPurify
-     * with config SAFE_FOR_TEMPLATES: true
-     * to make output safe for template systems
+    _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
+    Handlebars = Handlebars && Object.prototype.hasOwnProperty.call(Handlebars, 'default') ? Handlebars['default'] : Handlebars;
+    __ = __ && Object.prototype.hasOwnProperty.call(__, 'default') ? __['default'] : __;
+    DOMPurify = DOMPurify && Object.prototype.hasOwnProperty.call(DOMPurify, 'default') ? DOMPurify['default'] : DOMPurify;
+
+    /**
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; under version 2
+     * of the License (non-upgradable).
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+     *
+     * Copyright (c) 2013-2019 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT);
+     *
+     *
      */
+    function Helpers0 (hb) {
+      //register a i18n helper
+      hb.registerHelper('__', function (key) {
+        return __(key);
+      });
 
-    hb.registerHelper('dompurify', function (context) {
-      return DOMPurify.sanitize(context);
-    });
-    /**
-     * Register join helper
-     *
-     * Example :
-     * var values = {a:v1, b:v2, c:v3};
-     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
-     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
-     */
-
-    hb.registerHelper('join', function (arr, keyValueGlue, fragmentGlue, wrapper) {
-      var fragments = [];
-      keyValueGlue = typeof keyValueGlue === 'string' ? keyValueGlue : undefined;
-      fragmentGlue = typeof fragmentGlue === 'string' ? fragmentGlue : ' ';
-      wrapper = typeof wrapper === 'string' ? wrapper : '"';
-
-      _.forIn(arr, function (value, key) {
-        var fragment = '';
+      /**
+       * Register dompurify helper
+       *
+       * https://github.com/cure53/DOMPurify
+       * with config SAFE_FOR_TEMPLATES: true
+       * to make output safe for template systems
+       */
+      hb.registerHelper('dompurify', function (context) {
+        return DOMPurify.sanitize(context);
+      });
 
-        if (value !== null || value !== undefined) {
-          if (typeof value === 'boolean') {
-            value = value ? 'true' : 'false';
-          } else if (_typeof(value) === 'object') {
-            value = _.values(value).join(' ');
+      /**
+       * Register join helper
+       *
+       * Example :
+       * var values = {a:v1, b:v2, c:v3};
+       * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
+       * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
+       */
+      hb.registerHelper('join', function (arr, keyValueGlue, fragmentGlue, wrapper) {
+        var fragments = [];
+        keyValueGlue = typeof keyValueGlue === 'string' ? keyValueGlue : undefined;
+        fragmentGlue = typeof fragmentGlue === 'string' ? fragmentGlue : ' ';
+        wrapper = typeof wrapper === 'string' ? wrapper : '"';
+        _.forIn(arr, function (value, key) {
+          var fragment = '';
+          if (value !== null || value !== undefined) {
+            if (typeof value === 'boolean') {
+              value = value ? 'true' : 'false';
+            } else if (typeof value === 'object') {
+              value = _.values(value).join(' ');
+            }
+          } else {
+            value = '';
           }
-        } else {
-          value = '';
-        }
+          if (keyValueGlue !== undefined) {
+            fragment += key + keyValueGlue;
+          }
+          fragment += wrapper + value + wrapper;
+          fragments.push(fragment);
+        });
+        return fragments.join(fragmentGlue);
+      });
 
-        if (keyValueGlue !== undefined) {
-          fragment += key + keyValueGlue;
+      //register a classic "for loop" helper
+      //it also adds a local variable "i" as the index in each iteration loop
+      hb.registerHelper('for', function (startIndex, stopIndex, increment, options) {
+        var ret = '';
+        startIndex = parseInt(startIndex);
+        stopIndex = parseInt(stopIndex);
+        increment = parseInt(increment);
+        for (var i = startIndex; i < stopIndex; i += increment) {
+          ret += options.fn(_.extend({}, this, {
+            i: i
+          }));
+        }
+        return ret;
+      });
+      hb.registerHelper('equal', function (var1, var2, options) {
+        if (var1 == var2) {
+          return options.fn(this);
+        } else {
+          return options.inverse(this);
         }
-
-        fragment += wrapper + value + wrapper;
-        fragments.push(fragment);
       });
 
-      return fragments.join(fragmentGlue);
-    }); //register a classic "for loop" helper
-    //it also adds a local variable "i" as the index in each iteration loop
-
-    hb.registerHelper('for', function (startIndex, stopIndex, increment, options) {
-      var ret = '';
-      startIndex = parseInt(startIndex);
-      stopIndex = parseInt(stopIndex);
-      increment = parseInt(increment);
-
-      for (var i = startIndex; i < stopIndex; i += increment) {
-        ret += options.fn(_.extend({}, this, {
-          i: i
-        }));
-      }
-
-      return ret;
-    });
-    hb.registerHelper('equal', function (var1, var2, options) {
-      if (var1 == var2) {
-        return options.fn(this);
-      } else {
-        return options.inverse(this);
-      }
-    }); // register a "get property" helper
-    // it gets the named property from the provided context
-
-    hb.registerHelper('property', function (name, context) {
-      return context[name] || '';
-    }); // register an 'includes' helper
-    // it checks if value is in array
-
-    hb.registerHelper('includes', function (haystack, needle, options) {
-      if (_.contains(haystack, needle)) {
-        return options.fn(this);
-      }
-    });
-  }
-
-  if (!Helpers0.__initialized) {
-    Helpers0(Handlebars);
-    Helpers0.__initialized = true;
-  }
-  var Template = Handlebars.template(function (Handlebars,depth0,helpers,partials,data) {
-    this.compilerInfo = [4,'>= 1.0.0'];
-  helpers = this.merge(helpers, Handlebars.helpers); data = data || {};
-    var buffer = "", stack1, helper, functionType="function", escapeExpression=this.escapeExpression;
-
-
-    buffer += "<span class=\"highlight ";
-    if (helper = helpers.cls) { stack1 = helper.call(depth0, {hash:{},data:data}); }
-    else { helper = (depth0 && depth0.cls); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
-    buffer += escapeExpression(stack1)
-      + "\" data-match=\"";
-    if (helper = helpers.index) { stack1 = helper.call(depth0, {hash:{},data:data}); }
-    else { helper = (depth0 && depth0.index); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
-    buffer += escapeExpression(stack1)
-      + "\">";
-    if (helper = helpers.text) { stack1 = helper.call(depth0, {hash:{},data:data}); }
-    else { helper = (depth0 && depth0.text); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
-    buffer += escapeExpression(stack1)
-      + "</span>\r\n";
-    return buffer;
-    });
-  function matchTpl(data, options, asString) {
-    var html = Template(data, options);
-    return (asString || true) ? html : $(html);
-  }
-
-  /**
-   * This program is free software; you can redistribute it and/or
-   * modify it under the terms of the GNU General Public License
-   * as published by the Free Software Foundation; under version 2
-   * of the License (non-upgradable).
-   *
-   * This program is distributed in the hope that it will be useful,
-   * but WITHOUT ANY WARRANTY; without even the implied warranty of
-   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   * GNU General Public License for more details.
-   *
-   * You should have received a copy of the GNU General Public License
-   * along with this program; if not, write to the Free Software
-   * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-   *
-   * Copyright (c) 2016 (original work) Open Assessment Technologies SA ;
-   */
-  /**
-   * Map of special chars to normalize
-   * @type {Object}
-   */
-
-  var charactersToNormalize = {
-    "\u2018": "'",
-    // Left single quotation mark
-    "\u2019": "'",
-    // Right single quotation mark
-    "\u201A": "'",
-    // Single low-9 quotation mark
-    "\u201B": "'",
-    // Single high-reversed-9 quotation mark
-    "\u201C": '"',
-    // Left double quotation mark
-    "\u201D": '"',
-    // Right double quotation mark
-    "\u201E": '"',
-    // Double low-9 quotation mark
-    "\u201F": '"',
-    // Double high-reversed-9 quotation mark
-    "\xBC": '1/4',
-    // Vulgar fraction one quarter
-    "\xBD": '1/2',
-    // Vulgar fraction one half
-    "\xBE": '3/4' // Vulgar fraction three quarters
-
-  };
-  /**
-   * RegExp that will match special chars to normalize
-   * @type {RegExp}
-   */
-
-  var normalizationRegex = new RegExp('[' + Object.keys(charactersToNormalize).join('') + ']', 'g');
-  /**
-   * Replaces special chars by normalized equivalent
-   * @param {String} text
-   * @returns {String}
-   */
-
-  function normalizeSpecialChars(text) {
-    return text.replace(normalizationRegex, function (ch) {
-      return charactersToNormalize[ch];
-    });
-  }
-  /**
-   * Find terms in a text
-   * @param {String} query
-   * @param {String} text
-   * @returns {Array}
-   */
-
-
-  function findInText(query, text) {
-    var queryLen = query.length;
-    var index,
-        end = 0;
-    var matches = [];
-
-    if (queryLen) {
-      do {
-        index = text.indexOf(query, end);
-        end = index + queryLen;
+      // register a "get property" helper
+      // it gets the named property from the provided context
+      hb.registerHelper('property', function (name, context) {
+        return context[name] || '';
+      });
 
-        if (index !== -1) {
-          matches.push([index, end]);
+      // register an 'includes' helper
+      // it checks if value is in array
+      hb.registerHelper('includes', function (haystack, needle, options) {
+        if (_.contains(haystack, needle)) {
+          return options.fn(this);
         }
-      } while (index !== -1);
+      });
     }
 
-    return matches;
-  }
-  /**
-   * Find the query in the whole document
-   * @param {String} query
-   * @param {Array} contentText
-   * @param {Object} config
-   * @returns {Array}
-   */
-
-
-  function findInDocument(query, contentText, config) {
-    var normalizedQuery = normalizeSpecialChars(query);
-
-    if (!config.caseSensitive) {
-      normalizedQuery = normalizedQuery.toLowerCase();
+    if (!Helpers0.__initialized) {
+      Helpers0(Handlebars);
+      Helpers0.__initialized = true;
+    }
+    var Template = Handlebars.template(function (Handlebars,depth0,helpers,partials,data) {
+      this.compilerInfo = [4,'>= 1.0.0'];
+    helpers = this.merge(helpers, Handlebars.helpers); data = data || {};
+      var buffer = "", stack1, helper, functionType="function", escapeExpression=this.escapeExpression;
+
+
+      buffer += "<span class=\"highlight ";
+      if (helper = helpers.cls) { stack1 = helper.call(depth0, {hash:{},data:data}); }
+      else { helper = (depth0 && depth0.cls); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
+      buffer += escapeExpression(stack1)
+        + "\" data-match=\"";
+      if (helper = helpers.index) { stack1 = helper.call(depth0, {hash:{},data:data}); }
+      else { helper = (depth0 && depth0.index); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
+      buffer += escapeExpression(stack1)
+        + "\">";
+      if (helper = helpers.text) { stack1 = helper.call(depth0, {hash:{},data:data}); }
+      else { helper = (depth0 && depth0.text); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
+      buffer += escapeExpression(stack1)
+        + "</span>\n";
+      return buffer;
+      });
+    function matchTpl(data, options, asString) {
+      var html = Template(data, options);
+      return (asString || true) ? html : $(html);
     }
 
-    return _.times(contentText.length, function (pageIndex) {
-      var pageContent = normalizeSpecialChars(contentText[pageIndex]);
-
-      if (!config.caseSensitive) {
-        pageContent = pageContent.toLowerCase();
-      }
-
-      return findInText(normalizedQuery, pageContent);
-    });
-  }
-  /**
-   * Wraps a text into a highlighting span
-   * @param {String} text - The text to highlight
-   * @param {Number} index - The match index
-   * @param {String} [cls] - An additional CSS class to set
-   * @returns {String}
-   */
-
-
-  function highlight(text, index, cls) {
-    return matchTpl({
-      text: text,
-      index: index,
-      cls: cls
-    }).trim();
-  }
-  /**
-   * Highlights a substring in a text
-   * @param {String} text - The text in which highlight the substring
-   * @param {Number} start - The start position of the substring in the text
-   * @param {Number} end - The end position of the substring in the text
-   * @param {Number} index - The match index
-   * @param {String} [cls] - An additional CSS class to set
-   * @returns {String}
-   */
-
-
-  function highlightInText(text, start, end, index, cls) {
-    return text.substring(0, start) + highlight(text.substring(start, end), index, cls) + text.substring(end);
-  }
-  /**
-   * Refines the array of matches to provide positions inside the text layer per nodes basis
-   * @param {Array} matches
-   * @param {Object} pageContent
-   * @returns {Array}
-   */
+    /**
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; under version 2
+     * of the License (non-upgradable).
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+     *
+     * Copyright (c) 2016 (original work) Open Assessment Technologies SA ;
+     */
 
+    /**
+     * Map of special chars to normalize
+     * @type {Object}
+     */
+    var charactersToNormalize = {
+      '\u2018': "'",
+      // Left single quotation mark
+      '\u2019': "'",
+      // Right single quotation mark
+      '\u201A': "'",
+      // Single low-9 quotation mark
+      '\u201B': "'",
+      // Single high-reversed-9 quotation mark
+      '\u201C': '"',
+      // Left double quotation mark
+      '\u201D': '"',
+      // Right double quotation mark
+      '\u201E': '"',
+      // Double low-9 quotation mark
+      '\u201F': '"',
+      // Double high-reversed-9 quotation mark
+      '\u00BC': '1/4',
+      // Vulgar fraction one quarter
+      '\u00BD': '1/2',
+      // Vulgar fraction one half
+      '\u00BE': '3/4' // Vulgar fraction three quarters
+    };
 
-  function refineMatches(matches, pageContent) {
-    var refinedMatches = [];
-    var textItems = pageContent.content.items;
-    var count = textItems.length;
-    var cursor = 0;
-    var strPos = 0;
+    /**
+     * RegExp that will match special chars to normalize
+     * @type {RegExp}
+     */
+    var normalizationRegex = new RegExp('[' + Object.keys(charactersToNormalize).join('') + ']', 'g');
 
-    _.forEach(matches, function (match, index) {
-      var matchStart = match[0];
-      var matchEnd = match[1];
-      var position = {
-        index: index
-      };
+    /**
+     * Replaces special chars by normalized equivalent
+     * @param {String} text
+     * @returns {String}
+     */
+    function normalizeSpecialChars(text) {
+      return text.replace(normalizationRegex, function (ch) {
+        return charactersToNormalize[ch];
+      });
+    }
 
-      while (cursor < count && matchStart >= strPos + textItems[cursor].str.length) {
-        strPos += textItems[cursor].str.length;
-        cursor++;
+    /**
+     * Find terms in a text
+     * @param {String} query
+     * @param {String} text
+     * @returns {Array}
+     */
+    function findInText(query, text) {
+      var queryLen = query.length;
+      var index,
+        end = 0;
+      var matches = [];
+      if (queryLen) {
+        do {
+          index = text.indexOf(query, end);
+          end = index + queryLen;
+          if (index !== -1) {
+            matches.push([index, end]);
+          }
+        } while (index !== -1);
       }
+      return matches;
+    }
 
-      position.begin = {
-        node: cursor,
-        offset: matchStart - strPos
-      };
-
-      while (cursor < count && matchEnd > strPos + textItems[cursor].str.length) {
-        strPos += textItems[cursor].str.length;
-        cursor++;
+    /**
+     * Find the query in the whole document
+     * @param {String} query
+     * @param {Array} contentText
+     * @param {Object} config
+     * @returns {Array}
+     */
+    function findInDocument(query, contentText, config) {
+      var normalizedQuery = normalizeSpecialChars(query);
+      if (!config.caseSensitive) {
+        normalizedQuery = normalizedQuery.toLowerCase();
       }
-
-      position.end = {
-        node: cursor,
-        offset: matchEnd - strPos
-      };
-      refinedMatches.push(position);
-    });
-
-    return refinedMatches;
-  }
-  /**
-   * Renders the matches into the text layer
-   * @param {Array} matches
-   * @param {Object} pageContent
-   * @param {Number} [selectedMatch]
-   */
-
-
-  function renderMatches(matches, pageContent, selectedMatch) {
-    var positions = refineMatches(matches, pageContent);
-    var matchIndex = positions.length - 1;
-    var nodes = pageContent.nodes;
-    var selected = matchIndex === selectedMatch;
-
-    _.forEachRight(nodes, function (node, nodeIndex) {
-      var nodeText = pageContent.content.items[nodeIndex].str;
-      var match, startInNode, endInNode, nodeInMatch, cls;
-
-      while (matchIndex >= 0) {
-        match = positions[matchIndex];
-        startInNode = match.begin.node === nodeIndex;
-        endInNode = match.end.node === nodeIndex;
-        nodeInMatch = nodeIndex > match.begin.node && nodeIndex < match.end.node;
-        cls = selected ? ' selected' : '';
-
-        if (startInNode && endInNode) {
-          nodeText = highlightInText(nodeText, match.begin.offset, match.end.offset, match.index, cls);
-          matchIndex--;
-        } else if (startInNode) {
-          nodeText = highlightInText(nodeText, match.begin.offset, nodeText.length, match.index, 'begin' + cls);
-          matchIndex--;
-        } else if (endInNode) {
-          nodeText = highlightInText(nodeText, 0, match.end.offset, match.index, 'end' + cls);
-          break;
-        } else if (nodeInMatch) {
-          nodeText = highlight(nodeText, match.index, 'middle' + cls);
-          break;
-        } else {
-          break;
+      return _.times(contentText.length, function (pageIndex) {
+        var pageContent = normalizeSpecialChars(contentText[pageIndex]);
+        if (!config.caseSensitive) {
+          pageContent = pageContent.toLowerCase();
         }
-
-        selected = matchIndex === selectedMatch;
-      }
-
-      node.innerHTML = nodeText;
-    });
-  }
-  /**
-   * Embeds the search engine for the PDF viewer
-   * @param {Object} config A config set
-   * @param {Object} config.textManager - The textManager component that gives access to the text content
-   * @param {Boolean} [config.caseSensitive] - Use a case sensitive search when the search feature is available
-   * @returns {Object} Returns the search engine instance
-   */
-
-
-  function pdfjsSearchFactory(config) {
-    var textManager = null;
-    var currentQuery = null;
-    var currentMatch = null;
-    var matches = [];
-    var pages = [];
-    var count = 0;
-    config = config || {};
-    textManager = config.textManager;
-
-    if (!_.isPlainObject(textManager)) {
-      throw new TypeError('You must provide a textManager to give access to the PDF text content! [config.textManager is missing]');
+        return findInText(normalizedQuery, pageContent);
+      });
     }
 
-    return {
-      /**
-       * Gets the list of page numbers that lead to search matches
-       * @returns {Array}
-       */
-      getPages: function getPages() {
-        return pages;
-      },
-
-      /**
-       * Gets the search matches
-       * @returns {Array}
-       */
-      getMatches: function getMatches() {
-        return matches;
-      },
-
-      /**
-       * Gets the number of search matches
-       * @returns {Number}
-       */
-      getMatchCount: function getMatchCount() {
-        return count;
-      },
-
-      /**
-       * Clears the search matches
-       */
-      clearMatches: function clearMatches() {
-        currentMatch = null;
-        matches = [];
-        pages = [];
-        count = 0;
-      },
-
-      /**
-       * Sets the text manager
-       * @param {Object} manager
-       */
-      setTextManager: function setTextManager(manager) {
-        textManager = manager;
-      },
-
-      /**
-       * Gets the text manager
-       * @returns {Object}
-       */
-      getTextManager: function getTextManager() {
-        return textManager;
-      },
-
-      /**
-       * Gets the currently matched query
-       * @returns {String}
-       */
-      getQuery: function getQuery() {
-        return currentQuery;
-      },
-
-      /**
-       * Gets the current match data. It contains:
-       * - overall: the index of the match over all the document, starting at 1
-       * - page: the page number of the match, starting at 1
-       * - index: the index of the match within its page, starting at 0
-       * @returns {Object}
-       */
-      getCurrentMatch: function getCurrentMatch() {
-        return currentMatch;
-      },
-
-      /**
-       * Go to the previous match and returns the match data
-       * @returns {Boolean} Returns true if the search has reached the beginning of the document and moved to the end.
-       */
-      previousMatch: function previousMatch() {
-        var pageIndex;
-        var loop = false;
-
-        if (currentMatch) {
-          if (currentMatch.index) {
-            currentMatch.index--;
-          } else {
-            pageIndex = _.indexOf(pages, currentMatch.page);
-            loop = !pageIndex;
-            currentMatch.page = pages[(pageIndex + pages.length - 1) % pages.length];
-            currentMatch.index = matches[currentMatch.page - 1].length - 1;
-          } // the overall index start at 1 instead of 0, so the formula is a little bit more complex
+    /**
+     * Wraps a text into a highlighting span
+     * @param {String} text - The text to highlight
+     * @param {Number} index - The match index
+     * @param {String} [cls] - An additional CSS class to set
+     * @returns {String}
+     */
+    function highlight(text, index, cls) {
+      return matchTpl({
+        text: text,
+        index: index,
+        cls: cls
+      }).trim();
+    }
 
+    /**
+     * Highlights a substring in a text
+     * @param {String} text - The text in which highlight the substring
+     * @param {Number} start - The start position of the substring in the text
+     * @param {Number} end - The end position of the substring in the text
+     * @param {Number} index - The match index
+     * @param {String} [cls] - An additional CSS class to set
+     * @returns {String}
+     */
+    function highlightInText(text, start, end, index, cls) {
+      return text.substring(0, start) + highlight(text.substring(start, end), index, cls) + text.substring(end);
+    }
 
-          currentMatch.overall = (currentMatch.overall + count - 2) % count + 1;
+    /**
+     * Refines the array of matches to provide positions inside the text layer per nodes basis
+     * @param {Array} matches
+     * @param {Object} pageContent
+     * @returns {Array}
+     */
+    function refineMatches(matches, pageContent) {
+      var refinedMatches = [];
+      var textItems = pageContent.content.items;
+      var count = textItems.length;
+      var cursor = 0;
+      var strPos = 0;
+      _.forEach(matches, function (match, index) {
+        var matchStart = match[0];
+        var matchEnd = match[1];
+        var position = {
+          index: index
+        };
+        while (cursor < count && matchStart >= strPos + textItems[cursor].str.length) {
+          strPos += textItems[cursor].str.length;
+          cursor++;
         }
+        position.begin = {
+          node: cursor,
+          offset: matchStart - strPos
+        };
+        while (cursor < count && matchEnd > strPos + textItems[cursor].str.length) {
+          strPos += textItems[cursor].str.length;
+          cursor++;
+        }
+        position.end = {
+          node: cursor,
+          offset: matchEnd - strPos
+        };
+        refinedMatches.push(position);
+      });
+      return refinedMatches;
+    }
 
-        return loop;
-      },
-
-      /**
-       * Go to the next match and returns the match data
-       * @returns {Boolean} Returns true if the search has reached the end of the document and moved to the beginning.
-       */
-      nextMatch: function nextMatch() {
-        var pageIndex;
-        var loop = false;
-
-        if (currentMatch) {
-          if (currentMatch.index + 1 < matches[currentMatch.page - 1].length) {
-            currentMatch.index++;
+    /**
+     * Renders the matches into the text layer
+     * @param {Array} matches
+     * @param {Object} pageContent
+     * @param {Number} [selectedMatch]
+     */
+    function renderMatches(matches, pageContent, selectedMatch) {
+      var positions = refineMatches(matches, pageContent);
+      var matchIndex = positions.length - 1;
+      var nodes = pageContent.nodes;
+      var selected = matchIndex === selectedMatch;
+      _.forEachRight(nodes, function (node, nodeIndex) {
+        var nodeText = pageContent.content.items[nodeIndex].str;
+        var match, startInNode, endInNode, nodeInMatch, cls;
+        while (matchIndex >= 0) {
+          match = positions[matchIndex];
+          startInNode = match.begin.node === nodeIndex;
+          endInNode = match.end.node === nodeIndex;
+          nodeInMatch = nodeIndex > match.begin.node && nodeIndex < match.end.node;
+          cls = selected ? ' selected' : '';
+          if (startInNode && endInNode) {
+            nodeText = highlightInText(nodeText, match.begin.offset, match.end.offset, match.index, cls);
+            matchIndex--;
+          } else if (startInNode) {
+            nodeText = highlightInText(nodeText, match.begin.offset, nodeText.length, match.index, 'begin' + cls);
+            matchIndex--;
+          } else if (endInNode) {
+            nodeText = highlightInText(nodeText, 0, match.end.offset, match.index, 'end' + cls);
+            break;
+          } else if (nodeInMatch) {
+            nodeText = highlight(nodeText, match.index, 'middle' + cls);
+            break;
           } else {
-            pageIndex = _.indexOf(pages, currentMatch.page);
-            loop = pageIndex === pages.length - 1;
-            currentMatch.page = pages[(pageIndex + 1) % pages.length];
-            currentMatch.index = 0;
-          } // the overall index start at 1 instead of 0, so the formula is a little bit more complex
-
-
-          currentMatch.overall = currentMatch.overall % count + 1;
+            break;
+          }
+          selected = matchIndex === selectedMatch;
         }
+        node.innerHTML = nodeText;
+      });
+    }
 
-        return loop;
-      },
-
-      /**
-       * Searches for the requested query.
-       * The promise will return the page number of the first match, that could be 0 if no result has been found.
-       * @param {String} query - The terms to search for
-       * @param {Number} [pageNum] - An optional page number from which start the search
-       * @returns {Promise}
-       */
-      search: function search(query, pageNum) {
-        matches = null;
-        return textManager.getContents().then(function (pageContents) {
-          var contentText = _.map(pageContents, 'text');
-
-          var firstPage = 0;
-          var firstMatch = 0;
-          matches = findInDocument(query, contentText, config);
-          currentQuery = query;
+    /**
+     * Embeds the search engine for the PDF viewer
+     * @param {Object} config A config set
+     * @param {Object} config.textManager - The textManager component that gives access to the text content
+     * @param {Boolean} [config.caseSensitive] - Use a case sensitive search when the search feature is available
+     * @returns {Object} Returns the search engine instance
+     */
+    function pdfjsSearchFactory(config) {
+      var textManager = null;
+      var currentQuery = null;
+      var currentMatch = null;
+      var matches = [];
+      var pages = [];
+      var count = 0;
+      config = config || {};
+      textManager = config.textManager;
+      if (!_.isPlainObject(textManager)) {
+        throw new TypeError('You must provide a textManager to give access to the PDF text content! [config.textManager is missing]');
+      }
+      return {
+        /**
+         * Gets the list of page numbers that lead to search matches
+         * @returns {Array}
+         */
+        getPages: function getPages() {
+          return pages;
+        },
+        /**
+         * Gets the search matches
+         * @returns {Array}
+         */
+        getMatches: function getMatches() {
+          return matches;
+        },
+        /**
+         * Gets the number of search matches
+         * @returns {Number}
+         */
+        getMatchCount: function getMatchCount() {
+          return count;
+        },
+        /**
+         * Clears the search matches
+         */
+        clearMatches: function clearMatches() {
           currentMatch = null;
+          matches = [];
           pages = [];
           count = 0;
-
-          _.forEach(matches, function (pageMatches, pageIndex) {
-            var page = pageIndex + 1;
-
-            if (pageMatches.length > 0) {
-              pages.push(page);
-
-              if (!firstPage && page >= pageNum) {
-                firstPage = page;
-                firstMatch = count;
-              }
+        },
+        /**
+         * Sets the text manager
+         * @param {Object} manager
+         */
+        setTextManager: function setTextManager(manager) {
+          textManager = manager;
+        },
+        /**
+         * Gets the text manager
+         * @returns {Object}
+         */
+        getTextManager: function getTextManager() {
+          return textManager;
+        },
+        /**
+         * Gets the currently matched query
+         * @returns {String}
+         */
+        getQuery: function getQuery() {
+          return currentQuery;
+        },
+        /**
+         * Gets the current match data. It contains:
+         * - overall: the index of the match over all the document, starting at 1
+         * - page: the page number of the match, starting at 1
+         * - index: the index of the match within its page, starting at 0
+         * @returns {Object}
+         */
+        getCurrentMatch: function getCurrentMatch() {
+          return currentMatch;
+        },
+        /**
+         * Go to the previous match and returns the match data
+         * @returns {Boolean} Returns true if the search has reached the beginning of the document and moved to the end.
+         */
+        previousMatch: function previousMatch() {
+          var pageIndex;
+          var loop = false;
+          if (currentMatch) {
+            if (currentMatch.index) {
+              currentMatch.index--;
+            } else {
+              pageIndex = _.indexOf(pages, currentMatch.page);
+              loop = !pageIndex;
+              currentMatch.page = pages[(pageIndex + pages.length - 1) % pages.length];
+              currentMatch.index = matches[currentMatch.page - 1].length - 1;
             }
 
-            count += pageMatches.length;
-          });
-
-          if (!firstPage) {
-            firstPage = pages[0] || 0;
-          }
-
-          if (firstPage) {
-            currentMatch = {
-              overall: firstMatch + 1,
-              // the overall index of the match
-              page: firstPage,
-              // the page number of the match
-              index: 0 // the index of the match within its page
-
-            };
-          }
-
-          return firstPage;
-        });
-      },
-
-      /**
-       * Displays the search matches on the rendered page
-       * @param {Number} pageNum - The page number of the rendered page
-       * @returns {Promise}
-       */
-      updateMatches: function updateMatches(pageNum) {
-        return textManager.getPageContent(pageNum).then(function (pageContent) {
-          var selectedMatch;
-
-          if (currentMatch && currentMatch.page === pageNum) {
-            selectedMatch = currentMatch.index;
+            // the overall index start at 1 instead of 0, so the formula is a little bit more complex
+            currentMatch.overall = (currentMatch.overall + count - 2) % count + 1;
           }
+          return loop;
+        },
+        /**
+         * Go to the next match and returns the match data
+         * @returns {Boolean} Returns true if the search has reached the end of the document and moved to the beginning.
+         */
+        nextMatch: function nextMatch() {
+          var pageIndex;
+          var loop = false;
+          if (currentMatch) {
+            if (currentMatch.index + 1 < matches[currentMatch.page - 1].length) {
+              currentMatch.index++;
+            } else {
+              pageIndex = _.indexOf(pages, currentMatch.page);
+              loop = pageIndex === pages.length - 1;
+              currentMatch.page = pages[(pageIndex + 1) % pages.length];
+              currentMatch.index = 0;
+            }
 
-          if (pageContent) {
-            renderMatches(matches[pageNum - 1], pageContent, selectedMatch);
+            // the overall index start at 1 instead of 0, so the formula is a little bit more complex
+            currentMatch.overall = currentMatch.overall % count + 1;
           }
+          return loop;
+        },
+        /**
+         * Searches for the requested query.
+         * The promise will return the page number of the first match, that could be 0 if no result has been found.
+         * @param {String} query - The terms to search for
+         * @param {Number} [pageNum] - An optional page number from which start the search
+         * @returns {Promise}
+         */
+        search: function search(query, pageNum) {
+          matches = null;
+          return textManager.getContents().then(function (pageContents) {
+            var contentText = _.map(pageContents, 'text');
+            var firstPage = 0;
+            var firstMatch = 0;
+            matches = findInDocument(query, contentText, config);
+            currentQuery = query;
+            currentMatch = null;
+            pages = [];
+            count = 0;
+            _.forEach(matches, function (pageMatches, pageIndex) {
+              var page = pageIndex + 1;
+              if (pageMatches.length > 0) {
+                pages.push(page);
+                if (!firstPage && page >= pageNum) {
+                  firstPage = page;
+                  firstMatch = count;
+                }
+              }
+              count += pageMatches.length;
+            });
+            if (!firstPage) {
+              firstPage = pages[0] || 0;
+            }
+            if (firstPage) {
+              currentMatch = {
+                overall: firstMatch + 1,
+                // the overall index of the match
+                page: firstPage,
+                // the page number of the match
+                index: 0 // the index of the match within its page
+              };
+            }
 
-          return pageNum;
-        });
-      },
-
-      /**
-       * Destroys the search engine and frees the resources
-       */
-      destroy: function destroy() {
-        textManager = null;
-        currentQuery = null;
-        currentMatch = null;
-        matches = null;
-        pages = null;
-        config = null;
-      }
-    };
-  }
+            return firstPage;
+          });
+        },
+        /**
+         * Displays the search matches on the rendered page
+         * @param {Number} pageNum - The page number of the rendered page
+         * @returns {Promise}
+         */
+        updateMatches: function updateMatches(pageNum) {
+          return textManager.getPageContent(pageNum).then(function (pageContent) {
+            var selectedMatch;
+            if (currentMatch && currentMatch.page === pageNum) {
+              selectedMatch = currentMatch.index;
+            }
+            if (pageContent) {
+              renderMatches(matches[pageNum - 1], pageContent, selectedMatch);
+            }
+            return pageNum;
+          });
+        },
+        /**
+         * Destroys the search engine and frees the resources
+         */
+        destroy: function destroy() {
+          textManager = null;
+          currentQuery = null;
+          currentMatch = null;
+          matches = null;
+          pages = null;
+          config = null;
+        }
+      };
+    }
 
-  return pdfjsSearchFactory;
+    return pdfjsSearchFactory;
 
 });