jclic 2.2.1 → 2.3.0

package/src/boxes/TextGridContent.js

@@ -1,215 +0,0 @@
-/**
- *  File    : boxes/TextGridContent.js
- *  Created : 14/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 { settings, attrForEach, getBoolean, getAttr, setAttr } from '../Utils.js';
-import BoxBase from './BoxBase.js';
-
-/**
- * This class encapsulates the content of {@link module:boxes/TextGrid.TextGrid TextGrid} objects.
- *
- * It implements methods to set and retrieve individual characters on the grid, and parsing of
- * XML objects. It also contains information about the optimal size and other graphic properties
- * (fonts, colors, etc.) of the grid.
- */
-export class TextGridContent {
-  /**
-   * TextGridContent constructor
-   */
-  constructor() {
-    this.style = new BoxBase(null);
-    this.text = [];
-  }
-
-  /**
-   * Loads the object settings from a specific JQuery XML element
-   * @param {external:jQuery} $xml
-   */
-  setProperties($xml) {
-    // Read attributes
-    attrForEach($xml.get(0).attributes, (name, val) => {
-      switch (name) {
-        case 'rows':
-          // WARNING: Due to a bug in JClic, the meaning of "rows" and "columns" must be
-          // interchanged:
-          this.ncw = Number(val);
-          break;
-        case 'columns':
-          this.nch = Number(val);
-          break;
-        case 'cellWidth':
-          this.w = Number(val);
-          break;
-        case 'cellHeight':
-          this.h = Number(val);
-          break;
-        case 'border':
-          this.border = getBoolean(val);
-          break;
-        case 'wild':
-        case 'randomChars':
-          this[name] = val;
-          break;
-      }
-    });
-
-    // Read inner elements
-    $xml.children('style:first').each((_n, child) => {
-      this.style = new BoxBase().setProperties($(child));
-    });
-
-    $xml.find('text:first > row').each((_n, el) => this.text.push(el.textContent));
-
-    for (let i = this.text.length; i < this.nch; i++)
-      this.text[i] = '';
-
-    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, [
-      'ncw', 'nch',
-      'w', 'h',
-      'text',
-      'style', // BoxBase
-      'border',
-      'wild|*',
-      `randomChars|${settings.RANDOM_CHARS}`,
-    ]);
-  }
-
-  /**
-   * Reads the properties of this TextGridContent from a data object
-   * @param {object|string} data - The data object to be parsed, or just the text content
-   * @returns {module:boxes/TextGridContent.TextGridContent}
-   */
-  setAttributes(data) {
-    return setAttr(this, data, [
-      'ncw', 'nch',
-      'w', 'h',
-      'text',
-      { key: 'style', fn: BoxBase },
-      'border',
-      'wild',
-      `randomChars`,
-    ]);
-  }
-
-  /**
-   * Counts the number of wildcard characters present in this TextGrid
-   * @returns {number}
-   */
-  countWildChars() {
-    let result = 0;
-    if (this.text)
-      for (let y = 0; y < this.nch; y++)
-        for (let x = 0; x < this.ncw; x++)
-          if (this.text[y].charAt(x) === this.wild)
-            result++;
-    return result;
-  }
-
-  /**
-   * Counts the total number of characters, including wildcard characters.
-   * @returns {number}
-   */
-  getNumChars() {
-    return this.ncw * this.nch;
-  }
-
-  /**
-   * Sets the specified character as a content of the cell located at specific coordinates
-   * @param {number} x - The X coordinate of the cell
-   * @param {number} y - The X coordinate of the cell
-   * @param {string} ch - The character to be placed on the specified cell
-   */
-  setCharAt(x, y, ch) {
-    if (x >= 0 && x < this.ncw && y >= 0 && y < this.nch)
-      this.text[y] = this.text[y].substring(0, x) + ch + this.text[y].substring(x + 1);
-  }
-}
-
-Object.assign(TextGridContent.prototype, {
-  /**
-   * Grid columns
-   * @name module:boxes/TextGridContent.TextGridContent#ncw
-   * @type {number} */
-  ncw: 1,
-  /**
-   * Grid rows
-   * @name module:boxes/TextGridContent.TextGridContent#nch
-   * @type {number} */
-  nch: 1,
-  /**
-   * Width of cells
-   * @name module:boxes/TextGridContent.TextGridContent#w
-   * @type {number} */
-  w: 20,
-  /**
-   * Height of cells
-   * @name module:boxes/TextGridContent.TextGridContent#h
-   * @type {number} */
-  h: 20,
-  /**
-   * Whether the cells must be surrounded by a border or not
-   * @name module:boxes/TextGridContent.TextGridContent#border
-   * @type {boolean} */
-  border: false,
-  /**
-   * The {@link module:boxes/BoxBase.BoxBase BoxBase} object with visual settings of the text grid
-   * @name module:boxes/TextGridContent.TextGridContent#style
-   * @type {module:boxes/BoxBase.BoxBase} */
-  style: null,
-  /**
-   * An array of String objects textning the chars of cells. One string per row, one character of
-   * this string per cell.
-   * @name module:boxes/TextGridContent.TextGridContent#text
-   * @type {string[]} */
-  text: null,
-  /**
-   * The letter used as wildcardtext
-   * @name module:boxes/TextGridContent.TextGridContent#wild
-   * @type {string} */
-  wild: '*',
-  /**
-   * A String with the chars to take as source when randomly filling empty cells
-   * @name module:boxes/TextGridContent.TextGridContent#randomChars
-   * @type {string} */
-  randomChars: settings.RANDOM_CHARS,
-});
-
-export default TextGridContent;

