scorm-again 2.4.0 → 2.5.0

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,
@@ -23,7 +24,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")
@@ -58,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/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/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();

package/tsconfig.json

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