@patch-adams/core 1.5.18 → 1.5.20

package/dist/index.js

@@ -1591,6 +1591,101 @@ function generateLrsBridgeCode(options) {
       return hasValidMbox || hasValidAccount;
     }
 
+    // ========================================================================
+    // CROSS-FRAME ACTOR SHARING
+    // PA-Patcher injects the bridge into ALL HTML files in a SCORM package.
+    // Rise courses have multiple HTML files (index.html, scormcontent/index.html),
+    // each getting their own bridge instance with its own LRS.actor.
+    // The skin overlay (email gate) only runs in one frame and sets the actor there.
+    // Without sharing, other bridge instances keep the Anonymous Learner actor.
+    // Solution: persist actor to localStorage so all bridge instances can use it.
+    // ========================================================================
+    var ACTOR_STORAGE_KEY = 'pa_lrs_shared_actor';
+
+    function isAnonymousActor(actor) {
+      if (!actor) return true;
+      if (!actor.name) return true;
+      var n = actor.name.toLowerCase();
+      return n === 'anonymous learner' || n === 'unknown learner' || n === 'anonymous' || n === 'unknown';
+    }
+
+    /**
+     * Persist actor to localStorage for cross-frame sharing.
+     * Only stores non-anonymous actors.
+     */
+    function persistActor(actor) {
+      if (!actor || isAnonymousActor(actor)) return;
+      try {
+        localStorage.setItem(ACTOR_STORAGE_KEY, JSON.stringify(actor));
+        log('Actor persisted to localStorage:', actor.name);
+      } catch (e) { /* localStorage unavailable */ }
+    }
+
+    /**
+     * Load shared actor from localStorage.
+     * Returns the stored actor or null.
+     */
+    function loadSharedActor() {
+      try {
+        var stored = localStorage.getItem(ACTOR_STORAGE_KEY);
+        if (stored) {
+          var actor = JSON.parse(stored);
+          if (actor && !isAnonymousActor(actor)) {
+            return actor;
+          }
+        }
+      } catch (e) { /* localStorage unavailable or parse error */ }
+      return null;
+    }
+
+    /**
+     * Get the best available actor for statement building.
+     * Priority: LRS.actor (if non-anonymous) > localStorage shared actor > LRS.actor > extractActor()
+     */
+    function getActor() {
+      // If current actor is non-anonymous, use it
+      if (LRS.actor && !isAnonymousActor(LRS.actor)) {
+        return LRS.actor;
+      }
+      // Check localStorage for actor set by another frame (e.g., skin overlay)
+      var shared = loadSharedActor();
+      if (shared) {
+        // Update local actor so future calls are fast
+        LRS.actor = shared;
+        log('Actor loaded from cross-frame storage:', shared.name);
+        return shared;
+      }
+      // Fallback to current actor or re-extract
+      return LRS.actor || extractActor();
+    }
+
+    /**
+     * Set actor on the bridge with cross-frame persistence.
+     * Called by skins and external code via window.pa_patcher.lrs.setActor(actor)
+     */
+    LRS.setActor = function(actor) {
+      LRS.actor = actor;
+      persistActor(actor);
+      // Also try to propagate to other frames in the hierarchy
+      try {
+        var w = window;
+        for (var i = 0; i < 10; i++) {
+          try {
+            if (w !== window && w.pa_patcher && w.pa_patcher.lrs) {
+              w.pa_patcher.lrs.actor = actor;
+            }
+          } catch (e) { /* cross-origin */ }
+          if (w === w.parent) break;
+          w = w.parent;
+        }
+      } catch (e) {}
+      if (window.console && window.console.info) {
+        console.info('[PA-LRS] Actor set:', actor.name,
+          actor.mbox ? '(' + actor.mbox + ')' : '',
+          '\u2014 shared across frames');
+      }
+    };
+
     /**
      * Async version that fetches Bravais session if needed
      * Also re-checks all sources in case they became available
@@ -1602,6 +1697,7 @@ function generateLrsBridgeCode(options) {
         // Try to enhance actor with email if missing
         enhanceActorWithEmail(actor, function(enhancedActor) {
           LRS.actor = enhancedActor;
+          persistActor(enhancedActor);
           callback(enhancedActor);
         });
       }
@@ -1947,12 +2043,12 @@ function generateLrsBridgeCode(options) {
       // Without this override, our statements have a different object.id than cloudplayer
       // statements, so Analytics treats them as unrelated to the document.
       if (docData.guid) {
-        if (LRS.courseInfo.guid && LRS.courseInfo.guid !== docData.guid) {
-          log('Overriding baked-in GUID with Bravais GUID:', LRS.courseInfo.guid, '->', docData.guid);
-        }
+        var oldGuid = LRS.courseInfo.guid;
         LRS.courseInfo.guid = docData.guid;
         LRS.courseInfo.id = 'http://xyleme.com/bravais/document/' + docData.guid;
-        log('Document GUID from API:', docData.guid);
+        // Always-visible log (not behind DEBUG) so we can confirm override in production
+        console.info('[PA-LRS] Document GUID set from API:', docData.guid,
+          oldGuid && oldGuid !== docData.guid ? '(was: ' + oldGuid + ')' : '');
       }
 
       // Version GUID \u2014 same principle: Bravais version GUID must override baked-in
@@ -2261,21 +2357,20 @@ function generateLrsBridgeCode(options) {
         info.sharedLinkName = launchInfo.sharedLinkName || info.sharedLinkName;
       }
 
-      // 3b. Try to extract GUIDs from Xyleme Cloud Player's internal data
-      // This is more reliable than API calls which may fail with 401
-      if (!info.guid || !info.versionGuid) {
-        var cloudPlayerData = extractFromXylemeCloudPlayer();
-        if (cloudPlayerData) {
-          info.guid = cloudPlayerData.guid || info.guid;
-          info.versionGuid = cloudPlayerData.versionGuid || info.versionGuid;
-          info.documentId = cloudPlayerData.documentId || info.documentId;
-          info.title = cloudPlayerData.title || info.title;
-          log('Updated course info from Cloud Player:', {
-            guid: info.guid,
-            versionGuid: info.versionGuid,
-            documentId: info.documentId
-          });
-        }
+      // 3b. Always try to extract GUIDs from Xyleme Cloud Player's internal data.
+      // Cloud Player data is authoritative \u2014 it has the canonical Bravais GUID.
+      // This overrides any baked-in GUID which is just a random UUID from wrap time.
+      var cloudPlayerData = extractFromXylemeCloudPlayer();
+      if (cloudPlayerData) {
+        if (cloudPlayerData.guid) info.guid = cloudPlayerData.guid;
+        if (cloudPlayerData.versionGuid) info.versionGuid = cloudPlayerData.versionGuid;
+        info.documentId = cloudPlayerData.documentId || info.documentId;
+        info.title = cloudPlayerData.title || info.title;
+        log('Updated course info from Cloud Player:', {
+          guid: info.guid,
+          versionGuid: info.versionGuid,
+          documentId: info.documentId
+        });
       }
 
       // 4. Try getCourseTitle() from preloadIntegrity.js
@@ -2609,7 +2704,7 @@ function generateLrsBridgeCode(options) {
 
       var statement = {
         id: generateUUID(),
-        actor: LRS.actor || extractActor(),
+        actor: getActor(),
         verb: typeof verb === 'string' ? (VERBS[verb] || { id: verb, display: { 'en-US': verb } }) : verb,
         object: courseObj,
         timestamp: new Date().toISOString()
@@ -3031,7 +3126,7 @@ function generateLrsBridgeCode(options) {
     function buildStatementXyleme(verb, activityObject, result, additionalContext) {
       var statement = {
         id: generateUUID(),
-        actor: LRS.actor || extractActor(),
+        actor: getActor(),
         verb: typeof verb === 'string' ? (VERBS[verb] || { id: verb, display: { 'en-US': verb } }) : verb,
         object: activityObject,
         timestamp: new Date().toISOString()
@@ -4760,6 +4855,15 @@ function generateLrsBridgeCode(options) {
         // Extract actor (sync first for immediate use)
         extractActor();
 
+        // Check localStorage for actor set by another frame (e.g., skin overlay in a different HTML file)
+        if (isAnonymousActor(LRS.actor)) {
+          var sharedActor = loadSharedActor();
+          if (sharedActor) {
+            LRS.actor = sharedActor;
+            log('Loaded actor from cross-frame storage at init:', sharedActor.name);
+          }
+        }
+
         log('Bridge initialized in mode:', LRS.mode);
         log('Actor:', LRS.actor);
         log('Course:', LRS.courseInfo);
@@ -4897,12 +5001,18 @@ function generateLrsBridgeCode(options) {
 
       // Always-visible bridge summary (not gated by DEBUG)
       // This ensures diagnostics are available even in production builds
+      // Shows current GUID (may be from Cloud Player, baked-in, or pending API override)
+      var currentGuid = LRS.courseInfo ? LRS.courseInfo.guid : DOCUMENT_GUID;
+      var currentVerGuid = LRS.courseInfo ? LRS.courseInfo.versionGuid : VERSION_GUID;
+      var sharedToken = LRS.courseInfo ? LRS.courseInfo.sharedLinkToken : null;
       if (window.console && window.console.info) {
         console.info('[PA-LRS] Bridge v' + LRS.version + ': mode=' + LRS.mode +
           ', endpoint=' + (LRS_ENDPOINT ? LRS_ENDPOINT.substring(0, 30) + '...' : 'NONE') +
           ', proxy=' + (LRS_PROXY_ENDPOINT ? 'yes' : 'no') +
-          ', docGuid=' + (DOCUMENT_GUID || 'NONE') +
-          ', verGuid=' + (VERSION_GUID || 'NONE') +
+          ', docGuid=' + (currentGuid || 'NONE') +
+          (currentGuid !== DOCUMENT_GUID ? ' (overridden from baked: ' + DOCUMENT_GUID + ')' : '') +
+          ', verGuid=' + (currentVerGuid || 'NONE') +
+          ', sharedToken=' + (sharedToken || 'NONE') +
           ', actor=' + (LRS.actor ? (LRS.actor.name || 'anonymous') : 'none') +
           ', hasRefreshActor=' + (typeof LRS.refreshActor === 'function'));
       }
@@ -4973,35 +5083,30 @@ function generateLrsBridgeCode(options) {
         });
       }
 
-      if (!LRS.courseInfo.guid) {
-        // When we have a shared link token, use /api/shared/{token}/documents directly
-        // This endpoint does NOT require authentication and returns both document GUID and version GUID
-        if (sharedLinkToken) {
-          log('Have shared link token, fetching document data via shared API...');
-          // fetchDocumentMetadata will use /api/shared/{token}/documents when sharedLinkToken is present
-          fetchDocumentMetadata(null, function(docData) {
-            if (docData) {
-              updateCourseInfoFromApi(docData);
-              // Also update document name if available
-              if (docData.name) {
-                LRS.courseInfo.sharedLinkName = docData.name;
-              }
-            } else {
-              warn('Could not fetch document data from shared API - statements may fail aggregation');
+      // ALWAYS fetch document metadata from the Bravais API.
+      // Even if we have a baked-in GUID, we must override it with the canonical
+      // Bravais GUID so our statements link to the same document as cloudplayer.
+      // The baked-in GUID is a random UUID from wrap time; the Bravais GUID is
+      // assigned at upload and is what Analytics uses for aggregation.
+      if (sharedLinkToken) {
+        log('Have shared link token, fetching document data via shared API...');
+        fetchDocumentMetadata(null, function(docData) {
+          if (docData) {
+            updateCourseInfoFromApi(docData);
+            if (docData.name) {
+              LRS.courseInfo.sharedLinkName = docData.name;
             }
-            maybeEnrichAndReady();
-          });
-        } else if (documentId) {
-          // No shared link token, try with extracted document ID (requires auth)
-          log('No shared link token, fetching document data with ID:', documentId);
-          fetchDocDataAndReady(documentId);
-        } else {
-          // No identifiers available
-          warn('No shared link token or document ID - statements may fail aggregation');
+          } else {
+            warn('Could not fetch document data from shared API - statements may use baked-in GUID');
+          }
           maybeEnrichAndReady();
-        }
+        });
+      } else if (documentId) {
+        log('Fetching document data with ID:', documentId);
+        fetchDocDataAndReady(documentId);
       } else {
-        // Already have GUID \u2014 still try to enrich packageName if missing
+        // No identifiers available
+        warn('No shared link token or document ID - statements will use baked-in GUID');
         maybeEnrichAndReady();
       }