@jspsych/plugin-survey-likert 1.1.2 → 2.0.0

package/src/index.spec.ts

@@ -30,7 +30,7 @@ describe("survey-likert plugin", () => {
     selectInput("Q3", "3").checked = true;
     selectInput("Q4", "4").checked = true;
 
-    clickTarget(document.querySelector("#jspsych-survey-likert-next"));
+    await clickTarget(document.querySelector("#jspsych-survey-likert-next"));
 
     await expectFinished();
 
@@ -62,7 +62,7 @@ describe("survey-likert plugin simulation", () => {
 
     await expectFinished();
 
-    const surveyData = getData().values()[0].response;
+    const surveyData = getData().values()[0].response as Record<string, number>;
     const all_valid = Object.entries(surveyData).every((x) => {
       return x[1] <= 4 && x[1] >= 0;
     });
@@ -94,7 +94,7 @@ describe("survey-likert plugin simulation", () => {
 
     await expectFinished();
 
-    const surveyData = getData().values()[0].response;
+    const surveyData = getData().values()[0].response as Record<string, number>;
     const all_valid = Object.entries(surveyData).every((x) => {
       return x[1] <= 4 && x[1] >= 0;
     });

package/src/index.ts

@@ -1,37 +1,35 @@
 import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
 
+import { version } from "../package.json";
+
 const info = <const>{
   name: "survey-likert",
+  version: version,
   parameters: {
     /** Array containing one or more objects with parameters for the question(s) that should be shown on the page. */
     questions: {
       type: ParameterType.COMPLEX,
       array: true,
-      pretty_name: "Questions",
       nested: {
         /** Question prompt. */
         prompt: {
           type: ParameterType.HTML_STRING,
-          pretty_name: "Prompt",
           default: undefined,
         },
         /** Array of likert labels to display for this question. */
         labels: {
           type: ParameterType.STRING,
           array: true,
-          pretty_name: "Labels",
           default: undefined,
         },
         /** Whether or not a response to this question must be given in order to continue. */
         required: {
           type: ParameterType.BOOL,
-          pretty_name: "Required",
           default: false,
         },
         /** Name of the question in the trial data. If no name is given, the questions are named Q0, Q1, etc. */
         name: {
           type: ParameterType.STRING,
-          pretty_name: "Question Name",
           default: "",
         },
       },
@@ -39,45 +37,67 @@ const info = <const>{
     /** If true, the order of the questions in the 'questions' array will be randomized. */
     randomize_question_order: {
       type: ParameterType.BOOL,
-      pretty_name: "Randomize Question Order",
       default: false,
     },
     /** HTML-formatted string to display at top of the page above all of the questions. */
     preamble: {
       type: ParameterType.HTML_STRING,
-      pretty_name: "Preamble",
       default: null,
     },
     /** Width of the likert scales in pixels. */
     scale_width: {
       type: ParameterType.INT,
-      pretty_name: "Scale width",
       default: null,
     },
     /** Label of the button to submit responses. */
     button_label: {
       type: ParameterType.STRING,
-      pretty_name: "Button label",
       default: "Continue",
     },
     /** Setting this to true will enable browser auto-complete or auto-fill for the form. */
     autocomplete: {
       type: ParameterType.BOOL,
-      pretty_name: "Allow autocomplete",
       default: false,
     },
   },
+  data: {
+    /** An object containing the response for each question. The object will have a separate key (variable) for each question, with the first question in the trial being recorded in `Q0`, the second in `Q1`, and so on. The responses are recorded as integers, representing the position selected on the likert scale for that question. If the `name` parameter is defined for the question, then the response object will use the value of `name` as the key for each question. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. */
+    response: {
+      type: ParameterType.COMPLEX,
+      nested: {
+        identifier: {
+          type: ParameterType.STRING,
+        },
+        response: {
+          type:
+            ParameterType.STRING |
+            ParameterType.INT |
+            ParameterType.FLOAT |
+            ParameterType.BOOL |
+            ParameterType.OBJECT,
+        },
+      },
+    },
+    /** The response time in milliseconds for the participant to make a response. The time is measured from when the questions first appear on the screen until the participant's response(s) are submitted. */
+    rt: {
+      type: ParameterType.INT,
+    },
+    /** An array with the order of questions. For example `[2,0,1]` would indicate that the first question was `trial.questions[2]` (the third item in the `questions` parameter), the second question was `trial.questions[0]`, and the final question was `trial.questions[1]`. This will be encoded as a JSON string when data is saved using the `.json()` or `.csv()` functions. */
+    question_order: {
+      type: ParameterType.INT,
+      array: true,
+    },
+  },
 };
 
 type Info = typeof info;
 
 /**
- * **survey-likert**
- *
- * jsPsych plugin for gathering responses to questions on a likert scale
+ * The survey-likert plugin displays a set of questions with Likert scale responses. The participant responds
+ * by selecting a radio button.
  *
  * @author Josh de Leeuw
- * @see {@link https://www.jspsych.org/plugins/jspsych-survey-likert/ survey-likert plugin documentation on jspsych.org}
+ * @see {@link https://www.jspsych.org/latest/plugins/survey-likert/ survey-likert plugin documentation on jspsych.org}
  */
 class SurveyLikertPlugin implements JsPsychPlugin<Info> {
   static info = info;
@@ -209,8 +229,6 @@ class SurveyLikertPlugin implements JsPsychPlugin<Info> {
         question_order: question_order,
       };
 
-      display_element.innerHTML = "";
-
       // next trial
       this.jsPsych.finishTrial(trial_data);
     });