jspsych 7.3.3 → 7.3.4

package/dist/migration.d.ts

@@ -1,3 +1,3 @@
-export declare class MigrationError extends Error {
-    constructor(message?: string);
-}
+export declare class MigrationError extends Error {
+    constructor(message?: string);
+}

package/dist/modules/data/DataCollection.d.ts

@@ -1,46 +1,46 @@
-import { DataColumn } from "./DataColumn";
-export declare class DataCollection {
-    private trials;
-    constructor(data?: any[]);
-    push(new_data: any): this;
-    join(other_data_collection: DataCollection): this;
-    top(): DataCollection;
-    /**
-     * Queries the first n elements in a collection of trials.
-     *
-     * @param n A positive integer of elements to return. A value of
-     *          n that is less than 1 will throw an error.
-     *
-     * @return First n objects of a collection of trials. If fewer than
-     *         n trials are available, the trials.length elements will
-     *         be returned.
-     *
-     */
-    first(n?: number): DataCollection;
-    /**
-     * Queries the last n elements in a collection of trials.
-     *
-     * @param n A positive integer of elements to return. A value of
-     *          n that is less than 1 will throw an error.
-     *
-     * @return Last n objects of a collection of trials. If fewer than
-     *         n trials are available, the trials.length elements will
-     *         be returned.
-     *
-     */
-    last(n?: number): DataCollection;
-    values(): any[];
-    count(): number;
-    readOnly(): DataCollection;
-    addToAll(properties: any): this;
-    addToLast(properties: any): this;
-    filter(filters: any): DataCollection;
-    filterCustom(fn: any): DataCollection;
-    filterColumns(columns: Array<string>): DataCollection;
-    select(column: any): DataColumn;
-    ignore(columns: any): DataCollection;
-    uniqueNames(): any[];
-    csv(): string;
-    json(pretty?: boolean): string;
-    localSave(format: any, filename: any): void;
-}
+import { DataColumn } from "./DataColumn";
+export declare class DataCollection {
+    private trials;
+    constructor(data?: any[]);
+    push(new_data: any): this;
+    join(other_data_collection: DataCollection): this;
+    top(): DataCollection;
+    /**
+     * Queries the first n elements in a collection of trials.
+     *
+     * @param n A positive integer of elements to return. A value of
+     *          n that is less than 1 will throw an error.
+     *
+     * @return First n objects of a collection of trials. If fewer than
+     *         n trials are available, the trials.length elements will
+     *         be returned.
+     *
+     */
+    first(n?: number): DataCollection;
+    /**
+     * Queries the last n elements in a collection of trials.
+     *
+     * @param n A positive integer of elements to return. A value of
+     *          n that is less than 1 will throw an error.
+     *
+     * @return Last n objects of a collection of trials. If fewer than
+     *         n trials are available, the trials.length elements will
+     *         be returned.
+     *
+     */
+    last(n?: number): DataCollection;
+    values(): any[];
+    count(): number;
+    readOnly(): DataCollection;
+    addToAll(properties: any): this;
+    addToLast(properties: any): this;
+    filter(filters: any): DataCollection;
+    filterCustom(fn: any): DataCollection;
+    filterColumns(columns: Array<string>): DataCollection;
+    select(column: any): DataColumn;
+    ignore(columns: any): DataCollection;
+    uniqueNames(): any[];
+    csv(): string;
+    json(pretty?: boolean): string;
+    localSave(format: any, filename: any): void;
+}

package/dist/modules/data/DataColumn.d.ts

@@ -1,15 +1,15 @@
-export declare class DataColumn {
-    values: any[];
-    constructor(values?: any[]);
-    sum(): number;
-    mean(): number;
-    median(): any;
-    min(): any;
-    max(): any;
-    count(): number;
-    variance(): number;
-    sd(): number;
-    frequencies(): {};
-    all(eval_fn: any): boolean;
-    subset(eval_fn: any): DataColumn;
-}
+export declare class DataColumn {
+    values: any[];
+    constructor(values?: any[]);
+    sum(): number;
+    mean(): number;
+    median(): any;
+    min(): any;
+    max(): any;
+    count(): number;
+    variance(): number;
+    sd(): number;
+    frequencies(): {};
+    all(eval_fn: any): boolean;
+    subset(eval_fn: any): DataColumn;
+}

package/dist/modules/data/index.d.ts

