@missing-elements/h5p-libraries
v1.1.0
Published
The H5P hub's runtime libraries for every content type it serves, for <h5p-player>'s `libraries` attribute: one archive per library, which the player fetches as a package needs them, and the whole pack as one .h5p. With them, the editor libraries an H5P s
Maintainers
Readme
@missing-elements/h5p-libraries
The H5P hub's runtime libraries for every content type it serves, each at the newest minor of its
major, for <h5p-player>'s
libraries="pack". With it, an export that carries only content/ (common from h5p.com and
h5p.org) plays, and an older export plays the newer versions of its libraries. With them, the
libraries an H5P site asks for when a package is uploaded, the editor's among them, which
h5p-author copies into a package
and the player never serves.
What is in it
parts/: one.h5pper library folder, andindex.json, which gives each library's version, dependencies and addon patterns, and its archive's size and SHA-256. The player downloads only the archives a package needs and checks each against its hash. A library markedinstallOnlyis carried for an H5P site's upload check, which wants every library a package carries to have its dependencies with it at the exact version, editor dependencies included: the editor libraries, and an older minor of a library that another names exactly.index.js: thepackexport, the index of the libraries the player serves, with a staticnew URLfor each archive, so a bundler emits them as assets of your site.install.js: thepackexport with theinstallOnlylibraries too, for a page that writes packages with@missing-elements/h5p-author/browser. A bundler emits every archive a module names, 1.9 MB more here, so a page that only plays importsindex.js.libraries.h5p: the whole pack as one archive, for alibrariesURL that takes it as any bundle. Since 1.1.0 it holds theinstallOnlylibraries too, 15.5 MB where it was 13.7, which a player never reads.libraries.txt: each library's version, licence and authors.
Use
The element names this pack itself: libraries="pack" fetches the archives a package needs from
jsDelivr, at the version its release pins.
<h5p-player src="stripped.h5p" libraries="pack"></h5p-player>To keep the requests on your own site, serve a copy of parts/ and name its folder:
<h5p-player src="stripped.h5p" libraries="pack" pack-base="/h5p-libraries/"></h5p-player>Or, with a bundler, hand over the pack export:
import { pack } from '@missing-elements/h5p-libraries'
player.pack = pack
player.setAttribute('libraries', 'pack')Every archive is at least 8 kB, padded with the archive's comment where a library is smaller, so
that a bundler emits it as a file rather than inlining it as a data: URL, which a page's policy
would refuse to fetch.
Licences
Each library keeps its own licence (mostly MIT; also MPL-2.0, public domain,
and GPL-3.0 for flowplayer and H5P.MaterialDesignIcons).
libraries.txt lists each one's version, licence and authors; serve it beside
the pack.
pnpm libraries in the repository rebuilds the pack from the hub, its parts and libraries.txt;
pnpm parts in this package splits the committed libraries.h5p again.
