coursecode 0.1.0

package/lib/manifest/manifest-factory.js

@@ -0,0 +1,99 @@
+/**
+ * @file manifest-factory.js
+ * @description Factory for generating format-specific manifests.
+ */
+
+import { generateScorm2004Manifest } from './scorm-2004-manifest.js';
+import { generateScorm12Manifest } from './scorm-12-manifest.js';
+import { generateCmi5Manifest } from './cmi5-manifest.js';
+import { generateScorm12ProxyManifest, generateScorm2004ProxyManifest } from './scorm-proxy-manifest.js';
+import { generateLtiToolConfig } from './lti-tool-config.js';
+
+/**
+ * Generates the appropriate manifest based on format.
+ * @param {string} format - 'scorm2004' | 'scorm1.2' | 'cmi5' | 'scorm1.2-proxy' | 'scorm2004-proxy' | 'cmi5-remote' | 'lti'
+ * @param {Object} config - Course configuration
+ * @param {string[]} files - List of files to include
+ * @param {Object} options - Additional options (externalUrl for proxy/remote)
+ * @returns {{ filename: string, content: string }} Manifest filename and content
+ */
+export function generateManifest(format, config, files, options = {}) {
+    switch (format) {
+        case 'cmi5':
+            return {
+                filename: 'cmi5.xml',
+                content: generateCmi5Manifest(config, files)
+            };
+
+        case 'cmi5-remote':
+            return {
+                filename: 'cmi5.xml',
+                content: generateCmi5Manifest(config, files, { externalUrl: options.externalUrl })
+            };
+
+        case 'scorm1.2':
+            return {
+                filename: 'imsmanifest.xml',
+                content: generateScorm12Manifest(config, files)
+            };
+
+        case 'scorm1.2-proxy':
+            return {
+                filename: 'imsmanifest.xml',
+                content: generateScorm12ProxyManifest(config)
+            };
+
+        case 'scorm2004-proxy':
+            return {
+                filename: 'imsmanifest.xml',
+                content: generateScorm2004ProxyManifest(config)
+            };
+
+        case 'lti':
+            return {
+                filename: 'lti-tool-config.json',
+                content: generateLtiToolConfig(config, options)
+            };
+
+        case 'scorm2004':
+        default:
+            return {
+                filename: 'imsmanifest.xml',
+                content: generateScorm2004Manifest(config, files)
+            };
+    }
+}
+
+/**
+ * Gets the schema files needed for the format.
+ * @param {string} format - 'scorm2004' | 'scorm1.2' | 'cmi5'
+ * @returns {string[]} List of schema file patterns to copy
+ */
+export function getSchemaFiles(format) {
+    switch (format) {
+        case 'cmi5':
+        case 'lti':
+            // cmi5 and LTI don't require schema files in the package
+            return [];
+
+        case 'scorm1.2':
+            // SCORM 1.2 schema files
+            return [
+                'imscp_rootv1p1p2.xsd',
+                'adlcp_rootv1p2.xsd',
+                'ims_xml.xsd'
+            ];
+
+        case 'scorm2004':
+        default:
+            // SCORM 2004 4th Edition schema files
+            return [
+                'imscp_v1p1.xsd',
+                'adlcp_v1p3.xsd',
+                'imsss_v1p0.xsd',
+                'adlseq_v1p3.xsd',
+                'adlnav_v1p3.xsd',
+                'lom.xsd'
+            ];
+    }
+}

package/lib/manifest/scorm-12-manifest.js

