@jspsych/plugin-audio-slider-response 1.1.3 → 2.0.1

package/dist/index.js

@@ -1,351 +1,305 @@
+import autoBind from 'auto-bind';
 import { ParameterType } from 'jspsych';
 
+var _package = {
+  name: "@jspsych/plugin-audio-slider-response",
+  version: "2.0.1",
+  description: "",
+  type: "module",
+  main: "dist/index.cjs",
+  exports: {
+    import: "./dist/index.js",
+    require: "./dist/index.cjs"
+  },
+  typings: "dist/index.d.ts",
+  unpkg: "dist/index.browser.min.js",
+  files: [
+    "src",
+    "dist"
+  ],
+  source: "src/index.ts",
+  scripts: {
+    test: "jest  --passWithNoTests",
+    "test:watch": "npm test -- --watch",
+    tsc: "tsc",
+    build: "rollup --config",
+    "build:watch": "npm run build -- --watch"
+  },
+  repository: {
+    type: "git",
+    url: "git+https://github.com/jspsych/jsPsych.git",
+    directory: "packages/plugin-audio-slider-response"
+  },
+  author: "Josh de Leeuw",
+  license: "MIT",
+  bugs: {
+    url: "https://github.com/jspsych/jsPsych/issues"
+  },
+  homepage: "https://www.jspsych.org/latest/plugins/audio-slider-response",
+  peerDependencies: {
+    jspsych: ">=7.1.0"
+  },
+  devDependencies: {
+    "@jspsych/config": "^3.0.0",
+    "@jspsych/test-utils": "^1.2.0"
+  }
+};
+
 const info = {
-    name: "audio-slider-response",
-    parameters: {
-        /** The audio file to be played. */
-        stimulus: {
-            type: ParameterType.AUDIO,
-            pretty_name: "Stimulus",
-            default: undefined,
-        },
-        /** Sets the minimum value of the slider. */
-        min: {
-            type: ParameterType.INT,
-            pretty_name: "Min slider",
-            default: 0,
-        },
-        /** Sets the maximum value of the slider */
-        max: {
-            type: ParameterType.INT,
-            pretty_name: "Max slider",
-            default: 100,
-        },
-        /** Sets the starting value of the slider */
-        slider_start: {
-            type: ParameterType.INT,
-            pretty_name: "Slider starting value",
-            default: 50,
-        },
-        /** Sets the step of the slider */
-        step: {
-            type: ParameterType.INT,
-            pretty_name: "Step",
-            default: 1,
-        },
-        /** Array containing the labels for the slider. Labels will be displayed at equidistant locations along the slider. */
-        labels: {
-            type: ParameterType.HTML_STRING,
-            pretty_name: "Labels",
-            default: [],
-            array: true,
-        },
-        /** Width of the slider in pixels. */
-        slider_width: {
-            type: ParameterType.INT,
-            pretty_name: "Slider width",
-            default: null,
-        },
-        /** Label of the button to advance. */
-        button_label: {
-            type: ParameterType.STRING,
-            pretty_name: "Button label",
-            default: "Continue",
-            array: false,
-        },
-        /** If true, the participant will have to move the slider before continuing. */
-        require_movement: {
-            type: ParameterType.BOOL,
-            pretty_name: "Require movement",
-            default: false,
-        },
-        /** Any content here will be displayed below the slider. */
-        prompt: {
-            type: ParameterType.HTML_STRING,
-            pretty_name: "Prompt",
-            default: null,
-        },
-        /** How long to show the trial. */
-        trial_duration: {
-            type: ParameterType.INT,
-            pretty_name: "Trial duration",
-            default: null,
-        },
-        /** If true, trial will end when user makes a response. */
-        response_ends_trial: {
-            type: ParameterType.BOOL,
-            pretty_name: "Response ends trial",
-            default: true,
-        },
-        /** If true, then the trial will end as soon as the audio file finishes playing. */
-        trial_ends_after_audio: {
-            type: ParameterType.BOOL,
-            pretty_name: "Trial ends after audio",
-            default: false,
-        },
-        /** If true, then responses are allowed while the audio is playing. If false, then the audio must finish playing before a response is accepted. */
-        response_allowed_while_playing: {
-            type: ParameterType.BOOL,
-            pretty_name: "Response allowed while playing",
-            default: true,
-        },
+  name: "audio-slider-response",
+  version: _package.version,
+  parameters: {
+    stimulus: {
+      type: ParameterType.AUDIO,
+      default: void 0
+    },
+    min: {
+      type: ParameterType.INT,
+      default: 0
+    },
+    max: {
+      type: ParameterType.INT,
+      default: 100
+    },
+    slider_start: {
+      type: ParameterType.INT,
+      default: 50
+    },
+    step: {
+      type: ParameterType.INT,
+      default: 1
+    },
+    labels: {
+      type: ParameterType.HTML_STRING,
+      default: [],
+      array: true
+    },
+    slider_width: {
+      type: ParameterType.INT,
+      default: null
+    },
+    button_label: {
+      type: ParameterType.STRING,
+      default: "Continue",
+      array: false
+    },
+    require_movement: {
+      type: ParameterType.BOOL,
+      default: false
+    },
+    prompt: {
+      type: ParameterType.HTML_STRING,
+      default: null
+    },
+    trial_duration: {
+      type: ParameterType.INT,
+      default: null
+    },
+    response_ends_trial: {
+      type: ParameterType.BOOL,
+      default: true
     },
+    trial_ends_after_audio: {
+      type: ParameterType.BOOL,
+      default: false
+    },
+    response_allowed_while_playing: {
+      type: ParameterType.BOOL,
+      default: true
+    }
+  },
+  data: {
+    response: {
+      type: ParameterType.INT
+    },
+    rt: {
+      type: ParameterType.INT
+    },
+    stimulus: {
+      type: ParameterType.STRING
+    },
+    slider_start: {
+      type: ParameterType.INT
+    }
+  }
 };
-/**
- * **audio-slider-response**
- *
- * jsPsych plugin for playing audio and getting a slider response
- *
- * @author Josh de Leeuw
- * @see {@link https://www.jspsych.org/plugins/jspsych-audio-slider-response/ audio-slider-response plugin documentation on jspsych.org}
- */
 class AudioSliderResponsePlugin {
-    constructor(jsPsych) {
-        this.jsPsych = jsPsych;
-    }
-    trial(display_element, trial, on_load) {
-        // hold the .resolve() function from the Promise that ends the trial
-        let trial_complete;
-        // half of the thumb width value from jspsych.css, used to adjust the label positions
-        var half_thumb_width = 7.5;
-        // setup stimulus
-        var context = this.jsPsych.pluginAPI.audioContext();
-        // record webaudio context start time
-        var startTime;
-        // for storing data related to response
-        var response;
-        // load audio file
-        this.jsPsych.pluginAPI
-            .getAudioBuffer(trial.stimulus)
-            .then((buffer) => {
-            if (context !== null) {
-                this.audio = context.createBufferSource();
-                this.audio.buffer = buffer;
-                this.audio.connect(context.destination);
-            }
-            else {
-                this.audio = buffer;
-                this.audio.currentTime = 0;
-            }
-            setupTrial();
-        })
-            .catch((err) => {
-            console.error(`Failed to load audio file "${trial.stimulus}". Try checking the file path. We recommend using the preload plugin to load audio files.`);
-            console.error(err);
-        });
-        const setupTrial = () => {
-            // set up end event if trial needs it
-            if (trial.trial_ends_after_audio) {
-                this.audio.addEventListener("ended", end_trial);
-            }
-            // enable slider after audio ends if necessary
-            if (!trial.response_allowed_while_playing && !trial.trial_ends_after_audio) {
-                this.audio.addEventListener("ended", enable_slider);
-            }
-            var html = '<div id="jspsych-audio-slider-response-wrapper" style="margin: 100px 0px;">';
-            html +=
-                '<div class="jspsych-audio-slider-response-container" style="position:relative; margin: 0 auto 3em auto; width:';
-            if (trial.slider_width !== null) {
-                html += trial.slider_width + "px;";
-            }
-            else {
-                html += "auto;";
-            }
-            html += '">';
-            html +=
-                '<input type="range" class="jspsych-slider" value="' +
-                    trial.slider_start +
-                    '" min="' +
-                    trial.min +
-                    '" max="' +
-                    trial.max +
-                    '" step="' +
-                    trial.step +
-                    '" id="jspsych-audio-slider-response-response"';
-            if (!trial.response_allowed_while_playing) {
-                html += " disabled";
-            }
-            html += "></input><div>";
-            for (var j = 0; j < trial.labels.length; j++) {
-                var label_width_perc = 100 / (trial.labels.length - 1);
-                var percent_of_range = j * (100 / (trial.labels.length - 1));
-                var percent_dist_from_center = ((percent_of_range - 50) / 50) * 100;
-                var offset = (percent_dist_from_center * half_thumb_width) / 100;
-                html +=
-                    '<div style="border: 1px solid transparent; display: inline-block; position: absolute; ' +
-                        "left:calc(" +
-                        percent_of_range +
-                        "% - (" +
-                        label_width_perc +
-                        "% / 2) - " +
-                        offset +
-                        "px); text-align: center; width: " +
-                        label_width_perc +
-                        '%;">';
-                html += '<span style="text-align: center; font-size: 80%;">' + trial.labels[j] + "</span>";
-                html += "</div>";
-            }
-            html += "</div>";
-            html += "</div>";
-            html += "</div>";
-            if (trial.prompt !== null) {
-                html += trial.prompt;
-            }
-            // add submit button
-            var next_disabled_attribute = "";
-            if (trial.require_movement || !trial.response_allowed_while_playing) {
-                next_disabled_attribute = "disabled";
-            }
-            html +=
-                '<button id="jspsych-audio-slider-response-next" class="jspsych-btn" ' +
-                    next_disabled_attribute +
-                    ">" +
-                    trial.button_label +
-                    "</button>";
-            display_element.innerHTML = html;
-            response = {
-                rt: null,
-                response: null,
-            };
-            if (!trial.response_allowed_while_playing) {
-                display_element.querySelector("#jspsych-audio-slider-response-response").disabled = true;
-                display_element.querySelector("#jspsych-audio-slider-response-next").disabled = true;
-            }
-            if (trial.require_movement) {
-                const enable_button = () => {
-                    display_element.querySelector("#jspsych-audio-slider-response-next").disabled = false;
-                };
-                display_element
-                    .querySelector("#jspsych-audio-slider-response-response")
-                    .addEventListener("mousedown", enable_button);
-                display_element
-                    .querySelector("#jspsych-audio-slider-response-response")
-                    .addEventListener("touchstart", enable_button);
-                display_element
-                    .querySelector("#jspsych-audio-slider-response-response")
-                    .addEventListener("change", enable_button);
-            }
-            display_element
-                .querySelector("#jspsych-audio-slider-response-next")
-                .addEventListener("click", () => {
-                // measure response time
-                var endTime = performance.now();
-                var rt = Math.round(endTime - startTime);
-                if (context !== null) {
-                    endTime = context.currentTime;
-                    rt = Math.round((endTime - startTime) * 1000);
-                }
-                response.rt = rt;
-                response.response = display_element.querySelector("#jspsych-audio-slider-response-response").valueAsNumber;
-                if (trial.response_ends_trial) {
-                    end_trial();
-                }
-                else {
-                    display_element.querySelector("#jspsych-audio-slider-response-next").disabled = true;
-                }
-            });
-            startTime = performance.now();
-            // start audio
-            if (context !== null) {
-                startTime = context.currentTime;
-                this.audio.start(startTime);
-            }
-            else {
-                this.audio.play();
-            }
-            // end trial if trial_duration is set
-            if (trial.trial_duration !== null) {
-                this.jsPsych.pluginAPI.setTimeout(() => {
-                    end_trial();
-                }, trial.trial_duration);
-            }
-            on_load();
+  constructor(jsPsych) {
+    this.jsPsych = jsPsych;
+    this.response = { rt: null, response: null };
+    this.setupTrial = () => {
+      if (this.params.trial_ends_after_audio) {
+        this.audio.addEventListener("ended", this.end_trial);
+      }
+      if (!this.params.response_allowed_while_playing && !this.params.trial_ends_after_audio) {
+        this.audio.addEventListener("ended", this.enable_slider);
+      }
+      var html = '<div id="jspsych-audio-slider-response-wrapper" style="margin: 100px 0px;">';
+      html += '<div class="jspsych-audio-slider-response-container" style="position:relative; margin: 0 auto 3em auto; width:';
+      if (this.params.slider_width !== null) {
+        html += this.params.slider_width + "px;";
+      } else {
+        html += "auto;";
+      }
+      html += '">';
+      html += '<input type="range" class="jspsych-slider" value="' + this.params.slider_start + '" min="' + this.params.min + '" max="' + this.params.max + '" step="' + this.params.step + '" id="jspsych-audio-slider-response-response"';
+      if (!this.params.response_allowed_while_playing) {
+        html += " disabled";
+      }
+      html += "></input><div>";
+      for (var j = 0; j < this.params.labels.length; j++) {
+        var label_width_perc = 100 / (this.params.labels.length - 1);
+        var percent_of_range = j * (100 / (this.params.labels.length - 1));
+        var percent_dist_from_center = (percent_of_range - 50) / 50 * 100;
+        var offset = percent_dist_from_center * this.half_thumb_width / 100;
+        html += '<div style="border: 1px solid transparent; display: inline-block; position: absolute; left:calc(' + percent_of_range + "% - (" + label_width_perc + "% / 2) - " + offset + "px); text-align: center; width: " + label_width_perc + '%;">';
+        html += '<span style="text-align: center; font-size: 80%;">' + this.params.labels[j] + "</span>";
+        html += "</div>";
+      }
+      html += "</div>";
+      html += "</div>";
+      html += "</div>";
+      if (this.params.prompt !== null) {
+        html += this.params.prompt;
+      }
+      var next_disabled_attribute = "";
+      if (this.params.require_movement || !this.params.response_allowed_while_playing) {
+        next_disabled_attribute = "disabled";
+      }
+      html += '<button id="jspsych-audio-slider-response-next" class="jspsych-btn" ' + next_disabled_attribute + ">" + this.params.button_label + "</button>";
+      this.display.innerHTML = html;
+      this.response = {
+        rt: null,
+        response: null
+      };
+      if (!this.params.response_allowed_while_playing) {
+        this.display.querySelector(
+          "#jspsych-audio-slider-response-response"
+        ).disabled = true;
+        this.display.querySelector("#jspsych-audio-slider-response-next").disabled = true;
+      }
+      if (this.params.require_movement) {
+        const enable_button = () => {
+          this.display.querySelector(
+            "#jspsych-audio-slider-response-next"
+          ).disabled = false;
         };
-        // function to enable slider after audio ends
-        function enable_slider() {
-            document.querySelector("#jspsych-audio-slider-response-response").disabled =
-                false;
-            if (!trial.require_movement) {
-                document.querySelector("#jspsych-audio-slider-response-next").disabled =
-                    false;
-            }
+        this.display.querySelector("#jspsych-audio-slider-response-response").addEventListener("mousedown", enable_button);
+        this.display.querySelector("#jspsych-audio-slider-response-response").addEventListener("touchstart", enable_button);
+        this.display.querySelector("#jspsych-audio-slider-response-response").addEventListener("change", enable_button);
+      }
+      this.display.querySelector("#jspsych-audio-slider-response-next").addEventListener("click", () => {
+        var endTime = performance.now();
+        var rt = Math.round(endTime - this.startTime);
+        if (this.context !== null) {
+          endTime = this.context.currentTime;
+          rt = Math.round((endTime - this.startTime) * 1e3);
         }
-        const end_trial = () => {
-            // kill any remaining setTimeout handlers
-            this.jsPsych.pluginAPI.clearAllTimeouts();
-            // stop the audio file if it is playing
-            // remove end event listeners if they exist
-            if (context !== null) {
-                this.audio.stop();
-            }
-            else {
-                this.audio.pause();
-            }
-            this.audio.removeEventListener("ended", end_trial);
-            this.audio.removeEventListener("ended", enable_slider);
-            // save data
-            var trialdata = {
-                rt: response.rt,
-                stimulus: trial.stimulus,
-                slider_start: trial.slider_start,
-                response: response.response,
-            };
-            display_element.innerHTML = "";
-            // next trial
-            this.jsPsych.finishTrial(trialdata);
-            trial_complete();
-        };
-        return new Promise((resolve) => {
-            trial_complete = resolve;
-        });
-    }
-    simulate(trial, simulation_mode, simulation_options, load_callback) {
-        if (simulation_mode == "data-only") {
-            load_callback();
-            this.simulate_data_only(trial, simulation_options);
-        }
-        if (simulation_mode == "visual") {
-            this.simulate_visual(trial, simulation_options, load_callback);
+        this.response.rt = rt;
+        this.response.response = this.display.querySelector(
+          "#jspsych-audio-slider-response-response"
+        ).valueAsNumber;
+        if (this.params.response_ends_trial) {
+          this.end_trial();
+        } else {
+          this.display.querySelector(
+            "#jspsych-audio-slider-response-next"
+          ).disabled = true;
         }
+      });
+      this.startTime = performance.now();
+      if (this.context !== null) {
+        this.startTime = this.context.currentTime;
+      }
+      this.audio.play();
+      if (this.params.trial_duration !== null) {
+        this.jsPsych.pluginAPI.setTimeout(() => {
+          this.end_trial();
+        }, this.params.trial_duration);
+      }
+    };
+    this.end_trial = () => {
+      this.jsPsych.pluginAPI.clearAllTimeouts();
+      this.audio.stop();
+      this.audio.removeEventListener("ended", this.end_trial);
+      this.audio.removeEventListener("ended", this.enable_slider);
+      var trialdata = {
+        rt: this.response.rt,
+        stimulus: this.params.stimulus,
+        slider_start: this.params.slider_start,
+        response: this.response.response
+      };
+      this.display.innerHTML = "";
+      this.trial_complete(trialdata);
+    };
+    autoBind(this);
+  }
+  async trial(display_element, trial, on_load) {
+    this.params = trial;
+    this.display = display_element;
+    this.response;
+    this.half_thumb_width = 7.5;
+    this.trial_complete;
+    this.context = this.jsPsych.pluginAPI.audioContext();
+    this.audio = await this.jsPsych.pluginAPI.getAudioPlayer(trial.stimulus);
+    this.setupTrial();
+    on_load();
+    return new Promise((resolve) => {
+      this.trial_complete = resolve;
+    });
+  }
+  enable_slider() {
+    document.querySelector("#jspsych-audio-slider-response-response").disabled = false;
+    if (!this.params.require_movement) {
+      document.querySelector("#jspsych-audio-slider-response-next").disabled = false;
     }
-    create_simulation_data(trial, simulation_options) {
-        const default_data = {
-            stimulus: trial.stimulus,
-            slider_start: trial.slider_start,
-            response: this.jsPsych.randomization.randomInt(trial.min, trial.max),
-            rt: this.jsPsych.randomization.sampleExGaussian(500, 50, 1 / 150, true),
-        };
-        const data = this.jsPsych.pluginAPI.mergeSimulationData(default_data, simulation_options);
-        this.jsPsych.pluginAPI.ensureSimulationDataConsistency(trial, data);
-        return data;
-    }
-    simulate_data_only(trial, simulation_options) {
-        const data = this.create_simulation_data(trial, simulation_options);
-        this.jsPsych.finishTrial(data);
+  }
+  simulate(trial, simulation_mode, simulation_options, load_callback) {
+    if (simulation_mode == "data-only") {
+      load_callback();
+      this.simulate_data_only(trial, simulation_options);
     }
-    simulate_visual(trial, simulation_options, load_callback) {
-        const data = this.create_simulation_data(trial, simulation_options);
-        const display_element = this.jsPsych.getDisplayElement();
-        const respond = () => {
-            if (data.rt !== null) {
-                const el = display_element.querySelector("input[type='range']");
-                setTimeout(() => {
-                    this.jsPsych.pluginAPI.clickTarget(el);
-                    el.valueAsNumber = data.response;
-                }, data.rt / 2);
-                this.jsPsych.pluginAPI.clickTarget(display_element.querySelector("button"), data.rt);
-            }
-        };
-        this.trial(display_element, trial, () => {
-            load_callback();
-            if (!trial.response_allowed_while_playing) {
-                this.audio.addEventListener("ended", respond);
-            }
-            else {
-                respond();
-            }
-        });
+    if (simulation_mode == "visual") {
+      this.simulate_visual(trial, simulation_options, load_callback);
     }
+  }
+  create_simulation_data(trial, simulation_options) {
+    const default_data = {
+      stimulus: trial.stimulus,
+      slider_start: trial.slider_start,
+      response: this.jsPsych.randomization.randomInt(trial.min, trial.max),
+      rt: this.jsPsych.randomization.sampleExGaussian(500, 50, 1 / 150, true)
+    };
+    const data = this.jsPsych.pluginAPI.mergeSimulationData(default_data, simulation_options);
+    this.jsPsych.pluginAPI.ensureSimulationDataConsistency(trial, data);
+    return data;
+  }
+  simulate_data_only(trial, simulation_options) {
+    const data = this.create_simulation_data(trial, simulation_options);
+    this.jsPsych.finishTrial(data);
+  }
+  simulate_visual(trial, simulation_options, load_callback) {
+    const data = this.create_simulation_data(trial, simulation_options);
+    const display_element = this.jsPsych.getDisplayElement();
+    const respond = () => {
+      if (data.rt !== null) {
+        const el = display_element.querySelector("input[type='range']");
+        setTimeout(() => {
+          this.jsPsych.pluginAPI.clickTarget(el);
+          el.valueAsNumber = data.response;
+        }, data.rt / 2);
+        this.jsPsych.pluginAPI.clickTarget(display_element.querySelector("button"), data.rt);
+      }
+    };
+    this.trial(display_element, trial, () => {
+      load_callback();
+      if (!trial.response_allowed_while_playing) {
+        this.audio.addEventListener("ended", respond);
+      } else {
+        respond();
+      }
+    });
+  }
 }
 AudioSliderResponsePlugin.info = info;