jspsych 8.1.0 → 8.2.1

package/dist/index.d.ts

@@ -64,6 +64,7 @@ interface PluginInfo {
     version?: string;
     parameters: ParameterInfos;
     data?: ParameterInfos;
+    citations?: Record<string, string> | string;
 }
 interface JsPsychPlugin<I extends PluginInfo> {
     trial(display_element: HTMLElement, trial: TrialType<I>, on_load?: () => void): void | Promise<TrialResult | void>;
@@ -75,6 +76,7 @@ interface JsPsychExtensionInfo {
     name: string;
     version?: string;
     data?: ParameterInfos;
+    citations?: Record<string, string> | string;
 }
 interface JsPsychExtension {
     /**
@@ -790,39 +792,23 @@ type RandomWordsResult<T extends RandomWordsOptions> = T extends {
  */
 declare function randomWords<T extends RandomWordsOptions>(opts: T): RandomWordsResult<T>;
 
-declare const randomization_setSeed: typeof setSeed;
-declare const randomization_repeat: typeof repeat;
-declare const randomization_shuffle: typeof shuffle;
-declare const randomization_shuffleNoRepeats: typeof shuffleNoRepeats;
-declare const randomization_shuffleAlternateGroups: typeof shuffleAlternateGroups;
-declare const randomization_sampleWithoutReplacement: typeof sampleWithoutReplacement;
-declare const randomization_sampleWithReplacement: typeof sampleWithReplacement;
 declare const randomization_factorial: typeof factorial;
 declare const randomization_randomID: typeof randomID;
 declare const randomization_randomInt: typeof randomInt;
+declare const randomization_randomWords: typeof randomWords;
+declare const randomization_repeat: typeof repeat;
 declare const randomization_sampleBernoulli: typeof sampleBernoulli;
-declare const randomization_sampleNormal: typeof sampleNormal;
-declare const randomization_sampleExponential: typeof sampleExponential;
 declare const randomization_sampleExGaussian: typeof sampleExGaussian;
-declare const randomization_randomWords: typeof randomWords;
+declare const randomization_sampleExponential: typeof sampleExponential;
+declare const randomization_sampleNormal: typeof sampleNormal;
+declare const randomization_sampleWithReplacement: typeof sampleWithReplacement;
+declare const randomization_sampleWithoutReplacement: typeof sampleWithoutReplacement;
+declare const randomization_setSeed: typeof setSeed;
+declare const randomization_shuffle: typeof shuffle;
+declare const randomization_shuffleAlternateGroups: typeof shuffleAlternateGroups;
+declare const randomization_shuffleNoRepeats: typeof shuffleNoRepeats;
 declare namespace randomization {
-  export {
-    randomization_setSeed as setSeed,
-    randomization_repeat as repeat,
-    randomization_shuffle as shuffle,
-    randomization_shuffleNoRepeats as shuffleNoRepeats,
-    randomization_shuffleAlternateGroups as shuffleAlternateGroups,
-    randomization_sampleWithoutReplacement as sampleWithoutReplacement,
-    randomization_sampleWithReplacement as sampleWithReplacement,
-    randomization_factorial as factorial,
-    randomization_randomID as randomID,
-    randomization_randomInt as randomInt,
-    randomization_sampleBernoulli as sampleBernoulli,
-    randomization_sampleNormal as sampleNormal,
-    randomization_sampleExponential as sampleExponential,
-    randomization_sampleExGaussian as sampleExGaussian,
-    randomization_randomWords as randomWords,
-  };
+  export { randomization_factorial as factorial, randomization_randomID as randomID, randomization_randomInt as randomInt, randomization_randomWords as randomWords, randomization_repeat as repeat, randomization_sampleBernoulli as sampleBernoulli, randomization_sampleExGaussian as sampleExGaussian, randomization_sampleExponential as sampleExponential, randomization_sampleNormal as sampleNormal, randomization_sampleWithReplacement as sampleWithReplacement, randomization_sampleWithoutReplacement as sampleWithoutReplacement, randomization_setSeed as setSeed, randomization_shuffle as shuffle, randomization_shuffleAlternateGroups as shuffleAlternateGroups, randomization_shuffleNoRepeats as shuffleNoRepeats };
 }
 
 interface turkInformation {
@@ -865,13 +851,10 @@ declare function turkInfo(): turkInformation;
  */
 declare function submitToTurk(data: any): void;
 
-declare const turk_turkInfo: typeof turkInfo;
 declare const turk_submitToTurk: typeof submitToTurk;
+declare const turk_turkInfo: typeof turkInfo;
 declare namespace turk {
-  export {
-    turk_turkInfo as turkInfo,
-    turk_submitToTurk as submitToTurk,
-  };
+  export { turk_submitToTurk as submitToTurk, turk_turkInfo as turkInfo };
 }
 
 /**
@@ -888,15 +871,11 @@ declare function deepCopy(obj: any): any;
  */
 declare function deepMerge(obj1: any, obj2: any): any;
 
-declare const utils_unique: typeof unique;
 declare const utils_deepCopy: typeof deepCopy;
 declare const utils_deepMerge: typeof deepMerge;
+declare const utils_unique: typeof unique;
 declare namespace utils {
-  export {
-    utils_unique as unique,
-    utils_deepCopy as deepCopy,
-    utils_deepMerge as deepMerge,
-  };
+  export { utils_deepCopy as deepCopy, utils_deepMerge as deepMerge, utils_unique as unique };
 }
 
 /**
@@ -928,6 +907,7 @@ declare class JsPsych {
     data: JsPsychData;
     pluginAPI: PluginAPI;
     version(): string;
+    private citation;
     /** Options */
     private options;
     /** Experiment timeline */
@@ -983,6 +963,15 @@ declare class JsPsych {
     resumeExperiment(): void;
     getSafeModeStatus(): boolean;
     getTimeline(): TimelineArray;
+    /**
+     * Prints out a string containing citations for the jsPsych library and all input plugins/extensions in the specified format.
+     * If called without input, prints citation for jsPsych library.
+     *
+     * @param plugins The plugins/extensions to generate citations for. Always prints the citation for the jsPsych library at the top.
+     * @param format The desired output citation format. Currently supports "apa" and "bibtex".
+     * @returns String containing citations separated with newline character.
+     */
+    getCitations(plugins?: Array<Class<JsPsychPlugin<any>> | Class<JsPsychExtension>>, format?: "apa" | "bibtex"): string;
     get extensions(): Record<string, JsPsychExtension>;
     private prepareDom;
     private finishTrialPromise;
@@ -1000,4 +989,4 @@ declare class JsPsych {
  */
 declare function initJsPsych(options?: any): JsPsych;
 
-export { DataCollection, JsPsych, JsPsychExtension, JsPsychExtensionInfo, JsPsychPlugin, ParameterType, PluginInfo, TrialType, initJsPsych };
+export { DataCollection, JsPsych, type JsPsychExtension, type JsPsychExtensionInfo, type JsPsychPlugin, ParameterType, type PluginInfo, type TrialType, initJsPsych };