@@ -0,0 +1,61 @@
+/**
+ * @file scorm-12-manifest.js
+ * @description Generates imsmanifest.xml for SCORM 1.2 packages.
+ * 
+ * SCORM 1.2 uses a simpler manifest structure without:
+ * - Sequencing rules (imsss namespace)
+ * - Navigation controls (adlnav namespace)
+ * - 4th Edition schema references
+ */
+
+/**
+ * Generates the SCORM 1.2 manifest.
+ * @param {Object} config - Course configuration
+ * @param {string[]} files - List of files to include in the manifest
+ * @returns {string} The manifest XML
+ */
+export function generateScorm12Manifest(config, files) {
+    const resourceFiles = files.filter(f =>
+        f !== 'imsmanifest.xml' &&
+        !f.endsWith('.xsd') &&
+        !f.endsWith('.dtd') &&
+        !f.startsWith('common/')
+    );
+
+    const fileEntries = resourceFiles.map(f => `      <file href="${f}"/>`).join('\n');
+
+    // SCORM 1.2 uses ADLCP 1.2 schema and doesn't include sequencing
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<!-- SCORM 1.2 manifest - GENERATED FILE - DO NOT EDIT MANUALLY -->
+<manifest identifier="${config.title.replace(/[^a-zA-Z0-9]/g, '-')}"
+          version="${config.version}"
+          xmlns="http://www.imsproject.org/xsd/imscp_rootv1p1p2"
+          xmlns:adlcp="http://www.adlnet.org/xsd/adlcp_rootv1p2"
+          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="
+            http://www.imsproject.org/xsd/imscp_rootv1p1p2 imscp_rootv1p1p2.xsd
+            http://www.adlnet.org/xsd/adlcp_rootv1p2 adlcp_rootv1p2.xsd">
+
+  <metadata>
+    <schema>ADL SCORM</schema>
+    <schemaversion>1.2</schemaversion>
+  </metadata>
+
+  <organizations default="org-1">
+    <organization identifier="org-1">
+      <title>${config.title}</title>
+      <item identifier="item-1" identifierref="res-1" isvisible="true">
+        <title>${config.title}</title>
+        <adlcp:masteryscore>80</adlcp:masteryscore>
+      </item>
+    </organization>
+  </organizations>
+
+  <resources>
+    <resource identifier="res-1" type="webcontent" adlcp:scormtype="sco" href="index.html">
+${fileEntries}
+    </resource>
+  </resources>
+</manifest>
+`;
+}

package/lib/manifest/scorm-2004-manifest.js

@@ -0,0 +1,94 @@
+/**
+ * @file scorm-2004-manifest.js
+ * @description Generates imsmanifest.xml for SCORM 2004 4th Edition packages.
+ */
+
+/**
+ * Generates the SCORM 2004 4th Edition manifest.
+ * @param {Object} config - Course configuration
+ * @param {string[]} files - List of files to include in the manifest
+ * @returns {string} The manifest XML
+ */
+export function generateScorm2004Manifest(config, files) {
+    const resourceFiles = files.filter(f =>
+        f !== 'imsmanifest.xml' &&
+        !f.endsWith('.xsd') &&
+        !f.endsWith('.dtd') &&
+        !f.startsWith('common/')
+    );
+
+    const fileEntries = resourceFiles.map(f => `      <file href="${f}"/>`).join('\n');
+
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<!-- SCORM 2004 4th Edition manifest - GENERATED FILE - DO NOT EDIT MANUALLY -->
+<manifest identifier="${config.title.replace(/[^a-zA-Z0-9]/g, '-')}"
+            version="${config.version}"
+            xmlns="http://www.imsglobal.org/xsd/imscp_v1p1"
+            xmlns:imscp="http://www.imsglobal.org/xsd/imscp_v1p1"
+            xmlns:imsss="http://www.imsglobal.org/xsd/imsss"
+            xmlns:adlcp="http://www.adlnet.org/xsd/adlcp_v1p3"
+            xmlns:adlseq="http://www.adlnet.org/xsd/adlseq_v1p3"
+            xmlns:adlnav="http://www.adlnet.org/xsd/adlnav_v1p3"
+            xmlns:lom="http://ltsc.ieee.org/xsd/LOM"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="
+              http://www.imsglobal.org/xsd/imscp_v1p1 imscp_v1p1.xsd
+              http://www.imsglobal.org/xsd/imsss imsss_v1p0.xsd
+              http://www.adlnet.org/xsd/adlcp_v1p3 adlcp_v1p3.xsd
+              http://www.adlnet.org/xsd/adlseq_v1p3 adlseq_v1p3.xsd
+              http://www.adlnet.org/xsd/adlnav_v1p3 adlnav_v1p3.xsd
+              http://ltsc.ieee.org/xsd/LOM lom.xsd"
+            xml:base="./">
+
+  <metadata>
+    <schema>ADL SCORM</schema>
+    <schemaversion>2004 4th Edition</schemaversion>
+    <lom:lom>
+      <lom:general>
+        <lom:title><lom:string language="${config.language}">${config.title}</lom:string></lom:title>
+        <lom:description><lom:string language="${config.language}">${config.description}</lom:string></lom:description>
+        <lom:language>${config.language}</lom:language>
+      </lom:general>
+      <lom:lifecycle>
+        <lom:version><lom:string>${config.version}</lom:string></lom:version>
+        <lom:contribute>
+          <lom:role>
+            <lom:source><lom:string>LOMv1.0</lom:string></lom:source>
+            <lom:value><lom:string>author</lom:string></lom:value>
+          </lom:role>
+          <lom:entity>${config.author}</lom:entity>
+        </lom:contribute>
+      </lom:lifecycle>
+      <lom:technical>
+        <lom:format>text/html</lom:format>
+      </lom:technical>
+    </lom:lom>
+  </metadata>
+
+  <organizations default="org-1">
+    <organization identifier="org-1" adlseq:objectivesGlobalToSystem="false">
+      <title>${config.title}</title>
+      <item identifier="item-1" identifierref="res-1" isvisible="true">
+        <title>${config.title}</title>
+        <imsss:sequencing>
+          <imsss:controlMode choiceExit="true" forwardOnly="false"/>
+          <imsss:deliveryControls tracked="true" completionSetByContent="true" objectiveSetByContent="true"/>
+          <adlnav:presentation>
+            <adlnav:navigationInterface>
+              <adlnav:hideLMSUI>continue</adlnav:hideLMSUI>
+              <adlnav:hideLMSUI>previous</adlnav:hideLMSUI>
+            </adlnav:navigationInterface>
+          </adlnav:presentation>
+        </imsss:sequencing>
+      </item>
+    </organization>
+  </organizations>
+
+  <resources>
+    <resource identifier="res-1" type="webcontent" adlcp:scormType="sco" href="index.html">
+${fileEntries}
+    </resource>
+  </resources>
+</manifest>
+`;
+}

