jspsych 7.3.3 → 8.0.0

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

@@ -1,8 +0,0 @@
-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>;

package/dist/modules/plugins.d.ts

@@ -1,136 +0,0 @@
-/**
-Flatten the type output to improve type hints shown in editors.
-Borrowed from type-fest
-*/
-declare type Simplify<T> = {
-    [KeyType in keyof T]: T[KeyType];
-};
-/**
-Create a type that makes the given keys required. The remaining keys are kept as is.
-Borrowed from type-fest
-*/
-declare type SetRequired<BaseType, Keys extends keyof BaseType> = Simplify<Omit<BaseType, Keys> & Required<Pick<BaseType, Keys>>>;
-/**
- * Parameter types for plugins
- */
-export declare enum ParameterType {
-    BOOL = 0,
-    STRING = 1,
-    INT = 2,
-    FLOAT = 3,
-    FUNCTION = 4,
-    KEY = 5,
-    KEYS = 6,
-    SELECT = 7,
-    HTML_STRING = 8,
-    IMAGE = 9,
-    AUDIO = 10,
-    VIDEO = 11,
-    OBJECT = 12,
-    COMPLEX = 13,
-    TIMELINE = 14
-}
-declare type ParameterTypeMap = {
-    [ParameterType.BOOL]: boolean;
-    [ParameterType.STRING]: string;
-    [ParameterType.INT]: number;
-    [ParameterType.FLOAT]: number;
-    [ParameterType.FUNCTION]: (...args: any[]) => any;
-    [ParameterType.KEY]: string;
-    [ParameterType.KEYS]: string[] | "ALL_KEYS" | "NO_KEYS";
-    [ParameterType.SELECT]: any;
-    [ParameterType.HTML_STRING]: string;
-    [ParameterType.IMAGE]: string;
-    [ParameterType.AUDIO]: string;
-    [ParameterType.VIDEO]: string;
-    [ParameterType.OBJECT]: object;
-    [ParameterType.COMPLEX]: any;
-    [ParameterType.TIMELINE]: any;
-};
-export interface ParameterInfo {
-    type: ParameterType;
-    array?: boolean;
-    pretty_name?: string;
-    default?: any;
-    preload?: boolean;
-}
-export interface ParameterInfos {
-    [key: string]: ParameterInfo;
-}
-declare type InferredParameter<I extends ParameterInfo> = I["array"] extends true ? Array<ParameterTypeMap[I["type"]]> : ParameterTypeMap[I["type"]];
-declare type RequiredParameterNames<I extends ParameterInfos> = {
-    [K in keyof I]: I[K]["default"] extends undefined ? K : never;
-}[keyof I];
-declare type InferredParameters<I extends ParameterInfos> = SetRequired<{
-    [Property in keyof I]?: InferredParameter<I[Property]>;
-}, RequiredParameterNames<I>>;
-export declare const universalPluginParameters: {
-    /**
-     * Data to add to this trial (key-value pairs)
-     */
-    readonly data: {
-        readonly type: ParameterType.OBJECT;
-        readonly pretty_name: "Data";
-        readonly default: {};
-    };
-    /**
-     * Function to execute when trial begins
-     */
-    readonly on_start: {
-        readonly type: ParameterType.FUNCTION;
-        readonly pretty_name: "On start";
-        readonly default: () => void;
-    };
-    /**
-     * Function to execute when trial is finished
-     */
-    readonly on_finish: {
-        readonly type: ParameterType.FUNCTION;
-        readonly pretty_name: "On finish";
-        readonly default: () => void;
-    };
-    /**
-     * Function to execute after the trial has loaded
-     */
-    readonly on_load: {
-        readonly type: ParameterType.FUNCTION;
-        readonly pretty_name: "On load";
-        readonly default: () => void;
-    };
-    /**
-     * Length of gap between the end of this trial and the start of the next trial
-     */
-    readonly post_trial_gap: {
-        readonly type: ParameterType.INT;
-        readonly pretty_name: "Post trial gap";
-        readonly default: any;
-    };
-    /**
-     * A list of CSS classes to add to the jsPsych display element for the duration of this trial
-     */
-    readonly css_classes: {
-        readonly type: ParameterType.STRING;
-        readonly pretty_name: "Custom CSS classes";
-        readonly default: any;
-    };
-    /**
-     * Options to control simulation mode for the trial.
-     */
-    readonly simulation_options: {
-        readonly type: ParameterType.COMPLEX;
-        readonly default: any;
-    };
-};
-export declare type UniversalPluginParameters = InferredParameters<typeof universalPluginParameters>;
-export interface PluginInfo {
-    name: string;
-    parameters: {
-        [key: string]: ParameterInfo;
-    };
-}
-export interface JsPsychPlugin<I extends PluginInfo> {
-    trial(display_element: HTMLElement, trial: TrialType<I>, on_load?: () => void): void | Promise<any>;
-}
-export declare type TrialType<I extends PluginInfo> = InferredParameters<I["parameters"]> & UniversalPluginParameters;
-export declare type PluginParameters<I extends PluginInfo> = InferredParameters<I["parameters"]>;
-export {};

