@citolab/tspci-tao 2.6.3-beta.1 → 2.6.5

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.6.5](https://github.com/Citolab/tspci/compare/v2.6.3-beta.3...v2.6.5) (2025-04-16)
+
+**Note:** Version bump only for package @citolab/tspci-tao
+
+
+
+
+
+## [2.6.3-beta.3](https://github.com/Citolab/tspci/compare/v2.6.3-beta.2...v2.6.3-beta.3) (2025-04-16)
+
+**Note:** Version bump only for package @citolab/tspci-tao
+
+
+
+
+
+## [2.6.3-beta.2](https://github.com/Citolab/tspci/compare/v2.6.3-beta.1...v2.6.3-beta.2) (2025-04-16)
+
+**Note:** Version bump only for package @citolab/tspci-tao
+
+
+
+
+
 ## [2.6.3-beta.1](https://github.com/Citolab/tspci/compare/v2.6.3-beta.0...v2.6.3-beta.1) (2025-04-14)
 
 **Note:** Version bump only for package @citolab/tspci-tao

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci-tao",
-  "version": "2.6.3-beta.1",
+  "version": "2.6.5",
   "description": "create a zip file that can be imported into TAO",
   "author": "patrick <patrick.deklein@cito.nl>, Marcel Hoekstra <marcel.hoekstra@cito.nl>",
   "repository": "",
@@ -12,5 +12,5 @@
     "inquirer": "11.0.1"
   },
   "scripts": {},
-  "gitHead": "86cdeaf19f50955e56c729ea9fe96ab82d1df171"
+  "gitHead": "06a99429f9555a99fe3f877fb55c4bcbb9282b8a"
 }

package/src/createPackage.mjs

