jspsych-tangram 0.0.14 → 0.0.16

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { JsPsychPlugin, ParameterType, JsPsych, TrialType } from 'jspsych';
 
-declare const info$2: {
+declare const info$3: {
     name: string;
     version: string;
     parameters: {
@@ -127,7 +127,7 @@ declare const info$2: {
     };
     citations: string;
 };
-type Info$2 = typeof info$2;
+type Info$3 = typeof info$3;
 /**
  * **tangram-construct**
  *
@@ -136,7 +136,7 @@ type Info$2 = typeof info$2;
  * @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$2> {
+declare class TangramConstructPlugin implements JsPsychPlugin<Info$3> {
     private jsPsych;
     static info: {
         name: string;
@@ -270,10 +270,10 @@ declare class TangramConstructPlugin implements JsPsychPlugin<Info$2> {
      * Launches the trial by invoking startConstructionTrial
      * with the display element, parameters, and jsPsych instance.
      */
-    trial(display_element: HTMLElement, trial: TrialType<Info$2>): void;
+    trial(display_element: HTMLElement, trial: TrialType<Info$3>): void;
 }
 
-declare const info$1: {
+declare const info$2: {
     name: string;
     version: string;
     parameters: {
@@ -356,7 +356,7 @@ declare const info$1: {
     };
     citations: string;
 };
-type Info$1 = typeof info$1;
+type Info$2 = typeof info$2;
 /**
  * **tangram-prep**
  *
@@ -364,7 +364,7 @@ type Info$1 = typeof info$1;
  *
  * @author Justin Yang & Sean Paul Anderson
  */
-declare class TangramPrepPlugin implements JsPsychPlugin<Info$1> {
+declare class TangramPrepPlugin implements JsPsychPlugin<Info$2> {
     private jsPsych;
     static info: {
         name: string;
@@ -454,10 +454,10 @@ declare class TangramPrepPlugin implements JsPsychPlugin<Info$1> {
      * Launches the trial by invoking startPrepTrial
      * 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: {
@@ -545,7 +545,7 @@ declare const info: {
     };
     citations: string;
 };
-type Info = typeof info;
+type Info$1 = typeof info$1;
 /**
  * **tangram-nback**
  *
@@ -555,7 +555,7 @@ type Info = typeof info;
  * @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> {
+declare class TangramNBackPlugin implements JsPsychPlugin<Info$1> {
     private jsPsych;
     static info: {
         name: string;
@@ -650,7 +650,173 @@ declare class TangramNBackPlugin implements JsPsychPlugin<Info> {
      * Launches the trial by invoking startNBackTrial
      * 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: {
+        /** Left tangram specification to display */
+        tangram_left: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+        /** Right tangram specification to display */
+        tangram_right: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+        /** HTML content to display above the tangrams as instructions */
+        instructions: {
+            type: ParameterType;
+            default: string;
+            description: string;
+        };
+        /** Text to display on left response button */
+        button_text_left: {
+            type: ParameterType;
+            default: string;
+            description: string;
+        };
+        /** Text to display on right response button */
+        button_text_right: {
+            type: ParameterType;
+            default: string;
+            description: string;
+        };
+        /** Whether to show tangram decomposed into individual primitives with borders */
+        show_tangram_decomposition: {
+            type: ParameterType;
+            default: boolean;
+            description: string;
+        };
+        /** Whether to use distinct colors for each primitive shape type */
+        use_primitive_colors: {
+            type: ParameterType;
+            default: boolean;
+            description: string;
+        };
+        /** Indices mapping primitives to colors from the color palette */
+        primitive_color_indices: {
+            type: ParameterType;
+            default: number[];
+            description: string;
+        };
+        /** Callback fired when trial ends */
+        onTrialEnd: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+    };
+    data: {
+        /** Reaction time in milliseconds */
+        rt: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Response choice */
+        response: {
+            type: ParameterType;
+            description: string;
+        };
+    };
+    citations: string;
+};
+type Info = typeof info;
+/**
+ * **tangram-afc**
+ *
+ * A jsPsych plugin for alternative forced choice (AFC) trials displaying two tangrams
+ * side-by-side with response buttons.
+ *
+ * @author Justin Yang & Sean Paul Anderson
+ * @see {@link https://github.com/cogtoolslab/tangram_construction.git/tree/main/experiments/jspsych-tangram-prep}
+ */
+declare class TangramAFCPlugin implements JsPsychPlugin<Info> {
+    private jsPsych;
+    static info: {
+        name: string;
+        version: string;
+        parameters: {
+            /** Left tangram specification to display */
+            tangram_left: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+            /** Right tangram specification to display */
+            tangram_right: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+            /** HTML content to display above the tangrams as instructions */
+            instructions: {
+                type: ParameterType;
+                default: string;
+                description: string;
+            };
+            /** Text to display on left response button */
+            button_text_left: {
+                type: ParameterType;
+                default: string;
+                description: string;
+            };
+            /** Text to display on right response button */
+            button_text_right: {
+                type: ParameterType;
+                default: string;
+                description: string;
+            };
+            /** Whether to show tangram decomposed into individual primitives with borders */
+            show_tangram_decomposition: {
+                type: ParameterType;
+                default: boolean;
+                description: string;
+            };
+            /** Whether to use distinct colors for each primitive shape type */
+            use_primitive_colors: {
+                type: ParameterType;
+                default: boolean;
+                description: string;
+            };
+            /** Indices mapping primitives to colors from the color palette */
+            primitive_color_indices: {
+                type: ParameterType;
+                default: number[];
+                description: string;
+            };
+            /** Callback fired when trial ends */
+            onTrialEnd: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+        };
+        data: {
+            /** Reaction time in milliseconds */
+            rt: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Response choice */
+            response: {
+                type: ParameterType;
+                description: string;
+            };
+        };
+        citations: string;
+    };
+    constructor(jsPsych: JsPsych);
+    /**
+     * Launches the trial by invoking startAFCTrial
+     * with the display element, parameters, and jsPsych instance.
+     */
     trial(display_element: HTMLElement, trial: TrialType<Info>): void;
 }
 
-export { TangramConstructPlugin, TangramNBackPlugin, TangramPrepPlugin };
+export { TangramAFCPlugin, TangramConstructPlugin, TangramNBackPlugin, TangramPrepPlugin };