@lookit/record 0.0.3

package/dist/consentVideo.d.ts

@@ -0,0 +1,353 @@
+import { JsPsych, JsPsychPlugin, ParameterType, TrialType } from "jspsych";
+declare const info: {
+    readonly name: "consent-video";
+    readonly version: string;
+    readonly parameters: {
+        readonly template: {
+            readonly type: ParameterType.STRING;
+            readonly default: "consent_005";
+        };
+        readonly locale: {
+            readonly type: ParameterType.STRING;
+            readonly default: "en-us";
+        };
+        readonly additional_video_privacy_statement: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly datause: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly gdpr: {
+            readonly type: ParameterType.BOOL;
+            readonly default: false;
+        };
+        readonly gdpr_personal_data: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly gdpr_sensitive_data: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly PIName: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly include_databrary: {
+            readonly type: ParameterType.BOOL;
+            readonly default: false;
+        };
+        readonly institution: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly PIContact: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly payment: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly private_level_only: {
+            readonly type: ParameterType.BOOL;
+            readonly default: false;
+        };
+        readonly procedures: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly purpose: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly research_rights_statement: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly risk_statement: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly voluntary_participation: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly purpose_header: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly procedures_header: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly participation_header: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly benefits_header: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly risk_header: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly summary_statement: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly additional_segments: {
+            readonly type: ParameterType.COMPLEX;
+            readonly array: true;
+            readonly nested: {
+                readonly title: {
+                    readonly type: ParameterType.STRING;
+                    readonly default: "";
+                };
+            };
+            readonly text: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+        };
+        readonly prompt_all_adults: {
+            readonly type: ParameterType.BOOL;
+            readonly default: false;
+        };
+        readonly prompt_only_adults: {
+            readonly type: ParameterType.BOOL;
+            readonly default: false;
+        };
+        readonly consent_statement_text: {
+            readonly type: ParameterType.STRING;
+            readonly default: "";
+        };
+        readonly omit_injury_phrase: {
+            readonly type: ParameterType.BOOL;
+            readonly default: false;
+        };
+    };
+};
+type Info = typeof info;
+/** The video consent plugin. */
+export declare class VideoConsentPlugin implements JsPsychPlugin<Info> {
+    private readonly jsPsych;
+    static readonly info: {
+        readonly name: "consent-video";
+        readonly version: string;
+        readonly parameters: {
+            readonly template: {
+                readonly type: ParameterType.STRING;
+                readonly default: "consent_005";
+            };
+            readonly locale: {
+                readonly type: ParameterType.STRING;
+                readonly default: "en-us";
+            };
+            readonly additional_video_privacy_statement: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly datause: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly gdpr: {
+                readonly type: ParameterType.BOOL;
+                readonly default: false;
+            };
+            readonly gdpr_personal_data: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly gdpr_sensitive_data: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly PIName: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly include_databrary: {
+                readonly type: ParameterType.BOOL;
+                readonly default: false;
+            };
+            readonly institution: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly PIContact: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly payment: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly private_level_only: {
+                readonly type: ParameterType.BOOL;
+                readonly default: false;
+            };
+            readonly procedures: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly purpose: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly research_rights_statement: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly risk_statement: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly voluntary_participation: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly purpose_header: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly procedures_header: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly participation_header: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly benefits_header: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly risk_header: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly summary_statement: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly additional_segments: {
+                readonly type: ParameterType.COMPLEX;
+                readonly array: true;
+                readonly nested: {
+                    readonly title: {
+                        readonly type: ParameterType.STRING;
+                        readonly default: "";
+                    };
+                };
+                readonly text: {
+                    readonly type: ParameterType.STRING;
+                    readonly default: "";
+                };
+            };
+            readonly prompt_all_adults: {
+                readonly type: ParameterType.BOOL;
+                readonly default: false;
+            };
+            readonly prompt_only_adults: {
+                readonly type: ParameterType.BOOL;
+                readonly default: false;
+            };
+            readonly consent_statement_text: {
+                readonly type: ParameterType.STRING;
+                readonly default: "";
+            };
+            readonly omit_injury_phrase: {
+                readonly type: ParameterType.BOOL;
+                readonly default: false;
+            };
+        };
+    };
+    private readonly recorder;
+    private readonly video_container_id;
+    /**
+     * Instantiate video consent plugin.
+     *
+     * @param jsPsych - JsPsych object
+     */
+    constructor(jsPsych: JsPsych);
+    /**
+     * Create/Show trial view.
+     *
+     * @param display - HTML element for experiment.
+     * @param trial - Trial data including user supplied parameters.
+     */
+    trial(display: HTMLElement, trial: TrialType<Info>): void;
+    /**
+     * Retrieve video container element.
+     *
+     * @param display - HTML element for experiment.
+     * @returns Video container
+     */
+    private getVideoContainer;
+    /**
+     * Add webcam feed to HTML.
+     *
+     * @param display - HTML element for experiment.
+     */
+    private recordFeed;
+    /**
+     * Playback Feed
+     *
+     * @param display - JsPsych display HTML element.
+     */
+    private playbackFeed;
+    /**
+     * Put back the webcam feed once the video recording has ended. This is used
+     * with the "ended" Event.
+     *
+     * @param display - JsPsych display HTML element.
+     * @returns Event function
+     */
+    private onEnded;
+    /**
+     * Retrieve button element from DOM.
+     *
+     * @param display - HTML element for experiment.
+     * @param id - Element id
+     * @returns Button element
+     */
+    private getButton;
+    /**
+     * Select and return the image element.
+     *
+     * @param display - HTML element for experiment.
+     * @param id - ID string of Image element
+     * @returns Image Element
+     */
+    private getImg;
+    /**
+     * Add record button to HTML.
+     *
+     * @param display - HTML element for experiment.
+     */
+    private recordButton;
+    /**
+     * Set up play button to playback last recorded video.
+     *
+     * @param display - HTML element for experiment.
+     */
+    private playButton;
+    /**
+     * Add stop button to HTML.
+     *
+     * @param display - HTML element for experiment.
+     */
+    private stopButton;
+    /**
+     * Add next button to HTML.
+     *
+     * @param display - HTML element for experiment.
+     */
+    private nextButton;
+}
+export {};

