scorm-again 2.4.1 → 2.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scorm-again",
-  "version": "2.4.1",
+  "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/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);
@@ -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/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) {
@@ -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/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 = {

package/src/constants/default_settings.ts

@@ -1,5 +1,6 @@
-import { ResultObject, Settings } from "../types/api_types";
+import { LogLevel, ResultObject, Settings } from "../types/api_types";
 import APIConstants from "./api_constants";
+import { LogLevelEnum } from "./enums";
 
 /**
  * Default settings for the SCORM API
@@ -13,7 +14,7 @@ export const DefaultSettings: Settings = {
   dataCommitFormat: "json",
   commitRequestDataType: "application/json;charset=UTF-8",
   autoProgress: false,
-  logLevel: APIConstants.global.LOG_LEVEL_ERROR,
+  logLevel: LogLevelEnum.ERROR,
   selfReportSessionTime: false,
   alwaysSendTotalTime: false,
   renderCommonCommitFields: false,
@@ -62,18 +63,30 @@ export const DefaultSettings: Settings = {
   requestHandler: function (commitObject) {
     return commitObject;
   },
-  onLogMessage: function (messageLevel, logMessage) {
+  onLogMessage: function (messageLevel: LogLevel, logMessage) {
     switch (messageLevel) {
-      case APIConstants.global.LOG_LEVEL_ERROR:
+      case "4":
+      case 4:
+      case "ERROR":
+      case LogLevelEnum.ERROR:
         console.error(logMessage);
         break;
-      case APIConstants.global.LOG_LEVEL_WARNING:
+      case "3":
+      case 3:
+      case "WARN":
+      case LogLevelEnum.WARN:
         console.warn(logMessage);
         break;
-      case APIConstants.global.LOG_LEVEL_INFO:
+      case "2":
+      case 2:
+      case "INFO":
+      case LogLevelEnum.INFO:
         console.info(logMessage);
         break;
-      case APIConstants.global.LOG_LEVEL_DEBUG:
+      case "1":
+      case 1:
+      case "DEBUG":
+      case LogLevelEnum.DEBUG:
         if (console.debug) {
           console.debug(logMessage);
         } else {

package/src/constants/enums.ts

@@ -15,3 +15,12 @@ export enum CompletionStatus {
   incomplete = "incomplete",
   unknown = "unknown",
 }
+
+export enum LogLevelEnum {
+  _,
+  DEBUG,
+  INFO,
+  WARN,
+  ERROR,
+  NONE,
+}

package/src/constants/regex.ts

@@ -78,7 +78,7 @@ const scorm2004 = {
   CMIResult:
     "^(correct|incorrect|unanticipated|neutral|-?([0-9]{1,4})(\\.[0-9]{1,18})?)$",
   NAVEvent:
-    "^(previous|continue|exit|exitAll|abandon|abandonAll|suspendAll|_none_|(\\{target=\\S{0,}[a-zA-Z0-9-_]+})?choice|(\\{target=\\S{0,}[a-zA-Z0-9-_]+})?jump)$",
+    "^(previous|continue|exit|exitAll|abandon|abandonAll|suspendAll|_none_|(\\{target=(?<choice_target>\\S{0,}[a-zA-Z0-9-_]+)})?choice|(\\{target=(?<jump_target>\\S{0,}[a-zA-Z0-9-_]+)})?jump)$",
 
   NAVBoolean: "^(unknown|true|false$)",
   NAVTarget: "^{target=\\S{0,}[a-zA-Z0-9-_]+}$",

package/src/exceptions.ts

@@ -26,10 +26,6 @@ export class BaseScormValidationError extends Error {
   get errorCode(): number {
     return this._errorCode;
   }
-
-  setMessage(message: string) {
-    this.message = message;
-  }
 }
 
 /**
@@ -51,7 +47,7 @@ export class ValidationError
     detailedMessage?: string,
   ) {
     super(errorCode);
-    this.setMessage(errorMessage);
+    this.message = errorMessage;
     this._errorMessage = errorMessage;
     if (detailedMessage) {
       this._detailedMessage = detailedMessage;

package/src/types/api_types.ts

@@ -1,4 +1,8 @@
-import { CompletionStatus, SuccessStatus } from "../constants/enums";
+import {
+  CompletionStatus,
+  LogLevelEnum,
+  SuccessStatus,
+} from "../constants/enums";
 
 export type Settings = {
   autocommit?: boolean;
@@ -9,7 +13,7 @@ export type Settings = {
   dataCommitFormat?: string;
   commitRequestDataType?: string;
   autoProgress?: boolean;
-  logLevel?: number;
+  logLevel?: LogLevel;
   selfReportSessionTime?: boolean;
   alwaysSendTotalTime?: boolean;
   strict_errors?: boolean;
@@ -18,7 +22,7 @@ export type Settings = {
   fetchMode?: "cors" | "no-cors" | "same-origin" | "navigate";
   responseHandler?: (response: Response) => Promise<ResultObject>;
   requestHandler?: (commitObject: any) => any;
-  onLogMessage?: (messageLevel: number, logMessage: string) => void;
+  onLogMessage?: (messageLevel: LogLevel, logMessage: string) => void;
   scoItemIds?: string[];
   scoItemIdValidator?: false | ((scoItemId: string) => boolean);
   mastery_override?: boolean;
@@ -49,3 +53,22 @@ export type CommitObject = {
   runtimeData: RefObject;
   score?: ScoreObject;
 };
+
+export type LogLevel =
+  | 1
+  | 2
+  | 3
+  | 4
+  | 5
+  | "1"
+  | "2"
+  | "3"
+  | "4"
+  | "5"
+  | "DEBUG"
+  | "INFO"
+  | "WARN"
+  | "ERROR"
+  | "NONE"
+  | LogLevelEnum
+  | undefined;

package/test/types/api_types.spec.ts

@@ -1,7 +1,10 @@
 import { expect } from "expect";
 import * as sinon from "sinon";
-import { ResultObject, Settings } from "../../src/types/api_types";
+import { LogLevel, ResultObject, Settings } from "../../src/types/api_types";
 import APIConstants from "../../src/constants/api_constants";
+import { LogLevelEnum } from "../../src/constants/enums";
+import { DefaultSettings } from "../../src/constants/default_settings";
+import { SinonStub } from "sinon";
 
 describe("Settings Type", () => {
   const defaultSettings: Settings = {
@@ -13,7 +16,7 @@ describe("Settings Type", () => {
     dataCommitFormat: "json",
     commitRequestDataType: "application/json;charset=UTF-8",
     autoProgress: false,
-    logLevel: APIConstants.global.LOG_LEVEL_ERROR,
+    logLevel: LogLevelEnum.ERROR,
     selfReportSessionTime: false,
     alwaysSendTotalTime: false,
     strict_errors: true,
@@ -28,26 +31,7 @@ describe("Settings Type", () => {
       };
     },
     requestHandler: (commitObject: any) => commitObject,
-    onLogMessage: (messageLevel: number, logMessage: string) => {
-      switch (messageLevel) {
-        case APIConstants.global.LOG_LEVEL_ERROR:
-          console.error(logMessage);
-          break;
-        case APIConstants.global.LOG_LEVEL_WARNING:
-          console.warn(logMessage);
-          break;
-        case APIConstants.global.LOG_LEVEL_INFO:
-          console.info(logMessage);
-          break;
-        case APIConstants.global.LOG_LEVEL_DEBUG:
-          if (console.debug) {
-            console.debug(logMessage);
-          } else {
-            console.log(logMessage);
-          }
-          break;
-      }
-    },
+    onLogMessage: DefaultSettings.onLogMessage,
   };
 
   it("should have correct default values", () => {
@@ -61,9 +45,7 @@ describe("Settings Type", () => {
       "application/json;charset=UTF-8",
     );
     expect(defaultSettings.autoProgress).toBe(false);
-    expect(defaultSettings.logLevel).toEqual(
-      APIConstants.global.LOG_LEVEL_ERROR,
-    );
+    expect(defaultSettings.logLevel).toEqual(LogLevelEnum.ERROR);
     expect(defaultSettings.selfReportSessionTime).toBe(false);
     expect(defaultSettings.alwaysSendTotalTime).toBe(false);
     expect(defaultSettings.strict_errors).toBe(true);
@@ -93,29 +75,40 @@ describe("Settings Type", () => {
     const consoleDebugStub = sinon.stub(console, "debug");
     const consoleLogStub = sinon.stub(console, "log");
 
-    defaultSettings.onLogMessage(
-      APIConstants.global.LOG_LEVEL_ERROR,
-      "Error message",
-    );
-    expect(consoleErrorStub.calledWith("Error message")).toBe(true);
+    const testLog = function (
+      stub: SinonStub,
+      level: LogLevel,
+      shouldBeLogged = true,
+    ) {
+      const message = `${level} message - ${typeof level}`;
+      defaultSettings.onLogMessage(level, message);
+      expect(stub.calledWith(message)).toBe(shouldBeLogged);
+    };
 
-    defaultSettings.onLogMessage(
-      APIConstants.global.LOG_LEVEL_WARNING,
-      "Warning message",
-    );
-    expect(consoleWarnStub.calledWith("Warning message")).toBe(true);
+    testLog(consoleErrorStub, LogLevelEnum.ERROR);
+    testLog(consoleErrorStub, 4);
+    testLog(consoleErrorStub, "4");
+    testLog(consoleErrorStub, "ERROR");
 
-    defaultSettings.onLogMessage(
-      APIConstants.global.LOG_LEVEL_INFO,
-      "Info message",
-    );
-    expect(consoleInfoStub.calledWith("Info message")).toBe(true);
+    testLog(consoleWarnStub, LogLevelEnum.WARN);
+    testLog(consoleWarnStub, 3);
+    testLog(consoleWarnStub, "3");
+    testLog(consoleWarnStub, "WARN");
 
-    defaultSettings.onLogMessage(
-      APIConstants.global.LOG_LEVEL_DEBUG,
-      "Debug message",
-    );
-    expect(consoleDebugStub.calledWith("Debug message")).toBe(true);
+    testLog(consoleInfoStub, LogLevelEnum.INFO);
+    testLog(consoleInfoStub, 2);
+    testLog(consoleInfoStub, "2");
+    testLog(consoleInfoStub, "INFO");
+
+    testLog(consoleDebugStub, LogLevelEnum.DEBUG);
+    testLog(consoleDebugStub, 1);
+    testLog(consoleDebugStub, "1");
+    testLog(consoleDebugStub, "DEBUG");
+
+    testLog(consoleLogStub, LogLevelEnum.NONE, false);
+    testLog(consoleLogStub, 5, false);
+    testLog(consoleLogStub, "5", false);
+    testLog(consoleLogStub, "NONE", false);
 
     consoleErrorStub.restore();
     consoleWarnStub.restore();