scorm-again 2.6.1 → 2.6.3

package/dist/types/cmi/scorm12/interactions.d.ts

@@ -0,0 +1,64 @@
+import { CMIArray } from "../common/array";
+import { BaseCMI } from "../common/base_cmi";
+export declare class CMIInteractions extends CMIArray {
+    constructor();
+}
+export declare class CMIInteractionsObject extends BaseCMI {
+    constructor();
+    readonly objectives: CMIArray;
+    readonly correct_responses: CMIArray;
+    initialize(): void;
+    private _id;
+    private _time;
+    private _type;
+    private _weighting;
+    private _student_response;
+    private _result;
+    private _latency;
+    reset(): void;
+    get id(): string;
+    set id(id: string);
+    get time(): string;
+    set time(time: string);
+    get type(): string;
+    set type(type: string);
+    get weighting(): string;
+    set weighting(weighting: string);
+    get student_response(): string;
+    set student_response(student_response: string);
+    get result(): string;
+    set result(result: string);
+    get latency(): string;
+    set latency(latency: string);
+    toJSON(): {
+        id: string;
+        time: string;
+        type: string;
+        weighting: string;
+        student_response: string;
+        result: string;
+        latency: string;
+        objectives: CMIArray;
+        correct_responses: CMIArray;
+    };
+}
+export declare class CMIInteractionsObjectivesObject extends BaseCMI {
+    constructor();
+    private _id;
+    reset(): void;
+    get id(): string;
+    set id(id: string);
+    toJSON(): {
+        id: string;
+    };
+}
+export declare class CMIInteractionsCorrectResponsesObject extends BaseCMI {
+    constructor();
+    private _pattern;
+    reset(): void;
+    get pattern(): string;
+    set pattern(pattern: string);
+    toJSON(): {
+        pattern: string;
+    };
+}

package/dist/types/cmi/scorm12/nav.d.ts

@@ -0,0 +1,11 @@
+import { BaseCMI } from "../common/base_cmi";
+export declare class NAV extends BaseCMI {
+    constructor();
+    reset(): void;
+    private _event;
+    get event(): string;
+    set event(event: string);
+    toJSON(): {
+        event: string;
+    };
+}

package/dist/types/cmi/scorm12/objectives.d.ts

@@ -0,0 +1,22 @@
+import { BaseCMI } from "../common/base_cmi";
+import { CMIScore } from "../common/score";
+import { CMIArray } from "../common/array";
+export declare class CMIObjectives extends CMIArray {
+    constructor();
+}
+export declare class CMIObjectivesObject extends BaseCMI {
+    constructor();
+    readonly score: CMIScore;
+    private _id;
+    private _status;
+    reset(): void;
+    get id(): string;
+    set id(id: string);
+    get status(): string;
+    set status(status: string);
+    toJSON(): {
+        id: string;
+        status: string;
+        score: CMIScore;
+    };
+}

package/dist/types/cmi/scorm12/student_data.d.ts

@@ -0,0 +1,22 @@
+import { BaseCMI } from "../common/base_cmi";
+export declare class CMIStudentData extends BaseCMI {
+    private readonly __children;
+    private _mastery_score;
+    private _max_time_allowed;
+    private _time_limit_action;
+    constructor(student_data_children?: string);
+    reset(): void;
+    get _children(): string;
+    set _children(_children: string);
+    get mastery_score(): string;
+    set mastery_score(mastery_score: string);
+    get max_time_allowed(): string;
+    set max_time_allowed(max_time_allowed: string);
+    get time_limit_action(): string;
+    set time_limit_action(time_limit_action: string);
+    toJSON(): {
+        mastery_score: string;
+        max_time_allowed: string;
+        time_limit_action: string;
+    };
+}

package/dist/types/cmi/scorm12/student_preference.d.ts

@@ -0,0 +1,26 @@
+import { BaseCMI } from "../common/base_cmi";
+export declare class CMIStudentPreference extends BaseCMI {
+    private readonly __children;
+    constructor(student_preference_children?: string);
+    private _audio;
+    private _language;
+    private _speed;
+    private _text;
+    reset(): void;
+    get _children(): string;
+    set _children(_children: string);
+    get audio(): string;
+    set audio(audio: string);
+    get language(): string;
+    set language(language: string);
+    get speed(): string;
+    set speed(speed: string);
+    get text(): string;
+    set text(text: string);
+    toJSON(): {
+        audio: string;
+        language: string;
+        speed: string;
+        text: string;
+    };
+}

