npm - speaker-calibration - Versions diffs - 2.2.216 → 2.2.217 - Mend

speaker-calibration 2.2.216 → 2.2.217

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (142) hide show

package/.eslintignore +71 -71
package/.eslintrc.json +40 -40
package/.gitignore +81 -0
package/.prettierignore +69 -69
package/.prettierrc +14 -14
package/LICENSE +20 -20
package/README.md +133 -133
package/__mocks__/fileMock.js +1 -1
package/__mocks__/styleMock.js +1 -1
package/babel.config.js +3 -3
package/coverage/clover.xml +71 -71
package/coverage/coverage-final.json +224 -224
package/coverage/lcov-report/PythonServerInterface.js.html +265 -265
package/coverage/lcov-report/base.css +354 -354
package/coverage/lcov-report/block-navigation.js +82 -82
package/coverage/lcov-report/favicon.png +0 -0
package/coverage/lcov-report/index.html +123 -123
package/coverage/lcov-report/prettify.css +101 -101
package/coverage/lcov-report/prettify.js +937 -937
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +189 -189
package/coverage/lcov-report/src/index.html +121 -121
package/coverage/lcov-report/src/server/PythonServerInterface.js.html +268 -268
package/coverage/lcov-report/src/server/index.html +123 -123
package/coverage/lcov-report/src/tasks/audioCalibrator.js.html +499 -499
package/coverage/lcov-report/src/tasks/audioRecorder.js.html +412 -412
package/coverage/lcov-report/src/tasks/index.html +143 -143
package/coverage/lcov-report/src/tasks/volume/index.html +123 -123
package/coverage/lcov-report/src/tasks/volume/volume.js.html +409 -409
package/coverage/lcov-report/src/utils.js.html +172 -172
package/coverage/lcov.info +91 -91
package/dist/Procfile +0 -0
package/dist/example/NoSleep.min.js +1 -1
package/dist/example/credentials.json.gpg +0 -0
package/dist/example/fetch-languages-sheets.js +77 -77
package/dist/example/i18n.js +28705 -28705
package/dist/example/index.html +47 -47
package/dist/example/listener.html +79 -79
package/dist/example/server.js +51 -51
package/dist/example/speaker.html +145 -145
package/dist/example/speakerUI.js +273 -273
package/dist/example/styles.css +99 -99
package/dist/listener.js +13 -13
package/dist/main.js +12 -12
package/dist/main.js.LICENSE.txt +0 -0
package/dist/mlsGen.js +6814 -6814
package/dist/mlsGen.wasm +0 -0
package/dist/package-lock.json +1018 -1018
package/dist/package.json +18 -18
package/doc/AudioCalibrator.html +417 -417
package/doc/AudioPeer.html +251 -251
package/doc/AudioRecorder.html +195 -195
package/doc/ImpulseResponse.html +215 -215
package/doc/Listener.html +308 -308
package/doc/MlsGenInterface.html +226 -226
package/doc/MyEventEmitter.html +274 -274
package/doc/PythonServerAPI.html +109 -109
package/doc/Speaker-Calibration-UML-Diagram.png +0 -0
package/doc/Speaker.html +276 -276
package/doc/Takes%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +128 -128
package/doc/Takes%20the%20url%20of%20the%20current%20site%0Aand%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +138 -138
package/doc/Takes%20the%20url%20of%20the%20current%20site%20and%20a%20target%20element%20where%20html%20elements%20will%20be%20appended..html +137 -137
package/doc/Volume.html +88 -88
package/doc/audioCalibrator.js.html +179 -179
package/doc/audioPeer.js.html +175 -175
package/doc/audioRecorder.js.html +163 -163
package/doc/creates%20a%20new%20AudioRecorder%20instance.%20%0ASets%20up%20the%20audio%20context%20and%20file%20reader..html +114 -114
package/doc/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/fonts/OpenSans-Bold-webfont.svg +1829 -1829
package/doc/fonts/OpenSans-Bold-webfont.woff +0 -0
package/doc/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/doc/fonts/OpenSans-BoldItalic-webfont.svg +1829 -1829
package/doc/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Italic-webfont.eot +0 -0
package/doc/fonts/OpenSans-Italic-webfont.svg +1829 -1829
package/doc/fonts/OpenSans-Italic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Light-webfont.eot +0 -0
package/doc/fonts/OpenSans-Light-webfont.svg +1830 -1830
package/doc/fonts/OpenSans-Light-webfont.woff +0 -0
package/doc/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/doc/fonts/OpenSans-LightItalic-webfont.svg +1834 -1834
package/doc/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/doc/fonts/OpenSans-Regular-webfont.eot +0 -0
package/doc/fonts/OpenSans-Regular-webfont.svg +1830 -1830
package/doc/fonts/OpenSans-Regular-webfont.woff +0 -0
package/doc/global.html +308 -308
package/doc/index.html +58 -58
package/doc/listener.js.html +170 -170
package/doc/mlsGen_mlsGenInterface.js.html +117 -117
package/doc/myEventEmitter.js.html +124 -124
package/doc/peer-connection_audioPeer.js.html +188 -188
package/doc/peer-connection_listener.js.html +311 -311
package/doc/peer-connection_speaker.js.html +381 -381
package/doc/sc-activity-diagram.png +0 -0
package/doc/scripts/linenumber.js +25 -25
package/doc/scripts/prettify/Apache-License-2.0.txt +202 -202
package/doc/scripts/prettify/lang-css.js +24 -24
package/doc/scripts/prettify/prettify.js +640 -640
package/doc/server_PythonServerAPI.js.html +160 -160
package/doc/speaker.js.html +248 -248
package/doc/styles/jsdoc-default.css +371 -371
package/doc/styles/prettify-jsdoc.css +111 -111
package/doc/styles/prettify-tomorrow.css +163 -163
package/doc/tasks_audioCalibrator.js.html +207 -207
package/doc/tasks_audioRecorder.js.html +190 -190
package/doc/tasks_impulse-response_impulseResponse.js.html +442 -442
package/doc/tasks_impulse-response_mlsGen_mlsGenInterface.js.html +175 -175
package/doc/tasks_volume_volume.js.html +185 -185
package/doc/utils.js.html +105 -105
package/jest.config.js +173 -173
package/netlify.toml +26 -26
package/package.json +78 -78
package/src/config/firebase.js +26 -26
package/src/index.html +21 -21
package/src/listener-app/listener.js +153 -153
package/src/main.js +23 -23
package/src/myEventEmitter.js +83 -83
package/src/peer-connection/audioPeer.js +183 -183
package/src/peer-connection/listener.js +369 -369
package/src/peer-connection/peerErrors.js +25 -25
package/src/peer-connection/speaker.js +765 -765
package/src/powerCheck.js +98 -98
package/src/server/PythonServerAPI.js +869 -869
package/src/tasks/audioCalibrator.js +360 -351
package/src/tasks/audioRecorder.js +315 -315
package/src/tasks/combination/combination.js +3160 -3160
package/src/tasks/combination/mlsGen/mlsGen.cpp +98 -98
package/src/tasks/combination/mlsGen/mlsGen.hpp +303 -303
package/src/tasks/combination/mlsGen/mlsGenInterface.js +131 -131
package/src/tasks/combination/mlsGen/mlsGenTest.cpp +180 -180
package/src/tasks/impulse-response/impulseResponse.js +610 -610
package/src/tasks/impulse-response/mlsGen/mlsGen.cpp +98 -98
package/src/tasks/impulse-response/mlsGen/mlsGen.hpp +303 -303
package/src/tasks/impulse-response/mlsGen/mlsGenInterface.js +131 -131
package/src/tasks/impulse-response/mlsGen/mlsGenTest.cpp +180 -180
package/src/tasks/volume/volume.cpp +2 -2
package/src/tasks/volume/volume.hpp +22 -22
package/src/tasks/volume/volume.js +279 -279
package/src/utils.js +205 -205
package/webpack.config.js +64 -64
package/.github/workflows/update-phrases.yml +0 -37
package/makefile +0 -74

