@citolab/tspci-tao 2.7.1 → 2.8.2

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.8.2](https://github.com/Citolab/tspci/compare/v2.8.1...v2.8.2) (2026-02-24)
+
+**Note:** Version bump only for package @citolab/tspci-tao
+
+
+
+
+
+## [2.8.1](https://github.com/Citolab/tspci/compare/v2.8.0...v2.8.1) (2026-02-24)
+
+**Note:** Version bump only for package @citolab/tspci-tao
+
+
+
+
+
+# [2.8.0](https://github.com/Citolab/tspci/compare/v2.7.1...v2.8.0) (2026-02-24)
+
+**Note:** Version bump only for package @citolab/tspci-tao
+
+
+
+
+
 ## [2.7.1](https://github.com/Citolab/tspci/compare/v2.7.0...v2.7.1) (2026-02-09)
 
 **Note:** Version bump only for package @citolab/tspci-tao

package/package.json

@@ -1,16 +1,20 @@
 {
   "name": "@citolab/tspci-tao",
-  "version": "2.7.1",
+  "version": "2.8.2",
   "description": "create a zip file that can be imported into TAO",
   "author": "patrick <patrick.deklein@cito.nl>, Marcel Hoekstra <marcel.hoekstra@cito.nl>",
   "repository": "",
   "type": "module",
   "types": "types/index.d.ts",
-  "devDependencies": {
-    "archiver": "^7.0.1",
+  "dependencies": {
     "chalk": "5.6.2",
-    "inquirer": "13.2.2"
+    "inquirer": "13.2.2",
+    "yazl": "^3.3.1"
   },
   "scripts": {},
-  "gitHead": "1481d1ed65ab57b07bf6a12ae9f7e402105d2964"
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "gitHead": "460f7339e0490caea95fc5e9bedfcd12ebfce41f"
 }

package/src/createPackage.mjs

@@ -1,6 +1,6 @@
 import fs, { mkdirSync } from "fs";
 import path from "path";
-import archiver from "archiver";
+import yazl from "yazl";
 
 export const bundle = () => {
   const PACKAGE_ROOT_PATH = process.cwd();
@@ -16,7 +16,7 @@ export const bundle = () => {
     typeIdentifier: "emptytypeIdentifier",
     label: "label",
     short: "short",
-    score: ["NONE"],
+    score: ["MATCH_CORRECT", "NONE"],
   };
 
   const config = path.join(PACKAGE_ROOT_PATH, "package.json");
@@ -160,7 +160,7 @@ export const bundle = () => {
       "###_FIRST_SCORING_METHOD_###",
       propertiesToReplace.score?.length > 0
         ? propertiesToReplace.score[0]
-        : "NONE"
+        : "MATCH_CORRECT"
     );
     replace_string_in_file(
       creatorFile,
@@ -374,20 +374,32 @@ function copyDirectoryRecursiveSync(source, target) {
 }
 
 function zipDirectory(sourceDir, outPath) {
-  const archive = archiver("zip", { zlib: { level: 9 } });
-  const stream = fs.createWriteStream(outPath);
-
+  const zipFile = new yazl.ZipFile();
+  addDirectoryToZip(zipFile, sourceDir, sourceDir);
   return new Promise((resolve, reject) => {
-    archive
-      .directory(sourceDir, false)
-      .on("error", (err) => reject(err))
-      .pipe(stream);
-
+    const stream = fs.createWriteStream(outPath);
     stream.on("close", () => resolve());
-    archive.finalize();
+    stream.on("error", (err) => reject(err));
+    zipFile.outputStream.on("error", (err) => reject(err)).pipe(stream);
+    zipFile.end();
   });
 }
 
+function addDirectoryToZip(zipFile, rootDir, currentDir) {
+  for (const entry of fs.readdirSync(currentDir, { withFileTypes: true })) {
+    const fullPath = path.join(currentDir, entry.name);
+    if (entry.isDirectory()) {
+      addDirectoryToZip(zipFile, rootDir, fullPath);
+      continue;
+    }
+    if (!entry.isFile()) {
+      continue;
+    }
+    const relativePath = path.relative(rootDir, fullPath).split(path.sep).join("/");
+    zipFile.addFile(fullPath, relativePath, { compress: true });
+  }
+}
+
 function replaceAll(str, find, replace) {
   return str.replace(new RegExp(find, "g"), replace);
 }

package/src/init.mjs

@@ -31,6 +31,8 @@ function selectOptions(prompt, options) {
 
 export const init = async () => {
   console.log("adding TAO support to PCI");
+  const args = process.argv.slice(2);
+  const ciMode = args.includes("--ci");
   const PACKAGE_ROOT_PATH = process.cwd();
   const packageData = JSON.parse(fs.readFileSync(path.join(PACKAGE_ROOT_PATH, "package.json"), "utf8"));
   const typeIdentifer = packageData.config?.tspci?.typeIdentifier;
@@ -42,15 +44,17 @@ export const init = async () => {
   }
   // get first 5 chars of identifier
   const defaultShort = typeIdentifer.length > 5 ? typeIdentifer.substring(0, 5) : typeIdentifer;
-  const short = (await askOption(`Enter a short name for the PCI: (default: ${defaultShort}) `)) || defaultShort;
+  const short = ciMode
+    ? defaultShort
+    : (await askOption(`Enter a short name for the PCI: (default: ${defaultShort}) `)) || defaultShort;
 
   const defaultLabel = typeIdentifer.length > 5 ? typeIdentifer.substring(0, 5) : typeIdentifer;
-  const label = (await askOption(`Enter the label of the PCI: (default: ${defaultLabel}) `)) || defaultLabel;
-  const scoringsMethods = await selectOptions("Which scoring methods do you want to support?", [
-    "MATCH_CORRECT",
-    "NONE",
-  ]);
-  const scoreMethodArray = scoringsMethods.values;
+  const label = ciMode
+    ? defaultLabel
+    : (await askOption(`Enter the label of the PCI: (default: ${defaultLabel}) `)) || defaultLabel;
+  const scoreMethodArray = ciMode
+    ? ["MATCH_CORRECT", "NONE"]
+    : (await selectOptions("Which scoring methods do you want to support?", ["MATCH_CORRECT", "NONE"])).values;
 
   // adding short, label and typeIdentifer to packageData
   packageData.config.tspci.short = short;
@@ -63,9 +67,13 @@ export const init = async () => {
   // get package.json from PACKAGER_PATH
   const PACKAGER_PATH = path.join(PACKAGE_ROOT_PATH + "/node_modules/@citolab/tspci-tao");
   const packagerPackageData = JSON.parse(fs.readFileSync(path.join(PACKAGER_PATH, "package.json"), "utf8"));
-  // add devDependencies from packagerPackageData to packageData
-  Object.keys(packagerPackageData.devDependencies).forEach((key) => {
-    packageData.devDependencies[key] = packagerPackageData.devDependencies[key];
+  // add required runtime dependencies from the packager package to the generated project
+  const packagerDeps = {
+    ...(packagerPackageData.dependencies || {}),
+    ...(packagerPackageData.devDependencies || {}),
+  };
+  Object.keys(packagerDeps).forEach((key) => {
+    packageData.devDependencies[key] = packagerDeps[key];
   });
 
   packageData.scripts = packageData.scripts || {};
@@ -106,9 +114,12 @@ export const init = async () => {
           // this.render();
         };
       `;
-      const lastBracket = newSourceFile.lastIndexOf("}");
-      newSourceFile =
-        newSourceFile.substring(0, lastBracket) + defaultImplementation + newSourceFile.substring(lastBracket);
+      const classEndMarker = "\n}\n\nconst factory";
+      if (newSourceFile.indexOf(classEndMarker) === -1) {
+        console.error("Cannot inject TAO methods automatically. Please implement TAOpci methods manually.");
+      } else {
+        newSourceFile = newSourceFile.replace(classEndMarker, `\n${defaultImplementation}\n}\n\nconst factory`);
+      }
 
       fs.writeFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), newSourceFile, "utf8");
       console.log(chalk.green("TAO interface implemented"));
@@ -165,8 +176,12 @@ export const init = async () => {
     // used to set the response in tao. E.g. when the item author has set a correct response. And you refresh TAO it will call this method to set the response in the PCI in the score-editor.
   };
     `;
-    const lastBracket = newSourceFile.lastIndexOf("}");
-    newSourceFile = newSourceFile.substring(0, lastBracket) + jsImplementation + newSourceFile.substring(lastBracket);
+    const classEndMarker = "\n}\n\nconst factory";
+    if (newSourceFile.indexOf(classEndMarker) === -1) {
+      console.error("Cannot inject TAO methods automatically for JavaScript. Please implement manually.");
+    } else {
+      newSourceFile = newSourceFile.replace(classEndMarker, `\n${jsImplementation}\n}\n\nconst factory`);
+    }
 
     fs.writeFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), newSourceFile, "utf8");