@lookit/record 4.0.0 → 4.1.0

package/dist/index.d.ts

@@ -132,6 +132,11 @@ declare const info$3: {
             readonly default: false;
         };
     };
+    readonly data: {
+        readonly chs_type: {
+            readonly type: ParameterType.STRING;
+        };
+    };
 };
 type Info$3 = typeof info$3;
 /** The video consent plugin. */
@@ -269,6 +274,11 @@ declare class VideoConsentPlugin implements JsPsychPlugin<Info$3> {
                 readonly default: false;
             };
         };
+        readonly data: {
+            readonly chs_type: {
+                readonly type: ParameterType.STRING;
+            };
+        };
     };
     private readonly recorder;
     private readonly video_container_id;
@@ -393,7 +403,9 @@ declare class VideoConsentPlugin implements JsPsychPlugin<Info$3> {
 
 declare const info$2: {
     readonly name: "start-record-plugin";
+    readonly version: string;
     readonly parameters: {};
+    readonly data: {};
 };
 type Info$2 = typeof info$2;
 /** Start recording. Used by researchers who want to record across trials. */
@@ -401,7 +413,9 @@ declare class StartRecordPlugin implements JsPsychPlugin<Info$2> {
     private jsPsych;
     static readonly info: {
         readonly name: "start-record-plugin";
+        readonly version: string;
         readonly parameters: {};
+        readonly data: {};
     };
     private recorder;
     /**
@@ -416,12 +430,32 @@ declare class StartRecordPlugin implements JsPsychPlugin<Info$2> {
 
 declare const info$1: {
     readonly name: "stop-record-plugin";
+    readonly version: string;
     readonly parameters: {
+        /**
+         * This string can contain HTML markup. Any content provided will be
+         * displayed while the recording is uploading. If null (the default), then
+         * the default 'uploading video, please wait' (or appropriate translation
+         * based on 'locale') will be displayed. Use a blank string for no
+         * message/content.
+         */
+        readonly wait_for_upload_message: {
+            readonly type: ParameterType.HTML_STRING;
+            readonly default: string | null;
+        };
+        /**
+         * Locale code used for translating the default 'uploading video, please
+         * wait' message. This code must be present in the translation files. If the
+         * code is not found then English will be used. If the
+         * 'wait_for_upload_message' parameter is specified then this value is
+         * ignored.
+         */
         readonly locale: {
             readonly type: ParameterType.STRING;
             readonly default: "en-us";
         };
     };
+    readonly data: {};
 };
 type Info$1 = typeof info$1;
 /** Stop recording. Used by researchers who want to record across trials. */
