scorm-again 2.0.0 → 2.1.0

package/src/interfaces/IBaseAPI.ts

@@ -0,0 +1,35 @@
+import { RefObject, ResultObject } from "../types/api_types";
+import { BaseCMI } from "../cmi/common/base_cmi";
+
+export interface IBaseAPI {
+  cmi: BaseCMI;
+  startingData?: RefObject;
+
+  initialize(
+    callbackName: string,
+    initializeMessage?: string,
+    terminationMessage?: string,
+  ): string;
+  lmsInitialize(): string;
+  lmsFinish(): string;
+  lmsGetValue(CMIElement: string): string;
+  lmsSetValue(CMIElement: string, value: any): string;
+  lmsCommit(): string;
+  lmsGetLastError(): string;
+  lmsGetErrorString(CMIErrorCode: string | number): string;
+  lmsGetDiagnostic(CMIErrorCode: string | number): string;
+  storeData(_calculateTotalTime: boolean): Promise<ResultObject>;
+  renderCommitCMI(_terminateCommit: boolean): RefObject | Array<any>;
+  getLmsErrorMessageDetails(
+    _errorNumber: string | number,
+    _detail?: boolean,
+  ): string;
+  getCMIValue(_CMIElement: string): string;
+  setCMIValue(_CMIElement: string, _value: any): string;
+  validateCorrectResponse(_CMIElement: string, _value: any): void;
+  getChildElement(
+    _CMIElement: string,
+    _value: any,
+    _foundFirstIndex: boolean,
+  ): BaseCMI | null;
+}

package/src/types/api_types.ts

@@ -0,0 +1,32 @@
+export type Settings = {
+  autocommit?: boolean;
+  autocommitSeconds?: number;
+  asyncCommit?: boolean;
+  sendFullCommit?: boolean;
+  lmsCommitUrl?: boolean | string;
+  dataCommitFormat?: string;
+  commitRequestDataType?: string;
+  autoProgress?: boolean;
+  logLevel?: number;
+  selfReportSessionTime?: boolean;
+  alwaysSendTotalTime?: boolean;
+  strict_errors?: boolean;
+  xhrHeaders?: RefObject;
+  xhrWithCredentials?: boolean;
+  responseHandler?: (response: Response) => Promise<ResultObject>;
+  requestHandler?: (commitObject: any) => any;
+  onLogMessage?: (messageLevel: number, logMessage: string) => void;
+  scoItemIds?: string[];
+  scoItemIdValidator?: false | ((scoItemId: string) => boolean);
+  mastery_override?: boolean;
+};
+
+export type RefObject = {
+  [key: string]: any;
+};
+
+export type ResultObject = {
+  result: string;
+  errorCode: number;
+  navRequest?: string;
+};

package/src/utilities/debounce.ts

@@ -0,0 +1,31 @@
+/**
+ * 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/src/utilities.ts

@@ -280,3 +280,59 @@ export function countDecimals(num: number): number {
   const parts = num.toString().split(".")[1];
   return parts.length || 0;
 }
+
+/**
+ * Formats the SCORM messages for easy reading
+ *
+ * @param {string} functionName
+ * @param {string} message
+ * @param {string} CMIElement
+ * @return {string}
+ */
+export function formatMessage(
+  functionName: string,
+  message: string,
+  CMIElement?: string,
+): string {
+  const baseLength = 20;
+  let messageString = "";
+
+  messageString += functionName;
+
+  let fillChars = baseLength - messageString.length;
+
+  for (let i = 0; i < fillChars; i++) {
+    messageString += " ";
+  }
+
+  messageString += ": ";
+
+  if (CMIElement) {
+    const CMIElementBaseLength = 70;
+
+    messageString += CMIElement;
+
+    fillChars = CMIElementBaseLength - messageString.length;
+
+    for (let j = 0; j < fillChars; j++) {
+      messageString += " ";
+    }
+  }
+
+  if (message) {
+    messageString += message;
+  }
+
+  return messageString;
+}
+
+/**
+ * Checks to see if {str} contains {tester}
+ *
+ * @param {string} str String to check against
+ * @param {string} tester String to check for
+ * @return {boolean}
+ */
+export function stringMatches(str: string, tester: string): boolean {
+  return str?.match(tester) !== null;
+}

