feat: Add zip extraction to server

Author: andre-dietrich

dist/index.js

@@ -51,10 +51,14 @@
   "author": "André Dietrich",
   "license": "ISC",
   "dependencies": {
+    "@fastify/multipart": "^8.1.0",
+    "@fastify/static": "^7.0.1",
     "@liascript/simple-scorm-packager": "^0.3.0",
     "@types/fs-extra": "^11.0.4",
+    "@types/unzipper": "^0.10.11",
     "archiver": "^7.0.1",
     "epub-gen": "^0.1.0",
+    "fastify": "^4.26.0",
     "fs-extra": "^11.3.3",
     "jsonld": "^9.0.0",
     "minimist": "^1.2.5",
@@ -64,11 +68,9 @@
     "simply-beautiful": "^1.0.1",
     "temp": "^0.9.4",
     "typescript": "^5.9.3",
+    "unzipper": "^0.12.3",
     "xhr2": "^0.2.1",
-    "yaml": "^2.8.2",
-    "fastify": "^4.26.0",
-    "@fastify/multipart": "^8.1.0",
-    "@fastify/static": "^7.0.1"
+    "yaml": "^2.8.2"
   },
   "devDependencies": {
     "@parcel/transformer-elm": "^2.16.3",

package-lock.json

@@ -169,13 +169,19 @@ export class JobQueue extends EventEmitter {
           job.source.files &&
           job.source.files.length > 0
         ) {
-          // Use the first file (README.md or similar)
-          const readmeFile = job.source.files.find(
-            (f) =>
-              f.filename === 'README.md' ||
-              f.filename.toLowerCase().endsWith('.md'),
-          )
-          inputFile = readmeFile ? readmeFile.path : job.source.files[0].path
+          // Check if we have a main file from ZIP extraction
+          if ((job.source as any).mainFile) {
+            inputFile = (job.source as any).mainFile
+            console.log(`Using main markdown from ZIP: ${inputFile}`)
+          } else {
+            // Use the first markdown file or fallback to first file
+            const readmeFile = job.source.files.find(
+              (f) =>
+                f.filename === 'README.md' ||
+                f.filename.toLowerCase().endsWith('.md'),
+            )
+            inputFile = readmeFile ? readmeFile.path : job.source.files[0].path
+          }
         } else if (job.source.type === 'git' && job.source.gitUrl) {
           // For git repos, we'd need to clone first - not implemented yet
           throw new Error('Git repository export not yet implemented')

package.json

@@ -7,6 +7,7 @@ import { tmpdir } from 'os'
 import { fileURLToPath } from 'url'
 import { dirname } from 'path'
 import * as YAML from 'yaml'
+import { extractZip, findMainMarkdown, isZipFile } from '../utils/zipExtractor'
 
 export const exportRouter: FastifyPluginAsync = async (fastify) => {
   // GET /api/presets - Get available presets configuration
@@ -51,14 +52,13 @@ export const exportRouter: FastifyPluginAsync = async (fastify) => {
       if (request.isMultipart()) {
         const parts = request.parts()
         const files: any[] = []
+        const uploadId = randomUUID()
+        const uploadDir = join(tmpdir(), 'liaex-uploads', uploadId)
+        await mkdir(uploadDir, { recursive: true })
 
         for await (const part of parts) {
           if (part.type === 'file') {
             // Save file temporarily
-            const uploadId = randomUUID()
-            const uploadDir = join(tmpdir(), 'liaex-uploads', uploadId)
-            await mkdir(uploadDir, { recursive: true })
-
             const filepath = join(uploadDir, part.filename)
             const buffer = await part.toBuffer()
             await writeFile(filepath, buffer)
@@ -93,6 +93,36 @@ export const exportRouter: FastifyPluginAsync = async (fastify) => {
         if (files.length > 0) {
           jobData.source.type = 'upload'
           jobData.source.files = files
+          jobData.source.uploadDir = uploadDir
+
+          // Check if any file is a ZIP - extract it
+          const zipFile = files.find((f) => isZipFile(f.filename))
+          if (zipFile) {
+            fastify.log.info(`Extracting ZIP file: ${zipFile.filename}`)
+
+            // Create extraction directory
+            const extractDir = join(uploadDir, 'extracted')
+            await mkdir(extractDir, { recursive: true })
+
+            // Extract ZIP
+            await extractZip(zipFile.path, extractDir)
+            fastify.log.info(`ZIP extracted to: ${extractDir}`)
+
+            // Find main markdown file
+            const mainMarkdown = await findMainMarkdown(extractDir)
+            if (!mainMarkdown) {
+              return reply.code(400).send({
+                error:
+                  'No markdown file found in ZIP archive. Please include a README.md or any .md file.',
+              })
+            }
+
+            fastify.log.info(`Found main markdown: ${mainMarkdown}`)
+
+            // Update job data with extracted markdown
+            jobData.source.mainFile = mainMarkdown
+            jobData.source.extractedFrom = zipFile.filename
+          }
         } else if (jobData.source.gitUrl) {
           jobData.source.type = 'git'
         } else {

src/server/queue/jobQueue.ts

@@ -0,0 +1,93 @@
+import { createReadStream } from 'fs'
+import { readdir, stat } from 'fs/promises'
+import { join, extname } from 'path'
+import unzipper from 'unzipper'
+
+/**
+ * Extracts a ZIP file to a target directory
+ * @param zipPath Path to the ZIP file
+ * @param extractPath Path where to extract the ZIP contents
+ */
+export async function extractZip(
+  zipPath: string,
+  extractPath: string,
+): Promise<void> {
+  return new Promise((resolve, reject) => {
+    createReadStream(zipPath)
+      .pipe(unzipper.Extract({ path: extractPath }))
+      .on('close', resolve)
+      .on('error', reject)
+  })
+}
+
+/**
+ * Recursively finds all markdown files in a directory
+ * @param dir Directory to search
+ * @param files Array to collect found files (used internally for recursion)
+ * @returns Array of markdown file paths
+ */
+async function findMarkdownFiles(
+  dir: string,
+  files: string[] = [],
+): Promise<string[]> {
+  const entries = await readdir(dir)
+
+  for (const entry of entries) {
+    const fullPath = join(dir, entry)
+    const stats = await stat(fullPath)
+
+    if (stats.isDirectory()) {
+      // Skip common non-content directories
+      if (
+        !entry.startsWith('.') &&
+        entry !== 'node_modules' &&
+        entry !== 'dist' &&
+        entry !== 'build'
+      ) {
+        await findMarkdownFiles(fullPath, files)
+      }
+    } else if (stats.isFile() && extname(entry).toLowerCase() === '.md') {
+      files.push(fullPath)
+    }
+  }
+
+  return files
+}
+
+/**
+ * Finds the main markdown file in a directory
+ * Priority:
+ * 1. README.md (case insensitive)
+ * 2. First markdown file found
+ * @param dir Directory to search
+ * @returns Path to the main markdown file or null if none found
+ */
+export async function findMainMarkdown(dir: string): Promise<string | null> {
+  const markdownFiles = await findMarkdownFiles(dir)
+
+  if (markdownFiles.length === 0) {
+    return null
+  }
+
+  // Look for README.md (case insensitive)
+  const readmeFile = markdownFiles.find((file) => {
+    const filename = file.split('/').pop()?.toLowerCase()
+    return filename === 'readme.md'
+  })
+
+  if (readmeFile) {
+    return readmeFile
+  }
+
+  // Return first markdown file found
+  return markdownFiles[0]
+}
+
+/**
+ * Checks if a file is a ZIP file based on its extension
+ * @param filename Filename to check
+ * @returns true if the file is a ZIP file
+ */
+export function isZipFile(filename: string): boolean {
+  return extname(filename).toLowerCase() === '.zip'
+}