@lookit/record 3.0.1 → 4.1.0

package/dist/index.cjs

@@ -8,7 +8,7 @@ var Handlebars = require('handlebars');
 
 var _package = {
   name: "@lookit/record",
-  version: "3.0.1",
+  version: "4.1.0",
   description: "Recording extensions and plugins for CHS studies.",
   homepage: "https://github.com/lookit/lookit-jspsych#readme",
   bugs: {
@@ -50,7 +50,7 @@ var _package = {
   },
   peerDependencies: {
     "@lookit/data": "^0.2.0",
-    "@lookit/templates": "^2.0.0",
+    "@lookit/templates": "^2.1.0",
     jspsych: "^8.0.3"
   }
 };
@@ -143,21 +143,10 @@ class CreateURLError extends Error {
     this.name = "CreateURLError";
   }
 }
-class VideoContainerNotFoundError extends Error {
-  constructor() {
-    super("Video Container could not be found.");
-    this.name = "VideoContainerError";
-  }
-}
-class ButtonNotFoundError extends Error {
-  constructor(id) {
-    super(`"${id}" button not found.`);
-    this.name = "ButtonNotFoundError";
-  }
-}
-class ImageNotFoundError extends Error {
-  constructor(id) {
-    super(`"${id}" image not found.`);
+class ElementNotFoundError extends Error {
+  constructor(id, tag) {
+    super(`"${id}" ${tag} not found.`);
+    this.name = "ElementNotFoundError";
   }
 }
 
@@ -270,9 +259,9 @@ class Recorder {
     this.recorder.stop();
     this.stream.getTracks().map((t) => t.stop());
   }
-  stop() {
+  stop(maintain_container_size = false) {
+    this.clearWebcamFeed(maintain_container_size);
     this.stopTracks();
-    this.clearWebcamFeed();
     if (!this.stopPromise) {
       throw new NoStopPromiseError();
     }
@@ -300,6 +289,7 @@ class Recorder {
       } else {
         await this.s3.completeUpload();
       }
+      this.reset();
       resolve();
     };
   }
@@ -317,11 +307,20 @@ class Recorder {
       link.click();
     }
   }
-  clearWebcamFeed() {
+  clearWebcamFeed(maintain_container_size) {
     const webcam_feed_element = document.querySelector(
       `#${this.webcam_element_id}`
     );
     if (webcam_feed_element) {
+      if (maintain_container_size) {
+        const parent_div = webcam_feed_element.parentElement;
+        if (parent_div) {
+          const width = webcam_feed_element.offsetWidth;
+          const height = webcam_feed_element.offsetHeight;
+          parent_div.style.height = `${height}px`;
+          parent_div.style.width = `${width}px`;
+        }
+      }
       webcam_feed_element.remove();
     }
   }
@@ -385,12 +384,22 @@ const info$3 = {
     prompt_only_adults: { type: jspsych.ParameterType.BOOL, default: false },
     consent_statement_text: { type: jspsych.ParameterType.STRING, default: "" },
     omit_injury_phrase: { type: jspsych.ParameterType.BOOL, default: false }
+  },
+  data: {
+    chs_type: {
+      type: jspsych.ParameterType.STRING
+    }
   }
 };
 const _VideoConsentPlugin = class {
   constructor(jsPsych) {
     this.jsPsych = jsPsych;
     this.video_container_id = "lookit-jspsych-video-container";
+    this.msg_container_id = "lookit-jspsych-video-msg-container";
+    this.uploadingMsg = null;
+    this.startingMsg = null;
+    this.recordingMsg = null;
+    this.notRecordingMsg = null;
     this.jsPsych = jsPsych;
     this.recorder = new Recorder(this.jsPsych);
   }
@@ -402,13 +411,25 @@ const _VideoConsentPlugin = class {
     this.stopButton(display);
     this.playButton(display);
     this.nextButton(display);
+    this.uploadingMsg = chsTemplates.translateString(
+      "exp-lookit-video-consent.Stopping-and-uploading"
+    );
+    this.startingMsg = chsTemplates.translateString(
+      "exp-lookit-video-consent.Starting-recorder"
+    );
+    this.recordingMsg = chsTemplates.translateString(
+      "exp-lookit-video-consent.Recording"
+    );
+    this.notRecordingMsg = chsTemplates.translateString(
+      "exp-lookit-video-consent.Not-recording"
+    );
   }
   getVideoContainer(display) {
     const videoContainer = display.querySelector(
       `div#${this.video_container_id}`
     );
     if (!videoContainer) {
-      throw new VideoContainerNotFoundError();
+      throw new ElementNotFoundError(this.video_container_id, "div");
     }
     return videoContainer;
   }
@@ -419,14 +440,31 @@ const _VideoConsentPlugin = class {
   }
   playbackFeed(display) {
     const videoContainer = this.getVideoContainer(display);
-    this.recorder.insertPlaybackFeed(videoContainer, this.onEnded(display));
+    this.recorder.insertPlaybackFeed(
+      videoContainer,
+      this.onPlaybackEnded(display)
+    );
+  }
+  getMessageContainer(display) {
+    const msgContainer = display.querySelector(
+      `div#${this.msg_container_id}`
+    );
+    if (!msgContainer) {
+      throw new ElementNotFoundError(this.msg_container_id, "div");
+    }
+    return msgContainer;
+  }
+  addMessage(display, message) {
+    const msgContainer = this.getMessageContainer(display);
+    msgContainer.innerHTML = message;
   }
-  onEnded(display) {
+  onPlaybackEnded(display) {
     return () => {
       const next = this.getButton(display, "next");
       const play = this.getButton(display, "play");
       const record = this.getButton(display, "record");
       this.recordFeed(display);
+      this.addMessage(display, this.notRecordingMsg);
       next.disabled = false;
       play.disabled = false;
       record.disabled = false;
@@ -435,14 +473,14 @@ const _VideoConsentPlugin = class {
   getButton(display, id) {
     const btn = display.querySelector(`button#${id}`);
     if (!btn) {
-      throw new ButtonNotFoundError(id);
+      throw new ElementNotFoundError(id, "button");
     }
     return btn;
   }
   getImg(display, id) {
     const img = display.querySelector(`img#${id}`);
     if (!img) {
-      throw new ImageNotFoundError(id);
+      throw new ElementNotFoundError(id, "img");
     }
     return img;
   }
@@ -452,12 +490,14 @@ const _VideoConsentPlugin = class {
     const play = this.getButton(display, "play");
     const next = this.getButton(display, "next");
     record.addEventListener("click", async () => {
+      this.addMessage(display, this.startingMsg);
       record.disabled = true;
-      stop.disabled = false;
       play.disabled = true;
       next.disabled = true;
-      this.getImg(display, "record-icon").style.visibility = "visible";
       await this.recorder.start(true, _VideoConsentPlugin.info.name);
+      this.getImg(display, "record-icon").style.visibility = "visible";
+      this.addMessage(display, this.recordingMsg);
+      stop.disabled = false;
     });
   }
   playButton(display) {
@@ -475,11 +515,13 @@ const _VideoConsentPlugin = class {
     const play = this.getButton(display, "play");
     stop.addEventListener("click", async () => {
       stop.disabled = true;
-      record.disabled = false;
-      play.disabled = false;
-      await this.recorder.stop();
-      this.recorder.reset();
+      this.addMessage(display, this.uploadingMsg);
+      await this.recorder.stop(true);
       this.recordFeed(display);
+      this.getImg(display, "record-icon").style.visibility = "hidden";
+      this.addMessage(display, this.notRecordingMsg);
+      play.disabled = false;
+      record.disabled = false;
     });
   }
   nextButton(display) {
@@ -499,7 +541,12 @@ const _VideoConsentPlugin = class {
 let VideoConsentPlugin = _VideoConsentPlugin;
 VideoConsentPlugin.info = info$3;
 
-const info$2 = { name: "start-record-plugin", parameters: {} };
+const info$2 = {
+  name: "start-record-plugin",
+  version: _package.version,
+  parameters: {},
+  data: {}
+};
 const _StartRecordPlugin = class {
   constructor(jsPsych) {
     this.jsPsych = jsPsych;
@@ -521,9 +568,18 @@ StartRecordPlugin.info = info$2;
 
 const info$1 = {
   name: "stop-record-plugin",
+  version: _package.version,
   parameters: {
-    locale: { type: jspsych.ParameterType.STRING, default: "en-us" }
-  }
+    wait_for_upload_message: {
+      type: jspsych.ParameterType.HTML_STRING,
+      default: null
+    },
+    locale: {
+      type: jspsych.ParameterType.STRING,
+      default: "en-us"
+    }
+  },
+  data: {}
 };
 class StopRecordPlugin {
   constructor(jsPsych) {
@@ -535,11 +591,17 @@ class StopRecordPlugin {
     }
   }
   trial(display_element, trial) {
-    display_element.innerHTML = chsTemplates.uploadingVideo(trial);
+    if (trial.wait_for_upload_message == null) {
+      display_element.innerHTML = chsTemplates.uploadingVideo(trial);
+    } else {
+      display_element.innerHTML = trial.wait_for_upload_message;
+    }
     this.recorder.stop().then(() => {
       window.chs.sessionRecorder = null;
       display_element.innerHTML = "";
       this.jsPsych.finishTrial();
+    }).catch((err) => {
+      console.error("StopRecordPlugin: recorder stop/upload failed.", err);
     });
   }
 }
@@ -548,19 +610,50 @@ StopRecordPlugin.info = info$1;
 class TrialRecordExtension {
   constructor(jsPsych) {
     this.jsPsych = jsPsych;
+    this.uploadMsg = null;
+    this.locale = "en-us";
     autoBind(this);
   }
-  async initialize() {
+  async initialize(params) {
+    await new Promise((resolve) => {
+      this.uploadMsg = params?.wait_for_upload_message ? params.wait_for_upload_message : null;
+      this.locale = params?.locale ? params.locale : "en-us";
+      console.log(this.uploadMsg);
+      console.log(this.locale);
+      resolve();
+    });
   }
-  on_start() {
+  on_start(startParams) {
+    if (startParams?.wait_for_upload_message) {
+      this.uploadMsg = startParams.wait_for_upload_message;
+    }
+    if (startParams?.locale) {
+      this.locale = startParams.locale;
+    }
+    console.log(this.uploadMsg);
+    console.log(this.locale);
     this.recorder = new Recorder(this.jsPsych);
   }
   on_load() {
     this.pluginName = this.getCurrentPluginName();
     this.recorder?.start(false, `${this.pluginName}`);
   }
-  on_finish() {
-    this.recorder?.stop();
+  async on_finish() {
+    const displayEl = this.jsPsych.getDisplayElement();
+    if (this.uploadMsg == null) {
+      displayEl.innerHTML = chsTemplates.uploadingVideo({
+        type: this.jsPsych.getCurrentTrial().type,
+        locale: this.locale
+      });
+    } else {
+      displayEl.innerHTML = this.uploadMsg;
+    }
+    try {
+      await this.recorder?.stop();
+      displayEl.innerHTML = "";
+    } catch (err) {
+      console.error("TrialRecordExtension: recorder stop/upload failed.", err);
+    }
     return {};
   }
   getCurrentPluginName() {
@@ -569,7 +662,9 @@ class TrialRecordExtension {
   }
 }
 TrialRecordExtension.info = {
-  name: "chs-trial-record-extension"
+  name: "chs-trial-record-extension",
+  version: _package.version,
+  data: {}
 };
 
 var img$6 = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACgAAAAnCAYAAAB9qAq4AAAAAXNSR0IArs4c6QAAAIRlWElmTU0AKgAAAAgABQESAAMAAAABAAEAAAEaAAUAAAABAAAASgEbAAUAAAABAAAAUgEoAAMAAAABAAIAAIdpAAQAAAABAAAAWgAAAAAAAABIAAAAAQAAAEgAAAABAAOgAQADAAAAAQABAACgAgAEAAAAAQAAACigAwAEAAAAAQAAACcAAAAAC4ycfgAAAAlwSFlzAAALEwAACxMBAJqcGAAAAVlpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAADx4OnhtcG1ldGEgeG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IlhNUCBDb3JlIDYuMC4wIj4KICAgPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICAgICAgPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9IiIKICAgICAgICAgICAgeG1sbnM6dGlmZj0iaHR0cDovL25zLmFkb2JlLmNvbS90aWZmLzEuMC8iPgogICAgICAgICA8dGlmZjpPcmllbnRhdGlvbj4xPC90aWZmOk9yaWVudGF0aW9uPgogICAgICA8L3JkZjpEZXNjcmlwdGlvbj4KICAgPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KGV7hBwAACY5JREFUWAnFmA1wFdUVx89+v488AgkEIzGEfAAPB2mBoXxYaUHQtmhFtINAgI5AFZ1By+gM0hE7DpSxSIVBLG0dmNGK2AK2qAWZQYFgQSF8I1YghpgUSUiAvLz3dvfubv9neYvhoyCV0Dtzc3fvxzm/Pefec88L0f+heJ4noUYC1WdbGkfhfRXqEdRG1ErLsR4Nxm9oC+UqqsZKG8yGnq7rvod3vzSm671jDYfx7PrvjuM8fqPhjEBhS7p5OijOMMnn9Qe9RVtmeVP/FnfGriZ3zvuTbMezeahWCha0dQtlYUmSUqzHEuZyTdEnuyTojU+WemurZ7i2R3JYJilb60Ubzx6iLT8+Km7JKXbVtgZj+XVeXQRwyZozNTn50fx1iqIMrmmqoiXbZzr7m9fKuTophlRC2Vop7W7eQM/3WJQCXBhL17e5BWE5H+5M+kxZzIhBoVT8SdVWemn3HY7pkdJeLSFZ0igsd6bKxGYqL5xnThs8i7eCMMns1aYWzLg12WK19I9okfVQmrv+0F/dlw8+SO1UUnLUXuR6KTLkjj7cw8ULzckDnmQ4T5AYFpJCn7cZYLDnUqnmoSEt8h6URt6q/KPz6pFpcr6eLelyAQnvNEWVItqbqKDpZa+kH+r3SAjzLCHEME3TtkGG3CYuDuAS6cSIqBF9F0q1FdsXOiuPz5QLjEJJkaKAawJcKe1rqaDHypaZP+s7jS2XsMkeqkt6JcPh3bvugAFc2k6PNFSDLacs2zbXWfvlr5RbQqVEkkLCbaQstQcdANwvSl8xx/Z7hOHOWlbL7YaRtf88nCT5lBi7PiWAS9mp4QHc0opfO2trARfuATgZcA2A606HkxU0qWiBlYFLWJY1JAOngMbDqfeYis14XUoA15xqviOkhvhAKAz397rnlMJQHCod33JRtYyqUtvonptmi8nfm6ljnp20k0MNwzgAGQznBnAMdl1cDMEhCE3DRf01LbIVckN/2DbPWVM7G3B8Uk1yvASFlC7UYFVSr9hE95lhy2RDDVFapH8Y1sIfXg7uugBCsAE40zSb47qetR1C2y3fsUC8+cVTatcww6XJJZNUqR2ZbjUgS735wzY5HaK5Ku7asaqqcpJwieUYjsv5MINJbG6eyIX976CK1ubmgdaF1zBcMpks0PXwhxhrt3LnUrEScEUZOI9suEn16xmRpDmD37IAZwhXzNZUjeF4m13g1tY6OLPgCSoUWa0H+BljQeZhY1y0HseYxmsaGxuzQ6HQZozlvb33NfHq0cfU4nDcdyvDebhvw3IhfZbcQXP6bjCL83oYjuus1BRtXiAPcvwDEby3bhnMRYeVsJr6qBQeCFrNdq3j/245uRtjNRjzwQDEQdRBH6cZSqaVXc/dhOfijZ++LZYcnqh2w2l1PQtgXF0KyTdTdXoHjS9aYH+/bCSHk4OKrExAywaQsZb1/9fiu1g4YhkWTQtmaWRQiRE7CwG7TDv5l6+SR9+EoCYeRx9f4iY/C8f6h6roff959APx2/2jlaJQCSY4AONhGW6JUbPYRfGsUe64fo9xDiiwWe+HxTnhY+Nc4BWWeXGRsFGfkWV5bu3paqo4th5f71BeVgGVdb6VCttD4bly0nbsVSlxenF2KO8Id1nCWgE3Tdpfu8uZ9VF/OU/v4t8QrpfEKG9lhzQpl+rMvfS7H3xql3TqqUHGz3VVXwE43h42y7la4dS7yqJ00Yx1g8Sx1B4FOZknsCM4N4vHxktDCkbT4NLhFNPbsywb9+RSJJOOoYV/Wd1wxHtqSxnmhiVD7uqHEracB7iQnE9HUzvp8fgb1j29H9JdclcpkjIW+njPnw/E3wRQVDd87v1oQ3d1ePbtlHJqoUD4ytJuk9eMs3yT3pWGd3laGhEfTZ2i+b7MU4mT9MymEV7C2SdFlV6Y34z+c2FVkSKUEIepJDrOff6uPzNQfVNTU1lOTg5n0Ffdd62h2YIV6Biybv/K1MJD48K9IgPJwnV07li5vjVsxK8mQV4Unru3cIk0uGgkvb73BW9X05+kPL23n5UEcIgYvmtr4dqXMq7FNfYAborV0PWNXRtAMmA3vHCAzXv/0Fpz/v77jZ6R/giqX6ELfj4fKmFX7wRAkwh+hByOpLBcBpw05p2zHDxHmpxLNek9NKF4qf1Qv0c1j7zVsiQ/AD188jm2XlPxJWPxzVi1DbUI4cL8zb7RRjwygFJuLVTzhvcyoOwtF+5sIU6ZOIzwWFB4LiegmtzRe/Guj6QsI5ZKUaosIkVqoeOaXBvIlDNfVpegxAB0fjEifp/xRPx167Pkx9j8BVDPh403PnyM2MZFQfi4GI7fNbkD1ZgnqDz+ogAckgPxXAaOXXvFeOcLvswf/iqHIWNSrB5X1hDMOXnvbeP18V0XiCoE2JDcJQPJxpbwzHGOQb+2HMvlg3HGrqRBHSY4t5eN5Jj3L4ShF3gM5arx7ty0S/+yzygDqUaj0TrLSgxDlz154JPqoA5T3QZrp7/p2bVfl2DPBT0ugnKUTgHjwVtn+OT4z8AsHsXHc0C+8GuCZd+g9QF5HoQIFmYYsYOOY46R4NbpA+fi5HYi22uE7fiWunxhl5+ydtOdnWY4vbv059upAgnrGshjD/3P1mNt5wH5JYBU1dA67J/nc7M6KU/0e8eqNWuxv7Lh1NZW5BVc8IubdOJ4+dP4w34Pcrxn/YeL5Gf6rqm5ADCz0g8F2D/PwgJb+9wyQC/vtlgcT1citHTClAshFSmLTtl76c7OM0X3m3rzkd+IBPQDrOWw8q2sxzyXAEIoZPsJJOFiL8cc84HvTlFLIkO9pLMXCzipCQqsJxm+9X7SvdzfmEKk5waj16O9BJCFApJPthYOh6tt134ipIZpap8F4oSFwyAHIQZfh5N72t5Dd3R8RPTM78PW+1DTwpux1o8ObQaYgeS8T9YV/fdoN/cu6K+NKZgr6tK7SZdyMIVPbgTuJbq7dKLPYjrmixmoy354ZuyamqsJ8t1m2/Z0ljrmtilqTOVsJwFXc0Kwm77TbpTTt3AQn9x9+DX3Dj4GDvj2ey/4iisCBq7GRX/IdcX83Kw8mtRjjahOH6OImk8nEK/v7jbFPzXYCi9nhLKrb1xhi7C2qqqqEJ5rUL2n37vPKV9DXvla3T2bPs1dX9XX18d4Hp4vjuLc3bYFSvnqIlOY45nmwJe70rScvNc+Xpzid2TKi3gcj/48fr7hBcr97YB2C6p3/NQxvnmCUsZAeLnilmlT6EA52jzUd1Et1KOeJ0Zl4Npk7/0HL4Dtx/60f2MAAAAASUVORK5CYII=";