@learnpack/learnpack 5.0.335 → 5.0.339

package/src/utils/export/index.ts

@@ -1,4 +1,4 @@
-export { exportToScorm } from "./scorm";
-export { exportToEpub } from "./epub";
-export { exportToZip } from "./zip";
-export { ExportFormat, ExportOptions, EpubMetadata } from "./types";
+export { exportToScorm } from "./scorm";
+export { exportToEpub } from "./epub";
+export { exportToZip } from "./zip";
+export { ExportFormat, ExportOptions, EpubMetadata } from "./types";

package/src/utils/export/scorm.ts

@@ -1,121 +1,121 @@
-import * as path from "path";
-import * as fs from "fs";
-import * as archiver from "archiver";
-import * as mkdirp from "mkdirp";
-import * as rimraf from "rimraf";
-import { v4 as uuidv4 } from "uuid";
-import { ExportOptions, CourseMetadata } from "./types";
-import {
-  copyDir,
-  downloadS3Folder,
-  getFilesList,
-  getCourseMetadata,
-} from "./shared";
-
-export async function exportToScorm(options: ExportOptions): Promise<string> {
-  const { courseSlug, bucket, outDir } = options;
-
-  // 1. Create temporary folder
-  const tmpName = uuidv4();
-  const scormOutDir = path.join(outDir, tmpName);
-  rimraf.sync(scormOutDir);
-  mkdirp.sync(scormOutDir);
-
-  // 2. Copy SCORM template
-  const scormTpl = path.join(__dirname, "../templates/scorm");
-  copyDir(scormTpl, scormOutDir);
-
-  // Paths
-  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 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);
-      }
-    }
-  }
-
-  // 3. Download exercises and .learn from bucket
-  await downloadS3Folder(
-    bucket,
-    `courses/${courseSlug}/exercises/`,
-    path.join(scormOutDir, "exercises")
-  );
-  await downloadS3Folder(
-    bucket,
-    `courses/${courseSlug}/.learn/`,
-    path.join(scormOutDir, ".learn")
-  );
-
-  // 4. Read learn.json for course info
-  const learnJson = await getCourseMetadata(bucket, 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
-  );
-
-  // Generate exercises list
-  const exercisesList = getFilesList(
-    path.join(scormOutDir, "exercises"),
-    "exercises"
-  ).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);
-
-  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
-  );
-  fs.writeFileSync(configIndexPath, indexHtml, "utf-8");
-
-  // 7. Compress as ZIP
-  const zipPath = `${scormOutDir}.zip`;
-  await new Promise((resolve: any, reject: any) => {
-    const output = fs.createWriteStream(zipPath);
-    const archive = archiver("zip", { zlib: { level: 9 } });
-
-    output.on("close", resolve);
-    archive.on("error", reject);
-
-    archive.pipe(output);
-    archive.directory(scormOutDir, false);
-    archive.finalize();
-  });
-
-  // Clean up temporary directory
-  rimraf.sync(scormOutDir);
-
-  return zipPath;
-}
+import * as path from "path";
+import * as fs from "fs";
+import * as archiver from "archiver";
+import * as mkdirp from "mkdirp";
+import * as rimraf from "rimraf";
+import { v4 as uuidv4 } from "uuid";
+import { ExportOptions, CourseMetadata } from "./types";
+import {
+  copyDir,
+  downloadS3Folder,
+  getFilesList,
+  getCourseMetadata,
+} from "./shared";
+
+export async function exportToScorm(options: ExportOptions): Promise<string> {
+  const { courseSlug, bucket, outDir } = options;
+
+  // 1. Create temporary folder
+  const tmpName = uuidv4();
+  const scormOutDir = path.join(outDir, tmpName);
+  rimraf.sync(scormOutDir);
+  mkdirp.sync(scormOutDir);
+
+  // 2. Copy SCORM template
+  const scormTpl = path.join(__dirname, "../templates/scorm");
+  copyDir(scormTpl, scormOutDir);
+
+  // Paths
+  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 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);
+      }
+    }
+  }
+
+  // 3. Download exercises and .learn from bucket
+  await downloadS3Folder(
+    bucket,
+    `courses/${courseSlug}/exercises/`,
+    path.join(scormOutDir, "exercises")
+  );
+  await downloadS3Folder(
+    bucket,
+    `courses/${courseSlug}/.learn/`,
+    path.join(scormOutDir, ".learn")
+  );
+
+  // 4. Read learn.json for course info
+  const learnJson = await getCourseMetadata(bucket, 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
+  );
+
+  // Generate exercises list
+  const exercisesList = getFilesList(
+    path.join(scormOutDir, "exercises"),
+    "exercises"
+  ).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);
+
+  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
+  );
+  fs.writeFileSync(configIndexPath, indexHtml, "utf-8");
+
+  // 7. Compress as ZIP
+  const zipPath = `${scormOutDir}.zip`;
+  await new Promise((resolve: any, reject: any) => {
+    const output = fs.createWriteStream(zipPath);
+    const archive = archiver("zip", { zlib: { level: 9 } });
+
+    output.on("close", resolve);
+    archive.on("error", reject);
+
+    archive.pipe(output);
+    archive.directory(scormOutDir, false);
+    archive.finalize();
+  });
+
+  // Clean up temporary directory
+  rimraf.sync(scormOutDir);
+
+  return zipPath;
+}

