@lessonkit/lxpack 0.8.1 → 0.9.1

package/dist/index.js

@@ -1,3 +1,7 @@
+import {
+  telemetryEventToLessonkit
+} from "./chunk-PSUSESH3.js";
+
 // src/validateDescriptor.ts
 import { validateId } from "@lessonkit/core";
 
@@ -268,6 +272,37 @@ function mapLessonkitIds(descriptor) {
   return { courseId, lessonIds, checkIds };
 }
 
+// src/assessments.ts
+function slugChoiceId(text, index) {
+  const base = text.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "").slice(0, 32);
+  const stem = base.length ? base : "choice";
+  return `${stem}-${index + 1}`;
+}
+function assessmentDescriptorToLxpack(assessment) {
+  const choices = assessment.choices.map((text, index) => {
+    const id = slugChoiceId(text, index);
+    return {
+      id,
+      text,
+      correct: text === assessment.answer
+    };
+  });
+  return {
+    id: assessment.checkId,
+    passingScore: assessment.passingScore ?? 1,
+    questions: [
+      {
+        id: "q1",
+        prompt: assessment.question,
+        choices
+      }
+    ]
+  };
+}
+function extractAssessments(descriptor) {
+  return (descriptor.assessments ?? []).map(assessmentDescriptorToLxpack);
+}
+
 // src/interchange.ts
 function resolveSpaLessons(descriptor) {
   const mapped = mapLessonkitIds(descriptor);
@@ -291,6 +326,8 @@ function resolveSpaLessons(descriptor) {
 function descriptorToInterchange(descriptor) {
   const mapped = mapLessonkitIds(descriptor);
   const spaLessons = resolveSpaLessons(descriptor);
+  const runtime = descriptor.theme ? themeToLxpackRuntime(descriptor.theme) : void 0;
+  const assessments = extractAssessments(descriptor);
   return {
     format: "lessonkit",
     version: "1",
@@ -304,121 +341,52 @@ function descriptorToInterchange(descriptor) {
       type: "spa",
       path: l.path
     })),
-    tracking: descriptor.tracking
+    tracking: descriptor.tracking,
+    runtime: runtime ? {
+      theme: runtime.theme,
+      cssVariables: runtime.cssVariables
+    } : void 0,
+    assessments: assessments.length ? assessments : void 0
   };
 }
 
-// src/assessments.ts
-function slugChoiceId(text, index) {
-  const base = text.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-|-$/g, "").slice(0, 32);
-  const stem = base.length ? base : "choice";
-  return `${stem}-${index + 1}`;
-}
-function assessmentDescriptorToLxpack(assessment) {
-  const choices = assessment.choices.map((text, index) => {
-    const id = slugChoiceId(text, index);
-    return {
-      id,
-      text,
-      correct: text === assessment.answer
-    };
-  });
-  return {
-    id: assessment.checkId,
-    passingScore: assessment.passingScore ?? 1,
-    questions: [
-      {
-        id: "q1",
-        prompt: assessment.question,
-        choices
-      }
-    ]
-  };
-}
-function extractAssessments(descriptor) {
-  return (descriptor.assessments ?? []).map(assessmentDescriptorToLxpack);
-}
-
 // src/writeProject.ts
-import { access, cp, mkdir, rm, writeFile } from "fs/promises";
-import { dirname, join, resolve as resolve3 } from "path";
+import { join, resolve as resolve4 } from "path";
+import { materializeLessonkitProject } from "@lxpack/validators";
 
