jclic 2.2.0 → 2.3.0

package/src/bags/ConditionalJumpInfo.js

@@ -1,113 +0,0 @@
-/**
- *  File    : bags/ConditionalJumpInfo.js
- *  Created : 05/04/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Catalan Educational Telematic Network (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import JumpInfo from './JumpInfo.js';
-import { getAttr, isEmpty } from '../Utils.js';
-
-/**
- * This special case of {@link module:bags/JumpInfo.JumpInfo JumpInfo} is used in {@link module:bags/ActivitySequenceJump.ActivitySequenceJump ActivitySequenceJump} objects to decide
- * the type of jump or action to be performed, based on the results obtained by the user when
- * playing previous JClic activities.
- *
- * In addition to the standard {@link module:bags/JumpInfo.JumpInfo JumpInfo} fields and methods, this class has two public
- * members where score and time thresholds are stored.
- *
- * The exact meaning of this members will depend on the type of `ConditionalJumpInfo` in the
- * {@link module:bags/ActivitySequenceJump.ActivitySequenceJump ActivitySequenceJump} (it can be `upperJump` or `lowerJump`).
- * @extends module:bags/JumpInfo.JumpInfo
- */
-export class ConditionalJumpInfo extends JumpInfo {
-  /**
-   * ConditionalJumpInfo constructor
-   * @param {string} action - Must be one of the described actions.
-   * @param {number|string} [sq] - Can be the tag of the sequence element to jump to, or its
-   * cardinal number in the list.
-   * @param {number} [threshold] - Threshold above or below which the action will be triggered,
-   * depending on the type of JumpInfo.
-   * @param {number} [time] - Delay to be applied in automatic jumps.
-   */
-  constructor(action, sq, threshold, time) {
-    super(action, sq);
-    this.threshold = typeof threshold === 'number' ? threshold : -1;
-    this.time = typeof threshold === 'number' ? time : -1;
-  }
-
-  /**
-   * Loads this object settings from a specific JQuery XML element
-   * @param {external:jQuery} $xml - The XML element to parse
-   */
-  setProperties($xml) {
-    super.setProperties($xml);
-    if ($xml.attr('threshold') !== undefined)
-      this.threshold = $xml.attr('threshold');
-    if ($xml.attr('time') !== undefined)
-      this.time = $xml.attr('time');
-    return this;
-  }
-
-  /**
-   * Gets a object with the basic attributes needed to rebuild this instance excluding functions,
-   * parent references, constants and also attributes retaining the default value.
-   * The resulting object is commonly usued to serialize elements in JSON format.
-   * @returns {object} - The resulting object, with minimal attrributes
-   */
-  getAttributes() {
-    return Object.assign(super.getAttributes(), getAttr(this, ['threshold', 'time']));
-  }
-
-  /**
-   * Loads this conditional jump settings from a data object
-   * @param {object} data - The data object to parse
-   */
-  setAttributes(data) {
-    super.setAttributes(data);
-    ['threshold', 'time'].forEach(t => {
-      if (!isEmpty(data[t]))
-        this[t] = data[t];
-    });
-    return this;
-  }
-}
-
-Object.assign(ConditionalJumpInfo.prototype, {
-  /**
-   * Threshold above or below which the action will be triggered, depending on the type of JumpInfo.
-   * @name module:bags/ConditionalJumpInfo.ConditionalJumpInfo#threshold
-   * @type {number} */
-  threshold: -1,
-  /**
-   * Delay to be applied in automatic jumps.
-   * @name module:bags/ConditionalJumpInfo.ConditionalJumpInfo#time
-   * @type {number} */
-  time: -1,
-});
-
-export default ConditionalJumpInfo;

package/src/bags/JumpInfo.js

