Adding default value for loadFromJSON for issue #767

jcputney · Oct 29, 2024 · 757fc13 · 757fc13
1 parent 0a5fa75
commit 757fc13
Show file tree

Hide file tree

Showing 35 changed files with 135 additions and 27 deletions.
diff --git a/dist/aicc.js b/dist/aicc.js
diff --git a/dist/aicc.js.map b/dist/aicc.js.map
diff --git a/dist/aicc.min.js b/dist/aicc.min.js
diff --git a/dist/aicc.min.js.map b/dist/aicc.min.js.map
diff --git a/dist/esm/aicc.js b/dist/esm/aicc.js
diff --git a/dist/esm/aicc.js.map b/dist/esm/aicc.js.map
diff --git a/dist/esm/aicc.min.js b/dist/esm/aicc.min.js
diff --git a/dist/esm/aicc.min.js.map b/dist/esm/aicc.min.js.map
diff --git a/dist/esm/scorm-again.js b/dist/esm/scorm-again.js
diff --git a/dist/esm/scorm-again.js.map b/dist/esm/scorm-again.js.map
diff --git a/dist/esm/scorm-again.min.js b/dist/esm/scorm-again.min.js
diff --git a/dist/esm/scorm-again.min.js.map b/dist/esm/scorm-again.min.js.map
diff --git a/dist/esm/scorm12.js b/dist/esm/scorm12.js
diff --git a/dist/esm/scorm12.js.map b/dist/esm/scorm12.js.map
diff --git a/dist/esm/scorm12.min.js b/dist/esm/scorm12.min.js
diff --git a/dist/esm/scorm12.min.js.map b/dist/esm/scorm12.min.js.map
diff --git a/dist/esm/scorm2004.js b/dist/esm/scorm2004.js
diff --git a/dist/esm/scorm2004.js.map b/dist/esm/scorm2004.js.map
diff --git a/dist/esm/scorm2004.min.js b/dist/esm/scorm2004.min.js
diff --git a/dist/esm/scorm2004.min.js.map b/dist/esm/scorm2004.min.js.map
diff --git a/dist/scorm-again.js b/dist/scorm-again.js
diff --git a/dist/scorm-again.js.map b/dist/scorm-again.js.map
diff --git a/dist/scorm-again.min.js b/dist/scorm-again.min.js
diff --git a/dist/scorm-again.min.js.map b/dist/scorm-again.min.js.map
diff --git a/dist/scorm12.js b/dist/scorm12.js
diff --git a/dist/scorm12.js.map b/dist/scorm12.js.map
diff --git a/dist/scorm12.min.js b/dist/scorm12.min.js
diff --git a/dist/scorm12.min.js.map b/dist/scorm12.min.js.map
diff --git a/dist/scorm2004.js b/dist/scorm2004.js
diff --git a/dist/scorm2004.js.map b/dist/scorm2004.js.map
diff --git a/dist/scorm2004.min.js b/dist/scorm2004.min.js
diff --git a/dist/scorm2004.min.js.map b/dist/scorm2004.min.js.map
diff --git a/package.json b/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",

diff --git a/src/BaseAPI.ts b/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.",

diff --git a/test/Scorm12API.spec.ts b/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(),