@patch-adams/core 1.5.10 → 1.5.13

package/dist/index.js

@@ -3394,6 +3394,95 @@ function generateLrsBridgeCode(options) {
       sendStatement(statement);
     };
 
+    // Send a course completion statement \u2014 called by skin or auto-detected via SCORM
+    LRS.sendCompletionStatement = function(data) {
+      data = data || {};
+      // Cancel any pending SCORM auto-detection to avoid double-fire for same attempt
+      if (scormCompletionDebounce) {
+        clearTimeout(scormCompletionDebounce);
+        scormCompletionDebounce = null;
+      }
+
+      var status = data.status || 'completed';
+      var courseTitle = data.courseTitle || (LRS.courseInfo && LRS.courseInfo.title ? decodeEntities(LRS.courseInfo.title) : decodeEntities(document.title) || 'Course');
+
+      var verbKey = 'completed';
+      if (status === 'passed') verbKey = 'passed';
+      if (status === 'failed') verbKey = 'failed';
+
+      var result = { completion: true, success: (status === 'passed') };
+
+      if (typeof data.score === 'number') {
+        var max = data.scoreMax || 100;
+        var min = data.scoreMin || 0;
+        result.score = {
+          raw: data.score,
+          max: max,
+          min: min,
+          scaled: max > min ? (data.score - min) / (max - min) : 0
+        };
+      }
+
+      var activityDetails = {
+        courseTitle: courseTitle,
+        completionStatus: status,
+        employeeEmail: data.email || (LRS.actor && LRS.actor.mbox ? LRS.actor.mbox.replace('mailto:', '') : undefined),
+        employeeId: data.employeeId || LRS.employeeId || undefined
+      };
+      if (data.employeeName) activityDetails.employeeName = data.employeeName;
+
+      // 1. Always send "completed" statement
+      log('Sending completed statement, score:', result.score, 'title:', courseTitle);
+      var completedStatement = buildStatement('completed', ACTIVITY_TYPES.course, activityDetails, result, null);
+      sendStatement(completedStatement);
+
+      // 2. Send "passed" or "failed" statement (assessment outcome)
+      if (status === 'passed' || status === 'failed') {
+        log('Sending', status, 'statement');
+        var outcomeStatement = buildStatement(status, ACTIVITY_TYPES.course, activityDetails, result, null);
+        sendStatement(outcomeStatement);
+      }
+    };
+
+    // Send a "terminated" statement \u2014 called by skin close button or auto on page unload
+    var exitStatementSent = false;
+    LRS.sendExitStatement = function(data) {
+      if (exitStatementSent) return;
+      exitStatementSent = true;
+      data = data || {};
+
+      var courseTitle = (LRS.courseInfo && LRS.courseInfo.title) ? decodeEntities(LRS.courseInfo.title) : decodeEntities(document.title) || 'Course';
+      var duration = null;
+      if (LRS.launchTime) {
+        var ms = new Date().getTime() - new Date(LRS.launchTime).getTime();
+        var secs = Math.floor(ms / 1000);
+        var mins = Math.floor(secs / 60);
+        var hrs = Math.floor(mins / 60);
+        duration = 'PT' + (hrs > 0 ? hrs + 'H' : '') + (mins % 60) + 'M' + (secs % 60) + 'S';
+      }
+
+      var activityDetails = {
+        courseTitle: courseTitle,
+        exitSource: data.source || 'page-unload',
+        employeeEmail: LRS.actor && LRS.actor.mbox ? LRS.actor.mbox.replace('mailto:', '') : undefined,
+        employeeId: LRS.employeeId || undefined,
+        sessionDuration: duration,
+        statementsSent: LRS.stats.statementsSent
+      };
+
+      var result = duration ? { duration: duration } : null;
+      log('Sending exit statement, duration:', duration);
+      var statement = buildStatement('terminated', ACTIVITY_TYPES.course, activityDetails, result, null);
+      sendStatement(statement);
+    };
+
+    // Auto-send exit statement on page unload
+    window.addEventListener('beforeunload', function() {
+      if (!exitStatementSent && LRS.actor) {
+        LRS.sendExitStatement({ source: 'page-unload' });
+      }
+    });
+
     /**
      * Re-extract actor from SCORM after LMSInitialize has been called.
      * Call this from the SCORM wrapper after scormInit() succeeds,
@@ -3500,6 +3589,23 @@ function generateLrsBridgeCode(options) {
       LRS.interacted({ type: 'choice-branch', id: data.id, name: 'Choice Branch Discarded' });
     };
 
+    // ========================================================================
+    // PUBLIC API \u2014 expose core internals for skin scripts
+    // Usage: window.pa_patcher.lrs.api.sendStatement(stmt)
+    // ========================================================================
+    LRS.api = {
+      sendStatement: sendStatement,
+      buildStatement: buildStatement,
+      buildCourseActivityObject: buildCourseActivityObject,
+      buildXylemeContext: buildXylemeContext,
+      generateUUID: generateUUID,
+      decodeEntities: decodeEntities,
+      extractActor: extractActor,
+      getCachedLessonInfo: getCachedLessonInfo,
+      VERBS: VERBS,
+      ACTIVITY_TYPES: ACTIVITY_TYPES
+    };
+
     // ========================================================================
     // 8. RISE EVENT INTERCEPTORS
     // ========================================================================
@@ -4064,9 +4170,40 @@ function generateLrsBridgeCode(options) {
     var scormInteractions = {};  // Pending interactions keyed by index N
     var scormInteractionsSent = {};  // Track which interactions were already sent
     var scormTrackerActive = false;  // Set true when SCORM tracker wraps SetValue \u2014 KC handler defers
+    var scormCourseData = {};  // Accumulates course-level SCORM data (score, status)
+    var scormCompletionDebounce = null;  // Debounce timer \u2014 prevents duplicate fires within same completion event
 
     function interceptScormSetValue(key, value) {
       if (typeof key !== 'string') return;
+
+      // ---- Course-level SCORM data (score, status, completion) ----
+      // SCORM 1.2
+      if (key === 'cmi.core.score.raw') { scormCourseData.scoreRaw = parseFloat(value); }
+      if (key === 'cmi.core.score.max') { scormCourseData.scoreMax = parseFloat(value); }
+      if (key === 'cmi.core.score.min') { scormCourseData.scoreMin = parseFloat(value); }
+      if (key === 'cmi.core.lesson_status') { scormCourseData.status = String(value).toLowerCase(); }
+      // SCORM 2004
+      if (key === 'cmi.score.raw') { scormCourseData.scoreRaw = parseFloat(value); }
+      if (key === 'cmi.score.max') { scormCourseData.scoreMax = parseFloat(value); }
+      if (key === 'cmi.score.min') { scormCourseData.scoreMin = parseFloat(value); }
+      if (key === 'cmi.score.scaled') { scormCourseData.scoreScaled = parseFloat(value); }
+      if (key === 'cmi.completion_status') { scormCourseData.completionStatus = String(value).toLowerCase(); }
+      if (key === 'cmi.success_status') { scormCourseData.successStatus = String(value).toLowerCase(); }
+
+      // Fire course completion statement when status indicates pass/fail/complete
+      // Uses debounce (not one-time flag) so retries/new attempts are captured
+      if (key === 'cmi.core.lesson_status' || key === 'cmi.success_status' || key === 'cmi.completion_status') {
+        var status = String(value).toLowerCase();
+        if (status === 'passed' || status === 'failed' || status === 'completed') {
+          if (scormCompletionDebounce) clearTimeout(scormCompletionDebounce);
+          scormCompletionDebounce = setTimeout(function() {
+            scormCompletionDebounce = null;
+            sendCourseCompletionStatement(status);
+          }, 500);
+        }
+      }
+
+      // ---- Interaction-level tracking (existing) ----
       var interactionPattern = /^cmi\\.interactions\\.(\\d+)\\.(.+)$/;
       var match = key.match(interactionPattern);
       if (!match) return;
@@ -4166,6 +4303,53 @@ function generateLrsBridgeCode(options) {
       }
     }
 
+    function sendCourseCompletionStatement(status) {
+      logGroup('Course Completion');
+      log('Status:', status);
+      log('SCORM course data:', scormCourseData);
+
+      var courseTitle = (LRS.courseInfo && LRS.courseInfo.title) ? decodeEntities(LRS.courseInfo.title) : decodeEntities(document.title) || 'Course';
+
+      // Build result with score
+      var result = { completion: true };
+
+      var raw = scormCourseData.scoreRaw;
+      var max = scormCourseData.scoreMax || 100;
+      var min = scormCourseData.scoreMin || 0;
+
+      if (typeof raw === 'number' && !isNaN(raw)) {
+        result.score = {
+          raw: raw,
+          max: max,
+          min: min,
+          scaled: scormCourseData.scoreScaled != null ? scormCourseData.scoreScaled : (max > min ? (raw - min) / (max - min) : 0)
+        };
+      }
+
+      result.success = (status === 'passed');
+
+      var activityDetails = {
+        courseTitle: courseTitle,
+        completionStatus: status,
+        employeeEmail: LRS.actor && LRS.actor.mbox ? LRS.actor.mbox.replace('mailto:', '') : undefined,
+        employeeId: LRS.employeeId || undefined
+      };
+
+      // 1. Send "completed" statement (course was finished)
+      log('Sending completed statement, score:', result.score, 'title:', courseTitle);
+      var completedStatement = buildStatement('completed', ACTIVITY_TYPES.course, activityDetails, result, null);
+      sendStatement(completedStatement);
+
+      // 2. Send "passed" or "failed" statement (assessment outcome)
+      if (status === 'passed' || status === 'failed') {
+        log('Sending', status, 'statement');
+        var outcomeStatement = buildStatement(status, ACTIVITY_TYPES.course, activityDetails, result, null);
+        sendStatement(outcomeStatement);
+      }
+
+      logGroupEnd();
+    }
+
     function setupScormInteractionTracker() {
       if (!TRACK_QUIZZES) return;