@lookit/record 4.1.0 → 6.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lookit/record",
-  "version": "4.1.0",
+  "version": "6.0.0",
   "description": "Recording extensions and plugins for CHS studies.",
   "homepage": "https://github.com/lookit/lookit-jspsych#readme",
   "bugs": {
@@ -41,8 +41,8 @@
     "typescript": "^5.6.2"
   },
   "peerDependencies": {
-    "@lookit/data": "^0.2.0",
-    "@lookit/templates": "^2.1.0",
+    "@lookit/data": "^0.3.0",
+    "@lookit/templates": "^3.1.0",
     "jspsych": "^8.0.3"
   }
 }

package/src/consentVideo.spec.ts

@@ -8,6 +8,7 @@ import recordFeed from "../hbs/record-feed.hbs";
 import { VideoConsentPlugin } from "./consentVideo";
 import { ElementNotFoundError } from "./errors";
 import Recorder from "./recorder";
+import type { StopOptions, StopResult } from "./types";
 
 declare const window: LookitWindow;
 
@@ -288,6 +289,14 @@ test("playButton", () => {
 });
 
 test("stopButton", async () => {
+  // We need to mock the return values for Recorder.stop because it is called in the stop button's callback function
+  (
+    Recorder.prototype.stop as jest.Mock<StopResult, [StopOptions?]>
+  ).mockImplementation(() => ({
+    stopped: Promise.resolve("mock-url"),
+    uploaded: Promise.resolve(),
+  }));
+
   const jsPsych = initJsPsych();
   const plugin = new VideoConsentPlugin(jsPsych);
   const display = document.createElement("div");

package/src/consentVideo.ts

@@ -12,7 +12,15 @@ const info = <const>{
   name: "consent-video",
   version,
   parameters: {
-    template: { type: ParameterType.STRING, default: "consent-template-5" },
+    template: {
+      type: ParameterType.SELECT,
+      options: [
+        "consent-template-5",
+        "consent-garden",
+        "consent-recording-only",
+      ],
+      default: "consent-template-5",
+    },
     locale: { type: ParameterType.STRING, default: "en-us" },
     additional_video_privacy_statement: {
       type: ParameterType.STRING,
@@ -58,6 +66,16 @@ const info = <const>{
     prompt_only_adults: { type: ParameterType.BOOL, default: false },
     consent_statement_text: { type: ParameterType.STRING, default: "" },
     omit_injury_phrase: { type: ParameterType.BOOL, default: false },
+    /**
+     * This parameter is only relevant for the consent-recording-only template.
+     * If a different template is used, this parameter will be ignored. Whether
+     * or not the consent trial is the only data being collected on CHS (i.e.
+     * the study redirects to an external URL immediately after the consent
+     * trial). If false (the default), the consent template contains information
+     * about how CHS handles data/responses. If true, any statements about
+     * session data/responses are omitted.
+     */
+    only_consent_on_chs: { type: ParameterType.BOOL, default: false },
   },
   data: {
     chs_type: {
@@ -305,7 +323,11 @@ export class VideoConsentPlugin implements JsPsychPlugin<Info> {
     stop.addEventListener("click", async () => {
       stop.disabled = true;
       this.addMessage(display, this.uploadingMsg!);
-      await this.recorder.stop(true);
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      const { stopped, uploaded } = this.recorder.stop({
+        maintain_container_size: true,
+      });
+      await stopped;
       this.recordFeed(display);
       this.getImg(display, "record-icon").style.visibility = "hidden";
       this.addMessage(display, this.notRecordingMsg!);

package/src/errors.ts

@@ -154,6 +154,21 @@ export class S3UndefinedError extends Error {
   }
 }
 
+/**
+ * Error thrown when a filename does not exist but is needed for upload or local
+ * download.
+ */
+export class NoFileNameError extends Error {
+  /**
+   * Provide information when the recorder attempts to upload/download the
+   * recording but there is no file name.
+   */
+  public constructor() {
+    super("No filename found for recording.");
+    this.name = "NoFileNameError";
+  }
+}
+
 /**
  * Error thrown when attempting to reset recorder, but its stream is still
  * active.
@@ -209,3 +224,16 @@ export class ElementNotFoundError extends Error {
     this.name = "ElementNotFoundError";
   }
 }
+
+/** Thrown when the timeout duration is reached. */
+export class TimeoutError extends Error {
+  /**
+   * String passed in with more info about the event that timed out.
+   *
+   * @param msg - Timeout error message string.
+   */
+  public constructor(msg: string) {
+    super(`${msg}`);
+    this.name = "TimeoutError";
+  }
+}