scorm-again 1.7.1 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (124) hide show
  1. package/.babelrc +18 -7
  2. package/.github/dependabot.yml +5 -0
  3. package/.github/workflows/main.yml +79 -0
  4. package/.github/workflows/stale.yml +14 -0
  5. package/.jsdoc.json +4 -5
  6. package/.mocharc.json +8 -0
  7. package/.run/{Mocha Unit Tests.run.xml → Mocha Unit Tests (watch).run.xml } +6 -3
  8. package/.run/Template Mocha.run.xml +17 -0
  9. package/CONTRIBUTING.md +1 -1
  10. package/README.md +183 -71
  11. package/dist/aicc.js +3822 -7030
  12. package/dist/aicc.js.map +1 -1
  13. package/dist/aicc.min.js +2 -40
  14. package/dist/aicc.min.js.map +1 -0
  15. package/dist/scorm-again.js +5965 -10498
  16. package/dist/scorm-again.js.map +1 -1
  17. package/dist/scorm-again.min.js +2 -52
  18. package/dist/scorm-again.min.js.map +1 -0
  19. package/dist/scorm12.js +3028 -5373
  20. package/dist/scorm12.js.map +1 -1
  21. package/dist/scorm12.min.js +2 -34
  22. package/dist/scorm12.min.js.map +1 -0
  23. package/dist/scorm2004.js +4054 -6693
  24. package/dist/scorm2004.js.map +1 -1
  25. package/dist/scorm2004.min.js +2 -40
  26. package/dist/scorm2004.min.js.map +1 -0
  27. package/eslint.config.js +21 -0
  28. package/package.json +76 -34
  29. package/results.json +34254 -0
  30. package/src/AICC.ts +72 -0
  31. package/src/BaseAPI.ts +1300 -0
  32. package/src/Scorm12API.ts +387 -0
  33. package/src/Scorm2004API.ts +688 -0
  34. package/src/cmi/aicc/attempts.ts +94 -0
  35. package/src/cmi/aicc/cmi.ts +100 -0
  36. package/src/cmi/aicc/core.ts +360 -0
  37. package/src/cmi/aicc/evaluation.ts +157 -0
  38. package/src/cmi/aicc/paths.ts +180 -0
  39. package/src/cmi/aicc/student_data.ts +86 -0
  40. package/src/cmi/aicc/student_demographics.ts +367 -0
  41. package/src/cmi/aicc/student_preferences.ts +176 -0
  42. package/src/cmi/aicc/tries.ts +116 -0
  43. package/src/cmi/aicc/validation.ts +25 -0
  44. package/src/cmi/common/array.ts +77 -0
  45. package/src/cmi/common/base_cmi.ts +46 -0
  46. package/src/cmi/common/score.ts +203 -0
  47. package/src/cmi/common/validation.ts +60 -0
  48. package/src/cmi/scorm12/cmi.ts +224 -0
  49. package/src/cmi/scorm12/interactions.ts +368 -0
  50. package/src/cmi/scorm12/nav.ts +54 -0
  51. package/src/cmi/scorm12/objectives.ts +112 -0
  52. package/src/cmi/scorm12/student_data.ts +130 -0
  53. package/src/cmi/scorm12/student_preference.ts +158 -0
  54. package/src/cmi/scorm12/validation.ts +48 -0
  55. package/src/cmi/scorm2004/adl.ts +272 -0
  56. package/src/cmi/scorm2004/cmi.ts +599 -0
  57. package/src/cmi/scorm2004/comments.ts +163 -0
  58. package/src/cmi/scorm2004/interactions.ts +466 -0
  59. package/src/cmi/scorm2004/learner_preference.ts +152 -0
  60. package/src/cmi/scorm2004/objectives.ts +212 -0
  61. package/src/cmi/scorm2004/score.ts +78 -0
  62. package/src/cmi/scorm2004/validation.ts +42 -0
  63. package/src/constants/api_constants.ts +318 -0
  64. package/src/constants/default_settings.ts +81 -0
  65. package/src/constants/enums.ts +5 -0
  66. package/src/constants/error_codes.ts +88 -0
  67. package/src/constants/language_constants.ts +394 -0
  68. package/src/constants/regex.ts +97 -0
  69. package/src/constants/{response_constants.js → response_constants.ts} +69 -62
  70. package/src/exceptions.ts +154 -0
  71. package/src/exports/aicc.js +1 -1
  72. package/src/exports/scorm-again.js +3 -3
  73. package/src/exports/scorm12.js +1 -1
  74. package/src/exports/scorm2004.js +1 -1
  75. package/src/helpers/scheduled_commit.ts +42 -0
  76. package/src/interfaces/IBaseAPI.ts +35 -0
  77. package/src/types/api_types.ts +32 -0
  78. package/src/utilities/debounce.ts +31 -0
  79. package/src/utilities.ts +338 -0
  80. package/tea.yaml +6 -0
  81. package/test/{AICC.spec.js → AICC.spec.ts} +79 -71
  82. package/test/Scorm12API.spec.ts +833 -0
  83. package/test/Scorm2004API.spec.ts +1298 -0
  84. package/test/api_helpers.ts +176 -0
  85. package/test/cmi/aicc_cmi.spec.ts +845 -0
  86. package/test/cmi/{scorm12_cmi.spec.js → scorm12_cmi.spec.ts} +253 -271
  87. package/test/cmi/scorm2004_cmi.spec.ts +1031 -0
  88. package/test/cmi_helpers.ts +207 -0
  89. package/test/exceptions.spec.ts +79 -0
  90. package/test/field_values.ts +202 -0
  91. package/test/types/api_types.spec.ts +126 -0
  92. package/test/utilities/debounce.spec.ts +56 -0
  93. package/test/utilities.spec.ts +322 -0
  94. package/tsconfig.json +18 -0
  95. package/webpack.config.js +65 -0
  96. package/.circleci/config.yml +0 -99
  97. package/.codeclimate.yml +0 -7
  98. package/.eslintrc.js +0 -36
  99. package/src/.flowconfig +0 -11
  100. package/src/AICC.js +0 -68
  101. package/src/BaseAPI.js +0 -1275
  102. package/src/Scorm12API.js +0 -308
  103. package/src/Scorm2004API.js +0 -572
  104. package/src/cmi/aicc_cmi.js +0 -1141
  105. package/src/cmi/common.js +0 -328
  106. package/src/cmi/scorm12_cmi.js +0 -1312
  107. package/src/cmi/scorm2004_cmi.js +0 -1692
  108. package/src/constants/api_constants.js +0 -218
  109. package/src/constants/error_codes.js +0 -87
  110. package/src/constants/language_constants.js +0 -76
  111. package/src/constants/regex.js +0 -84
  112. package/src/exceptions.js +0 -104
  113. package/src/utilities.js +0 -242
  114. package/test/Scorm12API.spec.js +0 -528
  115. package/test/Scorm2004API.spec.js +0 -775
  116. package/test/abstract_classes.spec.js +0 -17
  117. package/test/api_helpers.js +0 -128
  118. package/test/cmi/aicc_cmi.spec.js +0 -684
  119. package/test/cmi/scorm2004_cmi.spec.js +0 -1066
  120. package/test/cmi_helpers.js +0 -161
  121. package/test/exceptions.spec.js +0 -71
  122. package/test/field_values.js +0 -353
  123. package/test/utilities.spec.js +0 -339
  124. package/webpack.js +0 -78
