@learnpack/learnpack 5.0.348 → 5.0.349

package/src/utils/export/scorm.ts

@@ -10,6 +10,7 @@ import {
   downloadS3Folder,
   getFilesList,
   getCourseMetadata,
+  escapeXml,
 } from "./shared";
 
 export async function exportToScorm(options: ExportOptions): Promise<string> {
@@ -29,24 +30,28 @@ export async function exportToScorm(options: ExportOptions): Promise<string> {
   const appDir = path.resolve(__dirname, "../../ui/_app");
   const configDir = path.join(scormOutDir, "config");
 
-  // Check if _app exists and has content
-  if (fs.existsSync(appDir) && fs.readdirSync(appDir).length > 0) {
-    // Copy app.css and app.js to config/
-    for (const file of ["app.css", "app.js"]) {
-      const src = path.join(appDir, file);
-      const dest = path.join(configDir, file);
-      if (fs.existsSync(src)) {
-        fs.copyFileSync(src, dest);
-      }
+  // Copy the IDE bundle. app.js/app.css are declared as required files in the
+  // manifest, so their absence must be a hard error (otherwise we would ship a
+  // broken, blank package that references non-existent files).
+  for (const file of ["app.css", "app.js"]) {
+    const src = path.join(appDir, file);
+    const dest = path.join(configDir, file);
+    if (!fs.existsSync(src)) {
+      throw new Error(
+        `SCORM export failed: IDE bundle (${file}) not found in ${appDir}. ` +
+          "Ensure the editor was downloaded/extracted before exporting."
+      );
     }
 
-    // Copy logo-192.png and logo-512.png to SCORM build root
-    for (const file of ["logo-192.png", "logo-512.png"]) {
-      const src = path.join(appDir, file);
-      const dest = path.join(scormOutDir, file);
-      if (fs.existsSync(src)) {
-        fs.copyFileSync(src, dest);
-      }
+    fs.copyFileSync(src, dest);
+  }
+
+  // Copy logo-192.png and logo-512.png to SCORM build root (optional assets)
+  for (const file of ["logo-192.png", "logo-512.png"]) {
+    const src = path.join(appDir, file);
+    const dest = path.join(scormOutDir, file);
+    if (fs.existsSync(src)) {
+      fs.copyFileSync(src, dest);
     }
   }
 
@@ -65,14 +70,19 @@ export async function exportToScorm(options: ExportOptions): Promise<string> {
   // 4. Read learn.json for course info
   const learnJson = await getCourseMetadata(bucket, courseSlug);
 
+  // Resolve the course title once, escaped for safe XML/HTML embedding
+  const courseTitle = escapeXml(
+    learnJson.title?.en || learnJson.title || courseSlug
+  );
+
   // 5. Replace imsmanifest.xml
   const manifestPath = path.join(scormOutDir, "imsmanifest.xml");
   let manifest = fs.readFileSync(manifestPath, "utf-8");
-  manifest = manifest.replace(/{{organization_name}}/g, "FourGeeksAcademy");
   manifest = manifest.replace(
-    /{{course_title}}/g,
-    learnJson.title?.en || learnJson.title || courseSlug
+    /{{organization_name}}/g,
+    escapeXml("FourGeeksAcademy")
   );
+  manifest = manifest.replace(/{{course_title}}/g, courseTitle);
 
   // Generate exercises list
   const exercisesList = getFilesList(
@@ -81,23 +91,19 @@ export async function exportToScorm(options: ExportOptions): Promise<string> {
   ).join("\n      ");
   manifest = manifest.replace(/{{exercises_list}}/g, exercisesList);
 
-  // Generate images list (optional, if you have assets)
-  let imagesList = "";
-  const assetsDir = path.join(scormOutDir, ".learn", "assets");
-  if (fs.existsSync(assetsDir)) {
-    imagesList = getFilesList(assetsDir, ".learn/assets").join("\n      ");
-  }
-  manifest = manifest.replace(/{{images_list}}/g, imagesList);
+  // Declare all .learn/ files (config.json + assets) that ship in the package
+  const learnDir = path.join(scormOutDir, ".learn");
+  const learnFilesList = fs.existsSync(learnDir)
+    ? getFilesList(learnDir, ".learn").join("\n      ")
+    : "";
+  manifest = manifest.replace(/{{learn_files_list}}/g, learnFilesList);
 
   fs.writeFileSync(manifestPath, manifest, "utf-8");
 
   // 6. Replace title in config/index.html
   const configIndexPath = path.join(scormOutDir, "config", "index.html");
   let indexHtml = fs.readFileSync(configIndexPath, "utf-8");
-  indexHtml = indexHtml.replace(
-    /{{title}}/g,
-    learnJson.title?.en || learnJson.title || courseSlug
-  );
+  indexHtml = indexHtml.replace(/{{title}}/g, courseTitle);
   fs.writeFileSync(configIndexPath, indexHtml, "utf-8");
 
   // 7. Compress as ZIP

package/src/utils/export/shared.ts

@@ -2,6 +2,16 @@ import * as path from "path";
 import * as fs from "fs";
 import * as mkdirp from "mkdirp";
 
+// Escape a string so it can be safely embedded inside XML text or attributes
+export function escapeXml(value: string): string {
+  return String(value)
+    .replace(/&/g, "&")
+    .replace(/</g, "&lt;")
+    .replace(/>/g, "&gt;")
+    .replace(/"/g, "&quot;")
+    .replace(/'/g, "&apos;");
+}
+
 // Utility function to copy directory recursively
 export function copyDir(src: string, dest: string) {
   if (!fs.existsSync(dest)) mkdirp.sync(dest);
@@ -45,10 +55,13 @@ export function getFilesList(folder: string, base: string) {
       list = list.concat(getFilesList(filePath, path.join(base, file.name)));
     } else {
       list.push(
-        `<file href="${path.join(base, file.name).replace(/\\/g, "/")}" />`
+        `<file href="${escapeXml(
+          path.join(base, file.name).replace(/\\/g, "/")
+        )}" />`
       );
     }
   }
+
   return list;
 }
 

package/src/utils/templates/scorm/config/api.js

@@ -109,6 +109,35 @@ function ScormProcessFinish() {
   }
 }
 
+function ScormProcessCommit() {
+  var result;
+
+  if (initialized == false || finishCalled == true) {
+    return;
+  }
+
+  result = API.LMSCommit("");
+
+  if (result == SCORM_FALSE) {
+    var errorNumber = API.LMSGetLastError();
+    var errorString = API.LMSGetErrorString(errorNumber);
+    var diagnostic = API.LMSGetDiagnostic(errorNumber);
+
+    var errorDescription =
+      "Number: " +
+      errorNumber +
+      "\nDescription: " +
+      errorString +
+      "\nDiagnostic: " +
+      diagnostic;
+
+    alert(
+      "Error - Could not persist data to the LMS.\n\nYour results may not be recorded.\n\n" +
+        errorDescription
+    );
+  }
+}
+
 function ScormProcessGetValue(element) {
   var result;
 

package/src/utils/templates/scorm/imsmanifest.xml

@@ -25,13 +25,12 @@
 
       {{exercises_list}}
 
-      {{images_list}}
+      {{learn_files_list}}
 
       <file href="config/index.html" />
       <file href="config/api.js" />
       <file href="config/app.js" />
       <file href="config/app.css" />
-      <file href="config/config.json" />
 
     </resource>
   </resources>