scorm-again 2.5.0 → 2.6.1

package/src/cmi/aicc/evaluation.ts

@@ -1,10 +1,10 @@
 import { CMIArray } from "../common/array";
-import { AICCValidationError } from "../../exceptions";
+import { AICCValidationError } from "../../exceptions/aicc_exceptions";
 import { BaseCMI } from "../common/base_cmi";
-import APIConstants from "../../constants/api_constants";
-import ErrorCodes from "../../constants/error_codes";
+import { aicc_constants } from "../../constants/api_constants";
+import { scorm12_errors } from "../../constants/error_codes";
 import { checkAICCValidFormat } from "./validation";
-import Regex from "../../constants/regex";
+import { aicc_regex } from "../../constants/regex";
 
 /**
  * AICC Evaluation object
@@ -28,6 +28,14 @@ export class CMIEvaluation extends BaseCMI {
     this.comments?.initialize();
   }
 
+  /**
+   * Called when the API has been reset
+   */
+  reset(): void {
+    this._initialized = false;
+    this.comments?.reset();
+  }
+
   /**
    * toJSON for cmi.evaluation object
    * @return {{comments: CMIEvaluationComments}}
@@ -54,8 +62,8 @@ class CMIEvaluationComments extends CMIArray {
    */
   constructor() {
     super({
-      children: APIConstants.aicc.comments_children,
-      errorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
+      children: aicc_constants.comments_children,
+      errorCode: scorm12_errors.INVALID_SET_VALUE,
       errorClass: AICCValidationError,
     });
   }
