@lessonkit/lxpack 0.8.0 → 0.9.0

package/README.md

@@ -45,4 +45,4 @@ import { notifyLxpackLessonComplete } from "@lessonkit/lxpack/bridge";
 
 `@lessonkit/react` forwards `lesson_completed`, `course_completed`, and `quiz_completed` automatically when `window.parent.lxpackBridge.v1` is present (`config.lxpack.bridge: "off"` to disable).
 
-For interoperability notes, see [LXPack upgrades](https://lessonkit.readthedocs.io/en/latest/reference/lxpack-upgrades.html).
+For interoperability notes, see [LXPack upgrades](https://lessonkit.readthedocs.io/en/latest/reference/lxpack-upgrades.html). LXPack maintainers: [upgrade plan for maintainers](https://github.com/eddiethedean/lessonkit/blob/main/docs/LXPACK_UPGRADE_PLAN_FOR_MAINTAINERS.md).

package/dist/bridge.cjs

@@ -20,29 +20,78 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/bridge.ts
 var bridge_exports = {};
 __export(bridge_exports, {
+  DEFAULT_BRIDGE_PASSING_SCORE: () => import_spa_bridge2.DEFAULT_BRIDGE_PASSING_SCORE,
+  LESSONKIT_TELEMETRY_EVENTS: () => import_tracking_schema2.LESSONKIT_TELEMETRY_EVENTS,
+  LXPACK_BRIDGE_VERSIONS: () => import_spa_bridge2.LXPACK_BRIDGE_VERSIONS,
   createLxpackBridge: () => createLxpackBridge,
+  createLxpackBridgeHost: () => import_spa_bridge2.createLxpackBridgeHost,
+  getLxpackBridge: () => import_spa_bridge2.getLxpackBridge,
+  mapLessonkitTelemetryToBridgeAction: () => import_tracking_schema2.mapLessonkitTelemetryToBridgeAction,
+  mapLessonkitTelemetryToLxpack: () => import_tracking_schema2.mapLessonkitTelemetryToLxpack,
   normalizeAssessmentPassingScore: () => normalizeAssessmentPassingScore,
   normalizeAssessmentScore: () => normalizeAssessmentScore,
+  normalizePassingThreshold: () => import_spa_bridge2.normalizePassingThreshold,
+  normalizeScore: () => import_spa_bridge2.normalizeScore,
   notifyLxpackAssessment: () => notifyLxpackAssessment,
   notifyLxpackCourseComplete: () => notifyLxpackCourseComplete,
-  notifyLxpackLessonComplete: () => notifyLxpackLessonComplete
+  notifyLxpackLessonComplete: () => notifyLxpackLessonComplete,
+  supportedBridgeVersions: () => import_spa_bridge2.supportedBridgeVersions,
+  telemetryEventToLessonkit: () => telemetryEventToLessonkit
 });
 module.exports = __toCommonJS(bridge_exports);
+var import_spa_bridge = require("@lxpack/spa-bridge");
+var import_spa_bridge2 = require("@lxpack/spa-bridge");
+var import_tracking_schema2 = require("@lxpack/tracking-schema");
+
+// src/telemetry.ts
+var import_tracking_schema = require("@lxpack/tracking-schema");
+var SUPPORTED = new Set(import_tracking_schema.LESSONKIT_TELEMETRY_EVENTS);
+function telemetryEventToLessonkit(event) {
+  if (!SUPPORTED.has(event.name)) {
+    return null;
+  }
+  const name = event.name;
+  const mapped = {
+    name,
+    lessonId: event.lessonId
+  };
+  if (name === "quiz_completed" || name === "quiz_answered") {
+    const data = event.data;
+    mapped.assessmentId = data?.checkId;
+    if (data && "score" in data) {
+      mapped.score = data.score;
+      mapped.maxScore = data.maxScore;
+      mapped.passingScore = data.passingScore;
+    }
+    if (data) {
+      mapped.data = data;
+    }
+  } else if (name === "interaction" && event.data) {
+    mapped.data = event.data;
+  }
+  return mapped;
+}
+
+// src/bridge.ts
 function normalizeAssessmentScore(opts) {
   if (typeof opts.score !== "number" || !Number.isFinite(opts.score)) {
     return null;
   }
-  const maxScore = typeof opts.maxScore === "number" && opts.maxScore > 0 ? opts.maxScore : 1;
-  return opts.score / maxScore;
+  return (0, import_spa_bridge.normalizeScore)({ score: opts.score, maxScore: opts.maxScore });
 }
-function normalizeAssessmentPassingScore(passingScore) {
-  return typeof passingScore === "number" && passingScore > 0 ? passingScore : 1;
+function normalizeAssessmentPassingScore(opts) {
+  return (0, import_spa_bridge.normalizePassingThreshold)({
+    passingScore: opts?.passingScore,
+    maxScore: opts?.maxScore
+  });
 }
-function getBridge() {
+function getBridge(parentWindow) {
+  const fromSdk = (0, import_spa_bridge.getLxpackBridge)(parentWindow);
+  if (fromSdk) return fromSdk;
   if (typeof window === "undefined") return null;
-  const parent = window.parent;
+  const parent = parentWindow ?? window.parent;
   if (!parent || parent === window) return null;
-  return parent.lxpackBridge?.v1 ?? parent.lxpack ?? null;
+  return parent.lxpack ?? null;
 }
 function createLxpackBridge() {
   return getBridge();
@@ -67,10 +116,21 @@ function notifyLxpackAssessment(payload) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DEFAULT_BRIDGE_PASSING_SCORE,
+  LESSONKIT_TELEMETRY_EVENTS,
+  LXPACK_BRIDGE_VERSIONS,
   createLxpackBridge,
+  createLxpackBridgeHost,
+  getLxpackBridge,
+  mapLessonkitTelemetryToBridgeAction,
+  mapLessonkitTelemetryToLxpack,
   normalizeAssessmentPassingScore,
   normalizeAssessmentScore,
+  normalizePassingThreshold,
+  normalizeScore,
   notifyLxpackAssessment,
   notifyLxpackCourseComplete,
-  notifyLxpackLessonComplete
+  notifyLxpackLessonComplete,
+  supportedBridgeVersions,
+  telemetryEventToLessonkit
 });

package/dist/bridge.d.cts

@@ -1,25 +1,9 @@
-import { LessonId, CheckId } from '@lessonkit/core';
+import { CheckId, LessonId } from '@lessonkit/core';
+import { LxpackBridgeV1, LxpackBridgeSubmitAssessmentPayload } from '@lxpack/spa-bridge';
+export { DEFAULT_BRIDGE_PASSING_SCORE, LXPACK_BRIDGE_VERSIONS, LxpackBridgeSubmitAssessmentPayload, LxpackBridgeV1, createLxpackBridgeHost, getLxpackBridge, normalizePassingThreshold, normalizeScore, supportedBridgeVersions } from '@lxpack/spa-bridge';
+export { LESSONKIT_TELEMETRY_EVENTS, LessonkitBridgeAction, LessonkitTelemetryEvent, LessonkitTelemetryEventName, TrackingSchemaEvent, mapLessonkitTelemetryToBridgeAction, mapLessonkitTelemetryToLxpack } from '@lxpack/tracking-schema';
+export { t as telemetryEventToLessonkit } from './telemetry-gCxlwc7I.cjs';
 
-type LxpackBridgeV1 = {
-    completeLesson?: (lessonId: LessonId) => void;
-    completeCourse?: () => void;
-    submitAssessment?: (payload: {
-        id: string;
-        score: number;
-        passingScore?: number;
-    }) => void;
-    track?: (payload: {
-        type: string;
-        id: string;
-        data?: Record<string, unknown>;
-    }) => void;
-};
-type LxpackBridgeHost = {
-    lxpackBridge?: {
-        v1?: LxpackBridgeV1;
-    };
-    lxpack?: LxpackBridgeV1;
-};
 /**
  * Scale a raw quiz score to 0–1 for the LXPack parent bridge.
  * Returns null when `score` is missing or not finite (caller should skip submit).
@@ -28,8 +12,14 @@ declare function normalizeAssessmentScore(opts: {
     score?: number;
     maxScore?: number;
 }): number | null;
-/** Bridge passing threshold (0–1 scale). Defaults to 1 when omitted or invalid. */
-declare function normalizeAssessmentPassingScore(passingScore?: number): number;
+/**
+ * Scale a raw passing threshold to 0–1 for the LXPack parent bridge.
+ * Delegates to `@lxpack/spa-bridge` (default 0.7 when omitted).
+ */
+declare function normalizeAssessmentPassingScore(opts?: {
+    passingScore?: number;
+    maxScore?: number;
+}): number;
 declare function createLxpackBridge(): LxpackBridgeV1 | null;
 declare function notifyLxpackLessonComplete(lessonId: LessonId): boolean;
 declare function notifyLxpackCourseComplete(): boolean;
@@ -37,10 +27,8 @@ declare function notifyLxpackCourseComplete(): boolean;
  * Submit assessment results to the parent LXPack bridge.
  * `score` must already be on a 0–1 scale (use `normalizeAssessmentScore` for raw points).
  */
-declare function notifyLxpackAssessment(payload: {
+declare function notifyLxpackAssessment(payload: LxpackBridgeSubmitAssessmentPayload & {
     id: CheckId;
-    score: number;
-    passingScore?: number;
 }): boolean;
 
-export { type LxpackBridgeHost, type LxpackBridgeV1, createLxpackBridge, normalizeAssessmentPassingScore, normalizeAssessmentScore, notifyLxpackAssessment, notifyLxpackCourseComplete, notifyLxpackLessonComplete };
+export { createLxpackBridge, normalizeAssessmentPassingScore, normalizeAssessmentScore, notifyLxpackAssessment, notifyLxpackCourseComplete, notifyLxpackLessonComplete };

package/dist/bridge.d.ts

@@ -1,25 +1,9 @@
-import { LessonId, CheckId } from '@lessonkit/core';
+import { CheckId, LessonId } from '@lessonkit/core';
+import { LxpackBridgeV1, LxpackBridgeSubmitAssessmentPayload } from '@lxpack/spa-bridge';
+export { DEFAULT_BRIDGE_PASSING_SCORE, LXPACK_BRIDGE_VERSIONS, LxpackBridgeSubmitAssessmentPayload, LxpackBridgeV1, createLxpackBridgeHost, getLxpackBridge, normalizePassingThreshold, normalizeScore, supportedBridgeVersions } from '@lxpack/spa-bridge';
+export { LESSONKIT_TELEMETRY_EVENTS, LessonkitBridgeAction, LessonkitTelemetryEvent, LessonkitTelemetryEventName, TrackingSchemaEvent, mapLessonkitTelemetryToBridgeAction, mapLessonkitTelemetryToLxpack } from '@lxpack/tracking-schema';
+export { t as telemetryEventToLessonkit } from './telemetry-gCxlwc7I.js';
 
-type LxpackBridgeV1 = {
-    completeLesson?: (lessonId: LessonId) => void;
-    completeCourse?: () => void;
-    submitAssessment?: (payload: {
-        id: string;
-        score: number;
-        passingScore?: number;
-    }) => void;
-    track?: (payload: {
-        type: string;
-        id: string;
-        data?: Record<string, unknown>;
-    }) => void;
-};
-type LxpackBridgeHost = {
-    lxpackBridge?: {
-        v1?: LxpackBridgeV1;
-    };
-    lxpack?: LxpackBridgeV1;
-};
 /**
  * Scale a raw quiz score to 0–1 for the LXPack parent bridge.
  * Returns null when `score` is missing or not finite (caller should skip submit).
@@ -28,8 +12,14 @@ declare function normalizeAssessmentScore(opts: {
     score?: number;
     maxScore?: number;
 }): number | null;
-/** Bridge passing threshold (0–1 scale). Defaults to 1 when omitted or invalid. */
-declare function normalizeAssessmentPassingScore(passingScore?: number): number;
+/**
+ * Scale a raw passing threshold to 0–1 for the LXPack parent bridge.
+ * Delegates to `@lxpack/spa-bridge` (default 0.7 when omitted).
+ */
+declare function normalizeAssessmentPassingScore(opts?: {
+    passingScore?: number;
+    maxScore?: number;
+}): number;
 declare function createLxpackBridge(): LxpackBridgeV1 | null;
 declare function notifyLxpackLessonComplete(lessonId: LessonId): boolean;
 declare function notifyLxpackCourseComplete(): boolean;
@@ -37,10 +27,8 @@ declare function notifyLxpackCourseComplete(): boolean;
  * Submit assessment results to the parent LXPack bridge.
  * `score` must already be on a 0–1 scale (use `normalizeAssessmentScore` for raw points).
  */
-declare function notifyLxpackAssessment(payload: {
+declare function notifyLxpackAssessment(payload: LxpackBridgeSubmitAssessmentPayload & {
     id: CheckId;
-    score: number;
-    passingScore?: number;
 }): boolean;
 
-export { type LxpackBridgeHost, type LxpackBridgeV1, createLxpackBridge, normalizeAssessmentPassingScore, normalizeAssessmentScore, notifyLxpackAssessment, notifyLxpackCourseComplete, notifyLxpackLessonComplete };
+export { createLxpackBridge, normalizeAssessmentPassingScore, normalizeAssessmentScore, notifyLxpackAssessment, notifyLxpackCourseComplete, notifyLxpackLessonComplete };

package/dist/bridge.js

@@ -1,19 +1,46 @@
+import {
+  telemetryEventToLessonkit
+} from "./chunk-PSUSESH3.js";
+
 // src/bridge.ts
+import {
+  getLxpackBridge as getLxpackBridgeFromParent,
+  normalizePassingThreshold,
+  normalizeScore
+} from "@lxpack/spa-bridge";
+import {
+  createLxpackBridgeHost as createLxpackBridgeHost2,
+  DEFAULT_BRIDGE_PASSING_SCORE,
+  getLxpackBridge,
+  LXPACK_BRIDGE_VERSIONS,
+  normalizePassingThreshold as normalizePassingThreshold2,
+  normalizeScore as normalizeScore2,
+  supportedBridgeVersions
+} from "@lxpack/spa-bridge";
+import {
+  LESSONKIT_TELEMETRY_EVENTS,
+  mapLessonkitTelemetryToBridgeAction,
+  mapLessonkitTelemetryToLxpack
+} from "@lxpack/tracking-schema";
 function normalizeAssessmentScore(opts) {
   if (typeof opts.score !== "number" || !Number.isFinite(opts.score)) {
     return null;
   }
-  const maxScore = typeof opts.maxScore === "number" && opts.maxScore > 0 ? opts.maxScore : 1;
-  return opts.score / maxScore;
+  return normalizeScore({ score: opts.score, maxScore: opts.maxScore });
 }
-function normalizeAssessmentPassingScore(passingScore) {
-  return typeof passingScore === "number" && passingScore > 0 ? passingScore : 1;
+function normalizeAssessmentPassingScore(opts) {
+  return normalizePassingThreshold({
+    passingScore: opts?.passingScore,
+    maxScore: opts?.maxScore
+  });
 }
-function getBridge() {
+function getBridge(parentWindow) {
+  const fromSdk = getLxpackBridgeFromParent(parentWindow);
+  if (fromSdk) return fromSdk;
   if (typeof window === "undefined") return null;
-  const parent = window.parent;
+  const parent = parentWindow ?? window.parent;
   if (!parent || parent === window) return null;
-  return parent.lxpackBridge?.v1 ?? parent.lxpack ?? null;
+  return parent.lxpack ?? null;
 }
 function createLxpackBridge() {
   return getBridge();
@@ -37,10 +64,21 @@ function notifyLxpackAssessment(payload) {
   return true;
 }
 export {
+  DEFAULT_BRIDGE_PASSING_SCORE,
+  LESSONKIT_TELEMETRY_EVENTS,
+  LXPACK_BRIDGE_VERSIONS,
   createLxpackBridge,
+  createLxpackBridgeHost2 as createLxpackBridgeHost,
+  getLxpackBridge,
+  mapLessonkitTelemetryToBridgeAction,
+  mapLessonkitTelemetryToLxpack,
   normalizeAssessmentPassingScore,
   normalizeAssessmentScore,
+  normalizePassingThreshold2 as normalizePassingThreshold,
+  normalizeScore2 as normalizeScore,
   notifyLxpackAssessment,
   notifyLxpackCourseComplete,
-  notifyLxpackLessonComplete
+  notifyLxpackLessonComplete,
+  supportedBridgeVersions,
+  telemetryEventToLessonkit
 };

package/dist/chunk-PSUSESH3.js

@@ -0,0 +1,32 @@
+// src/telemetry.ts
+import { LESSONKIT_TELEMETRY_EVENTS } from "@lxpack/tracking-schema";
+var SUPPORTED = new Set(LESSONKIT_TELEMETRY_EVENTS);
+function telemetryEventToLessonkit(event) {
+  if (!SUPPORTED.has(event.name)) {
+    return null;
+  }
+  const name = event.name;
+  const mapped = {
+    name,
+    lessonId: event.lessonId
+  };
+  if (name === "quiz_completed" || name === "quiz_answered") {
+    const data = event.data;
+    mapped.assessmentId = data?.checkId;
+    if (data && "score" in data) {
+      mapped.score = data.score;
+      mapped.maxScore = data.maxScore;
+      mapped.passingScore = data.passingScore;
+    }
+    if (data) {
+      mapped.data = data;
+    }
+  } else if (name === "interaction" && event.data) {
+    mapped.data = event.data;
+  }
+  return mapped;
+}
+
+export {
+  telemetryEventToLessonkit
+};