package/dist/types/cmi/scorm12/validation.d.ts

@@ -0,0 +1,2 @@
+export declare function check12ValidFormat(value: string, regexPattern: string, allowEmptyString?: boolean): boolean;
+export declare function check12ValidRange(value: any, rangePattern: string, allowEmptyString?: boolean): boolean;

package/dist/types/cmi/scorm2004/adl.d.ts

@@ -0,0 +1,71 @@
+import { BaseCMI } from "../common/base_cmi";
+import { NAVBoolean } from "../../constants/enums";
+import { CMIArray } from "../common/array";
+export declare class ADL extends BaseCMI {
+    constructor();
+    nav: ADLNav;
+    data: ADLData;
+    initialize(): void;
+    reset(): void;
+    toJSON(): {
+        nav: ADLNav;
+        data: ADLData;
+    };
+}
+export declare class ADLNav extends BaseCMI {
+    private _request;
+    constructor();
+    request_valid: ADLNavRequestValid;
+    initialize(): void;
+    reset(): void;
+    get request(): string;
+    set request(request: string);
+    toJSON(): {
+        request: string;
+    };
+}
+export declare class ADLData extends CMIArray {
+    constructor();
+}
+export declare class ADLDataObject extends BaseCMI {
+    private _id;
+    private _store;
+    constructor();
+    reset(): void;
+    get id(): string;
+    set id(id: string);
+    get store(): string;
+    set store(store: string);
+    toJSON(): {
+        id: string;
+        store: string;
+    };
+}
+export declare class ADLNavRequestValid extends BaseCMI {
+    private _continue;
+    private _previous;
+    private _choice;
+    private _jump;
+    constructor();
+    reset(): void;
+    get continue(): string;
+    set continue(_continue: string);
+    get previous(): string;
+    set previous(_previous: string);
+    get choice(): {
+        [key: string]: NAVBoolean;
+    };
+    set choice(choice: {
+        [key: string]: string;
+    });
+    get jump(): {
+        [key: string]: NAVBoolean;
+    };
+    set jump(jump: {
+        [key: string]: string;
+    });
+    toJSON(): {
+        previous: string;
+        continue: string;
+    };
+}

package/dist/types/cmi/scorm2004/cmi.d.ts

@@ -0,0 +1,103 @@
+import { BaseRootCMI } from "../common/base_cmi";
+import { CMILearnerPreference } from "./learner_preference";
+import { CMIInteractions } from "./interactions";
+import { Scorm2004CMIScore } from "./score";
+import { CMICommentsFromLearner, CMICommentsFromLMS } from "./comments";
+import { CMIObjectives } from "./objectives";
+export declare class CMI extends BaseRootCMI {
+    constructor(initialized?: boolean);
+    learner_preference: CMILearnerPreference;
+    score: Scorm2004CMIScore;
+    comments_from_learner: CMICommentsFromLearner;
+    comments_from_lms: CMICommentsFromLMS;
+    interactions: CMIInteractions;
+    objectives: CMIObjectives;
+    private __version;
+    private __children;
+    private _completion_status;
+    private _completion_threshold;
+    private _credit;
+    private _entry;
+    private _exit;
+    private _launch_data;
+    private _learner_id;
+    private _learner_name;
+    private _location;
+    private _max_time_allowed;
+    private _mode;
+    private _progress_measure;
+    private _scaled_passing_score;
+    private _session_time;
+    private _success_status;
+    private _suspend_data;
+    private _time_limit_action;
+    private _total_time;
+    initialize(): void;
+    reset(): void;
+    get _version(): string;
+    set _version(_version: string);
+    get _children(): string;
+    set _children(_children: number);
+    get completion_status(): string;
+    set completion_status(completion_status: string);
+    get completion_threshold(): string;
+    set completion_threshold(completion_threshold: string);
+    get credit(): string;
+    set credit(credit: string);
+    get entry(): string;
+    set entry(entry: string);
+    get exit(): string;
+    set exit(exit: string);
+    get launch_data(): string;
+    set launch_data(launch_data: string);
+    get learner_id(): string;
+    set learner_id(learner_id: string);
+    get learner_name(): string;
+    set learner_name(learner_name: string);
+    get location(): string;
+    set location(location: string);
+    get max_time_allowed(): string;
+    set max_time_allowed(max_time_allowed: string);
+    get mode(): string;
+    set mode(mode: string);
+    get progress_measure(): string;
+    set progress_measure(progress_measure: string);
+    get scaled_passing_score(): string;
+    set scaled_passing_score(scaled_passing_score: string);
+    get session_time(): string;
+    set session_time(session_time: string);
+    get success_status(): string;
+    set success_status(success_status: string);
+    get suspend_data(): string;
+    set suspend_data(suspend_data: string);
+    get time_limit_action(): string;
+    set time_limit_action(time_limit_action: string);
+    get total_time(): string;
+    set total_time(total_time: string);
+    getCurrentTotalTime(): string;
+    toJSON(): {
+        comments_from_learner: CMICommentsFromLearner;
+        comments_from_lms: CMICommentsFromLMS;
+        completion_status: string;
+        completion_threshold: string;
+        credit: string;
+        entry: string;
+        exit: string;
+        interactions: CMIInteractions;
+        launch_data: string;
+        learner_id: string;
+        learner_name: string;
+        learner_preference: CMILearnerPreference;
+        location: string;
+        max_time_allowed: string;
+        mode: string;
+        objectives: CMIObjectives;
+        progress_measure: string;
+        scaled_passing_score: string;
+        score: Scorm2004CMIScore;
+        session_time: string;
+        success_status: string;
+        suspend_data: string;
+        time_limit_action: string;
+    };
+}

