scorm-again 2.6.1 → 2.6.3

package/dist/types/AICC.d.ts

@@ -0,0 +1,13 @@
+import { Scorm12API } from "./Scorm12API";
+import { CMI } from "./cmi/aicc/cmi";
+import { BaseCMI } from "./cmi/common/base_cmi";
+import { NAV } from "./cmi/scorm12/nav";
+import { Settings } from "./types/api_types";
+declare class AICCImpl extends Scorm12API {
+    constructor(settings?: Settings);
+    cmi: CMI;
+    nav: NAV;
+    getChildElement(CMIElement: string, value: any, foundFirstIndex: boolean): BaseCMI | null;
+    replaceWithAnotherScormAPI(newAPI: AICCImpl): void;
+}
+export { AICCImpl as AICC };

package/dist/types/BaseAPI.d.ts

@@ -0,0 +1,71 @@
+import { ErrorCode } from "./constants/error_codes";
+import { BaseCMI } from "./cmi/common/base_cmi";
+import { CommitObject, InternalSettings, LogLevel, RefObject, ResultObject, Settings } from "./types/api_types";
+import { IBaseAPI } from "./interfaces/IBaseAPI";
+export default abstract class BaseAPI implements IBaseAPI {
+    private _timeout?;
+    private readonly _error_codes;
+    private _settings;
+    protected constructor(error_codes: ErrorCode, settings?: Settings);
+    abstract cmi: BaseCMI;
+    startingData?: RefObject;
+    currentState: number;
+    lastErrorCode: string;
+    listenerArray: any[];
+    apiLogLevel: LogLevel;
+    selfReportSessionTime: boolean;
+    abstract reset(settings?: Settings): void;
+    commonReset(settings?: Settings): void;
+    initialize(callbackName: string, initializeMessage?: string, terminationMessage?: string): string;
+    abstract lmsInitialize(): string;
+    abstract lmsFinish(): string;
+    abstract lmsGetValue(CMIElement: string): string;
+    abstract lmsSetValue(CMIElement: string, value: any): string;
+    abstract lmsCommit(): string;
+    abstract lmsGetLastError(): string;
+    abstract lmsGetErrorString(CMIErrorCode: string | number): string;
+    abstract lmsGetDiagnostic(CMIErrorCode: string | number): string;
+    abstract validateCorrectResponse(_CMIElement: string, _value: any): void;
+    abstract getChildElement(_CMIElement: string, _value: any, _foundFirstIndex: boolean): BaseCMI | null;
+    abstract storeData(_calculateTotalTime: boolean): Promise<ResultObject>;
+    abstract renderCommitCMI(_terminateCommit: boolean): RefObject | Array<any>;
+    abstract renderCommitObject(_terminateCommit: boolean): CommitObject;
+    apiLog(functionName: string, logMessage: string, messageLevel: LogLevel, CMIElement?: string): void;
+    get error_codes(): ErrorCode;
+    get settings(): InternalSettings;
+    set settings(settings: Settings);
+    terminate(callbackName: string, checkTerminated: boolean): Promise<string>;
+    getValue(callbackName: string, checkTerminated: boolean, CMIElement: string): string;
+    setValue(callbackName: string, commitCallback: string, checkTerminated: boolean, CMIElement: string, value: any): string;
+    commit(callbackName: string, checkTerminated?: boolean): Promise<string>;
+    getLastError(callbackName: string): string;
+    getErrorString(callbackName: string, CMIErrorCode: string | number): string;
+    getDiagnostic(callbackName: string, CMIErrorCode: string | number): string;
+    checkState(checkTerminated: boolean, beforeInitError: number, afterTermError: number): boolean;
+    getLmsErrorMessageDetails(_errorNumber: string | number, _detail?: boolean): string;
+    getCMIValue(_CMIElement: string): string;
+    setCMIValue(_CMIElement: string, _value: any): string;
+    _commonSetCMIValue(methodName: string, scorm2004: boolean, CMIElement: string, value: any): string;
+    _commonGetCMIValue(methodName: string, scorm2004: boolean, CMIElement: string): any;
+    isInitialized(): boolean;
+    isNotInitialized(): boolean;
+    isTerminated(): boolean;
+    on(listenerName: string, callback: Function): void;
+    off(listenerName: string, callback: Function): void;
+    clear(listenerName: string): void;
+    processListeners(functionName: string, CMIElement?: string, value?: any): void;
+    throwSCORMError(errorNumber: number, message?: string): void;
+    clearSCORMError(success: string): void;
+    loadFromFlattenedJSON(json: RefObject, CMIElement?: string): void;
+    loadFromJSON(json: RefObject, CMIElement?: string): void;
+    renderCMIToJSONString(): string;
+    renderCMIToJSONObject(): object;
+    processHttpRequest(url: string, params: CommitObject | RefObject | Array<any>, immediate?: boolean): Promise<ResultObject>;
+    scheduleCommit(when: number, callback: string): void;
+    clearScheduledCommit(): void;
+    private _checkObjectHasProperty;
+    private handleValueAccessException;
+    protected getCommitObject(terminateCommit: boolean): CommitObject | RefObject | Array<any>;
+    private performFetch;
+    private transformResponse;
+}