-// src/assessmentYaml.ts
-function yamlQuote(value) {
-  return JSON.stringify(value);
-}
-function emitAssessmentYaml(assessment) {
-  const lx = assessmentDescriptorToLxpack(assessment);
-  const lines = [];
-  lines.push(`id: ${lx.id}`);
-  lines.push(`passingScore: ${lx.passingScore}`);
-  lines.push("questions:");
-  for (const question of lx.questions) {
-    lines.push(`  - id: ${question.id}`);
-    lines.push(`    prompt: ${yamlQuote(question.prompt)}`);
-    lines.push("    choices:");
-    for (const choice of question.choices) {
-      lines.push(`      - id: ${choice.id}`);
-      lines.push(`        text: ${yamlQuote(choice.text)}`);
-      if (choice.correct) lines.push("        correct: true");
+// src/spaDirs.ts
+import { access } from "fs/promises";
+import { resolve as resolve3 } from "path";
+async function resolveSpaDirs(options) {
+  const { descriptor, spaDistDir, lessonSpaDirs, projectRoot } = options;
+  const spaLessons = resolveSpaLessons(descriptor);
+  if (descriptor.layout === "single-spa") {
+    const spaDistRelative = spaDistDir ?? descriptor.spaDistDir ?? "dist";
+    const srcDist = projectRoot ? resolve3(projectRoot, spaDistRelative) : resolve3(spaDistRelative);
+    if (projectRoot) {
+      assertResolvedPathUnderRoot(resolve3(projectRoot), srcDist);
     }
-  }
-  return `${lines.join("\n")}
-`;
-}
-
-// src/yaml.ts
-function yamlQuote2(value) {
-  if (/[:#\n\r]/.test(value) || value.startsWith(" ") || value.endsWith(" ")) {
-    return JSON.stringify(value);
-  }
-  return value;
-}
-function emitCourseYaml(opts) {
-  const lines = [];
-  lines.push(`title: ${yamlQuote2(opts.title)}`);
-  lines.push(`version: ${yamlQuote2(opts.version)}`);
-  if (opts.description) lines.push(`description: ${yamlQuote2(opts.description)}`);
-  if (opts.runtime) {
-    lines.push("runtime:");
-    lines.push(`  theme: ${yamlQuote2(opts.runtime.theme)}`);
-    if (opts.runtime.cssVariables && Object.keys(opts.runtime.cssVariables).length) {
-      lines.push("  cssVariables:");
-      for (const [key, value] of Object.entries(opts.runtime.cssVariables).sort(
-        ([a], [b]) => a.localeCompare(b)
-      )) {
-        lines.push(`    ${key}: ${JSON.stringify(String(value))}`);
-      }
+    try {
+      await access(srcDist);
+    } catch {
+      throw new Error(`spaDistDir not found: ${srcDist}`);
     }
-  }
-  if (opts.tracking?.completion?.threshold !== void 0) {
-    lines.push("tracking:");
-    lines.push("  completion:");
-    lines.push(`    threshold: ${opts.tracking.completion.threshold}`);
-  }
-  lines.push("lessons:");
-  for (const lesson of opts.lessons) {
-    lines.push(`  - id: ${lesson.id}`);
-    lines.push(`    title: ${yamlQuote2(lesson.title)}`);
-    lines.push(`    type: spa`);
-    lines.push(`    path: ${lesson.path}`);
-  }
-  if (opts.assessments.length) {
-    lines.push("assessments:");
-    for (const assessment of opts.assessments) {
-      lines.push(`  - id: ${assessment.id}`);
-      lines.push(`    file: ${assessment.file}`);
+    const lessonId = spaLessons[0]?.id ?? "main";
+    return { [lessonId]: srcDist };
+  }
+  const dirs = {};
+  const lessonDirs = lessonSpaDirs ?? {};
+  for (const lesson of descriptor.lessons) {
+    const src = lessonDirs[lesson.id];
+    if (!src) {
+      throw new Error(`lessonSpaDirs missing build output for lesson "${lesson.id}"`);
     }
+    dirs[lesson.id] = resolve3(src);
   }
-  return `${lines.join("\n")}
-`;
+  return dirs;
 }
 
 // src/writeProject.ts
-async function copyDir(src, dest) {
-  await mkdir(dirname(dest), { recursive: true });
-  await cp(src, dest, { recursive: true });
-}
 async function writeLxpackProject(options) {
   const validation = validateDescriptor(options.descriptor);
   if (!validation.ok) {
@@ -427,97 +395,46 @@ async function writeLxpackProject(options) {
     );
   }
   const descriptor = validation.descriptor;
-  const outDir = resolve3(options.outDir);
-  await mkdir(outDir, { recursive: true });
-  const spaLessons = resolveSpaLessons(descriptor);
-  const runtime = descriptor.theme ? themeToLxpackRuntime(descriptor.theme) : void 0;
-  const assessments = (descriptor.assessments ?? []).map((a) => ({
-    id: a.checkId,
-    file: `assessments/${a.checkId}.yaml`
-  }));
-  if (descriptor.layout === "single-spa") {
-    const spaDistRelative = options.spaDistDir ?? descriptor.spaDistDir ?? "dist";
-    const srcDist = options.projectRoot ? resolve3(options.projectRoot, spaDistRelative) : resolve3(spaDistRelative);
-    if (options.projectRoot) {
-      assertResolvedPathUnderRoot(resolve3(options.projectRoot), srcDist);
-    }
-    try {
-      await access(srcDist);
-    } catch {
-      throw new Error(`spaDistDir not found: ${srcDist}`);
-    }
-    const destDist = join(outDir, "dist");
-    await rm(destDist, { recursive: true, force: true });
-    await copyDir(srcDist, destDist);
-  } else {
-    const lessonDirs = options.lessonSpaDirs ?? {};
-    for (const lesson of descriptor.lessons) {
-      const src = lessonDirs[lesson.id];
-      if (!src) {
-        throw new Error(`lessonSpaDirs missing build output for lesson "${lesson.id}"`);
-      }
-      const dest = join(outDir, lesson.spaPath);
-      assertResolvedPathUnderRoot(outDir, dest);
-      await rm(dest, { recursive: true, force: true });
-      await copyDir(resolve3(src), dest);
-    }
-  }
-  if (assessments.length) {
-    const assessmentsDir = join(outDir, "assessments");
-    await mkdir(assessmentsDir, { recursive: true });
-    for (const assessment of descriptor.assessments ?? []) {
-      await writeFile(
-        join(outDir, `assessments/${assessment.checkId}.yaml`),
-        emitAssessmentYaml(assessment),
-        "utf-8"
-      );
-    }
+  const outDir = resolve4(options.outDir);
+  const spaDirs = await resolveSpaDirs({ ...options, descriptor });
+  const interchange = descriptorToInterchange(descriptor);
+  const materialized = await materializeLessonkitProject({
+    interchange,
+    spaDirs,
+    courseDir: outDir,
+    writeAuthoringFiles: true
+  });
+  if (!materialized.ok) {
+    throw new Error(
+      materialized.issues.map((i) => `${i.path ?? ""}: ${i.message}`.trim()).join("; ")
+    );
   }
-  const courseYamlPath = join(outDir, "course.yaml");
-  await writeFile(
-    courseYamlPath,
-    emitCourseYaml({
-      title: descriptor.title,
-      version: descriptor.version ?? "1.0.0",
-      runtime,
-      tracking: descriptor.tracking,
-      lessons: spaLessons.map((l) => ({
-        id: l.id,
-        title: l.title,
-        type: "spa",
-        path: l.path
-      })),
-      assessments
-    }),
-    "utf-8"
-  );
-  const lessonkitJsonPath = join(outDir, "lessonkit.json");
-  await writeFile(
-    lessonkitJsonPath,
-    `${JSON.stringify(descriptorToInterchange(descriptor), null, 2)}
-`,
-    "utf-8"
-  );
-  return { outDir, courseYamlPath, lessonkitJsonPath };
+  const courseDir = materialized.courseDir;
+  return {
+    outDir: courseDir,
+    courseYamlPath: join(courseDir, "course.yaml"),
+    lessonkitJsonPath: join(courseDir, "lessonkit.json")
+  };
 }
 
 // src/packageCourse.ts
 import * as fsp from "fs/promises";
-import { dirname as dirname2, join as join2, resolve as resolve4 } from "path";
+import { dirname, join as join2, resolve as resolve5 } from "path";
 import { tmpdir } from "os";
 import {
   buildCourse,
+  packageLessonkit,
   validateCourse
 } from "@lxpack/api";
 async function validateLessonkitProject(options) {
   return validateCourse({
-    courseDir: resolve4(options.courseDir),
+    courseDir: resolve5(options.courseDir),
     target: options.target
   });
 }
 async function buildLessonkitProject(options) {
   return buildCourse({
-    courseDir: resolve4(options.courseDir),
+    courseDir: resolve5(options.courseDir),
     target: options.target,
     output: options.output,
     dir: options.dir,
@@ -556,7 +473,7 @@ async function promoteStagingToOutDir(stagingDir, outDir) {
 }
 async function packageLessonkitCourse(options) {
   const { target, output, dir, outputBaseDir, ...writeOpts } = options;
-  const outDir = resolve4(writeOpts.outDir);
+  const outDir = resolve5(writeOpts.outDir);
   const descriptorValidation = validateDescriptor(writeOpts.descriptor);
   if (!descriptorValidation.ok) {
     return {
@@ -573,39 +490,47 @@ async function packageLessonkitCourse(options) {
   const stagingDir = await fsp.mkdtemp(join2(tmpdir(), "lessonkit-lxpack-"));
   let promoted = false;
   try {
-    const written = await writeLxpackProject({ ...writeOpts, descriptor, outDir: stagingDir });
-    const courseDir = written.outDir;
-    const assessments = extractAssessments(descriptor);
-    const validation = await validateLessonkitProject({ courseDir, target });
-    if (!validation.ok) {
+    let spaDirs;
+    try {
+      spaDirs = await resolveSpaDirs({ ...writeOpts, descriptor });
+    } catch (err) {
       return {
         ok: false,
         courseDir: outDir,
         target,
-        validation,
-        issues: validation.issues.map((i) => ({
-          path: i.path,
-          message: i.message,
-          severity: i.severity
-        }))
+        issues: [
+          {
+            path: "spaDirs",
+            message: err instanceof Error ? err.message : String(err)
+          }
+        ]
       };
     }
+    const interchange = descriptorToInterchange(descriptor);
     const outputBase = outputBaseDir ?? ".lxpack/out";
-    await fsp.mkdir(join2(courseDir, outputBase), { recursive: true });
+    await fsp.mkdir(join2(stagingDir, outputBase), { recursive: true });
     const defaultOutput = output ?? (dir ? join2(outputBase, target) : join2(outputBase, `course-${target}.zip`));
-    const build = await buildLessonkitProject({
-      courseDir,
+    const build = await packageLessonkit({
+      interchange,
+      spaDirs,
       target,
-      output: defaultOutput.startsWith("/") ? defaultOutput : join2(courseDir, defaultOutput),
+      courseDir: stagingDir,
+      output: defaultOutput,
       dir,
-      assessments: assessments.length ? assessments : void 0
+      outputBaseDir,
+      outputAnchorDir: stagingDir,
+      writeAuthoringFiles: true
     });
     if (!build.ok) {
+      const validation2 = {
+        ok: false,
+        issues: build.issues
+      };
       return {
         ok: false,
         courseDir: outDir,
         target,
-        validation,
+        validation: validation2,
         build,
         issues: build.issues.map((i) => ({
           path: i.path,
@@ -614,15 +539,17 @@ async function packageLessonkitCourse(options) {
         }))
       };
     }
-    await fsp.mkdir(dirname2(outDir), { recursive: true });
-    await promoteStagingToOutDir(stagingDir, outDir);
-    promoted = true;
+    const validation = {
+      ok: true,
+      manifest: build.manifest,
+      issues: build.issues
+    };
+    const stagingRoot = await fsp.realpath(stagingDir);
     const remapArtifactPath = (artifactPath) => {
       if (!artifactPath) return void 0;
-      const resolved = resolve4(artifactPath);
-      const stagingResolved = resolve4(stagingDir);
-      if (resolved === stagingResolved || resolved.startsWith(stagingResolved + "/")) {
-        return join2(outDir, resolved.slice(stagingResolved.length + 1));
+      const resolved = resolve5(artifactPath);
+      if (resolved === stagingRoot || resolved.startsWith(`${stagingRoot}/`)) {
+        return join2(outDir, resolved.slice(stagingRoot.length + 1));
       }
       return artifactPath;
     };
@@ -630,6 +557,9 @@ async function packageLessonkitCourse(options) {
       "outputPath" in build ? build.outputPath : void 0
     );
     const remappedOutputDir = remapArtifactPath("outputDir" in build ? build.outputDir : void 0);
+    await fsp.mkdir(dirname(outDir), { recursive: true });
+    await promoteStagingToOutDir(stagingDir, outDir);
+    promoted = true;
     const remappedBuild = { ...build };
     if ("outputPath" in remappedBuild && remappedOutputPath !== void 0) {
       remappedBuild.outputPath = remappedOutputPath;
@@ -653,15 +583,34 @@ async function packageLessonkitCourse(options) {
     }
   }
 }
+
+// src/index.ts
+import {
+  LESSONKIT_TELEMETRY_EVENTS,
+  mapLessonkitTelemetryToBridgeAction,
+  mapLessonkitTelemetryToLxpack
+} from "@lxpack/tracking-schema";
+import {
+  lessonkitInterchangeSchema,
+  materializeLessonkitProject as materializeLessonkitProject2,
+  parseLessonkitInterchange
+} from "@lxpack/validators";
 export {
+  LESSONKIT_TELEMETRY_EVENTS,
   assessmentDescriptorToLxpack,
   buildLessonkitProject,
   descriptorToInterchange,
   extractAssessments,
+  lessonkitInterchangeSchema,
   mapLessonkitIds,
+  mapLessonkitTelemetryToBridgeAction,
+  mapLessonkitTelemetryToLxpack,
+  materializeLessonkitProject2 as materializeLessonkitProject,
   packageLessonkitCourse,
+  parseLessonkitInterchange,
   resolveSafePackageOutputOverride,
   resolveSpaLessons,
+  telemetryEventToLessonkit,
   themeToLxpackRuntime,
   validateDescriptor,
   validateLessonkitProject,

package/dist/telemetry-gCxlwc7I.d.cts

@@ -0,0 +1,9 @@
+import { TelemetryEvent } from '@lessonkit/core';
+import { LessonkitTelemetryEvent } from '@lxpack/tracking-schema';
+
+/**
+ * Map a `@lessonkit/core` telemetry event to the LXPack LessonKit telemetry shape.
+ */
+declare function telemetryEventToLessonkit(event: TelemetryEvent): LessonkitTelemetryEvent | null;
+
+export { telemetryEventToLessonkit as t };

package/dist/telemetry-gCxlwc7I.d.ts

@@ -0,0 +1,9 @@
+import { TelemetryEvent } from '@lessonkit/core';
+import { LessonkitTelemetryEvent } from '@lxpack/tracking-schema';
+
+/**
+ * Map a `@lessonkit/core` telemetry event to the LXPack LessonKit telemetry shape.
+ */
+declare function telemetryEventToLessonkit(event: TelemetryEvent): LessonkitTelemetryEvent | null;
+
+export { telemetryEventToLessonkit as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lessonkit/lxpack",
-  "version": "0.8.1",
+  "version": "0.9.1",
   "private": false,
   "description": "LXPack export adapter for LessonKit courses (SCORM, standalone, xAPI, cmi5).",
   "license": "Apache-2.0",
@@ -53,9 +53,12 @@
     "lint": "echo \"(no lint configured yet)\""
   },
   "dependencies": {
-    "@lessonkit/core": "0.8.1",
-    "@lessonkit/themes": "0.8.1",
-    "@lxpack/api": "^0.4.0"
+    "@lessonkit/core": "0.9.1",
+    "@lessonkit/themes": "0.9.1",
+    "@lxpack/api": "^0.6.0",
+    "@lxpack/spa-bridge": "^0.6.0",
+    "@lxpack/tracking-schema": "^0.6.0",
+    "@lxpack/validators": "^0.6.0"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",