scorm-again 2.4.1 → 2.6.0

package/test/cmi/aicc_cmi.spec.ts

@@ -1,6 +1,6 @@
 import { describe, it } from "mocha";
-import APIConstants from "../../src/constants/api_constants";
-import ErrorCodes from "../../src/constants/error_codes";
+import { aicc_constants } from "../../src/constants/api_constants";
+import { scorm12_errors } from "../../src/constants/error_codes";
 import { CMI } from "../../src/cmi/aicc/cmi";
 import * as h from "../cmi_helpers";
 import { expect } from "expect";
@@ -13,13 +13,10 @@ import { NAV } from "../../src/cmi/scorm12/nav";
 import { CMIPathsObject } from "../../src/cmi/aicc/paths";
 import { CMIStudentDemographics } from "../../src/cmi/aicc/student_demographics";
 
-const aicc_constants = APIConstants.aicc;
-const scorm12_error_codes = ErrorCodes.scorm12;
-
-const invalid_set = scorm12_error_codes.INVALID_SET_VALUE;
-const type_mismatch = scorm12_error_codes.TYPE_MISMATCH;
-const write_only = scorm12_error_codes.WRITE_ONLY_ELEMENT;
-const read_only = scorm12_error_codes.READ_ONLY_ELEMENT;
+const invalid_set = scorm12_errors.INVALID_SET_VALUE;
+const type_mismatch = scorm12_errors.TYPE_MISMATCH;
+const write_only = scorm12_errors.WRITE_ONLY_ELEMENT;
+const read_only = scorm12_errors.READ_ONLY_ELEMENT;
 
 describe("AICC CMI Tests", () => {
   describe("CMI Spec Tests", () => {

package/test/cmi/scorm12_cmi.spec.ts

@@ -1,7 +1,7 @@
 import { expect } from "expect";
 import { describe, it } from "mocha";
-import APIConstants from "../../src/constants/api_constants";
-import ErrorCodes from "../../src/constants/error_codes";
+import { scorm12_constants } from "../../src/constants/api_constants";
+import { scorm12_errors } from "../../src/constants/error_codes";
 import { CMI } from "../../src/cmi/scorm12/cmi";
 import * as h from "../cmi_helpers";
 import { scorm12Values } from "../field_values";
@@ -12,13 +12,13 @@ import {
   CMIInteractionsObjectivesObject,
 } from "../../src/cmi/scorm12/interactions";
 
-const scorm12 = APIConstants.scorm12;
-const scorm12_error_codes = ErrorCodes.scorm12;
+const scorm12 = scorm12_constants;
+const scorm12_error_codes = scorm12;
 
-const invalid_set = scorm12_error_codes.INVALID_SET_VALUE;
-const type_mismatch = scorm12_error_codes.TYPE_MISMATCH;
-const write_only = scorm12_error_codes.WRITE_ONLY_ELEMENT;
-const read_only = scorm12_error_codes.READ_ONLY_ELEMENT;
+const invalid_set = scorm12_errors.INVALID_SET_VALUE;
+const type_mismatch = scorm12_errors.TYPE_MISMATCH;
+const write_only = scorm12_errors.WRITE_ONLY_ELEMENT;
+const read_only = scorm12_errors.READ_ONLY_ELEMENT;
 
 const cmi = () => {
   return new CMI();

package/test/cmi/scorm2004_cmi.spec.ts

@@ -1,6 +1,6 @@
 import { describe, it } from "mocha";
-import ErrorCodes from "../../src/constants/error_codes";
-import APIConstants from "../../src/constants/api_constants";
+import { scorm2004_errors } from "../../src/constants/error_codes";
+import { scorm2004_constants } from "../../src/constants/api_constants";
 import { CMI } from "../../src/cmi/scorm2004/cmi";
 import * as h from "../cmi_helpers";
 import { expect } from "expect";
@@ -14,12 +14,9 @@ import { CMICommentsObject } from "../../src/cmi/scorm2004/comments";
 import { CMIObjectivesObject } from "../../src/cmi/scorm2004/objectives";
 import { ADL } from "../../src/cmi/scorm2004/adl";
 
-const scorm2004_constants = APIConstants.scorm2004;
-const scorm2004_error_codes = ErrorCodes.scorm2004;
-
-const read_only = scorm2004_error_codes.READ_ONLY_ELEMENT;
-const write_only = scorm2004_error_codes.WRITE_ONLY_ELEMENT;
-const type_mismatch = scorm2004_error_codes.TYPE_MISMATCH;
+const read_only = scorm2004_errors.READ_ONLY_ELEMENT;
+const write_only = scorm2004_errors.WRITE_ONLY_ELEMENT;
+const type_mismatch = scorm2004_errors.TYPE_MISMATCH;
 
 const cmi = () => {
   return new CMI();
@@ -1023,7 +1020,9 @@ describe("SCORM 2004 CMI Tests", () => {
 
         it("should export JSON", () => {
           const cmi = adl();
-          expect(JSON.stringify(cmi)).toEqual('{"nav":{"request":"_none_"}}');
+          expect(JSON.stringify(cmi)).toEqual(
+            '{"nav":{"request":"_none_"},"data":{}}',
+          );
         });
       });
     });

package/test/exceptions.spec.ts

@@ -1,16 +1,18 @@
 import { describe, it } from "mocha";
 import { expect } from "expect";
+import { ValidationError } from "../src/exceptions";
 import {
-  ValidationError,
-  AICCValidationError,
-  Scorm12ValidationError,
-  Scorm2004ValidationError,
-} from "../src/exceptions";
-import APIConstants from "../src/constants/api_constants";
+  aicc_constants,
+  scorm12_constants,
+  scorm2004_constants,
+} from "../src/constants/api_constants";
+import { AICCValidationError } from "../src/exceptions/aicc_exceptions";
+import { Scorm12ValidationError } from "../src/exceptions/scorm12_exceptions";
+import { Scorm2004ValidationError } from "../src/exceptions/scorm2004_exceptions";
 
-const scorm12_errors = APIConstants.scorm12.error_descriptions;
-const aicc_errors = APIConstants.aicc.error_descriptions;
-const scorm2004_errors = APIConstants.scorm2004.error_descriptions;
+const scorm12_errors = scorm12_constants.error_descriptions;
+const aicc_errors = aicc_constants.error_descriptions;
+const scorm2004_errors = scorm2004_constants.error_descriptions;
 
 type CheckValidationMessage = {
   errorClass: any;

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 APIConstants from "../../src/constants/api_constants";
+import { SinonStub } from "sinon";
+import { LogLevel, ResultObject, Settings } from "../../src/types/api_types";
+import { global_constants } from "../../src/constants/api_constants";
+import { LogLevelEnum } from "../../src/constants/enums";
+import { DefaultSettings } from "../../src/constants/default_settings";
 
 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,
@@ -22,32 +25,13 @@ describe("Settings Type", () => {
     responseHandler: async (response: Response): Promise<ResultObject> => {
       const httpResult = JSON.parse(await response.text());
       return {
-        result: httpResult.result || APIConstants.global.SCORM_FALSE,
+        result: httpResult.result || global_constants.SCORM_FALSE,
         errorCode:
           httpResult.errorCode !== undefined ? httpResult.errorCode : 101,
       };
     },
     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/test/utilities.spec.ts

@@ -1,10 +1,7 @@
 import { expect } from "expect";
 import { describe, it } from "mocha";
 import * as Utilities from "../src/utilities";
-import Regex from "../src/constants/regex";
-
-const scorm12_regex = Regex.scorm12;
-const scorm2004_regex = Regex.scorm2004;
+import { scorm12_regex, scorm2004_regex } from "../src/constants/regex";
 
 describe("Utility Tests", () => {
   describe("getSecondsAsHHMMSS()", () => {

package/webpack.config.js

@@ -32,6 +32,7 @@ const commonConfig = {
     rules: [TSLoader],
   },
   optimization: {
+    usedExports: false,
     minimize: true,
     minimizer: [
       new TerserPlugin({
@@ -41,6 +42,9 @@ const commonConfig = {
           output: {
             comments: false,
           },
+          compress: {
+            passes: 3,
+          },
         },
       }),
     ],