@lessonkit/lxpack 0.6.0 → 0.8.0

package/README.md

@@ -1,9 +1,15 @@
 # @lessonkit/lxpack
 
+[![Documentation](https://readthedocs.org/projects/lessonkit/badge/?version=latest)](https://lessonkit.readthedocs.io/en/latest/)
+[![npm](https://img.shields.io/npm/v/@lessonkit/lxpack.svg)](https://www.npmjs.com/package/@lessonkit/lxpack)
+[![License](https://img.shields.io/github/license/eddiethedean/lessonkit)](https://github.com/eddiethedean/lessonkit/blob/main/LICENSE)
+
 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+**.
 
+**Docs:** [Packaging reference](https://lessonkit.readthedocs.io/en/latest/reference/packaging.html) · [Packaging & CLI guide](https://lessonkit.readthedocs.io/en/latest/guides/react-developers/packaging-and-cli.html) · [Live examples](https://lessonkit.readthedocs.io/en/latest/examples/index.html)
+
 ## Install
 
 ```bash
@@ -27,7 +33,7 @@ const result = await packageLessonkitCourse({
 if (!result.ok) throw new Error("packaging failed");
 ```
 
-See [`docs/PACKAGING.md`](../../docs/PACKAGING.md) and [`examples/lxpack-golden`](../../examples/lxpack-golden).
+See the [packaging reference](https://lessonkit.readthedocs.io/en/latest/reference/packaging.html) and the [`examples/lxpack-golden`](https://github.com/eddiethedean/lessonkit/tree/main/examples/lxpack-golden) course.
 
 ## Browser bridge
 
@@ -38,3 +44,5 @@ 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).

package/dist/index.cjs

@@ -57,6 +57,8 @@ function assertResolvedPathUnderRoot(root, target) {
 }
 
 // src/validateDescriptor.ts
+var VALID_LAYOUTS = ["single-spa", "per-lesson-spa"];
+var VALID_THEME_PRESETS = ["default", "light", "dark", "brand"];
 function normalizeDescriptor(input) {
   const course = (0, import_core.validateId)(input.courseId, "courseId");
   if (!course.ok) throw new Error("normalizeDescriptor called with invalid courseId");
@@ -99,7 +101,23 @@ function validateDescriptor(input) {
   if (!input.lessons?.length) {
     issues.push({ path: "lessons", message: "at least one lesson is required" });
   }
-  if (input.layout === "single-spa" && (input.lessons?.length ?? 0) > 1) {
+  if (!input.layout) {
+    issues.push({ path: "layout", message: "layout is required" });
+  } else if (!VALID_LAYOUTS.includes(input.layout)) {
+    issues.push({
+      path: "layout",
+      message: `layout must be one of: ${VALID_LAYOUTS.join(", ")}`
+    });
+  }
+  const layout = input.layout;
+  const themePreset = input.theme?.preset;
+  if (themePreset !== void 0 && !VALID_THEME_PRESETS.includes(themePreset)) {
+    issues.push({
+      path: "theme.preset",
+      message: `unknown preset; use one of: ${VALID_THEME_PRESETS.join(", ")}`
+    });
+  }
+  if (layout === "single-spa" && (input.lessons?.length ?? 0) > 1) {
     issues.push({
       path: "lessons",
       message: "single-spa layout packages one SPA lesson; remove extra lesson entries or use per-lesson-spa"
@@ -120,7 +138,7 @@ function validateDescriptor(input) {
     if (!lesson.title?.trim()) {
       issues.push({ path: `${path}.title`, message: "lesson title is required" });
     }
-    if (input.layout === "per-lesson-spa") {
+    if (layout === "per-lesson-spa") {
       const spaPath = lesson.spaPath?.trim();
       if (!spaPath) {
         issues.push({
@@ -139,7 +157,7 @@ function validateDescriptor(input) {
       }
     }
   }
-  if (input.layout === "single-spa" && input.spaLessonId?.trim()) {
+  if (layout === "single-spa" && input.spaLessonId?.trim()) {
     const spaId = input.spaLessonId.trim();
     const spaResult = (0, import_core.validateId)(spaId, "spaLessonId");
     if (!spaResult.ok) {

package/dist/index.js

@@ -21,6 +21,8 @@ function assertResolvedPathUnderRoot(root, target) {
 }
 
 // src/validateDescriptor.ts
+var VALID_LAYOUTS = ["single-spa", "per-lesson-spa"];
+var VALID_THEME_PRESETS = ["default", "light", "dark", "brand"];
 function normalizeDescriptor(input) {
   const course = validateId(input.courseId, "courseId");
   if (!course.ok) throw new Error("normalizeDescriptor called with invalid courseId");
@@ -63,7 +65,23 @@ function validateDescriptor(input) {
   if (!input.lessons?.length) {
     issues.push({ path: "lessons", message: "at least one lesson is required" });
   }
-  if (input.layout === "single-spa" && (input.lessons?.length ?? 0) > 1) {
+  if (!input.layout) {
+    issues.push({ path: "layout", message: "layout is required" });
+  } else if (!VALID_LAYOUTS.includes(input.layout)) {
+    issues.push({
+      path: "layout",
+      message: `layout must be one of: ${VALID_LAYOUTS.join(", ")}`
+    });
+  }
+  const layout = input.layout;
+  const themePreset = input.theme?.preset;
+  if (themePreset !== void 0 && !VALID_THEME_PRESETS.includes(themePreset)) {
+    issues.push({
+      path: "theme.preset",
+      message: `unknown preset; use one of: ${VALID_THEME_PRESETS.join(", ")}`
+    });
+  }
+  if (layout === "single-spa" && (input.lessons?.length ?? 0) > 1) {
     issues.push({
       path: "lessons",
       message: "single-spa layout packages one SPA lesson; remove extra lesson entries or use per-lesson-spa"
@@ -84,7 +102,7 @@ function validateDescriptor(input) {
     if (!lesson.title?.trim()) {
       issues.push({ path: `${path}.title`, message: "lesson title is required" });
     }
-    if (input.layout === "per-lesson-spa") {
+    if (layout === "per-lesson-spa") {
       const spaPath = lesson.spaPath?.trim();
       if (!spaPath) {
         issues.push({
@@ -103,7 +121,7 @@ function validateDescriptor(input) {
       }
     }
   }
-  if (input.layout === "single-spa" && input.spaLessonId?.trim()) {
+  if (layout === "single-spa" && input.spaLessonId?.trim()) {
     const spaId = input.spaLessonId.trim();
     const spaResult = validateId(spaId, "spaLessonId");
     if (!spaResult.ok) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lessonkit/lxpack",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "private": false,
   "description": "LXPack export adapter for LessonKit courses (SCORM, standalone, xAPI, cmi5).",
   "license": "Apache-2.0",
@@ -53,8 +53,8 @@
     "lint": "echo \"(no lint configured yet)\""
   },
   "dependencies": {
-    "@lessonkit/core": "0.6.0",
-    "@lessonkit/themes": "0.6.0",
+    "@lessonkit/core": "0.8.0",
+    "@lessonkit/themes": "0.8.0",
     "@lxpack/api": "^0.4.0"
   },
   "devDependencies": {