@@ -5,7 +5,9 @@ import archiver from "archiver";
 export const bundle = () => {
   const PACKAGE_ROOT_PATH = process.cwd();
 
-  const PACKAGER_PATH = path.join(PACKAGE_ROOT_PATH + "/node_modules/@citolab/tspci-tao");
+  const PACKAGER_PATH = path.join(
+    PACKAGE_ROOT_PATH + "/node_modules/@citolab/tspci-tao"
+  );
 
   // PROPERTIES CAN BE OVERRIDEN BY VALUES IN YOUR Package.json INSIDE YOUR PCI FOLDER
   // OTHER CONFIG VALUES ARE: "pciJsFile" THE BUNDLED PCI FILE DEFAULTS TO: "/dist/index.js"
@@ -46,7 +48,9 @@ export const bundle = () => {
           "'typeIdentifier' should be added as an option in package.json and should match the typeIdentifier of the PCI code file."
         );
         return;
-      } else if (!/^[A-Za-z0-9]*$/.test(packageData.config.tspci[propertyName])) {
+      } else if (
+        !/^[A-Za-z0-9]*$/.test(packageData.config.tspci[propertyName])
+      ) {
         console.error(
           "'typeIdentifier' can only contain (alpha)numeric characters. The pci does not work in TAO if typeindentifier contains a hyphen therefor we restrict all non (alpha)numeric characters. Make sure typeIdentifier of the PCI code file matches the typeidentier in package.json."
         );
@@ -64,7 +68,9 @@ export const bundle = () => {
   propertiesToReplace.version = packageData.version;
 
   if (migrated) {
-    console.warn('package.json has been migrated to use "{ config: { tspci: { typeIdentifier: ..., xx" properties.');
+    console.warn(
+      'package.json has been migrated to use "{ config: { tspci: { typeIdentifier: ..., xx" properties.'
+    );
     fs.writeFileSync(config, JSON.stringify(packageData, null, 2));
   }
 
@@ -90,7 +96,11 @@ export const bundle = () => {
   // to override these files for a specific PCI: add them in the same structure in the tao_pci folder
   // of the pci.
 
-  copyDirectoryRecursiveSync(path.join(PACKAGER_PATH, "toa_pci_default"), outputDirectoryTemp, false);
+  copyDirectoryRecursiveSync(
+    path.join(PACKAGER_PATH, "toa_pci_default"),
+    outputDirectoryTemp,
+    false
+  );
 
   // ---------------------------------------------------------------------
   // ADD THE VALUES THAT ARE SHOULD BE CONFIGURABLE WITHIN TAO
@@ -138,7 +148,8 @@ export const bundle = () => {
       if (defaultPackageJsonProperties.includes(propertyName)) {
         propertiesToReplace[propertyName] = packageData[propertyName];
       } else {
-        propertiesToReplace[propertyName] = packageData.config.tspci[propertyName];
+        propertiesToReplace[propertyName] =
+          packageData.config.tspci[propertyName];
       }
     }
 
@@ -147,9 +158,15 @@ export const bundle = () => {
     replace_string_in_file(
       creatorFile,
       "###_FIRST_SCORING_METHOD_###",
-      propertiesToReplace.score?.length > 0 ? propertiesToReplace.score[0] : "NONE"
+      propertiesToReplace.score?.length > 0
+        ? propertiesToReplace.score[0]
+        : "NONE"
+    );
+    replace_string_in_file(
+      creatorFile,
+      `'##__DEFAULT_VALUES__##'`,
+      defaultValues
     );
-    replace_string_in_file(creatorFile, `'##__DEFAULT_VALUES__##'`, defaultValues);
 
     // add stuff in interaction/creator/widget/states/Question.js
     const variableDeclaration = `
@@ -181,43 +198,83 @@ export const bundle = () => {
       .join(",\r\n")}
   `;
 
-    const widgetAnswerFile = path.join(outputDirectoryTemp, "interaction/creator/widget/states/Answer.js");
+    const widgetAnswerFile = path.join(
+      outputDirectoryTemp,
+      "interaction/creator/widget/states/Answer.js"
+    );
     replace_string_in_file(
       widgetAnswerFile,
       `'###_RD_TEMPLATES_###'`,
-      JSON.stringify(propertiesToReplace.score).replace("[", "").replace("]", "")
+      JSON.stringify(propertiesToReplace.score)
+        .replace("[", "")
+        .replace("]", "")
     );
 
-    const widgetQuestionFile = path.join(outputDirectoryTemp, "interaction/creator/widget/states/Question.js");
+    const widgetQuestionFile = path.join(
+      outputDirectoryTemp,
+      "interaction/creator/widget/states/Question.js"
+    );
 
-    replace_string_in_file(widgetQuestionFile, `// ##__SET_VARIABLES__##`, setVariables);
-    replace_string_in_file(widgetQuestionFile, `// ##__DECLARE_VARIABLES__##`, variableDeclaration);
-    replace_string_in_file(widgetQuestionFile, `// ##__CALLBACK__##`, callbacks);
+    replace_string_in_file(
+      widgetQuestionFile,
+      `// ##__SET_VARIABLES__##`,
+      setVariables
+    );
+    replace_string_in_file(
+      widgetQuestionFile,
+      `// ##__DECLARE_VARIABLES__##`,
+      variableDeclaration
+    );
+    replace_string_in_file(
+      widgetQuestionFile,
+      `// ##__CALLBACK__##`,
+      callbacks
+    );
     // add controls in
-    const propertiesFormFile = path.join(outputDirectoryTemp, "interaction/creator/tpl/propertiesForm.tpl");
+    const propertiesFormFile = path.join(
+      outputDirectoryTemp,
+      "interaction/creator/tpl/propertiesForm.tpl"
+    );
     const template = `${configValues
       .map((cv) => {
-        const capitalizedName = cv.name.charAt(0).toUpperCase() + cv.name.slice(1);
+        const capitalizedName =
+          cv.name.charAt(0).toUpperCase() + cv.name.slice(1);
         return `<label for="${cv.name}">{{__ "${capitalizedName}"}}</label>
         <span class="icon-help tooltipstered" data-tooltip="~ .tooltip-content:first" data-tooltip-theme="info"></span>
         <span class="tooltip-content">{{__ "${capitalizedName}"}}</span>
             <input type="text"
                name="${cv.name}"
-               type="${cv.type === "string" ? "text" : cv.type === "number" ? "number" : "text"}"
+               type="${
+                 cv.type === "string"
+                   ? "text"
+                   : cv.type === "number"
+                   ? "number"
+                   : "text"
+               }"
                value="{{${cv.name}}}"
                placeholder="e.g. ${replaceAll(cv.defaultValue, '"', "")}"
                data-validate="${cv.optional ? "" : "$notEmpty"};">`;
       })
       .join("\r\n")}
 `;
-    replace_string_in_file(propertiesFormFile, `<!-- ##_HTML_CONTROLS_## -->`, template);
+    replace_string_in_file(
+      propertiesFormFile,
+      `<!-- ##_HTML_CONTROLS_## -->`,
+      template
+    );
   } else {
-    console.warn("Create a config.json with properties to generate a TAO config");
+    console.warn(
+      "Create a config.json with properties to generate a TAO config"
+    );
   }
 
   // copy specific files
   if (fs.existsSync(path.join(PACKAGE_ROOT_PATH, "tao_pci"))) {
-    copyDirectoryRecursiveSync(path.join(PACKAGE_ROOT_PATH, "tao_pci"), outputDirectoryTemp, false);
+    copyDirectoryRecursiveSync(
+      path.join(PACKAGE_ROOT_PATH, "tao_pci"),
+      outputDirectoryTemp,
+      false
+    );
   }
 
   // files that contain values that should be replaced
@@ -234,14 +291,20 @@ export const bundle = () => {
   for (const fileToEdit of filesToEdit) {
     for (const propertyName in propertiesToReplace) {
       const pathToFile = path.join(outputDirectoryTemp, fileToEdit);
-      replace_string_in_file(pathToFile, `##${propertyName}##`, propertiesToReplace[propertyName]);
+      replace_string_in_file(
+        pathToFile,
+        `##${propertyName}##`,
+        propertiesToReplace[propertyName]
+      );
     }
   }
 
   // copy the actual PCI file
   const pciFile = config.main || "/dist/index.js";
 
-  if (!fs.existsSync(path.join(outputDirectoryTemp, "/interaction/runtime/js"))) {
+  if (
+    !fs.existsSync(path.join(outputDirectoryTemp, "/interaction/runtime/js"))
+  ) {
     mkdirSync(path.join(outputDirectoryTemp, "/interaction/runtime/js"));
   }
 
@@ -251,9 +314,15 @@ export const bundle = () => {
   );
 
   // the icon can be replaced by a custom icon
-  const iconLocation = path.join(PACKAGE_ROOT_PATH, `${propertiesToReplace.typeIdentifier}.svg`);
+  const iconLocation = path.join(
+    PACKAGE_ROOT_PATH,
+    `${propertiesToReplace.typeIdentifier}.svg`
+  );
   if (fs.existsSync(iconLocation)) {
-    fs.copyFileSync(iconLocation, path.join(outputDirectoryTemp, "/interaction/creator/img/icon.svg"));
+    fs.copyFileSync(
+      iconLocation,
+      path.join(outputDirectoryTemp, "/interaction/creator/img/icon.svg")
+    );
   } else {
     console.warn(
       `Cannot find svg file at: ${iconLocation} default icon will be used. To have a custom icon for the PCI in TAO add a svg file here: ${iconLocation}`
@@ -263,9 +332,10 @@ export const bundle = () => {
 
   // zip the folder
   const zipName = `tao-pci-${propertiesToReplace.typeIdentifier}_${packageData.version}.zip`;
-  zipDirectory(outputDirectoryTemp, path.join(outputDirectory, zipName)).then(() =>
-    // fs.rmdirSync(outputDirectoryTemp, { recursive: true });
-    console.log(`created tao pci zip: ${zipName}`)
+  zipDirectory(outputDirectoryTemp, path.join(outputDirectory, zipName)).then(
+    () =>
+      // fs.rmdirSync(outputDirectoryTemp, { recursive: true });
+      console.log(`created tao pci zip: ${zipName}`)
   );
 };
 
@@ -280,11 +350,16 @@ function copyDirectoryRecursiveSync(source, target) {
   if (!fs.lstatSync(source).isDirectory() || source.endsWith("tmp")) return;
   // var operation = move ? fs.renameSync : fs.copyFileSync;
   fs.readdirSync(source).forEach(function (itemName) {
-    if (!(itemName.indexOf("tao-pci-") !== -1 && itemName.indexOf(".zip") !== -1)) {
+    if (
+      !(itemName.indexOf("tao-pci-") !== -1 && itemName.indexOf(".zip") !== -1)
+    ) {
       var sourcePath = path.join(source, itemName);
       var targetPath = path.join(target, itemName);
       if (fs.lstatSync(sourcePath).isDirectory()) {
-        if (!fs.existsSync(targetPath) && !targetPath.toLocaleLowerCase().endsWith("tmp")) {
+        if (
+          !fs.existsSync(targetPath) &&
+          !targetPath.toLocaleLowerCase().endsWith("tmp")
+        ) {
           fs.mkdirSync(targetPath);
         }
         copyDirectoryRecursiveSync(sourcePath, targetPath);
@@ -317,14 +392,24 @@ function replaceAll(str, find, replace) {
   return str.replace(new RegExp(find, "g"), replace);
 }
 
-function isBoolean(string) {
-  switch (string.toLowerCase().trim()) {
+function isBoolean(val) {
+  // If val is already a boolean, return true
+  if (typeof val === "boolean") {
+    return true;
+  }
+
+  // If val is not a string, return false
+  if (typeof val !== "string") {
+    return false;
+  }
+
+  // Handle string cases
+  switch (val.toLowerCase().trim()) {
     case "true":
     case "yes":
     case "false":
     case "no":
       return true;
-
     default:
       return false;
   }