package/dist/types/Scorm12API.d.ts

@@ -0,0 +1,39 @@
+import { CMI } from "./cmi/scorm12/cmi";
+import { BaseCMI } from "./cmi/common/base_cmi";
+import { NAV } from "./cmi/scorm12/nav";
+import { CommitObject, ResultObject, Settings } from "./types/api_types";
+import BaseAPI from "./BaseAPI";
+declare class Scorm12Impl extends BaseAPI {
+    constructor(settings?: Settings);
+    statusSetByModule: boolean;
+    cmi: CMI;
+    nav: NAV;
+    LMSInitialize: () => string;
+    LMSFinish: () => string;
+    LMSGetValue: (CMIElement: string) => string;
+    LMSSetValue: (CMIElement: string, value: any) => string;
+    LMSCommit: () => string;
+    LMSGetLastError: () => string;
+    LMSGetErrorString: (CMIErrorCode: string) => string;
+    LMSGetDiagnostic: (CMIErrorCode: string) => string;
+    reset(settings?: Settings): void;
+    lmsInitialize(): string;
+    lmsFinish(): string;
+    internalFinish(): Promise<string>;
+    lmsGetValue(CMIElement: string): string;
+    lmsSetValue(CMIElement: string, value: any): string;
+    lmsCommit(): string;
+    lmsGetLastError(): string;
+    lmsGetErrorString(CMIErrorCode: string): string;
+    lmsGetDiagnostic(CMIErrorCode: string): string;
+    setCMIValue(CMIElement: string, value: any): string;
+    getCMIValue(CMIElement: string): any;
+    getChildElement(CMIElement: string, _value: any, foundFirstIndex: boolean): BaseCMI | null;
+    validateCorrectResponse(_CMIElement: string, _value: any): void;
+    getLmsErrorMessageDetails(errorNumber: number | string, detail: boolean): string;
+    replaceWithAnotherScormAPI(newAPI: Scorm12Impl): void;
+    renderCommitCMI(terminateCommit: boolean): object | Array<any>;
+    renderCommitObject(terminateCommit: boolean): CommitObject;
+    storeData(terminateCommit: boolean): Promise<ResultObject>;
+}
+export { Scorm12Impl as Scorm12API };

package/dist/types/Scorm2004API.d.ts

