@lookit/record 1.0.0 → 3.0.0

package/src/{video_config.ts → videoConfig.ts}

@@ -1,6 +1,6 @@
-import Handlebars from "handlebars";
+import chsTemplates from "@lookit/templates";
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
-import video_config from "../hbs/video-config.hbs";
+import checkmarkIcon from "../img/checkmark-icon.png";
 import chromeInitialPrompt from "../img/chrome_initialprompt.png";
 import chromeAlwaysAllow from "../img/chrome_step1_alwaysallow.png";
 import chromePermissions from "../img/chrome_step1_permissions.png";
@@ -16,6 +16,7 @@ const info = <const>{
   name: "video-config-plugin",
   version: version,
   parameters: {
+    locale: { type: ParameterType.STRING, default: "en-us" },
     troubleshooting_intro: {
       /**
        * Optional string to appear at the start of the "Setup tips and
@@ -50,6 +51,31 @@ interface MediaDeviceInfo {
   groupId: string;
 }
 
+export const html_params = {
+  webcam_container_id: "lookit-jspsych-webcam-container",
+  reload_button_id_text: "lookit-jspsych-reload-webcam",
+  reload_button_id_cam: "lookit-jspsych-reload-cam-mic",
+  camera_selection_id: "lookit-jspsych-which-webcam",
+  mic_selection_id: "lookit-jspsych-which-mic",
+  next_button_id: "lookit-jspsych-next",
+  error_msg_div_id: "lookit-jspsych-video-config-errors",
+  step1_id: "lookit-jspsych-step1",
+  step2_id: "lookit-jspsych-step2",
+  step3_id: "lookit-jspsych-step3",
+  step_complete_class: "lookit-jspsych-step-complete",
+  waiting_for_access_msg_id: "lookit-jspsych-waiting-for-access",
+  checking_mic_msg_id: "lookit-jspsych-checking-mic",
+  access_problem_msg_id: "lookit-jspsych-access-problem",
+  setup_problem_msg_id: "lookit-jspsych-setup-problem",
+  chromeInitialPrompt,
+  chromeAlwaysAllow,
+  chromePermissions,
+  firefoxInitialPrompt,
+  firefoxChooseDevice,
+  firefoxDevicesBlocked,
+  checkmarkIcon,
+};
+
 /**
  * **Video Config**.
  *
@@ -73,26 +99,6 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
   private minVolume: number = 0.1;
   private micChecked: boolean = false;
   private processorNode: AudioWorkletNode | null = null;
-  // HTML IDs and classes
-  private webcam_container_id: string = "lookit-jspsych-webcam-container";
-  private reload_button_id_text: string = "lookit-jspsych-reload-webcam";
-  private reload_button_id_cam: string = "lookit-jspsych-reload-cam-mic";
-  private camera_selection_id: string = "lookit-jspsych-which-webcam";
-  private mic_selection_id: string = "lookit-jspsych-which-mic";
-  private next_button_id: string = "lookit-jspsych-next";
-  private error_msg_div_id: string = "lookit-jspsych-video-config-errors";
-  private step1_id: string = "lookit-jspsych-step1";
-  private step2_id: string = "lookit-jspsych-step2";
-  private step3_id: string = "lookit-jspsych-step3";
-  private step_complete_class: string = "lookit-jspsych-step-complete";
-  // info/error messages
-  private step_complete_text: string = "Done!";
-  private waiting_for_access_msg: string = "Waiting for camera/mic access...";
-  private checking_mic_msg: string = "Checking mic input...";
-  private access_problem_msg: string =
-    "There was a problem accessing your media devices.";
-  private setup_problem_msg: string =
-    "There was a problem setting up your camera and mic.";
 
   /**
    * Constructor for video config plugin.
@@ -112,7 +118,7 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
     // Set up the event listener for device changes.
     navigator.mediaDevices.ondevicechange = this.onDeviceChange;
     // Add page content.
-    this.addHtmlContent(trial.troubleshooting_intro as string);
+    this.addHtmlContent(trial);
     // Add event listeners after elements have been added to the page.
     this.addEventListeners();
     // Begin the initial recorder setup steps.
@@ -124,44 +130,23 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
   /**
    * Add HTML content to the page.
    *
-   * @param troubleshooting_intro - Troubleshooting intro parameter from the
-   *   Trial object.
+   * @param trial - Trial object.
    */
-  private addHtmlContent = (troubleshooting_intro: string) => {
-    const html_params = {
-      webcam_container_id: this.webcam_container_id,
-      reload_button_id_cam: this.reload_button_id_cam,
-      camera_selection_id: this.camera_selection_id,
-      mic_selection_id: this.mic_selection_id,
-      step1_id: this.step1_id,
-      step2_id: this.step2_id,
-      step3_id: this.step3_id,
-      step_complete_class: this.step_complete_class,
-      step_complete_text: this.step_complete_text,
-      reload_button_id_text: this.reload_button_id_text,
-      next_button_id: this.next_button_id,
-      chromeInitialPrompt,
-      chromeAlwaysAllow,
-      chromePermissions,
-      firefoxInitialPrompt,
-      firefoxChooseDevice,
-      firefoxDevicesBlocked,
-      troubleshooting_intro,
-    };
-    this.display_el!.innerHTML = Handlebars.compile(video_config)(html_params);
+  private addHtmlContent = (trial: VideoConsentTrialType) => {
+    this.display_el!.innerHTML = chsTemplates.videoConfig(trial, html_params);
   };
 
   /** Add event listeners to elements after they've been added to the page. */
   private addEventListeners = () => {
     // Next button.
     const next_button_el = this.display_el?.querySelector(
-      `#${this.next_button_id}`,
+      `#${html_params.next_button_id}`,
     ) as HTMLButtonElement;
     next_button_el.addEventListener("click", this.nextButtonClick);
     // Reload buttons.
     (
       this.display_el?.querySelectorAll(
-        `#${this.reload_button_id_cam}, #${this.reload_button_id_text}`,
+        `#${html_params.reload_button_id_cam}, #${html_params.reload_button_id_text}`,
       ) as NodeListOf<HTMLButtonElement>
     ).forEach((el) => el.addEventListener("click", this.reloadButtonClick));
     // Camera/mic selection elements.
@@ -211,9 +196,9 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
     // Don't reset step 2 (reload) because that should persist after being checked once with any Recorder/devices.
     this.updateInstructions(1, false);
     this.updateInstructions(3, false);
-    this.updateErrors(this.waiting_for_access_msg);
+    this.updateErrors(html_params.waiting_for_access_msg_id);
     await this.requestPermission({ video: true, audio: true });
-    this.updateErrors("");
+    this.updateErrors();
     await this.onDeviceChange();
     await this.setDevices();
     await this.runStreamChecks();
@@ -259,11 +244,11 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
   }) => {
     // Clear any existing options in select elements
     const cam_selection_el = this.display_el?.querySelector(
-      `#${this.camera_selection_id}`,
+      `#${html_params.camera_selection_id}`,
     ) as HTMLSelectElement;
     cam_selection_el.innerHTML = "";
     const mic_selection_el = this.display_el?.querySelector(
-      `#${this.mic_selection_id}`,
+      `#${html_params.mic_selection_id}`,
     ) as HTMLSelectElement;
     mic_selection_el.innerHTML = "";
     // Populate select elements with current device options.
@@ -299,13 +284,13 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
     // Get the devices selected from the drop-down element.
     const selected_cam: string = (
       this.display_el?.querySelector(
-        `#${this.camera_selection_id}`,
+        `#${html_params.camera_selection_id}`,
       ) as HTMLSelectElement
     ).value;
     this.camId = selected_cam;
     const selected_mic: string = (
       this.display_el?.querySelector(
-        `#${this.mic_selection_id}`,
+        `#${html_params.mic_selection_id}`,
       ) as HTMLSelectElement
     ).value;
     this.micId = selected_mic;
@@ -332,14 +317,14 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
     if (this.jsPsych.pluginAPI.getCameraRecorder() && this.recorder) {
       this.recorder.insertWebcamFeed(
         this.display_el?.querySelector(
-          `#${this.webcam_container_id}`,
+          `#${html_params.webcam_container_id}`,
         ) as HTMLDivElement,
       );
       this.updateInstructions(1, true);
-      this.updateErrors(this.checking_mic_msg);
+      this.updateErrors(html_params.checking_mic_msg_id);
       try {
         await this.checkMic();
-        this.updateErrors("");
+        this.updateErrors();
         this.updateInstructions(3, true);
         // Allow user to continue (end trial) when all checks have passed.
         if (this.hasReloaded) {
@@ -347,11 +332,11 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
         }
       } catch (e) {
         console.warn(`${e}`);
-        this.updateErrors(this.setup_problem_msg);
+        this.updateErrors(html_params.setup_problem_msg_id);
         throw new Error(`${e}`);
       }
     } else {
-      this.updateErrors(this.access_problem_msg);
+      this.updateErrors(html_params.access_problem_msg_id);
       throw new NoStreamError();
     }
   };
@@ -553,15 +538,15 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
     let step_id = null;
     switch (step) {
       case 1: {
-        step_id = this.step1_id;
+        step_id = html_params.step1_id;
         break;
       }
       case 2: {
-        step_id = this.step2_id;
+        step_id = html_params.step2_id;
         break;
       }
       case 3: {
-        step_id = this.step3_id;
+        step_id = html_params.step3_id;
         break;
       }
     }
@@ -586,14 +571,27 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
    * Update the errors/messages div with information for the user about the
    * camera/mic checks.
    *
-   * @param errorMsg - Message to display in the error message div. Pass an
-   *   empty string to clear any existing errors/messages.
+   * @param errorMsgId - Span element ID containing the message to display in
+   *   the error message div. Call the function without an errorMsgId to clear
+   *   the errors.
    */
-  private updateErrors = (errorMsg: string) => {
-    const error_msg_div = this.display_el?.querySelector(
-      `#${this.error_msg_div_id}`,
+  private updateErrors = (errorMsgId?: string) => {
+    const error_msg_container = this.display_el?.querySelector(
+      `#${html_params.error_msg_div_id}`,
     ) as HTMLDivElement;
-    error_msg_div.innerHTML = errorMsg;
+    (
+      error_msg_container.querySelectorAll(
+        "span.error_msg",
+      ) as NodeListOf<HTMLSpanElement>
+    ).forEach((span) => {
+      span.style.display = "none";
+    });
+    if (errorMsgId) {
+      const error_msg_el = this.display_el?.querySelector(
+        `#${errorMsgId}`,
+      ) as HTMLSpanElement;
+      error_msg_el.style.display = "block";
+    }
   };
 
   /**
@@ -652,14 +650,14 @@ export default class VideoConfigPlugin implements JsPsychPlugin<Info> {
    */
   private enableNext = (enable: boolean) => {
     const next_button_el = this.display_el?.querySelector(
-      `#${this.next_button_id}`,
+      `#${html_params.next_button_id}`,
     ) as HTMLButtonElement;
     if (enable) {
       next_button_el.disabled = false;
-      next_button_el.classList.add(`${this.step_complete_class}`);
+      next_button_el.classList.add(`${html_params.step_complete_class}`);
     } else {
       next_button_el.disabled = true;
-      next_button_el.classList.remove(`${this.step_complete_class}`);
+      next_button_el.classList.remove(`${html_params.step_complete_class}`);
     }
   };
 }

package/src/{video_config_mic_check.spec.ts → videoConfig_mic_check.spec.ts}

@@ -5,7 +5,7 @@ import {
   AudioWorkletNodeMock,
 } from "../fixtures/MockWebAudioAPI";
 import { MicCheckError, NoStreamError } from "./errors";
-import VideoConfigPlugin from "./video_config";
+import VideoConfigPlugin from "./videoConfig";
 
 // The video config mic check relies on the WebAudio API, which is not available in Node/Jest/jsdom, so we'll mock it here.
 // This is in a separate file to avoid polluting the other test environments with the WebAudio API mocks.

package/dist/consentVideo.d.ts

@@ -1,370 +0,0 @@
-import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
-declare const info: {
-    readonly name: "consent-video";
-    readonly version: string;
-    readonly parameters: {
-        readonly template: {
-            readonly type: ParameterType.STRING;
-            readonly default: "consent-template-5";
-        };
-        readonly locale: {
-            readonly type: ParameterType.STRING;
-            readonly default: "en-us";
-        };
-        readonly additional_video_privacy_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly datause: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly gdpr: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly gdpr_personal_data: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly gdpr_sensitive_data: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly PIName: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly include_databrary: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly institution: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly PIContact: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly payment: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly private_level_only: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly procedures: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly purpose: {
-            readonly type: ParameterType.STRING;
-            readonly default: undefined;
-        };
-        readonly research_rights_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly risk_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly voluntary_participation: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly purpose_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly procedures_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly participation_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly benefits_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly risk_header: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly summary_statement: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly additional_segments: {
-            readonly type: ParameterType.COMPLEX;
-            readonly array: true;
-            readonly default: readonly [];
-            readonly nested: {
-                readonly title: {
-                    readonly type: ParameterType.STRING;
-                    readonly default: "";
-                };
-                readonly text: {
-                    readonly type: ParameterType.STRING;
-                    readonly default: "";
-                };
-            };
-        };
-        readonly prompt_all_adults: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly prompt_only_adults: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-        readonly consent_statement_text: {
-            readonly type: ParameterType.STRING;
-            readonly default: "";
-        };
-        readonly omit_injury_phrase: {
-            readonly type: ParameterType.BOOL;
-            readonly default: false;
-        };
-    };
-};
-type Info = typeof info;
-/** The video consent plugin. */
-export declare class VideoConsentPlugin implements JsPsychPlugin<Info> {
-    private readonly jsPsych;
-    static readonly info: {
-        readonly name: "consent-video";
-        readonly version: string;
-        readonly parameters: {
-            readonly template: {
-                readonly type: ParameterType.STRING;
-                readonly default: "consent-template-5";
-            };
-            readonly locale: {
-                readonly type: ParameterType.STRING;
-                readonly default: "en-us";
-            };
-            readonly additional_video_privacy_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly datause: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly gdpr: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly gdpr_personal_data: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly gdpr_sensitive_data: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly PIName: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly include_databrary: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly institution: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly PIContact: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly payment: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly private_level_only: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly procedures: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly purpose: {
-                readonly type: ParameterType.STRING;
-                readonly default: undefined;
-            };
-            readonly research_rights_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly risk_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly voluntary_participation: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly purpose_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly procedures_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly participation_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly benefits_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly risk_header: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly summary_statement: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly additional_segments: {
-                readonly type: ParameterType.COMPLEX;
-                readonly array: true;
-                readonly default: readonly [];
-                readonly nested: {
-                    readonly title: {
-                        readonly type: ParameterType.STRING;
-                        readonly default: "";
-                    };
-                    readonly text: {
-                        readonly type: ParameterType.STRING;
-                        readonly default: "";
-                    };
-                };
-            };
-            readonly prompt_all_adults: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly prompt_only_adults: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-            readonly consent_statement_text: {
-                readonly type: ParameterType.STRING;
-                readonly default: "";
-            };
-            readonly omit_injury_phrase: {
-                readonly type: ParameterType.BOOL;
-                readonly default: false;
-            };
-        };
-    };
-    private readonly recorder;
-    private readonly video_container_id;
-    /**
-     * Instantiate video consent plugin.
-     *
-     * @param jsPsych - JsPsych object
-     */
-    constructor(jsPsych: JsPsych);
-    /**
-     * Create/Show trial view.
-     *
-     * @param display - HTML element for experiment.
-     * @param trial - Trial data including user supplied parameters.
-     */
-    trial(display: HTMLElement, trial: TrialType<Info>): void;
-    /**
-     * Retrieve video container element.
-     *
-     * @param display - HTML element for experiment.
-     * @returns Video container
-     */
-    private getVideoContainer;
-    /**
-     * Add webcam feed to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private recordFeed;
-    /**
-     * Playback Feed
-     *
-     * @param display - JsPsych display HTML element.
-     */
-    private playbackFeed;
-    /**
-     * Put back the webcam feed once the video recording has ended. This is used
-     * with the "ended" Event.
-     *
-     * @param display - JsPsych display HTML element.
-     * @returns Event function
-     */
-    private onEnded;
-    /**
-     * Retrieve button element from DOM.
-     *
-     * @param display - HTML element for experiment.
-     * @param id - Element id
-     * @returns Button element
-     */
-    private getButton;
-    /**
-     * Select and return the image element.
-     *
-     * @param display - HTML element for experiment.
-     * @param id - ID string of Image element
-     * @returns Image Element
-     */
-    private getImg;
-    /**
-     * Add record button to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private recordButton;
-    /**
-     * Set up play button to playback last recorded video.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private playButton;
-    /**
-     * Add stop button to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private stopButton;
-    /**
-     * Add next button to HTML.
-     *
-     * @param display - HTML element for experiment.
-     */
-    private nextButton;
-    /**
-     * Mark the response in the lookit-api database as having completed the
-     * consent frame, then finish the trial.
-     */
-    private endTrial;
-    /**
-     * Add CHS type to experiment data. This will enable Lookit API to run the
-     * "consent" Frame Action Dispatcher method after the experiment has
-     * completed.
-     *
-     * @returns Object containing CHS type.
-     */
-    static chsData(): {
-        chs_type: string;
-    };
-}
-export {};