scorm-again 1.7.0 → 2.0.0

package/.babelrc

@@ -1,11 +1,22 @@
 {
   "presets": [
-    "@babel/preset-env",
-    "@babel/preset-flow"
-  ],
-  "plugins": [
-    "@babel/plugin-proposal-class-properties",
-    "@babel/plugin-proposal-private-methods",
-    "@babel/plugin-proposal-optional-chaining"
+    [
+      "@babel/preset-env",
+      {
+        "corejs": "3",
+        "useBuiltIns": "entry",
+        "targets": {
+          "browsers": [
+            "edge >= 16",
+            "safari >= 9",
+            "firefox >= 57",
+            "ie >= 11",
+            "ios >= 9",
+            "chrome >= 49"
+          ]
+        }
+      }
+    ],
+    "@babel/preset-typescript"
   ]
 }

package/.github/dependabot.yml

@@ -6,6 +6,11 @@
 version: 2
 updates:
   - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 20
+  - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
       interval: "daily"

package/.github/workflows/main.yml

@@ -0,0 +1,79 @@
+name: Node.js CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout repository
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      # Set up Node.js
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'yarn'
+
+      # Install dependencies
+      - name: Install dependencies
+        run: yarn install
+
+      # Create required directories
+      - name: Create directories
+        run: mkdir -p reports dist docs test-results
+
+      # Run Mocha tests
+      - name: Run tests with Mocha
+        run: |
+          export TS_NODE_COMPILER_OPTIONS="{\"module\":\"commonjs\"}"
+          yarn run test:coverage
+
+        # Upload test results to GitHub
+      - uses: dorny/test-reporter@v1
+        with:
+          name: Test Reporter
+          path: test-results.json
+          reporter: mocha-json
+
+      # Run ESLint
+      - name: Run ESLint
+        run: |
+          ./node_modules/.bin/eslint ./src --format junit --output-file ./reports/eslint/eslint.xml
+
+      # Generate code coverage report and upload to Code Climate
+      - name: Upload Code Coverage Report
+        uses: paambaati/codeclimate-action@v9.0.0
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+        with:
+          coverageCommand: yarn run test:coverage
+          coverageLocations: |
+            ${{github.workspace}}/coverage/lcov.info:lcov
+          debug: 'true'
+
+      # Format code with Prettier
+      - name: Format code with Prettier
+        run: yarn run prettier
+
+      # Build the project
+      - name: Build project
+        run: yarn run compile
+
+      - name: Commit and Push Dist Folder
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: '[skip ci] Add dist folder'
+          file_pattern: 'dist/*.* src/**/*.* test/**/*.* src/*.* test/*.*'
+          skip_dirty_check: false

package/.jsdoc.json

@@ -4,13 +4,12 @@
   ],
   "babel": {
     "presets": [
-      "@babel/preset-env",
-      "@babel/preset-flow"
+      "@babel/preset-env"
     ],
     "plugins": [
-      "@babel/plugin-proposal-class-properties",
-      "@babel/plugin-proposal-private-methods",
-      "@babel/plugin-proposal-optional-chaining"
+      "@babel/plugin-transform-class-properties",
+      "@babel/plugin-transform-private-methods",
+      "@babel/plugin-transform-optional-chaining"
     ]
   }
 }

package/.mocharc.json

@@ -0,0 +1,8 @@
+{
+  "ui": "bdd",
+  "extension": [
+    "ts"
+  ],
+  "spec": "test/**/*.spec.ts",
+  "recursive": true
+}

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

@@ -5,10 +5,13 @@
     <mocha-package>$PROJECT_DIR$/node_modules/mocha</mocha-package>
     <working-directory>$PROJECT_DIR$</working-directory>
     <pass-parent-env>true</pass-parent-env>
+    <envs>
+      <env name="TS_NODE_COMPILER_OPTIONS" value="&quot;{\&quot;module\&quot;:\&quot;commonjs\&quot;}&quot;" />
+    </envs>
     <ui>bdd</ui>
-    <extra-mocha-options>--watch --require @babel/register</extra-mocha-options>
+    <extra-mocha-options>--watch --import=tsx</extra-mocha-options>
     <test-kind>PATTERN</test-kind>
-    <test-pattern>test/**/*.spec.js</test-pattern>
+    <test-pattern>test/**/*.spec.ts</test-pattern>
     <method v="2" />
   </configuration>
 </component>

package/CONTRIBUTING.md

@@ -6,7 +6,7 @@ I'm really glad you're reading this, because this project could definitely benef
 
 I have written 1700+ test cases for the project, but testing is nowhere near what it should be. I try to add test cases as I have time or as an issue comes up. For pull requests, please create test cases for any new code that gets added.
 
-If you would like to contribute, but don't know where to get started, we could absolute use more test cases. The CMI test cases are pretty well covered, but there are always edge cases to think of, but the API test cases are definitely lacking. They are more difficult to create and setup, but obviously cover the bulk of the functionality as well.
+If you would like to contribute, but don't know where to get started, we could absolutely use more test cases. The CMI test cases are pretty well covered, but there are always edge cases to think of, and the API test cases are definitely lacking. They are more difficult to create and setup, but obviously cover the bulk of the functionality as well.
 
 ## Submitting changes
 

package/README.md

@@ -1,8 +1,21 @@
-[![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)
+[![Github Actions](https://img.shields.io/github/actions/workflow/status/jcputney/scorm-again/main.yml?style=for-the-badge "Build Status")](https://github.com/jcputney/scorm-again/actions)
+[![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)
+![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hy/scorm-again?style=for-the-badge&label=jsDeliver%20Downloads)
+![NPM Downloads](https://img.shields.io/npm/dy/scorm-again?style=for-the-badge&label=npm%20Downloads)
+![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/jcputney/scorm-again?style=for-the-badge) ![npm bundle size](https://img.shields.io/bundlephobia/min/scorm-again?style=for-the-badge)
+[![npm](https://img.shields.io/npm/v/scorm-again?color=%2344cc11&style=for-the-badge)](https://www.npmjs.com/package/scorm-again)
+![GitHub License](https://img.shields.io/github/license/jcputney/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)
+
 
 # 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.
 
+## Potential Breaking Change!
+Version 2.0.0 of scorm-again switches to using `fetch`, as well as async-only for reporting to the LMS. Since `fetch` is not supported by IE11, you will need to provide your own polyfill for this functionality if you need to support it.
+
 ### What is this not and what doesn't it do?
 1. This is not an LMS
 1. This does not handle the uploading and verification of SCORM/AICC modules