package/dist/types/cmi/scorm2004/comments.d.ts

@@ -0,0 +1,27 @@
+import { CMIArray } from "../common/array";
+import { BaseCMI } from "../common/base_cmi";
+export declare class CMICommentsFromLMS extends CMIArray {
+    constructor();
+}
+export declare class CMICommentsFromLearner extends CMIArray {
+    constructor();
+}
+export declare class CMICommentsObject extends BaseCMI {
+    private _comment;
+    private _location;
+    private _timestamp;
+    private readonly _readOnlyAfterInit;
+    constructor(readOnlyAfterInit?: boolean);
+    reset(): void;
+    get comment(): string;
+    set comment(comment: string);
+    get location(): string;
+    set location(location: string);
+    get timestamp(): string;
+    set timestamp(timestamp: string);
+    toJSON(): {
+        comment: string;
+        location: string;
+        timestamp: string;
+    };
+}

package/dist/types/cmi/scorm2004/interactions.d.ts

@@ -0,0 +1,68 @@
+import { BaseCMI } from "../common/base_cmi";
+import { CMIArray } from "../common/array";
+export declare class CMIInteractions extends CMIArray {
+    constructor();
+}
+export declare class CMIInteractionsObject extends BaseCMI {
+    private _id;
+    private _type;
+    private _timestamp;
+    private _weighting;
+    private _learner_response;
+    private _result;
+    private _latency;
+    private _description;
+    constructor();
+    objectives: CMIArray;
+    correct_responses: CMIArray;
+    initialize(): void;
+    reset(): void;
+    get id(): string;
+    set id(id: string);
+    get type(): string;
+    set type(type: string);
+    get timestamp(): string;
+    set timestamp(timestamp: string);
+    get weighting(): string;
+    set weighting(weighting: string);
+    get learner_response(): string;
+    set learner_response(learner_response: string);
+    get result(): string;
+    set result(result: string);
+    get latency(): string;
+    set latency(latency: string);
+    get description(): string;
+    set description(description: string);
+    toJSON(): {
+        id: string;
+        type: string;
+        objectives: CMIArray;
+        timestamp: string;
+        correct_responses: CMIArray;
+        weighting: string;
+        learner_response: string;
+        result: string;
+        latency: string;
+        description: string;
+    };
+}
+export declare class CMIInteractionsObjectivesObject extends BaseCMI {
+    private _id;
+    constructor();
+    reset(): void;
+    get id(): string;
+    set id(id: string);
+    toJSON(): {
+        id: string;
+    };
+}
+export declare class CMIInteractionsCorrectResponsesObject extends BaseCMI {
+    private _pattern;
+    constructor();
+    reset(): void;
+    get pattern(): string;
+    set pattern(pattern: string);
+    toJSON(): {
+        pattern: string;
+    };
+}