package/src/init-jsdom.js

@@ -1,65 +0,0 @@
-/*!
- *  File    : init-jsdom.js
- *  Created : 12/11/2024
- *  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-2024 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
- */
-
-/* global global, globalThis */
-
-/**
- * Initializes some global variables needed for JClic in order to be used in nodeJS
- */
-
-import jsdom from 'jsdom';
-import { DOMParser } from '@xmldom/xmldom';
-
-// Create a new DOM object
-const dom = new jsdom.JSDOM('<!DOCTYPE html><head></head><body></body>', { url: 'https://example.com' });
-
-// `global` is a legacy object in NodeJS 22 and will be replaced soon by `globalThis`
-// Also, provide a fallback empty object in case of no `global` object at all (should not occur!)
-const globalObject = globalThis || global || {};
-
-// Assign global variables, only if not already assigned
-if (!globalObject.window)
-  globalObject.window = dom.window;
-if (!globalObject.document)
-  globalObject.document = dom.window.document;
-if (!globalObject.navigator)
-  globalObject.navigator = dom.window.navigator;
-if (!globalObject.Image)
-  globalObject.Image = dom.window.Image;
-if (!globalObject.Audio)
-  globalObject.Audio = dom.window.Audio;
-if (!globalObject.XMLHttpRequest)
-  globalObject.XMLHttpRequest = dom.window.XMLHttpRequest;
-if (!globalObject.DOMParser)
-  globalObject.DOMParser = DOMParser;
-
-// This is just a side-effect module
-export default {};

package/src/jclic-node.js

