@missing-elements/h5p-embed 1.3.0 → 1.3.1

package/README.md

@@ -163,7 +163,29 @@ complete such an activity on viewing it instead. Replacing the zip with one writ
 belongs to what it was saved in.
 
 Checked in Moodle 4.5: the score reaches the gradebook, and a learner who leaves halfway continues
-there on the next launch. Other LMSs have not been tried yet.
+there on the next launch.
+
+Checked in Frappe LMS too, on its `develop` branch, uploaded as a SCORM chapter. A learner who
+leaves halfway continues there, but Frappe records less than Moodle. It marks the lesson done only
+when the content reports a pass, so a quiz needs a pass mark; a failed attempt, or content that
+reports only `completed`, leaves the lesson open. It keeps no score. Frappe sends a file whole
+rather than in ranges, so the package is downloaded in full when the lesson opens, and a large video
+in it starts once the download has reached it.
+
+Checked in SCORM Cloud too: the score, whether it passed, the time and the learner's place are
+recorded, and an export without its libraries plays from the parts in the zip. A zip written by
+embed 1.3.0 or earlier cannot be imported there ("IO Error processing zip"), nor, likely, into
+other LMSs that read uploads with Java; write it again with a later version.
+
+Checked in ILIAS 11 too, uploaded as a SCORM learning module. The score, whether it passed, the
+time and the learner's place are recorded, but only once Learning Progress is on, which a fresh
+ILIAS has off: without it ILIAS's SCORM player keeps the learner's place and drops every score and
+status the content sends. Turn it on in Administration, then in the module's Learning Progress
+settings choose "Collection of SCORM Items" and tick the item. ILIAS sent the larger packages whole
+rather than in ranges, as Frappe does. With a zip written by embed 1.3.0 or earlier, ILIAS records
+no time for a session the learner ends by closing the tab; write it again with a later version.
+
+Other LMSs have not been tried yet.
 
 ## As a library
 

package/lib/crc32.mjs

@@ -0,0 +1,36 @@
+import zlib from 'node:zlib'
+
+/** @type {Uint32Array | undefined} */
+let table
+
+/**
+ * @param {Uint8Array} bytes
+ * @param {number} previous
+ */
+function tableCrc32(bytes, previous) {
+  if (!table) {
+    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
+    }
+  }
+  let crc = ~previous >>> 0
+  for (let i = 0; i < bytes.length; i++) crc = table[(crc ^ bytes[i]) & 0xff] ^ (crc >>> 8)
+  return ~crc >>> 0
+}
+
+/**
+ * CRC-32 of `bytes`, continuing from `previous`. Native from Node 22.2 on; a table before that.
+ * A namespace import rather than a named one, because a named import of a builtin's missing
+ * export fails at link time and would take the whole script down on an older Node.
+ *
+ * A copy of the normalizer's `lib/crc32.mjs`; keep the two in step.
+ *
+ * @type {(bytes: Uint8Array, previous?: number) => number}
+ */
+export const crc32 =
+  typeof zlib.crc32 === 'function'
+    ? (bytes, previous = 0) => zlib.crc32(bytes, previous)
+    : (bytes, previous = 0) => tableCrc32(bytes, previous)

package/lib/scorm.mjs

@@ -6,6 +6,7 @@ import { Writable } from 'node:stream'
 import { fileURLToPath } from 'node:url'
 import { BlobReader, TextReader, TextWriter, ZipReader, ZipWriter, configure } from '@zip.js/zip.js'
 import { EmbedError, PLAYER_FILES, installed } from './build.mjs'
