scorm-again 2.0.0 → 2.1.0

package/src/cmi/aicc/paths.ts

@@ -0,0 +1,180 @@
+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";
+
+/**
+ * Class representing the AICC `cmi.paths` object
+ */
+export class CMIPaths extends CMIArray {
+  /**
+   * Constructor for inline Paths Array class
+   */
+  constructor() {
+    super({
+      children: APIConstants.aicc.paths_children,
+    });
+  }
+}
+
+/**
+ * Class for AICC Paths
+ */
+export class CMIPathsObject extends BaseCMI {
+  /**
+   * Constructor for AICC Paths objects
+   */
+  constructor() {
+    super();
+  }
+
+  private _location_id = "";
+  private _date = "";
+  private _time = "";
+  private _status = "";
+  private _why_left = "";
+  private _time_in_element = "";
+
+  /**
+   * Getter for _location_id
+   * @return {string}
+   */
+  get location_id(): string {
+    return this._location_id;
+  }
+
+  /**
+   * Setter for _location_id
+   * @param {string} location_id
+   */
+  set location_id(location_id: string) {
+    if (checkAICCValidFormat(location_id, Regex.aicc.CMIString256)) {
+      this._location_id = location_id;
+    }
+  }
+
+  /**
+   * Getter for _date
+   * @return {string}
+   */
+  get date(): string {
+    return this._date;
+  }
+
+  /**
+   * Setter for _date
+   * @param {string} date
+   */
+  set date(date: string) {
+    if (checkAICCValidFormat(date, Regex.aicc.CMIString256)) {
+      this._date = date;
+    }
+  }
+
+  /**
+   * Getter for _time
+   * @return {string}
+   */
+  get time(): string {
+    return this._time;
+  }
+
+  /**
+   * Setter for _time
+   * @param {string} time
+   */
+  set time(time: string) {
+    if (checkAICCValidFormat(time, Regex.aicc.CMITime)) {
+      this._time = time;
+    }
+  }
+
+  /**
+   * Getter for _status
+   * @return {string}
+   */
+  get status(): string {
+    return this._status;
+  }
+
+  /**
+   * Setter for _status
+   * @param {string} status
+   */
+  set status(status: string) {
+    if (checkAICCValidFormat(status, Regex.aicc.CMIStatus2)) {
+      this._status = status;
+    }
+  }
+
+  /**
+   * Getter for _why_left
+   * @return {string}
+   */
+  get why_left(): string {
+    return this._why_left;
+  }
+
+  /**
+   * Setter for _why_left
+   * @param {string} why_left
+   */
+  set why_left(why_left: string) {
+    if (checkAICCValidFormat(why_left, Regex.aicc.CMIString256)) {
+      this._why_left = why_left;
+    }
+  }
+
+  /**
+   * Getter for _time_in_element
+   * @return {string}
+   */
+  get time_in_element(): string {
+    return this._time_in_element;
+  }
+
+  /**
+   * Setter for _time_in_element
+   * @param {string} time_in_element
+   */
+  set time_in_element(time_in_element: string) {
+    if (checkAICCValidFormat(time_in_element, Regex.aicc.CMITime)) {
+      this._time_in_element = time_in_element;
+    }
+  }
+
+  /**
+   * toJSON for cmi.paths.n object
+   * @return {
+   *    {
+   *      location_id: string,
+   *      date: string,
+   *      time: string,
+   *      status: string,
+   *      why_left: string,
+   *      time_in_element: string
+   *    }
+   *  }
+   */
+  toJSON(): {
+    location_id: string;
+    date: string;
+    time: string;
+    status: string;
+    why_left: string;
+    time_in_element: string;
+  } {
+    this.jsonString = true;
+    const result = {
+      location_id: this.location_id,
+      date: this.date,
+      time: this.time,
+      status: this.status,
+      why_left: this.why_left,
+      time_in_element: this.time_in_element,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}

package/src/cmi/aicc/student_data.ts

@@ -0,0 +1,86 @@
+import { AICCValidationError } from "../../exceptions";
+import ErrorCodes from "../../constants/error_codes";
+import APIConstants from "../../constants/api_constants";
+import { CMITries } from "./tries";
+import { CMIStudentData } from "../scorm12/student_data";
+import { CMIAttemptRecords } from "./attempts";
+
+/**
+ * StudentData class for AICC
+ */
+export class AICCCMIStudentData extends CMIStudentData {
+  /**
+   * Constructor for AICC StudentData object
+   */
+  constructor() {
+    super(APIConstants.aicc.student_data_children);
+    this.tries = new CMITries();
+    this.attempt_records = new CMIAttemptRecords();
+  }
+
+  public tries: CMITries;
+  public attempt_records: CMIAttemptRecords;
+
+  /**
+   * Called when the API has been initialized after the CMI has been created
+   */
+  initialize() {
+    super.initialize();
+    this.tries?.initialize();
+    this.attempt_records?.initialize();
+  }
+
+  private _tries_during_lesson = "";
+
+  /**
+   * Getter for tries_during_lesson
+   * @return {string}
+   */
+  get tries_during_lesson(): string {
+    return this._tries_during_lesson;
+  }
+
+  /**
+   * Setter for _tries_during_lesson. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} tries_during_lesson
+   */
+  set tries_during_lesson(tries_during_lesson: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._tries_during_lesson = tries_during_lesson;
+    }
+  }
+
+  /**
+   * toJSON for cmi.student_data object
+   * @return {
+   *    {
+   *      mastery_score: string,
+   *      max_time_allowed: string,
+   *      time_limit_action: string,
+   *      tries: CMITries,
+   *      attempt_records: CMIAttemptRecords
+   *    }
+   *  }
+   */
+  toJSON(): {
+    mastery_score: string;
+    max_time_allowed: string;
+    time_limit_action: string;
+    tries: CMITries;
+    attempt_records: CMIAttemptRecords;
+  } {
+    this.jsonString = true;
+    const result = {
+      mastery_score: this.mastery_score,
+      max_time_allowed: this.max_time_allowed,
+      time_limit_action: this.time_limit_action,
+      tries: this.tries,
+      attempt_records: this.attempt_records,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}

package/src/cmi/aicc/student_demographics.ts

@@ -0,0 +1,367 @@
+import { BaseCMI } from "../common/base_cmi";
+import { AICCValidationError } from "../../exceptions";
+import APIConstants from "../../constants/api_constants";
+import ErrorCodes 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 _city = "";
+  private _class = "";
+  private _company = "";
+  private _country = "";
+  private _experience = "";
+  private _familiar_name = "";
+  private _instructor_name = "";
+  private _title = "";
+  private _native_language = "";
+  private _state = "";
+  private _street_address = "";
+  private _telephone = "";
+  private _years_experience = "";
+
+  /**
+   * Getter for _children
+   * @return {string}
+   */
+  get _children(): string {
+    return this.__children;
+  }
+
+  /**
+   * Getter for city
+   * @return {string}
+   */
+  get city(): string {
+    return this._city;
+  }
+
+  /**
+   * Setter for _city. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} city
+   */
+  set city(city: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._city = city;
+    }
+  }
+
+  /**
+   * Getter for class
+   * @return {string}
+   */
+  get class(): string {
+    return this._class;
+  }
+
+  /**
+   * Setter for _class. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} clazz
+   */
+  set class(clazz: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._class = clazz;
+    }
+  }
+
+  /**
+   * Getter for company
+   * @return {string}
+   */
+  get company(): string {
+    return this._company;
+  }
+
+  /**
+   * Setter for _company. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} company
+   */
+  set company(company: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._company = company;
+    }
+  }
+
+  /**
+   * Getter for country
+   * @return {string}
+   */
+  get country(): string {
+    return this._country;
+  }
+
+  /**
+   * Setter for _country. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} country
+   */
+  set country(country: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._country = country;
+    }
+  }
+
+  /**
+   * Getter for experience
+   * @return {string}
+   */
+  get experience(): string {
+    return this._experience;
+  }
+
+  /**
+   * Setter for _experience. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} experience
+   */
+  set experience(experience: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._experience = experience;
+    }
+  }
+
+  /**
+   * Getter for familiar_name
+   * @return {string}
+   */
+  get familiar_name(): string {
+    return this._familiar_name;
+  }
+
+  /**
+   * Setter for _familiar_name. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} familiar_name
+   */
+  set familiar_name(familiar_name: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._familiar_name = familiar_name;
+    }
+  }
+
+  /**
+   * Getter for instructor_name
+   * @return {string}
+   */
+  get instructor_name(): string {
+    return this._instructor_name;
+  }
+
+  /**
+   * Setter for _instructor_name. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} instructor_name
+   */
+  set instructor_name(instructor_name: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._instructor_name = instructor_name;
+    }
+  }
+
+  /**
+   * Getter for title
+   * @return {string}
+   */
+  get title(): string {
+    return this._title;
+  }
+
+  /**
+   * Setter for _title. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} title
+   */
+  set title(title: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._title = title;
+    }
+  }
+
+  /**
+   * Getter for native_language
+   * @return {string}
+   */
+  get native_language(): string {
+    return this._native_language;
+  }
+
+  /**
+   * Setter for _native_language. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} native_language
+   */
+  set native_language(native_language: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._native_language = native_language;
+    }
+  }
+
+  /**
+   * Getter for state
+   * @return {string}
+   */
+  get state(): string {
+    return this._state;
+  }
+
+  /**
+   * Setter for _state. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} state
+   */
+  set state(state: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._state = state;
+    }
+  }
+
+  /**
+   * Getter for street_address
+   * @return {string}
+   */
+  get street_address(): string {
+    return this._street_address;
+  }
+
+  /**
+   * Setter for _street_address. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} street_address
+   */
+  set street_address(street_address: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._street_address = street_address;
+    }
+  }
+
+  /**
+   * Getter for telephone
+   * @return {string}
+   */
+  get telephone(): string {
+    return this._telephone;
+  }
+
+  /**
+   * Setter for _telephone. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} telephone
+   */
+  set telephone(telephone: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._telephone = telephone;
+    }
+  }
+
+  /**
+   * Getter for years_experience
+   * @return {string}
+   */
+  get years_experience(): string {
+    return this._years_experience;
+  }
+
+  /**
+   * Setter for _years_experience. Sets an error if trying to set after
+   *  initialization.
+   * @param {string} years_experience
+   */
+  set years_experience(years_experience: string) {
+    if (this.initialized) {
+      throw new AICCValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._years_experience = years_experience;
+    }
+  }
+
+  /**
+   * toJSON for cmi.student_demographics object
+   * @return {
+   *      {
+   *        city: string,
+   *        class: string,
+   *        company: string,
+   *        country: string,
+   *        experience: string,
+   *        familiar_name: string,
+   *        instructor_name: string,
+   *        title: string,
+   *        native_language: string,
+   *        state: string,
+   *        street_address: string,
+   *        telephone: string,
+   *        years_experience: string
+   *      }
+   *    }
+   */
+  toJSON(): {
+    city: string;
+    class: string;
+    company: string;
+    country: string;
+    experience: string;
+    familiar_name: string;
+    instructor_name: string;
+    title: string;
+    native_language: string;
+    state: string;
+    street_address: string;
+    telephone: string;
+    years_experience: string;
+  } {
+    this.jsonString = true;
+    const result = {
+      city: this.city,
+      class: this.class,
+      company: this.company,
+      country: this.country,
+      experience: this.experience,
+      familiar_name: this.familiar_name,
+      instructor_name: this.instructor_name,
+      title: this.title,
+      native_language: this.native_language,
+      state: this.state,
+      street_address: this.street_address,
+      telephone: this.telephone,
+      years_experience: this.years_experience,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}