@@ -1,219 +0,0 @@
-/*!
- *  File    : jclic-node.js
- *  Created : 12/11/2024
- *  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-2024 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
- */
-
-// Initialize fake DOM global variables like 'window' or 'document'.
-import './init-jsdom.js';
-
-import $ from 'jquery';
-import AWT from './AWT.js';
-import Activity from './Activity.js';
-import GlobalData from './GlobalData.js';
-import JClicPlayer from './JClicPlayer.js';
-import Utils from './Utils.js';
-import PlayerHistory from './PlayerHistory.js';
-import ComplexAssociation from './activities/associations/ComplexAssociation.js';
-import SimpleAssociation from './activities/associations/SimpleAssociation.js';
-import MemoryGame from './activities/memory/MemoryGame.js';
-import Explore from './activities/panels/Explore.js';
-import Identify from './activities/panels/Identify.js';
-import InformationScreen from './activities/panels/InformationScreen.js';
-import Menu from './activities/panels/Menu.js';
-import DoublePuzzle from './activities/puzzles/DoublePuzzle.js';
-import ExchangePuzzle from './activities/puzzles/ExchangePuzzle.js';
-import HolePuzzle from './activities/puzzles/HolePuzzle.js';
-import Complete from './activities/text/Complete.js';
-import Evaluator from './activities/text/Evaluator.js';
-import FillInBlanks from './activities/text/FillInBlanks.js';
-import CrossWord from './activities/textGrid/CrossWord.js';
-import WordSearch from './activities/textGrid/WordSearch.js';
-import IdentifyText from './activities/text/IdentifyText.js';
-import OrderText from './activities/text/OrderText.js';
-import TextActivityBase from './activities/text/TextActivityBase.js';
-import TextActivityDocument from './activities/text/TextActivityDocument.js';
-import WrittenAnswer from './activities/text/WrittenAnswer.js';
-import Arith from './automation/arith/Arith.js';
-import AutoContentProvider from './automation/AutoContentProvider.js';
-import ActivitySequenceElement from './bags/ActivitySequenceElement.js';
-import ActivitySequence from './bags/ActivitySequence.js';
-import ActivitySequenceJump from './bags/ActivitySequenceJump.js';
-import ConditionalJumpInfo from './bags/ConditionalJumpInfo.js';
-import JumpInfo from './bags/JumpInfo.js';
-import MediaBagElement from './bags/MediaBagElement.js';
-import MediaBag from './bags/MediaBag.js';
-import AbstractBox from './boxes/AbstractBox.js';
-import ActiveBagContent from './boxes/ActiveBagContent.js';
-import ActiveBoxBag from './boxes/ActiveBoxBag.js';
-import ActiveBoxContent from './boxes/ActiveBoxContent.js';
-import ActiveBoxGrid from './boxes/ActiveBoxGrid.js';
-import ActiveBox from './boxes/ActiveBox.js';
-import BoxBag from './boxes/BoxBag.js';
-import BoxBase from './boxes/BoxBase.js';
-import BoxConnector from './boxes/BoxConnector.js';
-import TextGridContent from './boxes/TextGridContent.js';
-import TextGrid from './boxes/TextGrid.js';
-import ActiveMediaBag from './media/ActiveMediaBag.js';
-import ActiveMediaPlayer from './media/ActiveMediaPlayer.js';
-import AudioBuffer from './media/AudioBuffer.js';
-import EventSoundsElement from './media/EventSoundsElement.js';
-import EventSounds from './media/EventSounds.js';
-import MediaContent from './media/MediaContent.js';
-import MidiAudioPlayer from './media/MidiAudioPlayer.js';
-import JClicProject from './project/JClicProject.js';
-import ProjectSettings from './project/ProjectSettings.js';
-import ActionReg from './report/ActionReg.js';
-import ActivityReg from './report/ActivityReg.js';
-import EncryptMin from './report/EncryptMin.js';
-import Reporter from './report/Reporter.js';
-import SCORM from './report/SCORM.js';
-import SequenceReg from './report/SequenceReg.js';
-import SessionReg from './report/SessionReg.js';
-import SessionStorageReporter from './report/SessionStorageReporter.js';
-import TCPReporter from './report/TCPReporter.js';
-import ClassicJigSaw from './shapers/ClassicJigSaw.js';
-import Holes from './shapers/Holes.js';
-import JigSaw from './shapers/JigSaw.js';
-import Rectangular from './shapers/Rectangular.js';
-import Shaper from './shapers/Shaper.js';
-import TriangularJigSaw from './shapers/TriangularJigSaw.js';
-import BlueSkin from './skins/BlueSkin.js';
-import Counter from './skins/Counter.js';
-import CustomSkin from './skins/CustomSkin.js';
-import DefaultSkin from './skins/DefaultSkin.js';
-import EmptySkin from './skins/EmptySkin.js';
-import GreenSkin from './skins/GreenSkin.js';
-import MiniSkin from './skins/MiniSkin.js';
-import OrangeSkin from './skins/OrangeSkin.js';
-import SimpleSkin from './skins/SimpleSkin.js';
-import Skin from './skins/Skin.js';
-
-// Export all JClic core classes plus jQuery, so they can be used in NodeJS
-export default ({
-  $,
-  AWT,
-  Activity,
-  GlobalData,
-  JClicPlayer,
-  Utils,
-  PlayerHistory,
-  JClicProject,
-  activities: {
-    ComplexAssociation,
-    SimpleAssociation,
-    MemoryGame,
-    Explore,
-    Identify,
-    InformationScreen,
-    Menu,
-    DoublePuzzle,
-    ExchangePuzzle,
-    HolePuzzle,
-    Complete,
-    Evaluator,
-    FillInBlanks,
-    CrossWord,
-    WordSearch,
-    IdentifyText,
-    OrderText,
-    TextActivityBase,
-    TextActivityDocument,
-    WrittenAnswer,
-  },
-  automation: {
-    Arith,
-    AutoContentProvider,
-  },
-  bags: {
-    ActivitySequenceElement,
-    ActivitySequence,
-    ActivitySequenceJump,
-    ConditionalJumpInfo,
-    JumpInfo,
-    MediaBagElement,
-    MediaBag,
-  },
-  boxes: {
-    AbstractBox,
-    ActiveBagContent,
-    ActiveBoxBag,
-    ActiveBoxContent,
-    ActiveBoxGrid,
-    ActiveBox,
-    BoxBag,
-    BoxBase,
-    BoxConnector,
-    TextGridContent,
-    TextGrid,
-  },
-  media: {
-    ActiveMediaBag,
-    ActiveMediaPlayer,
-    AudioBuffer,
-    EventSoundsElement,
-    EventSounds,
-    MediaContent,
-    MidiAudioPlayer,
-  },
-  project: {
-    JClicProject,
-    ProjectSettings,
-  },
-  report: {
-    ActionReg,
-    ActivityReg,
-    EncryptMin,
-    Reporter,
-    SCORM,
-    SequenceReg,
-    SessionReg,
-    SessionStorageReporter,
-    TCPReporter,
-  },
-  shapers: {
-    ClassicJigSaw,
-    Holes,
-    JigSaw,
-    Rectangular,
-    Shaper,
-    TriangularJigSaw,
-  },
-  skins: {
-    BlueSkin,
-    Counter,
-    CustomSkin,
-    DefaultSkin,
-    EmptySkin,
-    GreenSkin,
-    MiniSkin,
-    OrangeSkin,
-    SimpleSkin,
-    Skin,
-  },
-});