package/dist/errors.d.ts

@@ -0,0 +1,158 @@
+/** Error thrown when recorder is null. */
+export declare class RecorderInitializeError extends Error {
+    /**
+     * When there isn't a recorder, provide the user with an explanation of what
+     * they could do to resolve the issue.
+     */
+    constructor();
+}
+/** Error thrown when stream is inactive and recorder is started. */
+export declare class StreamInactiveInitializeError extends Error {
+    /**
+     * Error check on initialize. Attempting to validate recorder is ready to
+     * start recording.
+     */
+    constructor();
+}
+/** Error thrown when stream data is available and recorder is started. */
+export declare class StreamDataInitializeError extends Error {
+    /**
+     * Error check on recorder initialize. Attempt to validate recorder data array
+     * is empty and ready to start recording.
+     */
+    constructor();
+}
+/**
+ * Error thrown when trying to stop an active session recording that cannot be
+ * found.
+ */
+export declare class NoSessionRecordingError extends Error {
+    /**
+     * When trying to stop a recording that isn't found, provide the user with an
+     * explanation of what they could do to resolve the issue.
+     */
+    constructor();
+}
+/**
+ * Error thrown when trying to trying to start a recording while another is
+ * already active.
+ */
+export declare class ExistingRecordingError extends Error {
+    /**
+     * When trying to start a recording but there is already an active recording
+     * in progress, provide the user with an explanation of what they could do to
+     * resolve the issue.
+     */
+    constructor();
+}
+/**
+ * Error thrown when trying to to stop the recorder and the stop promise doesn't
+ * exist.
+ */
+export declare class NoStopPromiseError extends Error {
+    /**
+     * When attempting to stop a recording but there's no stop promise to ensure
+     * the stop has completed.
+     */
+    constructor();
+}
+/**
+ * Error thrown when attempting an action that relies on an input stream, such
+ * as the mic volume check, but no such stream is found.
+ */
+export declare class NoStreamError extends Error {
+    /**
+     * When attempting an action that requires an input stream, such as the mic
+     * check, but no stream is found.
+     */
+    constructor();
+}
+/**
+ * Error thrown if there's a problem setting up the microphone input level
+ * check.
+ */
+export declare class MicCheckError extends Error {
+    /**
+     * Occurs if there's a problem setting up the mic check, including setting up
+     * the audio context and stream source, loading the audio worklet processor
+     * script, setting up the port message event handler, and resolving the
+     * promise chain via message events passed to onMicActivityLevel.
+     *
+     * @param err - Error passed into this error that is thrown in the catch
+     *   block, if any. Errors passed to catch blocks must have type unknown.
+     */
+    constructor(err: unknown);
+}
+/**
+ * Error thrown when attempting to access S3 object and it's, unknowingly,
+ * undefined.
+ */
+export declare class S3UndefinedError extends Error {
+    /**
+     * Provide feed back when recorder attempts to use S3 object and it's
+     * undefined.
+     */
+    constructor();
+}
+/**
+ * Error thrown when attempting to reset recorder, but its stream is still
+ * active.
+ */
+export declare class StreamActiveOnResetError extends Error {
+    /**
+     * This error will be thrown when developer attempts to reset recorder while
+     * active.
+     */
+    constructor();
+}
+/** Error thrown when attempting to select webcam element and it's not found. */
+export declare class NoWebCamElementError extends Error {
+    /**
+     * Error thrown when attempting to retrieve webcam element and it's not in the
+     * DOM.
+     */
+    constructor();
+}
+/**
+ * Error thrown when attempting to create playback/download url and data array
+ * is empty.
+ */
+export declare class CreateURLError extends Error {
+    /**
+     * Throw this error when data array is empty and url still needs to be
+     * created. Sometimes this means the "reset()" method was called too early.
+     */
+    constructor();
+}
+/** Error thrown when video container couldn't be found. */
+export declare class VideoContainerNotFoundError extends Error {
+    /** No video container found. */
+    constructor();
+}
+/** Error thrown when button not found. */
+export declare class ButtonNotFoundError extends Error {
+    /**
+     * Button couldn't be found by ID field.
+     *
+     * @param id - HTML ID parameter.
+     */
+    constructor(id: string);
+}
+/** Throw Error when image couldn't be found. */
+export declare class ImageNotFoundError extends Error {
+    /**
+     * Error when image couldn't be found by ID field.
+     *
+     * @param id - HTML ID parameter
+     */
+    constructor(id: string);
+}
+/** Error throw what specified language isn't found */
+export declare class TranslationNotFoundError extends Error {
+    /**
+     * This will be thrown when attempting to init i18n
+     *
+     * @param baseName - Language a2code with region
+     */
+    constructor(baseName: string);
+}