@@ -1,17 +0,0 @@
1
- import {describe, it} from 'mocha';
2
- import {expect} from 'chai';
3
- import BaseAPI from '../src/BaseAPI';
4
- import {BaseCMI} from '../src/cmi/common';
5
-
6
- describe('Abstract Class Tests', () => {
7
- it('BaseAPI should not be instantiated', () => {
8
- expect(
9
- () => new BaseAPI(),
10
- ).to.throw('Cannot construct BaseAPI instances directly');
11
- });
12
- it('BaseCMI should not be instantiated', () => {
13
- expect(
14
- () => new BaseCMI(),
15
- ).to.throw('Cannot construct BaseCMI instances directly');
16
- });
17
- });
@@ -1,128 +0,0 @@
1
- import {describe, it} from 'mocha';
2
- import {expect} from 'chai';
3
-
4
- export const checkValidValues = (
5
- {
6
- api,
7
- fieldName,
8
- validValues,
9
- invalidValues,
10
- }) => {
11
- describe(`Field: ${fieldName}`, () => {
12
- for (const idx in validValues) {
13
- if ({}.hasOwnProperty.call(validValues, idx)) {
14
- it(`Should successfully write '${validValues[idx]}' to ${fieldName}`,
15
- () => {
16
- expect(api.lmsSetValue(fieldName, validValues[idx])).
17
- to.equal('true');
18
- });
19
- }
20
- }
21
-
22
- for (const idx in invalidValues) {
23
- if ({}.hasOwnProperty.call(invalidValues, idx)) {
24
- it(`Should fail to write '${invalidValues[idx]}' to ${fieldName}`,
25
- () => {
26
- expect(api.lmsSetValue(fieldName, invalidValues[idx])).
27
- to.equal('false');
28
- });
29
- }
30
- }
31
- });
32
- };
33
-
34
- export const checkLMSSetValue = (
35
- {
36
- api,
37
- fieldName,
38
- valueToTest = 'xxx',
39
- expectedError = 0,
40
- errorThrown = false,
41
- }) => {
42
- describe(`Field: ${fieldName}`, () => {
43
- const status = expectedError > 0 ? 'fail to' : 'successfully';
44
- it(`Should ${status} set value for ${fieldName}`, () => {
45
- if (expectedError > 0) {
46
- if (errorThrown) {
47
- expect(() => api.lmsSetValue(fieldName, valueToTest)).
48
- to.throw().with.property('errorCode', expectedError);
49
- } else {
50
- api.lmsSetValue(fieldName, valueToTest);
51
- expect(String(api.lmsGetLastError())).to.equal(String(expectedError));
52
- }
53
- } else {
54
- if (errorThrown) {
55
- expect(() => api.lmsSetValue(fieldName, valueToTest)).
56
- to.not.throw();
57
- } else {
58
- api.lmsSetValue(fieldName, valueToTest);
59
- expect(String(api.lmsGetLastError())).to.equal(String(0));
60
- }
61
- }
62
- });
63
- });
64
- };
65
-
66
- export const checkLMSGetValue = (
67
- {
68
- api,
69
- fieldName,
70
- expectedValue = '',
71
- initializeFirst = false,
72
- initializationValue = '',
73
- expectedError = 0,
74
- errorThrown = false,
75
- }) => {
76
- describe(`Field: ${fieldName}`, () => {
77
- const status = expectedError > 0 ? 'fail to' : 'successfully';
78
-
79
- if (initializeFirst) {
80
- api.setCMIValue(fieldName, initializationValue);
81
- }
82
-
83
- it(`Should ${status} get value for ${fieldName}`, () => {
84
- if (expectedError > 0) {
85
- if (errorThrown) {
86
- expect(() => api.lmsGetValue(fieldName)).
87
- to.throw().with.property('errorCode', expectedError);
88
- } else {
89
- api.lmsGetValue(fieldName);
90
- expect(String(api.lmsGetLastError())).to.equal(String(expectedError));
91
- }
92
- } else {
93
- expect(api.lmsGetValue(fieldName)).to.equal(expectedValue);
94
- }
95
- });
96
- });
97
- };
98
-
99
- export const checkSetCMIValue = (
100
- {
101
- api,
102
- fieldName,
103
- valueToTest = 'xxx',
104
- expectedError = 0,
105
- errorThrown = true,
106
- }) => {
107
- describe(`Field: ${fieldName}`, () => {
108
- const status = expectedError > 0 ? 'fail to' : 'successfully';
109
- it(`Should ${status} set CMI value for ${fieldName}`, () => {
110
- if (expectedError > 0) {
111
- if (errorThrown) {
112
- expect(() => api.setCMIValue(fieldName, valueToTest)).
113
- to.throw().with.property('errorCode', expectedError);
114
- } else {
115
- api.setCMIValue(fieldName, valueToTest);
116
- expect(String(api.lmsGetLastError())).to.equal(String(expectedError));
117
- }
118
- } else {
119
- if (errorThrown) {
120
- expect(() => api.setCMIValue(fieldName, valueToTest)).to.not.throw();
121
- } else {
122
- api.setCMIValue(fieldName, valueToTest);
123
- expect(String(api.lmsGetLastError())).to.equal(String(0));
124
- }
125
- }
126
- });
127
- });
128
- };