jspsych 8.0.2 → 8.1.0

package/dist/index.d.ts

@@ -204,7 +204,7 @@ declare class Timeline extends TimelineNode {
      * If the timeline is running or paused, aborts the timeline after the current trial has completed
      */
     abort(): void;
-    private instantiateChildNodes;
+    private instantiateChildNode;
     private currentTimelineVariables;
     private setCurrentTimelineVariablesByIndex;
     /**
@@ -742,11 +742,11 @@ type PluginAPI = ReturnType<typeof createJointPluginAPIObject>;
  */
 declare function setSeed(seed?: string): string;
 declare function repeat(array: any, repetitions: any, unpack?: boolean): any;
-declare function shuffle(array: Array<any>): any[];
-declare function shuffleNoRepeats(arr: Array<any>, equalityTest: (a: any, b: any) => boolean): any[];
-declare function shuffleAlternateGroups(arr_groups: any, random_group_order?: boolean): any[];
-declare function sampleWithoutReplacement(arr: any, size: any): any[];
-declare function sampleWithReplacement(arr: any, size: any, weights?: any): any[];
+declare function shuffle<T>(array: Array<T>): T[];
+declare function shuffleNoRepeats<T>(arr: Array<T>, equalityTest: (a: T, b: T) => boolean): T[];
+declare function shuffleAlternateGroups<T extends any[]>(arr_groups: Array<T>, random_group_order?: boolean): any[];
+declare function sampleWithoutReplacement<T>(arr: Array<T>, size: number): T[];
+declare function sampleWithReplacement<T>(arr: Array<T>, size: number, weights?: number[]): any[];
 declare function factorial(factors: Record<string, any>, repetitions?: number, unpack?: boolean): any;
 declare function randomID(length?: number): string;
 /**
@@ -765,6 +765,19 @@ declare function sampleBernoulli(p: number): 0 | 1;
 declare function sampleNormal(mean: number, standard_deviation: number): number;
 declare function sampleExponential(rate: number): number;
 declare function sampleExGaussian(mean: number, standard_deviation: number, rate: number, positive?: boolean): number;
+type RandomWordsOptions = {
+    min?: number;
+    max?: number;
+    exactly?: number;
+    maxLength?: number;
+    wordsPerString?: number;
+    seperator?: string;
+    formatter?: (word: string, index: number) => string;
+    join?: string;
+};
+type RandomWordsResult<T extends RandomWordsOptions> = T extends {
+    join: string;
+} ? string : string[];
 /**
  * Generate one or more random words.
  *
@@ -775,7 +788,7 @@ declare function sampleExGaussian(mean: number, standard_deviation: number, rate
  *
  * @returns An array of words or a single string, depending on parameter choices.
  */
-declare function randomWords(opts: any): string[];
+declare function randomWords<T extends RandomWordsOptions>(opts: T): RandomWordsResult<T>;
 
 declare const randomization_setSeed: typeof setSeed;
 declare const randomization_repeat: typeof repeat;

package/dist/index.js

@@ -4,7 +4,7 @@ import seedrandom from 'seedrandom/lib/alea';
 
 var _package = {
   name: "jspsych",
-  version: "8.0.2",
+  version: "8.1.0",
   description: "Behavioral experiments in a browser",
   type: "module",
   main: "dist/index.cjs",
@@ -52,7 +52,7 @@ var _package = {
   },
   devDependencies: {
     "@fontsource/open-sans": "4.5.3",
-    "@jspsych/config": "^3.0.0",
+    "@jspsych/config": "^3.0.1",
     "@types/dom-mediacapture-record": "^1.0.11",
     "base64-inline-loader": "^2.0.1",
     "css-loader": "^6.6.0",
@@ -2038,7 +2038,8 @@ class Timeline extends TimelineNode {
           }
           for (const timelineVariableIndex of timelineVariableOrder) {
             this.setCurrentTimelineVariablesByIndex(timelineVariableIndex);
-            for (const childNode of this.instantiateChildNodes()) {
+            for (const childNodeDescription of this.description.timeline) {
+              const childNode = this.instantiateChildNode(childNodeDescription);
               const previousChild = this.currentChild;
               this.currentChild = childNode;
               childNode.index = previousChild ? previousChild.getLatestNode().index + 1 : this.index;
@@ -2095,12 +2096,10 @@ class Timeline extends TimelineNode {
       }
     }
   }
-  instantiateChildNodes() {
-    const newChildNodes = this.description.timeline.map((childDescription) => {
-      return isTimelineDescription(childDescription) ? new Timeline(this.dependencies, childDescription, this) : new Trial(this.dependencies, childDescription, this);
-    });
-    this.children.push(...newChildNodes);
-    return newChildNodes;
+  instantiateChildNode(childDescription) {
+    const newChildNode = isTimelineDescription(childDescription) ? new Timeline(this.dependencies, childDescription, this) : new Trial(this.dependencies, childDescription, this);
+    this.children.push(newChildNode);
+    return newChildNode;
   }
   setCurrentTimelineVariablesByIndex(index) {
     this.currentTimelineVariables = {