scorm-again 1.6.1 → 1.7.0

package/package.json

@@ -1,50 +1,58 @@
 {
   "name": "scorm-again",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "A modern SCORM JavaScript run-time library for AICC, SCORM 1.2, and SCORM 2004",
   "main": "dist/scorm-again.min.js",
+  "browserslist": [
+    "> 1%",
+    "edge >= 16",
+    "safari >= 9",
+    "firefox >= 57",
+    "ie >= 11",
+    "ios >= 9",
+    "chrome >= 49"
+  ],
   "directories": {
     "test": "test"
   },
   "devDependencies": {
-    "@babel/cli": "^7.15.4",
-    "@babel/core": "^7.15.5",
-    "@babel/node": "^7.15.4",
-    "@babel/plugin-proposal-class-properties": "^7.14.5",
-    "@babel/plugin-proposal-optional-chaining": "^7.14.5",
-    "@babel/plugin-proposal-private-methods": "^7.14.5",
-    "@babel/preset-env": "^7.15.4",
-    "@babel/preset-flow": "^7.14.5",
-    "@babel/register": "^7.15.3",
-    "@types/chai": "^4.2.21",
-    "@types/mocha": "^9.0.0",
+    "@babel/cli": "^7.17.0",
+    "@babel/core": "^7.17.2",
+    "@babel/node": "^7.16.8",
+    "@babel/plugin-proposal-class-properties": "^7.16.7",
+    "@babel/plugin-proposal-optional-chaining": "^7.16.7",
+    "@babel/plugin-proposal-private-methods": "^7.16.11",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-flow": "^7.16.7",
+    "@babel/register": "^7.17.0",
+    "@types/chai": "^4.3.0",
+    "@types/mocha": "^9.1.0",
     "babel-eslint": "^11.0.0-beta.2",
+    "babel-loader": "^8.2.3",
     "babelify": "^10.0.0",
     "browserify": "^17.0.0",
-    "chai": "^4.3.4",
-    "eslint": "^7.32.0",
+    "chai": "^4.3.6",
+    "eslint": "^8.8.0",
     "eslint-config-google": "^0.14.0",
-    "eslint-plugin-import": "^2.24.2",
+    "eslint-plugin-import": "^2.25.4",
+    "eslint-webpack-plugin": "^3.1.1",
     "fetch-pretender": "^1.5.0",
-    "grunt": "^1.4.1",
-    "grunt-browserify": "^6.0.0",
-    "grunt-cli": "^1.4.3",
-    "grunt-contrib-watch": "^1.1.0",
-    "grunt-mocha-test": "^0.13.3",
-    "jsdoc": "^3.6.7",
+    "jsdoc": "^3.6.10",
     "jsdoc-babel": "^0.5.0",
     "lodash.debounce": "^4.0.8",
     "minimist": "^1.2.5",
-    "mocha": "^9.1.1",
-    "mocha-junit-reporter": "^2.0.0",
-    "mochawesome": "^6.2.1",
+    "mocha": "^9.2.0",
+    "mocha-junit-reporter": "^2.0.2",
+    "mochawesome": "^7.0.1",
     "nyc": "^15.1.0",
-    "sinon": "^11.1.2",
-    "uglifyify": "^5.0.2"
+    "sinon": "^13.0.1",
+    "uglifyjs-webpack-plugin": "^2.2.0",
+    "webpack": "^5.68.0",
+    "webpack-cli": "^4.9.2"
   },
   "scripts": {
     "test": "./node_modules/.bin/mocha --require @babel/register --bdd --recursive --reporter list",
-    "compile": "./node_modules/.bin/grunt default",
+    "compile": "./node_modules/.bin/webpack --bail --config webpack.js",
     "fix": "./node_modules/.bin/eslint ./src --fix"
   },
   "repository": {

package/src/BaseAPI.js

@@ -29,6 +29,8 @@ export default class BaseAPI {
     selfReportSessionTime: false,
     alwaysSendTotalTime: false,
     strict_errors: true,
+    xhrHeaders: {},
+    xhrWithCredentials: false,
     responseHandler: function(xhr) {
       let result;
       if (typeof xhr !== 'undefined') {
@@ -46,6 +48,29 @@ export default class BaseAPI {
       }
       return result;
     },
+    requestHandler: function(commitObject) {
+      return commitObject;
+    },
+    onLogMessage: function(messageLevel, logMessage) {
+      switch (messageLevel) {
+        case global_constants.LOG_LEVEL_ERROR:
+          console.error(logMessage);
+          break;
+        case global_constants.LOG_LEVEL_WARNING:
+          console.warn(logMessage);
+          break;
+        case global_constants.LOG_LEVEL_INFO:
+          console.info(logMessage);
+          break;
+        case global_constants.LOG_LEVEL_DEBUG:
+          if (console.debug) {
+            console.debug(logMessage);
+          } else {
+            console.log(logMessage);
+          }
+          break;
+      }
+    },
   };
   cmi;
   startingData: {};
@@ -149,11 +174,11 @@ export default class BaseAPI {
 
       const result = this.storeData(true);
       if (!this.settings.sendBeaconCommit && !this.settings.asyncCommit &&
-          typeof result.errorCode !== 'undefined' && result.errorCode > 0) {
+        typeof result.errorCode !== 'undefined' && result.errorCode > 0) {
         this.throwSCORMError(result.errorCode);
       }
       returnValue = (typeof result !== 'undefined' && result.result) ?
-          result.result : global_constants.SCORM_FALSE;
+        result.result : global_constants.SCORM_FALSE;
 
       if (checkTerminated) this.lastErrorCode = 0;
 
@@ -290,11 +315,11 @@ export default class BaseAPI {
         this.#error_codes.COMMIT_AFTER_TERM)) {
       const result = this.storeData(false);
       if (!this.settings.sendBeaconCommit && !this.settings.asyncCommit &&
-          result.errorCode && result.errorCode > 0) {
+        result.errorCode && result.errorCode > 0) {
         this.throwSCORMError(result.errorCode);
       }
       returnValue = (typeof result !== 'undefined' && result.result) ?
-          result.result : global_constants.SCORM_FALSE;
+        result.result : global_constants.SCORM_FALSE;
 
       this.apiLog(callbackName, 'HttpRequest', ' Result: ' + returnValue,
           global_constants.LOG_LEVEL_DEBUG);
@@ -408,24 +433,7 @@ export default class BaseAPI {
     logMessage = this.formatMessage(functionName, CMIElement, logMessage);
 
     if (messageLevel >= this.apiLogLevel) {
-      switch (messageLevel) {
-        case global_constants.LOG_LEVEL_ERROR:
-          console.error(logMessage);
-          break;
-        case global_constants.LOG_LEVEL_WARNING:
-          console.warn(logMessage);
-          break;
-        case global_constants.LOG_LEVEL_INFO:
-          console.info(logMessage);
-          break;
-        case global_constants.LOG_LEVEL_DEBUG:
-          if (console.debug) {
-            console.debug(logMessage);
-          } else {
-            console.log(logMessage);
-          }
-          break;
-      }
+      this.settings.onLogMessage(messageLevel, logMessage);
     }
   }
 
@@ -490,9 +498,9 @@ export default class BaseAPI {
    */
   _checkObjectHasProperty(refObject, attribute: String) {
     return Object.hasOwnProperty.call(refObject, attribute) ||
-        Object.getOwnPropertyDescriptor(
-            Object.getPrototypeOf(refObject), attribute) ||
-        (attribute in refObject);
+      Object.getOwnPropertyDescriptor(
+          Object.getPrototypeOf(refObject), attribute) ||
+      (attribute in refObject);
   }
 
   /**
@@ -556,21 +564,21 @@ export default class BaseAPI {
 
     const invalidErrorMessage = `The data model element passed to ${methodName} (${CMIElement}) is not a valid SCORM data model element.`;
     const invalidErrorCode = scorm2004 ?
-        this.#error_codes.UNDEFINED_DATA_MODEL :
-        this.#error_codes.GENERAL;
+      this.#error_codes.UNDEFINED_DATA_MODEL :
+      this.#error_codes.GENERAL;
 
     for (let i = 0; i < structure.length; i++) {
       const attribute = structure[i];
 
       if (i === structure.length - 1) {
         if (scorm2004 && (attribute.substr(0, 8) === '{target=') &&
-            (typeof refObject._isTargetValid == 'function')) {
+          (typeof refObject._isTargetValid == 'function')) {
           this.throwSCORMError(this.#error_codes.READ_ONLY_ELEMENT);
         } else if (!this._checkObjectHasProperty(refObject, attribute)) {
           this.throwSCORMError(invalidErrorCode, invalidErrorMessage);
         } else {
           if (this.isInitialized() &&
-              this.stringMatches(CMIElement, '\\.correct_responses\\.\\d+')) {
+            this.stringMatches(CMIElement, '\\.correct_responses\\.\\d+')) {
             this.validateCorrectResponse(CMIElement, value);
           }
 
@@ -671,8 +679,8 @@ export default class BaseAPI {
     const uninitializedErrorMessage = `The data model element passed to ${methodName} (${CMIElement}) has not been initialized.`;
     const invalidErrorMessage = `The data model element passed to ${methodName} (${CMIElement}) is not a valid SCORM data model element.`;
     const invalidErrorCode = scorm2004 ?
-        this.#error_codes.UNDEFINED_DATA_MODEL :
-        this.#error_codes.GENERAL;
+      this.#error_codes.UNDEFINED_DATA_MODEL :
+      this.#error_codes.GENERAL;
 
     for (let i = 0; i < structure.length; i++) {
       attribute = structure[i];
@@ -686,9 +694,8 @@ export default class BaseAPI {
         }
       } else {
         if ((String(attribute).substr(0, 8) === '{target=') &&
-            (typeof refObject._isTargetValid == 'function')) {
-          const target = String(attribute).
-              substr(8, String(attribute).length - 9);
+          (typeof refObject._isTargetValid == 'function')) {
+          const target = String(attribute).substr(8, String(attribute).length - 9);
           return refObject._isTargetValid(target);
         } else if (!this._checkObjectHasProperty(refObject, attribute)) {
           this.throwSCORMError(invalidErrorCode, invalidErrorMessage);
@@ -818,7 +825,7 @@ export default class BaseAPI {
       const removeIndex = this.listenerArray.findIndex((obj) =>
         obj.functionName === functionName &&
         obj.CMIElement === CMIElement &&
-        obj.callback === callback
+        obj.callback === callback,
       );
       if (removeIndex !== -1) {
         this.listenerArray.splice(removeIndex, 1);
@@ -867,8 +874,8 @@ export default class BaseAPI {
       const listenerHasCMIElement = !!listener.CMIElement;
       let CMIElementsMatch = false;
       if (CMIElement && listener.CMIElement &&
-          listener.CMIElement.substring(listener.CMIElement.length - 1) ===
-          '*') {
+        listener.CMIElement.substring(listener.CMIElement.length - 1) ===
+        '*') {
         CMIElementsMatch = CMIElement.indexOf(listener.CMIElement.substring(0,
             listener.CMIElement.length - 1)) === 0;
       } else {
@@ -1093,6 +1100,15 @@ export default class BaseAPI {
       if (!settings.sendBeaconCommit) {
         const httpReq = new XMLHttpRequest();
         httpReq.open('POST', url, settings.asyncCommit);
+
+        if (Object.keys(settings.xhrHeaders).length) {
+          Object.keys(settings.xhrHeaders).forEach((header) => {
+            httpReq.setRequestHeader(header, settings.xhrHeaders[header]);
+          });
+        }
+
+        httpReq.withCredentials = settings.xhrWithCredentials;
+
         if (settings.asyncCommit) {
           httpReq.onload = function(e) {
             if (typeof settings.responseHandler === 'function') {
@@ -1103,6 +1119,7 @@ export default class BaseAPI {
           };
         }
         try {
+          params = settings.requestHandler(params);
           if (params instanceof Array) {
             httpReq.setRequestHeader('Content-Type',
                 'application/x-www-form-urlencoded');
@@ -1164,7 +1181,7 @@ export default class BaseAPI {
       }
 
       if (result.result === true ||
-          result.result === global_constants.SCORM_TRUE) {
+        result.result === global_constants.SCORM_TRUE) {
         api.processListeners('CommitSuccess');
       } else {
         api.processListeners('CommitError');

package/webpack.js

@@ -0,0 +1,78 @@
+const path = require('path');
+const webpack = require('webpack');
+const ESLintPlugin = require('eslint-webpack-plugin');
+const UglifyJsPlugin = require('uglifyjs-webpack-plugin');
+
+const JSLoader = {
+  test: /\.js$/i,
+  use: {
+    loader: 'babel-loader',
+    options: {
+      presets: [
+        [
+          '@babel/preset-env',
+          {
+            'corejs': '3',
+            'useBuiltIns': 'entry',
+            'targets': {
+              'browsers': [
+                'edge >= 16',
+                'safari >= 9',
+                'firefox >= 57',
+                'ie >= 11',
+                'ios >= 9',
+                'chrome >= 49',
+              ],
+            },
+          },
+        ],
+        ['@babel/preset-flow'],
+      ],
+      plugins: [
+        '@babel/plugin-proposal-class-properties',
+        '@babel/plugin-proposal-private-methods',
+        '@babel/plugin-proposal-optional-chaining',
+      ],
+    },
+  },
+};
+
+module.exports = {
+  mode: 'development',
+  devtool: 'source-map',
+  entry: {
+    'aicc': './src/exports/aicc.js',
+    'scorm12': './src/exports/scorm12.js',
+    'scorm2004': './src/exports/scorm2004.js',
+    'scorm-again': './src/exports/scorm-again.js',
+    'aicc.min': './src/exports/aicc.js',
+    'scorm12.min': './src/exports/scorm12.js',
+    'scorm2004.min': './src/exports/scorm2004.js',
+    'scorm-again.min': './src/exports/scorm-again.js',
+  },
+  target: ['web', 'es5'],
+  module: {
+    rules: [
+      JSLoader,
+    ],
+  },
+  output: {
+    path: path.resolve(__dirname, 'dist'),
+    environment: {
+      arrowFunction: false,
+    },
+  },
+  optimization: {
+    minimize: true,
+    minimizer: [new UglifyJsPlugin({
+      include: /\.min\.js$/,
+    })],
+  },
+  plugins: [
+    new ESLintPlugin({
+      overrideConfigFile: path.resolve(__dirname, '.eslintrc.js'),
+      context: path.resolve(__dirname, '../src'),
+      files: '**/*.js',
+    }),
+  ],
+};

package/gruntfile.js

@@ -1,90 +0,0 @@
-module.exports = function(grunt) {
-  grunt.initConfig({
-    mochaTest: {
-      test: {
-        options: {
-          reporter: 'list',
-          require: '@babel/register',
-          noFail: false,
-          recursive: true,
-          captureFile: false,
-        },
-        src: ['test/**/*.spec.js'],
-      },
-    },
-    watch: {
-      scripts: {
-        files: ['src/**/*.js'],
-        tasks: ['default'],
-        options: {
-          spawn: false,
-        },
-      },
-    },
-    browserify: {
-      development: {
-        files: [{
-          expand: true,
-          cwd: 'src/exports/',
-          src: ['*.js'],
-          dest: 'dist/',
-          ext: '.js',
-          extDot: 'first',
-        }],
-        options: {
-          browserifyOptions: {debug: true},
-          transform: [
-            [
-              'babelify', {
-                'presets': ['@babel/preset-env', '@babel/preset-flow'],
-                'plugins': [
-                  '@babel/plugin-proposal-class-properties',
-                  '@babel/plugin-proposal-private-methods',
-                  '@babel/plugin-proposal-optional-chaining',
-                ],
-              },
-            ],
-          ],
-        },
-      },
-      production: {
-        files: [{
-          expand: true,
-          cwd: 'src/exports/',
-          src: ['*.js'],
-          dest: 'dist/',
-          ext: '.min.js',
-          extDot: 'first',
-        }],
-        options: {
-          browserifyOptions: {debug: false},
-          transform: [
-            [
-              'babelify', {
-                'presets': ['@babel/preset-env', '@babel/preset-flow'],
-                'plugins': [
-                  '@babel/plugin-proposal-class-properties',
-                  '@babel/plugin-proposal-private-methods',
-                  '@babel/plugin-proposal-optional-chaining',
-                ],
-              },
-              'uglifyify', {
-                sourceMap: true,
-              },
-            ],
-          ],
-        },
-      },
-    },
-
-  });
-
-  grunt.loadNpmTasks('grunt-browserify');
-  grunt.loadNpmTasks('grunt-mocha-test');
-  grunt.loadNpmTasks('grunt-contrib-watch');
-
-  grunt.registerTask('test', 'mochaTest');
-
-  grunt.registerTask('default',
-      ['browserify:development', 'browserify:production']);
-};