@@ -0,0 +1,52 @@
+import BaseAPI from "./BaseAPI";
+import { CMI } from "./cmi/scorm2004/cmi";
+import { ResponseType } from "./constants/response_constants";
+import { CMIArray } from "./cmi/common/array";
+import { BaseCMI } from "./cmi/common/base_cmi";
+import { CMIInteractionsObject } from "./cmi/scorm2004/interactions";
+import { CMIObjectivesObject } from "./cmi/scorm2004/objectives";
+import { ADL } from "./cmi/scorm2004/adl";
+import { CommitObject, ResultObject, Settings } from "./types/api_types";
+declare class Scorm2004Impl extends BaseAPI {
+    private _version;
+    private _globalObjectives;
+    constructor(settings?: Settings);
+    cmi: CMI;
+    adl: ADL;
+    Initialize: () => string;
+    Terminate: () => string;
+    GetValue: (CMIElement: string) => string;
+    SetValue: (CMIElement: string, value: any) => string;
+    Commit: () => string;
+    GetLastError: () => string;
+    GetErrorString: (CMIErrorCode: string | number) => string;
+    GetDiagnostic: (CMIErrorCode: string | number) => string;
+    reset(settings?: Settings): void;
+    get version(): string;
+    get globalObjectives(): CMIObjectivesObject[];
+    lmsInitialize(): string;
+    lmsFinish(): string;
+    internalFinish(): Promise<string>;
+    lmsGetValue(CMIElement: string): string;
+    lmsSetValue(CMIElement: string, value: any): string;
+    lmsCommit(): string;
+    lmsGetLastError(): string;
+    lmsGetErrorString(CMIErrorCode: string | number): string;
+    lmsGetDiagnostic(CMIErrorCode: string | number): string;
+    setCMIValue(CMIElement: string, value: any): string;
+    getChildElement(CMIElement: string, value: any, foundFirstIndex: boolean): BaseCMI | null;
+    private createCorrectResponsesObject;
+    checkValidResponseType(response_type: ResponseType, value: any, interaction_type: string): void;
+    checkDuplicateChoiceResponse(interaction: CMIInteractionsObject, value: any): void;
+    validateCorrectResponse(CMIElement: string, value: any): void;
+    getCMIValue(CMIElement: string): any;
+    getLmsErrorMessageDetails(errorNumber: string | number, detail: boolean): string;
+    checkDuplicatedPattern(correct_response: CMIArray, current_index: number, value: any): boolean;
+    checkCorrectResponseValue(interaction_type: string, nodes: Array<any>, value: any): void;
+    removeCorrectResponsePrefixes(node: string): any;
+    replaceWithAnotherScormAPI(newAPI: Scorm2004Impl): void;
+    renderCommitCMI(terminateCommit: boolean): object | Array<any>;
+    renderCommitObject(terminateCommit: boolean): CommitObject;
+    storeData(terminateCommit: boolean): Promise<ResultObject>;
+}
+export { Scorm2004Impl as Scorm2004API };

package/dist/types/ScormAgain.d.ts

@@ -0,0 +1,4 @@
+import { AICC } from "./AICC";
+import { Scorm12API } from "./Scorm12API";
+import { Scorm2004API } from "./Scorm2004API";
+export { Scorm12API, Scorm2004API, AICC };

package/dist/types/cmi/aicc/attempts.d.ts

@@ -0,0 +1,19 @@
+import { BaseCMI } from "../common/base_cmi";
+import { CMIScore } from "../common/score";
+import { CMIArray } from "../common/array";
+export declare class CMIAttemptRecords extends CMIArray {
+    constructor();
+}
+export declare class CMIAttemptRecordsObject extends BaseCMI {
+    private _lesson_status;
+    constructor();
+    score: CMIScore;
+    initialize(): void;
+    reset(): void;
+    get lesson_status(): string;
+    set lesson_status(lesson_status: string);
+    toJSON(): {
+        lesson_status: string;
+        score: CMIScore;
+    };
+}

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

@@ -0,0 +1,34 @@
+import * as Scorm12CMI from "../scorm12/cmi";
+import { CMIEvaluation } from "./evaluation";
+import { AICCStudentPreferences } from "./student_preferences";
+import { CMIStudentDemographics } from "./student_demographics";
+import { AICCCMIStudentData } from "./student_data";
+import { CMIPaths } from "./paths";
+import { CMICore } from "./core";
+import { CMIObjectives } from "../scorm12/objectives";
+import { CMIStudentData } from "../scorm12/student_data";
+import { CMIStudentPreference } from "../scorm12/student_preference";
+import { CMIInteractions } from "../scorm12/interactions";
+export declare class CMI extends Scorm12CMI.CMI {
+    constructor(initialized?: boolean);
+    student_data: AICCCMIStudentData;
+    student_preference: AICCStudentPreferences;
+    student_demographics: CMIStudentDemographics;
+    evaluation: CMIEvaluation;
+    paths: CMIPaths;
+    initialize(): void;
+    toJSON(): {
+        suspend_data: string;
+        launch_data: string;
+        comments: string;
+        comments_from_lms: string;
+        core: CMICore;
+        objectives: CMIObjectives;
+        student_data: CMIStudentData;
+        student_preference: CMIStudentPreference;
+        student_demographics: CMIStudentDemographics;
+        interactions: CMIInteractions;
+        evaluation: CMIEvaluation;
+        paths: CMIPaths;
+    };
+}

