@oat-sa/tao-core-ui 1.54.2 → 1.55.0

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

@@ -20,24 +20,24 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
     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
+    /**
+     * 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);
     });
-    /**
-     * 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*
+    /**
+     * 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) {
@@ -128,7 +128,7 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
     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) {
@@ -136,26 +136,26 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
     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 = {
@@ -182,16 +182,16 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
     "\xBE": '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) {
@@ -199,11 +199,11 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
       return charactersToNormalize[ch];
     });
   }
-  /**
-   * 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}
    */
 
 
@@ -226,12 +226,12 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
 
     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}
    */
 
 
@@ -252,12 +252,12 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
       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}
+  /**
+   * 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}
    */
 
 
@@ -268,25 +268,25 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
       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}
+  /**
+   * 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}
    */
 
 
@@ -328,11 +328,11 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
 
     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]
    */
 
 
@@ -375,12 +375,12 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
       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
+  /**
+   * 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
    */
 
 
@@ -399,32 +399,32 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
     }
 
     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;
@@ -433,44 +433,44 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
         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;
@@ -493,9 +493,9 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
         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;
@@ -518,12 +518,12 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
         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;
@@ -572,10 +572,10 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
         });
       },
 
-      /**
-       * 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) {
@@ -593,8 +593,8 @@ define(['lodash', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, Ha
         });
       },
 
-      /**
-       * 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,28 +2,28 @@ 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) {
@@ -31,8 +31,8 @@ define(['lodash'], function (_) { 'use strict';
       var PDFJS = null;
       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) {
@@ -41,8 +41,8 @@ define(['lodash'], function (_) { 'use strict';
           textRenderTasks[pageIndex] = null;
         }
       }
-      /**
-       * Stops all the rendering tasks, if any
+      /**
+       * Stops all the rendering tasks, if any
        */
 
 
@@ -57,10 +57,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}
        */
 
 
@@ -71,9 +71,9 @@ define(['lodash'], function (_) { 'use strict';
           });
         });
       }
-      /**
-       * Extracts the full text of the PDF
-       * @returns {Promise}
+      /**
+       * Extracts the full text of the PDF
+       * @returns {Promise}
        */
 
 
@@ -96,9 +96,9 @@ define(['lodash'], function (_) { 'use strict';
 
         return Promise.all(promises);
       }
-      /**
-       * Gets the PDF content
-       * @returns {Promise}
+      /**
+       * Gets the PDF content
+       * @returns {Promise}
        */
 
 
@@ -127,9 +127,9 @@ define(['lodash'], function (_) { 'use strict';
       }
 
       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();
@@ -137,17 +137,17 @@ define(['lodash'], function (_) { 'use strict';
           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) {
@@ -157,9 +157,9 @@ 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) {
@@ -167,9 +167,9 @@ define(['lodash'], function (_) { 'use strict';
           });
         },
 
-        /**
-         * 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) {
@@ -177,10 +177,10 @@ define(['lodash'], function (_) { 'use strict';
           });
         },
 
-        /**
-         * 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) {
@@ -189,10 +189,10 @@ define(['lodash'], function (_) { 'use strict';
           });
         },
 
-        /**
-         * 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) {
@@ -201,13 +201,13 @@ define(['lodash'], function (_) { 'use strict';
           });
         },
 
-        /**
-         * 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) {
@@ -233,8 +233,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();