@@ -1,25 +1,25 @@
-import { JsPsych } from "../../JsPsych";
-import { DataCollection } from "./DataCollection";
-export declare class JsPsychData {
-    private jsPsych;
-    private allData;
-    private interactionData;
-    private dataProperties;
-    private query_string;
-    constructor(jsPsych: JsPsych);
-    reset(): void;
-    get(): DataCollection;
-    getInteractionData(): DataCollection;
-    write(data_object: any): void;
-    addProperties(properties: any): void;
-    addDataToLastTrial(data: any): void;
-    getDataByTimelineNode(node_id: any): DataCollection;
-    getLastTrialData(): DataCollection;
-    getLastTimelineData(): DataCollection;
-    displayData(format?: string): void;
-    urlVariables(): any;
-    getURLVariable(whichvar: any): any;
-    createInteractionListeners(): void;
-    _customInsert(data: any): void;
-    _fullreset(): void;
-}
+import { JsPsych } from "../../JsPsych";
+import { DataCollection } from "./DataCollection";
+export declare class JsPsychData {
+    private jsPsych;
+    private allData;
+    private interactionData;
+    private dataProperties;
+    private query_string;
+    constructor(jsPsych: JsPsych);
+    reset(): void;
+    get(): DataCollection;
+    getInteractionData(): DataCollection;
+    write(data_object: any): void;
+    addProperties(properties: any): void;
+    addDataToLastTrial(data: any): void;
+    getDataByTimelineNode(node_id: any): DataCollection;
+    getLastTrialData(): DataCollection;
+    getLastTimelineData(): DataCollection;
+    displayData(format?: string): void;
+    urlVariables(): any;
+    getURLVariable(whichvar: any): any;
+    createInteractionListeners(): void;
+    _customInsert(data: any): void;
+    _fullreset(): void;
+}

package/dist/modules/data/utils.d.ts

@@ -1,3 +1,3 @@
-export declare function saveTextToFile(textstr: string, filename: string): void;
-export declare function JSON2CSV(objArray: any): string;
-export declare function getQueryString(): {};
+export declare function saveTextToFile(textstr: string, filename: string): void;
+export declare function JSON2CSV(objArray: any): string;
+export declare function getQueryString(): {};

package/dist/modules/extensions.d.ts

@@ -1,22 +1,22 @@
-export interface JsPsychExtensionInfo {
-    name: string;
-}
-export interface JsPsychExtension {
-    /**
-     * Called once at the start of the experiment to initialize the extension
-     */
-    initialize(params?: Record<string, any>): Promise<void>;
-    /**
-     * Called at the start of a trial, prior to invoking the plugin's trial method.
-     */
-    on_start(params?: Record<string, any>): void;
-    /**
-     * Called during a trial, after the plugin makes initial changes to the DOM.
-     */
-    on_load(params?: Record<string, any>): void;
-    /**
-     * Called at the end of the trial.
-     * @returns Data to append to the trial's data object.
-     */
-    on_finish(params?: Record<string, any>): Record<string, any> | Promise<Record<string, any>>;
-}
+export interface JsPsychExtensionInfo {
+    name: string;
+}
+export interface JsPsychExtension {
+    /**
+     * Called once at the start of the experiment to initialize the extension
+     */
+    initialize(params?: Record<string, any>): Promise<void>;
+    /**
+     * Called at the start of a trial, prior to invoking the plugin's trial method.
+     */
+    on_start(params?: Record<string, any>): void;
+    /**
+     * Called during a trial, after the plugin makes initial changes to the DOM.
+     */
+    on_load(params?: Record<string, any>): void;
+    /**
+     * Called at the end of the trial.
+     * @returns Data to append to the trial's data object.
+     */
+    on_finish(params?: Record<string, any>): Record<string, any> | Promise<Record<string, any>>;
+}

package/dist/modules/plugin-api/HardwareAPI.d.ts

@@ -1,15 +1,15 @@
-export declare class HardwareAPI {
-    /**
-     * Indicates whether this instance of jspsych has opened a hardware connection through our browser
-     * extension
-     **/
-    hardwareConnected: boolean;
-    constructor();
-    /**
-     * Allows communication with user hardware through our custom Google Chrome extension + native C++ program
-     * @param		mess	The message to be passed to our extension, see its documentation for the expected members of this object.
-     * @author	Daniel Rivas
-     *
-     */
-    hardware(mess: any): void;
-}
+export declare class HardwareAPI {
+    /**
+     * Indicates whether this instance of jspsych has opened a hardware connection through our browser
+     * extension
+     **/
+    hardwareConnected: boolean;
+    constructor();
+    /**
+     * Allows communication with user hardware through our custom Google Chrome extension + native C++ program
+     * @param		mess	The message to be passed to our extension, see its documentation for the expected members of this object.
+     * @author	Daniel Rivas
+     *
+     */
+    hardware(mess: any): void;
+}

