scorm-again 2.4.0 → 2.4.1

package/package.json

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

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

@@ -1067,7 +1067,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.",

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

@@ -226,7 +226,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 +411,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 +422,7 @@ class Scorm2004Impl extends BaseAPI {
    * @param {boolean} detail
    * @return {string}
    */
-  getLmsErrorMessageDetails(
+  override getLmsErrorMessageDetails(
     errorNumber: string | number,
     detail: boolean,
   ): string {

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/default_settings.ts

@@ -23,7 +23,11 @@ export const DefaultSettings: Settings = {
   fetchMode: "cors",
   responseHandler: async function (response: Response): Promise<ResultObject> {
     if (typeof response !== "undefined") {
-      const httpResult = JSON.parse(await response.text());
+      const responseText = await response.text();
+      let httpResult = null;
+      if (responseText) {
+        httpResult = JSON.parse(responseText);
+      }
       if (
         httpResult === null ||
         !{}.hasOwnProperty.call(httpResult, "result")

package/test/Scorm12API.spec.ts

@@ -20,7 +20,7 @@ const api = (settings?: Settings, startingData: RefObject = {}) => {
 };
 const apiInitialized = (settings?: Settings, startingData: RefObject = {}) => {
   const API = api(settings);
-  API.loadFromJSON(startingData ? startingData : {}, "");
+  API.loadFromJSON(startingData ? startingData : {});
   API.lmsInitialize();
   return API;
 };
@@ -51,6 +51,106 @@ describe("SCORM 1.2 API Tests", () => {
     clock.restore();
   });
 
+  describe("loadFromJSON()", () => {
+    it("should load JSON data into the CMI object", () => {
+      const scorm12API = api();
+      const jsonData = {
+        cmi: {
+          core: {
+            student_id: "student_1",
+            student_name: "John Doe",
+            lesson_status: "incomplete",
+          },
+        },
+      };
+
+      scorm12API.loadFromJSON(jsonData);
+      scorm12API.lmsInitialize();
+
+      expect(scorm12API.cmi.core.student_id).toEqual("student_1");
+      expect(scorm12API.cmi.core.student_name).toEqual("John Doe");
+      expect(scorm12API.cmi.core.lesson_status).toEqual("incomplete");
+    });
+
+    it("should load nested JSON data into the CMI object", () => {
+      const scorm12API = api();
+      const jsonData = {
+        cmi: {
+          objectives: {
+            "0": {
+              id: "obj_1",
+              score: {
+                raw: "85",
+                min: "0",
+                max: "100",
+              },
+            },
+          },
+        },
+      };
+
+      scorm12API.loadFromJSON(jsonData);
+
+      expect(scorm12API.cmi.objectives.childArray[0].id).toEqual("obj_1");
+      expect(scorm12API.cmi.objectives.childArray[0].score.raw).toEqual("85");
+      expect(scorm12API.cmi.objectives.childArray[0].score.min).toEqual("0");
+      expect(scorm12API.cmi.objectives.childArray[0].score.max).toEqual("100");
+    });
+
+    it("should load nested cmi JSON data into the CMI object", () => {
+      const scorm12API = api();
+      const jsonData = {
+        objectives: {
+          "0": {
+            id: "obj_1",
+            score: {
+              raw: "85",
+              min: "0",
+              max: "100",
+            },
+          },
+        },
+      };
+
+      scorm12API.loadFromJSON(jsonData, "cmi");
+
+      expect(scorm12API.cmi.objectives.childArray[0].id).toEqual("obj_1");
+      expect(scorm12API.cmi.objectives.childArray[0].score.raw).toEqual("85");
+      expect(scorm12API.cmi.objectives.childArray[0].score.min).toEqual("0");
+      expect(scorm12API.cmi.objectives.childArray[0].score.max).toEqual("100");
+    });
+
+    it("should handle empty JSON data", () => {
+      const scorm12API = api();
+      const jsonData = {};
+
+      scorm12API.loadFromJSON(jsonData);
+
+      expect(scorm12API.cmi.core.student_id).toBeFalsy();
+      expect(scorm12API.cmi.core.student_name).toBeFalsy();
+      expect(scorm12API.cmi.core.lesson_status).toBe("not attempted");
+    });
+
+    it("should not load data if API is initialized", () => {
+      const scorm12API = apiInitialized();
+      const jsonData = {
+        cmi: {
+          core: {
+            student_id: "student_1",
+            student_name: "John Doe",
+            lesson_status: "incomplete",
+          },
+        },
+      };
+
+      scorm12API.loadFromJSON(jsonData);
+
+      expect(scorm12API.cmi.core.student_id).toBeFalsy();
+      expect(scorm12API.cmi.core.student_name).toBeFalsy();
+      expect(scorm12API.cmi.core.lesson_status).toBe("not attempted");
+    });
+  });
+
   describe("LMSSetValue()", () => {
     h.checkValidValues({
       api: apiInitialized(),

package/tsconfig.json

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "sourceMap": true,
     "noImplicitAny": true,
+    "noImplicitOverride": true,
     "declaration": false,
     "module": "es2015",
     "moduleResolution": "Node",