@citolab/tspci-tao 2.0.10 → 2.3.0-alpha.0

package/package.json

@@ -1,14 +1,16 @@
 {
   "name": "@citolab/tspci-tao",
-  "version": "2.0.10",
+  "version": "2.3.0-alpha.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": "",
   "type": "module",
   "types": "types/index.d.ts",
-  "dependencies": {
-    "archiver": "^5.3.0"
+  "devDependencies": {
+    "archiver": "^5.3.0",
+    "chalk": "5.2.0",
+    "inquirer": "9.2.0"
   },
   "scripts": {},
-  "gitHead": "1fbf4b0fd1cc33ad267e67adc79d9c073885e7c7"
+  "gitHead": "872d3b8628f1e7e9b2568563b8aae5ffa1a818d6"
 }

package/src/createPackage.mjs

@@ -12,8 +12,6 @@ export const bundle = () => {
   // AND icon WHICH CAN BE REFERENCED TO A SVG TO OVERRIDE THE 'LIKE' ICON.
   const propertiesToReplace = {
     typeIdentifier: "emptytypeIdentifier",
-    version: "1.0.0",
-    description: "my interaction description",
     label: "label",
     short: "short",
     score: ["NONE"],
@@ -26,29 +24,50 @@ export const bundle = () => {
   }
   const rawConfigData = fs.readFileSync(config);
   const packageData = JSON.parse(rawConfigData);
-
+  let migrated = false;
   // show warning if not specified
   for (const propertyName in propertiesToReplace) {
+    if (!packageData.config) {
+      migrated = true;
+      packageData.config = {};
+    }
+    if (!packageData.config.tspci) {
+      migrated = true;
+      packageData.config.tspci = {};
+    }
+    if (!packageData.config.tspci[propertyName] && packageData[propertyName]) {
+      packageData.config.tspci[propertyName] = packageData[propertyName];
+      delete packageData[propertyName];
+      migrated = true;
+    }
     if (propertyName === "typeIdentifier") {
-      if (!packageData[propertyName]) {
+      if (!packageData.config.tspci[propertyName]) {
         console.error(
           "'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[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."
         );
         return;
       }
     } else {
-      if (!packageData[propertyName])
+      if (!packageData.config.tspci[propertyName])
         console.warn(
-          `${propertyName} not specified in ${packageData.name} in package.json using ${propertiesToReplace[propertyName]}`
+          `${propertyName} not specified in ${packageData.name} in package.json using { config: tspci: {${propertiesToReplace[propertyName]}}`
         );
     }
   }
 
+  propertiesToReplace.description = packageData.description;
+  propertiesToReplace.version = packageData.version;
+
+  if (migrated) {
+    console.warn('package.json has been migrated to use "{ config: { tspci: { typeIdentifier: ..., xx" properties.');
+    fs.writeFileSync(config, JSON.stringify(packageData, null, 2));
+  }
+
   const outputDirectory = path.join(PACKAGE_ROOT_PATH, "dist");
   const outputDirectoryTemp = path.join(outputDirectory, "tmp");
 
@@ -71,7 +90,6 @@ 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);
 
   // ---------------------------------------------------------------------
@@ -115,8 +133,13 @@ export const bundle = () => {
 
     // loop through properties with values that should be replaced
     // if the value is not in the config, the default value will be used
+    const defaultPackageJsonProperties = ["version", "description"];
     for (const propertyName in propertiesToReplace) {
-      propertiesToReplace[propertyName] = packageData[propertyName];
+      if (defaultPackageJsonProperties.includes(propertyName)) {
+        propertiesToReplace[propertyName] = packageData[propertyName];
+      } else {
+        propertiesToReplace[propertyName] = packageData.config.tspci[propertyName];
+      }
     }
 
     const creatorFile = path.join(outputDirectoryTemp, "imsPciCreator.js");
@@ -245,6 +268,7 @@ export const bundle = () => {
     console.log(`created tao pci zip: ${zipName}`)
   );
 };
+
 function replace_string_in_file(filename, to_replace, replace_with) {
   var data = fs.readFileSync(filename, "utf8");
 

package/src/init.mjs

@@ -0,0 +1,112 @@
+import fs, { cp, mkdirSync } from "fs";
+import path from "path";
+import readline from "readline";
+import chalk from "chalk";
+import inquirer from "inquirer";
+function askOption(prompt) {
+  const rl = readline.createInterface({
+    input: process.stdin,
+    output: process.stdout,
+  });
+  return new Promise((resolve) => {
+    rl.question(prompt, (option) => {
+      rl.close();
+      resolve(option);
+    });
+  });
+}
+
+function selectOptions(prompt, options) {
+  return inquirer.prompt([
+    {
+      type: "checkbox",
+      message: prompt,
+      name: "values",
+      choices: options.map((o) => ({ name: o, checked: true })),
+    },
+  ]);
+}
+
+export const init = async () => {
+  console.log("adding TAO support to PCI");
+  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;
+  if (!typeIdentifer) {
+    console.error(
+      "No typeIdentifier found in package.json (config { tspci: { typeIdentifier: 'my-pci' }}). Add it and make sure it matches the PCI typeIdentifier property"
+    );
+    return;
+  }
+  // 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 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
+
+  // adding short, label and typeIdentifer to packageData
+  packageData.config.tspci.short = short;
+  packageData.config.tspci.label = label;
+  packageData.config.tspci.typeIdentifier = typeIdentifer;
+  packageData.config.tspci.score = scoreMethodArray;
+
+  packageData.scripts = packageData.scripts || {};
+  packageData.scripts["package:tao"] = "tspci --target tao";
+  // store packageData
+  fs.writeFileSync(path.join(PACKAGE_ROOT_PATH, "package.json"), JSON.stringify(packageData, null, 2), "utf8");
+
+  console.log("Adding TAO interface to PCI");
+  if (!packageData.source) {
+    console.error("Failed implementing TAO interface; No source property found in package.json.");
+  }
+    
+  const sourceFile = fs.readFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), "utf8");
+  if (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.");
+    } else {
+      let newSourceFile = sourceFile.replace(
+        "implements IMSpci<PropTypes> {",
+        "implements IMSpci<PropTypes>, TAOpci {"
+      );
+      // add import { TAOpci } from "@citolab/tspci-tao"; to the top of the file
+      newSourceFile = `import { TAOpci } from "@citolab/tspci-tao";\r\n${newSourceFile}`;
+      if (newSourceFile.indexOf(" QtiVariableJSON ") === -1) {
+        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.
+    };
+      `
+      const lastBracket = newSourceFile.lastIndexOf("}");
+      newSourceFile = newSourceFile.substring(0, lastBracket) + defaultImplementation + newSourceFile.substring(lastBracket);
+
+      fs.writeFileSync(path.join(PACKAGE_ROOT_PATH, packageData.source), newSourceFile, "utf8");
+      console.log("TAO interface implemented");
+    }
+  } else {
+    console.log("TAO interface already implemented");
+  }
+};
+