@citolab/tspci-qbci 2.11.0 → 2.12.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 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)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci-qbci",
-  "version": "2.11.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": "ad0858f9b665b6778cdf19685e858e167847e930",
+  "gitHead": "eb7676525e9bf75daa9b2f42f035faed9b8e9a70",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"

package/readme.md

@@ -17,8 +17,12 @@ In the package.json of the pci:
 
 ## sbom
 
-A CycloneDX SBOM of the bundle is copied next to the `.ci` package in `ci-dist/` as
-`<name>_<version>.sbom.cdx.json`. Pass `--include-sbom` to also add `sbom.cdx.json` to the package
-itself; note that Questify does not expect the extra file, so only do that when a customer asks for it.
-Pass `--no-sbom` to skip generating one.
-See [@citolab/tspci](https://github.com/Citolab/tspci/tree/main/lib/tspci#sbom) for the configuration.
+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,9 @@
+# 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`

package/src/createPackage.mjs

@@ -112,11 +112,13 @@ export const bundle = () => {
 
   isMaxFileSize(maxJsFileSize, minifiedFilePath);
 
-  // SBOM: delivered next to the package by default, optionally inside it
+  // 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,
   });
@@ -213,11 +215,12 @@ function addDirectoryToZip(zipFile, rootDir, currentDir) {
   }
 }
 
-// The CRA requires an SBOM as part of the technical documentation, not as part
-// of the delivery to the customer, so it is written next to the package per
-// version. Use --include-sbom (or config.tspci.sbom.includeInPackage) to also
-// ship it inside the package, and --no-sbom to skip it altogether.
-function handleSbom({ distDirectory, outputDirectory, packageTempDirectory, baseName, packageData }) {
+// 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 "";
@@ -231,10 +234,11 @@ function handleSbom({ distDirectory, outputDirectory, packageTempDirectory, base
   fs.copyFileSync(source, path.join(outputDirectory, `${baseName}.${fileName}`));
   console.log(chalk.green(`created sbom: ${baseName}.${fileName}`));
 
-  const includeInPackage = process.argv.includes("--include-sbom") || settings.includeInPackage === true;
-  if (!includeInPackage) {
+  if (settings.includeInPackage === false || process.argv.includes("--no-include-sbom")) {
     return "";
   }
-  fs.copyFileSync(source, path.join(packageTempDirectory, fileName));
-  return fileName;
+  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;
 }