package/dist/types/cmi/aicc/core.d.ts

@@ -0,0 +1,57 @@
+import { BaseCMI } from "../common/base_cmi";
+import { CMIScore } from "../common/score";
+export declare class CMICore extends BaseCMI {
+    constructor();
+    readonly score: CMIScore;
+    initialize(): void;
+    private __children;
+    private _student_id;
+    private _student_name;
+    private _lesson_location;
+    private _credit;
+    private _lesson_status;
+    private _entry;
+    private _total_time;
+    private _lesson_mode;
+    private _exit;
+    private _session_time;
+    private _suspend_data;
+    reset(): void;
+    get _children(): string;
+    set _children(_children: string);
+    get student_id(): string;
+    set student_id(student_id: string);
+    get student_name(): string;
+    set student_name(student_name: string);
+    get lesson_location(): string;
+    set lesson_location(lesson_location: string);
+    get credit(): string;
+    set credit(credit: string);
+    get lesson_status(): string;
+    set lesson_status(lesson_status: string);
+    get entry(): string;
+    set entry(entry: string);
+    get total_time(): string;
+    set total_time(total_time: string);
+    get lesson_mode(): string;
+    set lesson_mode(lesson_mode: string);
+    get exit(): string;
+    set exit(exit: string);
+    get session_time(): string;
+    set session_time(session_time: string);
+    get suspend_data(): string;
+    set suspend_data(suspend_data: string);
+    getCurrentTotalTime(start_time: number | undefined): string;
+    toJSON(): {
+        student_name: string;
+        entry: string;
+        exit: string;
+        score: CMIScore;
+        student_id: string;
+        lesson_mode: string;
+        lesson_location: string;
+        lesson_status: string;
+        credit: string;
+        session_time: string;
+    };
+}

package/dist/types/cmi/aicc/evaluation.d.ts

@@ -0,0 +1,33 @@
+import { CMIArray } from "../common/array";
+import { BaseCMI } from "../common/base_cmi";
+export declare class CMIEvaluation extends BaseCMI {
+    constructor();
+    comments: CMIEvaluationComments;
+    initialize(): void;
+    reset(): void;
+    toJSON(): {
+        comments: CMIEvaluationComments;
+    };
+}
+declare class CMIEvaluationComments extends CMIArray {
+    constructor();
+}
+export declare class CMIEvaluationCommentsObject extends BaseCMI {
+    private _content;
+    private _location;
+    private _time;
+    constructor();
+    reset(): void;
+    get content(): string;
+    set content(content: string);
+    get location(): string;
+    set location(location: string);
+    get time(): string;
+    set time(time: string);
+    toJSON(): {
+        content: string;
+        location: string;
+        time: string;
+    };
+}
+export {};

package/dist/types/cmi/aicc/paths.d.ts

@@ -0,0 +1,35 @@
+import { BaseCMI } from "../common/base_cmi";
+import { CMIArray } from "../common/array";
+export declare class CMIPaths extends CMIArray {
+    constructor();
+}
+export declare class CMIPathsObject extends BaseCMI {
+    private _location_id;
+    private _date;
+    private _time;
+    private _status;
+    private _why_left;
+    private _time_in_element;
+    constructor();
+    reset(): void;
+    get location_id(): string;
+    set location_id(location_id: string);
+    get date(): string;
+    set date(date: string);
+    get time(): string;
+    set time(time: string);
+    get status(): string;
+    set status(status: string);
+    get why_left(): string;
+    set why_left(why_left: string);
+    get time_in_element(): string;
+    set time_in_element(time_in_element: string);
+    toJSON(): {
+        location_id: string;
+        date: string;
+        time: string;
+        status: string;
+        why_left: string;
+        time_in_element: string;
+    };
+}

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

