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

package/dist/documentViewer/providers/pdfViewer.js

@@ -1,213 +1,211 @@
 define(['lodash', 'core/requireIfExists', 'ui/documentViewer/providers/pdfViewer/fallback/viewer', 'ui/documentViewer/providers/pdfViewer/pdfjs/viewer', 'handlebars', 'i18n', 'lib/dompurify/purify'], function (_, requireIfExists, fallbackFactory, pdfjsFactory, Handlebars, __, DOMPurify) { 'use strict';
 
-  _ = _ && Object.prototype.hasOwnProperty.call(_, 'default') ? _['default'] : _;
-  requireIfExists = requireIfExists && Object.prototype.hasOwnProperty.call(requireIfExists, 'default') ? requireIfExists['default'] : requireIfExists;
-  fallbackFactory = fallbackFactory && Object.prototype.hasOwnProperty.call(fallbackFactory, 'default') ? fallbackFactory['default'] : fallbackFactory;
-  pdfjsFactory = pdfjsFactory && Object.prototype.hasOwnProperty.call(pdfjsFactory, 'default') ? pdfjsFactory['default'] : pdfjsFactory;
-  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'] : _;
+    requireIfExists = requireIfExists && Object.prototype.hasOwnProperty.call(requireIfExists, 'default') ? requireIfExists['default'] : requireIfExists;
+    fallbackFactory = fallbackFactory && Object.prototype.hasOwnProperty.call(fallbackFactory, 'default') ? fallbackFactory['default'] : fallbackFactory;
+    pdfjsFactory = pdfjsFactory && Object.prototype.hasOwnProperty.call(pdfjsFactory, 'default') ? pdfjsFactory['default'] : pdfjsFactory;
+    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
+          }));
         }
-
-        fragment += wrapper + value + wrapper;
-        fragments.push(fragment);
+        return ret;
       });
