scorm-again 1.7.1 → 2.0.0

package/src/constants/language_constants.ts

@@ -0,0 +1,394 @@
+const ValidLanguages: string[] = [
+  "aa",
+  "ab",
+  "ae",
+  "af",
+  "ak",
+  "am",
+  "an",
+  "ar",
+  "as",
+  "av",
+  "ay",
+  "az",
+  "ba",
+  "be",
+  "bg",
+  "bh",
+  "bi",
+  "bm",
+  "bn",
+  "bo",
+  "br",
+  "bs",
+  "ca",
+  "ce",
+  "ch",
+  "co",
+  "cr",
+  "cs",
+  "cu",
+  "cv",
+  "cy",
+  "da",
+  "de",
+  "dv",
+  "dz",
+  "ee",
+  "el",
+  "en",
+  "eo",
+  "es",
+  "et",
+  "eu",
+  "fa",
+  "ff",
+  "fi",
+  "fj",
+  "fo",
+  "fr",
+  "fy",
+  "ga",
+  "gd",
+  "gl",
+  "gn",
+  "gu",
+  "gv",
+  "ha",
+  "he",
+  "hi",
+  "ho",
+  "hr",
+  "ht",
+  "hu",
+  "hy",
+  "hz",
+  "ia",
+  "id",
+  "ie",
+  "ig",
+  "ii",
+  "ik",
+  "io",
+  "is",
+  "it",
+  "iu",
+  "ja",
+  "jv",
+  "ka",
+  "kg",
+  "ki",
+  "kj",
+  "kk",
+  "kl",
+  "km",
+  "kn",
+  "ko",
+  "kr",
+  "ks",
+  "ku",
+  "kv",
+  "kw",
+  "ky",
+  "la",
+  "lb",
+  "lg",
+  "li",
+  "ln",
+  "lo",
+  "lt",
+  "lu",
+  "lv",
+  "mg",
+  "mh",
+  "mi",
+  "mk",
+  "ml",
+  "mn",
+  "mo",
+  "mr",
+  "ms",
+  "mt",
+  "my",
+  "na",
+  "nb",
+  "nd",
+  "ne",
+  "ng",
+  "nl",
+  "nn",
+  "no",
+  "nr",
+  "nv",
+  "ny",
+  "oc",
+  "oj",
+  "om",
+  "or",
+  "os",
+  "pa",
+  "pi",
+  "pl",
+  "ps",
+  "pt",
+  "qu",
+  "rm",
+  "rn",
+  "ro",
+  "ru",
+  "rw",
+  "sa",
+  "sc",
+  "sd",
+  "se",
+  "sg",
+  "sh",
+  "si",
+  "sk",
+  "sl",
+  "sm",
+  "sn",
+  "so",
+  "sq",
+  "sr",
+  "ss",
+  "st",
+  "su",
+  "sv",
+  "sw",
+  "ta",
+  "te",
+  "tg",
+  "th",
+  "ti",
+  "tk",
+  "tl",
+  "tn",
+  "to",
+  "tr",
+  "ts",
+  "tt",
+  "tw",
+  "ty",
+  "ug",
+  "uk",
+  "ur",
+  "uz",
+  "ve",
+  "vi",
+  "vo",
+  "wa",
+  "wo",
+  "xh",
+  "yi",
+  "yo",
+  "za",
+  "zh",
+  "zu",
+  "aar",
+  "abk",
+  "ave",
+  "afr",
+  "aka",
+  "amh",
+  "arg",
+  "ara",
+  "asm",
+  "ava",
+  "aym",
+  "aze",
+  "bak",
+  "bel",
+  "bul",
+  "bih",
+  "bis",
+  "bam",
+  "ben",
+  "tib",
+  "bod",
+  "bre",
+  "bos",
+  "cat",
+  "che",
+  "cha",
+  "cos",
+  "cre",
+  "cze",
+  "ces",
+  "chu",
+  "chv",
+  "wel",
+  "cym",
+  "dan",
+  "ger",
+  "deu",
+  "div",
+  "dzo",
+  "ewe",
+  "gre",
+  "ell",
+  "eng",
+  "epo",
+  "spa",
+  "est",
+  "baq",
+  "eus",
+  "per",
+  "fas",
+  "ful",
+  "fin",
+  "fij",
+  "fao",
+  "fre",
+  "fra",
+  "fry",
+  "gle",
+  "gla",
+  "glg",
+  "grn",
+  "guj",
+  "glv",
+  "hau",
+  "heb",
+  "hin",
+  "hmo",
+  "hrv",
+  "hat",
+  "hun",
+  "arm",
+  "hye",
+  "her",
+  "ina",
+  "ind",
+  "ile",
+  "ibo",
+  "iii",
+  "ipk",
+  "ido",
+  "ice",
+  "isl",
+  "ita",
+  "iku",
+  "jpn",
+  "jav",
+  "geo",
+  "kat",
+  "kon",
+  "kik",
+  "kua",
+  "kaz",
+  "kal",
+  "khm",
+  "kan",
+  "kor",
+  "kau",
+  "kas",
+  "kur",
+  "kom",
+  "cor",
+  "kir",
+  "lat",
+  "ltz",
+  "lug",
+  "lim",
+  "lin",
+  "lao",
+  "lit",
+  "lub",
+  "lav",
+  "mlg",
+  "mah",
+  "mao",
+  "mri",
+  "mac",
+  "mkd",
+  "mal",
+  "mon",
+  "mol",
+  "mar",
+  "may",
+  "msa",
+  "mlt",
+  "bur",
+  "mya",
+  "nau",
+  "nob",
+  "nde",
+  "nep",
+  "ndo",
+  "dut",
+  "nld",
+  "nno",
+  "nor",
+  "nbl",
+  "nav",
+  "nya",
+  "oci",
+  "oji",
+  "orm",
+  "ori",
+  "oss",
+  "pan",
+  "pli",
+  "pol",
+  "pus",
+  "por",
+  "que",
+  "roh",
+  "run",
+  "rum",
+  "ron",
+  "rus",
+  "kin",
+  "san",
+  "srd",
+  "snd",
+  "sme",
+  "sag",
+  "slo",
+  "sin",
+  "slk",
+  "slv",
+  "smo",
+  "sna",
+  "som",
+  "alb",
+  "sqi",
+  "srp",
+  "ssw",
+  "sot",
+  "sun",
+  "swe",
+  "swa",
+  "tam",
+  "tel",
+  "tgk",
+  "tha",
+  "tir",
+  "tuk",
+  "tgl",
+  "tsn",
+  "ton",
+  "tur",
+  "tso",
+  "tat",
+  "twi",
+  "tah",
+  "uig",
+  "ukr",
+  "urd",
+  "uzb",
+  "ven",
+  "vie",
+  "vol",
+  "wln",
+  "wol",
+  "xho",
+  "yid",
+  "yor",
+  "zha",
+  "chi",
+  "zho",
+  "zul",
+];
+export default ValidLanguages;

