jspsych-tangram 0.0.8 → 0.0.10

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { JsPsychPlugin, ParameterType, JsPsych, TrialType } from 'jspsych';
 
-declare const info$1: {
+declare const info$2: {
     name: string;
     version: string;
     parameters: {
@@ -109,7 +109,7 @@ declare const info$1: {
     };
     citations: string;
 };
-type Info$1 = typeof info$1;
+type Info$2 = typeof info$2;
 /**
  * **tangram-construct**
  *
@@ -118,7 +118,7 @@ type Info$1 = typeof info$1;
  * @author Justin Yang & Sean Paul Anderson
  * @see {@link https://github.com/cogtoolslab/tangram_construction.git/tree/main/experiments/jspsych-tangram-prep}
  */
-declare class TangramConstructPlugin implements JsPsychPlugin<Info$1> {
+declare class TangramConstructPlugin implements JsPsychPlugin<Info$2> {
     private jsPsych;
     static info: {
         name: string;
@@ -234,10 +234,10 @@ declare class TangramConstructPlugin implements JsPsychPlugin<Info$1> {
      * Launches the trial by invoking startConstructionTrial
      * with the display element, parameters, and jsPsych instance.
      */
-    trial(display_element: HTMLElement, trial: TrialType<Info$1>): void;
+    trial(display_element: HTMLElement, trial: TrialType<Info$2>): void;
 }
 
-declare const info: {
+declare const info$1: {
     name: string;
     version: string;
     parameters: {
@@ -308,7 +308,7 @@ declare const info: {
     };
     citations: string;
 };
-type Info = typeof info;
+type Info$1 = typeof info$1;
 /**
  * **tangram-prep**
  *
@@ -316,7 +316,7 @@ type Info = typeof info;
  *
  * @author Justin Yang & Sean Paul Anderson
  */
-declare class TangramPrepPlugin implements JsPsychPlugin<Info> {
+declare class TangramPrepPlugin implements JsPsychPlugin<Info$1> {
     private jsPsych;
     static info: {
         name: string;
@@ -394,7 +394,179 @@ declare class TangramPrepPlugin implements JsPsychPlugin<Info> {
      * Launches the trial by invoking startPrepTrial
      * with the display element, parameters, and jsPsych instance.
      */
+    trial(display_element: HTMLElement, trial: TrialType<Info$1>): void;
+}
+
+declare const info: {
+    name: string;
+    version: string;
+    parameters: {
+        /** Single tangram specification to display */
+        tangram: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+        /** Whether this trial is a match (for computing accuracy) */
+        isMatch: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+        /** Whether to show tangram decomposed into individual primitives with borders */
+        show_tangram_decomposition: {
+            type: ParameterType;
+            default: boolean;
+            description: string;
+        };
+        /** HTML content to display above the tangram as instructions */
+        instructions: {
+            type: ParameterType;
+            default: string;
+            description: string;
+        };
+        /** Text to display on response button */
+        button_text: {
+            type: ParameterType;
+            default: string;
+            description: string;
+        };
+        /** Duration to display tangram and accept responses (milliseconds) */
+        duration: {
+            type: ParameterType;
+            default: number;
+            description: string;
+        };
+        /** Callback fired when trial ends */
+        onTrialEnd: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+    };
+    data: {
+        /** Whether participant clicked the response button before duration expired */
+        responded_match: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Reaction time in milliseconds (NaN if no response or response after duration) */
+        rt: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Accuracy: 1 if correct, 0 if incorrect, NaN if isMatch not provided */
+        accuracy: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Whether response occurred after duration expired */
+        responded_after_duration: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Time of late response (NaN if no late response) */
+        rt_after_duration: {
+            type: ParameterType;
+            description: string;
+        };
+    };
+    citations: string;
+};
+type Info = typeof info;
+/**
+ * **tangram-nback**
+ *
+ * A jsPsych plugin for n-back matching trials displaying a single tangram
+ * with a response button.
+ *
+ * @author Justin Yang & Sean Paul Anderson
+ * @see {@link https://github.com/cogtoolslab/tangram_construction.git/tree/main/experiments/jspsych-tangram-prep}
+ */
+declare class TangramNBackPlugin implements JsPsychPlugin<Info> {
+    private jsPsych;
+    static info: {
+        name: string;
+        version: string;
+        parameters: {
+            /** Single tangram specification to display */
+            tangram: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+            /** Whether this trial is a match (for computing accuracy) */
+            isMatch: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+            /** Whether to show tangram decomposed into individual primitives with borders */
+            show_tangram_decomposition: {
+                type: ParameterType;
+                default: boolean;
+                description: string;
+            };
+            /** HTML content to display above the tangram as instructions */
+            instructions: {
+                type: ParameterType;
+                default: string;
+                description: string;
+            };
+            /** Text to display on response button */
+            button_text: {
+                type: ParameterType;
+                default: string;
+                description: string;
+            };
+            /** Duration to display tangram and accept responses (milliseconds) */
+            duration: {
+                type: ParameterType;
+                default: number;
+                description: string;
+            };
+            /** Callback fired when trial ends */
+            onTrialEnd: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+        };
+        data: {
+            /** Whether participant clicked the response button before duration expired */
+            responded_match: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Reaction time in milliseconds (NaN if no response or response after duration) */
+            rt: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Accuracy: 1 if correct, 0 if incorrect, NaN if isMatch not provided */
+            accuracy: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Whether response occurred after duration expired */
+            responded_after_duration: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Time of late response (NaN if no late response) */
+            rt_after_duration: {
+                type: ParameterType;
+                description: string;
+            };
+        };
+        citations: string;
+    };
+    constructor(jsPsych: JsPsych);
+    /**
+     * Launches the trial by invoking startNBackTrial
+     * with the display element, parameters, and jsPsych instance.
+     */
     trial(display_element: HTMLElement, trial: TrialType<Info>): void;
 }
 
-export { TangramConstructPlugin, TangramPrepPlugin };
+export { TangramConstructPlugin, TangramNBackPlugin, TangramPrepPlugin };