package/src/index.html CHANGED Viewed

@@ -1,21 +1,21 @@
-<!DOCTYPE html>
-<html class="no-js" lang="">
-  <head>
-    <meta charset="utf-8" />
-    <meta http-equiv="x-ua-compatible" content="ie=edge" />
-    <title>Sound Check</title>
-    <meta name="description" content="" />
-    <meta name="viewport" content="width=device-width, initial-scale=1" />
-    <link rel="apple-touch-icon" href="/apple-touch-icon.png" />
-    <!-- Place favicon.ico in the root directory -->
-  </head>
-  <body>
-    <!--[if lt IE 8]>
-      <p class="browserupgrade">
-        You are using an <strong>outdated</strong> browser. Please
-        <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.
-      </p>
-    <![endif]-->
-  </body>
-</html>
+<!DOCTYPE html>
+<html class="no-js" lang="">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="x-ua-compatible" content="ie=edge" />
+    <title>Sound Check</title>
+    <meta name="description" content="" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <link rel="apple-touch-icon" href="/apple-touch-icon.png" />
+    <!-- Place favicon.ico in the root directory -->
+  </head>
+  <body>
+    <!--[if lt IE 8]>
+      <p class="browserupgrade">
+        You are using an <strong>outdated</strong> browser. Please
+        <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.
+      </p>
+    <![endif]-->
+  </body>
+</html>

