@patch-adams/core 1.5.11 → 1.5.14

package/dist/index.cjs

@@ -50,7 +50,9 @@ var LrsBridgeConfigSchema = zod.z.object({
   /** Document GUID for xAPI statement aggregation - baked into package at wrap time */
   documentGuid: zod.z.string().optional(),
   /** Version GUID for xAPI statement aggregation - unique per export */
-  versionGuid: zod.z.string().optional()
+  versionGuid: zod.z.string().optional(),
+  /** Original SCORM package filename - baked in at wrap time for LRS searchability */
+  packageName: zod.z.string().optional()
 });
 var BlockingAssetConfigSchema = zod.z.object({
   /** Filename for the asset */
@@ -399,7 +401,8 @@ var DEFAULT_LRS_OPTIONS = {
   lrsAuth: "",
   lrsProxyEndpoint: "",
   documentGuid: "",
-  versionGuid: ""
+  versionGuid: "",
+  packageName: ""
 };
 function generateLrsBridgeCode(options) {
   if (!options.enabled) {
@@ -415,6 +418,7 @@ function generateLrsBridgeCode(options) {
   const lrsProxyEndpoint = options.lrsProxyEndpoint || "";
   const documentGuid = options.documentGuid || "";
   const versionGuid = options.versionGuid || "";
+  const packageName = options.packageName || "";
   return `
   // ==========================================================================
   // PATCH-ADAMS LRS BRIDGE v2.2.0
@@ -447,6 +451,7 @@ function generateLrsBridgeCode(options) {
     var LRS_PROXY_ENDPOINT = '${lrsProxyEndpoint}';
     var DOCUMENT_GUID = '${documentGuid}';
     var VERSION_GUID = '${versionGuid}';
+    var PACKAGE_NAME = '${packageName}';
 
     // Bravais LRS endpoint pattern: https://lrs-{tenant}.bravais.com/XAPI/statements
     // Example: core-acme.bravais.com -> lrs-acme.bravais.com
@@ -2130,7 +2135,9 @@ function generateLrsBridgeCode(options) {
         sharedLinkName: null,
         // Tenant info
         homepage: COURSE_HOMEPAGE || window.location.origin,
-        tenantHomepage: null         // https://{tenant}.bravais.com format
+        tenantHomepage: null,        // https://{tenant}.bravais.com format
+        // Package info
+        packageName: null            // Original SCORM zip filename
       };
 
       // 0. Use baked-in GUIDs from PA-Patcher config (highest priority - set at wrap time)
@@ -2143,6 +2150,10 @@ function generateLrsBridgeCode(options) {
         info.versionGuid = VERSION_GUID;
         log('Version GUID from baked-in config:', VERSION_GUID);
       }
+      if (PACKAGE_NAME) {
+        info.packageName = PACKAGE_NAME;
+        log('Package name from baked-in config:', PACKAGE_NAME);
+      }
 
       // 1. Extract shared link token and document ID from URL
       info.sharedLinkToken = extractSharedLinkToken();
@@ -2573,6 +2584,11 @@ function generateLrsBridgeCode(options) {
       // Resource type
       obj.definition.extensions['resourceType'] = LRS.courseInfo.resourceType || 'Course';
 
+      // Package name (original SCORM zip filename)
+      if (LRS.courseInfo.packageName) {
+        obj.definition.extensions['packageName'] = LRS.courseInfo.packageName;
+      }
+
       return obj;
     }
 
@@ -3406,11 +3422,11 @@ function generateLrsBridgeCode(options) {
     // Send a course completion statement \u2014 called by skin or auto-detected via SCORM
     LRS.sendCompletionStatement = function(data) {
       data = data || {};
-      if (scormCompletionSent) {
-        log('Completion statement already sent (SCORM auto-detected). Skipping duplicate.');
-        return;
+      // Cancel any pending SCORM auto-detection to avoid double-fire for same attempt
+      if (scormCompletionDebounce) {
+        clearTimeout(scormCompletionDebounce);
+        scormCompletionDebounce = null;
       }
-      scormCompletionSent = true;
 
       var status = data.status || 'completed';
       var courseTitle = data.courseTitle || (LRS.courseInfo && LRS.courseInfo.title ? decodeEntities(LRS.courseInfo.title) : decodeEntities(document.title) || 'Course');
@@ -3440,11 +3456,58 @@ function generateLrsBridgeCode(options) {
       };
       if (data.employeeName) activityDetails.employeeName = data.employeeName;
 
-      log('Sending completion statement:', verbKey, 'score:', result.score, 'title:', courseTitle);
-      var statement = buildStatement(verbKey, ACTIVITY_TYPES.course, activityDetails, result, null);
+      // 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,
@@ -3551,6 +3614,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
     // ========================================================================
@@ -4116,7 +4196,7 @@ function generateLrsBridgeCode(options) {
     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 scormCompletionSent = false;  // Prevent duplicate completion statements
+    var scormCompletionDebounce = null;  // Debounce timer \u2014 prevents duplicate fires within same completion event
 
     function interceptScormSetValue(key, value) {
       if (typeof key !== 'string') return;
@@ -4136,12 +4216,15 @@ function generateLrsBridgeCode(options) {
       if (key === 'cmi.success_status') { scormCourseData.successStatus = String(value).toLowerCase(); }
 
       // Fire course completion statement when status indicates pass/fail/complete
-      if ((key === 'cmi.core.lesson_status' || key === 'cmi.success_status' || key === 'cmi.completion_status') && !scormCompletionSent) {
+      // 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') {
-          scormCompletionSent = true;
-          // Slight delay to let score values arrive (Rise often sets score just before status)
-          setTimeout(function() { sendCourseCompletionStatement(status); }, 200);
+          if (scormCompletionDebounce) clearTimeout(scormCompletionDebounce);
+          scormCompletionDebounce = setTimeout(function() {
+            scormCompletionDebounce = null;
+            sendCourseCompletionStatement(status);
+          }, 500);
         }
       }
 
@@ -4252,11 +4335,6 @@ function generateLrsBridgeCode(options) {
 
       var courseTitle = (LRS.courseInfo && LRS.courseInfo.title) ? decodeEntities(LRS.courseInfo.title) : decodeEntities(document.title) || 'Course';
 
-      // Determine verb
-      var verbKey = 'completed';
-      if (status === 'passed') verbKey = 'passed';
-      if (status === 'failed') verbKey = 'failed';
-
       // Build result with score
       var result = { completion: true };
 
@@ -4282,10 +4360,17 @@ function generateLrsBridgeCode(options) {
         employeeId: LRS.employeeId || undefined
       };
 
-      log('Sending course completion:', verbKey, 'score:', result.score, 'title:', courseTitle);
+      // 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);
 
-      var statement = buildStatement(verbKey, ACTIVITY_TYPES.course, activityDetails, result, null);
-      sendStatement(statement);
+      // 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();
     }
@@ -4969,7 +5054,8 @@ function buildJsBeforeOptions(config, metadata) {
     lrsProxyEndpoint: lrsBridgeConfig.lrsProxyEndpoint,
     employeeApiEndpoint: lrsBridgeConfig.employeeApiEndpoint,
     documentGuid: lrsBridgeConfig.documentGuid,
-    versionGuid: lrsBridgeConfig.versionGuid
+    versionGuid: lrsBridgeConfig.versionGuid,
+    packageName: lrsBridgeConfig.packageName
   };
   return {
     remoteUrl: `${config.remoteDomain}/${config.localFolders.js}/${config.jsBefore.filename}`,
@@ -6659,6 +6745,11 @@ var Patcher = class {
       if (effectiveSkin) {
         console.log(`[Patcher] Skin: ${effectiveSkin}`);
       }
+      if (options.packageName) {
+        this.config.lrsBridge = this.config.lrsBridge ?? {};
+        this.config.lrsBridge.packageName = options.packageName;
+        console.log(`[Patcher] Package name: ${options.packageName}`);
+      }
       const htmlInjector = this.getHtmlInjector(toolInfo.tool);
       htmlInjector.setMetadata(metadata);
       let fetchedFallbacks = {};