scorm-again 2.2.0 → 2.4.0

package/index.d.ts

@@ -0,0 +1,70 @@
+import { Scorm12Impl } from "./src/Scorm12API";
+import { CMI as Scorm12CMI } from "./src/cmi/scorm12/cmi";
+import { NAV as Scorm12NAV } from "./src/cmi/scorm12/nav";
+import { CMI as Scorm2004CMI } from "./src/cmi/scorm2004/cmi";
+import { ADL as Scorm2004ADL } from "./src/cmi/scorm2004/adl";
+import { Settings } from "./src/types/api_types";
+import { Scorm2004Impl } from "./src/Scorm2004API";
+import { AICCImpl } from "./src/AICC";
+
+declare class Scorm12API extends Scorm12Impl {
+  constructor(settings?: Settings);
+
+  cmi: Scorm12CMI;
+  nav: Scorm12NAV;
+  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;
+
+  /**
+   * Called when the API needs to be reset
+   */
+  reset(settings?: Settings): void;
+}
+
+declare class Scorm2004API extends Scorm2004Impl {
+  constructor(settings?: Settings);
+
+  cmi: Scorm2004CMI;
+  adl: Scorm2004ADL;
+  Initialize: () => string;
+  Terminate: () => string;
+  GetValue: (CMIElement: string) => string;
+  SetValue: (CMIElement: string, value: any) => string;
+  Commit: () => string;
+  GetLastError: () => string;
+  GetErrorString: (CMIErrorCode: string) => string;
+  GetDiagnostic: (CMIErrorCode: string) => string;
+
+  /**
+   * Called when the API needs to be reset
+   */
+  reset(settings?: Settings): void;
+}
+
+declare class AICC extends AICCImpl {
+  constructor(settings?: Settings);
+
+  cmi: Scorm12CMI;
+  nav: Scorm12NAV;
+  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;
+
+  /**
+   * Called when the API needs to be reset
+   */
+  reset(settings?: Settings): void;
+}
+
+export { Scorm12API, Scorm2004API, AICC, Settings };

package/package.json

