@lxpack/scorm 0.2.0 → 0.2.1

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { CourseManifest, RuntimeAssessmentBundle } from '@lxpack/validators';
+export { CourseActivity, enumerateActivities as listCourseActivities } from '@lxpack/validators';
 
 declare function manifestIdentifier(manifest: CourseManifest): string;
 declare function generateImsManifest(manifest: CourseManifest, files: string[], launchUrl?: string): string;
@@ -17,6 +18,15 @@ declare function buildScoIndexHtml(options: BuildHtmlOptions & {
 }): string;
 declare function buildIndexHtml(options: BuildHtmlOptions): string;
 
+interface PageTemplateOptions {
+    title: string;
+    runtimeCss: string;
+    configJson: string;
+    runtimeScript: string;
+    componentsScript?: string;
+}
+declare function buildLearnerPageHtml(options: PageTemplateOptions): string;
+
 type ExportTarget = "scorm12" | "scorm2004" | "standalone";
 interface PackageOptions {
     courseDir: string;
@@ -36,10 +46,22 @@ declare function collectFiles(dir: string, baseDir: string): Promise<Array<{
 declare function buildManifestFileList(courseFiles: Array<{
     path: string;
 }>): string[];
+interface PackageSink {
+    writeFile(relPath: string, content: string | Buffer): Promise<void>;
+}
+declare function assemblePackage(options: Omit<PackageOptions, "outputPath">, sink: PackageSink): Promise<{
+    fileCount: number;
+}>;
 declare function packageScorm2004(options: PackageOptions): Promise<{
     outputPath: string;
     fileCount: number;
 }>;
+declare function packageScorm2004Dir(options: Omit<PackageOptions, "outputPath"> & {
+    outputDir: string;
+}): Promise<{
+    outputDir: string;
+    fileCount: number;
+}>;
 declare function packageCourse(options: PackageOptions): Promise<{
     outputPath: string;
     fileCount: number;
@@ -51,21 +73,19 @@ declare function packageStandaloneDir(options: Omit<PackageOptions, "outputPath"
     fileCount: number;
 }>;
 
+/** Omit embedded quiz data from lesson SCOs; limit assessment SCOs to one quiz. */
+declare function sliceAssessmentBundleForActivity(bundle: RuntimeAssessmentBundle, activityId: string, activityKind: "lesson" | "assessment"): RuntimeAssessmentBundle;
+
 /** JSON safe to embed in HTML script blocks (prevents `</script>` breakout). */
 declare function safeJsonForHtml(value: unknown): string;
 
 /** Stable slug for ZIP filenames and SCORM identifiers. */
 declare function courseSlug(manifest: CourseManifest): string;
 
-interface CourseActivity {
-    id: string;
-    title: string;
-    kind: "lesson" | "assessment";
-}
-declare function listCourseActivities(manifest: CourseManifest): CourseActivity[];
-
 declare function scoLaunchPath(activityId: string): string;
-declare function buildScorm2004ManifestFiles(manifest: CourseManifest, courseFiles: string[]): string[];
-declare function generateScorm2004Manifest(manifest: CourseManifest, courseFiles: string[]): string;
+declare function buildScorm2004ManifestFiles(manifest: CourseManifest, courseFiles: string[], hasComponentsBundle?: boolean): string[];
+declare function generateScorm2004Manifest(manifest: CourseManifest, courseFiles: string[], options?: {
+    hasComponentsBundle?: boolean;
+}): string;
 
-export { type BuildHtmlOptions, type CourseActivity, type ExportTarget, type PackageOptions, buildIndexHtml, buildManifestFileList, buildRuntimeConfig, buildScoIndexHtml, buildScorm2004ManifestFiles, collectFiles, courseSlug, generateImsManifest, generateScorm2004Manifest, listCourseActivities, manifestIdentifier, packageCourse, packageScorm2004, packageStandaloneDir, safeJsonForHtml, scoLaunchPath, shouldSkipCourseFile };
+export { type BuildHtmlOptions, type ExportTarget, type PackageOptions, type PackageSink, type PageTemplateOptions, assemblePackage, buildIndexHtml, buildLearnerPageHtml, buildManifestFileList, buildRuntimeConfig, buildScoIndexHtml, buildScorm2004ManifestFiles, collectFiles, courseSlug, generateImsManifest, generateScorm2004Manifest, manifestIdentifier, packageCourse, packageScorm2004, packageScorm2004Dir, packageStandaloneDir, safeJsonForHtml, scoLaunchPath, shouldSkipCourseFile, sliceAssessmentBundleForActivity };

package/dist/index.js

@@ -57,95 +57,102 @@ function safeJsonForHtml(value) {
   return JSON.stringify(value).replace(/</g, "\\u003c");
 }
 
-// src/build-html.ts
-function buildRuntimeConfig(options) {
-  const { manifest, mode, assessmentBundle, activityId } = options;
-  return {
-    manifest,
-    baseUrl: ".",
-    mode,
-    ...activityId ? { activityId } : {},
-    ...assessmentBundle ? {
-      assessments: assessmentBundle.assessments,
-      answerKeys: assessmentBundle.answerKeys,
-      assessmentConfigs: assessmentBundle.configs,
-      assessmentFeedback: assessmentBundle.feedback
-    } : {}
-  };
-}
-function buildScoIndexHtml(options) {
-  const { manifest, runtimeCss, activityId, componentsScript } = options;
-  const config = safeJsonForHtml(buildRuntimeConfig({ ...options, activityId }));
-  const componentsTag = componentsScript ? `<script type="module" src="${escapeHtml(componentsScript)}"></script>` : "";
+// src/page-template.ts
+import { escapeHtml } from "@lxpack/validators";
+function buildLearnerPageHtml(options) {
+  const componentsTag = options.componentsScript ? `<script type="module" src="${escapeHtml(options.componentsScript)}"></script>` : "";
   return `<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>${escapeHtml(manifest.title)} \u2014 ${escapeHtml(activityId)}</title>
-  <style>${runtimeCss}</style>
+  <title>${escapeHtml(options.title)}</title>
+  <style>${options.runtimeCss}</style>
 </head>
 <body>
   <div id="lxpack-app"></div>
-  <script type="application/json" id="lxpack-config">${config}</script>
+  <script type="application/json" id="lxpack-config">${options.configJson}</script>
   <script>
     window.__LXPACK_CONFIG__ = JSON.parse(document.getElementById('lxpack-config').textContent);
   </script>
   ${componentsTag}
-  <script type="module" src="../../lxpack-runtime.js"></script>
+  <script type="module" src="${escapeHtml(options.runtimeScript)}"></script>
 </body>
 </html>`;
 }
+
+// src/build-html.ts
+function buildRuntimeConfig(options) {
+  const { manifest, mode, assessmentBundle, activityId } = options;
+  return {
+    manifest,
+    baseUrl: activityId ? "../.." : ".",
+    mode,
+    ...activityId ? { activityId } : {},
+    ...assessmentBundle ? {
+      ...Object.keys(assessmentBundle.assessments).length ? { assessments: assessmentBundle.assessments } : {},
+      ...Object.keys(assessmentBundle.answerKeys).length ? { answerKeys: assessmentBundle.answerKeys } : {},
+      ...Object.keys(assessmentBundle.configs ?? {}).length ? { assessmentConfigs: assessmentBundle.configs } : {},
+      ...Object.keys(assessmentBundle.feedback ?? {}).length ? { assessmentFeedback: assessmentBundle.feedback } : {}
+    } : {}
+  };
+}
+function buildScoIndexHtml(options) {
+  const { manifest, runtimeCss, activityId, componentsScript } = options;
+  const config = safeJsonForHtml(buildRuntimeConfig({ ...options, activityId }));
+  return buildLearnerPageHtml({
+    title: `${manifest.title} \u2014 ${activityId}`,
+    runtimeCss,
+    configJson: config,
+    runtimeScript: "../../lxpack-runtime.js",
+    componentsScript
+  });
+}
 function buildIndexHtml(options) {
   const { manifest, runtimeCss, componentsScript } = options;
   const config = safeJsonForHtml(buildRuntimeConfig(options));
-  const componentsTag = componentsScript ? `<script type="module" src="${escapeHtml(componentsScript)}"></script>` : "";
-  return `<!DOCTYPE html>
-<html lang="en">
-<head>
-  <meta charset="UTF-8">
-  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>${escapeHtml(manifest.title)}</title>
-  <style>${runtimeCss}</style>
-</head>
-<body>
-  <div id="lxpack-app"></div>
-  <script type="application/json" id="lxpack-config">${config}</script>
-  <script>
-    window.__LXPACK_CONFIG__ = JSON.parse(document.getElementById('lxpack-config').textContent);
-  </script>
-  ${componentsTag}
-  <script type="module" src="./lxpack-runtime.js"></script>
-</body>
-</html>`;
-}
-function escapeHtml(text) {
-  return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+  return buildLearnerPageHtml({
+    title: manifest.title,
+    runtimeCss,
+    configJson: config,
+    runtimeScript: "./lxpack-runtime.js",
+    componentsScript
+  });
 }
 
 // src/package.ts
-import { readFile, readdir, writeFile, mkdir, cp } from "fs/promises";
+import { readFile, readdir, writeFile, mkdir } from "fs/promises";
 import { existsSync } from "fs";
 import { dirname, join, relative } from "path";
 import JSZip from "jszip";
 
-// src/activities.ts
-function listCourseActivities(manifest) {
-  const activities = manifest.lessons.map((lesson) => ({
-    id: lesson.id,
-    title: lesson.title ?? lesson.id,
-    kind: "lesson"
-  }));
-  for (const ref of manifest.assessments ?? []) {
-    activities.push({
-      id: ref.id,
-      title: ref.id.replace(/_/g, " "),
-      kind: "assessment"
-    });
+// src/assessment-slice.ts
+function sliceAssessmentBundleForActivity(bundle, activityId, activityKind) {
+  if (activityKind === "assessment") {
+    const assessment = bundle.assessments[activityId];
+    if (!assessment) {
+      return { assessments: {}, answerKeys: {}, configs: {}, feedback: {} };
+    }
+    return {
+      assessments: { [activityId]: assessment },
+      answerKeys: bundle.answerKeys[activityId] ? { [activityId]: bundle.answerKeys[activityId] } : {},
+      configs: bundle.configs[activityId] ? { [activityId]: bundle.configs[activityId] } : {},
+      feedback: bundle.feedback[activityId] ? { [activityId]: bundle.feedback[activityId] } : {}
+    };
   }
-  return activities;
+  return {
+    assessments: {},
+    answerKeys: {},
+    configs: {},
+    feedback: {}
+  };
 }
 
+// src/activities.ts
+import {
+  enumerateActivities
+} from "@lxpack/validators";
+
 // src/scorm2004-manifest.ts
 function escapeXml2(text) {
   return text.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
@@ -153,20 +160,21 @@ function escapeXml2(text) {
 function scoLaunchPath(activityId) {
   return `sco/${activityId}/index.html`;
 }
-function buildScorm2004ManifestFiles(manifest, courseFiles) {
-  const activities = listCourseActivities(manifest);
+function buildScorm2004ManifestFiles(manifest, courseFiles, hasComponentsBundle = false) {
+  const activities = enumerateActivities(manifest);
   const scoFiles = activities.map((a) => scoLaunchPath(a.id));
   return [
     "lxpack-runtime.js",
-    "lxpack-components.js",
+    ...hasComponentsBundle ? ["lxpack-components.js"] : [],
     ...scoFiles,
     ...courseFiles
   ];
 }
-function generateScorm2004Manifest(manifest, courseFiles) {
+function generateScorm2004Manifest(manifest, courseFiles, options) {
+  const hasComponentsBundle = options?.hasComponentsBundle ?? false;
   const identifier = manifestIdentifier(manifest);
   const orgId = `${identifier}-org`;
-  const activities = listCourseActivities(manifest);
+  const activities = enumerateActivities(manifest);
   const itemEntries = activities.map((activity) => {
     const itemId = `item_${activity.id}`;
     const resourceId = `res_${activity.id}`;
@@ -184,10 +192,11 @@ function generateScorm2004Manifest(manifest, courseFiles) {
   const resources = activities.map((activity) => {
     const resourceId = `res_${activity.id}`;
     const href = scoLaunchPath(activity.id);
+    const componentFile = hasComponentsBundle ? `
+      <file href="lxpack-components.js"/>` : "";
     return `    <resource identifier="${escapeXml2(resourceId)}" type="webcontent" adlcp:scormType="sco" href="${escapeXml2(href)}">
       <file href="${escapeXml2(href)}"/>
-      <file href="lxpack-runtime.js"/>
-      <file href="lxpack-components.js"/>
+      <file href="lxpack-runtime.js"/>${componentFile}
     </resource>`;
   }).join("\n");
   const orgSequencing = `
@@ -209,7 +218,8 @@ function generateScorm2004Manifest(manifest, courseFiles) {
     <schemaversion>2004 4th Edition</schemaversion>
   </metadata>
   <organizations default="${escapeXml2(orgId)}">
-    <organization identifier="${escapeXml2(orgId)}">${orgSequencing}
+    <organization identifier="${escapeXml2(orgId)}">
+      <title>${escapeXml2(manifest.title)}</title>${orgSequencing}
 ${itemEntries}
     </organization>
   </organizations>
@@ -217,8 +227,7 @@ ${itemEntries}
 ${resources}
     <resource identifier="shared_assets" type="webcontent" adlcp:scormType="asset">
 ${uniqueCourseFiles}
-      <file href="lxpack-runtime.js"/>
-      <file href="lxpack-components.js"/>
+      <file href="lxpack-runtime.js"/>${hasComponentsBundle ? '\n      <file href="lxpack-components.js"/>' : ""}
     </resource>
   </resources>
 </manifest>`;
@@ -265,43 +274,119 @@ async function collectFiles(dir, baseDir) {
 function buildManifestFileList(courseFiles) {
   return ["index.html", "lxpack-runtime.js", ...courseFiles.map((f) => f.path)];
 }
-async function packageScorm2004(options) {
+async function writeSingleScoArtifacts(options) {
   const {
     courseDir,
     manifest,
-    outputPath,
+    target,
     runtimeClientJs,
     runtimeCss,
+    assessmentBundle,
     componentsBundleJs,
-    assessmentBundle
+    writeFile: writeArtifact
+  } = options;
+  const mode = target === "scorm12" ? "scorm12" : "standalone";
+  const courseFiles = await collectFiles(courseDir, courseDir);
+  let fileCount = 0;
+  for (const file of courseFiles) {
+    const content = await readFile(file.fullPath);
+    await writeArtifact(file.path, content);
+    fileCount++;
+  }
+  const indexHtml = buildIndexHtml({
+    manifest,
+    runtimeCss,
+    mode,
+    assessmentBundle,
+    componentsScript: componentsBundleJs ? "./lxpack-components.js" : void 0
+  });
+  await writeArtifact("index.html", indexHtml);
+  await writeArtifact("lxpack-runtime.js", runtimeClientJs);
+  fileCount += 2;
+  if (componentsBundleJs) {
+    await writeArtifact("lxpack-components.js", componentsBundleJs);
+    fileCount++;
+  }
+  if (target === "scorm12") {
+    const manifestFiles = buildManifestFileList(courseFiles);
+    await writeArtifact(
+      "imsmanifest.xml",
+      generateImsManifest(manifest, manifestFiles)
+    );
+    fileCount++;
+  }
+  return { fileCount };
+}
+async function assemblePackage(options, sink) {
+  if (options.target === "scorm2004") {
+    return writeScorm2004Artifacts({ ...options, writeFile: sink.writeFile });
+  }
+  return writeSingleScoArtifacts({ ...options, writeFile: sink.writeFile });
+}
+async function writeScorm2004Artifacts(options) {
+  const {
+    courseDir,
+    manifest,
+    runtimeClientJs,
+    runtimeCss,
+    componentsBundleJs,
+    assessmentBundle,
+    writeFile: writeArtifact
   } = options;
-  const zip = new JSZip();
   const courseFiles = await collectFiles(courseDir, courseDir);
+  let fileCount = 0;
   for (const file of courseFiles) {
     const content = await readFile(file.fullPath);
-    zip.file(file.path, content);
+    await writeArtifact(file.path, content);
+    fileCount++;
   }
-  zip.file("lxpack-runtime.js", runtimeClientJs);
+  await writeArtifact("lxpack-runtime.js", runtimeClientJs);
+  fileCount++;
   if (componentsBundleJs) {
-    zip.file("lxpack-components.js", componentsBundleJs);
+    await writeArtifact("lxpack-components.js", componentsBundleJs);
+    fileCount++;
   }
-  const activities = listCourseActivities(manifest);
+  const activities = enumerateActivities(manifest);
   for (const activity of activities) {
+    const scoBundle = assessmentBundle != null ? sliceAssessmentBundleForActivity(
+      assessmentBundle,
+      activity.id,
+      activity.kind
+    ) : void 0;
     const html = buildScoIndexHtml({
       manifest,
       runtimeCss,
       mode: "scorm2004",
       activityId: activity.id,
-      assessmentBundle,
+      assessmentBundle: scoBundle,
       componentsScript: componentsBundleJs ? "../../lxpack-components.js" : void 0
     });
-    zip.file(`sco/${activity.id}/index.html`, html);
+    await writeArtifact(`sco/${activity.id}/index.html`, html);
+    fileCount++;
   }
   const manifestFiles = buildScorm2004ManifestFiles(
     manifest,
-    courseFiles.map((f) => f.path)
+    courseFiles.map((f) => f.path),
+    Boolean(componentsBundleJs)
+  );
+  await writeArtifact(
+    "imsmanifest.xml",
+    generateScorm2004Manifest(manifest, manifestFiles, {
+      hasComponentsBundle: Boolean(componentsBundleJs)
+    })
   );
-  zip.file("imsmanifest.xml", generateScorm2004Manifest(manifest, manifestFiles));
+  fileCount++;
+  return { fileCount };
+}
+async function packageScorm2004(options) {
+  const { outputPath, ...rest } = options;
+  const zip = new JSZip();
+  const { fileCount } = await writeScorm2004Artifacts({
+    ...rest,
+    writeFile: async (relPath, content) => {
+      zip.file(relPath, content);
+    }
+  });
   const buffer = await zip.generateAsync({
     type: "nodebuffer",
     compression: "DEFLATE"
@@ -309,49 +394,36 @@ async function packageScorm2004(options) {
   await writeFile(outputPath, buffer);
   return {
     outputPath,
-    fileCount: Object.keys(zip.files).length
+    fileCount: Object.keys(zip.files).length || fileCount
   };
 }
+async function packageScorm2004Dir(options) {
+  const { outputDir, ...rest } = options;
+  await mkdir(outputDir, { recursive: true });
+  const { fileCount } = await writeScorm2004Artifacts({
+    ...rest,
+    writeFile: async (relPath, content) => {
+      const dest = join(outputDir, relPath);
+      const destDir = dirname(dest);
+      if (!existsSync(destDir)) {
+        await mkdir(destDir, { recursive: true });
+      }
+      await writeFile(dest, content);
+    }
+  });
+  return { outputDir, fileCount };
+}
 async function packageCourse(options) {
   if (options.target === "scorm2004") {
     return packageScorm2004(options);
   }
-  const {
-    courseDir,
-    manifest,
-    outputPath,
-    target,
-    runtimeClientJs,
-    runtimeCss,
-    assessmentBundle,
-    componentsBundleJs
-  } = options;
+  const { outputPath, ...rest } = options;
   const zip = new JSZip();
-  const mode = target === "scorm12" ? "scorm12" : "standalone";
-  const courseFiles = await collectFiles(courseDir, courseDir);
-  for (const file of courseFiles) {
-    const content = await readFile(file.fullPath);
-    zip.file(file.path, content);
-  }
-  const indexHtml = buildIndexHtml({
-    manifest,
-    runtimeCss,
-    mode,
-    assessmentBundle,
-    componentsScript: componentsBundleJs ? "./lxpack-components.js" : void 0
+  const { fileCount } = await assemblePackage(rest, {
+    writeFile: async (relPath, content) => {
+      zip.file(relPath, content);
+    }
   });
-  zip.file("index.html", indexHtml);
-  zip.file("lxpack-runtime.js", runtimeClientJs);
-  if (componentsBundleJs) {
-    zip.file("lxpack-components.js", componentsBundleJs);
-  }
-  if (target === "scorm12") {
-    const manifestFiles = buildManifestFileList(courseFiles);
-    zip.file(
-      "imsmanifest.xml",
-      generateImsManifest(manifest, manifestFiles)
-    );
-  }
   const buffer = await zip.generateAsync({
     type: "nodebuffer",
     compression: "DEFLATE"
@@ -359,7 +431,7 @@ async function packageCourse(options) {
   await writeFile(outputPath, buffer);
   return {
     outputPath,
-    fileCount: Object.keys(zip.files).length
+    fileCount: Object.keys(zip.files).length || fileCount
   };
 }
 async function packageStandaloneDir(options) {
@@ -370,42 +442,41 @@ async function packageStandaloneDir(options) {
     target,
     runtimeClientJs,
     runtimeCss,
-    assessmentBundle
+    assessmentBundle,
+    componentsBundleJs
   } = options;
   await mkdir(outputDir, { recursive: true });
-  const mode = target === "scorm12" ? "scorm12" : "standalone";
-  const courseFiles = await collectFiles(courseDir, courseDir);
-  let fileCount = 0;
-  for (const file of courseFiles) {
-    const dest = join(outputDir, file.path);
-    const destDir = dirname(dest);
-    if (!existsSync(destDir)) {
-      await mkdir(destDir, { recursive: true });
+  const { fileCount } = await assemblePackage(
+    {
+      courseDir,
+      manifest,
+      target,
+      runtimeClientJs,
+      runtimeCss,
+      assessmentBundle,
+      componentsBundleJs
+    },
+    {
+      writeFile: async (relPath, content) => {
+        const dest = join(outputDir, relPath);
+        const destDir = dirname(dest);
+        if (!existsSync(destDir)) {
+          await mkdir(destDir, { recursive: true });
+        }
+        if (typeof content === "string") {
+          await writeFile(dest, content);
+        } else {
+          await writeFile(dest, content);
+        }
+      }
     }
-    await cp(file.fullPath, dest);
-    fileCount++;
-  }
-  const indexHtml = buildIndexHtml({
-    manifest,
-    runtimeCss,
-    mode,
-    assessmentBundle
-  });
-  await writeFile(join(outputDir, "index.html"), indexHtml);
-  await writeFile(join(outputDir, "lxpack-runtime.js"), runtimeClientJs);
-  fileCount += 2;
-  if (target === "scorm12") {
-    const manifestFiles = buildManifestFileList(courseFiles);
-    await writeFile(
-      join(outputDir, "imsmanifest.xml"),
-      generateImsManifest(manifest, manifestFiles)
-    );
-    fileCount++;
-  }
+  );
   return { outputDir, fileCount };
 }
 export {
+  assemblePackage,
   buildIndexHtml,
+  buildLearnerPageHtml,
   buildManifestFileList,
   buildRuntimeConfig,
   buildScoIndexHtml,
@@ -414,12 +485,14 @@ export {
   courseSlug,
   generateImsManifest,
   generateScorm2004Manifest,
-  listCourseActivities,
+  enumerateActivities as listCourseActivities,
   manifestIdentifier,
   packageCourse,
   packageScorm2004,
+  packageScorm2004Dir,
   packageStandaloneDir,
   safeJsonForHtml,
   scoLaunchPath,
-  shouldSkipCourseFile
+  shouldSkipCourseFile,
+  sliceAssessmentBundleForActivity
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lxpack/scorm",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "SCORM and standalone HTML export for LXPack",
   "license": "Apache-2.0",
   "repository": {
@@ -39,7 +39,7 @@
   ],
   "dependencies": {
     "jszip": "^3.10.1",
-    "@lxpack/validators": "0.2.0"
+    "@lxpack/validators": "0.2.1"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",