@@ -0,0 +1,20 @@
+import { CMITries } from "./tries";
+import { CMIStudentData } from "../scorm12/student_data";
+import { CMIAttemptRecords } from "./attempts";
+export declare class AICCCMIStudentData extends CMIStudentData {
+    constructor();
+    tries: CMITries;
+    attempt_records: CMIAttemptRecords;
+    initialize(): void;
+    reset(): void;
+    private _tries_during_lesson;
+    get tries_during_lesson(): string;
+    set tries_during_lesson(tries_during_lesson: string);
+    toJSON(): {
+        mastery_score: string;
+        max_time_allowed: string;
+        time_limit_action: string;
+        tries: CMITries;
+        attempt_records: CMIAttemptRecords;
+    };
+}

package/dist/types/cmi/aicc/student_demographics.d.ts

@@ -0,0 +1,61 @@
+import { BaseCMI } from "../common/base_cmi";
+export declare class CMIStudentDemographics extends BaseCMI {
+    private __children;
+    private _city;
+    private _class;
+    private _company;
+    private _country;
+    private _experience;
+    private _familiar_name;
+    private _instructor_name;
+    private _title;
+    private _native_language;
+    private _state;
+    private _street_address;
+    private _telephone;
+    private _years_experience;
+    constructor();
+    reset(): void;
+    get _children(): string;
+    get city(): string;
+    set city(city: string);
+    get class(): string;
+    set class(clazz: string);
+    get company(): string;
+    set company(company: string);
+    get country(): string;
+    set country(country: string);
+    get experience(): string;
+    set experience(experience: string);
+    get familiar_name(): string;
+    set familiar_name(familiar_name: string);
+    get instructor_name(): string;
+    set instructor_name(instructor_name: string);
+    get title(): string;
+    set title(title: string);
+    get native_language(): string;
+    set native_language(native_language: string);
+    get state(): string;
+    set state(state: string);
+    get street_address(): string;
+    set street_address(street_address: string);
+    get telephone(): string;
+    set telephone(telephone: string);
+    get years_experience(): string;
+    set years_experience(years_experience: string);
+    toJSON(): {
+        city: string;
+        class: string;
+        company: string;
+        country: string;
+        experience: string;
+        familiar_name: string;
+        instructor_name: string;
+        title: string;
+        native_language: string;
+        state: string;
+        street_address: string;
+        telephone: string;
+        years_experience: string;
+    };
+}

package/dist/types/cmi/aicc/student_preferences.d.ts

@@ -0,0 +1,34 @@
+import { CMIArray } from "../common/array";
+import { CMIStudentPreference } from "../scorm12/student_preference";
+export declare class AICCStudentPreferences extends CMIStudentPreference {
+    constructor();
+    windows: CMIArray;
+    initialize(): void;
+    private _lesson_type;
+    private _text_color;
+    private _text_location;
+    private _text_size;
+    private _video;
+    get lesson_type(): string;
+    set lesson_type(lesson_type: string);
+    get text_color(): string;
+    set text_color(text_color: string);
+    get text_location(): string;
+    set text_location(text_location: string);
+    get text_size(): string;
+    set text_size(text_size: string);
+    get video(): string;
+    set video(video: string);
+    toJSON(): {
+        audio: string;
+        language: string;
+        lesson_type: string;
+        speed: string;
+        text: string;
+        text_color: string;
+        text_location: string;
+        text_size: string;
+        video: string;
+        windows: CMIArray;
+    };
+}

package/dist/types/cmi/aicc/tries.d.ts

@@ -0,0 +1,23 @@
+import { CMIArray } from "../common/array";
+import { BaseCMI } from "../common/base_cmi";
+import { CMIScore } from "../common/score";
+export declare class CMITries extends CMIArray {
+    constructor();
+}
+export declare class CMITriesObject extends BaseCMI {
+    private _status;
+    private _time;
+    constructor();
+    score: CMIScore;
+    initialize(): void;
+    reset(): void;
+    get status(): string;
+    set status(status: string);
+    get time(): string;
+    set time(time: string);
+    toJSON(): {
+        status: string;
+        time: string;
+        score: CMIScore;
+    };
+}

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

@@ -0,0 +1 @@
+export declare function checkAICCValidFormat(value: string, regexPattern: string, allowEmptyString?: boolean): boolean;

package/dist/types/cmi/common/array.d.ts

