@lookit/record 0.0.3 → 0.0.4

package/src/trial.ts

@@ -1,6 +1,7 @@
 import autoBind from "auto-bind";
 import { JsPsych, JsPsychExtension, JsPsychExtensionInfo } from "jspsych";
 import Recorder from "./recorder";
+import { jsPsychPluginWithInfo } from "./types";
 
 /** This extension will allow reasearchers to record trials. */
 export default class TrialRecordExtension implements JsPsychExtension {
@@ -9,6 +10,7 @@ export default class TrialRecordExtension implements JsPsychExtension {
   };
 
   private recorder?: Recorder;
+  private pluginName: string | undefined;
 
   /**
    * Video recording extension.
@@ -32,7 +34,8 @@ export default class TrialRecordExtension implements JsPsychExtension {
 
   /** Ran when the trial has loaded. */
   public on_load() {
-    this.recorder?.start("trial_video");
+    this.pluginName = this.getCurrentPluginName();
+    this.recorder?.start(false, `${this.pluginName}`);
   }
 
   /**
@@ -44,4 +47,15 @@ export default class TrialRecordExtension implements JsPsychExtension {
     this.recorder?.stop();
     return {};
   }
+
+  /**
+   * 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.
+   *
+   * @returns Plugin name string from the plugin class's info.
+   */
+  private getCurrentPluginName() {
+    const current_plugin_class = this.jsPsych.getCurrentTrial().type;
+    return (current_plugin_class as jsPsychPluginWithInfo).info.name;
+  }
 }

package/src/types.ts

@@ -1,3 +1,11 @@
+import { JsPsychPlugin, PluginInfo } from "jspsych";
+import { Class } from "type-fest";
+
+export interface jsPsychPluginWithInfo
+  extends Class<JsPsychPlugin<PluginInfo>> {
+  info: PluginInfo;
+}
+
 /**
  * A valid CSS height/width value, which can be a number, a string containing a
  * number with units, or 'auto'.

package/src/video_config.spec.ts

@@ -1,7 +1,7 @@
 import { clickTarget } from "@jspsych/test-utils";
 import Handlebars from "handlebars";
 import { initJsPsych, JsPsych } from "jspsych";
-import videoConfig from "../templates/video-config.hbs";
+import videoConfig from "../hbs/video-config.hbs";
 import { NoStreamError } from "./errors";
 import chromeInitialPrompt from "./img/chrome_initialprompt.png";
 import chromeAlwaysAllow from "./img/chrome_step1_alwaysallow.png";

package/src/video_config.ts

@@ -1,5 +1,6 @@
 import Handlebars from "handlebars";
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
+import video_config from "../hbs/video-config.hbs";
 import chromeInitialPrompt from "../img/chrome_initialprompt.png";
 import chromeAlwaysAllow from "../img/chrome_step1_alwaysallow.png";
 import chromePermissions from "../img/chrome_step1_permissions.png";
@@ -7,7 +8,6 @@ import firefoxInitialPrompt from "../img/firefox_initialprompt.png";
 import firefoxChooseDevice from "../img/firefox_prompt_choose_device.png";
 import firefoxDevicesBlocked from "../img/firefox_prompt_devices_blocked.png";
 import { version } from "../package.json";
-import video_config from "../templates/video-config.hbs";
 import { MicCheckError, NoStreamError } from "./errors";
 import Recorder from "./recorder";
 // import MicCheckProcessor from './mic_check';  // TO DO: fix or remove this. See: https://github.com/lookit/lookit-jspsych/issues/44

package/dist/utils.d.ts

@@ -1,21 +0,0 @@
-import { PluginInfo, TrialType } from "jspsych";
-/**
- * Pulled from EFP. Function to convert researcher's text to HTML.
- *
- * @param text - Text
- * @returns Formatted string
- */
-export declare const expFormat: (text?: string | string[]) => string;
-/**
- * Get a translation file based on selected language.
- *
- * @param lcl - Locale object with locale
- * @returns Translations from i18next
- */
-export declare const getTranslation: (lcl: Intl.Locale) => Record<string, string>;
-/**
- * Initialize both i18next and Handlebars.
- *
- * @param trial - Yup
- */
-export declare const initI18nAndTemplates: (trial: TrialType<PluginInfo>) => void;

package/src/utils.spec.ts