package/src/utils/export/shared.ts

@@ -1,61 +1,61 @@
-import * as path from "path";
-import * as fs from "fs";
-import * as mkdirp from "mkdirp";
-
-// Utility function to copy directory recursively
-export function copyDir(src: string, dest: string) {
-  if (!fs.existsSync(dest)) mkdirp.sync(dest);
-  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
-    const srcPath = path.join(src, entry.name);
-    const destPath = path.join(dest, entry.name);
-    if (entry.isDirectory()) {
-      copyDir(srcPath, destPath);
-    } else {
-      fs.copyFileSync(srcPath, destPath);
-    }
-  }
-}
-
-// Download all files from a GCS Bucket prefix to a local folder
-export async function downloadS3Folder(
-  bucket: any,
-  prefix: string,
-  localPath: string
-) {
-  const [files] = await bucket.getFiles({ prefix });
-  for (const file of files) {
-    const relPath = file.name.replace(prefix, "");
-    if (!relPath) continue;
-    const outPath = path.join(localPath, relPath);
-    mkdirp.sync(path.dirname(outPath));
-    // esling-disable-next-line
-    const [buf] = await file.download();
-    fs.writeFileSync(outPath, buf);
-  }
-}
-
-// Generate file list for manifest, given a folder
-export function getFilesList(folder: string, base: string) {
-  let list: string[] = [];
-  const files = fs.readdirSync(folder, { withFileTypes: true });
-  for (const file of files) {
-    const filePath = path.join(folder, file.name);
-    if (file.isDirectory()) {
-      // esling-disable-next-line
-      list = list.concat(getFilesList(filePath, path.join(base, file.name)));
-    } else {
-      list.push(
-        `<file href="${path.join(base, file.name).replace(/\\/g, "/")}" />`
-      );
-    }
-  }
-  return list;
-}
-
-// Read course metadata from learn.json
-export async function getCourseMetadata(bucket: any, courseSlug: string) {
-  const [learnBuf] = await bucket
-    .file(`courses/${courseSlug}/learn.json`)
-    .download();
-  return JSON.parse(learnBuf.toString());
-}
+import * as path from "path";
+import * as fs from "fs";
+import * as mkdirp from "mkdirp";
+
+// Utility function to copy directory recursively
+export function copyDir(src: string, dest: string) {
+  if (!fs.existsSync(dest)) mkdirp.sync(dest);
+  for (const entry of fs.readdirSync(src, { withFileTypes: true })) {
+    const srcPath = path.join(src, entry.name);
+    const destPath = path.join(dest, entry.name);
+    if (entry.isDirectory()) {
+      copyDir(srcPath, destPath);
+    } else {
+      fs.copyFileSync(srcPath, destPath);
+    }
+  }
+}
+
+// Download all files from a GCS Bucket prefix to a local folder
+export async function downloadS3Folder(
+  bucket: any,
+  prefix: string,
+  localPath: string
+) {
+  const [files] = await bucket.getFiles({ prefix });
+  for (const file of files) {
+    const relPath = file.name.replace(prefix, "");
+    if (!relPath) continue;
+    const outPath = path.join(localPath, relPath);
+    mkdirp.sync(path.dirname(outPath));
+    // esling-disable-next-line
+    const [buf] = await file.download();
+    fs.writeFileSync(outPath, buf);
+  }
+}
+
+// Generate file list for manifest, given a folder
+export function getFilesList(folder: string, base: string) {
+  let list: string[] = [];
+  const files = fs.readdirSync(folder, { withFileTypes: true });
+  for (const file of files) {
+    const filePath = path.join(folder, file.name);
+    if (file.isDirectory()) {
+      // esling-disable-next-line
+      list = list.concat(getFilesList(filePath, path.join(base, file.name)));
+    } else {
+      list.push(
+        `<file href="${path.join(base, file.name).replace(/\\/g, "/")}" />`
+      );
+    }
+  }
+  return list;
+}
+
+// Read course metadata from learn.json
+export async function getCourseMetadata(bucket: any, courseSlug: string) {
+  const [learnBuf] = await bucket
+    .file(`courses/${courseSlug}/learn.json`)
+    .download();
+  return JSON.parse(learnBuf.toString());
+}

package/src/utils/export/types.ts