package/test/AICC.spec.ts

@@ -8,7 +8,7 @@ const scorm12_error_codes = ErrorCodes.scorm12;
 
 const api = () => {
   const API = new AICC();
-  API.apiLogLevel = 5;
+  API.apiLogLevel = 1;
   return API;
 };
 const apiInitialized = () => {
@@ -256,6 +256,16 @@ describe("AICC API Tests", () => {
         fieldName: "cmi.student_data.tries.0.score.max",
         valueToTest: "100",
       });
+      h.checkLMSSetValue({
+        api: apiInitialized(),
+        fieldName: "cmi.student_data.attempt_records.0.score.max",
+        valueToTest: "100",
+      });
+      h.checkLMSSetValue({
+        api: apiInitialized(),
+        fieldName: "cmi.paths.0.location_id",
+        valueToTest: "xyz",
+      });
     });
   });
 

package/test/Scorm12API.spec.ts

@@ -6,18 +6,21 @@ import ErrorCodes from "../src/constants/error_codes";
 import { scorm12Values } from "./field_values";
 import * as sinon from "sinon";
 import Pretender from "fetch-pretender";
-import { RefObject, Settings, DefaultSettings } from "../src/BaseAPI";
+import { RefObject, Settings } from "../src/types/api_types";
+import { DefaultSettings } from "../src/constants/default_settings";
 
 const scorm12_error_codes = ErrorCodes.scorm12;
 
 let clock: sinon.SinonFakeTimers;
