@citolab/tspci-tao 2.5.1-alpha.0 → 2.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@citolab/tspci-tao",
-  "version": "2.5.1-alpha.0",
+  "version": "2.5.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": "",
@@ -12,5 +12,5 @@
     "inquirer": "11.0.1"
   },
   "scripts": {},
-  "gitHead": "ca12b53627968796843a752ab994b6b2e7a39cf8"
+  "gitHead": "675cb6d40b418bac93a3e970d4d6dc4dc7c17bb5"
 }

package/src/init.mjs

@@ -42,18 +42,15 @@ 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 = (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 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"
+    "MATCH_CORRECT",
+    "NONE",
   ]);
-  const scoreMethodArray = scoringsMethods.values
+  const scoreMethodArray = scoringsMethods.values;
 
   // adding short, label and typeIdentifer to packageData
   packageData.config.tspci.short = short;
@@ -62,7 +59,7 @@ export const init = async () => {
   packageData.config.tspci.score = scoreMethodArray;
 
   packageData.devDependencies = packageData.devDependencies || {};
-  
+
   // 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"));
@@ -81,9 +78,12 @@ export const init = async () => {
   if (!packageData.source) {
     console.error("Failed implementing TAO interface; No source property found in package.json.");
   }
-    
+
+  // Determine if the file is TypeScript or JavaScript
+  const isTypeScript = packageData.source.endsWith(".ts");
+
   const sourceFile = fs.readFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), "utf8");
-  if (sourceFile.indexOf("implements IMSpci<PropTypes>, TAOpci") === -1) {
+  if (isTypeScript && sourceFile.indexOf("implements IMSpci<PropTypes>, TAOpci") === -1) {
     console.log("TAO interface not implemented yet; Implementing...");
     if (sourceFile.indexOf("implements IMSpci<PropTypes> {") === -1) {
       console.error("Cannot implement TAOpci interface automatically. Please implement it manually.");
@@ -98,29 +98,89 @@ export const init = async () => {
         newSourceFile = `import { QtiVariableJSON } from "@citolab/tspci";\r\n${newSourceFile}`;
       }
       const defaultImplementation = `
-off = () => {}; // called when setting correct response in tao
-on = (val) => {};
-trigger = (event: string, value: any) => {
-  this.config.properties[event] = value;
-  this.render();
-};
-resetResponse = () => {
-  // used in tao to reset the response. clean-up and re-render the PCI would be best. 
-  // this.render();
-};
-setResponse = (response: QtiVariableJSON) => {
-  // 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.
-};
-      `
+        off = () => {}; // called when setting correct response in tao
+        on = (val) => {};
+        trigger = (event: string, value: any) => {
+          this.config.properties[event] = value;
+          this.render();
+        };
+        resetResponse = () => {
+          // used in tao to reset the response. clean-up and re-render the PCI would be best. 
+          // this.render();
+        };
+        setResponse = (response: QtiVariableJSON) => {
+          // 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) + defaultImplementation + newSourceFile.substring(lastBracket);
+      newSourceFile =
+        newSourceFile.substring(0, lastBracket) + defaultImplementation + newSourceFile.substring(lastBracket);
 
       fs.writeFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), newSourceFile, "utf8");
       console.log(chalk.green("TAO interface implemented"));
     }
+  } else if (!isTypeScript) {
+    // For JavaScript implementation
+    let newSourceFile = sourceFile;
+
+    if (sourceFile.indexOf("@implements {TAOpci}") === -1) {
+      // Add @implements {TAOpci} to JSDoc of an existing method, e.g., getInstance
+      newSourceFile = newSourceFile.replace("/**", `/**\n * @implements {TAOpci}`);
+    }
+
+    const jsImplementation = `
+  /**
+   * Called when setting correct response in tao
+   * @method off
+   */
+  off = function() {};
+
+  /**
+   * Called when setting a value in TAO
+   * @method on
+   * @param {any} val
+   */
+  on = function(val) {};
+
+  /**
+   * Triggers an event and updates the configuration
+   * @method trigger
+   * @param {string} event
+   * @param {any} value
+   */
+  trigger = function(event, value) {
+    this.config.properties[event] = value;
+    this.render();
+  };
+
+  /**
+   * Resets the response in TAO
+   * @method resetResponse
+   */
+  resetResponse = function() {
+    // used in tao to reset the response. clean-up and re-render the PCI would be best. 
+    // this.render();
+  };
+
+  /**
+   * Sets the response in TAO
+   * @method setResponse
+   * @param {QtiVariableJSON} response
+   */
+  setResponse = function(response) {
+    // 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);
+
+    fs.writeFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), newSourceFile, "utf8");
+
+    fs.writeFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), newSourceFile, "utf8");
+    console.log(chalk.green("TAO interface implemented for JavaScript"));
   } else {
     console.log("TAO interface already implemented");
   }
   console.log(chalk.green("Done!"));
 };
-