package/dist/types/cmi/scorm2004/learner_preference.d.ts

@@ -0,0 +1,26 @@
+import { BaseCMI } from "../common/base_cmi";
+export declare class CMILearnerPreference extends BaseCMI {
+    private __children;
+    private _audio_level;
+    private _language;
+    private _delivery_speed;
+    private _audio_captioning;
+    constructor();
+    reset(): void;
+    get _children(): string;
+    set _children(_children: string);
+    get audio_level(): string;
+    set audio_level(audio_level: string);
+    get language(): string;
+    set language(language: string);
+    get delivery_speed(): string;
+    set delivery_speed(delivery_speed: string);
+    get audio_captioning(): string;
+    set audio_captioning(audio_captioning: string);
+    toJSON(): {
+        audio_level: string;
+        language: string;
+        delivery_speed: string;
+        audio_captioning: string;
+    };
+}

package/dist/types/cmi/scorm2004/objectives.d.ts

@@ -0,0 +1,38 @@
+import { CMIArray } from "../common/array";
+import { BaseCMI } from "../common/base_cmi";
+import { Scorm2004CMIScore } from "./score";
+export declare class CMIObjectives extends CMIArray {
+    constructor();
+    findObjectiveById(id: string): CMIObjectivesObject | undefined;
+    findObjectiveByIndex(index: number): CMIObjectivesObject;
+    setObjectiveByIndex(index: number, objective: CMIObjectivesObject): void;
+}
+export declare class CMIObjectivesObject extends BaseCMI {
+    private _id;
+    private _success_status;
+    private _completion_status;
+    private _progress_measure;
+    private _description;
+    constructor();
+    reset(): void;
+    score: Scorm2004CMIScore;
+    initialize(): void;
+    get id(): string;
+    set id(id: string);
+    get success_status(): string;
+    set success_status(success_status: string);
+    get completion_status(): string;
+    set completion_status(completion_status: string);
+    get progress_measure(): string;
+    set progress_measure(progress_measure: string);
+    get description(): string;
+    set description(description: string);
+    toJSON(): {
+        id: string;
+        success_status: string;
+        completion_status: string;
+        progress_measure: string;
+        description: string;
+        score: Scorm2004CMIScore;
+    };
+}

package/dist/types/cmi/scorm2004/score.d.ts

@@ -0,0 +1,14 @@
+import { CMIScore } from "../common/score";
+export declare class Scorm2004CMIScore extends CMIScore {
+    private _scaled;
+    constructor();
+    reset(): void;
+    get scaled(): string;
+    set scaled(scaled: string);
+    toJSON(): {
+        scaled: string;
+        raw: string;
+        min: string;
+        max: string;
+    };
+}

package/dist/types/cmi/scorm2004/validation.d.ts

@@ -0,0 +1,2 @@
+export declare function check2004ValidFormat(value: string, regexPattern: string, allowEmptyString?: boolean): boolean;
+export declare function check2004ValidRange(value: string, rangePattern: string): boolean;

package/dist/types/constants/api_constants.d.ts

@@ -0,0 +1,49 @@
+interface ErrorDescription {
+    basicMessage: string;
+    detailMessage: string;
+}
+interface ErrorDescriptions {
+    [key: string]: ErrorDescription;
+}
+interface ScormConstants {
+    cmi_children: string;
+    core_children: string;
+    score_children: string;
+    comments_children: string;
+    objectives_children: string;
+    correct_responses_children: string;
+    student_data_children: string;
+    student_preference_children: string;
+    interactions_children: string;
+    error_descriptions: ErrorDescriptions;
+}
+interface AiccConstants extends ScormConstants {
+    student_demographics_children: string;
+    tries_children: string;
+    attempt_records_children: string;
+    paths_children: string;
+}
+interface Scorm2004Constants {
+    cmi_children: string;
+    comments_children: string;
+    score_children: string;
+    objectives_children: string;
+    correct_responses_children: string;
+    student_data_children: string;
+    student_preference_children: string;
+    interactions_children: string;
+    adl_data_children: string;
+    error_descriptions: ErrorDescriptions;
+}
+interface GlobalConstants {
+    SCORM_TRUE: string;
+    SCORM_FALSE: string;
+    STATE_NOT_INITIALIZED: number;
+    STATE_INITIALIZED: number;
+    STATE_TERMINATED: number;
+}
+export declare const global_constants: GlobalConstants;
+export declare const scorm12_constants: ScormConstants;
+export declare const aicc_constants: AiccConstants;
+export declare const scorm2004_constants: Scorm2004Constants;
+export {};