package/src/listener-app/listener.js CHANGED Viewed

@@ -1,153 +1,153 @@
-// get element with id message
-import {phrases} from '../../dist/example/i18n.js';
-import {Listener} from '../main.js';
-// get url query parameters
-const urlParams = new URLSearchParams(window.location.search);
-// get isSmartPhone query parameter
-const isSmartPhone = urlParams.get('sp'); // previous isSmartPhone
-const listenerParameters = {
-  targetElementId: 'display',
-  microphoneFromAPI: '',
-  microphoneDeviceId: '',
-};
-const container = document.getElementById('listenerContainer');
-const recordingInProgress = phrases.RC_soundRecording['en-US'];
-const backToExperimentWindow = phrases.RC_backToExperimentWindow['en-US'];
-const allowMicrophone = phrases.RC_allowMicrophoneUse['en-US'].replace(/\n/g, '<br>');
-const placeSmartphoneMicrophone = phrases.RC_placeSmartphoneMicrophone['en-US'].replace(
-  /\n/g,
-  '<br>'
-);
-const turnMeToReadBelow = phrases.RC_turnMeToReadBelow['en-US'].replace(/\n/g, '<br>');
-const recordingInProgressElement = document.getElementById('recordingInProgress');
-const allowMicrophoneElement = document.getElementById('allowMicrophone');
-const turnMessageElement = document.getElementById('turnMeToReadBelow');
-switch (isSmartPhone) {
-  case 'true':
-    allowMicrophoneElement.innerHTML = placeSmartphoneMicrophone;
-    allowMicrophoneElement.style.lineHeight = '1.2rem';
-    allowMicrophoneElement.style.fontSize = '14px';
-    turnMessageElement.innerHTML = turnMeToReadBelow;
-    turnMessageElement.style.lineHeight = '1.2rem';
-    turnMessageElement.style.fontSize = '14px';
-    // show the html upsidedown
-    const phrasesContainer = document.getElementById('phrases');
-    // add class
-    phrasesContainer.classList.add('phrases');
-    const html = document.querySelector('html');
-    html.style.overflow = 'hidden';
-    const display = document.getElementById('updateDisplay');
-    display.classList.add('updateDisplay');
-    container.style.display = 'block';
-    // event listener for id calibrationBeginButton
-    const calibrationBeginButton = document.getElementById('calibrationBeginButton');
-    console.log('Waiting for proceed button click');
-    calibrationBeginButton.addEventListener('click', async () => {
-      console.log('Proceed button clicked');
-      // remove the button
-      calibrationBeginButton.remove();
-      // remove turn message
-      turnMessageElement.remove();
-      // set the text of the html elements
-      recordingInProgressElement.innerHTML = recordingInProgress;
-      allowMicrophoneElement.innerHTML = allowMicrophone;
-      recordingInProgressElement.style.whiteSpace = 'nowrap';
-      recordingInProgressElement.style.fontWeight = 'bold';
-      // fit content
-      recordingInProgressElement.style.width = 'fit-content';
-      let fontSize = 100;
-      recordingInProgressElement.style.fontSize = fontSize + 'px';
-      console.log('Adjusting font size for recording in progress text');
-      while (recordingInProgressElement.scrollWidth > window.innerWidth * 0.9 && fontSize > 10) {
-        fontSize--;
-        recordingInProgressElement.style.fontSize = fontSize + 'px';
-      }
-      console.log('Done adjusting font size for recording in progress text');
-      const webAudioDeviceNames = {microphone: '', deviceID: ''};
-      const externalMicList = ['UMIK', 'Airpods', 'Bluetooth'];
-      try {
-        console.log('Getting user media...Should ask for microphone permission');
-        const stream = await navigator.mediaDevices.getUserMedia({audio: true});
-        console.log('Got user media');
-        if (stream) {
-          console.log('Getting devices');
-          const devices = await navigator.mediaDevices.enumerateDevices();
-          console.log(devices);
-          const mics = devices.filter(device => device.kind === 'audioinput');
-          mics.forEach(mic => {
-            if (externalMicList.some(externalMic => mic.label.includes(externalMic))) {
-              webAudioDeviceNames.microphone = mic.label;
-              webAudioDeviceNames.deviceID = mic.deviceId;
-            }
-          });
-          if (webAudioDeviceNames.microphone === '') {
-            webAudioDeviceNames.microphone = mics[0].label;
-            webAudioDeviceNames.deviceID = mics[0].deviceId;
-          }
-        }
-      } catch (err) {
-        console.log(err);
-      }
-      listenerParameters.microphoneFromAPI = webAudioDeviceNames.microphone;
-      listenerParameters.microphoneDeviceId = webAudioDeviceNames.microphone;
-      let lock = null;
-      try {
-        if ('wakeLock' in navigator) {
-          lock = await navigator.wakeLock.request('screen');
-        }
-      } catch (err) {
-        console.log(err);
-      }
-      console.log(lock);
-      console.log('Starting Calibration');
-      console.log('Device id in example listenr:', listenerParameters.microphoneDeviceId);
-      window.listener = new Listener(listenerParameters);
-      console.log(window.listener);
-      if (lock) {
-        lock.release();
-      }
-    });
-    break;
-  case 'false':
-    // remove the button
-    const calibrationBeginButton2 = document.getElementById('calibrationBeginButton');
-    calibrationBeginButton2.remove();
-    container.style.display = 'block';
-    // event listener for when the page is loaded
-    window.addEventListener('load', () => {
-      // set the text of the html elements
-      recordingInProgressElement.innerHTML = recordingInProgress;
-      allowMicrophoneElement.innerHTML = allowMicrophone;
-      recordingInProgressElement.style.whiteSpace = 'nowrap';
-      recordingInProgressElement.style.fontWeight = 'bold';
-      // fit content
-      recordingInProgressElement.style.width = 'fit-content';
-      let fontSize = 100;
-      recordingInProgressElement.style.fontSize = fontSize + 'px';
-      while (recordingInProgressElement.scrollWidth > window.innerWidth * 0.9 && fontSize > 10) {
-        fontSize--;
-        recordingInProgressElement.style.fontSize = fontSize + 'px';
-      }
-      const message = document.getElementById('message');
-      message.style.lineHeight = '2.5rem';
-      const p = document.createElement('p');
-      p.innerHTML = backToExperimentWindow;
-      message.appendChild(p);
-      listenerParameters.microphoneDeviceId = urlParams.get('deviceId');
-      window.listener = new Listener(listenerParameters);
-      console.log(window.listener);
-    });
-    break;
-}
+// get element with id message
+import {phrases} from '../../dist/example/i18n.js';
+import {Listener} from '../main.js';
+// get url query parameters
+const urlParams = new URLSearchParams(window.location.search);
+// get isSmartPhone query parameter
+const isSmartPhone = urlParams.get('sp'); // previous isSmartPhone
+const listenerParameters = {
+  targetElementId: 'display',
+  microphoneFromAPI: '',
+  microphoneDeviceId: '',
+};
+const container = document.getElementById('listenerContainer');
+const recordingInProgress = phrases.RC_soundRecording['en-US'];
+const backToExperimentWindow = phrases.RC_backToExperimentWindow['en-US'];
+const allowMicrophone = phrases.RC_allowMicrophoneUse['en-US'].replace(/\n/g, '<br>');
+const placeSmartphoneMicrophone = phrases.RC_placeSmartphoneMicrophone['en-US'].replace(
+  /\n/g,
+  '<br>'
+);
+const turnMeToReadBelow = phrases.RC_turnMeToReadBelow['en-US'].replace(/\n/g, '<br>');
+const recordingInProgressElement = document.getElementById('recordingInProgress');
+const allowMicrophoneElement = document.getElementById('allowMicrophone');
+const turnMessageElement = document.getElementById('turnMeToReadBelow');
+switch (isSmartPhone) {
+  case 'true':
+    allowMicrophoneElement.innerHTML = placeSmartphoneMicrophone;
+    allowMicrophoneElement.style.lineHeight = '1.2rem';
+    allowMicrophoneElement.style.fontSize = '14px';
+    turnMessageElement.innerHTML = turnMeToReadBelow;
+    turnMessageElement.style.lineHeight = '1.2rem';
+    turnMessageElement.style.fontSize = '14px';
+    // show the html upsidedown
+    const phrasesContainer = document.getElementById('phrases');
+    // add class
+    phrasesContainer.classList.add('phrases');
+    const html = document.querySelector('html');
+    html.style.overflow = 'hidden';
+    const display = document.getElementById('updateDisplay');
+    display.classList.add('updateDisplay');
+    container.style.display = 'block';
+    // event listener for id calibrationBeginButton
+    const calibrationBeginButton = document.getElementById('calibrationBeginButton');
+    console.log('Waiting for proceed button click');
+    calibrationBeginButton.addEventListener('click', async () => {
+      console.log('Proceed button clicked');
+      // remove the button
+      calibrationBeginButton.remove();
+      // remove turn message
+      turnMessageElement.remove();
+      // set the text of the html elements
+      recordingInProgressElement.innerHTML = recordingInProgress;
+      allowMicrophoneElement.innerHTML = allowMicrophone;
+      recordingInProgressElement.style.whiteSpace = 'nowrap';
+      recordingInProgressElement.style.fontWeight = 'bold';
+      // fit content
+      recordingInProgressElement.style.width = 'fit-content';
+      let fontSize = 100;
+      recordingInProgressElement.style.fontSize = fontSize + 'px';
+      console.log('Adjusting font size for recording in progress text');
+      while (recordingInProgressElement.scrollWidth > window.innerWidth * 0.9 && fontSize > 10) {
+        fontSize--;
+        recordingInProgressElement.style.fontSize = fontSize + 'px';
+      }
+      console.log('Done adjusting font size for recording in progress text');
+      const webAudioDeviceNames = {microphone: '', deviceID: ''};
+      const externalMicList = ['UMIK', 'Airpods', 'Bluetooth'];
+      try {
+        console.log('Getting user media...Should ask for microphone permission');
+        const stream = await navigator.mediaDevices.getUserMedia({audio: true});
+        console.log('Got user media');
+        if (stream) {
+          console.log('Getting devices');
+          const devices = await navigator.mediaDevices.enumerateDevices();
+          console.log(devices);
+          const mics = devices.filter(device => device.kind === 'audioinput');
+          mics.forEach(mic => {
+            if (externalMicList.some(externalMic => mic.label.includes(externalMic))) {
+              webAudioDeviceNames.microphone = mic.label;
+              webAudioDeviceNames.deviceID = mic.deviceId;
+            }
+          });
+          if (webAudioDeviceNames.microphone === '') {
+            webAudioDeviceNames.microphone = mics[0].label;
+            webAudioDeviceNames.deviceID = mics[0].deviceId;
+          }
+        }
+      } catch (err) {
+        console.log(err);
+      }
+      listenerParameters.microphoneFromAPI = webAudioDeviceNames.microphone;
+      listenerParameters.microphoneDeviceId = webAudioDeviceNames.microphone;
+      let lock = null;
+      try {
+        if ('wakeLock' in navigator) {
+          lock = await navigator.wakeLock.request('screen');
+        }
+      } catch (err) {
+        console.log(err);
+      }
+      console.log(lock);
+      console.log('Starting Calibration');
+      console.log('Device id in example listenr:', listenerParameters.microphoneDeviceId);
+      window.listener = new Listener(listenerParameters);
+      console.log(window.listener);
+      if (lock) {
+        lock.release();
+      }
+    });
+    break;
+  case 'false':
+    // remove the button
+    const calibrationBeginButton2 = document.getElementById('calibrationBeginButton');
+    calibrationBeginButton2.remove();
+    container.style.display = 'block';
+    // event listener for when the page is loaded
+    window.addEventListener('load', () => {
+      // set the text of the html elements
+      recordingInProgressElement.innerHTML = recordingInProgress;
+      allowMicrophoneElement.innerHTML = allowMicrophone;
+      recordingInProgressElement.style.whiteSpace = 'nowrap';
+      recordingInProgressElement.style.fontWeight = 'bold';
+      // fit content
+      recordingInProgressElement.style.width = 'fit-content';
+      let fontSize = 100;
+      recordingInProgressElement.style.fontSize = fontSize + 'px';
+      while (recordingInProgressElement.scrollWidth > window.innerWidth * 0.9 && fontSize > 10) {
+        fontSize--;
+        recordingInProgressElement.style.fontSize = fontSize + 'px';
+      }
+      const message = document.getElementById('message');
+      message.style.lineHeight = '2.5rem';
+      const p = document.createElement('p');
+      p.innerHTML = backToExperimentWindow;
+      message.appendChild(p);
+      listenerParameters.microphoneDeviceId = urlParams.get('deviceId');
+      window.listener = new Listener(listenerParameters);
+      console.log(window.listener);
+    });
+    break;
+}