package/dist/modules/plugin-api/KeyboardListenerAPI.d.ts

@@ -1,34 +1,34 @@
-export declare type KeyboardListener = (e: KeyboardEvent) => void;
-export declare type ValidResponses = string[] | "ALL_KEYS" | "NO_KEYS";
-export interface GetKeyboardResponseOptions {
-    callback_function: any;
-    valid_responses?: ValidResponses;
-    rt_method?: "performance" | "audio";
-    persist?: boolean;
-    audio_context?: AudioContext;
-    audio_context_start_time?: number;
-    allow_held_key?: boolean;
-    minimum_valid_rt?: number;
-}
-export declare class KeyboardListenerAPI {
-    private getRootElement;
-    private areResponsesCaseSensitive;
-    private minimumValidRt;
-    constructor(getRootElement: () => Element | undefined, areResponsesCaseSensitive?: boolean, minimumValidRt?: number);
-    private listeners;
-    private heldKeys;
-    private areRootListenersRegistered;
-    /**
-     * If not previously done and `this.getRootElement()` returns an element, adds the root key
-     * listeners to that element.
-     */
-    private registerRootListeners;
-    private rootKeydownListener;
-    private toLowerCaseIfInsensitive;
-    private rootKeyupListener;
-    private isResponseValid;
-    getKeyboardResponse({ callback_function, valid_responses, rt_method, persist, audio_context, audio_context_start_time, allow_held_key, minimum_valid_rt, }: GetKeyboardResponseOptions): KeyboardListener;
-    cancelKeyboardResponse(listener: KeyboardListener): void;
-    cancelAllKeyboardResponses(): void;
-    compareKeys(key1: string | null, key2: string | null): boolean;
-}
+export type KeyboardListener = (e: KeyboardEvent) => void;
+export type ValidResponses = string[] | "ALL_KEYS" | "NO_KEYS";
+export interface GetKeyboardResponseOptions {
+    callback_function: any;
+    valid_responses?: ValidResponses;
+    rt_method?: "performance" | "audio";
+    persist?: boolean;
+    audio_context?: AudioContext;
+    audio_context_start_time?: number;
+    allow_held_key?: boolean;
+    minimum_valid_rt?: number;
+}
+export declare class KeyboardListenerAPI {
+    private getRootElement;
+    private areResponsesCaseSensitive;
+    private minimumValidRt;
+    constructor(getRootElement: () => Element | undefined, areResponsesCaseSensitive?: boolean, minimumValidRt?: number);
+    private listeners;
+    private heldKeys;
+    private areRootListenersRegistered;
+    /**
+     * If not previously done and `this.getRootElement()` returns an element, adds the root key
+     * listeners to that element.
+     */
+    private registerRootListeners;
+    private rootKeydownListener;
+    private toLowerCaseIfInsensitive;
+    private rootKeyupListener;
+    private isResponseValid;
+    getKeyboardResponse({ callback_function, valid_responses, rt_method, persist, audio_context, audio_context_start_time, allow_held_key, minimum_valid_rt, }: GetKeyboardResponseOptions): KeyboardListener;
+    cancelKeyboardResponse(listener: KeyboardListener): void;
+    cancelAllKeyboardResponses(): void;
+    compareKeys(key1: string | null, key2: string | null): boolean;
+}

package/dist/modules/plugin-api/MediaAPI.d.ts