@@ -65,6 +73,10 @@ class CMIEvaluationComments extends CMIArray {
  * Class for AICC Evaluation Comments
  */
 export class CMIEvaluationCommentsObject extends BaseCMI {
+  private _content = "";
+  private _location = "";
+  private _time = "";
+
   /**
    * Constructor for Evaluation Comments
    */
@@ -72,9 +84,16 @@ export class CMIEvaluationCommentsObject extends BaseCMI {
     super();
   }
 
-  private _content = "";
-  private _location = "";
-  private _time = "";
+  /**
+   * Called when the API has been reset
+   */
+  reset(): void {
+    this._initialized = false;
+
+    this._content = "";
+    this._location = "";
+    this._time = "";
+  }
 
   /**
    * Getter for _content
@@ -89,7 +108,7 @@ export class CMIEvaluationCommentsObject extends BaseCMI {
    * @param {string} content
    */
   set content(content: string) {
-    if (checkAICCValidFormat(content, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(content, aicc_regex.CMIString256)) {
       this._content = content;
     }
   }
@@ -107,7 +126,7 @@ export class CMIEvaluationCommentsObject extends BaseCMI {
    * @param {string} location
    */
   set location(location: string) {
-    if (checkAICCValidFormat(location, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(location, aicc_regex.CMIString256)) {
       this._location = location;
     }
   }
@@ -125,7 +144,7 @@ export class CMIEvaluationCommentsObject extends BaseCMI {
    * @param {string} time
    */
   set time(time: string) {
-    if (checkAICCValidFormat(time, Regex.aicc.CMITime)) {
+    if (checkAICCValidFormat(time, aicc_regex.CMITime)) {
       this._time = time;
     }
   }

package/src/cmi/aicc/paths.ts

@@ -1,8 +1,8 @@
 import { BaseCMI } from "../common/base_cmi";
 import { checkAICCValidFormat } from "./validation";
 import { CMIArray } from "../common/array";
-import Regex from "../../constants/regex";
-import APIConstants from "../../constants/api_constants";
+import { aicc_regex } from "../../constants/regex";
+import { aicc_constants } from "../../constants/api_constants";
 
 /**
  * Class representing the AICC `cmi.paths` object
@@ -13,7 +13,7 @@ export class CMIPaths extends CMIArray {
    */
   constructor() {
     super({
-      children: APIConstants.aicc.paths_children,
+      children: aicc_constants.paths_children,
     });
   }
 }
@@ -22,6 +22,13 @@ export class CMIPaths extends CMIArray {
  * Class for AICC Paths
  */
 export class CMIPathsObject extends BaseCMI {
+  private _location_id = "";
+  private _date = "";
+  private _time = "";
+  private _status = "";
+  private _why_left = "";
+  private _time_in_element = "";
+
   /**
    * Constructor for AICC Paths objects
    */
@@ -29,12 +36,19 @@ export class CMIPathsObject extends BaseCMI {
     super();
   }
 
-  private _location_id = "";
-  private _date = "";
-  private _time = "";
-  private _status = "";
-  private _why_left = "";
-  private _time_in_element = "";
+  /**
+   * Called when the API has been reset
+   */
+  reset(): void {
+    this._initialized = false;
+
+    this._location_id = "";
+    this._date = "";
+    this._time = "";
+    this._status = "";
+    this._why_left = "";
+    this._time_in_element = "";
+  }
 
   /**
    * Getter for _location_id
@@ -49,7 +63,7 @@ export class CMIPathsObject extends BaseCMI {
    * @param {string} location_id
    */
   set location_id(location_id: string) {
-    if (checkAICCValidFormat(location_id, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(location_id, aicc_regex.CMIString256)) {
       this._location_id = location_id;
     }
   }
@@ -67,7 +81,7 @@ export class CMIPathsObject extends BaseCMI {
    * @param {string} date
    */
   set date(date: string) {
-    if (checkAICCValidFormat(date, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(date, aicc_regex.CMIString256)) {
       this._date = date;
     }
   }
@@ -85,7 +99,7 @@ export class CMIPathsObject extends BaseCMI {
    * @param {string} time
    */
   set time(time: string) {
-    if (checkAICCValidFormat(time, Regex.aicc.CMITime)) {
+    if (checkAICCValidFormat(time, aicc_regex.CMITime)) {
       this._time = time;
     }
   }
@@ -103,7 +117,7 @@ export class CMIPathsObject extends BaseCMI {
    * @param {string} status
    */
   set status(status: string) {
-    if (checkAICCValidFormat(status, Regex.aicc.CMIStatus2)) {
+    if (checkAICCValidFormat(status, aicc_regex.CMIStatus2)) {
       this._status = status;
     }
   }
@@ -121,7 +135,7 @@ export class CMIPathsObject extends BaseCMI {
    * @param {string} why_left
    */
   set why_left(why_left: string) {
-    if (checkAICCValidFormat(why_left, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(why_left, aicc_regex.CMIString256)) {
       this._why_left = why_left;
     }
   }
@@ -139,7 +153,7 @@ export class CMIPathsObject extends BaseCMI {
    * @param {string} time_in_element
    */
   set time_in_element(time_in_element: string) {
-    if (checkAICCValidFormat(time_in_element, Regex.aicc.CMITime)) {
+    if (checkAICCValidFormat(time_in_element, aicc_regex.CMITime)) {
       this._time_in_element = time_in_element;
     }
   }

package/src/cmi/aicc/student_data.ts

@@ -1,6 +1,6 @@
-import { AICCValidationError } from "../../exceptions";
-import ErrorCodes from "../../constants/error_codes";
-import APIConstants from "../../constants/api_constants";
+import { AICCValidationError } from "../../exceptions/aicc_exceptions";
+import { scorm12_errors } from "../../constants/error_codes";
+import { aicc_constants } from "../../constants/api_constants";
 import { CMITries } from "./tries";
 import { CMIStudentData } from "../scorm12/student_data";
 import { CMIAttemptRecords } from "./attempts";
@@ -13,7 +13,7 @@ export class AICCCMIStudentData extends CMIStudentData {
    * Constructor for AICC StudentData object
    */
   constructor() {
-    super(APIConstants.aicc.student_data_children);
+    super(aicc_constants.student_data_children);
     this.tries = new CMITries();
     this.attempt_records = new CMIAttemptRecords();
   }
@@ -30,6 +30,15 @@ export class AICCCMIStudentData extends CMIStudentData {
     this.attempt_records?.initialize();
   }
 
+  /**
+   * Called when the API has been reset
+   */
+  override reset(): void {
+    this._initialized = false;
+    this.tries?.reset(true);
+    this.attempt_records?.reset(true);
+  }
+
   private _tries_during_lesson = "";
 
   /**
@@ -47,7 +56,7 @@ export class AICCCMIStudentData extends CMIStudentData {
    */
   set tries_during_lesson(tries_during_lesson: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._tries_during_lesson = tries_during_lesson;
     }

package/src/cmi/aicc/student_demographics.ts

@@ -1,20 +1,13 @@
 import { BaseCMI } from "../common/base_cmi";
-import { AICCValidationError } from "../../exceptions";
-import APIConstants from "../../constants/api_constants";
-import ErrorCodes from "../../constants/error_codes";
+import { AICCValidationError } from "../../exceptions/aicc_exceptions";
+import { aicc_constants } from "../../constants/api_constants";
+import { scorm12_errors } from "../../constants/error_codes";
 
 /**
  * Class representing the AICC cmi.student_demographics object
  */
 export class CMIStudentDemographics extends BaseCMI {
-  /**
-   * Constructor for AICC StudentDemographics object
-   */
-  constructor() {
-    super();
-  }
-
-  private __children = APIConstants.aicc.student_demographics_children;
+  private __children = aicc_constants.student_demographics_children;
   private _city = "";
   private _class = "";
   private _company = "";
@@ -29,6 +22,20 @@ export class CMIStudentDemographics extends BaseCMI {
   private _telephone = "";
   private _years_experience = "";
 
+  /**
+   * Constructor for AICC StudentDemographics object
+   */
+  constructor() {
+    super();
+  }
+
+  /**
+   * Called when the API has been reset
+   */
+  reset(): void {
+    this._initialized = false;
+  }
+
   /**
    * Getter for _children
    * @return {string}
@@ -52,7 +59,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set city(city: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._city = city;
     }
@@ -73,7 +80,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set class(clazz: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._class = clazz;
     }
@@ -94,7 +101,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set company(company: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._company = company;
     }
@@ -115,7 +122,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set country(country: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._country = country;
     }
@@ -136,7 +143,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set experience(experience: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._experience = experience;
     }
@@ -157,7 +164,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set familiar_name(familiar_name: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._familiar_name = familiar_name;
     }
@@ -178,7 +185,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set instructor_name(instructor_name: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._instructor_name = instructor_name;
     }
@@ -199,7 +206,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set title(title: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._title = title;
     }
@@ -220,7 +227,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set native_language(native_language: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._native_language = native_language;
     }
@@ -241,7 +248,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set state(state: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._state = state;
     }
@@ -262,7 +269,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set street_address(street_address: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._street_address = street_address;
     }
@@ -283,7 +290,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set telephone(telephone: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._telephone = telephone;
     }
@@ -304,7 +311,7 @@ export class CMIStudentDemographics extends BaseCMI {
    */
   set years_experience(years_experience: string) {
     if (this.initialized) {
-      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+      throw new AICCValidationError(scorm12_errors.READ_ONLY_ELEMENT);
     } else {
       this._years_experience = years_experience;
     }

package/src/cmi/aicc/student_preferences.ts

@@ -1,9 +1,9 @@
 import { CMIArray } from "../common/array";
-import { AICCValidationError } from "../../exceptions";
+import { AICCValidationError } from "../../exceptions/aicc_exceptions";
 import { checkAICCValidFormat } from "./validation";
-import ErrorCodes from "../../constants/error_codes";
-import Regex from "../../constants/regex";
-import APIConstants from "../../constants/api_constants";
+import { scorm12_errors } from "../../constants/error_codes";
+import { aicc_regex } from "../../constants/regex";
+import { aicc_constants } from "../../constants/api_constants";
 import { CMIStudentPreference } from "../scorm12/student_preference";
 
 /**
@@ -14,9 +14,9 @@ export class AICCStudentPreferences extends CMIStudentPreference {
    * Constructor for AICC Student Preferences object
    */
   constructor() {
-    super(APIConstants.aicc.student_preference_children);
+    super(aicc_constants.student_preference_children);
     this.windows = new CMIArray({
-      errorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
+      errorCode: scorm12_errors.INVALID_SET_VALUE,
       errorClass: AICCValidationError,
       children: "",
     });
@@ -51,7 +51,7 @@ export class AICCStudentPreferences extends CMIStudentPreference {
    * @param {string} lesson_type
    */
   set lesson_type(lesson_type: string) {
-    if (checkAICCValidFormat(lesson_type, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(lesson_type, aicc_regex.CMIString256)) {
       this._lesson_type = lesson_type;
     }
   }
@@ -69,7 +69,7 @@ export class AICCStudentPreferences extends CMIStudentPreference {
    * @param {string} text_color
    */
   set text_color(text_color: string) {
-    if (checkAICCValidFormat(text_color, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(text_color, aicc_regex.CMIString256)) {
       this._text_color = text_color;
     }
   }
@@ -87,7 +87,7 @@ export class AICCStudentPreferences extends CMIStudentPreference {
    * @param {string} text_location
    */
   set text_location(text_location: string) {
-    if (checkAICCValidFormat(text_location, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(text_location, aicc_regex.CMIString256)) {
       this._text_location = text_location;
     }
   }
@@ -105,7 +105,7 @@ export class AICCStudentPreferences extends CMIStudentPreference {
    * @param {string} text_size
    */
   set text_size(text_size: string) {
-    if (checkAICCValidFormat(text_size, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(text_size, aicc_regex.CMIString256)) {
       this._text_size = text_size;
     }
   }
@@ -123,7 +123,7 @@ export class AICCStudentPreferences extends CMIStudentPreference {
    * @param {string} video
    */
   set video(video: string) {
-    if (checkAICCValidFormat(video, Regex.aicc.CMIString256)) {
+    if (checkAICCValidFormat(video, aicc_regex.CMIString256)) {
       this._video = video;
     }
   }

package/src/cmi/aicc/tries.ts

@@ -1,10 +1,10 @@
 import { CMIArray } from "../common/array";
-import APIConstants from "../../constants/api_constants";
+import { aicc_constants } from "../../constants/api_constants";
 import { BaseCMI } from "../common/base_cmi";
 import { CMIScore } from "../common/score";
-import Regex from "../../constants/regex";
-import ErrorCodes from "../../constants/error_codes";
-import { AICCValidationError } from "../../exceptions";
+import { aicc_regex } from "../../constants/regex";
+import { scorm12_errors } from "../../constants/error_codes";
+import { AICCValidationError } from "../../exceptions/aicc_exceptions";
 import { checkAICCValidFormat } from "./validation";
 
 /**
@@ -16,7 +16,7 @@ export class CMITries extends CMIArray {
    */
   constructor() {
     super({
-      children: APIConstants.aicc.tries_children,
+      children: aicc_constants.tries_children,
     });
   }
 }
@@ -25,17 +25,20 @@ export class CMITries extends CMIArray {
  * Class for AICC Tries
  */
 export class CMITriesObject extends BaseCMI {
+  private _status = "";
+  private _time = "";
+
   /**
    * Constructor for AICC Tries object
    */
   constructor() {
     super();
     this.score = new CMIScore({
-      score_children: APIConstants.aicc.score_children,
-      score_range: Regex.aicc.score_range,
-      invalidErrorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
-      invalidTypeCode: ErrorCodes.scorm12.TYPE_MISMATCH,
-      invalidRangeCode: ErrorCodes.scorm12.VALUE_OUT_OF_RANGE,
+      score_children: aicc_constants.score_children,
+      score_range: aicc_regex.score_range,
+      invalidErrorCode: scorm12_errors.INVALID_SET_VALUE,
+      invalidTypeCode: scorm12_errors.TYPE_MISMATCH,
+      invalidRangeCode: scorm12_errors.VALUE_OUT_OF_RANGE,
       errorClass: AICCValidationError,
     });
   }
@@ -50,8 +53,15 @@ export class CMITriesObject extends BaseCMI {
     this.score?.initialize();
   }
 
-  private _status = "";
-  private _time = "";
+  /**
+   * Called when the API has been reset
+   */
+  reset(): void {
+    this._initialized = false;
+    this._status = "";
+    this._time = "";
+    this.score?.reset();
+  }
 
   /**
    * Getter for _status
@@ -66,7 +76,7 @@ export class CMITriesObject extends BaseCMI {
    * @param {string} status
    */
   set status(status: string) {
-    if (checkAICCValidFormat(status, Regex.aicc.CMIStatus2)) {
+    if (checkAICCValidFormat(status, aicc_regex.CMIStatus2)) {
       this._status = status;
     }
   }
@@ -84,7 +94,7 @@ export class CMITriesObject extends BaseCMI {
    * @param {string} time
    */
   set time(time: string) {
-    if (checkAICCValidFormat(time, Regex.aicc.CMITime)) {
+    if (checkAICCValidFormat(time, aicc_regex.CMITime)) {
       this._time = time;
     }
   }

package/src/cmi/aicc/validation.ts

@@ -1,7 +1,6 @@
 import { checkValidFormat } from "../common/validation";
-import { AICCValidationError } from "../../exceptions";
-import ErrorCodes from "../../constants/error_codes";
-const aicc_error_codes = ErrorCodes.scorm12;
+import { AICCValidationError } from "../../exceptions/aicc_exceptions";
+import { scorm12_errors } from "../../constants/error_codes";
 
 /**
  * Helper method, no reason to have to pass the same error codes every time
@@ -18,7 +17,7 @@ export function checkAICCValidFormat(
   return checkValidFormat(
     value,
     regexPattern,
-    aicc_error_codes.TYPE_MISMATCH,
+    scorm12_errors.TYPE_MISMATCH,
     AICCValidationError,
     allowEmptyString,
   );

package/src/cmi/common/array.ts

@@ -1,8 +1,6 @@
 import { BaseCMI } from "./base_cmi";
-import ErrorCodes from "../../constants/error_codes";
 import { BaseScormValidationError } from "../../exceptions";
-
-export const scorm12_error_codes = ErrorCodes.scorm12;
+import { scorm12_errors } from "../../constants/error_codes";
 
 /**
  * Base class for cmi *.n objects
@@ -11,7 +9,7 @@ export class CMIArray extends BaseCMI {
   private readonly _errorCode: number;
   private readonly _errorClass: typeof BaseScormValidationError;
   private readonly __children: string;
-  childArray: any[];
+  public childArray: any[];
 
   /**
    * Constructor cmi *.n arrays
@@ -24,11 +22,25 @@ export class CMIArray extends BaseCMI {
   }) {
     super();
     this.__children = params.children;
-    this._errorCode = params.errorCode || scorm12_error_codes.GENERAL;
+    this._errorCode = params.errorCode || scorm12_errors.GENERAL;
     this._errorClass = params.errorClass || BaseScormValidationError;
     this.childArray = [];
   }
 
+  /**
+   * Called when the API has been reset
+   */
+  reset(wipe: boolean = false): void {
+    this._initialized = false;
+    if (wipe) {
+      this.childArray = [];
+    } else {
+      // Reset all children
+      for (let i = 0; i < this.childArray.length; i++) {
+        this.childArray[i].reset();
+      }
+    }
+  }
   /**
    * Getter for _children
    * @return {string}

package/src/cmi/common/base_cmi.ts

@@ -3,7 +3,7 @@
  */
 export abstract class BaseCMI {
   jsonString? = false;
-  private _initialized = false;
+  protected _initialized = false;
   private _start_time: number | undefined;
 
   /**
@@ -36,6 +36,8 @@ export abstract class BaseCMI {
   setStartTime(): void {
     this._start_time = new Date().getTime();
   }
+
+  abstract reset(): void;
 }
 
 /**