@oat-sa/tao-core-ui 1.64.2 → 1.65.0

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

@@ -26,7 +26,7 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       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";
+        + "</span>\n";
       return buffer;
       });
     function matchTpl(data, options, asString) {
@@ -34,27 +34,27 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       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 ;
+    /**
+     * 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}
+    /**
+     * Map of special chars to normalize
+     * @type {Object}
      */
     var charactersToNormalize = {
       '\u2018': "'",
@@ -80,16 +80,16 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       '\u00BE': '3/4' // Vulgar fraction three quarters
     };
 
-    /**
-     * RegExp that will match special chars to normalize
-     * @type {RegExp}
+    /**
+     * 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}
+    /**
+     * Replaces special chars by normalized equivalent
+     * @param {String} text
+     * @returns {String}
      */
     function normalizeSpecialChars(text) {
       return text.replace(normalizationRegex, function (ch) {
@@ -97,11 +97,11 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       });
     }
 
-    /**
-     * Find terms in a text
-     * @param {String} query
-     * @param {String} text
-     * @returns {Array}
+    /**
+     * Find terms in a text
+     * @param {String} query
+     * @param {String} text
+     * @returns {Array}
      */
     function findInText(query, text) {
       var queryLen = query.length;
@@ -120,12 +120,12 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       return matches;
     }
 
-    /**
-     * Find the query in the whole document
-     * @param {String} query
-     * @param {Array} contentText
-     * @param {Object} config
-     * @returns {Array}
+    /**
+     * 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);
@@ -141,12 +141,12 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       });
     }
 
-    /**
-     * 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}
+    /**
+     * 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({
@@ -156,24 +156,24 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       }).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}
+    /**
+     * 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}
+    /**
+     * 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 = [];
@@ -208,11 +208,11 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       return refinedMatches;
     }
 
-    /**
-     * Renders the matches into the text layer
-     * @param {Array} matches
-     * @param {Object} pageContent
-     * @param {Number} [selectedMatch]
+    /**
+     * 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);
@@ -249,12 +249,12 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
       });
     }
 
-    /**
-     * 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
+    /**
+     * 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;
@@ -269,29 +269,29 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
         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}
+        /**
+         * Gets the list of page numbers that lead to search matches
+         * @returns {Array}
          */
         getPages: function getPages() {
           return pages;
         },
-        /**
-         * Gets the search matches
-         * @returns {Array}
+        /**
+         * Gets the search matches
+         * @returns {Array}
          */
         getMatches: function getMatches() {
           return matches;
         },
-        /**
-         * Gets the number of search matches
-         * @returns {Number}
+        /**
+         * Gets the number of search matches
+         * @returns {Number}
          */
         getMatchCount: function getMatchCount() {
           return count;
         },
-        /**
-         * Clears the search matches
+        /**
+         * Clears the search matches
          */
         clearMatches: function clearMatches() {
           currentMatch = null;
@@ -299,40 +299,40 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
           pages = [];
           count = 0;
         },
-        /**
-         * Sets the text manager
-         * @param {Object} manager
+        /**
+         * Sets the text manager
+         * @param {Object} manager
          */
         setTextManager: function setTextManager(manager) {
           textManager = manager;
         },
-        /**
-         * Gets the text manager
-         * @returns {Object}
+        /**
+         * Gets the text manager
+         * @returns {Object}
          */
         getTextManager: function getTextManager() {
           return textManager;
         },
-        /**
-         * Gets the currently matched query
-         * @returns {String}
+        /**
+         * 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}
+        /**
+         * 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.
+        /**
+         * 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;
@@ -352,9 +352,9 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
           }
           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.
+        /**
+         * 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;
@@ -374,12 +374,12 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
           }
           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}
+        /**
+         * 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;
@@ -419,10 +419,10 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
             return firstPage;
           });
         },
-        /**
-         * Displays the search matches on the rendered page
-         * @param {Number} pageNum - The page number of the rendered page
-         * @returns {Promise}
+        /**
+         * 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) {
@@ -436,8 +436,8 @@ define(['lodash', 'handlebars', 'lib/handlebars/helpers'], function (_, Handleba
             return pageNum;
           });
         },
-        /**
-         * Destroys the search engine and frees the resources
+        /**
+         * Destroys the search engine and frees the resources
          */
         destroy: function destroy() {
           textManager = null;

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

@@ -2,29 +2,29 @@ define(['lodash'], function (_) { 'use strict';
 
     _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
 
-    /**
-     * 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 ;
+    /**
+     * 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 ;
      */
 
-    /**
-     * Creates a component that will provide access to the text contained by a PDF
-     * @param {Object} config
-     * @param {Object} config.PDFJS - The PDFJS entry point
-     * @returns {Object}
+    /**
+     * Creates a component that will provide access to the text contained by a PDF
+     * @param {Object} config
+     * @param {Object} config.PDFJS - The PDFJS entry point
+     * @returns {Object}
      */
     function textManagerFactory(config) {
       var pdfDoc = null;
@@ -32,8 +32,8 @@ define(['lodash'], function (_) { 'use strict';
       var pageContents = null;
       var textRenderTasks = null;
 
-      /**
-       * Stops the rendering task for a particular page, if any
+      /**
+       * Stops the rendering task for a particular page, if any
        */
       function cancelRenderingTask(pageIndex) {
         if (textRenderTasks && textRenderTasks[pageIndex]) {
@@ -42,8 +42,8 @@ define(['lodash'], function (_) { 'use strict';
         }
       }
 
-      /**
-       * Stops all the rendering tasks, if any
+      /**
+       * Stops all the rendering tasks, if any
        */
       function cancelAllRenderingTasks() {
         var pageIndex;
@@ -55,10 +55,10 @@ define(['lodash'], function (_) { 'use strict';
         }
       }
 
-      /**
-       * Extracts the text of a particular page of the PDF
-       * @param {Number} pageNum
-       * @returns {Promise}
+      /**
+       * Extracts the text of a particular page of the PDF
+       * @param {Number} pageNum
+       * @returns {Promise}
        */
       function getPageTextContent(pageNum) {
         return pdfDoc.getPage(pageNum).then(function (page) {
@@ -68,9 +68,9 @@ define(['lodash'], function (_) { 'use strict';
         });
       }
 
-      /**
-       * Extracts the full text of the PDF
-       * @returns {Promise}
+      /**
+       * Extracts the full text of the PDF
+       * @returns {Promise}
        */
       function getTextContent() {
         var numPages = pdfDoc.numPages;
@@ -89,9 +89,9 @@ define(['lodash'], function (_) { 'use strict';
         return Promise.all(promises);
       }
 
-      /**
-       * Gets the PDF content
-       * @returns {Promise}
+      /**
+       * Gets the PDF content
+       * @returns {Promise}
        */
       function getPageContents() {
         var numPages = pdfDoc.numPages;
@@ -113,25 +113,25 @@ define(['lodash'], function (_) { 'use strict';
         throw new TypeError('You must provide the entry point to the PDF.js library! [config.PDFJS is missing]');
       }
       return {
-        /**
-         * Assign the PDF document from which extract the text
-         * @returns {Object}
+        /**
+         * Assign the PDF document from which extract the text
+         * @returns {Object}
          */
         setDocument: function setDocument(doc) {
           cancelAllRenderingTasks();
           pdfDoc = doc;
           pageContents = null;
         },
-        /**
-         * Gets the PDF document
-         * @returns {Object}
+        /**
+         * Gets the PDF document
+         * @returns {Object}
          */
         getDocument: function getDocument() {
           return pdfDoc;
         },
-        /**
-         * Gets the content of the PDF
-         * @returns {Promise}
+        /**
+         * Gets the content of the PDF
+         * @returns {Promise}
          */
         getContents: function getContents() {
           if (pdfDoc) {
@@ -139,28 +139,28 @@ define(['lodash'], function (_) { 'use strict';
           }
           return Promise.reject(new Error('You must assign a document to get the content from!'));
         },
-        /**
-         * Gets the text of the document, grouped by page
-         * @returns {Promise}
+        /**
+         * Gets the text of the document, grouped by page
+         * @returns {Promise}
          */
         getText: function getText() {
           return this.getContents().then(function (content) {
             return _.map(content, 'text');
           });
         },
-        /**
-         * Gets the full text of the document in a single string
-         * @returns {Promise}
+        /**
+         * Gets the full text of the document in a single string
+         * @returns {Promise}
          */
         getFullText: function getText() {
           return this.getContents().then(function (content) {
             return _.map(content, 'text').join(' ');
           });
         },
-        /**
-         * Gets the content of a particular page
-         * @param {Number} pageNum
-         * @returns {Promise}
+        /**
+         * Gets the content of a particular page
+         * @param {Number} pageNum
+         * @returns {Promise}
          */
         getPageContent: function getPageContent(pageNum) {
           return this.getContents().then(function (content) {
@@ -168,10 +168,10 @@ define(['lodash'], function (_) { 'use strict';
             return content[pageIndex];
           });
         },
-        /**
-         * Gets the full text of a particular page
-         * @param {Number} pageNum
-         * @returns {Promise}
+        /**
+         * Gets the full text of a particular page
+         * @param {Number} pageNum
+         * @returns {Promise}
          */
         getPageText: function getPageText(pageNum) {
           return this.getContents().then(function (content) {
@@ -179,13 +179,13 @@ define(['lodash'], function (_) { 'use strict';
             return content[pageIndex].text;
           });
         },
-        /**
-         * Renders the text of a page into a layer using the provided viewport settings.
-         * The promise will return the rendered layer.
-         * @param {Number} pageNum
-         * @param {Object} viewport
-         * @param {Number} [timeout]
-         * @returns {Promise}
+        /**
+         * Renders the text of a page into a layer using the provided viewport settings.
+         * The promise will return the rendered layer.
+         * @param {Number} pageNum
+         * @param {Object} viewport
+         * @param {Number} [timeout]
+         * @returns {Promise}
          */
         renderPage: function renderPage(pageNum, viewport, timeout) {
           return this.getContents().then(function (content) {
@@ -210,8 +210,8 @@ define(['lodash'], function (_) { 'use strict';
             });
           });
         },
-        /**
-         * Destroys the text manager and frees the resources
+        /**
+         * Destroys the text manager and frees the resources
          */
         destroy: function destroy() {
           cancelAllRenderingTasks();