@@ -1,32 +1,32 @@
-export declare class MediaAPI {
-    private useWebaudio;
-    private webaudioContext?;
-    constructor(useWebaudio: boolean, webaudioContext?: AudioContext);
-    private video_buffers;
-    getVideoBuffer(videoID: string): any;
-    private context;
-    private audio_buffers;
-    initAudio(): void;
-    audioContext(): any;
-    getAudioBuffer(audioID: any): Promise<unknown>;
-    private preload_requests;
-    private img_cache;
-    preloadAudio(files: any, callback_complete?: () => void, callback_load?: (filepath: any) => void, callback_error?: (error_msg: any) => void): void;
-    preloadImages(images: any, callback_complete?: () => void, callback_load?: (filepath: any) => void, callback_error?: (error_msg: any) => void): void;
-    preloadVideo(videos: any, callback_complete?: () => void, callback_load?: (filepath: any) => void, callback_error?: (error_msg: any) => void): void;
-    private preloadMap;
-    getAutoPreloadList(timeline_description: any[]): {
-        images: string[];
-        audio: string[];
-        video: string[];
-    };
-    cancelPreloads(): void;
-    private microphone_recorder;
-    initializeMicrophoneRecorder(stream: MediaStream): void;
-    getMicrophoneRecorder(): MediaRecorder;
-    private camera_stream;
-    private camera_recorder;
-    initializeCameraRecorder(stream: MediaStream, opts?: MediaRecorderOptions): void;
-    getCameraStream(): MediaStream;
-    getCameraRecorder(): MediaRecorder;
-}
+export declare class MediaAPI {
+    private useWebaudio;
+    private webaudioContext?;
+    constructor(useWebaudio: boolean, webaudioContext?: AudioContext);
+    private video_buffers;
+    getVideoBuffer(videoID: string): any;
+    private context;
+    private audio_buffers;
+    initAudio(): void;
+    audioContext(): any;
+    getAudioBuffer(audioID: any): Promise<unknown>;
+    private preload_requests;
+    private img_cache;
+    preloadAudio(files: any, callback_complete?: () => void, callback_load?: (filepath: any) => void, callback_error?: (error_msg: any) => void): void;
+    preloadImages(images: any, callback_complete?: () => void, callback_load?: (filepath: any) => void, callback_error?: (error_msg: any) => void): void;
+    preloadVideo(videos: any, callback_complete?: () => void, callback_load?: (filepath: any) => void, callback_error?: (error_msg: any) => void): void;
+    private preloadMap;
+    getAutoPreloadList(timeline_description: any[]): {
+        images: string[];
+        audio: string[];
+        video: string[];
+    };
+    cancelPreloads(): void;
+    private microphone_recorder;
+    initializeMicrophoneRecorder(stream: MediaStream): void;
+    getMicrophoneRecorder(): MediaRecorder;
+    private camera_stream;
+    private camera_recorder;
+    initializeCameraRecorder(stream: MediaStream, opts?: MediaRecorderOptions): void;
+    getCameraStream(): MediaStream;
+    getCameraRecorder(): MediaRecorder;
+}

package/dist/modules/plugin-api/SimulationAPI.d.ts

@@ -1,44 +1,44 @@
-export declare class SimulationAPI {
-    private getDisplayContainerElement;
-    private setJsPsychTimeout;
-    constructor(getDisplayContainerElement: () => HTMLElement, setJsPsychTimeout: (callback: () => void, delay: number) => number);
-    dispatchEvent(event: Event): void;
-    /**
-     * Dispatches a `keydown` event for the specified key
-     * @param key Character code (`.key` property) for the key to press.
-     */
-    keyDown(key: string): void;
-    /**
-     * Dispatches a `keyup` event for the specified key
-     * @param key Character code (`.key` property) for the key to press.
-     */
-    keyUp(key: string): void;
-    /**
-     * Dispatches a `keydown` and `keyup` event in sequence to simulate pressing a key.
-     * @param key Character code (`.key` property) for the key to press.
-     * @param delay Length of time to wait (ms) before executing action
-     */
-    pressKey(key: string, delay?: number): void;
-    /**
-     * Dispatches `mousedown`, `mouseup`, and `click` events on the target element
-     * @param target The element to click
-     * @param delay Length of time to wait (ms) before executing action
-     */
-    clickTarget(target: Element, delay?: number): void;
-    /**
-     * Sets the value of a target text input
-     * @param target A text input element to fill in
-     * @param text Text to input
-     * @param delay Length of time to wait (ms) before executing action
-     */
-    fillTextInput(target: HTMLInputElement, text: string, delay?: number): void;
-    /**
-     * Picks a valid key from `choices`, taking into account jsPsych-specific
-     * identifiers like "NO_KEYS" and "ALL_KEYS".
-     * @param choices Which keys are valid.
-     * @returns A key selected at random from the valid keys.
-     */
-    getValidKey(choices: "NO_KEYS" | "ALL_KEYS" | Array<string> | Array<Array<string>>): any;
-    mergeSimulationData(default_data: any, simulation_options: any): any;
-    ensureSimulationDataConsistency(trial: any, data: any): void;
-}
+export declare class SimulationAPI {
+    private getDisplayContainerElement;
+    private setJsPsychTimeout;
+    constructor(getDisplayContainerElement: () => HTMLElement, setJsPsychTimeout: (callback: () => void, delay: number) => number);
+    dispatchEvent(event: Event): void;
+    /**
+     * Dispatches a `keydown` event for the specified key
+     * @param key Character code (`.key` property) for the key to press.
+     */
+    keyDown(key: string): void;
+    /**
+     * Dispatches a `keyup` event for the specified key
+     * @param key Character code (`.key` property) for the key to press.
+     */
+    keyUp(key: string): void;
+    /**
+     * Dispatches a `keydown` and `keyup` event in sequence to simulate pressing a key.
+     * @param key Character code (`.key` property) for the key to press.
+     * @param delay Length of time to wait (ms) before executing action
+     */
+    pressKey(key: string, delay?: number): void;
+    /**
+     * Dispatches `mousedown`, `mouseup`, and `click` events on the target element
+     * @param target The element to click
+     * @param delay Length of time to wait (ms) before executing action
+     */
+    clickTarget(target: Element, delay?: number): void;
+    /**
+     * Sets the value of a target text input
+     * @param target A text input element to fill in
+     * @param text Text to input
+     * @param delay Length of time to wait (ms) before executing action
+     */
+    fillTextInput(target: HTMLInputElement, text: string, delay?: number): void;
+    /**
+     * Picks a valid key from `choices`, taking into account jsPsych-specific
+     * identifiers like "NO_KEYS" and "ALL_KEYS".
+     * @param choices Which keys are valid.
+     * @returns A key selected at random from the valid keys.
+     */
+    getValidKey(choices: "NO_KEYS" | "ALL_KEYS" | Array<string> | Array<Array<string>>): any;
+    mergeSimulationData(default_data: any, simulation_options: any): any;
+    ensureSimulationDataConsistency(trial: any, data: any): void;
+}

