scorm-again 2.0.0 → 2.1.0

package/src/cmi/scorm12/cmi.ts

@@ -0,0 +1,224 @@
+import APIConstants from "../../constants/api_constants";
+import ErrorCodes from "../../constants/error_codes";
+import Regex from "../../constants/regex";
+import { Scorm12ValidationError } from "../../exceptions";
+import { BaseRootCMI } from "../common/base_cmi";
+import { check12ValidFormat } from "./validation";
+import { CMICore } from "../aicc/core";
+import { CMIObjectives } from "./objectives";
+import { CMIStudentData } from "./student_data";
+import { CMIStudentPreference } from "./student_preference";
+import { CMIInteractions } from "./interactions";
+
+/**
+ * Class representing the cmi object for SCORM 1.2
+ */
+export class CMI extends BaseRootCMI {
+  private readonly __children: string = "";
+  private __version: string = "3.4";
+  private _launch_data: string = "";
+  private _comments: string = "";
+  private _comments_from_lms: string = "";
+
+  /**
+   * Constructor for the SCORM 1.2 cmi object
+   * @param {string} cmi_children
+   * @param {(CMIStudentData|AICCCMIStudentData)} student_data
+   * @param {boolean} initialized
+   */
+  constructor(
+    cmi_children?: string,
+    student_data?: CMIStudentData,
+    initialized?: boolean,
+  ) {
+    super();
+    if (initialized) this.initialize();
+    this.__children = cmi_children
+      ? cmi_children
+      : APIConstants.scorm12.cmi_children;
+    this.core = new CMICore();
+    this.objectives = new CMIObjectives();
+    this.student_data = student_data ? student_data : new CMIStudentData();
+    this.student_preference = new CMIStudentPreference();
+    this.interactions = new CMIInteractions();
+  }
+
+  public core: CMICore;
+  public objectives: CMIObjectives;
+  public student_data: CMIStudentData;
+  public student_preference: CMIStudentPreference;
+  public interactions: CMIInteractions;
+
+  /**
+   * Called when the API has been initialized after the CMI has been created
+   */
+  initialize() {
+    super.initialize();
+    this.core?.initialize();
+    this.objectives?.initialize();
+    this.student_data?.initialize();
+    this.student_preference?.initialize();
+    this.interactions?.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
+   *    }
+   *  }
+   */
+  toJSON(): {
+    suspend_data: string;
+    launch_data: string;
+    comments: string;
+    comments_from_lms: string;
+    core: CMICore;
+    objectives: CMIObjectives;
+    student_data: CMIStudentData;
+    student_preference: CMIStudentPreference;
+    interactions: CMIInteractions;
+  } {
+    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,
+      interactions: this.interactions,
+    };
+    delete this.jsonString;
+    return result;
+  }
+
+  /**
+   * Getter for __version
+   * @return {string}
+   */
+  get _version(): string {
+    return this.__version;
+  }
+
+  /**
+   * Setter for __version. Just throws an error.
+   * @param {string} _version
+   */
+  set _version(_version: string) {
+    throw new Scorm12ValidationError(ErrorCodes.scorm12.INVALID_SET_VALUE);
+  }
+
+  /**
+   * Getter for __children
+   * @return {string}
+   */
+  get _children(): string {
+    return this.__children;
+  }
+
+  /**
+   * Setter for __version. Just throws an error.
+   * @param {string} _children
+   */
+  set _children(_children: string) {
+    throw new Scorm12ValidationError(ErrorCodes.scorm12.INVALID_SET_VALUE);
+  }
+
+  /**
+   * Getter for _suspend_data
+   * @return {string}
+   */
+  get suspend_data(): string {
+    return this.core?.suspend_data;
+  }
+
+  /**
+   * Setter for _suspend_data
+   * @param {string} suspend_data
+   */
+  set suspend_data(suspend_data: string) {
+    if (this.core) {
+      this.core.suspend_data = suspend_data;
+    }
+  }
+
+  /**
+   * Getter for _launch_data
+   * @return {string}
+   */
+  get launch_data(): string {
+    return this._launch_data;
+  }
+
+  /**
+   * Setter for _launch_data. Can only be called before  initialization.
+   * @param {string} launch_data
+   */
+  set launch_data(launch_data: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._launch_data = launch_data;
+    }
+  }
+
+  /**
+   * Getter for _comments
+   * @return {string}
+   */
+  get comments(): string {
+    return this._comments;
+  }
+
+  /**
+   * Setter for _comments
+   * @param {string} comments
+   */
+  set comments(comments: string) {
+    if (check12ValidFormat(comments, Regex.scorm12.CMIString4096, true)) {
+      this._comments = comments;
+    }
+  }
+
+  /**
+   * Getter for _comments_from_lms
+   * @return {string}
+   */
+  get comments_from_lms(): string {
+    return this._comments_from_lms;
+  }
+
+  /**
+   * Setter for _comments_from_lms. Can only be called before  initialization.
+   * @param {string} comments_from_lms
+   */
+  set comments_from_lms(comments_from_lms: string) {
+    if (this.initialized) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.READ_ONLY_ELEMENT);
+    } else {
+      this._comments_from_lms = comments_from_lms;
+    }
+  }
+
+  /**
+   * Adds the current session time to the existing total time.
+   *
+   * @return {string}
+   */
+  getCurrentTotalTime(): string {
+    return this.core.getCurrentTotalTime(this.start_time);
+  }
+}