@@ -1,136 +0,0 @@
-/**
- *  File    : bags/JumpInfo.js
- *  Created : 05/04/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Catalan Educational Telematic Network (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import { nSlash, getAttr, isEmpty } from '../Utils.js';
-
-/**
- * This class contains information about what things JClic sequence manager has to do in certain
- * circumstances, such as:
- * - an activity finishes
- * - the user clicks on the "next" or "prev" buttons
- * - the user clicks or a cell with special "active content"
- *
- * Different kinds of actions are possible for each of these events:
- * - RETURN: to go back to a previous point in the sequence.
- * - EXIT: to exit the program (thus navigating to another URL)
- * - STOP: to do nothing.
- * - JUMP: to jump to a specific point in the sequence of activities, or to another JClic project.
- * @see {@link module:bags/ActivitySequenceJump.ActivitySequenceJump ActivitySequenceJump}
- * @see {@link module:bags/ConditionalJumpInfo.ConditionalJumpInfo ConditionalJumpInfo}
- */
-export class JumpInfo {
-  /**
-   * JumpInfo constructor
-   * @param {string} action - Must be one of the described actions.
-   * @param {number|string} [sq] - Can be the tag of the sequence element to jump to, or its
-   * cardinal number in the list.
-   */
-  constructor(action, sq) {
-    this.action = action;
-    switch (typeof sq) {
-      case 'string':
-        this.sequence = sq;
-        break;
-      case 'number':
-        this.actNum = sq;
-        break;
-    }
-  }
-
-  /**
-   * Loads the object settings from a specific JQuery XML element
-   * @param {external:jQuery} $xml - The XML element to parse
-   */
-  setProperties($xml) {
-    this.id = $xml.attr('id');
-    this.action = $xml.attr('action') || 'JUMP';
-    if ($xml.attr('tag'))
-      this.sequence = nSlash($xml.attr('tag'));
-    if ($xml.attr('project'))
-      this.projectPath = nSlash($xml.attr('project'));
-    return this;
-  }
-
-  /**
-   * Gets a object with the basic attributes needed to rebuild this instance excluding functions,
-   * parent references, constants and also attributes retaining the default value.
-   * The resulting object is commonly usued to serialize elements in JSON format.
-   * @returns {object} - The resulting object, with minimal attrributes
-   */
-  getAttributes() {
-    return getAttr(this, ['id', 'action', 'actNum', 'sequence', 'projectPath']);
-  }
-
-  /**
-   * Loads the object settings from a data object
-   * @param {object} data - The data object to parse
-   */
-  setAttributes(data) {
-    ['id', 'action', 'actNum', 'sequence', 'projectPath'].forEach(t => {
-      if (!isEmpty(data[t]))
-        this[t] = data[t];
-    });
-    return this;
-  }
-}
-
-Object.assign(JumpInfo.prototype, {
-  /**
-   * The JumpInfo identifier
-   * - For regular jumps: 'forward', 'back'
-   * - For conditional jumps: 'upper', 'lower'
-   * @name module:bags/JumpInfo.JumpInfo#id
-   * @type {string} */
-  id: null,
-  /**
-   * The current action.
-   * Possible values are: `JUMP`, `STOP`, `RETURN` and `EXIT`.
-   * @name module:bags/JumpInfo.JumpInfo#action
-   * @type {string} */
-  action: null,
-  /**
-   * Activity number in the sequence list
-   * @name module:bags/JumpInfo.JumpInfo#actNum
-   * @type {number} */
-  actNum: -1,
-  /**
-   * Current sequence tag
-   * @name module:bags/JumpInfo.JumpInfo#sequence
-   * @type {string} */
-  sequence: null,
-  /**
-   * Path of another JClic project to jump to
-   * @name module:bags/JumpInfo.JumpInfo#projectPath
-   * @type {string} */
-  projectPath: null,
-});
-
-export default JumpInfo;

package/src/bags/MediaBag.js

