jspsych-tangram 0.0.16 → 0.0.18

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { JsPsychPlugin, ParameterType, JsPsych, TrialType } from 'jspsych';
 
-declare const info$3: {
+declare const info$4: {
     name: string;
     version: string;
     parameters: {
@@ -127,7 +127,7 @@ declare const info$3: {
     };
     citations: string;
 };
-type Info$3 = typeof info$3;
+type Info$4 = typeof info$4;
 /**
  * **tangram-construct**
  *
@@ -136,7 +136,7 @@ type Info$3 = typeof info$3;
  * @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$3> {
+declare class TangramConstructPlugin implements JsPsychPlugin<Info$4> {
     private jsPsych;
     static info: {
         name: string;
@@ -270,10 +270,10 @@ declare class TangramConstructPlugin implements JsPsychPlugin<Info$3> {
      * Launches the trial by invoking startConstructionTrial
      * with the display element, parameters, and jsPsych instance.
      */
-    trial(display_element: HTMLElement, trial: TrialType<Info$3>): void;
+    trial(display_element: HTMLElement, trial: TrialType<Info$4>): void;
 }
 
-declare const info$2: {
+declare const info$3: {
     name: string;
     version: string;
     parameters: {
@@ -356,7 +356,7 @@ declare const info$2: {
     };
     citations: string;
 };
-type Info$2 = typeof info$2;
+type Info$3 = typeof info$3;
 /**
  * **tangram-prep**
  *
@@ -364,7 +364,7 @@ type Info$2 = typeof info$2;
  *
  * @author Justin Yang & Sean Paul Anderson
  */
-declare class TangramPrepPlugin implements JsPsychPlugin<Info$2> {
+declare class TangramPrepPlugin implements JsPsychPlugin<Info$3> {
     private jsPsych;
     static info: {
         name: string;
@@ -454,10 +454,10 @@ declare class TangramPrepPlugin implements JsPsychPlugin<Info$2> {
      * Launches the trial by invoking startPrepTrial
      * 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: {
@@ -545,7 +545,7 @@ declare const info$1: {
     };
     citations: string;
 };
-type Info$1 = typeof info$1;
+type Info$2 = typeof info$2;
 /**
  * **tangram-nback**
  *
@@ -555,7 +555,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 TangramNBackPlugin implements JsPsychPlugin<Info$1> {
+declare class TangramNBackPlugin implements JsPsychPlugin<Info$2> {
     private jsPsych;
     static info: {
         name: string;
@@ -650,10 +650,10 @@ declare class TangramNBackPlugin implements JsPsychPlugin<Info$1> {
      * Launches the trial by invoking startNBackTrial
      * 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: {
@@ -726,7 +726,7 @@ declare const info: {
     };
     citations: string;
 };
-type Info = typeof info;
+type Info$1 = typeof info$1;
 /**
  * **tangram-afc**
  *
@@ -736,7 +736,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 TangramAFCPlugin implements JsPsychPlugin<Info> {
+declare class TangramAFCPlugin implements JsPsychPlugin<Info$1> {
     private jsPsych;
     static info: {
         name: string;
@@ -816,7 +816,178 @@ declare class TangramAFCPlugin implements JsPsychPlugin<Info> {
      * Launches the trial by invoking startAFCTrial
      * 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: {
+        /** Array of tangram specifications to display in the grid */
+        tangrams: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+        /** Number of rows in the grid */
+        n_rows: {
+            type: ParameterType;
+            default: number;
+            description: string;
+        };
+        /** Number of columns in the grid */
+        n_cols: {
+            type: ParameterType;
+            default: number;
+            description: string;
+        };
+        /** Prompt text displayed above the text input */
+        prompt_text: {
+            type: ParameterType;
+            default: string;
+            description: string;
+        };
+        /** Label for the submit button */
+        button_text: {
+            type: ParameterType;
+            default: string;
+            description: string;
+        };
+        /** Whether to show tangrams decomposed into primitives */
+        show_tangram_decomposition: {
+            type: ParameterType;
+            default: boolean;
+            description: string;
+        };
+        /** Whether to use distinct colors for each primitive type */
+        use_primitive_colors: {
+            type: ParameterType;
+            default: boolean;
+            description: string;
+        };
+        /** Indices mapping primitives to colors */
+        primitive_color_indices: {
+            type: ParameterType;
+            default: number[];
+            description: string;
+        };
+        /** Callback fired when trial ends */
+        onTrialEnd: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+    };
+    data: {
+        /** The text response entered by the participant */
+        response: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Reaction time from trial start to submit button click */
+        rt: {
+            type: ParameterType;
+            description: string;
+        };
+    };
+    citations: string;
+};
+type Info = typeof info;
+/**
+ * **tangram-grid**
+ *
+ * A jsPsych plugin that displays a grid of tangrams with a text input field
+ * and submit button for collecting free-text responses.
+ *
+ * @author Sean Paul Anderson & Justin Yang
+ * @see {@link https://github.com/cogtoolslab/tangram_construction.git}
+ */
+declare class TangramGridPlugin implements JsPsychPlugin<Info> {
+    private jsPsych;
+    static info: {
+        name: string;
+        version: string;
+        parameters: {
+            /** Array of tangram specifications to display in the grid */
+            tangrams: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+            /** Number of rows in the grid */
+            n_rows: {
+                type: ParameterType;
+                default: number;
+                description: string;
+            };
+            /** Number of columns in the grid */
+            n_cols: {
+                type: ParameterType;
+                default: number;
+                description: string;
+            };
+            /** Prompt text displayed above the text input */
+            prompt_text: {
+                type: ParameterType;
+                default: string;
+                description: string;
+            };
+            /** Label for the submit button */
+            button_text: {
+                type: ParameterType;
+                default: string;
+                description: string;
+            };
+            /** Whether to show tangrams decomposed into primitives */
+            show_tangram_decomposition: {
+                type: ParameterType;
+                default: boolean;
+                description: string;
+            };
+            /** Whether to use distinct colors for each primitive type */
+            use_primitive_colors: {
+                type: ParameterType;
+                default: boolean;
+                description: string;
+            };
+            /** Indices mapping primitives to colors */
+            primitive_color_indices: {
+                type: ParameterType;
+                default: number[];
+                description: string;
+            };
+            /** Callback fired when trial ends */
+            onTrialEnd: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+        };
+        data: {
+            /** The text response entered by the participant */
+            response: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Reaction time from trial start to submit button click */
+            rt: {
+                type: ParameterType;
+                description: string;
+            };
+        };
+        citations: string;
+    };
+    constructor(jsPsych: JsPsych);
+    /**
+     * Launches the trial by invoking startGridTrial with the display element,
+     * parameters, and jsPsych instance.
+     *
+     * REQUIRES: display_element is a valid HTMLElement, trial contains valid
+     *           parameters
+     * MODIFIES: display_element (renders React component)
+     * EFFECTS: Starts the grid trial and handles cleanup on completion
+     */
     trial(display_element: HTMLElement, trial: TrialType<Info>): void;
 }
 
-export { TangramAFCPlugin, TangramConstructPlugin, TangramNBackPlugin, TangramPrepPlugin };
+export { TangramAFCPlugin, TangramConstructPlugin, TangramGridPlugin, TangramNBackPlugin, TangramPrepPlugin };