+import { crc32 } from './crc32.mjs'
 
 /**
  * Writes a SCORM 1.2 package that plays one `.h5p` in an LMS and reports its result there: the
@@ -382,6 +383,16 @@ function sha256(file) {
   })
 }
 
+/**
+ * A file's CRC-32, read as a stream.
+ * @param {string} file
+ */
+async function fileCrc32(file) {
+  let crc = 0
+  for await (const chunk of createReadStream(file)) crc = crc32(chunk, crc)
+  return crc
+}
+
 /**
  * Every file under a folder, as zip paths relative to it, sorted.
  * @param {string} dir
@@ -533,9 +544,20 @@ export async function buildScorm({ h5p, out, force = false }) {
     const zip = new ZipWriter(Writable.toWeb(createWriteStream(partial)))
     await zip.add('imsmanifest.xml', new TextReader(xml))
     for (const [name, content] of files) {
-      // The package, the pack's parts and the fonts are compressed already.
-      const level = name.endsWith('.h5p') || name.endsWith('.woff2') ? 0 : 6
-      await zip.add(name, 'text' in content ? new TextReader(content.text) : new BlobReader(await openAsBlob(content.file)), { level })
+      if ('text' in content) {
+        await zip.add(name, new TextReader(content.text), { level: 6 })
+        continue
+      }
+      const blob = await openAsBlob(content.file)
+      // The package, the pack's parts and the fonts are compressed already, so they are stored.
+      // Written into a stream, an entry gets a data descriptor, and a Java ZipInputStream refuses
+      // a stored entry that has one: SCORM Cloud refused exactly those (#92). Passed through with
+      // its size and CRC, it gets a complete local header instead, and is still streamed, not held.
+      if (name.endsWith('.h5p') || name.endsWith('.woff2')) {
+        await zip.add(name, new BlobReader(blob), { passThrough: true, compressionMethod: 0, uncompressedSize: blob.size, crc32: await fileCrc32(content.file) })
+      } else {
+        await zip.add(name, new BlobReader(blob), { level: 6 })
+      }
     }
     await zip.close()
     await rename(partial, target)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@missing-elements/h5p-embed",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Self-hosted H5P embeds: writes the H5P embed page as a static site for a player domain of your own, then any site frames it with an iframe and one script line; or wraps one .h5p as a SCORM 1.2 package an LMS plays and grades. No H5P server, no third-party service; optional allowlists for package hosts and embedding sites.",
   "license": "MIT",
   "repository": {

package/scorm/scorm.js

@@ -151,13 +151,36 @@ player.addEventListener('finished', (event) => {
   commit()
 })
 
-// The session ends with the page. Unfinished, it is suspended, so the next launch resumes it.
+/*
+ * The session ends with the page. Unfinished, it is suspended, so the next launch resumes it.
+ *
+ * Its time and how it ended are committed on `beforeunload` too, while the page is still there,
+ * and the session is finished on `pagehide`, once the page is going for good. ILIAS sends what a
+ * closing page writes with a beacon only during `beforeunload`, `unload` or a click; on `pagehide`
+ * it tries a synchronous request, which Chrome refuses while a page goes, so the finish alone lost
+ * the session's time there (#94). The commit is all `beforeunload` does: the content saves its
+ * state for the last time on its own frame's `beforeunload`, which comes after this page's, and a
+ * learner asked whether to leave may stay.
+ */
 let ended = false
+
+function writeEnd() {
+  set('cmi.core.session_time', timespan(Date.now() - started))
+  set('cmi.core.exit', finished ? '' : 'suspend')
+}
+
+if (initialized) {
+  addEventListener('beforeunload', () => {
+    if (ended) return
+    writeEnd()
+    commit()
+  })
+}
+
 addEventListener('pagehide', () => {
   if (!initialized || ended || !api) return
   ended = true
-  set('cmi.core.session_time', timespan(Date.now() - started))
-  set('cmi.core.exit', finished ? '' : 'suspend')
+  writeEnd()
   api.LMSFinish('')
 })
 

package/types/lib/crc32.d.mts

@@ -0,0 +1,10 @@
+/**
+ * CRC-32 of `bytes`, continuing from `previous`. Native from Node 22.2 on; a table before that.
+ * A namespace import rather than a named one, because a named import of a builtin's missing
+ * export fails at link time and would take the whole script down on an older Node.
+ *
+ * A copy of the normalizer's `lib/crc32.mjs`; keep the two in step.
+ *
+ * @type {(bytes: Uint8Array, previous?: number) => number}
+ */
+export declare const crc32: (bytes: Uint8Array, previous?: number) => number;