scorm-again 1.5.3 → 1.7.0

package/.circleci/config.yml

@@ -19,11 +19,6 @@ jobs:
     steps:
       - checkout
 
-      # Update npm
-      - run:
-          name: update-npm
-          command: 'sudo npm install -g npm@latest'
-
       # Download and cache dependencies
       - restore_cache:
           keys:
@@ -31,7 +26,7 @@ jobs:
             # fallback to using the latest cache if no exact match is found
             - v1-dependencies-
 
-      - run: npm install
+      - run: yarn install
 
       - save_cache:
           paths:
@@ -42,7 +37,7 @@ jobs:
 
       # Run mocha
       - run:
-          name: npm test
+          name: yarn test
           command: ./node_modules/.bin/nyc ./node_modules/.bin/mocha --require @babel/register --recursive --timeout=10000 --exit --reporter mocha-junit-reporter --reporter-options mochaFile=test-results/mocha/results.xml
           when: always
 
@@ -78,7 +73,7 @@ jobs:
 
       # run babel compile
       - run: git config user.email "jputney@noverant.com" && git config user.name "Jonathan Putney"
-      - run: ./node_modules/.bin/grunt
+      - run: ./node_modules/.bin/webpack --bail --config webpack.js
       - run: git add --all dist/
 
       # run jsdoc
@@ -101,4 +96,4 @@ jobs:
 
       - store_artifacts: # upload test coverage as artifact
           path: ./coverage/lcov.info
-          prefix: tests
+          prefix: tests

package/.run/Mocha Unit Tests.run.xml

@@ -0,0 +1,14 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Mocha Unit Tests" type="mocha-javascript-test-runner">
+    <node-interpreter>project</node-interpreter>
+    <node-options />
+    <mocha-package>$PROJECT_DIR$/node_modules/mocha</mocha-package>
+    <working-directory>$PROJECT_DIR$</working-directory>
+    <pass-parent-env>true</pass-parent-env>
+    <ui>bdd</ui>
+    <extra-mocha-options>--watch --require @babel/register</extra-mocha-options>
+    <test-kind>PATTERN</test-kind>
+    <test-pattern>test/**/*.spec.js</test-pattern>
+    <method v="2" />
+  </configuration>
+</component>

package/.run/compile.run.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="compile" type="js.build_tools.npm" nameIsGenerated="true">
+    <package-json value="$PROJECT_DIR$/package.json" />
+    <command value="run" />
+    <scripts>
+      <script value="compile" />
+    </scripts>
+    <node-interpreter value="project" />
+    <envs />
+    <method v="2" />
+  </configuration>
+</component>

package/README.md