package/src/constants/regex.ts

@@ -0,0 +1,97 @@
+const scorm12 = {
+  CMIString256: "^.{0,255}$",
+  CMIString4096: "^.{0,4096}$",
+  CMITime: "^(?:[01]\\d|2[0123]):(?:[012345]\\d):(?:[012345]\\d)$",
+  CMITimespan: "^([0-9]{2,}):([0-9]{2}):([0-9]{2})(.[0-9]{1,2})?$",
+
+  CMIInteger: "^\\d+$",
+  CMISInteger: "^-?([0-9]+)$",
+  CMIDecimal: "^-?([0-9]{0,3})(.[0-9]*)?$",
+
+  CMIIdentifier: "^[\\u0021-\\u007E\\s]{0,255}$",
+  CMIFeedback: "^.{0,255}$",
+  // This must be redefined
+  CMIIndex: "[._](\\d+).",
+  // Vocabulary Data Type Definition
+  CMIStatus: "^(passed|completed|failed|incomplete|browsed)$",
+  CMIStatus2: "^(passed|completed|failed|incomplete|browsed|not attempted)$",
+  CMIExit: "^(time-out|suspend|logout|)$",
+  CMIType:
+    "^(true-false|choice|fill-in|matching|performance|sequencing|likert|numeric)$",
+  CMIResult:
+    "^(correct|wrong|unanticipated|neutral|([0-9]{0,3})?(\\.[0-9]*)?)$",
+  NAVEvent: "^(previous|continue)$",
+  // Data ranges
+  score_range: "0#100",
+  audio_range: "-1#100",
+  speed_range: "-100#100",
+  weighting_range: "-100#100",
+  text_range: "-1#1",
+};
+const aicc = {
+  ...scorm12,
+  ...{
+    CMIIdentifier: "^\\w{1,255}$",
+  },
+};
+const scorm2004 = {
+  CMIString200: "^[\\u0000-\\uFFFF]{0,200}$",
+  CMIString250: "^[\\u0000-\\uFFFF]{0,250}$",
+  CMIString1000: "^[\\u0000-\\uFFFF]{0,1000}$",
+  CMIString4000: "^[\\u0000-\\uFFFF]{0,4000}$",
+  CMIString64000: "^[\\u0000-\\uFFFF]{0,64000}$",
+  CMILang: "^([a-zA-Z]{2,3}|i|x)(-[a-zA-Z0-9-]{2,8})?$|^$",
+
+  CMILangString250:
+    "^({lang=([a-zA-Z]{2,3}|i|x)(-[a-zA-Z0-9-]{2,8})?})?((?!{.*$).{0,250}$)?$",
+
+  CMILangcr: "^(({lang=([a-zA-Z]{2,3}|i|x)?(-[a-zA-Z0-9-]{2,8})?}))(.*?)$",
+
+  CMILangString250cr:
+    "^(({lang=([a-zA-Z]{2,3}|i|x)?(-[a-zA-Z0-9-]{2,8})?})?(.{0,250})?)?$",
+
+  CMILangString4000:
+    "^({lang=([a-zA-Z]{2,3}|i|x)(-[a-zA-Z0-9-]{2,8})?})?((?!{.*$).{0,4000}$)?$",
+
+  CMITime:
+    "^(19[7-9]{1}[0-9]{1}|20[0-2]{1}[0-9]{1}|203[0-8]{1})((-(0[1-9]{1}|1[0-2]{1}))((-(0[1-9]{1}|[1-2]{1}[0-9]{1}|3[0-1]{1}))(T([0-1]{1}[0-9]{1}|2[0-3]{1})((:[0-5]{1}[0-9]{1})((:[0-5]{1}[0-9]{1})((\\.[0-9]{1,2})((Z|([+|-]([0-1]{1}[0-9]{1}|2[0-3]{1})))(:[0-5]{1}[0-9]{1})?)?)?)?)?)?)?)?$",
+  CMITimespan:
+    "^P(?:([.,\\d]+)Y)?(?:([.,\\d]+)M)?(?:([.,\\d]+)W)?(?:([.,\\d]+)D)?(?:T?(?:([.,\\d]+)H)?(?:([.,\\d]+)M)?(?:([.,\\d]+)S)?)?$",
+  CMIInteger: "^\\d+$",
+  CMISInteger: "^-?([0-9]+)$",
+  CMIDecimal: "^-?([0-9]{1,5})(\\.[0-9]{1,18})?$",
+  CMIIdentifier: "^\\S{1,250}[a-zA-Z0-9]$",
+  CMIShortIdentifier: "^[\\w\\.\\-\\_]{1,250}$",
+  CMILongIdentifier:
+    "^(?:(?!urn:)\\S{1,4000}|urn:[A-Za-z0-9-]{1,31}:\\S{1,4000}|.{1,4000})$",
+  // need to re-examine this
+  CMIFeedback: "^.*$",
+  // This must be redefined
+  CMIIndex: "[._](\\d+).",
+  CMIIndexStore: ".N(\\d+).",
+  // Vocabulary Data Type Definition
+  CMICStatus: "^(completed|incomplete|not attempted|unknown)$",
+  CMISStatus: "^(passed|failed|unknown)$",
+  CMIExit: "^(time-out|suspend|logout|normal)$",
+  CMIType:
+    "^(true-false|choice|fill-in|long-fill-in|matching|performance|sequencing|likert|numeric|other)$",
+  CMIResult:
+    "^(correct|incorrect|unanticipated|neutral|-?([0-9]{1,4})(\\.[0-9]{1,18})?)$",
+  NAVEvent:
+    "^(previous|continue|exit|exitAll|abandon|abandonAll|suspendAll|{target=\\S{0,200}[a-zA-Z0-9]}choice|jump)$",
+
+  NAVBoolean: "^(unknown|true|false$)",
+  NAVTarget: "^(previous|continue|choice.{target=\\S{0,200}[a-zA-Z0-9]})$",
+  // Data ranges
+  scaled_range: "-1#1",
+  audio_range: "0#*",
+  speed_range: "0#*",
+  text_range: "-1#1",
+  progress_range: "0#1",
+};
+const Regex = {
+  aicc: aicc,
+  scorm12: scorm12,
+  scorm2004: scorm2004,
+};
+export default Regex;

