scorm-again 2.0.0 → 2.2.0

package/src/cmi/aicc/cmi.ts

@@ -0,0 +1,100 @@
+import * as Scorm12CMI from "../scorm12/cmi";
+import APIConstants from "../../constants/api_constants";
+import { CMIEvaluation } from "./evaluation";
+import { AICCStudentPreferences } from "./student_preferences";
+import { CMIStudentDemographics } from "./student_demographics";
+import { AICCCMIStudentData } from "./student_data";
+import { CMIPaths } from "./paths";
+import { CMICore } from "./core";
+import { CMIObjectives } from "../scorm12/objectives";
+import { CMIStudentData } from "../scorm12/student_data";
+import { CMIStudentPreference } from "../scorm12/student_preference";
+import { CMIInteractions } from "../scorm12/interactions";
+
+/**
+ * CMI Class for AICC
+ */
+export class CMI extends Scorm12CMI.CMI {
+  /**
+   * Constructor for AICC CMI object
+   * @param {boolean} initialized
+   */
+  constructor(initialized: boolean = false) {
+    super(APIConstants.aicc.cmi_children);
+    if (initialized) this.initialize();
+    this.student_preference = new AICCStudentPreferences();
+    this.student_data = new AICCCMIStudentData();
+    this.student_demographics = new CMIStudentDemographics();
+    this.evaluation = new CMIEvaluation();
+    this.paths = new CMIPaths();
+  }
+
+  public student_data: AICCCMIStudentData;
+  public student_preference: AICCStudentPreferences;
+  public student_demographics: CMIStudentDemographics;
+  public evaluation: CMIEvaluation;
+  public paths: CMIPaths;
+
+  /**
+   * Called when the API has been initialized after the CMI has been created
+   */
+  initialize() {
+    super.initialize();
+    this.student_preference?.initialize();
+    this.student_data?.initialize();
+    this.student_demographics?.initialize();
+    this.evaluation?.initialize();
+    this.paths?.initialize();
+  }
+
+  /**
+   * toJSON for cmi
+   *
+   * @return {
+   *    {
+   *      suspend_data: string,
+   *      launch_data: string,
+   *      comments: string,
+   *      comments_from_lms: string,
+   *      core: CMICore,
+   *      objectives: CMIObjectives,
+   *      student_data: CMIStudentData,
+   *      student_preference: CMIStudentPreference,
+   *      interactions: CMIInteractions,
+   *      paths: CMIPaths
+   *    }
+   *  }
+   */
+  toJSON(): {
+    suspend_data: string;
+    launch_data: string;
+    comments: string;
+    comments_from_lms: string;
+    core: CMICore;
+    objectives: CMIObjectives;
+    student_data: CMIStudentData;
+    student_preference: CMIStudentPreference;
+    student_demographics: CMIStudentDemographics;
+    interactions: CMIInteractions;
+    evaluation: CMIEvaluation;
+    paths: CMIPaths;
+  } {
+    this.jsonString = true;
+    const result = {
+      suspend_data: this.suspend_data,
+      launch_data: this.launch_data,
+      comments: this.comments,
+      comments_from_lms: this.comments_from_lms,
+      core: this.core,
+      objectives: this.objectives,
+      student_data: this.student_data,
+      student_preference: this.student_preference,
+      student_demographics: this.student_demographics,
+      interactions: this.interactions,
+      evaluation: this.evaluation,
+      paths: this.paths,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}

package/src/cmi/aicc/core.ts

@@ -0,0 +1,360 @@
+import { BaseCMI } from "../common/base_cmi";
+import { CMIScore } from "../common/score";
+import APIConstants from "../../constants/api_constants";
+import Regex from "../../constants/regex";
+import ErrorCodes from "../../constants/error_codes";
+import { Scorm12ValidationError } from "../../exceptions";
+import { check12ValidFormat } from "../scorm12/validation";
+import * as Util from "../../utilities";
+
+/**
+ * Class representing the `cmi.core` object
+ * @extends BaseCMI
+ */
+export class CMICore extends BaseCMI {
+  /**
+   * Constructor for `cmi.core`
+   */
+  constructor() {
+    super();
+    this.score = new CMIScore({
+      score_children: APIConstants.scorm12.score_children,
+      score_range: Regex.scorm12.score_range,
+      invalidErrorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
+      invalidTypeCode: ErrorCodes.scorm12.TYPE_MISMATCH,
+      invalidRangeCode: ErrorCodes.scorm12.VALUE_OUT_OF_RANGE,
+      errorClass: Scorm12ValidationError,
+    });
+  }
+
+  public readonly score: CMIScore;
+
+  /**
+   * Called when the API has been initialized after the CMI has been created
+   */
+  initialize() {
+    super.initialize();
+    this.score?.initialize();
+  }
+
+  private __children = APIConstants.scorm12.core_children;
+  private _student_id = "";
+  private _student_name = "";
+  private _lesson_location = "";
+  private _credit = "";
+  private _lesson_status = "not attempted";
+  private _entry = "";
+  private _total_time = "";
+  private _lesson_mode = "normal";
+  private _exit = "";
+  private _session_time = "00:00:00";
+  private _suspend_data = "";
+
+  /**
+   * Getter for __children
+   * @return {string}
+   * @private
+   */
+  get _children(): string {
+    return this.__children;
+  }
+
+  /**
+   * Setter for __children. Just throws an error.
+   * @param {string} _children
+   * @private
+   */
+  set _children(_children: string) {
+    throw new Scorm12ValidationError(ErrorCodes.scorm12.INVALID_SET_VALUE);
+  }
+
+  /**
+   * Getter for _student_id
+   * @return {string}
+   */
+  get student_id(): string {
+    return this._student_id;
+  }
+
+  /**
+   * Setter for _student_id. Can only be called before  initialization.
+   * @param {string} student_id
+   */
+  set student_id(student_id: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._student_id = student_id;
+    }
+  }
+
+  /**
+   * Getter for _student_name
+   * @return {string}
+   */
+  get student_name(): string {
+    return this._student_name;
+  }
+
+  /**
+   * Setter for _student_name. Can only be called before  initialization.
+   * @param {string} student_name
+   */
+  set student_name(student_name: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._student_name = student_name;
+    }
+  }
+
+  /**
+   * Getter for _lesson_location
+   * @return {string}
+   */
+  get lesson_location(): string {
+    return this._lesson_location;
+  }
+
+  /**
+   * Setter for _lesson_location
+   * @param {string} lesson_location
+   */
+  set lesson_location(lesson_location: string) {
+    if (check12ValidFormat(lesson_location, Regex.scorm12.CMIString256, true)) {
+      this._lesson_location = lesson_location;
+    }
+  }
+
+  /**
+   * Getter for _credit
+   * @return {string}
+   */
+  get credit(): string {
+    return this._credit;
+  }
+
+  /**
+   * Setter for _credit. Can only be called before  initialization.
+   * @param {string} credit
+   */
+  set credit(credit: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._credit = credit;
+    }
+  }
+
+  /**
+   * Getter for _lesson_status
+   * @return {string}
+   */
+  get lesson_status(): string {
+    return this._lesson_status;
+  }
+
+  /**
+   * Setter for _lesson_status
+   * @param {string} lesson_status
+   */
+  set lesson_status(lesson_status: string) {
+    if (this.initialized) {
+      if (check12ValidFormat(lesson_status, Regex.scorm12.CMIStatus)) {
+        this._lesson_status = lesson_status;
+      }
+    } else {
+      if (check12ValidFormat(lesson_status, Regex.scorm12.CMIStatus2)) {
+        this._lesson_status = lesson_status;
+      }
+    }
+  }
+
+  /**
+   * Getter for _entry
+   * @return {string}
+   */
+  get entry(): string {
+    return this._entry;
+  }
+
+  /**
+   * Setter for _entry. Can only be called before  initialization.
+   * @param {string} entry
+   */
+  set entry(entry: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._entry = entry;
+    }
+  }
+
+  /**
+   * Getter for _total_time
+   * @return {string}
+   */
+  get total_time(): string {
+    return this._total_time;
+  }
+
+  /**
+   * Setter for _total_time. Can only be called before  initialization.
+   * @param {string} total_time
+   */
+  set total_time(total_time: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._total_time = total_time;
+    }
+  }
+
+  /**
+   * Getter for _lesson_mode
+   * @return {string}
+   */
+  get lesson_mode(): string {
+    return this._lesson_mode;
+  }
+
+  /**
+   * Setter for _lesson_mode. Can only be called before  initialization.
+   * @param {string} lesson_mode
+   */
+  set lesson_mode(lesson_mode: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._lesson_mode = lesson_mode;
+    }
+  }
+
+  /**
+   * Getter for _exit. Should only be called during JSON export.
+   * @return {string}
+   */
+  get exit(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._exit;
+  }
+
+  /**
+   * Setter for _exit
+   * @param {string} exit
+   */
+  set exit(exit: string) {
+    if (check12ValidFormat(exit, Regex.scorm12.CMIExit, true)) {
+      this._exit = exit;
+    }
+  }
+
+  /**
+   * Getter for _session_time. Should only be called during JSON export.
+   * @return {string}
+   */
+  get session_time(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._session_time;
+  }
+
+  /**
+   * Setter for _session_time
+   * @param {string} session_time
+   */
+  set session_time(session_time: string) {
+    if (check12ValidFormat(session_time, Regex.scorm12.CMITimespan)) {
+      this._session_time = session_time;
+    }
+  }
+
+  /**
+   * Getter for _suspend_data
+   * @return {string}
+   */
+  get suspend_data(): string {
+    return this._suspend_data;
+  }
+
+  /**
+   * Setter for _suspend_data
+   * @param {string} suspend_data
+   */
+  set suspend_data(suspend_data: string) {
+    if (check12ValidFormat(suspend_data, Regex.scorm12.CMIString4096, true)) {
+      this._suspend_data = suspend_data;
+    }
+  }
+
+  /**
+   * Adds the current session time to the existing total time.
+   * @param {number} start_time
+   * @return {string}
+   */
+  getCurrentTotalTime(start_time: number | undefined): string {
+    let sessionTime = this._session_time;
+    const startTime = start_time;
+
+    if (typeof startTime !== "undefined" && startTime !== null) {
+      const seconds = new Date().getTime() - startTime;
+      sessionTime = Util.getSecondsAsHHMMSS(seconds / 1000);
+    }
+
+    return Util.addHHMMSSTimeStrings(
+      this._total_time,
+      sessionTime,
+      new RegExp(Regex.scorm12.CMITimespan),
+    );
+  }
+
+  /**
+   * toJSON for cmi.core
+   *
+   * @return {
+   *    {
+   *      student_name: string,
+   *      entry: string,
+   *      exit: string,
+   *      score: CMIScore,
+   *      student_id: string,
+   *      lesson_mode: string,
+   *      lesson_location: string,
+   *      lesson_status: string,
+   *      credit: string,
+   *      session_time: string
+   *    }
+   *  }
+   */
+  toJSON(): {
+    student_name: string;
+    entry: string;
+    exit: string;
+    score: CMIScore;
+    student_id: string;
+    lesson_mode: string;
+    lesson_location: string;
+    lesson_status: string;
+    credit: string;
+    session_time: string;
+  } {
+    this.jsonString = true;
+    const result = {
+      student_id: this.student_id,
+      student_name: this.student_name,
+      lesson_location: this.lesson_location,
+      credit: this.credit,
+      lesson_status: this.lesson_status,
+      entry: this.entry,
+      lesson_mode: this.lesson_mode,
+      exit: this.exit,
+      session_time: this.session_time,
+      score: this.score,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}

package/src/cmi/aicc/evaluation.ts

@@ -0,0 +1,157 @@
+import { CMIArray } from "../common/array";
+import { AICCValidationError } from "../../exceptions";
+import { BaseCMI } from "../common/base_cmi";
+import APIConstants from "../../constants/api_constants";
+import ErrorCodes from "../../constants/error_codes";
+import { checkAICCValidFormat } from "./validation";
+import Regex from "../../constants/regex";
+
+/**
+ * AICC Evaluation object
+ */
+export class CMIEvaluation extends BaseCMI {
+  /**
+   * Constructor for AICC Evaluation object
+   */
+  constructor() {
+    super();
+    this.comments = new CMIEvaluationComments();
+  }
+
+  public comments: CMIEvaluationComments;
+
+  /**
+   * Called when the API has been initialized after the CMI has been created
+   */
+  initialize() {
+    super.initialize();
+    this.comments?.initialize();
+  }
+
+  /**
+   * toJSON for cmi.evaluation object
+   * @return {{comments: CMIEvaluationComments}}
+   */
+  toJSON(): {
+    comments: CMIEvaluationComments;
+  } {
+    this.jsonString = true;
+    const result = {
+      comments: this.comments,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}
+
+/**
+ * Class representing AICC's cmi.evaluation.comments object
+ */
+
+class CMIEvaluationComments extends CMIArray {
+  /**
+   * Constructor for AICC Evaluation Comments object
+   */
+  constructor() {
+    super({
+      children: APIConstants.aicc.comments_children,
+      errorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
+      errorClass: AICCValidationError,
+    });
+  }
+}
+
+/**
+ * Class for AICC Evaluation Comments
+ */
+export class CMIEvaluationCommentsObject extends BaseCMI {
+  /**
+   * Constructor for Evaluation Comments
+   */
+  constructor() {
+    super();
+  }
+
+  private _content = "";
+  private _location = "";
+  private _time = "";
+
+  /**
+   * Getter for _content
+   * @return {string}
+   */
+  get content(): string {
+    return this._content;
+  }
+
+  /**
+   * Setter for _content
+   * @param {string} content
+   */
+  set content(content: string) {
+    if (checkAICCValidFormat(content, Regex.aicc.CMIString256)) {
+      this._content = content;
+    }
+  }
+
+  /**
+   * Getter for _location
+   * @return {string}
+   */
+  get location(): string {
+    return this._location;
+  }
+
+  /**
+   * Setter for _location
+   * @param {string} location
+   */
+  set location(location: string) {
+    if (checkAICCValidFormat(location, Regex.aicc.CMIString256)) {
+      this._location = location;
+    }
+  }
+
+  /**
+   * Getter for _time
+   * @return {string}
+   */
+  get time(): string {
+    return this._time;
+  }
+
+  /**
+   * Setting for _time
+   * @param {string} time
+   */
+  set time(time: string) {
+    if (checkAICCValidFormat(time, Regex.aicc.CMITime)) {
+      this._time = time;
+    }
+  }
+
+  /**
+   * toJSON for cmi.evaluation.comments.n object
+   * @return {
+   *    {
+   *      content: string,
+   *      location: string,
+   *      time: string
+   *    }
+   *  }
+   */
+  toJSON(): {
+    content: string;
+    location: string;
+    time: string;
+  } {
+    this.jsonString = true;
+    const result = {
+      content: this.content,
+      location: this.location,
+      time: this.time,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}