scorm-again 2.5.0 → 2.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scorm-again",
-  "version": "2.5.0",
+  "version": "2.6.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",
@@ -22,47 +22,47 @@
     "test": "test"
   },
   "devDependencies": {
-    "@babel/cli": "^7.25.9",
+    "@babel/cli": "^7.26.4",
     "@babel/core": "^7.26.0",
     "@babel/eslint-parser": "^7.25.9",
     "@babel/node": "^7.26.0",
     "@babel/preset-env": "^7.26.0",
     "@babel/preset-typescript": "^7.26.0",
-    "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.13.0",
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.16.0",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
     "@types/eslint__js": "^8.42.3",
-    "@types/mocha": "^10.0.9",
+    "@types/mocha": "^10.0.10",
     "@types/sinon": "^17.0.3",
     "babel-eslint": "^11.0.0-beta.2",
     "babel-loader": "^9.2.1",
     "babelify": "^10.0.0",
     "browserify": "^17.0.1",
-    "c8": "^10.1.2",
+    "c8": "^10.1.3",
     "c8-as-nyc": "^1.1.11",
-    "eslint": "^9.13.0",
+    "eslint": "^9.16.0",
     "eslint-formatter-junit": "^8.40.0",
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsdoc": "^50.4.3",
+    "eslint-plugin-jsdoc": "^50.6.1",
     "eslint-webpack-plugin": "^4.2.0",
     "expect": "^29.7.0",
     "fetch-pretender": "https://github.com/jcputney/fetch-pretender#master",
-    "globals": "^15.11.0",
+    "globals": "^15.13.0",
     "jsdoc": "^4.0.4",
     "jsdoc-babel": "^0.5.0",
     "minimist": "^1.2.8",
     "miragejs": "^0.2.0-alpha.3",
-    "mocha": "^10.8.2",
+    "mocha": "^11.0.1",
     "mocha-junit-reporter": "^2.2.1",
     "mochawesome": "^7.1.3",
-    "prettier": "^3.3.3",
+    "prettier": "^3.4.2",
     "sinon": "^19.0.2",
     "terser-webpack-plugin": "^5.3.10",
     "ts-loader": "^9.5.1",
     "tsx": "^4.19.2",
-    "typescript": "^5.6.3",
-    "typescript-eslint": "^8.12.2",
-    "webpack": "^5.91.0",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.18.0",
+    "webpack": "^5.97.1",
     "webpack-cli": "^5.1.4"
   },
   "scripts": {

package/src/AICC.ts

@@ -25,6 +25,9 @@ class AICCImpl extends Scorm12Impl {
     this.nav = new NAV();
   }
 
+  override cmi: CMI;
+  override nav: NAV;
+
   /**
    * Gets or builds a new child element to add to the array.
    *

package/src/BaseAPI.ts

@@ -1,7 +1,7 @@
 import { CMIArray } from "./cmi/common/array";
 import { ValidationError } from "./exceptions";
-import ErrorCodes, { ErrorCode } from "./constants/error_codes";
-import APIConstants from "./constants/api_constants";
+import { ErrorCode } from "./constants/error_codes";
+import { global_constants } from "./constants/api_constants";
 import { formatMessage, stringMatches, unflatten } from "./utilities";
 import { BaseCMI } from "./cmi/common/base_cmi";
 import {
@@ -35,7 +35,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     if (new.target === BaseAPI) {
       throw new TypeError("Cannot construct BaseAPI instances directly");
     }
-    this.currentState = APIConstants.global.STATE_NOT_INITIALIZED;
+    this.currentState = global_constants.STATE_NOT_INITIALIZED;
     this.lastErrorCode = "0";
     this.listenerArray = [];
 
@@ -69,11 +69,15 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @protected
    */
   commonReset(settings?: Settings): void {
+    this.apiLog("reset", "Called", LogLevelEnum.INFO);
+
     this.settings = { ...this.settings, ...settings };
 
-    this.currentState = APIConstants.global.STATE_NOT_INITIALIZED;
+    this.clearScheduledCommit();
+    this.currentState = global_constants.STATE_NOT_INITIALIZED;
     this.lastErrorCode = "0";
     this.listenerArray = [];
+    this.startingData = undefined;
   }
 
   /**
@@ -88,7 +92,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     initializeMessage?: string,
     terminationMessage?: string,
   ): string {
-    let returnValue = APIConstants.global.SCORM_FALSE;
+    let returnValue = global_constants.SCORM_FALSE;
 
     if (this.isInitialized()) {
       this.throwSCORMError(this._error_codes.INITIALIZED, initializeMessage);
@@ -99,9 +103,9 @@ export default abstract class BaseAPI implements IBaseAPI {
         this.cmi.setStartTime();
       }
 
-      this.currentState = APIConstants.global.STATE_INITIALIZED;
+      this.currentState = global_constants.STATE_INITIALIZED;
       this.lastErrorCode = "0";
-      returnValue = APIConstants.global.SCORM_TRUE;
+      returnValue = global_constants.SCORM_TRUE;
       this.processListeners(callbackName);
     }
 
@@ -233,7 +237,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     callbackName: string,
     checkTerminated: boolean,
   ): Promise<string> {
-    let returnValue = APIConstants.global.SCORM_FALSE;
+    let returnValue = global_constants.SCORM_FALSE;
 
     if (
       this.checkState(
@@ -242,7 +246,7 @@ export default abstract class BaseAPI implements IBaseAPI {
         this._error_codes.MULTIPLE_TERMINATION,
       )
     ) {
-      this.currentState = APIConstants.global.STATE_TERMINATED;
+      this.currentState = global_constants.STATE_TERMINATED;
 
       const result: ResultObject = await this.storeData(true);
       if (typeof result.errorCode !== "undefined" && result.errorCode > 0) {
@@ -251,11 +255,11 @@ export default abstract class BaseAPI implements IBaseAPI {
       returnValue =
         typeof result !== "undefined" && result.result
           ? result.result
-          : APIConstants.global.SCORM_FALSE;
+          : global_constants.SCORM_FALSE;
 
       if (checkTerminated) this.lastErrorCode = "0";
 
-      returnValue = APIConstants.global.SCORM_TRUE;
+      returnValue = global_constants.SCORM_TRUE;
       this.processListeners(callbackName);
     }
 
@@ -332,7 +336,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     if (value !== undefined) {
       value = String(value);
     }
-    let returnValue: string = APIConstants.global.SCORM_FALSE;
+    let returnValue: string = global_constants.SCORM_FALSE;
 
     if (
       this.checkState(
@@ -351,7 +355,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     }
 
     if (returnValue === undefined) {
-      returnValue = APIConstants.global.SCORM_FALSE;
+      returnValue = global_constants.SCORM_FALSE;
     }
 
     // If we didn't have any errors while setting the data, go ahead and
@@ -388,7 +392,7 @@ export default abstract class BaseAPI implements IBaseAPI {
   ): Promise<string> {
     this.clearScheduledCommit();
 
-    let returnValue = APIConstants.global.SCORM_FALSE;
+    let returnValue = global_constants.SCORM_FALSE;
 
     if (
       this.checkState(
@@ -404,7 +408,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       returnValue =
         typeof result !== "undefined" && result.result
           ? result.result
-          : APIConstants.global.SCORM_FALSE;
+          : global_constants.SCORM_FALSE;
 
       this.apiLog(
         callbackName,
@@ -562,12 +566,12 @@ export default abstract class BaseAPI implements IBaseAPI {
     value: any,
   ): string {
     if (!CMIElement || CMIElement === "") {
-      return APIConstants.global.SCORM_FALSE;
+      return global_constants.SCORM_FALSE;
     }
 
     const structure = CMIElement.split(".");
     let refObject: RefObject = this;
-    let returnValue = APIConstants.global.SCORM_FALSE;
+    let returnValue = global_constants.SCORM_FALSE;
     let foundFirstIndex = false;
 
     const invalidErrorMessage = `The data model element passed to ${methodName} (${CMIElement}) is not a valid SCORM data model element.`;
@@ -600,7 +604,7 @@ export default abstract class BaseAPI implements IBaseAPI {
 
           if (!scorm2004 || this.lastErrorCode === "0") {
             refObject[attribute] = value;
-            returnValue = APIConstants.global.SCORM_TRUE;
+            returnValue = global_constants.SCORM_TRUE;
           }
         }
       } else {
@@ -645,7 +649,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       }
     }
 
-    if (returnValue === APIConstants.global.SCORM_FALSE) {
+    if (returnValue === global_constants.SCORM_FALSE) {
       this.apiLog(
         methodName,
         `There was an error setting the value for: ${CMIElement}, value of: ${value}`,
@@ -741,9 +745,9 @@ export default abstract class BaseAPI implements IBaseAPI {
     if (refObject === null || refObject === undefined) {
       if (!scorm2004) {
         if (attribute === "_children") {
-          this.throwSCORMError(ErrorCodes.scorm12.CHILDREN_ERROR);
+          this.throwSCORMError(this._error_codes.CHILDREN_ERROR);
         } else if (attribute === "_count") {
-          this.throwSCORMError(ErrorCodes.scorm12.COUNT_ERROR);
+          this.throwSCORMError(this._error_codes.COUNT_ERROR);
         }
       }
     } else {
@@ -757,7 +761,7 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @return {boolean}
    */
   isInitialized(): boolean {
-    return this.currentState === APIConstants.global.STATE_INITIALIZED;
+    return this.currentState === global_constants.STATE_INITIALIZED;
   }
 
   /**
@@ -766,7 +770,7 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @return {boolean}
    */
   isNotInitialized(): boolean {
-    return this.currentState === APIConstants.global.STATE_NOT_INITIALIZED;
+    return this.currentState === global_constants.STATE_NOT_INITIALIZED;
   }
 
   /**
@@ -775,7 +779,7 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @return {boolean}
    */
   isTerminated(): boolean {
-    return this.currentState === APIConstants.global.STATE_TERMINATED;
+    return this.currentState === global_constants.STATE_TERMINATED;
   }
 
   /**
@@ -943,7 +947,7 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @param {string} success
    */
   clearSCORMError(success: string) {
-    if (success !== undefined && success !== APIConstants.global.SCORM_FALSE) {
+    if (success !== undefined && success !== global_constants.SCORM_FALSE) {
       this.lastErrorCode = "0";
     }
   }
@@ -1113,7 +1117,7 @@ export default abstract class BaseAPI implements IBaseAPI {
   ): Promise<ResultObject> {
     const api = this;
     const genericError: ResultObject = {
-      result: APIConstants.global.SCORM_FALSE,
+      result: global_constants.SCORM_FALSE,
       errorCode: this.error_codes.GENERAL,
     };
 
@@ -1124,7 +1128,7 @@ export default abstract class BaseAPI implements IBaseAPI {
         await this.transformResponse(response);
       });
       return {
-        result: APIConstants.global.SCORM_TRUE,
+        result: global_constants.SCORM_TRUE,
         errorCode: 0,
       };
     }
@@ -1204,7 +1208,7 @@ export default abstract class BaseAPI implements IBaseAPI {
   private handleValueAccessException(e: any, returnValue: string): string {
     if (e instanceof ValidationError) {
       this.lastErrorCode = String(e.errorCode);
-      returnValue = APIConstants.global.SCORM_FALSE;
+      returnValue = global_constants.SCORM_FALSE;
     } else {
       if (e instanceof Error && e.message) {
         console.error(e.message);
@@ -1279,8 +1283,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     if (
       response.status >= 200 &&
       response.status <= 299 &&
-      (result.result === true ||
-        result.result === APIConstants.global.SCORM_TRUE)
+      (result.result === true || result.result === global_constants.SCORM_TRUE)
     ) {
       this.processListeners("CommitSuccess");
     } else {

package/src/Scorm12API.ts

@@ -1,8 +1,8 @@
 import { CMI } from "./cmi/scorm12/cmi";
 import * as Utilities from "./utilities";
 import { stringMatches } from "./utilities";
-import APIConstants from "./constants/api_constants";
-import ErrorCodes from "./constants/error_codes";
+import { global_constants, scorm12_constants } from "./constants/api_constants";
+import { scorm12_errors } from "./constants/error_codes";
 
 import { BaseCMI } from "./cmi/common/base_cmi";
 import { CMIObjectivesObject } from "./cmi/scorm12/objectives";
@@ -19,9 +19,9 @@ import {
   ScoreObject,
   Settings,
 } from "./types/api_types";
-import Regex from "./constants/regex";
 import { CompletionStatus, SuccessStatus } from "./constants/enums";
 import BaseAPI from "./BaseAPI";
+import { scorm12_regex } from "./constants/regex";
 
 /**
  * API class for SCORM 1.2
@@ -38,7 +38,7 @@ class Scorm12Impl extends BaseAPI {
       }
     }
 
-    super(ErrorCodes.scorm12, settings);
+    super(scorm12_errors, settings);
 
     this.cmi = new CMI();
     this.nav = new NAV();
@@ -74,8 +74,8 @@ class Scorm12Impl extends BaseAPI {
   reset(settings?: Settings) {
     this.commonReset(settings);
 
-    this.cmi = new CMI();
-    this.nav = new NAV();
+    this.cmi?.reset();
+    this.nav?.reset();
   }
 
   /**
@@ -106,13 +106,13 @@ class Scorm12Impl extends BaseAPI {
     (async () => {
       await this.internalFinish();
     })();
-    return APIConstants.global.SCORM_TRUE;
+    return global_constants.SCORM_TRUE;
   }
 
   async internalFinish(): Promise<string> {
     const result = await this.terminate("LMSFinish", true);
 
-    if (result === APIConstants.global.SCORM_TRUE) {
+    if (result === global_constants.SCORM_TRUE) {
       if (this.nav.event !== "") {
         if (this.nav.event === "continue") {
           this.processListeners("SequenceNext");
@@ -164,7 +164,7 @@ class Scorm12Impl extends BaseAPI {
         await this.commit("LMSCommit", false);
       })();
     }
-    return APIConstants.global.SCORM_TRUE;
+    return global_constants.SCORM_TRUE;
   }
 
   /**
@@ -281,11 +281,11 @@ class Scorm12Impl extends BaseAPI {
 
     // Set error number to string since inconsistent from modules if string or number
     errorNumber = String(errorNumber);
-    if (APIConstants.scorm12.error_descriptions[errorNumber]) {
+    if (scorm12_constants.error_descriptions[errorNumber]) {
       basicMessage =
-        APIConstants.scorm12.error_descriptions[errorNumber].basicMessage;
+        scorm12_constants.error_descriptions[errorNumber].basicMessage;
       detailMessage =
-        APIConstants.scorm12.error_descriptions[errorNumber].detailMessage;
+        scorm12_constants.error_descriptions[errorNumber].detailMessage;
     }
 
     return detail ? detailMessage : basicMessage;
@@ -342,7 +342,7 @@ class Scorm12Impl extends BaseAPI {
     const totalTimeHHMMSS = this.cmi.getCurrentTotalTime();
     const totalTimeSeconds = Utilities.getTimeAsSeconds(
       totalTimeHHMMSS,
-      Regex.scorm12.CMITimespan,
+      scorm12_regex.CMITimespan,
     );
     const lessonStatus = this.cmi.core.lesson_status;
     let completionStatus = CompletionStatus.unknown;
@@ -437,7 +437,7 @@ class Scorm12Impl extends BaseAPI {
       );
     } else {
       return {
-        result: APIConstants.global.SCORM_TRUE,
+        result: global_constants.SCORM_TRUE,
         errorCode: 0,
       };
     }