@@ -1,4 +1,4 @@
-[![CircleCI](https://img.shields.io/circleci/build/github/jcputney/scorm-again/master?style=for-the-badge "CircleCI Build Status")](https://circleci.com/gh/jcputney/scorm-again) [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/jcputney/scorm-again?style=for-the-badge)](https://codeclimate.com/github/jcputney/scorm-again) [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/jcputney/scorm-again?style=for-the-badge)](https://codeclimate.com/github/jcputney/scorm-again/trends/test_coverage_total) [![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/jcputney/scorm-again?style=for-the-badge)](https://codeclimate.com/github/jcputney/scorm-again/trends/technical_debt) [![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/jcputney/scorm-again?style=for-the-badge) ](https://app.snyk.io/org/jcputney/projects?origin[]=github) ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/scorm-again?style=for-the-badge) ![npm bundle size](https://img.shields.io/bundlephobia/min/scorm-again?style=for-the-badge) [![donate](https://img.shields.io/badge/paypal-donate-success?style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=NF5MPZJAV26LE) [![Gitter](https://img.shields.io/gitter/room/jcputney/scorm-again?style=for-the-badge)](https://gitter.im/jcputney/scorm-again)
+[![CircleCI](https://img.shields.io/circleci/build/github/jcputney/scorm-again/master?style=for-the-badge "CircleCI Build Status")](https://circleci.com/gh/jcputney/scorm-again) [![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/jcputney/scorm-again?style=for-the-badge)](https://codeclimate.com/github/jcputney/scorm-again) [![Code Climate coverage](https://img.shields.io/codeclimate/coverage/jcputney/scorm-again?style=for-the-badge)](https://codeclimate.com/github/jcputney/scorm-again/trends/test_coverage_total) [![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/jcputney/scorm-again?style=for-the-badge)](https://codeclimate.com/github/jcputney/scorm-again/trends/technical_debt) [![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/jcputney/scorm-again?style=for-the-badge) ](https://app.snyk.io/org/jcputney/projects?origin[]=github) ![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/scorm-again?style=for-the-badge) ![npm bundle size](https://img.shields.io/bundlephobia/min/scorm-again?style=for-the-badge) [![donate](https://img.shields.io/badge/paypal-donate-success?style=for-the-badge)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=NF5MPZJAV26LE) [![Gitter](https://img.shields.io/gitter/room/jcputney/scorm-again?style=for-the-badge)](https://gitter.im/jcputney/scorm-again) [![npm](https://img.shields.io/npm/v/scorm-again?color=%2344cc11&style=for-the-badge)](https://www.npmjs.com/package/scorm-again)
 
 # SCORM Again
 This project was created to modernize the SCORM JavaScript runtime, and to provide a stable, tested platform for running AICC, SCORM 1.2, and SCORM 2004 modules. This module is designed to be LMS agnostic, and is written to be able to be run without a backing LMS, logging all function calls and data instead of committing, if an LMS endpoint is not configured.
@@ -17,6 +17,11 @@ To begin with, you include either the `scorm-again.js` or `scorm-again.min.js` f
 <script type="text/javascript" src="/dist/scorm-again.js"></script>
 ```
 
+Or, if you would like to only pull in one API, you include either the `aicc.js`, `scorm12.js` or `scorm2004.js` files or their minified versions on your launching page:
+```html
+<script type="text/javascript" src="/dist/scorm2004.js"></script>
+```
+
 Or, if you would like to install the library using your package manager, you can do the following:
 ```sh
 npm install scorm-again
@@ -54,7 +59,11 @@ The APIs include several settings to customize the functionality of each API:
 | `mastery_override` | false | true/false | (SCORM 1.2) Used to override a module's `cmi.core.lesson_status` so that a pass/fail is determined based on a mastery score and the user's raw score, rather than using whatever status is provided by the module. An example of this would be if a module is published using a `Complete/Incomplete` final status, but the LMS always wants to receive a `Passed/Failed` for quizzes, then we can use this setting to override the given final status. |
 | `selfReportSessionTime` | false | true/false | Should the API override the default `session_time` reported by the module? Useful when modules don't properly report time. |
 | `alwaysSendTotalTime` | false | true/false | Should the API always send `total_time` when committing to the LMS |
+| `xhrWithCredentials` | false | true/false | Sets the withCredentials flag on the request to the LMS |
+| `xhrHeaders` | {} | Object | This allows setting of additional headers on the request to the LMS where the key should be the header name and the value is the value of the header you want to send |
 | `responseHandler` | function |  | A function to properly tranform the response from the LMS to the correct format. The APIs expect the result from the LMS to be in the following format (errorCode is optional): `{ "result": true, "errorCode": 0 }` |
+| `requestHandler` | function |  | A function to transform the commit object before sending it to `lmsCommitUrl`. By default it's the identity function (no transformation). |
+| `onLogMessage` | function |  | A function to be called whenever a message is logged. Defaults to console.{error,warn,info,debug,log} |
 
 ## Initial Values
 
@@ -261,8 +270,8 @@ I welcome any and all feedback and contributions to this project! I'm sure it wo
 #### Setup and Development
 You will need `node` installed on your local machine, and you'll have to run `npm install` in the repo directory before starting development. 
 
-To run a build, you need to just run the `grunt` command in the root of the project.
+To run a build, you need to just run the `yarn run compile` command in the root of the project.
 
-Similarly, to run the tests, you just run the `grunt test` or `npm test` command.
+Similarly, to run the tests, you just run the `yarn test` command.
 
 Before submitting pull requests, please also run `eslint ./src --fix` against your code first, otherwise your pull request build could fail.