scorm-again 2.4.1 → 2.6.0

package/src/constants/default_settings.ts

@@ -1,5 +1,6 @@
-import { ResultObject, Settings } from "../types/api_types";
-import APIConstants from "./api_constants";
+import { LogLevel, ResultObject, Settings } from "../types/api_types";
+import { global_constants } 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,
@@ -34,12 +35,12 @@ export const DefaultSettings: Settings = {
       ) {
         if (response.status === 200) {
           return {
-            result: APIConstants.global.SCORM_TRUE,
+            result: global_constants.SCORM_TRUE,
             errorCode: 0,
           };
         } else {
           return {
-            result: APIConstants.global.SCORM_FALSE,
+            result: global_constants.SCORM_FALSE,
             errorCode: 101,
           };
         }
@@ -48,32 +49,44 @@ export const DefaultSettings: Settings = {
           result: httpResult.result,
           errorCode: httpResult.errorCode
             ? httpResult.errorCode
-            : httpResult.result === APIConstants.global.SCORM_TRUE
+            : httpResult.result === global_constants.SCORM_TRUE
               ? 0
               : 101,
         };
       }
     }
     return {
-      result: APIConstants.global.SCORM_FALSE,
+      result: global_constants.SCORM_FALSE,
       errorCode: 101,
     };
   },
   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 {
@@ -84,4 +97,5 @@ export const DefaultSettings: Settings = {
   },
   scoItemIds: [],
   scoItemIdValidator: false,
+  globalObjectiveIds: [],
 };

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/error_codes.ts

@@ -2,7 +2,7 @@ export type ErrorCode = {
   [key: string]: number;
 };
 