package/src/cmi/scorm12/interactions.ts

@@ -0,0 +1,368 @@
+import { CMIArray } from "../common/array";
+import APIConstants from "../../constants/api_constants";
+import ErrorCodes from "../../constants/error_codes";
+import { Scorm12ValidationError } from "../../exceptions";
+import { BaseCMI } from "../common/base_cmi";
+import { check12ValidFormat, check12ValidRange } from "./validation";
+import Regex from "../../constants/regex";
+
+/**
+ * Class representing the SCORM 1.2 `cmi.interactions`
+ * @extends CMIArray
+ */
+export class CMIInteractions extends CMIArray {
+  /**
+   * Constructor for `cmi.interactions`
+   */
+  constructor() {
+    super({
+      children: APIConstants.scorm12.interactions_children,
+      errorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
+      errorClass: Scorm12ValidationError,
+    });
+  }
+}
+
+/**
+ * Class representing SCORM 1.2's cmi.interactions.n object
+ * @extends BaseCMI
+ */
+export class CMIInteractionsObject extends BaseCMI {
+  /**
+   * Constructor for cmi.interactions.n object
+   */
+  constructor() {
+    super();
+    this.objectives = new CMIArray({
+      errorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
+      errorClass: Scorm12ValidationError,
+      children: APIConstants.scorm12.objectives_children,
+    });
+    this.correct_responses = new CMIArray({
+      errorCode: ErrorCodes.scorm12.INVALID_SET_VALUE,
+      errorClass: Scorm12ValidationError,
+      children: APIConstants.scorm12.correct_responses_children,
+    });
+  }
+
+  public readonly objectives: CMIArray;
+  public readonly correct_responses: CMIArray;
+
+  /**
+   * Called when the API has been initialized after the CMI has been created
+   */
+  initialize() {
+    super.initialize();
+    this.objectives?.initialize();
+    this.correct_responses?.initialize();
+  }
+
+  private _id = "";
+  private _time = "";
+  private _type = "";
+  private _weighting = "";
+  private _student_response = "";
+  private _result = "";
+  private _latency = "";
+
+  /**
+   * Getter for _id. Should only be called during JSON export.
+   * @return {string}
+   */
+  get id(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._id;
+  }
+
+  /**
+   * Setter for _id
+   * @param {string} id
+   */
+  set id(id: string) {
+    if (check12ValidFormat(id, Regex.scorm12.CMIIdentifier)) {
+      this._id = id;
+    }
+  }
+
+  /**
+   * Getter for _time. Should only be called during JSON export.
+   * @return {string}
+   */
+  get time(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._time;
+  }
+
+  /**
+   * Setter for _time
+   * @param {string} time
+   */
+  set time(time: string) {
+    if (check12ValidFormat(time, Regex.scorm12.CMITime)) {
+      this._time = time;
+    }
+  }
+
+  /**
+   * Getter for _type. Should only be called during JSON export.
+   * @return {string}
+   */
+  get type(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._type;
+  }
+
+  /**
+   * Setter for _type
+   * @param {string} type
+   */
+  set type(type: string) {
+    if (check12ValidFormat(type, Regex.scorm12.CMIType)) {
+      this._type = type;
+    }
+  }
+
+  /**
+   * Getter for _weighting. Should only be called during JSON export.
+   * @return {string}
+   */
+  get weighting(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._weighting;
+  }
+
+  /**
+   * Setter for _weighting
+   * @param {string} weighting
+   */
+  set weighting(weighting: string) {
+    if (
+      check12ValidFormat(weighting, Regex.scorm12.CMIDecimal) &&
+      check12ValidRange(weighting, Regex.scorm12.weighting_range)
+    ) {
+      this._weighting = weighting;
+    }
+  }
+
+  /**
+   * Getter for _student_response. Should only be called during JSON export.
+   * @return {string}
+   */
+  get student_response(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._student_response;
+  }
+
+  /**
+   * Setter for _student_response
+   * @param {string} student_response
+   */
+  set student_response(student_response: string) {
+    if (check12ValidFormat(student_response, Regex.scorm12.CMIFeedback, true)) {
+      this._student_response = student_response;
+    }
+  }
+
+  /**
+   * Getter for _result. Should only be called during JSON export.
+   * @return {string}
+   */
+  get result(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._result;
+  }
+
+  /**
+   * Setter for _result
+   * @param {string} result
+   */
+  set result(result: string) {
+    if (check12ValidFormat(result, Regex.scorm12.CMIResult)) {
+      this._result = result;
+    }
+  }
+
+  /**
+   * Getter for _latency. Should only be called during JSON export.
+   * @return {string}
+   */
+  get latency(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._latency;
+  }
+
+  /**
+   * Setter for _latency
+   * @param {string} latency
+   */
+  set latency(latency: string) {
+    if (check12ValidFormat(latency, Regex.scorm12.CMITimespan)) {
+      this._latency = latency;
+    }
+  }
+
+  /**
+   * toJSON for cmi.interactions.n
+   *
+   * @return {
+   *    {
+   *      id: string,
+   *      time: string,
+   *      type: string,
+   *      weighting: string,
+   *      student_response: string,
+   *      result: string,
+   *      latency: string,
+   *      objectives: CMIArray,
+   *      correct_responses: CMIArray
+   *    }
+   *  }
+   */
+  toJSON(): {
+    id: string;
+    time: string;
+    type: string;
+    weighting: string;
+    student_response: string;
+    result: string;
+    latency: string;
+    objectives: CMIArray;
+    correct_responses: CMIArray;
+  } {
+    this.jsonString = true;
+    const result = {
+      id: this.id,
+      time: this.time,
+      type: this.type,
+      weighting: this.weighting,
+      student_response: this.student_response,
+      result: this.result,
+      latency: this.latency,
+      objectives: this.objectives,
+      correct_responses: this.correct_responses,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}
+
+/**
+ * Class representing SCORM 1.2's cmi.interactions.n.objectives.n object
+ * @extends BaseCMI
+ */
+export class CMIInteractionsObjectivesObject extends BaseCMI {
+  /**
+   * Constructor for cmi.interactions.n.objectives.n
+   */
+  constructor() {
+    super();
+  }
+
+  private _id = "";
+
+  /**
+   * Getter for _id
+   * @return {string}
+   */
+  get id(): string {
+    return this._id;
+  }
+
+  /**
+   * Setter for _id
+   * @param {string} id
+   */
+  set id(id: string) {
+    if (check12ValidFormat(id, Regex.scorm12.CMIIdentifier)) {
+      this._id = id;
+    }
+  }
+
+  /**
+   * toJSON for cmi.interactions.n.objectives.n
+   * @return {
+   *    {
+   *      id: string
+   *    }
+   *  }
+   */
+  toJSON(): {
+    id: string;
+  } {
+    this.jsonString = true;
+    const result = {
+      id: this.id,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}
+
+/**
+ * Class representing SCORM 1.2's cmi.interactions.correct_responses.n object
+ * @extends BaseCMI
+ */
+export class CMIInteractionsCorrectResponsesObject extends BaseCMI {
+  /**
+   * Constructor for cmi.interactions.correct_responses.n
+   */
+  constructor() {
+    super();
+  }
+
+  private _pattern = "";
+
+  /**
+   * Getter for _pattern
+   * @return {string}
+   */
+  get pattern(): string {
+    if (!this.jsonString) {
+      throw new Scorm12ValidationError(ErrorCodes.scorm12.WRITE_ONLY_ELEMENT);
+    }
+    return this._pattern;
+  }
+
+  /**
+   * Setter for _pattern
+   * @param {string} pattern
+   */
+  set pattern(pattern: string) {
+    if (check12ValidFormat(pattern, Regex.scorm12.CMIFeedback, true)) {
+      this._pattern = pattern;
+    }
+  }
+
+  /**
+   * toJSON for cmi.interactions.correct_responses.n
+   * @return {
+   *    {
+   *      pattern: string
+   *    }
+   *  }
+   */
+  toJSON(): {
+    pattern: string;
+  } {
+    this.jsonString = true;
+    const result = {
+      pattern: this._pattern,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}

package/src/cmi/scorm12/nav.ts

@@ -0,0 +1,54 @@
+import {BaseCMI} from "../common/base_cmi";
+import {check12ValidFormat} from "./validation";
+import Regex from "../../constants/regex";
+
+/**
+ * Class for AICC Navigation object
+ */
+export class NAV extends BaseCMI {
+  /**
+   * Constructor for NAV object
+   */
+  constructor() {
+    super();
+  }
+
+  private _event = "";
+
+  /**
+   * Getter for _event
+   * @return {string}
+   */
+  get event(): string {
+    return this._event;
+  }
+
+  /**
+   * Setter for _event
+   * @param {string} event
+   */
+  set event(event: string) {
+    if (check12ValidFormat(event, Regex.scorm12.NAVEvent)) {
+      this._event = event;
+    }
+  }
+
+  /**
+   * toJSON for nav object
+   * @return {
+   *    {
+   *      event: string
+   *    }
+   *  }
+   */
+  toJSON(): {
+    event: string;
+  } {
+    this.jsonString = true;
+    const result = {
+      event: this.event,
+    };
+    delete this.jsonString;
+    return result;
+  }
+}