scorm-again 2.4.0 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scorm-again",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "A modern SCORM JavaScript run-time library for AICC, SCORM 1.2, and SCORM 2004",
   "main": "dist/scorm-again.js",
   "types": "index.d.ts",
@@ -52,16 +52,16 @@
     "jsdoc-babel": "^0.5.0",
     "minimist": "^1.2.8",
     "miragejs": "^0.2.0-alpha.3",
-    "mocha": "^10.7.3",
+    "mocha": "^10.8.2",
     "mocha-junit-reporter": "^2.2.1",
     "mochawesome": "^7.1.3",
     "prettier": "^3.3.3",
     "sinon": "^19.0.2",
     "terser-webpack-plugin": "^5.3.10",
     "ts-loader": "^9.5.1",
-    "tsx": "^4.19.1",
+    "tsx": "^4.19.2",
     "typescript": "^5.6.3",
-    "typescript-eslint": "^8.11.0",
+    "typescript-eslint": "^8.12.2",
     "webpack": "^5.91.0",
     "webpack-cli": "^5.1.4"
   },

package/src/AICC.ts

@@ -33,7 +33,7 @@ class AICCImpl extends Scorm12Impl {
    * @param {boolean} foundFirstIndex
    * @return {BaseCMI | null}
    */
-  getChildElement(
+  override getChildElement(
     CMIElement: string,
     value: any,
     foundFirstIndex: boolean,
@@ -64,7 +64,7 @@ class AICCImpl extends Scorm12Impl {
    *
    * @param {AICCImpl} newAPI
    */
-  replaceWithAnotherScormAPI(newAPI: AICCImpl) {
+  override replaceWithAnotherScormAPI(newAPI: AICCImpl) {
     // Data Model
     this.cmi = newAPI.cmi;
     this.nav = newAPI.nav;

package/src/BaseAPI.ts

@@ -6,6 +6,7 @@ import { formatMessage, stringMatches, unflatten } from "./utilities";
 import { BaseCMI } from "./cmi/common/base_cmi";
 import {
   CommitObject,
+  LogLevel,
   RefObject,
   ResultObject,
   Settings,
@@ -13,6 +14,7 @@ import {
 import { DefaultSettings } from "./constants/default_settings";
 import { IBaseAPI } from "./interfaces/IBaseAPI";
 import { ScheduledCommit } from "./helpers/scheduled_commit";
+import { LogLevelEnum } from "./constants/enums";
 
 /**
  * Base API class for AICC, SCORM 1.2, and SCORM 2004. Should be considered
@@ -44,6 +46,10 @@ export default abstract class BaseAPI implements IBaseAPI {
     }
     this.apiLogLevel = this.settings.logLevel;
     this.selfReportSessionTime = this.settings.selfReportSessionTime;
+
+    if (this.apiLogLevel === undefined) {
+      this.apiLogLevel = LogLevelEnum.NONE;
+    }
   }
 
   public abstract cmi: BaseCMI;
@@ -52,7 +58,7 @@ export default abstract class BaseAPI implements IBaseAPI {
   public currentState: number;
   public lastErrorCode: string;
   public listenerArray: any[];
-  public apiLogLevel: number;
+  public apiLogLevel: LogLevel;
   public selfReportSessionTime: boolean;
 
   abstract reset(settings?: Settings): void;
@@ -99,11 +105,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.processListeners(callbackName);
     }
 
-    this.apiLog(
-      callbackName,
-      "returned: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
-    );
+    this.apiLog(callbackName, "returned: " + returnValue, LogLevelEnum.INFO);
     this.clearSCORMError(returnValue);
 
     return returnValue;
@@ -187,7 +189,7 @@ export default abstract class BaseAPI implements IBaseAPI {
   apiLog(
     functionName: string,
     logMessage: string,
-    messageLevel: number,
+    messageLevel: LogLevel,
     CMIElement?: string,
   ) {
     logMessage = formatMessage(functionName, logMessage, CMIElement);
@@ -257,11 +259,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.processListeners(callbackName);
     }
 
-    this.apiLog(
-      callbackName,
-      "returned: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
-    );
+    this.apiLog(callbackName, "returned: " + returnValue, LogLevelEnum.INFO);
     this.clearSCORMError(returnValue);
 
     return returnValue;
@@ -301,7 +299,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     this.apiLog(
       callbackName,
       ": returned: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
+      LogLevelEnum.INFO,
       CMIElement,
     );
 
@@ -370,7 +368,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     this.apiLog(
       callbackName,
       ": " + value + ": result: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
+      LogLevelEnum.INFO,
       CMIElement,
     );
     this.clearSCORMError(returnValue);
@@ -388,7 +386,6 @@ export default abstract class BaseAPI implements IBaseAPI {
     callbackName: string,
     checkTerminated: boolean = false,
   ): Promise<string> {
-    console.log("commit");
     this.clearScheduledCommit();
 
     let returnValue = APIConstants.global.SCORM_FALSE;
@@ -412,7 +409,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.apiLog(
         callbackName,
         " Result: " + returnValue,
-        APIConstants.global.LOG_LEVEL_DEBUG,
+        LogLevelEnum.DEBUG,
         "HttpRequest",
       );
 
@@ -421,11 +418,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.processListeners(callbackName);
     }
 
-    this.apiLog(
-      callbackName,
-      "returned: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
-    );
+    this.apiLog(callbackName, "returned: " + returnValue, LogLevelEnum.INFO);
     this.clearSCORMError(returnValue);
 
     return returnValue;
@@ -441,11 +434,7 @@ export default abstract class BaseAPI implements IBaseAPI {
 
     this.processListeners(callbackName);
 
-    this.apiLog(
-      callbackName,
-      "returned: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
-    );
+    this.apiLog(callbackName, "returned: " + returnValue, LogLevelEnum.INFO);
 
     return returnValue;
   }
@@ -465,11 +454,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.processListeners(callbackName);
     }
 
-    this.apiLog(
-      callbackName,
-      "returned: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
-    );
+    this.apiLog(callbackName, "returned: " + returnValue, LogLevelEnum.INFO);
 
     return returnValue;
   }
@@ -489,11 +474,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.processListeners(callbackName);
     }
 
-    this.apiLog(
-      callbackName,
-      "returned: " + returnValue,
-      APIConstants.global.LOG_LEVEL_INFO,
-    );
+    this.apiLog(callbackName, "returned: " + returnValue, LogLevelEnum.INFO);
 
     return returnValue;
   }
@@ -668,7 +649,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.apiLog(
         methodName,
         `There was an error setting the value for: ${CMIElement}, value of: ${value}`,
-        APIConstants.global.LOG_LEVEL_WARNING,
+        LogLevelEnum.WARN,
       );
     }
 
@@ -827,7 +808,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       this.apiLog(
         "on",
         `Added event listener: ${this.listenerArray.length}`,
-        APIConstants.global.LOG_LEVEL_INFO,
+        LogLevelEnum.INFO,
         functionName,
       );
     }
@@ -865,7 +846,7 @@ export default abstract class BaseAPI implements IBaseAPI {
         this.apiLog(
           "off",
           `Removed event listener: ${this.listenerArray.length}`,
-          APIConstants.global.LOG_LEVEL_INFO,
+          LogLevelEnum.INFO,
           functionName,
         );
       }
@@ -905,12 +886,7 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @param {any} value
    */
   processListeners(functionName: string, CMIElement?: string, value?: any) {
-    this.apiLog(
-      functionName,
-      value,
-      APIConstants.global.LOG_LEVEL_INFO,
-      CMIElement,
-    );
+    this.apiLog(functionName, value, LogLevelEnum.INFO, CMIElement);
     for (let i = 0; i < this.listenerArray.length; i++) {
       const listener = this.listenerArray[i];
       const functionsMatch = listener.functionName === functionName;
@@ -933,7 +909,7 @@ export default abstract class BaseAPI implements IBaseAPI {
         this.apiLog(
           "processListeners",
           `Processing listener: ${listener.functionName}`,
-          APIConstants.global.LOG_LEVEL_INFO,
+          LogLevelEnum.INFO,
           CMIElement,
         );
         listener.callback(CMIElement, value);
@@ -955,7 +931,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     this.apiLog(
       "throwSCORMError",
       errorNumber + ": " + message,
-      APIConstants.global.LOG_LEVEL_ERROR,
+      LogLevelEnum.ERROR,
     );
 
     this.lastErrorCode = String(errorNumber);
@@ -1067,7 +1043,7 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @param {RefObject} json
    * @param {string} CMIElement
    */
-  loadFromJSON(json: RefObject, CMIElement: string) {
+  loadFromJSON(json: RefObject, CMIElement: string = "") {
     if (!this.isNotInitialized()) {
       console.error(
         "loadFromJSON can only be called before the call to lmsInitialize.",
@@ -1164,11 +1140,7 @@ export default abstract class BaseAPI implements IBaseAPI {
 
         return this.transformResponse(response);
       } catch (e) {
-        this.apiLog(
-          "processHttpRequest",
-          e,
-          APIConstants.global.LOG_LEVEL_ERROR,
-        );
+        this.apiLog("processHttpRequest", e, LogLevelEnum.ERROR);
         api.processListeners("CommitError");
         return genericError;
       }
@@ -1186,12 +1158,7 @@ export default abstract class BaseAPI implements IBaseAPI {
   scheduleCommit(when: number, callback: string) {
     if (!this._timeout) {
       this._timeout = new ScheduledCommit(this, when, callback);
-      this.apiLog(
-        "scheduleCommit",
-        "scheduled",
-        APIConstants.global.LOG_LEVEL_DEBUG,
-        "",
-      );
+      this.apiLog("scheduleCommit", "scheduled", LogLevelEnum.DEBUG, "");
     }
   }
 
@@ -1202,12 +1169,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     if (this._timeout) {
       this._timeout.cancel();
       this._timeout = undefined;
-      this.apiLog(
-        "clearScheduledCommit",
-        "cleared",
-        APIConstants.global.LOG_LEVEL_DEBUG,
-        "",
-      );
+      this.apiLog("clearScheduledCommit", "cleared", LogLevelEnum.DEBUG, "");
     }
   }
 
@@ -1269,7 +1231,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       ? this.renderCommitObject(shouldTerminateCommit)
       : this.renderCommitCMI(shouldTerminateCommit);
 
-    if (this.apiLogLevel === APIConstants.global.LOG_LEVEL_DEBUG) {
+    if ([LogLevelEnum.DEBUG, "1", 1, "DEBUG"].includes(this.apiLogLevel)) {
       console.debug(
         "Commit (terminated: " + (terminateCommit ? "yes" : "no") + "): ",
       );

package/src/Scorm12API.ts

@@ -203,7 +203,7 @@ class Scorm12Impl extends BaseAPI {
    * @param {*} value
    * @return {string}
    */
-  setCMIValue(CMIElement: string, value: any): string {
+  override setCMIValue(CMIElement: string, value: any): string {
     return this._commonSetCMIValue("LMSSetValue", false, CMIElement, value);
   }
 
@@ -213,7 +213,7 @@ class Scorm12Impl extends BaseAPI {
    * @param {string} CMIElement
    * @return {*}
    */
-  getCMIValue(CMIElement: string): any {
+  override getCMIValue(CMIElement: string): any {
     return this._commonGetCMIValue("getCMIValue", false, CMIElement);
   }
 
@@ -272,7 +272,7 @@ class Scorm12Impl extends BaseAPI {
    * @param {boolean} detail
    * @return {string}
    */
-  getLmsErrorMessageDetails(
+  override getLmsErrorMessageDetails(
     errorNumber: number | string,
     detail: boolean,
   ): string {

package/src/Scorm2004API.ts

@@ -128,9 +128,14 @@ class Scorm2004Impl extends BaseAPI {
         const choiceJumpRegex = new RegExp(regex.scorm2004.NAVEvent);
         const matches = request.match(choiceJumpRegex);
         let target = "";
-        if (matches && matches.length > 2) {
-          target = matches[2];
-          request = matches[1].replace(target, "");
+        if (matches) {
+          if (matches.groups?.choice_target) {
+            target = matches.groups?.choice_target;
+            request = "choice";
+          } else if (matches.groups?.jump_target) {
+            target = matches.groups?.jump_target;
+            request = "jump";
+          }
         }
         const action = navActions[request];
         if (action) {
@@ -226,7 +231,7 @@ class Scorm2004Impl extends BaseAPI {
    * @param {any} value
    * @return {string}
    */
-  setCMIValue(CMIElement: string, value: any): string {
+  override setCMIValue(CMIElement: string, value: any): string {
     return this._commonSetCMIValue("SetValue", true, CMIElement, value);
   }
 
@@ -411,7 +416,7 @@ class Scorm2004Impl extends BaseAPI {
    * @param {string} CMIElement
    * @return {*}
    */
-  getCMIValue(CMIElement: string): any {
+  override getCMIValue(CMIElement: string): any {
     return this._commonGetCMIValue("GetValue", true, CMIElement);
   }
 
@@ -422,7 +427,7 @@ class Scorm2004Impl extends BaseAPI {
    * @param {boolean} detail
    * @return {string}
    */
-  getLmsErrorMessageDetails(
+  override getLmsErrorMessageDetails(
     errorNumber: string | number,
     detail: boolean,
   ): string {
@@ -718,7 +723,6 @@ class Scorm2004Impl extends BaseAPI {
       this.adl.nav.request !== this.startingData?.adl?.nav?.request &&
       this.adl.nav.request !== "_none_"
     ) {
-      this.adl.nav.request = encodeURIComponent(this.adl.nav.request);
       navRequest = true;
     }
 

package/src/cmi/aicc/attempts.ts

@@ -1,11 +1,11 @@
-import {BaseCMI} from "../common/base_cmi";
-import {CMIScore} from "../common/score";
+import { BaseCMI } from "../common/base_cmi";
+import { CMIScore } from "../common/score";
 import APIConstants from "../../constants/api_constants";
 import Regex from "../../constants/regex";
 import ErrorCodes from "../../constants/error_codes";
-import {AICCValidationError} from "../../exceptions";
-import {checkAICCValidFormat} from "./validation";
-import {CMIArray} from "../common/array";
+import { AICCValidationError } from "../../exceptions";
+import { checkAICCValidFormat } from "./validation";
+import { CMIArray } from "../common/array";
 
 /**
  * Class for cmi.student_data.attempt_records array
@@ -45,7 +45,7 @@ export class CMIAttemptRecordsObject extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.score?.initialize();
   }
@@ -91,4 +91,4 @@ export class CMIAttemptRecordsObject extends BaseCMI {
     delete this.jsonString;
     return result;
   }
-}
+}

package/src/cmi/aicc/cmi.ts

@@ -29,8 +29,8 @@ export class CMI extends Scorm12CMI.CMI {
     this.paths = new CMIPaths();
   }
 
-  public student_data: AICCCMIStudentData;
-  public student_preference: AICCStudentPreferences;
+  public override student_data: AICCCMIStudentData;
+  public override student_preference: AICCStudentPreferences;
   public student_demographics: CMIStudentDemographics;
   public evaluation: CMIEvaluation;
   public paths: CMIPaths;
@@ -38,7 +38,7 @@ export class CMI extends Scorm12CMI.CMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.student_preference?.initialize();
     this.student_data?.initialize();
@@ -65,7 +65,7 @@ export class CMI extends Scorm12CMI.CMI {
    *    }
    *  }
    */
-  toJSON(): {
+  override toJSON(): {
     suspend_data: string;
     launch_data: string;
     comments: string;

package/src/cmi/aicc/core.ts

@@ -32,7 +32,7 @@ export class CMICore extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.score?.initialize();
   }

package/src/cmi/aicc/evaluation.ts

@@ -23,7 +23,7 @@ export class CMIEvaluation extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.comments?.initialize();
   }

package/src/cmi/aicc/student_data.ts

@@ -24,7 +24,7 @@ export class AICCCMIStudentData extends CMIStudentData {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.tries?.initialize();
     this.attempt_records?.initialize();
@@ -65,7 +65,7 @@ export class AICCCMIStudentData extends CMIStudentData {
    *    }
    *  }
    */
-  toJSON(): {
+  override toJSON(): {
     mastery_score: string;
     max_time_allowed: string;
     time_limit_action: string;

package/src/cmi/aicc/student_preferences.ts

@@ -27,7 +27,7 @@ export class AICCStudentPreferences extends CMIStudentPreference {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.windows?.initialize();
   }
@@ -145,7 +145,7 @@ export class AICCStudentPreferences extends CMIStudentPreference {
    *    }
    *  }
    */
-  toJSON(): {
+  override toJSON(): {
     audio: string;
     language: string;
     lesson_type: string;

package/src/cmi/aicc/tries.ts

@@ -1,11 +1,11 @@
-import {CMIArray} from "../common/array";
+import { CMIArray } from "../common/array";
 import APIConstants from "../../constants/api_constants";
-import {BaseCMI} from "../common/base_cmi";
-import {CMIScore} from "../common/score";
+import { BaseCMI } from "../common/base_cmi";
+import { CMIScore } from "../common/score";
 import Regex from "../../constants/regex";
 import ErrorCodes from "../../constants/error_codes";
-import {AICCValidationError} from "../../exceptions";
-import {checkAICCValidFormat} from "./validation";
+import { AICCValidationError } from "../../exceptions";
+import { checkAICCValidFormat } from "./validation";
 
 /**
  * Class representing the AICC cmi.student_data.tries object
@@ -45,7 +45,7 @@ export class CMITriesObject extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.score?.initialize();
   }
@@ -113,4 +113,4 @@ export class CMITriesObject extends BaseCMI {
     delete this.jsonString;
     return result;
   }
-}
+}

package/src/cmi/scorm12/cmi.ts

@@ -52,7 +52,7 @@ export class CMI extends BaseRootCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.core?.initialize();
     this.objectives?.initialize();

package/src/cmi/scorm12/interactions.ts

@@ -51,7 +51,7 @@ export class CMIInteractionsObject extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.objectives?.initialize();
     this.correct_responses?.initialize();

package/src/cmi/scorm2004/adl.ts

@@ -22,7 +22,7 @@ export class ADL extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.nav?.initialize();
   }
@@ -67,7 +67,7 @@ export class ADLNav extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.request_valid?.initialize();
   }

package/src/cmi/scorm2004/cmi.ts

@@ -61,7 +61,7 @@ export class CMI extends BaseRootCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.learner_preference?.initialize();
     this.score?.initialize();

package/src/cmi/scorm2004/interactions.ts

@@ -60,7 +60,7 @@ export class CMIInteractionsObject extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.objectives?.initialize();
     this.correct_responses?.initialize();

package/src/cmi/scorm2004/objectives.ts

@@ -47,7 +47,7 @@ export class CMIObjectivesObject extends BaseCMI {
   /**
    * Called when the API has been initialized after the CMI has been created
    */
-  initialize() {
+  override initialize() {
     super.initialize();
     this.score?.initialize();
   }

package/src/cmi/scorm2004/score.ts

@@ -59,7 +59,7 @@ export class Scorm2004CMIScore extends CMIScore {
    *    }
    *  }
    */
-  toJSON(): {
+  override toJSON(): {
     scaled: string;
     raw: string;
     min: string;

package/src/constants/api_constants.ts

@@ -45,11 +45,6 @@ interface GlobalConstants {
   STATE_NOT_INITIALIZED: number;
   STATE_INITIALIZED: number;
   STATE_TERMINATED: number;
-  LOG_LEVEL_DEBUG: number;
-  LOG_LEVEL_INFO: number;
-  LOG_LEVEL_WARNING: number;
-  LOG_LEVEL_ERROR: number;
-  LOG_LEVEL_NONE: number;
 }
 
 interface APIConstants {
@@ -65,11 +60,6 @@ const global: GlobalConstants = {
   STATE_NOT_INITIALIZED: 0,
   STATE_INITIALIZED: 1,
   STATE_TERMINATED: 2,
-  LOG_LEVEL_DEBUG: 1,
-  LOG_LEVEL_INFO: 2,
-  LOG_LEVEL_WARNING: 3,
-  LOG_LEVEL_ERROR: 4,
-  LOG_LEVEL_NONE: 5,
 };
 
 const scorm12: ScormConstants = {