scorm-xapi-interoperability

SCORM & xAPI Interoperability Skill Guide

This skill governs standard implementation of interactive e-learning communication protocols, SCORM packaging manifests, and xAPI statement streaming to Learning Record Stores (LRS).

1. E-Learning Standard Architectural Comparison

+-----------------------+---------------------------------------+---------------------------------------+
| Feature               | SCORM (1.2 / 2004)                   | xAPI (Tin Can) / CMI5                 |
+-----------------------+---------------------------------------+---------------------------------------+
| Environment           | Browser iframe inside LMS only        | Anywhere (Web, Mobile, VR, Offline)   |
| Communication         | Window JavaScript object (`API_1484`) | REST API (HTTP JSON Statements)       |
| Data Model            | CMI data elements (pass/fail, score)  | Actor-Verb-Object + Context Extensions|
| Storage Target        | LMS Database                          | Learning Record Store (LRS)           |
+-----------------------+---------------------------------------+---------------------------------------+

2. Production Code Implementations

A. SCORM 1.2 JavaScript Bridge Interface (Client-Side)

class SCORM12Bridge {
  constructor() {
    this.api = this.findLMSAPI(window);
    this.isInitialized = false;
  }

  findLMSAPI(win) {
    let attempts = 0;
    while (!win.API && win.parent && win.parent !== win && attempts < 10) {
      attempts++;
      win = win.parent;
    }
    return win.API || null;
  }

  initialize() {
    if (!this.api) {
      console.warn("[SCORM] No LMS API found. Running in standalone preview mode.");
      return false;
    }
    const result = this.api.LMSInitialize("");
    this.isInitialized = result === "true";
    return this.isInitialized;
  }

  setScore(scoreRaw, min = 0, max = 100) {
    if (!this.isInitialized) return;
    this.api.LMSSetValue("cmi.core.score.raw", String(scoreRaw));
    this.api.LMSSetValue("cmi.core.score.min", String(min));
    this.api.LMSSetValue("cmi.core.score.max", String(max));
  }

  completeCourse(passed = true) {
    if (!this.isInitialized) return;
    const status = passed ? "passed" : "failed";
    this.api.LMSSetValue("cmi.core.lesson_status", status);
    this.api.LMSCommit("");
  }

  terminate() {
    if (!this.isInitialized) return;
    this.api.LMSFinish("");
    this.isInitialized = false;
  }
}