@@ -1,8 +1,10 @@
 {
   "name": "scorm-again",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "A modern SCORM JavaScript run-time library for AICC, SCORM 1.2, and SCORM 2004",
-  "main": "dist/scorm-again.min.js",
+  "main": "dist/scorm-again.js",
+  "types": "index.d.ts",
+  "module": "dist/esm/scorm-again.js",
   "type": "module",
   "browser": {
     "electron": false
@@ -21,11 +23,11 @@
   },
   "devDependencies": {
     "@babel/cli": "^7.25.9",
-    "@babel/core": "^7.25.9",
+    "@babel/core": "^7.26.0",
     "@babel/eslint-parser": "^7.25.9",
-    "@babel/node": "^7.25.9",
-    "@babel/preset-env": "^7.25.9",
-    "@babel/preset-typescript": "^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",
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
@@ -66,7 +68,7 @@
   "scripts": {
     "test": "./node_modules/.bin/mocha --import=tsx --bdd --recursive --reporter list",
     "test:coverage": "./node_modules/.bin/c8 ./node_modules/.bin/mocha --import=tsx --recursive --timeout=10000 --exit --reporter json --reporter-option output=test-results.json",
-    "compile": "./node_modules/.bin/webpack --bail --config webpack.config.js",
+    "compile": "./node_modules/.bin/webpack --bail --config webpack.config.js --mode production",
     "fix": "./node_modules/.bin/eslint ./src --fix",
     "prettier": "./node_modules/.bin/prettier --write src/**/*.ts test/**/*.ts src/*.ts test/*.ts"
   },
@@ -97,7 +99,8 @@
       "test/**/*.*",
       "src/exports/*.*",
       "src/interfaces/*.*",
-      "src/types/*.*"
+      "src/types/*.*",
+      "src/ScormAgain.ts"
     ],
     "extension": [
       ".ts"

package/src/AICC.ts

@@ -1,4 +1,4 @@
-import Scorm12API from "./Scorm12API";
+import { Scorm12Impl } from "./Scorm12API";
 import { CMI } from "./cmi/aicc/cmi";
 
 import { BaseCMI } from "./cmi/common/base_cmi";
@@ -13,7 +13,7 @@ import { stringMatches } from "./utilities";
 /**
  * The AICC API class
  */
-export default class AICC extends Scorm12API {
+class AICCImpl extends Scorm12Impl {
   /**
    * Constructor to create AICC API object
    * @param {Settings} settings
@@ -62,11 +62,13 @@ export default class AICC extends Scorm12API {
   /**
    * Replace the whole API with another
    *
-   * @param {AICC} newAPI
+   * @param {AICCImpl} newAPI
    */
-  replaceWithAnotherScormAPI(newAPI: AICC) {
+  replaceWithAnotherScormAPI(newAPI: AICCImpl) {
     // Data Model
     this.cmi = newAPI.cmi;
     this.nav = newAPI.nav;
   }
 }
+
+export { AICCImpl };

package/src/BaseAPI.ts

@@ -4,10 +4,9 @@ import ErrorCodes, { ErrorCode } from "./constants/error_codes";
 import APIConstants from "./constants/api_constants";
 import { formatMessage, stringMatches, unflatten } from "./utilities";
 import { BaseCMI } from "./cmi/common/base_cmi";
-import { debounce } from "./utilities/debounce";
 import {
-  RefObject,
   CommitObject,
+  RefObject,
   ResultObject,
   Settings,
 } from "./types/api_types";
@@ -360,7 +359,7 @@ export default abstract class BaseAPI implements IBaseAPI {
     // If we didn't have any errors while setting the data, go ahead and
     // schedule a commit, if autocommit is turned on
     if (String(this.lastErrorCode) === "0") {
-      if (this.settings.autocommit && !this._timeout) {
+      if (this.settings.autocommit) {
         this.scheduleCommit(
           this.settings.autocommitSeconds * 1000,
           commitCallback,
@@ -389,6 +388,7 @@ 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;
@@ -1174,17 +1174,7 @@ export default abstract class BaseAPI implements IBaseAPI {
       }
     };
 
-    if (this.settings.asyncCommit) {
-      const debouncedProcess = debounce(process, 500, immediate);
-      debouncedProcess(url, params, this.settings);
-
-      return {
-        result: APIConstants.global.SCORM_TRUE,
-        errorCode: 0,
-      };
-    } else {
-      return await process(url, params, this.settings);
-    }
+    return await process(url, params, this.settings);
   }
 
   /**
@@ -1194,13 +1184,15 @@ export default abstract class BaseAPI implements IBaseAPI {
    * @param {string} callback - the name of the commit event callback
    */
   scheduleCommit(when: number, callback: string) {
-    this._timeout = new ScheduledCommit(this, when, callback);
-    this.apiLog(
-      "scheduleCommit",
-      "scheduled",
-      APIConstants.global.LOG_LEVEL_DEBUG,
-      "",
-    );
+    if (!this._timeout) {
+      this._timeout = new ScheduledCommit(this, when, callback);
+      this.apiLog(
+        "scheduleCommit",
+        "scheduled",
+        APIConstants.global.LOG_LEVEL_DEBUG,
+        "",
+      );
+    }
   }
 
   /**
@@ -1262,6 +1254,30 @@ export default abstract class BaseAPI implements IBaseAPI {
     return returnValue;
   }
 
+  /**
+   * Builds the commit object to be sent to the LMS
+   * @param {boolean} terminateCommit
+   * @return {CommitObject|RefObject|Array}
+   * @private
+   */
+  protected getCommitObject(
+    terminateCommit: boolean,
+  ): CommitObject | RefObject | Array<any> {
+    const shouldTerminateCommit =
+      terminateCommit || this.settings.alwaysSendTotalTime;
+    const commitObject = this.settings.renderCommonCommitFields
+      ? this.renderCommitObject(shouldTerminateCommit)
+      : this.renderCommitCMI(shouldTerminateCommit);
+
+    if (this.apiLogLevel === APIConstants.global.LOG_LEVEL_DEBUG) {
+      console.debug(
+        "Commit (terminated: " + (terminateCommit ? "yes" : "no") + "): ",
+      );
+      console.debug(commitObject);
+    }
+    return commitObject;
+  }
+
   /**
    * Perform the fetch request to the LMS
    * @param {string} url
@@ -1275,6 +1291,7 @@ export default abstract class BaseAPI implements IBaseAPI {
   ): Promise<Response> {
     return fetch(url, {
       method: "POST",
+      mode: this.settings.fetchMode,
       body: params instanceof Array ? params.join("&") : JSON.stringify(params),
       headers: {
         ...this.settings.xhrHeaders,

package/src/Scorm12API.ts

@@ -1,4 +1,3 @@
-import BaseAPI from "./BaseAPI";
 import { CMI } from "./cmi/scorm12/cmi";
 import * as Utilities from "./utilities";
 import { stringMatches } from "./utilities";
@@ -22,11 +21,12 @@ import {
 } from "./types/api_types";
 import Regex from "./constants/regex";
 import { CompletionStatus, SuccessStatus } from "./constants/enums";
+import BaseAPI from "./BaseAPI";
 
 /**
  * API class for SCORM 1.2
  */
-export default class Scorm12API extends BaseAPI {
+class Scorm12Impl extends BaseAPI {
   /**
    * Constructor for SCORM 1.2 API
    * @param {object} settings
@@ -56,17 +56,17 @@ export default class Scorm12API extends BaseAPI {
 
   public statusSetByModule = false;
 
-  public cmi: CMI;
-  public nav: NAV;
+  cmi: CMI;
+  nav: NAV;
 
-  public LMSInitialize: () => string;
-  public LMSFinish: () => string;
-  public LMSGetValue: (CMIElement: string) => string;
-  public LMSSetValue: (CMIElement: string, value: any) => string;
-  public LMSCommit: () => string;
-  public LMSGetLastError: () => string;
-  public LMSGetErrorString: (CMIErrorCode: string) => string;
-  public LMSGetDiagnostic: (CMIErrorCode: string) => string;
+  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;
 
   /**
    * Called when the API needs to be reset
@@ -157,9 +157,13 @@ export default class Scorm12API extends BaseAPI {
    * @return {string} bool
    */
   lmsCommit(): string {
-    (async () => {
-      await this.commit("LMSCommit", false);
-    })();
+    if (this.settings.asyncCommit) {
+      this.scheduleCommit(500, "LMSCommit");
+    } else {
+      (async () => {
+        await this.commit("LMSCommit", false);
+      })();
+    }
     return APIConstants.global.SCORM_TRUE;
   }
 
@@ -290,9 +294,9 @@ export default class Scorm12API extends BaseAPI {
   /**
    * Replace the whole API with another
    *
-   * @param {Scorm12API} newAPI
+   * @param {Scorm12Impl} newAPI
    */
-  replaceWithAnotherScormAPI(newAPI: Scorm12API) {
+  replaceWithAnotherScormAPI(newAPI: Scorm12Impl) {
     // Data Model
     this.cmi = newAPI.cmi;
   }
@@ -424,18 +428,7 @@ export default class Scorm12API extends BaseAPI {
       }
     }
 
-    const shouldTerminateCommit =
-      terminateCommit || this.settings.alwaysSendTotalTime;
-    const commitObject = this.settings.renderCommonCommitFields
-      ? this.renderCommitObject(shouldTerminateCommit)
-      : this.renderCommitCMI(shouldTerminateCommit);
-
-    if (this.apiLogLevel === APIConstants.global.LOG_LEVEL_DEBUG) {
-      console.debug(
-        "Commit (terminated: " + (terminateCommit ? "yes" : "no") + "): ",
-      );
-      console.debug(commitObject);
-    }
+    const commitObject = this.getCommitObject(terminateCommit);
     if (typeof this.settings.lmsCommitUrl === "string") {
       return await this.processHttpRequest(
         this.settings.lmsCommitUrl,
@@ -450,3 +443,5 @@ export default class Scorm12API extends BaseAPI {
     }
   }
 }
+
+export { Scorm12Impl };

package/src/Scorm2004API.ts

@@ -30,7 +30,7 @@ import { CompletionStatus, SuccessStatus } from "./constants/enums";
 /**
  * API class for SCORM 2004
  */
-export default class Scorm2004API extends BaseAPI {
+class Scorm2004Impl extends BaseAPI {
   private _version: string = "1.0";
 
   /**
@@ -180,9 +180,13 @@ export default class Scorm2004API extends BaseAPI {
    * @return {string} bool
    */
   lmsCommit(): string {
-    (async () => {
-      await this.commit("Commit");
-    })();
+    if (this.settings.asyncCommit) {
+      this.scheduleCommit(500, "LMSCommit");
+    } else {
+      (async () => {
+        await this.commit("LMSCommit", false);
+      })();
+    }
     return APIConstants.global.SCORM_TRUE;
   }
 
@@ -581,9 +585,9 @@ export default class Scorm2004API extends BaseAPI {
 
   /**
    * Replace the whole API with another
-   * @param {Scorm2004API} newAPI
+   * @param {Scorm2004Impl} newAPI
    */
-  replaceWithAnotherScormAPI(newAPI: Scorm2004API) {
+  replaceWithAnotherScormAPI(newAPI: Scorm2004Impl) {
     // Data Model
     this.cmi = newAPI.cmi;
     this.adl = newAPI.adl;
@@ -718,18 +722,7 @@ export default class Scorm2004API extends BaseAPI {
       navRequest = true;
     }
 
-    const shouldTerminateCommit =
-      terminateCommit || this.settings.alwaysSendTotalTime;
-    const commitObject = this.settings.renderCommonCommitFields
-      ? this.renderCommitObject(shouldTerminateCommit)
-      : this.renderCommitCMI(shouldTerminateCommit);
-
-    if (this.apiLogLevel === APIConstants.global.LOG_LEVEL_DEBUG) {
-      console.debug(
-        "Commit (terminated: " + (terminateCommit ? "yes" : "no") + "): ",
-      );
-      console.debug(commitObject);
-    }
+    const commitObject = this.getCommitObject(terminateCommit);
     if (typeof this.settings.lmsCommitUrl === "string") {
       const result = await this.processHttpRequest(
         this.settings.lmsCommitUrl,
@@ -756,3 +749,5 @@ export default class Scorm2004API extends BaseAPI {
     }
   }
 }
+
+export { Scorm2004Impl };

package/src/ScormAgain.ts

@@ -0,0 +1,9 @@
+import { AICCImpl } from "./AICC";
+import { Scorm12Impl } from "./Scorm12API";
+import { Scorm2004Impl } from "./Scorm2004API";
+
+const Scorm12API = Scorm12Impl;
+const Scorm2004API = Scorm2004Impl;
+const AICC = AICCImpl;
+
+export { Scorm12API, Scorm2004API, AICC };

package/src/constants/default_settings.ts

@@ -20,6 +20,7 @@ export const DefaultSettings: Settings = {
   strict_errors: true,
   xhrHeaders: {},
   xhrWithCredentials: false,
+  fetchMode: "cors",
   responseHandler: async function (response: Response): Promise<ResultObject> {
     if (typeof response !== "undefined") {
       const httpResult = JSON.parse(await response.text());

package/src/types/api_types.ts

@@ -15,6 +15,7 @@ export type Settings = {
   strict_errors?: boolean;
   xhrHeaders?: RefObject;
   xhrWithCredentials?: boolean;
+  fetchMode?: "cors" | "no-cors" | "same-origin" | "navigate";
   responseHandler?: (response: Response) => Promise<ResultObject>;
   requestHandler?: (commitObject: any) => any;
   onLogMessage?: (messageLevel: number, logMessage: string) => void;

package/test/AICC.spec.ts

@@ -2,12 +2,12 @@ import { expect } from "expect";
 import { describe } from "mocha";
 import * as h from "./api_helpers";
 import ErrorCodes from "../src/constants/error_codes";
-import AICC from "../src/AICC";
+import { AICCImpl } from "../src/AICC";
 
 const scorm12_error_codes = ErrorCodes.scorm12;
 
 const api = () => {
-  const API = new AICC();
+  const API = new AICCImpl();
   API.apiLogLevel = 1;
   return API;
 };

package/test/Scorm12API.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from "expect";
 import { after, before, describe, it } from "mocha";
-import Scorm12API from "../src/Scorm12API";
+import { Scorm12Impl } from "../src/Scorm12API";
 import * as h from "./api_helpers";
 import ErrorCodes from "../src/constants/error_codes";
 import { scorm12Values } from "./field_values";
@@ -13,7 +13,7 @@ const scorm12_error_codes = ErrorCodes.scorm12;
 
 let clock: sinon.SinonFakeTimers;
 const api = (settings?: Settings, startingData: RefObject = {}) => {
-  const API = new Scorm12API(settings);
+  const API = new Scorm12Impl(settings);
   API.apiLogLevel = 5;
   API.startingData = startingData;
   return API;
@@ -537,6 +537,77 @@ describe("SCORM 1.2 API Tests", () => {
     });
   });
 
+  describe("LMSCommit Debounce Tests", () => {
+    it("should debounce LMSCommit calls when autocommit is true", async () => {
+      const scorm12API = api({
+        ...DefaultSettings,
+        autocommit: true,
+        autocommitSeconds: 1,
+      });
+      scorm12API.lmsInitialize();
+
+      const commitSpy = sinon.spy(scorm12API, "commit");
+
+      scorm12API.lmsSetValue("cmi.core.session_time", "00:01:00");
+      scorm12API.lmsSetValue("cmi.core.session_time", "00:02:00");
+      scorm12API.lmsSetValue("cmi.core.session_time", "00:03:00");
+
+      clock.tick(2000);
+      await clock.runAllAsync();
+
+      expect(commitSpy.calledOnce).toBe(true);
+    });
+
+    it("should call LMSCommit only once within the debounce period ", async () => {
+      const scorm12API = api({
+        ...DefaultSettings,
+        asyncCommit: true,
+        autocommit: true,
+      });
+      scorm12API.lmsInitialize();
+
+      const commitSpy = sinon.spy(scorm12API, "commit");
+
+      scorm12API.lmsSetValue("cmi.core.session_time", "00:01:00");
+
+      scorm12API.lmsCommit();
+      clock.tick(100);
+
+      scorm12API.lmsCommit();
+      clock.tick(100);
+
+      scorm12API.lmsCommit();
+      clock.tick(100);
+
+      clock.tick(1000);
+      await clock.runAllAsync();
+
+      expect(commitSpy.calledOnce).toBe(true);
+    });
+
+    it("should call LMSCommit multiple times if debounce period is exceeded", async () => {
+      const scorm12API = api({
+        ...DefaultSettings,
+        autocommit: true,
+        autocommitSeconds: 1,
+      });
+      scorm12API.lmsInitialize();
+
+      const commitSpy = sinon.spy(scorm12API, "commit");
+
+      scorm12API.lmsSetValue("cmi.core.session_time", "00:01:00");
+      clock.tick(2000);
+      scorm12API.lmsSetValue("cmi.core.session_time", "00:02:00");
+      clock.tick(2000);
+      scorm12API.lmsSetValue("cmi.core.session_time", "00:03:00");
+
+      clock.tick(2000);
+      await clock.runAllAsync();
+
+      expect(commitSpy.calledThrice).toBe(true);
+    });
+  });
+
   describe("Event Handlers", () => {
     it("Should handle SetValue.cmi.core.student_name event", () => {
       const scorm12API = apiInitialized();