@@ -1,25 +1,25 @@
-export type ExportFormat = "scorm" | "epub" | "zip";
-
-export interface ExportOptions {
-  courseSlug: string;
-  format: ExportFormat;
-  bucket: any; // Google Cloud Storage Bucket
-  outDir: string;
-  language?: string; // Optional language parameter for EPUB export
-}
-
-export interface EpubMetadata {
-  creator: string;
-  publisher: string;
-  title: string;
-  rights: string;
-  lang: string;
-}
-
-export interface CourseMetadata {
-  title: string;
-  description?: string;
-  language?: string;
-  technologies?: string[];
-  difficulty?: string;
-}
+export type ExportFormat = "scorm" | "epub" | "zip";
+
+export interface ExportOptions {
+  courseSlug: string;
+  format: ExportFormat;
+  bucket: any; // Google Cloud Storage Bucket
+  outDir: string;
+  language?: string; // Optional language parameter for EPUB export
+}
+
+export interface EpubMetadata {
+  creator: string;
+  publisher: string;
+  title: string;
+  rights: string;
+  lang: string;
+}
+
+export interface CourseMetadata {
+  title: string;
+  description?: string;
+  language?: string;
+  technologies?: string[];
+  difficulty?: string;
+}

package/src/utils/export/zip.ts

@@ -1,55 +1,55 @@
-import * as path from "path";
-import * as fs from "fs";
-import * as archiver from "archiver";
-import * as mkdirp from "mkdirp";
-import * as rimraf from "rimraf";
-import { v4 as uuidv4 } from "uuid";
-import { ExportOptions } from "./types";
-import { downloadS3Folder, getCourseMetadata } from "./shared";
-
-export async function exportToZip(options: ExportOptions): Promise<string> {
-  const { courseSlug, bucket, outDir } = options;
-
-  // 1. Create temporary folder
-  const tmpName = uuidv4();
-  const zipOutDir = path.join(outDir, tmpName);
-  rimraf.sync(zipOutDir);
-  mkdirp.sync(zipOutDir);
-
-  // 2. Download all course files from bucket to temporary directory
-  await downloadS3Folder(bucket, `courses/${courseSlug}/`, zipOutDir);
-
-  // 3. Create ZIP file
-  const zipName = `${courseSlug}.zip`;
-  const zipPath = path.join(outDir, zipName);
-
-  // Remove existing zip file if it exists
-  if (fs.existsSync(zipPath)) {
-    fs.unlinkSync(zipPath);
-  }
-
-  const output = fs.createWriteStream(zipPath);
-  const archive = archiver("zip", { zlib: { level: 9 } });
-
-  return new Promise((resolve, reject) => {
-    output.on("close", () => {
-      console.log(`✅ ZIP export completed: ${archive.pointer()} total bytes`);
-      // Clean up temporary directory
-      rimraf.sync(zipOutDir);
-      resolve(zipPath);
-    });
-
-    archive.on("error", (err) => {
-      console.error("❌ ZIP creation error:", err);
-      rimraf.sync(zipOutDir);
-      reject(err);
-    });
-
-    archive.pipe(output);
-
-    // Add all files from the temporary directory to the ZIP
-    archive.directory(zipOutDir, false);
-
-    archive.finalize();
-  });
-}
+import * as path from "path";
+import * as fs from "fs";
+import * as archiver from "archiver";
+import * as mkdirp from "mkdirp";
+import * as rimraf from "rimraf";
+import { v4 as uuidv4 } from "uuid";
+import { ExportOptions } from "./types";
+import { downloadS3Folder, getCourseMetadata } from "./shared";
+
+export async function exportToZip(options: ExportOptions): Promise<string> {
+  const { courseSlug, bucket, outDir } = options;
+
+  // 1. Create temporary folder
+  const tmpName = uuidv4();
+  const zipOutDir = path.join(outDir, tmpName);
+  rimraf.sync(zipOutDir);
+  mkdirp.sync(zipOutDir);
+
+  // 2. Download all course files from bucket to temporary directory
+  await downloadS3Folder(bucket, `courses/${courseSlug}/`, zipOutDir);
+
+  // 3. Create ZIP file
+  const zipName = `${courseSlug}.zip`;
+  const zipPath = path.join(outDir, zipName);
+
+  // Remove existing zip file if it exists
+  if (fs.existsSync(zipPath)) {
+    fs.unlinkSync(zipPath);
+  }
+
+  const output = fs.createWriteStream(zipPath);
+  const archive = archiver("zip", { zlib: { level: 9 } });
+
+  return new Promise((resolve, reject) => {
+    output.on("close", () => {
+      console.log(`✅ ZIP export completed: ${archive.pointer()} total bytes`);
+      // Clean up temporary directory
+      rimraf.sync(zipOutDir);
+      resolve(zipPath);
+    });
+
+    archive.on("error", (err) => {
+      console.error("❌ ZIP creation error:", err);
+      rimraf.sync(zipOutDir);
+      reject(err);
+    });
+
+    archive.pipe(output);
+
+    // Add all files from the temporary directory to the ZIP
+    archive.directory(zipOutDir, false);
+
+    archive.finalize();
+  });
+}

package/src/utils/readmeSanitizer.ts

@@ -0,0 +1,10 @@
+/**
+ * Replaces sequences of 3+ newlines (with optional spaces in between)
+ * with a single double newline. Prevents excessive whitespace that can
+ * cause translation API token limit issues.
+ * @param content - Raw README string
+ * @returns Sanitized string
+ */
+export function sanitizeReadmeNewlines(content: string): string {
+  return content.replace(/(\n\s*){3,}/g, "\n\n")
+}