@citolab/tspci-tao 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-tao

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci-tao",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "create a zip file that can be imported into TAO",
   "author": "patrick <patrick.deklein@cito.nl>, Marcel Hoekstra <marcel.hoekstra@cito.nl>",
   "repository": "",
@@ -16,5 +16,5 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "gitHead": "7dbead5cfa41583d47bb503d40970df2d3444a1e"
+  "gitHead": "eb7676525e9bf75daa9b2f42f035faed9b8e9a70"
 }

package/readme.md

@@ -131,3 +131,17 @@ Other config properties should be placed under: config -> tspci:
 Add a svg file with the name {typeIdentifier}.svg in the root of the PCI directory to have a custom icon for the PCI in TAO.
 
 ![custom icon](https://github.com/Citolab/tspci/blob/main/lib/tspci-tao/readme-images/icon.png)
+
+## sbom
+
+A CycloneDX SBOM of the bundle is included in the package as `interaction/runtime/js/sbom.cdx.json`,
+next to the bundle it describes, and copied next to the zip in `dist/` as
+`tao-pci-<typeIdentifier>_<version>.sbom.cdx.json` for your own technical documentation.
+
+Note that `imsPciCreator.json` does not list the SBOM in `runtime.src`. It travels with the zip you hand
+over, but whether TAO keeps the file after registering the PCI is untested: TAO copies the files from
+the src lists. Adding it there is a one line change, but a rejected registration is worse than a missing
+file, so that is not done by default.
+
+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,33 @@
+# 2.12.0
+
+- the SBOM is included in the package as `interaction/runtime/js/sbom.cdx.json`, next to the bundle
+- it is not listed in `runtime.src` of `imsPciCreator.json`, so whether TAO keeps the file after registering the PCI is untested
+- `--no-include-sbom` keeps it out of the package
+
+# 2.11.0
+
+- a CycloneDX SBOM of the bundle is copied next to the zip in `dist/` as `tao-pci-<typeIdentifier>_<version>.sbom.cdx.json`
+- `--include-sbom` also adds `sbom.cdx.json` to the package itself, `--no-sbom` skips generating one
+
+_The notes for 2.4.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 `setResponse`, so TAO can push a response into the PCI
+- added a GPL-3.0 LICENSE file to the package
+
+# 2.6.0
+
+- support for javascript PCIs, with `onCompleted` implemented by default
+- replaced the deprecated `fs.rmdir` with `fs.rm`
+
+# 2.4.0
+
+- fixed the destination location of the export
+
 # 2.3.0
 - added a script to add TAO support in a PCI that only support the IMS interface.
 

package/src/createPackage.mjs

@@ -330,6 +330,17 @@ export const bundle = () => {
   }
   // console.log(propertiesToReplace.short)
 
+  // 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("interaction", "runtime", "js"),
+    baseName: `tao-pci-${propertiesToReplace.typeIdentifier}_${packageData.version}`,
+    packageData,
+  });
+
   // zip the folder
   const zipName = `tao-pci-${propertiesToReplace.typeIdentifier}_${packageData.version}.zip`;
   zipDirectory(outputDirectoryTemp, path.join(outputDirectory, zipName)).then(
@@ -426,3 +437,31 @@ function isBoolean(val) {
       return false;
   }
 }
+
+// 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(`no SBOM found at ${source}, skipping it`);
+    return "";
+  }
+  fs.copyFileSync(source, path.join(outputDirectory, `${baseName}.${fileName}`));
+  console.log(`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;
+}