playable-lessons 0.6.4 → 0.8.0

package/out/shared/scormExporter.js

@@ -0,0 +1,114 @@
+"use strict";
+/**
+ * SCORM 1.2 export: wrap the standalone story player in a single-SCO package
+ * that reports completion to an LMS (Moodle, Canvas, Blackboard, …).
+ *
+ * Unlike H5P/Twee/EPUB this works for *stateful* stories too — the SCO is the
+ * full HTML player, and completion is reported when the story reaches an
+ * ending. The package is self-contained (one index.html), so no assets folder
+ * is needed.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportScorm = exportScorm;
+const storyExport_js_1 = require("./storyExport.js");
+const zip_js_1 = require("./zip.js");
+/** Report completion/exit to a SCORM 1.2 LMS found on the parent chain. */
+const SCORM_WRAPPER = `
+<script>
+(function () {
+  function findAPI(win) {
+    var tries = 0;
+    while (win && !win.API && win.parent && win.parent !== win && tries < 10) {
+      win = win.parent;
+      tries++;
+    }
+    return (win && win.API) || null;
+  }
+  var api = null;
+  try { api = findAPI(window); } catch (e) { api = null; }
+  if (!api) { try { api = window.opener && window.opener.API; } catch (e) { api = null; } }
+  if (!api) return;
+
+  var done = false;
+  function init() {
+    try {
+      api.LMSInitialize('');
+      api.LMSSetValue('cmi.core.lesson_status', 'incomplete');
+      api.LMSCommit('');
+    } catch (e) {}
+  }
+  function complete() {
+    try {
+      api.LMSSetValue('cmi.core.lesson_status', 'completed');
+      api.LMSSetValue('cmi.core.exit', '');
+      api.LMSCommit('');
+    } catch (e) {}
+  }
+  function check() {
+    if (done) return;
+    if (document.querySelector('.ending')) { done = true; complete(); }
+  }
+
+  init();
+  var target = document.getElementById('content') || document.body;
+  if (window.MutationObserver) new MutationObserver(check).observe(target, { childList: true, subtree: true });
+  setInterval(check, 1000);
+
+  window.addEventListener('beforeunload', function () {
+    try {
+      if (!done) api.LMSSetValue('cmi.core.exit', 'suspend');
+      api.LMSCommit('');
+      api.LMSFinish('');
+    } catch (e) {}
+  });
+})();
+</script>
+`;
+/** SCORM 1.2 imsmanifest.xml for a single web-content SCO. */
+function manifest(title) {
+    const safeTitle = (0, storyExport_js_1.escapeHtml)(title);
+    const id = `com.playablelessons.${Math.random().toString(36).slice(2, 10)}`;
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<manifest identifier="${id}" version="1.2"
+  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.imsglobal.org/xsd/imsmd_rootv1p2p1 imsmd_rootv1p2p1.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>${safeTitle}</title>
+      <item identifier="ITEM-1" identifierref="RES-1">
+        <title>${safeTitle}</title>
+      </item>
+    </organization>
+  </organizations>
+  <resources>
+    <resource identifier="RES-1" type="webcontent" adlcp:scormtype="sco" href="index.html">
+      <file href="index.html"/>
+    </resource>
+  </resources>
+</manifest>
+`;
+}
+function injectWrapper(html) {
+    return html.includes('</body>')
+        ? html.replace('</body>', `${SCORM_WRAPPER}</body>`)
+        : html + SCORM_WRAPPER;
+}
+/**
+ * Build a SCORM 1.2 package (zip bytes) from a story. Never gated on state:
+ * the SCO is the same standalone HTML player, so variables/conditionals work.
+ */
+async function exportScorm(inkSource, title, sceneImages) {
+    const html = injectWrapper(await (0, storyExport_js_1.exportStandaloneHTML)(inkSource, title, sceneImages));
+    return (0, zip_js_1.zipStore)([
+        { name: 'imsmanifest.xml', data: manifest(title) },
+        { name: 'index.html', data: html }
+    ]);
+}

package/out/shared/storyExport.js

@@ -163,7 +163,7 @@ ${favicon_js_1.FAVICON_LINK}
 <body>
 <div id="story">
   <h1>${safeTitle}</h1>
-  <div id="content"></div>
+  <div id="content" role="region" aria-live="polite" aria-label="Story"></div>
 </div>
 
 <!-- inkjs ${inkRuntime_generated_js_1.INKJS_VERSION} runtime embedded inline so this file plays fully offline -->
@@ -190,24 +190,26 @@ ${favicon_js_1.FAVICON_LINK}
     }
 
     // Scene illustrations: resolve IMAGE_PROMPT tags via the embedded map;
-    // IMAGE tags render only when they carry a usable URL/data URL.
-    var imgSrcs = [];
+    // IMAGE tags render only when they carry a usable URL/data URL. The prompt
+    // doubles as alt text so screen readers describe the illustration.
+    var imgs = [];
     tags.forEach(function(tag) {
       if (tag.indexOf('IMAGE_PROMPT:') === 0) {
-        var src = sceneImages[tag.substring('IMAGE_PROMPT:'.length).trim()];
-        if (src) imgSrcs.push(src);
+        var prompt = tag.substring('IMAGE_PROMPT:'.length).trim();
+        var src = sceneImages[prompt];
+        if (src) imgs.push({ src: src, alt: prompt });
       } else if (tag.indexOf('IMAGE:') === 0) {
         var val = tag.substring('IMAGE:'.length).trim();
         // NB: no '//' inside this regex — in this template literal \/ collapses
         // to / and would turn into a line comment in the generated page.
-        if (/^(data:|https?:)/.test(val)) imgSrcs.push(val);
+        if (/^(data:|https?:)/.test(val)) imgs.push({ src: val, alt: '' });
       }
     });
-    imgSrcs.forEach(function(src) {
+    imgs.forEach(function(item) {
       var img = document.createElement('img');
       img.className = 'scene-img';
-      img.src = src;
-      img.alt = '';
+      img.src = item.src;
+      img.alt = item.alt;
       textDiv.insertBefore(img, textDiv.firstChild);
     });
 

package/out/shared/version.generated.js

@@ -3,5 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.APP_VERSION = void 0;
 // AUTO-GENERATED by scripts/embed-version.mjs — do not edit by hand.
 // Source: package.json (version). Regenerate: npm run embed:version
-/* eslint-disable */
-exports.APP_VERSION = "0.6.4";
+exports.APP_VERSION = "0.8.0";

package/out/shared/zip.js

@@ -0,0 +1,86 @@
+"use strict";
+/**
+ * Minimal ZIP writer shared by the H5P, SCORM, and EPUB exporters.
+ *
+ * Uses the "store" method (no compression) so the output is byte-identical
+ * across runs and the EPUB `mimetype` entry can be first and uncompressed,
+ * as the OCF spec requires.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.zipStore = zipStore;
+exports.bytesToBase64 = bytesToBase64;
+exports.base64ToBytes = base64ToBytes;
+const CRC_TABLE = (() => {
+    const table = new Uint32Array(256);
+    for (let n = 0; n < 256; n++) {
+        let c = n;
+        for (let k = 0; k < 8; k++)
+            c = c & 1 ? 0xedb88320 ^ (c >>> 1) : c >>> 1;
+        table[n] = c >>> 0;
+    }
+    return table;
+})();
+function crc32(data) {
+    let crc = 0xffffffff;
+    for (let i = 0; i < data.length; i++) {
+        crc = CRC_TABLE[(crc ^ data[i]) & 0xff] ^ (crc >>> 8);
+    }
+    return (crc ^ 0xffffffff) >>> 0;
+}
+// Fixed DOS timestamp (2026-01-01 00:00) keeps output byte-identical across runs.
+const DOS_DATE = ((2026 - 1980) << 9) | (1 << 5) | 1;
+const DOS_TIME = 0;
+/** Assemble a store-only (uncompressed) zip. Entry order is preserved. */
+function zipStore(entries) {
+    const encoder = new TextEncoder();
+    const chunks = [];
+    const central = [];
+    let offset = 0;
+    const u16 = (v) => new Uint8Array([v & 0xff, (v >> 8) & 0xff]);
+    const u32 = (v) => new Uint8Array([v & 0xff, (v >>> 8) & 0xff, (v >>> 16) & 0xff, (v >>> 24) & 0xff]);
+    const cat = (...parts) => {
+        const total = parts.reduce((n, p) => n + p.length, 0);
+        const out = new Uint8Array(total);
+        let pos = 0;
+        for (const p of parts) {
+            out.set(p, pos);
+            pos += p.length;
+        }
+        return out;
+    };
+    for (const entry of entries) {
+        const name = encoder.encode(entry.name);
+        const data = typeof entry.data === 'string' ? encoder.encode(entry.data) : entry.data;
+        const crc = crc32(data);
+        // Local file header: flag bit 11 set = UTF-8 names; method 0 = store.
+        const local = cat(u32(0x04034b50), u16(20), u16(0x0800), u16(0), u16(DOS_TIME), u16(DOS_DATE), u32(crc), u32(data.length), u32(data.length), u16(name.length), u16(0), name, data);
+        central.push(cat(u32(0x02014b50), u16(20), u16(20), u16(0x0800), u16(0), u16(DOS_TIME), u16(DOS_DATE), u32(crc), u32(data.length), u32(data.length), u16(name.length), u16(0), u16(0), u16(0), u16(0), u32(0), u32(offset), name));
+        chunks.push(local);
+        offset += local.length;
+    }
+    const centralBlob = cat(...central);
+    const eocd = cat(u32(0x06054b50), u16(0), u16(0), u16(entries.length), u16(entries.length), u32(centralBlob.length), u32(offset), u16(0));
+    return cat(...chunks, centralBlob, eocd);
+}
+/** Base64-encode package bytes (works in both Node and the browser). */
+function bytesToBase64(bytes) {
+    const B = globalThis.Buffer;
+    if (B)
+        return B.from(bytes).toString('base64');
+    let binary = '';
+    for (let i = 0; i < bytes.length; i += 0x8000) {
+        binary += String.fromCharCode(...bytes.subarray(i, i + 0x8000));
+    }
+    return btoa(binary);
+}
+/** Decode base64 to bytes (works in both Node and the browser). */
+function base64ToBytes(base64) {
+    const B = globalThis.Buffer;
+    if (B)
+        return B.from(base64, 'base64');
+    const binary = atob(base64);
+    const out = new Uint8Array(binary.length);
+    for (let i = 0; i < binary.length; i++)
+        out[i] = binary.charCodeAt(i);
+    return out;
+}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "playable-lessons",
-  "version": "0.6.4",
+  "version": "0.8.0",
+  "description": "Turn educational source material into playable interactive fiction (Ink, HTML, H5P, EPUB, SCORM).",
   "main": "./out/main/index.mjs",
   "scripts": {
     "dev": "electron-vite dev",
@@ -50,8 +51,11 @@
     "url": "git+https://github.com/michael-borck/playable-lessons.git"
   },
   "homepage": "https://github.com/michael-borck/playable-lessons",
-  "comment:dependencies": "Runtime deps for the published CLI only. The GUI libraries (react, zustand, @xyflow/react, …) are devDependencies because Vite bundles them into the Electron renderer at build time, so they don't need to be installed by CLI consumers.",
+  "comment:dependencies": "Runtime deps for the published CLI and the self-hosted web server. The GUI libraries (react, zustand, @xyflow/react, …) are devDependencies because Vite bundles them into the Electron renderer at build time, so they don't need to be installed by CLI consumers.",
   "dependencies": {
+    "electron-updater": "^6.8.11",
+    "express": "^5.3.0",
+    "helmet": "^8.3.0",
     "inkjs": "^2.4.0",
     "yargs": "^18.0.0"
   },
@@ -61,16 +65,15 @@
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
     "@types/yargs": "^17.0.35",
-    "@typescript-eslint/eslint-plugin": "^8.57.2",
-    "@typescript-eslint/parser": "^8.57.2",
+    "@typescript-eslint/eslint-plugin": "^8.72.1",
+    "@typescript-eslint/parser": "^8.72.1",
     "@vitejs/plugin-react": "^6.0.1",
     "@xyflow/react": "^12.10.2",
-    "electron": "^41.1.0",
-    "electron-builder": "^26.8.1",
+    "electron": "^45.2.1",
+    "electron-builder": "^26.18.0",
     "electron-vite": "^5.0.0",
-    "eslint": "^10.1.0",
+    "eslint": "^10.14.0",
     "eslint-plugin-react-hooks": "^5.2.0",
-    "express": "^5.2.1",
     "react": "^19.2.4",
     "react-dom": "^19.2.4",
     "tsx": "^4.21.0",