scorm-again 2.0.0 → 2.2.0

package/src/Scorm12API.ts

@@ -1,20 +1,27 @@
-import BaseAPI, { RefObject, ResultObject, Settings } from "./BaseAPI";
+import BaseAPI from "./BaseAPI";
+import { CMI } from "./cmi/scorm12/cmi";
+import * as Utilities from "./utilities";
+import { stringMatches } from "./utilities";
+import APIConstants from "./constants/api_constants";
+import ErrorCodes from "./constants/error_codes";
+
+import { BaseCMI } from "./cmi/common/base_cmi";
+import { CMIObjectivesObject } from "./cmi/scorm12/objectives";
 import {
-  CMI,
   CMIInteractionsCorrectResponsesObject,
   CMIInteractionsObject,
   CMIInteractionsObjectivesObject,
-  CMIObjectivesObject,
-  NAV,
-} from "./cmi/scorm12_cmi";
-import * as Utilities from "./utilities";
-import APIConstants from "./constants/api_constants";
-import ErrorCodes, { ErrorCode } from "./constants/error_codes";
-import { BaseCMI } from "./cmi/common";
-
-const scorm12_constants = APIConstants.scorm12;
-const global_constants = APIConstants.global;
-const scorm12_error_codes: ErrorCode = ErrorCodes.scorm12;
+} from "./cmi/scorm12/interactions";
+import { NAV } from "./cmi/scorm12/nav";
+import {
+  CommitObject,
+  RefObject,
+  ResultObject,
+  ScoreObject,
+  Settings,
+} from "./types/api_types";
+import Regex from "./constants/regex";
+import { CompletionStatus, SuccessStatus } from "./constants/enums";
 
 /**
  * API class for SCORM 1.2
@@ -31,7 +38,7 @@ export default class Scorm12API extends BaseAPI {
       }
     }
 
-    super(scorm12_error_codes, settings);
+    super(ErrorCodes.scorm12, settings);
 
     this.cmi = new CMI();
     this.nav = new NAV();
@@ -47,6 +54,8 @@ export default class Scorm12API extends BaseAPI {
     this.LMSGetDiagnostic = this.lmsGetDiagnostic;
   }
 
+  public statusSetByModule = false;
+
   public cmi: CMI;
   public nav: NAV;
 
@@ -59,6 +68,16 @@ export default class Scorm12API extends BaseAPI {
   public LMSGetErrorString: (CMIErrorCode: string) => string;
   public LMSGetDiagnostic: (CMIErrorCode: string) => string;
 
+  /**
+   * Called when the API needs to be reset
+   */
+  reset(settings?: Settings) {
+    this.commonReset(settings);
+
+    this.cmi = new CMI();
+    this.nav = new NAV();
+  }
+
   /**
    * lmsInitialize function from SCORM 1.2 Spec
    *
@@ -66,6 +85,11 @@ export default class Scorm12API extends BaseAPI {
    */
   lmsInitialize(): string {
     this.cmi.initialize();
+    if (this.cmi.core.lesson_status) {
+      this.statusSetByModule = true;
+    } else {
+      this.cmi.core.lesson_status = "not attempted";
+    }
     return this.initialize(
       "LMSInitialize",
       "LMS was already initialized!",
@@ -79,9 +103,16 @@ export default class Scorm12API extends BaseAPI {
    * @return {string} bool
    */
   lmsFinish(): string {
-    const result = this.terminate("LMSFinish", true);
+    (async () => {
+      await this.internalFinish();
+    })();
+    return APIConstants.global.SCORM_TRUE;
+  }
 
-    if (result === global_constants.SCORM_TRUE) {
+  async internalFinish(): Promise<string> {
+    const result = await this.terminate("LMSFinish", true);
+
+    if (result === APIConstants.global.SCORM_TRUE) {
       if (this.nav.event !== "") {
         if (this.nav.event === "continue") {
           this.processListeners("SequenceNext");
@@ -114,6 +145,9 @@ export default class Scorm12API extends BaseAPI {
    * @return {string}
    */
   lmsSetValue(CMIElement: string, value: any): string {
+    if (CMIElement === "cmi.core.lesson_status") {
+      this.statusSetByModule = true;
+    }
     return this.setValue("LMSSetValue", "LMSCommit", false, CMIElement, value);
   }
 
@@ -123,7 +157,10 @@ export default class Scorm12API extends BaseAPI {
    * @return {string} bool
    */
   lmsCommit(): string {
-    return this.commit("LMSCommit", false);
+    (async () => {
+      await this.commit("LMSCommit", false);
+    })();
+    return APIConstants.global.SCORM_TRUE;
   }
 
   /**
@@ -189,11 +226,11 @@ export default class Scorm12API extends BaseAPI {
     _value: any,
     foundFirstIndex: boolean,
   ): BaseCMI | null {
-    if (this.stringMatches(CMIElement, "cmi\\.objectives\\.\\d+")) {
+    if (stringMatches(CMIElement, "cmi\\.objectives\\.\\d+")) {
       return new CMIObjectivesObject();
     } else if (
       foundFirstIndex &&
-      this.stringMatches(
+      stringMatches(
         CMIElement,
         "cmi\\.interactions\\.\\d+\\.correct_responses\\.\\d+",
       )
@@ -201,15 +238,12 @@ export default class Scorm12API extends BaseAPI {
       return new CMIInteractionsCorrectResponsesObject();
     } else if (
       foundFirstIndex &&
-      this.stringMatches(
-        CMIElement,
-        "cmi\\.interactions\\.\\d+\\.objectives\\.\\d+",
-      )
+      stringMatches(CMIElement, "cmi\\.interactions\\.\\d+\\.objectives\\.\\d+")
     ) {
       return new CMIInteractionsObjectivesObject();
     } else if (
       !foundFirstIndex &&
-      this.stringMatches(CMIElement, "cmi\\.interactions\\.\\d+")
+      stringMatches(CMIElement, "cmi\\.interactions\\.\\d+")
     ) {
       return new CMIInteractionsObject();
     }
@@ -243,11 +277,11 @@ export default class Scorm12API extends BaseAPI {
 
     // Set error number to string since inconsistent from modules if string or number
     errorNumber = String(errorNumber);
-    if (scorm12_constants.error_descriptions[errorNumber]) {
+    if (APIConstants.scorm12.error_descriptions[errorNumber]) {
       basicMessage =
-        scorm12_constants.error_descriptions[errorNumber].basicMessage;
+        APIConstants.scorm12.error_descriptions[errorNumber].basicMessage;
       detailMessage =
-        scorm12_constants.error_descriptions[errorNumber].detailMessage;
+        APIConstants.scorm12.error_descriptions[errorNumber].detailMessage;
     }
 
     return detail ? detailMessage : basicMessage;
@@ -294,16 +328,75 @@ export default class Scorm12API extends BaseAPI {
     }
   }
 
+  /**
+   * Render the cmi object to the proper format for LMS commit
+   * @param {boolean} terminateCommit
+   * @return {CommitObject}
+   */
+  renderCommitObject(terminateCommit: boolean): CommitObject {
+    const cmiExport = this.renderCommitCMI(terminateCommit);
+    const totalTimeHHMMSS = this.cmi.getCurrentTotalTime();
+    const totalTimeSeconds = Utilities.getTimeAsSeconds(
+      totalTimeHHMMSS,
+      Regex.scorm12.CMITimespan,
+    );
+    const lessonStatus = this.cmi.core.lesson_status;
+    let completionStatus = CompletionStatus.unknown;
+    let successStatus = SuccessStatus.unknown;
+    if (lessonStatus) {
+      completionStatus =
+        lessonStatus === "completed" || lessonStatus === "passed"
+          ? CompletionStatus.completed
+          : CompletionStatus.incomplete;
+      if (lessonStatus === "passed") {
+        successStatus = SuccessStatus.passed;
+      } else if (lessonStatus === "failed") {
+        successStatus = SuccessStatus.failed;
+      }
+    }
+
+    const score = this.cmi.core.score;
+    let scoreObject: ScoreObject = null;
+    if (score) {
+      scoreObject = {};
+
+      if (!Number.isNaN(Number.parseFloat(score.raw))) {
+        scoreObject.raw = Number.parseFloat(score.raw);
+      }
+      if (!Number.isNaN(Number.parseFloat(score.min))) {
+        scoreObject.min = Number.parseFloat(score.min);
+      }
+      if (!Number.isNaN(Number.parseFloat(score.max))) {
+        scoreObject.max = Number.parseFloat(score.max);
+      }
+    }
+
+    const commitObject: CommitObject = {
+      successStatus: successStatus,
+      completionStatus: completionStatus,
+      runtimeData: cmiExport,
+      totalTimeSeconds: totalTimeSeconds,
+    };
+    if (scoreObject) {
+      commitObject.score = scoreObject;
+    }
+    return commitObject;
+  }
+
   /**
    * Attempts to store the data to the LMS
    *
    * @param {boolean} terminateCommit
    * @return {ResultObject}
    */
-  storeData(terminateCommit: boolean): ResultObject {
+  async storeData(terminateCommit: boolean): Promise<ResultObject> {
     if (terminateCommit) {
       const originalStatus = this.cmi.core.lesson_status;
-      if (originalStatus === "not attempted") {
+      if (
+        !this.cmi.core.lesson_status ||
+        (!this.statusSetByModule &&
+          this.cmi.core.lesson_status === "not attempted")
+      ) {
         this.cmi.core.lesson_status = "completed";
       }
 
@@ -314,14 +407,11 @@ export default class Scorm12API extends BaseAPI {
             this.cmi.student_data.mastery_score !== "" &&
             this.cmi.core.score.raw !== ""
           ) {
-            if (
+            this.cmi.core.lesson_status =
               parseFloat(this.cmi.core.score.raw) >=
               parseFloat(this.cmi.student_data.mastery_score)
-            ) {
-              this.cmi.core.lesson_status = "passed";
-            } else {
-              this.cmi.core.lesson_status = "failed";
-            }
+                ? "passed"
+                : "failed";
           }
         }
       } else if (this.cmi.core.lesson_mode === "browse") {
@@ -334,25 +424,27 @@ export default class Scorm12API extends BaseAPI {
       }
     }
 
-    const commitObject = this.renderCommitCMI(
-      terminateCommit || this.settings.alwaysSendTotalTime,
-    );
+    const shouldTerminateCommit =
+      terminateCommit || this.settings.alwaysSendTotalTime;
+    const commitObject = this.settings.renderCommonCommitFields
+      ? this.renderCommitObject(shouldTerminateCommit)
+      : this.renderCommitCMI(shouldTerminateCommit);
 
-    if (this.apiLogLevel === global_constants.LOG_LEVEL_DEBUG) {
+    if (this.apiLogLevel === APIConstants.global.LOG_LEVEL_DEBUG) {
       console.debug(
         "Commit (terminated: " + (terminateCommit ? "yes" : "no") + "): ",
       );
       console.debug(commitObject);
     }
     if (typeof this.settings.lmsCommitUrl === "string") {
-      return this.processHttpRequest(
+      return await this.processHttpRequest(
         this.settings.lmsCommitUrl,
         commitObject,
         terminateCommit,
       );
     } else {
       return {
-        result: global_constants.SCORM_TRUE,
+        result: APIConstants.global.SCORM_TRUE,
         errorCode: 0,
       };
     }