@citolab/tspci-qbci 2.5.4 → 2.5.5

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## [2.5.5](https://github.com/Citolab/tspci/compare/v2.5.4...v2.5.5) (2024-10-10)
+
+**Note:** Version bump only for package @citolab/tspci-qbci

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@citolab/tspci-qbci",
-  "version": "2.5.4",
+  "version": "2.5.5",
   "description": "create a .ci file that can be imported into Questify",
   "author": "patrick <patrick.deklein@cito.nl>, Marcel Hoekstra <marcel.hoekstra@cito.nl>",
   "repository": "",
   "type": "module",
   "types": "types/index.d.ts",
   "dependencies": {
-    "archiver": "^7.0.1"
+    "archiver": "^7.0.1",
+    "chalk": "5.3.0"
   },
   "scripts": {},
-  "gitHead": "3f69ce948e8d2e02131235a9488645aaa95e0413",
+  "gitHead": "107b2fde32e7e09f6ac2cac98a6018bce51539c0",
   "publishConfig": {
     "access": "public"
   }

package/release-notes.md

@@ -1,3 +1,13 @@
+
+# 2.1.1
+tspci
+- support for your own export plugin not in the npm package by using full name of npm path
+
+tspci-qbci
+- all media files from the assets folder in your root will be copied to .ref/media
+- all found media files will be added in an array .ref/json/manifes.json as media property
+- added chalk for some nice warning colors in cli mesages
+
 # 2.0.0
 
 - first release questify builder ci plugin

package/src/createPackage.mjs

@@ -1,6 +1,8 @@
+"use strict";
 import fs, { mkdirSync } from "fs";
 import path from "path";
 import archiver from "archiver";
+import chalk from "chalk";
 
 export const bundle = () => {
   const PACKAGE_ROOT_PATH = process.cwd();
@@ -40,7 +42,7 @@ export const bundle = () => {
   const questifyMetadataData = JSON.parse(rawMetadata);
 
   const propertiesToReplace = {
-    typeIdentifier: "emptytypeIdentifier"
+    typeIdentifier: "emptytypeIdentifier",
   };
   copyDirectoryRecursiveSync(path.join(PACKAGER_PATH, "questify-default"), outputDirectoryTemp, false);
 
@@ -54,13 +56,13 @@ export const bundle = () => {
     if (propertyName === "typeIdentifier") {
       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."
+          "'typeIdentifier' should be added as an option in package.json and should match the typeIdentifier of the PCI code file.",
         );
         return;
       } else {
         if (!packageData.config?.tspci[propertyName])
           console.info(
-            `${propertyName} not specified in ${packageData.name} in package.json using { config: tspci: {${propertiesToReplace[propertyName]}}`
+            `${propertyName} not specified in ${packageData.name} in package.json using { config: tspci: {${propertiesToReplace[propertyName]}}`,
           );
       }
     }
@@ -84,23 +86,82 @@ export const bundle = () => {
   if (!fs.existsSync(scriptPath)) {
     fs.mkdirSync(scriptPath);
   }
-  fs.copyFileSync(path.join(PACKAGE_ROOT_PATH, pciFile), path.join(scriptPath, "/index.min.js"));
+  const minifiedFilePath = path.join(scriptPath, "/index.min.js");
+  const maxJsFileSize = 499; // the facet player has a limit of 500kb for js files
+  fs.copyFileSync(path.join(PACKAGE_ROOT_PATH, pciFile), minifiedFilePath);
+
+  // make changes to the if files found in ./assets in the root of the project
+  // add media files to manifest.json and copy them to the output directory
+  // replace 'assets/' with 'ref/media/' in the minified js file
+  const assetsFolderPath = path.join(PACKAGE_ROOT_PATH, "assets");
+  const media = getMediaPathFilesArray(assetsFolderPath);
+  if (media.length > 0) {
+    const manifestRaw = fs.readFileSync(path.join(outputDirectoryTemp, "ref/json/manifest.json"), "utf8");
+    let manifestData = JSON.parse(manifestRaw);
+    manifestData = { ...manifestData, media };
+
+    // check if ref/media folder exists, if not create it
+    const mediaPath = path.join(outputDirectoryTemp, "ref/media");
+    if (!fs.existsSync(mediaPath)) {
+      fs.mkdirSync(mediaPath);
+    }
+
+    fs.writeFileSync(path.join(outputDirectoryTemp, "ref/json/manifest.json"), JSON.stringify(manifestData), "utf8");
+    copyDirectoryRecursiveSync(assetsFolderPath, path.join(outputDirectoryTemp, "ref/media"));
+  }
+
+  isMaxFileSize(maxJsFileSize, minifiedFilePath);
 
   // zip the folder
   const zipName = `${name}_${packageData.version}.ci`;
   zipDirectory(outputDirectoryTemp, path.join(outputDirectory, zipName)).then(() =>
     // fs.rmdirSync(outputDirectoryTemp, { recursive: true });
-    console.log(`created questify ci zip: ${zipName}`)
+    console.log(`created questify ci zip: ${zipName}`),
   );
 };
 
+function getMediaPathFilesArray(assetsFolderPath) {
+  if (!fs.existsSync(assetsFolderPath)) {
+    console.log(chalk.orange(`Assets folder not found: ${assetsFolderPath}`));
+    return [];
+  }
+
+  const mediaFiles = [];
+  const files = fs.readdirSync(assetsFolderPath);
+
+  files.forEach((file) => {
+    // check if file is an image, if not skip
+    if (!file.match(/\.(png|jpe?g|gif|svg)$/)) {
+      return;
+    }
+
+    const filePath = `ref/media/${file}`;
+    mediaFiles.push(filePath);
+  });
+
+  return mediaFiles;
+}
+
+function isMaxFileSize(maxFileSize, filePath) {
+  const fileSizeInBytes = fs.statSync(filePath).size;
+  const fileSizeInKilobytes = (fileSizeInBytes / 1024).toFixed(2);
+  if (parseFloat(fileSizeInKilobytes) > maxFileSize) {
+    // js file to big
+    console.log(chalk.red(`❗️Warning, minified file size of ${maxFileSize}kb exceeded: ${fileSizeInKilobytes} KB.❗️`));
+    console.log(chalk.red(`This will result in a packagestream error in the player.`));
+  } else {
+    // js file is ok
+    console.log(`✅ minified js file size: ${fileSizeInKilobytes} KB (max: ${maxFileSize} KB)`);
+  }
+}
+
 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("questify-pci-") !== -1 && itemName.indexOf(".zip") !== -1)) {
-      var sourcePath = path.join(source, itemName);
-      var targetPath = path.join(target, itemName);
+      const sourcePath = path.join(source, itemName);
+      const targetPath = path.join(target, itemName);
       if (fs.lstatSync(sourcePath).isDirectory()) {
         if (!fs.existsSync(targetPath) && !targetPath.toLocaleLowerCase().endsWith("tmp")) {
           fs.mkdirSync(targetPath);