package/src/constants/{response_constants.js → response_constants.ts}

@@ -1,151 +1,148 @@
-// @flow
-import Regex from './regex';
+import Regex from "./regex";
 
 const scorm2004_regex = Regex.scorm2004;
-
-const learner = {
-  'true-false': {
-    format: '^true$|^false$',
+export const LearnerResponses: Responses = {
+  "true-false": {
+    format: "^true$|^false$",
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
   },
-  'choice': {
+  choice: {
     format: scorm2004_regex.CMILongIdentifier,
     max: 36,
-    delimiter: '[,]',
+    delimiter: "[,]",
     unique: true,
   },
-  'fill-in': {
+  "fill-in": {
     format: scorm2004_regex.CMILangString250,
     max: 10,
-    delimiter: '[,]',
+    delimiter: "[,]",
     unique: false,
   },
-  'long-fill-in': {
+  "long-fill-in": {
     format: scorm2004_regex.CMILangString4000,
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
   },
-  'matching': {
+  matching: {
     format: scorm2004_regex.CMIShortIdentifier,
     format2: scorm2004_regex.CMIShortIdentifier,
     max: 36,
-    delimiter: '[,]',
-    delimiter2: '[.]',
+    delimiter: "[,]",
+    delimiter2: "[.]",
     unique: false,
   },
-  'performance': {
-    format: '^$|' + scorm2004_regex.CMIShortIdentifier,
-    format2: scorm2004_regex.CMIDecimal + '|^$|' +
-        scorm2004_regex.CMIShortIdentifier,
+  performance: {
+    format: "^$|" + scorm2004_regex.CMIShortIdentifier,
+    format2:
+      scorm2004_regex.CMIDecimal + "|^$|" + scorm2004_regex.CMIShortIdentifier,
     max: 250,
-    delimiter: '[,]',
-    delimiter2: '[.]',
+    delimiter: "[,]",
+    delimiter2: "[.]",
     unique: false,
   },
-  'sequencing': {
+  sequencing: {
     format: scorm2004_regex.CMIShortIdentifier,
     max: 36,
-    delimiter: '[,]',
+    delimiter: "[,]",
     unique: false,
   },
-  'likert': {
+  likert: {
     format: scorm2004_regex.CMIShortIdentifier,
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
   },
-  'numeric': {
+  numeric: {
     format: scorm2004_regex.CMIDecimal,
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
   },
-  'other': {
+  other: {
     format: scorm2004_regex.CMIString4000,
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
   },
 };
-
-const correct = {
-  'true-false': {
+export const CorrectResponses: Responses = {
+  "true-false": {
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
     duplicate: false,
-    format: '^true$|^false$',
+    format: "^true$|^false$",
     limit: 1,
   },
-  'choice': {
+  choice: {
     max: 36,
-    delimiter: '[,]',
+    delimiter: "[,]",
     unique: true,
     duplicate: false,
     format: scorm2004_regex.CMILongIdentifier,
   },
-  'fill-in': {
+  "fill-in": {
     max: 10,
-    delimiter: '[,]',
+    delimiter: "[,]",
     unique: false,
     duplicate: false,
     format: scorm2004_regex.CMILangString250cr,
   },
-  'long-fill-in': {
+  "long-fill-in": {
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
     duplicate: true,
     format: scorm2004_regex.CMILangString4000,
   },
-  'matching': {
+  matching: {
     max: 36,
-    delimiter: '[,]',
-    delimiter2: '[.]',
+    delimiter: "[,]",
+    delimiter2: "[.]",
     unique: false,
     duplicate: false,
     format: scorm2004_regex.CMIShortIdentifier,
     format2: scorm2004_regex.CMIShortIdentifier,
   },
-  'performance': {
+  performance: {
     max: 250,
-    delimiter: '[,]',
-    delimiter2: '[.]',
+    delimiter: "[,]",
+    delimiter2: "[.]",
     unique: false,
     duplicate: false,
-    format: '^$|' + scorm2004_regex.CMIShortIdentifier,
-    format2: scorm2004_regex.CMIDecimal + '|^$|' +
-        scorm2004_regex.CMIShortIdentifier,
+    format: "^$|" + scorm2004_regex.CMIShortIdentifier,
+    format2:
+      scorm2004_regex.CMIDecimal + "|^$|" + scorm2004_regex.CMIShortIdentifier,
   },
-  'sequencing': {
+  sequencing: {
     max: 36,
-    delimiter: '[,]',
+    delimiter: "[,]",
     unique: false,
     duplicate: false,
     format: scorm2004_regex.CMIShortIdentifier,
   },
-  'likert': {
+  likert: {
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
     duplicate: false,
     format: scorm2004_regex.CMIShortIdentifier,
     limit: 1,
   },
-  'numeric': {
+  numeric: {
     max: 2,
-    delimiter: '[:]',
+    delimiter: "[:]",
     unique: false,
     duplicate: false,
     format: scorm2004_regex.CMIDecimal,
     limit: 1,
   },
-  'other': {
+  other: {
     max: 1,
-    delimiter: '',
+    delimiter: "",
     unique: false,
     duplicate: false,
     format: scorm2004_regex.CMIString4000,
@@ -153,9 +150,17 @@ const correct = {
   },
 };
 
-const Responses = {
-  learner: learner,
-  correct: correct,
+export type ResponseType = {
+  format: string;
+  max: number;
+  delimiter: string;
+  unique: boolean;
+  duplicate?: boolean;
+  format2?: string;
+  delimiter2?: string;
+  limit?: number;
 };
 
-export default Responses;
+export type Responses = {
+  [key: string]: ResponseType;
+};