package/src/media/ActiveMediaBag.js

@@ -1,145 +0,0 @@
-/**
- *  File    : media/ActiveMediaBag.js
- *  Created : 28/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 ActiveMediaPlayer from './ActiveMediaPlayer.js';
-import { settings } from '../Utils.js';
-
-/**
- * This class stores a collection of realized {@link module:media/ActiveMediaPlayer.ActiveMediaPlayer ActiveMediaPlayer} objects, related to a
- * {@link module:project/JClicProject.JClicProject JClicProject} or {@link module:Activity.Activity Activity}.
- */
-export class ActiveMediaBag {
-  /**
-   * ActiveMediaBag constructor
-   */
-  constructor() {
-    this.players = [];
-  }
-
-  /**
-   * Creates a new {@link module:media/ActiveMediaPlayer.ActiveMediaPlayer ActiveMediaPlayer} linked to this media bag
-   * @param {module:media/MediaContent.MediaContent} mc - The content used by the new player
-   * @param {module:bags/MediaBag.MediaBag} mb - The project's MediaBag
-   * @param {module:JClicPlayer.JClicPlayer} ps - An object implementing the
-   * [PlayStation](http://projectestac.github.io/jclic/apidoc/edu/xtec/jclic/PlayStation.html) interface,
-   * usually a {@link module:JClicPlayer.JClicPlayer JClicPlayer}.
-   * @returns {module:media/ActiveMediaPlayer.ActiveMediaPlayer}
-   */
-  createActiveMediaPlayer(mc, mb, ps) {
-    let amp = null;
-    switch (mc.type) {
-      case 'RECORD_AUDIO':
-        if (mc.length <= 0 || mc.length >= settings.MAX_RECORD_LENGTH)
-          break;
-      /* falls through */
-      case 'PLAY_RECORDED_AUDIO':
-        if (mc.recBuffer < 0 || mc.recBuffer >= 10)
-          break;
-      /* falls through */
-      case 'PLAY_AUDIO':
-      case 'PLAY_MIDI':
-      case 'PLAY_VIDEO':
-        amp = new ActiveMediaPlayer(mc, mb, ps);
-        break;
-    }
-    if (amp !== null)
-      this.players.push(amp);
-    return amp;
-  }
-
-  /**
-   * Looks for an already existing {@link module:media/ActiveMediaPlayer.ActiveMediaPlayer ActiveMediaPlayer} equivalent to the requested.
-   * When not found, a new one is created and and returned.
-   * @param {module:media/MediaContent.MediaContent} mc - The content used by the new player
-   * @param {module:bags/MediaBag.MediaBag} mb - The project's MediaBag
-   * @param {module:JClicPlayer.JClicPlayer} ps - An object implementing the
-   * {@link http://projectestac.github.io/jclic/apidoc/edu/xtec/jclic/PlayStation.html|PlayStation} interface,
-   * usually a {@link module:JClicPlayer.JClicPlayer JClicPlayer}.
-   * @returns {module:media/ActiveMediaPlayer.ActiveMediaPlayer}
-   */
-  getActiveMediaPlayer(mc, mb, ps) {
-    return this.players.find(p => p.mc === mc || p.mc.isEquivalent(mc))
-      || this.createActiveMediaPlayer(mc, mb, ps);
-  }
-
-  /**
-   * Removes from the list of players the {@link module:media/ActiveMediaPlayer.ActiveMediaPlayer ActiveMediaPlayer} related to the specified {@link module:media/MediaContent.MediaContent}.
-   * @param {module:media/MediaContent.MediaContent} mc - The media content to look for.
-   */
-  removeActiveMediaPlayer(mc) {
-    const i = this.players.findIndex(p => p.mc === mc);
-    if (i >= 0) {
-      this.players[i].clear();
-      // removes the element pointed by 'i'
-      this.players.splice(i, 1);
-    }
-  }
-
-  /**
-   * Realizes all the media elements stored in this bag
-   */
-  realizeAll() {
-    this.players.forEach(p => p.realize());
-  }
-
-  /**
-   * Stops playing all media elements stored in this bag
-   * @param {number} level - Level at and below what all media players will be muted.
-   */
-  stopAll(level) {
-    if (typeof level === 'undefined')
-      level = -1;
-    this.players.forEach(amp => {
-      if (level === -1 || amp.mc !== null && amp.mc.level <= level)
-        amp.stop();
-    });
-  }
-
-  /**
-   * Removes all players from this media bag
-   */
-  removeAll() {
-    this.players.forEach(p => p.clear());
-    // Empty the `players` array
-    this.players.length = 0;
-    ActiveMediaPlayer.prototype.clearAllAudioBuffers();
-  }
-}
-
-Object.assign(ActiveMediaBag.prototype, {
-  /**
-   * The collection of {@link module:media/ActiveMediaPlayer.ActiveMediaPlayer ActiveMediaPlayer} objects stored in this media bag.
-   * @name module:media/ActiveMediaBag.ActiveMediaBag#players
-   * @type {module:media/ActiveMediaPlayer.ActiveMediaPlayer[]} */
-  players: [],
-});
-
-export default ActiveMediaBag;