@@ -429,12 +463,32 @@ declare class StopRecordPlugin implements JsPsychPlugin<Info$1> {
     private jsPsych;
     static readonly info: {
         readonly name: "stop-record-plugin";
+        readonly version: string;
         readonly parameters: {
+            /**
+             * This string can contain HTML markup. Any content provided will be
+             * displayed while the recording is uploading. If null (the default), then
+             * the default 'uploading video, please wait' (or appropriate translation
+             * based on 'locale') will be displayed. Use a blank string for no
+             * message/content.
+             */
+            readonly wait_for_upload_message: {
+                readonly type: ParameterType.HTML_STRING;
+                readonly default: string | null;
+            };
+            /**
+             * Locale code used for translating the default 'uploading video, please
+             * wait' message. This code must be present in the translation files. If the
+             * code is not found then English will be used. If the
+             * 'wait_for_upload_message' parameter is specified then this value is
+             * ignored.
+             */
             readonly locale: {
                 readonly type: ParameterType.STRING;
                 readonly default: "en-us";
             };
         };
+        readonly data: {};
     };
     private recorder;
     /**
@@ -454,12 +508,39 @@ declare class StopRecordPlugin implements JsPsychPlugin<Info$1> {
     trial(display_element: HTMLElement, trial: TrialType<Info$1>): void;
 }
 
-/** This extension will allow reasearchers to record trials. */
+interface Parameters {
+    /**
+     * Content that should be displayed while the recording is uploading. If null
+     * (the default), then the default 'uploading video, please wait...' (or
+     * appropriate translation based on 'locale') will be displayed. Use a blank
+     * string for no message/content. Otherwise this parameter can be set to a
+     * custom string and can contain HTML markup. If you want to embed
+     * images/video/audio in this HTML string, be sure to preload the media files
+     * with the `preload` plugin and manual preloading. Use a blank string (`""`)
+     * for no message/content.
+     *
+     * @default null
+     */
+    wait_for_upload_message?: null | string;
+    /**
+     * Locale code used for translating the default 'uploading video, please
+     * wait...' message. This code must be present in the translation files. If
+     * the code is not found then English will be used. If the
+     * 'wait_for_upload_message' parameter is specified then this value
+     * isignored.
+     *
+     * @default "en-us"
+     */
+    locale?: string;
+}
+/** This extension allows researchers to record webcam audio/video during trials. */
 declare class TrialRecordExtension implements JsPsychExtension {
     private jsPsych;
     static readonly info: JsPsychExtensionInfo;
     private recorder?;
     private pluginName;
+    private uploadMsg;
+    private locale;
     /**
      * Video recording extension.
      *
@@ -467,20 +548,34 @@ declare class TrialRecordExtension implements JsPsychExtension {
      */
     constructor(jsPsych: JsPsych);
     /**
-     * Ran on the initialize step for extensions, called when an instance of
+     * Runs on the initialize step for extensions, called when an instance of
      * jsPsych is first initialized through initJsPsych().
+     *
+     * @param params - Parameters object
+     * @param params.wait_for_upload_message - Message to display while waiting
+     *   for upload. String or null (default)
+     * @param params.locale - Message to display while waiting for upload. String
+     *   or null (default).
+     */
+    initialize(params?: Parameters): Promise<void>;
+    /**
+     * Runs at the start of a trial.
+     *
+     * @param startParams - Parameters object
+     * @param startParams.wait_for_upload_message - Message to display while
+     *   waiting for upload. String or null (default). If given, this will
+     *   overwrite the value used during initialization.
      */
-    initialize(): Promise<void>;
-    /** Ran at the start of a trial. */
-    on_start(): void;
-    /** Ran when the trial has loaded. */
+    on_start(startParams?: Parameters): void;
+    /** Runs when the trial has loaded. */
     on_load(): void;
     /**
-     * Ran when trial has finished.
+     * Runs when trial has finished.
      *
-     * @returns Trial data.
+     * @returns Any data from the trial extension that should be added to the rest
+     *   of the trial data.
      */
-    on_finish(): {};
+    on_finish(): Promise<{}>;
     /**
      * Gets the plugin name for the trial that is being extended. This is same as
      * the "trial_type" value that is stored in the data for this trial.

package/dist/index.js

@@ -6,7 +6,7 @@ import Handlebars from 'handlebars';
 
 var _package = {
   name: "@lookit/record",
-  version: "4.0.0",
+  version: "4.1.0",
   description: "Recording extensions and plugins for CHS studies.",
   homepage: "https://github.com/lookit/lookit-jspsych#readme",
   bugs: {
@@ -287,6 +287,7 @@ class Recorder {
       } else {
         await this.s3.completeUpload();
       }
+      this.reset();
       resolve();
     };
   }
@@ -381,6 +382,11 @@ const info$3 = {
     prompt_only_adults: { type: ParameterType.BOOL, default: false },
     consent_statement_text: { type: ParameterType.STRING, default: "" },
     omit_injury_phrase: { type: ParameterType.BOOL, default: false }
+  },
+  data: {
+    chs_type: {
+      type: ParameterType.STRING
+    }
   }
 };
 const _VideoConsentPlugin = class {
@@ -509,7 +515,6 @@ const _VideoConsentPlugin = class {
       stop.disabled = true;
       this.addMessage(display, this.uploadingMsg);
       await this.recorder.stop(true);
-      this.recorder.reset();
       this.recordFeed(display);
       this.getImg(display, "record-icon").style.visibility = "hidden";
       this.addMessage(display, this.notRecordingMsg);
@@ -534,7 +539,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;
@@ -556,9 +566,18 @@ StartRecordPlugin.info = info$2;
 
 const info$1 = {
   name: "stop-record-plugin",
+  version: _package.version,
   parameters: {
-    locale: { type: ParameterType.STRING, default: "en-us" }
-  }
+    wait_for_upload_message: {
+      type: ParameterType.HTML_STRING,
+      default: null
+    },
+    locale: {
+      type: ParameterType.STRING,
+      default: "en-us"
+    }
+  },
+  data: {}
 };
 class StopRecordPlugin {
   constructor(jsPsych) {
@@ -570,11 +589,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);
     });
   }
 }
@@ -583,19 +608,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() {
@@ -604,7 +660,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=";