@ijuantm/simpl-addon 2.0.0 → 2.2.0

package/README.md

@@ -56,5 +56,5 @@ The installer:
 
 ## Requirements
 
-- **Node.js**: >= 20.x.x
+- **Node.js**: >= 22.x.x
 - **Simpl Framework**: A (preferably clean) installation of Simpl, if not clean, some manual merging may be required, or the installer may skip files or break things (you have been warned).

package/install.js

@@ -3,6 +3,7 @@
 const fs = require('fs');
 const path = require('path');
 const https = require('https');
+const readline = require('readline');
 const {promisify} = require('util');
 const {exec} = require('child_process');
 
@@ -13,6 +14,7 @@ const COLORS = {
 };
 
 const CDN_BASE = 'https://cdn.simpl.iwanvanderwal.nl/framework';
+const LOCAL_RELEASES_DIR = process.env.SIMPL_LOCAL_RELEASES || path.join(process.cwd(), 'local-releases');
 
 const log = (message, color = 'reset') => console.log(`${COLORS[color]}${message}${COLORS.reset}`);
 
@@ -56,13 +58,22 @@ const downloadFile = (url, dest) => new Promise((resolve, reject) => {
   });
 });
 
+const promptUser = (question, defaultValue = '') => new Promise(resolve => {
+  const rl = readline.createInterface({input: process.stdin, output: process.stdout});
+  const prompt = defaultValue ? `${question} ${COLORS.dim}(${defaultValue})${COLORS.reset}: ` : `${question}: `;
+
+  rl.question(prompt, answer => {
+    rl.close();
+    resolve(answer.trim() || defaultValue);
+  });
+});
+
 const getSimplVersion = () => {
   const simplFile = path.join(process.cwd(), '.simpl');
 
   if (!fs.existsSync(simplFile)) throw new Error('Not a Simpl project. Missing .simpl file in current directory.');
 
-  const content = fs.readFileSync(simplFile, 'utf8');
-  const config = JSON.parse(content);
+  const config = JSON.parse(fs.readFileSync(simplFile, 'utf8'));
 
   if (!config.version) throw new Error('Invalid .simpl file: missing version field');
 
@@ -76,20 +87,14 @@ const showHelp = () => {
   log(`  ╰${'─'.repeat(62)}╯`);
   console.log();
   log(`  ${COLORS.bold}Usage:${COLORS.reset}`, 'blue');
-  log(`    ${COLORS.dim}npx @ijuantm/simpl-addon <addon-name>${COLORS.reset}`);
-  log(`    ${COLORS.dim}npx @ijuantm/simpl-addon --list${COLORS.reset}`);
+  log(`    ${COLORS.dim}npx @ijuantm/simpl-addon${COLORS.reset}`);
   log(`    ${COLORS.dim}npx @ijuantm/simpl-addon --help${COLORS.reset}`);
   console.log();
-  log(`  ${COLORS.bold}Arguments:${COLORS.reset}`, 'blue');
-  log(`    ${COLORS.dim}addon-name${COLORS.reset}    Name of the add-on to install`);
-  console.log();
   log(`  ${COLORS.bold}Commands:${COLORS.reset}`, 'blue');
-  log(`    ${COLORS.dim}--list, -l${COLORS.reset}    List all available add-ons`);
   log(`    ${COLORS.dim}--help, -h${COLORS.reset}    Show this help message`);
   console.log();
   log(`  ${COLORS.bold}Examples:${COLORS.reset}`, 'blue');
-  log(`    ${COLORS.dim}npx @ijuantm/simpl-addon auth${COLORS.reset}`);
-  log(`    ${COLORS.dim}npx @ijuantm/simpl-addon --list${COLORS.reset}`);
+  log(`    ${COLORS.dim}npx @ijuantm/simpl-addon${COLORS.reset}`);
   console.log();
   log(`  ${COLORS.bold}Note:${COLORS.reset}`, 'blue');
   log(`    Run this command from the root of your Simpl project.`);
@@ -97,31 +102,26 @@ const showHelp = () => {
   console.log();
 };
 
-const listAddons = async (version) => {
-  console.log();
-  log(`  ╭${'─'.repeat(62)}╮`);
-  log(`  │  ${COLORS.bold}Available Add-ons${COLORS.reset} ${COLORS.dim}(${version})${COLORS.reset}${' '.repeat(40 - version.length)}│`);
-  log(`  ╰${'─'.repeat(62)}╯`);
-  console.log();
-  log('  📦 Fetching available add-ons...', 'bold');
-
-  try {
-    const response = await fetchUrl(`${CDN_BASE}/${version}/add-ons/list.json`);
-    const addons = JSON.parse(String(response))['add-ons'];
+const checkServerAvailability = () => new Promise(resolve => {
+  const req = https.get(`${CDN_BASE}/versions.json`, {timeout: 5000}, res => {
+    res.resume();
+    resolve(res.statusCode === 200);
+  });
+  req.on('error', () => resolve(false));
+  req.on('timeout', () => {
+    req.destroy();
+    resolve(false);
+  });
+});
 
-    console.log();
+const getAvailableAddons = async (version) => {
+  const localListPath = path.join(LOCAL_RELEASES_DIR, version, 'add-ons', 'list.json');
 
-    if (addons.length === 0) log(`  ${COLORS.yellow}⚠${COLORS.reset} No add-ons available`);
-    else addons.forEach(name => log(`  ${COLORS.cyan}•${COLORS.reset} ${name}`));
-  } catch (error) {
-    console.log();
-    log(`  ${COLORS.red}✗${COLORS.reset} Failed to fetch add-ons: ${error.message}`, 'red');
-    console.log();
+  if (fs.existsSync(localListPath)) return JSON.parse(fs.readFileSync(localListPath, 'utf8'))['add-ons'];
 
-    process.exit(1);
-  }
+  if (!await checkServerAvailability()) throw new Error('CDN server is currently unreachable');
 
-  console.log();
+  return JSON.parse(await fetchUrl(`${CDN_BASE}/${version}/add-ons/list.json`))['add-ons'];
 };
 
 const extractMarkers = (content) => {
@@ -142,13 +142,10 @@ const extractMarkers = (content) => {
 
 const collectContentBetweenMarkers = (lines, startIndex) => {
   const content = [];
-
   for (let i = startIndex + 1; i < lines.length; i++) {
     if (lines[i].trim().includes('@addon-end')) break;
-
     content.push(lines[i]);
   }
-
   return content;
 };
 
@@ -166,7 +163,6 @@ const processEnvContent = (content, targetContent) => {
     }
 
     const match = line.match(/^([A-Z_][A-Z0-9_]*)=/);
-
     if (match && !new RegExp(`^${match[1]}=`, 'm').test(targetContent)) envVarsToAdd.push(line);
   });
 
@@ -182,19 +178,16 @@ const mergeFile = (targetPath, addonContent, markers, isEnv = false) => {
   const targetContent = fs.readFileSync(targetPath, 'utf8');
   const addonLines = addonContent.split('\n');
   const operations = [];
-
   let newContent = targetContent;
 
   markers.forEach(marker => {
     let content = collectContentBetweenMarkers(addonLines, marker.lineIndex);
-
     if (content.length === 0) return;
 
     let lineCount = content.length;
 
     if (isEnv) {
       const processed = processEnvContent(content, newContent);
-
       content = processed.content;
       lineCount = processed.count;
 
@@ -214,13 +207,10 @@ const mergeFile = (targetPath, addonContent, markers, isEnv = false) => {
 
     if (marker.type === 'prepend') {
       newContent = content.join('\n') + '\n' + newContent;
-
       operations.push({success: true, type: 'prepend', lines: lineCount});
     } else if (marker.type === 'append') {
       if (!newContent.endsWith('\n')) newContent += '\n';
-
       newContent += '\n' + content.join('\n') + '\n';
-
       operations.push({success: true, type: 'append', lines: lineCount});
     } else if ((marker.type === 'after' || marker.type === 'before') && marker.searchText) {
       const targetLines = newContent.split('\n');
@@ -232,9 +222,7 @@ const mergeFile = (targetPath, addonContent, markers, isEnv = false) => {
       }
 
       targetLines.splice(insertIndex, 0, ...content);
-
       newContent = targetLines.join('\n');
-
       operations.push({success: true, type: marker.type, lines: lineCount, searchText: marker.searchText});
     }
   });
@@ -247,13 +235,11 @@ const mergeFile = (targetPath, addonContent, markers, isEnv = false) => {
 const printMergeResults = (relativePath, isEnv, result) => {
   const indent = '    ';
   const varText = isEnv ? 'environment variable' : 'line';
-
   let hasChanges = false;
 
   result.operations.forEach(op => {
     if (op.success) {
       hasChanges = true;
-
       if (op.type === 'prepend') log(`${indent}${COLORS.green}✓${COLORS.reset} Prepended ${COLORS.bold}${op.lines}${COLORS.reset} ${varText}${op.lines !== 1 ? 's' : ''} to file start`);
       else if (op.type === 'append') log(`${indent}${COLORS.green}✓${COLORS.reset} Appended ${COLORS.bold}${op.lines}${COLORS.reset} ${varText}${op.lines !== 1 ? 's' : ''} to file end`);
       else if (op.type === 'after') log(`${indent}${COLORS.green}✓${COLORS.reset} Inserted ${COLORS.bold}${op.lines}${COLORS.reset} ${varText}${op.lines !== 1 ? 's' : ''} ${COLORS.cyan}after${COLORS.reset} "${COLORS.dim}${op.searchText}${COLORS.reset}"`);
@@ -265,19 +251,21 @@ const printMergeResults = (relativePath, isEnv, result) => {
   return hasChanges;
 };
 
-const extractZip = async zipPath => {
-  const tempExtract = path.join(process.cwd(), '__temp_extract_addon__');
+const extractZip = async (zipPath, destDir) => {
+  fs.mkdirSync(destDir, {recursive: true});
 
-  if (process.platform === 'win32') {
-    await execAsync(`powershell -command "Expand-Archive -Path '${zipPath}' -DestinationPath '${tempExtract}' -Force"`);
-  } else {
-    await execAsync(`unzip -q "${zipPath}" -d "${tempExtract}"`);
-  }
+  if (process.platform === 'win32') await execAsync(`powershell -command "Expand-Archive -Path '${zipPath}' -DestinationPath '${destDir}' -Force"`);
+  else await execAsync(`unzip -q "${zipPath}" -d "${destDir}"`);
 
-  const entries = fs.readdirSync(tempExtract, {withFileTypes: true});
-  const sourceDir = entries.length === 1 && entries[0].isDirectory() ? path.join(tempExtract, entries[0].name) : tempExtract;
+  const entries = fs.readdirSync(destDir, {withFileTypes: true});
 
-  return {sourceDir, tempExtract};
+  if (entries.length === 1 && entries[0].isDirectory()) {
+    const nestedDir = path.join(destDir, entries[0].name);
+    fs.readdirSync(nestedDir).forEach(item => fs.renameSync(path.join(nestedDir, item), path.join(destDir, item)));
+    fs.rmdirSync(nestedDir);
+  }
+
+  return destDir;
 };
 
 const processAddonFiles = (addonDir, targetDir) => {
@@ -290,19 +278,18 @@ const processAddonFiles = (addonDir, targetDir) => {
     const relativePath = path.join(basePath, entry.name).replace(/\\/g, '/');
     const destPath = path.join(targetDir, relativePath);
 
-    if (entry.isDirectory()) processDirectory(srcPath, relativePath);
-    else {
+    if (entry.isDirectory()) {
+      processDirectory(srcPath, relativePath);
+    } else {
       const content = fs.readFileSync(srcPath, 'utf8');
 
       if (fs.existsSync(destPath)) {
         const markers = extractMarkers(content);
-
         if (markers.length > 0 || entry.name === '.env') toMerge.push({content, destPath, relativePath, markers});
         else skipped.push(relativePath);
       } else {
         fs.mkdirSync(path.dirname(destPath), {recursive: true});
         fs.copyFileSync(srcPath, destPath);
-
         copied.push(relativePath);
       }
     }
@@ -314,21 +301,30 @@ const processAddonFiles = (addonDir, targetDir) => {
 };
 
 const downloadAddon = async (addonName, version, targetDir) => {
-  const zipUrl = `${CDN_BASE}/${version}/add-ons/${addonName}.zip`;
-  const tempZip = path.join(process.cwd(), `temp-addon-${addonName}.zip`);
+  const localZipPath = path.join(LOCAL_RELEASES_DIR, version, 'add-ons', `${addonName}.zip`);
+  const tempExtract = path.join(process.cwd(), '__temp_extract_addon__');
 
   try {
-    await downloadFile(zipUrl, tempZip);
+    if (fs.existsSync(localZipPath)) {
+      console.log();
+      log(`  💻 Using local add-on files`, 'bold');
+      const sourceDir = await extractZip(localZipPath, tempExtract);
+      const result = processAddonFiles(sourceDir, targetDir);
+      fs.rmSync(tempExtract, {recursive: true, force: true});
+      return result;
+    }
 
-    const {sourceDir, tempExtract} = await extractZip(tempZip);
-    const result = processAddonFiles(sourceDir, targetDir);
+    if (!await checkServerAvailability()) throw new Error('CDN server is currently unreachable');
 
+    const tempZip = path.join(process.cwd(), `temp-addon-${addonName}.zip`);
+    await downloadFile(`${CDN_BASE}/${version}/add-ons/${addonName}.zip`, tempZip);
+    const sourceDir = await extractZip(tempZip, tempExtract);
+    const result = processAddonFiles(sourceDir, targetDir);
     fs.unlinkSync(tempZip);
     fs.rmSync(tempExtract, {recursive: true, force: true});
-
     return result;
   } catch (error) {
-    if (fs.existsSync(tempZip)) fs.unlinkSync(tempZip);
+    if (fs.existsSync(tempExtract)) fs.rmSync(tempExtract, {recursive: true, force: true});
     throw error;
   }
 };
@@ -340,17 +336,14 @@ const mergeFiles = (toMerge) => {
 
   toMerge.forEach(({content, destPath, relativePath, markers}) => {
     const isEnv = path.basename(destPath) === '.env';
-
     log(`\n  ${COLORS.cyan}•${COLORS.reset} ${COLORS.dim}${relativePath}${COLORS.reset}`);
 
     try {
       const result = mergeFile(destPath, content, markers, isEnv);
-
       if (printMergeResults(relativePath, isEnv, result)) merged.push(relativePath);
       else unchanged.push(relativePath);
     } catch (error) {
       log(`    ${COLORS.red}✗ Error:${COLORS.reset} ${error.message}`, 'red');
-
       failed.push(relativePath);
     }
   });
@@ -362,9 +355,8 @@ const main = async () => {
   const args = process.argv.slice(2);
   const firstArg = args[0];
 
-  if (!firstArg || firstArg === '--help' || firstArg === '-h') {
+  if (firstArg === '--help' || firstArg === '-h') {
     showHelp();
-
     process.exit(0);
   }
 
@@ -376,21 +368,60 @@ const main = async () => {
     console.log();
     log(`  ${COLORS.red}✗${COLORS.reset} ${error.message}`, 'red');
     console.log();
+    process.exit(1);
+  }
+
+  console.log();
+  log(`  ╭${'─'.repeat(62)}╮`);
+  log(`  │  ${COLORS.bold}Simpl Add-on Installer${COLORS.reset} ${COLORS.dim}(${version})${COLORS.reset}${' '.repeat(37 - version.length)}│`);
+  log(`  ╰${'─'.repeat(62)}╯`);
+  console.log();
+  log('  📦 Fetching available add-ons...', 'bold');
 
+  let addons;
+
+  try {
+    addons = await getAvailableAddons(version);
+  } catch (error) {
+    console.log();
+    log(`  ${COLORS.red}✗${COLORS.reset} Failed to fetch add-ons`, 'red');
+    if (error.message === 'CDN server is currently unreachable') log(`  ${COLORS.dim}The CDN server is currently unavailable. Please try again later.${COLORS.reset}`);
+    console.log();
     process.exit(1);
   }
 
-  if (firstArg === '--list' || firstArg === '-l') {
-    await listAddons(version);
+  console.log();
 
+  if (addons.length === 0) {
+    log(`  ${COLORS.yellow}⚠${COLORS.reset} No add-ons available for this version`);
+    console.log();
     process.exit(0);
   }
 
-  const addonName = firstArg;
+  log(`  ${COLORS.bold}Available add-ons:${COLORS.reset}`, 'blue');
+  addons.forEach(name => log(`    ${COLORS.cyan}•${COLORS.reset} ${name}`));
+  console.log();
+
+  let addonName;
+
+  while (true) {
+    addonName = await promptUser('  Add-on to install');
+    if (!addonName) {
+      log(`  ${COLORS.red}✗${COLORS.reset} Add-on name cannot be empty`, 'red');
+      console.log();
+      continue;
+    }
+    if (!addons.includes(addonName)) {
+      log(`  ${COLORS.red}✗${COLORS.reset} Add-on "${addonName}" not found`, 'red');
+      console.log();
+      continue;
+    }
+    break;
+  }
 
   console.log();
   log(`  ╭${'─'.repeat(62)}╮`);
-  log(`  │  ${COLORS.bold}Installing Add-on: ${COLORS.cyan}${addonName}${COLORS.reset} ${COLORS.dim}(${version})${COLORS.reset}${' '.repeat(38 - addonName.length - version.length)}│`);
+  log(`  │  ${COLORS.bold}Installing: ${COLORS.cyan}${addonName}${COLORS.reset} ${COLORS.dim}(${version})${COLORS.reset}${' '.repeat(46 - addonName.length - version.length)}│`);
   log(`  ╰${'─'.repeat(62)}╯`);
   console.log();
   log('  📦 Downloading add-on...', 'bold');
@@ -401,10 +432,10 @@ const main = async () => {
     ({copied, skipped, toMerge} = await downloadAddon(addonName, version, process.cwd()));
   } catch (error) {
     console.log();
-    log(`  ${COLORS.red}✗${COLORS.reset} ${error.message}`, 'red');
-    log(`  ${COLORS.dim}Run ${COLORS.dim}npx @ijuantm/simpl-addon --list${COLORS.reset} to see available add-ons`);
+    log(`  ${COLORS.red}✗${COLORS.reset} Installation failed`, 'red');
+    if (error.message === 'CDN server is currently unreachable') log(`  ${COLORS.dim}The CDN server is currently unavailable. Please try again later.${COLORS.reset}`);
+    else log(`  ${COLORS.dim}Please verify the add-on exists and try again${COLORS.reset}`);
     console.log();
-
     process.exit(1);
   }
 
@@ -416,7 +447,6 @@ const main = async () => {
   if (skipped.length > 0) {
     console.log();
     log(`  ${COLORS.gray}○${COLORS.reset} ${COLORS.dim}Skipped ${skipped.length} file${skipped.length !== 1 ? 's' : ''} (no merge markers):${COLORS.reset}`);
-
     skipped.forEach(file => log(`    ${COLORS.dim}• ${file}${COLORS.reset}`));
   }
 
@@ -436,7 +466,6 @@ const main = async () => {
       console.log();
       log(`  ${COLORS.yellow}⚠${COLORS.reset} ${COLORS.yellow}${failed.length} file${failed.length !== 1 ? 's' : ''} failed to merge${COLORS.reset}`);
       log(`  ${COLORS.yellow}Please review manually:${COLORS.reset}`);
-
       failed.forEach(file => log(`    ${COLORS.cyan}• ${file}${COLORS.reset}`));
     }
   }
@@ -446,8 +475,7 @@ const main = async () => {
   console.log();
 };
 
-main().catch(err => {
-  log(`\n  ${COLORS.red}✗${COLORS.reset} Fatal error: ${err.message}\n`, 'red');
-
+main().catch(() => {
+  log(`\n  ${COLORS.red}✗${COLORS.reset} Fatal error occurred\n`, 'red');
   process.exit(1);
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ijuantm/simpl-addon",
   "description": "CLI tool to install Simpl framework add-ons.",
-  "version": "2.0.0",
+  "version": "2.2.0",
   "scripts": {
     "link": "npm link",
     "unlink": "npm unlink -g @ijuantm/simpl-addon"
@@ -11,11 +11,11 @@
     "simpl-addon": "install.js"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=22"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/IJuanTM/simpl"
+    "url": "https://github.com/IJuanTM/simpl/"
   },
   "keywords": [
     "simpl",
@@ -26,5 +26,5 @@
   ],
   "author": "Iwan van der Wal",
   "license": "GPL-3.0-only",
-  "homepage": "https://simpl.iwanvanderwal.nl"
+  "homepage": "https://simpl.iwanvanderwal.nl/"
 }