package/src/main.js CHANGED Viewed

@@ -1,23 +1,23 @@
-import Listener from './peer-connection/listener';
-import Speaker from './peer-connection/speaker';
-import VolumeCalibration from './tasks/volume/volume';
-import ImpulseResponseCalibration from './tasks/impulse-response/impulseResponse';
-import CombinationCalibration from './tasks/combination/combination';
-import {
-  UnsupportedDeviceError,
-  MissingSpeakerIdError,
-  CalibrationTimedOutError,
-} from './peer-connection/peerErrors';
-export {
-  Listener,
-  Speaker,
-  VolumeCalibration,
-  ImpulseResponseCalibration,
-  UnsupportedDeviceError,
-  MissingSpeakerIdError,
-  CalibrationTimedOutError,
-  CombinationCalibration,
-};
+import Listener from './peer-connection/listener';
+import Speaker from './peer-connection/speaker';
+import VolumeCalibration from './tasks/volume/volume';
+import ImpulseResponseCalibration from './tasks/impulse-response/impulseResponse';
+import CombinationCalibration from './tasks/combination/combination';
+import {
+  UnsupportedDeviceError,
+  MissingSpeakerIdError,
+  CalibrationTimedOutError,
+} from './peer-connection/peerErrors';
+export {
+  Listener,
+  Speaker,
+  VolumeCalibration,
+  ImpulseResponseCalibration,
+  UnsupportedDeviceError,
+  MissingSpeakerIdError,
+  CalibrationTimedOutError,
+  CombinationCalibration,
+};

