@lessonkit/lxpack 0.6.0

package/README.md

@@ -0,0 +1,40 @@
+# @lessonkit/lxpack
+
+LXPack export adapter for LessonKit — write `lessonkit.json` + `course.yaml`, copy SPA builds, and package to SCORM / standalone / xAPI / cmi5 via [`@lxpack/api`](https://www.npmjs.com/package/@lxpack/api).
+
+Requires **Node.js 20+**.
+
+## Install
+
+```bash
+npm install @lessonkit/lxpack @lxpack/api
+```
+
+## Quick start
+
+```ts
+import { packageLessonkitCourse } from "@lessonkit/lxpack";
+import { goldenCourseDescriptor } from "./course.descriptor";
+
+const result = await packageLessonkitCourse({
+  descriptor: goldenCourseDescriptor,
+  outDir: ".lxpack/course",
+  spaDistDir: "dist",
+  target: "scorm12",
+  output: ".lxpack/out/course-scorm12.zip",
+});
+
+if (!result.ok) throw new Error("packaging failed");
+```
+
+See [`docs/PACKAGING.md`](../../docs/PACKAGING.md) and [`examples/lxpack-golden`](../../examples/lxpack-golden).
+
+## Browser bridge
+
+When your React app runs inside an LXPack iframe:
+
+```ts
+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).

package/dist/bridge.cjs

@@ -0,0 +1,76 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/bridge.ts
+var bridge_exports = {};
+__export(bridge_exports, {
+  createLxpackBridge: () => createLxpackBridge,
+  normalizeAssessmentPassingScore: () => normalizeAssessmentPassingScore,
+  normalizeAssessmentScore: () => normalizeAssessmentScore,
+  notifyLxpackAssessment: () => notifyLxpackAssessment,
+  notifyLxpackCourseComplete: () => notifyLxpackCourseComplete,
+  notifyLxpackLessonComplete: () => notifyLxpackLessonComplete
+});
+module.exports = __toCommonJS(bridge_exports);
+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;
+}
+function normalizeAssessmentPassingScore(passingScore) {
+  return typeof passingScore === "number" && passingScore > 0 ? passingScore : 1;
+}
+function getBridge() {
+  if (typeof window === "undefined") return null;
+  const parent = window.parent;
+  if (!parent || parent === window) return null;
+  return parent.lxpackBridge?.v1 ?? parent.lxpack ?? null;
+}
+function createLxpackBridge() {
+  return getBridge();
+}
+function notifyLxpackLessonComplete(lessonId) {
+  const bridge = getBridge();
+  if (!bridge?.completeLesson) return false;
+  bridge.completeLesson(lessonId);
+  return true;
+}
+function notifyLxpackCourseComplete() {
+  const bridge = getBridge();
+  if (!bridge?.completeCourse) return false;
+  bridge.completeCourse();
+  return true;
+}
+function notifyLxpackAssessment(payload) {
+  const bridge = getBridge();
+  if (!bridge?.submitAssessment) return false;
+  bridge.submitAssessment(payload);
+  return true;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createLxpackBridge,
+  normalizeAssessmentPassingScore,
+  normalizeAssessmentScore,
+  notifyLxpackAssessment,
+  notifyLxpackCourseComplete,
+  notifyLxpackLessonComplete
+});

package/dist/bridge.d.cts

@@ -0,0 +1,46 @@
+import { LessonId, CheckId } from '@lessonkit/core';
+
+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).
+ */
+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;
+declare function createLxpackBridge(): LxpackBridgeV1 | null;
+declare function notifyLxpackLessonComplete(lessonId: LessonId): boolean;
+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: {
+    id: CheckId;
+    score: number;
+    passingScore?: number;
+}): boolean;
+
+export { type LxpackBridgeHost, type LxpackBridgeV1, createLxpackBridge, normalizeAssessmentPassingScore, normalizeAssessmentScore, notifyLxpackAssessment, notifyLxpackCourseComplete, notifyLxpackLessonComplete };

package/dist/bridge.d.ts

@@ -0,0 +1,46 @@
+import { LessonId, CheckId } from '@lessonkit/core';
+
+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).
+ */
+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;
+declare function createLxpackBridge(): LxpackBridgeV1 | null;
+declare function notifyLxpackLessonComplete(lessonId: LessonId): boolean;
+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: {
+    id: CheckId;
+    score: number;
+    passingScore?: number;
+}): boolean;
+
+export { type LxpackBridgeHost, type LxpackBridgeV1, createLxpackBridge, normalizeAssessmentPassingScore, normalizeAssessmentScore, notifyLxpackAssessment, notifyLxpackCourseComplete, notifyLxpackLessonComplete };

package/dist/bridge.js

@@ -0,0 +1,46 @@
+// 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;
+}
+function normalizeAssessmentPassingScore(passingScore) {
+  return typeof passingScore === "number" && passingScore > 0 ? passingScore : 1;
+}
+function getBridge() {
+  if (typeof window === "undefined") return null;
+  const parent = window.parent;
+  if (!parent || parent === window) return null;
+  return parent.lxpackBridge?.v1 ?? parent.lxpack ?? null;
+}
+function createLxpackBridge() {
+  return getBridge();
+}
+function notifyLxpackLessonComplete(lessonId) {
+  const bridge = getBridge();
+  if (!bridge?.completeLesson) return false;
+  bridge.completeLesson(lessonId);
+  return true;
+}
+function notifyLxpackCourseComplete() {
+  const bridge = getBridge();
+  if (!bridge?.completeCourse) return false;
+  bridge.completeCourse();
+  return true;
+}
+function notifyLxpackAssessment(payload) {
+  const bridge = getBridge();
+  if (!bridge?.submitAssessment) return false;
+  bridge.submitAssessment(payload);
+  return true;
+}
+export {
+  createLxpackBridge,
+  normalizeAssessmentPassingScore,
+  normalizeAssessmentScore,
+  notifyLxpackAssessment,
+  notifyLxpackCourseComplete,
+  notifyLxpackLessonComplete
+};