@@ -1,215 +0,0 @@
-/**
- *  File    : bags/MediaBag.js
- *  Created : 07/04/2015
- *  By      : Francesc Busquets <francesc@gmail.com>
- *
- *  JClic.js
- *  An HTML5 player of JClic activities
- *  https://projectestac.github.io/jclic.js
- *
- *  @source https://github.com/projectestac/jclic.js
- *
- *  @license EUPL-1.2
- *  @licstart
- *  (c) 2000-2020 Educational Telematic Network of Catalonia (XTEC)
- *
- *  Licensed under the EUPL, Version 1.1 or -as soon they will be approved by
- *  the European Commission- subsequent versions of the EUPL (the "Licence");
- *  You may not use this work except in compliance with the Licence.
- *
- *  You may obtain a copy of the Licence at:
- *  https://joinup.ec.europa.eu/software/page/eupl
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the Licence is distributed on an "AS IS" basis, WITHOUT
- *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- *  Licence for the specific language governing permissions and limitations
- *  under the Licence.
- *  @licend
- *  @module
- */
-
-import $ from 'jquery';
-import MediaBagElement from './MediaBagElement.js';
-import Skin from '../skins/Skin.js';
-import { log, nSlash } from '../Utils.js';
-
-/**
- * This class stores and manages all the media components (images, sounds, animations, video,
- * MIDI files, etc.) needed to run the activities of a {@link module:project/JClicProject.JClicProject JClicProject}. The main member of
- * the class is `elements`. This is where {@link module:bads/MediaBagElement.MediaBagElement} objects are stored.
- */
-export class MediaBag {
-  /**
-   * MediaBag constructor
-   * @param {module:project/JClicProject.JClicProject} project - The JClic project to which this media bag belongs
-   */
-  constructor(project) {
-    this.project = project;
-    this.elements = {};
-  }
-
-  /**
-   * Loads this object settings from a specific JQuery XML element
-   * @param {external:jQuery} $xml - The XML element to parse
-   */
-  setProperties($xml) {
-    $xml.children('media').each((_n, child) => {
-      const mbe = new MediaBagElement(this.project.basePath, null, this.project.zip);
-      mbe.setProperties($(child));
-      this.elements[mbe.name] = mbe;
-    });
-    return this;
-  }
-
-  /**
-   * Gets a object with the basic attributes needed to rebuild this instance excluding functions,
-   * parent references, constants and also attributes retaining the default value.
-   * The resulting object is commonly usued to serialize elements in JSON format.
-   * @returns {object} - The resulting object, with minimal attrributes
-   */
-  getAttributes() {
-    return Object.keys(this.elements).map(k => this.elements[k].getAttributes());
-  }
-
-  /**
-   * Loads the MediaBag content from a data object
-   * @param {object} data - The data object to parse
-   */
-  setAttributes(data) {
-    if (data && data.length)
-      data.forEach(el => {
-        const mbe = new MediaBagElement(this.project.basePath, null, this.project.zip);
-        mbe.setAttributes(el);
-        this.elements[mbe.name] = mbe;
-      });
-    return this;
-  }
-
-  /**
-   * Finds a {@link module:bads/MediaBagElement.MediaBagElement} by its name, creating a new one if not found and requested.
-   * @param {string} name - The name of the element
-   * @param {boolean} [create] - When `true`, a new MediaBagElement will be created if not found,
-   * using 'name' as its file name.
-   * @returns {module:bags/MediaBagElement.MediaBagElement}
-   */
-  getElement(name, create) {
-    name = nSlash(name);
-    let result = this.elements[name];
-    if (create && !result)
-      result = this.getElementByFileName(name, create);
-    return result;
-  }
-
-  /**
-   * Gets a {@link module:bads/MediaBagElement.MediaBagElement} by its file name.
-   * @param {string} file - The requested file name
-   * @param {boolean} [create] - When `true`, a new {@link module:bads/MediaBagElement.MediaBagElement} will be created if not
-   * found.
-   * @returns {module:bags/MediaBagElement.MediaBagElement}
-   */
-  getElementByFileName(file, create) {
-    let result = null;
-    if (file) {
-      file = nSlash(file);
-      for (let name in this.elements) {
-        if (this.elements[name].file === file) {
-          result = this.elements[name];
-          break;
-        }
-      }
-      if (!result && create) {
-        result = new MediaBagElement(this.project.basePath, null, this.project.zip);
-        result.name = file;
-        result.file = file;
-        result.ext = file.toLowerCase().split('#')[0].split('.').pop();
-        result.type = result.getFileType(result.ext);
-        this.elements[result.name] = result;
-      }
-    }
-    return result;
-  }
-
-  /**
-   * Get the names of the media elements that are of the given type.
-   * When the search type is `font`, the `fontName` property is used instead of `name`
-   * @param {string} type - The type of elements to search
-   * @returns {string[]}
-   */
-  getElementsOfType(type) {
-    const result = [];
-    $.each(this.elements, (name, element) => {
-      if (element.type === type)
-        result.push(type === 'font' ? element.fontName : name);
-    });
-    return result;
-  }
-
-  /**
-   * Preloads all resources.
-   *
-   * __Use with care!__ Calling this method will start loading all the resources defined in the
-   * MediaBag, whether used or not in the current activity.
-   * @param {string} type - The type of media to be build. When `null` or `undefined`, all
-   * resources will be build.
-   * @param {function} [callback] - Function to be called when each element is ready.
-   * @param {module:JClicPlayer.JClicPlayer} [ps] - An optional `PlayStation` (currently a {@link module:JClicPlayer.JClicPlayer JClicPlayer}) used to dynamically load fonts
-   * @returns {number} - The total number of elements that will be built
-   */
-  buildAll(type, callback, ps) {
-    let count = 0;
-    $.each(this.elements, (name, element) => {
-      if (!type || element.type === type) {
-        element.build(callback, ps, false);
-        count++;
-      }
-    });
-    return count;
-  }
-
-  /**
-   * Checks if there are media waiting to be loaded
-   * @returns {number} - The amount of media elements already loaded, or -1 if all elements are ready
-   */
-  countWaitingElements() {
-    let
-      ready = 0,
-      allReady = true;
-
-    // Only for debug purposes: return always 'false'
-    // TODO: Check loading process!
-    $.each(this.elements, (name, element) => {
-      if (element.data && !element.ready && !element.checkReady() && !element.checkTimeout()) {
-        log('debug', '... waiting for: %s', name);
-        allReady = false;
-      } else
-        ready++;
-    });
-    return allReady ? -1 : ready;
-  }
-
-  /**
-   * Loads a {@link module:skins/Skin.Skin Skin} object
-   * @param {string} name - The skin name to be loaded
-   * @param {string} ps - The {@link module:JClicPlayer.JClicPlayer JClicPlayer} linked to the skin
-   * @returns {module:skins/Skin.Skin}
-   */
-  getSkinElement(name, ps) {
-    return Skin.getSkin(name, ps);
-  }
-}
-
-Object.assign(MediaBag.prototype, {
-  /**
-   * The collection of {@link module:bads/MediaBagElement.MediaBagElement} objects
-   * @name module:bags/MediaBag.MediaBag#elements
-   * @type {object} */
-  elements: null,
-  /**
-   * The JClic project to which this MediaBag belongs
-   * @name module:bags/MediaBag.MediaBag#project
-   * @type {module:project/JClicProject.JClicProject} */
-  project: null,
-});
-
-export default MediaBag;