package/dist/modules/randomization.d.ts

@@ -1,42 +0,0 @@
-/**
- * Uses the `seedrandom` package to replace Math.random() with a seedable PRNG.
- *
- * @param seed An optional seed. If none is given, a random seed will be generated.
- * @returns The seed value.
- */
-export declare function setSeed(seed?: string): string;
-export declare function repeat(array: any, repetitions: any, unpack?: boolean): any;
-export declare function shuffle(array: Array<any>): any[];
-export declare function shuffleNoRepeats(arr: Array<any>, equalityTest: (a: any, b: any) => boolean): any[];
-export declare function shuffleAlternateGroups(arr_groups: any, random_group_order?: boolean): any[];
-export declare function sampleWithoutReplacement(arr: any, size: any): any[];
-export declare function sampleWithReplacement(arr: any, size: any, weights?: any): any[];
-export declare function factorial(factors: Record<string, any>, repetitions?: number, unpack?: boolean): any;
-export declare function randomID(length?: number): string;
-/**
- * Generate a random integer from `lower` to `upper`, inclusive of both end points.
- * @param lower The lowest value it is possible to generate
- * @param upper The highest value it is possible to generate
- * @returns A random integer
- */
-export declare function randomInt(lower: number, upper: number): number;
-/**
- * Generates a random sample from a Bernoulli distribution.
- * @param p The probability of sampling 1.
- * @returns 0, with probability 1-p, or 1, with probability p.
- */
-export declare function sampleBernoulli(p: number): 0 | 1;
-export declare function sampleNormal(mean: number, standard_deviation: number): number;
-export declare function sampleExponential(rate: number): number;
-export declare function sampleExGaussian(mean: number, standard_deviation: number, rate: number, positive?: boolean): number;
-/**
- * Generate one or more random words.
- *
- * This is a wrapper function for the {@link https://www.npmjs.com/package/random-words `random-words` npm package}.
- *
- * @param opts An object with optional properties `min`, `max`, `exactly`,
- * `join`, `maxLength`, `wordsPerString`, `separator`, and `formatter`.
- *
- * @returns An array of words or a single string, depending on parameter choices.
- */
-export declare function randomWords(opts: any): any;

package/dist/modules/turk.d.ts

@@ -1,40 +0,0 @@
-interface turkInformation {
-    /**
-     * Is the experiment being loaded in preview mode on Mechanical Turk?
-     */
-    previewMode: boolean;
-    /**
-     * Is the experiment being loaded outside of the Mechanical Turk environment?
-     */
-    outsideTurk: boolean;
-    /**
-     * The HIT ID.
-     */
-    hitId: string;
-    /**
-     * The Assignment ID.
-     */
-    assignmentId: string;
-    /**
-     * The worker ID.
-     */
-    workerId: string;
-    /**
-     * URL for submission of the HIT.
-     */
-    turkSubmitTo: string;
-}
-/**
- * Gets information about the Mechanical Turk Environment, HIT, Assignment, and Worker
- * by parsing the URL variables that Mechanical Turk generates.
- * @returns An object containing information about the Mechanical Turk Environment, HIT, Assignment, and Worker.
- */
-export declare function turkInfo(): turkInformation;
-/**
- * Send data to Mechnical Turk for storage.
- * @param data An object containing `key:value` pairs to send to Mechanical Turk. Values
- * cannot contain nested objects, arrays, or functions.
- * @returns Nothing
- */
-export declare function submitToTurk(data: any): void;
-export {};

package/dist/modules/utils.d.ts

@@ -1,13 +0,0 @@
-/**
- * Finds all of the unique items in an array.
- * @param arr The array to extract unique values from
- * @returns An array with one copy of each unique item in `arr`
- */
-export declare function unique(arr: Array<any>): any[];
-export declare function deepCopy(obj: any): any;
-/**
- * Merges two objects, recursively.
- * @param obj1 Object to merge
- * @param obj2 Object to merge
- */
-export declare function deepMerge(obj1: any, obj2: any): any;