@@ -1,55 +0,0 @@
-import Yaml from "js-yaml";
-import en_us from "../i18n/en-us.yaml";
-import eu from "../i18n/eu.yaml";
-import fr from "../i18n/fr.yaml";
-import hu from "../i18n/hu.yaml";
-import it from "../i18n/it.yaml";
-import ja from "../i18n/ja.yaml";
-import nl from "../i18n/nl.yaml";
-import pt_br from "../i18n/pt-br.yaml";
-import pt from "../i18n/pt.yaml";
-import { TranslationNotFoundError } from "./errors";
-import { expFormat, getTranslation } from "./utils";
-
-test("expFormat convert written text to format well in HTML", () => {
-  expect(expFormat("abcdefg")).toStrictEqual("abcdefg");
-  expect(expFormat("AAABBBCCC")).toStrictEqual("AAABBBCCC");
-  expect(expFormat("A normal sentence with multiple words.")).toStrictEqual(
-    "A normal sentence with multiple words.",
-  );
-  expect(expFormat(["Array", "of", "strings"])).toStrictEqual(
-    "Array<br><br>of<br><br>strings",
-  );
-  expect(expFormat("carriage return an newline\r\n")).toStrictEqual(
-    "carriage return an newline<br>",
-  );
-  expect(expFormat("new line\n")).toStrictEqual("new line<br>");
-  expect(expFormat("carriage return\r")).toStrictEqual("carriage return<br>");
-  expect(expFormat("\tTabbed text")).toStrictEqual(
-    "&nbsp;&nbsp;&nbsp;&nbsp;Tabbed text",
-  );
-});
-
-test("Get translation file for specified locale", () => {
-  const translations = {
-    ja,
-    pt,
-    eu,
-    fr,
-    hu,
-    it,
-    nl,
-    "en-us": en_us,
-    "pt-br": pt_br,
-  };
-
-  for (const [k, v] of Object.entries<string>(translations)) {
-    expect(getTranslation(new Intl.Locale(k))).toStrictEqual(Yaml.load(v));
-  }
-
-  expect(pt_br).not.toStrictEqual(pt);
-
-  expect(() => getTranslation(new Intl.Locale("not-a2code"))).toThrow(
-    TranslationNotFoundError,
-  );
-});

package/src/utils.ts

@@ -1,119 +0,0 @@
-import Handlebars from "handlebars";
-import i18next from "i18next";
-import ICU from "i18next-icu";
-import Yaml from "js-yaml";
-import { PluginInfo, TrialType } from "jspsych";
-import en_us from "../i18n/en-us.yaml";
-import eu from "../i18n/eu.yaml";
-import fr from "../i18n/fr.yaml";
-import hu from "../i18n/hu.yaml";
-import it from "../i18n/it.yaml";
-import ja from "../i18n/ja.yaml";
-import nl from "../i18n/nl.yaml";
-import pt_br from "../i18n/pt-br.yaml";
-import pt from "../i18n/pt.yaml";
-import { TranslationNotFoundError } from "./errors";
-
-/**
- * Pulled from EFP. Function to convert researcher's text to HTML.
- *
- * @param text - Text
- * @returns Formatted string
- */
-export const expFormat = (text?: string | string[]) => {
-  if (!text) {
-    return "";
-  }
-
-  if (Array.isArray(text)) {
-    text = text.join("\n\n");
-  }
-
-  return text
-    .replace(/(\r\n|\n|\r)/gm, "<br>")
-    .replace(/\t/gm, "&nbsp;&nbsp;&nbsp;&nbsp;");
-};
-
-/**
- * Get a translation file based on selected language.
- *
- * @param lcl - Locale object with locale
- * @returns Translations from i18next
- */
-export const getTranslation = (lcl: Intl.Locale) => {
-  /**
-   * Switch case to find language from a string. Will throw error is language
-   * not found.
-   *
-   * @param baseName - Base name from locale (en-us)
-   * @returns Language yaml file
-   */
-  const getYaml = (baseName: string) => {
-    switch (baseName) {
-      case "en-US":
-        return en_us;
-      case "eu":
-        return eu;
-      case "fr":
-        return fr;
-      case "hu":
-        return hu;
-      case "it":
-        return it;
-      case "ja":
-        return ja;
-      case "nl":
-        return nl;
-      case "pt-BR":
-        return pt_br;
-      case "pt":
-        return pt;
-      default:
-        throw new TranslationNotFoundError(baseName);
-    }
-  };
-
-  return Yaml.load(getYaml(lcl.baseName)) as Record<string, string>;
-};
-
-/**
- * Initialize i18next with parameters from trial.
- *
- * @param trial - Trial data including user supplied parameters.
- */
-const initI18next = (trial: TrialType<PluginInfo>) => {
-  const debug = process.env.DEBUG === "true";
-  const lcl = new Intl.Locale(trial.locale);
-  const translation = getTranslation(lcl);
-
-  i18next.use(ICU).init({
-    lng: lcl.baseName,
-    debug,
-    resources: {
-      [lcl.language]: {
-        translation,
-      },
-    },
-  });
-};
-
-/**
- * Initialize handlebars helpers. This could be done globally, but it does go
- * hand in hand with initializing i18n.
- */
-const initHandlebars = () => {
-  Handlebars.registerHelper("t", (context, { hash }) =>
-    i18next.t(context, hash),
-  );
-  Handlebars.registerHelper("exp-format", (context) => expFormat(context));
-};
-
-/**
- * Initialize both i18next and Handlebars.
- *
- * @param trial - Yup
- */
-export const initI18nAndTemplates = (trial: TrialType<PluginInfo>) => {
-  initI18next(trial);
-  initHandlebars();
-};