scorm-again 2.3.0 → 2.4.0

package/test/Scorm2004API.spec.ts

@@ -4,7 +4,7 @@ import * as sinon from "sinon";
 import * as h from "./api_helpers";
 import Pretender from "fetch-pretender";
 import ErrorCodes from "../src/constants/error_codes";
-import Scorm2004API from "../src/Scorm2004API";
+import { Scorm2004Impl } from "../src/Scorm2004API";
 import { scorm2004Values } from "./field_values";
 import APIConstants from "../src/constants/api_constants";
 import { RefObject, Settings } from "../src/types/api_types";
@@ -15,7 +15,7 @@ const scorm2004_error_codes = ErrorCodes.scorm2004;
 
 let clock: sinon.SinonFakeTimers;
 const api = (settings?: Settings, startingData: RefObject = {}) => {
-  const API = new Scorm2004API(settings);
+  const API = new Scorm2004Impl(settings);
   API.apiLogLevel = 5;
   if (startingData) {
     API.startingData = startingData;
@@ -949,7 +949,7 @@ describe("SCORM 2004 API Tests", () => {
 
   describe("checkCorrectResponseValue()", () => {
     it("should properly handle the true-false response type for unknown value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       scorm2004API.checkCorrectResponseValue("true-false", ["unknown"], "true");
       expect(scorm2004API.lmsGetLastError()).toEqual(
         String(scorm2004_error_codes.TYPE_MISMATCH),
@@ -957,13 +957,13 @@ describe("SCORM 2004 API Tests", () => {
     });
 
     it("should properly handle the true-false response type for correct value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       scorm2004API.checkCorrectResponseValue("true-false", ["true"], "true");
       expect(scorm2004API.lmsGetLastError()).toEqual(String(0));
     });
 
     it("should properly handle the choice response type for value over 4000 characters", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       scorm2004API.checkCorrectResponseValue(
         "choice",
         ["x".repeat(4001)],
@@ -975,25 +975,25 @@ describe("SCORM 2004 API Tests", () => {
     });
 
     it("should properly handle the choice response type for correct value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       scorm2004API.checkCorrectResponseValue("choice", ["true"], "true");
       expect(scorm2004API.lmsGetLastError()).toEqual(String(0));
     });
 
     it("should properly handle the fill-in response type for correct value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       scorm2004API.checkCorrectResponseValue("fill-in", ["true"], "true");
       expect(scorm2004API.lmsGetLastError()).toEqual(String(0));
     });
 
     it("should properly handle the long-fill-in response type for correct value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       scorm2004API.checkCorrectResponseValue("long-fill-in", ["true"], "true");
       expect(scorm2004API.lmsGetLastError()).toEqual(String(0));
     });
 
     it("should properly handle the matching response type for correct value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       scorm2004API.checkCorrectResponseValue(
         "matching",
         ["{order_matters=true}0[.]1"],
@@ -1005,28 +1005,28 @@ describe("SCORM 2004 API Tests", () => {
 
   describe("removeCorrectResponsePrefixes()", () => {
     it("should remove the prefix from the string", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input = "{order_matters=true}correctResponse";
       const result = scorm2004API.removeCorrectResponsePrefixes(input);
       expect(result).toBe("correctResponse");
     });
 
     it("should return the original string if no prefix is present", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input = "correctResponse";
       const result = scorm2004API.removeCorrectResponsePrefixes(input);
       expect(result).toBe("correctResponse");
     });
 
     it("should handle empty strings correctly", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input = "";
       const result = scorm2004API.removeCorrectResponsePrefixes(input);
       expect(result).toBe("");
     });
 
     it("should handle multiple prefixes correctly", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input =
         "{lang=en}{order_matters=true}{case_matters=false}correctResponse";
       const result = scorm2004API.removeCorrectResponsePrefixes(input);
@@ -1034,7 +1034,7 @@ describe("SCORM 2004 API Tests", () => {
     });
 
     it("should throw an error for invalid order_matters value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input = "{order_matters=invalid}correctResponse";
       scorm2004API.removeCorrectResponsePrefixes(input);
       expect(scorm2004API.lmsGetLastError()).toEqual(
@@ -1043,7 +1043,7 @@ describe("SCORM 2004 API Tests", () => {
     });
 
     it("should throw an error for invalid case_matters value", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input = "{case_matters=invalid}correctResponse";
       scorm2004API.removeCorrectResponsePrefixes(input);
       expect(scorm2004API.lmsGetLastError()).toEqual(
@@ -1052,14 +1052,14 @@ describe("SCORM 2004 API Tests", () => {
     });
 
     it("should ignore an unknown prefix", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input = "{unknown=true}correctResponse";
       const result = scorm2004API.removeCorrectResponsePrefixes(input);
       expect(result).toBe("{unknown=true}correctResponse");
     });
 
     it("should throw an error with an invalid language code", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const input = "{lang=xyz}correctResponse";
       scorm2004API.removeCorrectResponsePrefixes(input);
       expect(scorm2004API.lmsGetLastError()).toEqual(
@@ -1089,7 +1089,7 @@ describe("SCORM 2004 API Tests", () => {
     });
 
     it("should call throwSCORMError with the correct arguments in createCorrectResponsesObject", () => {
-      const scorm2004API = new Scorm2004API();
+      const scorm2004API = new Scorm2004Impl();
       const interaction = {
         id: "interaction-id-1",
         type: "invalid-type",

package/webpack.config.js

@@ -14,29 +14,23 @@ const TSLoader = {
   },
 };
 
-export default {
+const commonConfig = {
   mode: "production",
   devtool: "source-map",
   entry: {
-    aicc: "./src/exports/aicc.js",
-    scorm12: "./src/exports/scorm12.js",
-    scorm2004: "./src/exports/scorm2004.js",
-    "scorm-again": "./src/exports/scorm-again.js",
-    "aicc.min": "./src/exports/aicc.js",
-    "scorm12.min": "./src/exports/scorm12.js",
-    "scorm2004.min": "./src/exports/scorm2004.js",
-    "scorm-again.min": "./src/exports/scorm-again.js",
+    aicc: "./src/AICC.ts",
+    scorm12: "./src/Scorm12API.ts",
+    scorm2004: "./src/Scorm2004API.ts",
+    "scorm-again": "./src/ScormAgain.ts",
+    "aicc.min": "./src/AICC.ts",
+    "scorm12.min": "./src/Scorm12API.ts",
+    "scorm2004.min": "./src/Scorm2004API.ts",
+    "scorm-again.min": "./src/ScormAgain.ts",
   },
   target: ["web", "es5"],
   module: {
     rules: [TSLoader],
   },
-  output: {
-    path: path.resolve(__dirname, "dist"),
-    environment: {
-      arrowFunction: false,
-    },
-  },
   optimization: {
     minimize: true,
     minimizer: [
@@ -63,3 +57,32 @@ export default {
     }),
   ],
 };
+
+const cjsConfig = {
+  ...commonConfig,
+  output: {
+    path: path.resolve(__dirname, "dist"),
+    filename: "[name].js",
+    libraryTarget: "this",
+    environment: {
+      arrowFunction: false,
+    },
+  },
+};
+
+const esmConfig = {
+  ...commonConfig,
+  experiments: {
+    outputModule: true,
+  },
+  output: {
+    path: path.resolve(__dirname, "dist/esm"),
+    filename: "[name].js",
+    libraryTarget: "module",
+    environment: {
+      arrowFunction: false,
+    },
+  },
+};
+
+export default [cjsConfig, esmConfig];

package/src/exports/aicc.js

@@ -1,3 +0,0 @@
-import AICC from "../AICC.ts";
-
-window.AICC = AICC;

package/src/exports/scorm-again.js

@@ -1,7 +0,0 @@
-import Scorm2004API from "../Scorm2004API.ts";
-import Scorm12API from "../Scorm12API.ts";
-import AICC from "../AICC.ts";
-
-window.Scorm12API = Scorm12API;
-window.Scorm2004API = Scorm2004API;
-window.AICC = AICC;

package/src/exports/scorm12.js

@@ -1,3 +0,0 @@
-import Scorm12API from "../Scorm12API.ts";
-
-window.Scorm12API = Scorm12API;

package/src/exports/scorm2004.js

@@ -1,3 +0,0 @@
-import Scorm2004API from "../Scorm2004API.ts";
-
-window.Scorm2004API = Scorm2004API;

package/src/utilities/debounce.ts

@@ -1,31 +0,0 @@
-/**
- * Debounce function to delay the execution of a given function.
- *
- * @param func - The function to debounce.
- * @param wait - The number of milliseconds to delay.
- * @param immediate - If `true`, the function will be triggered on the leading edge instead of the trailing.
- * @returns A debounced version of the provided function.
- */
-export function debounce<T extends (...args: any[]) => void>(
-  func: T,
-  wait: number,
-  immediate = false,
-): (...args: Parameters<T>) => void {
-  let timeout: ReturnType<typeof setTimeout> | null;
-
-  return function (this: any, ...args: Parameters<T>) {
-    const context = this;
-
-    const later = () => {
-      timeout = null;
-      if (!immediate) func.apply(context, args);
-    };
-
-    const callNow = immediate && !timeout;
-
-    if (timeout) clearTimeout(timeout);
-    timeout = setTimeout(later, wait);
-
-    if (callNow) func.apply(context, args);
-  };
-}

package/test/utilities/debounce.spec.ts

@@ -1,56 +0,0 @@
-import { expect } from "expect";
-import * as sinon from "sinon";
-import { debounce } from "../../src/utilities/debounce";
-
-describe("debounce", () => {
-  it("executes the function after the specified wait time", (done) => {
-    const mockFunction = sinon.spy();
-    const debouncedFunction = debounce(mockFunction, 100);
-
-    debouncedFunction();
-    expect(mockFunction.called).toBe(false);
-
-    setTimeout(() => {
-      expect(mockFunction.called).toBe(true);
-      done();
-    }, 150);
-  });
-
-  it("executes the function immediately if immediate is true", () => {
-    const mockFunction = sinon.spy();
-    const debouncedFunction = debounce(mockFunction, 100, true);
-
-    debouncedFunction();
-    expect(mockFunction.called).toBe(true);
-  });
-
-  it("does not execute the function if called again within the wait time", (done) => {
-    const mockFunction = sinon.spy();
-    const debouncedFunction = debounce(mockFunction, 100);
-
-    debouncedFunction();
-    debouncedFunction();
-
-    setTimeout(() => {
-      expect(mockFunction.calledOnce).toBe(true);
-      done();
-    }, 150);
-  });
-
-  it("executes the function again after the wait time if called again", (done) => {
-    const mockFunction = sinon.spy();
-    const debouncedFunction = debounce(mockFunction, 100);
-
-    debouncedFunction();
-
-    setTimeout(() => {
-      debouncedFunction();
-      expect(mockFunction.calledOnce).toBe(true);
-
-      setTimeout(() => {
-        expect(mockFunction.calledTwice).toBe(true);
-        done();
-      }, 150);
-    }, 150);
-  });
-});