Skip to main content

Installation

scorm-again can be installed and used in multiple ways depending on your project setup. This guide covers all installation methods.

Package Managers​

npm​

npm install scorm-again

yarn​

yarn add scorm-again

CDN Usage​

For quick prototyping or simple integrations, you can include scorm-again directly from a CDN:

jsDelivr​

<!-- Full library (both SCORM 1.2 and SCORM 2004) -->
<script src="https://cdn.jsdelivr.net/npm/scorm-again@latest/dist/scorm-again.min.js"></script>

<!-- SCORM 1.2 only -->
<script src="https://cdn.jsdelivr.net/npm/scorm-again@latest/dist/scorm12.min.js"></script>

<!-- SCORM 2004 only -->
<script src="https://cdn.jsdelivr.net/npm/scorm-again@latest/dist/scorm2004.min.js"></script>
tip

For production, specify an exact version instead of @latest to ensure stability:

<script src="https://cdn.jsdelivr.net/npm/scorm-again@3.0.0/dist/scorm2004.min.js"></script>

Local Script Tag​

If you've installed scorm-again via npm or downloaded the distribution files, you can include them directly:

<!-- Full library -->
<script type="text/javascript" src="/node_modules/scorm-again/dist/scorm-again.min.js"></script>

<!-- SCORM 1.2 only -->
<script type="text/javascript" src="/node_modules/scorm-again/dist/scorm12.min.js"></script>

<!-- SCORM 2004 only -->
<script type="text/javascript" src="/node_modules/scorm-again/dist/scorm2004.min.js"></script>

Module Imports​

ES Modules (ESM)​

For modern JavaScript projects using ES modules:

// Import both APIs
import { Scorm12API, Scorm2004API } from 'scorm-again';

// Import only SCORM 1.2
import { Scorm12API } from 'scorm-again/scorm12';

// Import only SCORM 2004
import { Scorm2004API } from 'scorm-again/scorm2004';

// Import minified version for smaller bundle size
import { Scorm2004API } from 'scorm-again/scorm2004/min';

// Import cross-frame components
import CrossFrameLMS from 'scorm-again/cross-frame-lms';
import CrossFrameAPI from 'scorm-again/cross-frame-api';

CommonJS​

For Node.js or bundlers with CommonJS support:

// Full library
const { Scorm12API, Scorm2004API } = require('scorm-again');

// Individual APIs
const { Scorm12API } = require('scorm-again/scorm12');
const { Scorm2004API } = require('scorm-again/scorm2004');

TypeScript Support​

TypeScript types are included with the package and work automatically:

import { Scorm12API, Scorm2004API, Settings } from 'scorm-again';

// Create an instance with typed settings
const settings: Settings = {
  autocommit: true,
  logLevel: 'DEBUG',
  lmsCommitUrl: 'https://your-lms.com/api/scorm/commit'
};

const api = new Scorm2004API(settings);

TypeScript will provide full IntelliSense and type checking for:

  • API settings and configuration
  • CMI data structures
  • Event handlers
  • Method signatures

Bundle Size Optimization​

To minimize bundle size in production:

1. Import Only What You Need​

// Good - imports only SCORM 2004
import { Scorm2004API } from 'scorm-again/scorm2004/min';

// Avoid - imports both SCORM 1.2 and 2004
import { Scorm2004API } from 'scorm-again';

2. Use Minified Versions​

Always use the .min.js versions in production for smaller file sizes:

// Development
import { Scorm2004API } from 'scorm-again/scorm2004';

// Production
import { Scorm2004API } from 'scorm-again/scorm2004/min';

3. Tree Shaking​

Modern bundlers (webpack, Rollup, Vite) will automatically tree-shake unused code when using ES modules. Make sure your bundler is configured for production mode:

// webpack.config.js
module.exports = {
  mode: 'production',
  // ... other config
};

4. Code Splitting​

If you support both SCORM standards, consider lazy-loading the API based on the content type:

// Lazy load SCORM 1.2
const loadScorm12 = () => import('scorm-again/scorm12/min');

// Lazy load SCORM 2004
const loadScorm2004 = () => import('scorm-again/scorm2004/min');

// Use based on content type
if (contentType === 'scorm12') {
  const { Scorm12API } = await loadScorm12();
  window.API = new Scorm12API(settings);
} else {
  const { Scorm2004API } = await loadScorm2004();
  window.API_1484_11 = new Scorm2004API(settings);
}

Internet Explorer 11 Support​

If you need to support IE11, you'll need to include a fetch polyfill:

<!-- Include polyfill before scorm-again -->
<script src="https://cdn.jsdelivr.net/npm/whatwg-fetch@3.6.2/dist/fetch.umd.js"></script>
<script src="https://cdn.jsdelivr.net/npm/scorm-again@latest/dist/scorm2004.min.js"></script>

Or with npm:

npm install whatwg-fetch
import 'whatwg-fetch';
import { Scorm2004API } from 'scorm-again/scorm2004';

Verification​

To verify the installation worked correctly, you can check the version:

Browser Console​

// After including via script tag
console.log(window.Scorm2004API);
// Should output the API constructor function

Node.js/Module​

import { Scorm2004API } from 'scorm-again';
console.log(Scorm2004API);
// Should output the API constructor function

Next Steps​

Now that you have scorm-again installed, continue to the Quick Start guide to learn how to create and configure API instances.