package/src/myEventEmitter.js CHANGED Viewed

@@ -1,83 +1,83 @@
-/**
- * A simple event emitter class. Objects that inheret this class or implement it can then bubble events up to the UI
- * similar to existings event emitter such as 'onChange' or 'onClick'.
- */
-class MyEventEmitter {
-  #events;
-  /** .
-   * .
-   * .
-   * Default constructor, intializes an empty object to store events
-   *
-   * @example
-   */
-  constructor() {
-    this.#events = {};
-  }
-  /**
-   * The external API for this class. Gets called with an event name and a callback function that is fired when the event is emitted.
-   *
-   * @param name
-   * @param listener
-   * @example
-   */
-  on(name, listener) {
-    if (!this.#events[name]) {
-      this.#events[name] = [];
-    }
-    this.#events[name].push(listener);
-  }
-  /** .
-   * .
-   * .
-   * Function to remove a listener that was previously set
-   *
-   * @param {*} name
-   * @param {*} listenerToRemove
-   * @example
-   */
-  removeListener(name, listenerToRemove) {
-    if (!this.#events[name]) {
-      throw new Error(`Can't remove a listener. Event "${name}" doesn't exits.`);
-    }
-    /**
-     *
-     * @param listener
-     * @example
-     */
-    const filterListeners = listener => listener !== listenerToRemove;
-    this.#events[name] = this.#events[name].filter(filterListeners);
-  }
-  /**
-   * The internal API for this class. Gets called with an event name and a data object.
-   * Any callbacks that have been set to listen to the matching event are dispatched.
-   *
-   * @param name
-   * @param data
-   * @example
-   */
-  emit(name, data) {
-    if (!this.#events[name]) {
-      throw new Error(`Can't emit an event. Event "${name}" doesn't exits.`);
-    }
-    /**
-     *
-     * @param {*} callback
-     */
-    const fireCallbacks = callback => {
-      callback(data);
-    };
-    this.#events[name].forEach(fireCallbacks);
-  }
-}
-export default MyEventEmitter;
+/**
+ * A simple event emitter class. Objects that inheret this class or implement it can then bubble events up to the UI
+ * similar to existings event emitter such as 'onChange' or 'onClick'.
+ */
+class MyEventEmitter {
+  #events;
+  /** .
+   * .
+   * .
+   * Default constructor, intializes an empty object to store events
+   *
+   * @example
+   */
+  constructor() {
+    this.#events = {};
+  }
+  /**
+   * The external API for this class. Gets called with an event name and a callback function that is fired when the event is emitted.
+   *
+   * @param name
+   * @param listener
+   * @example
+   */
+  on(name, listener) {
+    if (!this.#events[name]) {
+      this.#events[name] = [];
+    }
+    this.#events[name].push(listener);
+  }
+  /** .
+   * .
+   * .
+   * Function to remove a listener that was previously set
+   *
+   * @param {*} name
+   * @param {*} listenerToRemove
+   * @example
+   */
+  removeListener(name, listenerToRemove) {
+    if (!this.#events[name]) {
+      throw new Error(`Can't remove a listener. Event "${name}" doesn't exits.`);
+    }
+    /**
+     *
+     * @param listener
+     * @example
+     */
+    const filterListeners = listener => listener !== listenerToRemove;
+    this.#events[name] = this.#events[name].filter(filterListeners);
+  }
+  /**
+   * The internal API for this class. Gets called with an event name and a data object.
+   * Any callbacks that have been set to listen to the matching event are dispatched.
+   *
+   * @param name
+   * @param data
+   * @example
+   */
+  emit(name, data) {
+    if (!this.#events[name]) {
+      throw new Error(`Can't emit an event. Event "${name}" doesn't exits.`);
+    }
+    /**
+     *
+     * @param {*} callback
+     */
+    const fireCallbacks = callback => {
+      callback(data);
+    };
+    this.#events[name].forEach(fireCallbacks);
+  }
+}
+export default MyEventEmitter;