package/dist/types/constants/default_settings.d.ts

@@ -0,0 +1,2 @@
+import { InternalSettings } from "../types/api_types";
+export declare const DefaultSettings: InternalSettings;

package/dist/types/constants/enums.d.ts

@@ -0,0 +1,23 @@
+export declare enum NAVBoolean {
+    unknown = "unknown",
+    true = "true",
+    false = "false"
+}
+export declare enum SuccessStatus {
+    passed = "passed",
+    failed = "failed",
+    unknown = "unknown"
+}
+export declare enum CompletionStatus {
+    completed = "completed",
+    incomplete = "incomplete",
+    unknown = "unknown"
+}
+export declare enum LogLevelEnum {
+    _ = 0,
+    DEBUG = 1,
+    INFO = 2,
+    WARN = 3,
+    ERROR = 4,
+    NONE = 5
+}

package/dist/types/constants/error_codes.d.ts

@@ -0,0 +1,6 @@
+export type ErrorCode = {
+    [key: string]: number;
+};
+export declare const global_errors: ErrorCode;
+export declare const scorm12_errors: ErrorCode;
+export declare const scorm2004_errors: ErrorCode;

package/dist/types/constants/language_constants.d.ts

@@ -0,0 +1,2 @@
+declare const ValidLanguages: string[];
+export default ValidLanguages;

package/dist/types/constants/regex.d.ts

@@ -0,0 +1,82 @@
+export declare const scorm12_regex: {
+    CMIString256: string;
+    CMIString4096: string;
+    CMITime: string;
+    CMITimespan: string;
+    CMIInteger: string;
+    CMISInteger: string;
+    CMIDecimal: string;
+    CMIIdentifier: string;
+    CMIFeedback: string;
+    CMIIndex: string;
+    CMIStatus: string;
+    CMIStatus2: string;
+    CMIExit: string;
+    CMIType: string;
+    CMIResult: string;
+    NAVEvent: string;
+    score_range: string;
+    audio_range: string;
+    speed_range: string;
+    weighting_range: string;
+    text_range: string;
+};
+export declare const aicc_regex: {
+    CMIIdentifier: string;
+    CMIString256: string;
+    CMIString4096: string;
+    CMITime: string;
+    CMITimespan: string;
+    CMIInteger: string;
+    CMISInteger: string;
+    CMIDecimal: string;
+    CMIFeedback: string;
+    CMIIndex: string;
+    CMIStatus: string;
+    CMIStatus2: string;
+    CMIExit: string;
+    CMIType: string;
+    CMIResult: string;
+    NAVEvent: string;
+    score_range: string;
+    audio_range: string;
+    speed_range: string;
+    weighting_range: string;
+    text_range: string;
+};
+export declare const scorm2004_regex: {
+    CMIString200: string;
+    CMIString250: string;
+    CMIString1000: string;
+    CMIString4000: string;
+    CMIString64000: string;
+    CMILang: string;
+    CMILangString250: string;
+    CMILangcr: string;
+    CMILangString250cr: string;
+    CMILangString4000: string;
+    CMITime: string;
+    CMITimespan: string;
+    CMIInteger: string;
+    CMISInteger: string;
+    CMIDecimal: string;
+    CMIIdentifier: string;
+    CMIShortIdentifier: string;
+    CMILongIdentifier: string;
+    CMIFeedback: string;
+    CMIIndex: string;
+    CMIIndexStore: string;
+    CMICStatus: string;
+    CMISStatus: string;
+    CMIExit: string;
+    CMIType: string;
+    CMIResult: string;
+    NAVEvent: string;
+    NAVBoolean: string;
+    NAVTarget: string;
+    scaled_range: string;
+    audio_range: string;
+    speed_range: string;
+    text_range: string;
+    progress_range: string;
+};