package/lib/manifest/scorm-proxy-manifest.js

@@ -0,0 +1,104 @@
+/**
+ * @file scorm-proxy-manifest.js
+ * @description Generates minimal SCORM manifest for proxy packages.
+ * 
+ * Proxy packages contain only:
+ * - proxy.html (entry point)
+ * - scorm-bridge.js (postMessage → SCORM bridge)
+ * - pipwerks.js (SCORM API wrapper)
+ * 
+ * Works for both SCORM 1.2 and 2004 - pipwerks auto-detects.
+ */
+
+/**
+ * Generate SCORM 1.2 proxy manifest
+ * @param {Object} config - Course configuration
+ * @returns {string} imsmanifest.xml content
+ */
+export function generateScorm12ProxyManifest(config) {
+    const identifier = config.identifier || 
+        config.title.replace(/[^a-zA-Z0-9]/g, '_').toLowerCase();
+
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<!-- SCORM 1.2 Proxy Manifest - Generated by CourseCode -->
+<manifest identifier="${identifier}_proxy" version="1.0"
+    xmlns="http://www.imsproject.org/xsd/imscp_rootv1p1p2"
+    xmlns:adlcp="http://www.adlnet.org/xsd/adlcp_rootv1p2">
+    
+    <metadata>
+        <schema>ADL SCORM</schema>
+        <schemaversion>1.2</schemaversion>
+    </metadata>
+    
+    <organizations default="org_${identifier}">
+        <organization identifier="org_${identifier}">
+            <title>${escapeXml(config.title)}</title>
+            <item identifier="item_${identifier}" identifierref="res_${identifier}">
+                <title>${escapeXml(config.title)}</title>
+            </item>
+        </organization>
+    </organizations>
+    
+    <resources>
+        <resource identifier="res_${identifier}" type="webcontent" adlcp:scormtype="sco" href="proxy.html">
+            <file href="proxy.html"/>
+            <file href="scorm-bridge.js"/>
+            <file href="pipwerks.js"/>
+        </resource>
+    </resources>
+</manifest>`;
+}
+
+/**
+ * Generate SCORM 2004 proxy manifest
+ * @param {Object} config - Course configuration
+ * @returns {string} imsmanifest.xml content
+ */
+export function generateScorm2004ProxyManifest(config) {
+    const identifier = config.identifier || 
+        config.title.replace(/[^a-zA-Z0-9]/g, '_').toLowerCase();
+
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<!-- SCORM 2004 Proxy Manifest - Generated by CourseCode -->
+<manifest identifier="${identifier}_proxy" version="1.0"
+    xmlns="http://www.imsglobal.org/xsd/imscp_v1p1"
+    xmlns:adlcp="http://www.adlnet.org/xsd/adlcp_v1p3"
+    xmlns:adlseq="http://www.adlnet.org/xsd/adlseq_v1p3"
+    xmlns:adlnav="http://www.adlnet.org/xsd/adlnav_v1p3"
+    xmlns:imsss="http://www.imsglobal.org/xsd/imsss">
+    
+    <metadata>
+        <schema>ADL SCORM</schema>
+        <schemaversion>2004 4th Edition</schemaversion>
+    </metadata>
+    
+    <organizations default="org_${identifier}">
+        <organization identifier="org_${identifier}">
+            <title>${escapeXml(config.title)}</title>
+            <item identifier="item_${identifier}" identifierref="res_${identifier}">
+                <title>${escapeXml(config.title)}</title>
+            </item>
+        </organization>
+    </organizations>
+    
+    <resources>
+        <resource identifier="res_${identifier}" type="webcontent" adlcp:scormType="sco" href="proxy.html">
+            <file href="proxy.html"/>
+            <file href="scorm-bridge.js"/>
+            <file href="pipwerks.js"/>
+        </resource>
+    </resources>
+</manifest>`;
+}
+
+/**
+ * Escape special XML characters
+ */
+function escapeXml(str) {
+    return String(str)
+        .replace(/&/g, '&amp;')
+        .replace(/</g, '&lt;')
+        .replace(/>/g, '&gt;')
+        .replace(/"/g, '&quot;')
+        .replace(/'/g, '&apos;');
+}

package/lib/manifest-parser.js

@@ -0,0 +1,96 @@
+/**
+ * manifest-parser.js - Parse SCORM imsmanifest.xml and cmi5.xml files
+ * 
+ * Extracts key metadata for preview export and other tools.
+ */
+
+/**
+ * Parse imsmanifest.xml content and extract key fields
+ * @param {string} xmlContent - Raw XML content of imsmanifest.xml
+ * @returns {{ identifier: string, title: string, launchFile: string, version: string | null }}
+ */
+export function parseManifest(xmlContent) {
+    // Extract manifest identifier
+    const identifierMatch = xmlContent.match(/<manifest\s+[^>]*identifier=["']([^"']+)["']/);
+    const identifier = identifierMatch ? identifierMatch[1] : 'unknown-course';
+
+    // Extract version from manifest element
+    const versionMatch = xmlContent.match(/<manifest\s+[^>]*version=["']([^"']+)["']/);
+    const version = versionMatch ? versionMatch[1] : null;
+
+    // Extract title from metadata (LOM format)
+    // Look for: <lom:general><lom:title><lom:string>Title</lom:string></lom:title></lom:general>
+    let title = 'SCORM Course';
+    const lomTitleMatch = xmlContent.match(/<lom:title>\s*<lom:string[^>]*>([^<]+)<\/lom:string>/);
+    if (lomTitleMatch) {
+        title = lomTitleMatch[1].trim();
+    } else {
+        // Fallback: try organization title
+        const orgTitleMatch = xmlContent.match(/<organization[^>]*>[\s\S]*?<title>([^<]+)<\/title>/);
+        if (orgTitleMatch) {
+            title = orgTitleMatch[1].trim();
+        }
+    }
+
+    // Extract launch file from resource href
+    // Look for: <resource ... adlcp:scormType="sco" ... href="index.html">
+    let launchFile = 'index.html';
+    const resourceMatch = xmlContent.match(/<resource[^>]*adlcp:scormType=["']sco["'][^>]*href=["']([^"']+)["']/);
+    if (resourceMatch) {
+        launchFile = resourceMatch[1];
+    } else {
+        // Try alternate ordering (href before scormType)
+        const altMatch = xmlContent.match(/<resource[^>]*href=["']([^"']+)["'][^>]*adlcp:scormType=["']sco["']/);
+        if (altMatch) {
+            launchFile = altMatch[1];
+        }
+    }
+
+    return {
+        identifier,
+        title,
+        launchFile,
+        version
+    };
+}
+
+/**
+ * Parse cmi5.xml content and extract key fields
+ * @param {string} xmlContent - Raw XML content of cmi5.xml
+ * @returns {{ identifier: string, title: string, launchFile: string, version: string | null }}
+ */
+export function parseCmi5Manifest(xmlContent) {
+    // Extract course id
+    const idMatch = xmlContent.match(/<course\s+id=["']([^"']+)["']/);
+    const identifier = idMatch ? idMatch[1] : 'unknown-course';
+
+    // Extract title from course > title > langstring
+    let title = 'cmi5 Course';
+    const titleMatch = xmlContent.match(/<course[^>]*>[\s\S]*?<title>\s*<langstring[^>]*>([^<]+)<\/langstring>/i);
+    if (titleMatch) {
+        title = titleMatch[1].trim();
+    }
+
+    // Extract launch URL from first AU
+    let launchFile = 'index.html';
+    const urlMatch = xmlContent.match(/<au[^>]*>[\s\S]*?<url>([^<]+)<\/url>/i);
+    if (urlMatch) {
+        launchFile = urlMatch[1].trim();
+    }
+
+    return {
+        identifier,
+        title,
+        launchFile,
+        version: null
+    };
+}
+
+/**
+ * Sanitize identifier for use as localStorage key
+ * @param {string} identifier - Raw manifest identifier
+ * @returns {string} - Safe key for localStorage
+ */
+export function sanitizeIdentifier(identifier) {
+    return identifier.replace(/[^a-zA-Z0-9_-]/g, '_').substring(0, 64);
+}