jspsych-tangram 0.0.1

package/dist/construct/index.d.ts

@@ -0,0 +1,204 @@
+import { JsPsychPlugin, ParameterType, JsPsych, TrialType } from 'jspsych';
+
+declare const info: {
+    name: string;
+    version: string;
+    parameters: {
+        /** Array of tangram specifications defining the puzzles to solve */
+        tangrams: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+        /** Array of pre-made macro pieces from prep plugin */
+        quickstash_macros: {
+            type: ParameterType;
+            default: never[];
+            description: string;
+        };
+        /** Whether to place pieces in workspace or directly on silhouette */
+        target: {
+            type: ParameterType;
+            options: string[];
+            default: string;
+            description: string;
+        };
+        /** Input method for piece manipulation */
+        input: {
+            type: ParameterType;
+            options: string[];
+            default: string;
+            description: string;
+        };
+        /** Layout style for piece arrangement */
+        layout: {
+            type: ParameterType;
+            options: string[];
+            default: string;
+            description: string;
+        };
+        /** Maximum time allowed for trial in milliseconds */
+        time_limit_ms: {
+            type: ParameterType;
+            default: number;
+            description: string;
+        };
+        /** Snap radius for piece placement in pixels */
+        snap_radius_px: {
+            type: ParameterType;
+            default: number;
+            description: string;
+        };
+        /** Callback fired after each interaction (piece pickup + placedown) */
+        onInteraction: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+        /** Callback fired when trial ends */
+        onTrialEnd: {
+            type: ParameterType;
+            default: undefined;
+            description: string;
+        };
+    };
+    data: {
+        /** Array of all interaction events during trial */
+        events: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Completion time for each sector/tangram */
+        completion_times: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Final completion state of each sector */
+        final_state: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Usage statistics for macro pieces */
+        macros_used: {
+            type: ParameterType;
+            description: string;
+        };
+        /** Total trial duration in milliseconds */
+        trial_duration_ms: {
+            type: ParameterType;
+            description: string;
+        };
+    };
+    citations: string;
+};
+type Info = typeof info;
+/**
+ * **tangram-construct**
+ *
+ * A jsPsych wrapper around the React-based construction interface.
+ *
+ * @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> {
+    private jsPsych;
+    static info: {
+        name: string;
+        version: string;
+        parameters: {
+            /** Array of tangram specifications defining the puzzles to solve */
+            tangrams: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+            /** Array of pre-made macro pieces from prep plugin */
+            quickstash_macros: {
+                type: ParameterType;
+                default: never[];
+                description: string;
+            };
+            /** Whether to place pieces in workspace or directly on silhouette */
+            target: {
+                type: ParameterType;
+                options: string[];
+                default: string;
+                description: string;
+            };
+            /** Input method for piece manipulation */
+            input: {
+                type: ParameterType;
+                options: string[];
+                default: string;
+                description: string;
+            };
+            /** Layout style for piece arrangement */
+            layout: {
+                type: ParameterType;
+                options: string[];
+                default: string;
+                description: string;
+            };
+            /** Maximum time allowed for trial in milliseconds */
+            time_limit_ms: {
+                type: ParameterType;
+                default: number;
+                description: string;
+            };
+            /** Snap radius for piece placement in pixels */
+            snap_radius_px: {
+                type: ParameterType;
+                default: number;
+                description: string;
+            };
+            /** Callback fired after each interaction (piece pickup + placedown) */
+            onInteraction: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+            /** Callback fired when trial ends */
+            onTrialEnd: {
+                type: ParameterType;
+                default: undefined;
+                description: string;
+            };
+        };
+        data: {
+            /** Array of all interaction events during trial */
+            events: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Completion time for each sector/tangram */
+            completion_times: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Final completion state of each sector */
+            final_state: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Usage statistics for macro pieces */
+            macros_used: {
+                type: ParameterType;
+                description: string;
+            };
+            /** Total trial duration in milliseconds */
+            trial_duration_ms: {
+                type: ParameterType;
+                description: string;
+            };
+        };
+        citations: string;
+    };
+    constructor(jsPsych: JsPsych);
+    /**
+     * Launches the trial by invoking startConstructionTrial
+     * with the display element, parameters, and jsPsych instance.
+     */
+    trial(display_element: HTMLElement, trial: TrialType<Info>): void;
+}
+
+export { TangramConstructPlugin as default };