-const api = (settings?: Settings) => {
+const api = (settings?: Settings, startingData: RefObject = {}) => {
   const API = new Scorm12API(settings);
   API.apiLogLevel = 5;
+  API.startingData = startingData;
   return API;
 };
-const apiInitialized = (settings?: Settings) => {
+const apiInitialized = (settings?: Settings, startingData: RefObject = {}) => {
   const API = api(settings);
+  API.loadFromJSON(startingData ? startingData : {}, "");
   API.lmsInitialize();
   return API;
 };
@@ -323,14 +326,16 @@ describe("SCORM 1.2 API Tests", () => {
   });
 
   describe("replaceWithAnotherScormAPI()", () => {
-    const firstAPI = api();
-    const secondAPI = api();
+    it("should replace the current API with another API", () => {
+      const firstAPI = api();
+      const secondAPI = api();
 
-    firstAPI.cmi.core.student_id = "student_1";
-    secondAPI.cmi.core.student_id = "student_2";
+      firstAPI.cmi.core.student_id = "student_1";
+      secondAPI.cmi.core.student_id = "student_2";
 
-    firstAPI.replaceWithAnotherScormAPI(secondAPI);
-    expect(firstAPI.cmi.core.student_id).toEqual("student_2");
+      firstAPI.replaceWithAnotherScormAPI(secondAPI);
+      expect(firstAPI.cmi.core.student_id).toEqual("student_2");
+    });
   });
 
   describe("renderCommitCMI()", () => {
@@ -577,4 +582,252 @@ describe("SCORM 1.2 API Tests", () => {
       expect(callback.called).toBe(true);
     });
   });
+
+  describe("Test issues from users", () => {
+    it("Should be able to load the JSON data from issue #587", () => {
+      const scorm12api = api({
+        ...DefaultSettings,
+        autocommit: false,
+        lmsCommitUrl: "/scorm12",
+        dataCommitFormat: "flattened",
+        logLevel: 1,
+      });
+
+      scorm12api.loadFromFlattenedJSON(
+        {
+          "cmi.comments": "",
+          "cmi.comments_from_lms": "",
+          "cmi.core.credit": "",
+          "cmi.core.entry": "",
+          "cmi.core.exit": "",
+          "cmi.core.lesson_location": "topic-nOmtUy",
+          "cmi.core.lesson_mode": "normal",
+          "cmi.core.lesson_status": "completed",
+          "cmi.core.score.max": "100",
+          "cmi.core.score.min": "",
+          "cmi.core.score.raw": "",
+          "cmi.core.session_time": "00:03:50",
+          "cmi.core.student_id": "student1",
+          "cmi.core.student_name": "Student 1",
+          "cmi.core.total_time": "00:03:50",
+          "cmi.interactions": {},
+          "cmi.launch_data": "",
+          "cmi.objectives.0.id": "topic-aMMlFF",
+          "cmi.objectives.0.score.max": "100",
+          "cmi.objectives.0.score.min": "",
+          "cmi.objectives.0.score.raw": "",
+          "cmi.objectives.0.status": "completed",
+          "cmi.objectives.1.id": "topic-6ReD72",
+          "cmi.objectives.1.score.max": "100",
+          "cmi.objectives.1.score.min": "",
+          "cmi.objectives.1.score.raw": "",
+          "cmi.objectives.1.status": "completed",
+          "cmi.objectives.10.id": "topic-MllWvr",
+          "cmi.objectives.10.score.max": "100",
+          "cmi.objectives.10.score.min": "",
+          "cmi.objectives.10.score.raw": "",
+          "cmi.objectives.10.status": "completed",
+          "cmi.objectives.11.id": "topic-m0dnP3",
+          "cmi.objectives.11.score.max": "100",
+          "cmi.objectives.11.score.min": "",
+          "cmi.objectives.11.score.raw": "",
+          "cmi.objectives.11.status": "completed",
+          "cmi.objectives.12.id": "topic-so4hKC",
+          "cmi.objectives.12.score.max": "100",
+          "cmi.objectives.12.score.min": "",
+          "cmi.objectives.12.score.raw": "",
+          "cmi.objectives.12.status": "completed",
+          "cmi.objectives.13.id": "topic-S9p8FE",
+          "cmi.objectives.13.score.max": "100",
+          "cmi.objectives.13.score.min": "",
+          "cmi.objectives.13.score.raw": "",
+          "cmi.objectives.13.status": "completed",
+          "cmi.objectives.14.id": "topic-E97B5s",
+          "cmi.objectives.14.score.max": "100",
+          "cmi.objectives.14.score.min": "",
+          "cmi.objectives.14.score.raw": "",
+          "cmi.objectives.14.status": "completed",
+          "cmi.objectives.15.id": "topic-TTyEf0",
+          "cmi.objectives.15.score.max": "100",
+          "cmi.objectives.15.score.min": "",
+          "cmi.objectives.15.score.raw": "",
+          "cmi.objectives.15.status": "completed",
+          "cmi.objectives.16.id": "topic-Bk8ZLK",
+          "cmi.objectives.16.score.max": "100",
+          "cmi.objectives.16.score.min": "",
+          "cmi.objectives.16.score.raw": "",
+          "cmi.objectives.16.status": "completed",
+          "cmi.objectives.17.id": "topic-5rxzyV",
+          "cmi.objectives.17.score.max": "100",
+          "cmi.objectives.17.score.min": "",
+          "cmi.objectives.17.score.raw": "",
+          "cmi.objectives.17.status": "completed",
+          "cmi.objectives.18.id": "topic-Q3rjln",
+          "cmi.objectives.18.score.max": "100",
+          "cmi.objectives.18.score.min": "",
+          "cmi.objectives.18.score.raw": "",
+          "cmi.objectives.18.status": "completed",
+          "cmi.objectives.19.id": "topic-eIbwi4",
+          "cmi.objectives.19.score.max": "100",
+          "cmi.objectives.19.score.min": "",
+          "cmi.objectives.19.score.raw": "",
+          "cmi.objectives.19.status": "completed",
+          "cmi.objectives.2.id": "topic-sfvmuO",
+          "cmi.objectives.2.score.max": "100",
+          "cmi.objectives.2.score.min": "",
+          "cmi.objectives.2.score.raw": "",
+          "cmi.objectives.2.status": "completed",
+          "cmi.objectives.20.id": "topic-AzAspy",
+          "cmi.objectives.20.score.max": "100",
+          "cmi.objectives.20.score.min": "",
+          "cmi.objectives.20.score.raw": "",
+          "cmi.objectives.20.status": "completed",
+          "cmi.objectives.21.id": "topic-ehMV4A",
+          "cmi.objectives.21.score.max": "100",
+          "cmi.objectives.21.score.min": "",
+          "cmi.objectives.21.score.raw": "",
+          "cmi.objectives.21.status": "completed",
+          "cmi.objectives.22.id": "topic-U52hDp",
+          "cmi.objectives.22.score.max": "100",
+          "cmi.objectives.22.score.min": "",
+          "cmi.objectives.22.score.raw": "",
+          "cmi.objectives.22.status": "completed",
+          "cmi.objectives.23.id": "topic-mmAPuC",
+          "cmi.objectives.23.score.max": "100",
+          "cmi.objectives.23.score.min": "",
+          "cmi.objectives.23.score.raw": "",
+          "cmi.objectives.23.status": "completed",
+          "cmi.objectives.24.id": "topic-UyqqeN",
+          "cmi.objectives.24.score.max": "100",
+          "cmi.objectives.24.score.min": "",
+          "cmi.objectives.24.score.raw": "",
+          "cmi.objectives.24.status": "completed",
+          "cmi.objectives.25.id": "topic-UIALBn",
+          "cmi.objectives.25.score.max": "100",
+          "cmi.objectives.25.score.min": "",
+          "cmi.objectives.25.score.raw": "",
+          "cmi.objectives.25.status": "completed",
+          "cmi.objectives.26.id": "topic-oLGCQE",
+          "cmi.objectives.26.score.max": "100",
+          "cmi.objectives.26.score.min": "",
+          "cmi.objectives.26.score.raw": "",
+          "cmi.objectives.26.status": "completed",
+          "cmi.objectives.27.id": "topic-JhRmY0",
+          "cmi.objectives.27.score.max": "100",
+          "cmi.objectives.27.score.min": "",
+          "cmi.objectives.27.score.raw": "",
+          "cmi.objectives.27.status": "completed",
+          "cmi.objectives.28.id": "topic-677fLH",
+          "cmi.objectives.28.score.max": "100",
+          "cmi.objectives.28.score.min": "",
+          "cmi.objectives.28.score.raw": "",
+          "cmi.objectives.28.status": "completed",
+          "cmi.objectives.29.id": "topic-rKvnIL",
+          "cmi.objectives.29.score.max": "100",
+          "cmi.objectives.29.score.min": "",
+          "cmi.objectives.29.score.raw": "",
+          "cmi.objectives.29.status": "completed",
+          "cmi.objectives.3.id": "topic-IObzTr",
+          "cmi.objectives.3.score.max": "100",
+          "cmi.objectives.3.score.min": "",
+          "cmi.objectives.3.score.raw": "",
+          "cmi.objectives.3.status": "completed",
+          "cmi.objectives.30.id": "topic-Vjd6mO",
+          "cmi.objectives.30.score.max": "100",
+          "cmi.objectives.30.score.min": "",
+          "cmi.objectives.30.score.raw": "",
+          "cmi.objectives.30.status": "completed",
+          "cmi.objectives.31.id": "topic-jUsEtX",
+          "cmi.objectives.31.score.max": "100",
+          "cmi.objectives.31.score.min": "",
+          "cmi.objectives.31.score.raw": "",
+          "cmi.objectives.31.status": "completed",
+          "cmi.objectives.32.id": "topic-SvCWWr",
+          "cmi.objectives.32.score.max": "100",
+          "cmi.objectives.32.score.min": "",
+          "cmi.objectives.32.score.raw": "",
+          "cmi.objectives.32.status": "completed",
+          "cmi.objectives.33.id": "topic-knRFfG",
+          "cmi.objectives.33.score.max": "100",
+          "cmi.objectives.33.score.min": "",
+          "cmi.objectives.33.score.raw": "",
+          "cmi.objectives.33.status": "completed",
+          "cmi.objectives.34.id": "topic-wlFwhf",
+          "cmi.objectives.34.score.max": "100",
+          "cmi.objectives.34.score.min": "",
+          "cmi.objectives.34.score.raw": "",
+          "cmi.objectives.34.status": "completed",
+          "cmi.objectives.35.id": "topic-3b86fq",
+          "cmi.objectives.35.score.max": "100",
+          "cmi.objectives.35.score.min": "",
+          "cmi.objectives.35.score.raw": "",
+          "cmi.objectives.35.status": "completed",
+          "cmi.objectives.36.id": "topic-ZjIFKf",
+          "cmi.objectives.36.score.max": "100",
+          "cmi.objectives.36.score.min": "",
+          "cmi.objectives.36.score.raw": "",
+          "cmi.objectives.36.status": "completed",
+          "cmi.objectives.37.id": "topic-A9spZz",
+          "cmi.objectives.37.score.max": "100",
+          "cmi.objectives.37.score.min": "",
+          "cmi.objectives.37.score.raw": "",
+          "cmi.objectives.37.status": "completed",
+          "cmi.objectives.38.id": "topic-nOmtUy",
+          "cmi.objectives.38.score.max": "100",
+          "cmi.objectives.38.score.min": "",
+          "cmi.objectives.38.score.raw": "",
+          "cmi.objectives.38.status": "completed",
+          "cmi.objectives.39.id": "topic-jxtabl",
+          "cmi.objectives.39.score.max": "100",
+          "cmi.objectives.39.score.min": "",
+          "cmi.objectives.39.score.raw": "",
+          "cmi.objectives.39.status": "completed",
+          "cmi.objectives.4.id": "topic-Bq3O5v",
+          "cmi.objectives.4.score.max": "100",
+          "cmi.objectives.4.score.min": "",
+          "cmi.objectives.4.score.raw": "",
+          "cmi.objectives.4.status": "completed",
+          "cmi.objectives.5.id": "topic-HmnDxg",
+          "cmi.objectives.5.score.max": "100",
+          "cmi.objectives.5.score.min": "",
+          "cmi.objectives.5.score.raw": "",
+          "cmi.objectives.5.status": "completed",
+          "cmi.objectives.6.id": "topic-4YswmY",
+          "cmi.objectives.6.score.max": "100",
+          "cmi.objectives.6.score.min": "",
+          "cmi.objectives.6.score.raw": "",
+          "cmi.objectives.6.status": "completed",
+          "cmi.objectives.7.id": "topic-LuAS5e",
+          "cmi.objectives.7.score.max": "100",
+          "cmi.objectives.7.score.min": "",
+          "cmi.objectives.7.score.raw": "",
+          "cmi.objectives.7.status": "completed",
+          "cmi.objectives.8.id": "topic-K6ECXa",
+          "cmi.objectives.8.score.max": "100",
+          "cmi.objectives.8.score.min": "",
+          "cmi.objectives.8.score.raw": "",
+          "cmi.objectives.8.status": "completed",
+          "cmi.objectives.9.id": "topic-2lpxvN",
+          "cmi.objectives.9.score.max": "100",
+          "cmi.objectives.9.score.min": "",
+          "cmi.objectives.9.score.raw": "",
+          "cmi.objectives.9.status": "completed",
+          "cmi.student_data.mastery_score": "",
+          "cmi.student_data.max_time_allowed": "",
+          "cmi.student_data.time_limit_action": "",
+          "cmi.student_preference.audio": "",
+          "cmi.student_preference.language": "",
+          "cmi.student_preference.speed": "",
+          "cmi.student_preference.text": "",
+          "cmi.suspend_data": "",
+        },
+        "",
+      );
+      scorm12api.lmsInitialize();
+
+      expect(scorm12api.getCMIValue("cmi.objectives.10.id")).toEqual(
+        "topic-MllWvr",
+      );
+    });
+  });
 });