-const global: ErrorCode = {
+export const global_errors: ErrorCode = {
   GENERAL: 101,
   INITIALIZATION_FAILED: 101,
   INITIALIZED: 101,
@@ -33,8 +33,8 @@ const global: ErrorCode = {
   DEPENDENCY_NOT_ESTABLISHED: 101,
 };
 
-const scorm12: ErrorCode = {
-  ...global,
+export const scorm12_errors: ErrorCode = {
+  ...global_errors,
   RETRIEVE_BEFORE_INIT: 301,
   STORE_BEFORE_INIT: 301,
   COMMIT_BEFORE_INIT: 301,
@@ -52,8 +52,8 @@ const scorm12: ErrorCode = {
   DEPENDENCY_NOT_ESTABLISHED: 408,
 };
 
-const scorm2004: ErrorCode = {
-  ...global,
+export const scorm2004_errors: ErrorCode = {
+  ...global_errors,
   INITIALIZATION_FAILED: 102,
   INITIALIZED: 103,
   TERMINATED: 104,
@@ -79,10 +79,3 @@ const scorm2004: ErrorCode = {
   VALUE_OUT_OF_RANGE: 407,
   DEPENDENCY_NOT_ESTABLISHED: 408,
 };
-
-const ErrorCodes = {
-  scorm12,
-  scorm2004,
-};
-
-export default ErrorCodes;

package/src/constants/regex.ts

@@ -1,4 +1,4 @@
-const scorm12 = {
+export const scorm12_regex = {
   CMIString256: "^.{0,255}$",
   CMIString4096: "^.{0,4096}$",
   CMITime: "^(?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)$",
@@ -28,13 +28,13 @@ const scorm12 = {
   weighting_range: "-100#100",
   text_range: "-1#1",
 };
-const aicc = {
-  ...scorm12,
+export const aicc_regex = {
+  ...scorm12_regex,
   ...{
     CMIIdentifier: "^\\w{1,255}$",
   },
 };
-const scorm2004 = {
+export const scorm2004_regex = {
   CMIString200: "^[\\u0000-\\uFFFF]{0,200}$",
   CMIString250: "^[\\u0000-\\uFFFF]{0,250}$",
   CMIString1000: "^[\\u0000-\\uFFFF]{0,1000}$",
@@ -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-_]+}$",
@@ -89,9 +89,3 @@ const scorm2004 = {
   text_range: "-1#1",
   progress_range: "0#1",
 };
-const Regex = {
-  aicc: aicc,
-  scorm12: scorm12,
-  scorm2004: scorm2004,
-};
-export default Regex;

package/src/constants/response_constants.ts

@@ -1,6 +1,5 @@
-import Regex from "./regex";
+import { scorm2004_regex } from "./regex";
 
-const scorm2004_regex = Regex.scorm2004;
 export const LearnerResponses: Responses = {
   "true-false": {
     format: "^true$|^false$",

package/src/exceptions/aicc_exceptions.ts

@@ -0,0 +1,29 @@
+import { ValidationError } from "../exceptions";
+import { aicc_constants } from "../constants/api_constants";
+
+const aicc_errors = aicc_constants.error_descriptions;
+
+/**
+ * AICC Validation Error
+ */
+export class AICCValidationError extends ValidationError {
+  /**
+   * Constructor to take in an error code
+   * @param {number} errorCode
+   */
+  constructor(errorCode: number) {
+    if ({}.hasOwnProperty.call(aicc_errors, String(errorCode))) {
+      super(
+        errorCode,
+        aicc_errors[String(errorCode)].basicMessage,
+        aicc_errors[String(errorCode)].detailMessage,
+      );
+    } else {
+      super(
+        101,
+        aicc_errors["101"].basicMessage,
+        aicc_errors["101"].detailMessage,
+      );
+    }
+  }
+}

package/src/exceptions/scorm12_exceptions.ts

@@ -0,0 +1,29 @@
+import { ValidationError } from "../exceptions";
+import { scorm12_constants } from "../constants/api_constants";
+
+const scorm12_errors = scorm12_constants.error_descriptions;
+
+/**
+ * SCORM 1.2 Validation Error
+ */
+export class Scorm12ValidationError extends ValidationError {
+  /**
+   * Constructor to take in an error code
+   * @param {number} errorCode
+   */
+  constructor(errorCode: number) {
+    if ({}.hasOwnProperty.call(scorm12_errors, String(errorCode))) {
+      super(
+        errorCode,
+        scorm12_errors[String(errorCode)].basicMessage,
+        scorm12_errors[String(errorCode)].detailMessage,
+      );
+    } else {
+      super(
+        101,
+        scorm12_errors["101"].basicMessage,
+        scorm12_errors["101"].detailMessage,
+      );
+    }
+  }
+}

package/src/exceptions/scorm2004_exceptions.ts

@@ -0,0 +1,29 @@
+import { ValidationError } from "../exceptions";
+import { scorm2004_constants } from "../constants/api_constants";
+
+const scorm2004_errors = scorm2004_constants.error_descriptions;
+
+/**
+ * SCORM 2004 Validation Error
+ */
+export class Scorm2004ValidationError extends ValidationError {
+  /**
+   * Constructor to take in an error code
+   * @param {number} errorCode
+   */
+  constructor(errorCode: number) {
+    if ({}.hasOwnProperty.call(scorm2004_errors, String(errorCode))) {
+      super(
+        errorCode,
+        scorm2004_errors[String(errorCode)].basicMessage,
+        scorm2004_errors[String(errorCode)].detailMessage,
+      );
+    } else {
+      super(
+        101,
+        scorm2004_errors["101"].basicMessage,
+        scorm2004_errors["101"].detailMessage,
+      );
+    }
+  }
+}

package/src/exceptions.ts

@@ -1,9 +1,3 @@
-import APIConstants from "./constants/api_constants";
-
-const scorm12_errors = APIConstants.scorm12.error_descriptions;
-const aicc_errors = APIConstants.aicc.error_descriptions;
-const scorm2004_errors = APIConstants.scorm2004.error_descriptions;
-
 type APIError = {
   errorCode: number;
   errorMessage: string;
@@ -26,10 +20,6 @@ export class BaseScormValidationError extends Error {
   get errorCode(): number {
     return this._errorCode;
   }
-
-  setMessage(message: string) {
-    this.message = message;
-  }
 }
 
 /**
@@ -51,7 +41,7 @@ export class ValidationError
     detailedMessage?: string,
   ) {
     super(errorCode);
-    this.setMessage(errorMessage);
+    this.message = errorMessage;
     this._errorMessage = errorMessage;
     if (detailedMessage) {
       this._detailedMessage = detailedMessage;
@@ -77,78 +67,3 @@ export class ValidationError
     return this._detailedMessage;
   }
 }
-
-/**
- * SCORM 1.2 Validation Error
- */
-export class Scorm12ValidationError extends ValidationError {
-  /**
-   * Constructor to take in an error code
-   * @param {number} errorCode
-   */
-  constructor(errorCode: number) {
-    if ({}.hasOwnProperty.call(scorm12_errors, String(errorCode))) {
-      super(
-        errorCode,
-        scorm12_errors[String(errorCode)].basicMessage,
-        scorm12_errors[String(errorCode)].detailMessage,
-      );
-    } else {
-      super(
-        101,
-        scorm12_errors["101"].basicMessage,
-        scorm12_errors["101"].detailMessage,
-      );
-    }
-  }
-}
-
-/**
- * AICC Validation Error
- */
-export class AICCValidationError extends ValidationError {
-  /**
-   * Constructor to take in an error code
-   * @param {number} errorCode
-   */
-  constructor(errorCode: number) {
-    if ({}.hasOwnProperty.call(aicc_errors, String(errorCode))) {
-      super(
-        errorCode,
-        aicc_errors[String(errorCode)].basicMessage,
-        aicc_errors[String(errorCode)].detailMessage,
-      );
-    } else {
-      super(
-        101,
-        aicc_errors["101"].basicMessage,
-        aicc_errors["101"].detailMessage,
-      );
-    }
-  }
-}
-
-/**
- * SCORM 2004 Validation Error
- */
-export class Scorm2004ValidationError extends ValidationError {
-  /**
-   * Constructor to take in an error code
-   * @param {number} errorCode
-   */
-  constructor(errorCode: number) {
-    if ({}.hasOwnProperty.call(scorm2004_errors, String(errorCode))) {
-      super(
-        errorCode,
-        scorm2004_errors[String(errorCode)].basicMessage,
-        scorm2004_errors[String(errorCode)].detailMessage,
-      );
-    } else {
-      super(
-        101,
-        scorm2004_errors["101"].basicMessage,
-        scorm2004_errors["101"].detailMessage,
-      );
-    }
-  }
-}

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,11 +22,12 @@ 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;
-  scoItemIds?: string[];
-  scoItemIdValidator?: false | ((scoItemId: string) => boolean);
+  onLogMessage?: (messageLevel: LogLevel, logMessage: string) => void;
   mastery_override?: boolean;
   renderCommonCommitFields?: boolean;
+  scoItemIds?: string[];
+  scoItemIdValidator?: false | ((scoItemId: string) => boolean);
+  globalObjectiveIds?: string[];
 };
 
 export type RefObject = {
@@ -49,3 +54,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;