coursecode 0.1.16 → 0.1.18

package/framework/docs/FRAMEWORK_GUIDE.md

@@ -525,12 +525,12 @@ When cloud meta tags are present, they **always win** — even if `course-config
 | Utility | Config Key | Meta Tag | Transport | Events |
 |---------|-----------|----------|-----------|--------|
 | `error-reporter.js` | `environment.errorReporting` | `cc-error-endpoint` | POST per error (60s dedup) | `*:error` (14 event types) |
-| `data-reporter.js` | `environment.dataReporting` | `cc-data-endpoint` | Batched POST + `sendBeacon` on unload | `assessment:submitted`, `objective:updated`, `interaction:recorded` |
+| `data-reporter.js` | `environment.dataReporting` | `cc-data-endpoint` | Batched POST + `sendBeacon` on unload | `assessment:submitted`, `objective:updated`, `interaction:recorded`, `course:statusChanged`, `channel:message` |
 | `course-channel.js` | `environment.channel` | `cc-channel-endpoint` + `cc-channel-id` | POST to send, SSE to receive | `channel:message`, `channel:connected`, `channel:disconnected` |
 
 **Error Reporter** — Subscribes to all `*:error` events, deduplicates by domain+operation+message (60s window), POSTs to endpoint. Optional `enableUserReports: true` adds "Report Issue" to settings menu. `submitUserReport()` for programmatic user reports.
 
-**Data Reporter** — Queues assessment/objective/interaction records, flushes on batch size (default 10) or timer (default 30s). `sendBeacon` fallback on page unload.
+**Data Reporter** — Queues assessment/objective/interaction/session/channel records, flushes on batch size (default 10) or timer (default 30s). `sendBeacon` fallback on page unload. Also listens to `course:statusChanged` (queues a `session` record on completion) and `channel:message` (queues a `channel` record). Exposes `CourseCode.reportData(type, data)` for course authors to send custom event types.
 
 **Course Channel** — Generic pub/sub pipe. `sendChannelMessage(data)` POSTs any JSON to `endpoint/channelId`. SSE listener on same URL bridges incoming messages to EventBus. Exponential backoff reconnect (1s → 30s cap). Content-agnostic — the relay is a dumb fan-out router.
 

package/framework/js/main.js

@@ -48,7 +48,7 @@ import { logger } from './utilities/logger.js';
 import { iconManager } from './utilities/icons.js';
 import { breakpointManager } from './utilities/breakpoint-manager.js';
 import { initErrorReporter } from './utilities/error-reporter.js';
-import { initDataReporter } from './utilities/data-reporter.js';
+import { initDataReporter, reportData } from './utilities/data-reporter.js';
 import { initCourseChannel } from './utilities/course-channel.js';
 import { canvasSlide } from './utilities/canvas-slide.js';
 
@@ -98,7 +98,10 @@ window.CourseCode = {
 
     // Core
     eventBus,
-    courseConfig
+    courseConfig,
+
+    // Data reporting public API
+    reportData,
 };
 
 // --- Conditional Automation Module Loading ---

package/framework/js/utilities/data-reporter.js

@@ -1,8 +1,9 @@
 /**
  * Data Reporter - Optional external learning data reporting via webhook
  * 
- * Batches important learning records (assessments, objectives, interactions) and
- * sends them to a configured endpoint. Works across all LMS formats.
+ * Batches important learning records (assessments, objectives, interactions,
+ * session completion, channel messages, and custom events) and sends them
+ * to a configured endpoint. Works across all LMS formats.
  * 
  * Configuration in course-config.js:
  *   environment: {
@@ -13,6 +14,9 @@
  *           includeContext: true     // Include course metadata (default: true)
  *       }
  *   }
+ * 
+ * Public API:
+ *   CourseCode.reportData(type, data) — Queue a custom record for reporting
  */
 
 import { eventBus } from '../core/event-bus.js';
@@ -39,7 +43,7 @@ const DEFAULT_FLUSH_INTERVAL = 30000; // 30 seconds
 
 /**
  * Queue a record for batched sending
- * @param {string} type - Record type: 'assessment', 'objective', 'interaction', 'session'
+ * @param {string} type - Record type (assessment, objective, interaction, session, channel, or custom)
  * @param {Object} data - Record data
  */
 function queueRecord(type, data) {
@@ -230,6 +234,26 @@ function handleInteractionRecorded(interaction) {
     });
 }
 
+/**
+ * Handle course completion / status change
+ * Only reports when the course reaches 'completed' status.
+ */
+function handleCourseStatusChanged({ completionStatus, successStatus }) {
+    if (completionStatus !== 'completed') return;
+
+    queueRecord('session', {
+        completionStatus,
+        successStatus: successStatus || 'unknown'
+    });
+}
+
+/**
+ * Handle incoming channel messages — log them as 'channel' records
+ */
+function handleChannelMessage(data) {
+    queueRecord('channel', data);
+}
+
 /**
  * Handle session termination - flush remaining records
  */
@@ -282,10 +306,12 @@ export function initDataReporter(courseConfig) {
 
     logger.info('[DataReporter] Initialized with endpoint:', config.endpoint);
 
-    // Subscribe to important events
+    // Subscribe to learning events
     eventBus.on('assessment:submitted', handleAssessmentSubmitted);
     eventBus.on('objective:updated', handleObjectiveUpdated);
     eventBus.on('interaction:recorded', handleInteractionRecorded);
+    eventBus.on('course:statusChanged', handleCourseStatusChanged);
+    eventBus.on('channel:message', handleChannelMessage);
     eventBus.on('session:beforeTerminate', handleBeforeTerminate);
 
     // Emergency flush on page hide (catches tab close, navigation away)
@@ -294,3 +320,23 @@ export function initDataReporter(courseConfig) {
         window.addEventListener('beforeunload', emergencyFlush);
     }
 }
+
+/**
+ * Public API: Queue a custom data record for reporting.
+ * Exposed on window.CourseCode.reportData so course authors can send
+ * arbitrary events to the configured data endpoint.
+ *
+ * @param {string} type - Record type name (e.g. 'custom-metric', 'survey-response')
+ * @param {Object} data - Record data payload
+ */
+export function reportData(type, data) {
+    if (!type || typeof type !== 'string') {
+        logger.warn('[DataReporter] reportData: type must be a non-empty string');
+        return;
+    }
+    if (!data || typeof data !== 'object') {
+        logger.warn('[DataReporter] reportData: data must be an object');
+        return;
+    }
+    queueRecord(type, data);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "coursecode",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "Multi-format course authoring framework with CLI tools (SCORM 2004, SCORM 1.2, cmi5, LTI 1.3)",
   "type": "module",
   "bin": {

package/template/vite.config.js

@@ -104,8 +104,9 @@ function validatePackage(format = 'scorm2004') {
     if (fs.existsSync(ltiPath)) {
       try {
         const toolConfig = JSON.parse(fs.readFileSync(ltiPath, 'utf-8'));
-        if (!toolConfig.title || !toolConfig.target_link_uri) {
-          errors.push('Generated lti-tool-config.json missing required fields (title, target_link_uri)');
+        const ltiSpec = toolConfig['https://purl.imsglobal.org/spec/lti-tool-configuration'];
+        if (!toolConfig.client_name || !ltiSpec?.target_link_uri) {
+          errors.push('Generated lti-tool-config.json missing required fields (client_name, target_link_uri)');
         }
       } catch {
         errors.push('Generated lti-tool-config.json is not valid JSON');