@citolab/tspci-qbci 2.10.0 → 2.12.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.12.0](https://github.com/Citolab/tspci/compare/v2.11.0...v2.12.0) (2026-08-19)
+
+
+### Features
+
+* include the SBOM in the exported package by default ([376b89a](https://github.com/Citolab/tspci/commit/376b89a5651bb9a420fbd2973d221a7e5200bd35))
+
+
+
+
+
+# [2.11.0](https://github.com/Citolab/tspci/compare/v2.10.0...v2.11.0) (2026-08-19)
+
+
+### Features
+
+* generate a CycloneDX SBOM of the bundle ([fdc8cf7](https://github.com/Citolab/tspci/commit/fdc8cf7caf8d25b58737866d654315e6cb2e6fcf))
+
+
+
+
+
 # [2.10.0](https://github.com/Citolab/tspci/compare/v2.9.13...v2.10.0) (2026-08-18)
 
 **Note:** Version bump only for package @citolab/tspci-qbci

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci-qbci",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "create a .ci file that can be imported into Questify",
   "author": "patrick <patrick.deklein@cito.nl>, Marcel Hoekstra <marcel.hoekstra@cito.nl>",
   "repository": "",
@@ -11,7 +11,7 @@
     "yazl": "^3.3.1"
   },
   "scripts": {},
-  "gitHead": "7dbead5cfa41583d47bb503d40970df2d3444a1e",
+  "gitHead": "eb7676525e9bf75daa9b2f42f035faed9b8e9a70",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"

package/readme.md

@@ -14,3 +14,15 @@ In the package.json of the pci:
 - label (if empty, package name will be used)
 - config: { tspci: { width: '500' }} (optional, default: 500)
 - config: { tspci: { height: '500' }} (optional, default: 500)
+
+## sbom
+
+A CycloneDX SBOM of the bundle is included in the package as `ref/script/sbom.cdx.json`, next to the
+bundle it describes, and copied next to the `.ci` package in `ci-dist/` as
+`<name>_<version>.sbom.cdx.json` for your own technical documentation.
+
+It is deliberately not registered in `ref/json/manifest.json`: the `script` array drives what the player
+loads, and the SBOM is data, not a script.
+
+Use `--no-include-sbom` to keep it out of the package, or `--no-sbom` to skip generating one. See
+[@citolab/tspci](https://github.com/Citolab/tspci/tree/main/lib/tspci#sbom) for the configuration.

package/release-notes.md

@@ -1,3 +1,37 @@
+# 2.12.0
+
+- the SBOM is included in the package as `ref/script/sbom.cdx.json`, next to the bundle
+- it is deliberately not registered in `ref/json/manifest.json`: the `script` array drives what the player loads and the SBOM is data, not a script
+- `--no-include-sbom` keeps it out of the package
+
+# 2.11.0
+
+- a CycloneDX SBOM of the bundle is copied next to the `.ci` package in `ci-dist/` as `<name>_<version>.sbom.cdx.json`
+- `--include-sbom` also adds `sbom.cdx.json` to the package itself, `--no-sbom` skips generating one
+
+_The notes for 2.5.0 up to and including 2.10.0 were reconstructed from the git history afterwards, so
+they list the highlights per minor version. Versions without an entry contained no changes for this
+package: all packages in this repository are published in lockstep. `CHANGELOG.md` has the complete
+list of published versions._
+
+# 2.7.0
+
+- added a GPL-3.0 LICENSE file to the package
+- updated the development index.html
+
+# 2.6.0
+
+- images can be used with the native `CES.getMedia()` of the player
+- media files from the assets folder are copied to `ref/media` and registered in `ref/json/manifest.json`
+- a warning is shown when the bundled js file is too large for the player
+- replaced the deprecated `fs.rmdir` with `fs.rm`
+
+# 2.5.0
+
+- dropped the `ci` prefix from the package name and export to a separate `ci-dist` folder
+- the metadata.json of the PCI is picked up, `typeIdentifier` is also read from `config.tspci` in package.json
+- the script folder is created when it does not exist
+
 
 # 2.1.1
 tspci

package/src/createPackage.mjs

@@ -112,6 +112,17 @@ export const bundle = () => {
 
   isMaxFileSize(maxJsFileSize, minifiedFilePath);
 
+  // SBOM: shipped inside the package next to the bundle it describes, and
+  // copied next to the package for your own technical documentation
+  handleSbom({
+    distDirectory: path.join(PACKAGE_ROOT_PATH, path.dirname((packageData.main || "dist/index.js").replace(/^\//, ""))),
+    outputDirectory,
+    packageTempDirectory: outputDirectoryTemp,
+    packageDirectory: path.posix.join("ref", "script"),
+    baseName: `${name}_${packageData.version}`,
+    packageData,
+  });
+
   // zip the folder
   const zipName = `${name}_${packageData.version}.ci`;
   zipDirectory(outputDirectoryTemp, path.join(outputDirectory, zipName)).then(() =>
@@ -203,3 +214,31 @@ function addDirectoryToZip(zipFile, rootDir, currentDir) {
     zipFile.addFile(fullPath, relativePath, { compress: true });
   }
 }
+
+// The SBOM travels inside the package, because a file next to the zip does not
+// survive an import into another system, and that is exactly the party that
+// needs it. A copy is left next to the package for your own technical
+// documentation. Use --no-include-sbom (or config.tspci.sbom.includeInPackage:
+// false) to keep it out of the package, and --no-sbom to skip it altogether.
+function handleSbom({ distDirectory, outputDirectory, packageTempDirectory, packageDirectory, baseName, packageData }) {
+  const settings = packageData?.config?.tspci?.sbom || {};
+  if (settings.enabled === false || process.argv.includes("--no-sbom")) {
+    return "";
+  }
+  const fileName = settings.fileName || "sbom.cdx.json";
+  const source = path.join(distDirectory, fileName);
+  if (!fs.existsSync(source)) {
+    console.warn(chalk.yellow(`no SBOM found at ${source}, skipping it`));
+    return "";
+  }
+  fs.copyFileSync(source, path.join(outputDirectory, `${baseName}.${fileName}`));
+  console.log(chalk.green(`created sbom: ${baseName}.${fileName}`));
+
+  if (settings.includeInPackage === false || process.argv.includes("--no-include-sbom")) {
+    return "";
+  }
+  const target = packageDirectory ? path.join(packageTempDirectory, packageDirectory) : packageTempDirectory;
+  fs.mkdirSync(target, { recursive: true });
+  fs.copyFileSync(source, path.join(target, fileName));
+  return packageDirectory ? path.posix.join(packageDirectory, fileName) : fileName;
+}