@@ -0,0 +1,19 @@
+import { BaseCMI } from "./base_cmi";
+import { BaseScormValidationError } from "../../exceptions";
+export declare class CMIArray extends BaseCMI {
+    private readonly _errorCode;
+    private readonly _errorClass;
+    private readonly __children;
+    childArray: any[];
+    constructor(params: {
+        children: string;
+        errorCode?: number;
+        errorClass?: typeof BaseScormValidationError;
+    });
+    reset(wipe?: boolean): void;
+    get _children(): string;
+    set _children(_children: string);
+    get _count(): number;
+    set _count(_count: number);
+    toJSON(): object;
+}

package/dist/types/cmi/common/base_cmi.d.ts

@@ -0,0 +1,13 @@
+export declare abstract class BaseCMI {
+    jsonString?: boolean | undefined;
+    protected _initialized: boolean;
+    private _start_time;
+    get initialized(): boolean;
+    get start_time(): number | undefined;
+    initialize(): void;
+    setStartTime(): void;
+    abstract reset(): void;
+}
+export declare abstract class BaseRootCMI extends BaseCMI {
+    abstract getCurrentTotalTime(): string;
+}

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

@@ -0,0 +1,38 @@
+import { BaseCMI } from "./base_cmi";
+import { BaseScormValidationError } from "../../exceptions";
+export declare class CMIScore extends BaseCMI {
+    private readonly __children;
+    private readonly __score_range;
+    private readonly __invalid_error_code;
+    private readonly __invalid_type_code;
+    private readonly __invalid_range_code;
+    private readonly __decimal_regex;
+    private readonly __error_class;
+    protected _raw: string;
+    protected _min: string;
+    protected _max: string;
+    constructor(params: {
+        score_children?: string;
+        score_range?: string;
+        max?: string;
+        invalidErrorCode?: number;
+        invalidTypeCode?: number;
+        invalidRangeCode?: number;
+        decimalRegex?: string;
+        errorClass: typeof BaseScormValidationError;
+    });
+    reset(): void;
+    get _children(): string;
+    set _children(_children: string);
+    get raw(): string;
+    set raw(raw: string);
+    get min(): string;
+    set min(min: string);
+    get max(): string;
+    set max(max: string);
+    toJSON(): {
+        min: string;
+        max: string;
+        raw: string;
+    };
+}

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

@@ -0,0 +1,3 @@
+import { BaseScormValidationError } from "../../exceptions";
+export declare function checkValidFormat(value: string, regexPattern: string, errorCode: number, errorClass: typeof BaseScormValidationError, allowEmptyString?: boolean): boolean;
+export declare function checkValidRange(value: any, rangePattern: string, errorCode: number, errorClass: typeof BaseScormValidationError): boolean;

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

@@ -0,0 +1,45 @@
+import { BaseRootCMI } from "../common/base_cmi";
+import { CMICore } from "../aicc/core";
+import { CMIObjectives } from "./objectives";
+import { CMIStudentData } from "./student_data";
+import { CMIStudentPreference } from "./student_preference";
+import { CMIInteractions } from "./interactions";
+export declare class CMI extends BaseRootCMI {
+    private readonly __children;
+    private __version;
+    private _launch_data;
+    private _comments;
+    private _comments_from_lms;
+    constructor(cmi_children?: string, student_data?: CMIStudentData, initialized?: boolean);
+    core: CMICore;
+    objectives: CMIObjectives;
+    student_data: CMIStudentData;
+    student_preference: CMIStudentPreference;
+    interactions: CMIInteractions;
+    reset(): void;
+    initialize(): void;
+    toJSON(): {
+        suspend_data: string;
+        launch_data: string;
+        comments: string;
+        comments_from_lms: string;
+        core: CMICore;
+        objectives: CMIObjectives;
+        student_data: CMIStudentData;
+        student_preference: CMIStudentPreference;
+        interactions: CMIInteractions;
+    };
+    get _version(): string;
+    set _version(_version: string);
+    get _children(): string;
+    set _children(_children: string);
+    get suspend_data(): string;
+    set suspend_data(suspend_data: string);
+    get launch_data(): string;
+    set launch_data(launch_data: string);
+    get comments(): string;
+    set comments(comments: string);
+    get comments_from_lms(): string;
+    set comments_from_lms(comments_from_lms: string);
+    getCurrentTotalTime(): string;
+}