-
-      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);  
-
-
-    return "<div class=\"pdf-viewer\"></div>";
-    });
-  function viewerTpl(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 ;
-   */
-  var pdfViewer = {
-    /**
-     * Gets the template used to render the viewer
-     * @returns {Function}
-     */
-    getTemplate: function getTemplate() {
-      return viewerTpl;
-    },
-
-    /**
-     * Initializes the component
-     */
-    init: function init() {
-      this.pdf = null;
-    },
-
-    /**
-     * Loads and displays the document
-     */
-    load: function load() {
-      var self = this;
-      var $element = this.getElement(); // try to load the  PDF.js lib, otherwise fallback to the browser native handling
-
-      return requireIfExists('pdfjs-dist/build/pdf').then(function (pdfjs) {
-        var config = _.clone(self.config);
-
-        if (pdfjs) {
-          config.PDFJS = pdfjs;
-          self.pdf = pdfjsFactory($element, config);
+      hb.registerHelper('equal', function (var1, var2, options) {
+        if (var1 == var2) {
+          return options.fn(this);
         } else {
-          self.pdf = fallbackFactory($element, config);
+          return options.inverse(this);
         }
+      });
 
-        return self.pdf.load(self.getUrl());
-      }).then(function () {
-        self.setSize($element.width(), $element.height());
+      // register a "get property" helper
+      // it gets the named property from the provided context
+      hb.registerHelper('property', function (name, context) {
+        return context[name] || '';
       });
-    },
 
-    /**
-     * Destroys the component
-     */
-    unload: function unload() {
-      if (this.pdf) {
-        this.pdf.unload();
-      }
+      // 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);  
 
-      if (this.is('rendered')) {
-        this.getElement().empty();
-      }
 
-      this.pdf = null;
-    },
+      return "<div class=\"pdf-viewer\"></div>";
+      });
+    function viewerTpl(data, options, asString) {
+      var html = Template(data, options);
+      return (asString || true) ? html : $(html);
+    }
 
-    /**
-     * Sets the size of the component
-     * @param {Number} width
-     * @param {Number} height
+    /**
+     * 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 ;
      */
-    setSize: function setSize(width, height) {
-      if (this.pdf) {
-        this.pdf.setSize(width, height);
+    var pdfViewer = {
+      /**
+       * Gets the template used to render the viewer
+       * @returns {Function}
+       */
+      getTemplate: function getTemplate() {
+        return viewerTpl;
+      },
+      /**
+       * Initializes the component
+       */
+      init: function init() {
+        this.pdf = null;
+      },
+      /**
+       * Loads and displays the document
+       */
+      load: function load() {
+        var self = this;
+        var $element = this.getElement();
+
+        // try to load the  PDF.js lib, otherwise fallback to the browser native handling
+        return requireIfExists('pdfjs-dist/build/pdf').then(function (pdfjs) {
+          var config = _.clone(self.config);
+          if (pdfjs) {
+            config.PDFJS = pdfjs;
+            self.pdf = pdfjsFactory($element, config);
+          } else {
+            self.pdf = fallbackFactory($element, config);
+          }
+          return self.pdf.load(self.getUrl());
+        }).then(function () {
+          self.setSize($element.width(), $element.height());
+        });
+      },
+      /**
+       * Destroys the component
+       */
+      unload: function unload() {
+        if (this.pdf) {
+          this.pdf.unload();
+        }
+        if (this.is('rendered')) {
+          this.getElement().empty();
+        }
+        this.pdf = null;
+      },
+      /**
+       * Sets the size of the component
+       * @param {Number} width
+       * @param {Number} height
+       */
+      setSize: function setSize(width, height) {
+        if (this.pdf) {
+          this.pdf.setSize(width, height);
+        }
       }
-    }
-  };
+    };
 
-  return pdfViewer;
+    return pdfViewer;
 
 });

package/dist/documentViewer/viewerFactory.js

@@ -5,28 +5,28 @@ define(['lodash', 'core/providerRegistry', 'core/delegator', 'ui/component'], fu
     delegator = delegator && Object.prototype.hasOwnProperty.call(delegator, 'default') ? delegator['default'] : delegator;
     component = component && Object.prototype.hasOwnProperty.call(component, 'default') ? component['default'] : component;
 
-    /**
-     * 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 ;
-     */
-    /**
-     * Some defaults config
-     * @type {Object}
+    /**
+     * 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 ;
      */
 
+    /**
+     * Some defaults config
+     * @type {Object}
+     */
     var defaults = {
       width: 'auto',
       height: 'auto',
@@ -35,60 +35,59 @@ define(['lodash', 'core/providerRegistry', 'core/delegator', 'ui/component'], fu
       caseSensitiveSearch: false,
       highlightAllMatches: false
     };
-    /**
-     * A list of methods any provider must have
-     * @type {Array}
-     */
 
+    /**
+     * A list of methods any provider must have
+     * @type {Array}
+     */
     var mandatory = ['load' // loads the document to view
     ];
-    /**
-     * Creates a document viewer
-     * @param {Object} config - The config set
-     * @param {String} config.url - The URL of the document to load
-     * @param {String} config.type - The MIME type of the document to load
-     * @param {Number|String} [config.width] - The width in pixels, or 'auto' to use the container's width
-     * @param {Number|String} [config.height] - The height in pixels, or 'auto' to use the container's height
-     * @param {Boolean} [config.fitToWidth] - The document will be displayed using the full available width instead of fitting the height
-     * @param {Boolean} [config.allowSearch] - Allow to search within the displayed document
-     * @param {Boolean} [config.caseSensitiveSearch] - Use a case sensitive search when the search feature is available
-     * @param {Boolean} [config.highlightAllMatches] - Highlight all matches to see all of them at a glance
-     * @returns {Object}
-     */
 
+    /**
+     * Creates a document viewer
+     * @param {Object} config - The config set
+     * @param {String} config.url - The URL of the document to load
+     * @param {String} config.type - The MIME type of the document to load
+     * @param {Number|String} [config.width] - The width in pixels, or 'auto' to use the container's width
+     * @param {Number|String} [config.height] - The height in pixels, or 'auto' to use the container's height
+     * @param {Boolean} [config.fitToWidth] - The document will be displayed using the full available width instead of fitting the height
+     * @param {Boolean} [config.allowSearch] - Allow to search within the displayed document
+     * @param {Boolean} [config.caseSensitiveSearch] - Use a case sensitive search when the search feature is available
+     * @param {Boolean} [config.highlightAllMatches] - Highlight all matches to see all of them at a glance
+     * @returns {Object}
+     */
     function viewerFactory(documentType, config) {
-      /**
-       * The selected document viewer
-       * @type {Object}
+      /**
+       * The selected document viewer
+       * @type {Object}
        */
       var viewer = viewerFactory.getProvider(documentType);
-      /**
-       * The document viewer API
-       * @type {Object}
-       */
 
+      /**
+       * The document viewer API
+       * @type {Object}
+       */
       var documentViewer = component({
-        /**
-         * Gets the type of the loaded document
-         * @returns {String}
+        /**
+         * Gets the type of the loaded document
+         * @returns {String}
          */
         getType: function getType() {
           return this.config.type;
         },
-
-        /**
-         * Gets the url of the loaded document
-         * @returns {String}
+        /**
+         * Gets the url of the loaded document
+         * @returns {String}
          */
         getUrl: function getUrl() {
           return this.config.url;
         }
       }, defaults);
-      /**
-       * The function used to delegate the calls from the API to the provider.
-       * @type {Function}
-       */
 
+      /**
+       * The function used to delegate the calls from the API to the provider.
+       * @type {Function}
+       */
       var delegate = delegator(documentViewer, viewer, {
         name: documentType + 'Viewer',
         eventifier: false,
@@ -96,72 +95,69 @@ define(['lodash', 'core/providerRegistry', 'core/delegator', 'ui/component'], fu
           return Promise.resolve(response);
         }
       });
-
       if (_.isFunction(viewer.getTemplate)) {
         documentViewer.setTemplate(viewer.getTemplate());
       }
-
       return documentViewer.on('init', function onInit() {
         var self = this;
         delegate('init').then(function () {
-          /**
-           * @event viewer#initialized
+          /**
+           * @event viewer#initialized
            */
           self.trigger('initialized');
         }).catch(function (err) {
-          /**
-           * @event viewer#error
-           * @param err
+          /**
+           * @event viewer#error
+           * @param err
            */
           self.trigger('error', err);
         });
       }).on('destroy', function onDestroy() {
         var self = this;
         delegate('unload').then(function () {
-          /**
-           * @event viewer#unloaded
+          /**
+           * @event viewer#unloaded
            */
           self.trigger('unloaded');
         }).catch(function (err) {
-          /**
-           * @event viewer#error
-           * @param err
+          /**
+           * @event viewer#error
+           * @param err
            */
           self.trigger('error', err);
         });
       }).on('render', function onRender() {
         var self = this;
         delegate('load').then(function () {
-          /**
-           * @event viewer#loaded
+          /**
+           * @event viewer#loaded
            */
           self.trigger('loaded');
         }).catch(function (err) {
-          /**
-           * @event viewer#error
-           * @param err
+          /**
+           * @event viewer#error
+           * @param err
            */
           self.trigger('error', err);
         });
       }).on('setsize', function onSetSize(width, height) {
         var self = this;
         delegate('setSize', width, height).then(function () {
-          /**
-           * @event viewer#resized
-           * @param {Number} width
-           * @param {Number} height
+          /**
+           * @event viewer#resized
+           * @param {Number} width
+           * @param {Number} height
            */
           self.trigger('resized', width, height);
         }).catch(function (err) {
-          /**
-           * @event viewer#error
-           * @param err
+          /**
+           * @event viewer#error
+           * @param err
            */
           self.trigger('error', err);
         });
       }).init(config);
     }
-
     var viewerFactory$1 = providerRegistry(viewerFactory, function (provider) {
       //mandatory methods
       _.each(mandatory, function (name) {
@@ -169,7 +165,6 @@ define(['lodash', 'core/providerRegistry', 'core/delegator', 'ui/component'], fu
           throw new TypeError('The viewer provider MUST implement the ' + name + '() method!');
         }
       });
-
       return true;
     });