package/dist/modules/plugin-api/TimeoutAPI.d.ts

@@ -1,17 +1,17 @@
-/**
- * A class that provides a wrapper around the global setTimeout and clearTimeout functions.
- */
-export declare class TimeoutAPI {
-    private timeout_handlers;
-    /**
-     * Calls a function after a specified delay, in milliseconds.
-     * @param callback The function to call after the delay.
-     * @param delay The number of milliseconds to wait before calling the function.
-     * @returns A handle that can be used to clear the timeout with clearTimeout.
-     */
-    setTimeout(callback: () => void, delay: number): number;
-    /**
-     * Clears all timeouts that have been created with setTimeout.
-     */
-    clearAllTimeouts(): void;
-}
+/**
+ * A class that provides a wrapper around the global setTimeout and clearTimeout functions.
+ */
+export declare class TimeoutAPI {
+    private timeout_handlers;
+    /**
+     * Calls a function after a specified delay, in milliseconds.
+     * @param callback The function to call after the delay.
+     * @param delay The number of milliseconds to wait before calling the function.
+     * @returns A handle that can be used to clear the timeout with clearTimeout.
+     */
+    setTimeout(callback: () => void, delay: number): number;
+    /**
+     * Clears all timeouts that have been created with setTimeout.
+     */
+    clearAllTimeouts(): void;
+}

package/dist/modules/plugin-api/index.d.ts

@@ -1,8 +1,8 @@
-import { JsPsych } from "../../JsPsych";
-import { HardwareAPI } from "./HardwareAPI";
-import { KeyboardListenerAPI } from "./KeyboardListenerAPI";
-import { MediaAPI } from "./MediaAPI";
-import { SimulationAPI } from "./SimulationAPI";
-import { TimeoutAPI } from "./TimeoutAPI";
-export declare function createJointPluginAPIObject(jsPsych: JsPsych): KeyboardListenerAPI & TimeoutAPI & MediaAPI & HardwareAPI & SimulationAPI;
-export declare type PluginAPI = ReturnType<typeof createJointPluginAPIObject>;
+import { JsPsych } from "../../JsPsych";
+import { HardwareAPI } from "./HardwareAPI";
+import { KeyboardListenerAPI } from "./KeyboardListenerAPI";
+import { MediaAPI } from "./MediaAPI";
+import { SimulationAPI } from "./SimulationAPI";
+import { TimeoutAPI } from "./TimeoutAPI";
+export declare function createJointPluginAPIObject(jsPsych: JsPsych): KeyboardListenerAPI & TimeoutAPI & MediaAPI & HardwareAPI & SimulationAPI;
+export type PluginAPI = ReturnType<typeof createJointPluginAPIObject>;